Interface Workforce.Builder
-
- All Superinterfaces:
Buildable
,CopyableBuilder<Workforce.Builder,Workforce>
,SdkBuilder<Workforce.Builder,Workforce>
,SdkPojo
- Enclosing class:
- Workforce
public static interface Workforce.Builder extends SdkPojo, CopyableBuilder<Workforce.Builder,Workforce>
-
-
Method Summary
All Methods Instance Methods Abstract Methods Default Methods Modifier and Type Method Description default Workforce.Builder
cognitoConfig(Consumer<CognitoConfig.Builder> cognitoConfig)
The configuration of an Amazon Cognito workforce.Workforce.Builder
cognitoConfig(CognitoConfig cognitoConfig)
The configuration of an Amazon Cognito workforce.Workforce.Builder
createDate(Instant createDate)
The date that the workforce is created.Workforce.Builder
failureReason(String failureReason)
The reason your workforce failed.Workforce.Builder
lastUpdatedDate(Instant lastUpdatedDate)
The most recent date that UpdateWorkforce was used to successfully add one or more IP address ranges (CIDRs) to a private workforce's allow list.default Workforce.Builder
oidcConfig(Consumer<OidcConfigForResponse.Builder> oidcConfig)
The configuration of an OIDC Identity Provider (IdP) private workforce.Workforce.Builder
oidcConfig(OidcConfigForResponse oidcConfig)
The configuration of an OIDC Identity Provider (IdP) private workforce.default Workforce.Builder
sourceIpConfig(Consumer<SourceIpConfig.Builder> sourceIpConfig)
A list of one to ten IP address ranges (CIDRs) to be added to the workforce allow list.Workforce.Builder
sourceIpConfig(SourceIpConfig sourceIpConfig)
A list of one to ten IP address ranges (CIDRs) to be added to the workforce allow list.Workforce.Builder
status(String status)
The status of your workforce.Workforce.Builder
status(WorkforceStatus status)
The status of your workforce.Workforce.Builder
subDomain(String subDomain)
The subdomain for your OIDC Identity Provider.Workforce.Builder
workforceArn(String workforceArn)
The Amazon Resource Name (ARN) of the private workforce.Workforce.Builder
workforceName(String workforceName)
The name of the private workforce.default Workforce.Builder
workforceVpcConfig(Consumer<WorkforceVpcConfigResponse.Builder> workforceVpcConfig)
The configuration of a VPC workforce.Workforce.Builder
workforceVpcConfig(WorkforceVpcConfigResponse workforceVpcConfig)
The configuration of a VPC workforce.-
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
-
-
-
-
Method Detail
-
workforceName
Workforce.Builder workforceName(String workforceName)
The name of the private workforce.
- Parameters:
workforceName
- The name of the private workforce.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
workforceArn
Workforce.Builder workforceArn(String workforceArn)
The Amazon Resource Name (ARN) of the private workforce.
- Parameters:
workforceArn
- The Amazon Resource Name (ARN) of the private workforce.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
lastUpdatedDate
Workforce.Builder lastUpdatedDate(Instant lastUpdatedDate)
The most recent date that UpdateWorkforce was used to successfully add one or more IP address ranges (CIDRs) to a private workforce's allow list.
- Parameters:
lastUpdatedDate
- The most recent date that UpdateWorkforce was used to successfully add one or more IP address ranges (CIDRs) to a private workforce's allow list.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
sourceIpConfig
Workforce.Builder sourceIpConfig(SourceIpConfig sourceIpConfig)
A list of one to ten IP address ranges (CIDRs) to be added to the workforce allow list. By default, a workforce isn't restricted to specific IP addresses.
- Parameters:
sourceIpConfig
- A list of one to ten IP address ranges (CIDRs) to be added to the workforce allow list. By default, a workforce isn't restricted to specific IP addresses.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
sourceIpConfig
default Workforce.Builder sourceIpConfig(Consumer<SourceIpConfig.Builder> sourceIpConfig)
A list of one to ten IP address ranges (CIDRs) to be added to the workforce allow list. By default, a workforce isn't restricted to specific IP addresses.
This is a convenience method that creates an instance of theSourceIpConfig.Builder
avoiding the need to create one manually viaSourceIpConfig.builder()
.When the
Consumer
completes,SdkBuilder.build()
is called immediately and its result is passed tosourceIpConfig(SourceIpConfig)
.- Parameters:
sourceIpConfig
- a consumer that will call methods onSourceIpConfig.Builder
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
sourceIpConfig(SourceIpConfig)
-
subDomain
Workforce.Builder subDomain(String subDomain)
The subdomain for your OIDC Identity Provider.
- Parameters:
subDomain
- The subdomain for your OIDC Identity Provider.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
cognitoConfig
Workforce.Builder cognitoConfig(CognitoConfig cognitoConfig)
The configuration of an Amazon Cognito workforce. A single Cognito workforce is created using and corresponds to a single Amazon Cognito user pool.
- Parameters:
cognitoConfig
- The configuration of an Amazon Cognito workforce. A single Cognito workforce is created using and corresponds to a single Amazon Cognito user pool.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
cognitoConfig
default Workforce.Builder cognitoConfig(Consumer<CognitoConfig.Builder> cognitoConfig)
The configuration of an Amazon Cognito workforce. A single Cognito workforce is created using and corresponds to a single Amazon Cognito user pool.
This is a convenience method that creates an instance of theCognitoConfig.Builder
avoiding the need to create one manually viaCognitoConfig.builder()
.When the
Consumer
completes,SdkBuilder.build()
is called immediately and its result is passed tocognitoConfig(CognitoConfig)
.- Parameters:
cognitoConfig
- a consumer that will call methods onCognitoConfig.Builder
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
cognitoConfig(CognitoConfig)
-
oidcConfig
Workforce.Builder oidcConfig(OidcConfigForResponse oidcConfig)
The configuration of an OIDC Identity Provider (IdP) private workforce.
- Parameters:
oidcConfig
- The configuration of an OIDC Identity Provider (IdP) private workforce.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
oidcConfig
default Workforce.Builder oidcConfig(Consumer<OidcConfigForResponse.Builder> oidcConfig)
The configuration of an OIDC Identity Provider (IdP) private workforce.
This is a convenience method that creates an instance of theOidcConfigForResponse.Builder
avoiding the need to create one manually viaOidcConfigForResponse.builder()
.When the
Consumer
completes,SdkBuilder.build()
is called immediately and its result is passed tooidcConfig(OidcConfigForResponse)
.- Parameters:
oidcConfig
- a consumer that will call methods onOidcConfigForResponse.Builder
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
oidcConfig(OidcConfigForResponse)
-
createDate
Workforce.Builder createDate(Instant createDate)
The date that the workforce is created.
- Parameters:
createDate
- The date that the workforce is created.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
workforceVpcConfig
Workforce.Builder workforceVpcConfig(WorkforceVpcConfigResponse workforceVpcConfig)
The configuration of a VPC workforce.
- Parameters:
workforceVpcConfig
- The configuration of a VPC workforce.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
workforceVpcConfig
default Workforce.Builder workforceVpcConfig(Consumer<WorkforceVpcConfigResponse.Builder> workforceVpcConfig)
The configuration of a VPC workforce.
This is a convenience method that creates an instance of theWorkforceVpcConfigResponse.Builder
avoiding the need to create one manually viaWorkforceVpcConfigResponse.builder()
.When the
Consumer
completes,SdkBuilder.build()
is called immediately and its result is passed toworkforceVpcConfig(WorkforceVpcConfigResponse)
.- Parameters:
workforceVpcConfig
- a consumer that will call methods onWorkforceVpcConfigResponse.Builder
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
workforceVpcConfig(WorkforceVpcConfigResponse)
-
status
Workforce.Builder status(String status)
The status of your workforce.
- Parameters:
status
- The status of your workforce.- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
WorkforceStatus
,WorkforceStatus
-
status
Workforce.Builder status(WorkforceStatus status)
The status of your workforce.
- Parameters:
status
- The status of your workforce.- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
WorkforceStatus
,WorkforceStatus
-
failureReason
Workforce.Builder failureReason(String failureReason)
The reason your workforce failed.
- Parameters:
failureReason
- The reason your workforce failed.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
-