aclauthmethod

package
v9.3.0 Latest Latest
Warning

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

 Go to latest Published: Oct 16, 2024 License: MPL-2.0 Imports: 7 Imported by: 0

README

nomad_acl_auth_method

Refer to the Terraform Registry for docs: nomad_acl_auth_method.

Documentation

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

func AclAuthMethod_GenerateConfigForImport 

func AclAuthMethod_GenerateConfigForImport(scope constructs.Construct, importToId *string, importFromId *string, provider cdktf.TerraformProvider) cdktf.ImportableResource

Generates CDKTF code for importing a AclAuthMethod resource upon running "cdktf plan <stack-name>".

func AclAuthMethod_IsConstruct 

func AclAuthMethod_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 AclAuthMethod_IsTerraformElement 

func AclAuthMethod_IsTerraformElement(x interface{}) *bool

Experimental.

func AclAuthMethod_IsTerraformResource 

func AclAuthMethod_IsTerraformResource(x interface{}) *bool

Experimental.

func AclAuthMethod_TfResourceType 

func AclAuthMethod_TfResourceType() *string

func NewAclAuthMethodConfigAOutputReference_Override 

func NewAclAuthMethodConfigAOutputReference_Override(a AclAuthMethodConfigAOutputReference, terraformResource cdktf.IInterpolatingParent, terraformAttribute *string)

func NewAclAuthMethod_Override 

func NewAclAuthMethod_Override(a AclAuthMethod, scope constructs.Construct, id *string, config *AclAuthMethodConfig)

