Interface CreateIdentitySourceRequest.Builder
- All Superinterfaces:
AwsRequest.Builder
,Buildable
,CopyableBuilder<CreateIdentitySourceRequest.Builder,
,CreateIdentitySourceRequest> SdkBuilder<CreateIdentitySourceRequest.Builder,
,CreateIdentitySourceRequest> SdkPojo
,SdkRequest.Builder
,VerifiedPermissionsRequest.Builder
- Enclosing class:
CreateIdentitySourceRequest
-
Method Summary
Modifier and TypeMethodDescriptionclientToken
(String clientToken) Specifies a unique, case-sensitive ID that you provide to ensure the idempotency of the request.configuration
(Consumer<Configuration.Builder> configuration) Specifies the details required to communicate with the identity provider (IdP) associated with this identity source.configuration
(Configuration configuration) Specifies the details required to communicate with the identity provider (IdP) associated with this identity source.overrideConfiguration
(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer) Add an optional request override configuration.overrideConfiguration
(AwsRequestOverrideConfiguration overrideConfiguration) Add an optional request override configuration.policyStoreId
(String policyStoreId) Specifies the ID of the policy store in which you want to store this identity source.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.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
-
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 anConflictException
error.Verified Permissions recognizes a
ClientToken
for eight hours. After eight hours, the next request with the same parameters performs the operation again regardless of the value ofClientToken
.- 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 anConflictException
error.Verified Permissions recognizes a
ClientToken
for eight hours. After eight hours, the next request with the same parameters performs the operation again regardless of the value ofClientToken
.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
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
Specifies the details required to communicate with the identity provider (IdP) associated with this identity source.
- Parameters:
configuration
- Specifies the details required to communicate with the identity provider (IdP) associated with this identity source.- 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.
This is a convenience method that creates an instance of theConfiguration.Builder
avoiding the need to create one manually viaConfiguration.builder()
.When the
Consumer
completes,SdkBuilder.build()
is called immediately and its result is passed toconfiguration(Configuration)
.- Parameters:
configuration
- a consumer that will call methods onConfiguration.Builder
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
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) Description copied from interface:AwsRequest.Builder
Add an optional request override configuration.- Specified by:
overrideConfiguration
in interfaceAwsRequest.Builder
- Parameters:
overrideConfiguration
- The override configuration.- Returns:
- This object for method chaining.
-
overrideConfiguration
CreateIdentitySourceRequest.Builder overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer) Description copied from interface:AwsRequest.Builder
Add an optional request override configuration.- Specified by:
overrideConfiguration
in interfaceAwsRequest.Builder
- Parameters:
builderConsumer
- AConsumer
to which an emptyAwsRequestOverrideConfiguration.Builder
will be given.- Returns:
- This object for method chaining.
-