Package software.amazon.awscdk.services.config

Class CfnOrganizationConformancePack

java.lang.Object
software.amazon.jsii.JsiiObject
software.constructs.Construct
software.amazon.awscdk.core.Construct
software.amazon.awscdk.core.CfnElement
software.amazon.awscdk.core.CfnRefElement
software.amazon.awscdk.core.CfnResource
software.amazon.awscdk.services.config.CfnOrganizationConformancePack
All Implemented Interfaces:
IConstruct, IDependable, IInspectable, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct
@Generated(value="jsii-pacmak/1.84.0 (build 5404dcf)", date="2023-06-19T16:30:48.581Z") @Stability(Stable) public class CfnOrganizationConformancePack extends CfnResource implements IInspectable
A CloudFormation AWS::Config::OrganizationConformancePack.

OrganizationConformancePack deploys conformance packs across member accounts in an AWS Organizations . OrganizationConformancePack enables organization service access for config-multiaccountsetup.amazonaws.com through the EnableAWSServiceAccess action and creates a service linked role in the master account of your organization. The service linked role is created only when the role does not exist in the master account.

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.*;
 CfnOrganizationConformancePack cfnOrganizationConformancePack = CfnOrganizationConformancePack.Builder.create(this, "MyCfnOrganizationConformancePack")
         .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();

  • Field Details

    • CFN_RESOURCE_TYPE_NAME

      @Stability(Stable) public static final String CFN_RESOURCE_TYPE_NAME
      The CloudFormation resource type name for this resource class.

  • Constructor Details

    • CfnOrganizationConformancePack

      protected CfnOrganizationConformancePack(software.amazon.jsii.JsiiObjectRef objRef)

    • CfnOrganizationConformancePack

      protected CfnOrganizationConformancePack(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)

    • CfnOrganizationConformancePack

      @Stability(Stable) public CfnOrganizationConformancePack(@NotNull Construct scope, @NotNull String id, @NotNull CfnOrganizationConformancePackProps props)
      Create a new AWS::Config::OrganizationConformancePack.

      Parameters:
      scope -
      • scope in which this resource is defined.
      This parameter is required.
      id -
      • scoped id of the resource.
      This parameter is required.
      props -
      • resource properties.
      This parameter is required.

  • Method Details

    • inspect

      @Stability(Stable) public void inspect(@NotNull TreeInspector inspector)
      Examines the CloudFormation resource and discloses attributes.

      Specified by:
      inspect in interface IInspectable
      Parameters:
      inspector -
      • tree inspector to collect and process attributes.
      This parameter is required.

    • renderProperties

      @Stability(Stable) @NotNull protected Map<String,Object> renderProperties(@NotNull Map<String,Object> props)
      Overrides:
      renderProperties in class CfnResource
      Parameters:
      props - This parameter is required.

    • getCfnProperties

      @Stability(Stable) @NotNull protected Map<String,Object> getCfnProperties()
      Overrides:
      getCfnProperties in class CfnResource

    • getOrganizationConformancePackName

      @Stability(Stable) @NotNull public String getOrganizationConformancePackName()
      The name you assign to an organization conformance pack.

    • setOrganizationConformancePackName

      @Stability(Stable) public void setOrganizationConformancePackName(@NotNull String value)
      The name you assign to an organization conformance pack.

    • getConformancePackInputParameters

      @Stability(Stable) @Nullable public Object getConformancePackInputParameters()
      A list of ConformancePackInputParameter objects.

    • setConformancePackInputParameters

      @Stability(Stable) public void setConformancePackInputParameters(@Nullable IResolvable value)
      A list of ConformancePackInputParameter objects.

    • setConformancePackInputParameters

      @Stability(Stable) public void setConformancePackInputParameters(@Nullable List<Object> value)
      A list of ConformancePackInputParameter objects.

    • getDeliveryS3Bucket

      @Stability(Stable) @Nullable public String getDeliveryS3Bucket()
      The name of the Amazon S3 bucket where AWS Config stores conformance pack templates.

      This field is optional.

    • setDeliveryS3Bucket

      @Stability(Stable) public void setDeliveryS3Bucket(@Nullable String value)
      The name of the Amazon S3 bucket where AWS Config stores conformance pack templates.

      This field is optional.

    • getDeliveryS3KeyPrefix

      @Stability(Stable) @Nullable public String getDeliveryS3KeyPrefix()
      Any folder structure you want to add to an Amazon S3 bucket.

      This field is optional.

    • setDeliveryS3KeyPrefix

      @Stability(Stable) public void setDeliveryS3KeyPrefix(@Nullable String value)
      Any folder structure you want to add to an Amazon S3 bucket.

      This field is optional.

    • getExcludedAccounts

      @Stability(Stable) @Nullable public List<String> getExcludedAccounts()
      A comma-separated list of accounts excluded from organization conformance pack.

    • setExcludedAccounts

      @Stability(Stable) public void setExcludedAccounts(@Nullable List<String> value)
      A comma-separated list of accounts excluded from organization conformance pack.

    • getTemplateBody

      @Stability(Stable) @Nullable public 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.

    • setTemplateBody

      @Stability(Stable) public void setTemplateBody(@Nullable String value)
      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.

    • getTemplateS3Uri

      @Stability(Stable) @Nullable public String getTemplateS3Uri()
      Location of file containing the template body.

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

    • setTemplateS3Uri

      @Stability(Stable) public void setTemplateS3Uri(@Nullable String value)
      Location of file containing the template body.

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