You are viewing documentation for version 3 of the AWS SDK for Ruby. Version 2 documentation can be found here.

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

Inherits:
Struct
  • Object
show all
Defined in:
gems/aws-sdk-ssm/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"],
}

Instance Attribute Summary collapse

Instance Attribute Details

#account_ids_to_addArray<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>)


7692
7693
7694
7695
7696
7697
7698
# File 'gems/aws-sdk-ssm/lib/aws-sdk-ssm/types.rb', line 7692

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

#account_ids_to_removeArray<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>)


7692
7693
7694
7695
7696
7697
7698
# File 'gems/aws-sdk-ssm/lib/aws-sdk-ssm/types.rb', line 7692

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

#nameString

The name of the document that you want to share.

Returns:

  • (String)


7692
7693
7694
7695
7696
7697
7698
# File 'gems/aws-sdk-ssm/lib/aws-sdk-ssm/types.rb', line 7692

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

#permission_typeString

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

Returns:

  • (String)


7692
7693
7694
7695
7696
7697
7698
# File 'gems/aws-sdk-ssm/lib/aws-sdk-ssm/types.rb', line 7692

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