@Generated(value="software.amazon.awssdk:codegen") public class ModifyDocumentPermissionRequest extends SSMRequest implements ToCopyableBuilder<ModifyDocumentPermissionRequest.Builder,ModifyDocumentPermissionRequest>
Modifier and Type | Class and Description |
---|---|
static interface |
ModifyDocumentPermissionRequest.Builder |
Modifier and Type | Method and Description |
---|---|
List<String> |
accountIdsToAdd()
The AWS user accounts that should have access to the document.
|
List<String> |
accountIdsToRemove()
The AWS user accounts that should no longer have access to the document.
|
static ModifyDocumentPermissionRequest.Builder |
builder() |
boolean |
equals(Object obj) |
<T> Optional<T> |
getValueForField(String fieldName,
Class<T> clazz)
Used to retrieve the value of a field from any class that extends
SdkRequest . |
int |
hashCode() |
String |
name()
The name of the document that you want to share.
|
DocumentPermissionType |
permissionType()
The permission type for the document.
|
String |
permissionTypeString()
The permission type for the document.
|
static Class<? extends ModifyDocumentPermissionRequest.Builder> |
serializableBuilderClass() |
ModifyDocumentPermissionRequest.Builder |
toBuilder()
Take this object and create a builder that contains all of the current property values of this object.
|
String |
toString() |
requestOverrideConfig
copy
public String name()
The name of the document that you want to share.
public DocumentPermissionType permissionType()
The permission type for the document. The permission type can be Share.
If the service returns an enum value that is not available in the current SDK version, permissionType
will return DocumentPermissionType.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is
available from permissionTypeString()
.
DocumentPermissionType
public String permissionTypeString()
The permission type for the document. The permission type can be Share.
If the service returns an enum value that is not available in the current SDK version, permissionType
will return DocumentPermissionType.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is
available from permissionTypeString()
.
DocumentPermissionType
public List<String> accountIdsToAdd()
The AWS user accounts that should have access to the document. The account IDs can either be a group of account IDs or All.
Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
public List<String> accountIdsToRemove()
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.
Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
public ModifyDocumentPermissionRequest.Builder toBuilder()
ToCopyableBuilder
toBuilder
in interface ToCopyableBuilder<ModifyDocumentPermissionRequest.Builder,ModifyDocumentPermissionRequest>
toBuilder
in class SSMRequest
public static ModifyDocumentPermissionRequest.Builder builder()
public static Class<? extends ModifyDocumentPermissionRequest.Builder> serializableBuilderClass()
public <T> Optional<T> getValueForField(String fieldName, Class<T> clazz)
SdkRequest
SdkRequest
. The field name
specified should match the member name from the corresponding service-2.json model specified in the
codegen-resources folder for a given service. The class specifies what class to cast the returned value to.
If the returned value is also a modeled class, the SdkRequest.getValueForField(String, Class)
method will
again be available.getValueForField
in class SdkRequest
fieldName
- The name of the member to be retrieved.clazz
- The class to cast the returned object to.Copyright © 2017 Amazon Web Services, Inc. All Rights Reserved.