software.amazon.awsconstructs.services.fargatessmstringparameter

Class FargateToSsmstringparameterProps.Jsii$Proxy

java.lang.Object

software.amazon.jsii.JsiiObject

software.amazon.awsconstructs.services.fargatessmstringparameter.FargateToSsmstringparameterProps.Jsii$Proxy

All Implemented Interfaces:

FargateToSsmstringparameterProps, software.amazon.jsii.JsiiSerializable

Enclosing interface:

FargateToSsmstringparameterProps

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

An implementation for FargateToSsmstringparameterProps

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.fargatessmstringparameter.FargateToSsmstringparameterProps

FargateToSsmstringparameterProps.Builder, FargateToSsmstringparameterProps.Jsii$Proxy

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	Jsii$Proxy(FargateToSsmstringparameterProps.Builder builder) Constructor that initializes the object based on literal property values passed by the FargateToSsmstringparameterProps.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()
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.ssm.StringParameter	getExistingStringParameterObj() Optional user provided props to override the default props for SSM String Parameter.
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()
Boolean	getPublicApi() Whether the construct is deploying a private or public API.
String	getStringParameterEnvironmentVariableName() Optional Name for the container environment variable set to the SSM parameter name.
String	getStringParameterPermissions() Optional SSM String parameter permissions to grant to the Fargate service.
software.amazon.awscdk.services.ssm.StringParameterProps	getStringParameterProps() Optional user provided props to override the default props for SSM String Parameter.
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.fargatessmstringparameter.FargateToSsmstringparameterProps

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(FargateToSsmstringparameterProps.Builder builder)

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

Method Detail

getPublicApi

public final Boolean getPublicApi()

Description copied from interface: FargateToSsmstringparameterProps

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 FargateToSsmstringparameterProps

getClusterProps

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

Description copied from interface: FargateToSsmstringparameterProps

Optional properties to create a new ECS cluster.

Specified by:

getClusterProps in interface FargateToSsmstringparameterProps

getContainerDefinitionProps

public final Object getContainerDefinitionProps()

Specified by:

getContainerDefinitionProps in interface FargateToSsmstringparameterProps

getEcrImageVersion

public final String getEcrImageVersion()

Description copied from interface: FargateToSsmstringparameterProps

The version of the image to use from the repository.

Default: - 'latest'

Specified by:

getEcrImageVersion in interface FargateToSsmstringparameterProps

getEcrRepositoryArn

public final String getEcrRepositoryArn()

Description copied from interface: FargateToSsmstringparameterProps

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 FargateToSsmstringparameterProps

getExistingContainerDefinitionObject

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

Specified by:

getExistingContainerDefinitionObject in interface FargateToSsmstringparameterProps

getExistingFargateServiceObject

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

Description copied from interface: FargateToSsmstringparameterProps

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 FargateToSsmstringparameterProps

getExistingStringParameterObj

public final software.amazon.awscdk.services.ssm.StringParameter getExistingStringParameterObj()

Description copied from interface: FargateToSsmstringparameterProps

Optional user provided props to override the default props for SSM String Parameter.

Default: - None

Specified by:

getExistingStringParameterObj in interface FargateToSsmstringparameterProps

getExistingVpc

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

Description copied from interface: FargateToSsmstringparameterProps

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. An SSM Interface endpoint will be added to this VPC.

Default: - none

Specified by:

getExistingVpc in interface FargateToSsmstringparameterProps

getFargateServiceProps

public final Object getFargateServiceProps()

Description copied from interface: FargateToSsmstringparameterProps

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 FargateToSsmstringparameterProps

getFargateTaskDefinitionProps

public final Object getFargateTaskDefinitionProps()

Specified by:

getFargateTaskDefinitionProps in interface FargateToSsmstringparameterProps

getStringParameterEnvironmentVariableName

public final String getStringParameterEnvironmentVariableName()

Description copied from interface: FargateToSsmstringparameterProps

Optional Name for the container environment variable set to the SSM parameter name.

Default: - SSM_STRING_PARAMETER_NAME

Specified by:

getStringParameterEnvironmentVariableName in interface FargateToSsmstringparameterProps

getStringParameterPermissions

public final String getStringParameterPermissions()

Description copied from interface: FargateToSsmstringparameterProps

Optional SSM String parameter permissions to grant to the Fargate service.

One of the following may be specified: "Read", "ReadWrite".

Default: - 'Read'

Specified by:

getStringParameterPermissions in interface FargateToSsmstringparameterProps

getStringParameterProps

public final software.amazon.awscdk.services.ssm.StringParameterProps getStringParameterProps()

Description copied from interface: FargateToSsmstringparameterProps

Optional user provided props to override the default props for SSM String Parameter.

Default: - Default props are used

Specified by:

getStringParameterProps in interface FargateToSsmstringparameterProps

getVpcProps

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

Description copied from interface: FargateToSsmstringparameterProps

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. An SSM Interface endpoint will be included in this VPC.

Default: - none

Specified by:

getVpcProps in interface FargateToSsmstringparameterProps

$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