software.amazon.awssdk.services.verifiedpermissions.model

Interface CreateIdentitySourceRequest.Builder

All Superinterfaces:

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

Enclosing class:

CreateIdentitySourceRequest

public static interface CreateIdentitySourceRequest.Builder
extends VerifiedPermissionsRequest.Builder, SdkPojo, CopyableBuilder<CreateIdentitySourceRequest.Builder,CreateIdentitySourceRequest>

Method Summary

Modifier and Type	Method and Description
CreateIdentitySourceRequest.Builder	clientToken(String clientToken) Specifies a unique, case-sensitive ID that you provide to ensure the idempotency of the request.
CreateIdentitySourceRequest.Builder	configuration(Configuration configuration) Specifies the details required to communicate with the identity provider (IdP) associated with this identity source.
default CreateIdentitySourceRequest.Builder	configuration(Consumer<Configuration.Builder> configuration) Specifies the details required to communicate with the identity provider (IdP) associated with this identity source.
CreateIdentitySourceRequest.Builder	overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)
CreateIdentitySourceRequest.Builder	overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)
CreateIdentitySourceRequest.Builder	policyStoreId(String policyStoreId) Specifies the ID of the policy store in which you want to store this identity source.
CreateIdentitySourceRequest.Builder	principalEntityType(String principalEntityType) Specifies the namespace and data type of the principals generated for identities authenticated by the new identity source.

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

build

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

overrideConfiguration

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

equalsBySdkFields, sdkFields

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

copy

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

applyMutation, build

Method Detail

clientToken

CreateIdentitySourceRequest.Builder clientToken(String clientToken)

Specifies a unique, case-sensitive ID that you provide to ensure the idempotency of the request. This lets you safely retry the request without accidentally performing the same operation a second time. Passing the same value to a later call to an operation requires that you also pass the same value for all other parameters. We recommend that you use a UUID type of value..

If you don't provide this value, then Amazon Web Services generates a random one for you.

If you retry the operation with the same ClientToken, but with different parameters, the retry fails with an IdempotentParameterMismatch error.

Parameters:

clientToken - Specifies a unique, case-sensitive ID that you provide to ensure the idempotency of the request. This lets you safely retry the request without accidentally performing the same operation a second time. Passing the same value to a later call to an operation requires that you also pass the same value for all other parameters. We recommend that you use a UUID type of value..

If you don't provide this value, then Amazon Web Services generates a random one for you.

If you retry the operation with the same ClientToken, but with different parameters, the retry fails with an IdempotentParameterMismatch error.

Returns:

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

policyStoreId

CreateIdentitySourceRequest.Builder policyStoreId(String policyStoreId)

Specifies the ID of the policy store in which you want to store this identity source. Only policies and requests made using this policy store can reference identities from the identity provider configured in the new identity source.

Parameters:

policyStoreId - Specifies the ID of the policy store in which you want to store this identity source. Only policies and requests made using this policy store can reference identities from the identity provider configured in the new identity source.

Returns:

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

configuration

CreateIdentitySourceRequest.Builder configuration(Configuration configuration)

Specifies the details required to communicate with the identity provider (IdP) associated with this identity source.

At this time, the only valid member of this structure is a Amazon Cognito user pool configuration.

You must specify a UserPoolArn, and optionally, a ClientId.

Parameters:

configuration - Specifies the details required to communicate with the identity provider (IdP) associated with this identity source.

At this time, the only valid member of this structure is a Amazon Cognito user pool configuration.

You must specify a UserPoolArn, and optionally, a ClientId.

Returns:

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

configuration

default CreateIdentitySourceRequest.Builder configuration(Consumer<Configuration.Builder> configuration)

Specifies the details required to communicate with the identity provider (IdP) associated with this identity source.

At this time, the only valid member of this structure is a Amazon Cognito user pool configuration.

You must specify a UserPoolArn, and optionally, a ClientId.

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

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

Parameters:

configuration - a consumer that will call methods on Configuration.Builder

Returns:

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

See Also:

configuration(Configuration)

principalEntityType

CreateIdentitySourceRequest.Builder principalEntityType(String principalEntityType)

Specifies the namespace and data type of the principals generated for identities authenticated by the new identity source.

Parameters:

principalEntityType - Specifies the namespace and data type of the principals generated for identities authenticated by the new identity source.

Returns:

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

overrideConfiguration

CreateIdentitySourceRequest.Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)

Specified by:

overrideConfiguration in interface AwsRequest.Builder

overrideConfiguration

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

Specified by:

overrideConfiguration in interface AwsRequest.Builder