Class: AWSCDK::ECS::CfnExpressGatewayService

Inherits:
CfnResource
  • Object
show all
Includes:
IInspectable, ITaggableV2, Interfaces::AWSECS::IExpressGatewayServiceRef
Defined in:
ecs/cfn_express_gateway_service.rb

Overview

Creates 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 Also:

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(scope, id, props) ⇒ CfnExpressGatewayService

Create a new AWS::ECS::ExpressGatewayService.

Parameters:

  • scope (Constructs::Construct) —

    Scope in which this resource is defined.

  • id (String) —

    Construct identifier for this resource (unique in its scope).

  • props (AWSCDK::ECS::CfnExpressGatewayServiceProps) —

    Resource properties.



24
25
26
27
28
29
30
 
# File 'ecs/cfn_express_gateway_service.rb', line 24

def initialize(scope, id, props)
  props = props.is_a?(Hash) ? ::AWSCDK::ECS::CfnExpressGatewayServiceProps.new(**props.transform_keys(&:to_sym)) : props
  Jsii::Type.check_type(scope, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJjb25zdHJ1Y3RzLkNvbnN0cnVjdCJ9")), "scope")
  Jsii::Type.check_type(id, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "id")
  Jsii::Type.check_type(props, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5hd3NfZWNzLkNmbkV4cHJlc3NHYXRld2F5U2VydmljZVByb3BzIn0=")), "props")
  Jsii::Object.instance_method(:initialize).bind(self).call(scope, id, props)
end

Class Method Details

.CFN_RESOURCE_TYPE_NAME ⇒ String

The CloudFormation resource type name for this resource class.

Returns:

  • (String) 


208
209
210
 
# File 'ecs/cfn_express_gateway_service.rb', line 208

def self.CFN_RESOURCE_TYPE_NAME()
  Jsii::Kernel.instance.get_static("aws-cdk-lib.aws_ecs.CfnExpressGatewayService", "CFN_RESOURCE_TYPE_NAME")
end

.is_cfn_express_gateway_service(x) ⇒ Boolean

Checks whether the given object is a CfnExpressGatewayService.

Parameters:

  • x (Object)

Returns:

  • (Boolean) 


110
111
112
113
 
# File 'ecs/cfn_express_gateway_service.rb', line 110

def self.is_cfn_express_gateway_service(x)
  Jsii::Type.check_type(x, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJhbnkifQ==")), "x")
  Jsii::Kernel.instance.call_static("aws-cdk-lib.aws_ecs.CfnExpressGatewayService", "isCfnExpressGatewayService", [x])
end

.jsii_overridable_methods ⇒ Object 



32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
 
# File 'ecs/cfn_express_gateway_service.rb', line 32

def self.jsii_overridable_methods
  {
    :node => { kind: :property, name: "node", is_optional: false },
    :creation_stack => { kind: :property, name: "creationStack", is_optional: false },
    :logical_id => { kind: :property, name: "logicalId", is_optional: false },
    :stack => { kind: :property, name: "stack", is_optional: false },
    :ref => { kind: :property, name: "ref", is_optional: false },
    :cfn_options => { kind: :property, name: "cfnOptions", is_optional: false },
    :cfn_properties => { kind: :property, name: "cfnProperties", is_optional: false },
    :cfn_property_names => { kind: :property, name: "cfnPropertyNames", is_optional: false },
    :cfn_resource_type => { kind: :property, name: "cfnResourceType", is_optional: false },
    :env => { kind: :property, name: "env", is_optional: false },
    :updated_properites => { kind: :property, name: "updatedProperites", is_optional: false },
    :updated_properties => { kind: :property, name: "updatedProperties", is_optional: false },
    :attr_active_configurations => { kind: :property, name: "attrActiveConfigurations", is_optional: false },
    :attr_created_at => { kind: :property, name: "attrCreatedAt", is_optional: false },
    :attr_ecs_managed_resource_arns => { kind: :property, name: "attrEcsManagedResourceArns", is_optional: false },
    :attr_ecs_managed_resource_arns_auto_scaling => { kind: :property, name: "attrEcsManagedResourceArnsAutoScaling", is_optional: false },
    :attr_ecs_managed_resource_arns_auto_scaling_application_auto_scaling_policies => { kind: :property, name: "attrEcsManagedResourceArnsAutoScalingApplicationAutoScalingPolicies", is_optional: false },
    :attr_ecs_managed_resource_arns_auto_scaling_scalable_target => { kind: :property, name: "attrEcsManagedResourceArnsAutoScalingScalableTarget", is_optional: false },
    :attr_ecs_managed_resource_arns_ingress_path => { kind: :property, name: "attrEcsManagedResourceArnsIngressPath", is_optional: false },
    :attr_ecs_managed_resource_arns_ingress_path_certificate_arn => { kind: :property, name: "attrEcsManagedResourceArnsIngressPathCertificateArn", is_optional: false },
    :attr_ecs_managed_resource_arns_ingress_path_listener_arn => { kind: :property, name: "attrEcsManagedResourceArnsIngressPathListenerArn", is_optional: false },
    :attr_ecs_managed_resource_arns_ingress_path_listener_rule_arn => { kind: :property, name: "attrEcsManagedResourceArnsIngressPathListenerRuleArn", is_optional: false },
    :attr_ecs_managed_resource_arns_ingress_path_load_balancer_arn => { kind: :property, name: "attrEcsManagedResourceArnsIngressPathLoadBalancerArn", is_optional: false },
    :attr_ecs_managed_resource_arns_ingress_path_load_balancer_security_groups => { kind: :property, name: "attrEcsManagedResourceArnsIngressPathLoadBalancerSecurityGroups", is_optional: false },
    :attr_ecs_managed_resource_arns_ingress_path_target_group_arns => { kind: :property, name: "attrEcsManagedResourceArnsIngressPathTargetGroupArns", is_optional: false },
    :attr_ecs_managed_resource_arns_log_groups => { kind: :property, name: "attrEcsManagedResourceArnsLogGroups", is_optional: false },
    :attr_ecs_managed_resource_arns_metric_alarms => { kind: :property, name: "attrEcsManagedResourceArnsMetricAlarms", is_optional: false },
    :attr_ecs_managed_resource_arns_service_security_groups => { kind: :property, name: "attrEcsManagedResourceArnsServiceSecurityGroups", is_optional: false },
    :attr_endpoint => { kind: :property, name: "attrEndpoint", is_optional: false },
    :attr_service_arn => { kind: :property, name: "attrServiceArn", is_optional: false },
    :attr_status => { kind: :property, name: "attrStatus", is_optional: false },
    :attr_updated_at => { kind: :property, name: "attrUpdatedAt", is_optional: false },
    :cdk_tag_manager => { kind: :property, name: "cdkTagManager", is_optional: false },
    :express_gateway_service_ref => { kind: :property, name: "expressGatewayServiceRef", is_optional: false },
    :execution_role_arn => { kind: :property, name: "executionRoleArn", is_optional: false },
    :infrastructure_role_arn => { kind: :property, name: "infrastructureRoleArn", is_optional: false },
    :primary_container => { kind: :property, name: "primaryContainer", is_optional: false },
    :cluster => { kind: :property, name: "cluster", is_optional: true },
    :cpu => { kind: :property, name: "cpu", is_optional: true },
    :health_check_path => { kind: :property, name: "healthCheckPath", is_optional: true },
    :memory => { kind: :property, name: "memory", is_optional: true },
    :network_configuration => { kind: :property, name: "networkConfiguration", is_optional: true },
    :scaling_target => { kind: :property, name: "scalingTarget", is_optional: true },
    :service_name => { kind: :property, name: "serviceName", is_optional: true },
    :tags => { kind: :property, name: "tags", is_optional: true },
    :task_role_arn => { kind: :property, name: "taskRoleArn", is_optional: true },
    :to_string => { kind: :method, name: "toString", is_optional: false },
    :with => { kind: :method, name: "with", is_optional: false },
    :override_logical_id => { kind: :method, name: "overrideLogicalId", is_optional: false },
    :add_deletion_override => { kind: :method, name: "addDeletionOverride", is_optional: false },
    :add_dependency => { kind: :method, name: "addDependency", is_optional: false },
    :add_depends_on => { kind: :method, name: "addDependsOn", is_optional: false },
    :add_metadata => { kind: :method, name: "addMetadata", is_optional: false },
    :add_override => { kind: :method, name: "addOverride", is_optional: false },
    :add_property_deletion_override => { kind: :method, name: "addPropertyDeletionOverride", is_optional: false },
    :add_property_override => { kind: :method, name: "addPropertyOverride", is_optional: false },
    :apply_cross_stack_reference_strength => { kind: :method, name: "applyCrossStackReferenceStrength", is_optional: false },
    :apply_removal_policy => { kind: :method, name: "applyRemovalPolicy", is_optional: false },
    :cfn_property_name => { kind: :method, name: "cfnPropertyName", is_optional: false },
    :get_att => { kind: :method, name: "getAtt", is_optional: false },
    :get_metadata => { kind: :method, name: "getMetadata", is_optional: false },
    :obtain_dependencies => { kind: :method, name: "obtainDependencies", is_optional: false },
    :obtain_resource_dependencies => { kind: :method, name: "obtainResourceDependencies", is_optional: false },
    :remove_dependency => { kind: :method, name: "removeDependency", is_optional: false },
    :render_properties => { kind: :method, name: "renderProperties", is_optional: false },
    :replace_dependency => { kind: :method, name: "replaceDependency", is_optional: false },
    :should_synthesize => { kind: :method, name: "shouldSynthesize", is_optional: false },
    :validate_properties => { kind: :method, name: "validateProperties", is_optional: false },
    :inspect => { kind: :method, name: "inspect", is_optional: false },
  }
end

Instance Method Details

#add_deletion_override(path) ⇒ void

This method returns an undefined value.

Syntactic sugar for addOverride(path, undefined).

Parameters:

  • path (String) —

    The path of the value to delete.



542
543
544
545
 
# File 'ecs/cfn_express_gateway_service.rb', line 542

def add_deletion_override(path)
  Jsii::Type.check_type(path, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "path")
  jsii_call_method("addDeletionOverride", [path])
end

#add_dependency(target) ⇒ void

This method returns an undefined value.

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:



554
555
556
557
 
# File 'ecs/cfn_express_gateway_service.rb', line 554

def add_dependency(target)
  Jsii::Type.check_type(target, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5DZm5SZXNvdXJjZSJ9")), "target")
  jsii_call_method("addDependency", [target])
end

#add_depends_on(target) ⇒ void

Deprecated.

use addDependency

This method returns an undefined value.

Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned.

Parameters:



564
565
566
567
 
# File 'ecs/cfn_express_gateway_service.rb', line 564

def add_depends_on(target)
  Jsii::Type.check_type(target, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5DZm5SZXNvdXJjZSJ9")), "target")
  jsii_call_method("addDependsOn", [target])
end

#add_metadata(key, value) ⇒ void

This method returns an undefined value.

Add a value to the CloudFormation Resource Metadata.

Parameters:

  • key (String)
  • value (Object)

See Also:



575
576
577
578
579
 
# File 'ecs/cfn_express_gateway_service.rb', line 575

def add_metadata(key, value)
  Jsii::Type.check_type(key, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "key")
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJhbnkifQ==")), "value")
  jsii_call_method("addMetadata", [key, value])
end

#add_override(path, value) ⇒ void

This method returns an undefined value.

Adds an override to the synthesized CloudFormation resource.

To add a property override, either use add_property_override or prefix path with "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,

# Example automatically generated from non-compiling source. May contain errors.
cfn_resource.add_override("Properties.GlobalSecondaryIndexes.0.Projection.NonKeyAttributes", ["myattribute"])
cfn_resource.add_override("Properties.GlobalSecondaryIndexes.1.ProjectionType", "INCLUDE")

would add the overrides

"Properties": {
  "GlobalSecondaryIndexes": [
    {
      "Projection": {
        "NonKeyAttributes": [ "myattribute" ]
        ...
      }
      ...
    },
    {
      "ProjectionType": "INCLUDE"
      ...
    },
  ]
  ...
}

The value argument to add_override will 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 (String) —
    • The path of the property, you can use dot notation to override values in complex types.
  • value (Object) —
    • The value.


632
633
634
635
636
 
# File 'ecs/cfn_express_gateway_service.rb', line 632

def add_override(path, value)
  Jsii::Type.check_type(path, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "path")
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJhbnkifQ==")), "value")
  jsii_call_method("addOverride", [path, value])
end

#add_property_deletion_override(property_path) ⇒ void

This method returns an undefined value.

Adds an override that deletes the value of a property from the resource definition.

Parameters:

  • property_path (String) —

    The path to the property.



642
643
644
645
 
# File 'ecs/cfn_express_gateway_service.rb', line 642

def add_property_deletion_override(property_path)
  Jsii::Type.check_type(property_path, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "propertyPath")
  jsii_call_method("addPropertyDeletionOverride", [property_path])
end

#add_property_override(property_path, value) ⇒ void

This method returns an undefined value.

Adds an override to a resource property.

Syntactic sugar for addOverride("Properties.<...>", value).

Parameters:

  • property_path (String) —

    The path of the property.

  • value (Object) —

    The value.



654
655
656
657
658
 
# File 'ecs/cfn_express_gateway_service.rb', line 654

def add_property_override(property_path, value)
  Jsii::Type.check_type(property_path, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "propertyPath")
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJhbnkifQ==")), "value")
  jsii_call_method("addPropertyOverride", [property_path, value])
end

#apply_cross_stack_reference_strength(strength) ⇒ void

This method returns an undefined value.

Sets the cross-stack reference strength for this resource.

When set, any cross-stack reference to this resource will use the specified strength instead of the global default from the consuming stack's context.

Parameters:



667
668
669
670
 
# File 'ecs/cfn_express_gateway_service.rb', line 667

def apply_cross_stack_reference_strength(strength)
  Jsii::Type.check_type(strength, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5SZWZlcmVuY2VTdHJlbmd0aCJ9")), "strength")
  jsii_call_method("applyCrossStackReferenceStrength", [strength])
end

#apply_removal_policy(policy = nil, options = nil) ⇒ void

This method returns an undefined value.

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:

See Also:



689
690
691
692
693
694
 
# File 'ecs/cfn_express_gateway_service.rb', line 689

def apply_removal_policy(policy = nil, options = nil)
  Jsii::Type.check_type(policy, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5SZW1vdmFsUG9saWN5In0=")), "policy") unless policy.nil?
  options = options.is_a?(Hash) ? ::AWSCDK::RemovalPolicyOptions.new(**options.transform_keys(&:to_sym)) : options
  Jsii::Type.check_type(options, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5SZW1vdmFsUG9saWN5T3B0aW9ucyJ9")), "options") unless options.nil?
  jsii_call_method("applyRemovalPolicy", [policy, options])
end

#attr_active_configurations ⇒ AWSCDK::IResolvable

The list of active service configurations for the Express service.

Returns:



215
216
217
 
# File 'ecs/cfn_express_gateway_service.rb', line 215

def attr_active_configurations()
  jsii_get_property("attrActiveConfigurations")
end

#attr_created_at ⇒ String

The Unix timestamp for when the Express service was created.

Returns:

  • (String) 


222
223
224
 
# File 'ecs/cfn_express_gateway_service.rb', line 222

def attr_created_at()
  jsii_get_property("attrCreatedAt")
end

#attr_ecs_managed_resource_arns ⇒ AWSCDK::IResolvable

Returns:



227
228
229
 
# File 'ecs/cfn_express_gateway_service.rb', line 227

def attr_ecs_managed_resource_arns()
  jsii_get_property("attrEcsManagedResourceArns")
end

#attr_ecs_managed_resource_arns_auto_scaling ⇒ AWSCDK::IResolvable

Returns:



232
233
234
 
# File 'ecs/cfn_express_gateway_service.rb', line 232

def attr_ecs_managed_resource_arns_auto_scaling()
  jsii_get_property("attrEcsManagedResourceArnsAutoScaling")
end

#attr_ecs_managed_resource_arns_auto_scaling_application_auto_scaling_policies ⇒ Array<String>

The list of Auto Scaling policy ARNs associated with the express service.

Returns:

  • (Array<String>) 


239
240
241
 
# File 'ecs/cfn_express_gateway_service.rb', line 239

def attr_ecs_managed_resource_arns_auto_scaling_application_auto_scaling_policies()
  jsii_get_property("attrEcsManagedResourceArnsAutoScalingApplicationAutoScalingPolicies")
end

#attr_ecs_managed_resource_arns_auto_scaling_scalable_target ⇒ String

The Auto Scaling Scalable Target ARN associated with the express service.

Returns:

  • (String) 


246
247
248
 
# File 'ecs/cfn_express_gateway_service.rb', line 246

def attr_ecs_managed_resource_arns_auto_scaling_scalable_target()
  jsii_get_property("attrEcsManagedResourceArnsAutoScalingScalableTarget")
end

#attr_ecs_managed_resource_arns_ingress_path ⇒ AWSCDK::IResolvable

Returns:



251
252
253
 
# File 'ecs/cfn_express_gateway_service.rb', line 251

def attr_ecs_managed_resource_arns_ingress_path()
  jsii_get_property("attrEcsManagedResourceArnsIngressPath")
end

#attr_ecs_managed_resource_arns_ingress_path_certificate_arn ⇒ String

The Certificate ARN associated with the express service.

Returns:

  • (String) 


258
259
260
 
# File 'ecs/cfn_express_gateway_service.rb', line 258

def attr_ecs_managed_resource_arns_ingress_path_certificate_arn()
  jsii_get_property("attrEcsManagedResourceArnsIngressPathCertificateArn")
end

#attr_ecs_managed_resource_arns_ingress_path_listener_arn ⇒ String

The ARN of the Load Balancer listener associated with the express service.

Returns:

  • (String) 


265
266
267
 
# File 'ecs/cfn_express_gateway_service.rb', line 265

def attr_ecs_managed_resource_arns_ingress_path_listener_arn()
  jsii_get_property("attrEcsManagedResourceArnsIngressPathListenerArn")
end

#attr_ecs_managed_resource_arns_ingress_path_listener_rule_arn ⇒ String

The ARN of the Load Balancer listener rule associated with the express service.

Returns:

  • (String) 


272
273
274
 
# File 'ecs/cfn_express_gateway_service.rb', line 272

def attr_ecs_managed_resource_arns_ingress_path_listener_rule_arn()
  jsii_get_property("attrEcsManagedResourceArnsIngressPathListenerRuleArn")
end

#attr_ecs_managed_resource_arns_ingress_path_load_balancer_arn ⇒ String

The ARN of the Load Balancer associated with the express service.

Returns:

  • (String) 


279
280
281
 
# File 'ecs/cfn_express_gateway_service.rb', line 279

def attr_ecs_managed_resource_arns_ingress_path_load_balancer_arn()
  jsii_get_property("attrEcsManagedResourceArnsIngressPathLoadBalancerArn")
end

#attr_ecs_managed_resource_arns_ingress_path_load_balancer_security_groups ⇒ Array<String>

The list of Load Balancer Security Group ARNs associated with the express service.

Returns:

  • (Array<String>) 


286
287
288
 
# File 'ecs/cfn_express_gateway_service.rb', line 286

def attr_ecs_managed_resource_arns_ingress_path_load_balancer_security_groups()
  jsii_get_property("attrEcsManagedResourceArnsIngressPathLoadBalancerSecurityGroups")
end

#attr_ecs_managed_resource_arns_ingress_path_target_group_arns ⇒ Array<String>

The list of Target Group ARNs associated with the express service.

Returns:

  • (Array<String>) 


293
294
295
 
# File 'ecs/cfn_express_gateway_service.rb', line 293

def attr_ecs_managed_resource_arns_ingress_path_target_group_arns()
  jsii_get_property("attrEcsManagedResourceArnsIngressPathTargetGroupArns")
end

#attr_ecs_managed_resource_arns_log_groups ⇒ Array<String>

The list of Log Group ARNs associated with the express service.

Returns:

  • (Array<String>) 


300
301
302
 
# File 'ecs/cfn_express_gateway_service.rb', line 300

def attr_ecs_managed_resource_arns_log_groups()
  jsii_get_property("attrEcsManagedResourceArnsLogGroups")
end

#attr_ecs_managed_resource_arns_metric_alarms ⇒ Array<String>

The list of Metric Alarm ARNs associated with the express service.

Returns:

  • (Array<String>) 


307
308
309
 
# File 'ecs/cfn_express_gateway_service.rb', line 307

def attr_ecs_managed_resource_arns_metric_alarms()
  jsii_get_property("attrEcsManagedResourceArnsMetricAlarms")
end

#attr_ecs_managed_resource_arns_service_security_groups ⇒ Array<String>

The list of Security Group ARNs associated with the express service.

Returns:

  • (Array<String>) 


314
315
316
 
# File 'ecs/cfn_express_gateway_service.rb', line 314

def attr_ecs_managed_resource_arns_service_security_groups()
  jsii_get_property("attrEcsManagedResourceArnsServiceSecurityGroups")
end

#attr_endpoint ⇒ String

The Endpoint of the express service.

Returns:

  • (String) 


321
322
323
 
# File 'ecs/cfn_express_gateway_service.rb', line 321

def attr_endpoint()
  jsii_get_property("attrEndpoint")
end

#attr_service_arn ⇒ String

The ARN that identifies the Express service.

Returns:

  • (String) 


328
329
330
 
# File 'ecs/cfn_express_gateway_service.rb', line 328

def attr_service_arn()
  jsii_get_property("attrServiceArn")
end

#attr_status ⇒ AWSCDK::IResolvable

Returns:



333
334
335
 
# File 'ecs/cfn_express_gateway_service.rb', line 333

def attr_status()
  jsii_get_property("attrStatus")
end

#attr_updated_at ⇒ String

The Unix timestamp for when the Express service was last updated.

Returns:

  • (String) 


340
341
342
 
# File 'ecs/cfn_express_gateway_service.rb', line 340

def attr_updated_at()
  jsii_get_property("attrUpdatedAt")
end

#cdk_tag_manager ⇒ AWSCDK::TagManager

Tag Manager which manages the tags for this resource.

Returns:



347
348
349
 
# File 'ecs/cfn_express_gateway_service.rb', line 347

def cdk_tag_manager()
  jsii_get_property("cdkTagManager")
end

#cfn_options ⇒ AWSCDK::ICfnResourceOptions

Options for this resource, such as condition, update policy etc.

Returns:



161
162
163
 
# File 'ecs/cfn_express_gateway_service.rb', line 161

def cfn_options()
  jsii_get_property("cfnOptions")
end

#cfn_properties ⇒ Hash{String => Object}

Returns:

  • (Hash{String => Object}) 


166
167
168
 
# File 'ecs/cfn_express_gateway_service.rb', line 166

def cfn_properties()
  jsii_get_property("cfnProperties")
end

#cfn_property_name(cdk_property_name) ⇒ String?

Parameters:

  • cdk_property_name (String)

Returns:

  • (String, nil) 


698
699
700
701
 
# File 'ecs/cfn_express_gateway_service.rb', line 698

def cfn_property_name(cdk_property_name)
  Jsii::Type.check_type(cdk_property_name, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "cdkPropertyName")
  jsii_call_method("cfnPropertyName", [cdk_property_name])
end

#cfn_property_names ⇒ Hash{String => String}

Returns:

  • (Hash{String => String}) 


171
172
173
 
# File 'ecs/cfn_express_gateway_service.rb', line 171

def cfn_property_names()
  jsii_get_property("cfnPropertyNames")
end

#cfn_resource_type ⇒ String

AWS resource type.

Returns:

  • (String) 


178
179
180
 
# File 'ecs/cfn_express_gateway_service.rb', line 178

def cfn_resource_type()
  jsii_get_property("cfnResourceType")
end

#cluster ⇒ String?

The short name or full ARN of the cluster that hosts the Express service.

Returns:

  • (String, nil) 


398
399
400
 
# File 'ecs/cfn_express_gateway_service.rb', line 398

def cluster()
  jsii_get_property("cluster")
end

#cluster=(value) ⇒ Object 



402
403
404
405
 
# File 'ecs/cfn_express_gateway_service.rb', line 402

def cluster=(value)
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "cluster") unless value.nil?
  jsii_set_property("cluster", value)
end

#cpu ⇒ String?

The CPU allocation for tasks in this service revision.

Returns:

  • (String, nil) 


410
411
412
 
# File 'ecs/cfn_express_gateway_service.rb', line 410

def cpu()
  jsii_get_property("cpu")
end

#cpu=(value) ⇒ Object 



414
415
416
417
 
# File 'ecs/cfn_express_gateway_service.rb', line 414

def cpu=(value)
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "cpu") unless value.nil?
  jsii_set_property("cpu", value)
end

#creation_stack ⇒ Array<String>

Returns:

  • (Array<String>) 


123
124
125
 
# File 'ecs/cfn_express_gateway_service.rb', line 123

def creation_stack()
  jsii_get_property("creationStack")
end

#env ⇒ AWSCDK::Interfaces::ResourceEnvironment

Returns:



183
184
185
 
# File 'ecs/cfn_express_gateway_service.rb', line 183

def env()
  jsii_get_property("env")
end

#execution_role_arn ⇒ String

The ARN of the task execution role for the service revision.

Returns:

  • (String) 


361
362
363
 
# File 'ecs/cfn_express_gateway_service.rb', line 361

def execution_role_arn()
  jsii_get_property("executionRoleArn")
end

#execution_role_arn=(value) ⇒ Object 



365
366
367
368
 
# File 'ecs/cfn_express_gateway_service.rb', line 365

def execution_role_arn=(value)
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "executionRoleArn")
  jsii_set_property("executionRoleArn", value)
end

#express_gateway_service_ref ⇒ AWSCDK::Interfaces::AWSECS::ExpressGatewayServiceReference

A reference to a ExpressGatewayService resource.

Returns:



354
355
356
 
# File 'ecs/cfn_express_gateway_service.rb', line 354

def express_gateway_service_ref()
  jsii_get_property("expressGatewayServiceRef")
end

#get_att(attribute_name, type_hint = nil) ⇒ AWSCDK::Reference

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:

Returns:



711
712
713
714
715
 
# File 'ecs/cfn_express_gateway_service.rb', line 711

def get_att(attribute_name, type_hint = nil)
  Jsii::Type.check_type(attribute_name, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "attributeName")
  Jsii::Type.check_type(type_hint, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5SZXNvbHV0aW9uVHlwZUhpbnQifQ==")), "typeHint") unless type_hint.nil?
  jsii_call_method("getAtt", [attribute_name, type_hint])
end

#get_metadata(key) ⇒ Object

Retrieve a value value from the CloudFormation Resource Metadata.

Parameters:

  • key (String)

Returns:

  • (Object)

See Also:



722
723
724
725
 
# File 'ecs/cfn_express_gateway_service.rb', line 722

def get_metadata(key)
  Jsii::Type.check_type(key, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "key")
  jsii_call_method("getMetadata", [key])
end

#health_check_path ⇒ String?

The health check path for this service revision.

Returns:

  • (String, nil) 


422
423
424
 
# File 'ecs/cfn_express_gateway_service.rb', line 422

def health_check_path()
  jsii_get_property("healthCheckPath")
end

#health_check_path=(value) ⇒ Object 



426
427
428
429
 
# File 'ecs/cfn_express_gateway_service.rb', line 426

def health_check_path=(value)
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "healthCheckPath") unless value.nil?
  jsii_set_property("healthCheckPath", value)
end

#infrastructure_role_arn ⇒ String

The ARN of the infrastructure role that manages AWS resources for the Express service.

Returns:

  • (String) 


373
374
375
 
# File 'ecs/cfn_express_gateway_service.rb', line 373

def infrastructure_role_arn()
  jsii_get_property("infrastructureRoleArn")
end

#infrastructure_role_arn=(value) ⇒ Object 



377
378
379
380
 
# File 'ecs/cfn_express_gateway_service.rb', line 377

def infrastructure_role_arn=(value)
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "infrastructureRoleArn")
  jsii_set_property("infrastructureRoleArn", value)
end

#inspect(inspector) ⇒ void

This method returns an undefined value.

Examines the CloudFormation resource and discloses attributes.

Parameters:



792
793
794
795
 
# File 'ecs/cfn_express_gateway_service.rb', line 792

def inspect(inspector)
  Jsii::Type.check_type(inspector, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5UcmVlSW5zcGVjdG9yIn0=")), "inspector")
  jsii_call_method("inspect", [inspector])
end

#logical_id ⇒ String

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 override_logical_id(new_logical_id).

Returns:

  • (String) 


135
136
137
 
# File 'ecs/cfn_express_gateway_service.rb', line 135

def logical_id()
  jsii_get_property("logicalId")
end

#memory ⇒ String?

The memory allocation for tasks in this service revision.

Returns:

  • (String, nil) 


434
435
436
 
# File 'ecs/cfn_express_gateway_service.rb', line 434

def memory()
  jsii_get_property("memory")
end

#memory=(value) ⇒ Object 



438
439
440
441
 
# File 'ecs/cfn_express_gateway_service.rb', line 438

def memory=(value)
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "memory") unless value.nil?
  jsii_set_property("memory", value)
end

#network_configuration ⇒ AWSCDK::IResolvable, ...

The network configuration for tasks in this service revision.

Returns:



446
447
448
 
# File 'ecs/cfn_express_gateway_service.rb', line 446

def network_configuration()
  jsii_get_property("networkConfiguration")
end

#network_configuration=(value) ⇒ Object 



450
451
452
453
454
 
# File 'ecs/cfn_express_gateway_service.rb', line 450

def network_configuration=(value)
  value = value.is_a?(Hash) ? ::AWSCDK::ECS::CfnExpressGatewayService::ExpressGatewayServiceNetworkConfigurationProperty.new(**value.transform_keys(&:to_sym)) : value
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19lY3MuQ2ZuRXhwcmVzc0dhdGV3YXlTZXJ2aWNlLkV4cHJlc3NHYXRld2F5U2VydmljZU5ldHdvcmtDb25maWd1cmF0aW9uUHJvcGVydHkifV19fQ==")), "networkConfiguration") unless value.nil?
  jsii_set_property("networkConfiguration", value)
end

#node ⇒ Constructs::Node

The tree node.

Returns:

  • (Constructs::Node) 


118
119
120
 
# File 'ecs/cfn_express_gateway_service.rb', line 118

def node()
  jsii_get_property("node")
end

#obtain_dependencies ⇒ Array<AWSCDK::CfnResource, AWSCDK::Stack>

Retrieves an array of resources this resource depends on.

This assembles dependencies on resources across stacks (including nested stacks) automatically.

Returns:



733
734
735
 
# File 'ecs/cfn_express_gateway_service.rb', line 733

def obtain_dependencies()
  jsii_call_method("obtainDependencies", [])
end

#obtain_resource_dependencies ⇒ Array<AWSCDK::CfnResource>

Get a shallow copy of dependencies between this resource and other resources in the same stack.

Returns:



740
741
742
 
# File 'ecs/cfn_express_gateway_service.rb', line 740

def obtain_resource_dependencies()
  jsii_call_method("obtainResourceDependencies", [])
end

#override_logical_id(new_logical_id) ⇒ void

This method returns an undefined value.

Overrides the auto-generated logical ID with a specific ID.

Parameters:

  • new_logical_id (String) —

    The new logical ID to use for this stack element.



533
534
535
536
 
# File 'ecs/cfn_express_gateway_service.rb', line 533

def override_logical_id(new_logical_id)
  Jsii::Type.check_type(new_logical_id, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "newLogicalId")
  jsii_call_method("overrideLogicalId", [new_logical_id])
end

#primary_container ⇒ AWSCDK::IResolvable, AWSCDK::ECS::CfnExpressGatewayService::ExpressGatewayContainerProperty

The primary container configuration for this service revision.

Returns:



385
386
387
 
# File 'ecs/cfn_express_gateway_service.rb', line 385

def primary_container()
  jsii_get_property("primaryContainer")
end

#primary_container=(value) ⇒ Object 



389
390
391
392
393
 
# File 'ecs/cfn_express_gateway_service.rb', line 389

def primary_container=(value)
  value = value.is_a?(Hash) ? ::AWSCDK::ECS::CfnExpressGatewayService::ExpressGatewayContainerProperty.new(**value.transform_keys(&:to_sym)) : value
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19lY3MuQ2ZuRXhwcmVzc0dhdGV3YXlTZXJ2aWNlLkV4cHJlc3NHYXRld2F5Q29udGFpbmVyUHJvcGVydHkifV19fQ==")), "primaryContainer")
  jsii_set_property("primaryContainer", value)
end

#ref ⇒ String

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 }).

Returns:

  • (String) 


154
155
156
 
# File 'ecs/cfn_express_gateway_service.rb', line 154

def ref()
  jsii_get_property("ref")
end

#remove_dependency(target) ⇒ void

This method returns an undefined value.

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:



751
752
753
754
 
# File 'ecs/cfn_express_gateway_service.rb', line 751

def remove_dependency(target)
  Jsii::Type.check_type(target, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5DZm5SZXNvdXJjZSJ9")), "target")
  jsii_call_method("removeDependency", [target])
end

#render_properties(props) ⇒ Hash{String => Object}

Parameters:

  • props (Hash{String => Object})

Returns:

  • (Hash{String => Object}) 


758
759
760
761
 
# File 'ecs/cfn_express_gateway_service.rb', line 758

def render_properties(props)
  Jsii::Type.check_type(props, JSON.parse(Base64.strict_decode64("eyJjb2xsZWN0aW9uIjp7ImVsZW1lbnR0eXBlIjp7InByaW1pdGl2ZSI6ImFueSJ9LCJraW5kIjoibWFwIn19")), "props")
  jsii_call_method("renderProperties", [props])
end

#replace_dependency(target, new_target) ⇒ void

This method returns an undefined value.

Replaces one dependency with another.

Parameters:



768
769
770
771
772
 
# File 'ecs/cfn_express_gateway_service.rb', line 768

def replace_dependency(target, new_target)
  Jsii::Type.check_type(target, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5DZm5SZXNvdXJjZSJ9")), "target")
  Jsii::Type.check_type(new_target, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5DZm5SZXNvdXJjZSJ9")), "newTarget")
  jsii_call_method("replaceDependency", [target, new_target])
end

#scaling_target ⇒ AWSCDK::IResolvable, ...

The auto-scaling configuration for this service revision.

Returns:



459
460
461
 
# File 'ecs/cfn_express_gateway_service.rb', line 459

def scaling_target()
  jsii_get_property("scalingTarget")
end

#scaling_target=(value) ⇒ Object 



463
464
465
466
467
 
# File 'ecs/cfn_express_gateway_service.rb', line 463

def scaling_target=(value)
  value = value.is_a?(Hash) ? ::AWSCDK::ECS::CfnExpressGatewayService::ExpressGatewayScalingTargetProperty.new(**value.transform_keys(&:to_sym)) : value
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19lY3MuQ2ZuRXhwcmVzc0dhdGV3YXlTZXJ2aWNlLkV4cHJlc3NHYXRld2F5U2NhbGluZ1RhcmdldFByb3BlcnR5In1dfX0=")), "scalingTarget") unless value.nil?
  jsii_set_property("scalingTarget", value)
end

#service_name ⇒ String?

The name of the Express service.

Returns:

  • (String, nil) 


472
473
474
 
# File 'ecs/cfn_express_gateway_service.rb', line 472

def service_name()
  jsii_get_property("serviceName")
end

#service_name=(value) ⇒ Object 



476
477
478
479
 
# File 'ecs/cfn_express_gateway_service.rb', line 476

def service_name=(value)
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "serviceName") unless value.nil?
  jsii_set_property("serviceName", value)
end

#should_synthesize ⇒ Boolean

Can be overridden by subclasses to determine if this resource will be rendered into the cloudformation template.

Returns:

  • (Boolean) —

    true if the resource should be included or false is the resource should be omitted.



777
778
779
 
# File 'ecs/cfn_express_gateway_service.rb', line 777

def should_synthesize()
  jsii_call_method("shouldSynthesize", [])
end

#stack ⇒ AWSCDK::Stack

The stack in which this element is defined.

CfnElements must be defined within a stack scope (directly or indirectly).

Returns:



144
145
146
 
# File 'ecs/cfn_express_gateway_service.rb', line 144

def stack()
  jsii_get_property("stack")
end

#tags ⇒ Array<AWSCDK::CfnTag>?

The metadata applied to the Express service.

Returns:



484
485
486
 
# File 'ecs/cfn_express_gateway_service.rb', line 484

def tags()
  jsii_get_property("tags")
end

#tags=(value) ⇒ Object 



488
489
490
491
492
 
# File 'ecs/cfn_express_gateway_service.rb', line 488

def tags=(value)
  value = value.is_a?(Array) ? value.map { |jsii_v0| jsii_v0.is_a?(Hash) ? ::AWSCDK::CfnTag.new(**jsii_v0.transform_keys(&:to_sym)) : jsii_v0 } : value
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJjb2xsZWN0aW9uIjp7ImVsZW1lbnR0eXBlIjp7ImZxbiI6ImF3cy1jZGstbGliLkNmblRhZyJ9LCJraW5kIjoiYXJyYXkifX0=")), "tags") unless value.nil?
  jsii_set_property("tags", value)
end

#task_role_arn ⇒ String?

The ARN of the task role for the service revision.

Returns:

  • (String, nil) 


497
498
499
 
# File 'ecs/cfn_express_gateway_service.rb', line 497

def task_role_arn()
  jsii_get_property("taskRoleArn")
end

#task_role_arn=(value) ⇒ Object 



501
502
503
504
 
# File 'ecs/cfn_express_gateway_service.rb', line 501

def task_role_arn=(value)
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "taskRoleArn") unless value.nil?
  jsii_set_property("taskRoleArn", value)
end

#to_string ⇒ String

Returns a string representation of this construct.

Returns:

  • (String) —

    a string representation of this resource



509
510
511
 
# File 'ecs/cfn_express_gateway_service.rb', line 509

def to_string()
  jsii_call_method("toString", [])
end

#updated_properites ⇒ Hash{String => Object}

Deprecated.

use updatedProperties Return properties modified after initiation Resources that expose mutable properties should override this function to collect and return the properties object for this resource.

Deprecated.

Returns:

  • (Hash{String => Object}) 


191
192
193
 
# File 'ecs/cfn_express_gateway_service.rb', line 191

def updated_properites()
  jsii_get_property("updatedProperites")
end

#updated_properties ⇒ Hash{String => Object}

Return properties modified after initiation.

Resources that expose mutable properties should override this function to collect and return the properties object for this resource.

Returns:

  • (Hash{String => Object}) 


201
202
203
 
# File 'ecs/cfn_express_gateway_service.rb', line 201

def updated_properties()
  jsii_get_property("updatedProperties")
end

#validate_properties(_properties) ⇒ void

This method returns an undefined value.

Parameters:

  • _properties (Object) 


783
784
785
786
 
# File 'ecs/cfn_express_gateway_service.rb', line 783

def validate_properties(_properties)
  Jsii::Type.check_type(_properties, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJhbnkifQ==")), "_properties")
  jsii_call_method("validateProperties", [_properties])
end

#with(*mixins) ⇒ Constructs::IConstruct

Applies one or more mixins to this construct.

Mixins are applied in order. The list of constructs is captured at the start of the call, so constructs added by a mixin will not be visited. Use multiple with() calls if subsequent mixins should apply to added constructs.

Parameters:

  • mixins (Array<Constructs::IMixin>)

Returns:

  • (Constructs::IConstruct) 


522
523
524
525
526
527
 
# File 'ecs/cfn_express_gateway_service.rb', line 522

def with(*mixins)
  mixins.each_with_index do |item, index|
    Jsii::Type.check_type(item, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJjb25zdHJ1Y3RzLklNaXhpbiJ9")), "mixins[#{index}]")
  end
  jsii_call_method("with", [*mixins])
end