@pulumi/gcp
Version:
A Pulumi package for creating and managing Google Cloud Platform resources.
380 lines (379 loc) • 15.2 kB
TypeScript
import * as pulumi from "@pulumi/pulumi";
import * as inputs from "../types/input";
import * as outputs from "../types/output";
/**
* ## Example Usage
*
* ### Redis Cluster User Created Connections
*
* ```typescript
* import * as pulumi from "@pulumi/pulumi";
* import * as gcp from "@pulumi/gcp";
*
* const network1 = new gcp.compute.Network("network1", {
* name: "net1",
* autoCreateSubnetworks: false,
* });
* const subnetNetwork1 = new gcp.compute.Subnetwork("subnet_network1", {
* name: "subnet-net1",
* ipCidrRange: "10.0.0.248/29",
* region: "us-central1",
* network: network1.id,
* });
* const ip1Network1 = new gcp.compute.Address("ip1_network1", {
* name: "ip1-net1",
* region: "us-central1",
* subnetwork: subnetNetwork1.id,
* addressType: "INTERNAL",
* purpose: "GCE_ENDPOINT",
* });
* // redis cluster without endpoint
* const cluster_user_connCluster = new gcp.redis.Cluster("cluster-user-conn", {
* name: "cluster-user-conn",
* shardCount: 3,
* region: "us-central1",
* replicaCount: 0,
* deletionProtectionEnabled: false,
* });
* const forwardingRule1Network1 = new gcp.compute.ForwardingRule("forwarding_rule1_network1", {
* name: "fwd1-net1",
* region: "us-central1",
* ipAddress: ip1Network1.id,
* loadBalancingScheme: "",
* network: network1.id,
* target: cluster_user_connCluster.pscServiceAttachments.apply(pscServiceAttachments => pscServiceAttachments[0].serviceAttachment),
* });
* const ip2Network1 = new gcp.compute.Address("ip2_network1", {
* name: "ip2-net1",
* region: "us-central1",
* subnetwork: subnetNetwork1.id,
* addressType: "INTERNAL",
* purpose: "GCE_ENDPOINT",
* });
* const forwardingRule2Network1 = new gcp.compute.ForwardingRule("forwarding_rule2_network1", {
* name: "fwd2-net1",
* region: "us-central1",
* ipAddress: ip2Network1.id,
* loadBalancingScheme: "",
* network: network1.id,
* target: cluster_user_connCluster.pscServiceAttachments.apply(pscServiceAttachments => pscServiceAttachments[1].serviceAttachment),
* });
* const network2 = new gcp.compute.Network("network2", {
* name: "network2",
* autoCreateSubnetworks: false,
* });
* const subnetNetwork2 = new gcp.compute.Subnetwork("subnet_network2", {
* name: "subnet-net2",
* ipCidrRange: "10.0.0.248/29",
* region: "us-central1",
* network: network2.id,
* });
* const ip1Network2 = new gcp.compute.Address("ip1_network2", {
* name: "ip1-net2",
* region: "us-central1",
* subnetwork: subnetNetwork2.id,
* addressType: "INTERNAL",
* purpose: "GCE_ENDPOINT",
* });
* const forwardingRule1Network2 = new gcp.compute.ForwardingRule("forwarding_rule1_network2", {
* name: "fwd1-net2",
* region: "us-central1",
* ipAddress: ip1Network2.id,
* loadBalancingScheme: "",
* network: network2.id,
* target: cluster_user_connCluster.pscServiceAttachments.apply(pscServiceAttachments => pscServiceAttachments[0].serviceAttachment),
* });
* const ip2Network2 = new gcp.compute.Address("ip2_network2", {
* name: "ip2-net2",
* region: "us-central1",
* subnetwork: subnetNetwork2.id,
* addressType: "INTERNAL",
* purpose: "GCE_ENDPOINT",
* });
* const forwardingRule2Network2 = new gcp.compute.ForwardingRule("forwarding_rule2_network2", {
* name: "fwd2-net2",
* region: "us-central1",
* ipAddress: ip2Network2.id,
* loadBalancingScheme: "",
* network: network2.id,
* target: cluster_user_connCluster.pscServiceAttachments.apply(pscServiceAttachments => pscServiceAttachments[1].serviceAttachment),
* });
* const project = gcp.organizations.getProject({});
* const cluster_user_conn = new gcp.redis.ClusterUserCreatedConnections("cluster-user-conn", {
* name: "cluster-user-conn",
* region: "us-central1",
* clusterEndpoints: [
* {
* connections: [
* {
* pscConnection: {
* pscConnectionId: forwardingRule1Network1.pscConnectionId,
* address: ip1Network1.address,
* forwardingRule: forwardingRule1Network1.id,
* network: network1.id,
* projectId: project.then(project => project.projectId),
* serviceAttachment: cluster_user_connCluster.pscServiceAttachments.apply(pscServiceAttachments => pscServiceAttachments[0].serviceAttachment),
* },
* },
* {
* pscConnection: {
* pscConnectionId: forwardingRule2Network1.pscConnectionId,
* address: ip2Network1.address,
* forwardingRule: forwardingRule2Network1.id,
* network: network1.id,
* serviceAttachment: cluster_user_connCluster.pscServiceAttachments.apply(pscServiceAttachments => pscServiceAttachments[1].serviceAttachment),
* },
* },
* ],
* },
* {
* connections: [
* {
* pscConnection: {
* pscConnectionId: forwardingRule1Network2.pscConnectionId,
* address: ip1Network2.address,
* forwardingRule: forwardingRule1Network2.id,
* network: network2.id,
* serviceAttachment: cluster_user_connCluster.pscServiceAttachments.apply(pscServiceAttachments => pscServiceAttachments[0].serviceAttachment),
* },
* },
* {
* pscConnection: {
* pscConnectionId: forwardingRule2Network2.pscConnectionId,
* address: ip2Network2.address,
* forwardingRule: forwardingRule2Network2.id,
* network: network2.id,
* serviceAttachment: cluster_user_connCluster.pscServiceAttachments.apply(pscServiceAttachments => pscServiceAttachments[1].serviceAttachment),
* },
* },
* ],
* },
* ],
* });
* ```
* ### Redis Cluster User And Auto Created Connections
*
* ```typescript
* import * as pulumi from "@pulumi/pulumi";
* import * as gcp from "@pulumi/gcp";
*
* const network2 = new gcp.compute.Network("network2", {
* name: "network2",
* autoCreateSubnetworks: false,
* });
* const subnetNetwork2 = new gcp.compute.Subnetwork("subnet_network2", {
* name: "subnet-net2",
* ipCidrRange: "10.0.0.248/29",
* region: "us-central1",
* network: network2.id,
* });
* const ip1Network2 = new gcp.compute.Address("ip1_network2", {
* name: "ip1-net2",
* region: "us-central1",
* subnetwork: subnetNetwork2.id,
* addressType: "INTERNAL",
* purpose: "GCE_ENDPOINT",
* });
* const network1 = new gcp.compute.Network("network1", {
* name: "net1",
* autoCreateSubnetworks: false,
* });
* const subnetNetwork1 = new gcp.compute.Subnetwork("subnet_network1", {
* name: "subnet-net1",
* ipCidrRange: "10.0.0.248/29",
* region: "us-central1",
* network: network1.id,
* });
* const _default = new gcp.networkconnectivity.ServiceConnectionPolicy("default", {
* name: "scpolicy",
* location: "us-central1",
* serviceClass: "gcp-memorystore-redis",
* description: "my basic service connection policy",
* network: network1.id,
* pscConfig: {
* subnetworks: [subnetNetwork1.id],
* },
* });
* // redis cluster without endpoint
* const cluster_user_auto_connCluster = new gcp.redis.Cluster("cluster-user-auto-conn", {
* name: "cluster-user-auto-conn",
* shardCount: 3,
* region: "us-central1",
* replicaCount: 0,
* deletionProtectionEnabled: false,
* pscConfigs: [{
* network: network1.id,
* }],
* }, {
* dependsOn: [_default],
* });
* const forwardingRule1Network2 = new gcp.compute.ForwardingRule("forwarding_rule1_network2", {
* name: "fwd1-net2",
* region: "us-central1",
* ipAddress: ip1Network2.id,
* loadBalancingScheme: "",
* network: network2.id,
* target: cluster_user_auto_connCluster.pscServiceAttachments.apply(pscServiceAttachments => pscServiceAttachments[0].serviceAttachment),
* });
* const ip2Network2 = new gcp.compute.Address("ip2_network2", {
* name: "ip2-net2",
* region: "us-central1",
* subnetwork: subnetNetwork2.id,
* addressType: "INTERNAL",
* purpose: "GCE_ENDPOINT",
* });
* const forwardingRule2Network2 = new gcp.compute.ForwardingRule("forwarding_rule2_network2", {
* name: "fwd2-net2",
* region: "us-central1",
* ipAddress: ip2Network2.id,
* loadBalancingScheme: "",
* network: network2.id,
* target: cluster_user_auto_connCluster.pscServiceAttachments.apply(pscServiceAttachments => pscServiceAttachments[1].serviceAttachment),
* });
* const cluster_user_auto_conn = new gcp.redis.ClusterUserCreatedConnections("cluster-user-auto-conn", {
* name: "cluster-user-auto-conn",
* region: "us-central1",
* clusterEndpoints: [{
* connections: [
* {
* pscConnection: {
* pscConnectionId: forwardingRule1Network2.pscConnectionId,
* address: ip1Network2.address,
* forwardingRule: forwardingRule1Network2.id,
* network: network2.id,
* serviceAttachment: cluster_user_auto_connCluster.pscServiceAttachments.apply(pscServiceAttachments => pscServiceAttachments[0].serviceAttachment),
* },
* },
* {
* pscConnection: {
* pscConnectionId: forwardingRule2Network2.pscConnectionId,
* address: ip2Network2.address,
* forwardingRule: forwardingRule2Network2.id,
* network: network2.id,
* serviceAttachment: cluster_user_auto_connCluster.pscServiceAttachments.apply(pscServiceAttachments => pscServiceAttachments[1].serviceAttachment),
* },
* },
* ],
* }],
* });
* ```
*
* ## Import
*
* ClusterUserCreatedConnections can be imported using any of these accepted formats:
*
* * `projects/{{project}}/locations/{{region}}/clusters/{{name}}`
*
* * `{{project}}/{{region}}/{{name}}`
*
* * `{{region}}/{{name}}`
*
* * `{{name}}`
*
* When using the `pulumi import` command, ClusterUserCreatedConnections can be imported using one of the formats above. For example:
*
* ```sh
* $ pulumi import gcp:redis/clusterUserCreatedConnections:ClusterUserCreatedConnections default projects/{{project}}/locations/{{region}}/clusters/{{name}}
* ```
*
* ```sh
* $ pulumi import gcp:redis/clusterUserCreatedConnections:ClusterUserCreatedConnections default {{project}}/{{region}}/{{name}}
* ```
*
* ```sh
* $ pulumi import gcp:redis/clusterUserCreatedConnections:ClusterUserCreatedConnections default {{region}}/{{name}}
* ```
*
* ```sh
* $ pulumi import gcp:redis/clusterUserCreatedConnections:ClusterUserCreatedConnections default {{name}}
* ```
*/
export declare class ClusterUserCreatedConnections extends pulumi.CustomResource {
/**
* Get an existing ClusterUserCreatedConnections resource's state with the given name, ID, and optional extra
* properties used to qualify the lookup.
*
* @param name The _unique_ name of the resulting resource.
* @param id The _unique_ provider ID of the resource to lookup.
* @param state Any extra arguments used during the lookup.
* @param opts Optional settings to control the behavior of the CustomResource.
*/
static get(name: string, id: pulumi.Input<pulumi.ID>, state?: ClusterUserCreatedConnectionsState, opts?: pulumi.CustomResourceOptions): ClusterUserCreatedConnections;
/**
* Returns true if the given object is an instance of ClusterUserCreatedConnections. This is designed to work even
* when multiple copies of the Pulumi SDK have been loaded into the same process.
*/
static isInstance(obj: any): obj is ClusterUserCreatedConnections;
/**
* A list of cluster endpoints
* Structure is documented below.
*/
readonly clusterEndpoints: pulumi.Output<outputs.redis.ClusterUserCreatedConnectionsClusterEndpoint[] | undefined>;
/**
* The name of the Redis cluster these endpoints should be added to.
*/
readonly name: pulumi.Output<string>;
/**
* The ID of the project in which the resource belongs.
* If it is not provided, the provider project is used.
*/
readonly project: pulumi.Output<string>;
/**
* The name of the region of the Redis cluster these endpoints should be added to.
*/
readonly region: pulumi.Output<string>;
/**
* Create a ClusterUserCreatedConnections resource with the given unique name, arguments, and options.
*
* @param name The _unique_ name of the resource.
* @param args The arguments to use to populate this resource's properties.
* @param opts A bag of options that control this resource's behavior.
*/
constructor(name: string, args: ClusterUserCreatedConnectionsArgs, opts?: pulumi.CustomResourceOptions);
}
/**
* Input properties used for looking up and filtering ClusterUserCreatedConnections resources.
*/
export interface ClusterUserCreatedConnectionsState {
/**
* A list of cluster endpoints
* Structure is documented below.
*/
clusterEndpoints?: pulumi.Input<pulumi.Input<inputs.redis.ClusterUserCreatedConnectionsClusterEndpoint>[]>;
/**
* The name of the Redis cluster these endpoints should be added to.
*/
name?: pulumi.Input<string>;
/**
* The ID of the project in which the resource belongs.
* If it is not provided, the provider project is used.
*/
project?: pulumi.Input<string>;
/**
* The name of the region of the Redis cluster these endpoints should be added to.
*/
region?: pulumi.Input<string>;
}
/**
* The set of arguments for constructing a ClusterUserCreatedConnections resource.
*/
export interface ClusterUserCreatedConnectionsArgs {
/**
* A list of cluster endpoints
* Structure is documented below.
*/
clusterEndpoints?: pulumi.Input<pulumi.Input<inputs.redis.ClusterUserCreatedConnectionsClusterEndpoint>[]>;
/**
* The name of the Redis cluster these endpoints should be added to.
*/
name?: pulumi.Input<string>;
/**
* The ID of the project in which the resource belongs.
* If it is not provided, the provider project is used.
*/
project?: pulumi.Input<string>;
/**
* The name of the region of the Redis cluster these endpoints should be added to.
*/
region: pulumi.Input<string>;
}