authenticator

package
v12.0.1 Latest Latest
Warning

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

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

README

okta_authenticator

Refer to the Terraform Registory for docs: okta_authenticator.

Documentation

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

func Authenticator_GenerateConfigForImport 

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

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

func Authenticator_IsConstruct 

func Authenticator_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 Authenticator_IsTerraformElement 

func Authenticator_IsTerraformElement(x interface{}) *bool

Experimental.

func Authenticator_IsTerraformResource 

func Authenticator_IsTerraformResource(x interface{}) *bool

Experimental.

func Authenticator_TfResourceType 

func Authenticator_TfResourceType() *string

func NewAuthenticator_Override 

func NewAuthenticator_Override(a Authenticator, scope constructs.Construct, id *string, config *AuthenticatorConfig)

Create a new {@link https://registry.terraform.io/providers/okta/okta/4.5.0/docs/resources/authenticator okta_authenticator} Resource.

Types

type Authenticator 

type Authenticator interface {
	cdktf.TerraformResource
	// Experimental.
	CdktfStack() cdktf.TerraformStack
	// 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
	Key() *string
	SetKey(val *string)
	KeyInput() *string
	// Experimental.
	Lifecycle() *cdktf.TerraformResourceLifecycle
	// Experimental.
	SetLifecycle(val *cdktf.TerraformResourceLifecycle)
	Name() *string
	SetName(val *string)
	NameInput() *string
	// The tree node.
	Node() constructs.Node
	// Experimental.
	Provider() cdktf.TerraformProvider
	// Experimental.
	SetProvider(val cdktf.TerraformProvider)
	ProviderAuthPort() *float64
	SetProviderAuthPort(val *float64)
	ProviderAuthPortInput() *float64
	ProviderHost() *string
	SetProviderHost(val *string)
	ProviderHostInput() *string
	ProviderHostname() *string
	SetProviderHostname(val *string)
	ProviderHostnameInput() *string
	ProviderInstanceId() *string
	ProviderIntegrationKey() *string
	SetProviderIntegrationKey(val *string)
	ProviderIntegrationKeyInput() *string
	ProviderJson() *string
	SetProviderJson(val *string)
	ProviderJsonInput() *string
	ProviderSecretKey() *string
	SetProviderSecretKey(val *string)
	ProviderSecretKeyInput() *string
	ProviderSharedSecret() *string
	SetProviderSharedSecret(val *string)
	ProviderSharedSecretInput() *string
	ProviderType() *string
	ProviderUserNameTemplate() *string
	SetProviderUserNameTemplate(val *string)
	ProviderUserNameTemplateInput() *string
	// Experimental.
	Provisioners() *[]interface{}
	// Experimental.
	SetProvisioners(val *[]interface{})
	// Experimental.
	RawOverrides() interface{}
	Settings() *string
	SetSettings(val *string)
	SettingsInput() *string
	Status() *string
	SetStatus(val *string)
	StatusInput() *string
	// Experimental.
	TerraformGeneratorMetadata() *cdktf.TerraformProviderGeneratorMetadata
	// Experimental.
	TerraformMetaArguments() *map[string]interface{}
	// Experimental.
	TerraformResourceType() *string
	Type() *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.
	ImportFrom(id *string, provider cdktf.TerraformProvider)
	// Experimental.
	InterpolationForAttribute(terraformAttribute *string) cdktf.IResolvable
	// Moves this resource to the target resource given by moveTarget.
	// Experimental.
	MoveTo(moveTarget *string, index interface{})
	// Overrides the auto-generated logical ID with a specific ID.
	// Experimental.
	OverrideLogicalId(newLogicalId *string)
	ResetId()
	// Resets a previously passed logical Id to use the auto-generated logical id again.
	// Experimental.
	ResetOverrideLogicalId()
	ResetProviderAuthPort()
	ResetProviderHost()
	ResetProviderHostname()
	ResetProviderIntegrationKey()
	ResetProviderJson()
	ResetProviderSecretKey()
	ResetProviderSharedSecret()
	ResetProviderUserNameTemplate()
	ResetSettings()
	ResetStatus()
	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/okta/okta/4.5.0/docs/resources/authenticator okta_authenticator}.

func NewAuthenticator 

func NewAuthenticator(scope constructs.Construct, id *string, config *AuthenticatorConfig) Authenticator

Create a new {@link https://registry.terraform.io/providers/okta/okta/4.5.0/docs/resources/authenticator okta_authenticator} Resource.

type AuthenticatorConfig 

type AuthenticatorConfig 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"`
	// A human-readable string that identifies the Authenticator.
	//
	// Docs at Terraform Registry: {@link https://registry.terraform.io/providers/okta/okta/4.5.0/docs/resources/authenticator#key Authenticator#key}
	Key *string `field:"required" json:"key" yaml:"key"`
	// Display name of the Authenticator.
	//
	// Docs at Terraform Registry: {@link https://registry.terraform.io/providers/okta/okta/4.5.0/docs/resources/authenticator#name Authenticator#name}
	Name *string `field:"required" json:"name" yaml:"name"`
	// Docs at Terraform Registry: {@link https://registry.terraform.io/providers/okta/okta/4.5.0/docs/resources/authenticator#id Authenticator#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 RADIUS server port (for example 1812). This is defined when the On-Prem RADIUS server is configured.
	//
	// Docs at Terraform Registry: {@link https://registry.terraform.io/providers/okta/okta/4.5.0/docs/resources/authenticator#provider_auth_port Authenticator#provider_auth_port}
	ProviderAuthPort *float64 `field:"optional" json:"providerAuthPort" yaml:"providerAuthPort"`
	// The Duo Security API hostname.
	//
	// Docs at Terraform Registry: {@link https://registry.terraform.io/providers/okta/okta/4.5.0/docs/resources/authenticator#provider_host Authenticator#provider_host}
	ProviderHost *string `field:"optional" json:"providerHost" yaml:"providerHost"`
	// Server host name or IP address.
	//
	// Docs at Terraform Registry: {@link https://registry.terraform.io/providers/okta/okta/4.5.0/docs/resources/authenticator#provider_hostname Authenticator#provider_hostname}
	ProviderHostname *string `field:"optional" json:"providerHostname" yaml:"providerHostname"`
	// The Duo Security integration key.
	//
	// Docs at Terraform Registry: {@link https://registry.terraform.io/providers/okta/okta/4.5.0/docs/resources/authenticator#provider_integration_key Authenticator#provider_integration_key}
	ProviderIntegrationKey *string `field:"optional" json:"providerIntegrationKey" yaml:"providerIntegrationKey"`
	// Provider in JSON format.
	//
	// Docs at Terraform Registry: {@link https://registry.terraform.io/providers/okta/okta/4.5.0/docs/resources/authenticator#provider_json Authenticator#provider_json}
	ProviderJson *string `field:"optional" json:"providerJson" yaml:"providerJson"`
	// The Duo Security secret key.
	//
	// Docs at Terraform Registry: {@link https://registry.terraform.io/providers/okta/okta/4.5.0/docs/resources/authenticator#provider_secret_key Authenticator#provider_secret_key}
	ProviderSecretKey *string `field:"optional" json:"providerSecretKey" yaml:"providerSecretKey"`
	// An authentication key that must be defined when the RADIUS server is configured, and must be the same on both the RADIUS client and server.
	//
	// Docs at Terraform Registry: {@link https://registry.terraform.io/providers/okta/okta/4.5.0/docs/resources/authenticator#provider_shared_secret Authenticator#provider_shared_secret}
	ProviderSharedSecret *string `field:"optional" json:"providerSharedSecret" yaml:"providerSharedSecret"`
	// Format expected by the provider.
	//
	// Docs at Terraform Registry: {@link https://registry.terraform.io/providers/okta/okta/4.5.0/docs/resources/authenticator#provider_user_name_template Authenticator#provider_user_name_template}
	ProviderUserNameTemplate *string `field:"optional" json:"providerUserNameTemplate" yaml:"providerUserNameTemplate"`
	// Authenticator settings in JSON format.
	//
	// Docs at Terraform Registry: {@link https://registry.terraform.io/providers/okta/okta/4.5.0/docs/resources/authenticator#settings Authenticator#settings}
	Settings *string `field:"optional" json:"settings" yaml:"settings"`
	// Authenticator status: ACTIVE or INACTIVE.
	//
	// Docs at Terraform Registry: {@link https://registry.terraform.io/providers/okta/okta/4.5.0/docs/resources/authenticator#status Authenticator#status}
	Status *string `field:"optional" json:"status" yaml:"status"`
}

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.