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
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",
}
Instance Attribute Summary collapse
-
#account_ids_to_add ⇒ Array<String>
The AWS user accounts that should have access to the document.
-
#account_ids_to_remove ⇒ Array<String>
The AWS user accounts 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 AWS user accounts that should have access to the document. The account IDs can either be a group of account IDs or All.
11387 11388 11389 11390 11391 11392 11393 11394 |
# File 'lib/aws-sdk-ssm/types.rb', line 11387 class ModifyDocumentPermissionRequest < Struct.new( :name, :permission_type, :account_ids_to_add, :account_ids_to_remove, :shared_document_version) include Aws::Structure end |
#account_ids_to_remove ⇒ Array<String>
The AWS user accounts that should no longer have access to the document. The AWS 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.
11387 11388 11389 11390 11391 11392 11393 11394 |
# File 'lib/aws-sdk-ssm/types.rb', line 11387 class ModifyDocumentPermissionRequest < Struct.new( :name, :permission_type, :account_ids_to_add, :account_ids_to_remove, :shared_document_version) include Aws::Structure end |
#name ⇒ String
The name of the document that you want to share.
11387 11388 11389 11390 11391 11392 11393 11394 |
# File 'lib/aws-sdk-ssm/types.rb', line 11387 class ModifyDocumentPermissionRequest < Struct.new( :name, :permission_type, :account_ids_to_add, :account_ids_to_remove, :shared_document_version) include Aws::Structure end |
#permission_type ⇒ String
The permission type for the document. The permission type can be Share.
11387 11388 11389 11390 11391 11392 11393 11394 |
# File 'lib/aws-sdk-ssm/types.rb', line 11387 class ModifyDocumentPermissionRequest < Struct.new( :name, :permission_type, :account_ids_to_add, :account_ids_to_remove, :shared_document_version) include Aws::Structure end |
#shared_document_version ⇒ String
(Optional) The version of the document to share. If it’s not specified, the system choose the ‘Default` version to share.
11387 11388 11389 11390 11391 11392 11393 11394 |
# File 'lib/aws-sdk-ssm/types.rb', line 11387 class ModifyDocumentPermissionRequest < Struct.new( :name, :permission_type, :account_ids_to_add, :account_ids_to_remove, :shared_document_version) include Aws::Structure end |