terraformcloud

package
v6.1.0 Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: Apr 4, 2024 License: Apache-2.0 Imports: 7 Imported by: 0

Documentation

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

This section is empty.

Types

type SecretBackend 

type SecretBackend struct {
	pulumi.CustomResourceState

	// Specifies the address of the Terraform Cloud instance, provided as "host:port" like "127.0.0.1:8500".
	Address pulumi.StringPtrOutput `pulumi:"address"`
	// Unique name of the Vault Terraform Cloud mount to configure
	Backend pulumi.StringPtrOutput `pulumi:"backend"`
	// Specifies the base path for the Terraform Cloud or Enterprise API.
	BasePath pulumi.StringPtrOutput `pulumi:"basePath"`
	// The default TTL for credentials issued by this backend.
	DefaultLeaseTtlSeconds pulumi.IntPtrOutput `pulumi:"defaultLeaseTtlSeconds"`
	// A human-friendly description for this backend.
	Description pulumi.StringPtrOutput `pulumi:"description"`
	// If set, opts out of mount migration on path updates.
	// See here for more info on [Mount Migration](https://www.vaultproject.io/docs/concepts/mount-migration)
	DisableRemount pulumi.BoolPtrOutput `pulumi:"disableRemount"`
	// The maximum TTL that can be requested
	// for credentials issued by this backend.
	MaxLeaseTtlSeconds pulumi.IntPtrOutput `pulumi:"maxLeaseTtlSeconds"`
	// The namespace to provision the resource in.
	// The value should not contain leading or trailing forward slashes.
	// The `namespace` is always relative to the provider's configured namespace.
	// *Available only for Vault Enterprise*.
	Namespace pulumi.StringPtrOutput `pulumi:"namespace"`
	// Specifies the Terraform Cloud access token to use.
	Token pulumi.StringPtrOutput `pulumi:"token"`
}

## Example Usage

<!--Start PulumiCodeChooser --> ```go package main

import ( 

"github.com/pulumi/pulumi-vault/sdk/v6/go/vault/terraformcloud"
"github.com/pulumi/pulumi/sdk/v3/go/pulumi"

) 

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := terraformcloud.NewSecretBackend(ctx, "test", &terraformcloud.SecretBackendArgs{
			Backend:     pulumi.String("terraform"),
			Description: pulumi.String("Manages the Terraform Cloud backend"),
			Token:       pulumi.String("V0idfhi2iksSDU234ucdbi2nidsi..."),
		})
		if err != nil {
			return err
		}
		return nil
	})
}

``` <!--End PulumiCodeChooser -->

## Import

Terraform Cloud secret backends can be imported using the `backend`, e.g.

```sh $ pulumi import vault:terraformcloud/secretBackend:SecretBackend example terraform ```

func GetSecretBackend 

func GetSecretBackend(ctx *pulumi.Context,
	name string, id pulumi.IDInput, state *SecretBackendState, opts ...pulumi.ResourceOption) (*SecretBackend, error)

GetSecretBackend gets an existing SecretBackend resource's state with the given name, ID, and optional state properties that are used to uniquely qualify the lookup (nil if not required).

func NewSecretBackend 

func NewSecretBackend(ctx *pulumi.Context,
	name string, args *SecretBackendArgs, opts ...pulumi.ResourceOption) (*SecretBackend, error)

NewSecretBackend registers a new resource with the given unique name, arguments, and options.

func (*SecretBackend) ElementType 

func (*SecretBackend) ElementType() reflect.Type

func (*SecretBackend) ToSecretBackendOutput 

func (i *SecretBackend) ToSecretBackendOutput() SecretBackendOutput

func (*SecretBackend) ToSecretBackendOutputWithContext 

func (i *SecretBackend) ToSecretBackendOutputWithContext(ctx context.Context) SecretBackendOutput

type SecretBackendArgs 

type SecretBackendArgs struct {
	// Specifies the address of the Terraform Cloud instance, provided as "host:port" like "127.0.0.1:8500".
	Address pulumi.StringPtrInput
	// Unique name of the Vault Terraform Cloud mount to configure
	Backend pulumi.StringPtrInput
	// Specifies the base path for the Terraform Cloud or Enterprise API.
	BasePath pulumi.StringPtrInput
	// The default TTL for credentials issued by this backend.
	DefaultLeaseTtlSeconds pulumi.IntPtrInput
	// A human-friendly description for this backend.
	Description pulumi.StringPtrInput
	// If set, opts out of mount migration on path updates.
	// See here for more info on [Mount Migration](https://www.vaultproject.io/docs/concepts/mount-migration)
	DisableRemount pulumi.BoolPtrInput
	// The maximum TTL that can be requested
	// for credentials issued by this backend.
	MaxLeaseTtlSeconds pulumi.IntPtrInput
	// The namespace to provision the resource in.
	// The value should not contain leading or trailing forward slashes.
	// The `namespace` is always relative to the provider's configured namespace.
	// *Available only for Vault Enterprise*.
	Namespace pulumi.StringPtrInput
	// Specifies the Terraform Cloud access token to use.
	Token pulumi.StringPtrInput
}

