Class: AWSCDK::SSM::CfnDocument::AttachmentsSourceProperty

Inherits:
Jsii::Struct
  • Object
show all
Defined in:
ssm/cfn_document.rb

Overview

Identifying information about a document attachment, including the file name and a key-value pair that identifies the location of an attachment to a document.

See Also:

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(key: nil, name: nil, values: nil) ⇒ AttachmentsSourceProperty

Returns a new instance of AttachmentsSourceProperty.

Parameters:

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

    The key of a key-value pair that identifies the location of an attachment to a document.

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

    The name of the document attachment file.

  • values (Array<String>, nil) (defaults to: nil) —

    The value of a key-value pair that identifies the location of an attachment to a document.



645
646
647
648
649
650
651
652
 
# File 'ssm/cfn_document.rb', line 645

def initialize(key: nil, name: nil, values: nil)
  @key = key
  Jsii::Type.check_type(@key, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "key") unless @key.nil?
  @name = name
  Jsii::Type.check_type(@name, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "name") unless @name.nil?
  @values = values
  Jsii::Type.check_type(@values, JSON.parse(Base64.strict_decode64("eyJjb2xsZWN0aW9uIjp7ImVsZW1lbnR0eXBlIjp7InByaW1pdGl2ZSI6InN0cmluZyJ9LCJraW5kIjoiYXJyYXkifX0=")), "values") unless @values.nil?
end

Instance Attribute Details

#key ⇒ String? (readonly)

The key of a key-value pair that identifies the location of an attachment to a document.

Returns:

  • (String, nil)

See Also:



658
659
660
 
# File 'ssm/cfn_document.rb', line 658

def key
  @key
end

#name ⇒ String? (readonly)

The name of the document attachment file.

Returns:

  • (String, nil)

See Also:



663
664
665
 
# File 'ssm/cfn_document.rb', line 663

def name
  @name
end

#values ⇒ Array<String>? (readonly)

The value of a key-value pair that identifies the location of an attachment to a document.

The format for Value depends on the type of key you specify.

  • For the key SourceUrl , the value is an S3 bucket location. For example:

"Values": [ "s3://amzn-s3-demo-bucket/my-prefix" ]

  • For the key S3FileUrl , the value is a file in an S3 bucket. For example:

"Values": [ "s3://amzn-s3-demo-bucket/my-prefix/my-file.py" ]

  • For the key AttachmentReference , the value is constructed from the name of another SSM document in your account, a version number of that document, and a file attached to that document version that you want to reuse. For example:

"Values": [ "MyOtherDocument/3/my-other-file.py" ]

However, if the SSM document is shared with you from another account, the full SSM document ARN must be specified instead of the document name only. For example:

"Values": [ "arn:aws:ssm:us-east-2:111122223333:document/OtherAccountDocument/3/their-file.py" ]

Returns:

  • (Array<String>, nil)

See Also:



686
687
688
 
# File 'ssm/cfn_document.rb', line 686

def values
  @values
end

Class Method Details

.jsii_properties ⇒ Object 



688
689
690
691
692
693
694
 
# File 'ssm/cfn_document.rb', line 688

def self.jsii_properties
  {
    :key => "key",
    :name => "name",
    :values => "values",
  }
end

Instance Method Details

#to_jsii ⇒ Object 



696
697
698
699
700
701
702
703
704
 
# File 'ssm/cfn_document.rb', line 696

def to_jsii
  result = {}
  result.merge!({
    "key" => @key,
    "name" => @name,
    "values" => @values,
  })
  result.compact
end