Interface IsAuthorizedRequest.Builder

All Superinterfaces:

AwsRequest.Builder, Buildable, CopyableBuilder<IsAuthorizedRequest.Builder,IsAuthorizedRequest>, SdkBuilder<IsAuthorizedRequest.Builder,IsAuthorizedRequest>, SdkPojo, SdkRequest.Builder, VerifiedPermissionsRequest.Builder

Enclosing class:

IsAuthorizedRequest

@Mutable
@NotThreadSafe
public static interface IsAuthorizedRequest.Builder
extends VerifiedPermissionsRequest.Builder, SdkPojo, CopyableBuilder<IsAuthorizedRequest.Builder,IsAuthorizedRequest>

Method Summary

Modifier and Type	Method	Description
default IsAuthorizedRequest.Builder	action(Consumer<ActionIdentifier.Builder> action)	Specifies the requested action to be authorized.
IsAuthorizedRequest.Builder	action(ActionIdentifier action)	Specifies the requested action to be authorized.
default IsAuthorizedRequest.Builder	context(Consumer<ContextDefinition.Builder> context)	Specifies additional context that can be used to make more granular authorization decisions.
IsAuthorizedRequest.Builder	context(ContextDefinition context)	Specifies additional context that can be used to make more granular authorization decisions.
default IsAuthorizedRequest.Builder	entities(Consumer<EntitiesDefinition.Builder> entities)	(Optional) Specifies the list of resources and principals and their associated attributes that Verified Permissions can examine when evaluating the policies.
IsAuthorizedRequest.Builder	entities(EntitiesDefinition entities)	(Optional) Specifies the list of resources and principals and their associated attributes that Verified Permissions can examine when evaluating the policies.
IsAuthorizedRequest.Builder	overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)	Add an optional request override configuration.
IsAuthorizedRequest.Builder	overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)	Add an optional request override configuration.
IsAuthorizedRequest.Builder	policyStoreId(String policyStoreId)	Specifies the ID of the policy store.
default IsAuthorizedRequest.Builder	principal(Consumer<EntityIdentifier.Builder> principal)	Specifies the principal for which the authorization decision is to be made.
IsAuthorizedRequest.Builder	principal(EntityIdentifier principal)	Specifies the principal for which the authorization decision is to be made.
default IsAuthorizedRequest.Builder	resource(Consumer<EntityIdentifier.Builder> resource)	Specifies the resource for which the authorization decision is to be made.
IsAuthorizedRequest.Builder	resource(EntityIdentifier resource)	Specifies the resource for which the authorization decision is to be made.

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

overrideConfiguration

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

Methods inherited from interface software.amazon.awssdk.services.verifiedpermissions.model.VerifiedPermissionsRequest.Builder

build

Method Details

policyStoreId

IsAuthorizedRequest.Builder policyStoreId(String policyStoreId)

Specifies the ID of the policy store. Policies in this policy store will be used to make an authorization decision for the input.

Parameters:

policyStoreId - Specifies the ID of the policy store. Policies in this policy store will be used to make an authorization decision for the input.

Returns:

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

principal

IsAuthorizedRequest.Builder principal(EntityIdentifier principal)

Specifies the principal for which the authorization decision is to be made.

Parameters:

principal - Specifies the principal for which the authorization decision is to be made.

Returns:

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

principal

default IsAuthorizedRequest.Builder principal(Consumer<EntityIdentifier.Builder> principal)

Specifies the principal for which the authorization decision is to be made.

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

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

Parameters:

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

Returns:

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

See Also:

• principal(EntityIdentifier)

action

IsAuthorizedRequest.Builder action(ActionIdentifier action)

Specifies the requested action to be authorized. For example, is the principal authorized to perform this action on the resource?

Parameters:

action - Specifies the requested action to be authorized. For example, is the principal authorized to perform this action on the resource?

Returns:

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

action

default IsAuthorizedRequest.Builder action(Consumer<ActionIdentifier.Builder> action)

Specifies the requested action to be authorized. For example, is the principal authorized to perform this action on the resource?

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

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

Parameters:

action - a consumer that will call methods on ActionIdentifier.Builder

Returns:

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

See Also:

• action(ActionIdentifier)

resource

IsAuthorizedRequest.Builder resource(EntityIdentifier resource)

Specifies the resource for which the authorization decision is to be made.

Parameters:

resource - Specifies the resource for which the authorization decision is to be made.

Returns:

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

resource

default IsAuthorizedRequest.Builder resource(Consumer<EntityIdentifier.Builder> resource)

Specifies the resource for which the authorization decision is to be made.

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

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

Parameters:

resource - a consumer that will call methods on EntityIdentifier.Builder

Returns:

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

See Also:

• resource(EntityIdentifier)

context

IsAuthorizedRequest.Builder context(ContextDefinition context)

Specifies additional context that can be used to make more granular authorization decisions.

Parameters:

context - Specifies additional context that can be used to make more granular authorization decisions.

Returns:

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

context

default IsAuthorizedRequest.Builder context(Consumer<ContextDefinition.Builder> context)

Specifies additional context that can be used to make more granular authorization decisions.

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

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

Parameters:

context - a consumer that will call methods on ContextDefinition.Builder

Returns:

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

See Also:

• context(ContextDefinition)

entities

IsAuthorizedRequest.Builder entities(EntitiesDefinition entities)

(Optional) Specifies the list of resources and principals and their associated attributes that Verified Permissions can examine when evaluating the policies. These additional entities and their attributes can be referenced and checked by conditional elements in the policies in the specified policy store.

You can include only principal and resource entities in this parameter; you can't include actions. You must specify actions in the schema.

Parameters:

entities - (Optional) Specifies the list of resources and principals and their associated attributes that Verified Permissions can examine when evaluating the policies. These additional entities and their attributes can be referenced and checked by conditional elements in the policies in the specified policy store.

You can include only principal and resource entities in this parameter; you can't include actions. You must specify actions in the schema.

Returns:

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

entities

default IsAuthorizedRequest.Builder entities(Consumer<EntitiesDefinition.Builder> entities)

(Optional) Specifies the list of resources and principals and their associated attributes that Verified Permissions can examine when evaluating the policies. These additional entities and their attributes can be referenced and checked by conditional elements in the policies in the specified policy store.

You can include only principal and resource entities in this parameter; you can't include actions. You must specify actions in the schema.

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

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

Parameters:

entities - a consumer that will call methods on EntitiesDefinition.Builder

Returns:

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

See Also:

• entities(EntitiesDefinition)

overrideConfiguration

IsAuthorizedRequest.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

IsAuthorizedRequest.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.