Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi Cloud Packages Tutorials
  1. Packages
  2. HCP
  3. API Docs
  4. BoundaryCluster
HashiCorp Cloud Platform (HCP) v0.1.14 published on Friday, Dec 2, 2022 by Grapl Security
grapl-security/pulumi-hcp

hcp.BoundaryCluster

Explore with Pulumi AI

HashiCorp Cloud Platform (HCP) v0.1.14 published on Friday, Dec 2, 2022 by Grapl Security
grapl-security/pulumi-hcp

This resource allows you to manage an HCP Boundary cluster

Example Usage

using System.Collections.Generic;
using Pulumi;
using Hcp = Pulumi.Hcp;

return await Deployment.RunAsync(() => 
{
    var example = new Hcp.BoundaryCluster("example", new()
    {
        ClusterId = "boundary-cluster",
        Password = "Password123!",
        Username = "test-user",
    });

});
Copy
package main

import (
	"github.com/grapl-security/pulumi-hcp/sdk/go/hcp"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := hcp.NewBoundaryCluster(ctx, "example", &hcp.BoundaryClusterArgs{
			ClusterId: pulumi.String("boundary-cluster"),
			Password:  pulumi.String("Password123!"),
			Username:  pulumi.String("test-user"),
		})
		if err != nil {
			return err
		}
		return nil
	})
}
Copy
package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.hcp.BoundaryCluster;
import com.pulumi.hcp.BoundaryClusterArgs;
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 example = new BoundaryCluster("example", BoundaryClusterArgs.builder()        
            .clusterId("boundary-cluster")
            .password("Password123!")
            .username("test-user")
            .build());

    }
}
Copy
import * as pulumi from "@pulumi/pulumi";
import * as hcp from "@pulumi/hcp";

const example = new hcp.BoundaryCluster("example", {
    clusterId: "boundary-cluster",
    password: "Password123!",
    username: "test-user",
});
Copy
import pulumi
import pulumi_hcp as hcp

example = hcp.BoundaryCluster("example",
    cluster_id="boundary-cluster",
    password="Password123!",
    username="test-user")
Copy
resources:
  example:
    type: hcp:BoundaryCluster
    properties:
      clusterId: boundary-cluster
      password: Password123!
      username: test-user
Copy

Create BoundaryCluster Resource

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

Constructor syntax

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

@overload
def BoundaryCluster(resource_name: str,
                    opts: Optional[ResourceOptions] = None,
                    cluster_id: Optional[str] = None,
                    password: Optional[str] = None,
                    username: Optional[str] = None)
func NewBoundaryCluster(ctx *Context, name string, args BoundaryClusterArgs, opts ...ResourceOption) (*BoundaryCluster, error)
public BoundaryCluster(string name, BoundaryClusterArgs args, CustomResourceOptions? opts = null)
public BoundaryCluster(String name, BoundaryClusterArgs args)
public BoundaryCluster(String name, BoundaryClusterArgs args, CustomResourceOptions options)

type: hcp:BoundaryCluster
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 This property is required. BoundaryClusterArgs
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 This property is required. BoundaryClusterArgs
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 This property is required. BoundaryClusterArgs
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 This property is required. BoundaryClusterArgs
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. BoundaryClusterArgs
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 boundaryClusterResource = new Hcp.BoundaryCluster("boundaryClusterResource", new()
{
    ClusterId = "string",
    Password = "string",
    Username = "string",
});
Copy
example, err := hcp.NewBoundaryCluster(ctx, "boundaryClusterResource", &hcp.BoundaryClusterArgs{
	ClusterId: pulumi.String("string"),
	Password:  pulumi.String("string"),
	Username:  pulumi.String("string"),
})
Copy
var boundaryClusterResource = new BoundaryCluster("boundaryClusterResource", BoundaryClusterArgs.builder()
    .clusterId("string")
    .password("string")
    .username("string")
    .build());
Copy
boundary_cluster_resource = hcp.BoundaryCluster("boundaryClusterResource",
    cluster_id="string",
    password="string",
    username="string")
Copy
const boundaryClusterResource = new hcp.BoundaryCluster("boundaryClusterResource", {
    clusterId: "string",
    password: "string",
    username: "string",
});
Copy
type: hcp:BoundaryCluster
properties:
    clusterId: string
    password: string
    username: string
Copy

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

