public static final class FargateToStepfunctionsProps.Builder extends Object implements software.amazon.jsii.Builder<FargateToStepfunctionsProps>
FargateToStepfunctionsProps| Constructor and Description |
|---|
Builder() |
public FargateToStepfunctionsProps.Builder publicApi(Boolean publicApi)
FargateToStepfunctionsProps.getPublicApi()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.thispublic FargateToStepfunctionsProps.Builder stateMachineProps(software.amazon.awscdk.services.stepfunctions.StateMachineProps stateMachineProps)
FargateToStepfunctionsProps.getStateMachineProps()stateMachineProps - User provided StateMachineProps to override the defaults. This parameter is required.thispublic FargateToStepfunctionsProps.Builder clusterProps(software.amazon.awscdk.services.ecs.ClusterProps clusterProps)
FargateToStepfunctionsProps.getClusterProps()clusterProps - Optional properties to create a new ECS cluster.thispublic FargateToStepfunctionsProps.Builder containerDefinitionProps(Object containerDefinitionProps)
FargateToStepfunctionsProps.getContainerDefinitionProps()containerDefinitionProps - the value to be set.thispublic FargateToStepfunctionsProps.Builder createCloudWatchAlarms(Boolean createCloudWatchAlarms)
FargateToStepfunctionsProps.getCreateCloudWatchAlarms()createCloudWatchAlarms - Whether to create recommended CloudWatch alarms.thispublic FargateToStepfunctionsProps.Builder ecrImageVersion(String ecrImageVersion)
FargateToStepfunctionsProps.getEcrImageVersion()ecrImageVersion - The version of the image to use from the repository.thispublic FargateToStepfunctionsProps.Builder ecrRepositoryArn(String ecrRepositoryArn)
FargateToStepfunctionsProps.getEcrRepositoryArn()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]thispublic FargateToStepfunctionsProps.Builder existingContainerDefinitionObject(software.amazon.awscdk.services.ecs.ContainerDefinition existingContainerDefinitionObject)
FargateToStepfunctionsProps.getExistingContainerDefinitionObject()existingContainerDefinitionObject - the value to be set.thispublic FargateToStepfunctionsProps.Builder existingFargateServiceObject(software.amazon.awscdk.services.ecs.FargateService existingFargateServiceObject)
FargateToStepfunctionsProps.getExistingFargateServiceObject()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.thispublic FargateToStepfunctionsProps.Builder existingVpc(software.amazon.awscdk.services.ec2.IVpc existingVpc)
FargateToStepfunctionsProps.getExistingVpc()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.thispublic FargateToStepfunctionsProps.Builder fargateServiceProps(Object fargateServiceProps)
FargateToStepfunctionsProps.getFargateServiceProps()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.tsthispublic FargateToStepfunctionsProps.Builder fargateTaskDefinitionProps(Object fargateTaskDefinitionProps)
FargateToStepfunctionsProps.getFargateTaskDefinitionProps()fargateTaskDefinitionProps - the value to be set.thispublic FargateToStepfunctionsProps.Builder logGroupProps(software.amazon.awscdk.services.logs.LogGroupProps logGroupProps)
FargateToStepfunctionsProps.getLogGroupProps()logGroupProps - User provided props to override the default props for the CloudWatchLogs LogGroup.thispublic FargateToStepfunctionsProps.Builder stateMachineEnvironmentVariableName(String stateMachineEnvironmentVariableName)
FargateToStepfunctionsProps.getStateMachineEnvironmentVariableName()stateMachineEnvironmentVariableName - Optional Name for the container environment variable set to the ARN of the state machine.thispublic FargateToStepfunctionsProps.Builder vpcProps(software.amazon.awscdk.services.ec2.VpcProps vpcProps)
FargateToStepfunctionsProps.getVpcProps()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.thispublic FargateToStepfunctionsProps build()
build in interface software.amazon.jsii.Builder<FargateToStepfunctionsProps>FargateToStepfunctionsPropsNullPointerException - if any required attribute was not providedCopyright © 2022. All rights reserved.