`brand` Submodule

Constructs

Brand

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

Initializers

using HashiCorp.Cdktf.Providers.Okta;

new Brand(Construct Scope, string Id, BrandConfig Config);

Name	Type	Description
`Scope`	`Constructs.Construct`	The scope in which to define this construct.
`Id`	`string`	The scoped construct ID.
`Config`	`BrandConfig`	No description.

`Scope`^Required

Type: Constructs.Construct

The scope in which to define this construct.

`Id`^Required

Type: string

The scoped construct ID.

Must be unique amongst siblings in the same scope

`Config`^Required

Type: BrandConfig

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".
`ResetAgreeToCustomPrivacyPolicy`	No description.
`ResetBrandId`	No description.
`ResetCustomPrivacyPolicyUrl`	No description.
`ResetDefaultAppAppInstanceId`	No description.
`ResetDefaultAppAppLinkName`	No description.
`ResetDefaultAppClassicApplicationUri`	No description.
`ResetLocale`	No description.
`ResetRemovePoweredByOkta`	No description.

`ToString`

private string ToString()

Returns a string representation of this construct.

`AddOverride`

private void AddOverride(string Path, object Value)

`Path`^Required

Type: string

`Value`^Required

Type: object

`OverrideLogicalId`

private void OverrideLogicalId(string NewLogicalId)

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

`NewLogicalId`^Required

Type: string

The new logical ID to use for this stack element.

`ResetOverrideLogicalId`

private void ResetOverrideLogicalId()

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

`ToHclTerraform`

private object ToHclTerraform()

`ToMetadata`

private object ToMetadata()

`ToTerraform`

private object ToTerraform()

Adds this resource to the terraform JSON output.

`AddMoveTarget`

private void AddMoveTarget(string MoveTarget)

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

`MoveTarget`^Required

Type: string

The string move target that will correspond to this resource.

`GetAnyMapAttribute`

private System.Collections.Generic.IDictionary<string, object> GetAnyMapAttribute(string TerraformAttribute)

`TerraformAttribute`^Required

Type: string

`GetBooleanAttribute`

private IResolvable GetBooleanAttribute(string TerraformAttribute)

`TerraformAttribute`^Required

Type: string

`GetBooleanMapAttribute`

private System.Collections.Generic.IDictionary<string, bool> GetBooleanMapAttribute(string TerraformAttribute)

`TerraformAttribute`^Required

Type: string

`GetListAttribute`

private string[] GetListAttribute(string TerraformAttribute)

`TerraformAttribute`^Required

Type: string

`GetNumberAttribute`

private double GetNumberAttribute(string TerraformAttribute)

`TerraformAttribute`^Required

Type: string

`GetNumberListAttribute`

private double[] GetNumberListAttribute(string TerraformAttribute)

`TerraformAttribute`^Required

Type: string

`GetNumberMapAttribute`

private System.Collections.Generic.IDictionary<string, double> GetNumberMapAttribute(string TerraformAttribute)

`TerraformAttribute`^Required

Type: string

`GetStringAttribute`

private string GetStringAttribute(string TerraformAttribute)

`TerraformAttribute`^Required

Type: string

`GetStringMapAttribute`

private System.Collections.Generic.IDictionary<string, string> GetStringMapAttribute(string TerraformAttribute)

`TerraformAttribute`^Required

Type: string

`HasResourceMove`

private object HasResourceMove()

`ImportFrom`

private void ImportFrom(string Id, TerraformProvider Provider = null)

`Id`^Required

Type: string

`Provider`^Optional

Type: HashiCorp.Cdktf.TerraformProvider

`InterpolationForAttribute`

private IResolvable InterpolationForAttribute(string TerraformAttribute)

`TerraformAttribute`^Required

Type: string

`MoveFromId`

private void MoveFromId(string Id)

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.

`Id`^Required

Type: string

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

`MoveTo`

private void MoveTo(string MoveTarget, object Index = null)

Moves this resource to the target resource given by moveTarget.

`MoveTarget`^Required

Type: string

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

`Index`^Optional

Type: object

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

`MoveToId`

private void MoveToId(string Id)

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

`Id`^Required

Type: string

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

`ResetAgreeToCustomPrivacyPolicy`

private void ResetAgreeToCustomPrivacyPolicy()

`ResetBrandId`

