software.amazon.awsconstructs.services.fargatestepfunctions

Interface FargateToStepfunctionsProps

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

FargateToStepfunctionsProps.Jsii$Proxy

@Generated(value="jsii-pacmak/1.67.0 (build 2c027f5)",
           date="2022-09-14T01:00:23.950Z")
public interface FargateToStepfunctionsProps
extends software.amazon.jsii.JsiiSerializable

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	FargateToStepfunctionsProps.Builder A builder for FargateToStepfunctionsProps
static class	FargateToStepfunctionsProps.Jsii$Proxy An implementation for FargateToStepfunctionsProps

Method Summary

Modifier and Type	Method and Description
static FargateToStepfunctionsProps.Builder	builder()
default software.amazon.awscdk.services.ecs.ClusterProps	getClusterProps() Optional properties to create a new ECS cluster.
default Object	getContainerDefinitionProps()
default Boolean	getCreateCloudWatchAlarms() Whether to create recommended CloudWatch alarms.
default String	getEcrImageVersion() The version of the image to use from the repository.
default String	getEcrRepositoryArn() The arn of an ECR Repository containing the image to use to generate the containers.
default software.amazon.awscdk.services.ecs.ContainerDefinition	getExistingContainerDefinitionObject()
default software.amazon.awscdk.services.ecs.FargateService	getExistingFargateServiceObject() A Fargate Service already instantiated (probably by another Solutions Construct).
default software.amazon.awscdk.services.ec2.IVpc	getExistingVpc() An existing VPC in which to deploy the construct.
default Object	getFargateServiceProps() Optional values to override default Fargate Task definition properties (fargate-defaults.ts).
default Object	getFargateTaskDefinitionProps()
default software.amazon.awscdk.services.logs.LogGroupProps	getLogGroupProps() User provided props to override the default props for the CloudWatchLogs LogGroup.
Boolean	getPublicApi() Whether the construct is deploying a private or public API.
default String	getStateMachineEnvironmentVariableName() Optional Name for the container environment variable set to the ARN of the state machine.
software.amazon.awscdk.services.stepfunctions.StateMachineProps	getStateMachineProps() User provided StateMachineProps to override the defaults.
default software.amazon.awscdk.services.ec2.VpcProps	getVpcProps() Optional custom properties for a VPC the construct will create.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Detail

getPublicApi

@NotNull
Boolean getPublicApi()

Whether the construct is deploying a private or public API.

This has implications for the VPC deployed by this construct.

Default: - none

getStateMachineProps

@NotNull
software.amazon.awscdk.services.stepfunctions.StateMachineProps getStateMachineProps()

User provided StateMachineProps to override the defaults.

Default: - None

getClusterProps

@Nullable
default software.amazon.awscdk.services.ecs.ClusterProps getClusterProps()

Optional properties to create a new ECS cluster.

getContainerDefinitionProps

@Nullable
default Object getContainerDefinitionProps()

getCreateCloudWatchAlarms

@Nullable
default Boolean getCreateCloudWatchAlarms()

Whether to create recommended CloudWatch alarms.

Default: - true

getEcrImageVersion

@Nullable
default String getEcrImageVersion()

The version of the image to use from the repository.

Default: - 'latest'

getEcrRepositoryArn

@Nullable
default String getEcrRepositoryArn()

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]

getExistingContainerDefinitionObject

@Nullable
default software.amazon.awscdk.services.ecs.ContainerDefinition getExistingContainerDefinitionObject()

getExistingFargateServiceObject

@Nullable
default software.amazon.awscdk.services.ecs.FargateService getExistingFargateServiceObject()

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

getExistingVpc

@Nullable
default software.amazon.awscdk.services.ec2.IVpc getExistingVpc()

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

getFargateServiceProps

@Nullable
default Object getFargateServiceProps()

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

getFargateTaskDefinitionProps

@Nullable
default Object getFargateTaskDefinitionProps()

getLogGroupProps

@Nullable
default software.amazon.awscdk.services.logs.LogGroupProps getLogGroupProps()

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

Default: - Default props are used

getStateMachineEnvironmentVariableName

@Nullable
default String getStateMachineEnvironmentVariableName()

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

Default: - STATE_MACHINE_ARN

getVpcProps

@Nullable
default software.amazon.awscdk.services.ec2.VpcProps getVpcProps()

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.

builder

static FargateToStepfunctionsProps.Builder builder()

Returns:

a FargateToStepfunctionsProps.Builder of FargateToStepfunctionsProps