software.amazon.awssdk.services.ssm.model

Class ModifyDocumentPermissionRequest

java.lang.Object

software.amazon.awssdk.core.SdkRequest

software.amazon.awssdk.awscore.AwsRequest

software.amazon.awssdk.services.ssm.model.SsmRequest

software.amazon.awssdk.services.ssm.model.ModifyDocumentPermissionRequest

All Implemented Interfaces:

SdkPojo, ToCopyableBuilder<ModifyDocumentPermissionRequest.Builder,ModifyDocumentPermissionRequest>

@Generated(value="software.amazon.awssdk:codegen")
public final class ModifyDocumentPermissionRequest
extends SsmRequest
implements ToCopyableBuilder<ModifyDocumentPermissionRequest.Builder,ModifyDocumentPermissionRequest>

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	ModifyDocumentPermissionRequest.Builder

Method Summary

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)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
boolean	hasAccountIdsToAdd() Returns true if the AccountIdsToAdd property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty).
boolean	hasAccountIdsToRemove() Returns true if the AccountIdsToRemove property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty).
int	hashCode()
String	name() The name of the document that you want to share.
DocumentPermissionType	permissionType() The permission type for the document.
String	permissionTypeAsString() The permission type for the document.
List<SdkField<?>>	sdkFields()
static Class<? extends ModifyDocumentPermissionRequest.Builder>	serializableBuilderClass()
String	sharedDocumentVersion() (Optional) The version of the document to share.
ModifyDocumentPermissionRequest.Builder	toBuilder()
String	toString() Returns a string representation of this object.

Methods inherited from class software.amazon.awssdk.awscore.AwsRequest

overrideConfiguration

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder

copy

Method Detail

name

public String name()

The name of the document that you want to share.

Returns:

The name of the document that you want to share.

permissionType

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 permissionTypeAsString().

Returns:

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

See Also:

DocumentPermissionType

permissionTypeAsString

public String permissionTypeAsString()

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 permissionTypeAsString().

Returns:

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

See Also:

DocumentPermissionType

hasAccountIdsToAdd

public boolean hasAccountIdsToAdd()

Returns true if the AccountIdsToAdd property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty). For responses returned by the SDK, the sender is the AWS service.

accountIdsToAdd

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.

You can use hasAccountIdsToAdd() to see if a value was sent in this field.

Returns:

The AWS user accounts that should have access to the document. The account IDs can either be a group of account IDs or All.

hasAccountIdsToRemove

public boolean hasAccountIdsToRemove()

Returns true if the AccountIdsToRemove property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty). For responses returned by the SDK, the sender is the AWS service.

accountIdsToRemove

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.

You can use hasAccountIdsToRemove() to see if a value was sent in this field.

Returns:

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.

sharedDocumentVersion

public String sharedDocumentVersion()

(Optional) The version of the document to share. If it's not specified, the system choose the Default version to share.

Returns:

(Optional) The version of the document to share. If it's not specified, the system choose the Default version to share.

toBuilder

public ModifyDocumentPermissionRequest.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<ModifyDocumentPermissionRequest.Builder,ModifyDocumentPermissionRequest>

Specified by:

toBuilder in class SsmRequest

builder

public static ModifyDocumentPermissionRequest.Builder builder()

serializableBuilderClass

public static Class<? extends ModifyDocumentPermissionRequest.Builder> serializableBuilderClass()

hashCode

public int hashCode()

Overrides:

hashCode in class AwsRequest

equals

public boolean equals(Object obj)

Overrides:

equals in class AwsRequest

equalsBySdkFields

public boolean equalsBySdkFields(Object obj)

Specified by:

equalsBySdkFields in interface SdkPojo

toString

public String toString()

Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value.

Overrides:

toString in class Object

getValueForField

public <T> Optional<T> getValueForField(String fieldName,
                                        Class<T> clazz)

Overrides:

getValueForField in class SdkRequest

sdkFields

public List<SdkField<?>> sdkFields()

Specified by:

sdkFields in interface SdkPojo