Interface CreateAccessGrantRequest.Builder

All Superinterfaces:

AwsRequest.Builder, Buildable, CloudWatchOmniRequest.Builder, CopyableBuilder<CreateAccessGrantRequest.Builder,CreateAccessGrantRequest>, SdkBuilder<CreateAccessGrantRequest.Builder,CreateAccessGrantRequest>, SdkPojo, SdkRequest.Builder

Enclosing class:

CreateAccessGrantRequest

@Mutable
@NotThreadSafe
public static interface CreateAccessGrantRequest.Builder
extends CloudWatchOmniRequest.Builder, SdkPojo, CopyableBuilder<CreateAccessGrantRequest.Builder,CreateAccessGrantRequest>

Method Summary

Modifier and Type	Method	Description
CreateAccessGrantRequest.Builder	clientToken(String clientToken)	Idempotency token for safe retries.
CreateAccessGrantRequest.Builder	domainId(String domainId)	The ID of the domain that contains the space.
CreateAccessGrantRequest.Builder	name(String name)	A name that identifies the access grant.
CreateAccessGrantRequest.Builder	overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)	Add an optional request override configuration.
CreateAccessGrantRequest.Builder	overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)	Add an optional request override configuration.
CreateAccessGrantRequest.Builder	permission(String permission)	The permission to grant.
CreateAccessGrantRequest.Builder	permission(AccessGrantPermission permission)	The permission to grant.
default CreateAccessGrantRequest.Builder	principal(Consumer<AccessGrantPrincipal.Builder> principal)	The principal receiving the grant.
CreateAccessGrantRequest.Builder	principal(AccessGrantPrincipal principal)	The principal receiving the grant.
CreateAccessGrantRequest.Builder	scopedActions(Collection<ScopedActions> scopedActions)	Groups of actions to allow, each with the resource scopes and conditions that limit those actions.
CreateAccessGrantRequest.Builder	scopedActions(Consumer<ScopedActions.Builder>... scopedActions)	Groups of actions to allow, each with the resource scopes and conditions that limit those actions.
CreateAccessGrantRequest.Builder	scopedActions(ScopedActions... scopedActions)	Groups of actions to allow, each with the resource scopes and conditions that limit those actions.
CreateAccessGrantRequest.Builder	spaceId(String spaceId)	The ID of the space to scope the grant to.
CreateAccessGrantRequest.Builder	tags(Map<String,String> tags)	The tags to associate with the access grant.

Methods inherited from interface software.amazon.awssdk.awscore.AwsRequest.Builder

overrideConfiguration

Methods inherited from interface software.amazon.awssdk.services.cloudwatchomni.model.CloudWatchOmniRequest.Builder

build

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

copy

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

applyMutation, build

Methods inherited from interface software.amazon.awssdk.core.SdkPojo

equalsBySdkFields, sdkFieldNameToField, sdkFields

Method Details

domainId

CreateAccessGrantRequest.Builder domainId(String domainId)

The ID of the domain that contains the space.

Parameters:

domainId - The ID of the domain that contains the space.

Returns:

Returns a reference to this object so that method calls can be chained together.

spaceId

CreateAccessGrantRequest.Builder spaceId(String spaceId)

The ID of the space to scope the grant to.

Parameters:

spaceId - The ID of the space to scope the grant to.

Returns:

Returns a reference to this object so that method calls can be chained together.

name

CreateAccessGrantRequest.Builder name(String name)

A name that identifies the access grant.

Parameters:

name - A name that identifies the access grant.

Returns:

Returns a reference to this object so that method calls can be chained together.

principal

CreateAccessGrantRequest.Builder principal(AccessGrantPrincipal principal)

The principal receiving the grant.

Parameters:

principal - The principal receiving the grant.

Returns:

Returns a reference to this object so that method calls can be chained together.

principal

default CreateAccessGrantRequest.Builder principal(Consumer<AccessGrantPrincipal.Builder> principal)

The principal receiving the grant.

This is a convenience method that creates an instance of the AccessGrantPrincipal.Builder avoiding the need to create one manually via AccessGrantPrincipal.builder().

When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to principal(AccessGrantPrincipal).

Parameters:

principal - a consumer that will call methods on AccessGrantPrincipal.Builder

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

• principal(AccessGrantPrincipal)

permission

CreateAccessGrantRequest.Builder permission(String permission)

The permission to grant. Exactly one permission is granted per request.

Parameters:

permission - The permission to grant. Exactly one permission is granted per request.

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

• AccessGrantPermission
• AccessGrantPermission

permission

CreateAccessGrantRequest.Builder permission(AccessGrantPermission permission)

The permission to grant. Exactly one permission is granted per request.

Parameters:

permission - The permission to grant. Exactly one permission is granted per request.

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

• AccessGrantPermission
• AccessGrantPermission

scopedActions

CreateAccessGrantRequest.Builder scopedActions(Collection<ScopedActions> scopedActions)

Groups of actions to allow, each with the resource scopes and conditions that limit those actions.

Parameters:

scopedActions - Groups of actions to allow, each with the resource scopes and conditions that limit those actions.

Returns:

Returns a reference to this object so that method calls can be chained together.

scopedActions

CreateAccessGrantRequest.Builder scopedActions(ScopedActions... scopedActions)

Groups of actions to allow, each with the resource scopes and conditions that limit those actions.

Parameters:

scopedActions - Groups of actions to allow, each with the resource scopes and conditions that limit those actions.

Returns:

Returns a reference to this object so that method calls can be chained together.

scopedActions

CreateAccessGrantRequest.Builder scopedActions(Consumer<ScopedActions.Builder>... scopedActions)

Groups of actions to allow, each with the resource scopes and conditions that limit those actions.

This is a convenience method that creates an instance of the ScopedActions.Builder avoiding the need to create one manually via ScopedActions.builder().

When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to scopedActions(List<ScopedActions>).

Parameters:

scopedActions - a consumer that will call methods on ScopedActions.Builder

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

• scopedActions(java.util.Collection<ScopedActions>)

tags

CreateAccessGrantRequest.Builder tags(Map<String,String> tags)

The tags to associate with the access grant.

Parameters:

tags - The tags to associate with the access grant.

Returns:

Returns a reference to this object so that method calls can be chained together.

clientToken

CreateAccessGrantRequest.Builder clientToken(String clientToken)

Idempotency token for safe retries. Repeated requests with the same token return the original result instead of creating a duplicate.

Parameters:

clientToken - Idempotency token for safe retries. Repeated requests with the same token return the original result instead of creating a duplicate.

Returns:

Returns a reference to this object so that method calls can be chained together.

overrideConfiguration

CreateAccessGrantRequest.Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)

Description copied from interface: AwsRequest.Builder

Add an optional request override configuration.

Specified by:

overrideConfiguration in interface AwsRequest.Builder

Parameters:

overrideConfiguration - The override configuration.

Returns:

This object for method chaining.

overrideConfiguration

CreateAccessGrantRequest.Builder overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)

Description copied from interface: AwsRequest.Builder

Add an optional request override configuration.

Specified by:

overrideConfiguration in interface AwsRequest.Builder

Parameters:

builderConsumer - A Consumer to which an empty AwsRequestOverrideConfiguration.Builder will be given.

Returns:

This object for method chaining.