authserverscope

README

okta_auth_server_scope

Refer to the Terraform Registory for docs: okta_auth_server_scope.

Documentation

Index

• func AuthServerScope_GenerateConfigForImport(scope constructs.Construct, importToId *string, importFromId *string, ...) cdktf.ImportableResource
• func AuthServerScope_IsConstruct(x interface{}) *bool
• func AuthServerScope_IsTerraformElement(x interface{}) *bool
• func AuthServerScope_IsTerraformResource(x interface{}) *bool
• func AuthServerScope_TfResourceType() *string
• func NewAuthServerScope_Override(a AuthServerScope, scope constructs.Construct, id *string, ...)
• type AuthServerScope
  • func NewAuthServerScope(scope constructs.Construct, id *string, config *AuthServerScopeConfig) AuthServerScope
• type AuthServerScopeConfig

Functions

func AuthServerScope_GenerateConfigForImport

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

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

func AuthServerScope_IsConstruct

func AuthServerScope_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 AuthServerScope_IsTerraformElement

func AuthServerScope_IsTerraformElement(x interface{}) *bool

Experimental.

func AuthServerScope_IsTerraformResource

func AuthServerScope_IsTerraformResource(x interface{}) *bool

Experimental.

func AuthServerScope_TfResourceType

func AuthServerScope_TfResourceType() *string

func NewAuthServerScope_Override

func NewAuthServerScope_Override(a AuthServerScope, scope constructs.Construct, id *string, config *AuthServerScopeConfig)

Create a new {@link https://registry.terraform.io/providers/okta/okta/4.6.2/docs/resources/auth_server_scope okta_auth_server_scope} Resource.

Types

type AuthServerScope

type AuthServerScope interface {
	cdktf.TerraformResource
	AuthServerId() *string
	SetAuthServerId(val *string)
	AuthServerIdInput() *string
	// Experimental.
	CdktfStack() cdktf.TerraformStack
	// Experimental.
	Connection() interface{}
	// Experimental.
	SetConnection(val interface{})
	Consent() *string
	SetConsent(val *string)
	ConsentInput() *string
	// 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)
	Description() *string
	SetDescription(val *string)
	DescriptionInput() *string
	DisplayName() *string
	SetDisplayName(val *string)
	DisplayNameInput() *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)
	MetadataPublish() *string
	SetMetadataPublish(val *string)
	MetadataPublishInput() *string
	Name() *string
	SetName(val *string)
	NameInput() *string
	// The tree node.
	Node() constructs.Node
	Optional() interface{}
	SetOptional(val interface{})
	OptionalInput() interface{}
	// Experimental.
	Provider() cdktf.TerraformProvider
	// Experimental.
	SetProvider(val cdktf.TerraformProvider)
	// Experimental.
	Provisioners() *[]interface{}
	// Experimental.
	SetProvisioners(val *[]interface{})
	// Experimental.
	RawOverrides() interface{}
	SystemAttribute() cdktf.IResolvable
	// Experimental.
	TerraformGeneratorMetadata() *cdktf.TerraformProviderGeneratorMetadata
	// Experimental.
	TerraformMetaArguments() *map[string]interface{}
	// Experimental.
	TerraformResourceType() *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)
	ResetConsent()
	ResetDefault()
	ResetDescription()
	ResetDisplayName()
	ResetId()
	ResetMetadataPublish()
	ResetOptional()
	// Resets a previously passed logical Id to use the auto-generated logical id again.
	// Experimental.
	ResetOverrideLogicalId()
	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.6.2/docs/resources/auth_server_scope okta_auth_server_scope}.

func NewAuthServerScope

func NewAuthServerScope(scope constructs.Construct, id *string, config *AuthServerScopeConfig) AuthServerScope

Create a new {@link https://registry.terraform.io/providers/okta/okta/4.6.2/docs/resources/auth_server_scope okta_auth_server_scope} Resource.

type AuthServerScopeConfig

type AuthServerScopeConfig 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"`
	// Auth server ID.
	//
	// Docs at Terraform Registry: {@link https://registry.terraform.io/providers/okta/okta/4.6.2/docs/resources/auth_server_scope#auth_server_id AuthServerScope#auth_server_id}
	AuthServerId *string `field:"required" json:"authServerId" yaml:"authServerId"`
	// Auth server scope name.
	//
	// Docs at Terraform Registry: {@link https://registry.terraform.io/providers/okta/okta/4.6.2/docs/resources/auth_server_scope#name AuthServerScope#name}
	Name *string `field:"required" json:"name" yaml:"name"`
	// EA Feature and thus it is simply ignored if the feature is off.
	//
	// Docs at Terraform Registry: {@link https://registry.terraform.io/providers/okta/okta/4.6.2/docs/resources/auth_server_scope#consent AuthServerScope#consent}
	Consent *string `field:"optional" json:"consent" yaml:"consent"`
	// A default scope will be returned in an access token when the client omits the scope parameter in a token request, provided this scope is allowed as part of the access policy rule.
	//
	// Docs at Terraform Registry: {@link https://registry.terraform.io/providers/okta/okta/4.6.2/docs/resources/auth_server_scope#default AuthServerScope#default}
	Default interface{} `field:"optional" json:"default" yaml:"default"`
	// Description of the Auth Server Scope.
	//
	// Docs at Terraform Registry: {@link https://registry.terraform.io/providers/okta/okta/4.6.2/docs/resources/auth_server_scope#description AuthServerScope#description}
	Description *string `field:"optional" json:"description" yaml:"description"`
	// Name of the end user displayed in a consent dialog box.
	//
	// Docs at Terraform Registry: {@link https://registry.terraform.io/providers/okta/okta/4.6.2/docs/resources/auth_server_scope#display_name AuthServerScope#display_name}
	DisplayName *string `field:"optional" json:"displayName" yaml:"displayName"`
	// Docs at Terraform Registry: {@link https://registry.terraform.io/providers/okta/okta/4.6.2/docs/resources/auth_server_scope#id AuthServerScope#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"`
	// Whether to publish metadata or not, matching API type despite the fact it could just be a boolean.
	//
	// Docs at Terraform Registry: {@link https://registry.terraform.io/providers/okta/okta/4.6.2/docs/resources/auth_server_scope#metadata_publish AuthServerScope#metadata_publish}
	MetadataPublish *string `field:"optional" json:"metadataPublish" yaml:"metadataPublish"`
	// Whether the scope optional.
	//
	// Docs at Terraform Registry: {@link https://registry.terraform.io/providers/okta/okta/4.6.2/docs/resources/auth_server_scope#optional AuthServerScope#optional}
	Optional interface{} `field:"optional" json:"optional" yaml:"optional"`
}