software.amazon.awscdk.services.eks

Class CfnCluster

java.lang.Object

software.amazon.jsii.JsiiObject

software.constructs.Construct

software.amazon.awscdk.CfnElement

software.amazon.awscdk.CfnRefElement

software.amazon.awscdk.CfnResource

software.amazon.awscdk.services.eks.CfnCluster

All Implemented Interfaces:

IInspectable, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct, software.constructs.IDependable

@Generated(value="jsii-pacmak/1.46.0 (build cd08c55)",
           date="2021-11-25T20:11:06.345Z")
 @Stability(value=Stable)
public class CfnCluster
extends CfnResource
implements IInspectable

A CloudFormation `AWS::EKS::Cluster`.

Example:

 // The code below shows an example of how to instantiate this type.
 // The values are placeholders you should change.
 import software.amazon.awscdk.services.eks.*;
 Object provider;
 CfnCluster cfnCluster = CfnCluster.Builder.create(this, "MyCfnCluster")
         .resourcesVpcConfig(ResourcesVpcConfigProperty.builder()
                 .subnetIds(List.of("subnetIds"))
                 // the properties below are optional
                 .endpointPrivateAccess(false)
                 .endpointPublicAccess(false)
                 .publicAccessCidrs(List.of("publicAccessCidrs"))
                 .securityGroupIds(List.of("securityGroupIds"))
                 .build())
         .roleArn("roleArn")
         // the properties below are optional
         .encryptionConfig(List.of(EncryptionConfigProperty.builder()
                 .provider(provider)
                 .resources(List.of("resources"))
                 .build()))
         .kubernetesNetworkConfig(KubernetesNetworkConfigProperty.builder()
                 .serviceIpv4Cidr("serviceIpv4Cidr")
                 .build())
         .logging(LoggingProperty.builder()
                 .clusterLogging(ClusterLoggingProperty.builder()
                         .enabledTypes(List.of(LoggingTypeConfigProperty.builder()
                                 .type("type")
                                 .build()))
                         .build())
                 .build())
         .name("name")
         .tags(List.of(CfnTag.builder()
                 .key("key")
                 .value("value")
                 .build()))
         .version("version")
         .build();
 

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	CfnCluster.Builder A fluent builder for CfnCluster.
static interface	CfnCluster.ClusterLoggingProperty Example:
static interface	CfnCluster.EncryptionConfigProperty Example:
static interface	CfnCluster.KubernetesNetworkConfigProperty Example:
static interface	CfnCluster.LoggingProperty Example:
static interface	CfnCluster.LoggingTypeConfigProperty Example:
static interface	CfnCluster.ResourcesVpcConfigProperty Example:

Nested classes/interfaces inherited from class software.amazon.jsii.JsiiObject

software.amazon.jsii.JsiiObject.InitializationMode

Nested classes/interfaces inherited from interface software.amazon.awscdk.IInspectable

IInspectable.Jsii$Default, IInspectable.Jsii$Proxy

Nested classes/interfaces inherited from interface software.constructs.IConstruct

software.constructs.IConstruct.Jsii$Default

Field Summary

Fields

Modifier and Type	Field and Description
static String	CFN_RESOURCE_TYPE_NAME The CloudFormation resource type name for this resource class.

Constructor Summary

Constructors

Modifier	Constructor and Description
	CfnCluster(software.constructs.Construct scope, String id, CfnClusterProps props) Create a new `AWS::EKS::Cluster`.
