Docs Home Pulumi IaC Pulumi ESC Pulumi Cloud Packages Tutorials
  1. Packages
  2. RedisCloud
  3. API Docs
  4. Subscription
Redis Cloud v1.3.5 published on Wednesday, Dec 20, 2023 by RedisLabs
RedisLabs/pulumi-rediscloud

rediscloud.Subscription

Explore with Pulumi AI

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

    Import

    rediscloud_subscription can be imported using the ID of the subscription, e.g.

     $ pulumi import rediscloud:index/subscription:Subscription subscription-resource 12345678

    ~> Note: the creation_plan block will be ignored during imports.

    Example Usage

    using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Rediscloud = Pulumi.Rediscloud;
using Rediscloud = RedisLabs.Rediscloud;

return await Deployment.RunAsync(() => 
{
    var card = Rediscloud.GetPaymentMethod.Invoke(new()
    {
        CardType = "Visa",
    });

    var subscription_resource = new Rediscloud.Subscription("subscription-resource", new()
    {
        PaymentMethod = "credit-card",
        PaymentMethodId = card.Apply(getPaymentMethodResult => getPaymentMethodResult.Id),
        MemoryStorage = "ram",
        CloudProvider = new Rediscloud.Inputs.SubscriptionCloudProviderArgs
        {
            Provider = data.Rediscloud_cloud_account.Account.Provider_type,
            Regions = new[]
            {
                new Rediscloud.Inputs.SubscriptionCloudProviderRegionArgs
                {
                    Region = "eu-west-1",
                    MultipleAvailabilityZones = true,
                    NetworkingDeploymentCidr = "10.0.0.0/24",
                    PreferredAvailabilityZones = new[]
                    {
                        "euw1-az1, euw1-az2, euw1-az3",
                    },
                },
            },
        },
        CreationPlan = new Rediscloud.Inputs.SubscriptionCreationPlanArgs
        {
            MemoryLimitInGb = 15,
            Quantity = 1,
            Replication = true,
            ThroughputMeasurementBy = "operations-per-second",
            ThroughputMeasurementValue = 20000,
            Modules = new[]
            {
                "RedisJSON",
            },
        },
    });

});

    package main

import (
	"github.com/RedisLabs/pulumi-rediscloud/sdk/go/rediscloud"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		card, err := rediscloud.GetPaymentMethod(ctx, &rediscloud.GetPaymentMethodArgs{
			CardType: pulumi.StringRef("Visa"),
		}, nil)
		if err != nil {
			return err
		}
		_, err = rediscloud.NewSubscription(ctx, "subscription-resource", &rediscloud.SubscriptionArgs{
			PaymentMethod:   pulumi.String("credit-card"),
			PaymentMethodId: *pulumi.String(card.Id),
			MemoryStorage:   pulumi.String("ram"),
			CloudProvider: &rediscloud.SubscriptionCloudProviderArgs{
				Provider: pulumi.Any(data.Rediscloud_cloud_account.Account.Provider_type),
				Regions: rediscloud.SubscriptionCloudProviderRegionArray{
					&rediscloud.SubscriptionCloudProviderRegionArgs{
						Region:                    pulumi.String("eu-west-1"),
						MultipleAvailabilityZones: pulumi.Bool(true),
						NetworkingDeploymentCidr:  pulumi.String("10.0.0.0/24"),
						PreferredAvailabilityZones: pulumi.StringArray{
							pulumi.String("euw1-az1, euw1-az2, euw1-az3"),
						},
					},
				},
			},
			CreationPlan: &rediscloud.SubscriptionCreationPlanArgs{
				MemoryLimitInGb:            pulumi.Float64(15),
				Quantity:                   pulumi.Int(1),
				Replication:                pulumi.Bool(true),
				ThroughputMeasurementBy:    pulumi.String("operations-per-second"),
				ThroughputMeasurementValue: pulumi.Int(20000),
				Modules: pulumi.StringArray{
					pulumi.String("RedisJSON"),
				},
			},
		})
		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.RediscloudFunctions;
import com.pulumi.rediscloud.inputs.GetPaymentMethodArgs;
import com.pulumi.rediscloud.Subscription;
import com.pulumi.rediscloud.SubscriptionArgs;
import com.pulumi.rediscloud.inputs.SubscriptionCloudProviderArgs;
import com.pulumi.rediscloud.inputs.SubscriptionCreationPlanArgs;
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) {
        final var card = RediscloudFunctions.getPaymentMethod(GetPaymentMethodArgs.builder()
            .cardType("Visa")
            .build());

        var subscription_resource = new Subscription("subscription-resource", SubscriptionArgs.builder()        
            .paymentMethod("credit-card")
            .paymentMethodId(card.applyValue(getPaymentMethodResult -> getPaymentMethodResult.id()))
            .memoryStorage("ram")
            .cloudProvider(SubscriptionCloudProviderArgs.builder()
                .provider(data.rediscloud_cloud_account().account().provider_type())
                .regions(SubscriptionCloudProviderRegionArgs.builder()
                    .region("eu-west-1")
                    .multipleAvailabilityZones(true)
                    .networkingDeploymentCidr("10.0.0.0/24")
                    .preferredAvailabilityZones("euw1-az1, euw1-az2, euw1-az3")
                    .build())
                .build())
            .creationPlan(SubscriptionCreationPlanArgs.builder()
                .memoryLimitInGb(15)
                .quantity(1)
                .replication(true)
                .throughputMeasurementBy("operations-per-second")
                .throughputMeasurementValue(20000)
                .modules("RedisJSON")
                .build())
            .build());

    }
}

    import pulumi
import pulumi_rediscloud as rediscloud

card = rediscloud.get_payment_method(card_type="Visa")
subscription_resource = rediscloud.Subscription("subscription-resource",
    payment_method="credit-card",
    payment_method_id=card.id,
    memory_storage="ram",
    cloud_provider=rediscloud.SubscriptionCloudProviderArgs(
        provider=data["rediscloud_cloud_account"]["account"]["provider_type"],
        regions=[rediscloud.SubscriptionCloudProviderRegionArgs(
            region="eu-west-1",
            multiple_availability_zones=True,
            networking_deployment_cidr="10.0.0.0/24",
            preferred_availability_zones=["euw1-az1, euw1-az2, euw1-az3"],
        )],
    ),
    creation_plan=rediscloud.SubscriptionCreationPlanArgs(
        memory_limit_in_gb=15,
        quantity=1,
        replication=True,
        throughput_measurement_by="operations-per-second",
        throughput_measurement_value=20000,
        modules=["RedisJSON"],
    ))

    import * as pulumi from "@pulumi/pulumi";
