identityoidcclient

README

vault_identity_oidc_client

Refer to the Terraform Registory for docs: vault_identity_oidc_client.

Documentation

Index

• func IdentityOidcClient_IsConstruct(x interface{}) *bool
• func IdentityOidcClient_IsTerraformElement(x interface{}) *bool
• func IdentityOidcClient_IsTerraformResource(x interface{}) *bool
• func IdentityOidcClient_TfResourceType() *string
• func NewIdentityOidcClient_Override(i IdentityOidcClient, scope constructs.Construct, id *string, ...)
• type IdentityOidcClient
  • func NewIdentityOidcClient(scope constructs.Construct, id *string, config *IdentityOidcClientConfig) IdentityOidcClient
• type IdentityOidcClientConfig

Functions

func IdentityOidcClient_IsConstruct

func IdentityOidcClient_IsConstruct(x interface{}) *bool

Checks if `x` is a construct.

Use this method instead of `instanceof` to properly detect `Construct` instances, even when the construct library is symlinked.

Explanation: in JavaScript, multiple copies of the `constructs` library on disk are seen as independent, completely different libraries. As a consequence, the class `Construct` in each copy of the `constructs` library is seen as a different class, and an instance of one class will not test as `instanceof` the other class. `npm install` will not create installations like this, but users may manually symlink construct libraries together or use a monorepo tool: in those cases, multiple copies of the `constructs` library can be accidentally installed, and `instanceof` will behave unpredictably. It is safest to avoid using `instanceof`, and using this type-testing method instead.

Returns: true if `x` is an object created from a class which extends `Construct`.

func IdentityOidcClient_IsTerraformElement

func IdentityOidcClient_IsTerraformElement(x interface{}) *bool

Experimental.

func IdentityOidcClient_IsTerraformResource

func IdentityOidcClient_IsTerraformResource(x interface{}) *bool

Experimental.

func IdentityOidcClient_TfResourceType

func IdentityOidcClient_TfResourceType() *string

func NewIdentityOidcClient_Override

func NewIdentityOidcClient_Override(i IdentityOidcClient, scope constructs.Construct, id *string, config *IdentityOidcClientConfig)

