Docs Home Pulumi IaC Pulumi ESC Pulumi Cloud Packages Tutorials
  1. Packages
  2. Google Cloud (GCP) Classic
  3. API Docs
  4. memcache
  5. Instance
Google Cloud Classic v8.9.3 published on Monday, Nov 18, 2024 by Pulumi
pulumi/pulumi-gcp

gcp.memcache.Instance

Explore with Pulumi AI

gcp logo
Google Cloud Classic v8.9.3 published on Monday, Nov 18, 2024 by Pulumi
pulumi/pulumi-gcp

    A Google Cloud Memcache instance.

    To get more information about Instance, see:

    Example Usage

    Memcache Instance Basic

    import * as pulumi from "@pulumi/pulumi";
import * as gcp from "@pulumi/gcp";

// This example assumes this network already exists.
// The API creates a tenant network per network authorized for a
// Memcache instance and that network is not deleted when the user-created
// network (authorized_network) is deleted, so this prevents issues
// with tenant network quota.
// If this network hasn't been created and you are using this example in your
// config, add an additional network resource or change
// this from "data"to "resource"
const memcacheNetwork = new gcp.compute.Network("memcache_network", {name: "test-network"});
const serviceRange = new gcp.compute.GlobalAddress("service_range", {
    name: "address",
    purpose: "VPC_PEERING",
    addressType: "INTERNAL",
    prefixLength: 16,
    network: memcacheNetwork.id,
});
const privateServiceConnection = new gcp.servicenetworking.Connection("private_service_connection", {
    network: memcacheNetwork.id,
    service: "servicenetworking.googleapis.com",
    reservedPeeringRanges: [serviceRange.name],
});
const instance = new gcp.memcache.Instance("instance", {
    name: "test-instance",
    authorizedNetwork: privateServiceConnection.network,
    labels: {
        env: "test",
    },
    nodeConfig: {
        cpuCount: 1,
        memorySizeMb: 1024,
    },
    nodeCount: 1,
    memcacheVersion: "MEMCACHE_1_5",
    maintenancePolicy: {
        weeklyMaintenanceWindows: [{
            day: "SATURDAY",
            duration: "14400s",
            startTime: {
                hours: 0,
                minutes: 30,
                seconds: 0,
                nanos: 0,
            },
        }],
    },
});

    import pulumi
import pulumi_gcp as gcp

# This example assumes this network already exists.
# The API creates a tenant network per network authorized for a
# Memcache instance and that network is not deleted when the user-created
# network (authorized_network) is deleted, so this prevents issues
# with tenant network quota.
# If this network hasn't been created and you are using this example in your
# config, add an additional network resource or change
# this from "data"to "resource"
memcache_network = gcp.compute.Network("memcache_network", name="test-network")
service_range = gcp.compute.GlobalAddress("service_range",
    name="address",
    purpose="VPC_PEERING",
    address_type="INTERNAL",
    prefix_length=16,
    network=memcache_network.id)
private_service_connection = gcp.servicenetworking.Connection("private_service_connection",
    network=memcache_network.id,
    service="servicenetworking.googleapis.com",
    reserved_peering_ranges=[service_range.name])
instance = gcp.memcache.Instance("instance",
    name="test-instance",
    authorized_network=private_service_connection.network,
    labels={
        "env": "test",
    },
    node_config={
        "cpu_count": 1,
        "memory_size_mb": 1024,
    },
    node_count=1,
    memcache_version="MEMCACHE_1_5",
    maintenance_policy={
        "weekly_maintenance_windows": [{
            "day": "SATURDAY",
            "duration": "14400s",
            "start_time": {
                "hours": 0,
                "minutes": 30,
                "seconds": 0,
                "nanos": 0,
            },
        }],
    })

    package main

import (
	"github.com/pulumi/pulumi-gcp/sdk/v8/go/gcp/compute"
	"github.com/pulumi/pulumi-gcp/sdk/v8/go/gcp/memcache"
	"github.com/pulumi/pulumi-gcp/sdk/v8/go/gcp/servicenetworking"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		// This example assumes this network already exists.
		// The API creates a tenant network per network authorized for a
		// Memcache instance and that network is not deleted when the user-created
		// network (authorized_network) is deleted, so this prevents issues
		// with tenant network quota.
		// If this network hasn't been created and you are using this example in your
		// config, add an additional network resource or change
		// this from "data"to "resource"
		memcacheNetwork, err := compute.NewNetwork(ctx, "memcache_network", &compute.NetworkArgs{
			Name: pulumi.String("test-network"),
		})
		if err != nil {
			return err
		}
		serviceRange, err := compute.NewGlobalAddress(ctx, "service_range", &compute.GlobalAddressArgs{
			Name:         pulumi.String("address"),
			Purpose:      pulumi.String("VPC_PEERING"),
			AddressType:  pulumi.String("INTERNAL"),
			PrefixLength: pulumi.Int(16),
			Network:      memcacheNetwork.ID(),
		})
		if err != nil {
			return err
		}
		privateServiceConnection, err := servicenetworking.NewConnection(ctx, "private_service_connection", &servicenetworking.ConnectionArgs{
			Network: memcacheNetwork.ID(),
			Service: pulumi.String("servicenetworking.googleapis.com"),
			ReservedPeeringRanges: pulumi.StringArray{
				serviceRange.Name,
			},
		})
		if err != nil {
			return err
		}
		_, err = memcache.NewInstance(ctx, "instance", &memcache.InstanceArgs{
			Name:              pulumi.String("test-instance"),
			AuthorizedNetwork: privateServiceConnection.Network,
			Labels: pulumi.StringMap{
				"env": pulumi.String("test"),
			},
			NodeConfig: &memcache.InstanceNodeConfigArgs{
				CpuCount:     pulumi.Int(1),
				MemorySizeMb: pulumi.Int(1024),
			},
			NodeCount:       pulumi.Int(1),
			MemcacheVersion: pulumi.String("MEMCACHE_1_5"),
			MaintenancePolicy: &memcache.InstanceMaintenancePolicyArgs{
				WeeklyMaintenanceWindows: memcache.InstanceMaintenancePolicyWeeklyMaintenanceWindowArray{
					&memcache.InstanceMaintenancePolicyWeeklyMaintenanceWindowArgs{
						Day:      pulumi.String("SATURDAY"),
						Duration: pulumi.String("14400s"),
						StartTime: &memcache.InstanceMaintenancePolicyWeeklyMaintenanceWindowStartTimeArgs{
							Hours:   pulumi.Int(0),
							Minutes: pulumi.Int(30),
							Seconds: pulumi.Int(0),
							Nanos:   pulumi.Int(0),
						},
					},
				},
			},
		})
		if err != nil {
			return err
		}
		return nil
	})
}

    using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Gcp = Pulumi.Gcp;

return await Deployment.RunAsync(() => 
{
    // This example assumes this network already exists.
    // The API creates a tenant network per network authorized for a
    // Memcache instance and that network is not deleted when the user-created
    // network (authorized_network) is deleted, so this prevents issues
    // with tenant network quota.
    // If this network hasn't been created and you are using this example in your
    // config, add an additional network resource or change
    // this from "data"to "resource"
    var memcacheNetwork = new Gcp.Compute.Network("memcache_network", new()
    {
        Name = "test-network",
    });

    var serviceRange = new Gcp.Compute.GlobalAddress("service_range", new()
    {
        Name = "address",
        Purpose = "VPC_PEERING",
        AddressType = "INTERNAL",
        PrefixLength = 16,
        Network = memcacheNetwork.Id,
    });

    var privateServiceConnection = new Gcp.ServiceNetworking.Connection("private_service_connection", new()
    {
        Network = memcacheNetwork.Id,
        Service = "servicenetworking.googleapis.com",
        ReservedPeeringRanges = new[]
        {
            serviceRange.Name,
        },
    });

    var instance = new Gcp.Memcache.Instance("instance", new()
    {
        Name = "test-instance",
        AuthorizedNetwork = privateServiceConnection.Network,
        Labels = 
        {
            { "env", "test" },
        },
        NodeConfig = new Gcp.Memcache.Inputs.InstanceNodeConfigArgs
        {
            CpuCount = 1,
            MemorySizeMb = 1024,
        },
        NodeCount = 1,
        MemcacheVersion = "MEMCACHE_1_5",
        MaintenancePolicy = new Gcp.Memcache.Inputs.InstanceMaintenancePolicyArgs
        {
            WeeklyMaintenanceWindows = new[]
            {
                new Gcp.Memcache.Inputs.InstanceMaintenancePolicyWeeklyMaintenanceWindowArgs
                {
                    Day = "SATURDAY",
                    Duration = "14400s",
                    StartTime = new Gcp.Memcache.Inputs.InstanceMaintenancePolicyWeeklyMaintenanceWindowStartTimeArgs
                    {
                        Hours = 0,
                        Minutes = 30,
                        Seconds = 0,
                        Nanos = 0,
                    },
                },
            },
        },
    });

});

    package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.gcp.compute.Network;
