Skip to content

Latest commit

 

History

History
2321 lines (1427 loc) · 104 KB

failoverGroup.typescript.md

File metadata and controls

2321 lines (1427 loc) · 104 KB
Raw

failoverGroup Submodule

Constructs

FailoverGroup

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

Initializers 

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

new failoverGroup.FailoverGroup(scope: Construct, id: string, config: FailoverGroupConfig)
Name Type Description
scope constructs.Construct The scope in which to define this construct.
id string The scoped construct ID.
config FailoverGroupConfig 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".
putFromReplica No description.
putReplicationSchedule No description.
resetAllowedAccounts No description.
resetAllowedDatabases No description.
resetAllowedIntegrationTypes No description.
resetAllowedShares No description.
resetFromReplica No description.
resetId No description.
resetIgnoreEditionCheck No description.
resetObjectTypes No description.
resetReplicationSchedule 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".

putFromReplica 
public putFromReplica(value: FailoverGroupFromReplica): void
valueRequired
putReplicationSchedule 
public putReplicationSchedule(value: FailoverGroupReplicationSchedule): void
valueRequired
resetAllowedAccounts 
public resetAllowedAccounts(): void
resetAllowedDatabases 
public resetAllowedDatabases(): void
resetAllowedIntegrationTypes 
public resetAllowedIntegrationTypes(): void
resetAllowedShares 
public resetAllowedShares(): void
resetFromReplica 
public resetFromReplica(): void
resetId 
public resetId(): void
resetIgnoreEditionCheck 
public resetIgnoreEditionCheck(): void
resetObjectTypes 
public resetObjectTypes(): void
resetReplicationSchedule 
public resetReplicationSchedule(): 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 FailoverGroup resource upon running "cdktf plan ".
isConstruct 
import { failoverGroup } from '@cdktf/provider-snowflake'

failoverGroup.FailoverGroup.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 { failoverGroup } from '@cdktf/provider-snowflake'

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

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

failoverGroup.FailoverGroup.generateConfigForImport(scope: Construct, importToId: string, importFromId: string, provider?: TerraformProvider)

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

importFromIdRequired
  • Type: string

The id of the existing FailoverGroup that should be imported.

