FargateToSsmstringparameter.Builder (software.amazon.awsconstructs:fargatessmstringparameter 1.175.0 API)

java.lang.Object
- software.amazon.awsconstructs.services.fargatessmstringparameter.FargateToSsmstringparameter.Builder

All Implemented Interfaces:

software.amazon.jsii.Builder<FargateToSsmstringparameter>

Enclosing class:

FargateToSsmstringparameter
```
public static final class FargateToSsmstringparameter.Builder
extends Object
implements software.amazon.jsii.Builder<FargateToSsmstringparameter>
```
A fluent builder for FargateToSsmstringparameter.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`FargateToSsmstringparameter`	`build()`
`FargateToSsmstringparameter.Builder`	`clusterProps(software.amazon.awscdk.services.ecs.ClusterProps clusterProps)` Optional properties to create a new ECS cluster.
`FargateToSsmstringparameter.Builder`	`containerDefinitionProps(Object containerDefinitionProps)`
`static FargateToSsmstringparameter.Builder`	`create(software.amazon.awscdk.core.Construct scope, String id)`
`FargateToSsmstringparameter.Builder`	`ecrImageVersion(String ecrImageVersion)` The version of the image to use from the repository.
`FargateToSsmstringparameter.Builder`	`ecrRepositoryArn(String ecrRepositoryArn)` The arn of an ECR Repository containing the image to use to generate the containers.
`FargateToSsmstringparameter.Builder`	`existingContainerDefinitionObject(software.amazon.awscdk.services.ecs.ContainerDefinition existingContainerDefinitionObject)`
`FargateToSsmstringparameter.Builder`	`existingFargateServiceObject(software.amazon.awscdk.services.ecs.FargateService existingFargateServiceObject)` A Fargate Service already instantiated (probably by another Solutions Construct).
`FargateToSsmstringparameter.Builder`	`existingStringParameterObj(software.amazon.awscdk.services.ssm.StringParameter existingStringParameterObj)` Optional user provided props to override the default props for SSM String Parameter.
`FargateToSsmstringparameter.Builder`	`existingVpc(software.amazon.awscdk.services.ec2.IVpc existingVpc)` An existing VPC in which to deploy the construct.
`FargateToSsmstringparameter.Builder`	`fargateServiceProps(Object fargateServiceProps)` Optional values to override default Fargate Task definition properties (fargate-defaults.ts).
`FargateToSsmstringparameter.Builder`	`fargateTaskDefinitionProps(Object fargateTaskDefinitionProps)`
`FargateToSsmstringparameter.Builder`	`publicApi(Boolean publicApi)` Whether the construct is deploying a private or public API.
`FargateToSsmstringparameter.Builder`	`stringParameterEnvironmentVariableName(String stringParameterEnvironmentVariableName)` Optional Name for the container environment variable set to the SSM parameter name.
`FargateToSsmstringparameter.Builder`	`stringParameterPermissions(String stringParameterPermissions)` Optional SSM String parameter permissions to grant to the Fargate service.
`FargateToSsmstringparameter.Builder`	`stringParameterProps(software.amazon.awscdk.services.ssm.StringParameterProps stringParameterProps)` Optional user provided props to override the default props for SSM String Parameter.
`FargateToSsmstringparameter.Builder`	`vpcProps(software.amazon.awscdk.services.ec2.VpcProps vpcProps)` Optional custom properties for a VPC the construct will create.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Method Detail
  - create
```
public static FargateToSsmstringparameter.Builder create(software.amazon.awscdk.core.Construct scope,
                                                         String id)
```
    Parameters:
    
    scope - This parameter is required.
    
    id - This parameter is required.
    
    Returns:
    
    a new instance of FargateToSsmstringparameter.Builder.
  - publicApi
```
public FargateToSsmstringparameter.Builder publicApi(Boolean publicApi)
```
    Whether the construct is deploying a private or public API.
    This has implications for the VPC deployed by this construct.
    Default: - none
    
    Parameters:
    
    publicApi - Whether the construct is deploying a private or public API. This parameter is required.
    
    Returns:
    
    this
  - clusterProps
```
public FargateToSsmstringparameter.Builder clusterProps(software.amazon.awscdk.services.ecs.ClusterProps clusterProps)
```
    Optional properties to create a new ECS cluster.
    
    Parameters:
    
    clusterProps - Optional properties to create a new ECS cluster. This parameter is required.
    
    Returns:
    
    this
  - containerDefinitionProps
```
public FargateToSsmstringparameter.Builder containerDefinitionProps(Object containerDefinitionProps)
```
    Parameters:
    
    containerDefinitionProps - This parameter is required.
    
    Returns:
    
    this
  - ecrImageVersion
