Interface CfnExpressGatewayServiceProps
- All Superinterfaces:
software.amazon.jsii.JsiiSerializable
- All Known Implementing Classes:
CfnExpressGatewayServiceProps.Jsii$Proxy
@Generated(value="jsii-pacmak/1.120.0 (build 192dc88)",
date="2025-12-05T22:26:35.676Z")
@Stability(Stable)
public interface CfnExpressGatewayServiceProps
extends software.amazon.jsii.JsiiSerializable
Properties for defining a
CfnExpressGatewayService.
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.*;
CfnExpressGatewayServiceProps cfnExpressGatewayServiceProps = CfnExpressGatewayServiceProps.builder()
.executionRoleArn("executionRoleArn")
.infrastructureRoleArn("infrastructureRoleArn")
.primaryContainer(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())
// the properties below are optional
.cluster("cluster")
.cpu("cpu")
.healthCheckPath("healthCheckPath")
.memory("memory")
.networkConfiguration(ExpressGatewayServiceNetworkConfigurationProperty.builder()
.securityGroups(List.of("securityGroups"))
.subnets(List.of("subnets"))
.build())
.scalingTarget(ExpressGatewayScalingTargetProperty.builder()
.autoScalingMetric("autoScalingMetric")
.autoScalingTargetValue(123)
.maxTaskCount(123)
.minTaskCount(123)
.build())
.serviceName("serviceName")
.tags(List.of(CfnTag.builder()
.key("key")
.value("value")
.build()))
.taskRoleArn("taskRoleArn")
.build();
- See Also:
-
Nested Class Summary
Nested ClassesModifier and TypeInterfaceDescriptionstatic final classA builder forCfnExpressGatewayServicePropsstatic final classAn implementation forCfnExpressGatewayServiceProps -
Method Summary
Modifier and TypeMethodDescriptionbuilder()default StringThe short name or full ARN of the cluster that hosts the Express service.default StringgetCpu()The CPU allocation for tasks in this service revision.The ARN of the task execution role for the service revision.default StringThe health check path for this service revision.The ARN of the infrastructure role that manages AWS resources for the Express service.default StringThe memory allocation for tasks in this service revision.default ObjectThe network configuration for tasks in this service revision.The primary container configuration for this service revision.default ObjectThe auto-scaling configuration for this service revision.default StringThe name of the Express service.getTags()The metadata applied to the Express service.default StringThe ARN of the task role for the service revision.Methods inherited from interface software.amazon.jsii.JsiiSerializable
$jsii$toJson
-
Method Details
-
getExecutionRoleArn
The ARN of the task execution role for the service revision.- See Also:
-
getInfrastructureRoleArn
The ARN of the infrastructure role that manages AWS resources for the Express service.- See Also:
-
getPrimaryContainer
The primary container configuration for this service revision.Returns union: either
IResolvableorCfnExpressGatewayService.ExpressGatewayContainerProperty- See Also:
-
getCluster
The short name or full ARN of the cluster that hosts the Express service.Default: - "default"
- See Also:
-
getCpu
The CPU allocation for tasks in this service revision.Default: - "256"
- See Also:
-
getHealthCheckPath
The health check path for this service revision.Default: - "HTTP:80/ping"
- See Also:
-
getMemory
The memory allocation for tasks in this service revision.Default: - "512"
- See Also:
-
getNetworkConfiguration
The network configuration for tasks in this service revision.Returns union: either
IResolvableorCfnExpressGatewayService.ExpressGatewayServiceNetworkConfigurationProperty- See Also:
-
getScalingTarget
The auto-scaling configuration for this service revision.Returns union: either
IResolvableorCfnExpressGatewayService.ExpressGatewayScalingTargetProperty- See Also:
-
getServiceName
The name of the Express service.- See Also:
-
getTags
The metadata applied to the Express service.- See Also:
-
getTaskRoleArn
The ARN of the task role for the service revision.- See Also:
-
builder
-