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"],
}

See Also:

Instance Attribute Summary collapse

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.

Returns:

  • (Array<String>) 


9601
9602
9603
9604
9605
9606
9607
 
# File 'lib/aws-sdk-ssm/types.rb', line 9601

class ModifyDocumentPermissionRequest < Struct.new(
  :name,
  :permission_type,
  :account_ids_to_add,
  :account_ids_to_remove)
  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.

Returns:

  • (Array<String>) 


9601
9602
9603
9604
9605
9606
9607
 
# File 'lib/aws-sdk-ssm/types.rb', line 9601

class ModifyDocumentPermissionRequest < Struct.new(
  :name,
  :permission_type,
  :account_ids_to_add,
  :account_ids_to_remove)
  include Aws::Structure
end

#name ⇒ String

The name of the document that you want to share.

Returns:

  • (String) 


9601
9602
9603
9604
9605
9606
9607
 
# File 'lib/aws-sdk-ssm/types.rb', line 9601

class ModifyDocumentPermissionRequest < Struct.new(
  :name,
  :permission_type,
  :account_ids_to_add,
  :account_ids_to_remove)
  include Aws::Structure
end

#permission_type ⇒ String

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

Returns:

  • (String) 


9601
9602
9603
9604
9605
9606
9607
 
# File 'lib/aws-sdk-ssm/types.rb', line 9601

class ModifyDocumentPermissionRequest < Struct.new(
  :name,
  :permission_type,
  :account_ids_to_add,
  :account_ids_to_remove)
  include Aws::Structure
end