Skip to content

ClusterUserKubeconfig

This class encapsulates and extends the ROS resource type DATASOURCE::CS::ClusterUserKubeconfig, which is used to query the kubeconfig configurations of a Container Service for Kubernetes (ACK) cluster by cluster ID.

Initializers 

import com.aliyun.ros.cdk.cs.datasource.ClusterUserKubeconfig;
ClusterUserKubeconfig.Builder.create(Construct scope, java.lang.String id, java.lang.Boolean enableResourcePropertyConstraint)
    .clusterId(java.lang.String)
    .clusterId(IResolvable)
//  .privateIpAddress(java.lang.Boolean)
//  .privateIpAddress(IResolvable)
//  .refreshOptions(java.lang.String)
//  .refreshOptions(IResolvable)
//  .temporaryDurationMinutes(java.lang.Number)
//  .temporaryDurationMinutes(IResolvable)
    .build();
Name Type Description
scope com.aliyun.ros.cdk.core.Construct No description.
id java.lang.String No description.
enableResourcePropertyConstraint java.lang.Boolean No description.
clusterId java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Property clusterId: The ID of the ACK cluster.
privateIpAddress java.lang.Boolean OR com.aliyun.ros.cdk.core.IResolvable Property privateIpAddress: Specifies whether to obtain the credential that is used to connect to the cluster over the internal network.
refreshOptions java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Property refreshOptions: The refresh strategy for the datasource resource when the stack is updated.
temporaryDurationMinutes java.lang.Number OR com.aliyun.ros.cdk.core.IResolvable Property temporaryDurationMinutes: The validity period of a temporary kubeconfig file.

scopeRequired

  • Type: com.aliyun.ros.cdk.core.Construct

idRequired

  • Type: java.lang.String

enableResourcePropertyConstraintOptional

  • Type: java.lang.Boolean

clusterIdRequired

  • Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

Property clusterId: The ID of the ACK cluster.

privateIpAddressOptional

  • Type: java.lang.Boolean OR com.aliyun.ros.cdk.core.IResolvable

Property privateIpAddress: Specifies whether to obtain the credential that is used to connect to the cluster over the internal network.

Valid values: true: obtains the credential that is used to connect to the cluster over the internal network. false: obtains the credential that is used to connect to the cluster over the Internet. Default value: false.

refreshOptionsOptional

  • Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

Property refreshOptions: The refresh strategy for the datasource resource when the stack is updated.

Valid values:

  • Never: Never refresh the datasource resource when the stack is updated.
  • Always: Always refresh the datasource resource when the stack is updated. Default is Never.

temporaryDurationMinutesOptional

  • Type: java.lang.Number OR com.aliyun.ros.cdk.core.IResolvable

Property temporaryDurationMinutes: The validity period of a temporary kubeconfig file.

Unit: minutes. Valid values: 15 to 4320. Note If you do not specify this parameter, the system automatically specifies a validity period, which is indicated by the expiration field in the response.

Methods

Name Description
toString Returns a string representation of this construct.
synthesize Allows this construct to emit artifacts into the cloud assembly during synthesis.
addCondition No description.
addCount No description.
addDependency No description.
addResourceDesc No description.
applyRemovalPolicy No description.
getAtt No description.
setMetadata No description.

toString 

public java.lang.String toString()

Returns a string representation of this construct.

synthesize 

public void synthesize(ISynthesisSession session)

Allows this construct to emit artifacts into the cloud assembly during synthesis.

This method is usually implemented by framework-level constructs such as Stack and Asset as they participate in synthesizing the cloud assembly.

sessionRequired

  • Type: com.aliyun.ros.cdk.core.ISynthesisSession

The synthesis session.

addCondition 

public void addCondition(RosCondition condition)

conditionRequired

  • Type: com.aliyun.ros.cdk.core.RosCondition

addCount 

public void addCount(java.lang.Number OR IResolvable count)

countRequired

  • Type: java.lang.Number OR com.aliyun.ros.cdk.core.IResolvable

addDependency 

public void addDependency(Resource resource)

resourceRequired

  • Type: com.aliyun.ros.cdk.core.Resource

addResourceDesc 

public void addResourceDesc(java.lang.String desc)

descRequired

  • Type: java.lang.String

applyRemovalPolicy 

public void applyRemovalPolicy(RemovalPolicy policy)

policyRequired

  • Type: com.aliyun.ros.cdk.core.RemovalPolicy

getAtt 

public IResolvable getAtt(java.lang.String name)

nameRequired

  • Type: java.lang.String

setMetadata 

public void setMetadata(java.lang.String key, java.lang.Object value)

keyRequired

  • Type: java.lang.String

valueRequired

  • Type: java.lang.Object

Static Functions

Name Description
isConstruct Return whether the given object is a Construct.

isConstruct 

import com.aliyun.ros.cdk.cs.datasource.ClusterUserKubeconfig;
ClusterUserKubeconfig.isConstruct(java.lang.Object x)

Return whether the given object is a Construct.

xRequired

  • Type: java.lang.Object

Properties

Name Type Description
node com.aliyun.ros.cdk.core.ConstructNode The construct tree node associated with this construct.
ref java.lang.String No description.
stack com.aliyun.ros.cdk.core.Stack The stack in which this resource is defined.
resource com.aliyun.ros.cdk.core.RosResource No description.
attrClusterId com.aliyun.ros.cdk.core.IResolvable Attribute ClusterId: The ID of the ACK cluster.
attrConfig com.aliyun.ros.cdk.core.IResolvable Attribute Config: The content of the kubeconfig file.
attrExpiration com.aliyun.ros.cdk.core.IResolvable Attribute Expiration: The expiration time of the kubeconfig file.

nodeRequired 

public ConstructNode getNode();
  • Type: com.aliyun.ros.cdk.core.ConstructNode

The construct tree node associated with this construct.

refRequired 

public java.lang.String getRef();
  • Type: java.lang.String

stackRequired 

public Stack getStack();
  • Type: com.aliyun.ros.cdk.core.Stack

The stack in which this resource is defined.

resourceOptional 

public RosResource getResource();
  • Type: com.aliyun.ros.cdk.core.RosResource

attrClusterIdRequired 

public IResolvable getAttrClusterId();
  • Type: com.aliyun.ros.cdk.core.IResolvable

Attribute ClusterId: The ID of the ACK cluster.

attrConfigRequired 

public IResolvable getAttrConfig();
  • Type: com.aliyun.ros.cdk.core.IResolvable

Attribute Config: The content of the kubeconfig file.

attrExpirationRequired 

public IResolvable getAttrExpiration();
  • Type: com.aliyun.ros.cdk.core.IResolvable

Attribute Expiration: The expiration time of the kubeconfig file.

The value is the UTC time displayed in RFC3339 format.