Skip to content

Latest commit

 

History

History
1153 lines (719 loc) · 47.3 KB

userBaseSchemaProperty.go.md

File metadata and controls

1153 lines (719 loc) · 47.3 KB
Raw

userBaseSchemaProperty Submodule

Constructs

UserBaseSchemaProperty

Represents a {@link https://registry.terraform.io/providers/okta/okta/4.8.1/docs/resources/user_base_schema_property okta_user_base_schema_property}.

Initializers 

import "github.com/cdktf/cdktf-provider-okta-go/okta/v13/userbaseschemaproperty"

userbaseschemaproperty.NewUserBaseSchemaProperty(scope Construct, id *string, config UserBaseSchemaPropertyConfig) UserBaseSchemaProperty
Name Type Description
scope github.com/aws/constructs-go/constructs/v10.Construct The scope in which to define this construct.
id *string The scoped construct ID.
config UserBaseSchemaPropertyConfig No description.
scopeRequired
  • Type: github.com/aws/constructs-go/constructs/v10.Construct

The scope in which to define this construct.

idRequired
  • Type: *string

The scoped construct ID.

Must be unique amongst siblings in the same scope

configRequired

Methods

Name Description
ToString Returns a string representation of this construct.
AddOverride No description.
OverrideLogicalId Overrides the auto-generated logical ID with a specific ID.
ResetOverrideLogicalId Resets a previously passed logical Id to use the auto-generated logical id again.
ToHclTerraform No description.
ToMetadata No description.
ToTerraform Adds this resource to the terraform JSON output.
AddMoveTarget Adds a user defined moveTarget string to this resource to be later used in .moveTo(moveTarget) to resolve the location of the move.
GetAnyMapAttribute No description.
GetBooleanAttribute No description.
GetBooleanMapAttribute No description.
GetListAttribute No description.
GetNumberAttribute No description.
GetNumberListAttribute No description.
GetNumberMapAttribute No description.
GetStringAttribute No description.
GetStringMapAttribute No description.
HasResourceMove No description.
ImportFrom No description.
InterpolationForAttribute No description.
MoveFromId Move the resource corresponding to "id" to this resource.
MoveTo Moves this resource to the target resource given by moveTarget.
MoveToId Moves this resource to the resource corresponding to "id".
ResetId No description.
ResetMaster No description.
ResetPattern No description.
ResetPermissions No description.
ResetRequired No description.
ResetUserType No description.
ToString 
func ToString() *string

Returns a string representation of this construct.

AddOverride 
func AddOverride(path *string, value interface{})
pathRequired
  • Type: *string
valueRequired
  • Type: interface{}
OverrideLogicalId 
func OverrideLogicalId(newLogicalId *string)

Overrides the auto-generated logical ID with a specific ID.

newLogicalIdRequired
  • Type: *string

The new logical ID to use for this stack element.

ResetOverrideLogicalId 
func ResetOverrideLogicalId()

Resets a previously passed logical Id to use the auto-generated logical id again.

ToHclTerraform 
func ToHclTerraform() interface{}
ToMetadata 
func ToMetadata() interface{}
ToTerraform 
func ToTerraform() interface{}

Adds this resource to the terraform JSON output.

AddMoveTarget 
func AddMoveTarget(moveTarget *string)

Adds a user defined moveTarget string to this resource to be later used in .moveTo(moveTarget) to resolve the location of the move.

moveTargetRequired
  • Type: *string

The string move target that will correspond to this resource.

GetAnyMapAttribute 
func GetAnyMapAttribute(terraformAttribute *string) *map[string]interface{}
terraformAttributeRequired
  • Type: *string
GetBooleanAttribute 
func GetBooleanAttribute(terraformAttribute *string) IResolvable
terraformAttributeRequired
  • Type: *string
GetBooleanMapAttribute 
func GetBooleanMapAttribute(terraformAttribute *string) *map[string]*bool
terraformAttributeRequired
  • Type: *string
GetListAttribute 
func GetListAttribute(terraformAttribute *string) *[]*string
terraformAttributeRequired
  • Type: *string
GetNumberAttribute 
func GetNumberAttribute(terraformAttribute *string) *f64
terraformAttributeRequired
  • Type: *string
GetNumberListAttribute 
func GetNumberListAttribute(terraformAttribute *string) *[]*f64
terraformAttributeRequired
  • Type: *string
GetNumberMapAttribute 
func GetNumberMapAttribute(terraformAttribute *string) *map[string]*f64
terraformAttributeRequired
  • Type: *string
GetStringAttribute 
func GetStringAttribute(terraformAttribute *string) *string
terraformAttributeRequired
  • Type: *string
GetStringMapAttribute 
func GetStringMapAttribute(terraformAttribute *string) *map[string]*string
terraformAttributeRequired
  • Type: *string
HasResourceMove 
func HasResourceMove() interface{}
ImportFrom 
func ImportFrom(id *string, provider TerraformProvider)
idRequired
  • Type: *string
providerOptional
  • Type: github.com/hashicorp/terraform-cdk-go/cdktf.TerraformProvider
InterpolationForAttribute 
func InterpolationForAttribute(terraformAttribute *string) IResolvable
terraformAttributeRequired
  • Type: *string
MoveFromId 
func MoveFromId(id *string)

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.

idRequired
  • Type: *string

Full id of resource being moved from, e.g. "aws_s3_bucket.example".

MoveTo 
func MoveTo(moveTarget *string, index interface{})

Moves this resource to the target resource given by moveTarget.

moveTargetRequired
  • Type: *string

The previously set user defined string set by .addMoveTarget() corresponding to the resource to move to.

indexOptional
  • Type: interface{}

Optional The index corresponding to the key the resource is to appear in the foreach of a resource to move to.

MoveToId 
func MoveToId(id *string)

Moves this resource to the resource corresponding to "id".

idRequired
  • Type: *string

Full id of resource to move to, e.g. "aws_s3_bucket.example".

ResetId 
func ResetId()
ResetMaster 
func ResetMaster()
ResetPattern 
func ResetPattern()
ResetPermissions 
func ResetPermissions()
ResetRequired 
func ResetRequired()
ResetUserType 
func ResetUserType()

Static Functions

Name Description
IsConstruct Checks if x is a construct.
IsTerraformElement No description.
IsTerraformResource No description.
GenerateConfigForImport Generates CDKTF code for importing a UserBaseSchemaProperty resource upon running "cdktf plan ".
IsConstruct 
import "github.com/cdktf/cdktf-provider-okta-go/okta/v13/userbaseschemaproperty"

userbaseschemaproperty.UserBaseSchemaProperty_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.

xRequired
  • Type: interface{}

Any object.

IsTerraformElement 
import "github.com/cdktf/cdktf-provider-okta-go/okta/v13/userbaseschemaproperty"

userbaseschemaproperty.UserBaseSchemaProperty_IsTerraformElement(x interface{}) *bool
xRequired
  • Type: interface{}
IsTerraformResource 
import "github.com/cdktf/cdktf-provider-okta-go/okta/v13/userbaseschemaproperty"

userbaseschemaproperty.UserBaseSchemaProperty_IsTerraformResource(x interface{}) *bool
xRequired
  • Type: interface{}
GenerateConfigForImport 
import "github.com/cdktf/cdktf-provider-okta-go/okta/v13/userbaseschemaproperty"

userbaseschemaproperty.UserBaseSchemaProperty_GenerateConfigForImport(scope Construct, importToId *string, importFromId *string, provider TerraformProvider) ImportableResource

Generates CDKTF code for importing a UserBaseSchemaProperty resource upon running "cdktf plan ".

scopeRequired
  • Type: github.com/aws/constructs-go/constructs/v10.Construct

The scope in which to define this construct.

importToIdRequired
  • Type: *string

The construct id used in the generated config for the UserBaseSchemaProperty to import.

importFromIdRequired
  • Type: *string

The id of the existing UserBaseSchemaProperty that should be imported.

Refer to the {@link https://registry.terraform.io/providers/okta/okta/4.8.1/docs/resources/user_base_schema_property#import import section} in the documentation of this resource for the id to use

providerOptional
  • Type: github.com/hashicorp/terraform-cdk-go/cdktf.TerraformProvider

? Optional instance of the provider where the UserBaseSchemaProperty to import is found.

Properties

Name Type Description
Node github.com/aws/constructs-go/constructs/v10.Node The tree node.
CdktfStack github.com/hashicorp/terraform-cdk-go/cdktf.TerraformStack No description.
Fqn *string No description.
FriendlyUniqueId *string No description.
TerraformMetaArguments *map[string]interface{} No description.
TerraformResourceType *string No description.
TerraformGeneratorMetadata github.com/hashicorp/terraform-cdk-go/cdktf.TerraformProviderGeneratorMetadata No description.
Connection interface{} No description.
Count interface{} No description.
DependsOn *[]*string No description.
ForEach github.com/hashicorp/terraform-cdk-go/cdktf.ITerraformIterator No description.
Lifecycle github.com/hashicorp/terraform-cdk-go/cdktf.TerraformResourceLifecycle No description.
Provider github.com/hashicorp/terraform-cdk-go/cdktf.TerraformProvider No description.
Provisioners *[]interface{} No description.
IdInput *string No description.
IndexInput *string No description.
MasterInput *string No description.
PatternInput *string No description.
PermissionsInput *string No description.
RequiredInput interface{} No description.
TitleInput *string No description.
TypeInput *string No description.
UserTypeInput *string No description.
Id *string No description.
Index *string No description.
Master *string No description.
Pattern *string No description.
Permissions *string No description.
Required interface{} No description.
Title *string No description.
Type *string No description.
UserType *string No description.
NodeRequired 
func Node() Node
  • Type: github.com/aws/constructs-go/constructs/v10.Node

The tree node.

CdktfStackRequired 
func CdktfStack() TerraformStack
  • Type: github.com/hashicorp/terraform-cdk-go/cdktf.TerraformStack
FqnRequired 
func Fqn() *string
  • Type: *string
FriendlyUniqueIdRequired 
func FriendlyUniqueId() *string
  • Type: *string
TerraformMetaArgumentsRequired 
func TerraformMetaArguments() *map[string]interface{}
  • Type: *map[string]interface{}
TerraformResourceTypeRequired 
func TerraformResourceType() *string
  • Type: *string
TerraformGeneratorMetadataOptional 
func TerraformGeneratorMetadata() TerraformProviderGeneratorMetadata
  • Type: github.com/hashicorp/terraform-cdk-go/cdktf.TerraformProviderGeneratorMetadata
ConnectionOptional 
func Connection() interface{}
  • Type: interface{}
CountOptional 
func Count() interface{}
  • Type: interface{}
DependsOnOptional 
func DependsOn() *[]*string
  • Type: *[]*string
ForEachOptional 
func ForEach() ITerraformIterator
  • Type: github.com/hashicorp/terraform-cdk-go/cdktf.ITerraformIterator
LifecycleOptional 
func Lifecycle() TerraformResourceLifecycle
  • Type: github.com/hashicorp/terraform-cdk-go/cdktf.TerraformResourceLifecycle
ProviderOptional 
func Provider() TerraformProvider
  • Type: github.com/hashicorp/terraform-cdk-go/cdktf.TerraformProvider
ProvisionersOptional 
func Provisioners() *[]interface{}
  • Type: *[]interface{}
IdInputOptional 
func IdInput() *string
  • Type: *string
IndexInputOptional 
func IndexInput() *string
  • Type: *string
MasterInputOptional 
func MasterInput() *string
  • Type: *string
PatternInputOptional 
func PatternInput() *string
  • Type: *string
PermissionsInputOptional 
func PermissionsInput() *string
  • Type: *string
RequiredInputOptional 
func RequiredInput() interface{}
  • Type: interface{}
TitleInputOptional 
func TitleInput() *string
  • Type: *string
TypeInputOptional 
func TypeInput() *string
  • Type: *string
UserTypeInputOptional 
func UserTypeInput() *string
  • Type: *string
IdRequired 
func Id() *string
  • Type: *string
IndexRequired 
func Index() *string
  • Type: *string
MasterRequired 
func Master() *string
  • Type: *string
PatternRequired 
func Pattern() *string
  • Type: *string
PermissionsRequired 
func Permissions() *string
  • Type: *string
RequiredRequired 
func Required() interface{}
  • Type: interface{}
TitleRequired 
func Title() *string
  • Type: *string
TypeRequired 
func Type() *string
  • Type: *string
UserTypeRequired 
func UserType() *string
  • Type: *string

Constants

Name Type Description
TfResourceType *string No description.
TfResourceTypeRequired 
func TfResourceType() *string
  • Type: *string

Structs

UserBaseSchemaPropertyConfig

Initializer 

import "github.com/cdktf/cdktf-provider-okta-go/okta/v13/userbaseschemaproperty"

&userbaseschemaproperty.UserBaseSchemaPropertyConfig {
	Connection: interface{},
	Count: interface{},
	DependsOn: *[]github.com/hashicorp/terraform-cdk-go/cdktf.ITerraformDependable,
	ForEach: github.com/hashicorp/terraform-cdk-go/cdktf.ITerraformIterator,
	Lifecycle: github.com/hashicorp/terraform-cdk-go/cdktf.TerraformResourceLifecycle,
	Provider: github.com/hashicorp/terraform-cdk-go/cdktf.TerraformProvider,
	Provisioners: *[]interface{},
	Index: *string,
	Title: *string,
	Type: *string,
	Id: *string,
	Master: *string,
	Pattern: *string,
	Permissions: *string,
	Required: interface{},
	UserType: *string,
}

Properties

Name Type Description
Connection interface{} No description.
Count interface{} No description.
DependsOn *[]github.com/hashicorp/terraform-cdk-go/cdktf.ITerraformDependable No description.
ForEach github.com/hashicorp/terraform-cdk-go/cdktf.ITerraformIterator No description.
Lifecycle github.com/hashicorp/terraform-cdk-go/cdktf.TerraformResourceLifecycle No description.
Provider github.com/hashicorp/terraform-cdk-go/cdktf.TerraformProvider No description.
Provisioners *[]interface{} No description.
Index *string Subschema unique string identifier.
Title *string Subschema title (display name).
Type *string The type of the schema property. It can be string, boolean, number, integer, array, or object.
Id *string Docs at Terraform Registry: {@link https://registry.terraform.io/providers/okta/okta/4.8.1/docs/resources/user_base_schema_property#id UserBaseSchemaProperty#id}.
Master *string Master priority for the user schema property. It can be set to PROFILE_MASTER or OKTA. Default: PROFILE_MASTER.
Pattern *string The validation pattern to use for the subschema. Must be in form of '.+', or '[]+' if present.'.
Permissions *string Access control permissions for the property. It can be set to READ_WRITE, READ_ONLY, HIDE. Default: READ_ONLY.
Required interface{} Whether the subschema is required.
UserType *string User type ID. By default, it is default.
ConnectionOptional 
Connection interface{}
  • Type: interface{}
CountOptional 
Count interface{}
  • Type: interface{}
DependsOnOptional 
DependsOn *[]ITerraformDependable
  • Type: *[]github.com/hashicorp/terraform-cdk-go/cdktf.ITerraformDependable
ForEachOptional 
ForEach ITerraformIterator
  • Type: github.com/hashicorp/terraform-cdk-go/cdktf.ITerraformIterator
LifecycleOptional 
Lifecycle TerraformResourceLifecycle
  • Type: github.com/hashicorp/terraform-cdk-go/cdktf.TerraformResourceLifecycle
ProviderOptional 
Provider TerraformProvider
  • Type: github.com/hashicorp/terraform-cdk-go/cdktf.TerraformProvider
ProvisionersOptional 
Provisioners *[]interface{}
  • Type: *[]interface{}
IndexRequired 
Index *string
  • Type: *string

Subschema unique string identifier.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/okta/okta/4.8.1/docs/resources/user_base_schema_property#index UserBaseSchemaProperty#index}

TitleRequired 
Title *string
  • Type: *string

Subschema title (display name).

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/okta/okta/4.8.1/docs/resources/user_base_schema_property#title UserBaseSchemaProperty#title}

TypeRequired 
Type *string
  • Type: *string

The type of the schema property. It can be string, boolean, number, integer, array, or object.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/okta/okta/4.8.1/docs/resources/user_base_schema_property#type UserBaseSchemaProperty#type}

IdOptional 
Id *string
  • Type: *string

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/okta/okta/4.8.1/docs/resources/user_base_schema_property#id UserBaseSchemaProperty#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.

MasterOptional 
Master *string
  • Type: *string

Master priority for the user schema property. It can be set to PROFILE_MASTER or OKTA. Default: PROFILE_MASTER.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/okta/okta/4.8.1/docs/resources/user_base_schema_property#master UserBaseSchemaProperty#master}

PatternOptional 
Pattern *string
  • Type: *string

The validation pattern to use for the subschema. Must be in form of '.+', or '[]+' if present.'.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/okta/okta/4.8.1/docs/resources/user_base_schema_property#pattern UserBaseSchemaProperty#pattern}

PermissionsOptional 
Permissions *string
  • Type: *string

Access control permissions for the property. It can be set to READ_WRITE, READ_ONLY, HIDE. Default: READ_ONLY.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/okta/okta/4.8.1/docs/resources/user_base_schema_property#permissions UserBaseSchemaProperty#permissions}

RequiredOptional 
Required interface{}
  • Type: interface{}

Whether the subschema is required.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/okta/okta/4.8.1/docs/resources/user_base_schema_property#required UserBaseSchemaProperty#required}

UserTypeOptional 
UserType *string
  • Type: *string

User type ID. By default, it is default.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/okta/okta/4.8.1/docs/resources/user_base_schema_property#user_type UserBaseSchemaProperty#user_type}