rediscloud.SubscriptionPeering
Explore with Pulumi AI
Creates an AWS or GCP VPC peering for an existing Redis Enterprise Cloud Subscription, allowing access to your subscription databases as if they were on the same network.
For AWS, peering should be accepted by the other side. For GCP, the opposite peering request should be submitted.
Example Usage
AWS
GCP
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Gcp = Pulumi.Gcp;
using Rediscloud = RedisLabs.Rediscloud;
return await Deployment.RunAsync(() =>
{
var example = new Rediscloud.Subscription("example");
// ...
var network = Gcp.Compute.GetNetwork.Invoke(new()
{
Project = "my-gcp-project",
Name = "my-gcp-vpc",
});
var example_peeringSubscriptionPeering = new Rediscloud.SubscriptionPeering("example-peeringSubscriptionPeering", new()
{
SubscriptionId = example.Id,
ProviderName = "GCP",
GcpProjectId = network.Apply(getNetworkResult => getNetworkResult.Project),
GcpNetworkName = network.Apply(getNetworkResult => getNetworkResult.Name),
});
var example_peeringNetworkPeering = new Gcp.Compute.NetworkPeering("example-peeringNetworkPeering", new()
{
Network = network.Apply(getNetworkResult => getNetworkResult.SelfLink),
PeerNetwork = $"https://www.googleapis.com/compute/v1/projects/{rediscloud_subscription_peering.Example.Gcp_redis_project_id}/global/networks/{rediscloud_subscription_peering.Example.Gcp_redis_network_name}",
});
});
package main
import (
"fmt"
"github.com/RedisLabs/pulumi-rediscloud/sdk/go/rediscloud"
"github.com/pulumi/pulumi-gcp/sdk/v6/go/gcp/compute"
"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)
func main() {
pulumi.Run(func(ctx *pulumi.Context) error {
example, err := rediscloud.NewSubscription(ctx, "example", nil)
if err != nil {
return err
}
network, err := compute.LookupNetwork(ctx, &compute.LookupNetworkArgs{
Project: pulumi.StringRef("my-gcp-project"),
Name: "my-gcp-vpc",
}, nil)
if err != nil {
return err
}
_, err = rediscloud.NewSubscriptionPeering(ctx, "example-peeringSubscriptionPeering", &rediscloud.SubscriptionPeeringArgs{
SubscriptionId: example.ID(),
ProviderName: pulumi.String("GCP"),
GcpProjectId: *pulumi.String(network.Project),
GcpNetworkName: *pulumi.String(network.Name),
})
if err != nil {
return err
}
_, err = compute.NewNetworkPeering(ctx, "example-peeringNetworkPeering", &compute.NetworkPeeringArgs{
Network: *pulumi.String(network.SelfLink),
PeerNetwork: pulumi.String(fmt.Sprintf("https://www.googleapis.com/compute/v1/projects/%v/global/networks/%v", rediscloud_subscription_peering.Example.Gcp_redis_project_id, rediscloud_subscription_peering.Example.Gcp_redis_network_name)),
})
if err != nil {
return err
}
return nil
})
}
package generated_program;
import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.rediscloud.Subscription;
import com.pulumi.gcp.compute.ComputeFunctions;
import com.pulumi.gcp.compute.inputs.GetNetworkArgs;
import com.pulumi.rediscloud.SubscriptionPeering;
import com.pulumi.rediscloud.SubscriptionPeeringArgs;
import com.pulumi.gcp.compute.NetworkPeering;
import com.pulumi.gcp.compute.NetworkPeeringArgs;
import java.util.List;
import java.util.ArrayList;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;
public class App {
public static void main(String[] args) {
Pulumi.run(App::stack);
}
public static void stack(Context ctx) {
var example = new Subscription("example");
final var network = ComputeFunctions.getNetwork(GetNetworkArgs.builder()
.project("my-gcp-project")
.name("my-gcp-vpc")
.build());
var example_peeringSubscriptionPeering = new SubscriptionPeering("example-peeringSubscriptionPeering", SubscriptionPeeringArgs.builder()
.subscriptionId(example.id())
.providerName("GCP")
.gcpProjectId(network.applyValue(getNetworkResult -> getNetworkResult.project()))
.gcpNetworkName(network.applyValue(getNetworkResult -> getNetworkResult.name()))
.build());
var example_peeringNetworkPeering = new NetworkPeering("example-peeringNetworkPeering", NetworkPeeringArgs.builder()
.network(network.applyValue(getNetworkResult -> getNetworkResult.selfLink()))
.peerNetwork(String.format("https://www.googleapis.com/compute/v1/projects/%s/global/networks/%s", rediscloud_subscription_peering.example().gcp_redis_project_id(),rediscloud_subscription_peering.example().gcp_redis_network_name()))
.build());
}
}
import * as pulumi from "@pulumi/pulumi";
import * as gcp from "@pulumi/gcp";
import * as rediscloud from "@rediscloud/pulumi-rediscloud";
const example = new rediscloud.Subscription("example", {});
// ...
const network = gcp.compute.getNetwork({
project: "my-gcp-project",
name: "my-gcp-vpc",
});
const example_peeringSubscriptionPeering = new rediscloud.SubscriptionPeering("example-peeringSubscriptionPeering", {
subscriptionId: example.id,
providerName: "GCP",
gcpProjectId: network.then(network => network.project),
gcpNetworkName: network.then(network => network.name),
});
const example_peeringNetworkPeering = new gcp.compute.NetworkPeering("example-peeringNetworkPeering", {
network: network.then(network => network.selfLink),
peerNetwork: `https://www.googleapis.com/compute/v1/projects/${rediscloud_subscription_peering.example.gcp_redis_project_id}/global/networks/${rediscloud_subscription_peering.example.gcp_redis_network_name}`,
});
import pulumi
import pulumi_gcp as gcp
import pulumi_rediscloud as rediscloud
example = rediscloud.Subscription("example")
# ...
network = gcp.compute.get_network(project="my-gcp-project",
name="my-gcp-vpc")
example_peering_subscription_peering = rediscloud.SubscriptionPeering("example-peeringSubscriptionPeering",
subscription_id=example.id,
provider_name="GCP",
gcp_project_id=network.project,
gcp_network_name=network.name)
example_peering_network_peering = gcp.compute.NetworkPeering("example-peeringNetworkPeering",
network=network.self_link,
peer_network=f"https://www.googleapis.com/compute/v1/projects/{rediscloud_subscription_peering['example']['gcp_redis_project_id']}/global/networks/{rediscloud_subscription_peering['example']['gcp_redis_network_name']}")
resources:
example:
type: rediscloud:Subscription
example-peeringSubscriptionPeering:
type: rediscloud:SubscriptionPeering
properties:
subscriptionId: ${example.id}
providerName: GCP
gcpProjectId: ${network.project}
gcpNetworkName: ${network.name}
example-peeringNetworkPeering:
type: gcp:compute:NetworkPeering
properties:
network: ${network.selfLink}
peerNetwork: https://www.googleapis.com/compute/v1/projects/${rediscloud_subscription_peering.example.gcp_redis_project_id}/global/networks/${rediscloud_subscription_peering.example.gcp_redis_network_name}
variables:
network:
fn::invoke:
Function: gcp:compute:getNetwork
Arguments:
project: my-gcp-project
name: my-gcp-vpc
Create SubscriptionPeering Resource
Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.
Constructor syntax
new SubscriptionPeering(name: string, args: SubscriptionPeeringArgs, opts?: CustomResourceOptions);
@overload
def SubscriptionPeering(resource_name: str,
args: SubscriptionPeeringArgs,
opts: Optional[ResourceOptions] = None)
@overload
def SubscriptionPeering(resource_name: str,
opts: Optional[ResourceOptions] = None,
subscription_id: Optional[str] = None,
aws_account_id: Optional[str] = None,
gcp_network_name: Optional[str] = None,
gcp_project_id: Optional[str] = None,
provider_name: Optional[str] = None,
region: Optional[str] = None,
vpc_cidr: Optional[str] = None,
vpc_cidrs: Optional[Sequence[str]] = None,
vpc_id: Optional[str] = None)
func NewSubscriptionPeering(ctx *Context, name string, args SubscriptionPeeringArgs, opts ...ResourceOption) (*SubscriptionPeering, error)
public SubscriptionPeering(string name, SubscriptionPeeringArgs args, CustomResourceOptions? opts = null)
public SubscriptionPeering(String name, SubscriptionPeeringArgs args)
public SubscriptionPeering(String name, SubscriptionPeeringArgs args, CustomResourceOptions options)
type: rediscloud:SubscriptionPeering
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.
Parameters
- name
This property is required. string - The unique name of the resource.
- args
This property is required. SubscriptionPeeringArgs - The arguments to resource properties.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- resource_name
This property is required. str - The unique name of the resource.
- args
This property is required. SubscriptionPeeringArgs - The arguments to resource properties.
- opts ResourceOptions
- Bag of options to control resource's behavior.
- ctx Context
- Context object for the current deployment.
- name
This property is required. string - The unique name of the resource.
- args
This property is required. SubscriptionPeeringArgs - The arguments to resource properties.
- opts ResourceOption
- Bag of options to control resource's behavior.
- name
This property is required. string - The unique name of the resource.
- args
This property is required. SubscriptionPeeringArgs - The arguments to resource properties.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- name
This property is required. String - The unique name of the resource.
- args
This property is required. SubscriptionPeeringArgs - The arguments to resource properties.
- options CustomResourceOptions
- Bag of options to control resource's behavior.
Constructor example
The following reference example uses placeholder values for all input properties.
var subscriptionPeeringResource = new Rediscloud.SubscriptionPeering("subscriptionPeeringResource", new()
{
SubscriptionId = "string",
AwsAccountId = "string",
GcpNetworkName = "string",
GcpProjectId = "string",
ProviderName = "string",
Region = "string",
VpcCidr = "string",
VpcCidrs = new[]
{
"string",
},
VpcId = "string",
});
example, err := rediscloud.NewSubscriptionPeering(ctx, "subscriptionPeeringResource", &rediscloud.SubscriptionPeeringArgs{
SubscriptionId: pulumi.String("string"),
AwsAccountId: pulumi.String("string"),
GcpNetworkName: pulumi.String("string"),
GcpProjectId: pulumi.String("string"),
ProviderName: pulumi.String("string"),
Region: pulumi.String("string"),
VpcCidr: pulumi.String("string"),
VpcCidrs: pulumi.StringArray{
pulumi.String("string"),
},
VpcId: pulumi.String("string"),
})
var subscriptionPeeringResource = new SubscriptionPeering("subscriptionPeeringResource", SubscriptionPeeringArgs.builder()
.subscriptionId("string")
.awsAccountId("string")
.gcpNetworkName("string")
.gcpProjectId("string")
.providerName("string")
.region("string")
.vpcCidr("string")
.vpcCidrs("string")
.vpcId("string")
.build());
subscription_peering_resource = rediscloud.SubscriptionPeering("subscriptionPeeringResource",
subscription_id="string",
aws_account_id="string",
gcp_network_name="string",
gcp_project_id="string",
provider_name="string",
region="string",
vpc_cidr="string",
vpc_cidrs=["string"],
vpc_id="string")
const subscriptionPeeringResource = new rediscloud.SubscriptionPeering("subscriptionPeeringResource", {
subscriptionId: "string",
awsAccountId: "string",
gcpNetworkName: "string",
gcpProjectId: "string",
providerName: "string",
region: "string",
vpcCidr: "string",
vpcCidrs: ["string"],
vpcId: "string",
});
type: rediscloud:SubscriptionPeering
properties:
awsAccountId: string
gcpNetworkName: string
gcpProjectId: string
providerName: string
region: string
subscriptionId: string
vpcCidr: string
vpcCidrs:
- string
vpcId: string
SubscriptionPeering Resource Properties
To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.
Inputs
In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.
The SubscriptionPeering resource accepts the following input properties:
- Subscription
Id This property is required. Changes to this property will trigger replacement.
A valid subscription predefined in the current account. Modifying this attribute will force creation of a new resource.
AWS ONLY:
- Aws
Account Id Changes to this property will trigger replacement.
- AWS account ID that the VPC to be peered lives in. Modifying this attribute will force creation of a new resource.
- Gcp
Network Name Changes to this property will trigger replacement.
- The name of the network to be peered. Modifying this attribute will force creation of a new resource.
- Gcp
Project Id Changes to this property will trigger replacement.
- GCP project ID that the VPC to be peered lives in. Modifying this attribute will force creation of a new resource.
- Provider
Name Changes to this property will trigger replacement.
- The cloud provider to use with the vpc peering, (either
AWS
orGCP
). Default: ‘AWS’. Modifying this attribute will force creation of a new resource. - Region
Changes to this property will trigger replacement.
- AWS Region that the VPC to be peered lives in. Modifying this attribute will force creation of a new resource.
- Vpc
Cidr Changes to this property will trigger replacement.
- CIDR range of the VPC to be peered. Either this or
vpc_cidrs
must be specified. Modifying this attribute will force creation of a new resource. - Vpc
Cidrs Changes to this property will trigger replacement.
CIDR ranges of the VPC to be peered. Either this or
vpc_cidr
must be specified. Modifying this attribute will force creation of a new resource.GCP ONLY:
- Vpc
Id Changes to this property will trigger replacement.
- Identifier of the VPC to be peered. Modifying this attribute will force creation of a new resource.
- Subscription
Id This property is required. Changes to this property will trigger replacement.
A valid subscription predefined in the current account. Modifying this attribute will force creation of a new resource.
AWS ONLY:
- Aws
Account Id Changes to this property will trigger replacement.
- AWS account ID that the VPC to be peered lives in. Modifying this attribute will force creation of a new resource.
- Gcp
Network Name Changes to this property will trigger replacement.
- The name of the network to be peered. Modifying this attribute will force creation of a new resource.
- Gcp
Project Id Changes to this property will trigger replacement.
- GCP project ID that the VPC to be peered lives in. Modifying this attribute will force creation of a new resource.
- Provider
Name Changes to this property will trigger replacement.
- The cloud provider to use with the vpc peering, (either
AWS
orGCP
). Default: ‘AWS’. Modifying this attribute will force creation of a new resource. - Region
Changes to this property will trigger replacement.
- AWS Region that the VPC to be peered lives in. Modifying this attribute will force creation of a new resource.
- Vpc
Cidr Changes to this property will trigger replacement.
- CIDR range of the VPC to be peered. Either this or
vpc_cidrs
must be specified. Modifying this attribute will force creation of a new resource. - Vpc
Cidrs Changes to this property will trigger replacement.
CIDR ranges of the VPC to be peered. Either this or
vpc_cidr
must be specified. Modifying this attribute will force creation of a new resource.GCP ONLY:
- Vpc
Id Changes to this property will trigger replacement.
- Identifier of the VPC to be peered. Modifying this attribute will force creation of a new resource.
- subscription
Id This property is required. Changes to this property will trigger replacement.
A valid subscription predefined in the current account. Modifying this attribute will force creation of a new resource.
AWS ONLY:
- aws
Account Id Changes to this property will trigger replacement.
- AWS account ID that the VPC to be peered lives in. Modifying this attribute will force creation of a new resource.
- gcp
Network Name Changes to this property will trigger replacement.
- The name of the network to be peered. Modifying this attribute will force creation of a new resource.
- gcp
Project Id Changes to this property will trigger replacement.
- GCP project ID that the VPC to be peered lives in. Modifying this attribute will force creation of a new resource.
- provider
Name Changes to this property will trigger replacement.
- The cloud provider to use with the vpc peering, (either
AWS
orGCP
). Default: ‘AWS’. Modifying this attribute will force creation of a new resource. - region
Changes to this property will trigger replacement.
- AWS Region that the VPC to be peered lives in. Modifying this attribute will force creation of a new resource.
- vpc
Cidr Changes to this property will trigger replacement.
- CIDR range of the VPC to be peered. Either this or
vpc_cidrs
must be specified. Modifying this attribute will force creation of a new resource. - vpc
Cidrs Changes to this property will trigger replacement.
CIDR ranges of the VPC to be peered. Either this or
vpc_cidr
must be specified. Modifying this attribute will force creation of a new resource.GCP ONLY:
- vpc
Id Changes to this property will trigger replacement.
- Identifier of the VPC to be peered. Modifying this attribute will force creation of a new resource.
- subscription
Id This property is required. Changes to this property will trigger replacement.
A valid subscription predefined in the current account. Modifying this attribute will force creation of a new resource.
AWS ONLY:
- aws
Account Id Changes to this property will trigger replacement.
- AWS account ID that the VPC to be peered lives in. Modifying this attribute will force creation of a new resource.
- gcp
Network Name Changes to this property will trigger replacement.
- The name of the network to be peered. Modifying this attribute will force creation of a new resource.
- gcp
Project Id Changes to this property will trigger replacement.
- GCP project ID that the VPC to be peered lives in. Modifying this attribute will force creation of a new resource.
- provider
Name Changes to this property will trigger replacement.
- The cloud provider to use with the vpc peering, (either
AWS
orGCP
). Default: ‘AWS’. Modifying this attribute will force creation of a new resource. - region
Changes to this property will trigger replacement.
- AWS Region that the VPC to be peered lives in. Modifying this attribute will force creation of a new resource.
- vpc
Cidr Changes to this property will trigger replacement.
- CIDR range of the VPC to be peered. Either this or
vpc_cidrs
must be specified. Modifying this attribute will force creation of a new resource. - vpc
Cidrs Changes to this property will trigger replacement.
CIDR ranges of the VPC to be peered. Either this or
vpc_cidr
must be specified. Modifying this attribute will force creation of a new resource.GCP ONLY:
- vpc
Id Changes to this property will trigger replacement.
- Identifier of the VPC to be peered. Modifying this attribute will force creation of a new resource.
- subscription_
id This property is required. Changes to this property will trigger replacement.
A valid subscription predefined in the current account. Modifying this attribute will force creation of a new resource.
AWS ONLY:
- aws_
account_ id Changes to this property will trigger replacement.
- AWS account ID that the VPC to be peered lives in. Modifying this attribute will force creation of a new resource.
- gcp_
network_ name Changes to this property will trigger replacement.
- The name of the network to be peered. Modifying this attribute will force creation of a new resource.
- gcp_
project_ id Changes to this property will trigger replacement.
- GCP project ID that the VPC to be peered lives in. Modifying this attribute will force creation of a new resource.
- provider_
name Changes to this property will trigger replacement.
- The cloud provider to use with the vpc peering, (either
AWS
orGCP
). Default: ‘AWS’. Modifying this attribute will force creation of a new resource. - region
Changes to this property will trigger replacement.
- AWS Region that the VPC to be peered lives in. Modifying this attribute will force creation of a new resource.
- vpc_
cidr Changes to this property will trigger replacement.
- CIDR range of the VPC to be peered. Either this or
vpc_cidrs
must be specified. Modifying this attribute will force creation of a new resource. - vpc_
cidrs Changes to this property will trigger replacement.
CIDR ranges of the VPC to be peered. Either this or
vpc_cidr
must be specified. Modifying this attribute will force creation of a new resource.GCP ONLY:
- vpc_
id Changes to this property will trigger replacement.
- Identifier of the VPC to be peered. Modifying this attribute will force creation of a new resource.
- subscription
Id This property is required. Changes to this property will trigger replacement.
A valid subscription predefined in the current account. Modifying this attribute will force creation of a new resource.
AWS ONLY:
- aws
Account Id Changes to this property will trigger replacement.
- AWS account ID that the VPC to be peered lives in. Modifying this attribute will force creation of a new resource.
- gcp
Network Name Changes to this property will trigger replacement.
- The name of the network to be peered. Modifying this attribute will force creation of a new resource.
- gcp
Project Id Changes to this property will trigger replacement.
- GCP project ID that the VPC to be peered lives in. Modifying this attribute will force creation of a new resource.
- provider
Name Changes to this property will trigger replacement.
- The cloud provider to use with the vpc peering, (either
AWS
orGCP
). Default: ‘AWS’. Modifying this attribute will force creation of a new resource. - region
Changes to this property will trigger replacement.
- AWS Region that the VPC to be peered lives in. Modifying this attribute will force creation of a new resource.
- vpc
Cidr Changes to this property will trigger replacement.
- CIDR range of the VPC to be peered. Either this or
vpc_cidrs
must be specified. Modifying this attribute will force creation of a new resource. - vpc
Cidrs Changes to this property will trigger replacement.
CIDR ranges of the VPC to be peered. Either this or
vpc_cidr
must be specified. Modifying this attribute will force creation of a new resource.GCP ONLY:
- vpc
Id Changes to this property will trigger replacement.
- Identifier of the VPC to be peered. Modifying this attribute will force creation of a new resource.
Outputs
All input properties are implicitly available as output properties. Additionally, the SubscriptionPeering resource produces the following output properties:
- Aws
Peering stringId - Identifier of the AWS cloud peering
- Gcp
Peering stringId - Identifier of the cloud peering
- Gcp
Redis stringNetwork Name - The name of the Redis Enterprise Cloud network to be peered
- Gcp
Redis stringProject Id - Identifier of the Redis Enterprise Cloud GCP project to be peered
- Id string
- The provider-assigned unique ID for this managed resource.
- Status string
- is set to the current status of the peering -
initiating-request
,pending-acceptance
,active
,inactive
orfailed
.
- Aws
Peering stringId - Identifier of the AWS cloud peering
- Gcp
Peering stringId - Identifier of the cloud peering
- Gcp
Redis stringNetwork Name - The name of the Redis Enterprise Cloud network to be peered
- Gcp
Redis stringProject Id - Identifier of the Redis Enterprise Cloud GCP project to be peered
- Id string
- The provider-assigned unique ID for this managed resource.
- Status string
- is set to the current status of the peering -
initiating-request
,pending-acceptance
,active
,inactive
orfailed
.
- aws
Peering StringId - Identifier of the AWS cloud peering
- gcp
Peering StringId - Identifier of the cloud peering
- gcp
Redis StringNetwork Name - The name of the Redis Enterprise Cloud network to be peered
- gcp
Redis StringProject Id - Identifier of the Redis Enterprise Cloud GCP project to be peered
- id String
- The provider-assigned unique ID for this managed resource.
- status String
- is set to the current status of the peering -
initiating-request
,pending-acceptance
,active
,inactive
orfailed
.
- aws
Peering stringId - Identifier of the AWS cloud peering
- gcp
Peering stringId - Identifier of the cloud peering
- gcp
Redis stringNetwork Name - The name of the Redis Enterprise Cloud network to be peered
- gcp
Redis stringProject Id - Identifier of the Redis Enterprise Cloud GCP project to be peered
- id string
- The provider-assigned unique ID for this managed resource.
- status string
- is set to the current status of the peering -
initiating-request
,pending-acceptance
,active
,inactive
orfailed
.
- aws_
peering_ strid - Identifier of the AWS cloud peering
- gcp_
peering_ strid - Identifier of the cloud peering
- gcp_
redis_ strnetwork_ name - The name of the Redis Enterprise Cloud network to be peered
- gcp_
redis_ strproject_ id - Identifier of the Redis Enterprise Cloud GCP project to be peered
- id str
- The provider-assigned unique ID for this managed resource.
- status str
- is set to the current status of the peering -
initiating-request
,pending-acceptance
,active
,inactive
orfailed
.
- aws
Peering StringId - Identifier of the AWS cloud peering
- gcp
Peering StringId - Identifier of the cloud peering
- gcp
Redis StringNetwork Name - The name of the Redis Enterprise Cloud network to be peered
- gcp
Redis StringProject Id - Identifier of the Redis Enterprise Cloud GCP project to be peered
- id String
- The provider-assigned unique ID for this managed resource.
- status String
- is set to the current status of the peering -
initiating-request
,pending-acceptance
,active
,inactive
orfailed
.
Look up Existing SubscriptionPeering Resource
Get an existing SubscriptionPeering resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.
public static get(name: string, id: Input<ID>, state?: SubscriptionPeeringState, opts?: CustomResourceOptions): SubscriptionPeering
@staticmethod
def get(resource_name: str,
id: str,
opts: Optional[ResourceOptions] = None,
aws_account_id: Optional[str] = None,
aws_peering_id: Optional[str] = None,
gcp_network_name: Optional[str] = None,
gcp_peering_id: Optional[str] = None,
gcp_project_id: Optional[str] = None,
gcp_redis_network_name: Optional[str] = None,
gcp_redis_project_id: Optional[str] = None,
provider_name: Optional[str] = None,
region: Optional[str] = None,
status: Optional[str] = None,
subscription_id: Optional[str] = None,
vpc_cidr: Optional[str] = None,
vpc_cidrs: Optional[Sequence[str]] = None,
vpc_id: Optional[str] = None) -> SubscriptionPeering
func GetSubscriptionPeering(ctx *Context, name string, id IDInput, state *SubscriptionPeeringState, opts ...ResourceOption) (*SubscriptionPeering, error)
public static SubscriptionPeering Get(string name, Input<string> id, SubscriptionPeeringState? state, CustomResourceOptions? opts = null)
public static SubscriptionPeering get(String name, Output<String> id, SubscriptionPeeringState state, CustomResourceOptions options)
resources: _: type: rediscloud:SubscriptionPeering get: id: ${id}
- name
This property is required. - The unique name of the resulting resource.
- id
This property is required. - The unique provider ID of the resource to lookup.
- state
- Any extra arguments used during the lookup.
- opts
- A bag of options that control this resource's behavior.
- resource_name
This property is required. - The unique name of the resulting resource.
- id
This property is required. - The unique provider ID of the resource to lookup.
- name
This property is required. - The unique name of the resulting resource.
- id
This property is required. - The unique provider ID of the resource to lookup.
- state
- Any extra arguments used during the lookup.
- opts
- A bag of options that control this resource's behavior.
- name
This property is required. - The unique name of the resulting resource.
- id
This property is required. - The unique provider ID of the resource to lookup.
- state
- Any extra arguments used during the lookup.
- opts
- A bag of options that control this resource's behavior.
- name
This property is required. - The unique name of the resulting resource.
- id
This property is required. - The unique provider ID of the resource to lookup.
- state
- Any extra arguments used during the lookup.
- opts
- A bag of options that control this resource's behavior.
- Aws
Account Id Changes to this property will trigger replacement.
- AWS account ID that the VPC to be peered lives in. Modifying this attribute will force creation of a new resource.
- Aws
Peering stringId - Identifier of the AWS cloud peering
- Gcp
Network Name Changes to this property will trigger replacement.
- The name of the network to be peered. Modifying this attribute will force creation of a new resource.
- Gcp
Peering stringId - Identifier of the cloud peering
- Gcp
Project Id Changes to this property will trigger replacement.
- GCP project ID that the VPC to be peered lives in. Modifying this attribute will force creation of a new resource.
- Gcp
Redis stringNetwork Name - The name of the Redis Enterprise Cloud network to be peered
- Gcp
Redis stringProject Id - Identifier of the Redis Enterprise Cloud GCP project to be peered
- Provider
Name Changes to this property will trigger replacement.
- The cloud provider to use with the vpc peering, (either
AWS
orGCP
). Default: ‘AWS’. Modifying this attribute will force creation of a new resource. - Region
Changes to this property will trigger replacement.
- AWS Region that the VPC to be peered lives in. Modifying this attribute will force creation of a new resource.
- Status string
- is set to the current status of the peering -
initiating-request
,pending-acceptance
,active
,inactive
orfailed
. - Subscription
Id Changes to this property will trigger replacement.
A valid subscription predefined in the current account. Modifying this attribute will force creation of a new resource.
AWS ONLY:
- Vpc
Cidr Changes to this property will trigger replacement.
- CIDR range of the VPC to be peered. Either this or
vpc_cidrs
must be specified. Modifying this attribute will force creation of a new resource. - Vpc
Cidrs Changes to this property will trigger replacement.
CIDR ranges of the VPC to be peered. Either this or
vpc_cidr
must be specified. Modifying this attribute will force creation of a new resource.GCP ONLY:
- Vpc
Id Changes to this property will trigger replacement.
- Identifier of the VPC to be peered. Modifying this attribute will force creation of a new resource.
- Aws
Account Id Changes to this property will trigger replacement.
- AWS account ID that the VPC to be peered lives in. Modifying this attribute will force creation of a new resource.
- Aws
Peering stringId - Identifier of the AWS cloud peering
- Gcp
Network Name Changes to this property will trigger replacement.
- The name of the network to be peered. Modifying this attribute will force creation of a new resource.
- Gcp
Peering stringId - Identifier of the cloud peering
- Gcp
Project Id Changes to this property will trigger replacement.
- GCP project ID that the VPC to be peered lives in. Modifying this attribute will force creation of a new resource.
- Gcp
Redis stringNetwork Name - The name of the Redis Enterprise Cloud network to be peered
- Gcp
Redis stringProject Id - Identifier of the Redis Enterprise Cloud GCP project to be peered
- Provider
Name Changes to this property will trigger replacement.
- The cloud provider to use with the vpc peering, (either
AWS
orGCP
). Default: ‘AWS’. Modifying this attribute will force creation of a new resource. - Region
Changes to this property will trigger replacement.
- AWS Region that the VPC to be peered lives in. Modifying this attribute will force creation of a new resource.
- Status string
- is set to the current status of the peering -
initiating-request
,pending-acceptance
,active
,inactive
orfailed
. - Subscription
Id Changes to this property will trigger replacement.
A valid subscription predefined in the current account. Modifying this attribute will force creation of a new resource.
AWS ONLY:
- Vpc
Cidr Changes to this property will trigger replacement.
- CIDR range of the VPC to be peered. Either this or
vpc_cidrs
must be specified. Modifying this attribute will force creation of a new resource. - Vpc
Cidrs Changes to this property will trigger replacement.
CIDR ranges of the VPC to be peered. Either this or
vpc_cidr
must be specified. Modifying this attribute will force creation of a new resource.GCP ONLY:
- Vpc
Id Changes to this property will trigger replacement.
- Identifier of the VPC to be peered. Modifying this attribute will force creation of a new resource.
- aws
Account Id Changes to this property will trigger replacement.
- AWS account ID that the VPC to be peered lives in. Modifying this attribute will force creation of a new resource.
- aws
Peering StringId - Identifier of the AWS cloud peering
- gcp
Network Name Changes to this property will trigger replacement.
- The name of the network to be peered. Modifying this attribute will force creation of a new resource.
- gcp
Peering StringId - Identifier of the cloud peering
- gcp
Project Id Changes to this property will trigger replacement.
- GCP project ID that the VPC to be peered lives in. Modifying this attribute will force creation of a new resource.
- gcp
Redis StringNetwork Name - The name of the Redis Enterprise Cloud network to be peered
- gcp
Redis StringProject Id - Identifier of the Redis Enterprise Cloud GCP project to be peered
- provider
Name Changes to this property will trigger replacement.
- The cloud provider to use with the vpc peering, (either
AWS
orGCP
). Default: ‘AWS’. Modifying this attribute will force creation of a new resource. - region
Changes to this property will trigger replacement.
- AWS Region that the VPC to be peered lives in. Modifying this attribute will force creation of a new resource.
- status String
- is set to the current status of the peering -
initiating-request
,pending-acceptance
,active
,inactive
orfailed
. - subscription
Id Changes to this property will trigger replacement.
A valid subscription predefined in the current account. Modifying this attribute will force creation of a new resource.
AWS ONLY:
- vpc
Cidr Changes to this property will trigger replacement.
- CIDR range of the VPC to be peered. Either this or
vpc_cidrs
must be specified. Modifying this attribute will force creation of a new resource. - vpc
Cidrs Changes to this property will trigger replacement.
CIDR ranges of the VPC to be peered. Either this or
vpc_cidr
must be specified. Modifying this attribute will force creation of a new resource.GCP ONLY:
- vpc
Id Changes to this property will trigger replacement.
- Identifier of the VPC to be peered. Modifying this attribute will force creation of a new resource.
- aws
Account Id Changes to this property will trigger replacement.
- AWS account ID that the VPC to be peered lives in. Modifying this attribute will force creation of a new resource.
- aws
Peering stringId - Identifier of the AWS cloud peering
- gcp
Network Name Changes to this property will trigger replacement.
- The name of the network to be peered. Modifying this attribute will force creation of a new resource.
- gcp
Peering stringId - Identifier of the cloud peering
- gcp
Project Id Changes to this property will trigger replacement.
- GCP project ID that the VPC to be peered lives in. Modifying this attribute will force creation of a new resource.
- gcp
Redis stringNetwork Name - The name of the Redis Enterprise Cloud network to be peered
- gcp
Redis stringProject Id - Identifier of the Redis Enterprise Cloud GCP project to be peered
- provider
Name Changes to this property will trigger replacement.
- The cloud provider to use with the vpc peering, (either
AWS
orGCP
). Default: ‘AWS’. Modifying this attribute will force creation of a new resource. - region
Changes to this property will trigger replacement.
- AWS Region that the VPC to be peered lives in. Modifying this attribute will force creation of a new resource.
- status string
- is set to the current status of the peering -
initiating-request
,pending-acceptance
,active
,inactive
orfailed
. - subscription
Id Changes to this property will trigger replacement.
A valid subscription predefined in the current account. Modifying this attribute will force creation of a new resource.
AWS ONLY:
- vpc
Cidr Changes to this property will trigger replacement.
- CIDR range of the VPC to be peered. Either this or
vpc_cidrs
must be specified. Modifying this attribute will force creation of a new resource. - vpc
Cidrs Changes to this property will trigger replacement.
CIDR ranges of the VPC to be peered. Either this or
vpc_cidr
must be specified. Modifying this attribute will force creation of a new resource.GCP ONLY:
- vpc
Id Changes to this property will trigger replacement.
- Identifier of the VPC to be peered. Modifying this attribute will force creation of a new resource.
- aws_
account_ id Changes to this property will trigger replacement.
- AWS account ID that the VPC to be peered lives in. Modifying this attribute will force creation of a new resource.
- aws_
peering_ strid - Identifier of the AWS cloud peering
- gcp_
network_ name Changes to this property will trigger replacement.
- The name of the network to be peered. Modifying this attribute will force creation of a new resource.
- gcp_
peering_ strid - Identifier of the cloud peering
- gcp_
project_ id Changes to this property will trigger replacement.
- GCP project ID that the VPC to be peered lives in. Modifying this attribute will force creation of a new resource.
- gcp_
redis_ strnetwork_ name - The name of the Redis Enterprise Cloud network to be peered
- gcp_
redis_ strproject_ id - Identifier of the Redis Enterprise Cloud GCP project to be peered
- provider_
name Changes to this property will trigger replacement.
- The cloud provider to use with the vpc peering, (either
AWS
orGCP
). Default: ‘AWS’. Modifying this attribute will force creation of a new resource. - region
Changes to this property will trigger replacement.
- AWS Region that the VPC to be peered lives in. Modifying this attribute will force creation of a new resource.
- status str
- is set to the current status of the peering -
initiating-request
,pending-acceptance
,active
,inactive
orfailed
. - subscription_
id Changes to this property will trigger replacement.
A valid subscription predefined in the current account. Modifying this attribute will force creation of a new resource.
AWS ONLY:
- vpc_
cidr Changes to this property will trigger replacement.
- CIDR range of the VPC to be peered. Either this or
vpc_cidrs
must be specified. Modifying this attribute will force creation of a new resource. - vpc_
cidrs Changes to this property will trigger replacement.
CIDR ranges of the VPC to be peered. Either this or
vpc_cidr
must be specified. Modifying this attribute will force creation of a new resource.GCP ONLY:
- vpc_
id Changes to this property will trigger replacement.
- Identifier of the VPC to be peered. Modifying this attribute will force creation of a new resource.
- aws
Account Id Changes to this property will trigger replacement.
- AWS account ID that the VPC to be peered lives in. Modifying this attribute will force creation of a new resource.
- aws
Peering StringId - Identifier of the AWS cloud peering
- gcp
Network Name Changes to this property will trigger replacement.
- The name of the network to be peered. Modifying this attribute will force creation of a new resource.
- gcp
Peering StringId - Identifier of the cloud peering
- gcp
Project Id Changes to this property will trigger replacement.
- GCP project ID that the VPC to be peered lives in. Modifying this attribute will force creation of a new resource.
- gcp
Redis StringNetwork Name - The name of the Redis Enterprise Cloud network to be peered
- gcp
Redis StringProject Id - Identifier of the Redis Enterprise Cloud GCP project to be peered
- provider
Name Changes to this property will trigger replacement.
- The cloud provider to use with the vpc peering, (either
AWS
orGCP
). Default: ‘AWS’. Modifying this attribute will force creation of a new resource. - region
Changes to this property will trigger replacement.
- AWS Region that the VPC to be peered lives in. Modifying this attribute will force creation of a new resource.
- status String
- is set to the current status of the peering -
initiating-request
,pending-acceptance
,active
,inactive
orfailed
. - subscription
Id Changes to this property will trigger replacement.
A valid subscription predefined in the current account. Modifying this attribute will force creation of a new resource.
AWS ONLY:
- vpc
Cidr Changes to this property will trigger replacement.
- CIDR range of the VPC to be peered. Either this or
vpc_cidrs
must be specified. Modifying this attribute will force creation of a new resource. - vpc
Cidrs Changes to this property will trigger replacement.
CIDR ranges of the VPC to be peered. Either this or
vpc_cidr
must be specified. Modifying this attribute will force creation of a new resource.GCP ONLY:
- vpc
Id Changes to this property will trigger replacement.
- Identifier of the VPC to be peered. Modifying this attribute will force creation of a new resource.
Import
rediscloud_subscription_peering
can be imported using the ID of the subscription and the ID of the peering connection, e.g.
$ pulumi import rediscloud:index/subscriptionPeering:SubscriptionPeering example 12345678/1234
To learn more about importing existing cloud resources, see Importing resources.
Package Details
- Repository
- rediscloud RedisLabs/pulumi-rediscloud
- License
- Apache-2.0
- Notes
- This Pulumi package is based on the
rediscloud
Terraform Provider.