Refer to the {@link https://registry.terraform.io/providers/snowflake-labs/snowflake/0.90.0/docs/resources/failover_group#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 FailoverGroup 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.
fromReplica FailoverGroupFromReplicaOutputReference No description.
replicationSchedule FailoverGroupReplicationScheduleOutputReference No description.
allowedAccountsInput string[] No description.
allowedDatabasesInput string[] No description.
allowedIntegrationTypesInput string[] No description.
allowedSharesInput string[] No description.
fromReplicaInput FailoverGroupFromReplica No description.
idInput string No description.
ignoreEditionCheckInput boolean | cdktf.IResolvable No description.
nameInput string No description.
objectTypesInput string[] No description.
replicationScheduleInput FailoverGroupReplicationSchedule No description.
allowedAccounts string[] No description.
allowedDatabases string[] No description.
allowedIntegrationTypes string[] No description.
allowedShares string[] No description.
id string No description.
ignoreEditionCheck boolean | cdktf.IResolvable No description.
name string No description.
objectTypes 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[]
fromReplicaRequired 
public readonly fromReplica: FailoverGroupFromReplicaOutputReference;
replicationScheduleRequired 
public readonly replicationSchedule: FailoverGroupReplicationScheduleOutputReference;
allowedAccountsInputOptional 
public readonly allowedAccountsInput: string[];
  • Type: string[]
allowedDatabasesInputOptional 
public readonly allowedDatabasesInput: string[];
  • Type: string[]
allowedIntegrationTypesInputOptional 
public readonly allowedIntegrationTypesInput: string[];
  • Type: string[]
allowedSharesInputOptional 
public readonly allowedSharesInput: string[];
  • Type: string[]
fromReplicaInputOptional 
public readonly fromReplicaInput: FailoverGroupFromReplica;
idInputOptional 
public readonly idInput: string;
  • Type: string
ignoreEditionCheckInputOptional 
public readonly ignoreEditionCheckInput: boolean | IResolvable;
  • Type: boolean | cdktf.IResolvable
nameInputOptional 
public readonly nameInput: string;
  • Type: string
objectTypesInputOptional 
public readonly objectTypesInput: string[];
  • Type: string[]
replicationScheduleInputOptional 
public readonly replicationScheduleInput: FailoverGroupReplicationSchedule;
allowedAccountsRequired 
public readonly allowedAccounts: string[];
  • Type: string[]
allowedDatabasesRequired 
public readonly allowedDatabases: string[];
  • Type: string[]
allowedIntegrationTypesRequired 
public readonly allowedIntegrationTypes: string[];
  • Type: string[]
allowedSharesRequired 
public readonly allowedShares: string[];
  • Type: string[]
idRequired 
public readonly id: string;
  • Type: string
ignoreEditionCheckRequired 
public readonly ignoreEditionCheck: boolean | IResolvable;
  • Type: boolean | cdktf.IResolvable
nameRequired 
public readonly name: string;
  • Type: string
objectTypesRequired 
public readonly objectTypes: string[];
  • Type: string[]

Constants

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

Structs

FailoverGroupConfig

Initializer 

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

const failoverGroupConfig: failoverGroup.FailoverGroupConfig = { ... }

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.
name string Specifies the identifier for the failover group.
allowedAccounts string[] Specifies the target account or list of target accounts to which replication and failover of specified objects from the source account is enabled.
allowedDatabases string[] Specifies the database or list of databases for which you are enabling replication and failover from the source account to the target account.
allowedIntegrationTypes string[] Type(s) of integrations for which you are enabling replication and failover from the source account to the target account.
allowedShares string[] Specifies the share or list of shares for which you are enabling replication and failover from the source account to the target account.
fromReplica FailoverGroupFromReplica from_replica block.
id string Docs at Terraform Registry: {@link https://registry.terraform.io/providers/snowflake-labs/snowflake/0.90.0/docs/resources/failover_group#id FailoverGroup#id}.
ignoreEditionCheck boolean | cdktf.IResolvable Allows replicating objects to accounts on lower editions.
objectTypes string[] Type(s) of objects for which you are enabling replication and failover from the source account to the target account.
replicationSchedule FailoverGroupReplicationSchedule replication_schedule block.
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[]
nameRequired 
public readonly name: string;
  • Type: string

Specifies the identifier for the failover group.

The identifier must start with an alphabetic character and cannot contain spaces or special characters unless the identifier string is enclosed in double quotes (e.g. "My object"). Identifiers enclosed in double quotes are also case-sensitive.

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

allowedAccountsOptional 
public readonly allowedAccounts: string[];
  • Type: string[]

Specifies the target account or list of target accounts to which replication and failover of specified objects from the source account is enabled.

Secondary failover groups in the target accounts in this list can be promoted to serve as the primary failover group in case of failover. Expected in the form <org_name>.<target_account_name>

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/snowflake-labs/snowflake/0.90.0/docs/resources/failover_group#allowed_accounts FailoverGroup#allowed_accounts}

allowedDatabasesOptional 
public readonly allowedDatabases: string[];
  • Type: string[]

Specifies the database or list of databases for which you are enabling replication and failover from the source account to the target account.

The OBJECT_TYPES list must include DATABASES to set this parameter.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/snowflake-labs/snowflake/0.90.0/docs/resources/failover_group#allowed_databases FailoverGroup#allowed_databases}

allowedIntegrationTypesOptional 
public readonly allowedIntegrationTypes: string[];
  • Type: string[]

Type(s) of integrations for which you are enabling replication and failover from the source account to the target account.

This property requires that the OBJECT_TYPES list include INTEGRATIONS to set this parameter. The following integration types are supported: "SECURITY INTEGRATIONS", "API INTEGRATIONS", "STORAGE INTEGRATIONS", "EXTERNAL ACCESS INTEGRATIONS", "NOTIFICATION INTEGRATIONS"

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/snowflake-labs/snowflake/0.90.0/docs/resources/failover_group#allowed_integration_types FailoverGroup#allowed_integration_types}

allowedSharesOptional 
public readonly allowedShares: string[];
  • Type: string[]

Specifies the share or list of shares for which you are enabling replication and failover from the source account to the target account.

The OBJECT_TYPES list must include SHARES to set this parameter.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/snowflake-labs/snowflake/0.90.0/docs/resources/failover_group#allowed_shares FailoverGroup#allowed_shares}

fromReplicaOptional 
public readonly fromReplica: FailoverGroupFromReplica;

from_replica block.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/snowflake-labs/snowflake/0.90.0/docs/resources/failover_group#from_replica FailoverGroup#from_replica}

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/failover_group#id FailoverGroup#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.

ignoreEditionCheckOptional 
public readonly ignoreEditionCheck: boolean | IResolvable;
  • Type: boolean | cdktf.IResolvable

Allows replicating objects to accounts on lower editions.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/snowflake-labs/snowflake/0.90.0/docs/resources/failover_group#ignore_edition_check FailoverGroup#ignore_edition_check}

objectTypesOptional 
public readonly objectTypes: string[];
  • Type: string[]

Type(s) of objects for which you are enabling replication and failover from the source account to the target account.

The following object types are supported: "ACCOUNT PARAMETERS", "DATABASES", "INTEGRATIONS", "NETWORK POLICIES", "RESOURCE MONITORS", "ROLES", "SHARES", "USERS", "WAREHOUSES"

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/snowflake-labs/snowflake/0.90.0/docs/resources/failover_group#object_types FailoverGroup#object_types}

replicationScheduleOptional 
public readonly replicationSchedule: FailoverGroupReplicationSchedule;

replication_schedule block.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/snowflake-labs/snowflake/0.90.0/docs/resources/failover_group#replication_schedule FailoverGroup#replication_schedule}

FailoverGroupFromReplica

Initializer 

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

const failoverGroupFromReplica: failoverGroup.FailoverGroupFromReplica = { ... }

Properties

Name Type Description
name string Identifier for the primary failover group in the source account.
organizationName string Name of your Snowflake organization.
sourceAccountName string Source account from which you are enabling replication and failover of the specified objects.
nameRequired 
public readonly name: string;
  • Type: string

Identifier for the primary failover group in the source account.

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

organizationNameRequired 
public readonly organizationName: string;
  • Type: string

Name of your Snowflake organization.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/snowflake-labs/snowflake/0.90.0/docs/resources/failover_group#organization_name FailoverGroup#organization_name}

sourceAccountNameRequired 
public readonly sourceAccountName: string;
  • Type: string

Source account from which you are enabling replication and failover of the specified objects.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/snowflake-labs/snowflake/0.90.0/docs/resources/failover_group#source_account_name FailoverGroup#source_account_name}

FailoverGroupReplicationSchedule

Initializer 

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

const failoverGroupReplicationSchedule: failoverGroup.FailoverGroupReplicationSchedule = { ... }

Properties

Name Type Description
cron FailoverGroupReplicationScheduleCron cron block.
interval number Specifies the interval in minutes for the replication schedule.
cronOptional 
public readonly cron: FailoverGroupReplicationScheduleCron;

cron block.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/snowflake-labs/snowflake/0.90.0/docs/resources/failover_group#cron FailoverGroup#cron}

intervalOptional 
public readonly interval: number;
  • Type: number

Specifies the interval in minutes for the replication schedule.

The interval must be greater than 0 and less than 1440 (24 hours).

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/snowflake-labs/snowflake/0.90.0/docs/resources/failover_group#interval FailoverGroup#interval}

FailoverGroupReplicationScheduleCron

Initializer 

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

const failoverGroupReplicationScheduleCron: failoverGroup.FailoverGroupReplicationScheduleCron = { ... }

Properties

Name Type Description
expression string Specifies the cron expression for the replication schedule.
timeZone string Specifies the time zone for secondary group refresh.
expressionRequired 
public readonly expression: string;
  • Type: string

Specifies the cron expression for the replication schedule.

The cron expression must be in the following format: "minute hour day-of-month month day-of-week". The following values are supported: minute: 0-59 hour: 0-23 day-of-month: 1-31 month: 1-12 day-of-week: 0-6 (0 is Sunday)

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/snowflake-labs/snowflake/0.90.0/docs/resources/failover_group#expression FailoverGroup#expression}

timeZoneRequired 
public readonly timeZone: string;
  • Type: string

Specifies the time zone for secondary group refresh.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/snowflake-labs/snowflake/0.90.0/docs/resources/failover_group#time_zone FailoverGroup#time_zone}

Classes

FailoverGroupFromReplicaOutputReference

Initializers 

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

new failoverGroup.FailoverGroupFromReplicaOutputReference(terraformResource: IInterpolatingParent, terraformAttribute: string)
Name Type Description
terraformResource cdktf.IInterpolatingParent The parent resource.
terraformAttribute string The attribute on the parent resource this class is referencing.
terraformResourceRequired
  • Type: cdktf.IInterpolatingParent

The parent resource.

terraformAttributeRequired
  • Type: string

The attribute on the parent resource this class is referencing.

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

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.
nameInput string No description.
organizationNameInput string No description.
sourceAccountNameInput string No description.
name string No description.
organizationName string No description.
sourceAccountName string No description.
internalValue FailoverGroupFromReplica 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
nameInputOptional 
public readonly nameInput: string;
  • Type: string
organizationNameInputOptional 
public readonly organizationNameInput: string;
  • Type: string
sourceAccountNameInputOptional 
public readonly sourceAccountNameInput: string;
  • Type: string
nameRequired 
public readonly name: string;
  • Type: string
organizationNameRequired 
public readonly organizationName: string;
  • Type: string
sourceAccountNameRequired 
public readonly sourceAccountName: string;
  • Type: string
internalValueOptional 
public readonly internalValue: FailoverGroupFromReplica;

FailoverGroupReplicationScheduleCronOutputReference

Initializers 

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

new failoverGroup.FailoverGroupReplicationScheduleCronOutputReference(terraformResource: IInterpolatingParent, terraformAttribute: string)
Name Type Description
terraformResource cdktf.IInterpolatingParent The parent resource.
terraformAttribute string The attribute on the parent resource this class is referencing.
terraformResourceRequired
  • Type: cdktf.IInterpolatingParent

The parent resource.

terraformAttributeRequired
  • Type: string

The attribute on the parent resource this class is referencing.

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

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.
expressionInput string No description.
timeZoneInput string No description.
expression string No description.
timeZone string No description.
internalValue FailoverGroupReplicationScheduleCron 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
expressionInputOptional 
public readonly expressionInput: string;
  • Type: string
timeZoneInputOptional 
public readonly timeZoneInput: string;
  • Type: string
expressionRequired 
public readonly expression: string;
  • Type: string
timeZoneRequired 
public readonly timeZone: string;
  • Type: string
internalValueOptional 
public readonly internalValue: FailoverGroupReplicationScheduleCron;

FailoverGroupReplicationScheduleOutputReference

Initializers 

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

new failoverGroup.FailoverGroupReplicationScheduleOutputReference(terraformResource: IInterpolatingParent, terraformAttribute: string)
Name Type Description
terraformResource cdktf.IInterpolatingParent The parent resource.
terraformAttribute string The attribute on the parent resource this class is referencing.
terraformResourceRequired
  • Type: cdktf.IInterpolatingParent

The parent resource.

terraformAttributeRequired
  • Type: string

The attribute on the parent resource this class is referencing.

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.
putCron No description.
resetCron No description.
resetInterval 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.

putCron 
public putCron(value: FailoverGroupReplicationScheduleCron): void
valueRequired
resetCron 
public resetCron(): void
resetInterval 
public resetInterval(): 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.
cron FailoverGroupReplicationScheduleCronOutputReference No description.
cronInput FailoverGroupReplicationScheduleCron No description.
intervalInput number No description.
interval number No description.
internalValue FailoverGroupReplicationSchedule 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
cronRequired 
public readonly cron: FailoverGroupReplicationScheduleCronOutputReference;
cronInputOptional 
public readonly cronInput: FailoverGroupReplicationScheduleCron;
intervalInputOptional 
public readonly intervalInput: number;
  • Type: number
intervalRequired 
public readonly interval: number;
  • Type: number
internalValueOptional 
public readonly internalValue: FailoverGroupReplicationSchedule;