Class CfnCluster
The AWS::ECS::Cluster
resource creates an Amazon Elastic Container Service (Amazon ECS) cluster.
Inherited Members
Namespace: Amazon.CDK.AWS.ECS
Assembly: Amazon.CDK.Lib.dll
Syntax (csharp)
public class CfnCluster : CfnResource, IInspectable, ITaggable
Syntax (vb)
Public Class CfnCluster
Inherits CfnResource
Implements IInspectable, ITaggable
Remarks
See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ecs-cluster.html
CloudformationResource: AWS::ECS::Cluster
ExampleMetadata: fixture=_generated
Examples
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
using Amazon.CDK.AWS.ECS;
var cfnCluster = new CfnCluster(this, "MyCfnCluster", new CfnClusterProps {
CapacityProviders = new [] { "capacityProviders" },
ClusterName = "clusterName",
ClusterSettings = new [] { new ClusterSettingsProperty {
Name = "name",
Value = "value"
} },
Configuration = new ClusterConfigurationProperty {
ExecuteCommandConfiguration = new ExecuteCommandConfigurationProperty {
KmsKeyId = "kmsKeyId",
LogConfiguration = new ExecuteCommandLogConfigurationProperty {
CloudWatchEncryptionEnabled = false,
CloudWatchLogGroupName = "cloudWatchLogGroupName",
S3BucketName = "s3BucketName",
S3EncryptionEnabled = false,
S3KeyPrefix = "s3KeyPrefix"
},
Logging = "logging"
}
},
DefaultCapacityProviderStrategy = new [] { new CapacityProviderStrategyItemProperty {
Base = 123,
CapacityProvider = "capacityProvider",
Weight = 123
} },
ServiceConnectDefaults = new ServiceConnectDefaultsProperty {
Namespace = "namespace"
},
Tags = new [] { new CfnTag {
Key = "key",
Value = "value"
} }
});
Synopsis
Constructors
CfnCluster(ByRefValue) | Used by jsii to construct an instance of this class from a Javascript-owned object reference |
CfnCluster(DeputyBase.DeputyProps) | Used by jsii to construct an instance of this class from DeputyProps |
CfnCluster(Construct, String, ICfnClusterProps) |
Properties
AttrArn | The Amazon Resource Name (ARN) of the Amazon ECS cluster, such as |
CapacityProviders | The short name of one or more capacity providers to associate with the cluster. |
CFN_RESOURCE_TYPE_NAME | The CloudFormation resource type name for this resource class. |
CfnProperties | |
ClusterName | A user-generated string that you use to identify your cluster. |
ClusterSettings | The settings to use when creating a cluster. |
Configuration | The execute command configuration for the cluster. |
DefaultCapacityProviderStrategy | The default capacity provider strategy for the cluster. |
ServiceConnectDefaults | Use this parameter to set a default Service Connect namespace. |
Tags | Tag Manager which manages the tags for this resource. |
TagsRaw | The metadata that you apply to the cluster to help you categorize and organize them. |
Methods
Inspect(TreeInspector) | Examines the CloudFormation resource and discloses attributes. |
RenderProperties(IDictionary<String, Object>) |
Constructors
CfnCluster(ByRefValue)
Used by jsii to construct an instance of this class from a Javascript-owned object reference
protected CfnCluster(ByRefValue reference)
Parameters
- reference Amazon.JSII.Runtime.Deputy.ByRefValue
The Javascript-owned object reference
CfnCluster(DeputyBase.DeputyProps)
Used by jsii to construct an instance of this class from DeputyProps
protected CfnCluster(DeputyBase.DeputyProps props)
Parameters
- props Amazon.JSII.Runtime.Deputy.DeputyBase.DeputyProps
The deputy props
CfnCluster(Construct, String, ICfnClusterProps)
public CfnCluster(Construct scope, string id, ICfnClusterProps props = null)
Parameters
- scope Constructs.Construct
Scope in which this resource is defined.
- id System.String
Construct identifier for this resource (unique in its scope).
- props ICfnClusterProps
Resource properties.
Properties
AttrArn
The Amazon Resource Name (ARN) of the Amazon ECS cluster, such as arn:aws:ecs:us-east-2:123456789012:cluster/MyECSCluster
.
public virtual string AttrArn { get; }
Property Value
System.String
Remarks
CloudformationAttribute: Arn
CapacityProviders
The short name of one or more capacity providers to associate with the cluster.
public virtual string[] CapacityProviders { get; set; }
Property Value
System.String[]
CFN_RESOURCE_TYPE_NAME
The CloudFormation resource type name for this resource class.
public static string CFN_RESOURCE_TYPE_NAME { get; }
Property Value
System.String
CfnProperties
protected override IDictionary<string, object> CfnProperties { get; }
Property Value
System.Collections.Generic.IDictionary<System.String, System.Object>
Overrides
ClusterName
A user-generated string that you use to identify your cluster.
public virtual string ClusterName { get; set; }
Property Value
System.String
ClusterSettings
The settings to use when creating a cluster.
public virtual object ClusterSettings { get; set; }
Property Value
System.Object
Configuration
The execute command configuration for the cluster.
public virtual object Configuration { get; set; }
Property Value
System.Object
DefaultCapacityProviderStrategy
The default capacity provider strategy for the cluster.
public virtual object DefaultCapacityProviderStrategy { get; set; }
Property Value
System.Object
ServiceConnectDefaults
Use this parameter to set a default Service Connect namespace.
public virtual object ServiceConnectDefaults { get; set; }
Property Value
System.Object
Tags
Tag Manager which manages the tags for this resource.
public virtual TagManager Tags { get; }
Property Value
TagsRaw
The metadata that you apply to the cluster to help you categorize and organize them.
public virtual ICfnTag[] TagsRaw { get; set; }
Property Value
ICfnTag[]
Methods
Inspect(TreeInspector)
Examines the CloudFormation resource and discloses attributes.
public virtual void Inspect(TreeInspector inspector)
Parameters
- inspector TreeInspector
tree inspector to collect and process attributes.
RenderProperties(IDictionary<String, Object>)
protected override IDictionary<string, object> RenderProperties(IDictionary<string, object> props)
Parameters
- props System.Collections.Generic.IDictionary<System.String, System.Object>
Returns
System.Collections.Generic.IDictionary<System.String, System.Object>