Package software.amazon.awscdk.services.ecs

Interface CfnExpressGatewayService.ExpressGatewayContainerProperty

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnExpressGatewayService.ExpressGatewayContainerProperty.Jsii$Proxy

Enclosing class:

CfnExpressGatewayService

@Stability(Stable)
public static interface CfnExpressGatewayService.ExpressGatewayContainerProperty
extends software.amazon.jsii.JsiiSerializable

Defines the configuration for the primary container in an Express service.

This container receives traffic from the Application Load Balancer and runs your application code.

The container configuration includes the container image, port mapping, logging settings, environment variables, and secrets. The container image is the only required parameter, with sensible defaults provided for other settings.

Example:

 // The code below shows an example of how to instantiate this type.
 // The values are placeholders you should change.
 import software.amazon.awscdk.services.ecs.*;
 ExpressGatewayContainerProperty expressGatewayContainerProperty = ExpressGatewayContainerProperty.builder()
         .image("image")
         // the properties below are optional
         .awsLogsConfiguration(ExpressGatewayServiceAwsLogsConfigurationProperty.builder()
                 .logGroup("logGroup")
                 .logStreamPrefix("logStreamPrefix")
                 .build())
         .command(List.of("command"))
         .containerPort(123)
         .environment(List.of(KeyValuePairProperty.builder()
                 .name("name")
                 .value("value")
                 .build()))
         .repositoryCredentials(ExpressGatewayRepositoryCredentialsProperty.builder()
                 .credentialsParameter("credentialsParameter")
                 .build())
         .secrets(List.of(SecretProperty.builder()
                 .name("name")
                 .valueFrom("valueFrom")
                 .build()))
         .build();
 

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecs-expressgatewayservice-expressgatewaycontainer.html

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static final class	CfnExpressGatewayService.ExpressGatewayContainerProperty.Builder	A builder for CfnExpressGatewayService.ExpressGatewayContainerProperty
static final class	CfnExpressGatewayService.ExpressGatewayContainerProperty.Jsii$Proxy	An implementation for CfnExpressGatewayService.ExpressGatewayContainerProperty

Method Summary

Modifier and Type	Method	Description
static CfnExpressGatewayService.ExpressGatewayContainerProperty.Builder	builder()
default Object	getAwsLogsConfiguration()	The log configuration for the container.
default List<String>	getCommand()	The command that is passed to the container.
default Number	getContainerPort()	The port number on the container that receives traffic from the load balancer.
default Object	getEnvironment()	The environment variables to pass to the container.
String	getImage()	The image used to start a container.
default Object	getRepositoryCredentials()	The configuration for repository credentials for private registry authentication.
default Object	getSecrets()	The secrets to pass to the container.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getImage

@Stability(Stable)
@NotNull
String getImage()

The image used to start a container.

This string is passed directly to the Docker daemon. Images in the Docker Hub registry are available by default. Other repositories are specified with either repository-url/image:tag or repository-url/image@digest .

For Express services, the image typically contains a web application that listens on the specified container port. The image can be stored in Amazon ECR, Docker Hub, or any other container registry accessible to your execution role.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecs-expressgatewayservice-expressgatewaycontainer.html#cfn-ecs-expressgatewayservice-expressgatewaycontainer-image

getAwsLogsConfiguration

@Stability(Stable)
@Nullable
default Object getAwsLogsConfiguration()

The log configuration for the container.

Returns union: either IResolvable or CfnExpressGatewayService.ExpressGatewayServiceAwsLogsConfigurationProperty

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecs-expressgatewayservice-expressgatewaycontainer.html#cfn-ecs-expressgatewayservice-expressgatewaycontainer-awslogsconfiguration

getCommand

@Stability(Stable)
@Nullable
default List<String> getCommand()

The command that is passed to the container.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecs-expressgatewayservice-expressgatewaycontainer.html#cfn-ecs-expressgatewayservice-expressgatewaycontainer-command

getContainerPort

@Stability(Stable)
@Nullable
default Number getContainerPort()

The port number on the container that receives traffic from the load balancer.

Default is 80.

Default: - 80

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecs-expressgatewayservice-expressgatewaycontainer.html#cfn-ecs-expressgatewayservice-expressgatewaycontainer-containerport

getEnvironment

@Stability(Stable)
@Nullable
default Object getEnvironment()

The environment variables to pass to the container.

Returns union: either IResolvable or Listinvalid input: '<'either IResolvable or CfnExpressGatewayService.KeyValuePairProperty>

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecs-expressgatewayservice-expressgatewaycontainer.html#cfn-ecs-expressgatewayservice-expressgatewaycontainer-environment

getRepositoryCredentials

@Stability(Stable)
@Nullable
default Object getRepositoryCredentials()

The configuration for repository credentials for private registry authentication.

Returns union: either IResolvable or CfnExpressGatewayService.ExpressGatewayRepositoryCredentialsProperty

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecs-expressgatewayservice-expressgatewaycontainer.html#cfn-ecs-expressgatewayservice-expressgatewaycontainer-repositorycredentials

getSecrets

@Stability(Stable)
@Nullable
default Object getSecrets()

The secrets to pass to the container.

Returns union: either IResolvable or Listinvalid input: '<'either IResolvable or CfnExpressGatewayService.SecretProperty>

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecs-expressgatewayservice-expressgatewaycontainer.html#cfn-ecs-expressgatewayservice-expressgatewaycontainer-secrets

builder

@Stability(Stable)
static CfnExpressGatewayService.ExpressGatewayContainerProperty.Builder builder()

Returns:

a CfnExpressGatewayService.ExpressGatewayContainerProperty.Builder of CfnExpressGatewayService.ExpressGatewayContainerProperty