Class: Aws::SSM::Types::ModifyDocumentPermissionRequest

Inherits:

Struct

• Object
• Struct
• Aws::SSM::Types::ModifyDocumentPermissionRequest

Includes:

Aws::Structure

Defined in:

lib/aws-sdk-ssm/types.rb

Overview

See Also:

• AWS API Documentation

Constant Summary

SENSITIVE =

[]

Instance Attribute Summary

• #account_ids_to_add ⇒ Array<String>

  The Amazon Web Services users that should have access to the document.

• #account_ids_to_remove ⇒ Array<String>

  The Amazon Web Services users that should no longer have access to the document.

• #name ⇒ String

  The name of the document that you want to share.

• #permission_type ⇒ String

  The permission type for the document.

• #shared_document_version ⇒ String

  (Optional) The version of the document to share.

Instance Attribute Details

#account_ids_to_add ⇒ Array<String>

The Amazon Web Services users that should have access to the document. The account IDs can either be a group of account IDs or All. You must specify a value for this parameter or the ‘AccountIdsToRemove` parameter.

Returns:

• (Array<String>)

# File 'lib/aws-sdk-ssm/types.rb', line 13540

class ModifyDocumentPermissionRequest < Struct.new(
  :name,
  :permission_type,
  :account_ids_to_add,
  :account_ids_to_remove,
  :shared_document_version)
  SENSITIVE = []
  include Aws::Structure
end

#account_ids_to_remove ⇒ Array<String>

The Amazon Web Services users that should no longer have access to the document. The Amazon Web Services user can either be a group of account IDs or All. This action has a higher priority than ‘AccountIdsToAdd`. If you specify an ID to add and the same ID to remove, the system removes access to the document. You must specify a value for this parameter or the `AccountIdsToAdd` parameter.

Returns:

• (Array<String>)

# File 'lib/aws-sdk-ssm/types.rb', line 13540

class ModifyDocumentPermissionRequest < Struct.new(
  :name,
  :permission_type,
  :account_ids_to_add,
  :account_ids_to_remove,
  :shared_document_version)
  SENSITIVE = []
  include Aws::Structure
end

#name ⇒ String

The name of the document that you want to share.

Returns:

• (String)

# File 'lib/aws-sdk-ssm/types.rb', line 13540

class ModifyDocumentPermissionRequest < Struct.new(
  :name,
  :permission_type,
  :account_ids_to_add,
  :account_ids_to_remove,
  :shared_document_version)
  SENSITIVE = []
  include Aws::Structure
end

#permission_type ⇒ String

The permission type for the document. The permission type can be Share.

Returns:

• (String)

# File 'lib/aws-sdk-ssm/types.rb', line 13540

class ModifyDocumentPermissionRequest < Struct.new(
  :name,
  :permission_type,
  :account_ids_to_add,
  :account_ids_to_remove,
  :shared_document_version)
  SENSITIVE = []
  include Aws::Structure
end

#shared_document_version ⇒ String

(Optional) The version of the document to share. If it isn’t specified, the system choose the ‘Default` version to share.

Returns:

• (String)

# File 'lib/aws-sdk-ssm/types.rb', line 13540

class ModifyDocumentPermissionRequest < Struct.new(
  :name,
  :permission_type,
  :account_ids_to_add,
  :account_ids_to_remove,
  :shared_document_version)
  SENSITIVE = []
  include Aws::Structure
end