Class CfnConformancePack
A CloudFormation AWS::Config::ConformancePack
.
Inherited Members
Namespace: Amazon.CDK.AWS.Config
Assembly: Amazon.CDK.AWS.Config.dll
Syntax (csharp)
public class CfnConformancePack : CfnResource, IConstruct, IDependable, IInspectable
Syntax (vb)
Public Class CfnConformancePack
Inherits CfnResource
Implements IConstruct, IDependable, IInspectable
Remarks
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.
CloudformationResource: AWS::Config::ConformancePack
ExampleMetadata: fixture=_generated
Examples
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
using Amazon.CDK.AWS.Config;
var templateSsmDocumentDetails;
var cfnConformancePack = new CfnConformancePack(this, "MyCfnConformancePack", new CfnConformancePackProps {
ConformancePackName = "conformancePackName",
// the properties below are optional
ConformancePackInputParameters = new [] { new ConformancePackInputParameterProperty {
ParameterName = "parameterName",
ParameterValue = "parameterValue"
} },
DeliveryS3Bucket = "deliveryS3Bucket",
DeliveryS3KeyPrefix = "deliveryS3KeyPrefix",
TemplateBody = "templateBody",
TemplateS3Uri = "templateS3Uri",
TemplateSsmDocumentDetails = templateSsmDocumentDetails
});
Synopsis
Constructors
CfnConformancePack(Construct, String, ICfnConformancePackProps) | Create a new |
CfnConformancePack(ByRefValue) | Used by jsii to construct an instance of this class from a Javascript-owned object reference |
CfnConformancePack(DeputyBase.DeputyProps) | Used by jsii to construct an instance of this class from DeputyProps |
Properties
CFN_RESOURCE_TYPE_NAME | The CloudFormation resource type name for this resource class. |
CfnProperties | |
ConformancePackInputParameters | A list of ConformancePackInputParameter objects. |
ConformancePackName | Name of the conformance pack you want to create. |
DeliveryS3Bucket | The name of the Amazon S3 bucket where AWS Config stores conformance pack templates. |
DeliveryS3KeyPrefix | The prefix for the Amazon S3 bucket. |
TemplateBody | A string containing full conformance pack template body. |
TemplateS3Uri | Location of file containing the template body (s3://bucketname/prefix). |
TemplateSsmDocumentDetails |
|
Methods
Inspect(TreeInspector) | Examines the CloudFormation resource and discloses attributes. |
RenderProperties(IDictionary<String, Object>) |
Constructors
CfnConformancePack(Construct, String, ICfnConformancePackProps)
Create a new AWS::Config::ConformancePack
.
public CfnConformancePack(Construct scope, string id, ICfnConformancePackProps props)
Parameters
- scope Construct
- scope in which this resource is defined.
- id System.String
- scoped id of the resource.
- props ICfnConformancePackProps
- resource properties.
CfnConformancePack(ByRefValue)
Used by jsii to construct an instance of this class from a Javascript-owned object reference
protected CfnConformancePack(ByRefValue reference)
Parameters
- reference Amazon.JSII.Runtime.Deputy.ByRefValue
The Javascript-owned object reference
CfnConformancePack(DeputyBase.DeputyProps)
Used by jsii to construct an instance of this class from DeputyProps
protected CfnConformancePack(DeputyBase.DeputyProps props)
Parameters
- props Amazon.JSII.Runtime.Deputy.DeputyBase.DeputyProps
The deputy props
Properties
CFN_RESOURCE_TYPE_NAME
The CloudFormation resource type name for this resource class.
public static string CFN_RESOURCE_TYPE_NAME { get; }
Property Value
System.String
CfnProperties
protected override IDictionary<string, object> CfnProperties { get; }
Property Value
System.Collections.Generic.IDictionary<System.String, System.Object>
Overrides
ConformancePackInputParameters
A list of ConformancePackInputParameter objects.
public virtual object ConformancePackInputParameters { get; set; }
Property Value
System.Object
Remarks
ConformancePackName
Name of the conformance pack you want to create.
public virtual string ConformancePackName { get; set; }
Property Value
System.String
Remarks
DeliveryS3Bucket
The name of the Amazon S3 bucket where AWS Config stores conformance pack templates.
public virtual string DeliveryS3Bucket { get; set; }
Property Value
System.String
Remarks
DeliveryS3KeyPrefix
The prefix for the Amazon S3 bucket.
public virtual string DeliveryS3KeyPrefix { get; set; }
Property Value
System.String
Remarks
TemplateBody
A string containing full conformance pack template body.
public virtual string TemplateBody { get; set; }
Property Value
System.String
Remarks
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
).
TemplateS3Uri
Location of file containing the template body (s3://bucketname/prefix).
public virtual string TemplateS3Uri { get; set; }
Property Value
System.String
Remarks
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.
TemplateSsmDocumentDetails
AWS::Config::ConformancePack.TemplateSSMDocumentDetails
.
public virtual object TemplateSsmDocumentDetails { get; set; }
Property Value
System.Object
Remarks
Methods
Inspect(TreeInspector)
Examines the CloudFormation resource and discloses attributes.
public virtual void Inspect(TreeInspector inspector)
Parameters
- inspector TreeInspector
- tree inspector to collect and process attributes.
RenderProperties(IDictionary<String, Object>)
protected override IDictionary<string, object> RenderProperties(IDictionary<string, object> props)
Parameters
- props System.Collections.Generic.IDictionary<System.String, System.Object>
Returns
System.Collections.Generic.IDictionary<System.String, System.Object>