Skip to content

KubernetesClusters

This class encapsulates and extends the ROS resource type DATASOURCE::CS::KubernetesClusters, which is used to query Container Service for Kubernetes (ACK) clusters.

Initializers 

from ros_cdk_cs import datasource
datasource.KubernetesClusters(
  scope: Construct,
  id: str,
  cluster_spec: typing.Union[str, IResolvable] = None,
  cluster_type: typing.Union[str, IResolvable] = None,
  name: typing.Union[str, IResolvable] = None,
  profile: typing.Union[str, IResolvable] = None,
  refresh_options: typing.Union[str, IResolvable] = None,
  enable_resource_property_constraint: bool = None
)
Name Type Description
scope ros_cdk_core.Construct No description.
id str No description.
cluster_spec typing.Union[str, ros_cdk_core.IResolvable] Property clusterSpec: The specification of the cluster.
cluster_type typing.Union[str, ros_cdk_core.IResolvable] Property clusterType: The type of the cluster.
name typing.Union[str, ros_cdk_core.IResolvable] Property name: The name of the cluster.The name must be 1 to 63 characters in length, and can contain digits, letters, and hyphens (-). It cannot start with a hyphen (-).
profile typing.Union[str, ros_cdk_core.IResolvable] Property profile: The identifier of the cluster.
refresh_options typing.Union[str, ros_cdk_core.IResolvable] Property refreshOptions: The refresh strategy for the datasource resource when the stack is updated.
enable_resource_property_constraint bool No description.

scopeRequired

  • Type: ros_cdk_core.Construct

idRequired

  • Type: str

cluster_specOptional

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

Property clusterSpec: The specification of the cluster.

If you set the cluster type to ManagedKubernetes, you can use cluster specifications to distinguish clusters. Valid values: ack.pro.small: professional managed Kubernetes cluster ack.standard: standard managed Kubernetes cluster By default, this parameter is empty. This indicates that the parameter is not used to filter clusters.

cluster_typeOptional

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

Property clusterType: The type of the cluster.

Valid values: Kubernetes: dedicated Kubernetes cluster ManagedKubernetes: managed Kubernetes cluster, serverless Kubernetes (ASK) cluster, or edge Kubernetes cluster Ask: ASK cluster ExternalKubernetes: registered external cluster When you query an ASK cluster, the value specified when the cluster was created is returned.

nameOptional

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

Property name: The name of the cluster.The name must be 1 to 63 characters in length, and can contain digits, letters, and hyphens (-). It cannot start with a hyphen (-).

profileOptional

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

Property profile: The identifier of the cluster.

If you set the cluster type to ManagedKubernetes, you can use cluster identifiers to distinguish clusters. Valid values: Default: managed Kubernetes cluster Serverless: ASK cluster Edge: edge Kubernetes cluster By default, this parameter is empty. This indicates that the parameter is not used to filter clusters.

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.

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.KubernetesClusters.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_ids ros_cdk_core.IResolvable Attribute ClusterIds: The list of cluster IDs.
attr_clusters ros_cdk_core.IResolvable Attribute Clusters: The list of clusters.

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_idsRequired 

attr_cluster_ids: IResolvable
  • Type: ros_cdk_core.IResolvable

Attribute ClusterIds: The list of cluster IDs.

attr_clustersRequired 

attr_clusters: IResolvable
  • Type: ros_cdk_core.IResolvable

Attribute Clusters: The list of clusters.