ReadonlyclusterThe Amazon Resource Name (ARN) that identifies the cluster.
ReadonlyclusterThe name of the cluster.
ReadonlyconnectionsManage the allowed network connections for the cluster with Security Groups.
ReadonlyenvThe environment this resource belongs to. For resources that are created and managed by the CDK (generally, those created by creating new class instances like Role, Bucket, etc.), this is always the same as the environment of the stack they belong to; however, for imported resources (those obtained from static methods like fromRoleArn, fromBucketName, etc.), that might be different than the stack they were imported into.
ReadonlynodeThe tree node.
Protected ReadonlyphysicalReturns a string-encoded token that resolves to the physical name that should be passed to the CloudFormation resource.
This value will resolve to one of the following:
"my-awesome-bucket")undefined, when a name should be generated by CloudFormationReadonlystackThe stack in which this resource is defined.
ReadonlyvpcThe VPC associated with the cluster.
Static ReadonlyPROPERTY_Uniquely identifies this class.
Getter for autoscaling group added to cluster
Getter for _capacityProviderNames added to cluster
Getter for _defaultCapacityProviderStrategy. This is necessary to correctly create Capacity Provider Associations.
Getter for namespace added to cluster
Getter for execute command configuration associated with the cluster.
Whether the cluster has EC2 capacity associated with it
InternalCalled when this resource is referenced across environments (account/region) to order to request that a physical name will be generated for this resource during synthesis, so the resource can be referenced through its absolute name/arn.
This method adds an Auto Scaling Group Capacity Provider to a cluster.
the capacity provider to add to this cluster.
Optionaloptions: AddAutoScalingGroupCapacityOptionsIt is highly recommended to use Cluster.addAsgCapacityProvider instead of this method.
This method adds compute capacity to a cluster by creating an AutoScalingGroup with the specified options.
Returns the AutoScalingGroup so you can add autoscaling settings to it.
Add default capacity provider strategy for this cluster.
cluster default capacity provider strategy. This takes the form of a list of CapacityProviderStrategy objects.
For example [ { capacityProvider: 'FARGATE', base: 10, weight: 50 } ]
Add an AWS Cloud Map DNS namespace for this cluster. NOTE: HttpNamespaces are supported only for use cases involving Service Connect. For use cases involving both Service- Discovery and Service Connect, customers should manage the HttpNamespace outside of the Cluster.addDefaultCloudMapNamespace method.
This method adds a Managed Instances Capacity Provider to a cluster.
the capacity provider to add to this cluster.
Apply the given removal policy to this resource
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).
Returns an ARN that represents all tasks within the cluster that match
the task pattern specified. To represent all tasks, specify "*".
Task id pattern
Enable the Fargate capacity providers for this cluster.
ProtectedgenerateProtectedgetReturns an environment-sensitive token that should be used for the
resource's "ARN" attribute (e.g. bucket.bucketArn).
Normally, this token will resolve to arnAttr, but if the resource is
referenced across environments, arnComponents will be used to synthesize
a concrete ARN with the resource's physical name. Make sure to reference
this.physicalName in arnComponents.
The CFN attribute which resolves to the ARN of the resource.
Commonly it will be called "Arn" (e.g. resource.attrArn), but sometimes
it's the CFN resource's ref.
The format of the ARN of this resource. You must
reference this.physicalName somewhere within the ARN in order for
cross-environment references to work.
ProtectedgetReturns an environment-sensitive token that should be used for the
resource's "name" attribute (e.g. bucket.bucketName).
Normally, this token will resolve to nameAttr, but if the resource is
referenced across environments, it will be resolved to this.physicalName,
which will be a concrete name.
The CFN attribute which resolves to the resource's name.
Commonly this is the resource's ref.
Grants an ECS Task Protection API permission to the specified grantee. This method provides a streamlined way to assign the 'ecs:UpdateTaskProtection' permission, enabling the grantee to manage task protection in the ECS cluster.
The entity (e.g., IAM role or user) to grant the permissions to.
This method returns the specified CloudWatch metric for this cluster.
Optionalprops: MetricOptionsReturns a string representation of this construct.
StaticfromImport an existing cluster to the stack from the cluster ARN.
This does not provide access to the vpc, hasEc2Capacity, or connections -
use the fromClusterAttributes method to access those properties.
StaticfromImport an existing cluster to the stack from its attributes.
StaticisReturn whether the given object is a Cluster
StaticisChecks if x is a construct.
Use this method instead of instanceof to properly detect Construct
instances, even when the construct library is symlinked.
Explanation: in JavaScript, multiple copies of the constructs library on
disk are seen as independent, completely different libraries. As a
consequence, the class Construct in each copy of the constructs library
is seen as a different class, and an instance of one class will not test as
instanceof the other class. npm install will not create installations
like this, but users may manually symlink construct libraries together or
use a monorepo tool: in those cases, multiple copies of the constructs
library can be accidentally installed, and instanceof will behave
unpredictably. It is safest to avoid using instanceof, and using
this type-testing method instead.
Any object
true if x is an object created from a class which extends Construct.
StaticisReturns true if the construct was created by CDK, and false otherwise
StaticisCheck whether the given construct is a Resource
A construct for creating a compliant ECS cluster resource.