CfnExpressGatewayService
- class aws_cdk.aws_ecs.CfnExpressGatewayService(scope, id, *, execution_role_arn, infrastructure_role_arn, primary_container, cluster=None, cpu=None, health_check_path=None, memory=None, network_configuration=None, scaling_target=None, service_name=None, tags=None, task_role_arn=None)
Bases:
CfnResourceCreates an Express service that simplifies deploying containerized web applications on Amazon ECS with managed AWS infrastructure.
This operation provisions and configures Application Load Balancers, target groups, security groups, and auto-scaling policies automatically.
Specify a primary container configuration with your application image and basic settings. Amazon ECS creates the necessary AWS resources for traffic distribution, health monitoring, network access control, and capacity management.
Provide an execution role for task operations and an infrastructure role for managing AWS resources on your behalf.
- See:
- CloudformationResource:
AWS::ECS::ExpressGatewayService
- ExampleMetadata:
fixture=_generated
Example:
# The code below shows an example of how to instantiate this type. # The values are placeholders you should change. from aws_cdk import aws_ecs as ecs cfn_express_gateway_service = ecs.CfnExpressGatewayService(self, "MyCfnExpressGatewayService", execution_role_arn="executionRoleArn", infrastructure_role_arn="infrastructureRoleArn", primary_container=ecs.CfnExpressGatewayService.ExpressGatewayContainerProperty( image="image", # the properties below are optional aws_logs_configuration=ecs.CfnExpressGatewayService.ExpressGatewayServiceAwsLogsConfigurationProperty( log_group="logGroup", log_stream_prefix="logStreamPrefix" ), command=["command"], container_port=123, environment=[ecs.CfnExpressGatewayService.KeyValuePairProperty( name="name", value="value" )], repository_credentials=ecs.CfnExpressGatewayService.ExpressGatewayRepositoryCredentialsProperty( credentials_parameter="credentialsParameter" ), secrets=[ecs.CfnExpressGatewayService.SecretProperty( name="name", value_from="valueFrom" )] ), # the properties below are optional cluster="cluster", cpu="cpu", health_check_path="healthCheckPath", memory="memory", network_configuration=ecs.CfnExpressGatewayService.ExpressGatewayServiceNetworkConfigurationProperty( security_groups=["securityGroups"], subnets=["subnets"] ), scaling_target=ecs.CfnExpressGatewayService.ExpressGatewayScalingTargetProperty( auto_scaling_metric="autoScalingMetric", auto_scaling_target_value=123, max_task_count=123, min_task_count=123 ), service_name="serviceName", tags=[CfnTag( key="key", value="value" )], task_role_arn="taskRoleArn" )
Create a new
AWS::ECS::ExpressGatewayService.- Parameters:
scope (
Construct) – Scope in which this resource is defined.id (
str) – Construct identifier for this resource (unique in its scope).execution_role_arn (
str) – The ARN of the task execution role for the service revision.infrastructure_role_arn (
str) – The ARN of the infrastructure role that manages AWS resources for the Express service.primary_container (
Union[IResolvable,ExpressGatewayContainerProperty,Dict[str,Any]]) – The primary container configuration for this service revision.cluster (
Optional[str]) – The short name or full ARN of the cluster that hosts the Express service. Default: - “default”cpu (
Optional[str]) – The CPU allocation for tasks in this service revision. Default: - “256”health_check_path (
Optional[str]) – The health check path for this service revision. Default: - “HTTP:80/ping”memory (
Optional[str]) – The memory allocation for tasks in this service revision. Default: - “512”network_configuration (
Union[IResolvable,ExpressGatewayServiceNetworkConfigurationProperty,Dict[str,Any],None]) – The network configuration for tasks in this service revision.scaling_target (
Union[IResolvable,ExpressGatewayScalingTargetProperty,Dict[str,Any],None]) – The auto-scaling configuration for this service revision.service_name (
Optional[str]) – The name of the Express service.tags (
Optional[Sequence[Union[CfnTag,Dict[str,Any]]]]) – The metadata applied to the Express service.task_role_arn (
Optional[str]) – The ARN of the task role for the service revision.
Methods
- add_deletion_override(path)
Syntactic sugar for
addOverride(path, undefined).- Parameters:
path (
str) – The path of the value to delete.- Return type:
None
- add_dependency(target)
Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned.
This can be used for resources across stacks (or nested stack) boundaries and the dependency will automatically be transferred to the relevant scope.
- Parameters:
target (
CfnResource)- Return type:
None
- add_depends_on(target)
(deprecated) Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned.
- Parameters:
target (
CfnResource)- Deprecated:
use addDependency
- Stability:
deprecated
- Return type:
None
- add_metadata(key, value)
Add a value to the CloudFormation Resource Metadata.
- Parameters:
key (
str)value (
Any)
- See:
- Return type:
None
Note that this is a different set of metadata from CDK node metadata; this metadata ends up in the stack template under the resource, whereas CDK node metadata ends up in the Cloud Assembly.
- add_override(path, value)
Adds an override to the synthesized CloudFormation resource.
To add a property override, either use
addPropertyOverrideor prefixpathwith “Properties.” (i.e.Properties.TopicName).If the override is nested, separate each nested level using a dot (.) in the path parameter. If there is an array as part of the nesting, specify the index in the path.
To include a literal
.in the property name, prefix with a\. In most programming languages you will need to write this as"\\."because the\itself will need to be escaped.For example:
cfn_resource.add_override("Properties.GlobalSecondaryIndexes.0.Projection.NonKeyAttributes", ["myattribute"]) cfn_resource.add_override("Properties.GlobalSecondaryIndexes.1.ProjectionType", "INCLUDE")
would add the overrides Example:
"Properties": { "GlobalSecondaryIndexes": [ { "Projection": { "NonKeyAttributes": [ "myattribute" ] ... } ... }, { "ProjectionType": "INCLUDE" ... }, ] ... }
The
valueargument toaddOverridewill not be processed or translated in any way. Pass raw JSON values in here with the correct capitalization for CloudFormation. If you pass CDK classes or structs, they will be rendered with lowercased key names, and CloudFormation will reject the template.- Parameters:
path (
str) –The path of the property, you can use dot notation to override values in complex types. Any intermediate keys will be created as needed.
value (
Any) –The value. Could be primitive or complex.
- Return type:
None
- add_property_deletion_override(property_path)
Adds an override that deletes the value of a property from the resource definition.
- Parameters:
property_path (
str) – The path to the property.- Return type:
None
- add_property_override(property_path, value)
Adds an override to a resource property.
Syntactic sugar for
addOverride("Properties.<...>", value).- Parameters:
property_path (
str) – The path of the property.value (
Any) – The value.
- Return type:
None
- apply_removal_policy(policy=None, *, apply_to_update_replace_policy=None, default=None)
Sets the deletion policy of the resource based on the removal policy specified.
The Removal Policy controls what happens to this resource when it stops being managed by CloudFormation, either because you’ve removed it from the CDK application or because you’ve made a change that requires the resource to be replaced.
The resource can be deleted (
RemovalPolicy.DESTROY), or left in your AWS account for data recovery and cleanup later (RemovalPolicy.RETAIN). In some cases, a snapshot can be taken of the resource prior to deletion (RemovalPolicy.SNAPSHOT). A list of resources that support this policy can be found in the following link:- Parameters:
policy (
Optional[RemovalPolicy])apply_to_update_replace_policy (
Optional[bool]) – Apply the same deletion policy to the resource’s “UpdateReplacePolicy”. Default: truedefault (
Optional[RemovalPolicy]) – The default policy to apply in case the removal policy is not defined. Default: - Default value is resource specific. To determine the default value for a resource, please consult that specific resource’s documentation.
- See:
- Return type:
None
- get_att(attribute_name, type_hint=None)
Returns a token for an runtime attribute of this resource.
Ideally, use generated attribute accessors (e.g.
resource.arn), but this can be used for future compatibility in case there is no generated attribute.- Parameters:
attribute_name (
str) – The name of the attribute.type_hint (
Optional[ResolutionTypeHint])
- Return type:
- get_metadata(key)
Retrieve a value value from the CloudFormation Resource Metadata.
- Parameters:
key (
str)- See:
- Return type:
Any
Note that this is a different set of metadata from CDK node metadata; this metadata ends up in the stack template under the resource, whereas CDK node metadata ends up in the Cloud Assembly.
- inspect(inspector)
Examines the CloudFormation resource and discloses attributes.
- Parameters:
inspector (
TreeInspector) – tree inspector to collect and process attributes.- Return type:
None
- obtain_dependencies()
Retrieves an array of resources this resource depends on.
This assembles dependencies on resources across stacks (including nested stacks) automatically.
- Return type:
List[Union[Stack,CfnResource]]
- obtain_resource_dependencies()
Get a shallow copy of dependencies between this resource and other resources in the same stack.
- Return type:
List[CfnResource]
- override_logical_id(new_logical_id)
Overrides the auto-generated logical ID with a specific ID.
- Parameters:
new_logical_id (
str) – The new logical ID to use for this stack element.- Return type:
None
- remove_dependency(target)
Indicates that this resource no longer depends on another resource.
This can be used for resources across stacks (including nested stacks) and the dependency will automatically be removed from the relevant scope.
- Parameters:
target (
CfnResource)- Return type:
None
- replace_dependency(target, new_target)
Replaces one dependency with another.
- Parameters:
target (
CfnResource) – The dependency to replace.new_target (
CfnResource) – The new dependency to add.
- Return type:
None
- to_string()
Returns a string representation of this construct.
- Return type:
str- Returns:
a string representation of this resource
Attributes
- CFN_RESOURCE_TYPE_NAME = 'AWS::ECS::ExpressGatewayService'
- attr_active_configurations
The list of active service configurations for the Express service.
- CloudformationAttribute:
ActiveConfigurations
- attr_created_at
The Unix timestamp for when the Express service was created.
- CloudformationAttribute:
CreatedAt
- attr_service_arn
The ARN that identifies the Express service.
- CloudformationAttribute:
ServiceArn
- attr_status
Status
- Type:
cloudformationAttribute
- attr_updated_at
The Unix timestamp for when the Express service was last updated.
- CloudformationAttribute:
UpdatedAt
- cdk_tag_manager
Tag Manager which manages the tags for this resource.
- cfn_options
Options for this resource, such as condition, update policy etc.
- cfn_resource_type
AWS resource type.
- cluster
The short name or full ARN of the cluster that hosts the Express service.
- cpu
The CPU allocation for tasks in this service revision.
- creation_stack
return:
the stack trace of the point where this Resource was created from, sourced from the +metadata+ entry typed +aws:cdk:logicalId+, and with the bottom-most node +internal+ entries filtered.
- env
- execution_role_arn
The ARN of the task execution role for the service revision.
- express_gateway_service_ref
A reference to a ExpressGatewayService resource.
- health_check_path
The health check path for this service revision.
- infrastructure_role_arn
The ARN of the infrastructure role that manages AWS resources for the Express service.
- logical_id
The logical ID for this CloudFormation stack element.
The logical ID of the element is calculated from the path of the resource node in the construct tree.
To override this value, use
overrideLogicalId(newLogicalId).- Returns:
the logical ID as a stringified token. This value will only get resolved during synthesis.
- memory
The memory allocation for tasks in this service revision.
- network_configuration
The network configuration for tasks in this service revision.
- node
The tree node.
- primary_container
The primary container configuration for this service revision.
- ref
Return a string that will be resolved to a CloudFormation
{ Ref }for this element.If, by any chance, the intrinsic reference of a resource is not a string, you could coerce it to an IResolvable through
Lazy.any({ produce: resource.ref }).
- scaling_target
The auto-scaling configuration for this service revision.
- service_name
The name of the Express service.
- stack
The stack in which this element is defined.
CfnElements must be defined within a stack scope (directly or indirectly).
- tags
The metadata applied to the Express service.
- task_role_arn
The ARN of the task role for the service revision.
Static Methods
- classmethod is_cfn_element(x)
Returns
trueif a construct is a stack element (i.e. part of the synthesized cloudformation template).Uses duck-typing instead of
instanceofto allow stack elements from different versions of this library to be included in the same stack.- Parameters:
x (
Any)- Return type:
bool- Returns:
The construct as a stack element or undefined if it is not a stack element.
- classmethod is_cfn_express_gateway_service(x)
Checks whether the given object is a CfnExpressGatewayService.
- Parameters:
x (
Any)- Return type:
bool
- classmethod is_cfn_resource(x)
Check whether the given object is a CfnResource.
- Parameters:
x (
Any)- Return type:
bool
- classmethod is_construct(x)
Checks if
xis a construct.Use this method instead of
instanceofto properly detectConstructinstances, even when the construct library is symlinked.Explanation: in JavaScript, multiple copies of the
constructslibrary on disk are seen as independent, completely different libraries. As a consequence, the classConstructin each copy of theconstructslibrary is seen as a different class, and an instance of one class will not test asinstanceofthe other class.npm installwill not create installations like this, but users may manually symlink construct libraries together or use a monorepo tool: in those cases, multiple copies of theconstructslibrary can be accidentally installed, andinstanceofwill behave unpredictably. It is safest to avoid usinginstanceof, and using this type-testing method instead.- Parameters:
x (
Any) – Any object.- Return type:
bool- Returns:
true if
xis an object created from a class which extendsConstruct.
ExpressGatewayContainerProperty
- class CfnExpressGatewayService.ExpressGatewayContainerProperty(*, image, aws_logs_configuration=None, command=None, container_port=None, environment=None, repository_credentials=None, secrets=None)
Bases:
objectDefines 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.
- Parameters:
image (
str) – 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 eitherrepository-url/image:tagorrepository-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.aws_logs_configuration (
Union[IResolvable,ExpressGatewayServiceAwsLogsConfigurationProperty,Dict[str,Any],None]) – The log configuration for the container.command (
Optional[Sequence[str]]) – The command that is passed to the container.container_port (
Union[int,float,None]) – The port number on the container that receives traffic from the load balancer. Default is 80. Default: - 80environment (
Union[IResolvable,Sequence[Union[IResolvable,KeyValuePairProperty,Dict[str,Any]]],None]) – The environment variables to pass to the container.repository_credentials (
Union[IResolvable,ExpressGatewayRepositoryCredentialsProperty,Dict[str,Any],None]) – The configuration for repository credentials for private registry authentication.secrets (
Union[IResolvable,Sequence[Union[IResolvable,SecretProperty,Dict[str,Any]]],None]) – The secrets to pass to the container.
- See:
- ExampleMetadata:
fixture=_generated
Example:
# The code below shows an example of how to instantiate this type. # The values are placeholders you should change. from aws_cdk import aws_ecs as ecs express_gateway_container_property = ecs.CfnExpressGatewayService.ExpressGatewayContainerProperty( image="image", # the properties below are optional aws_logs_configuration=ecs.CfnExpressGatewayService.ExpressGatewayServiceAwsLogsConfigurationProperty( log_group="logGroup", log_stream_prefix="logStreamPrefix" ), command=["command"], container_port=123, environment=[ecs.CfnExpressGatewayService.KeyValuePairProperty( name="name", value="value" )], repository_credentials=ecs.CfnExpressGatewayService.ExpressGatewayRepositoryCredentialsProperty( credentials_parameter="credentialsParameter" ), secrets=[ecs.CfnExpressGatewayService.SecretProperty( name="name", value_from="valueFrom" )] )
Attributes
- aws_logs_configuration
The log configuration for the container.
- command
The command that is passed to the container.
- container_port
The port number on the container that receives traffic from the load balancer.
Default is 80.
- environment
The environment variables to pass to the container.
- image
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:tagorrepository-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.
- repository_credentials
The configuration for repository credentials for private registry authentication.
- secrets
The secrets to pass to the container.
ExpressGatewayRepositoryCredentialsProperty
- class CfnExpressGatewayService.ExpressGatewayRepositoryCredentialsProperty(*, credentials_parameter)
Bases:
objectThe repository credentials for private registry authentication to pass to the container.
- Parameters:
credentials_parameter (
str) – The Amazon Resource Name (ARN) of the secret containing the private repository credentials.- See:
- ExampleMetadata:
fixture=_generated
Example:
# The code below shows an example of how to instantiate this type. # The values are placeholders you should change. from aws_cdk import aws_ecs as ecs express_gateway_repository_credentials_property = ecs.CfnExpressGatewayService.ExpressGatewayRepositoryCredentialsProperty( credentials_parameter="credentialsParameter" )
Attributes
- credentials_parameter
The Amazon Resource Name (ARN) of the secret containing the private repository credentials.
ExpressGatewayScalingTargetProperty
- class CfnExpressGatewayService.ExpressGatewayScalingTargetProperty(*, auto_scaling_metric=None, auto_scaling_target_value=None, max_task_count=None, min_task_count=None)
Bases:
objectDefines the auto-scaling configuration for an Express service.
This determines how the service automatically adjusts the number of running tasks based on demand metrics such as CPU utilization, memory utilization, or request count per target.
Auto-scaling helps ensure your application can handle varying levels of traffic while optimizing costs by scaling down during low-demand periods. You can specify the minimum and maximum number of tasks, the scaling metric, and the target value for that metric.
- Parameters:
auto_scaling_metric (
Optional[str]) – The metric used for auto-scaling decisions. The default metric used for an Express service isCPUUtilization. Default: - “AVERAGE_CPU”auto_scaling_target_value (
Union[int,float,None]) – The target value for the auto-scaling metric. The default value for an Express service is 60. Default: - 60max_task_count (
Union[int,float,None]) – The maximum number of tasks to run in the Express service. Default: - 1min_task_count (
Union[int,float,None]) – The minimum number of tasks to run in the Express service. Default: - 1
- See:
- ExampleMetadata:
fixture=_generated
Example:
# The code below shows an example of how to instantiate this type. # The values are placeholders you should change. from aws_cdk import aws_ecs as ecs express_gateway_scaling_target_property = ecs.CfnExpressGatewayService.ExpressGatewayScalingTargetProperty( auto_scaling_metric="autoScalingMetric", auto_scaling_target_value=123, max_task_count=123, min_task_count=123 )
Attributes
- auto_scaling_metric
The metric used for auto-scaling decisions.
The default metric used for an Express service is
CPUUtilization.
- auto_scaling_target_value
The target value for the auto-scaling metric.
The default value for an Express service is 60.
- max_task_count
The maximum number of tasks to run in the Express service.
- min_task_count
The minimum number of tasks to run in the Express service.
ExpressGatewayServiceAwsLogsConfigurationProperty
- class CfnExpressGatewayService.ExpressGatewayServiceAwsLogsConfigurationProperty(*, log_group, log_stream_prefix)
Bases:
objectSpecifies the Amazon CloudWatch Logs configuration for the Express service container.
- Parameters:
log_group (
str) – The name of the CloudWatch Logs log group to send container logs to.log_stream_prefix (
str) – The prefix for the CloudWatch Logs log stream names. The default for an Express service isecs. Default: - “ecs”
- See:
- ExampleMetadata:
fixture=_generated
Example:
# The code below shows an example of how to instantiate this type. # The values are placeholders you should change. from aws_cdk import aws_ecs as ecs express_gateway_service_aws_logs_configuration_property = ecs.CfnExpressGatewayService.ExpressGatewayServiceAwsLogsConfigurationProperty( log_group="logGroup", log_stream_prefix="logStreamPrefix" )
Attributes
- log_group
The name of the CloudWatch Logs log group to send container logs to.
- log_stream_prefix
The prefix for the CloudWatch Logs log stream names.
The default for an Express service is
ecs.
ExpressGatewayServiceConfigurationProperty
- class CfnExpressGatewayService.ExpressGatewayServiceConfigurationProperty(*, cpu=None, created_at=None, execution_role_arn=None, health_check_path=None, ingress_paths=None, memory=None, network_configuration=None, primary_container=None, scaling_target=None, service_revision_arn=None, task_role_arn=None)
Bases:
objectRepresents a specific configuration revision of an Express service, containing all the settings and parameters for that revision.
- Parameters:
cpu (
Optional[str]) – The CPU allocation for tasks in this service revision.created_at (
Optional[str]) – The Unix timestamp for when this service revision was created.execution_role_arn (
Optional[str]) – The ARN of the task execution role for the service revision.health_check_path (
Optional[str]) – The health check path for this service revision.ingress_paths (
Union[IResolvable,Sequence[Union[IResolvable,IngressPathSummaryProperty,Dict[str,Any]]],None]) – The entry point into this service revision.memory (
Optional[str]) – The memory allocation for tasks in this service revision.network_configuration (
Union[IResolvable,ExpressGatewayServiceNetworkConfigurationProperty,Dict[str,Any],None]) – The network configuration for tasks in this service revision.primary_container (
Union[IResolvable,ExpressGatewayContainerProperty,Dict[str,Any],None]) – The primary container configuration for this service revision.scaling_target (
Union[IResolvable,ExpressGatewayScalingTargetProperty,Dict[str,Any],None]) – The auto-scaling configuration for this service revision.service_revision_arn (
Optional[str]) – The ARN of the service revision.task_role_arn (
Optional[str]) – The ARN of the task role for the service revision.
- See:
- ExampleMetadata:
fixture=_generated
Example:
# The code below shows an example of how to instantiate this type. # The values are placeholders you should change. from aws_cdk import aws_ecs as ecs express_gateway_service_configuration_property = ecs.CfnExpressGatewayService.ExpressGatewayServiceConfigurationProperty( cpu="cpu", created_at="createdAt", execution_role_arn="executionRoleArn", health_check_path="healthCheckPath", ingress_paths=[ecs.CfnExpressGatewayService.IngressPathSummaryProperty( access_type="accessType", endpoint="endpoint" )], memory="memory", network_configuration=ecs.CfnExpressGatewayService.ExpressGatewayServiceNetworkConfigurationProperty( security_groups=["securityGroups"], subnets=["subnets"] ), primary_container=ecs.CfnExpressGatewayService.ExpressGatewayContainerProperty( image="image", # the properties below are optional aws_logs_configuration=ecs.CfnExpressGatewayService.ExpressGatewayServiceAwsLogsConfigurationProperty( log_group="logGroup", log_stream_prefix="logStreamPrefix" ), command=["command"], container_port=123, environment=[ecs.CfnExpressGatewayService.KeyValuePairProperty( name="name", value="value" )], repository_credentials=ecs.CfnExpressGatewayService.ExpressGatewayRepositoryCredentialsProperty( credentials_parameter="credentialsParameter" ), secrets=[ecs.CfnExpressGatewayService.SecretProperty( name="name", value_from="valueFrom" )] ), scaling_target=ecs.CfnExpressGatewayService.ExpressGatewayScalingTargetProperty( auto_scaling_metric="autoScalingMetric", auto_scaling_target_value=123, max_task_count=123, min_task_count=123 ), service_revision_arn="serviceRevisionArn", task_role_arn="taskRoleArn" )
Attributes
- cpu
The CPU allocation for tasks in this service revision.
- created_at
The Unix timestamp for when this service revision was created.
- execution_role_arn
The ARN of the task execution role for the service revision.
- health_check_path
The health check path for this service revision.
- ingress_paths
The entry point into this service revision.
- memory
The memory allocation for tasks in this service revision.
- network_configuration
The network configuration for tasks in this service revision.
- primary_container
The primary container configuration for this service revision.
- scaling_target
The auto-scaling configuration for this service revision.
- service_revision_arn
The ARN of the service revision.
- task_role_arn
The ARN of the task role for the service revision.
ExpressGatewayServiceNetworkConfigurationProperty
- class CfnExpressGatewayService.ExpressGatewayServiceNetworkConfigurationProperty(*, security_groups=None, subnets=None)
Bases:
objectThe network configuration for an Express service.
By default, an Express service utilizes subnets and security groups associated with the default VPC.
- Parameters:
security_groups (
Optional[Sequence[str]]) – The IDs of the security groups associated with the Express service.subnets (
Optional[Sequence[str]]) – The IDs of the subnets associated with the Express service.
- See:
- ExampleMetadata:
fixture=_generated
Example:
# The code below shows an example of how to instantiate this type. # The values are placeholders you should change. from aws_cdk import aws_ecs as ecs express_gateway_service_network_configuration_property = ecs.CfnExpressGatewayService.ExpressGatewayServiceNetworkConfigurationProperty( security_groups=["securityGroups"], subnets=["subnets"] )
Attributes
- security_groups
The IDs of the security groups associated with the Express service.
- subnets
The IDs of the subnets associated with the Express service.
ExpressGatewayServiceStatusProperty
- class CfnExpressGatewayService.ExpressGatewayServiceStatusProperty(*, status_code=None)
Bases:
objectAn object that defines the status of Express service creation and information about the status of the service.
- Parameters:
status_code (
Optional[str]) – The status of the Express service.- See:
- ExampleMetadata:
fixture=_generated
Example:
# The code below shows an example of how to instantiate this type. # The values are placeholders you should change. from aws_cdk import aws_ecs as ecs express_gateway_service_status_property = ecs.CfnExpressGatewayService.ExpressGatewayServiceStatusProperty( status_code="statusCode" )
Attributes
- status_code
The status of the Express service.
IngressPathSummaryProperty
- class CfnExpressGatewayService.IngressPathSummaryProperty(*, access_type=None, endpoint=None)
Bases:
objectThe entry point into an Express service.
- Parameters:
access_type (
Optional[str]) – The type of access to the endpoint for the Express service.endpoint (
Optional[str]) – The endpoint for access to the service.
- See:
- ExampleMetadata:
fixture=_generated
Example:
# The code below shows an example of how to instantiate this type. # The values are placeholders you should change. from aws_cdk import aws_ecs as ecs ingress_path_summary_property = ecs.CfnExpressGatewayService.IngressPathSummaryProperty( access_type="accessType", endpoint="endpoint" )
Attributes
- access_type
The type of access to the endpoint for the Express service.
- endpoint
The endpoint for access to the service.
KeyValuePairProperty
- class CfnExpressGatewayService.KeyValuePairProperty(*, name, value)
Bases:
objectA key-value pair object.
- Parameters:
name (
str) – The name of the key-value pair. For environment variables, this is the name of the environment variable.value (
str) – The value of the key-value pair. For environment variables, this is the value of the environment variable.
- See:
- ExampleMetadata:
fixture=_generated
Example:
# The code below shows an example of how to instantiate this type. # The values are placeholders you should change. from aws_cdk import aws_ecs as ecs key_value_pair_property = ecs.CfnExpressGatewayService.KeyValuePairProperty( name="name", value="value" )
Attributes
- name
The name of the key-value pair.
For environment variables, this is the name of the environment variable.
- value
The value of the key-value pair.
For environment variables, this is the value of the environment variable.
SecretProperty
- class CfnExpressGatewayService.SecretProperty(*, name, value_from)
Bases:
objectAn object representing the secret to expose to your container.
Secrets can be exposed to a container in the following ways:
To inject sensitive data into your containers as environment variables, use the
secretscontainer definition parameter.To reference sensitive information in the log configuration of a container, use the
secretOptionscontainer definition parameter.
For more information, see Specifying sensitive data in the Amazon Elastic Container Service Developer Guide .
- Parameters:
name (
str) – The name of the secret.value_from (
str) –The secret to expose to the container. The supported values are either the full ARN of the AWS Secrets Manager secret or the full ARN of the parameter in the SSM Parameter Store. For information about the require AWS Identity and Access Management permissions, see Required IAM permissions for Amazon ECS secrets (for Secrets Manager) or Required IAM permissions for Amazon ECS secrets (for Systems Manager Parameter store) in the Amazon Elastic Container Service Developer Guide . .. epigraph:: If the SSM Parameter Store parameter exists in the same Region as the task you’re launching, then you can use either the full ARN or name of the parameter. If the parameter exists in a different Region, then the full ARN must be specified.
- See:
- ExampleMetadata:
fixture=_generated
Example:
# The code below shows an example of how to instantiate this type. # The values are placeholders you should change. from aws_cdk import aws_ecs as ecs secret_property = ecs.CfnExpressGatewayService.SecretProperty( name="name", value_from="valueFrom" )
Attributes
- name
The name of the secret.
- value_from
The secret to expose to the container.
The supported values are either the full ARN of the AWS Secrets Manager secret or the full ARN of the parameter in the SSM Parameter Store.
For information about the require AWS Identity and Access Management permissions, see Required IAM permissions for Amazon ECS secrets (for Secrets Manager) or Required IAM permissions for Amazon ECS secrets (for Systems Manager Parameter store) in the Amazon Elastic Container Service Developer Guide . .. epigraph:
If the SSM Parameter Store parameter exists in the same Region as the task you're launching, then you can use either the full ARN or name of the parameter. If the parameter exists in a different Region, then the full ARN must be specified.