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

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

Overview

Note:

When making an API call, you may pass ModifyDocumentPermissionRequest data as a hash:

{
  name: "DocumentName", # required
  permission_type: "Share", # required, accepts Share
  account_ids_to_add: ["AccountId"],
  account_ids_to_remove: ["AccountId"],
  shared_document_version: "SharedDocumentVersion",
}

Constant Summary collapse

SENSITIVE =
[]

Instance Attribute Summary collapse

Instance Attribute Details

#account_ids_to_addArray<String>

The Amazon Web Services user accounts that should have access to the document. The account IDs can either be a group of account IDs or All.

Returns:

  • (Array<String>)

13802
13803
13804
13805
13806
13807
13808
13809
13810
# File 'lib/aws-sdk-ssm/types.rb', line 13802

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_removeArray<String>

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

Returns:

  • (Array<String>)

13802
13803
13804
13805
13806
13807
13808
13809
13810
# File 'lib/aws-sdk-ssm/types.rb', line 13802

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

#nameString

The name of the document that you want to share.

Returns:

  • (String)

13802
13803
13804
13805
13806
13807
13808
13809
13810
# File 'lib/aws-sdk-ssm/types.rb', line 13802

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

#permission_typeString

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

Returns:

  • (String)

13802
13803
13804
13805
13806
13807
13808
13809
13810
# File 'lib/aws-sdk-ssm/types.rb', line 13802

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_versionString

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

Returns:

  • (String)

13802
13803
13804
13805
13806
13807
13808
13809
13810
# File 'lib/aws-sdk-ssm/types.rb', line 13802

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