Package software.amazon.awscdk.services.config

Class CfnConformancePack

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.CfnConformancePack
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.562Z") @Stability(Stable) public class CfnConformancePack extends CfnResource implements IInspectable
A CloudFormation AWS::Config::ConformancePack.

A conformance pack is a collection of AWS Config rules and remediation actions that can be easily deployed in an account and a region. ConformancePack creates a service linked role in your account. The service linked role is created only when the role does not exist in your 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.*;
 Object templateSsmDocumentDetails;
 CfnConformancePack cfnConformancePack = CfnConformancePack.Builder.create(this, "MyCfnConformancePack")
         .conformancePackName("conformancePackName")
         // the properties below are optional
         .conformancePackInputParameters(List.of(ConformancePackInputParameterProperty.builder()
                 .parameterName("parameterName")
                 .parameterValue("parameterValue")
                 .build()))
         .deliveryS3Bucket("deliveryS3Bucket")
         .deliveryS3KeyPrefix("deliveryS3KeyPrefix")
         .templateBody("templateBody")
         .templateS3Uri("templateS3Uri")
         .templateSsmDocumentDetails(templateSsmDocumentDetails)
         .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

    • CfnConformancePack

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

    • CfnConformancePack

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

    • CfnConformancePack

      @Stability(Stable) public CfnConformancePack(@NotNull Construct scope, @NotNull String id, @NotNull CfnConformancePackProps props)
      Create a new AWS::Config::ConformancePack.

      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

    • getConformancePackName

      @Stability(Stable) @NotNull public String getConformancePackName()
      Name of the conformance pack you want to create.

    • setConformancePackName

      @Stability(Stable) public void setConformancePackName(@NotNull String value)
      Name of the conformance pack you want to create.

    • getTemplateSsmDocumentDetails

      @Stability(Stable) @NotNull public Object getTemplateSsmDocumentDetails()
      AWS::Config::ConformancePack.TemplateSSMDocumentDetails.

    • setTemplateSsmDocumentDetails

      @Stability(Stable) public void setTemplateSsmDocumentDetails(@NotNull Object value)
      AWS::Config::ConformancePack.TemplateSSMDocumentDetails.

    • 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.

    • setDeliveryS3Bucket

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

    • getDeliveryS3KeyPrefix

      @Stability(Stable) @Nullable public String getDeliveryS3KeyPrefix()
      The prefix for the Amazon S3 bucket.

    • setDeliveryS3KeyPrefix

      @Stability(Stable) public void setDeliveryS3KeyPrefix(@Nullable String value)
      The prefix for the Amazon S3 bucket.

    • 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.

      You can only use a YAML template with two resource types: config rule ( AWS::Config::ConfigRule ) and a remediation action ( AWS::Config::RemediationConfiguration ).

    • 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.

      You can only use a YAML template with two resource types: config rule ( AWS::Config::ConfigRule ) and a remediation action ( AWS::Config::RemediationConfiguration ).

    • getTemplateS3Uri

      @Stability(Stable) @Nullable public String getTemplateS3Uri()
      Location of file containing the template body (s3://bucketname/prefix).

      The uri must point to the conformance pack template (max size: 300 KB) that is located in an Amazon S3 bucket.

      You must have access to read Amazon S3 bucket.

    • setTemplateS3Uri

      @Stability(Stable) public void setTemplateS3Uri(@Nullable String value)
      Location of file containing the template body (s3://bucketname/prefix).

      The uri must point to the conformance pack template (max size: 300 KB) that is located in an Amazon S3 bucket.

      You must have access to read Amazon S3 bucket.