software.amazon.awsconstructs.services.fargatestepfunctions

Class FargateToStepfunctions.Builder

java.lang.Object

software.amazon.awsconstructs.services.fargatestepfunctions.FargateToStepfunctions.Builder

All Implemented Interfaces:

software.amazon.jsii.Builder<FargateToStepfunctions>

Enclosing class:

FargateToStepfunctions

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

A fluent builder for FargateToStepfunctions.

Method Summary

Modifier and Type	Method and Description
FargateToStepfunctions	build()
FargateToStepfunctions.Builder	clusterProps(software.amazon.awscdk.services.ecs.ClusterProps clusterProps) Optional properties to create a new ECS cluster.
FargateToStepfunctions.Builder	containerDefinitionProps(Object containerDefinitionProps)
static FargateToStepfunctions.Builder	create(software.amazon.awscdk.core.Construct scope, String id)
FargateToStepfunctions.Builder	createCloudWatchAlarms(Boolean createCloudWatchAlarms) Whether to create recommended CloudWatch alarms.
FargateToStepfunctions.Builder	ecrImageVersion(String ecrImageVersion) The version of the image to use from the repository.
FargateToStepfunctions.Builder	ecrRepositoryArn(String ecrRepositoryArn) The arn of an ECR Repository containing the image to use to generate the containers.
FargateToStepfunctions.Builder	existingContainerDefinitionObject(software.amazon.awscdk.services.ecs.ContainerDefinition existingContainerDefinitionObject)
FargateToStepfunctions.Builder	existingFargateServiceObject(software.amazon.awscdk.services.ecs.FargateService existingFargateServiceObject) A Fargate Service already instantiated (probably by another Solutions Construct).
FargateToStepfunctions.Builder	existingVpc(software.amazon.awscdk.services.ec2.IVpc existingVpc) An existing VPC in which to deploy the construct.
FargateToStepfunctions.Builder	fargateServiceProps(Object fargateServiceProps) Optional values to override default Fargate Task definition properties (fargate-defaults.ts).
FargateToStepfunctions.Builder	fargateTaskDefinitionProps(Object fargateTaskDefinitionProps)
FargateToStepfunctions.Builder	logGroupProps(software.amazon.awscdk.services.logs.LogGroupProps logGroupProps) User provided props to override the default props for the CloudWatchLogs LogGroup.
FargateToStepfunctions.Builder	publicApi(Boolean publicApi) Whether the construct is deploying a private or public API.
FargateToStepfunctions.Builder	stateMachineEnvironmentVariableName(String stateMachineEnvironmentVariableName) Optional Name for the container environment variable set to the ARN of the state machine.
FargateToStepfunctions.Builder	stateMachineProps(software.amazon.awscdk.services.stepfunctions.StateMachineProps stateMachineProps) User provided StateMachineProps to override the defaults.
FargateToStepfunctions.Builder	vpcProps(software.amazon.awscdk.services.ec2.VpcProps vpcProps) Optional custom properties for a VPC the construct will create.

Methods inherited from class java.lang.Object

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

Method Detail

create

public static FargateToStepfunctions.Builder create(software.amazon.awscdk.core.Construct scope,
                                                    String id)

Parameters:

scope - This parameter is required.

id - This parameter is required.

Returns:

a new instance of FargateToStepfunctions.Builder.

publicApi

public FargateToStepfunctions.Builder publicApi(Boolean publicApi)

Whether the construct is deploying a private or public API.

This has implications for the VPC deployed by this construct.

Default: - none

Parameters:

publicApi - Whether the construct is deploying a private or public API. This parameter is required.

Returns:

this

stateMachineProps

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

User provided StateMachineProps to override the defaults.

Default: - None

Parameters:

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

Returns:

this

clusterProps

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

Optional properties to create a new ECS cluster.

Parameters:

clusterProps - Optional properties to create a new ECS cluster. This parameter is required.

Returns:

this

containerDefinitionProps

public FargateToStepfunctions.Builder containerDefinitionProps(Object containerDefinitionProps)

Parameters:

containerDefinitionProps - This parameter is required.

Returns:

this

createCloudWatchAlarms

public FargateToStepfunctions.Builder createCloudWatchAlarms(Boolean createCloudWatchAlarms)

Whether to create recommended CloudWatch alarms.

Default: - true

Parameters:

createCloudWatchAlarms - Whether to create recommended CloudWatch alarms. This parameter is required.

Returns:

this

ecrImageVersion

public FargateToStepfunctions.Builder ecrImageVersion(String ecrImageVersion)

The version of the image to use from the repository.

Default: - 'latest'

Parameters:

ecrImageVersion - The version of the image to use from the repository. This parameter is required.

Returns:

this

ecrRepositoryArn

public FargateToStepfunctions.Builder ecrRepositoryArn(String 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]

Parameters:

ecrRepositoryArn - The arn of an ECR Repository containing the image to use to generate the containers. This parameter is required.

Returns:

this

existingContainerDefinitionObject

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

Parameters:

existingContainerDefinitionObject - This parameter is required.

Returns:

this

existingFargateServiceObject

public FargateToStepfunctions.Builder existingFargateServiceObject(software.amazon.awscdk.services.ecs.FargateService 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.

Default: - none

Parameters:

existingFargateServiceObject - A Fargate Service already instantiated (probably by another Solutions Construct). This parameter is required.

Returns:

this

existingVpc

public FargateToStepfunctions.Builder existingVpc(software.amazon.awscdk.services.ec2.IVpc 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.

Default: - none

Parameters:

existingVpc - An existing VPC in which to deploy the construct. This parameter is required.

Returns:

this

fargateServiceProps

public FargateToStepfunctions.Builder fargateServiceProps(Object 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

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. This parameter is required.

Returns:

this

fargateTaskDefinitionProps

public FargateToStepfunctions.Builder fargateTaskDefinitionProps(Object fargateTaskDefinitionProps)

Parameters:

fargateTaskDefinitionProps - This parameter is required.

Returns:

this

logGroupProps

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

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

Default: - Default props are used

Parameters:

logGroupProps - User provided props to override the default props for the CloudWatchLogs LogGroup. This parameter is required.

Returns:

this

stateMachineEnvironmentVariableName

public FargateToStepfunctions.Builder stateMachineEnvironmentVariableName(String stateMachineEnvironmentVariableName)

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

Default: - STATE_MACHINE_ARN

Parameters:

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

Returns:

this

vpcProps

public FargateToStepfunctions.Builder vpcProps(software.amazon.awscdk.services.ec2.VpcProps 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.

Default: - A set of defaults from vpc-defaults.ts: DefaultPublicPrivateVpcProps() for public APIs and DefaultIsolatedVpcProps() for private APIs.

Parameters:

vpcProps - Optional custom properties for a VPC the construct will create. This parameter is required.

Returns:

this

build

public FargateToStepfunctions build()

Specified by:

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