Package software.amazon.awssdk.services.verifiedpermissions.model

Class CreateIdentitySourceRequest

java.lang.Object

software.amazon.awssdk.core.SdkRequest

software.amazon.awssdk.awscore.AwsRequest

software.amazon.awssdk.services.verifiedpermissions.model.VerifiedPermissionsRequest

software.amazon.awssdk.services.verifiedpermissions.model.CreateIdentitySourceRequest

All Implemented Interfaces:

SdkPojo, ToCopyableBuilder<CreateIdentitySourceRequest.Builder,CreateIdentitySourceRequest>

@Generated("software.amazon.awssdk:codegen")
public final class CreateIdentitySourceRequest
extends VerifiedPermissionsRequest
implements ToCopyableBuilder<CreateIdentitySourceRequest.Builder,CreateIdentitySourceRequest>

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	CreateIdentitySourceRequest.Builder

Method Summary

Modifier and Type	Method	Description
static CreateIdentitySourceRequest.Builder	builder()
String	clientToken()	Specifies a unique, case-sensitive ID that you provide to ensure the idempotency of the request.
Configuration	configuration()	Specifies the details required to communicate with the identity provider (IdP) associated with this identity source.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
String	policyStoreId()	Specifies the ID of the policy store in which you want to store this identity source.
String	principalEntityType()	Specifies the namespace and data type of the principals generated for identities authenticated by the new identity source.
List<SdkField<?>>	sdkFields()
static Class<? extends CreateIdentitySourceRequest.Builder>	serializableBuilderClass()
CreateIdentitySourceRequest.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

clientToken

public final 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.

Returns:

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.

policyStoreId

public final 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.

Returns:

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.

configuration

public final 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.

Returns:

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.

principalEntityType

public final String principalEntityType()

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

Returns:

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

toBuilder

public CreateIdentitySourceRequest.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<CreateIdentitySourceRequest.Builder,CreateIdentitySourceRequest>

Specified by:

toBuilder in class VerifiedPermissionsRequest

builder

public static CreateIdentitySourceRequest.Builder builder()

serializableBuilderClass

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