```
public FargateToSsmstringparameter.Builder ecrImageVersion(String ecrImageVersion)
```
    The version of the image to use from the repository.
    Default: - 'latest'
    
    Parameters:
    
    ecrImageVersion - The version of the image to use from the repository. This parameter is required.
    
    Returns:
    
    this
  - ecrRepositoryArn
```
public FargateToSsmstringparameter.Builder ecrRepositoryArn(String 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]
    
    Parameters:
    
    ecrRepositoryArn - The arn of an ECR Repository containing the image to use to generate the containers. This parameter is required.
    
    Returns:
    
    this
  - existingContainerDefinitionObject
```
public FargateToSsmstringparameter.Builder existingContainerDefinitionObject(software.amazon.awscdk.services.ecs.ContainerDefinition existingContainerDefinitionObject)
```
    Parameters:
    
    existingContainerDefinitionObject - This parameter is required.
    
    Returns:
    
    this
  - existingFargateServiceObject
```
public FargateToSsmstringparameter.Builder existingFargateServiceObject(software.amazon.awscdk.services.ecs.FargateService 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.
    Default: - none
    
    Parameters:
    
    existingFargateServiceObject - A Fargate Service already instantiated (probably by another Solutions Construct). This parameter is required.
    
    Returns:
    
    this
  - existingStringParameterObj
```
public FargateToSsmstringparameter.Builder existingStringParameterObj(software.amazon.awscdk.services.ssm.StringParameter existingStringParameterObj)
```
    Optional user provided props to override the default props for SSM String Parameter.
    Default: - None
    
    Parameters:
    
    existingStringParameterObj - Optional user provided props to override the default props for SSM String Parameter. This parameter is required.
    
    Returns:
    
    this
  - existingVpc
```
public FargateToSsmstringparameter.Builder existingVpc(software.amazon.awscdk.services.ec2.IVpc 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.
    Default: - none
    
    Parameters:
    
    existingVpc - An existing VPC in which to deploy the construct. This parameter is required.
    
    Returns:
    
    this
  - fargateServiceProps
```
public FargateToSsmstringparameter.Builder fargateServiceProps(Object 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
    
    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. This parameter is required.
    
    Returns:
    
    this
  - fargateTaskDefinitionProps
```
public FargateToSsmstringparameter.Builder fargateTaskDefinitionProps(Object fargateTaskDefinitionProps)
```
    Parameters:
    
    fargateTaskDefinitionProps - This parameter is required.
    
    Returns:
    
    this
  - stringParameterEnvironmentVariableName
```
public FargateToSsmstringparameter.Builder stringParameterEnvironmentVariableName(String stringParameterEnvironmentVariableName)
```
    Optional Name for the container environment variable set to the SSM parameter name.
    Default: - SSM_STRING_PARAMETER_NAME
    
    Parameters:
    
    stringParameterEnvironmentVariableName - Optional Name for the container environment variable set to the SSM parameter name. This parameter is required.
    
    Returns:
    
    this
  - stringParameterPermissions
```
public FargateToSsmstringparameter.Builder stringParameterPermissions(String stringParameterPermissions)
```
    Optional SSM String parameter permissions to grant to the Fargate service.
    One of the following may be specified: "Read", "ReadWrite".
    Default: - 'Read'
    
    Parameters:
    
    stringParameterPermissions - Optional SSM String parameter permissions to grant to the Fargate service. This parameter is required.
    
    Returns:
    
    this
  - stringParameterProps
```
public FargateToSsmstringparameter.Builder stringParameterProps(software.amazon.awscdk.services.ssm.StringParameterProps stringParameterProps)
```
    Optional user provided props to override the default props for SSM String Parameter.
    Default: - Default props are used
    
    Parameters:
    
    stringParameterProps - Optional user provided props to override the default props for SSM String Parameter. This parameter is required.
    
    Returns:
    
    this
  - vpcProps
```
public FargateToSsmstringparameter.Builder vpcProps(software.amazon.awscdk.services.ec2.VpcProps 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.
    Default: - none
    
    Parameters:
    
    vpcProps - Optional custom properties for a VPC the construct will create. This parameter is required.
    
    Returns:
    
    this
  - build
```
public FargateToSsmstringparameter build()
```
    Specified by:
    
    build in interface software.amazon.jsii.Builder<FargateToSsmstringparameter>

Class FargateToSsmstringparameter.Builder

Method Summary

Methods inherited from class java.lang.Object

Method Detail

create

publicApi

clusterProps

containerDefinitionProps

ecrImageVersion

ecrRepositoryArn

existingContainerDefinitionObject

existingFargateServiceObject

existingStringParameterObj

existingVpc

fargateServiceProps

fargateTaskDefinitionProps

stringParameterEnvironmentVariableName

stringParameterPermissions

stringParameterProps

vpcProps

build