private void ResetBrandId()

`ResetCustomPrivacyPolicyUrl`

private void ResetCustomPrivacyPolicyUrl()

`ResetDefaultAppAppInstanceId`

private void ResetDefaultAppAppInstanceId()

`ResetDefaultAppAppLinkName`

private void ResetDefaultAppAppLinkName()

`ResetDefaultAppClassicApplicationUri`

private void ResetDefaultAppClassicApplicationUri()

`ResetLocale`

private void ResetLocale()

`ResetRemovePoweredByOkta`

private void ResetRemovePoweredByOkta()

Static Functions

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

`IsConstruct`

using HashiCorp.Cdktf.Providers.Okta;

Brand.IsConstruct(object X);

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.

`X`^Required

Type: object

Any object.

`IsTerraformElement`

using HashiCorp.Cdktf.Providers.Okta;

Brand.IsTerraformElement(object X);

`X`^Required

Type: object

`IsTerraformResource`

using HashiCorp.Cdktf.Providers.Okta;

Brand.IsTerraformResource(object X);

`X`^Required

Type: object

`GenerateConfigForImport`

using HashiCorp.Cdktf.Providers.Okta;

Brand.GenerateConfigForImport(Construct Scope, string ImportToId, string ImportFromId, TerraformProvider Provider = null);

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

`Scope`^Required

Type: Constructs.Construct

The scope in which to define this construct.

`ImportToId`^Required

Type: string

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

`ImportFromId`^Required

Type: string

The id of the existing Brand that should be imported.

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

`Provider`^Optional

Type: HashiCorp.Cdktf.TerraformProvider

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

Properties

Name	Type	Description
`Node`	`Constructs.Node`	The tree node.
`CdktfStack`	`HashiCorp.Cdktf.TerraformStack`	No description.
`Fqn`	`string`	No description.
`FriendlyUniqueId`	`string`	No description.
`TerraformMetaArguments`	`System.Collections.Generic.IDictionary<string, object>`	No description.
`TerraformResourceType`	`string`	No description.
`TerraformGeneratorMetadata`	`HashiCorp.Cdktf.TerraformProviderGeneratorMetadata`	No description.
`Connection`	`object`	No description.
`Count`	`object`	No description.
`DependsOn`	`string[]`	No description.
`ForEach`	`HashiCorp.Cdktf.ITerraformIterator`	No description.
`Lifecycle`	`HashiCorp.Cdktf.TerraformResourceLifecycle`	No description.
`Provider`	`HashiCorp.Cdktf.TerraformProvider`	No description.
`Provisioners`	`object[]`	No description.
`EmailDomainId`	`string`	No description.
`Id`	`string`	No description.
`IsDefault`	`HashiCorp.Cdktf.IResolvable`	No description.
`Links`	`string`	No description.
`AgreeToCustomPrivacyPolicyInput`	`object`	No description.
`BrandIdInput`	`string`	No description.
`CustomPrivacyPolicyUrlInput`	`string`	No description.
`DefaultAppAppInstanceIdInput`	`string`	No description.
`DefaultAppAppLinkNameInput`	`string`	No description.
`DefaultAppClassicApplicationUriInput`	`string`	No description.
`LocaleInput`	`string`	No description.
`NameInput`	`string`	No description.
`RemovePoweredByOktaInput`	`object`	No description.
`AgreeToCustomPrivacyPolicy`	`object`	No description.
`BrandId`	`string`	No description.
`CustomPrivacyPolicyUrl`	`string`	No description.
`DefaultAppAppInstanceId`	`string`	No description.
`DefaultAppAppLinkName`	`string`	No description.
`DefaultAppClassicApplicationUri`	`string`	No description.
`Locale`	`string`	No description.
`Name`	`string`	No description.
`RemovePoweredByOkta`	`object`	No description.

`Node`^Required

public Node Node { get; }

Type: Constructs.Node

The tree node.

`CdktfStack`^Required

public TerraformStack CdktfStack { get; }

Type: HashiCorp.Cdktf.TerraformStack

`Fqn`^Required

public string Fqn { get; }

Type: string

`FriendlyUniqueId`^Required

public string FriendlyUniqueId { get; }

Type: string

`TerraformMetaArguments`^Required

public System.Collections.Generic.IDictionary<string, object> TerraformMetaArguments { get; }

