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

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

Overview

Describes the name of a SSM document.

Constant Summary collapse

SENSITIVE =
[]

Instance Attribute Summary collapse

Instance Attribute Details

#authorString

The user in your organization who created the document.

Returns:

  • (String)

7384
7385
7386
7387
7388
7389
7390
7391
7392
7393
7394
7395
7396
7397
7398
7399
7400
7401
7402
# File 'lib/aws-sdk-ssm/types.rb', line 7384

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

#created_dateTime

The date the SSM document was created.

Returns:

  • (Time)

7384
7385
7386
7387
7388
7389
7390
7391
7392
7393
7394
7395
7396
7397
7398
7399
7400
7401
7402
# File 'lib/aws-sdk-ssm/types.rb', line 7384

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

#display_nameString

An optional field where you can specify a friendly name for the SSM document. This value can differ for each version of the document. If you want to update this value, see UpdateDocument.

Returns:

  • (String)

7384
7385
7386
7387
7388
7389
7390
7391
7392
7393
7394
7395
7396
7397
7398
7399
7400
7401
7402
# File 'lib/aws-sdk-ssm/types.rb', line 7384

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

#document_formatString

The document format, either JSON or YAML.

Returns:

  • (String)

7384
7385
7386
7387
7388
7389
7390
7391
7392
7393
7394
7395
7396
7397
7398
7399
7400
7401
7402
# File 'lib/aws-sdk-ssm/types.rb', line 7384

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

#document_typeString

The document type.

Returns:

  • (String)

7384
7385
7386
7387
7388
7389
7390
7391
7392
7393
7394
7395
7396
7397
7398
7399
7400
7401
7402
# File 'lib/aws-sdk-ssm/types.rb', line 7384

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

#document_versionString

The document version.

Returns:

  • (String)

7384
7385
7386
7387
7388
7389
7390
7391
7392
7393
7394
7395
7396
7397
7398
7399
7400
7401
7402
# File 'lib/aws-sdk-ssm/types.rb', line 7384

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

#nameString

The name of the SSM document.

Returns:

  • (String)

7384
7385
7386
7387
7388
7389
7390
7391
7392
7393
7394
7395
7396
7397
7398
7399
7400
7401
7402
# File 'lib/aws-sdk-ssm/types.rb', line 7384

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

#ownerString

The Amazon Web Services user account that created the document.

Returns:

  • (String)

7384
7385
7386
7387
7388
7389
7390
7391
7392
7393
7394
7395
7396
7397
7398
7399
7400
7401
7402
# File 'lib/aws-sdk-ssm/types.rb', line 7384

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

#platform_typesArray<String>

The operating system platform.

Returns:

  • (Array<String>)

7384
7385
7386
7387
7388
7389
7390
7391
7392
7393
7394
7395
7396
7397
7398
7399
7400
7401
7402
# File 'lib/aws-sdk-ssm/types.rb', line 7384

class DocumentIdentifier < Struct.new(
  :name,
  :created_date,
  :display_name,
  :owner,
  :version_name,
  :platform_types,
  :document_version,
  :document_type,
  :schema_version,
  :document_format,
  :target_type,
  :tags,
  :requires,
  :review_status,
  :author)
  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:


7384
7385
7386
7387
7388
7389
7390
7391
7392
7393
7394
7395
7396
7397
7398
7399
7400
7401
7402
# File 'lib/aws-sdk-ssm/types.rb', line 7384

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

#review_statusString

The current status of a document review.

Returns:

  • (String)

7384
7385
7386
7387
7388
7389
7390
7391
7392
7393
7394
7395
7396
7397
7398
7399
7400
7401
7402
# File 'lib/aws-sdk-ssm/types.rb', line 7384

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

#schema_versionString

The schema version.

Returns:

  • (String)

7384
7385
7386
7387
7388
7389
7390
7391
7392
7393
7394
7395
7396
7397
7398
7399
7400
7401
7402
# File 'lib/aws-sdk-ssm/types.rb', line 7384

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

#tagsArray<Types::Tag>

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

Returns:


7384
7385
7386
7387
7388
7389
7390
7391
7392
7393
7394
7395
7396
7397
7398
7399
7400
7401
7402
# File 'lib/aws-sdk-ssm/types.rb', line 7384

class DocumentIdentifier < Struct.new(
  :name,
  :created_date,
  :display_name,
  :owner,
  :version_name,
  :platform_types,
  :document_version,
  :document_type,
  :schema_version,
  :document_format,
  :target_type,
  :tags,
  :requires,
  :review_status,
  :author)
  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 [Amazon Web Services resource and property types reference] in the *CloudFormation User Guide*.

[1]: docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-template-resource-type-ref.html

Returns:

  • (String)

7384
7385
7386
7387
7388
7389
7390
7391
7392
7393
7394
7395
7396
7397
7398
7399
7400
7401
7402
# File 'lib/aws-sdk-ssm/types.rb', line 7384

class DocumentIdentifier < Struct.new(
  :name,
  :created_date,
  :display_name,
  :owner,
  :version_name,
  :platform_types,
  :document_version,
  :document_type,
  :schema_version,
  :document_format,
  :target_type,
  :tags,
  :requires,
  :review_status,
  :author)
  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 can't be changed.

Returns:

  • (String)

7384
7385
7386
7387
7388
7389
7390
7391
7392
7393
7394
7395
7396
7397
7398
7399
7400
7401
7402
# File 'lib/aws-sdk-ssm/types.rb', line 7384

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