Class: AWSCDK::Config::CfnConformancePackProps

Inherits:
Jsii::Struct
  • Object
show all
Defined in:
config/cfn_conformance_pack_props.rb

Overview

Properties for defining a CfnConformancePack.

See Also:

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(conformance_pack_name:, conformance_pack_input_parameters: nil, delivery_s3_bucket: nil, delivery_s3_key_prefix: nil, template_body: nil, template_s3_uri: nil, template_ssm_document_details: nil) ⇒ CfnConformancePackProps

Returns a new instance of CfnConformancePackProps.

Parameters:

  • conformance_pack_name (String) —

    Name of the conformance pack you want to create.

  • conformance_pack_input_parameters (AWSCDK::IResolvable, Array<AWSCDK::IResolvable, AWSCDK::Config::CfnConformancePack::ConformancePackInputParameterProperty>, nil) (defaults to: nil) —

    A list of ConformancePackInputParameter objects.

  • delivery_s3_bucket (String, AWSCDK::Interfaces::AWSS3::IBucketRef, nil) (defaults to: nil) —

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

  • delivery_s3_key_prefix (String, nil) (defaults to: nil) —

    The prefix for the Amazon S3 bucket.

  • template_body (String, nil) (defaults to: nil) —

    A string containing full conformance pack template body.

  • template_s3_uri (String, nil) (defaults to: nil) —

    Location of file containing the template body (s3://bucketname/prefix).

  • template_ssm_document_details (Object, nil) (defaults to: nil) —

    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.



16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
 
# File 'config/cfn_conformance_pack_props.rb', line 16

def initialize(conformance_pack_name:, conformance_pack_input_parameters: nil, delivery_s3_bucket: nil, delivery_s3_key_prefix: nil, template_body: nil, template_s3_uri: nil, template_ssm_document_details: nil)
  @conformance_pack_name = conformance_pack_name
  Jsii::Type.check_type(@conformance_pack_name, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "conformancePackName")
  @conformance_pack_input_parameters = conformance_pack_input_parameters
  Jsii::Type.check_type(@conformance_pack_input_parameters, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImNvbGxlY3Rpb24iOnsiZWxlbWVudHR5cGUiOnsidW5pb24iOnsidHlwZXMiOlt7ImZxbiI6ImF3cy1jZGstbGliLklSZXNvbHZhYmxlIn0seyJmcW4iOiJhd3MtY2RrLWxpYi5hd3NfY29uZmlnLkNmbkNvbmZvcm1hbmNlUGFjay5Db25mb3JtYW5jZVBhY2tJbnB1dFBhcmFtZXRlclByb3BlcnR5In1dfX0sImtpbmQiOiJhcnJheSJ9fV19fQ==")), "conformancePackInputParameters") unless @conformance_pack_input_parameters.nil?
  @delivery_s3_bucket = delivery_s3_bucket
  Jsii::Type.check_type(@delivery_s3_bucket, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3sicHJpbWl0aXZlIjoic3RyaW5nIn0seyJmcW4iOiJhd3MtY2RrLWxpYi5pbnRlcmZhY2VzLmF3c19zMy5JQnVja2V0UmVmIn1dfX0=")), "deliveryS3Bucket") unless @delivery_s3_bucket.nil?
  @delivery_s3_key_prefix = delivery_s3_key_prefix
  Jsii::Type.check_type(@delivery_s3_key_prefix, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "deliveryS3KeyPrefix") unless @delivery_s3_key_prefix.nil?
  @template_body = template_body
  Jsii::Type.check_type(@template_body, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "templateBody") unless @template_body.nil?
  @template_s3_uri = template_s3_uri
  Jsii::Type.check_type(@template_s3_uri, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "templateS3Uri") unless @template_s3_uri.nil?
  @template_ssm_document_details = template_ssm_document_details
  Jsii::Type.check_type(@template_ssm_document_details, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJhbnkifQ==")), "templateSsmDocumentDetails") unless @template_ssm_document_details.nil?
end

Instance Attribute Details

#conformance_pack_input_parameters ⇒ AWSCDK::IResolvable, ... (readonly)

A list of ConformancePackInputParameter objects.

Returns:

See Also:



42
43
44
 
# File 'config/cfn_conformance_pack_props.rb', line 42

def conformance_pack_input_parameters
  @conformance_pack_input_parameters
end

#conformance_pack_name ⇒ String (readonly)

Name of the conformance pack you want to create.

Returns:

  • (String)

See Also:



37
38
39
 
# File 'config/cfn_conformance_pack_props.rb', line 37

def conformance_pack_name
  @conformance_pack_name
end

#delivery_s3_bucket ⇒ String, ... (readonly)

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

Returns:

See Also:



47
48
49
 
# File 'config/cfn_conformance_pack_props.rb', line 47

def delivery_s3_bucket
  @delivery_s3_bucket
end

#delivery_s3_key_prefix ⇒ String? (readonly)

The prefix for the Amazon S3 bucket.

Returns:

  • (String, nil)

See Also:



52
53
54
 
# File 'config/cfn_conformance_pack_props.rb', line 52

def delivery_s3_key_prefix
  @delivery_s3_key_prefix
end

#template_body ⇒ String? (readonly)

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

Returns:

  • (String, nil)

See Also:



61
62
63
 
# File 'config/cfn_conformance_pack_props.rb', line 61

def template_body
  @template_body
end

#template_s3_uri ⇒ String? (readonly)

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.

Returns:

  • (String, nil)

See Also:



70
71
72
 
# File 'config/cfn_conformance_pack_props.rb', line 70

def template_s3_uri
  @template_s3_uri
end

#template_ssm_document_details ⇒ Object? (readonly)

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.

Returns:

  • (Object, nil)

See Also:



75
76
77
 
# File 'config/cfn_conformance_pack_props.rb', line 75

def template_ssm_document_details
  @template_ssm_document_details
end

Class Method Details

.jsii_properties ⇒ Object 



77
78
79
80
81
82
83
84
85
86
87
 
# File 'config/cfn_conformance_pack_props.rb', line 77

def self.jsii_properties
  {
    :conformance_pack_name => "conformancePackName",
    :conformance_pack_input_parameters => "conformancePackInputParameters",
    :delivery_s3_bucket => "deliveryS3Bucket",
    :delivery_s3_key_prefix => "deliveryS3KeyPrefix",
    :template_body => "templateBody",
    :template_s3_uri => "templateS3Uri",
    :template_ssm_document_details => "templateSsmDocumentDetails",
  }
end

Instance Method Details

#to_jsii ⇒ Object 



89
90
91
92
93
94
95
96
97
98
99
100
101
 
# File 'config/cfn_conformance_pack_props.rb', line 89

def to_jsii
  result = {}
  result.merge!({
    "conformancePackName" => @conformance_pack_name,
    "conformancePackInputParameters" => @conformance_pack_input_parameters,
    "deliveryS3Bucket" => @delivery_s3_bucket,
    "deliveryS3KeyPrefix" => @delivery_s3_key_prefix,
    "templateBody" => @template_body,
    "templateS3Uri" => @template_s3_uri,
    "templateSsmDocumentDetails" => @template_ssm_document_details,
  })
  result.compact
end