software.amazon.awsconstructs.services.fargatestepfunctions

Class FargateToStepfunctionsProps.Jsii$Proxy

java.lang.Object

software.amazon.jsii.JsiiObject

software.amazon.awsconstructs.services.fargatestepfunctions.FargateToStepfunctionsProps.Jsii$Proxy

All Implemented Interfaces:

FargateToStepfunctionsProps, software.amazon.jsii.JsiiSerializable

Enclosing interface:

FargateToStepfunctionsProps

@Internal
public static final class FargateToStepfunctionsProps.Jsii$Proxy
extends software.amazon.jsii.JsiiObject
implements FargateToStepfunctionsProps

An implementation for FargateToStepfunctionsProps

Nested Class Summary

Nested classes/interfaces inherited from class software.amazon.jsii.JsiiObject

software.amazon.jsii.JsiiObject.InitializationMode

Nested classes/interfaces inherited from interface software.amazon.awsconstructs.services.fargatestepfunctions.FargateToStepfunctionsProps

FargateToStepfunctionsProps.Builder, FargateToStepfunctionsProps.Jsii$Proxy

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	Jsii$Proxy(FargateToStepfunctionsProps.Builder builder) Constructor that initializes the object based on literal property values passed by the FargateToStepfunctionsProps.Builder.
protected	Jsii$Proxy(software.amazon.jsii.JsiiObjectRef objRef) Constructor that initializes the object based on values retrieved from the JsiiObject.

Method Summary

Modifier and Type	Method and Description
com.fasterxml.jackson.databind.JsonNode	$jsii$toJson()
boolean	equals(Object o)
software.amazon.awscdk.services.ecs.ClusterProps	getClusterProps() Optional properties to create a new ECS cluster.
Object	getContainerDefinitionProps()
Boolean	getCreateCloudWatchAlarms() Whether to create recommended CloudWatch alarms.
String	getEcrImageVersion() The version of the image to use from the repository.
String	getEcrRepositoryArn() The arn of an ECR Repository containing the image to use to generate the containers.
software.amazon.awscdk.services.ecs.ContainerDefinition	getExistingContainerDefinitionObject()
software.amazon.awscdk.services.ecs.FargateService	getExistingFargateServiceObject() A Fargate Service already instantiated (probably by another Solutions Construct).
software.amazon.awscdk.services.ec2.IVpc	getExistingVpc() An existing VPC in which to deploy the construct.
Object	getFargateServiceProps() Optional values to override default Fargate Task definition properties (fargate-defaults.ts).
Object	getFargateTaskDefinitionProps()
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.
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.
software.amazon.awscdk.services.ec2.VpcProps	getVpcProps() Optional custom properties for a VPC the construct will create.
int	hashCode()

Methods inherited from class software.amazon.jsii.JsiiObject

jsiiAsyncCall, jsiiAsyncCall, jsiiCall, jsiiCall, jsiiGet, jsiiGet, jsiiSet, jsiiStaticCall, jsiiStaticCall, jsiiStaticGet, jsiiStaticGet, jsiiStaticSet, jsiiStaticSet

Methods inherited from class java.lang.Object

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

Methods inherited from interface software.amazon.awsconstructs.services.fargatestepfunctions.FargateToStepfunctionsProps

builder

Constructor Detail

Jsii$Proxy

protected Jsii$Proxy(software.amazon.jsii.JsiiObjectRef objRef)

Constructor that initializes the object based on values retrieved from the JsiiObject.

Parameters:

objRef - Reference to the JSII managed object.

Jsii$Proxy

protected Jsii$Proxy(FargateToStepfunctionsProps.Builder builder)

Constructor that initializes the object based on literal property values passed by the FargateToStepfunctionsProps.Builder.

Method Detail

getPublicApi

public final Boolean getPublicApi()

Description copied from interface: FargateToStepfunctionsProps

Whether the construct is deploying a private or public API.

