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.67.0 (build 2c027f5)",
           date="2022-09-19T20:26:37.725Z")
 @Stability(value=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();
 

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	CfnConformancePack.Builder A fluent builder for CfnConformancePack.
static interface	CfnConformancePack.ConformancePackInputParameterProperty Input parameters in the form of key-value pairs for the conformance pack, both of which you define.

Nested classes/interfaces inherited from class software.amazon.jsii.JsiiObject

software.amazon.jsii.JsiiObject.InitializationMode

Nested classes/interfaces inherited from interface software.amazon.awscdk.IInspectable

IInspectable.Jsii$Default, IInspectable.Jsii$Proxy

Nested classes/interfaces inherited from interface software.constructs.IConstruct

software.constructs.IConstruct.Jsii$Default

Field Summary

Fields

Modifier and Type	Field and Description
static String	CFN_RESOURCE_TYPE_NAME The CloudFormation resource type name for this resource class.

Constructor Summary

Constructors

Modifier	Constructor and Description
	CfnConformancePack(software.constructs.Construct scope, String id, CfnConformancePackProps props) Create a new `AWS::Config::ConformancePack`.
protected	CfnConformancePack(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
protected	CfnConformancePack(software.amazon.jsii.JsiiObjectRef objRef)

Method Summary

Modifier and Type	Method and Description
protected Map<String,Object>	getCfnProperties()
Object	getConformancePackInputParameters() A list of ConformancePackInputParameter objects.
String	getConformancePackName() Name of the conformance pack you want to create.
String	getDeliveryS3Bucket() The name of the Amazon S3 bucket where AWS Config stores conformance pack templates.
String	getDeliveryS3KeyPrefix() The prefix for the Amazon S3 bucket.
String	getTemplateBody() A string containing full conformance pack template body.
String	getTemplateS3Uri() Location of file containing the template body (s3://bucketname/prefix).
Object	getTemplateSsmDocumentDetails() `AWS::Config::ConformancePack.TemplateSSMDocumentDetails`.
void	inspect(TreeInspector inspector) Examines the CloudFormation resource and discloses attributes.
protected Map<String,Object>	renderProperties(Map<String,Object> props)
void	setConformancePackInputParameters(IResolvable value) A list of ConformancePackInputParameter objects.
void	setConformancePackInputParameters(List<Object> value) A list of ConformancePackInputParameter objects.
void	setConformancePackName(String value) Name of the conformance pack you want to create.
void	setDeliveryS3Bucket(String value) The name of the Amazon S3 bucket where AWS Config stores conformance pack templates.
void	setDeliveryS3KeyPrefix(String value) The prefix for the Amazon S3 bucket.
void	setTemplateBody(String value) A string containing full conformance pack template body.
void	setTemplateS3Uri(String value) Location of file containing the template body (s3://bucketname/prefix).
void	setTemplateSsmDocumentDetails(Object value) `AWS::Config::ConformancePack.TemplateSSMDocumentDetails`.

Methods inherited from class software.amazon.awscdk.CfnResource

addDeletionOverride, addDependsOn, addMetadata, addOverride, addPropertyDeletionOverride, addPropertyOverride, applyRemovalPolicy, applyRemovalPolicy, applyRemovalPolicy, getAtt, getCfnOptions, getCfnResourceType, getMetadata, getUpdatedProperites, getUpdatedProperties, isCfnResource, shouldSynthesize, toString, validateProperties

Methods inherited from class software.amazon.awscdk.CfnRefElement

getRef

Methods inherited from class software.amazon.awscdk.CfnElement

getCreationStack, getLogicalId, getStack, isCfnElement, overrideLogicalId

Methods inherited from class software.constructs.Construct

getNode, isConstruct

Methods inherited from class software.amazon.jsii.JsiiObject

jsiiAsyncCall, jsiiAsyncCall, jsiiCall, jsiiCall, jsiiGet, jsiiGet, jsiiSet, jsiiStaticCall, jsiiStaticCall, jsiiStaticGet, jsiiStaticGet, jsiiStaticSet, jsiiStaticSet

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Field Detail

CFN_RESOURCE_TYPE_NAME

@Stability(value=Stable)
public static final String CFN_RESOURCE_TYPE_NAME

The CloudFormation resource type name for this resource class.

Constructor Detail

CfnConformancePack

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

CfnConformancePack

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

CfnConformancePack

@Stability(value=Stable)
public CfnConformancePack(@NotNull
                                                   software.constructs.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 Detail

inspect

@Stability(value=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(value=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(value=Stable)
 @NotNull
protected Map<String,Object> getCfnProperties()

Overrides:

getCfnProperties in class CfnResource

getConformancePackName

@Stability(value=Stable)
 @NotNull
public String getConformancePackName()

Name of the conformance pack you want to create.

setConformancePackName

@Stability(value=Stable)
public void setConformancePackName(@NotNull
                                                            String value)

Name of the conformance pack you want to create.

getTemplateSsmDocumentDetails

@Stability(value=Stable)
 @NotNull
public Object getTemplateSsmDocumentDetails()

`AWS::Config::ConformancePack.TemplateSSMDocumentDetails`.

setTemplateSsmDocumentDetails

@Stability(value=Stable)
public void setTemplateSsmDocumentDetails(@NotNull
                                                                   Object value)

`AWS::Config::ConformancePack.TemplateSSMDocumentDetails`.

getConformancePackInputParameters

@Stability(value=Stable)
 @Nullable
public Object getConformancePackInputParameters()

A list of ConformancePackInputParameter objects.

setConformancePackInputParameters

@Stability(value=Stable)
public void setConformancePackInputParameters(@Nullable
                                                                       IResolvable value)

A list of ConformancePackInputParameter objects.

setConformancePackInputParameters

@Stability(value=Stable)
public void setConformancePackInputParameters(@Nullable
                                                                       List<Object> value)

A list of ConformancePackInputParameter objects.

getDeliveryS3Bucket

@Stability(value=Stable)
 @Nullable
public String getDeliveryS3Bucket()

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

setDeliveryS3Bucket

@Stability(value=Stable)
public void setDeliveryS3Bucket(@Nullable
                                                         String value)

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

getDeliveryS3KeyPrefix

@Stability(value=Stable)
 @Nullable
public String getDeliveryS3KeyPrefix()

The prefix for the Amazon S3 bucket.

setDeliveryS3KeyPrefix

@Stability(value=Stable)
public void setDeliveryS3KeyPrefix(@Nullable
                                                            String value)

The prefix for the Amazon S3 bucket.

getTemplateBody

@Stability(value=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(value=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(value=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(value=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.