Package software.amazon.awscdk.services.config

Interface CfnOrganizationConformancePackProps

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnOrganizationConformancePackProps.Jsii$Proxy

@Generated(value="jsii-pacmak/1.104.0 (build e79254c)",
           date="2024-12-17T21:37:28.645Z")
@Stability(Stable)
public interface CfnOrganizationConformancePackProps
extends software.amazon.jsii.JsiiSerializable

Properties for defining a CfnOrganizationConformancePack.

Example:

 // The code below shows an example of how to instantiate this type.
 // The values are placeholders you should change.
 import software.amazon.awscdk.services.config.*;
 CfnOrganizationConformancePackProps cfnOrganizationConformancePackProps = CfnOrganizationConformancePackProps.builder()
         .organizationConformancePackName("organizationConformancePackName")
         // the properties below are optional
         .conformancePackInputParameters(List.of(ConformancePackInputParameterProperty.builder()
                 .parameterName("parameterName")
                 .parameterValue("parameterValue")
                 .build()))
         .deliveryS3Bucket("deliveryS3Bucket")
         .deliveryS3KeyPrefix("deliveryS3KeyPrefix")
         .excludedAccounts(List.of("excludedAccounts"))
         .templateBody("templateBody")
         .templateS3Uri("templateS3Uri")
         .build();
 

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-config-organizationconformancepack.html

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static final class	CfnOrganizationConformancePackProps.Builder	A builder for CfnOrganizationConformancePackProps
static final class	CfnOrganizationConformancePackProps.Jsii$Proxy	An implementation for CfnOrganizationConformancePackProps

Method Summary

Modifier and Type	Method	Description
static CfnOrganizationConformancePackProps.Builder	builder()
default Object	getConformancePackInputParameters()	A list of ConformancePackInputParameter objects.
default String	getDeliveryS3Bucket()	The name of the Amazon S3 bucket where AWS Config stores conformance pack templates.
default String	getDeliveryS3KeyPrefix()	Any folder structure you want to add to an Amazon S3 bucket.
default List<String>	getExcludedAccounts()	A comma-separated list of accounts excluded from organization conformance pack.
String	getOrganizationConformancePackName()	The name you assign to an organization conformance pack.
default String	getTemplateBody()	A string containing full conformance pack template body.
default String	getTemplateS3Uri()	Location of file containing the template body.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getOrganizationConformancePackName

@Stability(Stable)
@NotNull
String getOrganizationConformancePackName()

The name you assign to an organization conformance pack.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-config-organizationconformancepack.html#cfn-config-organizationconformancepack-organizationconformancepackname

getConformancePackInputParameters

@Stability(Stable)
@Nullable
default Object getConformancePackInputParameters()

A list of ConformancePackInputParameter objects.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-config-organizationconformancepack.html#cfn-config-organizationconformancepack-conformancepackinputparameters

getDeliveryS3Bucket

@Stability(Stable)
@Nullable
default String getDeliveryS3Bucket()

The name of the Amazon S3 bucket where AWS Config stores conformance pack templates.

This field is optional.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-config-organizationconformancepack.html#cfn-config-organizationconformancepack-deliverys3bucket

getDeliveryS3KeyPrefix

@Stability(Stable)
@Nullable
default String getDeliveryS3KeyPrefix()

Any folder structure you want to add to an Amazon S3 bucket.

This field is optional.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-config-organizationconformancepack.html#cfn-config-organizationconformancepack-deliverys3keyprefix

getExcludedAccounts

@Stability(Stable)
@Nullable
default List<String> getExcludedAccounts()

A comma-separated list of accounts excluded from organization conformance pack.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-config-organizationconformancepack.html#cfn-config-organizationconformancepack-excludedaccounts

getTemplateBody

@Stability(Stable)
@Nullable
default String getTemplateBody()

A string containing full conformance pack template body.

Structure containing the template body with a minimum length of 1 byte and a maximum length of 51,200 bytes.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-config-organizationconformancepack.html#cfn-config-organizationconformancepack-templatebody

getTemplateS3Uri

@Stability(Stable)
@Nullable
default String getTemplateS3Uri()

Location of file containing the template body.

The uri must point to the conformance pack template (max size: 300 KB).

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-config-organizationconformancepack.html#cfn-config-organizationconformancepack-templates3uri

builder

@Stability(Stable)
static CfnOrganizationConformancePackProps.Builder builder()

Returns:

a CfnOrganizationConformancePackProps.Builder of CfnOrganizationConformancePackProps