The set of arguments for constructing a SecretBackend resource.

func (SecretBackendArgs) ElementType 

func (SecretBackendArgs) ElementType() reflect.Type

type SecretBackendArray 

type SecretBackendArray []SecretBackendInput

func (SecretBackendArray) ElementType 

func (SecretBackendArray) ElementType() reflect.Type

func (SecretBackendArray) ToSecretBackendArrayOutput 

func (i SecretBackendArray) ToSecretBackendArrayOutput() SecretBackendArrayOutput

func (SecretBackendArray) ToSecretBackendArrayOutputWithContext 

func (i SecretBackendArray) ToSecretBackendArrayOutputWithContext(ctx context.Context) SecretBackendArrayOutput

type SecretBackendArrayInput 

type SecretBackendArrayInput interface {
	pulumi.Input

	ToSecretBackendArrayOutput() SecretBackendArrayOutput
	ToSecretBackendArrayOutputWithContext(context.Context) SecretBackendArrayOutput
}

SecretBackendArrayInput is an input type that accepts SecretBackendArray and SecretBackendArrayOutput values. You can construct a concrete instance of `SecretBackendArrayInput` via: 

SecretBackendArray{ SecretBackendArgs{...} }

type SecretBackendArrayOutput 

type SecretBackendArrayOutput struct{ *pulumi.OutputState }

func (SecretBackendArrayOutput) ElementType 

func (SecretBackendArrayOutput) ElementType() reflect.Type

func (SecretBackendArrayOutput) Index 

func (o SecretBackendArrayOutput) Index(i pulumi.IntInput) SecretBackendOutput

func (SecretBackendArrayOutput) ToSecretBackendArrayOutput 

func (o SecretBackendArrayOutput) ToSecretBackendArrayOutput() SecretBackendArrayOutput

func (SecretBackendArrayOutput) ToSecretBackendArrayOutputWithContext 

func (o SecretBackendArrayOutput) ToSecretBackendArrayOutputWithContext(ctx context.Context) SecretBackendArrayOutput

type SecretBackendInput 

type SecretBackendInput interface {
	pulumi.Input

	ToSecretBackendOutput() SecretBackendOutput
	ToSecretBackendOutputWithContext(ctx context.Context) SecretBackendOutput
}

type SecretBackendMap 

type SecretBackendMap map[string]SecretBackendInput

func (SecretBackendMap) ElementType 

func (SecretBackendMap) ElementType() reflect.Type

func (SecretBackendMap) ToSecretBackendMapOutput 

func (i SecretBackendMap) ToSecretBackendMapOutput() SecretBackendMapOutput

func (SecretBackendMap) ToSecretBackendMapOutputWithContext 

func (i SecretBackendMap) ToSecretBackendMapOutputWithContext(ctx context.Context) SecretBackendMapOutput

type SecretBackendMapInput 

type SecretBackendMapInput interface {
	pulumi.Input

	ToSecretBackendMapOutput() SecretBackendMapOutput
	ToSecretBackendMapOutputWithContext(context.Context) SecretBackendMapOutput
}

SecretBackendMapInput is an input type that accepts SecretBackendMap and SecretBackendMapOutput values. You can construct a concrete instance of `SecretBackendMapInput` via: 

SecretBackendMap{ "key": SecretBackendArgs{...} }

type SecretBackendMapOutput 

type SecretBackendMapOutput struct{ *pulumi.OutputState }

func (SecretBackendMapOutput) ElementType 

func (SecretBackendMapOutput) ElementType() reflect.Type

func (SecretBackendMapOutput) MapIndex 

func (o SecretBackendMapOutput) MapIndex(k pulumi.StringInput) SecretBackendOutput

func (SecretBackendMapOutput) ToSecretBackendMapOutput 

func (o SecretBackendMapOutput) ToSecretBackendMapOutput() SecretBackendMapOutput

func (SecretBackendMapOutput) ToSecretBackendMapOutputWithContext 

func (o SecretBackendMapOutput) ToSecretBackendMapOutputWithContext(ctx context.Context) SecretBackendMapOutput

type SecretBackendOutput 

type SecretBackendOutput struct{ *pulumi.OutputState }

