Class: AWSCDK::GameLift::CfnContainerGroupDefinition

Inherits:
CfnResource
  • Object
show all
Includes:
IInspectable, ITaggableV2, Interfaces::AWSGamelift::IContainerGroupDefinitionRef
Defined in:
game_lift/cfn_container_group_definition.rb

Overview

The properties that describe a container group resource.

You can update all properties of a container group definition properties. Updates to a container group definition are saved as new versions.

Used with: CreateContainerGroupDefinition

Returned by: DescribeContainerGroupDefinition , ListContainerGroupDefinitions , UpdateContainerGroupDefinition

See Also:

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(scope, id, props) ⇒ CfnContainerGroupDefinition

Create a new AWS::GameLift::ContainerGroupDefinition.

Parameters:



24
25
26
27
28
29
30
 
# File 'game_lift/cfn_container_group_definition.rb', line 24

def initialize(scope, id, props)
  props = props.is_a?(Hash) ? ::AWSCDK::GameLift::CfnContainerGroupDefinitionProps.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("eyJmcW4iOiJhd3MtY2RrLWxpYi5hd3NfZ2FtZWxpZnQuQ2ZuQ29udGFpbmVyR3JvdXBEZWZpbml0aW9uUHJvcHMifQ==")), "props")
  Jsii::Object.instance_method(:initialize).bind(self).call(scope, id, props)
end

Class Method Details

.arn_for_container_group_definition(resource) ⇒ String

Parameters:

Returns:

  • (String) 


91
92
93
94
 
# File 'game_lift/cfn_container_group_definition.rb', line 91

