software.amazon.awsconstructs.services.fargatessmstringparameter

Class FargateToSsmstringparameterProps.Builder

java.lang.Object

software.amazon.awsconstructs.services.fargatessmstringparameter.FargateToSsmstringparameterProps.Builder

All Implemented Interfaces:

software.amazon.jsii.Builder<FargateToSsmstringparameterProps>

Enclosing interface:

FargateToSsmstringparameterProps

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

A builder for FargateToSsmstringparameterProps

Constructor Summary

Constructors

Constructor and Description
Builder()

Method Summary

Modifier and Type	Method and Description
FargateToSsmstringparameterProps	build() Builds the configured instance.
FargateToSsmstringparameterProps.Builder	clusterProps(software.amazon.awscdk.services.ecs.ClusterProps clusterProps) Sets the value of FargateToSsmstringparameterProps.getClusterProps()
FargateToSsmstringparameterProps.Builder	containerDefinitionProps(Object containerDefinitionProps) Sets the value of FargateToSsmstringparameterProps.getContainerDefinitionProps()
FargateToSsmstringparameterProps.Builder	ecrImageVersion(String ecrImageVersion) Sets the value of FargateToSsmstringparameterProps.getEcrImageVersion()
FargateToSsmstringparameterProps.Builder	ecrRepositoryArn(String ecrRepositoryArn) Sets the value of FargateToSsmstringparameterProps.getEcrRepositoryArn()
FargateToSsmstringparameterProps.Builder	existingContainerDefinitionObject(software.amazon.awscdk.services.ecs.ContainerDefinition existingContainerDefinitionObject) Sets the value of FargateToSsmstringparameterProps.getExistingContainerDefinitionObject()
FargateToSsmstringparameterProps.Builder	existingFargateServiceObject(software.amazon.awscdk.services.ecs.FargateService existingFargateServiceObject) Sets the value of FargateToSsmstringparameterProps.getExistingFargateServiceObject()
FargateToSsmstringparameterProps.Builder	existingStringParameterObj(software.amazon.awscdk.services.ssm.StringParameter existingStringParameterObj) Sets the value of FargateToSsmstringparameterProps.getExistingStringParameterObj()
FargateToSsmstringparameterProps.Builder	existingVpc(software.amazon.awscdk.services.ec2.IVpc existingVpc) Sets the value of FargateToSsmstringparameterProps.getExistingVpc()
FargateToSsmstringparameterProps.Builder	fargateServiceProps(Object fargateServiceProps) Sets the value of FargateToSsmstringparameterProps.getFargateServiceProps()
FargateToSsmstringparameterProps.Builder	fargateTaskDefinitionProps(Object fargateTaskDefinitionProps) Sets the value of FargateToSsmstringparameterProps.getFargateTaskDefinitionProps()
FargateToSsmstringparameterProps.Builder	publicApi(Boolean publicApi) Sets the value of FargateToSsmstringparameterProps.getPublicApi()
FargateToSsmstringparameterProps.Builder	stringParameterEnvironmentVariableName(String stringParameterEnvironmentVariableName) Sets the value of FargateToSsmstringparameterProps.getStringParameterEnvironmentVariableName()
FargateToSsmstringparameterProps.Builder	stringParameterPermissions(String stringParameterPermissions) Sets the value of FargateToSsmstringparameterProps.getStringParameterPermissions()
FargateToSsmstringparameterProps.Builder	stringParameterProps(software.amazon.awscdk.services.ssm.StringParameterProps stringParameterProps) Sets the value of FargateToSsmstringparameterProps.getStringParameterProps()
FargateToSsmstringparameterProps.Builder	vpcProps(software.amazon.awscdk.services.ec2.VpcProps vpcProps) Sets the value of FargateToSsmstringparameterProps.getVpcProps()

Methods inherited from class java.lang.Object

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

Constructor Detail

Builder

public Builder()

Method Detail

publicApi

public FargateToSsmstringparameterProps.Builder publicApi(Boolean publicApi)

Sets the value of FargateToSsmstringparameterProps.getPublicApi()

Parameters:

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.

Returns:

this

clusterProps

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

