Class: AWSCDK::SSM::CfnDocument::DocumentRequiresProperty

Inherits:

Jsii::Struct

• Object
• Jsii::Struct
• AWSCDK::SSM::CfnDocument::DocumentRequiresProperty

Defined in:

ssm/cfn_document.rb

Overview

An SSM document required by the current document.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ssm-document-documentrequires.html

Instance Attribute Summary

• #name ⇒ String^? readonly

  The name of the required SSM document.

• #version ⇒ String^? readonly

  The document version required by the current document.

Class Method Summary

• .jsii_properties ⇒ Object

Instance Method Summary

• #initialize(name: nil, version: nil) ⇒ DocumentRequiresProperty constructor

  A new instance of DocumentRequiresProperty.

• #to_jsii ⇒ Object

Constructor Details

#initialize(name: nil, version: nil) ⇒ DocumentRequiresProperty

Returns a new instance of DocumentRequiresProperty.

Parameters:

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

  The name of the required SSM document.

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

  The document version required by the current document.

# File 'ssm/cfn_document.rb', line 715

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

Instance Attribute Details

#name ⇒ String^? (readonly)

The name of the required SSM document.

The name can be an Amazon Resource Name (ARN).

Returns:

• (String, nil)

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ssm-document-documentrequires.html#cfn-ssm-document-documentrequires-name

# File 'ssm/cfn_document.rb', line 728

def name
  @name
end

#version ⇒ String^? (readonly)

The document version required by the current document.

Returns:

• (String, nil)

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ssm-document-documentrequires.html#cfn-ssm-document-documentrequires-version

# File 'ssm/cfn_document.rb', line 733

def version
  @version
end

Class Method Details

.jsii_properties ⇒ Object

# File 'ssm/cfn_document.rb', line 735

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

Instance Method Details

#to_jsii ⇒ Object

# File 'ssm/cfn_document.rb', line 742

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