software.amazon.awsconstructs.services.fargatestepfunctions

Class FargateToStepfunctionsProps.Builder

java.lang.Object

software.amazon.awsconstructs.services.fargatestepfunctions.FargateToStepfunctionsProps.Builder

All Implemented Interfaces:

software.amazon.jsii.Builder<FargateToStepfunctionsProps>

Enclosing interface:

FargateToStepfunctionsProps

public static final class FargateToStepfunctionsProps.Builder
extends Object
implements software.amazon.jsii.Builder<FargateToStepfunctionsProps>

A builder for FargateToStepfunctionsProps

Constructor Summary

Constructors

Constructor and Description
Builder()

Method Summary

Modifier and Type	Method and Description
FargateToStepfunctionsProps	build() Builds the configured instance.
FargateToStepfunctionsProps.Builder	clusterProps(software.amazon.awscdk.services.ecs.ClusterProps clusterProps) Sets the value of FargateToStepfunctionsProps.getClusterProps()
FargateToStepfunctionsProps.Builder	containerDefinitionProps(Object containerDefinitionProps) Sets the value of FargateToStepfunctionsProps.getContainerDefinitionProps()
FargateToStepfunctionsProps.Builder	createCloudWatchAlarms(Boolean createCloudWatchAlarms) Sets the value of FargateToStepfunctionsProps.getCreateCloudWatchAlarms()
FargateToStepfunctionsProps.Builder	ecrImageVersion(String ecrImageVersion) Sets the value of FargateToStepfunctionsProps.getEcrImageVersion()
FargateToStepfunctionsProps.Builder	ecrRepositoryArn(String ecrRepositoryArn) Sets the value of FargateToStepfunctionsProps.getEcrRepositoryArn()
FargateToStepfunctionsProps.Builder	existingContainerDefinitionObject(software.amazon.awscdk.services.ecs.ContainerDefinition existingContainerDefinitionObject) Sets the value of FargateToStepfunctionsProps.getExistingContainerDefinitionObject()
FargateToStepfunctionsProps.Builder	existingFargateServiceObject(software.amazon.awscdk.services.ecs.FargateService existingFargateServiceObject) Sets the value of FargateToStepfunctionsProps.getExistingFargateServiceObject()
FargateToStepfunctionsProps.Builder	existingVpc(software.amazon.awscdk.services.ec2.IVpc existingVpc) Sets the value of FargateToStepfunctionsProps.getExistingVpc()
FargateToStepfunctionsProps.Builder	fargateServiceProps(Object fargateServiceProps) Sets the value of FargateToStepfunctionsProps.getFargateServiceProps()
FargateToStepfunctionsProps.Builder	fargateTaskDefinitionProps(Object fargateTaskDefinitionProps) Sets the value of FargateToStepfunctionsProps.getFargateTaskDefinitionProps()
FargateToStepfunctionsProps.Builder	logGroupProps(software.amazon.awscdk.services.logs.LogGroupProps logGroupProps) Sets the value of FargateToStepfunctionsProps.getLogGroupProps()
FargateToStepfunctionsProps.Builder	publicApi(Boolean publicApi) Sets the value of FargateToStepfunctionsProps.getPublicApi()
FargateToStepfunctionsProps.Builder	stateMachineEnvironmentVariableName(String stateMachineEnvironmentVariableName) Sets the value of FargateToStepfunctionsProps.getStateMachineEnvironmentVariableName()
FargateToStepfunctionsProps.Builder	stateMachineProps(software.amazon.awscdk.services.stepfunctions.StateMachineProps stateMachineProps) Sets the value of FargateToStepfunctionsProps.getStateMachineProps()
FargateToStepfunctionsProps.Builder	vpcProps(software.amazon.awscdk.services.ec2.VpcProps vpcProps) Sets the value of FargateToStepfunctionsProps.getVpcProps()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

Builder

public Builder()

Method Detail

publicApi

public FargateToStepfunctionsProps.Builder publicApi(Boolean publicApi)

Sets the value of FargateToStepfunctionsProps.getPublicApi()

Parameters:

publicApi - Whether the construct is deploying a private or public API. This parameter is required. This has implications for the VPC deployed by this construct.

Returns:

this

stateMachineProps

public FargateToStepfunctionsProps.Builder stateMachineProps(software.amazon.awscdk.services.stepfunctions.StateMachineProps stateMachineProps)

Sets the value of FargateToStepfunctionsProps.getStateMachineProps()

Parameters:

stateMachineProps - User provided StateMachineProps to override the defaults. This parameter is required.

Returns:

this

clusterProps

public FargateToStepfunctionsProps.Builder clusterProps(software.amazon.awscdk.services.ecs.ClusterProps clusterProps)

Sets the value of FargateToStepfunctionsProps.getClusterProps()

Parameters:

clusterProps - Optional properties to create a new ECS cluster.

Returns:

this

containerDefinitionProps

public FargateToStepfunctionsProps.Builder containerDefinitionProps(Object containerDefinitionProps)

Sets the value of FargateToStepfunctionsProps.getContainerDefinitionProps()