Create a new {@link https://registry.terraform.io/providers/hashicorp/nomad/2.4.0/docs/resources/acl_auth_method nomad_acl_auth_method} Resource.

Types

type AclAuthMethod 

type AclAuthMethod interface {
	cdktf.TerraformResource
	// Experimental.
	CdktfStack() cdktf.TerraformStack
	Config() AclAuthMethodConfigAOutputReference
	ConfigInput() *AclAuthMethodConfigA
	// Experimental.
	Connection() interface{}
	// Experimental.
	SetConnection(val interface{})
	// Experimental.
	ConstructNodeMetadata() *map[string]interface{}
	// Experimental.
	Count() interface{}
	// Experimental.
	SetCount(val interface{})
	Default() interface{}
	SetDefault(val interface{})
	DefaultInput() 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
	// Experimental.
	Lifecycle() *cdktf.TerraformResourceLifecycle
	// Experimental.
	SetLifecycle(val *cdktf.TerraformResourceLifecycle)
	MaxTokenTtl() *string
	SetMaxTokenTtl(val *string)
	MaxTokenTtlInput() *string
	Name() *string
	SetName(val *string)
	NameInput() *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{}
	// Experimental.
	TerraformGeneratorMetadata() *cdktf.TerraformProviderGeneratorMetadata
	// Experimental.
	TerraformMetaArguments() *map[string]interface{}
	// Experimental.
	TerraformResourceType() *string
	TokenLocality() *string
	SetTokenLocality(val *string)
	TokenLocalityInput() *string
	TokenNameFormat() *string
	SetTokenNameFormat(val *string)
	TokenNameFormatInput() *string
	Type() *string
	SetType(val *string)
	TypeInput() *string
	// Adds a user defined moveTarget string to this resource to be later used in .moveTo(moveTarget) to resolve the location of the move.
	// Experimental.
	AddMoveTarget(moveTarget *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.
	HasResourceMove() interface{}
	// Experimental.
	ImportFrom(id *string, provider cdktf.TerraformProvider)
	// Experimental.
	InterpolationForAttribute(terraformAttribute *string) cdktf.IResolvable
	// Move the resource corresponding to "id" to this resource.
	//
	// Note that the resource being moved from must be marked as moved using it's instance function.
	// Experimental.
	MoveFromId(id *string)
	// Moves this resource to the target resource given by moveTarget.
	// Experimental.
	MoveTo(moveTarget *string, index interface{})
	// Moves this resource to the resource corresponding to "id".
	// Experimental.
	MoveToId(id *string)
	// Overrides the auto-generated logical ID with a specific ID.
	// Experimental.
	OverrideLogicalId(newLogicalId *string)
	PutConfig(value *AclAuthMethodConfigA)
	ResetDefault()
	ResetId()
	// Resets a previously passed logical Id to use the auto-generated logical id again.
	// Experimental.
	ResetOverrideLogicalId()
	ResetTokenNameFormat()
	SynthesizeAttributes() *map[string]interface{}
	SynthesizeHclAttributes() *map[string]interface{}
	// Experimental.
	ToHclTerraform() 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/nomad/2.4.0/docs/resources/acl_auth_method nomad_acl_auth_method}.

func NewAclAuthMethod 

func NewAclAuthMethod(scope constructs.Construct, id *string, config *AclAuthMethodConfig) AclAuthMethod

Create a new {@link https://registry.terraform.io/providers/hashicorp/nomad/2.4.0/docs/resources/acl_auth_method nomad_acl_auth_method} Resource.

type AclAuthMethodConfig 

type AclAuthMethodConfig 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"`
	// config block.
	//
	// Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/nomad/2.4.0/docs/resources/acl_auth_method#config AclAuthMethod#config}
	Config *AclAuthMethodConfigA `field:"required" json:"config" yaml:"config"`
	// Defines the maximum life of a token created by this method.
	//
	// Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/nomad/2.4.0/docs/resources/acl_auth_method#max_token_ttl AclAuthMethod#max_token_ttl}
	MaxTokenTtl *string `field:"required" json:"maxTokenTtl" yaml:"maxTokenTtl"`
	// The identifier of the ACL Auth Method.
	//
	// Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/nomad/2.4.0/docs/resources/acl_auth_method#name AclAuthMethod#name}
	Name *string `field:"required" json:"name" yaml:"name"`
	// Defines whether the ACL Auth Method creates a local or global token when performing SSO login.
	//
	// This field must be set to either "local" or "global".
	//
	// Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/nomad/2.4.0/docs/resources/acl_auth_method#token_locality AclAuthMethod#token_locality}
	TokenLocality *string `field:"required" json:"tokenLocality" yaml:"tokenLocality"`
	// ACL Auth Method SSO workflow type. Currently, the only supported type is "OIDC.".
	//
	// Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/nomad/2.4.0/docs/resources/acl_auth_method#type AclAuthMethod#type}
	Type *string `field:"required" json:"type" yaml:"type"`
	// Defines whether this ACL Auth Method is to be set as default.
	//
	// Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/nomad/2.4.0/docs/resources/acl_auth_method#default AclAuthMethod#default}
	Default interface{} `field:"optional" json:"default" yaml:"default"`
	// Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/nomad/2.4.0/docs/resources/acl_auth_method#id AclAuthMethod#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"`
	// Defines the token format for the authenticated users. This can be lightly templated using HIL '${foo}' syntax.
	//
	// Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/nomad/2.4.0/docs/resources/acl_auth_method#token_name_format AclAuthMethod#token_name_format}
	TokenNameFormat *string `field:"optional" json:"tokenNameFormat" yaml:"tokenNameFormat"`
}

type AclAuthMethodConfigA 

type AclAuthMethodConfigA struct {
	// A list of allowed values that can be used for the redirect URI.
	//
	// Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/nomad/2.4.0/docs/resources/acl_auth_method#allowed_redirect_uris AclAuthMethod#allowed_redirect_uris}
	AllowedRedirectUris *[]*string `field:"optional" json:"allowedRedirectUris" yaml:"allowedRedirectUris"`
	// List of auth claims that are valid for login.
	//
	// Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/nomad/2.4.0/docs/resources/acl_auth_method#bound_audiences AclAuthMethod#bound_audiences}
	BoundAudiences *[]*string `field:"optional" json:"boundAudiences" yaml:"boundAudiences"`
	// The value against which to match the iss claim in a JWT.
	//
	// Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/nomad/2.4.0/docs/resources/acl_auth_method#bound_issuer AclAuthMethod#bound_issuer}
	BoundIssuer *[]*string `field:"optional" json:"boundIssuer" yaml:"boundIssuer"`
	// Mappings of claims (key) that will be copied to a metadata field (value).
	//
	// Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/nomad/2.4.0/docs/resources/acl_auth_method#claim_mappings AclAuthMethod#claim_mappings}
	ClaimMappings *map[string]*string `field:"optional" json:"claimMappings" yaml:"claimMappings"`
	// Duration of leeway when validating all claims in the form of a time duration such as "5m" or "1h".
	//
	// Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/nomad/2.4.0/docs/resources/acl_auth_method#clock_skew_leeway AclAuthMethod#clock_skew_leeway}
	ClockSkewLeeway *string `field:"optional" json:"clockSkewLeeway" yaml:"clockSkewLeeway"`
	// PEM encoded CA certs for use by the TLS client used to talk with the OIDC Discovery URL.
	//
	// Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/nomad/2.4.0/docs/resources/acl_auth_method#discovery_ca_pem AclAuthMethod#discovery_ca_pem}
	DiscoveryCaPem *[]*string `field:"optional" json:"discoveryCaPem" yaml:"discoveryCaPem"`
	// Duration of leeway when validating expiration of a JWT in the form of a time duration such as "5m" or "1h".
	//
	// Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/nomad/2.4.0/docs/resources/acl_auth_method#expiration_leeway AclAuthMethod#expiration_leeway}
	ExpirationLeeway *string `field:"optional" json:"expirationLeeway" yaml:"expirationLeeway"`
	// PEM encoded CA cert for use by the TLS client used to talk with the JWKS server.
	//
	// Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/nomad/2.4.0/docs/resources/acl_auth_method#jwks_ca_cert AclAuthMethod#jwks_ca_cert}
	JwksCaCert *string `field:"optional" json:"jwksCaCert" yaml:"jwksCaCert"`
	// JSON Web Key Sets url for authenticating signatures.
	//
	// Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/nomad/2.4.0/docs/resources/acl_auth_method#jwks_url AclAuthMethod#jwks_url}
	JwksUrl *string `field:"optional" json:"jwksUrl" yaml:"jwksUrl"`
	// List of PEM-encoded public keys to use to authenticate signatures locally.
	//
	// Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/nomad/2.4.0/docs/resources/acl_auth_method#jwt_validation_pub_keys AclAuthMethod#jwt_validation_pub_keys}
	JwtValidationPubKeys *[]*string `field:"optional" json:"jwtValidationPubKeys" yaml:"jwtValidationPubKeys"`
	// Mappings of list claims (key) that will be copied to a metadata field (value).
	//
	// Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/nomad/2.4.0/docs/resources/acl_auth_method#list_claim_mappings AclAuthMethod#list_claim_mappings}
	ListClaimMappings *map[string]*string `field:"optional" json:"listClaimMappings" yaml:"listClaimMappings"`
	// Duration of leeway when validating not before values of a token in the form of a time duration such as "5m" or "1h".
	//
	// Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/nomad/2.4.0/docs/resources/acl_auth_method#not_before_leeway AclAuthMethod#not_before_leeway}
	NotBeforeLeeway *string `field:"optional" json:"notBeforeLeeway" yaml:"notBeforeLeeway"`
	// The OAuth Client ID configured with the OIDC provider.
	//
	// Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/nomad/2.4.0/docs/resources/acl_auth_method#oidc_client_id AclAuthMethod#oidc_client_id}
	OidcClientId *string `field:"optional" json:"oidcClientId" yaml:"oidcClientId"`
	// The OAuth Client Secret configured with the OIDC provider.
	//
	// Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/nomad/2.4.0/docs/resources/acl_auth_method#oidc_client_secret AclAuthMethod#oidc_client_secret}
	OidcClientSecret *string `field:"optional" json:"oidcClientSecret" yaml:"oidcClientSecret"`
	// Nomad will not make a request to the identity provider to get OIDC UserInfo.
	//
	// Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/nomad/2.4.0/docs/resources/acl_auth_method#oidc_disable_userinfo AclAuthMethod#oidc_disable_userinfo}
	OidcDisableUserinfo interface{} `field:"optional" json:"oidcDisableUserinfo" yaml:"oidcDisableUserinfo"`
	// The OIDC Discovery URL, without any .well-known component (base path).
	//
	// Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/nomad/2.4.0/docs/resources/acl_auth_method#oidc_discovery_url AclAuthMethod#oidc_discovery_url}
	OidcDiscoveryUrl *string `field:"optional" json:"oidcDiscoveryUrl" yaml:"oidcDiscoveryUrl"`
	// List of OIDC scopes.
	//
	// Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/nomad/2.4.0/docs/resources/acl_auth_method#oidc_scopes AclAuthMethod#oidc_scopes}
	OidcScopes *[]*string `field:"optional" json:"oidcScopes" yaml:"oidcScopes"`
	// A list of supported signing algorithms.
	//
	// Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/nomad/2.4.0/docs/resources/acl_auth_method#signing_algs AclAuthMethod#signing_algs}
	SigningAlgs *[]*string `field:"optional" json:"signingAlgs" yaml:"signingAlgs"`
}

type AclAuthMethodConfigAOutputReference 

type AclAuthMethodConfigAOutputReference interface {
	cdktf.ComplexObject
	AllowedRedirectUris() *[]*string
	SetAllowedRedirectUris(val *[]*string)
	AllowedRedirectUrisInput() *[]*string
	BoundAudiences() *[]*string
	SetBoundAudiences(val *[]*string)
	BoundAudiencesInput() *[]*string
	BoundIssuer() *[]*string
	SetBoundIssuer(val *[]*string)
	BoundIssuerInput() *[]*string
	ClaimMappings() *map[string]*string
	SetClaimMappings(val *map[string]*string)
	ClaimMappingsInput() *map[string]*string
	ClockSkewLeeway() *string
	SetClockSkewLeeway(val *string)
	ClockSkewLeewayInput() *string
	// the index of the complex object in a list.
	// Experimental.
	ComplexObjectIndex() interface{}
	// Experimental.
	SetComplexObjectIndex(val interface{})
	// set to true if this item is from inside a set and needs tolist() for accessing it set to "0" for single list items.
	// Experimental.
	ComplexObjectIsFromSet() *bool
	// Experimental.
	SetComplexObjectIsFromSet(val *bool)
	// The creation stack of this resolvable which will be appended to errors thrown during resolution.
	//
	// If this returns an empty array the stack will not be attached.
	// Experimental.
	CreationStack() *[]*string
	DiscoveryCaPem() *[]*string
	SetDiscoveryCaPem(val *[]*string)
	DiscoveryCaPemInput() *[]*string
	ExpirationLeeway() *string
	SetExpirationLeeway(val *string)
	ExpirationLeewayInput() *string
	// Experimental.
	Fqn() *string
	InternalValue() *AclAuthMethodConfigA
	SetInternalValue(val *AclAuthMethodConfigA)
	JwksCaCert() *string
	SetJwksCaCert(val *string)
	JwksCaCertInput() *string
	JwksUrl() *string
	SetJwksUrl(val *string)
	JwksUrlInput() *string
	JwtValidationPubKeys() *[]*string
	SetJwtValidationPubKeys(val *[]*string)
	JwtValidationPubKeysInput() *[]*string
	ListClaimMappings() *map[string]*string
	SetListClaimMappings(val *map[string]*string)
	ListClaimMappingsInput() *map[string]*string
	NotBeforeLeeway() *string
	SetNotBeforeLeeway(val *string)
	NotBeforeLeewayInput() *string
	OidcClientId() *string
	SetOidcClientId(val *string)
	OidcClientIdInput() *string
	OidcClientSecret() *string
	SetOidcClientSecret(val *string)
	OidcClientSecretInput() *string
	OidcDisableUserinfo() interface{}
	SetOidcDisableUserinfo(val interface{})
	OidcDisableUserinfoInput() interface{}
	OidcDiscoveryUrl() *string
	SetOidcDiscoveryUrl(val *string)
	OidcDiscoveryUrlInput() *string
	OidcScopes() *[]*string
	SetOidcScopes(val *[]*string)
	OidcScopesInput() *[]*string
	SigningAlgs() *[]*string
	SetSigningAlgs(val *[]*string)
	SigningAlgsInput() *[]*string
	// Experimental.
	TerraformAttribute() *string
	// Experimental.
	SetTerraformAttribute(val *string)
	// Experimental.
	TerraformResource() cdktf.IInterpolatingParent
	// Experimental.
	SetTerraformResource(val cdktf.IInterpolatingParent)
	// Experimental.
	ComputeFqn() *string
	// 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.
	InterpolationAsList() cdktf.IResolvable
	// Experimental.
	InterpolationForAttribute(property *string) cdktf.IResolvable
	ResetAllowedRedirectUris()
	ResetBoundAudiences()
	ResetBoundIssuer()
	ResetClaimMappings()
	ResetClockSkewLeeway()
	ResetDiscoveryCaPem()
	ResetExpirationLeeway()
	ResetJwksCaCert()
	ResetJwksUrl()
	ResetJwtValidationPubKeys()
	ResetListClaimMappings()
	ResetNotBeforeLeeway()
	ResetOidcClientId()
	ResetOidcClientSecret()
	ResetOidcDisableUserinfo()
	ResetOidcDiscoveryUrl()
	ResetOidcScopes()
	ResetSigningAlgs()
	// Produce the Token's value at resolution time.
	// Experimental.
	Resolve(_context cdktf.IResolveContext) interface{}
	// Return a string representation of this resolvable object.
	//
	// Returns a reversible string representation.
	// Experimental.
	ToString() *string
}

func NewAclAuthMethodConfigAOutputReference 

func NewAclAuthMethodConfigAOutputReference(terraformResource cdktf.IInterpolatingParent, terraformAttribute *string) AclAuthMethodConfigAOutputReference

Source Files

View all Source files

Directories

Path Synopsis

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.