1. Packages
  2. RedisCloud
  3. API Docs
  4. SubscriptionPeering
Redis Cloud v1.3.5 published on Wednesday, Dec 20, 2023 by RedisLabs

rediscloud.SubscriptionPeering

Explore with Pulumi AI

rediscloud logo
Redis Cloud v1.3.5 published on Wednesday, Dec 20, 2023 by RedisLabs

    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

    using System.Collections.Generic;
    using System.Linq;
    using Pulumi;
    using Aws = Pulumi.Aws;
    using Rediscloud = RedisLabs.Rediscloud;
    
    return await Deployment.RunAsync(() => 
    {
        var exampleSubscription = new Rediscloud.Subscription("exampleSubscription");
    
        // ...
        var exampleSubscriptionPeering = new Rediscloud.SubscriptionPeering("exampleSubscriptionPeering", new()
        {
            SubscriptionId = exampleSubscription.Id,
            Region = "eu-west-1",
            AwsAccountId = "123456789012",
            VpcId = "vpc-01234567890",
            VpcCidr = "10.0.0.0/8",
        });
    
        var example_peering = new Aws.Ec2.VpcPeeringConnectionAccepter("example-peering", new()
        {
            VpcPeeringConnectionId = exampleSubscriptionPeering.AwsPeeringId,
            AutoAccept = true,
        });
    
    });
    
    package main
    
    import (
    	"github.com/RedisLabs/pulumi-rediscloud/sdk/go/rediscloud"
    	"github.com/pulumi/pulumi-aws/sdk/v5/go/aws/ec2"
    	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
    )
    
    func main() {
    	pulumi.Run(func(ctx *pulumi.Context) error {
    		exampleSubscription, err := rediscloud.NewSubscription(ctx, "exampleSubscription", nil)
    		if err != nil {
    			return err
    		}
    		exampleSubscriptionPeering, err := rediscloud.NewSubscriptionPeering(ctx, "exampleSubscriptionPeering", &rediscloud.SubscriptionPeeringArgs{
    			SubscriptionId: exampleSubscription.ID(),
    			Region:         pulumi.String("eu-west-1"),
    			AwsAccountId:   pulumi.String("123456789012"),
    			VpcId:          pulumi.String("vpc-01234567890"),
    			VpcCidr:        pulumi.String("10.0.0.0/8"),
    		})
    		if err != nil {
    			return err
    		}
    		_, err = ec2.NewVpcPeeringConnectionAccepter(ctx, "example-peering", &ec2.VpcPeeringConnectionAccepterArgs{
    			VpcPeeringConnectionId: exampleSubscriptionPeering.AwsPeeringId,
    			AutoAccept:             pulumi.Bool(true),
    		})
    		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.rediscloud.SubscriptionPeering;
    import com.pulumi.rediscloud.SubscriptionPeeringArgs;
    import com.pulumi.aws.ec2.VpcPeeringConnectionAccepter;
    import com.pulumi.aws.ec2.VpcPeeringConnectionAccepterArgs;
    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 exampleSubscription = new Subscription("exampleSubscription");
    
            var exampleSubscriptionPeering = new SubscriptionPeering("exampleSubscriptionPeering", SubscriptionPeeringArgs.builder()        
                .subscriptionId(exampleSubscription.id())
                .region("eu-west-1")
                .awsAccountId("123456789012")
                .vpcId("vpc-01234567890")
                .vpcCidr("10.0.0.0/8")
                .build());
    
            var example_peering = new VpcPeeringConnectionAccepter("example-peering", VpcPeeringConnectionAccepterArgs.builder()        
                .vpcPeeringConnectionId(exampleSubscriptionPeering.awsPeeringId())
                .autoAccept(true)
                .build());
    
        }
    }
    
    import pulumi
    import pulumi_aws as aws
    import pulumi_rediscloud as rediscloud
    
    example_subscription = rediscloud.Subscription("exampleSubscription")
    # ...
    example_subscription_peering = rediscloud.SubscriptionPeering("exampleSubscriptionPeering",
        subscription_id=example_subscription.id,
        region="eu-west-1",
        aws_account_id="123456789012",
        vpc_id="vpc-01234567890",
        vpc_cidr="10.0.0.0/8")
    example_peering = aws.ec2.VpcPeeringConnectionAccepter("example-peering",
        vpc_peering_connection_id=example_subscription_peering.aws_peering_id,
        auto_accept=True)
    
    import * as pulumi from "@pulumi/pulumi";
    import * as aws from "@pulumi/aws";
    import * as rediscloud from "@rediscloud/pulumi-rediscloud";
    
    const exampleSubscription = new rediscloud.Subscription("exampleSubscription", {});
    // ...
    const exampleSubscriptionPeering = new rediscloud.SubscriptionPeering("exampleSubscriptionPeering", {
        subscriptionId: exampleSubscription.id,
        region: "eu-west-1",
        awsAccountId: "123456789012",
        vpcId: "vpc-01234567890",
        vpcCidr: "10.0.0.0/8",
    });
    const example_peering = new aws.ec2.VpcPeeringConnectionAccepter("example-peering", {
        vpcPeeringConnectionId: exampleSubscriptionPeering.awsPeeringId,
        autoAccept: true,
    });
    
    resources:
      exampleSubscription:
        type: rediscloud:Subscription
      exampleSubscriptionPeering:
        type: rediscloud:SubscriptionPeering
        properties:
          subscriptionId: ${exampleSubscription.id}
          region: eu-west-1
          awsAccountId: '123456789012'
          vpcId: vpc-01234567890
          vpcCidr: 10.0.0.0/8
      example-peering:
        type: aws:ec2:VpcPeeringConnectionAccepter
        properties:
          vpcPeeringConnectionId: ${exampleSubscriptionPeering.awsPeeringId}
          autoAccept: true
    

    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 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']}")
    
    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}`,
    });
    
    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 string
    The unique name of the resource.
    args SubscriptionPeeringArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    resource_name str
    The unique name of the resource.
    args 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 string
    The unique name of the resource.
    args SubscriptionPeeringArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args SubscriptionPeeringArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args SubscriptionPeeringArgs
    The arguments to resource properties.
    options CustomResourceOptions
    Bag of options to control resource's behavior.

    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

    The SubscriptionPeering resource accepts the following input properties:

    SubscriptionId string

    A valid subscription predefined in the current account. Modifying this attribute will force creation of a new resource.

    AWS ONLY:

    AwsAccountId string
    AWS account ID that the VPC to be peered lives in. Modifying this attribute will force creation of a new resource.
    GcpNetworkName string
    The name of the network to be peered. Modifying this attribute will force creation of a new resource.
    GcpProjectId string
    GCP project ID that the VPC to be peered lives in. Modifying this attribute will force creation of a new resource.
    ProviderName string
    The cloud provider to use with the vpc peering, (either AWS or GCP). Default: ‘AWS’. Modifying this attribute will force creation of a new resource.
    Region string
    AWS Region that the VPC to be peered lives in. Modifying this attribute will force creation of a new resource.
    VpcCidr string
    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.
    VpcCidrs List<string>

    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:

    VpcId string
    Identifier of the VPC to be peered. Modifying this attribute will force creation of a new resource.
    SubscriptionId string

    A valid subscription predefined in the current account. Modifying this attribute will force creation of a new resource.

    AWS ONLY:

    AwsAccountId string
    AWS account ID that the VPC to be peered lives in. Modifying this attribute will force creation of a new resource.
    GcpNetworkName string
    The name of the network to be peered. Modifying this attribute will force creation of a new resource.
    GcpProjectId string
    GCP project ID that the VPC to be peered lives in. Modifying this attribute will force creation of a new resource.
    ProviderName string
    The cloud provider to use with the vpc peering, (either AWS or GCP). Default: ‘AWS’. Modifying this attribute will force creation of a new resource.
    Region string
    AWS Region that the VPC to be peered lives in. Modifying this attribute will force creation of a new resource.
    VpcCidr string
    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.
    VpcCidrs []string

    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:

    VpcId string
    Identifier of the VPC to be peered. Modifying this attribute will force creation of a new resource.
    subscriptionId String

    A valid subscription predefined in the current account. Modifying this attribute will force creation of a new resource.

    AWS ONLY:

    awsAccountId String
    AWS account ID that the VPC to be peered lives in. Modifying this attribute will force creation of a new resource.
    gcpNetworkName String
    The name of the network to be peered. Modifying this attribute will force creation of a new resource.
    gcpProjectId String
    GCP project ID that the VPC to be peered lives in. Modifying this attribute will force creation of a new resource.
    providerName String
    The cloud provider to use with the vpc peering, (either AWS or GCP). Default: ‘AWS’. Modifying this attribute will force creation of a new resource.
    region String
    AWS Region that the VPC to be peered lives in. Modifying this attribute will force creation of a new resource.
    vpcCidr String
    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.
    vpcCidrs List<String>

    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:

    vpcId String
    Identifier of the VPC to be peered. Modifying this attribute will force creation of a new resource.
    subscriptionId string

    A valid subscription predefined in the current account. Modifying this attribute will force creation of a new resource.

    AWS ONLY:

    awsAccountId string
    AWS account ID that the VPC to be peered lives in. Modifying this attribute will force creation of a new resource.
    gcpNetworkName string
    The name of the network to be peered. Modifying this attribute will force creation of a new resource.
    gcpProjectId string
    GCP project ID that the VPC to be peered lives in. Modifying this attribute will force creation of a new resource.
    providerName string
    The cloud provider to use with the vpc peering, (either AWS or GCP). Default: ‘AWS’. Modifying this attribute will force creation of a new resource.
    region string
    AWS Region that the VPC to be peered lives in. Modifying this attribute will force creation of a new resource.
    vpcCidr string
    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.
    vpcCidrs string[]

    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:

    vpcId string
    Identifier of the VPC to be peered. Modifying this attribute will force creation of a new resource.
    subscription_id str

    A valid subscription predefined in the current account. Modifying this attribute will force creation of a new resource.

    AWS ONLY:

    aws_account_id str
    AWS account ID that the VPC to be peered lives in. Modifying this attribute will force creation of a new resource.
    gcp_network_name str
    The name of the network to be peered. Modifying this attribute will force creation of a new resource.
    gcp_project_id str
    GCP project ID that the VPC to be peered lives in. Modifying this attribute will force creation of a new resource.
    provider_name str
    The cloud provider to use with the vpc peering, (either AWS or GCP). Default: ‘AWS’. Modifying this attribute will force creation of a new resource.
    region str
    AWS Region that the VPC to be peered lives in. Modifying this attribute will force creation of a new resource.
    vpc_cidr str
    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 Sequence[str]

    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 str
    Identifier of the VPC to be peered. Modifying this attribute will force creation of a new resource.
    subscriptionId String

    A valid subscription predefined in the current account. Modifying this attribute will force creation of a new resource.

    AWS ONLY:

    awsAccountId String
    AWS account ID that the VPC to be peered lives in. Modifying this attribute will force creation of a new resource.
    gcpNetworkName String
    The name of the network to be peered. Modifying this attribute will force creation of a new resource.
    gcpProjectId String
    GCP project ID that the VPC to be peered lives in. Modifying this attribute will force creation of a new resource.
    providerName String
    The cloud provider to use with the vpc peering, (either AWS or GCP). Default: ‘AWS’. Modifying this attribute will force creation of a new resource.
    region String
    AWS Region that the VPC to be peered lives in. Modifying this attribute will force creation of a new resource.
    vpcCidr String
    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.
    vpcCidrs List<String>

    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:

    vpcId String
    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:

    AwsPeeringId string
    Identifier of the AWS cloud peering
    GcpPeeringId string
    Identifier of the cloud peering
    GcpRedisNetworkName string
    The name of the Redis Enterprise Cloud network to be peered
    GcpRedisProjectId string
    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 or failed.
    AwsPeeringId string
    Identifier of the AWS cloud peering
    GcpPeeringId string
    Identifier of the cloud peering
    GcpRedisNetworkName string
    The name of the Redis Enterprise Cloud network to be peered
    GcpRedisProjectId string
    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 or failed.
    awsPeeringId String
    Identifier of the AWS cloud peering
    gcpPeeringId String
    Identifier of the cloud peering
    gcpRedisNetworkName String
    The name of the Redis Enterprise Cloud network to be peered
    gcpRedisProjectId String
    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 or failed.
    awsPeeringId string
    Identifier of the AWS cloud peering
    gcpPeeringId string
    Identifier of the cloud peering
    gcpRedisNetworkName string
    The name of the Redis Enterprise Cloud network to be peered
    gcpRedisProjectId string
    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 or failed.
    aws_peering_id str
    Identifier of the AWS cloud peering
    gcp_peering_id str
    Identifier of the cloud peering
    gcp_redis_network_name str
    The name of the Redis Enterprise Cloud network to be peered
    gcp_redis_project_id str
    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 or failed.
    awsPeeringId String
    Identifier of the AWS cloud peering
    gcpPeeringId String
    Identifier of the cloud peering
    gcpRedisNetworkName String
    The name of the Redis Enterprise Cloud network to be peered
    gcpRedisProjectId String
    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 or failed.

    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)
    Resource lookup is not supported in YAML
    name
    The unique name of the resulting resource.
    id
    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
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    name
    The unique name of the resulting resource.
    id
    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
    The unique name of the resulting resource.
    id
    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
    The unique name of the resulting resource.
    id
    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.
    The following state arguments are supported:
    AwsAccountId string
    AWS account ID that the VPC to be peered lives in. Modifying this attribute will force creation of a new resource.
    AwsPeeringId string
    Identifier of the AWS cloud peering
    GcpNetworkName string
    The name of the network to be peered. Modifying this attribute will force creation of a new resource.
    GcpPeeringId string
    Identifier of the cloud peering
    GcpProjectId string
    GCP project ID that the VPC to be peered lives in. Modifying this attribute will force creation of a new resource.
    GcpRedisNetworkName string
    The name of the Redis Enterprise Cloud network to be peered
    GcpRedisProjectId string
    Identifier of the Redis Enterprise Cloud GCP project to be peered
    ProviderName string
    The cloud provider to use with the vpc peering, (either AWS or GCP). Default: ‘AWS’. Modifying this attribute will force creation of a new resource.
    Region string
    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 or failed.
    SubscriptionId string

    A valid subscription predefined in the current account. Modifying this attribute will force creation of a new resource.

    AWS ONLY:

    VpcCidr string
    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.
    VpcCidrs List<string>

    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:

    VpcId string
    Identifier of the VPC to be peered. Modifying this attribute will force creation of a new resource.
    AwsAccountId string
    AWS account ID that the VPC to be peered lives in. Modifying this attribute will force creation of a new resource.
    AwsPeeringId string
    Identifier of the AWS cloud peering
    GcpNetworkName string
    The name of the network to be peered. Modifying this attribute will force creation of a new resource.
    GcpPeeringId string
    Identifier of the cloud peering
    GcpProjectId string
    GCP project ID that the VPC to be peered lives in. Modifying this attribute will force creation of a new resource.
    GcpRedisNetworkName string
    The name of the Redis Enterprise Cloud network to be peered
    GcpRedisProjectId string
    Identifier of the Redis Enterprise Cloud GCP project to be peered
    ProviderName string
    The cloud provider to use with the vpc peering, (either AWS or GCP). Default: ‘AWS’. Modifying this attribute will force creation of a new resource.
    Region string
    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 or failed.
    SubscriptionId string

    A valid subscription predefined in the current account. Modifying this attribute will force creation of a new resource.

    AWS ONLY:

    VpcCidr string
    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.
    VpcCidrs []string

    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:

    VpcId string
    Identifier of the VPC to be peered. Modifying this attribute will force creation of a new resource.
    awsAccountId String
    AWS account ID that the VPC to be peered lives in. Modifying this attribute will force creation of a new resource.
    awsPeeringId String
    Identifier of the AWS cloud peering
    gcpNetworkName String
    The name of the network to be peered. Modifying this attribute will force creation of a new resource.
    gcpPeeringId String
    Identifier of the cloud peering
    gcpProjectId String
    GCP project ID that the VPC to be peered lives in. Modifying this attribute will force creation of a new resource.
    gcpRedisNetworkName String
    The name of the Redis Enterprise Cloud network to be peered
    gcpRedisProjectId String
    Identifier of the Redis Enterprise Cloud GCP project to be peered
    providerName String
    The cloud provider to use with the vpc peering, (either AWS or GCP). Default: ‘AWS’. Modifying this attribute will force creation of a new resource.
    region String
    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 or failed.
    subscriptionId String

    A valid subscription predefined in the current account. Modifying this attribute will force creation of a new resource.

    AWS ONLY:

    vpcCidr String
    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.
    vpcCidrs List<String>

    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:

    vpcId String
    Identifier of the VPC to be peered. Modifying this attribute will force creation of a new resource.
    awsAccountId string
    AWS account ID that the VPC to be peered lives in. Modifying this attribute will force creation of a new resource.
    awsPeeringId string
    Identifier of the AWS cloud peering
    gcpNetworkName string
    The name of the network to be peered. Modifying this attribute will force creation of a new resource.
    gcpPeeringId string
    Identifier of the cloud peering
    gcpProjectId string
    GCP project ID that the VPC to be peered lives in. Modifying this attribute will force creation of a new resource.
    gcpRedisNetworkName string
    The name of the Redis Enterprise Cloud network to be peered
    gcpRedisProjectId string
    Identifier of the Redis Enterprise Cloud GCP project to be peered
    providerName string
    The cloud provider to use with the vpc peering, (either AWS or GCP). Default: ‘AWS’. Modifying this attribute will force creation of a new resource.
    region string
    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 or failed.
    subscriptionId string

    A valid subscription predefined in the current account. Modifying this attribute will force creation of a new resource.

    AWS ONLY:

    vpcCidr string
    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.
    vpcCidrs string[]

    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:

    vpcId string
    Identifier of the VPC to be peered. Modifying this attribute will force creation of a new resource.
    aws_account_id str
    AWS account ID that the VPC to be peered lives in. Modifying this attribute will force creation of a new resource.
    aws_peering_id str
    Identifier of the AWS cloud peering
    gcp_network_name str
    The name of the network to be peered. Modifying this attribute will force creation of a new resource.
    gcp_peering_id str
    Identifier of the cloud peering
    gcp_project_id str
    GCP project ID that the VPC to be peered lives in. Modifying this attribute will force creation of a new resource.
    gcp_redis_network_name str
    The name of the Redis Enterprise Cloud network to be peered
    gcp_redis_project_id str
    Identifier of the Redis Enterprise Cloud GCP project to be peered
    provider_name str
    The cloud provider to use with the vpc peering, (either AWS or GCP). Default: ‘AWS’. Modifying this attribute will force creation of a new resource.
    region str
    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 or failed.
    subscription_id str

    A valid subscription predefined in the current account. Modifying this attribute will force creation of a new resource.

    AWS ONLY:

    vpc_cidr str
    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 Sequence[str]

    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 str
    Identifier of the VPC to be peered. Modifying this attribute will force creation of a new resource.
    awsAccountId String
    AWS account ID that the VPC to be peered lives in. Modifying this attribute will force creation of a new resource.
    awsPeeringId String
    Identifier of the AWS cloud peering
    gcpNetworkName String
    The name of the network to be peered. Modifying this attribute will force creation of a new resource.
    gcpPeeringId String
    Identifier of the cloud peering
    gcpProjectId String
    GCP project ID that the VPC to be peered lives in. Modifying this attribute will force creation of a new resource.
    gcpRedisNetworkName String
    The name of the Redis Enterprise Cloud network to be peered
    gcpRedisProjectId String
    Identifier of the Redis Enterprise Cloud GCP project to be peered
    providerName String
    The cloud provider to use with the vpc peering, (either AWS or GCP). Default: ‘AWS’. Modifying this attribute will force creation of a new resource.
    region String
    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 or failed.
    subscriptionId String

    A valid subscription predefined in the current account. Modifying this attribute will force creation of a new resource.

    AWS ONLY:

    vpcCidr String
    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.
    vpcCidrs List<String>

    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:

    vpcId String
    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.
    rediscloud logo
    Redis Cloud v1.3.5 published on Wednesday, Dec 20, 2023 by RedisLabs