import * as rediscloud from "@pulumi/rediscloud";
import * as rediscloud from "@rediscloud/pulumi-rediscloud";

const card = rediscloud.getPaymentMethod({
    cardType: "Visa",
});
const subscription_resource = new rediscloud.Subscription("subscription-resource", {
    paymentMethod: "credit-card",
    paymentMethodId: card.then(card => card.id),
    memoryStorage: "ram",
    cloudProvider: {
        provider: data.rediscloud_cloud_account.account.provider_type,
        regions: [{
            region: "eu-west-1",
            multipleAvailabilityZones: true,
            networkingDeploymentCidr: "10.0.0.0/24",
            preferredAvailabilityZones: ["euw1-az1, euw1-az2, euw1-az3"],
        }],
    },
    creationPlan: {
        memoryLimitInGb: 15,
        quantity: 1,
        replication: true,
        throughputMeasurementBy: "operations-per-second",
        throughputMeasurementValue: 20000,
        modules: ["RedisJSON"],
    },
});

    resources:
  subscription-resource:
    type: rediscloud:Subscription
    properties:
      paymentMethod: credit-card
      paymentMethodId: ${card.id}
      memoryStorage: ram
      cloudProvider:
        provider: ${data.rediscloud_cloud_account.account.provider_type}
        regions:
          - region: eu-west-1
            multipleAvailabilityZones: true
            networkingDeploymentCidr: 10.0.0.0/24
            preferredAvailabilityZones:
              - euw1-az1, euw1-az2, euw1-az3
      creationPlan:
        memoryLimitInGb: 15
        quantity: 1
        replication: true
        throughputMeasurementBy: operations-per-second
        throughputMeasurementValue: 20000
        modules:
          - RedisJSON
variables:
  card:
    fn::invoke:
      Function: rediscloud:getPaymentMethod
      Arguments:
        cardType: Visa

    Create Subscription Resource

    Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.

    Constructor syntax

    new Subscription(name: string, args: SubscriptionArgs, opts?: CustomResourceOptions);
    @overload
def Subscription(resource_name: str,
                 args: SubscriptionArgs,
                 opts: Optional[ResourceOptions] = None)

@overload
def Subscription(resource_name: str,
                 opts: Optional[ResourceOptions] = None,
                 cloud_provider: Optional[SubscriptionCloudProviderArgs] = None,
                 allowlist: Optional[SubscriptionAllowlistArgs] = None,
                 creation_plan: Optional[SubscriptionCreationPlanArgs] = None,
                 memory_storage: Optional[str] = None,
                 name: Optional[str] = None,
                 payment_method: Optional[str] = None,
                 payment_method_id: Optional[str] = None)
    func NewSubscription(ctx *Context, name string, args SubscriptionArgs, opts ...ResourceOption) (*Subscription, error)
    public Subscription(string name, SubscriptionArgs args, CustomResourceOptions? opts = null)
    public Subscription(String name, SubscriptionArgs args)