ClusterId
This property is required.
Changes to this property will trigger replacement.
string
The ID of the Boundary cluster
Password
This property is required.
Changes to this property will trigger replacement.
string
The password of the initial admin user. This must be at least 8 characters in length. Note that this may show up in logs, and it will be stored in the state file.
Username
This property is required.
Changes to this property will trigger replacement.
string
The username of the initial admin user. This must be at least 3 characters in length, alphanumeric, hyphen, or period.
ClusterId
This property is required.
Changes to this property will trigger replacement.
string
The ID of the Boundary cluster
Password
This property is required.
Changes to this property will trigger replacement.
string
The password of the initial admin user. This must be at least 8 characters in length. Note that this may show up in logs, and it will be stored in the state file.
Username
This property is required.
Changes to this property will trigger replacement.
string
The username of the initial admin user. This must be at least 3 characters in length, alphanumeric, hyphen, or period.
clusterId
This property is required.
Changes to this property will trigger replacement.
String
The ID of the Boundary cluster
password
This property is required.
Changes to this property will trigger replacement.
String
The password of the initial admin user. This must be at least 8 characters in length. Note that this may show up in logs, and it will be stored in the state file.
username
This property is required.
Changes to this property will trigger replacement.
String
The username of the initial admin user. This must be at least 3 characters in length, alphanumeric, hyphen, or period.
clusterId
This property is required.
Changes to this property will trigger replacement.
string
The ID of the Boundary cluster
password
This property is required.
Changes to this property will trigger replacement.
string
The password of the initial admin user. This must be at least 8 characters in length. Note that this may show up in logs, and it will be stored in the state file.
username
This property is required.
Changes to this property will trigger replacement.
string
The username of the initial admin user. This must be at least 3 characters in length, alphanumeric, hyphen, or period.
cluster_id
This property is required.
Changes to this property will trigger replacement.
str
The ID of the Boundary cluster
password
This property is required.
Changes to this property will trigger replacement.
str
The password of the initial admin user. This must be at least 8 characters in length. Note that this may show up in logs, and it will be stored in the state file.
username
This property is required.
Changes to this property will trigger replacement.
str
The username of the initial admin user. This must be at least 3 characters in length, alphanumeric, hyphen, or period.
clusterId
This property is required.
Changes to this property will trigger replacement.
String
The ID of the Boundary cluster
password
This property is required.
Changes to this property will trigger replacement.
String
The password of the initial admin user. This must be at least 8 characters in length. Note that this may show up in logs, and it will be stored in the state file.
username
This property is required.
Changes to this property will trigger replacement.
String
The username of the initial admin user. This must be at least 3 characters in length, alphanumeric, hyphen, or period.

Outputs

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

ClusterUrl string
A unique URL identifying the Boundary cluster.
CreatedAt string
The time that the Boundary cluster was created.
Id string
The provider-assigned unique ID for this managed resource.
State string
The state of the Boundary cluster.
ClusterUrl string
A unique URL identifying the Boundary cluster.
CreatedAt string
The time that the Boundary cluster was created.
Id string
The provider-assigned unique ID for this managed resource.
State string
The state of the Boundary cluster.
clusterUrl String
A unique URL identifying the Boundary cluster.
createdAt String
The time that the Boundary cluster was created.
id String
The provider-assigned unique ID for this managed resource.
state String
The state of the Boundary cluster.
clusterUrl string
A unique URL identifying the Boundary cluster.
createdAt string
The time that the Boundary cluster was created.
id string
The provider-assigned unique ID for this managed resource.
state string
The state of the Boundary cluster.
cluster_url str
A unique URL identifying the Boundary cluster.
created_at str
The time that the Boundary cluster was created.
id str
The provider-assigned unique ID for this managed resource.
state str
The state of the Boundary cluster.
clusterUrl String
A unique URL identifying the Boundary cluster.
createdAt String
The time that the Boundary cluster was created.
id String
The provider-assigned unique ID for this managed resource.
state String
The state of the Boundary cluster.

Look up Existing BoundaryCluster Resource

Get an existing BoundaryCluster 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?: BoundaryClusterState, opts?: CustomResourceOptions): BoundaryCluster
@staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        cluster_id: Optional[str] = None,
        cluster_url: Optional[str] = None,
        created_at: Optional[str] = None,
        password: Optional[str] = None,
        state: Optional[str] = None,
        username: Optional[str] = None) -> BoundaryCluster
