software.amazon.awscdk.services.config

Class CfnConformancePack

java.lang.Object

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

@Generated(value="jsii-pacmak/1.74.0 (build 6d08790)",
           date="2023-03-22T19:35:50.737Z")
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.
static interface	CfnConformancePack.TemplateSSMDocumentDetailsProperty This API allows you to create a conformance pack template with an AWS Systems Manager document (SSM document).

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

IInspectable.Jsii$Default, IInspectable.Jsii$Proxy

Nested classes/interfaces inherited from interface software.amazon.awscdk.core.IConstruct

IConstruct.Jsii$Default

Field Summary

Fields

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

Constructor Summary

Constructors

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

Methods inherited from class software.amazon.awscdk.core.CfnResource

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

Methods inherited from class software.amazon.awscdk.core.CfnRefElement

getRef

Methods inherited from class software.amazon.awscdk.core.CfnElement

getCreationStack, getLogicalId, getStack, isCfnElement, overrideLogicalId

Methods inherited from class software.amazon.awscdk.core.Construct

getNode, isConstruct, onPrepare, onSynthesize, onValidate, prepare, synthesize, validate

Methods inherited from class java.lang.Object

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

Field Detail

CFN_RESOURCE_TYPE_NAME

public static final java.lang.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

public CfnConformancePack(Construct scope,
                          java.lang.String id,
                          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

public void inspect(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

protected java.util.Map<java.lang.String,java.lang.Object> renderProperties(java.util.Map<java.lang.String,java.lang.Object> props)

Overrides:

renderProperties in class CfnResource

Parameters:

props - This parameter is required.

getCfnProperties

protected java.util.Map<java.lang.String,java.lang.Object> getCfnProperties()

Overrides:

getCfnProperties in class CfnResource

getConformancePackName

public java.lang.String getConformancePackName()

Name of the conformance pack you want to create.

setConformancePackName

public void setConformancePackName(java.lang.String value)

Name of the conformance pack you want to create.

getTemplateSsmDocumentDetails

public java.lang.Object getTemplateSsmDocumentDetails()

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

setTemplateSsmDocumentDetails

public void setTemplateSsmDocumentDetails(java.lang.Object value)

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

getConformancePackInputParameters

public java.lang.Object getConformancePackInputParameters()

A list of ConformancePackInputParameter objects.

setConformancePackInputParameters

public void setConformancePackInputParameters(IResolvable value)

A list of ConformancePackInputParameter objects.

setConformancePackInputParameters

public void setConformancePackInputParameters(java.util.List<java.lang.Object> value)

A list of ConformancePackInputParameter objects.

getDeliveryS3Bucket

public java.lang.String getDeliveryS3Bucket()

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

setDeliveryS3Bucket

public void setDeliveryS3Bucket(java.lang.String value)

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

getDeliveryS3KeyPrefix

public java.lang.String getDeliveryS3KeyPrefix()

The prefix for the Amazon S3 bucket.

setDeliveryS3KeyPrefix

public void setDeliveryS3KeyPrefix(java.lang.String value)

The prefix for the Amazon S3 bucket.

getTemplateBody

public java.lang.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

public void setTemplateBody(java.lang.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

public java.lang.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

public void setTemplateS3Uri(java.lang.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.