This has implications for the VPC deployed by this construct.

Default: - none

Specified by:

getPublicApi in interface FargateToStepfunctionsProps

getStateMachineProps

public final software.amazon.awscdk.services.stepfunctions.StateMachineProps getStateMachineProps()

Description copied from interface: FargateToStepfunctionsProps

User provided StateMachineProps to override the defaults.

Default: - None

Specified by:

getStateMachineProps in interface FargateToStepfunctionsProps

getClusterProps

public final software.amazon.awscdk.services.ecs.ClusterProps getClusterProps()

Description copied from interface: FargateToStepfunctionsProps

Optional properties to create a new ECS cluster.

Specified by:

getClusterProps in interface FargateToStepfunctionsProps

getContainerDefinitionProps

public final Object getContainerDefinitionProps()

Specified by:

getContainerDefinitionProps in interface FargateToStepfunctionsProps

getCreateCloudWatchAlarms

public final Boolean getCreateCloudWatchAlarms()

Description copied from interface: FargateToStepfunctionsProps

Whether to create recommended CloudWatch alarms.

Default: - true

Specified by:

getCreateCloudWatchAlarms in interface FargateToStepfunctionsProps

getEcrImageVersion

public final String getEcrImageVersion()

Description copied from interface: FargateToStepfunctionsProps

The version of the image to use from the repository.

Default: - 'latest'

Specified by:

getEcrImageVersion in interface FargateToStepfunctionsProps

getEcrRepositoryArn

public final String getEcrRepositoryArn()

Description copied from interface: FargateToStepfunctionsProps

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]

Specified by:

getEcrRepositoryArn in interface FargateToStepfunctionsProps

getExistingContainerDefinitionObject

public final software.amazon.awscdk.services.ecs.ContainerDefinition getExistingContainerDefinitionObject()

Specified by:

getExistingContainerDefinitionObject in interface FargateToStepfunctionsProps

getExistingFargateServiceObject

public final software.amazon.awscdk.services.ecs.FargateService getExistingFargateServiceObject()

Description copied from interface: FargateToStepfunctionsProps

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

Specified by:

getExistingFargateServiceObject in interface FargateToStepfunctionsProps

getExistingVpc

public final software.amazon.awscdk.services.ec2.IVpc getExistingVpc()

Description copied from interface: FargateToStepfunctionsProps

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

Specified by:

getExistingVpc in interface FargateToStepfunctionsProps

getFargateServiceProps

public final Object getFargateServiceProps()

Description copied from interface: FargateToStepfunctionsProps

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

Specified by:

getFargateServiceProps in interface FargateToStepfunctionsProps

getFargateTaskDefinitionProps

public final Object getFargateTaskDefinitionProps()

Specified by:

getFargateTaskDefinitionProps in interface FargateToStepfunctionsProps

getLogGroupProps

public final software.amazon.awscdk.services.logs.LogGroupProps getLogGroupProps()

Description copied from interface: FargateToStepfunctionsProps

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

Default: - Default props are used

Specified by:

getLogGroupProps in interface FargateToStepfunctionsProps

getStateMachineEnvironmentVariableName

public final String getStateMachineEnvironmentVariableName()

Description copied from interface: FargateToStepfunctionsProps

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

Default: - STATE_MACHINE_ARN

Specified by:

getStateMachineEnvironmentVariableName in interface FargateToStepfunctionsProps

getVpcProps

public final software.amazon.awscdk.services.ec2.VpcProps getVpcProps()

Description copied from interface: FargateToStepfunctionsProps

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.

Specified by:

getVpcProps in interface FargateToStepfunctionsProps

$jsii$toJson

@Internal
public com.fasterxml.jackson.databind.JsonNode $jsii$toJson()

Specified by:

$jsii$toJson in interface software.amazon.jsii.JsiiSerializable

equals

public final boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public final int hashCode()

Overrides:

hashCode in class Object