Skip to content

Latest commit

 

History

History
2549 lines (1581 loc) · 122 KB

athenaWorkgroup.md

File metadata and controls

2549 lines (1581 loc) · 122 KB

aws_athena_workgroup

Refer to the Terraform Registory for docs: aws_athena_workgroup.

athenaWorkgroup Submodule

Constructs

AthenaWorkgroup

Represents a {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/athena_workgroup aws_athena_workgroup}.

Initializers 

import { athenaWorkgroup } from '@cdktf/aws-cdk'

new athenaWorkgroup.AthenaWorkgroup(scope: Construct, id: string, config: AthenaWorkgroupConfig)
Name Type Description
scope constructs.Construct The scope in which to define this construct.
id string The scoped construct ID.
config AthenaWorkgroupConfig 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.
toMetadata No description.
toTerraform Adds this resource to the terraform JSON output.
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.
putConfiguration No description.
resetConfiguration No description.
resetDescription No description.
resetForceDestroy No description.
resetId No description.
resetState No description.
resetTags No description.
resetTagsAll 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.

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

Adds this resource to the terraform JSON output.

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(terraformAttribute: string): IResolvable
terraformAttributeRequired
  • Type: string
putConfiguration 
public putConfiguration(value: AthenaWorkgroupConfiguration): void
valueRequired
resetConfiguration 
public resetConfiguration(): void
resetDescription 
public resetDescription(): void
resetForceDestroy 
public resetForceDestroy(): void
resetId 
public resetId(): void
resetState 
public resetState(): void
resetTags 
public resetTags(): void
resetTagsAll 
public resetTagsAll(): void

Static Functions

Name Description
isConstruct Checks if x is a construct.
isTerraformElement No description.
isTerraformResource No description.
isConstruct 
import { athenaWorkgroup } from '@cdktf/aws-cdk'

athenaWorkgroup.AthenaWorkgroup.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 { athenaWorkgroup } from '@cdktf/aws-cdk'

athenaWorkgroup.AthenaWorkgroup.isTerraformElement(x: any)
xRequired
  • Type: any
isTerraformResource 
import { athenaWorkgroup } from '@cdktf/aws-cdk'