Create a new {@link https://registry.terraform.io/providers/hashicorp/vault/3.19.0/docs/resources/identity_oidc_client vault_identity_oidc_client} Resource.

Types

type IdentityOidcClient

type IdentityOidcClient interface {
	cdktf.TerraformResource
	AccessTokenTtl() *float64
	SetAccessTokenTtl(val *float64)
	AccessTokenTtlInput() *float64
	Assignments() *[]*string
	SetAssignments(val *[]*string)
	AssignmentsInput() *[]*string
	// Experimental.
	CdktfStack() cdktf.TerraformStack
	ClientId() *string
	ClientSecret() *string
	ClientType() *string
	SetClientType(val *string)
	ClientTypeInput() *string
	// Experimental.
	Connection() interface{}
	// Experimental.
	SetConnection(val interface{})
	// Experimental.
	ConstructNodeMetadata() *map[string]interface{}
	// Experimental.
	Count() interface{}
	// Experimental.
	SetCount(val interface{})
	// Experimental.
	DependsOn() *[]*string
	// Experimental.
	SetDependsOn(val *[]*string)
	// Experimental.
	ForEach() cdktf.ITerraformIterator
	// Experimental.
	SetForEach(val cdktf.ITerraformIterator)
	// Experimental.
	Fqn() *string
	// Experimental.
	FriendlyUniqueId() *string
	Id() *string
	SetId(val *string)
	IdInput() *string
	IdTokenTtl() *float64
	SetIdTokenTtl(val *float64)
	IdTokenTtlInput() *float64
	Key() *string
	SetKey(val *string)
	KeyInput() *string
	// Experimental.
	Lifecycle() *cdktf.TerraformResourceLifecycle
	// Experimental.
	SetLifecycle(val *cdktf.TerraformResourceLifecycle)
	Name() *string
	SetName(val *string)
	NameInput() *string
	Namespace() *string
	SetNamespace(val *string)
	NamespaceInput() *string
	// The tree node.
	Node() constructs.Node
	// Experimental.
	Provider() cdktf.TerraformProvider
	// Experimental.
	SetProvider(val cdktf.TerraformProvider)
	// Experimental.
	Provisioners() *[]interface{}
	// Experimental.
	SetProvisioners(val *[]interface{})
	// Experimental.
	RawOverrides() interface{}
	RedirectUris() *[]*string
	SetRedirectUris(val *[]*string)
	RedirectUrisInput() *[]*string
	// Experimental.
	TerraformGeneratorMetadata() *cdktf.TerraformProviderGeneratorMetadata
	// Experimental.
	TerraformMetaArguments() *map[string]interface{}
	// Experimental.
	TerraformResourceType() *string
	// Experimental.
	AddOverride(path *string, value interface{})
	// Experimental.
	GetAnyMapAttribute(terraformAttribute *string) *map[string]interface{}
	// Experimental.
	GetBooleanAttribute(terraformAttribute *string) cdktf.IResolvable
	// Experimental.
	GetBooleanMapAttribute(terraformAttribute *string) *map[string]*bool
	// Experimental.
	GetListAttribute(terraformAttribute *string) *[]*string
	// Experimental.
	GetNumberAttribute(terraformAttribute *string) *float64
	// Experimental.
	GetNumberListAttribute(terraformAttribute *string) *[]*float64
	// Experimental.
	GetNumberMapAttribute(terraformAttribute *string) *map[string]*float64
	// Experimental.
	GetStringAttribute(terraformAttribute *string) *string
	// Experimental.
	GetStringMapAttribute(terraformAttribute *string) *map[string]*string
	// Experimental.
	InterpolationForAttribute(terraformAttribute *string) cdktf.IResolvable
	// Overrides the auto-generated logical ID with a specific ID.
	// Experimental.
	OverrideLogicalId(newLogicalId *string)
	ResetAccessTokenTtl()
	ResetAssignments()
	ResetClientType()
	ResetId()
	ResetIdTokenTtl()
	ResetKey()
	ResetNamespace()
	// Resets a previously passed logical Id to use the auto-generated logical id again.
	// Experimental.
	ResetOverrideLogicalId()
	ResetRedirectUris()
	SynthesizeAttributes() *map[string]interface{}
	// Experimental.
	ToMetadata() interface{}
	// Returns a string representation of this construct.
	ToString() *string
	// Adds this resource to the terraform JSON output.
	// Experimental.
	ToTerraform() interface{}
}

Represents a {@link https://registry.terraform.io/providers/hashicorp/vault/3.19.0/docs/resources/identity_oidc_client vault_identity_oidc_client}.

func NewIdentityOidcClient

func NewIdentityOidcClient(scope constructs.Construct, id *string, config *IdentityOidcClientConfig) IdentityOidcClient

Create a new {@link https://registry.terraform.io/providers/hashicorp/vault/3.19.0/docs/resources/identity_oidc_client vault_identity_oidc_client} Resource.

type IdentityOidcClientConfig

type IdentityOidcClientConfig struct {
	// Experimental.
	Connection interface{} `field:"optional" json:"connection" yaml:"connection"`
	// Experimental.
	Count interface{} `field:"optional" json:"count" yaml:"count"`
	// Experimental.
	DependsOn *[]cdktf.ITerraformDependable `field:"optional" json:"dependsOn" yaml:"dependsOn"`
	// Experimental.
	ForEach cdktf.ITerraformIterator `field:"optional" json:"forEach" yaml:"forEach"`
	// Experimental.
	Lifecycle *cdktf.TerraformResourceLifecycle `field:"optional" json:"lifecycle" yaml:"lifecycle"`
	// Experimental.
	Provider cdktf.TerraformProvider `field:"optional" json:"provider" yaml:"provider"`
	// Experimental.
	Provisioners *[]interface{} `field:"optional" json:"provisioners" yaml:"provisioners"`
	// The name of the client.
	//
	// Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/vault/3.19.0/docs/resources/identity_oidc_client#name IdentityOidcClient#name}
	Name *string `field:"required" json:"name" yaml:"name"`
	// The time-to-live for access tokens obtained by the client.
	//
	// Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/vault/3.19.0/docs/resources/identity_oidc_client#access_token_ttl IdentityOidcClient#access_token_ttl}
	AccessTokenTtl *float64 `field:"optional" json:"accessTokenTtl" yaml:"accessTokenTtl"`
	// A list of assignment resources associated with the client.
	//
	// Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/vault/3.19.0/docs/resources/identity_oidc_client#assignments IdentityOidcClient#assignments}
	Assignments *[]*string `field:"optional" json:"assignments" yaml:"assignments"`
	// The client type based on its ability to maintain confidentiality of credentials.Defaults to 'confidential'.
	//
	// Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/vault/3.19.0/docs/resources/identity_oidc_client#client_type IdentityOidcClient#client_type}
	ClientType *string `field:"optional" json:"clientType" yaml:"clientType"`
	// Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/vault/3.19.0/docs/resources/identity_oidc_client#id IdentityOidcClient#id}.
	//
	// Please be aware that the id field is automatically added to all resources in Terraform providers using a Terraform provider SDK version below 2.
	// If you experience problems setting this value it might not be settable. Please take a look at the provider documentation to ensure it should be settable.
	Id *string `field:"optional" json:"id" yaml:"id"`
	// The time-to-live for ID tokens obtained by the client.
	//
	// The value should be less than the verification_ttl on the key.
	//
	// Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/vault/3.19.0/docs/resources/identity_oidc_client#id_token_ttl IdentityOidcClient#id_token_ttl}
	IdTokenTtl *float64 `field:"optional" json:"idTokenTtl" yaml:"idTokenTtl"`
	// A reference to a named key resource in Vault. This cannot be modified after creation.
	//
	// Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/vault/3.19.0/docs/resources/identity_oidc_client#key IdentityOidcClient#key}
	Key *string `field:"optional" json:"key" yaml:"key"`
	// Target namespace. (requires Enterprise).
	//
	// Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/vault/3.19.0/docs/resources/identity_oidc_client#namespace IdentityOidcClient#namespace}
	Namespace *string `field:"optional" json:"namespace" yaml:"namespace"`
	// Redirection URI values used by the client.
	//
	// One of these values must exactly match the redirect_uri parameter value used in each authentication request.
	//
	// Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/vault/3.19.0/docs/resources/identity_oidc_client#redirect_uris IdentityOidcClient#redirect_uris}
	RedirectUris *[]*string `field:"optional" json:"redirectUris" yaml:"redirectUris"`
}