Skip to content

Latest commit

 

History

History
1506 lines (947 loc) · 58 KB

orgConfiguration.go.md

File metadata and controls

1506 lines (947 loc) · 58 KB

orgConfiguration Submodule

Constructs

OrgConfiguration

Represents a {@link https://registry.terraform.io/providers/okta/okta/4.12.0/docs/resources/org_configuration okta_org_configuration}.

Initializers

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

orgconfiguration.NewOrgConfiguration(scope Construct, id *string, config OrgConfigurationConfig) OrgConfiguration
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 OrgConfigurationConfig 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".
ResetAddress1 No description.
ResetAddress2 No description.
ResetBillingContactUser No description.
ResetCity No description.
ResetCountry No description.
ResetEndUserSupportHelpUrl No description.
ResetId No description.
ResetLogo No description.
ResetOptOutCommunicationEmails No description.
ResetPhoneNumber No description.
ResetPostalCode No description.
ResetState No description.
ResetSupportPhoneNumber No description.
ResetTechnicalContactUser No description.
ResetWebsite 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".


ResetAddress1
func ResetAddress1()
ResetAddress2
func ResetAddress2()
ResetBillingContactUser
func ResetBillingContactUser()
ResetCity
func ResetCity()
ResetCountry
func ResetCountry()
ResetEndUserSupportHelpUrl
func ResetEndUserSupportHelpUrl()
ResetId
func ResetId()
ResetLogo
func ResetLogo()
ResetOptOutCommunicationEmails
func ResetOptOutCommunicationEmails()
ResetPhoneNumber
func ResetPhoneNumber()
ResetPostalCode
func ResetPostalCode()
ResetState
func ResetState()
ResetSupportPhoneNumber
func ResetSupportPhoneNumber()
ResetTechnicalContactUser
func ResetTechnicalContactUser()
ResetWebsite
func ResetWebsite()

Static Functions

Name Description
IsConstruct Checks if x is a construct.
IsTerraformElement No description.
IsTerraformResource No description.
GenerateConfigForImport Generates CDKTF code for importing a OrgConfiguration resource upon running "cdktf plan ".

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

orgconfiguration.OrgConfiguration_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/orgconfiguration"

orgconfiguration.OrgConfiguration_IsTerraformElement(x interface{}) *bool
xRequired
  • Type: interface{}

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

orgconfiguration.OrgConfiguration_IsTerraformResource(x interface{}) *bool
xRequired
  • Type: interface{}

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

orgconfiguration.OrgConfiguration_GenerateConfigForImport(scope Construct, importToId *string, importFromId *string, provider TerraformProvider) ImportableResource

Generates CDKTF code for importing a OrgConfiguration 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 OrgConfiguration to import.


importFromIdRequired
  • Type: *string

The id of the existing OrgConfiguration that should be imported.

Refer to the {@link https://registry.terraform.io/providers/okta/okta/4.12.0/docs/resources/org_configuration#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 OrgConfiguration 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.
ExpiresAt *string No description.
Subdomain *string No description.
Address1Input *string No description.
Address2Input *string No description.
BillingContactUserInput *string No description.
CityInput *string No description.
CompanyNameInput *string No description.
CountryInput *string No description.
EndUserSupportHelpUrlInput *string No description.
IdInput *string No description.
LogoInput *string No description.
OptOutCommunicationEmailsInput interface{} No description.
PhoneNumberInput *string No description.
PostalCodeInput *string No description.
StateInput *string No description.
SupportPhoneNumberInput *string No description.
TechnicalContactUserInput *string No description.
WebsiteInput *string No description.
Address1 *string No description.
Address2 *string No description.
BillingContactUser *string No description.
City *string No description.
CompanyName *string No description.
Country *string No description.
EndUserSupportHelpUrl *string No description.
Id *string No description.
Logo *string No description.
OptOutCommunicationEmails interface{} No description.
PhoneNumber *string No description.
PostalCode *string No description.
State *string No description.
SupportPhoneNumber *string No description.
TechnicalContactUser *string No description.
Website *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{}

ExpiresAtRequired
func ExpiresAt() *string
  • Type: *string

SubdomainRequired
func Subdomain() *string
  • Type: *string

Address1InputOptional
func Address1Input() *string
  • Type: *string

Address2InputOptional
func Address2Input() *string
  • Type: *string

BillingContactUserInputOptional
func BillingContactUserInput() *string
  • Type: *string

CityInputOptional
func CityInput() *string
  • Type: *string

CompanyNameInputOptional
func CompanyNameInput() *string
  • Type: *string

CountryInputOptional
func CountryInput() *string
  • Type: *string

EndUserSupportHelpUrlInputOptional
func EndUserSupportHelpUrlInput() *string
  • Type: *string

IdInputOptional
func IdInput() *string
  • Type: *string

LogoInputOptional
func LogoInput() *string
  • Type: *string

OptOutCommunicationEmailsInputOptional
func OptOutCommunicationEmailsInput() interface{}
  • Type: interface{}

PhoneNumberInputOptional
func PhoneNumberInput() *string
  • Type: *string

PostalCodeInputOptional
func PostalCodeInput() *string
  • Type: *string

StateInputOptional
func StateInput() *string
  • Type: *string

SupportPhoneNumberInputOptional
func SupportPhoneNumberInput() *string
  • Type: *string

TechnicalContactUserInputOptional
func TechnicalContactUserInput() *string
  • Type: *string

WebsiteInputOptional
func WebsiteInput() *string
  • Type: *string

Address1Required
func Address1() *string
  • Type: *string

Address2Required
func Address2() *string
  • Type: *string

BillingContactUserRequired
func BillingContactUser() *string
  • Type: *string

CityRequired
func City() *string
  • Type: *string

CompanyNameRequired
func CompanyName() *string
  • Type: *string

CountryRequired
func Country() *string
  • Type: *string

EndUserSupportHelpUrlRequired
func EndUserSupportHelpUrl() *string
  • Type: *string

IdRequired
func Id() *string
  • Type: *string

LogoRequired
func Logo() *string
  • Type: *string

OptOutCommunicationEmailsRequired
func OptOutCommunicationEmails() interface{}
  • Type: interface{}

PhoneNumberRequired
func PhoneNumber() *string
  • Type: *string

PostalCodeRequired
func PostalCode() *string
  • Type: *string

StateRequired
func State() *string
  • Type: *string

SupportPhoneNumberRequired
func SupportPhoneNumber() *string
  • Type: *string

TechnicalContactUserRequired
func TechnicalContactUser() *string
  • Type: *string

WebsiteRequired
func Website() *string
  • Type: *string

Constants

Name Type Description
TfResourceType *string No description.

TfResourceTypeRequired
func TfResourceType() *string
  • Type: *string

Structs

OrgConfigurationConfig

Initializer

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

&orgconfiguration.OrgConfigurationConfig {
	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{},
	CompanyName: *string,
	Address1: *string,
	Address2: *string,
	BillingContactUser: *string,
	City: *string,
	Country: *string,
	EndUserSupportHelpUrl: *string,
	Id: *string,
	Logo: *string,
	OptOutCommunicationEmails: interface{},
	PhoneNumber: *string,
	PostalCode: *string,
	State: *string,
	SupportPhoneNumber: *string,
	TechnicalContactUser: *string,
	Website: *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.
CompanyName *string Name of org.
Address1 *string Primary address of org.
Address2 *string Secondary address of org.
BillingContactUser *string User ID representing the billing contact.
City *string City of org.
Country *string Country of org.
EndUserSupportHelpUrl *string Support link of org.
Id *string Docs at Terraform Registry: {@link https://registry.terraform.io/providers/okta/okta/4.12.0/docs/resources/org_configuration#id OrgConfiguration#id}.
Logo *string Logo of org.
OptOutCommunicationEmails interface{} Indicates whether the org's users receive Okta Communication emails.
PhoneNumber *string Support help phone of org.
PostalCode *string Postal code of org.
State *string State of org.
SupportPhoneNumber *string Support help phone of org.
TechnicalContactUser *string User ID representing the technical contact.
Website *string The org's website.

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{}

CompanyNameRequired
CompanyName *string
  • Type: *string

Name of org.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/okta/okta/4.12.0/docs/resources/org_configuration#company_name OrgConfiguration#company_name}


Address1Optional
Address1 *string
  • Type: *string

Primary address of org.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/okta/okta/4.12.0/docs/resources/org_configuration#address_1 OrgConfiguration#address_1}


Address2Optional
Address2 *string
  • Type: *string

Secondary address of org.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/okta/okta/4.12.0/docs/resources/org_configuration#address_2 OrgConfiguration#address_2}


BillingContactUserOptional
BillingContactUser *string
  • Type: *string

User ID representing the billing contact.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/okta/okta/4.12.0/docs/resources/org_configuration#billing_contact_user OrgConfiguration#billing_contact_user}


CityOptional
City *string
  • Type: *string

City of org.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/okta/okta/4.12.0/docs/resources/org_configuration#city OrgConfiguration#city}


CountryOptional
Country *string
  • Type: *string

Country of org.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/okta/okta/4.12.0/docs/resources/org_configuration#country OrgConfiguration#country}


EndUserSupportHelpUrlOptional
EndUserSupportHelpUrl *string
  • Type: *string

Support link of org.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/okta/okta/4.12.0/docs/resources/org_configuration#end_user_support_help_url OrgConfiguration#end_user_support_help_url}


IdOptional
Id *string
  • Type: *string

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


LogoOptional
Logo *string
  • Type: *string

Logo of org.

The file must be in PNG, JPG, or GIF format and less than 1 MB in size. For best results use landscape orientation, a transparent background, and a minimum size of 420px by 120px to prevent upscaling.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/okta/okta/4.12.0/docs/resources/org_configuration#logo OrgConfiguration#logo}


OptOutCommunicationEmailsOptional
OptOutCommunicationEmails interface{}
  • Type: interface{}

Indicates whether the org's users receive Okta Communication emails.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/okta/okta/4.12.0/docs/resources/org_configuration#opt_out_communication_emails OrgConfiguration#opt_out_communication_emails}


PhoneNumberOptional
PhoneNumber *string
  • Type: *string

Support help phone of org.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/okta/okta/4.12.0/docs/resources/org_configuration#phone_number OrgConfiguration#phone_number}


PostalCodeOptional
PostalCode *string
  • Type: *string

Postal code of org.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/okta/okta/4.12.0/docs/resources/org_configuration#postal_code OrgConfiguration#postal_code}


StateOptional
State *string
  • Type: *string

State of org.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/okta/okta/4.12.0/docs/resources/org_configuration#state OrgConfiguration#state}


SupportPhoneNumberOptional
SupportPhoneNumber *string
  • Type: *string

Support help phone of org.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/okta/okta/4.12.0/docs/resources/org_configuration#support_phone_number OrgConfiguration#support_phone_number}


TechnicalContactUserOptional
TechnicalContactUser *string
  • Type: *string

User ID representing the technical contact.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/okta/okta/4.12.0/docs/resources/org_configuration#technical_contact_user OrgConfiguration#technical_contact_user}


WebsiteOptional
Website *string
  • Type: *string

The org's website.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/okta/okta/4.12.0/docs/resources/org_configuration#website OrgConfiguration#website}