Type: System.Collections.Generic.IDictionary<string, object>

`TerraformResourceType`^Required

public string TerraformResourceType { get; }

Type: string

`TerraformGeneratorMetadata`^Optional

public TerraformProviderGeneratorMetadata TerraformGeneratorMetadata { get; }

Type: HashiCorp.Cdktf.TerraformProviderGeneratorMetadata

`Connection`^Optional

public object Connection { get; }

Type: object

`Count`^Optional

public object Count { get; }

Type: object

`DependsOn`^Optional

public string[] DependsOn { get; }

Type: string[]

`ForEach`^Optional

public ITerraformIterator ForEach { get; }

Type: HashiCorp.Cdktf.ITerraformIterator

`Lifecycle`^Optional

public TerraformResourceLifecycle Lifecycle { get; }

Type: HashiCorp.Cdktf.TerraformResourceLifecycle

`Provider`^Optional

public TerraformProvider Provider { get; }

Type: HashiCorp.Cdktf.TerraformProvider

`Provisioners`^Optional

public object[] Provisioners { get; }

Type: object[]

`EmailDomainId`^Required

public string EmailDomainId { get; }

Type: string

`Id`^Required

public string Id { get; }

Type: string

`IsDefault`^Required

public IResolvable IsDefault { get; }

Type: HashiCorp.Cdktf.IResolvable

`Links`^Required

public string Links { get; }

Type: string

`AgreeToCustomPrivacyPolicyInput`^Optional

public object AgreeToCustomPrivacyPolicyInput { get; }

Type: object

`BrandIdInput`^Optional

public string BrandIdInput { get; }

Type: string

`CustomPrivacyPolicyUrlInput`^Optional

public string CustomPrivacyPolicyUrlInput { get; }

Type: string

`DefaultAppAppInstanceIdInput`^Optional

public string DefaultAppAppInstanceIdInput { get; }

Type: string

`DefaultAppAppLinkNameInput`^Optional

public string DefaultAppAppLinkNameInput { get; }

Type: string

`DefaultAppClassicApplicationUriInput`^Optional

public string DefaultAppClassicApplicationUriInput { get; }

Type: string

`LocaleInput`^Optional

public string LocaleInput { get; }

Type: string

`NameInput`^Optional

public string NameInput { get; }

Type: string

`RemovePoweredByOktaInput`^Optional

public object RemovePoweredByOktaInput { get; }

Type: object

`AgreeToCustomPrivacyPolicy`^Required

public object AgreeToCustomPrivacyPolicy { get; }

Type: object

`BrandId`^Required

public string BrandId { get; }

Type: string

`CustomPrivacyPolicyUrl`^Required

public string CustomPrivacyPolicyUrl { get; }

Type: string

`DefaultAppAppInstanceId`^Required

public string DefaultAppAppInstanceId { get; }

Type: string

`DefaultAppAppLinkName`^Required

public string DefaultAppAppLinkName { get; }

Type: string

`DefaultAppClassicApplicationUri`^Required

public string DefaultAppClassicApplicationUri { get; }

Type: string

`Locale`^Required

public string Locale { get; }

Type: string

`Name`^Required

public string Name { get; }

Type: string

`RemovePoweredByOkta`^Required

public object RemovePoweredByOkta { get; }

Type: object

Constants

Name	Type	Description
`TfResourceType`	`string`	No description.

`TfResourceType`^Required

public string TfResourceType { get; }

Type: string

Structs

BrandConfig

Initializer

using HashiCorp.Cdktf.Providers.Okta;

new BrandConfig {
    object Connection = null,
    object Count = null,
    ITerraformDependable[] DependsOn = null,
    ITerraformIterator ForEach = null,
    TerraformResourceLifecycle Lifecycle = null,
    TerraformProvider Provider = null,
    object[] Provisioners = null,
    string Name,
    object AgreeToCustomPrivacyPolicy = null,
    string BrandId = null,
    string CustomPrivacyPolicyUrl = null,
    string DefaultAppAppInstanceId = null,
    string DefaultAppAppLinkName = null,
    string DefaultAppClassicApplicationUri = null,
    string Locale = null,
    object RemovePoweredByOkta = null
};

Properties