Parameters:

containerDefinitionProps - the value to be set.

Returns:

this

createCloudWatchAlarms

public FargateToStepfunctionsProps.Builder createCloudWatchAlarms(Boolean createCloudWatchAlarms)

Sets the value of FargateToStepfunctionsProps.getCreateCloudWatchAlarms()

Parameters:

createCloudWatchAlarms - Whether to create recommended CloudWatch alarms.

Returns:

this

ecrImageVersion

public FargateToStepfunctionsProps.Builder ecrImageVersion(String ecrImageVersion)

Sets the value of FargateToStepfunctionsProps.getEcrImageVersion()

Parameters:

ecrImageVersion - The version of the image to use from the repository.

Returns:

this

ecrRepositoryArn

public FargateToStepfunctionsProps.Builder ecrRepositoryArn(String ecrRepositoryArn)

Sets the value of FargateToStepfunctionsProps.getEcrRepositoryArn()

Parameters:

ecrRepositoryArn - The arn of an ECR Repository containing the image to use to generate the containers. format: arn:aws:ecr:[region]:[account number]:repository/[Repository Name]

Returns:

this

existingContainerDefinitionObject

public FargateToStepfunctionsProps.Builder existingContainerDefinitionObject(software.amazon.awscdk.services.ecs.ContainerDefinition existingContainerDefinitionObject)

Sets the value of FargateToStepfunctionsProps.getExistingContainerDefinitionObject()

Parameters:

existingContainerDefinitionObject - the value to be set.

Returns:

this

existingFargateServiceObject

public FargateToStepfunctionsProps.Builder existingFargateServiceObject(software.amazon.awscdk.services.ecs.FargateService existingFargateServiceObject)

Sets the value of FargateToStepfunctionsProps.getExistingFargateServiceObject()

Parameters:

existingFargateServiceObject - A Fargate Service already instantiated (probably by another Solutions Construct). If this is specified, then no props defining a new service can be provided, including: existingImageObject, ecrImageVersion, containerDefintionProps, fargateTaskDefinitionProps, ecrRepositoryArn, fargateServiceProps, clusterProps, existingClusterInterface. If this value is provided, then existingContainerDefinitionObject must be provided as well.

Returns:

this

existingVpc

public FargateToStepfunctionsProps.Builder existingVpc(software.amazon.awscdk.services.ec2.IVpc existingVpc)

Sets the value of FargateToStepfunctionsProps.getExistingVpc()

Parameters:

existingVpc - An existing VPC in which to deploy the construct. Providing both this and vpcProps is an error. If the client provides an existing Fargate service, this value must be the VPC where the service is running. A Step Functions Interface endpoint will be added to this VPC.

Returns:

this

fargateServiceProps

public FargateToStepfunctionsProps.Builder fargateServiceProps(Object fargateServiceProps)

Sets the value of FargateToStepfunctionsProps.getFargateServiceProps()

Parameters:

fargateServiceProps - Optional values to override default Fargate Task definition properties (fargate-defaults.ts). The construct will default to launching the service is the most isolated subnets available (precedence: Isolated, Private and Public). Override those and other defaults here. defaults - fargate-defaults.ts

Returns:

this

fargateTaskDefinitionProps

public FargateToStepfunctionsProps.Builder fargateTaskDefinitionProps(Object fargateTaskDefinitionProps)

Sets the value of FargateToStepfunctionsProps.getFargateTaskDefinitionProps()

Parameters:

fargateTaskDefinitionProps - the value to be set.

Returns:

this

logGroupProps

public FargateToStepfunctionsProps.Builder logGroupProps(software.amazon.awscdk.services.logs.LogGroupProps logGroupProps)

Sets the value of FargateToStepfunctionsProps.getLogGroupProps()

Parameters:

logGroupProps - User provided props to override the default props for the CloudWatchLogs LogGroup.

Returns:

this

stateMachineEnvironmentVariableName

public FargateToStepfunctionsProps.Builder stateMachineEnvironmentVariableName(String stateMachineEnvironmentVariableName)

Sets the value of FargateToStepfunctionsProps.getStateMachineEnvironmentVariableName()

Parameters:

stateMachineEnvironmentVariableName - Optional Name for the container environment variable set to the ARN of the state machine.

Returns:

this

vpcProps

public FargateToStepfunctionsProps.Builder vpcProps(software.amazon.awscdk.services.ec2.VpcProps vpcProps)

Sets the value of FargateToStepfunctionsProps.getVpcProps()

Parameters:

vpcProps - Optional custom properties for a VPC the construct will create. This VPC will be used by the new Fargate service the construct creates (that's why targetGroupProps can't include a VPC). Providing both this and existingVpc is an error. A Step Functions Interface endpoint will be included in this VPC.

Returns:

this

build

public FargateToStepfunctionsProps build()

Builds the configured instance.

Specified by:

build in interface software.amazon.jsii.Builder<FargateToStepfunctionsProps>

Returns:

a new instance of FargateToStepfunctionsProps

Throws:

NullPointerException - if any required attribute was not provided