Interface CreateAccessPolicyRequest.Builder

All Superinterfaces:

AwsRequest.Builder, Buildable, CopyableBuilder<CreateAccessPolicyRequest.Builder,CreateAccessPolicyRequest>, OpenSearchServerlessRequest.Builder, SdkBuilder<CreateAccessPolicyRequest.Builder,CreateAccessPolicyRequest>, SdkPojo, SdkRequest.Builder

Enclosing class:

CreateAccessPolicyRequest

@Mutable
@NotThreadSafe
public static interface CreateAccessPolicyRequest.Builder
extends OpenSearchServerlessRequest.Builder, SdkPojo, CopyableBuilder<CreateAccessPolicyRequest.Builder,CreateAccessPolicyRequest>

Method Summary

Modifier and Type	Method	Description
CreateAccessPolicyRequest.Builder	clientToken(String clientToken)	Unique, case-sensitive identifier to ensure idempotency of the request.
CreateAccessPolicyRequest.Builder	description(String description)	A description of the policy.
CreateAccessPolicyRequest.Builder	name(String name)	The name of the policy.
CreateAccessPolicyRequest.Builder	overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)	Add an optional request override configuration.
CreateAccessPolicyRequest.Builder	overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)	Add an optional request override configuration.
CreateAccessPolicyRequest.Builder	policy(String policy)	The JSON policy document to use as the content for the policy.
CreateAccessPolicyRequest.Builder	type(String type)	The type of policy.
CreateAccessPolicyRequest.Builder	type(AccessPolicyType type)	The type of policy.

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.services.opensearchserverless.model.OpenSearchServerlessRequest.Builder

build

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

type

CreateAccessPolicyRequest.Builder type(String type)

The type of policy.

Parameters:

type - The type of policy.

Returns:

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

See Also:

• AccessPolicyType
• AccessPolicyType

type

CreateAccessPolicyRequest.Builder type(AccessPolicyType type)

The type of policy.

Parameters:

type - The type of policy.

Returns:

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

See Also:

• AccessPolicyType
• AccessPolicyType

name

CreateAccessPolicyRequest.Builder name(String name)

The name of the policy.

Parameters:

name - The name of the policy.

Returns:

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

description

CreateAccessPolicyRequest.Builder description(String description)

A description of the policy. Typically used to store information about the permissions defined in the policy.

Parameters:

description - A description of the policy. Typically used to store information about the permissions defined in the policy.

Returns:

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

policy

CreateAccessPolicyRequest.Builder policy(String policy)

The JSON policy document to use as the content for the policy.

Parameters:

policy - The JSON policy document to use as the content for the policy.

Returns:

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

clientToken

CreateAccessPolicyRequest.Builder clientToken(String clientToken)

Unique, case-sensitive identifier to ensure idempotency of the request.

Parameters:

clientToken - Unique, case-sensitive identifier to ensure idempotency of the request.

Returns:

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

overrideConfiguration

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

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