Docs
Packagesconsul.AdminPartition
Explore with Pulumi AI
NOTE: This feature requires Consul Enterprise.
The consul.AdminPartition resource manages Consul Enterprise Admin Partitions.
Example Usage
using Pulumi;
using Consul = Pulumi.Consul;
class MyStack : Stack
{
public MyStack()
{
var naWest = new Consul.AdminPartition("naWest", new Consul.AdminPartitionArgs
{
Description = "Partition for North America West",
});
}
}
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, "naWest", &consul.AdminPartitionArgs{
Description: pulumi.String("Partition for North America West"),
})
if err != nil {
return err
}
return nil
})
}
Coming soon!
import pulumi
import pulumi_consul as consul
na_west = consul.AdminPartition("naWest", description="Partition for North America West")
import * as pulumi from "@pulumi/pulumi";
import * as consul from "@pulumi/consul";
const naWest = new consul.AdminPartition("na_west", {
description: "Partition for North America West",
});
Coming soon!
Create AdminPartition Resource
new AdminPartition(name: string, args?: AdminPartitionArgs, opts?: CustomResourceOptions);@overload
def AdminPartition(resource_name: str,
opts: Optional[ResourceOptions] = None,
description: Optional[str] = None,
name: Optional[str] = None)
@overload
def AdminPartition(resource_name: str,
args: Optional[AdminPartitionArgs] = None,
opts: Optional[ResourceOptions] = 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.
- name 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 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 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 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 String
- The unique name of the resource.
- args AdminPartitionArgs
- The arguments to resource properties.
- options CustomResourceOptions
- Bag of options to control resource's behavior.
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
The AdminPartition resource accepts the following input properties:
- Description string
Free form partition description.
- Name string
The partition name. This must be a valid DNS hostname label.
- Description string
Free form partition description.
- Name string
The partition name. This must be a valid DNS hostname label.
- description String
Free form partition description.
- name String
The partition name. This must be a valid DNS hostname label.
- description string
Free form partition description.
- name string
The partition name. This must be a valid DNS hostname label.
- description str
Free form partition description.
- name str
The partition name. This must be a valid DNS hostname label.
- description String
Free form partition description.
- name 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) -> AdminPartitionfunc 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)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.
- Description string
Free form partition description.
- Name string
The partition name. This must be a valid DNS hostname label.
- Description string
Free form partition description.
- Name string
The partition name. This must be a valid DNS hostname label.
- description String
Free form partition description.
- name String
The partition name. This must be a valid DNS hostname label.
- description string
Free form partition description.
- name string
The partition name. This must be a valid DNS hostname label.
- description str
Free form partition description.
- name str
The partition name. This must be a valid DNS hostname label.
- description String
Free form partition description.
- name 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
Package Details
- Repository
- HashiCorp Consul pulumi/pulumi-consul
- License
- Apache-2.0
- Notes
This Pulumi package is based on the
consulTerraform Provider.