Name	Type	Description
`Connection`	`object`	No description.
`Count`	`object`	No description.
`DependsOn`	`HashiCorp.Cdktf.ITerraformDependable[]`	No description.
`ForEach`	`HashiCorp.Cdktf.ITerraformIterator`	No description.
`Lifecycle`	`HashiCorp.Cdktf.TerraformResourceLifecycle`	No description.
`Provider`	`HashiCorp.Cdktf.TerraformProvider`	No description.
`Provisioners`	`object[]`	No description.
`Name`	`string`	Name of the brand.
`AgreeToCustomPrivacyPolicy`	`object`	Is a required input flag with when changing custom_privacy_url, shouldn't be considered as a readable property.
`BrandId`	`string`	Brand ID - Note: Okta API for brands only reads and updates therefore the okta_brand resource needs to act as a quasi data source.
`CustomPrivacyPolicyUrl`	`string`	Custom privacy policy URL.
`DefaultAppAppInstanceId`	`string`	Default app app instance id.
`DefaultAppAppLinkName`	`string`	Default app app link name.
`DefaultAppClassicApplicationUri`	`string`	Default app classic application uri.
`Locale`	`string`	The language specified as an IETF BCP 47 language tag.
`RemovePoweredByOkta`	`object`	Removes "Powered by Okta" from the Okta-hosted sign-in page and "© 2021 Okta, Inc." from the Okta End-User Dashboard.

`Connection`^Optional

public object Connection { get; set; }

Type: object

`Count`^Optional

public object Count { get; set; }

Type: object

`DependsOn`^Optional

public ITerraformDependable[] DependsOn { get; set; }

Type: HashiCorp.Cdktf.ITerraformDependable[]

`ForEach`^Optional

public ITerraformIterator ForEach { get; set; }

Type: HashiCorp.Cdktf.ITerraformIterator

`Lifecycle`^Optional

public TerraformResourceLifecycle Lifecycle { get; set; }

Type: HashiCorp.Cdktf.TerraformResourceLifecycle

`Provider`^Optional

public TerraformProvider Provider { get; set; }

Type: HashiCorp.Cdktf.TerraformProvider

`Provisioners`^Optional

public object[] Provisioners { get; set; }

Type: object[]

`Name`^Required

public string Name { get; set; }

Type: string

Name of the brand.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/okta/okta/4.12.0/docs/resources/brand#name Brand#name}

`AgreeToCustomPrivacyPolicy`^Optional

public object AgreeToCustomPrivacyPolicy { get; set; }

Type: object

Is a required input flag with when changing custom_privacy_url, shouldn't be considered as a readable property.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/okta/okta/4.12.0/docs/resources/brand#agree_to_custom_privacy_policy Brand#agree_to_custom_privacy_policy}

`BrandId`^Optional

public string BrandId { get; set; }

Type: string

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. DEPRECATED: Okta has fully support brand creation, this attribute is a no op and will be removed

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/okta/okta/4.12.0/docs/resources/brand#brand_id Brand#brand_id}

`CustomPrivacyPolicyUrl`^Optional

public string CustomPrivacyPolicyUrl { get; set; }

Type: string

Custom privacy policy URL.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/okta/okta/4.12.0/docs/resources/brand#custom_privacy_policy_url Brand#custom_privacy_policy_url}

`DefaultAppAppInstanceId`^Optional

public string DefaultAppAppInstanceId { get; set; }

Type: string

Default app app instance id.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/okta/okta/4.12.0/docs/resources/brand#default_app_app_instance_id Brand#default_app_app_instance_id}

`DefaultAppAppLinkName`^Optional

public string DefaultAppAppLinkName { get; set; }

Type: string

Default app app link name.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/okta/okta/4.12.0/docs/resources/brand#default_app_app_link_name Brand#default_app_app_link_name}

`DefaultAppClassicApplicationUri`^Optional

public string DefaultAppClassicApplicationUri { get; set; }

Type: string

Default app classic application uri.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/okta/okta/4.12.0/docs/resources/brand#default_app_classic_application_uri Brand#default_app_classic_application_uri}

`Locale`^Optional

public string Locale { get; set; }

Type: string

The language specified as an IETF BCP 47 language tag.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/okta/okta/4.12.0/docs/resources/brand#locale Brand#locale}

`RemovePoweredByOkta`^Optional

public object RemovePoweredByOkta { get; set; }

