FargateToSsmstringparameterProps (software.amazon.awsconstructs:fargatessmstringparameter 1.175.0 API)

All Superinterfaces:: software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:: FargateToSsmstringparameterProps.Jsii$Proxy

@Generated(value="jsii-pacmak/1.71.0 (build f1f58ae)",
           date="2022-12-01T21:06:27.854Z")
public interface FargateToSsmstringparameterProps
extends software.amazon.jsii.JsiiSerializable

Nested Class Summary

Nested Classes
Modifier and Type	Interface and Description
`static class`	`FargateToSsmstringparameterProps.Builder` A builder for `FargateToSsmstringparameterProps`
`static class`	`FargateToSsmstringparameterProps.Jsii$Proxy` An implementation for `FargateToSsmstringparameterProps`

Method Summary

All Methods Static Methods Instance Methods Abstract Methods Default Methods
Modifier and Type	Method and Description
`static FargateToSsmstringparameterProps.Builder`	`builder()`
`default software.amazon.awscdk.services.ecs.ClusterProps`	`getClusterProps()` Optional properties to create a new ECS cluster.
`default Object`	`getContainerDefinitionProps()`
`default String`	`getEcrImageVersion()` The version of the image to use from the repository.
`default String`	`getEcrRepositoryArn()` The arn of an ECR Repository containing the image to use to generate the containers.
`default software.amazon.awscdk.services.ecs.ContainerDefinition`	`getExistingContainerDefinitionObject()`
`default software.amazon.awscdk.services.ecs.FargateService`	`getExistingFargateServiceObject()` A Fargate Service already instantiated (probably by another Solutions Construct).
`default software.amazon.awscdk.services.ssm.StringParameter`	`getExistingStringParameterObj()` Optional user provided props to override the default props for SSM String Parameter.
`default software.amazon.awscdk.services.ec2.IVpc`	`getExistingVpc()` An existing VPC in which to deploy the construct.
`default Object`	`getFargateServiceProps()` Optional values to override default Fargate Task definition properties (fargate-defaults.ts).
`default Object`	`getFargateTaskDefinitionProps()`
`Boolean`	`getPublicApi()` Whether the construct is deploying a private or public API.
`default String`	`getStringParameterEnvironmentVariableName()` Optional Name for the container environment variable set to the SSM parameter name.
`default String`	`getStringParameterPermissions()` Optional SSM String parameter permissions to grant to the Fargate service.
`default software.amazon.awscdk.services.ssm.StringParameterProps`	`getStringParameterProps()` Optional user provided props to override the default props for SSM String Parameter.
`default software.amazon.awscdk.services.ec2.VpcProps`	`getVpcProps()` Optional custom properties for a VPC the construct will create.

Methods inherited from interface software.amazon.jsii.JsiiSerializable
$jsii$toJson

- Method Detail
  - getPublicApi
```
@NotNull
Boolean getPublicApi()
```
    Whether the construct is deploying a private or public API.
    This has implications for the VPC deployed by this construct.
    Default: - none
  - getClusterProps
```
@Nullable
default software.amazon.awscdk.services.ecs.ClusterProps getClusterProps()
```
    Optional properties to create a new ECS cluster.
  - getContainerDefinitionProps
```
@Nullable
default Object getContainerDefinitionProps()
```
  - getEcrImageVersion
```
@Nullable
default String getEcrImageVersion()
```
    The version of the image to use from the repository.
    Default: - 'latest'
  - getEcrRepositoryArn
```
@Nullable
default String getEcrRepositoryArn()
```
    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]
  - getExistingContainerDefinitionObject
```
@Nullable
default software.amazon.awscdk.services.ecs.ContainerDefinition getExistingContainerDefinitionObject()
```
  - getExistingFargateServiceObject
```
@Nullable
default software.amazon.awscdk.services.ecs.FargateService getExistingFargateServiceObject()
```
    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
  - getExistingStringParameterObj
```
@Nullable
default software.amazon.awscdk.services.ssm.StringParameter getExistingStringParameterObj()
```
    Optional user provided props to override the default props for SSM String Parameter.
    Default: - None
  - getExistingVpc
```
@Nullable
default software.amazon.awscdk.services.ec2.IVpc getExistingVpc()
```
    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
  - getFargateServiceProps
```
@Nullable
default Object getFargateServiceProps()
```
    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
  - getFargateTaskDefinitionProps
```
@Nullable
default Object getFargateTaskDefinitionProps()
```
  - getStringParameterEnvironmentVariableName
```
@Nullable
default String getStringParameterEnvironmentVariableName()
```
    Optional Name for the container environment variable set to the SSM parameter name.
    Default: - SSM_STRING_PARAMETER_NAME
  - getStringParameterPermissions
```
@Nullable
default String getStringParameterPermissions()
```
    Optional SSM String parameter permissions to grant to the Fargate service.
    One of the following may be specified: "Read", "ReadWrite".
    Default: - 'Read'
  - getStringParameterProps
```
@Nullable
default software.amazon.awscdk.services.ssm.StringParameterProps getStringParameterProps()
```
    Optional user provided props to override the default props for SSM String Parameter.
    Default: - Default props are used
  - getVpcProps
```
@Nullable
default software.amazon.awscdk.services.ec2.VpcProps getVpcProps()
```
    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
  - builder
```
static FargateToSsmstringparameterProps.Builder builder()
```
    Returns:
    
    a FargateToSsmstringparameterProps.Builder of FargateToSsmstringparameterProps

Interface FargateToSsmstringparameterProps

Nested Class Summary

Method Summary

Methods inherited from interface software.amazon.jsii.JsiiSerializable

Method Detail

getPublicApi

getClusterProps

getContainerDefinitionProps

getEcrImageVersion

getEcrRepositoryArn

getExistingContainerDefinitionObject

getExistingFargateServiceObject

getExistingStringParameterObj

getExistingVpc

getFargateServiceProps

getFargateTaskDefinitionProps

getStringParameterEnvironmentVariableName

getStringParameterPermissions

getStringParameterProps

getVpcProps

builder