public Subscription(String name, SubscriptionArgs args, CustomResourceOptions options)

    type: rediscloud:Subscription
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 SubscriptionArgs
    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 SubscriptionArgs
    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 SubscriptionArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args SubscriptionArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args SubscriptionArgs
    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 subscriptionResource = new Rediscloud.Subscription("subscriptionResource", new()
{
    CloudProvider = new Rediscloud.Inputs.SubscriptionCloudProviderArgs
    {
        Regions = new[]
        {
            new Rediscloud.Inputs.SubscriptionCloudProviderRegionArgs
            {
                NetworkingDeploymentCidr = "string",
                Region = "string",
                MultipleAvailabilityZones = false,
                NetworkingVpcId = "string",
                Networks = new[]
                {
                    new Rediscloud.Inputs.SubscriptionCloudProviderRegionNetworkArgs
                    {
                        NetworkingDeploymentCidr = "string",
                        NetworkingSubnetId = "string",
                        NetworkingVpcId = "string",
                    },
                },
                PreferredAvailabilityZones = new[]
                {
                    "string",
                },
            },
        },
        CloudAccountId = "string",
        Provider = "string",
    },
    Allowlist = new Rediscloud.Inputs.SubscriptionAllowlistArgs
    {
        SecurityGroupIds = new[]
        {
            "string",
        },
        Cidrs = new[]
        {
            "string",
        },
    },
    CreationPlan = new Rediscloud.Inputs.SubscriptionCreationPlanArgs
    {
        MemoryLimitInGb = 0,
        Quantity = 0,
        Replication = false,
        ThroughputMeasurementBy = "string",
        ThroughputMeasurementValue = 0,
        AverageItemSizeInBytes = 0,
        Modules = new[]
        {
            "string",
        },
        SupportOssClusterApi = false,
    },
    MemoryStorage = "string",
    Name = "string",
    PaymentMethod = "string",
    PaymentMethodId = "string",
});

    example, err := rediscloud.NewSubscription(ctx, "subscriptionResource", &rediscloud.SubscriptionArgs{
	CloudProvider: &rediscloud.SubscriptionCloudProviderArgs{
		Regions: rediscloud.SubscriptionCloudProviderRegionArray{
			&rediscloud.SubscriptionCloudProviderRegionArgs{
				NetworkingDeploymentCidr:  pulumi.String("string"),
				Region:                    pulumi.String("string"),
				MultipleAvailabilityZones: pulumi.Bool(false),
				NetworkingVpcId:           pulumi.String("string"),
				Networks: rediscloud.SubscriptionCloudProviderRegionNetworkArray{
					&rediscloud.SubscriptionCloudProviderRegionNetworkArgs{
						NetworkingDeploymentCidr: pulumi.String("string"),
						NetworkingSubnetId:       pulumi.String("string"),
						NetworkingVpcId:          pulumi.String("string"),
					},
				},
				PreferredAvailabilityZones: pulumi.StringArray{
					pulumi.String("string"),
				},
			},
		},
		CloudAccountId: pulumi.String("string"),
		Provider:       pulumi.String("string"),
	},
	Allowlist: &rediscloud.SubscriptionAllowlistArgs{
		SecurityGroupIds: pulumi.StringArray{
			pulumi.String("string"),
		},
		Cidrs: pulumi.StringArray{
			pulumi.String("string"),
		},
	},
	CreationPlan: &rediscloud.SubscriptionCreationPlanArgs{
		MemoryLimitInGb:            pulumi.Float64(0),
		Quantity:                   pulumi.Int(0),
		Replication:                pulumi.Bool(false),
		ThroughputMeasurementBy:    pulumi.String("string"),
		ThroughputMeasurementValue: pulumi.Int(0),
		AverageItemSizeInBytes:     pulumi.Int(0),
		Modules: pulumi.StringArray{
			pulumi.String("string"),
		},
		SupportOssClusterApi: pulumi.Bool(false),
	},
	MemoryStorage:   pulumi.String("string"),
	Name:            pulumi.String("string"),
	PaymentMethod:   pulumi.String("string"),
	PaymentMethodId: pulumi.String("string"),
})

    var subscriptionResource = new Subscription("subscriptionResource", SubscriptionArgs.builder()
    .cloudProvider(SubscriptionCloudProviderArgs.builder()
        .regions(SubscriptionCloudProviderRegionArgs.builder()
            .networkingDeploymentCidr("string")
            .region("string")
            .multipleAvailabilityZones(false)
            .networkingVpcId("string")
            .networks(SubscriptionCloudProviderRegionNetworkArgs.builder()
                .networkingDeploymentCidr("string")
                .networkingSubnetId("string")
                .networkingVpcId("string")
                .build())
            .preferredAvailabilityZones("string")
            .build())
        .cloudAccountId("string")
        .provider("string")
        .build())
    .allowlist(SubscriptionAllowlistArgs.builder()
        .securityGroupIds("string")
        .cidrs("string")
        .build())
    .creationPlan(SubscriptionCreationPlanArgs.builder()
        .memoryLimitInGb(0)
        .quantity(0)
        .replication(false)
        .throughputMeasurementBy("string")
        .throughputMeasurementValue(0)
        .averageItemSizeInBytes(0)
        .modules("string")
        .supportOssClusterApi(false)
        .build())
    .memoryStorage("string")
    .name("string")
    .paymentMethod("string")
    .paymentMethodId("string")
    .build());

    subscription_resource = rediscloud.Subscription("subscriptionResource",
    cloud_provider={
        "regions": [{
            "networking_deployment_cidr": "string",
            "region": "string",
            "multiple_availability_zones": False,
            "networking_vpc_id": "string",
            "networks": [{
                "networking_deployment_cidr": "string",
                "networking_subnet_id": "string",
                "networking_vpc_id": "string",
            }],
            "preferred_availability_zones": ["string"],
        }],
        "cloud_account_id": "string",
        "provider": "string",
    },
    allowlist={
        "security_group_ids": ["string"],
        "cidrs": ["string"],
    },
    creation_plan={
        "memory_limit_in_gb": 0,
        "quantity": 0,
        "replication": False,
        "throughput_measurement_by": "string",
        "throughput_measurement_value": 0,
        "average_item_size_in_bytes": 0,
        "modules": ["string"],
        "support_oss_cluster_api": False,
    },
    memory_storage="string",
    name="string",
    payment_method="string",
    payment_method_id="string")

    const subscriptionResource = new rediscloud.Subscription("subscriptionResource", {
    cloudProvider: {
        regions: [{
            networkingDeploymentCidr: "string",
            region: "string",
            multipleAvailabilityZones: false,
            networkingVpcId: "string",
            networks: [{
                networkingDeploymentCidr: "string",
                networkingSubnetId: "string",
                networkingVpcId: "string",
            }],
            preferredAvailabilityZones: ["string"],
        }],
        cloudAccountId: "string",
        provider: "string",
    },
    allowlist: {
        securityGroupIds: ["string"],
        cidrs: ["string"],
    },
    creationPlan: {
        memoryLimitInGb: 0,
        quantity: 0,
        replication: false,
        throughputMeasurementBy: "string",
        throughputMeasurementValue: 0,
        averageItemSizeInBytes: 0,
        modules: ["string"],
        supportOssClusterApi: false,
    },
    memoryStorage: "string",
    name: "string",
    paymentMethod: "string",
    paymentMethodId: "string",
});

    type: rediscloud:Subscription
