import * as pulumi from "@pulumi/pulumi"; import * as inputs from "../types/input"; import * as outputs from "../types/output"; /** * A Google Cloud Memorystore instance. * * To get more information about Instance, see: * * * [API documentation](https://cloud.google.com/memorystore/docs/valkey/reference/rest/v1/projects.locations.instances) * * How-to Guides * * [Official Documentation](https://cloud.google.com/memorystore/docs/valkey/create-instances) * * ## Example Usage * * ### Memorystore Instance Basic * * ```typescript * import * as pulumi from "@pulumi/pulumi"; * import * as gcp from "@pulumi/gcp"; * * const producerNet = new gcp.compute.Network("producer_net", { * name: "my-network", * autoCreateSubnetworks: false, * }); * const producerSubnet = new gcp.compute.Subnetwork("producer_subnet", { * name: "my-subnet", * ipCidrRange: "10.0.0.248/29", * region: "us-central1", * network: producerNet.id, * }); * const _default = new gcp.networkconnectivity.ServiceConnectionPolicy("default", { * name: "my-policy", * location: "us-central1", * serviceClass: "gcp-memorystore", * description: "my basic service connection policy", * network: producerNet.id, * pscConfig: { * subnetworks: [producerSubnet.id], * }, * }); * const project = gcp.organizations.getProject({}); * const instance_basic = new gcp.memorystore.Instance("instance-basic", { * instanceId: "basic-instance", * shardCount: 3, * desiredPscAutoConnections: [{ * network: producerNet.id, * projectId: project.then(project => project.projectId), * }], * location: "us-central1", * deletionProtectionEnabled: false, * maintenancePolicy: { * weeklyMaintenanceWindows: [{ * day: "MONDAY", * startTime: { * hours: 1, * minutes: 0, * seconds: 0, * nanos: 0, * }, * }], * }, * }, { * dependsOn: [_default], * }); * ``` * ### Memorystore Instance Full * * ```typescript * import * as pulumi from "@pulumi/pulumi"; * import * as gcp from "@pulumi/gcp"; * * const producerNet = new gcp.compute.Network("producer_net", { * name: "my-network", * autoCreateSubnetworks: false, * }); * const producerSubnet = new gcp.compute.Subnetwork("producer_subnet", { * name: "my-subnet", * ipCidrRange: "10.0.0.248/29", * region: "us-central1", * network: producerNet.id, * }); * const _default = new gcp.networkconnectivity.ServiceConnectionPolicy("default", { * name: "my-policy", * location: "us-central1", * serviceClass: "gcp-memorystore", * description: "my basic service connection policy", * network: producerNet.id, * pscConfig: { * subnetworks: [producerSubnet.id], * }, * }); * const project = gcp.organizations.getProject({}); * const instance_full = new gcp.memorystore.Instance("instance-full", { * instanceId: "full-instance", * shardCount: 3, * desiredPscAutoConnections: [{ * network: producerNet.id, * projectId: project.then(project => project.projectId), * }], * location: "us-central1", * replicaCount: 2, * nodeType: "SHARED_CORE_NANO", * transitEncryptionMode: "TRANSIT_ENCRYPTION_DISABLED", * authorizationMode: "AUTH_DISABLED", * engineConfigs: { * "maxmemory-policy": "volatile-ttl", * }, * zoneDistributionConfig: { * mode: "SINGLE_ZONE", * zone: "us-central1-b", * }, * maintenancePolicy: { * weeklyMaintenanceWindows: [{ * day: "MONDAY", * startTime: { * hours: 1, * minutes: 0, * seconds: 0, * nanos: 0, * }, * }], * }, * engineVersion: "VALKEY_7_2", * deletionProtectionEnabled: false, * mode: "CLUSTER", * persistenceConfig: { * mode: "RDB", * rdbConfig: { * rdbSnapshotPeriod: "ONE_HOUR", * rdbSnapshotStartTime: "2024-10-02T15:01:23Z", * }, * }, * labels: { * abc: "xyz", * }, * }, { * dependsOn: [_default], * }); * ``` * ### Memorystore Instance Persistence Aof * * ```typescript * import * as pulumi from "@pulumi/pulumi"; * import * as gcp from "@pulumi/gcp"; * * const producerNet = new gcp.compute.Network("producer_net", { * name: "my-network", * autoCreateSubnetworks: false, * }); * const producerSubnet = new gcp.compute.Subnetwork("producer_subnet", { * name: "my-subnet", * ipCidrRange: "10.0.0.248/29", * region: "us-central1", * network: producerNet.id, * }); * const _default = new gcp.networkconnectivity.ServiceConnectionPolicy("default", { * name: "my-policy", * location: "us-central1", * serviceClass: "gcp-memorystore", * description: "my basic service connection policy", * network: producerNet.id, * pscConfig: { * subnetworks: [producerSubnet.id], * }, * }); * const project = gcp.organizations.getProject({}); * const instance_persistence_aof = new gcp.memorystore.Instance("instance-persistence-aof", { * instanceId: "aof-instance", * shardCount: 3, * desiredPscAutoConnections: [{ * network: producerNet.id, * projectId: project.then(project => project.projectId), * }], * location: "us-central1", * persistenceConfig: { * mode: "AOF", * aofConfig: { * appendFsync: "EVERY_SEC", * }, * }, * deletionProtectionEnabled: false, * }, { * dependsOn: [_default], * }); * ``` * ### Memorystore Instance Secondary Instance * * ```typescript * import * as pulumi from "@pulumi/pulumi"; * import * as gcp from "@pulumi/gcp"; * * const primaryProducerNet = new gcp.compute.Network("primary_producer_net", { * name: "my-network-primary-instance", * autoCreateSubnetworks: false, * }); * const primaryProducerSubnet = new gcp.compute.Subnetwork("primary_producer_subnet", { * name: "my-subnet-primary-instance", * ipCidrRange: "10.0.1.0/29", * region: "asia-east1", * network: primaryProducerNet.id, * }); * const primaryPolicy = new gcp.networkconnectivity.ServiceConnectionPolicy("primary_policy", { * name: "my-policy-primary-instance", * location: "asia-east1", * serviceClass: "gcp-memorystore", * description: "my basic service connection policy", * network: primaryProducerNet.id, * pscConfig: { * subnetworks: [primaryProducerSubnet.id], * }, * }); * const project = gcp.organizations.getProject({}); * // Primary instance * const primaryInstance = new gcp.memorystore.Instance("primary_instance", { * instanceId: "primary-instance", * shardCount: 1, * desiredPscAutoConnections: [{ * network: primaryProducerNet.id, * projectId: project.then(project => project.projectId), * }], * location: "asia-east1", * replicaCount: 1, * nodeType: "SHARED_CORE_NANO", * transitEncryptionMode: "TRANSIT_ENCRYPTION_DISABLED", * authorizationMode: "AUTH_DISABLED", * engineConfigs: { * "maxmemory-policy": "volatile-ttl", * }, * zoneDistributionConfig: { * mode: "SINGLE_ZONE", * zone: "asia-east1-c", * }, * deletionProtectionEnabled: true, * persistenceConfig: { * mode: "RDB", * rdbConfig: { * rdbSnapshotPeriod: "ONE_HOUR", * rdbSnapshotStartTime: "2024-10-02T15:01:23Z", * }, * }, * labels: { * abc: "xyz", * }, * }, { * dependsOn: [primaryPolicy], * }); * const secondaryProducerNet = new gcp.compute.Network("secondary_producer_net", { * name: "my-network-secondary-instance", * autoCreateSubnetworks: false, * }); * const secondaryProducerSubnet = new gcp.compute.Subnetwork("secondary_producer_subnet", { * name: "my-subnet-secondary-instance", * ipCidrRange: "10.0.2.0/29", * region: "europe-north1", * network: secondaryProducerNet.id, * }); * const secondaryPolicy = new gcp.networkconnectivity.ServiceConnectionPolicy("secondary_policy", { * name: "my-policy-secondary-instance", * location: "europe-north1", * serviceClass: "gcp-memorystore", * description: "my basic service connection policy", * network: secondaryProducerNet.id, * pscConfig: { * subnetworks: [secondaryProducerSubnet.id], * }, * }); * // Secondary instance * const secondaryInstance = new gcp.memorystore.Instance("secondary_instance", { * instanceId: "secondary-instance", * shardCount: 1, * desiredPscAutoConnections: [{ * network: secondaryProducerNet.id, * projectId: project.then(project => project.projectId), * }], * location: "europe-north1", * replicaCount: 1, * nodeType: "SHARED_CORE_NANO", * transitEncryptionMode: "TRANSIT_ENCRYPTION_DISABLED", * authorizationMode: "AUTH_DISABLED", * engineConfigs: { * "maxmemory-policy": "volatile-ttl", * }, * zoneDistributionConfig: { * mode: "SINGLE_ZONE", * zone: "europe-north1-c", * }, * deletionProtectionEnabled: true, * crossInstanceReplicationConfig: { * instanceRole: "SECONDARY", * primaryInstance: { * instance: primaryInstance.id, * }, * }, * persistenceConfig: { * mode: "RDB", * rdbConfig: { * rdbSnapshotPeriod: "ONE_HOUR", * rdbSnapshotStartTime: "2024-10-02T15:01:23Z", * }, * }, * labels: { * abc: "xyz", * }, * }, { * dependsOn: [secondaryPolicy], * }); * ``` * * ## Import * * Instance can be imported using any of these accepted formats: * * * `projects/{{project}}/locations/{{location}}/instances/{{instance_id}}` * * * `{{project}}/{{location}}/{{instance_id}}` * * * `{{location}}/{{instance_id}}` * * When using the `pulumi import` command, Instance can be imported using one of the formats above. For example: * * ```sh * $ pulumi import gcp:memorystore/instance:Instance default projects/{{project}}/locations/{{location}}/instances/{{instance_id}} * ``` * * ```sh * $ pulumi import gcp:memorystore/instance:Instance default {{project}}/{{location}}/{{instance_id}} * ``` * * ```sh * $ pulumi import gcp:memorystore/instance:Instance default {{location}}/{{instance_id}} * ``` */ export declare class Instance extends pulumi.CustomResource { /** * Get an existing Instance resource's state with the given name, ID, and optional extra * properties used to qualify the lookup. * * @param name The _unique_ name of the resulting resource. * @param id The _unique_ provider ID of the resource to lookup. * @param state Any extra arguments used during the lookup. * @param opts Optional settings to control the behavior of the CustomResource. */ static get(name: string, id: pulumi.Input, state?: InstanceState, opts?: pulumi.CustomResourceOptions): Instance; /** * Returns true if the given object is an instance of Instance. This is designed to work even * when multiple copies of the Pulumi SDK have been loaded into the same process. */ static isInstance(obj: any): obj is Instance; /** * Optional. Immutable. Authorization mode of the instance. Possible values: * AUTH_DISABLED * IAM_AUTH */ readonly authorizationMode: pulumi.Output; /** * Output only. Creation timestamp of the instance. */ readonly createTime: pulumi.Output; /** * Cross instance replication config * Structure is documented below. */ readonly crossInstanceReplicationConfig: pulumi.Output; /** * Optional. If set to true deletion of the instance will fail. */ readonly deletionProtectionEnabled: pulumi.Output; /** * Immutable. User inputs for the auto-created PSC connections. */ readonly desiredPscAutoConnections: pulumi.Output; /** * Output only. Endpoints clients can connect to the instance through. Currently only one * discovery endpoint is supported. * Structure is documented below. */ readonly discoveryEndpoints: pulumi.Output; /** * All of labels (key/value pairs) present on the resource in GCP, including the labels configured through Pulumi, other clients and services. */ readonly effectiveLabels: pulumi.Output<{ [key: string]: string; }>; /** * Endpoints for the instance. * Structure is documented below. */ readonly endpoints: pulumi.Output; /** * Optional. User-provided engine configurations for the instance. */ readonly engineConfigs: pulumi.Output<{ [key: string]: string; } | undefined>; /** * Optional. Engine version of the instance. */ readonly engineVersion: pulumi.Output; /** * Required. The ID to use for the instance, which will become the final component of * the instance's resource name. * This value is subject to the following restrictions: * * Must be 4-63 characters in length * * Must begin with a letter or digit * * Must contain only lowercase letters, digits, and hyphens * * Must not end with a hyphen * * Must be unique within a location * * * - - - */ readonly instanceId: pulumi.Output; /** * Optional. Labels to represent user-provided metadata. * **Note**: This field is non-authoritative, and will only manage the labels present in your configuration. * Please refer to the field `effectiveLabels` for all of the labels present on the resource. */ readonly labels: pulumi.Output<{ [key: string]: string; } | undefined>; /** * Resource ID segment making up resource `name`. It identifies the resource within its parent collection as described in https://google.aip.dev/122. See documentation for resource type `memorystore.googleapis.com/CertificateAuthority`. */ readonly location: pulumi.Output; /** * Maintenance policy for a cluster * Structure is documented below. */ readonly maintenancePolicy: pulumi.Output; /** * Upcoming maintenance schedule. * Structure is documented below. */ readonly maintenanceSchedules: pulumi.Output; /** * Optional. cluster or cluster-disabled. * Possible values: * CLUSTER * CLUSTER_DISABLED * Possible values are: `CLUSTER`, `CLUSTER_DISABLED`. */ readonly mode: pulumi.Output; /** * Identifier. Unique name of the instance. * Format: projects/{project}/locations/{location}/instances/{instance} */ readonly name: pulumi.Output; /** * Represents configuration for nodes of the instance. * Structure is documented below. */ readonly nodeConfigs: pulumi.Output; /** * Optional. Machine type for individual nodes of the instance. * Possible values: * SHARED_CORE_NANO * HIGHMEM_MEDIUM * HIGHMEM_XLARGE * STANDARD_SMALL */ readonly nodeType: pulumi.Output; /** * Represents persistence configuration for a instance. * Structure is documented below. */ readonly persistenceConfig: pulumi.Output; /** * The ID of the project in which the resource belongs. * If it is not provided, the provider project is used. */ readonly project: pulumi.Output; /** * Configuration of a service attachment of the cluster, for creating PSC connections. * Structure is documented below. */ readonly pscAttachmentDetails: pulumi.Output; /** * Output only. User inputs and resource details of the auto-created PSC connections. * Structure is documented below. */ readonly pscAutoConnections: pulumi.Output; /** * The combination of labels configured directly on the resource * and default labels configured on the provider. */ readonly pulumiLabels: pulumi.Output<{ [key: string]: string; }>; /** * Optional. Number of replica nodes per shard. If omitted the default is 0 replicas. */ readonly replicaCount: pulumi.Output; /** * Required. Number of shards for the instance. */ readonly shardCount: pulumi.Output; /** * Output only. Current state of the instance. * Possible values: * CREATING * ACTIVE * UPDATING * DELETING */ readonly state: pulumi.Output; /** * Additional information about the state of the instance. * Structure is documented below. */ readonly stateInfos: pulumi.Output; /** * Optional. Immutable. In-transit encryption mode of the instance. * Possible values: * TRANSIT_ENCRYPTION_DISABLED * SERVER_AUTHENTICATION */ readonly transitEncryptionMode: pulumi.Output; /** * Output only. System assigned, unique identifier for the instance. */ readonly uid: pulumi.Output; /** * Output only. Latest update timestamp of the instance. */ readonly updateTime: pulumi.Output; /** * Zone distribution configuration for allocation of instance resources. * Structure is documented below. */ readonly zoneDistributionConfig: pulumi.Output; /** * Create a Instance resource with the given unique name, arguments, and options. * * @param name The _unique_ name of the resource. * @param args The arguments to use to populate this resource's properties. * @param opts A bag of options that control this resource's behavior. */ constructor(name: string, args: InstanceArgs, opts?: pulumi.CustomResourceOptions); } /** * Input properties used for looking up and filtering Instance resources. */ export interface InstanceState { /** * Optional. Immutable. Authorization mode of the instance. Possible values: * AUTH_DISABLED * IAM_AUTH */ authorizationMode?: pulumi.Input; /** * Output only. Creation timestamp of the instance. */ createTime?: pulumi.Input; /** * Cross instance replication config * Structure is documented below. */ crossInstanceReplicationConfig?: pulumi.Input; /** * Optional. If set to true deletion of the instance will fail. */ deletionProtectionEnabled?: pulumi.Input; /** * Immutable. User inputs for the auto-created PSC connections. */ desiredPscAutoConnections?: pulumi.Input[]>; /** * Output only. Endpoints clients can connect to the instance through. Currently only one * discovery endpoint is supported. * Structure is documented below. */ discoveryEndpoints?: pulumi.Input[]>; /** * All of labels (key/value pairs) present on the resource in GCP, including the labels configured through Pulumi, other clients and services. */ effectiveLabels?: pulumi.Input<{ [key: string]: pulumi.Input; }>; /** * Endpoints for the instance. * Structure is documented below. */ endpoints?: pulumi.Input[]>; /** * Optional. User-provided engine configurations for the instance. */ engineConfigs?: pulumi.Input<{ [key: string]: pulumi.Input; }>; /** * Optional. Engine version of the instance. */ engineVersion?: pulumi.Input; /** * Required. The ID to use for the instance, which will become the final component of * the instance's resource name. * This value is subject to the following restrictions: * * Must be 4-63 characters in length * * Must begin with a letter or digit * * Must contain only lowercase letters, digits, and hyphens * * Must not end with a hyphen * * Must be unique within a location * * * - - - */ instanceId?: pulumi.Input; /** * Optional. Labels to represent user-provided metadata. * **Note**: This field is non-authoritative, and will only manage the labels present in your configuration. * Please refer to the field `effectiveLabels` for all of the labels present on the resource. */ labels?: pulumi.Input<{ [key: string]: pulumi.Input; }>; /** * Resource ID segment making up resource `name`. It identifies the resource within its parent collection as described in https://google.aip.dev/122. See documentation for resource type `memorystore.googleapis.com/CertificateAuthority`. */ location?: pulumi.Input; /** * Maintenance policy for a cluster * Structure is documented below. */ maintenancePolicy?: pulumi.Input; /** * Upcoming maintenance schedule. * Structure is documented below. */ maintenanceSchedules?: pulumi.Input[]>; /** * Optional. cluster or cluster-disabled. * Possible values: * CLUSTER * CLUSTER_DISABLED * Possible values are: `CLUSTER`, `CLUSTER_DISABLED`. */ mode?: pulumi.Input; /** * Identifier. Unique name of the instance. * Format: projects/{project}/locations/{location}/instances/{instance} */ name?: pulumi.Input; /** * Represents configuration for nodes of the instance. * Structure is documented below. */ nodeConfigs?: pulumi.Input[]>; /** * Optional. Machine type for individual nodes of the instance. * Possible values: * SHARED_CORE_NANO * HIGHMEM_MEDIUM * HIGHMEM_XLARGE * STANDARD_SMALL */ nodeType?: pulumi.Input; /** * Represents persistence configuration for a instance. * Structure is documented below. */ persistenceConfig?: pulumi.Input; /** * The ID of the project in which the resource belongs. * If it is not provided, the provider project is used. */ project?: pulumi.Input; /** * Configuration of a service attachment of the cluster, for creating PSC connections. * Structure is documented below. */ pscAttachmentDetails?: pulumi.Input[]>; /** * Output only. User inputs and resource details of the auto-created PSC connections. * Structure is documented below. */ pscAutoConnections?: pulumi.Input[]>; /** * The combination of labels configured directly on the resource * and default labels configured on the provider. */ pulumiLabels?: pulumi.Input<{ [key: string]: pulumi.Input; }>; /** * Optional. Number of replica nodes per shard. If omitted the default is 0 replicas. */ replicaCount?: pulumi.Input; /** * Required. Number of shards for the instance. */ shardCount?: pulumi.Input; /** * Output only. Current state of the instance. * Possible values: * CREATING * ACTIVE * UPDATING * DELETING */ state?: pulumi.Input; /** * Additional information about the state of the instance. * Structure is documented below. */ stateInfos?: pulumi.Input[]>; /** * Optional. Immutable. In-transit encryption mode of the instance. * Possible values: * TRANSIT_ENCRYPTION_DISABLED * SERVER_AUTHENTICATION */ transitEncryptionMode?: pulumi.Input; /** * Output only. System assigned, unique identifier for the instance. */ uid?: pulumi.Input; /** * Output only. Latest update timestamp of the instance. */ updateTime?: pulumi.Input; /** * Zone distribution configuration for allocation of instance resources. * Structure is documented below. */ zoneDistributionConfig?: pulumi.Input; } /** * The set of arguments for constructing a Instance resource. */ export interface InstanceArgs { /** * Optional. Immutable. Authorization mode of the instance. Possible values: * AUTH_DISABLED * IAM_AUTH */ authorizationMode?: pulumi.Input; /** * Cross instance replication config * Structure is documented below. */ crossInstanceReplicationConfig?: pulumi.Input; /** * Optional. If set to true deletion of the instance will fail. */ deletionProtectionEnabled?: pulumi.Input; /** * Immutable. User inputs for the auto-created PSC connections. */ desiredPscAutoConnections?: pulumi.Input[]>; /** * Optional. User-provided engine configurations for the instance. */ engineConfigs?: pulumi.Input<{ [key: string]: pulumi.Input; }>; /** * Optional. Engine version of the instance. */ engineVersion?: pulumi.Input; /** * Required. The ID to use for the instance, which will become the final component of * the instance's resource name. * This value is subject to the following restrictions: * * Must be 4-63 characters in length * * Must begin with a letter or digit * * Must contain only lowercase letters, digits, and hyphens * * Must not end with a hyphen * * Must be unique within a location * * * - - - */ instanceId: pulumi.Input; /** * Optional. Labels to represent user-provided metadata. * **Note**: This field is non-authoritative, and will only manage the labels present in your configuration. * Please refer to the field `effectiveLabels` for all of the labels present on the resource. */ labels?: pulumi.Input<{ [key: string]: pulumi.Input; }>; /** * Resource ID segment making up resource `name`. It identifies the resource within its parent collection as described in https://google.aip.dev/122. See documentation for resource type `memorystore.googleapis.com/CertificateAuthority`. */ location: pulumi.Input; /** * Maintenance policy for a cluster * Structure is documented below. */ maintenancePolicy?: pulumi.Input; /** * Optional. cluster or cluster-disabled. * Possible values: * CLUSTER * CLUSTER_DISABLED * Possible values are: `CLUSTER`, `CLUSTER_DISABLED`. */ mode?: pulumi.Input; /** * Optional. Machine type for individual nodes of the instance. * Possible values: * SHARED_CORE_NANO * HIGHMEM_MEDIUM * HIGHMEM_XLARGE * STANDARD_SMALL */ nodeType?: pulumi.Input; /** * Represents persistence configuration for a instance. * Structure is documented below. */ persistenceConfig?: pulumi.Input; /** * The ID of the project in which the resource belongs. * If it is not provided, the provider project is used. */ project?: pulumi.Input; /** * Optional. Number of replica nodes per shard. If omitted the default is 0 replicas. */ replicaCount?: pulumi.Input; /** * Required. Number of shards for the instance. */ shardCount: pulumi.Input; /** * Optional. Immutable. In-transit encryption mode of the instance. * Possible values: * TRANSIT_ENCRYPTION_DISABLED * SERVER_AUTHENTICATION */ transitEncryptionMode?: pulumi.Input; /** * Zone distribution configuration for allocation of instance resources. * Structure is documented below. */ zoneDistributionConfig?: pulumi.Input; }