Class CfnClusterProps
Properties for defining a CfnCluster
.
Inheritance
Implements
Namespace: Amazon.CDK.AWS.EKS
Assembly: Amazon.CDK.Lib.dll
Syntax (csharp)
public class CfnClusterProps : Object, ICfnClusterProps
Syntax (vb)
Public Class CfnClusterProps
Inherits Object
Implements ICfnClusterProps
Remarks
See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-eks-cluster.html
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.EKS;
var cfnClusterProps = new CfnClusterProps {
ResourcesVpcConfig = new ResourcesVpcConfigProperty {
SubnetIds = new [] { "subnetIds" },
// the properties below are optional
EndpointPrivateAccess = false,
EndpointPublicAccess = false,
PublicAccessCidrs = new [] { "publicAccessCidrs" },
SecurityGroupIds = new [] { "securityGroupIds" }
},
RoleArn = "roleArn",
// the properties below are optional
AccessConfig = new AccessConfigProperty {
AuthenticationMode = "authenticationMode",
BootstrapClusterCreatorAdminPermissions = false
},
EncryptionConfig = new [] { new EncryptionConfigProperty {
Provider = new ProviderProperty {
KeyArn = "keyArn"
},
Resources = new [] { "resources" }
} },
KubernetesNetworkConfig = new KubernetesNetworkConfigProperty {
IpFamily = "ipFamily",
ServiceIpv4Cidr = "serviceIpv4Cidr",
ServiceIpv6Cidr = "serviceIpv6Cidr"
},
Logging = new LoggingProperty {
ClusterLogging = new ClusterLoggingProperty {
EnabledTypes = new [] { new LoggingTypeConfigProperty {
Type = "type"
} }
}
},
Name = "name",
OutpostConfig = new OutpostConfigProperty {
ControlPlaneInstanceType = "controlPlaneInstanceType",
OutpostArns = new [] { "outpostArns" },
// the properties below are optional
ControlPlanePlacement = new ControlPlanePlacementProperty {
GroupName = "groupName"
}
},
Tags = new [] { new CfnTag {
Key = "key",
Value = "value"
} },
Version = "version"
};
Synopsis
Constructors
CfnClusterProps() |
Properties
AccessConfig | The access configuration for the cluster. |
EncryptionConfig | The encryption configuration for the cluster. |
KubernetesNetworkConfig | The Kubernetes network configuration for the cluster. |
Logging | The logging configuration for your cluster. |
Name | The unique name to give to your cluster. |
OutpostConfig | An object representing the configuration of your local Amazon EKS cluster on an AWS Outpost. |
ResourcesVpcConfig | The VPC configuration that's used by the cluster control plane. |
RoleArn | The Amazon Resource Name (ARN) of the IAM role that provides permissions for the Kubernetes control plane to make calls to AWS API operations on your behalf. |
Tags | The metadata that you apply to the cluster to assist with categorization and organization. |
Version | The desired Kubernetes version for your cluster. |
Constructors
CfnClusterProps()
public CfnClusterProps()
Properties
AccessConfig
The access configuration for the cluster.
public object AccessConfig { get; set; }
Property Value
System.Object
Remarks
EncryptionConfig
The encryption configuration for the cluster.
public object EncryptionConfig { get; set; }
Property Value
System.Object
Remarks
KubernetesNetworkConfig
The Kubernetes network configuration for the cluster.
public object KubernetesNetworkConfig { get; set; }
Property Value
System.Object
Remarks
Logging
The logging configuration for your cluster.
public object Logging { get; set; }
Property Value
System.Object
Remarks
Name
The unique name to give to your cluster.
public string Name { get; set; }
Property Value
System.String
Remarks
OutpostConfig
An object representing the configuration of your local Amazon EKS cluster on an AWS Outpost.
public object OutpostConfig { get; set; }
Property Value
System.Object
Remarks
This object isn't available for clusters on the AWS cloud.
ResourcesVpcConfig
The VPC configuration that's used by the cluster control plane.
public object ResourcesVpcConfig { get; set; }
Property Value
System.Object
Remarks
Amazon EKS VPC resources have specific requirements to work properly with Kubernetes. For more information, see Cluster VPC Considerations and Cluster Security Group Considerations in the Amazon EKS User Guide . You must specify at least two subnets. You can specify up to five security groups, but we recommend that you use a dedicated security group for your cluster control plane.
RoleArn
The Amazon Resource Name (ARN) of the IAM role that provides permissions for the Kubernetes control plane to make calls to AWS API operations on your behalf.
public string RoleArn { get; set; }
Property Value
System.String
Remarks
For more information, see Amazon EKS Service IAM Role in the Amazon EKS User Guide .
Tags
The metadata that you apply to the cluster to assist with categorization and organization.
public ICfnTag[] Tags { get; set; }
Property Value
ICfnTag[]
Remarks
Each tag consists of a key and an optional value, both of which you define. Cluster tags don't propagate to any other resources associated with the cluster.
You must have the eks:TagResource
and eks:UntagResource
permissions for your IAM principal to manage the AWS CloudFormation stack. If you don't have these permissions, there might be unexpected behavior with stack-level tags propagating to the resource during resource creation and update.
Version
The desired Kubernetes version for your cluster.
public string Version { get; set; }
Property Value
System.String
Remarks
If you don't specify a value here, the default version available in Amazon EKS is used.
The default version might not be the latest version available.