Interface CreateIdentitySourceRequest.Builder
- All Superinterfaces:
AwsRequest.Builder,Buildable,CopyableBuilder<CreateIdentitySourceRequest.Builder,,CreateIdentitySourceRequest> MpaRequest.Builder,SdkBuilder<CreateIdentitySourceRequest.Builder,,CreateIdentitySourceRequest> SdkPojo,SdkRequest.Builder
- Enclosing class:
CreateIdentitySourceRequest
-
Method Summary
Modifier and TypeMethodDescriptionclientToken(String clientToken) Unique, case-sensitive identifier that you provide to ensure the idempotency of the request.identitySourceParameters(Consumer<IdentitySourceParameters.Builder> identitySourceParameters) AIdentitySourceParametersobject.identitySourceParameters(IdentitySourceParameters identitySourceParameters) AIdentitySourceParametersobject.overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer) Add an optional request override configuration.overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration) Add an optional request override configuration.Tag you want to attach to the identity source.Methods inherited from interface software.amazon.awssdk.awscore.AwsRequest.Builder
overrideConfigurationMethods inherited from interface software.amazon.awssdk.utils.builder.CopyableBuilder
copyMethods inherited from interface software.amazon.awssdk.services.mpa.model.MpaRequest.Builder
buildMethods inherited from interface software.amazon.awssdk.utils.builder.SdkBuilder
applyMutation, buildMethods inherited from interface software.amazon.awssdk.core.SdkPojo
equalsBySdkFields, sdkFieldNameToField, sdkFields
-
Method Details
-
identitySourceParameters
CreateIdentitySourceRequest.Builder identitySourceParameters(IdentitySourceParameters identitySourceParameters) A
IdentitySourceParametersobject. Contains details for the resource that provides identities to the identity source. For example, an IAM Identity Center instance.- Parameters:
identitySourceParameters- AIdentitySourceParametersobject. Contains details for the resource that provides identities to the identity source. For example, an IAM Identity Center instance.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
identitySourceParameters
default CreateIdentitySourceRequest.Builder identitySourceParameters(Consumer<IdentitySourceParameters.Builder> identitySourceParameters) A
This is a convenience method that creates an instance of theIdentitySourceParametersobject. Contains details for the resource that provides identities to the identity source. For example, an IAM Identity Center instance.IdentitySourceParameters.Builderavoiding the need to create one manually viaIdentitySourceParameters.builder().When the
Consumercompletes,SdkBuilder.build()is called immediately and its result is passed toidentitySourceParameters(IdentitySourceParameters).- Parameters:
identitySourceParameters- a consumer that will call methods onIdentitySourceParameters.Builder- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
clientToken
Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If not provided, the Amazon Web Services populates this field.
What is idempotency?
When you make a mutating API request, the request typically returns a result before the operation's asynchronous workflows have completed. Operations might also time out or encounter other server issues before they complete, even though the request has already returned a result. This could make it difficult to determine whether the request succeeded or not, and could lead to multiple retries to ensure that the operation completes successfully. However, if the original request and the subsequent retries are successful, the operation is completed multiple times. This means that you might create more resources than you intended.
Idempotency ensures that an API request completes no more than one time. With an idempotent request, if the original request completes successfully, any subsequent retries complete successfully without performing any further actions.
- Parameters:
clientToken- Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If not provided, the Amazon Web Services populates this field.What is idempotency?
When you make a mutating API request, the request typically returns a result before the operation's asynchronous workflows have completed. Operations might also time out or encounter other server issues before they complete, even though the request has already returned a result. This could make it difficult to determine whether the request succeeded or not, and could lead to multiple retries to ensure that the operation completes successfully. However, if the original request and the subsequent retries are successful, the operation is completed multiple times. This means that you might create more resources than you intended.
Idempotency ensures that an API request completes no more than one time. With an idempotent request, if the original request completes successfully, any subsequent retries complete successfully without performing any further actions.
- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
tags
Tag you want to attach to the identity source.
- Parameters:
tags- Tag you want to attach to the 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.BuilderAdd an optional request override configuration.- Specified by:
overrideConfigurationin 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.BuilderAdd an optional request override configuration.- Specified by:
overrideConfigurationin interfaceAwsRequest.Builder- Parameters:
builderConsumer- AConsumerto which an emptyAwsRequestOverrideConfiguration.Builderwill be given.- Returns:
- This object for method chaining.
-