Skip to content

Latest commit

 

History

History
2024 lines (1249 loc) · 75.3 KB

stage.typescript.md

File metadata and controls

2024 lines (1249 loc) · 75.3 KB
Raw

stage Submodule

Constructs

Stage

Represents a {@link https://registry.terraform.io/providers/snowflake-labs/snowflake/0.90.0/docs/resources/stage snowflake_stage}.

Initializers 

import { stage } from '@cdktf/provider-snowflake'

new stage.Stage(scope: Construct, id: string, config: StageConfig)
Name Type Description
scope constructs.Construct The scope in which to define this construct.
id string The scoped construct ID.
config StageConfig No description.
scopeRequired
  • Type: constructs.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".
putTag No description.
resetAwsExternalId No description.
resetComment No description.
resetCopyOptions No description.
resetCredentials No description.
resetDirectory No description.
resetEncryption No description.
resetFileFormat No description.
resetId No description.
resetSnowflakeIamUser No description.
resetStorageIntegration No description.
resetTag No description.
resetUrl No description.
toString 
public toString(): string

Returns a string representation of this construct.

addOverride 
public addOverride(path: string, value: any): void
pathRequired
  • Type: string
valueRequired
  • Type: any
overrideLogicalId 
public overrideLogicalId(newLogicalId: string): void

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

newLogicalIdRequired
  • Type: string

The new logical ID to use for this stack element.

resetOverrideLogicalId 
public resetOverrideLogicalId(): void

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

toHclTerraform 
public toHclTerraform(): any
toMetadata 
public toMetadata(): any
toTerraform 
public toTerraform(): any

Adds this resource to the terraform JSON output.

addMoveTarget 
public addMoveTarget(moveTarget: string): void

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 
public getAnyMapAttribute(terraformAttribute: string): {[ key: string ]: any}
terraformAttributeRequired
  • Type: string
getBooleanAttribute 
public getBooleanAttribute(terraformAttribute: string): IResolvable
terraformAttributeRequired
  • Type: string
getBooleanMapAttribute 
public getBooleanMapAttribute(terraformAttribute: string): {[ key: string ]: boolean}
terraformAttributeRequired
  • Type: string
getListAttribute 
public getListAttribute(terraformAttribute: string): string[]
terraformAttributeRequired
  • Type: string
getNumberAttribute 
public getNumberAttribute(terraformAttribute: string): number
terraformAttributeRequired
  • Type: string
getNumberListAttribute 
public getNumberListAttribute(terraformAttribute: string): number[]
terraformAttributeRequired
  • Type: string
getNumberMapAttribute 
public getNumberMapAttribute(terraformAttribute: string): {[ key: string ]: number}
terraformAttributeRequired
  • Type: string
getStringAttribute 
public getStringAttribute(terraformAttribute: string): string
terraformAttributeRequired
  • Type: string
getStringMapAttribute 
public getStringMapAttribute(terraformAttribute: string): {[ key: string ]: string}
terraformAttributeRequired
  • Type: string
hasResourceMove 
public hasResourceMove(): TerraformResourceMoveByTarget | TerraformResourceMoveById
importFrom 
public importFrom(id: string, provider?: TerraformProvider): void
idRequired
  • Type: string
providerOptional
  • Type: cdktf.TerraformProvider
interpolationForAttribute 
public interpolationForAttribute(terraformAttribute: string): IResolvable
terraformAttributeRequired
  • Type: string
moveFromId 
public moveFromId(id: string): void

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 
public moveTo(moveTarget: string, index?: string | number): void

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: string | number

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

moveToId 
public moveToId(id: string): void

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".

putTag 
public putTag(value: IResolvable | StageTag[]): void
valueRequired
resetAwsExternalId 
public resetAwsExternalId(): void
resetComment 
public resetComment(): void
resetCopyOptions 
public resetCopyOptions(): void
resetCredentials 
public resetCredentials(): void
resetDirectory 
public resetDirectory(): void
resetEncryption 
public resetEncryption(): void
resetFileFormat 
public resetFileFormat(): void
resetId 
public resetId(): void
resetSnowflakeIamUser 
public resetSnowflakeIamUser(): void
resetStorageIntegration 
public resetStorageIntegration(): void
resetTag 
public resetTag(): void
resetUrl 
public resetUrl(): void

Static Functions

Name Description
isConstruct Checks if x is a construct.
isTerraformElement No description.
isTerraformResource No description.
generateConfigForImport Generates CDKTF code for importing a Stage resource upon running "cdktf plan ".
isConstruct 
import { stage } from '@cdktf/provider-snowflake'

stage.Stage.isConstruct(x: any)

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: any

Any object.

isTerraformElement 
import { stage } from '@cdktf/provider-snowflake'

stage.Stage.isTerraformElement(x: any)
xRequired
  • Type: any
isTerraformResource 
import { stage } from '@cdktf/provider-snowflake'

stage.Stage.isTerraformResource(x: any)
xRequired
  • Type: any
generateConfigForImport 
import { stage } from '@cdktf/provider-snowflake'

stage.Stage.generateConfigForImport(scope: Construct, importToId: string, importFromId: string, provider?: TerraformProvider)

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

scopeRequired
  • Type: constructs.Construct

The scope in which to define this construct.

importToIdRequired
  • Type: string

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

importFromIdRequired
  • Type: string

The id of the existing Stage that should be imported.

Refer to the {@link https://registry.terraform.io/providers/snowflake-labs/snowflake/0.90.0/docs/resources/stage#import import section} in the documentation of this resource for the id to use

providerOptional
  • Type: cdktf.TerraformProvider

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

Properties

Name Type Description
node constructs.Node The tree node.
cdktfStack cdktf.TerraformStack No description.
fqn string No description.
friendlyUniqueId string No description.
terraformMetaArguments {[ key: string ]: any} No description.
terraformResourceType string No description.
terraformGeneratorMetadata cdktf.TerraformProviderGeneratorMetadata No description.
connection cdktf.SSHProvisionerConnection | cdktf.WinrmProvisionerConnection No description.
count number | cdktf.TerraformCount No description.
dependsOn string[] No description.
forEach cdktf.ITerraformIterator No description.
lifecycle cdktf.TerraformResourceLifecycle No description.
provider cdktf.TerraformProvider No description.
provisioners cdktf.FileProvisioner | cdktf.LocalExecProvisioner | cdktf.RemoteExecProvisioner[] No description.
tag StageTagList No description.
awsExternalIdInput string No description.
commentInput string No description.
copyOptionsInput string No description.
credentialsInput string No description.
databaseInput string No description.
directoryInput string No description.
encryptionInput string No description.
fileFormatInput string No description.
idInput string No description.
nameInput string No description.
schemaInput string No description.
snowflakeIamUserInput string No description.
storageIntegrationInput string No description.
tagInput cdktf.IResolvable | StageTag[] No description.
urlInput string No description.
awsExternalId string No description.
comment string No description.
copyOptions string No description.
credentials string No description.
database string No description.
directory string No description.
encryption string No description.
fileFormat string No description.
id string No description.
name string No description.
schema string No description.
snowflakeIamUser string No description.
storageIntegration string No description.
url string No description.
nodeRequired 
public readonly node: Node;
  • Type: constructs.Node

The tree node.

cdktfStackRequired 
public readonly cdktfStack: TerraformStack;
  • Type: cdktf.TerraformStack
fqnRequired 
public readonly fqn: string;
  • Type: string
friendlyUniqueIdRequired 
public readonly friendlyUniqueId: string;
  • Type: string
terraformMetaArgumentsRequired 
public readonly terraformMetaArguments: {[ key: string ]: any};
  • Type: {[ key: string ]: any}
terraformResourceTypeRequired 
public readonly terraformResourceType: string;
  • Type: string
terraformGeneratorMetadataOptional 
public readonly terraformGeneratorMetadata: TerraformProviderGeneratorMetadata;
  • Type: cdktf.TerraformProviderGeneratorMetadata
connectionOptional 
public readonly connection: SSHProvisionerConnection | WinrmProvisionerConnection;
  • Type: cdktf.SSHProvisionerConnection | cdktf.WinrmProvisionerConnection
countOptional 
public readonly count: number | TerraformCount;
  • Type: number | cdktf.TerraformCount
dependsOnOptional 
public readonly dependsOn: string[];
  • Type: string[]
forEachOptional 
public readonly forEach: ITerraformIterator;
  • Type: cdktf.ITerraformIterator
lifecycleOptional 
public readonly lifecycle: TerraformResourceLifecycle;
  • Type: cdktf.TerraformResourceLifecycle
providerOptional 
public readonly provider: TerraformProvider;
  • Type: cdktf.TerraformProvider
provisionersOptional 
public readonly provisioners: FileProvisioner | LocalExecProvisioner | RemoteExecProvisioner[];
  • Type: cdktf.FileProvisioner | cdktf.LocalExecProvisioner | cdktf.RemoteExecProvisioner[]
tagRequired 
public readonly tag: StageTagList;
awsExternalIdInputOptional 
public readonly awsExternalIdInput: string;
  • Type: string
commentInputOptional 
public readonly commentInput: string;
  • Type: string
copyOptionsInputOptional 
public readonly copyOptionsInput: string;
  • Type: string
credentialsInputOptional 
public readonly credentialsInput: string;
  • Type: string
databaseInputOptional 
public readonly databaseInput: string;
  • Type: string
directoryInputOptional 
public readonly directoryInput: string;
  • Type: string
encryptionInputOptional 
public readonly encryptionInput: string;
  • Type: string
fileFormatInputOptional 
public readonly fileFormatInput: string;
  • Type: string
idInputOptional 
public readonly idInput: string;
  • Type: string
nameInputOptional 
public readonly nameInput: string;
  • Type: string
schemaInputOptional 
public readonly schemaInput: string;
  • Type: string
snowflakeIamUserInputOptional 
public readonly snowflakeIamUserInput: string;
  • Type: string
storageIntegrationInputOptional 
public readonly storageIntegrationInput: string;
  • Type: string
tagInputOptional 
public readonly tagInput: IResolvable | StageTag[];
urlInputOptional 
public readonly urlInput: string;
  • Type: string
awsExternalIdRequired 
public readonly awsExternalId: string;
  • Type: string
commentRequired 
public readonly comment: string;
  • Type: string
copyOptionsRequired 
public readonly copyOptions: string;
  • Type: string
credentialsRequired 
public readonly credentials: string;
  • Type: string
databaseRequired 
public readonly database: string;
  • Type: string
directoryRequired 
public readonly directory: string;
  • Type: string
encryptionRequired 
public readonly encryption: string;
  • Type: string
fileFormatRequired 
public readonly fileFormat: string;
  • Type: string
idRequired 
public readonly id: string;
  • Type: string
nameRequired 
public readonly name: string;
  • Type: string
schemaRequired 
public readonly schema: string;
  • Type: string
snowflakeIamUserRequired 
public readonly snowflakeIamUser: string;
  • Type: string
storageIntegrationRequired 
public readonly storageIntegration: string;
  • Type: string
urlRequired 
public readonly url: string;
  • Type: string

Constants

Name Type Description
tfResourceType string No description.
tfResourceTypeRequired 
public readonly tfResourceType: string;
  • Type: string

Structs

StageConfig

Initializer 

import { stage } from '@cdktf/provider-snowflake'

const stageConfig: stage.StageConfig = { ... }

Properties

Name Type Description
connection cdktf.SSHProvisionerConnection | cdktf.WinrmProvisionerConnection No description.
count number | cdktf.TerraformCount No description.
dependsOn cdktf.ITerraformDependable[] No description.
forEach cdktf.ITerraformIterator No description.
lifecycle cdktf.TerraformResourceLifecycle No description.
provider cdktf.TerraformProvider No description.
provisioners cdktf.FileProvisioner | cdktf.LocalExecProvisioner | cdktf.RemoteExecProvisioner[] No description.
database string The database in which to create the stage.
name string Specifies the identifier for the stage;
schema string The schema in which to create the stage.
awsExternalId string A unique ID assigned to the specific stage. The ID has the following format: <snowflakeAccount>SFCRole=<snowflakeRoleId><randomId>
comment string Specifies a comment for the stage.
copyOptions string Specifies the copy options for the stage.
credentials string Specifies the credentials for the stage.
directory string Specifies the directory settings for the stage.
encryption string Specifies the encryption settings for the stage.
fileFormat string Specifies the file format for the stage.
id string Docs at Terraform Registry: {@link https://registry.terraform.io/providers/snowflake-labs/snowflake/0.90.0/docs/resources/stage#id Stage#id}.
snowflakeIamUser string An AWS IAM user created for your Snowflake account.
storageIntegration string Specifies the name of the storage integration used to delegate authentication responsibility for external cloud storage to a Snowflake identity and access management (IAM) entity.
tag cdktf.IResolvable | StageTag[] tag block.
url string Specifies the URL for the stage.
connectionOptional 
public readonly connection: SSHProvisionerConnection | WinrmProvisionerConnection;
  • Type: cdktf.SSHProvisionerConnection | cdktf.WinrmProvisionerConnection
countOptional 
public readonly count: number | TerraformCount;
  • Type: number | cdktf.TerraformCount
dependsOnOptional 
public readonly dependsOn: ITerraformDependable[];
  • Type: cdktf.ITerraformDependable[]
forEachOptional 
public readonly forEach: ITerraformIterator;
  • Type: cdktf.ITerraformIterator
lifecycleOptional 
public readonly lifecycle: TerraformResourceLifecycle;
  • Type: cdktf.TerraformResourceLifecycle
providerOptional 
public readonly provider: TerraformProvider;
  • Type: cdktf.TerraformProvider
provisionersOptional 
public readonly provisioners: FileProvisioner | LocalExecProvisioner | RemoteExecProvisioner[];
  • Type: cdktf.FileProvisioner | cdktf.LocalExecProvisioner | cdktf.RemoteExecProvisioner[]
databaseRequired 
public readonly database: string;
  • Type: string

The database in which to create the stage.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/snowflake-labs/snowflake/0.90.0/docs/resources/stage#database Stage#database}

nameRequired 
public readonly name: string;
  • Type: string

Specifies the identifier for the stage;

must be unique for the database and schema in which the stage is created.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/snowflake-labs/snowflake/0.90.0/docs/resources/stage#name Stage#name}

schemaRequired 
public readonly schema: string;
  • Type: string

The schema in which to create the stage.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/snowflake-labs/snowflake/0.90.0/docs/resources/stage#schema Stage#schema}

awsExternalIdOptional 
public readonly awsExternalId: string;
  • Type: string

A unique ID assigned to the specific stage. The ID has the following format: <snowflakeAccount>SFCRole=<snowflakeRoleId><randomId>

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/snowflake-labs/snowflake/0.90.0/docs/resources/stage#aws_external_id Stage#aws_external_id}

commentOptional 
public readonly comment: string;
  • Type: string

Specifies a comment for the stage.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/snowflake-labs/snowflake/0.90.0/docs/resources/stage#comment Stage#comment}

copyOptionsOptional 
public readonly copyOptions: string;
  • Type: string

Specifies the copy options for the stage.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/snowflake-labs/snowflake/0.90.0/docs/resources/stage#copy_options Stage#copy_options}

credentialsOptional 
public readonly credentials: string;
  • Type: string

Specifies the credentials for the stage.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/snowflake-labs/snowflake/0.90.0/docs/resources/stage#credentials Stage#credentials}

directoryOptional 
public readonly directory: string;
  • Type: string

Specifies the directory settings for the stage.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/snowflake-labs/snowflake/0.90.0/docs/resources/stage#directory Stage#directory}

encryptionOptional 
public readonly encryption: string;
  • Type: string

Specifies the encryption settings for the stage.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/snowflake-labs/snowflake/0.90.0/docs/resources/stage#encryption Stage#encryption}

fileFormatOptional 
public readonly fileFormat: string;
  • Type: string

Specifies the file format for the stage.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/snowflake-labs/snowflake/0.90.0/docs/resources/stage#file_format Stage#file_format}

idOptional 
public readonly id: string;
  • Type: string

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/snowflake-labs/snowflake/0.90.0/docs/resources/stage#id Stage#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.

snowflakeIamUserOptional 
public readonly snowflakeIamUser: string;
  • Type: string

An AWS IAM user created for your Snowflake account.

This user is the same for every external S3 stage created in your account.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/snowflake-labs/snowflake/0.90.0/docs/resources/stage#snowflake_iam_user Stage#snowflake_iam_user}

storageIntegrationOptional 
public readonly storageIntegration: string;
  • Type: string

Specifies the name of the storage integration used to delegate authentication responsibility for external cloud storage to a Snowflake identity and access management (IAM) entity.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/snowflake-labs/snowflake/0.90.0/docs/resources/stage#storage_integration Stage#storage_integration}

tagOptional 
public readonly tag: IResolvable | StageTag[];

tag block.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/snowflake-labs/snowflake/0.90.0/docs/resources/stage#tag Stage#tag}

urlOptional 
public readonly url: string;
  • Type: string

Specifies the URL for the stage.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/snowflake-labs/snowflake/0.90.0/docs/resources/stage#url Stage#url}

StageTag

Initializer 

import { stage } from '@cdktf/provider-snowflake'

const stageTag: stage.StageTag = { ... }

Properties

Name Type Description
name string Tag name, e.g. department.
value string Tag value, e.g. marketing_info.
database string Name of the database that the tag was created in.
schema string Name of the schema that the tag was created in.
nameRequired 
public readonly name: string;
  • Type: string

Tag name, e.g. department.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/snowflake-labs/snowflake/0.90.0/docs/resources/stage#name Stage#name}

valueRequired 
public readonly value: string;
  • Type: string

Tag value, e.g. marketing_info.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/snowflake-labs/snowflake/0.90.0/docs/resources/stage#value Stage#value}

databaseOptional 
public readonly database: string;
  • Type: string

Name of the database that the tag was created in.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/snowflake-labs/snowflake/0.90.0/docs/resources/stage#database Stage#database}

schemaOptional 
public readonly schema: string;
  • Type: string

Name of the schema that the tag was created in.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/snowflake-labs/snowflake/0.90.0/docs/resources/stage#schema Stage#schema}

Classes

StageTagList

Initializers 

import { stage } from '@cdktf/provider-snowflake'

new stage.StageTagList(terraformResource: IInterpolatingParent, terraformAttribute: string, wrapsSet: boolean)
Name Type Description
terraformResource cdktf.IInterpolatingParent The parent resource.
terraformAttribute string The attribute on the parent resource this class is referencing.
wrapsSet boolean whether the list is wrapping a set (will add tolist() to be able to access an item via an index).
terraformResourceRequired
  • Type: cdktf.IInterpolatingParent

The parent resource.

terraformAttributeRequired
  • Type: string

The attribute on the parent resource this class is referencing.

wrapsSetRequired
  • Type: boolean

whether the list is wrapping a set (will add tolist() to be able to access an item via an index).

Methods

Name Description
allWithMapKey Creating an iterator for this complex list.
computeFqn No description.
resolve Produce the Token's value at resolution time.
toString Return a string representation of this resolvable object.
get No description.
allWithMapKey 
public allWithMapKey(mapKeyAttributeName: string): DynamicListTerraformIterator

Creating an iterator for this complex list.

The list will be converted into a map with the mapKeyAttributeName as the key.

mapKeyAttributeNameRequired
  • Type: string
computeFqn 
public computeFqn(): string
resolve 
public resolve(_context: IResolveContext): any

Produce the Token's value at resolution time.

_contextRequired
  • Type: cdktf.IResolveContext
toString 
public toString(): string

Return a string representation of this resolvable object.

Returns a reversible string representation.

get 
public get(index: number): StageTagOutputReference
indexRequired
  • Type: number

the index of the item to return.

Properties

Name Type Description
creationStack string[] The creation stack of this resolvable which will be appended to errors thrown during resolution.
fqn string No description.
internalValue cdktf.IResolvable | StageTag[] No description.
creationStackRequired 
public readonly creationStack: string[];
  • Type: string[]

The creation stack of this resolvable which will be appended to errors thrown during resolution.

If this returns an empty array the stack will not be attached.

fqnRequired 
public readonly fqn: string;
  • Type: string
internalValueOptional 
public readonly internalValue: IResolvable | StageTag[];

StageTagOutputReference

Initializers 

import { stage } from '@cdktf/provider-snowflake'

new stage.StageTagOutputReference(terraformResource: IInterpolatingParent, terraformAttribute: string, complexObjectIndex: number, complexObjectIsFromSet: boolean)
Name Type Description
terraformResource cdktf.IInterpolatingParent The parent resource.
terraformAttribute string The attribute on the parent resource this class is referencing.
complexObjectIndex number the index of this item in the list.
complexObjectIsFromSet boolean whether the list is wrapping a set (will add tolist() to be able to access an item via an index).
terraformResourceRequired
  • Type: cdktf.IInterpolatingParent

The parent resource.

terraformAttributeRequired
  • Type: string

The attribute on the parent resource this class is referencing.

complexObjectIndexRequired
  • Type: number

the index of this item in the list.

complexObjectIsFromSetRequired
  • Type: boolean

whether the list is wrapping a set (will add tolist() to be able to access an item via an index).

Methods

Name Description
computeFqn No description.
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.
interpolationForAttribute No description.
resolve Produce the Token's value at resolution time.
toString Return a string representation of this resolvable object.
resetDatabase No description.
resetSchema No description.
computeFqn 
public computeFqn(): string
getAnyMapAttribute 
public getAnyMapAttribute(terraformAttribute: string): {[ key: string ]: any}
terraformAttributeRequired
  • Type: string
getBooleanAttribute 
public getBooleanAttribute(terraformAttribute: string): IResolvable
terraformAttributeRequired
  • Type: string
getBooleanMapAttribute 
public getBooleanMapAttribute(terraformAttribute: string): {[ key: string ]: boolean}
terraformAttributeRequired
  • Type: string
getListAttribute 
public getListAttribute(terraformAttribute: string): string[]
terraformAttributeRequired
  • Type: string
getNumberAttribute 
public getNumberAttribute(terraformAttribute: string): number
terraformAttributeRequired
  • Type: string
getNumberListAttribute 
public getNumberListAttribute(terraformAttribute: string): number[]
terraformAttributeRequired
  • Type: string
getNumberMapAttribute 
public getNumberMapAttribute(terraformAttribute: string): {[ key: string ]: number}
terraformAttributeRequired
  • Type: string
getStringAttribute 
public getStringAttribute(terraformAttribute: string): string
terraformAttributeRequired
  • Type: string
getStringMapAttribute 
public getStringMapAttribute(terraformAttribute: string): {[ key: string ]: string}
terraformAttributeRequired
  • Type: string
interpolationForAttribute 
public interpolationForAttribute(property: string): IResolvable
propertyRequired
  • Type: string
resolve 
public resolve(_context: IResolveContext): any

Produce the Token's value at resolution time.

_contextRequired
  • Type: cdktf.IResolveContext
toString 
public toString(): string

Return a string representation of this resolvable object.

Returns a reversible string representation.

resetDatabase 
public resetDatabase(): void
resetSchema 
public resetSchema(): void

Properties

Name Type Description
creationStack string[] The creation stack of this resolvable which will be appended to errors thrown during resolution.
fqn string No description.
databaseInput string No description.
nameInput string No description.
schemaInput string No description.
valueInput string No description.
database string No description.
name string No description.
schema string No description.
value string No description.
internalValue cdktf.IResolvable | StageTag No description.
creationStackRequired 
public readonly creationStack: string[];
  • Type: string[]

The creation stack of this resolvable which will be appended to errors thrown during resolution.

If this returns an empty array the stack will not be attached.

fqnRequired 
public readonly fqn: string;
  • Type: string
databaseInputOptional 
public readonly databaseInput: string;
  • Type: string
nameInputOptional 
public readonly nameInput: string;
  • Type: string
schemaInputOptional 
public readonly schemaInput: string;
  • Type: string
valueInputOptional 
public readonly valueInput: string;
  • Type: string
databaseRequired 
public readonly database: string;
  • Type: string
nameRequired 
public readonly name: string;
  • Type: string
schemaRequired 
public readonly schema: string;
  • Type: string
valueRequired 
public readonly value: string;
  • Type: string
internalValueOptional 
public readonly internalValue: IResolvable | StageTag;