func (SecretBackendOutput) Address 

func (o SecretBackendOutput) Address() pulumi.StringPtrOutput

Specifies the address of the Terraform Cloud instance, provided as "host:port" like "127.0.0.1:8500".

func (SecretBackendOutput) Backend 

func (o SecretBackendOutput) Backend() pulumi.StringPtrOutput

Unique name of the Vault Terraform Cloud mount to configure

func (SecretBackendOutput) BasePath 

func (o SecretBackendOutput) BasePath() pulumi.StringPtrOutput

Specifies the base path for the Terraform Cloud or Enterprise API.

func (SecretBackendOutput) DefaultLeaseTtlSeconds 

func (o SecretBackendOutput) DefaultLeaseTtlSeconds() pulumi.IntPtrOutput

The default TTL for credentials issued by this backend.

func (SecretBackendOutput) Description 

func (o SecretBackendOutput) Description() pulumi.StringPtrOutput

A human-friendly description for this backend.

func (SecretBackendOutput) DisableRemount 

func (o SecretBackendOutput) DisableRemount() pulumi.BoolPtrOutput

If set, opts out of mount migration on path updates. See here for more info on [Mount Migration](https://www.vaultproject.io/docs/concepts/mount-migration)

func (SecretBackendOutput) ElementType 

func (SecretBackendOutput) ElementType() reflect.Type

func (SecretBackendOutput) MaxLeaseTtlSeconds 

func (o SecretBackendOutput) MaxLeaseTtlSeconds() pulumi.IntPtrOutput

The maximum TTL that can be requested for credentials issued by this backend.

func (SecretBackendOutput) Namespace 

func (o SecretBackendOutput) Namespace() pulumi.StringPtrOutput

The namespace to provision the resource in. The value should not contain leading or trailing forward slashes. The `namespace` is always relative to the provider's configured namespace. *Available only for Vault Enterprise*.

func (SecretBackendOutput) ToSecretBackendOutput 

func (o SecretBackendOutput) ToSecretBackendOutput() SecretBackendOutput

func (SecretBackendOutput) ToSecretBackendOutputWithContext 

func (o SecretBackendOutput) ToSecretBackendOutputWithContext(ctx context.Context) SecretBackendOutput

func (SecretBackendOutput) Token 

func (o SecretBackendOutput) Token() pulumi.StringPtrOutput

Specifies the Terraform Cloud access token to use.

type SecretBackendState 

type SecretBackendState struct {
	// Specifies the address of the Terraform Cloud instance, provided as "host:port" like "127.0.0.1:8500".
	Address pulumi.StringPtrInput
	// Unique name of the Vault Terraform Cloud mount to configure
	Backend pulumi.StringPtrInput
	// Specifies the base path for the Terraform Cloud or Enterprise API.
	BasePath pulumi.StringPtrInput
	// The default TTL for credentials issued by this backend.
	DefaultLeaseTtlSeconds pulumi.IntPtrInput
	// A human-friendly description for this backend.
	Description pulumi.StringPtrInput
	// If set, opts out of mount migration on path updates.
	// See here for more info on [Mount Migration](https://www.vaultproject.io/docs/concepts/mount-migration)
	DisableRemount pulumi.BoolPtrInput
	// The maximum TTL that can be requested
	// for credentials issued by this backend.
	MaxLeaseTtlSeconds pulumi.IntPtrInput
	// The namespace to provision the resource in.
	// The value should not contain leading or trailing forward slashes.
	// The `namespace` is always relative to the provider's configured namespace.
	// *Available only for Vault Enterprise*.
	Namespace pulumi.StringPtrInput
	// Specifies the Terraform Cloud access token to use.
	Token pulumi.StringPtrInput
}

func (SecretBackendState) ElementType 

func (SecretBackendState) ElementType() reflect.Type

type SecretCreds 

type SecretCreds struct {
	pulumi.CustomResourceState

	// Terraform Cloud secret backend to generate tokens from
	Backend pulumi.StringOutput `pulumi:"backend"`
	// The lease associated with the token. Only user tokens will have a
	// Vault lease associated with them.
	LeaseId pulumi.StringOutput `pulumi:"leaseId"`
	// The namespace to provision the resource in.
	// The value should not contain leading or trailing forward slashes.
	// The `namespace` is always relative to the provider's configured [namespace](https://www.terraform.io/docs/providers/vault/index.html#namespace).
	// *Available only for Vault Enterprise*.
	Namespace pulumi.StringPtrOutput `pulumi:"namespace"`
	// The organization associated with the token provided.
	Organization pulumi.StringOutput `pulumi:"organization"`
	// Name of the role.
	Role pulumi.StringOutput `pulumi:"role"`
	// The team id associated with the token provided.
	TeamId pulumi.StringOutput `pulumi:"teamId"`
	// The actual token that was generated and can be used with API calls
	// to identify the user of the call.
	Token pulumi.StringOutput `pulumi:"token"`
	// The public identifier for a specific token. It can be used
	// to look up information about a token or to revoke a token.
	TokenId pulumi.StringOutput `pulumi:"tokenId"`
}

## Example Usage

<!--Start PulumiCodeChooser --> ```go package main

import ( 

"github.com/pulumi/pulumi-vault/sdk/v6/go/vault/terraformcloud"
"github.com/pulumi/pulumi/sdk/v3/go/pulumi"

) 

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		test, err := terraformcloud.NewSecretBackend(ctx, "test", &terraformcloud.SecretBackendArgs{
			Backend:     pulumi.String("terraform"),
			Description: pulumi.String("Manages the Terraform Cloud backend"),
			Token:       pulumi.String("V0idfhi2iksSDU234ucdbi2nidsi..."),
		})
		if err != nil {
			return err
		}
		example, err := terraformcloud.NewSecretRole(ctx, "example", &terraformcloud.SecretRoleArgs{
			Backend:      test.Backend,
			Organization: pulumi.String("example-organization-name"),
			TeamId:       pulumi.String("team-ieF4isC..."),
		})
		if err != nil {
			return err
		}
		_, err = terraformcloud.NewSecretCreds(ctx, "token", &terraformcloud.SecretCredsArgs{
			Backend: test.Backend,
			Role:    example.Name,
		})
		if err != nil {
			return err
		}
		return nil
	})
}

``` <!--End PulumiCodeChooser -->

func GetSecretCreds 

func GetSecretCreds(ctx *pulumi.Context,
	name string, id pulumi.IDInput, state *SecretCredsState, opts ...pulumi.ResourceOption) (*SecretCreds, error)

GetSecretCreds gets an existing SecretCreds resource's state with the given name, ID, and optional state properties that are used to uniquely qualify the lookup (nil if not required).

func NewSecretCreds 

func NewSecretCreds(ctx *pulumi.Context,
	name string, args *SecretCredsArgs, opts ...pulumi.ResourceOption) (*SecretCreds, error)

NewSecretCreds registers a new resource with the given unique name, arguments, and options.

func (*SecretCreds) ElementType 

func (*SecretCreds) ElementType() reflect.Type

func (*SecretCreds) ToSecretCredsOutput 

func (i *SecretCreds) ToSecretCredsOutput() SecretCredsOutput

func (*SecretCreds) ToSecretCredsOutputWithContext 

func (i *SecretCreds) ToSecretCredsOutputWithContext(ctx context.Context) SecretCredsOutput

type SecretCredsArgs 

type SecretCredsArgs struct {
	// Terraform Cloud secret backend to generate tokens from
	Backend pulumi.StringInput
	// The namespace to provision the resource in.
	// The value should not contain leading or trailing forward slashes.
	// The `namespace` is always relative to the provider's configured [namespace](https://www.terraform.io/docs/providers/vault/index.html#namespace).
	// *Available only for Vault Enterprise*.
	Namespace pulumi.StringPtrInput
	// Name of the role.
	Role pulumi.StringInput
}

The set of arguments for constructing a SecretCreds resource.

func (SecretCredsArgs) ElementType 

func (SecretCredsArgs) ElementType() reflect.Type

type SecretCredsArray 

type SecretCredsArray []SecretCredsInput

func (SecretCredsArray) ElementType 

func (SecretCredsArray) ElementType() reflect.Type

func (SecretCredsArray) ToSecretCredsArrayOutput 

func (i SecretCredsArray) ToSecretCredsArrayOutput() SecretCredsArrayOutput

func (SecretCredsArray) ToSecretCredsArrayOutputWithContext 

func (i SecretCredsArray) ToSecretCredsArrayOutputWithContext(ctx context.Context) SecretCredsArrayOutput

type SecretCredsArrayInput 

type SecretCredsArrayInput interface {
	pulumi.Input

	ToSecretCredsArrayOutput() SecretCredsArrayOutput
	ToSecretCredsArrayOutputWithContext(context.Context) SecretCredsArrayOutput
}

SecretCredsArrayInput is an input type that accepts SecretCredsArray and SecretCredsArrayOutput values. You can construct a concrete instance of `SecretCredsArrayInput` via: 

SecretCredsArray{ SecretCredsArgs{...} }

type SecretCredsArrayOutput 

type SecretCredsArrayOutput struct{ *pulumi.OutputState }

func (SecretCredsArrayOutput) ElementType 

func (SecretCredsArrayOutput) ElementType() reflect.Type

func (SecretCredsArrayOutput) Index 

func (o SecretCredsArrayOutput) Index(i pulumi.IntInput) SecretCredsOutput

func (SecretCredsArrayOutput) ToSecretCredsArrayOutput 

func (o SecretCredsArrayOutput) ToSecretCredsArrayOutput() SecretCredsArrayOutput

func (SecretCredsArrayOutput) ToSecretCredsArrayOutputWithContext 

func (o SecretCredsArrayOutput) ToSecretCredsArrayOutputWithContext(ctx context.Context) SecretCredsArrayOutput

type SecretCredsInput 

type SecretCredsInput interface {
	pulumi.Input

	ToSecretCredsOutput() SecretCredsOutput
	ToSecretCredsOutputWithContext(ctx context.Context) SecretCredsOutput
}

type SecretCredsMap 

type SecretCredsMap map[string]SecretCredsInput

func (SecretCredsMap) ElementType 

func (SecretCredsMap) ElementType() reflect.Type

func (SecretCredsMap) ToSecretCredsMapOutput 

func (i SecretCredsMap) ToSecretCredsMapOutput() SecretCredsMapOutput

func (SecretCredsMap) ToSecretCredsMapOutputWithContext 

func (i SecretCredsMap) ToSecretCredsMapOutputWithContext(ctx context.Context) SecretCredsMapOutput

type SecretCredsMapInput 

type SecretCredsMapInput interface {
	pulumi.Input

	ToSecretCredsMapOutput() SecretCredsMapOutput
	ToSecretCredsMapOutputWithContext(context.Context) SecretCredsMapOutput
}

SecretCredsMapInput is an input type that accepts SecretCredsMap and SecretCredsMapOutput values. You can construct a concrete instance of `SecretCredsMapInput` via: 

SecretCredsMap{ "key": SecretCredsArgs{...} }

type SecretCredsMapOutput 

type SecretCredsMapOutput struct{ *pulumi.OutputState }

func (SecretCredsMapOutput) ElementType 

func (SecretCredsMapOutput) ElementType() reflect.Type

func (SecretCredsMapOutput) MapIndex 

func (o SecretCredsMapOutput) MapIndex(k pulumi.StringInput) SecretCredsOutput

func (SecretCredsMapOutput) ToSecretCredsMapOutput 

func (o SecretCredsMapOutput) ToSecretCredsMapOutput() SecretCredsMapOutput

func (SecretCredsMapOutput) ToSecretCredsMapOutputWithContext 

func (o SecretCredsMapOutput) ToSecretCredsMapOutputWithContext(ctx context.Context) SecretCredsMapOutput

type SecretCredsOutput 

type SecretCredsOutput struct{ *pulumi.OutputState }

func (SecretCredsOutput) Backend 

func (o SecretCredsOutput) Backend() pulumi.StringOutput

Terraform Cloud secret backend to generate tokens from

func (SecretCredsOutput) ElementType 

func (SecretCredsOutput) ElementType() reflect.Type

func (SecretCredsOutput) LeaseId 

func (o SecretCredsOutput) LeaseId() pulumi.StringOutput

The lease associated with the token. Only user tokens will have a Vault lease associated with them.

func (SecretCredsOutput) Namespace 

func (o SecretCredsOutput) Namespace() pulumi.StringPtrOutput

The namespace to provision the resource in. The value should not contain leading or trailing forward slashes. The `namespace` is always relative to the provider's configured [namespace](https://www.terraform.io/docs/providers/vault/index.html#namespace). *Available only for Vault Enterprise*.

func (SecretCredsOutput) Organization 

func (o SecretCredsOutput) Organization() pulumi.StringOutput

The organization associated with the token provided.

func (SecretCredsOutput) Role 

func (o SecretCredsOutput) Role() pulumi.StringOutput

Name of the role.

func (SecretCredsOutput) TeamId 

func (o SecretCredsOutput) TeamId() pulumi.StringOutput

The team id associated with the token provided.

func (SecretCredsOutput) ToSecretCredsOutput 

func (o SecretCredsOutput) ToSecretCredsOutput() SecretCredsOutput

func (SecretCredsOutput) ToSecretCredsOutputWithContext 

func (o SecretCredsOutput) ToSecretCredsOutputWithContext(ctx context.Context) SecretCredsOutput

func (SecretCredsOutput) Token 

func (o SecretCredsOutput) Token() pulumi.StringOutput

The actual token that was generated and can be used with API calls to identify the user of the call.

func (SecretCredsOutput) TokenId 

func (o SecretCredsOutput) TokenId() pulumi.StringOutput

The public identifier for a specific token. It can be used to look up information about a token or to revoke a token.

type SecretCredsState 

type SecretCredsState struct {
	// Terraform Cloud secret backend to generate tokens from
	Backend pulumi.StringPtrInput
	// The lease associated with the token. Only user tokens will have a
	// Vault lease associated with them.
	LeaseId pulumi.StringPtrInput
	// The namespace to provision the resource in.
	// The value should not contain leading or trailing forward slashes.
	// The `namespace` is always relative to the provider's configured [namespace](https://www.terraform.io/docs/providers/vault/index.html#namespace).
	// *Available only for Vault Enterprise*.
	Namespace pulumi.StringPtrInput
	// The organization associated with the token provided.
	Organization pulumi.StringPtrInput
	// Name of the role.
	Role pulumi.StringPtrInput
	// The team id associated with the token provided.
	TeamId pulumi.StringPtrInput
	// The actual token that was generated and can be used with API calls
	// to identify the user of the call.
	Token pulumi.StringPtrInput
	// The public identifier for a specific token. It can be used
	// to look up information about a token or to revoke a token.
	TokenId pulumi.StringPtrInput
}

func (SecretCredsState) ElementType 

func (SecretCredsState) ElementType() reflect.Type

type SecretRole 

type SecretRole struct {
	pulumi.CustomResourceState

	// The path of the Terraform Cloud Secret Backend the role belongs to.
	Backend pulumi.StringPtrOutput `pulumi:"backend"`
	// Maximum TTL for leases associated with this role, in seconds.
	MaxTtl pulumi.IntPtrOutput `pulumi:"maxTtl"`
	// The name of an existing role against which to create this Terraform Cloud credential
	Name pulumi.StringOutput `pulumi:"name"`
	// The namespace to provision the resource in.
	// The value should not contain leading or trailing forward slashes.
	// The `namespace` is always relative to the provider's configured [namespace](https://www.terraform.io/docs/providers/vault/index.html#namespace).
	// *Available only for Vault Enterprise*.
	Namespace pulumi.StringPtrOutput `pulumi:"namespace"`
	// Name of the Terraform Cloud or Enterprise organization
	Organization pulumi.StringPtrOutput `pulumi:"organization"`
	// ID of the Terraform Cloud or Enterprise team under organization (e.g., settings/teams/team-xxxxxxxxxxxxx)
	TeamId pulumi.StringPtrOutput `pulumi:"teamId"`
	// Specifies the TTL for this role.
	Ttl pulumi.IntPtrOutput `pulumi:"ttl"`
	// ID of the Terraform Cloud or Enterprise user (e.g., user-xxxxxxxxxxxxxxxx)
	UserId pulumi.StringPtrOutput `pulumi:"userId"`
}

## Example Usage

<!--Start PulumiCodeChooser --> ```go package main

import ( 

"github.com/pulumi/pulumi-vault/sdk/v6/go/vault/terraformcloud"
"github.com/pulumi/pulumi/sdk/v3/go/pulumi"

) 

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		test, err := terraformcloud.NewSecretBackend(ctx, "test", &terraformcloud.SecretBackendArgs{
			Backend:     pulumi.String("terraform"),
			Description: pulumi.String("Manages the Terraform Cloud backend"),
			Token:       pulumi.String("V0idfhi2iksSDU234ucdbi2nidsi..."),
		})
		if err != nil {
			return err
		}
		_, err = terraformcloud.NewSecretRole(ctx, "example", &terraformcloud.SecretRoleArgs{
			Backend:      test.Backend,
			Organization: pulumi.String("example-organization-name"),
			TeamId:       pulumi.String("team-ieF4isC..."),
		})
		if err != nil {
			return err
		}
		return nil
	})
}

``` <!--End PulumiCodeChooser -->

## Import

Terraform Cloud secret backend roles can be imported using the `backend`, `/roles/`, and the `name` e.g.

```sh $ pulumi import vault:terraformcloud/secretRole:SecretRole example terraform/roles/my-role ```

func GetSecretRole 

func GetSecretRole(ctx *pulumi.Context,
	name string, id pulumi.IDInput, state *SecretRoleState, opts ...pulumi.ResourceOption) (*SecretRole, error)

GetSecretRole gets an existing SecretRole resource's state with the given name, ID, and optional state properties that are used to uniquely qualify the lookup (nil if not required).

func NewSecretRole 

func NewSecretRole(ctx *pulumi.Context,
	name string, args *SecretRoleArgs, opts ...pulumi.ResourceOption) (*SecretRole, error)

NewSecretRole registers a new resource with the given unique name, arguments, and options.

func (*SecretRole) ElementType 

func (*SecretRole) ElementType() reflect.Type

func (*SecretRole) ToSecretRoleOutput 

func (i *SecretRole) ToSecretRoleOutput() SecretRoleOutput

func (*SecretRole) ToSecretRoleOutputWithContext 

func (i *SecretRole) ToSecretRoleOutputWithContext(ctx context.Context) SecretRoleOutput

type SecretRoleArgs 

type SecretRoleArgs struct {
	// The path of the Terraform Cloud Secret Backend the role belongs to.
	Backend pulumi.StringPtrInput
	// Maximum TTL for leases associated with this role, in seconds.
	MaxTtl pulumi.IntPtrInput
	// The name of an existing role against which to create this Terraform Cloud credential
	Name pulumi.StringPtrInput
	// The namespace to provision the resource in.
	// The value should not contain leading or trailing forward slashes.
	// The `namespace` is always relative to the provider's configured [namespace](https://www.terraform.io/docs/providers/vault/index.html#namespace).
	// *Available only for Vault Enterprise*.
	Namespace pulumi.StringPtrInput
	// Name of the Terraform Cloud or Enterprise organization
	Organization pulumi.StringPtrInput
	// ID of the Terraform Cloud or Enterprise team under organization (e.g., settings/teams/team-xxxxxxxxxxxxx)
	TeamId pulumi.StringPtrInput
	// Specifies the TTL for this role.
	Ttl pulumi.IntPtrInput
	// ID of the Terraform Cloud or Enterprise user (e.g., user-xxxxxxxxxxxxxxxx)
	UserId pulumi.StringPtrInput
}

The set of arguments for constructing a SecretRole resource.

func (SecretRoleArgs) ElementType 

func (SecretRoleArgs) ElementType() reflect.Type

type SecretRoleArray 

type SecretRoleArray []SecretRoleInput

func (SecretRoleArray) ElementType 

func (SecretRoleArray) ElementType() reflect.Type

func (SecretRoleArray) ToSecretRoleArrayOutput 

func (i SecretRoleArray) ToSecretRoleArrayOutput() SecretRoleArrayOutput

func (SecretRoleArray) ToSecretRoleArrayOutputWithContext 

func (i SecretRoleArray) ToSecretRoleArrayOutputWithContext(ctx context.Context) SecretRoleArrayOutput

type SecretRoleArrayInput 

type SecretRoleArrayInput interface {
	pulumi.Input

	ToSecretRoleArrayOutput() SecretRoleArrayOutput
	ToSecretRoleArrayOutputWithContext(context.Context) SecretRoleArrayOutput
}

SecretRoleArrayInput is an input type that accepts SecretRoleArray and SecretRoleArrayOutput values. You can construct a concrete instance of `SecretRoleArrayInput` via: 

SecretRoleArray{ SecretRoleArgs{...} }

type SecretRoleArrayOutput 

type SecretRoleArrayOutput struct{ *pulumi.OutputState }

func (SecretRoleArrayOutput) ElementType 

func (SecretRoleArrayOutput) ElementType() reflect.Type

func (SecretRoleArrayOutput) Index 

func (o SecretRoleArrayOutput) Index(i pulumi.IntInput) SecretRoleOutput

func (SecretRoleArrayOutput) ToSecretRoleArrayOutput 

func (o SecretRoleArrayOutput) ToSecretRoleArrayOutput() SecretRoleArrayOutput

func (SecretRoleArrayOutput) ToSecretRoleArrayOutputWithContext 

func (o SecretRoleArrayOutput) ToSecretRoleArrayOutputWithContext(ctx context.Context) SecretRoleArrayOutput

type SecretRoleInput 

type SecretRoleInput interface {
	pulumi.Input

	ToSecretRoleOutput() SecretRoleOutput
	ToSecretRoleOutputWithContext(ctx context.Context) SecretRoleOutput
}

type SecretRoleMap 

type SecretRoleMap map[string]SecretRoleInput

func (SecretRoleMap) ElementType 

func (SecretRoleMap) ElementType() reflect.Type

func (SecretRoleMap) ToSecretRoleMapOutput 

func (i SecretRoleMap) ToSecretRoleMapOutput() SecretRoleMapOutput

func (SecretRoleMap) ToSecretRoleMapOutputWithContext 

func (i SecretRoleMap) ToSecretRoleMapOutputWithContext(ctx context.Context) SecretRoleMapOutput

type SecretRoleMapInput 

type SecretRoleMapInput interface {
	pulumi.Input

	ToSecretRoleMapOutput() SecretRoleMapOutput
	ToSecretRoleMapOutputWithContext(context.Context) SecretRoleMapOutput
}

SecretRoleMapInput is an input type that accepts SecretRoleMap and SecretRoleMapOutput values. You can construct a concrete instance of `SecretRoleMapInput` via: 

SecretRoleMap{ "key": SecretRoleArgs{...} }

type SecretRoleMapOutput 

type SecretRoleMapOutput struct{ *pulumi.OutputState }

func (SecretRoleMapOutput) ElementType 

func (SecretRoleMapOutput) ElementType() reflect.Type

func (SecretRoleMapOutput) MapIndex 

func (o SecretRoleMapOutput) MapIndex(k pulumi.StringInput) SecretRoleOutput

func (SecretRoleMapOutput) ToSecretRoleMapOutput 

func (o SecretRoleMapOutput) ToSecretRoleMapOutput() SecretRoleMapOutput

func (SecretRoleMapOutput) ToSecretRoleMapOutputWithContext 

func (o SecretRoleMapOutput) ToSecretRoleMapOutputWithContext(ctx context.Context) SecretRoleMapOutput

type SecretRoleOutput 

type SecretRoleOutput struct{ *pulumi.OutputState }

func (SecretRoleOutput) Backend 

func (o SecretRoleOutput) Backend() pulumi.StringPtrOutput

The path of the Terraform Cloud Secret Backend the role belongs to.

func (SecretRoleOutput) ElementType 

func (SecretRoleOutput) ElementType() reflect.Type

func (SecretRoleOutput) MaxTtl 

func (o SecretRoleOutput) MaxTtl() pulumi.IntPtrOutput

Maximum TTL for leases associated with this role, in seconds.

func (SecretRoleOutput) Name 

func (o SecretRoleOutput) Name() pulumi.StringOutput

The name of an existing role against which to create this Terraform Cloud credential

func (SecretRoleOutput) Namespace 

func (o SecretRoleOutput) Namespace() pulumi.StringPtrOutput

The namespace to provision the resource in. The value should not contain leading or trailing forward slashes. The `namespace` is always relative to the provider's configured [namespace](https://www.terraform.io/docs/providers/vault/index.html#namespace). *Available only for Vault Enterprise*.

func (SecretRoleOutput) Organization 

func (o SecretRoleOutput) Organization() pulumi.StringPtrOutput

Name of the Terraform Cloud or Enterprise organization

func (SecretRoleOutput) TeamId 

func (o SecretRoleOutput) TeamId() pulumi.StringPtrOutput

ID of the Terraform Cloud or Enterprise team under organization (e.g., settings/teams/team-xxxxxxxxxxxxx)

func (SecretRoleOutput) ToSecretRoleOutput 

func (o SecretRoleOutput) ToSecretRoleOutput() SecretRoleOutput

func (SecretRoleOutput) ToSecretRoleOutputWithContext 

func (o SecretRoleOutput) ToSecretRoleOutputWithContext(ctx context.Context) SecretRoleOutput

func (SecretRoleOutput) Ttl 

func (o SecretRoleOutput) Ttl() pulumi.IntPtrOutput

Specifies the TTL for this role.

func (SecretRoleOutput) UserId 

func (o SecretRoleOutput) UserId() pulumi.StringPtrOutput

ID of the Terraform Cloud or Enterprise user (e.g., user-xxxxxxxxxxxxxxxx)

type SecretRoleState 

type SecretRoleState struct {
	// The path of the Terraform Cloud Secret Backend the role belongs to.
	Backend pulumi.StringPtrInput
	// Maximum TTL for leases associated with this role, in seconds.
	MaxTtl pulumi.IntPtrInput
	// The name of an existing role against which to create this Terraform Cloud credential
	Name pulumi.StringPtrInput
	// The namespace to provision the resource in.
	// The value should not contain leading or trailing forward slashes.
	// The `namespace` is always relative to the provider's configured [namespace](https://www.terraform.io/docs/providers/vault/index.html#namespace).
	// *Available only for Vault Enterprise*.
	Namespace pulumi.StringPtrInput
	// Name of the Terraform Cloud or Enterprise organization
	Organization pulumi.StringPtrInput
	// ID of the Terraform Cloud or Enterprise team under organization (e.g., settings/teams/team-xxxxxxxxxxxxx)
	TeamId pulumi.StringPtrInput
	// Specifies the TTL for this role.
	Ttl pulumi.IntPtrInput
	// ID of the Terraform Cloud or Enterprise user (e.g., user-xxxxxxxxxxxxxxxx)
	UserId pulumi.StringPtrInput
}

func (SecretRoleState) ElementType 

func (SecretRoleState) ElementType() reflect.Type

Source Files

View all Source files

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.