Class: AWSCDK::Config::CfnConformancePack::TemplateSSMDocumentDetailsProperty

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

Overview

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.

See Also:

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(document_name: nil, document_version: nil) ⇒ TemplateSSMDocumentDetailsProperty

Returns a new instance of TemplateSSMDocumentDetailsProperty.

Parameters:

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

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

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

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



622
623
624
625
626
627
 
# File 'config/cfn_conformance_pack.rb', line 622

def initialize(document_name: nil, document_version: nil)
  @document_name = document_name
  Jsii::Type.check_type(@document_name, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "documentName") unless @document_name.nil?
  @document_version = document_version
  Jsii::Type.check_type(@document_version, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "documentVersion") unless @document_version.nil?
end

Instance Attribute Details

#document_name ⇒ String? (readonly)

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.

Returns:

  • (String, nil)

See Also:



635
636
637
 
# File 'config/cfn_conformance_pack.rb', line 635

def document_name
  @document_name
end

#document_version ⇒ String? (readonly)

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

By default, AWS Config uses the latest version.

This field is optional.

Returns:

  • (String, nil)

See Also:



644
645
646
 
# File 'config/cfn_conformance_pack.rb', line 644

def document_version
  @document_version
end

Class Method Details

.jsii_properties ⇒ Object 



646
647
648
649
650
651
 
# File 'config/cfn_conformance_pack.rb', line 646

def self.jsii_properties
  {
    :document_name => "documentName",
    :document_version => "documentVersion",
  }
end

Instance Method Details

#to_jsii ⇒ Object 



653
654
655
656
657
658
659
660
 
# File 'config/cfn_conformance_pack.rb', line 653

def to_jsii
  result = {}
  result.merge!({
    "documentName" => @document_name,
    "documentVersion" => @document_version,
  })
  result.compact
end