Package 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("software.amazon.awssdk:codegen")
public final class ModifyDocumentPermissionRequest
extends SsmRequest
implements ToCopyableBuilder<ModifyDocumentPermissionRequest.Builder,ModifyDocumentPermissionRequest>

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	ModifyDocumentPermissionRequest.Builder

Method Summary

Modifier and Type	Method	Description
List<String>	accountIdsToAdd()	The Amazon Web Services users that should have access to the document.
List<String>	accountIdsToRemove()	The Amazon Web Services users 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()	For responses, this returns true if the service returned a value for the AccountIdsToAdd property.
boolean	hasAccountIdsToRemove()	For responses, this returns true if the service returned a value for the AccountIdsToRemove property.
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 final 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 final 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 final 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 final boolean hasAccountIdsToAdd()

For responses, this returns true if the service returned a value for the AccountIdsToAdd property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.

accountIdsToAdd

public final List<String> accountIdsToAdd()

The Amazon Web Services users 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.

This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasAccountIdsToAdd() method.

Returns:

The Amazon Web Services users that should have access to the document. The account IDs can either be a group of account IDs or All.

hasAccountIdsToRemove

public final boolean hasAccountIdsToRemove()

For responses, this returns true if the service returned a value for the AccountIdsToRemove property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.

accountIdsToRemove

public final List<String> accountIdsToRemove()

The Amazon Web Services users that should no longer have access to the document. The Amazon Web Services user can either be a group of account IDs or All. This action has a higher priority than AccountIdsToAdd. If you specify an 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.

This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasAccountIdsToRemove() method.

Returns:

The Amazon Web Services users that should no longer have access to the document. The Amazon Web Services user can either be a group of account IDs or All. This action has a higher priority than AccountIdsToAdd. If you specify an ID to add and the same ID to remove, the system removes access to the document.

sharedDocumentVersion

public final String sharedDocumentVersion()

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

Returns:

(Optional) The version of the document to share. If it isn't 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 final int hashCode()

Overrides:

hashCode in class AwsRequest

equals

public final boolean equals(Object obj)

Overrides:

equals in class AwsRequest

equalsBySdkFields

public final boolean equalsBySdkFields(Object obj)

Specified by:

equalsBySdkFields in interface SdkPojo

toString

public final 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 final <T> Optional<T> getValueForField(String fieldName,
                                              Class<T> clazz)

Overrides:

getValueForField in class SdkRequest

sdkFields

public final List<SdkField<?>> sdkFields()

Specified by:

sdkFields in interface SdkPojo