Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi Cloud Packages Tutorials
  1. Packages
  2. Consul Provider
  3. API Docs
  4. AdminPartition
Consul v3.12.4 published on Wednesday, Feb 12, 2025 by Pulumi
pulumi/pulumi-consul

consul.AdminPartition

Explore with Pulumi AI

Consul v3.12.4 published on Wednesday, Feb 12, 2025 by Pulumi
pulumi/pulumi-consul

NOTE: This feature requires Consul Enterprise.

The consul.AdminPartition resource manages Consul Enterprise Admin Partitions.

Example Usage

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

const naWest = new consul.AdminPartition("na_west", {
    name: "na-west",
    description: "Partition for North America West",
});
Copy
import pulumi
import pulumi_consul as consul

na_west = consul.AdminPartition("na_west",
    name="na-west",
    description="Partition for North America West")
Copy
package main

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

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := consul.NewAdminPartition(ctx, "na_west", &consul.AdminPartitionArgs{
			Name:        pulumi.String("na-west"),
			Description: pulumi.String("Partition for North America West"),
		})
		if err != nil {
			return err
		}
		return nil
	})
}
Copy
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Consul = Pulumi.Consul;

return await Deployment.RunAsync(() => 
{
    var naWest = new Consul.AdminPartition("na_west", new()
    {
        Name = "na-west",
        Description = "Partition for North America West",
    });

});
Copy
package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.consul.AdminPartition;
import com.pulumi.consul.AdminPartitionArgs;
import java.util.List;
import java.util.ArrayList;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;

public class App {
    public static void main(String[] args) {
        Pulumi.run(App::stack);
    }

    public static void stack(Context ctx) {
        var naWest = new AdminPartition("naWest", AdminPartitionArgs.builder()
            .name("na-west")
            .description("Partition for North America West")
            .build());

    }
}
Copy
resources:
  naWest:
    type: consul:AdminPartition
    name: na_west
    properties:
      name: na-west
      description: Partition for North America West
Copy

Create AdminPartition Resource

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

Constructor syntax

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

@overload
def AdminPartition(resource_name: str,
                   opts: Optional[ResourceOptions] = None,
                   description: Optional[str] = None,
                   name: Optional[str] = None)
func NewAdminPartition(ctx *Context, name string, args *AdminPartitionArgs, opts ...ResourceOption) (*AdminPartition, error)
public AdminPartition(string name, AdminPartitionArgs? args = null, CustomResourceOptions? opts = null)
public AdminPartition(String name, AdminPartitionArgs args)
public AdminPartition(String name, AdminPartitionArgs args, CustomResourceOptions options)

type: consul:AdminPartition
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

Parameters

name This property is required. string
The unique name of the resource.
args AdminPartitionArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
resource_name This property is required. str
The unique name of the resource.
args AdminPartitionArgs
The arguments to resource properties.
opts ResourceOptions
Bag of options to control resource's behavior.
ctx Context
Context object for the current deployment.
name This property is required. string
The unique name of the resource.
args AdminPartitionArgs
The arguments to resource properties.
opts ResourceOption
Bag of options to control resource's behavior.
name This property is required. string
The unique name of the resource.
args AdminPartitionArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
name This property is required. String
The unique name of the resource.
args This property is required. AdminPartitionArgs
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 adminPartitionResource = new Consul.AdminPartition("adminPartitionResource", new()
{
    Description = "string",
    Name = "string",
});
Copy
example, err := consul.NewAdminPartition(ctx, "adminPartitionResource", &consul.AdminPartitionArgs{
	Description: pulumi.String("string"),
	Name:        pulumi.String("string"),
})
Copy
var adminPartitionResource = new AdminPartition("adminPartitionResource", AdminPartitionArgs.builder()
    .description("string")
    .name("string")
    .build());
Copy
admin_partition_resource = consul.AdminPartition("adminPartitionResource",
    description="string",
    name="string")
Copy
const adminPartitionResource = new consul.AdminPartition("adminPartitionResource", {
    description: "string",
    name: "string",
});
Copy
type: consul:AdminPartition
properties:
    description: string
    name: string
Copy

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

Description string
Free form partition description.
Name Changes to this property will trigger replacement. string
The partition name. This must be a valid DNS hostname label.
Description string
Free form partition description.
Name Changes to this property will trigger replacement. string
The partition name. This must be a valid DNS hostname label.
description String
Free form partition description.
name Changes to this property will trigger replacement. String
The partition name. This must be a valid DNS hostname label.
description string
Free form partition description.
name Changes to this property will trigger replacement. string
The partition name. This must be a valid DNS hostname label.
description str
Free form partition description.
name Changes to this property will trigger replacement. str
The partition name. This must be a valid DNS hostname label.
description String
Free form partition description.
name Changes to this property will trigger replacement. String
The partition name. This must be a valid DNS hostname label.

Outputs

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

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

Look up Existing AdminPartition Resource

Get an existing AdminPartition 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?: AdminPartitionState, opts?: CustomResourceOptions): AdminPartition
@staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        description: Optional[str] = None,
        name: Optional[str] = None) -> AdminPartition
func GetAdminPartition(ctx *Context, name string, id IDInput, state *AdminPartitionState, opts ...ResourceOption) (*AdminPartition, error)
public static AdminPartition Get(string name, Input<string> id, AdminPartitionState? state, CustomResourceOptions? opts = null)
public static AdminPartition get(String name, Output<String> id, AdminPartitionState state, CustomResourceOptions options)
resources:  _:    type: consul:AdminPartition    get:      id: ${id}
name This property is required.
The unique name of the resulting resource.
id This property is required.
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 This property is required.
The unique name of the resulting resource.
id This property is required.
The unique provider ID of the resource to lookup.
name This property is required.
The unique name of the resulting resource.
id This property is required.
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 This property is required.
The unique name of the resulting resource.
id This property is required.
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 This property is required.
The unique name of the resulting resource.
id This property is required.
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:
Description string
Free form partition description.
Name Changes to this property will trigger replacement. string
The partition name. This must be a valid DNS hostname label.
Description string
Free form partition description.
Name Changes to this property will trigger replacement. string
The partition name. This must be a valid DNS hostname label.
description String
Free form partition description.
name Changes to this property will trigger replacement. String
The partition name. This must be a valid DNS hostname label.
description string
Free form partition description.
name Changes to this property will trigger replacement. string
The partition name. This must be a valid DNS hostname label.
description str
Free form partition description.
name Changes to this property will trigger replacement. str
The partition name. This must be a valid DNS hostname label.
description String
Free form partition description.
name Changes to this property will trigger replacement. String
The partition name. This must be a valid DNS hostname label.

Import

consul_admin_partition can be imported:

$ pulumi import consul:index/adminPartition:AdminPartition na_west na-west
Copy

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

Package Details

Repository
HashiCorp Consul pulumi/pulumi-consul
License
Apache-2.0
Notes
This Pulumi package is based on the consul Terraform Provider.
Consul v3.12.4 published on Wednesday, Feb 12, 2025 by Pulumi
pulumi/pulumi-consul