Interface CreateApprovalTeamRequest.Builder
- All Superinterfaces:
AwsRequest.Builder,Buildable,CopyableBuilder<CreateApprovalTeamRequest.Builder,,CreateApprovalTeamRequest> MpaRequest.Builder,SdkBuilder<CreateApprovalTeamRequest.Builder,,CreateApprovalTeamRequest> SdkPojo,SdkRequest.Builder
- Enclosing class:
CreateApprovalTeamRequest
-
Method Summary
Modifier and TypeMethodDescriptionapprovalStrategy(Consumer<ApprovalStrategy.Builder> approvalStrategy) AnApprovalStrategyobject.approvalStrategy(ApprovalStrategy approvalStrategy) AnApprovalStrategyobject.approvers(Collection<ApprovalTeamRequestApprover> approvers) An array ofApprovalTeamRequesterApproversobjects.approvers(Consumer<ApprovalTeamRequestApprover.Builder>... approvers) An array ofApprovalTeamRequesterApproversobjects.approvers(ApprovalTeamRequestApprover... approvers) An array ofApprovalTeamRequesterApproversobjects.clientToken(String clientToken) Unique, case-sensitive identifier that you provide to ensure the idempotency of the request.description(String description) Description for the team.Name of the team.overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer) Add an optional request override configuration.overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration) Add an optional request override configuration.policies(Collection<PolicyReference> policies) An array ofPolicyReferenceobjects.policies(Consumer<PolicyReference.Builder>... policies) An array ofPolicyReferenceobjects.policies(PolicyReference... policies) An array ofPolicyReferenceobjects.Tags you want to attach to the team.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
-
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.
-
approvalStrategy
An
ApprovalStrategyobject. Contains details for how the team grants approval.- Parameters:
approvalStrategy- AnApprovalStrategyobject. Contains details for how the team grants approval.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
approvalStrategy
default CreateApprovalTeamRequest.Builder approvalStrategy(Consumer<ApprovalStrategy.Builder> approvalStrategy) An
This is a convenience method that creates an instance of theApprovalStrategyobject. Contains details for how the team grants approval.ApprovalStrategy.Builderavoiding the need to create one manually viaApprovalStrategy.builder().When the
Consumercompletes,SdkBuilder.build()is called immediately and its result is passed toapprovalStrategy(ApprovalStrategy).- Parameters:
approvalStrategy- a consumer that will call methods onApprovalStrategy.Builder- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
approvers
An array of
ApprovalTeamRequesterApproversobjects. Contains details for the approvers in the team.- Parameters:
approvers- An array ofApprovalTeamRequesterApproversobjects. Contains details for the approvers in the team.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
approvers
An array of
ApprovalTeamRequesterApproversobjects. Contains details for the approvers in the team.- Parameters:
approvers- An array ofApprovalTeamRequesterApproversobjects. Contains details for the approvers in the team.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
approvers
CreateApprovalTeamRequest.Builder approvers(Consumer<ApprovalTeamRequestApprover.Builder>... approvers) An array of
This is a convenience method that creates an instance of theApprovalTeamRequesterApproversobjects. Contains details for the approvers in the team.ApprovalTeamRequestApprover.Builderavoiding the need to create one manually viaApprovalTeamRequestApprover.builder().When the
Consumercompletes,SdkBuilder.build()is called immediately and its result is passed toapprovers(List<ApprovalTeamRequestApprover>).- Parameters:
approvers- a consumer that will call methods onApprovalTeamRequestApprover.Builder- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
description
Description for the team.
- Parameters:
description- Description for the team.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
policies
An array of
PolicyReferenceobjects. Contains a list of policies that define the permissions for team resources.The protected operation for a service integration might require specific permissions. For more information, see How other services work with Multi-party approval in the Multi-party approval User Guide.
- Parameters:
policies- An array ofPolicyReferenceobjects. Contains a list of policies that define the permissions for team resources.The protected operation for a service integration might require specific permissions. For more information, see How other services work with Multi-party approval in the Multi-party approval User Guide.
- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
policies
An array of
PolicyReferenceobjects. Contains a list of policies that define the permissions for team resources.The protected operation for a service integration might require specific permissions. For more information, see How other services work with Multi-party approval in the Multi-party approval User Guide.
- Parameters:
policies- An array ofPolicyReferenceobjects. Contains a list of policies that define the permissions for team resources.The protected operation for a service integration might require specific permissions. For more information, see How other services work with Multi-party approval in the Multi-party approval User Guide.
- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
policies
An array of
PolicyReferenceobjects. Contains a list of policies that define the permissions for team resources.The protected operation for a service integration might require specific permissions. For more information, see How other services work with Multi-party approval in the Multi-party approval User Guide.
This is a convenience method that creates an instance of thePolicyReference.Builderavoiding the need to create one manually viaPolicyReference.builder().When the
Consumercompletes,SdkBuilder.build()is called immediately and its result is passed topolicies(List<PolicyReference>).- Parameters:
policies- a consumer that will call methods onPolicyReference.Builder- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
name
Name of the team.
- Parameters:
name- Name of the team.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
tags
Tags you want to attach to the team.
- Parameters:
tags- Tags you want to attach to the team.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
overrideConfiguration
CreateApprovalTeamRequest.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
CreateApprovalTeamRequest.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.
-