Class: Aws::SSM::Types::DocumentIdentifier

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

Overview

Describes the name of a Systems Manager document.

Constant Summary collapse

SENSITIVE =
[]

Instance Attribute Summary collapse

Instance Attribute Details

#document_formatString

The document format, either JSON or YAML.

Returns:

  • (String)


6497
6498
6499
6500
6501
6502
6503
6504
6505
6506
6507
6508
6509
6510
6511
# File 'gems/aws-sdk-ssm/lib/aws-sdk-ssm/types.rb', line 6497

class DocumentIdentifier < Struct.new(
  :name,
  :owner,
  :version_name,
  :platform_types,
  :document_version,
  :document_type,
  :schema_version,
  :document_format,
  :target_type,
  :tags,
  :requires)
  SENSITIVE = []
  include Aws::Structure
end

#document_typeString

The document type.

Returns:

  • (String)


6497
6498
6499
6500
6501
6502
6503
6504
6505
6506
6507
6508
6509
6510
6511
# File 'gems/aws-sdk-ssm/lib/aws-sdk-ssm/types.rb', line 6497

class DocumentIdentifier < Struct.new(
  :name,
  :owner,
  :version_name,
  :platform_types,
  :document_version,
  :document_type,
  :schema_version,
  :document_format,
  :target_type,
  :tags,
  :requires)
  SENSITIVE = []
  include Aws::Structure
end

#document_versionString

The document version.

Returns:

  • (String)


6497
6498
6499
6500
6501
6502
6503
6504
6505
6506
6507
6508
6509
6510
6511
# File 'gems/aws-sdk-ssm/lib/aws-sdk-ssm/types.rb', line 6497

class DocumentIdentifier < Struct.new(
  :name,
  :owner,
  :version_name,
  :platform_types,
  :document_version,
  :document_type,
  :schema_version,
  :document_format,
  :target_type,
  :tags,
  :requires)
  SENSITIVE = []
  include Aws::Structure
end

#nameString

The name of the Systems Manager document.

Returns:

  • (String)


6497
6498
6499
6500
6501
6502
6503
6504
6505
6506
6507
6508
6509
6510
6511
# File 'gems/aws-sdk-ssm/lib/aws-sdk-ssm/types.rb', line 6497

class DocumentIdentifier < Struct.new(
  :name,
  :owner,
  :version_name,
  :platform_types,
  :document_version,
  :document_type,
  :schema_version,
  :document_format,
  :target_type,
  :tags,
  :requires)
  SENSITIVE = []
  include Aws::Structure
end

#ownerString

The AWS user account that created the document.

Returns:

  • (String)


6497
6498
6499
6500
6501
6502
6503
6504
6505
6506
6507
6508
6509
6510
6511
# File 'gems/aws-sdk-ssm/lib/aws-sdk-ssm/types.rb', line 6497

class DocumentIdentifier < Struct.new(
  :name,
  :owner,
  :version_name,
  :platform_types,
  :document_version,
  :document_type,
  :schema_version,
  :document_format,
  :target_type,
  :tags,
  :requires)
  SENSITIVE = []
  include Aws::Structure
end

#platform_typesArray<String>

The operating system platform.

Returns:

  • (Array<String>)


6497
6498
6499
6500
6501
6502
6503
6504
6505
6506
6507
6508
6509
6510
6511
# File 'gems/aws-sdk-ssm/lib/aws-sdk-ssm/types.rb', line 6497

class DocumentIdentifier < Struct.new(
  :name,
  :owner,
  :version_name,
  :platform_types,
  :document_version,
  :document_type,
  :schema_version,
  :document_format,
  :target_type,
  :tags,
  :requires)
  SENSITIVE = []
  include Aws::Structure
end

#requiresArray<Types::DocumentRequires>

A list of SSM documents required by a document. For example, an ApplicationConfiguration document requires an ApplicationConfigurationSchema document.

Returns:



6497
6498
6499
6500
6501
6502
6503
6504
6505
6506
6507
6508
6509
6510
6511
# File 'gems/aws-sdk-ssm/lib/aws-sdk-ssm/types.rb', line 6497

class DocumentIdentifier < Struct.new(
  :name,
  :owner,
  :version_name,
  :platform_types,
  :document_version,
  :document_type,
  :schema_version,
  :document_format,
  :target_type,
  :tags,
  :requires)
  SENSITIVE = []
  include Aws::Structure
end

#schema_versionString

The schema version.

Returns:

  • (String)


6497
6498
6499
6500
6501
6502
6503
6504
6505
6506
6507
6508
6509
6510
6511
# File 'gems/aws-sdk-ssm/lib/aws-sdk-ssm/types.rb', line 6497

class DocumentIdentifier < Struct.new(
  :name,
  :owner,
  :version_name,
  :platform_types,
  :document_version,
  :document_type,
  :schema_version,
  :document_format,
  :target_type,
  :tags,
  :requires)
  SENSITIVE = []
  include Aws::Structure
end

#tagsArray<Types::Tag>

The tags, or metadata, that have been applied to the document.

Returns:



6497
6498
6499
6500
6501
6502
6503
6504
6505
6506
6507
6508
6509
6510
6511
# File 'gems/aws-sdk-ssm/lib/aws-sdk-ssm/types.rb', line 6497

class DocumentIdentifier < Struct.new(
  :name,
  :owner,
  :version_name,
  :platform_types,
  :document_version,
  :document_type,
  :schema_version,
  :document_format,
  :target_type,
  :tags,
  :requires)
  SENSITIVE = []
  include Aws::Structure
end

#target_typeString

The target type which defines the kinds of resources the document can run on. For example, /AWS::EC2::Instance. For a list of valid resource types, see AWS resource and property types reference in the AWS CloudFormation User Guide.

Returns:

  • (String)


6497
6498
6499
6500
6501
6502
6503
6504
6505
6506
6507
6508
6509
6510
6511
# File 'gems/aws-sdk-ssm/lib/aws-sdk-ssm/types.rb', line 6497

class DocumentIdentifier < Struct.new(
  :name,
  :owner,
  :version_name,
  :platform_types,
  :document_version,
  :document_type,
  :schema_version,
  :document_format,
  :target_type,
  :tags,
  :requires)
  SENSITIVE = []
  include Aws::Structure
end

#version_nameString

An optional field specifying the version of the artifact associated with the document. For example, "Release 12, Update 6". This value is unique across all versions of a document, and cannot be changed.

Returns:

  • (String)


6497
6498
6499
6500
6501
6502
6503
6504
6505
6506
6507
6508
6509
6510
6511
# File 'gems/aws-sdk-ssm/lib/aws-sdk-ssm/types.rb', line 6497

class DocumentIdentifier < Struct.new(
  :name,
  :owner,
  :version_name,
  :platform_types,
  :document_version,
  :document_type,
  :schema_version,
  :document_format,
  :target_type,
  :tags,
  :requires)
  SENSITIVE = []
  include Aws::Structure
end