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

from ros_cdk_cs import datasource
datasource.ClusterUserKubeconfig(
  scope: Construct,
  id: str,
  cluster_id: typing.Union[str, IResolvable],
  private_ip_address: typing.Union[bool, IResolvable] = None,
  refresh_options: typing.Union[str, IResolvable] = None,
  temporary_duration_minutes: typing.Union[typing.Union[int, float], IResolvable] = None,
  enable_resource_property_constraint: bool = None
)
Name Type Description
scope ros_cdk_core.Construct No description.
id str No description.
cluster_id typing.Union[str, ros_cdk_core.IResolvable] Property clusterId: The ID of the ACK cluster.
private_ip_address typing.Union[bool, ros_cdk_core.IResolvable] Property privateIpAddress: Specifies whether to obtain the credential that is used to connect to the cluster over the internal network.
refresh_options typing.Union[str, ros_cdk_core.IResolvable] Property refreshOptions: The refresh strategy for the datasource resource when the stack is updated.
temporary_duration_minutes typing.Union[typing.Union[int, float], ros_cdk_core.IResolvable] Property temporaryDurationMinutes: The validity period of a temporary kubeconfig file.
enable_resource_property_constraint bool No description.

scopeRequired

  • Type: ros_cdk_core.Construct

idRequired

  • Type: str

cluster_idRequired

  • Type: typing.Union[str, ros_cdk_core.IResolvable]

Property clusterId: The ID of the ACK cluster.


private_ip_addressOptional

  • Type: typing.Union[bool, 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.


refresh_optionsOptional

  • Type: typing.Union[str, 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.

temporary_duration_minutesOptional

  • Type: typing.Union[typing.Union[int, float], 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.


enable_resource_property_constraintOptional

  • Type: bool

Methods

Name Description
to_string Returns a string representation of this construct.
synthesize Allows this construct to emit artifacts into the cloud assembly during synthesis.
add_condition No description.
add_count No description.
add_dependency No description.
add_resource_desc No description.
apply_removal_policy No description.
get_att No description.
set_metadata No description.

to_string

def to_string() -> str

Returns a string representation of this construct.

synthesize

def synthesize(
  session: ISynthesisSession
) -> None

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: ros_cdk_core.ISynthesisSession

The synthesis session.


add_condition

def add_condition(
  condition: RosCondition
) -> None

conditionRequired

  • Type: ros_cdk_core.RosCondition

add_count

def add_count(
  count: typing.Union[typing.Union[int, float], IResolvable]
) -> None

countRequired

  • Type: typing.Union[typing.Union[int, float], ros_cdk_core.IResolvable]

add_dependency

def add_dependency(
  resource: Resource
) -> None

resourceRequired

  • Type: ros_cdk_core.Resource

add_resource_desc

def add_resource_desc(
  desc: str
) -> None

descRequired

  • Type: str

apply_removal_policy

def apply_removal_policy(
  policy: RemovalPolicy
) -> None

policyRequired

  • Type: ros_cdk_core.RemovalPolicy

get_att

def get_att(
  name: str
) -> IResolvable

nameRequired

  • Type: str

set_metadata

def set_metadata(
  key: str,
  value: typing.Any
) -> None

keyRequired

  • Type: str

valueRequired

  • Type: typing.Any

Static Functions

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

is_construct

from ros_cdk_cs import datasource
datasource.ClusterUserKubeconfig.is_construct(
  x: typing.Any
)

Return whether the given object is a Construct.

xRequired

  • Type: typing.Any

Properties

Name Type Description
node ros_cdk_core.ConstructNode The construct tree node associated with this construct.
ref str No description.
stack ros_cdk_core.Stack The stack in which this resource is defined.
resource ros_cdk_core.RosResource No description.
attr_cluster_id ros_cdk_core.IResolvable Attribute ClusterId: The ID of the ACK cluster.
attr_config ros_cdk_core.IResolvable Attribute Config: The content of the kubeconfig file.
attr_expiration ros_cdk_core.IResolvable Attribute Expiration: The expiration time of the kubeconfig file.

nodeRequired

node: ConstructNode
  • Type: ros_cdk_core.ConstructNode

The construct tree node associated with this construct.


refRequired

ref: str
  • Type: str

stackRequired

stack: Stack
  • Type: ros_cdk_core.Stack

The stack in which this resource is defined.


resourceOptional

resource: RosResource
  • Type: ros_cdk_core.RosResource

attr_cluster_idRequired

attr_cluster_id: IResolvable
  • Type: ros_cdk_core.IResolvable

Attribute ClusterId: The ID of the ACK cluster.


attr_configRequired

attr_config: IResolvable
  • Type: ros_cdk_core.IResolvable

Attribute Config: The content of the kubeconfig file.


attr_expirationRequired

attr_expiration: IResolvable
  • Type: ros_cdk_core.IResolvable

Attribute Expiration: The expiration time of the kubeconfig file.

The value is the UTC time displayed in RFC3339 format.