Type: object

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/okta/okta/4.12.0/docs/resources/brand#remove_powered_by_okta Brand#remove_powered_by_okta}

Files

brand.csharp.md

Latest commit

History

brand.csharp.md

File metadata and controls

brand Submodule

Constructs

Brand

Initializers

ScopeRequired

IdRequired

ConfigRequired

Methods

ToString

AddOverride

PathRequired

ValueRequired

OverrideLogicalId

NewLogicalIdRequired

ResetOverrideLogicalId

ToHclTerraform

ToMetadata

ToTerraform

AddMoveTarget

MoveTargetRequired

GetAnyMapAttribute

TerraformAttributeRequired

GetBooleanAttribute

TerraformAttributeRequired

GetBooleanMapAttribute

TerraformAttributeRequired

GetListAttribute

TerraformAttributeRequired

GetNumberAttribute

TerraformAttributeRequired

GetNumberListAttribute

TerraformAttributeRequired

GetNumberMapAttribute

TerraformAttributeRequired

GetStringAttribute

TerraformAttributeRequired

GetStringMapAttribute

TerraformAttributeRequired

HasResourceMove

ImportFrom

IdRequired

ProviderOptional

InterpolationForAttribute

TerraformAttributeRequired

MoveFromId

IdRequired

MoveTo

MoveTargetRequired

IndexOptional

MoveToId

IdRequired

ResetAgreeToCustomPrivacyPolicy

ResetBrandId

ResetCustomPrivacyPolicyUrl

ResetDefaultAppAppInstanceId

ResetDefaultAppAppLinkName

ResetDefaultAppClassicApplicationUri

ResetLocale

ResetRemovePoweredByOkta

Static Functions

IsConstruct

XRequired

IsTerraformElement

XRequired

IsTerraformResource

XRequired

GenerateConfigForImport

ScopeRequired

ImportToIdRequired

ImportFromIdRequired

ProviderOptional

Properties

NodeRequired

CdktfStackRequired

`brand` Submodule

`Scope`^Required

`Id`^Required

`Config`^Required

`ToString`

`AddOverride`

`Path`^Required

`Value`^Required

`OverrideLogicalId`

`NewLogicalId`^Required

`ResetOverrideLogicalId`

`ToHclTerraform`

`ToMetadata`

`ToTerraform`

`AddMoveTarget`

`MoveTarget`^Required

`GetAnyMapAttribute`

`TerraformAttribute`^Required

`GetBooleanAttribute`

`TerraformAttribute`^Required

`GetBooleanMapAttribute`

`TerraformAttribute`^Required

`GetListAttribute`

`TerraformAttribute`^Required

`GetNumberAttribute`

`TerraformAttribute`^Required

`GetNumberListAttribute`

`TerraformAttribute`^Required

`GetNumberMapAttribute`

`TerraformAttribute`^Required

`GetStringAttribute`

`TerraformAttribute`^Required

`GetStringMapAttribute`

`TerraformAttribute`^Required

`HasResourceMove`

`ImportFrom`

`Id`^Required

`Provider`^Optional

`InterpolationForAttribute`

`TerraformAttribute`^Required

`MoveFromId`

`Id`^Required

`MoveTo`

`MoveTarget`^Required

`Index`^Optional

`MoveToId`

`Id`^Required

`ResetAgreeToCustomPrivacyPolicy`

`ResetBrandId`

`ResetCustomPrivacyPolicyUrl`

`ResetDefaultAppAppInstanceId`

`ResetDefaultAppAppLinkName`

`ResetDefaultAppClassicApplicationUri`

`ResetLocale`

`ResetRemovePoweredByOkta`

`IsConstruct`

`X`^Required

`IsTerraformElement`

`X`^Required

`IsTerraformResource`

`X`^Required

`GenerateConfigForImport`

`Scope`^Required

`ImportToId`^Required

`ImportFromId`^Required

`Provider`^Optional

`Node`^Required

`CdktfStack`^Required

`Fqn`^Required

`FriendlyUniqueId`^Required

`TerraformMetaArguments`^Required

`TerraformResourceType`^Required

`TerraformGeneratorMetadata`^Optional

`Connection`^Optional

`Count`^Optional

`DependsOn`^Optional

`ForEach`^Optional

`Lifecycle`^Optional

`Provider`^Optional

`Provisioners`^Optional