athenaWorkgroup.AthenaWorkgroup.isTerraformResource(x: any)
xRequired
  • Type: any

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.
arn string No description.
configuration AthenaWorkgroupConfigurationOutputReference No description.
configurationInput AthenaWorkgroupConfiguration No description.
descriptionInput string No description.
forceDestroyInput boolean | cdktf.IResolvable No description.
idInput string No description.
nameInput string No description.
stateInput string No description.
tagsAllInput {[ key: string ]: string} No description.
tagsInput {[ key: string ]: string} No description.
description string No description.
forceDestroy boolean | cdktf.IResolvable No description.
id string No description.
name string No description.
state string No description.
tags {[ key: string ]: string} No description.
tagsAll {[ key: string ]: 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[]
arnRequired 
public readonly arn: string;
  • Type: string
configurationRequired 
public readonly configuration: AthenaWorkgroupConfigurationOutputReference;
configurationInputOptional 
public readonly configurationInput: AthenaWorkgroupConfiguration;
descriptionInputOptional 
public readonly descriptionInput: string;
  • Type: string
forceDestroyInputOptional 
public readonly forceDestroyInput: boolean | IResolvable;
  • Type: boolean | cdktf.IResolvable
idInputOptional 
public readonly idInput: string;
  • Type: string
nameInputOptional 
public readonly nameInput: string;
  • Type: string
stateInputOptional 
public readonly stateInput: string;
  • Type: string
tagsAllInputOptional 
public readonly tagsAllInput: {[ key: string ]: string};
  • Type: {[ key: string ]: string}
tagsInputOptional 
public readonly tagsInput: {[ key: string ]: string};
  • Type: {[ key: string ]: string}
descriptionRequired 
public readonly description: string;
  • Type: string
forceDestroyRequired 
public readonly forceDestroy: boolean | IResolvable;
  • Type: boolean | cdktf.IResolvable
idRequired 
public readonly id: string;
  • Type: string
nameRequired 
public readonly name: string;
  • Type: string
stateRequired 
public readonly state: string;
  • Type: string
tagsRequired 
public readonly tags: {[ key: string ]: string};
  • Type: {[ key: string ]: string}
tagsAllRequired 
public readonly tagsAll: {[ key: string ]: string};
  • Type: {[ key: string ]: string}

Constants

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

Structs

AthenaWorkgroupConfig

Initializer 

import { athenaWorkgroup } from '@cdktf/aws-cdk'

const athenaWorkgroupConfig: athenaWorkgroup.AthenaWorkgroupConfig = { ... }

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 Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/athena_workgroup#name AthenaWorkgroup#name}.
configuration AthenaWorkgroupConfiguration configuration block.
description string Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/athena_workgroup#description AthenaWorkgroup#description}.
forceDestroy boolean | cdktf.IResolvable Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/athena_workgroup#force_destroy AthenaWorkgroup#force_destroy}.
id string Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/athena_workgroup#id AthenaWorkgroup#id}.
state string Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/athena_workgroup#state AthenaWorkgroup#state}.
tags {[ key: string ]: string} Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/athena_workgroup#tags AthenaWorkgroup#tags}.
tagsAll {[ key: string ]: string} Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/athena_workgroup#tags_all AthenaWorkgroup#tags_all}.
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

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/athena_workgroup#name AthenaWorkgroup#name}.

configurationOptional 
public readonly configuration: AthenaWorkgroupConfiguration;

configuration block.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/athena_workgroup#configuration AthenaWorkgroup#configuration}

descriptionOptional 
public readonly description: string;
  • Type: string

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/athena_workgroup#description AthenaWorkgroup#description}.

forceDestroyOptional 
public readonly forceDestroy: boolean | IResolvable;
  • Type: boolean | cdktf.IResolvable

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/athena_workgroup#force_destroy AthenaWorkgroup#force_destroy}.

idOptional 
public readonly id: string;
  • Type: string

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/athena_workgroup#id AthenaWorkgroup#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.

stateOptional 
public readonly state: string;
  • Type: string

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/athena_workgroup#state AthenaWorkgroup#state}.

tagsOptional 
public readonly tags: {[ key: string ]: string};
  • Type: {[ key: string ]: string}

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/athena_workgroup#tags AthenaWorkgroup#tags}.

tagsAllOptional 
public readonly tagsAll: {[ key: string ]: string};
  • Type: {[ key: string ]: string}

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/athena_workgroup#tags_all AthenaWorkgroup#tags_all}.

AthenaWorkgroupConfiguration

Initializer 

import { athenaWorkgroup } from '@cdktf/aws-cdk'

const athenaWorkgroupConfiguration: athenaWorkgroup.AthenaWorkgroupConfiguration = { ... }

Properties

Name Type Description
bytesScannedCutoffPerQuery number Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/athena_workgroup#bytes_scanned_cutoff_per_query AthenaWorkgroup#bytes_scanned_cutoff_per_query}.
enforceWorkgroupConfiguration boolean | cdktf.IResolvable Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/athena_workgroup#enforce_workgroup_configuration AthenaWorkgroup#enforce_workgroup_configuration}.
engineVersion AthenaWorkgroupConfigurationEngineVersion engine_version block.
publishCloudwatchMetricsEnabled boolean | cdktf.IResolvable Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/athena_workgroup#publish_cloudwatch_metrics_enabled AthenaWorkgroup#publish_cloudwatch_metrics_enabled}.
requesterPaysEnabled boolean | cdktf.IResolvable Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/athena_workgroup#requester_pays_enabled AthenaWorkgroup#requester_pays_enabled}.
resultConfiguration AthenaWorkgroupConfigurationResultConfiguration result_configuration block.
bytesScannedCutoffPerQueryOptional 
public readonly bytesScannedCutoffPerQuery: number;
  • Type: number

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/athena_workgroup#bytes_scanned_cutoff_per_query AthenaWorkgroup#bytes_scanned_cutoff_per_query}.

enforceWorkgroupConfigurationOptional 
public readonly enforceWorkgroupConfiguration: boolean | IResolvable;
  • Type: boolean | cdktf.IResolvable

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/athena_workgroup#enforce_workgroup_configuration AthenaWorkgroup#enforce_workgroup_configuration}.

engineVersionOptional 
public readonly engineVersion: AthenaWorkgroupConfigurationEngineVersion;

engine_version block.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/athena_workgroup#engine_version AthenaWorkgroup#engine_version}

publishCloudwatchMetricsEnabledOptional 
public readonly publishCloudwatchMetricsEnabled: boolean | IResolvable;
  • Type: boolean | cdktf.IResolvable

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/athena_workgroup#publish_cloudwatch_metrics_enabled AthenaWorkgroup#publish_cloudwatch_metrics_enabled}.

requesterPaysEnabledOptional 
public readonly requesterPaysEnabled: boolean | IResolvable;
  • Type: boolean | cdktf.IResolvable

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/athena_workgroup#requester_pays_enabled AthenaWorkgroup#requester_pays_enabled}.

resultConfigurationOptional 
public readonly resultConfiguration: AthenaWorkgroupConfigurationResultConfiguration;

result_configuration block.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/athena_workgroup#result_configuration AthenaWorkgroup#result_configuration}

AthenaWorkgroupConfigurationEngineVersion

Initializer 

import { athenaWorkgroup } from '@cdktf/aws-cdk'

const athenaWorkgroupConfigurationEngineVersion: athenaWorkgroup.AthenaWorkgroupConfigurationEngineVersion = { ... }

Properties

Name Type Description
selectedEngineVersion string Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/athena_workgroup#selected_engine_version AthenaWorkgroup#selected_engine_version}.
selectedEngineVersionOptional 
public readonly selectedEngineVersion: string;
  • Type: string

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/athena_workgroup#selected_engine_version AthenaWorkgroup#selected_engine_version}.

AthenaWorkgroupConfigurationResultConfiguration

Initializer 

import { athenaWorkgroup } from '@cdktf/aws-cdk'

const athenaWorkgroupConfigurationResultConfiguration: athenaWorkgroup.AthenaWorkgroupConfigurationResultConfiguration = { ... }

Properties

Name Type Description
encryptionConfiguration AthenaWorkgroupConfigurationResultConfigurationEncryptionConfiguration encryption_configuration block.
outputLocation string Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/athena_workgroup#output_location AthenaWorkgroup#output_location}.
encryptionConfigurationOptional 
public readonly encryptionConfiguration: AthenaWorkgroupConfigurationResultConfigurationEncryptionConfiguration;

encryption_configuration block.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/athena_workgroup#encryption_configuration AthenaWorkgroup#encryption_configuration}

outputLocationOptional 
public readonly outputLocation: string;
  • Type: string

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/athena_workgroup#output_location AthenaWorkgroup#output_location}.

AthenaWorkgroupConfigurationResultConfigurationEncryptionConfiguration

Initializer 

import { athenaWorkgroup } from '@cdktf/aws-cdk'

const athenaWorkgroupConfigurationResultConfigurationEncryptionConfiguration: athenaWorkgroup.AthenaWorkgroupConfigurationResultConfigurationEncryptionConfiguration = { ... }

Properties

Name Type Description
encryptionOption string Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/athena_workgroup#encryption_option AthenaWorkgroup#encryption_option}.
kmsKeyArn string Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/athena_workgroup#kms_key_arn AthenaWorkgroup#kms_key_arn}.
encryptionOptionOptional 
public readonly encryptionOption: string;
  • Type: string

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/athena_workgroup#encryption_option AthenaWorkgroup#encryption_option}.

kmsKeyArnOptional 
public readonly kmsKeyArn: string;
  • Type: string

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/athena_workgroup#kms_key_arn AthenaWorkgroup#kms_key_arn}.

Classes

AthenaWorkgroupConfigurationEngineVersionOutputReference

Initializers 

import { athenaWorkgroup } from '@cdktf/aws-cdk'

new athenaWorkgroup.AthenaWorkgroupConfigurationEngineVersionOutputReference(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.
resetSelectedEngineVersion 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.

resetSelectedEngineVersion 
public resetSelectedEngineVersion(): 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.
effectiveEngineVersion string No description.
selectedEngineVersionInput string No description.
selectedEngineVersion string No description.
internalValue AthenaWorkgroupConfigurationEngineVersion 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
effectiveEngineVersionRequired 
public readonly effectiveEngineVersion: string;
  • Type: string
selectedEngineVersionInputOptional 
public readonly selectedEngineVersionInput: string;
  • Type: string
selectedEngineVersionRequired 
public readonly selectedEngineVersion: string;
  • Type: string
internalValueOptional 
public readonly internalValue: AthenaWorkgroupConfigurationEngineVersion;

AthenaWorkgroupConfigurationOutputReference

Initializers 

import { athenaWorkgroup } from '@cdktf/aws-cdk'

new athenaWorkgroup.AthenaWorkgroupConfigurationOutputReference(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.
putEngineVersion No description.
putResultConfiguration No description.
resetBytesScannedCutoffPerQuery No description.
resetEnforceWorkgroupConfiguration No description.
resetEngineVersion No description.
resetPublishCloudwatchMetricsEnabled No description.
resetRequesterPaysEnabled No description.
resetResultConfiguration 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.

putEngineVersion 
public putEngineVersion(value: AthenaWorkgroupConfigurationEngineVersion): void
valueRequired
putResultConfiguration 
public putResultConfiguration(value: AthenaWorkgroupConfigurationResultConfiguration): void
valueRequired
resetBytesScannedCutoffPerQuery 
public resetBytesScannedCutoffPerQuery(): void
resetEnforceWorkgroupConfiguration 
public resetEnforceWorkgroupConfiguration(): void
resetEngineVersion 
public resetEngineVersion(): void
resetPublishCloudwatchMetricsEnabled 
public resetPublishCloudwatchMetricsEnabled(): void
resetRequesterPaysEnabled 
public resetRequesterPaysEnabled(): void
resetResultConfiguration 
public resetResultConfiguration(): 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.
engineVersion AthenaWorkgroupConfigurationEngineVersionOutputReference No description.
resultConfiguration AthenaWorkgroupConfigurationResultConfigurationOutputReference No description.
bytesScannedCutoffPerQueryInput number No description.
enforceWorkgroupConfigurationInput boolean | cdktf.IResolvable No description.
engineVersionInput AthenaWorkgroupConfigurationEngineVersion No description.
publishCloudwatchMetricsEnabledInput boolean | cdktf.IResolvable No description.
requesterPaysEnabledInput boolean | cdktf.IResolvable No description.
resultConfigurationInput AthenaWorkgroupConfigurationResultConfiguration No description.
bytesScannedCutoffPerQuery number No description.
enforceWorkgroupConfiguration boolean | cdktf.IResolvable No description.
publishCloudwatchMetricsEnabled boolean | cdktf.IResolvable No description.
requesterPaysEnabled boolean | cdktf.IResolvable No description.
internalValue AthenaWorkgroupConfiguration 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
engineVersionRequired 
public readonly engineVersion: AthenaWorkgroupConfigurationEngineVersionOutputReference;
resultConfigurationRequired 
public readonly resultConfiguration: AthenaWorkgroupConfigurationResultConfigurationOutputReference;
bytesScannedCutoffPerQueryInputOptional 
public readonly bytesScannedCutoffPerQueryInput: number;
  • Type: number
enforceWorkgroupConfigurationInputOptional 
public readonly enforceWorkgroupConfigurationInput: boolean | IResolvable;
  • Type: boolean | cdktf.IResolvable
engineVersionInputOptional 
public readonly engineVersionInput: AthenaWorkgroupConfigurationEngineVersion;
publishCloudwatchMetricsEnabledInputOptional 
public readonly publishCloudwatchMetricsEnabledInput: boolean | IResolvable;
  • Type: boolean | cdktf.IResolvable
requesterPaysEnabledInputOptional 
public readonly requesterPaysEnabledInput: boolean | IResolvable;
  • Type: boolean | cdktf.IResolvable
resultConfigurationInputOptional 
public readonly resultConfigurationInput: AthenaWorkgroupConfigurationResultConfiguration;
bytesScannedCutoffPerQueryRequired 
public readonly bytesScannedCutoffPerQuery: number;
  • Type: number
enforceWorkgroupConfigurationRequired 
public readonly enforceWorkgroupConfiguration: boolean | IResolvable;
  • Type: boolean | cdktf.IResolvable
publishCloudwatchMetricsEnabledRequired 
public readonly publishCloudwatchMetricsEnabled: boolean | IResolvable;
  • Type: boolean | cdktf.IResolvable
requesterPaysEnabledRequired 
public readonly requesterPaysEnabled: boolean | IResolvable;
  • Type: boolean | cdktf.IResolvable
internalValueOptional 
public readonly internalValue: AthenaWorkgroupConfiguration;

AthenaWorkgroupConfigurationResultConfigurationEncryptionConfigurationOutputReference

Initializers 

import { athenaWorkgroup } from '@cdktf/aws-cdk'

new athenaWorkgroup.AthenaWorkgroupConfigurationResultConfigurationEncryptionConfigurationOutputReference(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.
resetEncryptionOption No description.
resetKmsKeyArn 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.

resetEncryptionOption 
public resetEncryptionOption(): void
resetKmsKeyArn 
public resetKmsKeyArn(): 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.
encryptionOptionInput string No description.
kmsKeyArnInput string No description.
encryptionOption string No description.
kmsKeyArn string No description.
internalValue AthenaWorkgroupConfigurationResultConfigurationEncryptionConfiguration 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
encryptionOptionInputOptional 
public readonly encryptionOptionInput: string;
  • Type: string
kmsKeyArnInputOptional 
public readonly kmsKeyArnInput: string;
  • Type: string
encryptionOptionRequired 
public readonly encryptionOption: string;
  • Type: string
kmsKeyArnRequired 
public readonly kmsKeyArn: string;
  • Type: string
internalValueOptional 
public readonly internalValue: AthenaWorkgroupConfigurationResultConfigurationEncryptionConfiguration;

AthenaWorkgroupConfigurationResultConfigurationOutputReference

Initializers 

import { athenaWorkgroup } from '@cdktf/aws-cdk'

new athenaWorkgroup.AthenaWorkgroupConfigurationResultConfigurationOutputReference(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.
putEncryptionConfiguration No description.
resetEncryptionConfiguration No description.
resetOutputLocation 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.

putEncryptionConfiguration 
public putEncryptionConfiguration(value: AthenaWorkgroupConfigurationResultConfigurationEncryptionConfiguration): void
valueRequired
resetEncryptionConfiguration 
public resetEncryptionConfiguration(): void
resetOutputLocation 
public resetOutputLocation(): 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.
encryptionConfiguration AthenaWorkgroupConfigurationResultConfigurationEncryptionConfigurationOutputReference No description.
encryptionConfigurationInput AthenaWorkgroupConfigurationResultConfigurationEncryptionConfiguration No description.
outputLocationInput string No description.
outputLocation string No description.
internalValue AthenaWorkgroupConfigurationResultConfiguration 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
encryptionConfigurationRequired 
public readonly encryptionConfiguration: AthenaWorkgroupConfigurationResultConfigurationEncryptionConfigurationOutputReference;
encryptionConfigurationInputOptional 
public readonly encryptionConfigurationInput: AthenaWorkgroupConfigurationResultConfigurationEncryptionConfiguration;
outputLocationInputOptional 
public readonly outputLocationInput: string;
  • Type: string
outputLocationRequired 
public readonly outputLocation: string;
  • Type: string
internalValueOptional 
public readonly internalValue: AthenaWorkgroupConfigurationResultConfiguration;