Skip to content

Latest commit

 

History

History
1240 lines (767 loc) · 49.3 KB

storageBucket.typescript.md

File metadata and controls

1240 lines (767 loc) · 49.3 KB
Raw

storageBucket Submodule

Constructs

StorageBucket

Represents a {@link https://registry.terraform.io/providers/hashicorp/boundary/1.1.15/docs/resources/storage_bucket boundary_storage_bucket}.

Initializers 

import { storageBucket } from '@cdktf/provider-boundary'

new storageBucket.StorageBucket(scope: Construct, id: string, config: StorageBucketConfig)
Name Type Description
scope constructs.Construct The scope in which to define this construct.
id string The scoped construct ID.
config StorageBucketConfig 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".
resetAttributesJson No description.
resetBucketPrefix No description.
resetDescription No description.
resetName No description.
resetPluginId No description.
resetPluginName No description.
resetSecretsJson 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".

resetAttributesJson 
public resetAttributesJson(): void
resetBucketPrefix 
public resetBucketPrefix(): void
resetDescription 
public resetDescription(): void
resetName 
public resetName(): void
resetPluginId 
public resetPluginId(): void
resetPluginName 
public resetPluginName(): void
resetSecretsJson 
public resetSecretsJson(): 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 StorageBucket resource upon running "cdktf plan ".
isConstruct 
import { storageBucket } from '@cdktf/provider-boundary'

storageBucket.StorageBucket.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 { storageBucket } from '@cdktf/provider-boundary'

storageBucket.StorageBucket.isTerraformElement(x: any)
xRequired
  • Type: any
isTerraformResource 
import { storageBucket } from '@cdktf/provider-boundary'

storageBucket.StorageBucket.isTerraformResource(x: any)
xRequired
  • Type: any
generateConfigForImport 
import { storageBucket } from '@cdktf/provider-boundary'

storageBucket.StorageBucket.generateConfigForImport(scope: Construct, importToId: string, importFromId: string, provider?: TerraformProvider)

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

importFromIdRequired
  • Type: string

The id of the existing StorageBucket that should be imported.

Refer to the {@link https://registry.terraform.io/providers/hashicorp/boundary/1.1.15/docs/resources/storage_bucket#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 StorageBucket 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.
id string No description.
internalForceUpdate string No description.
internalHmacUsedForSecretsConfigHmac string No description.
internalSecretsConfigHmac string No description.
secretsHmac string No description.
attributesJsonInput string No description.
bucketNameInput string No description.
bucketPrefixInput string No description.
descriptionInput string No description.
nameInput string No description.
pluginIdInput string No description.
pluginNameInput string No description.
scopeIdInput string No description.
secretsJsonInput string No description.
workerFilterInput string No description.
attributesJson string No description.
bucketName string No description.
bucketPrefix string No description.
description string No description.
name string No description.
pluginId string No description.
pluginName string No description.
scopeId string No description.
secretsJson string No description.
workerFilter 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[]
idRequired 
public readonly id: string;
  • Type: string
internalForceUpdateRequired 
public readonly internalForceUpdate: string;
  • Type: string
internalHmacUsedForSecretsConfigHmacRequired 
public readonly internalHmacUsedForSecretsConfigHmac: string;
  • Type: string
internalSecretsConfigHmacRequired 
public readonly internalSecretsConfigHmac: string;
  • Type: string
secretsHmacRequired 
public readonly secretsHmac: string;
  • Type: string
attributesJsonInputOptional 
public readonly attributesJsonInput: string;
  • Type: string
bucketNameInputOptional 
public readonly bucketNameInput: string;
  • Type: string
bucketPrefixInputOptional 
public readonly bucketPrefixInput: string;
  • Type: string
descriptionInputOptional 
public readonly descriptionInput: string;
  • Type: string
nameInputOptional 
public readonly nameInput: string;
  • Type: string
pluginIdInputOptional 
public readonly pluginIdInput: string;
  • Type: string
pluginNameInputOptional 
public readonly pluginNameInput: string;
  • Type: string
scopeIdInputOptional 
public readonly scopeIdInput: string;
  • Type: string
secretsJsonInputOptional 
public readonly secretsJsonInput: string;
  • Type: string
workerFilterInputOptional 
public readonly workerFilterInput: string;
  • Type: string
attributesJsonRequired 
public readonly attributesJson: string;
  • Type: string
bucketNameRequired 
public readonly bucketName: string;
  • Type: string
bucketPrefixRequired 
public readonly bucketPrefix: string;
  • Type: string
descriptionRequired 
public readonly description: string;
  • Type: string
nameRequired 
public readonly name: string;
  • Type: string
pluginIdRequired 
public readonly pluginId: string;
  • Type: string
pluginNameRequired 
public readonly pluginName: string;
  • Type: string
scopeIdRequired 
public readonly scopeId: string;
  • Type: string
secretsJsonRequired 
public readonly secretsJson: string;
  • Type: string
workerFilterRequired 
public readonly workerFilter: string;
  • Type: string

Constants

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

Structs

StorageBucketConfig

Initializer 

import { storageBucket } from '@cdktf/provider-boundary'

const storageBucketConfig: storageBucket.StorageBucketConfig = { ... }

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.
bucketName string The name of the bucket within the external object store service.
scopeId string The scope for this storage bucket.
workerFilter string Filters to the worker(s) that can handle requests for this storage bucket.
attributesJson string The attributes for the storage bucket.
bucketPrefix string The prefix used to organize the data held within the external object store.
description string The storage bucket description.
name string The storage bucket name. Defaults to the resource name.
pluginId string The ID of the plugin that should back the resource. This or plugin_name must be defined.
pluginName string The name of the plugin that should back the resource. This or plugin_id must be defined.
secretsJson string The secrets for the storage bucket.
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[]
bucketNameRequired 
public readonly bucketName: string;
  • Type: string

The name of the bucket within the external object store service.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/boundary/1.1.15/docs/resources/storage_bucket#bucket_name StorageBucket#bucket_name}

scopeIdRequired 
public readonly scopeId: string;
  • Type: string

The scope for this storage bucket.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/boundary/1.1.15/docs/resources/storage_bucket#scope_id StorageBucket#scope_id}

workerFilterRequired 
public readonly workerFilter: string;
  • Type: string

Filters to the worker(s) that can handle requests for this storage bucket.

The filter must match an existing worker in order to create a storage bucket.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/boundary/1.1.15/docs/resources/storage_bucket#worker_filter StorageBucket#worker_filter}

attributesJsonOptional 
public readonly attributesJson: string;
  • Type: string

The attributes for the storage bucket.

The "region" attribute field is required when creating an AWS storage bucket. Values are either encoded with the "jsonencode" function, pre-escaped JSON string, or a file:// or env:// path. Set to a string "null" or remove the block to clear all attributes in the storage bucket.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/boundary/1.1.15/docs/resources/storage_bucket#attributes_json StorageBucket#attributes_json}

bucketPrefixOptional 
public readonly bucketPrefix: string;
  • Type: string

The prefix used to organize the data held within the external object store.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/boundary/1.1.15/docs/resources/storage_bucket#bucket_prefix StorageBucket#bucket_prefix}

descriptionOptional 
public readonly description: string;
  • Type: string

The storage bucket description.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/boundary/1.1.15/docs/resources/storage_bucket#description StorageBucket#description}

nameOptional 
public readonly name: string;
  • Type: string

The storage bucket name. Defaults to the resource name.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/boundary/1.1.15/docs/resources/storage_bucket#name StorageBucket#name}

pluginIdOptional 
public readonly pluginId: string;
  • Type: string

The ID of the plugin that should back the resource. This or plugin_name must be defined.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/boundary/1.1.15/docs/resources/storage_bucket#plugin_id StorageBucket#plugin_id}

pluginNameOptional 
public readonly pluginName: string;
  • Type: string

The name of the plugin that should back the resource. This or plugin_id must be defined.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/boundary/1.1.15/docs/resources/storage_bucket#plugin_name StorageBucket#plugin_name}

secretsJsonOptional 
public readonly secretsJson: string;
  • Type: string

The secrets for the storage bucket.

Either values encoded with the "jsonencode" function, pre-escaped JSON string, or a file:// or env:// path. Set to a string "null" to clear any existing values. NOTE: Unlike "attributes_json", removing this block will NOT clear secrets from the storage bucket; this allows injecting secrets for one call, then removing them for storage.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/boundary/1.1.15/docs/resources/storage_bucket#secrets_json StorageBucket#secrets_json}