Class: Aws::Mgn::Types::SsmDocument

Inherits:

Struct

• Object
• Struct
• Aws::Mgn::Types::SsmDocument

Defined in:

gems/aws-sdk-mgn/lib/aws-sdk-mgn/types.rb

Overview

AWS Systems Manager Document.

See Also:

• AWS API Documentation

Constant Summary

SENSITIVE =

[]

Instance Attribute Summary

• #action_name ⇒ String

  User-friendly name for the AWS Systems Manager Document.

• #external_parameters ⇒ Hash<String,Types::SsmExternalParameter>

  AWS Systems Manager Document external parameters.

• #must_succeed_for_cutover ⇒ Boolean

  If true, Cutover will not be enabled if the document has failed.

• #parameters ⇒ Hash<String,Array<Types::SsmParameterStoreParameter>>

  AWS Systems Manager Document parameters.

• #ssm_document_name ⇒ String

  AWS Systems Manager Document name or full ARN.

• #timeout_seconds ⇒ Integer

  AWS Systems Manager Document timeout seconds.

Instance Attribute Details

#action_name ⇒ String

User-friendly name for the AWS Systems Manager Document.

Returns:

• (String)

# File 'gems/aws-sdk-mgn/lib/aws-sdk-mgn/types.rb', line 6029

class SsmDocument < Struct.new(
  :action_name,
  :ssm_document_name,
  :timeout_seconds,
  :must_succeed_for_cutover,
  :parameters,
  :external_parameters)
  SENSITIVE = []
  include Aws::Structure
end

#external_parameters ⇒ Hash<String,Types::SsmExternalParameter>

AWS Systems Manager Document external parameters.

Returns:

• (Hash<String,Types::SsmExternalParameter>)

# File 'gems/aws-sdk-mgn/lib/aws-sdk-mgn/types.rb', line 6029

class SsmDocument < Struct.new(
  :action_name,
  :ssm_document_name,
  :timeout_seconds,
  :must_succeed_for_cutover,
  :parameters,
  :external_parameters)
  SENSITIVE = []
  include Aws::Structure
end

#must_succeed_for_cutover ⇒ Boolean

If true, Cutover will not be enabled if the document has failed.

Returns:

• (Boolean)

# File 'gems/aws-sdk-mgn/lib/aws-sdk-mgn/types.rb', line 6029

class SsmDocument < Struct.new(
  :action_name,
  :ssm_document_name,
  :timeout_seconds,
  :must_succeed_for_cutover,
  :parameters,
  :external_parameters)
  SENSITIVE = []
  include Aws::Structure
end

#parameters ⇒ Hash<String,Array<Types::SsmParameterStoreParameter>>

AWS Systems Manager Document parameters.

Returns:

• (Hash<String,Array<Types::SsmParameterStoreParameter>>)

# File 'gems/aws-sdk-mgn/lib/aws-sdk-mgn/types.rb', line 6029

class SsmDocument < Struct.new(
  :action_name,
  :ssm_document_name,
  :timeout_seconds,
  :must_succeed_for_cutover,
  :parameters,
  :external_parameters)
  SENSITIVE = []
  include Aws::Structure
end

#ssm_document_name ⇒ String

AWS Systems Manager Document name or full ARN.

Returns:

• (String)

# File 'gems/aws-sdk-mgn/lib/aws-sdk-mgn/types.rb', line 6029

class SsmDocument < Struct.new(
  :action_name,
  :ssm_document_name,
  :timeout_seconds,
  :must_succeed_for_cutover,
  :parameters,
  :external_parameters)
  SENSITIVE = []
  include Aws::Structure
end

#timeout_seconds ⇒ Integer

AWS Systems Manager Document timeout seconds.

Returns:

• (Integer)

# File 'gems/aws-sdk-mgn/lib/aws-sdk-mgn/types.rb', line 6029

class SsmDocument < Struct.new(
  :action_name,
  :ssm_document_name,
  :timeout_seconds,
  :must_succeed_for_cutover,
  :parameters,
  :external_parameters)
  SENSITIVE = []
  include Aws::Structure
end