Package software.amazon.awscdk.services.config

Class CfnConformancePack

java.lang.Object
software.amazon.jsii.JsiiObject
software.constructs.Construct
software.amazon.awscdk.CfnElement
software.amazon.awscdk.CfnRefElement
software.amazon.awscdk.CfnResource
software.amazon.awscdk.services.config.CfnConformancePack
All Implemented Interfaces:
IInspectable, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct, software.constructs.IDependable
@Generated(value="jsii-pacmak/1.103.1 (build bef2dea)", date="2024-10-05T03:43:40.952Z") @Stability(Stable) public class CfnConformancePack extends CfnResource implements IInspectable
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();

See Also:

  • 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 software.constructs.Construct scope, @NotNull String id, @NotNull CfnConformancePackProps props)
      Parameters:
      scope - Scope in which this resource is defined. This parameter is required.
      id - Construct identifier for this resource (unique in its scope). 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.

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

    • setTemplateBody

      @Stability(Stable) public void setTemplateBody(@Nullable String value)
      A string containing full conformance pack template body.

    • getTemplateS3Uri

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

    • setTemplateS3Uri

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

    • getTemplateSsmDocumentDetails

      @Stability(Stable) @Nullable public Object getTemplateSsmDocumentDetails()
      An object that contains the name or Amazon Resource Name (ARN) of the AWS Systems Manager document (SSM document) and the version of the SSM document that is used to create a conformance pack.

    • setTemplateSsmDocumentDetails

      @Stability(Stable) public void setTemplateSsmDocumentDetails(@Nullable Object value)
      An object that contains the name or Amazon Resource Name (ARN) of the AWS Systems Manager document (SSM document) and the version of the SSM document that is used to create a conformance pack.