properties:
    allowlist:
        cidrs:
            - string
        securityGroupIds:
            - string
    cloudProvider:
        cloudAccountId: string
        provider: string
        regions:
            - multipleAvailabilityZones: false
              networkingDeploymentCidr: string
              networkingVpcId: string
              networks:
                - networkingDeploymentCidr: string
                  networkingSubnetId: string
                  networkingVpcId: string
              preferredAvailabilityZones:
                - string
              region: string
    creationPlan:
        averageItemSizeInBytes: 0
        memoryLimitInGb: 0
        modules:
            - string
        quantity: 0
        replication: false
        supportOssClusterApi: false
        throughputMeasurementBy: string
        throughputMeasurementValue: 0
    memoryStorage: string
    name: string
    paymentMethod: string
    paymentMethodId: string

    Subscription 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 Subscription resource accepts the following input properties:

    CloudProvider RedisLabs.Rediscloud.Inputs.SubscriptionCloudProvider
    A cloud provider object, documented below. Modifying this attribute will force creation of a new resource.
    Allowlist RedisLabs.Rediscloud.Inputs.SubscriptionAllowlist
    An allowlist object, documented below
    CreationPlan RedisLabs.Rediscloud.Inputs.SubscriptionCreationPlan
    A creation plan object, documented below
    MemoryStorage string
    Memory storage preference: either ‘ram’ or a combination of ‘ram-and-flash’. Default: ‘ram’. Modifying this attribute will force creation of a new resource.
    Name string
    A meaningful name to identify the subscription
    PaymentMethod string
    The payment method for the requested subscription, (either credit-card or marketplace). If credit-card is specified, payment_method_id must be defined. Default: 'credit-card'. Modifying this attribute will force creation of a new resource.
    PaymentMethodId string
    A valid payment method pre-defined in the current account. This value is Optional for AWS/GCP Marketplace accounts, but Required for all other account types
    CloudProvider SubscriptionCloudProviderArgs
    A cloud provider object, documented below. Modifying this attribute will force creation of a new resource.
    Allowlist SubscriptionAllowlistArgs
    An allowlist object, documented below
    CreationPlan SubscriptionCreationPlanArgs
    A creation plan object, documented below
    MemoryStorage string
    Memory storage preference: either ‘ram’ or a combination of ‘ram-and-flash’. Default: ‘ram’. Modifying this attribute will force creation of a new resource.
    Name string
    A meaningful name to identify the subscription
    PaymentMethod string
    The payment method for the requested subscription, (either credit-card or marketplace). If credit-card is specified, payment_method_id must be defined. Default: 'credit-card'. Modifying this attribute will force creation of a new resource.
    PaymentMethodId string
    A valid payment method pre-defined in the current account. This value is Optional for AWS/GCP Marketplace accounts, but Required for all other account types
    cloudProvider SubscriptionCloudProvider
    A cloud provider object, documented below. Modifying this attribute will force creation of a new resource.
    allowlist SubscriptionAllowlist
    An allowlist object, documented below
    creationPlan SubscriptionCreationPlan
    A creation plan object, documented below
    memoryStorage String
    Memory storage preference: either ‘ram’ or a combination of ‘ram-and-flash’. Default: ‘ram’. Modifying this attribute will force creation of a new resource.
    name String
    A meaningful name to identify the subscription
    paymentMethod String
    The payment method for the requested subscription, (either credit-card or marketplace). If credit-card is specified, payment_method_id must be defined. Default: 'credit-card'. Modifying this attribute will force creation of a new resource.
    paymentMethodId String
    A valid payment method pre-defined in the current account. This value is Optional for AWS/GCP Marketplace accounts, but Required for all other account types
    cloudProvider SubscriptionCloudProvider
    A cloud provider object, documented below. Modifying this attribute will force creation of a new resource.
    allowlist SubscriptionAllowlist
    An allowlist object, documented below
    creationPlan SubscriptionCreationPlan
    A creation plan object, documented below
    memoryStorage string
    Memory storage preference: either ‘ram’ or a combination of ‘ram-and-flash’. Default: ‘ram’. Modifying this attribute will force creation of a new resource.
    name string
    A meaningful name to identify the subscription
    paymentMethod string
    The payment method for the requested subscription, (either credit-card or marketplace). If credit-card is specified, payment_method_id must be defined. Default: 'credit-card'. Modifying this attribute will force creation of a new resource.
    paymentMethodId string
    A valid payment method pre-defined in the current account. This value is Optional for AWS/GCP Marketplace accounts, but Required for all other account types
    cloud_provider SubscriptionCloudProviderArgs
    A cloud provider object, documented below. Modifying this attribute will force creation of a new resource.
    allowlist SubscriptionAllowlistArgs
    An allowlist object, documented below
    creation_plan SubscriptionCreationPlanArgs
    A creation plan object, documented below
    memory_storage str
    Memory storage preference: either ‘ram’ or a combination of ‘ram-and-flash’. Default: ‘ram’. Modifying this attribute will force creation of a new resource.
    name str
    A meaningful name to identify the subscription
    payment_method str
    The payment method for the requested subscription, (either credit-card or marketplace). If credit-card is specified, payment_method_id must be defined. Default: 'credit-card'. Modifying this attribute will force creation of a new resource.
    payment_method_id str
    A valid payment method pre-defined in the current account. This value is Optional for AWS/GCP Marketplace accounts, but Required for all other account types
    cloudProvider Property Map
    A cloud provider object, documented below. Modifying this attribute will force creation of a new resource.
    allowlist Property Map
    An allowlist object, documented below
    creationPlan Property Map
    A creation plan object, documented below
    memoryStorage String
    Memory storage preference: either ‘ram’ or a combination of ‘ram-and-flash’. Default: ‘ram’. Modifying this attribute will force creation of a new resource.
    name String
    A meaningful name to identify the subscription
    paymentMethod String
    The payment method for the requested subscription, (either credit-card or marketplace). If credit-card is specified, payment_method_id must be defined. Default: 'credit-card'. Modifying this attribute will force creation of a new resource.
    paymentMethodId String
    A valid payment method pre-defined in the current account. This value is Optional for AWS/GCP Marketplace accounts, but Required for all other account types

    Outputs

    All input properties are implicitly available as output properties. Additionally, the Subscription resource produces the following output properties:

    Id string
    The provider-assigned unique ID for this managed resource.
    Id string
    The provider-assigned unique ID for this managed resource.
    id String
    The provider-assigned unique ID for this managed resource.
    id string
    The provider-assigned unique ID for this managed resource.
    id str
    The provider-assigned unique ID for this managed resource.
    id String
    The provider-assigned unique ID for this managed resource.

    Look up Existing Subscription Resource

    Get an existing Subscription 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?: SubscriptionState, opts?: CustomResourceOptions): Subscription
    @staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        allowlist: Optional[SubscriptionAllowlistArgs] = None,
        cloud_provider: Optional[SubscriptionCloudProviderArgs] = None,
        creation_plan: Optional[SubscriptionCreationPlanArgs] = None,
        memory_storage: Optional[str] = None,
        name: Optional[str] = None,
        payment_method: Optional[str] = None,
        payment_method_id: Optional[str] = None) -> Subscription
    func GetSubscription(ctx *Context, name string, id IDInput, state *SubscriptionState, opts ...ResourceOption) (*Subscription, error)
    public static Subscription Get(string name, Input<string> id, SubscriptionState? state, CustomResourceOptions? opts = null)
    public static Subscription get(String name, Output<String> id, SubscriptionState 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:
    Allowlist RedisLabs.Rediscloud.Inputs.SubscriptionAllowlist
    An allowlist object, documented below
    CloudProvider RedisLabs.Rediscloud.Inputs.SubscriptionCloudProvider
    A cloud provider object, documented below. Modifying this attribute will force creation of a new resource.
    CreationPlan RedisLabs.Rediscloud.Inputs.SubscriptionCreationPlan
    A creation plan object, documented below
    MemoryStorage string
    Memory storage preference: either ‘ram’ or a combination of ‘ram-and-flash’. Default: ‘ram’. Modifying this attribute will force creation of a new resource.
    Name string
    A meaningful name to identify the subscription
    PaymentMethod string
    The payment method for the requested subscription, (either credit-card or marketplace). If credit-card is specified, payment_method_id must be defined. Default: 'credit-card'. Modifying this attribute will force creation of a new resource.
    PaymentMethodId string
    A valid payment method pre-defined in the current account. This value is Optional for AWS/GCP Marketplace accounts, but Required for all other account types
    Allowlist SubscriptionAllowlistArgs
    An allowlist object, documented below
    CloudProvider SubscriptionCloudProviderArgs
    A cloud provider object, documented below. Modifying this attribute will force creation of a new resource.
    CreationPlan SubscriptionCreationPlanArgs
    A creation plan object, documented below
    MemoryStorage string
    Memory storage preference: either ‘ram’ or a combination of ‘ram-and-flash’. Default: ‘ram’. Modifying this attribute will force creation of a new resource.
    Name string
    A meaningful name to identify the subscription
    PaymentMethod string
    The payment method for the requested subscription, (either credit-card or marketplace). If credit-card is specified, payment_method_id must be defined. Default: 'credit-card'. Modifying this attribute will force creation of a new resource.
    PaymentMethodId string
    A valid payment method pre-defined in the current account. This value is Optional for AWS/GCP Marketplace accounts, but Required for all other account types
    allowlist SubscriptionAllowlist
    An allowlist object, documented below
    cloudProvider SubscriptionCloudProvider
    A cloud provider object, documented below. Modifying this attribute will force creation of a new resource.
    creationPlan SubscriptionCreationPlan
    A creation plan object, documented below
    memoryStorage String
    Memory storage preference: either ‘ram’ or a combination of ‘ram-and-flash’. Default: ‘ram’. Modifying this attribute will force creation of a new resource.
    name String
    A meaningful name to identify the subscription
    paymentMethod String
    The payment method for the requested subscription, (either credit-card or marketplace). If credit-card is specified, payment_method_id must be defined. Default: 'credit-card'. Modifying this attribute will force creation of a new resource.
    paymentMethodId String
    A valid payment method pre-defined in the current account. This value is Optional for AWS/GCP Marketplace accounts, but Required for all other account types
    allowlist SubscriptionAllowlist
    An allowlist object, documented below
    cloudProvider SubscriptionCloudProvider
    A cloud provider object, documented below. Modifying this attribute will force creation of a new resource.
    creationPlan SubscriptionCreationPlan
    A creation plan object, documented below
    memoryStorage string
    Memory storage preference: either ‘ram’ or a combination of ‘ram-and-flash’. Default: ‘ram’. Modifying this attribute will force creation of a new resource.
    name string
    A meaningful name to identify the subscription
    paymentMethod string
    The payment method for the requested subscription, (either credit-card or marketplace). If credit-card is specified, payment_method_id must be defined. Default: 'credit-card'. Modifying this attribute will force creation of a new resource.
    paymentMethodId string
    A valid payment method pre-defined in the current account. This value is Optional for AWS/GCP Marketplace accounts, but Required for all other account types
    allowlist SubscriptionAllowlistArgs
    An allowlist object, documented below
    cloud_provider SubscriptionCloudProviderArgs
    A cloud provider object, documented below. Modifying this attribute will force creation of a new resource.
    creation_plan SubscriptionCreationPlanArgs
    A creation plan object, documented below
    memory_storage str
    Memory storage preference: either ‘ram’ or a combination of ‘ram-and-flash’. Default: ‘ram’. Modifying this attribute will force creation of a new resource.
    name str
    A meaningful name to identify the subscription
    payment_method str
    The payment method for the requested subscription, (either credit-card or marketplace). If credit-card is specified, payment_method_id must be defined. Default: 'credit-card'. Modifying this attribute will force creation of a new resource.
    payment_method_id str
    A valid payment method pre-defined in the current account. This value is Optional for AWS/GCP Marketplace accounts, but Required for all other account types
    allowlist Property Map
    An allowlist object, documented below
    cloudProvider Property Map
    A cloud provider object, documented below. Modifying this attribute will force creation of a new resource.
    creationPlan Property Map
    A creation plan object, documented below
    memoryStorage String
    Memory storage preference: either ‘ram’ or a combination of ‘ram-and-flash’. Default: ‘ram’. Modifying this attribute will force creation of a new resource.
    name String
    A meaningful name to identify the subscription
    paymentMethod String
    The payment method for the requested subscription, (either credit-card or marketplace). If credit-card is specified, payment_method_id must be defined. Default: 'credit-card'. Modifying this attribute will force creation of a new resource.
    paymentMethodId String
    A valid payment method pre-defined in the current account. This value is Optional for AWS/GCP Marketplace accounts, but Required for all other account types

    Supporting Types

    SubscriptionAllowlist, SubscriptionAllowlistArgs

    SecurityGroupIds List<string>
    Set of security groups that are allowed to access the databases associated with this subscription
    Cidrs List<string>

    Set of CIDR ranges that are allowed to access the databases associated with this subscription

    Note: allowlist is only available when you run on your own cloud account, and not one that Redis provided (i.e cloud_account_id != 1)

    SecurityGroupIds []string
    Set of security groups that are allowed to access the databases associated with this subscription
    Cidrs []string

    Set of CIDR ranges that are allowed to access the databases associated with this subscription

    Note: allowlist is only available when you run on your own cloud account, and not one that Redis provided (i.e cloud_account_id != 1)

    securityGroupIds List<String>
    Set of security groups that are allowed to access the databases associated with this subscription
    cidrs List<String>

    Set of CIDR ranges that are allowed to access the databases associated with this subscription

    Note: allowlist is only available when you run on your own cloud account, and not one that Redis provided (i.e cloud_account_id != 1)

    securityGroupIds string[]
    Set of security groups that are allowed to access the databases associated with this subscription
    cidrs string[]

    Set of CIDR ranges that are allowed to access the databases associated with this subscription

    Note: allowlist is only available when you run on your own cloud account, and not one that Redis provided (i.e cloud_account_id != 1)

    security_group_ids Sequence[str]
    Set of security groups that are allowed to access the databases associated with this subscription
    cidrs Sequence[str]

    Set of CIDR ranges that are allowed to access the databases associated with this subscription

    Note: allowlist is only available when you run on your own cloud account, and not one that Redis provided (i.e cloud_account_id != 1)

    securityGroupIds List<String>
    Set of security groups that are allowed to access the databases associated with this subscription
    cidrs List<String>

    Set of CIDR ranges that are allowed to access the databases associated with this subscription

    Note: allowlist is only available when you run on your own cloud account, and not one that Redis provided (i.e cloud_account_id != 1)

    SubscriptionCloudProvider, SubscriptionCloudProviderArgs

    Regions List<RedisLabs.Rediscloud.Inputs.SubscriptionCloudProviderRegion>
    A region object, documented below. Modifying this attribute will force creation of a new resource.
    CloudAccountId string
    Cloud account identifier. Default: Redis Labs internal cloud account. Modifying this attribute will force creation of a new resource. (using Cloud Account ID = 1 implies using Redis Labs internal cloud account). Note that a GCP subscription can be created only with Redis Labs internal cloud account
    Provider string
    The cloud provider to use with the subscription, (either AWS or GCP). Default: ‘AWS’. Modifying this attribute will force creation of a new resource.
    Regions []SubscriptionCloudProviderRegion
    A region object, documented below. Modifying this attribute will force creation of a new resource.
    CloudAccountId string
    Cloud account identifier. Default: Redis Labs internal cloud account. Modifying this attribute will force creation of a new resource. (using Cloud Account ID = 1 implies using Redis Labs internal cloud account). Note that a GCP subscription can be created only with Redis Labs internal cloud account
    Provider string
    The cloud provider to use with the subscription, (either AWS or GCP). Default: ‘AWS’. Modifying this attribute will force creation of a new resource.
    regions List<SubscriptionCloudProviderRegion>
    A region object, documented below. Modifying this attribute will force creation of a new resource.
    cloudAccountId String
    Cloud account identifier. Default: Redis Labs internal cloud account. Modifying this attribute will force creation of a new resource. (using Cloud Account ID = 1 implies using Redis Labs internal cloud account). Note that a GCP subscription can be created only with Redis Labs internal cloud account
    provider String
    The cloud provider to use with the subscription, (either AWS or GCP). Default: ‘AWS’. Modifying this attribute will force creation of a new resource.
    regions SubscriptionCloudProviderRegion[]
    A region object, documented below. Modifying this attribute will force creation of a new resource.
    cloudAccountId string
    Cloud account identifier. Default: Redis Labs internal cloud account. Modifying this attribute will force creation of a new resource. (using Cloud Account ID = 1 implies using Redis Labs internal cloud account). Note that a GCP subscription can be created only with Redis Labs internal cloud account
    provider string
    The cloud provider to use with the subscription, (either AWS or GCP). Default: ‘AWS’. Modifying this attribute will force creation of a new resource.
    regions Sequence[SubscriptionCloudProviderRegion]
    A region object, documented below. Modifying this attribute will force creation of a new resource.
    cloud_account_id str
    Cloud account identifier. Default: Redis Labs internal cloud account. Modifying this attribute will force creation of a new resource. (using Cloud Account ID = 1 implies using Redis Labs internal cloud account). Note that a GCP subscription can be created only with Redis Labs internal cloud account
    provider str
    The cloud provider to use with the subscription, (either AWS or GCP). Default: ‘AWS’. Modifying this attribute will force creation of a new resource.
    regions List<Property Map>
    A region object, documented below. Modifying this attribute will force creation of a new resource.
    cloudAccountId String
    Cloud account identifier. Default: Redis Labs internal cloud account. Modifying this attribute will force creation of a new resource. (using Cloud Account ID = 1 implies using Redis Labs internal cloud account). Note that a GCP subscription can be created only with Redis Labs internal cloud account
    provider String
    The cloud provider to use with the subscription, (either AWS or GCP). Default: ‘AWS’. Modifying this attribute will force creation of a new resource.

    SubscriptionCloudProviderRegion, SubscriptionCloudProviderRegionArgs

    NetworkingDeploymentCidr string
    Deployment CIDR mask. The total number of bits must be 24 (x.x.x.x/24). Modifying this attribute will force creation of a new resource.
    Region string
    Deployment region as defined by cloud provider. Modifying this attribute will force creation of a new resource.
    MultipleAvailabilityZones bool
    Support deployment on multiple availability zones within the selected region. Default: ‘false’. Modifying this attribute will force creation of a new resource.
    NetworkingVpcId string
    Either an existing VPC Id (already exists in the specific region) or create a new VPC (if no VPC is specified). VPC Identifier must be in a valid format (for example: ‘vpc-0125be68a4986384ad’) and existing within the hosting account. Modifying this attribute will force creation of a new resource.
    Networks List<RedisLabs.Rediscloud.Inputs.SubscriptionCloudProviderRegionNetwork>
    List of generated network configuration
    PreferredAvailabilityZones List<string>
    NetworkingDeploymentCidr string
    Deployment CIDR mask. The total number of bits must be 24 (x.x.x.x/24). Modifying this attribute will force creation of a new resource.
    Region string
    Deployment region as defined by cloud provider. Modifying this attribute will force creation of a new resource.
    MultipleAvailabilityZones bool
    Support deployment on multiple availability zones within the selected region. Default: ‘false’. Modifying this attribute will force creation of a new resource.
    NetworkingVpcId string
    Either an existing VPC Id (already exists in the specific region) or create a new VPC (if no VPC is specified). VPC Identifier must be in a valid format (for example: ‘vpc-0125be68a4986384ad’) and existing within the hosting account. Modifying this attribute will force creation of a new resource.
    Networks []SubscriptionCloudProviderRegionNetwork
    List of generated network configuration
    PreferredAvailabilityZones []string
    networkingDeploymentCidr String
    Deployment CIDR mask. The total number of bits must be 24 (x.x.x.x/24). Modifying this attribute will force creation of a new resource.
    region String
    Deployment region as defined by cloud provider. Modifying this attribute will force creation of a new resource.
    multipleAvailabilityZones Boolean
    Support deployment on multiple availability zones within the selected region. Default: ‘false’. Modifying this attribute will force creation of a new resource.
    networkingVpcId String
    Either an existing VPC Id (already exists in the specific region) or create a new VPC (if no VPC is specified). VPC Identifier must be in a valid format (for example: ‘vpc-0125be68a4986384ad’) and existing within the hosting account. Modifying this attribute will force creation of a new resource.
    networks List<SubscriptionCloudProviderRegionNetwork>
    List of generated network configuration
    preferredAvailabilityZones List<String>
    networkingDeploymentCidr string
    Deployment CIDR mask. The total number of bits must be 24 (x.x.x.x/24). Modifying this attribute will force creation of a new resource.
    region string
    Deployment region as defined by cloud provider. Modifying this attribute will force creation of a new resource.
    multipleAvailabilityZones boolean
    Support deployment on multiple availability zones within the selected region. Default: ‘false’. Modifying this attribute will force creation of a new resource.
    networkingVpcId string
    Either an existing VPC Id (already exists in the specific region) or create a new VPC (if no VPC is specified). VPC Identifier must be in a valid format (for example: ‘vpc-0125be68a4986384ad’) and existing within the hosting account. Modifying this attribute will force creation of a new resource.
    networks SubscriptionCloudProviderRegionNetwork[]
    List of generated network configuration
    preferredAvailabilityZones string[]
    networking_deployment_cidr str
    Deployment CIDR mask. The total number of bits must be 24 (x.x.x.x/24). Modifying this attribute will force creation of a new resource.
    region str
    Deployment region as defined by cloud provider. Modifying this attribute will force creation of a new resource.
    multiple_availability_zones bool
    Support deployment on multiple availability zones within the selected region. Default: ‘false’. Modifying this attribute will force creation of a new resource.
    networking_vpc_id str
    Either an existing VPC Id (already exists in the specific region) or create a new VPC (if no VPC is specified). VPC Identifier must be in a valid format (for example: ‘vpc-0125be68a4986384ad’) and existing within the hosting account. Modifying this attribute will force creation of a new resource.
    networks Sequence[SubscriptionCloudProviderRegionNetwork]
    List of generated network configuration
    preferred_availability_zones Sequence[str]
    networkingDeploymentCidr String
    Deployment CIDR mask. The total number of bits must be 24 (x.x.x.x/24). Modifying this attribute will force creation of a new resource.
    region String
    Deployment region as defined by cloud provider. Modifying this attribute will force creation of a new resource.
    multipleAvailabilityZones Boolean
    Support deployment on multiple availability zones within the selected region. Default: ‘false’. Modifying this attribute will force creation of a new resource.
    networkingVpcId String
    Either an existing VPC Id (already exists in the specific region) or create a new VPC (if no VPC is specified). VPC Identifier must be in a valid format (for example: ‘vpc-0125be68a4986384ad’) and existing within the hosting account. Modifying this attribute will force creation of a new resource.
    networks List<Property Map>
    List of generated network configuration
    preferredAvailabilityZones List<String>

    SubscriptionCloudProviderRegionNetwork, SubscriptionCloudProviderRegionNetworkArgs

    NetworkingDeploymentCidr string
    Deployment CIDR mask. The total number of bits must be 24 (x.x.x.x/24). Modifying this attribute will force creation of a new resource.
    NetworkingSubnetId string
    The subnet that the subscription deploys into
    NetworkingVpcId string
    Either an existing VPC Id (already exists in the specific region) or create a new VPC (if no VPC is specified). VPC Identifier must be in a valid format (for example: ‘vpc-0125be68a4986384ad’) and existing within the hosting account. Modifying this attribute will force creation of a new resource.
    NetworkingDeploymentCidr string
    Deployment CIDR mask. The total number of bits must be 24 (x.x.x.x/24). Modifying this attribute will force creation of a new resource.
    NetworkingSubnetId string
    The subnet that the subscription deploys into
    NetworkingVpcId string
    Either an existing VPC Id (already exists in the specific region) or create a new VPC (if no VPC is specified). VPC Identifier must be in a valid format (for example: ‘vpc-0125be68a4986384ad’) and existing within the hosting account. Modifying this attribute will force creation of a new resource.
    networkingDeploymentCidr String
    Deployment CIDR mask. The total number of bits must be 24 (x.x.x.x/24). Modifying this attribute will force creation of a new resource.
    networkingSubnetId String
    The subnet that the subscription deploys into
    networkingVpcId String
    Either an existing VPC Id (already exists in the specific region) or create a new VPC (if no VPC is specified). VPC Identifier must be in a valid format (for example: ‘vpc-0125be68a4986384ad’) and existing within the hosting account. Modifying this attribute will force creation of a new resource.
    networkingDeploymentCidr string
    Deployment CIDR mask. The total number of bits must be 24 (x.x.x.x/24). Modifying this attribute will force creation of a new resource.
    networkingSubnetId string
    The subnet that the subscription deploys into
    networkingVpcId string
    Either an existing VPC Id (already exists in the specific region) or create a new VPC (if no VPC is specified). VPC Identifier must be in a valid format (for example: ‘vpc-0125be68a4986384ad’) and existing within the hosting account. Modifying this attribute will force creation of a new resource.
    networking_deployment_cidr str
    Deployment CIDR mask. The total number of bits must be 24 (x.x.x.x/24). Modifying this attribute will force creation of a new resource.
    networking_subnet_id str
    The subnet that the subscription deploys into
    networking_vpc_id str
    Either an existing VPC Id (already exists in the specific region) or create a new VPC (if no VPC is specified). VPC Identifier must be in a valid format (for example: ‘vpc-0125be68a4986384ad’) and existing within the hosting account. Modifying this attribute will force creation of a new resource.
    networkingDeploymentCidr String
    Deployment CIDR mask. The total number of bits must be 24 (x.x.x.x/24). Modifying this attribute will force creation of a new resource.
    networkingSubnetId String
    The subnet that the subscription deploys into
    networkingVpcId String
    Either an existing VPC Id (already exists in the specific region) or create a new VPC (if no VPC is specified). VPC Identifier must be in a valid format (for example: ‘vpc-0125be68a4986384ad’) and existing within the hosting account. Modifying this attribute will force creation of a new resource.

    SubscriptionCreationPlan, SubscriptionCreationPlanArgs

    MemoryLimitInGb double
    Maximum memory usage that will be used for your largest planned database.
    Quantity int
    The planned number of databases in the subscription
    Replication bool
    Databases replication. Default: ‘true’
    ThroughputMeasurementBy string
    Throughput measurement method that will be used by your databases, (either ‘number-of-shards’ or ‘operations-per-second’)
    ThroughputMeasurementValue int
    Throughput value that will be used by your databases (as applies to selected measurement method). The value needs to be the maximum throughput measurement value defined in one of your databases
    AverageItemSizeInBytes int

    Relevant only to ram-and-flash clusters Estimated average size (measured in bytes) of the items stored in the database. The value needs to be the maximum average item size defined in one of your databases. Default: 1000

    ~>Note: If the number of modules exceeds the quantity then additional creation-plan databases will be created with the modules defined in the modules block.

    Note: If changes are made to attributes in the subscription which require the subscription to be recreated (such as memory_storage, cloud_provider or payment_method), the creation_plan will need to be defined in order to change these attributes. This is because the creation_plan is always required when a subscription is created.

    Modules List<string>
    a list of modules that will be used by the databases in this subscription. Not currently compatible with ‘ram-and-flash’ memory storage. Example: modules = ["RedisJSON", RedisBloom"]
    SupportOssClusterApi bool
    Support Redis open-source (OSS) Cluster API. Default: ‘false’
    MemoryLimitInGb float64
    Maximum memory usage that will be used for your largest planned database.
    Quantity int
    The planned number of databases in the subscription
    Replication bool
    Databases replication. Default: ‘true’
    ThroughputMeasurementBy string
    Throughput measurement method that will be used by your databases, (either ‘number-of-shards’ or ‘operations-per-second’)
    ThroughputMeasurementValue int
    Throughput value that will be used by your databases (as applies to selected measurement method). The value needs to be the maximum throughput measurement value defined in one of your databases
    AverageItemSizeInBytes int

    Relevant only to ram-and-flash clusters Estimated average size (measured in bytes) of the items stored in the database. The value needs to be the maximum average item size defined in one of your databases. Default: 1000

    ~>Note: If the number of modules exceeds the quantity then additional creation-plan databases will be created with the modules defined in the modules block.

    Note: If changes are made to attributes in the subscription which require the subscription to be recreated (such as memory_storage, cloud_provider or payment_method), the creation_plan will need to be defined in order to change these attributes. This is because the creation_plan is always required when a subscription is created.

    Modules []string
    a list of modules that will be used by the databases in this subscription. Not currently compatible with ‘ram-and-flash’ memory storage. Example: modules = ["RedisJSON", RedisBloom"]
    SupportOssClusterApi bool
    Support Redis open-source (OSS) Cluster API. Default: ‘false’
    memoryLimitInGb Double
    Maximum memory usage that will be used for your largest planned database.
    quantity Integer
    The planned number of databases in the subscription
    replication Boolean
    Databases replication. Default: ‘true’
    throughputMeasurementBy String
    Throughput measurement method that will be used by your databases, (either ‘number-of-shards’ or ‘operations-per-second’)
    throughputMeasurementValue Integer
    Throughput value that will be used by your databases (as applies to selected measurement method). The value needs to be the maximum throughput measurement value defined in one of your databases
    averageItemSizeInBytes Integer

    Relevant only to ram-and-flash clusters Estimated average size (measured in bytes) of the items stored in the database. The value needs to be the maximum average item size defined in one of your databases. Default: 1000

    ~>Note: If the number of modules exceeds the quantity then additional creation-plan databases will be created with the modules defined in the modules block.

    Note: If changes are made to attributes in the subscription which require the subscription to be recreated (such as memory_storage, cloud_provider or payment_method), the creation_plan will need to be defined in order to change these attributes. This is because the creation_plan is always required when a subscription is created.

    modules List<String>
    a list of modules that will be used by the databases in this subscription. Not currently compatible with ‘ram-and-flash’ memory storage. Example: modules = ["RedisJSON", RedisBloom"]
    supportOssClusterApi Boolean
    Support Redis open-source (OSS) Cluster API. Default: ‘false’
    memoryLimitInGb number
    Maximum memory usage that will be used for your largest planned database.
    quantity number
    The planned number of databases in the subscription
    replication boolean
    Databases replication. Default: ‘true’
    throughputMeasurementBy string
    Throughput measurement method that will be used by your databases, (either ‘number-of-shards’ or ‘operations-per-second’)
    throughputMeasurementValue number
    Throughput value that will be used by your databases (as applies to selected measurement method). The value needs to be the maximum throughput measurement value defined in one of your databases
    averageItemSizeInBytes number

    Relevant only to ram-and-flash clusters Estimated average size (measured in bytes) of the items stored in the database. The value needs to be the maximum average item size defined in one of your databases. Default: 1000

    ~>Note: If the number of modules exceeds the quantity then additional creation-plan databases will be created with the modules defined in the modules block.

    Note: If changes are made to attributes in the subscription which require the subscription to be recreated (such as memory_storage, cloud_provider or payment_method), the creation_plan will need to be defined in order to change these attributes. This is because the creation_plan is always required when a subscription is created.

    modules string[]
    a list of modules that will be used by the databases in this subscription. Not currently compatible with ‘ram-and-flash’ memory storage. Example: modules = ["RedisJSON", RedisBloom"]
    supportOssClusterApi boolean
    Support Redis open-source (OSS) Cluster API. Default: ‘false’
    memory_limit_in_gb float
    Maximum memory usage that will be used for your largest planned database.
    quantity int
    The planned number of databases in the subscription
    replication bool
    Databases replication. Default: ‘true’
    throughput_measurement_by str
    Throughput measurement method that will be used by your databases, (either ‘number-of-shards’ or ‘operations-per-second’)
    throughput_measurement_value int
    Throughput value that will be used by your databases (as applies to selected measurement method). The value needs to be the maximum throughput measurement value defined in one of your databases
    average_item_size_in_bytes int

    Relevant only to ram-and-flash clusters Estimated average size (measured in bytes) of the items stored in the database. The value needs to be the maximum average item size defined in one of your databases. Default: 1000

    ~>Note: If the number of modules exceeds the quantity then additional creation-plan databases will be created with the modules defined in the modules block.

    Note: If changes are made to attributes in the subscription which require the subscription to be recreated (such as memory_storage, cloud_provider or payment_method), the creation_plan will need to be defined in order to change these attributes. This is because the creation_plan is always required when a subscription is created.

    modules Sequence[str]
    a list of modules that will be used by the databases in this subscription. Not currently compatible with ‘ram-and-flash’ memory storage. Example: modules = ["RedisJSON", RedisBloom"]
    support_oss_cluster_api bool
    Support Redis open-source (OSS) Cluster API. Default: ‘false’
    memoryLimitInGb Number
    Maximum memory usage that will be used for your largest planned database.
    quantity Number
    The planned number of databases in the subscription
    replication Boolean
    Databases replication. Default: ‘true’
    throughputMeasurementBy String
    Throughput measurement method that will be used by your databases, (either ‘number-of-shards’ or ‘operations-per-second’)
    throughputMeasurementValue Number
    Throughput value that will be used by your databases (as applies to selected measurement method). The value needs to be the maximum throughput measurement value defined in one of your databases
    averageItemSizeInBytes Number

    Relevant only to ram-and-flash clusters Estimated average size (measured in bytes) of the items stored in the database. The value needs to be the maximum average item size defined in one of your databases. Default: 1000

    ~>Note: If the number of modules exceeds the quantity then additional creation-plan databases will be created with the modules defined in the modules block.

    Note: If changes are made to attributes in the subscription which require the subscription to be recreated (such as memory_storage, cloud_provider or payment_method), the creation_plan will need to be defined in order to change these attributes. This is because the creation_plan is always required when a subscription is created.

    modules List<String>
    a list of modules that will be used by the databases in this subscription. Not currently compatible with ‘ram-and-flash’ memory storage. Example: modules = ["RedisJSON", RedisBloom"]
    supportOssClusterApi Boolean
    Support Redis open-source (OSS) Cluster API. Default: ‘false’

    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
    RedisLabs/pulumi-rediscloud