protected	CfnCluster(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
protected	CfnCluster(software.amazon.jsii.JsiiObjectRef objRef)

Method Summary

Modifier and Type	Method and Description
String	getAttrArn()
String	getAttrCertificateAuthorityData()
String	getAttrClusterSecurityGroupId()
String	getAttrEncryptionConfigKeyArn()
String	getAttrEndpoint()
String	getAttrOpenIdConnectIssuerUrl()
protected Map<String,Object>	getCfnProperties()
Object	getEncryptionConfig() `AWS::EKS::Cluster.EncryptionConfig`.
Object	getKubernetesNetworkConfig() `AWS::EKS::Cluster.KubernetesNetworkConfig`.
Object	getLogging() `AWS::EKS::Cluster.Logging`.
String	getName() `AWS::EKS::Cluster.Name`.
Object	getResourcesVpcConfig() `AWS::EKS::Cluster.ResourcesVpcConfig`.
String	getRoleArn() `AWS::EKS::Cluster.RoleArn`.
TagManager	getTags() `AWS::EKS::Cluster.Tags`.
String	getVersion() `AWS::EKS::Cluster.Version`.
void	inspect(TreeInspector inspector) Examines the CloudFormation resource and discloses attributes.
protected Map<String,Object>	renderProperties(Map<String,Object> props)
void	setEncryptionConfig(IResolvable value) `AWS::EKS::Cluster.EncryptionConfig`.
void	setEncryptionConfig(List<Object> value) `AWS::EKS::Cluster.EncryptionConfig`.
void	setKubernetesNetworkConfig(CfnCluster.KubernetesNetworkConfigProperty value) `AWS::EKS::Cluster.KubernetesNetworkConfig`.
void	setKubernetesNetworkConfig(IResolvable value) `AWS::EKS::Cluster.KubernetesNetworkConfig`.
void	setLogging(CfnCluster.LoggingProperty value) `AWS::EKS::Cluster.Logging`.
void	setLogging(IResolvable value) `AWS::EKS::Cluster.Logging`.
void	setName(String value) `AWS::EKS::Cluster.Name`.
void	setResourcesVpcConfig(CfnCluster.ResourcesVpcConfigProperty value) `AWS::EKS::Cluster.ResourcesVpcConfig`.
void	setResourcesVpcConfig(IResolvable value) `AWS::EKS::Cluster.ResourcesVpcConfig`.
void	setRoleArn(String value) `AWS::EKS::Cluster.RoleArn`.
void	setVersion(String value) `AWS::EKS::Cluster.Version`.

Methods inherited from class software.amazon.awscdk.CfnResource

addDeletionOverride, addDependsOn, addMetadata, addOverride, addPropertyDeletionOverride, addPropertyOverride, applyRemovalPolicy, applyRemovalPolicy, applyRemovalPolicy, getAtt, getCfnOptions, getCfnResourceType, getMetadata, getUpdatedProperites, isCfnResource, shouldSynthesize, toString, validateProperties

Methods inherited from class software.amazon.awscdk.CfnRefElement

getRef

Methods inherited from class software.amazon.awscdk.CfnElement

getCreationStack, getLogicalId, getStack, isCfnElement, overrideLogicalId

Methods inherited from class software.constructs.Construct

getNode, isConstruct

Methods inherited from class software.amazon.jsii.JsiiObject

jsiiAsyncCall, jsiiAsyncCall, jsiiCall, jsiiCall, jsiiGet, jsiiGet, jsiiSet, jsiiStaticCall, jsiiStaticCall, jsiiStaticGet, jsiiStaticGet, jsiiStaticSet, jsiiStaticSet

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Field Detail

CFN_RESOURCE_TYPE_NAME

@Stability(value=Stable)
public static final String CFN_RESOURCE_TYPE_NAME

The CloudFormation resource type name for this resource class.

Constructor Detail

CfnCluster

protected CfnCluster(software.amazon.jsii.JsiiObjectRef objRef)

CfnCluster

protected CfnCluster(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)

CfnCluster

@Stability(value=Stable)
public CfnCluster(@NotNull
                                           software.constructs.Construct scope,
                                           @NotNull
                                           String id,
                                           @NotNull
                                           CfnClusterProps props)

Create a new `AWS::EKS::Cluster`.

Parameters:

scope - - scope in which this resource is defined. This parameter is required.

id - - scoped id of the resource. This parameter is required.

props - - resource properties. This parameter is required.

Method Detail

inspect

@Stability(value=Stable)
public void inspect(@NotNull
                                             TreeInspector inspector)

Examines the CloudFormation resource and discloses attributes.

Specified by:

inspect in interface IInspectable

Parameters:

inspector - - tree inspector to collect and process attributes. This parameter is required.

renderProperties

@Stability(value=Stable)
 @NotNull
protected Map<String,Object> renderProperties(@NotNull
                                                                                 Map<String,Object> props)

Overrides:

renderProperties in class CfnResource

Parameters:

props - This parameter is required.

getAttrArn

@Stability(value=Stable)
 @NotNull
public String getAttrArn()

getAttrCertificateAuthorityData

@Stability(value=Stable)
 @NotNull
public String getAttrCertificateAuthorityData()

getAttrClusterSecurityGroupId

@Stability(value=Stable)
 @NotNull
public String getAttrClusterSecurityGroupId()

getAttrEncryptionConfigKeyArn

@Stability(value=Stable)
 @NotNull
public String getAttrEncryptionConfigKeyArn()

getAttrEndpoint

@Stability(value=Stable)
 @NotNull
public String getAttrEndpoint()

getAttrOpenIdConnectIssuerUrl

@Stability(value=Stable)
 @NotNull
public String getAttrOpenIdConnectIssuerUrl()

getCfnProperties

@Stability(value=Stable)
 @NotNull
protected Map<String,Object> getCfnProperties()

Overrides:

getCfnProperties in class CfnResource

getEncryptionConfig

@Stability(value=Stable)
 @Nullable
public Object getEncryptionConfig()

`AWS::EKS::Cluster.EncryptionConfig`.

setEncryptionConfig

@Stability(value=Stable)
public void setEncryptionConfig(@Nullable
                                                         IResolvable value)

`AWS::EKS::Cluster.EncryptionConfig`.

setEncryptionConfig

@Stability(value=Stable)
public void setEncryptionConfig(@Nullable
                                                         List<Object> value)

`AWS::EKS::Cluster.EncryptionConfig`.

getKubernetesNetworkConfig

@Stability(value=Stable)
 @Nullable
public Object getKubernetesNetworkConfig()

`AWS::EKS::Cluster.KubernetesNetworkConfig`.

setKubernetesNetworkConfig

@Stability(value=Stable)
public void setKubernetesNetworkConfig(@Nullable
                                                                CfnCluster.KubernetesNetworkConfigProperty value)

`AWS::EKS::Cluster.KubernetesNetworkConfig`.

setKubernetesNetworkConfig

@Stability(value=Stable)
public void setKubernetesNetworkConfig(@Nullable
                                                                IResolvable value)

`AWS::EKS::Cluster.KubernetesNetworkConfig`.

getLogging

@Stability(value=Stable)
 @Nullable
public Object getLogging()

`AWS::EKS::Cluster.Logging`.

setLogging

@Stability(value=Stable)
public void setLogging(@Nullable
                                                CfnCluster.LoggingProperty value)

`AWS::EKS::Cluster.Logging`.

setLogging

@Stability(value=Stable)
public void setLogging(@Nullable
                                                IResolvable value)

`AWS::EKS::Cluster.Logging`.

getName

@Stability(value=Stable)
 @Nullable
public String getName()

`AWS::EKS::Cluster.Name`.

setName

@Stability(value=Stable)
public void setName(@Nullable
                                             String value)

`AWS::EKS::Cluster.Name`.

getResourcesVpcConfig

@Stability(value=Stable)
 @NotNull
public Object getResourcesVpcConfig()

`AWS::EKS::Cluster.ResourcesVpcConfig`.

setResourcesVpcConfig

@Stability(value=Stable)
public void setResourcesVpcConfig(@NotNull
                                                           CfnCluster.ResourcesVpcConfigProperty value)

`AWS::EKS::Cluster.ResourcesVpcConfig`.

setResourcesVpcConfig

@Stability(value=Stable)
public void setResourcesVpcConfig(@NotNull
                                                           IResolvable value)

`AWS::EKS::Cluster.ResourcesVpcConfig`.

getRoleArn

@Stability(value=Stable)
 @NotNull
public String getRoleArn()

`AWS::EKS::Cluster.RoleArn`.

setRoleArn

@Stability(value=Stable)
public void setRoleArn(@NotNull
                                                String value)

`AWS::EKS::Cluster.RoleArn`.

getTags

@Stability(value=Stable)
 @NotNull
public TagManager getTags()

`AWS::EKS::Cluster.Tags`.

getVersion

@Stability(value=Stable)
 @Nullable
public String getVersion()

`AWS::EKS::Cluster.Version`.

setVersion

@Stability(value=Stable)
public void setVersion(@Nullable
                                                String value)

`AWS::EKS::Cluster.Version`.