@volcengine/pulumi
Version:
A Pulumi package for creating and managing volcengine cloud resources.
276 lines (275 loc) • 9.45 kB
TypeScript
import * as pulumi from "@pulumi/pulumi";
import * as inputs from "../types/input";
import * as outputs from "../types/output";
/**
* Use this data source to query detailed information of vke clusters
* ## Example Usage
*
* ```typescript
* import * as pulumi from "@pulumi/pulumi";
* import * as volcengine from "@pulumi/volcengine";
* import * as volcengine from "@volcengine/pulumi";
*
* const fooVpc = new volcengine.vpc.Vpc("fooVpc", {
* vpcName: "acc-test-project1",
* cidrBlock: "172.16.0.0/16",
* });
* const fooSubnet = new volcengine.vpc.Subnet("fooSubnet", {
* subnetName: "acc-subnet-test-2",
* cidrBlock: "172.16.0.0/24",
* zoneId: "cn-beijing-a",
* vpcId: fooVpc.id,
* });
* const fooSecurityGroup = new volcengine.vpc.SecurityGroup("fooSecurityGroup", {
* vpcId: fooVpc.id,
* securityGroupName: "acc-test-security-group2",
* });
* const fooCluster = new volcengine.vke.Cluster("fooCluster", {
* description: "created by terraform",
* deleteProtectionEnabled: false,
* clusterConfig: {
* subnetIds: [fooSubnet.id],
* apiServerPublicAccessEnabled: true,
* apiServerPublicAccessConfig: {
* publicAccessNetworkConfig: {
* billingType: "PostPaidByBandwidth",
* bandwidth: 1,
* },
* },
* resourcePublicAccessDefaultEnabled: true,
* },
* podsConfig: {
* podNetworkMode: "VpcCniShared",
* vpcCniConfig: {
* subnetIds: [fooSubnet.id],
* },
* },
* servicesConfig: {
* serviceCidrsv4s: ["172.30.0.0/18"],
* },
* tags: [{
* key: "tf-k1",
* value: "tf-v1",
* }],
* });
* const fooClusters = volcengine.vke.getClustersOutput({
* ids: [fooCluster.id],
* });
* ```
*/
/** @deprecated volcengine.vke.Clusters has been deprecated in favor of volcengine.vke.getClusters */
export declare function clusters(args?: ClustersArgs, opts?: pulumi.InvokeOptions): Promise<ClustersResult>;
/**
* A collection of arguments for invoking Clusters.
*/
export interface ClustersArgs {
/**
* ClientToken when the cluster is created successfully. ClientToken is a string that guarantees the idempotency of the request. This string is passed in by the caller.
*/
createClientToken?: string;
/**
* The delete protection of the cluster, the value is `true` or `false`.
*/
deleteProtectionEnabled?: boolean;
/**
* A list of Cluster IDs.
*/
ids?: string[];
/**
* The name of the cluster.
*/
name?: string;
/**
* A Name Regex of Cluster.
*/
nameRegex?: string;
/**
* File name where to save data source results.
*/
outputFile?: string;
/**
* The page number of clusters query.
*/
pageNumber?: number;
/**
* The page size of clusters query.
*/
pageSize?: number;
/**
* The container network model of the cluster, the value is `Flannel` or `VpcCniShared`. Flannel: Flannel network model, an independent Underlay container network solution, combined with the global routing capability of VPC, to achieve a high-performance network experience for the cluster. VpcCniShared: VPC-CNI network model, an Underlay container network solution based on the ENI of the private network elastic network card, with high network communication performance.
*/
podsConfigPodNetworkMode?: string;
/**
* The project name of the cluster.
*/
projectName?: string;
/**
* Array of cluster states to filter. (The elements of the array are logically ORed. A maximum of 15 state array elements can be filled at a time).
*/
statuses?: inputs.vke.ClustersStatus[];
/**
* Tags.
*/
tags?: inputs.vke.ClustersTag[];
/**
* The ClientToken when the last cluster update succeeded. ClientToken is a string that guarantees the idempotency of the request. This string is passed in by the caller.
*/
updateClientToken?: string;
}
/**
* A collection of values returned by Clusters.
*/
export interface ClustersResult {
/**
* The collection of VkeCluster query.
*/
readonly clusters: outputs.vke.ClustersCluster[];
readonly createClientToken?: string;
/**
* The delete protection of the cluster, the value is `true` or `false`.
*/
readonly deleteProtectionEnabled?: boolean;
/**
* The provider-assigned unique ID for this managed resource.
*/
readonly id: string;
readonly ids?: string[];
/**
* The name of the cluster.
*/
readonly name?: string;
readonly nameRegex?: string;
readonly outputFile?: string;
readonly pageNumber: number;
readonly pageSize: number;
readonly podsConfigPodNetworkMode?: string;
/**
* The project name of the cluster.
*/
readonly projectName?: string;
readonly statuses?: outputs.vke.ClustersStatus[];
/**
* Tags of the Cluster.
*/
readonly tags?: outputs.vke.ClustersTag[];
/**
* The total count of Cluster query.
*/
readonly totalCount: number;
readonly updateClientToken?: string;
}
/**
* Use this data source to query detailed information of vke clusters
* ## Example Usage
*
* ```typescript
* import * as pulumi from "@pulumi/pulumi";
* import * as volcengine from "@pulumi/volcengine";
* import * as volcengine from "@volcengine/pulumi";
*
* const fooVpc = new volcengine.vpc.Vpc("fooVpc", {
* vpcName: "acc-test-project1",
* cidrBlock: "172.16.0.0/16",
* });
* const fooSubnet = new volcengine.vpc.Subnet("fooSubnet", {
* subnetName: "acc-subnet-test-2",
* cidrBlock: "172.16.0.0/24",
* zoneId: "cn-beijing-a",
* vpcId: fooVpc.id,
* });
* const fooSecurityGroup = new volcengine.vpc.SecurityGroup("fooSecurityGroup", {
* vpcId: fooVpc.id,
* securityGroupName: "acc-test-security-group2",
* });
* const fooCluster = new volcengine.vke.Cluster("fooCluster", {
* description: "created by terraform",
* deleteProtectionEnabled: false,
* clusterConfig: {
* subnetIds: [fooSubnet.id],
* apiServerPublicAccessEnabled: true,
* apiServerPublicAccessConfig: {
* publicAccessNetworkConfig: {
* billingType: "PostPaidByBandwidth",
* bandwidth: 1,
* },
* },
* resourcePublicAccessDefaultEnabled: true,
* },
* podsConfig: {
* podNetworkMode: "VpcCniShared",
* vpcCniConfig: {
* subnetIds: [fooSubnet.id],
* },
* },
* servicesConfig: {
* serviceCidrsv4s: ["172.30.0.0/18"],
* },
* tags: [{
* key: "tf-k1",
* value: "tf-v1",
* }],
* });
* const fooClusters = volcengine.vke.getClustersOutput({
* ids: [fooCluster.id],
* });
* ```
*/
/** @deprecated volcengine.vke.Clusters has been deprecated in favor of volcengine.vke.getClusters */
export declare function clustersOutput(args?: ClustersOutputArgs, opts?: pulumi.InvokeOptions): pulumi.Output<ClustersResult>;
/**
* A collection of arguments for invoking Clusters.
*/
export interface ClustersOutputArgs {
/**
* ClientToken when the cluster is created successfully. ClientToken is a string that guarantees the idempotency of the request. This string is passed in by the caller.
*/
createClientToken?: pulumi.Input<string>;
/**
* The delete protection of the cluster, the value is `true` or `false`.
*/
deleteProtectionEnabled?: pulumi.Input<boolean>;
/**
* A list of Cluster IDs.
*/
ids?: pulumi.Input<pulumi.Input<string>[]>;
/**
* The name of the cluster.
*/
name?: pulumi.Input<string>;
/**
* A Name Regex of Cluster.
*/
nameRegex?: pulumi.Input<string>;
/**
* File name where to save data source results.
*/
outputFile?: pulumi.Input<string>;
/**
* The page number of clusters query.
*/
pageNumber?: pulumi.Input<number>;
/**
* The page size of clusters query.
*/
pageSize?: pulumi.Input<number>;
/**
* The container network model of the cluster, the value is `Flannel` or `VpcCniShared`. Flannel: Flannel network model, an independent Underlay container network solution, combined with the global routing capability of VPC, to achieve a high-performance network experience for the cluster. VpcCniShared: VPC-CNI network model, an Underlay container network solution based on the ENI of the private network elastic network card, with high network communication performance.
*/
podsConfigPodNetworkMode?: pulumi.Input<string>;
/**
* The project name of the cluster.
*/
projectName?: pulumi.Input<string>;
/**
* Array of cluster states to filter. (The elements of the array are logically ORed. A maximum of 15 state array elements can be filled at a time).
*/
statuses?: pulumi.Input<pulumi.Input<inputs.vke.ClustersStatusArgs>[]>;
/**
* Tags.
*/
tags?: pulumi.Input<pulumi.Input<inputs.vke.ClustersTagArgs>[]>;
/**
* The ClientToken when the last cluster update succeeded. ClientToken is a string that guarantees the idempotency of the request. This string is passed in by the caller.
*/
updateClientToken?: pulumi.Input<string>;
}