import com.pulumi.gcp.compute.NetworkArgs;
import com.pulumi.gcp.compute.GlobalAddress;
import com.pulumi.gcp.compute.GlobalAddressArgs;
import com.pulumi.gcp.servicenetworking.Connection;
import com.pulumi.gcp.servicenetworking.ConnectionArgs;
import com.pulumi.gcp.memcache.Instance;
import com.pulumi.gcp.memcache.InstanceArgs;
import com.pulumi.gcp.memcache.inputs.InstanceNodeConfigArgs;
import com.pulumi.gcp.memcache.inputs.InstanceMaintenancePolicyArgs;
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) {
        // This example assumes this network already exists.
        // The API creates a tenant network per network authorized for a
        // Memcache instance and that network is not deleted when the user-created
        // network (authorized_network) is deleted, so this prevents issues
        // with tenant network quota.
        // If this network hasn't been created and you are using this example in your
        // config, add an additional network resource or change
        // this from "data"to "resource"
        var memcacheNetwork = new Network("memcacheNetwork", NetworkArgs.builder()
            .name("test-network")
            .build());

        var serviceRange = new GlobalAddress("serviceRange", GlobalAddressArgs.builder()
            .name("address")
            .purpose("VPC_PEERING")
            .addressType("INTERNAL")
            .prefixLength(16)
            .network(memcacheNetwork.id())
            .build());

        var privateServiceConnection = new Connection("privateServiceConnection", ConnectionArgs.builder()
            .network(memcacheNetwork.id())
            .service("servicenetworking.googleapis.com")
            .reservedPeeringRanges(serviceRange.name())
            .build());

        var instance = new Instance("instance", InstanceArgs.builder()
            .name("test-instance")
            .authorizedNetwork(privateServiceConnection.network())
            .labels(Map.of("env", "test"))
            .nodeConfig(InstanceNodeConfigArgs.builder()
                .cpuCount(1)
                .memorySizeMb(1024)
                .build())
            .nodeCount(1)
            .memcacheVersion("MEMCACHE_1_5")
            .maintenancePolicy(InstanceMaintenancePolicyArgs.builder()
                .weeklyMaintenanceWindows(InstanceMaintenancePolicyWeeklyMaintenanceWindowArgs.builder()
                    .day("SATURDAY")
                    .duration("14400s")
                    .startTime(InstanceMaintenancePolicyWeeklyMaintenanceWindowStartTimeArgs.builder()
                        .hours(0)
                        .minutes(30)
                        .seconds(0)
                        .nanos(0)
                        .build())
                    .build())
                .build())
            .build());

    }
}

    resources:
  # This example assumes this network already exists.
  # // The API creates a tenant network per network authorized for a
  # // Memcache instance and that network is not deleted when the user-created
  # // network (authorized_network) is deleted, so this prevents issues
  # // with tenant network quota.
  # // If this network hasn't been created and you are using this example in your
  # // config, add an additional network resource or change
  # // this from "data"to "resource"
  memcacheNetwork:
    type: gcp:compute:Network
    name: memcache_network
    properties:
      name: test-network
  serviceRange:
    type: gcp:compute:GlobalAddress
    name: service_range
    properties:
      name: address
      purpose: VPC_PEERING
      addressType: INTERNAL
      prefixLength: 16
      network: ${memcacheNetwork.id}
  privateServiceConnection:
    type: gcp:servicenetworking:Connection
    name: private_service_connection
    properties:
      network: ${memcacheNetwork.id}
      service: servicenetworking.googleapis.com
      reservedPeeringRanges:
        - ${serviceRange.name}
  instance:
    type: gcp:memcache:Instance
    properties:
      name: test-instance
      authorizedNetwork: ${privateServiceConnection.network}
      labels:
        env: test
      nodeConfig:
        cpuCount: 1
        memorySizeMb: 1024
      nodeCount: 1
      memcacheVersion: MEMCACHE_1_5
      maintenancePolicy:
        weeklyMaintenanceWindows:
          - day: SATURDAY
            duration: 14400s
            startTime:
              hours: 0
              minutes: 30
              seconds: 0
              nanos: 0

    Create Instance Resource

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

    Constructor syntax

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

@overload
def Instance(resource_name: str,
             opts: Optional[ResourceOptions] = None,
             node_config: Optional[InstanceNodeConfigArgs] = None,
             node_count: Optional[int] = None,
             name: Optional[str] = None,
             maintenance_policy: Optional[InstanceMaintenancePolicyArgs] = None,
             memcache_parameters: Optional[InstanceMemcacheParametersArgs] = None,
             memcache_version: Optional[str] = None,
             authorized_network: Optional[str] = None,
             labels: Optional[Mapping[str, str]] = None,
             display_name: Optional[str] = None,
             project: Optional[str] = None,
             region: Optional[str] = None,
             reserved_ip_range_ids: Optional[Sequence[str]] = None,
             zones: Optional[Sequence[str]] = None)
    func NewInstance(ctx *Context, name string, args InstanceArgs, opts ...ResourceOption) (*Instance, error)
    public Instance(string name, InstanceArgs args, CustomResourceOptions? opts = null)
    public Instance(String name, InstanceArgs args)
