CfnConformancePackPropsMixin

class aws_cdk.mixins_preview.aws_config.mixins.CfnConformancePackPropsMixin(props, *, strategy=None)

Bases: Mixin

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.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-config-conformancepack.html
CloudformationResource:: AWS::Config::ConformancePack
Mixin:: true
ExampleMetadata:: fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk.mixins_preview import mixins
from aws_cdk.mixins_preview.aws_config import mixins as config_mixins

# template_ssm_document_details: Any

cfn_conformance_pack_props_mixin = config_mixins.CfnConformancePackPropsMixin(config_mixins.CfnConformancePackMixinProps(
    conformance_pack_input_parameters=[config_mixins.CfnConformancePackPropsMixin.ConformancePackInputParameterProperty(
        parameter_name="parameterName",
        parameter_value="parameterValue"
    )],
    conformance_pack_name="conformancePackName",
    delivery_s3_bucket="deliveryS3Bucket",
    delivery_s3_key_prefix="deliveryS3KeyPrefix",
    template_body="templateBody",
    template_s3_uri="templateS3Uri",
    template_ssm_document_details=template_ssm_document_details
),
    strategy=mixins.PropertyMergeStrategy.OVERRIDE
)

Create a mixin to apply properties to AWS::Config::ConformancePack.

Parameters:

props (Union[CfnConformancePackMixinProps, Dict[str, Any]]) – L1 properties to apply.
strategy (Optional[PropertyMergeStrategy]) – (experimental) Strategy for merging nested properties. Default: - PropertyMergeStrategy.MERGE

Methods

apply_to(construct)

Apply the mixin properties to the construct.

Parameters:: construct (IConstruct)
Return type:: IConstruct

supports(construct)

Check if this mixin supports the given construct.

Parameters:: construct (IConstruct)
Return type:: bool

Attributes

CFN_PROPERTY_KEYS = ['conformancePackInputParameters', 'conformancePackName', 'deliveryS3Bucket', 'deliveryS3KeyPrefix', 'templateBody', 'templateS3Uri', 'templateSsmDocumentDetails']

Static Methods

classmethod is_mixin(x)

(experimental) Checks if x is a Mixin.

Parameters:: x (Any) – Any object.
Return type:: bool
Returns:: true if x is an object created from a class which extends Mixin.
Stability:: experimental

ConformancePackInputParameterProperty

class CfnConformancePackPropsMixin.ConformancePackInputParameterProperty(*, parameter_name=None, parameter_value=None)

Bases: object

Input parameters in the form of key-value pairs for the conformance pack, both of which you define.

Keys can have a maximum character length of 255 characters, and values can have a maximum length of 4096 characters.

Parameters:

parameter_name (Optional[str]) – One part of a key-value pair.
parameter_value (Optional[str]) – Another part of the key-value pair.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-config-conformancepack-conformancepackinputparameter.html

ExampleMetadata:

fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk.mixins_preview.aws_config import mixins as config_mixins

conformance_pack_input_parameter_property = config_mixins.CfnConformancePackPropsMixin.ConformancePackInputParameterProperty(
    parameter_name="parameterName",
    parameter_value="parameterValue"
)

Attributes

parameter_name

One part of a key-value pair.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-config-conformancepack-conformancepackinputparameter.html#cfn-config-conformancepack-conformancepackinputparameter-parametername

parameter_value

Another part of the key-value pair.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-config-conformancepack-conformancepackinputparameter.html#cfn-config-conformancepack-conformancepackinputparameter-parametervalue

TemplateSSMDocumentDetailsProperty

class CfnConformancePackPropsMixin.TemplateSSMDocumentDetailsProperty(*, document_name=None, document_version=None)

Bases: object

This API allows you to create a conformance pack template with an AWS Systems Manager document (SSM document).

To deploy a conformance pack using an SSM document, first create an SSM document with conformance pack content, and then provide the DocumentName in the PutConformancePack API . You can also provide the DocumentVersion .

The TemplateSSMDocumentDetails object contains the name of the SSM document and the version of the SSM document.

Parameters:

document_name (Optional[str]) – The name or Amazon Resource Name (ARN) of the SSM document to use to create a conformance pack. If you use the document name, AWS Config checks only your account and AWS Region for the SSM document.
document_version (Optional[str]) – The version of the SSM document to use to create a conformance pack. By default, AWS Config uses the latest version. .. epigraph:: This field is optional.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-config-conformancepack-templatessmdocumentdetails.html

ExampleMetadata:

fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk.mixins_preview.aws_config import mixins as config_mixins

template_sSMDocument_details_property = config_mixins.CfnConformancePackPropsMixin.TemplateSSMDocumentDetailsProperty(
    document_name="documentName",
    document_version="documentVersion"
)

Attributes

document_name

The name or Amazon Resource Name (ARN) of the SSM document to use to create a conformance pack.

If you use the document name, AWS Config checks only your account and AWS Region for the SSM document.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-config-conformancepack-templatessmdocumentdetails.html#cfn-config-conformancepack-templatessmdocumentdetails-documentname

document_version

The version of the SSM document to use to create a conformance pack.

By default, AWS Config uses the latest version. .. epigraph:

This field is optional.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-config-conformancepack-templatessmdocumentdetails.html#cfn-config-conformancepack-templatessmdocumentdetails-documentversion