software.amazon.awssdk.services.ram.model

Class CreateResourceShareRequest

java.lang.Object

software.amazon.awssdk.core.SdkRequest

software.amazon.awssdk.awscore.AwsRequest

software.amazon.awssdk.services.ram.model.RamRequest

software.amazon.awssdk.services.ram.model.CreateResourceShareRequest

All Implemented Interfaces:

SdkPojo, ToCopyableBuilder<CreateResourceShareRequest.Builder,CreateResourceShareRequest>

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

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	CreateResourceShareRequest.Builder

Method Summary

Modifier and Type	Method and Description
Boolean	allowExternalPrincipals() Indicates whether principals outside your AWS organization can be associated with a resource share.
static CreateResourceShareRequest.Builder	builder()
String	clientToken() A unique, case-sensitive identifier that you provide to ensure the idempotency of the request.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
boolean	hasPermissionArns() Returns true if the PermissionArns 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	hasPrincipals() Returns true if the Principals 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	hasResourceArns() Returns true if the ResourceArns 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	hasTags() Returns true if the Tags property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty).
String	name() The name of the resource share.
List<String>	permissionArns() The ARNs of the permissions to associate with the resource share.
List<String>	principals() The principals to associate with the resource share.
List<String>	resourceArns() The Amazon Resource Names (ARN) of the resources to associate with the resource share.
List<SdkField<?>>	sdkFields()
static Class<? extends CreateResourceShareRequest.Builder>	serializableBuilderClass()
List<Tag>	tags() One or more tags.
CreateResourceShareRequest.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 resource share.

Returns:

The name of the resource share.

hasResourceArns

public final boolean hasResourceArns()

Returns true if the ResourceArns 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.

resourceArns

public final List<String> resourceArns()

The Amazon Resource Names (ARN) of the resources to associate with the resource share.

Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

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

Returns:

The Amazon Resource Names (ARN) of the resources to associate with the resource share.

hasPrincipals

public final boolean hasPrincipals()

Returns true if the Principals 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.

principals

public final List<String> principals()

The principals to associate with the resource share. The possible values are IDs of AWS accounts, the ARN of an OU or organization from AWS Organizations.

Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

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

Returns:

The principals to associate with the resource share. The possible values are IDs of AWS accounts, the ARN of an OU or organization from AWS Organizations.

hasTags

public final boolean hasTags()

Returns true if the Tags 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.

tags

public final List<Tag> tags()

One or more tags.

Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

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

Returns:

One or more tags.

allowExternalPrincipals

public final Boolean allowExternalPrincipals()

Indicates whether principals outside your AWS organization can be associated with a resource share.

Returns:

Indicates whether principals outside your AWS organization can be associated with a resource share.

clientToken

public final String clientToken()

A unique, case-sensitive identifier that you provide to ensure the idempotency of the request.

Returns:

A unique, case-sensitive identifier that you provide to ensure the idempotency of the request.

hasPermissionArns

public final boolean hasPermissionArns()

Returns true if the PermissionArns 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.

permissionArns

public final List<String> permissionArns()

The ARNs of the permissions to associate with the resource share. If you do not specify an ARN for the permission, AWS RAM automatically attaches the default version of the permission for each resource type.

Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

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

Returns:

The ARNs of the permissions to associate with the resource share. If you do not specify an ARN for the permission, AWS RAM automatically attaches the default version of the permission for each resource type.

toBuilder

public CreateResourceShareRequest.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<CreateResourceShareRequest.Builder,CreateResourceShareRequest>

Specified by:

toBuilder in class RamRequest

builder

public static CreateResourceShareRequest.Builder builder()

serializableBuilderClass

public static Class<? extends CreateResourceShareRequest.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