def self.arn_for_container_group_definition(resource)
  Jsii::Type.check_type(resource, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5pbnRlcmZhY2VzLmF3c19nYW1lbGlmdC5JQ29udGFpbmVyR3JvdXBEZWZpbml0aW9uUmVmIn0=")), "resource")
  Jsii::Kernel.instance.call_static("aws-cdk-lib.aws_gamelift.CfnContainerGroupDefinition", "arnForContainerGroupDefinition", [resource])
end

.CFN_RESOURCE_TYPE_NAME ⇒ String

The CloudFormation resource type name for this resource class.

Returns:

  • (String) 


198
199
200
 
# File 'game_lift/cfn_container_group_definition.rb', line 198

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

.is_cfn_container_group_definition(x) ⇒ Boolean

Checks whether the given object is a CfnContainerGroupDefinition.

Parameters:

  • x (Object)

Returns:

  • (Boolean) 


100
101
102
103
 
# File 'game_lift/cfn_container_group_definition.rb', line 100

def self.is_cfn_container_group_definition(x)
  Jsii::Type.check_type(x, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJhbnkifQ==")), "x")
  Jsii::Kernel.instance.call_static("aws-cdk-lib.aws_gamelift.CfnContainerGroupDefinition", "isCfnContainerGroupDefinition", [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
 
# File 'game_lift/cfn_container_group_definition.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_container_group_definition_arn => { kind: :property, name: "attrContainerGroupDefinitionArn", is_optional: false },
    :attr_creation_time => { kind: :property, name: "attrCreationTime", is_optional: false },
    :attr_status => { kind: :property, name: "attrStatus", is_optional: false },
    :attr_status_reason => { kind: :property, name: "attrStatusReason", is_optional: false },
    :attr_version_number => { kind: :property, name: "attrVersionNumber", is_optional: false },
    :cdk_tag_manager => { kind: :property, name: "cdkTagManager", is_optional: false },
    :container_group_definition_ref => { kind: :property, name: "containerGroupDefinitionRef", is_optional: false },
    :name => { kind: :property, name: "name", is_optional: false },
    :operating_system => { kind: :property, name: "operatingSystem", is_optional: false },
    :total_memory_limit_mebibytes => { kind: :property, name: "totalMemoryLimitMebibytes", is_optional: false },
    :total_vcpu_limit => { kind: :property, name: "totalVcpuLimit", is_optional: false },
    :container_group_type => { kind: :property, name: "containerGroupType", is_optional: true },
    :game_server_container_definition => { kind: :property, name: "gameServerContainerDefinition", is_optional: true },
    :source_version_number => { kind: :property, name: "sourceVersionNumber", is_optional: true },
    :support_container_definitions => { kind: :property, name: "supportContainerDefinitions", is_optional: true },
    :tags => { kind: :property, name: "tags", is_optional: true },
    :version_description => { kind: :property, name: "versionDescription", 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.



423
424
425
426
 
# File 'game_lift/cfn_container_group_definition.rb', line 423

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:



435
436
437
438
 
# File 'game_lift/cfn_container_group_definition.rb', line 435

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:



445
446
447
448
 
# File 'game_lift/cfn_container_group_definition.rb', line 445

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:



456
457
458
459
460
 
# File 'game_lift/cfn_container_group_definition.rb', line 456

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.


513
514
515
516
517
 
# File 'game_lift/cfn_container_group_definition.rb', line 513

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.



523
524
525
526
 
# File 'game_lift/cfn_container_group_definition.rb', line 523

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.



535
536
537
538
539
 
# File 'game_lift/cfn_container_group_definition.rb', line 535

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:



548
549
550
551
 
# File 'game_lift/cfn_container_group_definition.rb', line 548

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:



570
571
572
573
574
575
 
# File 'game_lift/cfn_container_group_definition.rb', line 570

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_container_group_definition_arn ⇒ String

The Amazon Resource Name ( ARN ) that is assigned to an Amazon GameLift Servers ContainerGroupDefinition resource. It uniquely identifies the resource across all AWS Regions. Format is arn:aws:gamelift:[region]::containergroupdefinition/[container group definition name]:[version] .

Returns:

  • (String) 


205
206
207
 
# File 'game_lift/cfn_container_group_definition.rb', line 205

def attr_container_group_definition_arn()
  jsii_get_property("attrContainerGroupDefinitionArn")
end

#attr_creation_time ⇒ String

A time stamp indicating when this data object was created.

Format is a number expressed in Unix time as milliseconds (for example "1469498468.057" ).

Returns:

  • (String) 


214
215
216
 
# File 'game_lift/cfn_container_group_definition.rb', line 214

def attr_creation_time()
  jsii_get_property("attrCreationTime")
end

#attr_status ⇒ String

Current status of the container group definition resource. Values include:.

  • COPYING -- Amazon GameLift Servers is in the process of making copies of all container images that are defined in the group. While in this state, the resource can't be used to create a container fleet.
  • READY -- Amazon GameLift Servers has copied the registry images for all containers that are defined in the group. You can use a container group definition in this status to create a container fleet.
  • FAILED -- Amazon GameLift Servers failed to create a valid container group definition resource. For more details on the cause of the failure, see StatusReason . A container group definition resource in failed status will be deleted within a few minutes.

Returns:

  • (String) 


225
226
227
 
# File 'game_lift/cfn_container_group_definition.rb', line 225

def attr_status()
  jsii_get_property("attrStatus")
end

#attr_status_reason ⇒ String

Additional information about a container group definition that's in FAILED status. Possible reasons include:.

  • An internal issue prevented Amazon GameLift Servers from creating the container group definition resource. Delete the failed resource and call CreateContainerGroupDefinition again.
  • An access-denied message means that you don't have permissions to access the container image on ECR. See IAM permission examples for help setting up required IAM permissions for Amazon GameLift Servers.
  • The ImageUri value for at least one of the containers in the container group definition was invalid or not found in the current AWS account.
  • At least one of the container images referenced in the container group definition exceeds the allowed size. For size limits, see Amazon GameLift Servers endpoints and quotas .
  • At least one of the container images referenced in the container group definition uses a different operating system than the one defined for the container group.

Returns:

  • (String) 


238
239
240
 
# File 'game_lift/cfn_container_group_definition.rb', line 238

def attr_status_reason()
  jsii_get_property("attrStatusReason")
end

#attr_version_number ⇒ Numeric

Indicates the version of a particular container group definition.

This number is incremented automatically when you update a container group definition. You can view, update, or delete individual versions or the entire container group definition.

Returns:

  • (Numeric) 


247
248
249
 
# File 'game_lift/cfn_container_group_definition.rb', line 247

def attr_version_number()
  jsii_get_property("attrVersionNumber")
end

#cdk_tag_manager ⇒ AWSCDK::TagManager

Tag Manager which manages the tags for this resource.

Returns:



254
255
256
 
# File 'game_lift/cfn_container_group_definition.rb', line 254

def cdk_tag_manager()
  jsii_get_property("cdkTagManager")
end

#cfn_options ⇒ AWSCDK::ICfnResourceOptions

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

Returns:



151
152
153
 
# File 'game_lift/cfn_container_group_definition.rb', line 151

def cfn_options()
  jsii_get_property("cfnOptions")
end

#cfn_properties ⇒ Hash{String => Object}

Returns:

  • (Hash{String => Object}) 


156
157
158
 
# File 'game_lift/cfn_container_group_definition.rb', line 156

def cfn_properties()
  jsii_get_property("cfnProperties")
end

#cfn_property_name(cdk_property_name) ⇒ String?

Parameters:

  • cdk_property_name (String)

Returns:

  • (String, nil) 


579
580
581
582
 
# File 'game_lift/cfn_container_group_definition.rb', line 579

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


161
162
163
 
# File 'game_lift/cfn_container_group_definition.rb', line 161

def cfn_property_names()
  jsii_get_property("cfnPropertyNames")
end

#cfn_resource_type ⇒ String

AWS resource type.

Returns:

  • (String) 


168
169
170
 
# File 'game_lift/cfn_container_group_definition.rb', line 168

def cfn_resource_type()
  jsii_get_property("cfnResourceType")
end

#container_group_definition_ref ⇒ AWSCDK::Interfaces::AWSGamelift::ContainerGroupDefinitionReference

A reference to a ContainerGroupDefinition resource.

Returns:



261
262
263
 
# File 'game_lift/cfn_container_group_definition.rb', line 261

def container_group_definition_ref()
  jsii_get_property("containerGroupDefinitionRef")
end

#container_group_type ⇒ String?

The type of container group.

Returns:

  • (String, nil) 


316
317
318
 
# File 'game_lift/cfn_container_group_definition.rb', line 316

def container_group_type()
  jsii_get_property("containerGroupType")
end

#container_group_type=(value) ⇒ Object 



320
321
322
323
 
# File 'game_lift/cfn_container_group_definition.rb', line 320

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

#creation_stack ⇒ Array<String>

Returns:

  • (Array<String>) 


113
114
115
 
# File 'game_lift/cfn_container_group_definition.rb', line 113

def creation_stack()
  jsii_get_property("creationStack")
end

#env ⇒ AWSCDK::Interfaces::ResourceEnvironment

Returns:



173
174
175
 
# File 'game_lift/cfn_container_group_definition.rb', line 173

def env()
  jsii_get_property("env")
end

#game_server_container_definition ⇒ AWSCDK::IResolvable, ...

The definition for the game server container in this group.

Returns:



328
329
330
 
# File 'game_lift/cfn_container_group_definition.rb', line 328

def game_server_container_definition()
  jsii_get_property("gameServerContainerDefinition")
end

#game_server_container_definition=(value) ⇒ Object 



332
333
334
335
336
 
# File 'game_lift/cfn_container_group_definition.rb', line 332

def game_server_container_definition=(value)
  value = value.is_a?(Hash) ? ::AWSCDK::GameLift::CfnContainerGroupDefinition::GameServerContainerDefinitionProperty.new(**value.transform_keys(&:to_sym)) : value
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19nYW1lbGlmdC5DZm5Db250YWluZXJHcm91cERlZmluaXRpb24uR2FtZVNlcnZlckNvbnRhaW5lckRlZmluaXRpb25Qcm9wZXJ0eSJ9XX19")), "gameServerContainerDefinition") unless value.nil?
  jsii_set_property("gameServerContainerDefinition", value)
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:



592
593
594
595
596
 
# File 'game_lift/cfn_container_group_definition.rb', line 592

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:



603
604
605
606
 
# File 'game_lift/cfn_container_group_definition.rb', line 603

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

#inspect(inspector) ⇒ void

This method returns an undefined value.

Examines the CloudFormation resource and discloses attributes.

Parameters:



673
674
675
676
 
# File 'game_lift/cfn_container_group_definition.rb', line 673

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) 


125
126
127
 
# File 'game_lift/cfn_container_group_definition.rb', line 125

def logical_id()
  jsii_get_property("logicalId")
end

#name ⇒ String

A descriptive identifier for the container group definition.

Returns:

  • (String) 


268
269
270
 
# File 'game_lift/cfn_container_group_definition.rb', line 268

def name()
  jsii_get_property("name")
end

#name=(value) ⇒ Object 



272
273
274
275
 
# File 'game_lift/cfn_container_group_definition.rb', line 272

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

#node ⇒ Constructs::Node

The tree node.

Returns:

  • (Constructs::Node) 


108
109
110
 
# File 'game_lift/cfn_container_group_definition.rb', line 108

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:



614
615
616
 
# File 'game_lift/cfn_container_group_definition.rb', line 614

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:



621
622
623
 
# File 'game_lift/cfn_container_group_definition.rb', line 621

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

#operating_system ⇒ String

The platform that all containers in the container group definition run on.

Returns:

  • (String) 


280
281
282
 
# File 'game_lift/cfn_container_group_definition.rb', line 280

def operating_system()
  jsii_get_property("operatingSystem")
end

#operating_system=(value) ⇒ Object 



284
285
286
287
 
# File 'game_lift/cfn_container_group_definition.rb', line 284

def operating_system=(value)
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "operatingSystem")
  jsii_set_property("operatingSystem", value)
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.



414
415
416
417
 
# File 'game_lift/cfn_container_group_definition.rb', line 414

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

#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) 


144
145
146
 
# File 'game_lift/cfn_container_group_definition.rb', line 144

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:



632
633
634
635
 
# File 'game_lift/cfn_container_group_definition.rb', line 632

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


639
640
641
642
 
# File 'game_lift/cfn_container_group_definition.rb', line 639

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:



649
650
651
652
653
 
# File 'game_lift/cfn_container_group_definition.rb', line 649

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

#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.



658
659
660
 
# File 'game_lift/cfn_container_group_definition.rb', line 658

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

#source_version_number ⇒ Numeric?

A specific ContainerGroupDefinition version to be updated.

Returns:

  • (Numeric, nil) 


341
342
343
 
# File 'game_lift/cfn_container_group_definition.rb', line 341

def source_version_number()
  jsii_get_property("sourceVersionNumber")
end

#source_version_number=(value) ⇒ Object 



345
346
347
348
 
# File 'game_lift/cfn_container_group_definition.rb', line 345

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

#stack ⇒ AWSCDK::Stack

The stack in which this element is defined.

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

Returns:



134
135
136
 
# File 'game_lift/cfn_container_group_definition.rb', line 134

def stack()
  jsii_get_property("stack")
end

#support_container_definitions ⇒ AWSCDK::IResolvable, ...

The set of definitions for support containers in this group.

Returns:



353
354
355
 
# File 'game_lift/cfn_container_group_definition.rb', line 353

def support_container_definitions()
  jsii_get_property("supportContainerDefinitions")
end

#support_container_definitions=(value) ⇒ Object 



357
358
359
360
 
# File 'game_lift/cfn_container_group_definition.rb', line 357

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

#tags ⇒ Array<AWSCDK::CfnTag>?

An array of key-value pairs to apply to this resource.

Returns:



365
366
367
 
# File 'game_lift/cfn_container_group_definition.rb', line 365

def tags()
  jsii_get_property("tags")
end

#tags=(value) ⇒ Object 



369
370
371
372
373
 
# File 'game_lift/cfn_container_group_definition.rb', line 369

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

#to_string ⇒ String

Returns a string representation of this construct.

Returns:

  • (String) —

    a string representation of this resource



390
391
392
 
# File 'game_lift/cfn_container_group_definition.rb', line 390

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

#total_memory_limit_mebibytes ⇒ Numeric

The amount of memory (in MiB) on a fleet instance to allocate for the container group.

Returns:

  • (Numeric) 


292
293
294
 
# File 'game_lift/cfn_container_group_definition.rb', line 292

def total_memory_limit_mebibytes()
  jsii_get_property("totalMemoryLimitMebibytes")
end

#total_memory_limit_mebibytes=(value) ⇒ Object 



296
297
298
299
 
# File 'game_lift/cfn_container_group_definition.rb', line 296

def total_memory_limit_mebibytes=(value)
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJudW1iZXIifQ==")), "totalMemoryLimitMebibytes")
  jsii_set_property("totalMemoryLimitMebibytes", value)
end

#total_vcpu_limit ⇒ Numeric

The amount of vCPU units on a fleet instance to allocate for the container group (1 vCPU is equal to 1024 CPU units).

Returns:

  • (Numeric) 


304
305
306
 
# File 'game_lift/cfn_container_group_definition.rb', line 304

def total_vcpu_limit()
  jsii_get_property("totalVcpuLimit")
end

#total_vcpu_limit=(value) ⇒ Object 



308
309
310
311
 
# File 'game_lift/cfn_container_group_definition.rb', line 308

def total_vcpu_limit=(value)
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJudW1iZXIifQ==")), "totalVcpuLimit")
  jsii_set_property("totalVcpuLimit", value)
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}) 


181
182
183
 
# File 'game_lift/cfn_container_group_definition.rb', line 181

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


191
192
193
 
# File 'game_lift/cfn_container_group_definition.rb', line 191

def updated_properties()
  jsii_get_property("updatedProperties")
end

#validate_properties(_properties) ⇒ void

This method returns an undefined value.

Parameters:

  • _properties (Object) 


664
665
666
667
 
# File 'game_lift/cfn_container_group_definition.rb', line 664

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

#version_description ⇒ String?

An optional description that was provided for a container group definition update.

Returns:

  • (String, nil) 


378
379
380
 
# File 'game_lift/cfn_container_group_definition.rb', line 378

def version_description()
  jsii_get_property("versionDescription")
end

#version_description=(value) ⇒ Object 



382
383
384
385
 
# File 'game_lift/cfn_container_group_definition.rb', line 382

def version_description=(value)
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "versionDescription") unless value.nil?
  jsii_set_property("versionDescription", value)
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) 


403
404
405
406
407
408
 
# File 'game_lift/cfn_container_group_definition.rb', line 403

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