public Instance(String name, InstanceArgs args, CustomResourceOptions options)

    type: gcp:memcache:Instance
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 InstanceArgs
    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 InstanceArgs
    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 InstanceArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args InstanceArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args InstanceArgs
    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 exampleinstanceResourceResourceFromMemcacheinstance = new Gcp.Memcache.Instance("exampleinstanceResourceResourceFromMemcacheinstance", new()
{
    NodeConfig = new Gcp.Memcache.Inputs.InstanceNodeConfigArgs
    {
        CpuCount = 0,
        MemorySizeMb = 0,
    },
    NodeCount = 0,
    Name = "string",
    MaintenancePolicy = new Gcp.Memcache.Inputs.InstanceMaintenancePolicyArgs
    {
        WeeklyMaintenanceWindows = new[]
        {
            new Gcp.Memcache.Inputs.InstanceMaintenancePolicyWeeklyMaintenanceWindowArgs
            {
                Day = "string",
                Duration = "string",
                StartTime = new Gcp.Memcache.Inputs.InstanceMaintenancePolicyWeeklyMaintenanceWindowStartTimeArgs
                {
                    Hours = 0,
                    Minutes = 0,
                    Nanos = 0,
                    Seconds = 0,
                },
            },
        },
        CreateTime = "string",
        Description = "string",
        UpdateTime = "string",
    },
    MemcacheParameters = new Gcp.Memcache.Inputs.InstanceMemcacheParametersArgs
    {
        Id = "string",
        Params = 
        {
            { "string", "string" },
        },
    },
    MemcacheVersion = "string",
    AuthorizedNetwork = "string",
    Labels = 
    {
        { "string", "string" },
    },
    DisplayName = "string",
    Project = "string",
    Region = "string",
    ReservedIpRangeIds = new[]
    {
        "string",
    },
    Zones = new[]
    {
        "string",
    },
});

    example, err := memcache.NewInstance(ctx, "exampleinstanceResourceResourceFromMemcacheinstance", &memcache.InstanceArgs{
	NodeConfig: &memcache.InstanceNodeConfigArgs{
		CpuCount:     pulumi.Int(0),
		MemorySizeMb: pulumi.Int(0),
	},
	NodeCount: pulumi.Int(0),
	Name:      pulumi.String("string"),
	MaintenancePolicy: &memcache.InstanceMaintenancePolicyArgs{
		WeeklyMaintenanceWindows: memcache.InstanceMaintenancePolicyWeeklyMaintenanceWindowArray{
			&memcache.InstanceMaintenancePolicyWeeklyMaintenanceWindowArgs{
				Day:      pulumi.String("string"),
				Duration: pulumi.String("string"),
				StartTime: &memcache.InstanceMaintenancePolicyWeeklyMaintenanceWindowStartTimeArgs{
					Hours:   pulumi.Int(0),
					Minutes: pulumi.Int(0),
					Nanos:   pulumi.Int(0),
					Seconds: pulumi.Int(0),
				},
			},
		},
		CreateTime:  pulumi.String("string"),
		Description: pulumi.String("string"),
		UpdateTime:  pulumi.String("string"),
	},
	MemcacheParameters: &memcache.InstanceMemcacheParametersArgs{
		Id: pulumi.String("string"),
		Params: pulumi.StringMap{
			"string": pulumi.String("string"),
		},
	},
	MemcacheVersion:   pulumi.String("string"),
	AuthorizedNetwork: pulumi.String("string"),
	Labels: pulumi.StringMap{
		"string": pulumi.String("string"),
	},
	DisplayName: pulumi.String("string"),
	Project:     pulumi.String("string"),
	Region:      pulumi.String("string"),
	ReservedIpRangeIds: pulumi.StringArray{
		pulumi.String("string"),
	},
	Zones: pulumi.StringArray{
		pulumi.String("string"),
	},
})

    var exampleinstanceResourceResourceFromMemcacheinstance = new Instance("exampleinstanceResourceResourceFromMemcacheinstance", InstanceArgs.builder()
    .nodeConfig(InstanceNodeConfigArgs.builder()
        .cpuCount(0)
        .memorySizeMb(0)
        .build())
    .nodeCount(0)
    .name("string")
    .maintenancePolicy(InstanceMaintenancePolicyArgs.builder()
        .weeklyMaintenanceWindows(InstanceMaintenancePolicyWeeklyMaintenanceWindowArgs.builder()
            .day("string")
            .duration("string")
            .startTime(InstanceMaintenancePolicyWeeklyMaintenanceWindowStartTimeArgs.builder()
                .hours(0)
                .minutes(0)
                .nanos(0)
                .seconds(0)
                .build())
            .build())
        .createTime("string")
        .description("string")
        .updateTime("string")
        .build())
    .memcacheParameters(InstanceMemcacheParametersArgs.builder()
        .id("string")
        .params(Map.of("string", "string"))
        .build())
    .memcacheVersion("string")
    .authorizedNetwork("string")
    .labels(Map.of("string", "string"))
    .displayName("string")
    .project("string")
    .region("string")
    .reservedIpRangeIds("string")
    .zones("string")
    .build());

    exampleinstance_resource_resource_from_memcacheinstance = gcp.memcache.Instance("exampleinstanceResourceResourceFromMemcacheinstance",
    node_config={
        "cpu_count": 0,
        "memory_size_mb": 0,
    },
    node_count=0,
    name="string",
    maintenance_policy={
        "weekly_maintenance_windows": [{
            "day": "string",
            "duration": "string",
            "start_time": {
                "hours": 0,
                "minutes": 0,
                "nanos": 0,
                "seconds": 0,
            },
        }],
        "create_time": "string",
        "description": "string",
        "update_time": "string",
    },
    memcache_parameters={
        "id": "string",
        "params": {
            "string": "string",
        },
    },
    memcache_version="string",
    authorized_network="string",
    labels={
        "string": "string",
    },
    display_name="string",
    project="string",
    region="string",
    reserved_ip_range_ids=["string"],
    zones=["string"])

    const exampleinstanceResourceResourceFromMemcacheinstance = new gcp.memcache.Instance("exampleinstanceResourceResourceFromMemcacheinstance", {
    nodeConfig: {
        cpuCount: 0,
        memorySizeMb: 0,
    },
    nodeCount: 0,
    name: "string",
    maintenancePolicy: {
        weeklyMaintenanceWindows: [{
            day: "string",
            duration: "string",
            startTime: {
                hours: 0,
                minutes: 0,
                nanos: 0,
                seconds: 0,
            },
        }],
        createTime: "string",
        description: "string",
        updateTime: "string",
    },
    memcacheParameters: {
        id: "string",
        params: {
            string: "string",
        },
    },
    memcacheVersion: "string",
    authorizedNetwork: "string",
    labels: {
        string: "string",
    },
    displayName: "string",
    project: "string",
    region: "string",
    reservedIpRangeIds: ["string"],
    zones: ["string"],
});

    type: gcp:memcache:Instance