func GetBoundaryCluster(ctx *Context, name string, id IDInput, state *BoundaryClusterState, opts ...ResourceOption) (*BoundaryCluster, error)
public static BoundaryCluster Get(string name, Input<string> id, BoundaryClusterState? state, CustomResourceOptions? opts = null)
public static BoundaryCluster get(String name, Output<String> id, BoundaryClusterState state, CustomResourceOptions options)
resources:  _:    type: hcp:BoundaryCluster    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:
ClusterId Changes to this property will trigger replacement. string
The ID of the Boundary cluster
ClusterUrl string
A unique URL identifying the Boundary cluster.
CreatedAt string
The time that the Boundary cluster was created.
Password Changes to this property will trigger replacement. string
The password of the initial admin user. This must be at least 8 characters in length. Note that this may show up in logs, and it will be stored in the state file.
State string
The state of the Boundary cluster.
Username Changes to this property will trigger replacement. string
The username of the initial admin user. This must be at least 3 characters in length, alphanumeric, hyphen, or period.
ClusterId Changes to this property will trigger replacement. string
The ID of the Boundary cluster
ClusterUrl string
A unique URL identifying the Boundary cluster.
CreatedAt string
The time that the Boundary cluster was created.
Password Changes to this property will trigger replacement. string
The password of the initial admin user. This must be at least 8 characters in length. Note that this may show up in logs, and it will be stored in the state file.
State string
The state of the Boundary cluster.
Username Changes to this property will trigger replacement. string
The username of the initial admin user. This must be at least 3 characters in length, alphanumeric, hyphen, or period.
clusterId Changes to this property will trigger replacement. String
The ID of the Boundary cluster
clusterUrl String
A unique URL identifying the Boundary cluster.
createdAt String
The time that the Boundary cluster was created.
password Changes to this property will trigger replacement. String
The password of the initial admin user. This must be at least 8 characters in length. Note that this may show up in logs, and it will be stored in the state file.
state String
The state of the Boundary cluster.
username Changes to this property will trigger replacement. String
The username of the initial admin user. This must be at least 3 characters in length, alphanumeric, hyphen, or period.
clusterId Changes to this property will trigger replacement. string
The ID of the Boundary cluster
clusterUrl string
A unique URL identifying the Boundary cluster.
createdAt string
The time that the Boundary cluster was created.
password Changes to this property will trigger replacement. string
The password of the initial admin user. This must be at least 8 characters in length. Note that this may show up in logs, and it will be stored in the state file.
state string
The state of the Boundary cluster.
username Changes to this property will trigger replacement. string
The username of the initial admin user. This must be at least 3 characters in length, alphanumeric, hyphen, or period.
cluster_id Changes to this property will trigger replacement. str
The ID of the Boundary cluster
cluster_url str
A unique URL identifying the Boundary cluster.
created_at str
The time that the Boundary cluster was created.
password Changes to this property will trigger replacement. str
The password of the initial admin user. This must be at least 8 characters in length. Note that this may show up in logs, and it will be stored in the state file.
state str
The state of the Boundary cluster.
username Changes to this property will trigger replacement. str
The username of the initial admin user. This must be at least 3 characters in length, alphanumeric, hyphen, or period.
clusterId Changes to this property will trigger replacement. String
The ID of the Boundary cluster
clusterUrl String
A unique URL identifying the Boundary cluster.
createdAt String
The time that the Boundary cluster was created.
password Changes to this property will trigger replacement. String
The password of the initial admin user. This must be at least 8 characters in length. Note that this may show up in logs, and it will be stored in the state file.
state String
The state of the Boundary cluster.
username Changes to this property will trigger replacement. String
The username of the initial admin user. This must be at least 3 characters in length, alphanumeric, hyphen, or period.

Import

The import ID is {cluster_id}

 $ pulumi import hcp:index/boundaryCluster:BoundaryCluster example boundary-cluster
Copy

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

Package Details

Repository
hcp grapl-security/pulumi-hcp
License
Apache-2.0
Notes
This Pulumi package is based on the hcp Terraform Provider.
HashiCorp Cloud Platform (HCP) v0.1.14 published on Friday, Dec 2, 2022 by Grapl Security
grapl-security/pulumi-hcp