Sets the value of FargateToSsmstringparameterProps.getClusterProps()

Parameters:

clusterProps - Optional properties to create a new ECS cluster.

Returns:

this

containerDefinitionProps

public FargateToSsmstringparameterProps.Builder containerDefinitionProps(Object containerDefinitionProps)

Sets the value of FargateToSsmstringparameterProps.getContainerDefinitionProps()

Parameters:

containerDefinitionProps - the value to be set.

Returns:

this

ecrImageVersion

public FargateToSsmstringparameterProps.Builder ecrImageVersion(String ecrImageVersion)

Sets the value of FargateToSsmstringparameterProps.getEcrImageVersion()

Parameters:

ecrImageVersion - The version of the image to use from the repository.

Returns:

this

ecrRepositoryArn

public FargateToSsmstringparameterProps.Builder ecrRepositoryArn(String ecrRepositoryArn)

Sets the value of FargateToSsmstringparameterProps.getEcrRepositoryArn()

Parameters:

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]

Returns:

this

existingContainerDefinitionObject

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

Sets the value of FargateToSsmstringparameterProps.getExistingContainerDefinitionObject()

Parameters:

existingContainerDefinitionObject - the value to be set.

Returns:

this

existingFargateServiceObject

public FargateToSsmstringparameterProps.Builder existingFargateServiceObject(software.amazon.awscdk.services.ecs.FargateService existingFargateServiceObject)

Sets the value of FargateToSsmstringparameterProps.getExistingFargateServiceObject()

Parameters:

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.

Returns:

this

existingStringParameterObj

public FargateToSsmstringparameterProps.Builder existingStringParameterObj(software.amazon.awscdk.services.ssm.StringParameter existingStringParameterObj)

Sets the value of FargateToSsmstringparameterProps.getExistingStringParameterObj()

Parameters:

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

Returns:

this

existingVpc

public FargateToSsmstringparameterProps.Builder existingVpc(software.amazon.awscdk.services.ec2.IVpc existingVpc)

Sets the value of FargateToSsmstringparameterProps.getExistingVpc()

Parameters:

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

Returns:

this

fargateServiceProps

public FargateToSsmstringparameterProps.Builder fargateServiceProps(Object fargateServiceProps)

Sets the value of FargateToSsmstringparameterProps.getFargateServiceProps()

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. defaults - fargate-defaults.ts

Returns:

this

fargateTaskDefinitionProps

public FargateToSsmstringparameterProps.Builder fargateTaskDefinitionProps(Object fargateTaskDefinitionProps)

Sets the value of FargateToSsmstringparameterProps.getFargateTaskDefinitionProps()

Parameters:

fargateTaskDefinitionProps - the value to be set.

Returns:

this

stringParameterEnvironmentVariableName

public FargateToSsmstringparameterProps.Builder stringParameterEnvironmentVariableName(String stringParameterEnvironmentVariableName)

Sets the value of FargateToSsmstringparameterProps.getStringParameterEnvironmentVariableName()

Parameters:

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

Returns:

this

stringParameterPermissions

public FargateToSsmstringparameterProps.Builder stringParameterPermissions(String stringParameterPermissions)

Sets the value of FargateToSsmstringparameterProps.getStringParameterPermissions()

Parameters:

stringParameterPermissions - Optional SSM String parameter permissions to grant to the Fargate service. One of the following may be specified: "Read", "ReadWrite".

Returns:

this

stringParameterProps

public FargateToSsmstringparameterProps.Builder stringParameterProps(software.amazon.awscdk.services.ssm.StringParameterProps stringParameterProps)

Sets the value of FargateToSsmstringparameterProps.getStringParameterProps()

Parameters:

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

Returns:

this

vpcProps

public FargateToSsmstringparameterProps.Builder vpcProps(software.amazon.awscdk.services.ec2.VpcProps vpcProps)

Sets the value of FargateToSsmstringparameterProps.getVpcProps()

Parameters:

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

Returns:

this

build

public FargateToSsmstringparameterProps build()

Builds the configured instance.

Specified by:

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

Returns:

a new instance of FargateToSsmstringparameterProps

Throws:

NullPointerException - if any required attribute was not provided