Class: Aws::ARCRegionswitch::Types::SsmDocumentConfig

Inherits:
Struct
  • Object
show all
Defined in:
gems/aws-sdk-arcregionswitch/lib/aws-sdk-arcregionswitch/types.rb

Overview

The Systems Manager document to run and the managed nodes to target for a single Amazon Web Services Region.

See Also:

Constant Summary collapse

SENSITIVE = 
[]

Instance Attribute Summary collapse

Instance Attribute Details

#cross_account_role ⇒ String

The cross-account role for the configuration.

Returns:

  • (String) 


2779
2780
2781
2782
2783
2784
2785
2786
2787
2788
 
# File 'gems/aws-sdk-arcregionswitch/lib/aws-sdk-arcregionswitch/types.rb', line 2779

class SsmDocumentConfig < Struct.new(
  :cross_account_role,
  :external_id,
  :document_arn,
  :targets,
  :parameters,
  :document_version)
  SENSITIVE = []
  include Aws::Structure
end

#document_arn ⇒ String

The Amazon Resource Name (ARN) of the Systems Manager document to run.

Returns:

  • (String) 


2779
2780
2781
2782
2783
2784
2785
2786
2787
2788
 
# File 'gems/aws-sdk-arcregionswitch/lib/aws-sdk-arcregionswitch/types.rb', line 2779

class SsmDocumentConfig < Struct.new(
  :cross_account_role,
  :external_id,
  :document_arn,
  :targets,
  :parameters,
  :document_version)
  SENSITIVE = []
  include Aws::Structure
end

#document_version ⇒ String

The version of the Systems Manager document to run for this Region. When you omit it, Systems Manager runs the document's default version.

Returns:

  • (String) 


2779
2780
2781
2782
2783
2784
2785
2786
2787
2788
 
# File 'gems/aws-sdk-arcregionswitch/lib/aws-sdk-arcregionswitch/types.rb', line 2779

class SsmDocumentConfig < Struct.new(
  :cross_account_role,
  :external_id,
  :document_arn,
  :targets,
  :parameters,
  :document_version)
  SENSITIVE = []
  include Aws::Structure
end

#external_id ⇒ String

The external ID (secret key) for the configuration.

Returns:

  • (String) 


2779
2780
2781
2782
2783
2784
2785
2786
2787
2788
 
# File 'gems/aws-sdk-arcregionswitch/lib/aws-sdk-arcregionswitch/types.rb', line 2779

class SsmDocumentConfig < Struct.new(
  :cross_account_role,
  :external_id,
  :document_arn,
  :targets,
  :parameters,
  :document_version)
  SENSITIVE = []
  include Aws::Structure
end

#parameters ⇒ Hash<String,Array<String>>

The parameters that are passed to this Region's Systems Manager document. You set parameters for each document, so each Region can run its document with its own parameters.

Returns:

  • (Hash<String,Array<String>>) 


2779
2780
2781
2782
2783
2784
2785
2786
2787
2788
 
# File 'gems/aws-sdk-arcregionswitch/lib/aws-sdk-arcregionswitch/types.rb', line 2779

class SsmDocumentConfig < Struct.new(
  :cross_account_role,
  :external_id,
  :document_arn,
  :targets,
  :parameters,
  :document_version)
  SENSITIVE = []
  include Aws::Structure
end

#targets ⇒ Array<Types::SsmTarget>

The target filters that Systems Manager resolves to managed nodes when the command runs. To target specific managed nodes, use the InstanceIds key. You can specify up to five target filters.

Returns:



2779
2780
2781
2782
2783
2784
2785
2786
2787
2788
 
# File 'gems/aws-sdk-arcregionswitch/lib/aws-sdk-arcregionswitch/types.rb', line 2779

class SsmDocumentConfig < Struct.new(
  :cross_account_role,
  :external_id,
  :document_arn,
  :targets,
  :parameters,
  :document_version)
  SENSITIVE = []
  include Aws::Structure
end