Documentation
¶
Index ¶
- func Brand_GenerateConfigForImport(scope constructs.Construct, importToId *string, importFromId *string, ...) cdktf.ImportableResource
- func Brand_IsConstruct(x interface{}) *bool
- func Brand_IsTerraformElement(x interface{}) *bool
- func Brand_IsTerraformResource(x interface{}) *bool
- func Brand_TfResourceType() *string
- func NewBrand_Override(b Brand, scope constructs.Construct, id *string, config *BrandConfig)
- type Brand
- type BrandConfig
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
func Brand_GenerateConfigForImport ¶
func Brand_GenerateConfigForImport(scope constructs.Construct, importToId *string, importFromId *string, provider cdktf.TerraformProvider) cdktf.ImportableResource
Generates CDKTF code for importing a Brand resource upon running "cdktf plan <stack-name>".
func Brand_IsConstruct ¶
func Brand_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 Brand_TfResourceType ¶
func Brand_TfResourceType() *string
func NewBrand_Override ¶
func NewBrand_Override(b Brand, scope constructs.Construct, id *string, config *BrandConfig)
Create a new {@link https://registry.terraform.io/providers/okta/okta/4.6.2/docs/resources/brand okta_brand} Resource.
Types ¶
type Brand ¶
type Brand interface { cdktf.TerraformResource AgreeToCustomPrivacyPolicy() interface{} SetAgreeToCustomPrivacyPolicy(val interface{}) AgreeToCustomPrivacyPolicyInput() interface{} BrandId() *string SetBrandId(val *string) BrandIdInput() *string // Experimental. CdktfStack() cdktf.TerraformStack // Experimental. Connection() interface{} // Experimental. SetConnection(val interface{}) // Experimental. ConstructNodeMetadata() *map[string]interface{} // Experimental. Count() interface{} // Experimental. SetCount(val interface{}) CustomPrivacyPolicyUrl() *string SetCustomPrivacyPolicyUrl(val *string) CustomPrivacyPolicyUrlInput() *string DefaultAppAppInstanceId() *string SetDefaultAppAppInstanceId(val *string) DefaultAppAppInstanceIdInput() *string DefaultAppAppLinkName() *string SetDefaultAppAppLinkName(val *string) DefaultAppAppLinkNameInput() *string DefaultAppClassicApplicationUri() *string SetDefaultAppClassicApplicationUri(val *string) DefaultAppClassicApplicationUriInput() *string // Experimental. DependsOn() *[]*string // Experimental. SetDependsOn(val *[]*string) EmailDomainId() *string // Experimental. ForEach() cdktf.ITerraformIterator // Experimental. SetForEach(val cdktf.ITerraformIterator) // Experimental. Fqn() *string // Experimental. FriendlyUniqueId() *string Id() *string IsDefault() cdktf.IResolvable // Experimental. Lifecycle() *cdktf.TerraformResourceLifecycle // Experimental. SetLifecycle(val *cdktf.TerraformResourceLifecycle) Links() *string Locale() *string SetLocale(val *string) LocaleInput() *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{} RemovePoweredByOkta() interface{} SetRemovePoweredByOkta(val interface{}) RemovePoweredByOktaInput() interface{} // 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) ResetAgreeToCustomPrivacyPolicy() ResetBrandId() ResetCustomPrivacyPolicyUrl() ResetDefaultAppAppInstanceId() ResetDefaultAppAppLinkName() ResetDefaultAppClassicApplicationUri() ResetLocale() // Resets a previously passed logical Id to use the auto-generated logical id again. // Experimental. ResetOverrideLogicalId() ResetRemovePoweredByOkta() 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/brand okta_brand}.
func NewBrand ¶
func NewBrand(scope constructs.Construct, id *string, config *BrandConfig) Brand
Create a new {@link https://registry.terraform.io/providers/okta/okta/4.6.2/docs/resources/brand okta_brand} Resource.
type BrandConfig ¶
type BrandConfig 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"` // Brand name. // // Docs at Terraform Registry: {@link https://registry.terraform.io/providers/okta/okta/4.6.2/docs/resources/brand#name Brand#name} Name *string `field:"required" json:"name" yaml:"name"` // Consent for updating the custom privacy policy URL. // // Docs at Terraform Registry: {@link https://registry.terraform.io/providers/okta/okta/4.6.2/docs/resources/brand#agree_to_custom_privacy_policy Brand#agree_to_custom_privacy_policy} AgreeToCustomPrivacyPolicy interface{} `field:"optional" json:"agreeToCustomPrivacyPolicy" yaml:"agreeToCustomPrivacyPolicy"` // Brand ID - Note: Okta API for brands only reads and updates therefore the okta_brand resource needs to act as a quasi data source. // // Do this by setting brand_id. // // Docs at Terraform Registry: {@link https://registry.terraform.io/providers/okta/okta/4.6.2/docs/resources/brand#brand_id Brand#brand_id} BrandId *string `field:"optional" json:"brandId" yaml:"brandId"` // Custom privacy policy URL. // // Docs at Terraform Registry: {@link https://registry.terraform.io/providers/okta/okta/4.6.2/docs/resources/brand#custom_privacy_policy_url Brand#custom_privacy_policy_url} CustomPrivacyPolicyUrl *string `field:"optional" json:"customPrivacyPolicyUrl" yaml:"customPrivacyPolicyUrl"` // Default app app instance id. // // Docs at Terraform Registry: {@link https://registry.terraform.io/providers/okta/okta/4.6.2/docs/resources/brand#default_app_app_instance_id Brand#default_app_app_instance_id} DefaultAppAppInstanceId *string `field:"optional" json:"defaultAppAppInstanceId" yaml:"defaultAppAppInstanceId"` // Default app app link name. // // Docs at Terraform Registry: {@link https://registry.terraform.io/providers/okta/okta/4.6.2/docs/resources/brand#default_app_app_link_name Brand#default_app_app_link_name} DefaultAppAppLinkName *string `field:"optional" json:"defaultAppAppLinkName" yaml:"defaultAppAppLinkName"` // Default app classic application uri. // // Docs at Terraform Registry: {@link https://registry.terraform.io/providers/okta/okta/4.6.2/docs/resources/brand#default_app_classic_application_uri Brand#default_app_classic_application_uri} DefaultAppClassicApplicationUri *string `field:"optional" json:"defaultAppClassicApplicationUri" yaml:"defaultAppClassicApplicationUri"` // The language specified as an IETF BCP 47 language tag. // // Docs at Terraform Registry: {@link https://registry.terraform.io/providers/okta/okta/4.6.2/docs/resources/brand#locale Brand#locale} Locale *string `field:"optional" json:"locale" yaml:"locale"` // Removes "Powered by Okta" from the Okta-hosted sign-in page and "© 2021 Okta, Inc." from the Okta End-User Dashboard. // // Docs at Terraform Registry: {@link https://registry.terraform.io/providers/okta/okta/4.6.2/docs/resources/brand#remove_powered_by_okta Brand#remove_powered_by_okta} RemovePoweredByOkta interface{} `field:"optional" json:"removePoweredByOkta" yaml:"removePoweredByOkta"` }