You are viewing documentation for version 2 of the AWS SDK for Ruby. Version 3 documentation can be found here.
Class: Aws::SSM::Types::ModifyDocumentPermissionRequest
- Inherits:
-
Struct
- Object
- Struct
- Aws::SSM::Types::ModifyDocumentPermissionRequest
- Defined in:
- (unknown)
Overview
When passing ModifyDocumentPermissionRequest as input to an Aws::Client method, you can use a vanilla 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.
#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.
#name ⇒ String
The name of the document that you want to share.
#permission_type ⇒ String
The permission type for the document. The permission type can be Share.
Possible values:
- Share
#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.