properties:
    authorizedNetwork: string
    displayName: string
    labels:
        string: string
    maintenancePolicy:
        createTime: string
        description: string
        updateTime: string
        weeklyMaintenanceWindows:
            - day: string
              duration: string
              startTime:
                hours: 0
                minutes: 0
                nanos: 0
                seconds: 0
    memcacheParameters:
        id: string
        params:
            string: string
    memcacheVersion: string
    name: string
    nodeConfig:
        cpuCount: 0
        memorySizeMb: 0
    nodeCount: 0
    project: string
    region: string
    reservedIpRangeIds:
        - string
    zones:
        - string

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

    NodeConfig InstanceNodeConfig
    Configuration for memcache nodes. Structure is documented below.
    NodeCount int
    Number of nodes in the memcache instance.
    AuthorizedNetwork string
    The full name of the GCE network to connect the instance to. If not provided, 'default' will be used.
    DisplayName string
    A user-visible name for the instance.
    Labels Dictionary<string, string>
    Resource 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 'effective_labels' for all of the labels present on the resource.
    MaintenancePolicy InstanceMaintenancePolicy
    Maintenance policy for an instance.
    MemcacheParameters InstanceMemcacheParameters
    User-specified parameters for this memcache instance.
    MemcacheVersion string
    The major version of Memcached software. If not provided, latest supported version will be used. Currently the latest supported major version is MEMCACHE_1_5. The minor version will be automatically determined by our system based on the latest supported minor version. Default value: "MEMCACHE_1_5" Possible values: ["MEMCACHE_1_5", "MEMCACHE_1_6_15"]
    Name string
    The resource name of the instance.
    Project string
    Region string
    The region of the Memcache instance. If it is not provided, the provider region is used.
    ReservedIpRangeIds List<string>
    Contains the name of allocated IP address ranges associated with the private service access connection for example, "test-default" associated with IP range 10.0.0.0/29.
    Zones List<string>
    Zones where memcache nodes should be provisioned. If not provided, all zones will be used.
    NodeConfig InstanceNodeConfigArgs
    Configuration for memcache nodes. Structure is documented below.
    NodeCount int
    Number of nodes in the memcache instance.
    AuthorizedNetwork string
    The full name of the GCE network to connect the instance to. If not provided, 'default' will be used.
    DisplayName string
    A user-visible name for the instance.
    Labels map[string]string
    Resource 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 'effective_labels' for all of the labels present on the resource.
    MaintenancePolicy InstanceMaintenancePolicyArgs
    Maintenance policy for an instance.
    MemcacheParameters InstanceMemcacheParametersArgs
    User-specified parameters for this memcache instance.
    MemcacheVersion string
    The major version of Memcached software. If not provided, latest supported version will be used. Currently the latest supported major version is MEMCACHE_1_5. The minor version will be automatically determined by our system based on the latest supported minor version. Default value: "MEMCACHE_1_5" Possible values: ["MEMCACHE_1_5", "MEMCACHE_1_6_15"]
    Name string
    The resource name of the instance.
    Project string
    Region string
    The region of the Memcache instance. If it is not provided, the provider region is used.
    ReservedIpRangeIds []string
    Contains the name of allocated IP address ranges associated with the private service access connection for example, "test-default" associated with IP range 10.0.0.0/29.
    Zones []string
    Zones where memcache nodes should be provisioned. If not provided, all zones will be used.
    nodeConfig InstanceNodeConfig
    Configuration for memcache nodes. Structure is documented below.
    nodeCount Integer
    Number of nodes in the memcache instance.
    authorizedNetwork String
    The full name of the GCE network to connect the instance to. If not provided, 'default' will be used.
    displayName String
    A user-visible name for the instance.
    labels Map<String,String>
    Resource 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 'effective_labels' for all of the labels present on the resource.
    maintenancePolicy InstanceMaintenancePolicy
    Maintenance policy for an instance.
    memcacheParameters InstanceMemcacheParameters
    User-specified parameters for this memcache instance.
    memcacheVersion String
    The major version of Memcached software. If not provided, latest supported version will be used. Currently the latest supported major version is MEMCACHE_1_5. The minor version will be automatically determined by our system based on the latest supported minor version. Default value: "MEMCACHE_1_5" Possible values: ["MEMCACHE_1_5", "MEMCACHE_1_6_15"]
    name String
    The resource name of the instance.
    project String
    region String
    The region of the Memcache instance. If it is not provided, the provider region is used.
    reservedIpRangeIds List<String>
    Contains the name of allocated IP address ranges associated with the private service access connection for example, "test-default" associated with IP range 10.0.0.0/29.
    zones List<String>
    Zones where memcache nodes should be provisioned. If not provided, all zones will be used.
    nodeConfig InstanceNodeConfig
    Configuration for memcache nodes. Structure is documented below.
    nodeCount number
    Number of nodes in the memcache instance.
    authorizedNetwork string
    The full name of the GCE network to connect the instance to. If not provided, 'default' will be used.
    displayName string
    A user-visible name for the instance.
    labels {[key: string]: string}
    Resource 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 'effective_labels' for all of the labels present on the resource.
    maintenancePolicy InstanceMaintenancePolicy
    Maintenance policy for an instance.
    memcacheParameters InstanceMemcacheParameters
    User-specified parameters for this memcache instance.
    memcacheVersion string
    The major version of Memcached software. If not provided, latest supported version will be used. Currently the latest supported major version is MEMCACHE_1_5. The minor version will be automatically determined by our system based on the latest supported minor version. Default value: "MEMCACHE_1_5" Possible values: ["MEMCACHE_1_5", "MEMCACHE_1_6_15"]
    name string
    The resource name of the instance.
    project string
    region string
    The region of the Memcache instance. If it is not provided, the provider region is used.
    reservedIpRangeIds string[]
    Contains the name of allocated IP address ranges associated with the private service access connection for example, "test-default" associated with IP range 10.0.0.0/29.
    zones string[]
    Zones where memcache nodes should be provisioned. If not provided, all zones will be used.
    node_config InstanceNodeConfigArgs
    Configuration for memcache nodes. Structure is documented below.
    node_count int
    Number of nodes in the memcache instance.
    authorized_network str
    The full name of the GCE network to connect the instance to. If not provided, 'default' will be used.
    display_name str
    A user-visible name for the instance.
    labels Mapping[str, str]
    Resource 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 'effective_labels' for all of the labels present on the resource.
    maintenance_policy InstanceMaintenancePolicyArgs
    Maintenance policy for an instance.
    memcache_parameters InstanceMemcacheParametersArgs
    User-specified parameters for this memcache instance.
    memcache_version str
    The major version of Memcached software. If not provided, latest supported version will be used. Currently the latest supported major version is MEMCACHE_1_5. The minor version will be automatically determined by our system based on the latest supported minor version. Default value: "MEMCACHE_1_5" Possible values: ["MEMCACHE_1_5", "MEMCACHE_1_6_15"]
    name str
    The resource name of the instance.
    project str
    region str
    The region of the Memcache instance. If it is not provided, the provider region is used.
    reserved_ip_range_ids Sequence[str]
    Contains the name of allocated IP address ranges associated with the private service access connection for example, "test-default" associated with IP range 10.0.0.0/29.
    zones Sequence[str]
    Zones where memcache nodes should be provisioned. If not provided, all zones will be used.
    nodeConfig Property Map
    Configuration for memcache nodes. Structure is documented below.
    nodeCount Number
    Number of nodes in the memcache instance.
    authorizedNetwork String
    The full name of the GCE network to connect the instance to. If not provided, 'default' will be used.
    displayName String
    A user-visible name for the instance.
    labels Map<String>
    Resource 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 'effective_labels' for all of the labels present on the resource.
    maintenancePolicy Property Map
    Maintenance policy for an instance.
    memcacheParameters Property Map
    User-specified parameters for this memcache instance.
    memcacheVersion String
    The major version of Memcached software. If not provided, latest supported version will be used. Currently the latest supported major version is MEMCACHE_1_5. The minor version will be automatically determined by our system based on the latest supported minor version. Default value: "MEMCACHE_1_5" Possible values: ["MEMCACHE_1_5", "MEMCACHE_1_6_15"]
    name String
    The resource name of the instance.
    project String
    region String
    The region of the Memcache instance. If it is not provided, the provider region is used.
    reservedIpRangeIds List<String>
    Contains the name of allocated IP address ranges associated with the private service access connection for example, "test-default" associated with IP range 10.0.0.0/29.
    zones List<String>
    Zones where memcache nodes should be provisioned. If not provided, all zones will be used.

    Outputs

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

    CreateTime string
    Creation timestamp in RFC3339 text format.
    DiscoveryEndpoint string
    Endpoint for Discovery API
    EffectiveLabels Dictionary<string, string>
    All of labels (key/value pairs) present on the resource in GCP, including the labels configured through Pulumi, other clients and services.
    Id string
    The provider-assigned unique ID for this managed resource.
    MaintenanceSchedules List<InstanceMaintenanceSchedule>
    Output only. Published maintenance schedule. Structure is documented below.
    MemcacheFullVersion string
    The full version of memcached server running on this instance.
    MemcacheNodes List<InstanceMemcacheNode>
    Additional information about the instance state, if available. Structure is documented below.
    PulumiLabels Dictionary<string, string>
    The combination of labels configured directly on the resource and default labels configured on the provider.
    CreateTime string
    Creation timestamp in RFC3339 text format.
    DiscoveryEndpoint string
    Endpoint for Discovery API
    EffectiveLabels map[string]string
    All of labels (key/value pairs) present on the resource in GCP, including the labels configured through Pulumi, other clients and services.
    Id string
    The provider-assigned unique ID for this managed resource.
    MaintenanceSchedules []InstanceMaintenanceSchedule
    Output only. Published maintenance schedule. Structure is documented below.
    MemcacheFullVersion string
    The full version of memcached server running on this instance.
    MemcacheNodes []InstanceMemcacheNode
    Additional information about the instance state, if available. Structure is documented below.
    PulumiLabels map[string]string
    The combination of labels configured directly on the resource and default labels configured on the provider.
    createTime String
    Creation timestamp in RFC3339 text format.
    discoveryEndpoint String
    Endpoint for Discovery API
    effectiveLabels Map<String,String>
    All of labels (key/value pairs) present on the resource in GCP, including the labels configured through Pulumi, other clients and services.
    id String
    The provider-assigned unique ID for this managed resource.
    maintenanceSchedules List<InstanceMaintenanceSchedule>
    Output only. Published maintenance schedule. Structure is documented below.
    memcacheFullVersion String
    The full version of memcached server running on this instance.
    memcacheNodes List<InstanceMemcacheNode>
    Additional information about the instance state, if available. Structure is documented below.
    pulumiLabels Map<String,String>
    The combination of labels configured directly on the resource and default labels configured on the provider.
    createTime string
    Creation timestamp in RFC3339 text format.
    discoveryEndpoint string
    Endpoint for Discovery API
    effectiveLabels {[key: string]: string}
    All of labels (key/value pairs) present on the resource in GCP, including the labels configured through Pulumi, other clients and services.
    id string
    The provider-assigned unique ID for this managed resource.
    maintenanceSchedules InstanceMaintenanceSchedule[]
    Output only. Published maintenance schedule. Structure is documented below.
    memcacheFullVersion string
    The full version of memcached server running on this instance.
    memcacheNodes InstanceMemcacheNode[]
    Additional information about the instance state, if available. Structure is documented below.
    pulumiLabels {[key: string]: string}
    The combination of labels configured directly on the resource and default labels configured on the provider.
    create_time str
    Creation timestamp in RFC3339 text format.
    discovery_endpoint str
    Endpoint for Discovery API
    effective_labels Mapping[str, str]
    All of labels (key/value pairs) present on the resource in GCP, including the labels configured through Pulumi, other clients and services.
    id str
    The provider-assigned unique ID for this managed resource.
    maintenance_schedules Sequence[InstanceMaintenanceSchedule]
    Output only. Published maintenance schedule. Structure is documented below.
    memcache_full_version str
    The full version of memcached server running on this instance.
    memcache_nodes Sequence[InstanceMemcacheNode]
    Additional information about the instance state, if available. Structure is documented below.
    pulumi_labels Mapping[str, str]
    The combination of labels configured directly on the resource and default labels configured on the provider.
    createTime String
    Creation timestamp in RFC3339 text format.
    discoveryEndpoint String
    Endpoint for Discovery API
    effectiveLabels Map<String>
    All of labels (key/value pairs) present on the resource in GCP, including the labels configured through Pulumi, other clients and services.
    id String
    The provider-assigned unique ID for this managed resource.
    maintenanceSchedules List<Property Map>
    Output only. Published maintenance schedule. Structure is documented below.
    memcacheFullVersion String
    The full version of memcached server running on this instance.
    memcacheNodes List<Property Map>
    Additional information about the instance state, if available. Structure is documented below.
    pulumiLabels Map<String>
    The combination of labels configured directly on the resource and default labels configured on the provider.

    Look up Existing Instance Resource

    Get an existing Instance 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?: InstanceState, opts?: CustomResourceOptions): Instance
    @staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        authorized_network: Optional[str] = None,
        create_time: Optional[str] = None,
        discovery_endpoint: Optional[str] = None,
        display_name: Optional[str] = None,
        effective_labels: Optional[Mapping[str, str]] = None,
        labels: Optional[Mapping[str, str]] = None,
        maintenance_policy: Optional[InstanceMaintenancePolicyArgs] = None,
        maintenance_schedules: Optional[Sequence[InstanceMaintenanceScheduleArgs]] = None,
        memcache_full_version: Optional[str] = None,
        memcache_nodes: Optional[Sequence[InstanceMemcacheNodeArgs]] = None,
        memcache_parameters: Optional[InstanceMemcacheParametersArgs] = None,
        memcache_version: Optional[str] = None,
        name: Optional[str] = None,
        node_config: Optional[InstanceNodeConfigArgs] = None,
        node_count: Optional[int] = None,
        project: Optional[str] = None,
        pulumi_labels: Optional[Mapping[str, str]] = None,
        region: Optional[str] = None,
        reserved_ip_range_ids: Optional[Sequence[str]] = None,
        zones: Optional[Sequence[str]] = None) -> Instance
    func GetInstance(ctx *Context, name string, id IDInput, state *InstanceState, opts ...ResourceOption) (*Instance, error)
    public static Instance Get(string name, Input<string> id, InstanceState? state, CustomResourceOptions? opts = null)
    public static Instance get(String name, Output<String> id, InstanceState 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:
    AuthorizedNetwork string
    The full name of the GCE network to connect the instance to. If not provided, 'default' will be used.
    CreateTime string
    Creation timestamp in RFC3339 text format.
    DiscoveryEndpoint string
    Endpoint for Discovery API
    DisplayName string
    A user-visible name for the instance.
    EffectiveLabels Dictionary<string, string>
    All of labels (key/value pairs) present on the resource in GCP, including the labels configured through Pulumi, other clients and services.
    Labels Dictionary<string, string>
    Resource 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 'effective_labels' for all of the labels present on the resource.
    MaintenancePolicy InstanceMaintenancePolicy
    Maintenance policy for an instance.
    MaintenanceSchedules List<InstanceMaintenanceSchedule>
    Output only. Published maintenance schedule. Structure is documented below.
    MemcacheFullVersion string
    The full version of memcached server running on this instance.
    MemcacheNodes List<InstanceMemcacheNode>
    Additional information about the instance state, if available. Structure is documented below.
    MemcacheParameters InstanceMemcacheParameters
    User-specified parameters for this memcache instance.
    MemcacheVersion string
    The major version of Memcached software. If not provided, latest supported version will be used. Currently the latest supported major version is MEMCACHE_1_5. The minor version will be automatically determined by our system based on the latest supported minor version. Default value: "MEMCACHE_1_5" Possible values: ["MEMCACHE_1_5", "MEMCACHE_1_6_15"]
    Name string
    The resource name of the instance.
    NodeConfig InstanceNodeConfig
    Configuration for memcache nodes. Structure is documented below.
    NodeCount int
    Number of nodes in the memcache instance.
    Project string
    PulumiLabels Dictionary<string, string>
    The combination of labels configured directly on the resource and default labels configured on the provider.
    Region string
    The region of the Memcache instance. If it is not provided, the provider region is used.
    ReservedIpRangeIds List<string>
    Contains the name of allocated IP address ranges associated with the private service access connection for example, "test-default" associated with IP range 10.0.0.0/29.
    Zones List<string>
    Zones where memcache nodes should be provisioned. If not provided, all zones will be used.
    AuthorizedNetwork string
    The full name of the GCE network to connect the instance to. If not provided, 'default' will be used.
    CreateTime string
    Creation timestamp in RFC3339 text format.
    DiscoveryEndpoint string
    Endpoint for Discovery API
    DisplayName string
    A user-visible name for the instance.
    EffectiveLabels map[string]string
    All of labels (key/value pairs) present on the resource in GCP, including the labels configured through Pulumi, other clients and services.
    Labels map[string]string
    Resource 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 'effective_labels' for all of the labels present on the resource.
    MaintenancePolicy InstanceMaintenancePolicyArgs
    Maintenance policy for an instance.
    MaintenanceSchedules []InstanceMaintenanceScheduleArgs
    Output only. Published maintenance schedule. Structure is documented below.
    MemcacheFullVersion string
    The full version of memcached server running on this instance.
    MemcacheNodes []InstanceMemcacheNodeArgs
    Additional information about the instance state, if available. Structure is documented below.
    MemcacheParameters InstanceMemcacheParametersArgs
    User-specified parameters for this memcache instance.
    MemcacheVersion string
    The major version of Memcached software. If not provided, latest supported version will be used. Currently the latest supported major version is MEMCACHE_1_5. The minor version will be automatically determined by our system based on the latest supported minor version. Default value: "MEMCACHE_1_5" Possible values: ["MEMCACHE_1_5", "MEMCACHE_1_6_15"]
    Name string
    The resource name of the instance.
    NodeConfig InstanceNodeConfigArgs
    Configuration for memcache nodes. Structure is documented below.
    NodeCount int
    Number of nodes in the memcache instance.
    Project string
    PulumiLabels map[string]string
    The combination of labels configured directly on the resource and default labels configured on the provider.
    Region string
    The region of the Memcache instance. If it is not provided, the provider region is used.
    ReservedIpRangeIds []string
    Contains the name of allocated IP address ranges associated with the private service access connection for example, "test-default" associated with IP range 10.0.0.0/29.
    Zones []string
    Zones where memcache nodes should be provisioned. If not provided, all zones will be used.
    authorizedNetwork String
    The full name of the GCE network to connect the instance to. If not provided, 'default' will be used.
    createTime String
    Creation timestamp in RFC3339 text format.
    discoveryEndpoint String
    Endpoint for Discovery API
    displayName String
    A user-visible name for the instance.
    effectiveLabels Map<String,String>
    All of labels (key/value pairs) present on the resource in GCP, including the labels configured through Pulumi, other clients and services.
    labels Map<String,String>
    Resource 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 'effective_labels' for all of the labels present on the resource.
    maintenancePolicy InstanceMaintenancePolicy
    Maintenance policy for an instance.
    maintenanceSchedules List<InstanceMaintenanceSchedule>
    Output only. Published maintenance schedule. Structure is documented below.
    memcacheFullVersion String
    The full version of memcached server running on this instance.
    memcacheNodes List<InstanceMemcacheNode>
    Additional information about the instance state, if available. Structure is documented below.
    memcacheParameters InstanceMemcacheParameters
    User-specified parameters for this memcache instance.
    memcacheVersion String
    The major version of Memcached software. If not provided, latest supported version will be used. Currently the latest supported major version is MEMCACHE_1_5. The minor version will be automatically determined by our system based on the latest supported minor version. Default value: "MEMCACHE_1_5" Possible values: ["MEMCACHE_1_5", "MEMCACHE_1_6_15"]
    name String
    The resource name of the instance.
    nodeConfig InstanceNodeConfig
    Configuration for memcache nodes. Structure is documented below.
    nodeCount Integer
    Number of nodes in the memcache instance.
    project String
    pulumiLabels Map<String,String>
    The combination of labels configured directly on the resource and default labels configured on the provider.
    region String
    The region of the Memcache instance. If it is not provided, the provider region is used.
    reservedIpRangeIds List<String>
    Contains the name of allocated IP address ranges associated with the private service access connection for example, "test-default" associated with IP range 10.0.0.0/29.
    zones List<String>
    Zones where memcache nodes should be provisioned. If not provided, all zones will be used.
    authorizedNetwork string
    The full name of the GCE network to connect the instance to. If not provided, 'default' will be used.
    createTime string
    Creation timestamp in RFC3339 text format.
    discoveryEndpoint string
    Endpoint for Discovery API
    displayName string
    A user-visible name for the instance.
    effectiveLabels {[key: string]: string}
    All of labels (key/value pairs) present on the resource in GCP, including the labels configured through Pulumi, other clients and services.
    labels {[key: string]: string}
    Resource 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 'effective_labels' for all of the labels present on the resource.
    maintenancePolicy InstanceMaintenancePolicy
    Maintenance policy for an instance.
    maintenanceSchedules InstanceMaintenanceSchedule[]
    Output only. Published maintenance schedule. Structure is documented below.
    memcacheFullVersion string
    The full version of memcached server running on this instance.
    memcacheNodes InstanceMemcacheNode[]
    Additional information about the instance state, if available. Structure is documented below.
    memcacheParameters InstanceMemcacheParameters
    User-specified parameters for this memcache instance.
    memcacheVersion string
    The major version of Memcached software. If not provided, latest supported version will be used. Currently the latest supported major version is MEMCACHE_1_5. The minor version will be automatically determined by our system based on the latest supported minor version. Default value: "MEMCACHE_1_5" Possible values: ["MEMCACHE_1_5", "MEMCACHE_1_6_15"]
    name string
    The resource name of the instance.
    nodeConfig InstanceNodeConfig
    Configuration for memcache nodes. Structure is documented below.
    nodeCount number
    Number of nodes in the memcache instance.
    project string
    pulumiLabels {[key: string]: string}
    The combination of labels configured directly on the resource and default labels configured on the provider.
    region string
    The region of the Memcache instance. If it is not provided, the provider region is used.
    reservedIpRangeIds string[]
    Contains the name of allocated IP address ranges associated with the private service access connection for example, "test-default" associated with IP range 10.0.0.0/29.
    zones string[]
    Zones where memcache nodes should be provisioned. If not provided, all zones will be used.
    authorized_network str
    The full name of the GCE network to connect the instance to. If not provided, 'default' will be used.
    create_time str
    Creation timestamp in RFC3339 text format.
    discovery_endpoint str
    Endpoint for Discovery API
    display_name str
    A user-visible name for the instance.
    effective_labels Mapping[str, str]
    All of labels (key/value pairs) present on the resource in GCP, including the labels configured through Pulumi, other clients and services.
    labels Mapping[str, str]
    Resource 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 'effective_labels' for all of the labels present on the resource.
    maintenance_policy InstanceMaintenancePolicyArgs
    Maintenance policy for an instance.
    maintenance_schedules Sequence[InstanceMaintenanceScheduleArgs]
    Output only. Published maintenance schedule. Structure is documented below.
    memcache_full_version str
    The full version of memcached server running on this instance.
    memcache_nodes Sequence[InstanceMemcacheNodeArgs]
    Additional information about the instance state, if available. Structure is documented below.
    memcache_parameters InstanceMemcacheParametersArgs
    User-specified parameters for this memcache instance.
    memcache_version str
    The major version of Memcached software. If not provided, latest supported version will be used. Currently the latest supported major version is MEMCACHE_1_5. The minor version will be automatically determined by our system based on the latest supported minor version. Default value: "MEMCACHE_1_5" Possible values: ["MEMCACHE_1_5", "MEMCACHE_1_6_15"]
    name str
    The resource name of the instance.
    node_config InstanceNodeConfigArgs
    Configuration for memcache nodes. Structure is documented below.
    node_count int
    Number of nodes in the memcache instance.
    project str
    pulumi_labels Mapping[str, str]
    The combination of labels configured directly on the resource and default labels configured on the provider.
    region str
    The region of the Memcache instance. If it is not provided, the provider region is used.
    reserved_ip_range_ids Sequence[str]
    Contains the name of allocated IP address ranges associated with the private service access connection for example, "test-default" associated with IP range 10.0.0.0/29.
    zones Sequence[str]
    Zones where memcache nodes should be provisioned. If not provided, all zones will be used.
    authorizedNetwork String
    The full name of the GCE network to connect the instance to. If not provided, 'default' will be used.
    createTime String
    Creation timestamp in RFC3339 text format.
    discoveryEndpoint String
    Endpoint for Discovery API
    displayName String
    A user-visible name for the instance.
    effectiveLabels Map<String>
    All of labels (key/value pairs) present on the resource in GCP, including the labels configured through Pulumi, other clients and services.
    labels Map<String>
    Resource 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 'effective_labels' for all of the labels present on the resource.
    maintenancePolicy Property Map
    Maintenance policy for an instance.
    maintenanceSchedules List<Property Map>
    Output only. Published maintenance schedule. Structure is documented below.
    memcacheFullVersion String
    The full version of memcached server running on this instance.
    memcacheNodes List<Property Map>
    Additional information about the instance state, if available. Structure is documented below.
    memcacheParameters Property Map
    User-specified parameters for this memcache instance.
    memcacheVersion String
    The major version of Memcached software. If not provided, latest supported version will be used. Currently the latest supported major version is MEMCACHE_1_5. The minor version will be automatically determined by our system based on the latest supported minor version. Default value: "MEMCACHE_1_5" Possible values: ["MEMCACHE_1_5", "MEMCACHE_1_6_15"]
    name String
    The resource name of the instance.
    nodeConfig Property Map
    Configuration for memcache nodes. Structure is documented below.
    nodeCount Number
    Number of nodes in the memcache instance.
    project String
    pulumiLabels Map<String>
    The combination of labels configured directly on the resource and default labels configured on the provider.
    region String
    The region of the Memcache instance. If it is not provided, the provider region is used.
    reservedIpRangeIds List<String>
    Contains the name of allocated IP address ranges associated with the private service access connection for example, "test-default" associated with IP range 10.0.0.0/29.
    zones List<String>
    Zones where memcache nodes should be provisioned. If not provided, all zones will be used.

    Supporting Types

    InstanceMaintenancePolicy, InstanceMaintenancePolicyArgs

    WeeklyMaintenanceWindows List<InstanceMaintenancePolicyWeeklyMaintenanceWindow>
    Required. Maintenance window that is applied to resources covered by this policy. Minimum 1. For the current version, the maximum number of weekly_maintenance_windows is expected to be one. Structure is documented below.
    CreateTime string
    (Output) Output only. The time when the policy was created. A timestamp in RFC3339 UTC "Zulu" format, with nanosecond resolution and up to nine fractional digits
    Description string
    Optional. Description of what this policy is for. Create/Update methods return INVALID_ARGUMENT if the length is greater than 512.
    UpdateTime string
    (Output) Output only. The time when the policy was updated. A timestamp in RFC3339 UTC "Zulu" format, with nanosecond resolution and up to nine fractional digits.
    WeeklyMaintenanceWindows []InstanceMaintenancePolicyWeeklyMaintenanceWindow
    Required. Maintenance window that is applied to resources covered by this policy. Minimum 1. For the current version, the maximum number of weekly_maintenance_windows is expected to be one. Structure is documented below.
    CreateTime string
    (Output) Output only. The time when the policy was created. A timestamp in RFC3339 UTC "Zulu" format, with nanosecond resolution and up to nine fractional digits
    Description string
    Optional. Description of what this policy is for. Create/Update methods return INVALID_ARGUMENT if the length is greater than 512.
    UpdateTime string
    (Output) Output only. The time when the policy was updated. A timestamp in RFC3339 UTC "Zulu" format, with nanosecond resolution and up to nine fractional digits.
    weeklyMaintenanceWindows List<InstanceMaintenancePolicyWeeklyMaintenanceWindow>
    Required. Maintenance window that is applied to resources covered by this policy. Minimum 1. For the current version, the maximum number of weekly_maintenance_windows is expected to be one. Structure is documented below.
    createTime String
    (Output) Output only. The time when the policy was created. A timestamp in RFC3339 UTC "Zulu" format, with nanosecond resolution and up to nine fractional digits
    description String
    Optional. Description of what this policy is for. Create/Update methods return INVALID_ARGUMENT if the length is greater than 512.
    updateTime String
    (Output) Output only. The time when the policy was updated. A timestamp in RFC3339 UTC "Zulu" format, with nanosecond resolution and up to nine fractional digits.
    weeklyMaintenanceWindows InstanceMaintenancePolicyWeeklyMaintenanceWindow[]
    Required. Maintenance window that is applied to resources covered by this policy. Minimum 1. For the current version, the maximum number of weekly_maintenance_windows is expected to be one. Structure is documented below.
    createTime string
    (Output) Output only. The time when the policy was created. A timestamp in RFC3339 UTC "Zulu" format, with nanosecond resolution and up to nine fractional digits
    description string
    Optional. Description of what this policy is for. Create/Update methods return INVALID_ARGUMENT if the length is greater than 512.
    updateTime string
    (Output) Output only. The time when the policy was updated. A timestamp in RFC3339 UTC "Zulu" format, with nanosecond resolution and up to nine fractional digits.
    weekly_maintenance_windows Sequence[InstanceMaintenancePolicyWeeklyMaintenanceWindow]
    Required. Maintenance window that is applied to resources covered by this policy. Minimum 1. For the current version, the maximum number of weekly_maintenance_windows is expected to be one. Structure is documented below.
    create_time str
    (Output) Output only. The time when the policy was created. A timestamp in RFC3339 UTC "Zulu" format, with nanosecond resolution and up to nine fractional digits
    description str
    Optional. Description of what this policy is for. Create/Update methods return INVALID_ARGUMENT if the length is greater than 512.
    update_time str
    (Output) Output only. The time when the policy was updated. A timestamp in RFC3339 UTC "Zulu" format, with nanosecond resolution and up to nine fractional digits.
    weeklyMaintenanceWindows List<Property Map>
    Required. Maintenance window that is applied to resources covered by this policy. Minimum 1. For the current version, the maximum number of weekly_maintenance_windows is expected to be one. Structure is documented below.
    createTime String
    (Output) Output only. The time when the policy was created. A timestamp in RFC3339 UTC "Zulu" format, with nanosecond resolution and up to nine fractional digits
    description String
    Optional. Description of what this policy is for. Create/Update methods return INVALID_ARGUMENT if the length is greater than 512.
    updateTime String
    (Output) Output only. The time when the policy was updated. A timestamp in RFC3339 UTC "Zulu" format, with nanosecond resolution and up to nine fractional digits.

    InstanceMaintenancePolicyWeeklyMaintenanceWindow, InstanceMaintenancePolicyWeeklyMaintenanceWindowArgs

    Day string
    Required. The day of week that maintenance updates occur.

    • DAY_OF_WEEK_UNSPECIFIED: The day of the week is unspecified.
    • MONDAY: Monday
    • TUESDAY: Tuesday
    • WEDNESDAY: Wednesday
    • THURSDAY: Thursday
    • FRIDAY: Friday
    • SATURDAY: Saturday
    • SUNDAY: Sunday Possible values are: DAY_OF_WEEK_UNSPECIFIED, MONDAY, TUESDAY, WEDNESDAY, THURSDAY, FRIDAY, SATURDAY, SUNDAY.
    Duration string
    Required. The length of the maintenance window, ranging from 3 hours to 8 hours. A duration in seconds with up to nine fractional digits, terminated by 's'. Example: "3.5s".
    StartTime InstanceMaintenancePolicyWeeklyMaintenanceWindowStartTime
    Required. Start time of the window in UTC time. Structure is documented below.
    Day string
    Required. The day of week that maintenance updates occur.

    • DAY_OF_WEEK_UNSPECIFIED: The day of the week is unspecified.
    • MONDAY: Monday
    • TUESDAY: Tuesday
    • WEDNESDAY: Wednesday
    • THURSDAY: Thursday
    • FRIDAY: Friday
    • SATURDAY: Saturday
    • SUNDAY: Sunday Possible values are: DAY_OF_WEEK_UNSPECIFIED, MONDAY, TUESDAY, WEDNESDAY, THURSDAY, FRIDAY, SATURDAY, SUNDAY.
    Duration string
    Required. The length of the maintenance window, ranging from 3 hours to 8 hours. A duration in seconds with up to nine fractional digits, terminated by 's'. Example: "3.5s".
    StartTime InstanceMaintenancePolicyWeeklyMaintenanceWindowStartTime
    Required. Start time of the window in UTC time. Structure is documented below.
    day String
    Required. The day of week that maintenance updates occur.

    • DAY_OF_WEEK_UNSPECIFIED: The day of the week is unspecified.
    • MONDAY: Monday
    • TUESDAY: Tuesday
    • WEDNESDAY: Wednesday
    • THURSDAY: Thursday
    • FRIDAY: Friday
    • SATURDAY: Saturday
    • SUNDAY: Sunday Possible values are: DAY_OF_WEEK_UNSPECIFIED, MONDAY, TUESDAY, WEDNESDAY, THURSDAY, FRIDAY, SATURDAY, SUNDAY.
    duration String
    Required. The length of the maintenance window, ranging from 3 hours to 8 hours. A duration in seconds with up to nine fractional digits, terminated by 's'. Example: "3.5s".
    startTime InstanceMaintenancePolicyWeeklyMaintenanceWindowStartTime
    Required. Start time of the window in UTC time. Structure is documented below.
    day string
    Required. The day of week that maintenance updates occur.

    • DAY_OF_WEEK_UNSPECIFIED: The day of the week is unspecified.
    • MONDAY: Monday
    • TUESDAY: Tuesday
    • WEDNESDAY: Wednesday
    • THURSDAY: Thursday
    • FRIDAY: Friday
    • SATURDAY: Saturday
    • SUNDAY: Sunday Possible values are: DAY_OF_WEEK_UNSPECIFIED, MONDAY, TUESDAY, WEDNESDAY, THURSDAY, FRIDAY, SATURDAY, SUNDAY.
    duration string
    Required. The length of the maintenance window, ranging from 3 hours to 8 hours. A duration in seconds with up to nine fractional digits, terminated by 's'. Example: "3.5s".
    startTime InstanceMaintenancePolicyWeeklyMaintenanceWindowStartTime
    Required. Start time of the window in UTC time. Structure is documented below.
    day str
    Required. The day of week that maintenance updates occur.

    • DAY_OF_WEEK_UNSPECIFIED: The day of the week is unspecified.
    • MONDAY: Monday
    • TUESDAY: Tuesday
    • WEDNESDAY: Wednesday
    • THURSDAY: Thursday
    • FRIDAY: Friday
    • SATURDAY: Saturday
    • SUNDAY: Sunday Possible values are: DAY_OF_WEEK_UNSPECIFIED, MONDAY, TUESDAY, WEDNESDAY, THURSDAY, FRIDAY, SATURDAY, SUNDAY.
    duration str
    Required. The length of the maintenance window, ranging from 3 hours to 8 hours. A duration in seconds with up to nine fractional digits, terminated by 's'. Example: "3.5s".
    start_time InstanceMaintenancePolicyWeeklyMaintenanceWindowStartTime
    Required. Start time of the window in UTC time. Structure is documented below.
    day String
    Required. The day of week that maintenance updates occur.

    • DAY_OF_WEEK_UNSPECIFIED: The day of the week is unspecified.
    • MONDAY: Monday
    • TUESDAY: Tuesday
    • WEDNESDAY: Wednesday
    • THURSDAY: Thursday
    • FRIDAY: Friday
    • SATURDAY: Saturday
    • SUNDAY: Sunday Possible values are: DAY_OF_WEEK_UNSPECIFIED, MONDAY, TUESDAY, WEDNESDAY, THURSDAY, FRIDAY, SATURDAY, SUNDAY.
    duration String
    Required. The length of the maintenance window, ranging from 3 hours to 8 hours. A duration in seconds with up to nine fractional digits, terminated by 's'. Example: "3.5s".
    startTime Property Map
    Required. Start time of the window in UTC time. Structure is documented below.

    InstanceMaintenancePolicyWeeklyMaintenanceWindowStartTime, InstanceMaintenancePolicyWeeklyMaintenanceWindowStartTimeArgs

    Hours int
    Hours of day in 24 hour format. Should be from 0 to 23. An API may choose to allow the value "24:00:00" for scenarios like business closing time.
    Minutes int
    Minutes of hour of day. Must be from 0 to 59.
    Nanos int
    Fractions of seconds in nanoseconds. Must be from 0 to 999,999,999.
    Seconds int
    Seconds of minutes of the time. Must normally be from 0 to 59. An API may allow the value 60 if it allows leap-seconds.
    Hours int
    Hours of day in 24 hour format. Should be from 0 to 23. An API may choose to allow the value "24:00:00" for scenarios like business closing time.
    Minutes int
    Minutes of hour of day. Must be from 0 to 59.
    Nanos int
    Fractions of seconds in nanoseconds. Must be from 0 to 999,999,999.
    Seconds int
    Seconds of minutes of the time. Must normally be from 0 to 59. An API may allow the value 60 if it allows leap-seconds.
    hours Integer
    Hours of day in 24 hour format. Should be from 0 to 23. An API may choose to allow the value "24:00:00" for scenarios like business closing time.
    minutes Integer
    Minutes of hour of day. Must be from 0 to 59.
    nanos Integer
    Fractions of seconds in nanoseconds. Must be from 0 to 999,999,999.
    seconds Integer
    Seconds of minutes of the time. Must normally be from 0 to 59. An API may allow the value 60 if it allows leap-seconds.
    hours number
    Hours of day in 24 hour format. Should be from 0 to 23. An API may choose to allow the value "24:00:00" for scenarios like business closing time.
    minutes number
    Minutes of hour of day. Must be from 0 to 59.
    nanos number
    Fractions of seconds in nanoseconds. Must be from 0 to 999,999,999.
    seconds number
    Seconds of minutes of the time. Must normally be from 0 to 59. An API may allow the value 60 if it allows leap-seconds.
    hours int
    Hours of day in 24 hour format. Should be from 0 to 23. An API may choose to allow the value "24:00:00" for scenarios like business closing time.
    minutes int
    Minutes of hour of day. Must be from 0 to 59.
    nanos int
    Fractions of seconds in nanoseconds. Must be from 0 to 999,999,999.
    seconds int
    Seconds of minutes of the time. Must normally be from 0 to 59. An API may allow the value 60 if it allows leap-seconds.
    hours Number
    Hours of day in 24 hour format. Should be from 0 to 23. An API may choose to allow the value "24:00:00" for scenarios like business closing time.
    minutes Number
    Minutes of hour of day. Must be from 0 to 59.
    nanos Number
    Fractions of seconds in nanoseconds. Must be from 0 to 999,999,999.
    seconds Number
    Seconds of minutes of the time. Must normally be from 0 to 59. An API may allow the value 60 if it allows leap-seconds.

    InstanceMaintenanceSchedule, InstanceMaintenanceScheduleArgs

    EndTime string
    (Output) Output only. The end time of any upcoming scheduled maintenance for this instance. A timestamp in RFC3339 UTC "Zulu" format, with nanosecond resolution and up to nine fractional digits.
    ScheduleDeadlineTime string
    (Output) Output only. The deadline that the maintenance schedule start time can not go beyond, including reschedule. A timestamp in RFC3339 UTC "Zulu" format, with nanosecond resolution and up to nine fractional digits.
    StartTime string
    (Output) Output only. The start time of any upcoming scheduled maintenance for this instance. A timestamp in RFC3339 UTC "Zulu" format, with nanosecond resolution and up to nine fractional digits.
    EndTime string
    (Output) Output only. The end time of any upcoming scheduled maintenance for this instance. A timestamp in RFC3339 UTC "Zulu" format, with nanosecond resolution and up to nine fractional digits.
    ScheduleDeadlineTime string
    (Output) Output only. The deadline that the maintenance schedule start time can not go beyond, including reschedule. A timestamp in RFC3339 UTC "Zulu" format, with nanosecond resolution and up to nine fractional digits.
    StartTime string
    (Output) Output only. The start time of any upcoming scheduled maintenance for this instance. A timestamp in RFC3339 UTC "Zulu" format, with nanosecond resolution and up to nine fractional digits.
    endTime String
    (Output) Output only. The end time of any upcoming scheduled maintenance for this instance. A timestamp in RFC3339 UTC "Zulu" format, with nanosecond resolution and up to nine fractional digits.
    scheduleDeadlineTime String
    (Output) Output only. The deadline that the maintenance schedule start time can not go beyond, including reschedule. A timestamp in RFC3339 UTC "Zulu" format, with nanosecond resolution and up to nine fractional digits.
    startTime String
    (Output) Output only. The start time of any upcoming scheduled maintenance for this instance. A timestamp in RFC3339 UTC "Zulu" format, with nanosecond resolution and up to nine fractional digits.
    endTime string
    (Output) Output only. The end time of any upcoming scheduled maintenance for this instance. A timestamp in RFC3339 UTC "Zulu" format, with nanosecond resolution and up to nine fractional digits.
    scheduleDeadlineTime string
    (Output) Output only. The deadline that the maintenance schedule start time can not go beyond, including reschedule. A timestamp in RFC3339 UTC "Zulu" format, with nanosecond resolution and up to nine fractional digits.
    startTime string
    (Output) Output only. The start time of any upcoming scheduled maintenance for this instance. A timestamp in RFC3339 UTC "Zulu" format, with nanosecond resolution and up to nine fractional digits.
    end_time str
    (Output) Output only. The end time of any upcoming scheduled maintenance for this instance. A timestamp in RFC3339 UTC "Zulu" format, with nanosecond resolution and up to nine fractional digits.
    schedule_deadline_time str
    (Output) Output only. The deadline that the maintenance schedule start time can not go beyond, including reschedule. A timestamp in RFC3339 UTC "Zulu" format, with nanosecond resolution and up to nine fractional digits.
    start_time str
    (Output) Output only. The start time of any upcoming scheduled maintenance for this instance. A timestamp in RFC3339 UTC "Zulu" format, with nanosecond resolution and up to nine fractional digits.
    endTime String
    (Output) Output only. The end time of any upcoming scheduled maintenance for this instance. A timestamp in RFC3339 UTC "Zulu" format, with nanosecond resolution and up to nine fractional digits.
    scheduleDeadlineTime String
    (Output) Output only. The deadline that the maintenance schedule start time can not go beyond, including reschedule. A timestamp in RFC3339 UTC "Zulu" format, with nanosecond resolution and up to nine fractional digits.
    startTime String
    (Output) Output only. The start time of any upcoming scheduled maintenance for this instance. A timestamp in RFC3339 UTC "Zulu" format, with nanosecond resolution and up to nine fractional digits.

    InstanceMemcacheNode, InstanceMemcacheNodeArgs

    Host string
    (Output) Hostname or IP address of the Memcached node used by the clients to connect to the Memcached server on this node.
    NodeId string
    (Output) Identifier of the Memcached node. The node id does not include project or location like the Memcached instance name.
    Port int
    (Output) The port number of the Memcached server on this node.
    State string
    (Output) Current state of the Memcached node.
    Zone string
    (Output) Location (GCP Zone) for the Memcached node.
    Host string
    (Output) Hostname or IP address of the Memcached node used by the clients to connect to the Memcached server on this node.
    NodeId string
    (Output) Identifier of the Memcached node. The node id does not include project or location like the Memcached instance name.
    Port int
    (Output) The port number of the Memcached server on this node.
    State string
    (Output) Current state of the Memcached node.
    Zone string
    (Output) Location (GCP Zone) for the Memcached node.
    host String
    (Output) Hostname or IP address of the Memcached node used by the clients to connect to the Memcached server on this node.
    nodeId String
    (Output) Identifier of the Memcached node. The node id does not include project or location like the Memcached instance name.
    port Integer
    (Output) The port number of the Memcached server on this node.
    state String
    (Output) Current state of the Memcached node.
    zone String
    (Output) Location (GCP Zone) for the Memcached node.
    host string
    (Output) Hostname or IP address of the Memcached node used by the clients to connect to the Memcached server on this node.
    nodeId string
    (Output) Identifier of the Memcached node. The node id does not include project or location like the Memcached instance name.
    port number
    (Output) The port number of the Memcached server on this node.
    state string
    (Output) Current state of the Memcached node.
    zone string
    (Output) Location (GCP Zone) for the Memcached node.
    host str
    (Output) Hostname or IP address of the Memcached node used by the clients to connect to the Memcached server on this node.
    node_id str
    (Output) Identifier of the Memcached node. The node id does not include project or location like the Memcached instance name.
    port int
    (Output) The port number of the Memcached server on this node.
    state str
    (Output) Current state of the Memcached node.
    zone str
    (Output) Location (GCP Zone) for the Memcached node.
    host String
    (Output) Hostname or IP address of the Memcached node used by the clients to connect to the Memcached server on this node.
    nodeId String
    (Output) Identifier of the Memcached node. The node id does not include project or location like the Memcached instance name.
    port Number
    (Output) The port number of the Memcached server on this node.
    state String
    (Output) Current state of the Memcached node.
    zone String
    (Output) Location (GCP Zone) for the Memcached node.

    InstanceMemcacheParameters, InstanceMemcacheParametersArgs

    Id string
    (Output) This is a unique ID associated with this set of parameters.
    Params Dictionary<string, string>
    User-defined set of parameters to use in the memcache process.
    Id string
    (Output) This is a unique ID associated with this set of parameters.
    Params map[string]string
    User-defined set of parameters to use in the memcache process.
    id String
    (Output) This is a unique ID associated with this set of parameters.
    params Map<String,String>
    User-defined set of parameters to use in the memcache process.
    id string
    (Output) This is a unique ID associated with this set of parameters.
    params {[key: string]: string}
    User-defined set of parameters to use in the memcache process.
    id str
    (Output) This is a unique ID associated with this set of parameters.
    params Mapping[str, str]
    User-defined set of parameters to use in the memcache process.
    id String
    (Output) This is a unique ID associated with this set of parameters.
    params Map<String>
    User-defined set of parameters to use in the memcache process.

    InstanceNodeConfig, InstanceNodeConfigArgs

    CpuCount int
    Number of CPUs per node.
    MemorySizeMb int
    Memory size in Mebibytes for each memcache node.

    CpuCount int
    Number of CPUs per node.
    MemorySizeMb int
    Memory size in Mebibytes for each memcache node.

    cpuCount Integer
    Number of CPUs per node.
    memorySizeMb Integer
    Memory size in Mebibytes for each memcache node.

    cpuCount number
    Number of CPUs per node.
    memorySizeMb number
    Memory size in Mebibytes for each memcache node.

    cpu_count int
    Number of CPUs per node.
    memory_size_mb int
    Memory size in Mebibytes for each memcache node.

    cpuCount Number
    Number of CPUs per node.
    memorySizeMb Number
    Memory size in Mebibytes for each memcache node.

    Import

    Instance can be imported using any of these accepted formats:

    • projects/{{project}}/locations/{{region}}/instances/{{name}}

    • {{project}}/{{region}}/{{name}}

    • {{region}}/{{name}}

    • {{name}}

    When using the pulumi import command, Instance can be imported using one of the formats above. For example:

    $ pulumi import gcp:memcache/instance:Instance default projects/{{project}}/locations/{{region}}/instances/{{name}}

    $ pulumi import gcp:memcache/instance:Instance default {{project}}/{{region}}/{{name}}

    $ pulumi import gcp:memcache/instance:Instance default {{region}}/{{name}}

    $ pulumi import gcp:memcache/instance:Instance default {{name}}

    To learn more about importing existing cloud resources, see Importing resources.

    Package Details

    Repository
    Google Cloud (GCP) Classic pulumi/pulumi-gcp
    License
    Apache-2.0
    Notes
    This Pulumi package is based on the google-beta Terraform Provider.
    gcp logo
    Google Cloud Classic v8.9.3 published on Monday, Nov 18, 2024 by Pulumi
    pulumi/pulumi-gcp