Instance

Create a Instance Resource

new Instance(name: string, args: InstanceArgs, opts?: CustomResourceOptions);

def Instance(resource_name, opts=None, authorized_network=None, display_name=None, labels=None, memcache_parameters=None, name=None, node_config=None, node_count=None, project=None, region=None, zones=None, __props__=None);

func NewInstance(ctx *Context, name string, args InstanceArgs, opts ...ResourceOption) (*Instance, error)

public Instance(string name, InstanceArgs args, CustomResourceOptions? opts = null)

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.
opts ResourceOptions: A bag of options that control this 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.

Instance Resource Properties

To learn more about resource properties and how to use them, see Inputs and Outputs in the Programming Model docs.

Inputs

The Instance resource accepts the following input properties:

NodeConfig InstanceNodeConfigArgs: Configuration for memcache nodes. Structure is documented below.
NodeCount int: Number of nodes in the memcache instance.
Region string: The name of the Memcache region of the 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.
MemcacheParameters InstanceMemcacheParametersArgs: User-specified parameters for this memcache instance. Structure is documented below.
Name string: The resource name of the instance.
Project string: The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
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 int: Number of nodes in the memcache instance.
Region string: The name of the Memcache region of the 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.
MemcacheParameters InstanceMemcacheParameters: User-specified parameters for this memcache instance. Structure is documented below.
Name string: The resource name of the instance.
Project string: The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
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 number: Number of nodes in the memcache instance.
region string: The name of the Memcache region of the 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.
memcacheParameters InstanceMemcacheParameters: User-specified parameters for this memcache instance. Structure is documented below.
name string: The resource name of the instance.
project string: The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
zones string[]: Zones where memcache nodes should be provisioned. If not provided, all zones will be used.

node_config Dict[InstanceNodeConfig]: Configuration for memcache nodes. Structure is documented below.
node_count float: Number of nodes in the memcache instance.
region str: The name of the Memcache region of the 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 Dict[str, str]: Resource labels to represent user-provided metadata.
memcache_parameters Dict[InstanceMemcacheParameters]: User-specified parameters for this memcache instance. Structure is documented below.
name str: The resource name of the instance.
project str: The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
zones List[str]: 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.
Id string: The provider-assigned unique ID for this managed resource.

CreateTime string: Creation timestamp in RFC3339 text format.
Id string: The provider-assigned unique ID for this managed resource.

createTime string: Creation timestamp in RFC3339 text format.
id string: The provider-assigned unique ID for this managed resource.

create_time str: Creation timestamp in RFC3339 text format.
id str: The provider-assigned unique ID for this managed resource.

Look up an 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

static get(resource_name, id, opts=None, authorized_network=None, create_time=None, display_name=None, labels=None, memcache_parameters=None, name=None, node_config=None, node_count=None, project=None, region=None, zones=None, __props__=None);

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)

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.

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.
DisplayName string: A user-visible name for the instance.
Labels Dictionary<string, string>: Resource labels to represent user-provided metadata.
MemcacheParameters InstanceMemcacheParametersArgs: User-specified parameters for this memcache instance. Structure is documented below.
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: The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
Region string: The name of the Memcache region of the instance.
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.
DisplayName string: A user-visible name for the instance.
Labels map[string]string: Resource labels to represent user-provided metadata.
MemcacheParameters InstanceMemcacheParameters: User-specified parameters for this memcache instance. Structure is documented below.
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: The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
Region string: The name of the Memcache region of the instance.
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.
displayName string: A user-visible name for the instance.
labels {[key: string]: string}: Resource labels to represent user-provided metadata.
memcacheParameters InstanceMemcacheParameters: User-specified parameters for this memcache instance. Structure is documented below.
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: The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
region string: The name of the Memcache region of the instance.
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.
display_name str: A user-visible name for the instance.
labels Dict[str, str]: Resource labels to represent user-provided metadata.
memcache_parameters Dict[InstanceMemcacheParameters]: User-specified parameters for this memcache instance. Structure is documented below.
name str: The resource name of the instance.
node_config Dict[InstanceNodeConfig]: Configuration for memcache nodes. Structure is documented below.
node_count float: Number of nodes in the memcache instance.
project str: The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
region str: The name of the Memcache region of the instance.
zones List[str]: Zones where memcache nodes should be provisioned. If not provided, all zones will be used.

Supporting Types

InstanceMemcacheParameters

See the input and output API doc for this type.

Id string: - 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: - 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: - 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: - This is a unique ID associated with this set of parameters.
params Dict[str, str]: User-defined set of parameters to use in the memcache process.

InstanceNodeConfig

See the input and output API doc for this type.

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 number: Number of CPUs per node.
memorySizeMb number: Memory size in Mebibytes for each memcache node.

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

Package Details

Repository: https://github.com/pulumi/pulumi-gcp
License: Apache-2.0
Notes: This Pulumi package is based on the google-beta Terraform Provider.

The Pulumi Platform

Get Started

Migrate to Pulumi

Solutions for All Teams and Engineers

Any Code

Any Cloud