Represents a {@link https://registry.terraform.io/providers/hashicorp/google-beta/6.15.0/docs/resources/google_filestore_backup google_filestore_backup}.
import { googleFilestoreBackup } from '@cdktf/provider-google-beta'
new googleFilestoreBackup.GoogleFilestoreBackup(scope: Construct, id: string, config: GoogleFilestoreBackupConfig)
Name | Type | Description |
---|---|---|
scope |
constructs.Construct |
The scope in which to define this construct. |
id |
string |
The scoped construct ID. |
config |
GoogleFilestoreBackupConfig |
No description. |
- Type: constructs.Construct
The scope in which to define this construct.
- Type: string
The scoped construct ID.
Must be unique amongst siblings in the same scope
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". |
putTimeouts |
No description. |
resetDescription |
No description. |
resetId |
No description. |
resetLabels |
No description. |
resetProject |
No description. |
resetTags |
No description. |
resetTimeouts |
No description. |
public toString(): string
Returns a string representation of this construct.
public addOverride(path: string, value: any): void
- Type: string
- Type: any
public overrideLogicalId(newLogicalId: string): void
Overrides the auto-generated logical ID with a specific ID.
- Type: string
The new logical ID to use for this stack element.
public resetOverrideLogicalId(): void
Resets a previously passed logical Id to use the auto-generated logical id again.
public toHclTerraform(): any
public toMetadata(): any
public toTerraform(): any
Adds this resource to the terraform JSON output.
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.
- Type: string
The string move target that will correspond to this resource.
public getAnyMapAttribute(terraformAttribute: string): {[ key: string ]: any}
- Type: string
public getBooleanAttribute(terraformAttribute: string): IResolvable
- Type: string
public getBooleanMapAttribute(terraformAttribute: string): {[ key: string ]: boolean}
- Type: string
public getListAttribute(terraformAttribute: string): string[]
- Type: string
public getNumberAttribute(terraformAttribute: string): number
- Type: string
public getNumberListAttribute(terraformAttribute: string): number[]
- Type: string
public getNumberMapAttribute(terraformAttribute: string): {[ key: string ]: number}
- Type: string
public getStringAttribute(terraformAttribute: string): string
- Type: string
public getStringMapAttribute(terraformAttribute: string): {[ key: string ]: string}
- Type: string
public hasResourceMove(): TerraformResourceMoveByTarget | TerraformResourceMoveById
public importFrom(id: string, provider?: TerraformProvider): void
- Type: string
- Type: cdktf.TerraformProvider
public interpolationForAttribute(terraformAttribute: string): IResolvable
- Type: string
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.
- Type: string
Full id of resource being moved from, e.g. "aws_s3_bucket.example".
public moveTo(moveTarget: string, index?: string | number): void
Moves this resource to the target resource given by moveTarget.
- Type: string
The previously set user defined string set by .addMoveTarget() corresponding to the resource to move to.
- Type: string | number
Optional The index corresponding to the key the resource is to appear in the foreach of a resource to move to.
public moveToId(id: string): void
Moves this resource to the resource corresponding to "id".
- Type: string
Full id of resource to move to, e.g. "aws_s3_bucket.example".
public putTimeouts(value: GoogleFilestoreBackupTimeouts): void
public resetDescription(): void
public resetId(): void
public resetLabels(): void
public resetProject(): void
public resetTags(): void
public resetTimeouts(): void
Name | Description |
---|---|
isConstruct |
Checks if x is a construct. |
isTerraformElement |
No description. |
isTerraformResource |
No description. |
generateConfigForImport |
Generates CDKTF code for importing a GoogleFilestoreBackup resource upon running "cdktf plan ". |
import { googleFilestoreBackup } from '@cdktf/provider-google-beta'
googleFilestoreBackup.GoogleFilestoreBackup.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.
- Type: any
Any object.
import { googleFilestoreBackup } from '@cdktf/provider-google-beta'
googleFilestoreBackup.GoogleFilestoreBackup.isTerraformElement(x: any)
- Type: any
import { googleFilestoreBackup } from '@cdktf/provider-google-beta'
googleFilestoreBackup.GoogleFilestoreBackup.isTerraformResource(x: any)
- Type: any
import { googleFilestoreBackup } from '@cdktf/provider-google-beta'
googleFilestoreBackup.GoogleFilestoreBackup.generateConfigForImport(scope: Construct, importToId: string, importFromId: string, provider?: TerraformProvider)
Generates CDKTF code for importing a GoogleFilestoreBackup resource upon running "cdktf plan ".
- Type: constructs.Construct
The scope in which to define this construct.
- Type: string
The construct id used in the generated config for the GoogleFilestoreBackup to import.
- Type: string
The id of the existing GoogleFilestoreBackup that should be imported.
Refer to the {@link https://registry.terraform.io/providers/hashicorp/google-beta/6.15.0/docs/resources/google_filestore_backup#import import section} in the documentation of this resource for the id to use
- Type: cdktf.TerraformProvider
? Optional instance of the provider where the GoogleFilestoreBackup to import is found.
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. |
capacityGb |
string |
No description. |
createTime |
string |
No description. |
downloadBytes |
string |
No description. |
effectiveLabels |
cdktf.StringMap |
No description. |
kmsKeyName |
string |
No description. |
sourceInstanceTier |
string |
No description. |
state |
string |
No description. |
storageBytes |
string |
No description. |
terraformLabels |
cdktf.StringMap |
No description. |
timeouts |
GoogleFilestoreBackupTimeoutsOutputReference |
No description. |
descriptionInput |
string |
No description. |
idInput |
string |
No description. |
labelsInput |
{[ key: string ]: string} |
No description. |
locationInput |
string |
No description. |
nameInput |
string |
No description. |
projectInput |
string |
No description. |
sourceFileShareInput |
string |
No description. |
sourceInstanceInput |
string |
No description. |
tagsInput |
{[ key: string ]: string} |
No description. |
timeoutsInput |
cdktf.IResolvable | GoogleFilestoreBackupTimeouts |
No description. |
description |
string |
No description. |
id |
string |
No description. |
labels |
{[ key: string ]: string} |
No description. |
location |
string |
No description. |
name |
string |
No description. |
project |
string |
No description. |
sourceFileShare |
string |
No description. |
sourceInstance |
string |
No description. |
tags |
{[ key: string ]: string} |
No description. |
public readonly node: Node;
- Type: constructs.Node
The tree node.
public readonly cdktfStack: TerraformStack;
- Type: cdktf.TerraformStack
public readonly fqn: string;
- Type: string
public readonly friendlyUniqueId: string;
- Type: string
public readonly terraformMetaArguments: {[ key: string ]: any};
- Type: {[ key: string ]: any}
public readonly terraformResourceType: string;
- Type: string
public readonly terraformGeneratorMetadata: TerraformProviderGeneratorMetadata;
- Type: cdktf.TerraformProviderGeneratorMetadata
public readonly connection: SSHProvisionerConnection | WinrmProvisionerConnection;
- Type: cdktf.SSHProvisionerConnection | cdktf.WinrmProvisionerConnection
public readonly count: number | TerraformCount;
- Type: number | cdktf.TerraformCount
public readonly dependsOn: string[];
- Type: string[]
public readonly forEach: ITerraformIterator;
- Type: cdktf.ITerraformIterator
public readonly lifecycle: TerraformResourceLifecycle;
- Type: cdktf.TerraformResourceLifecycle
public readonly provider: TerraformProvider;
- Type: cdktf.TerraformProvider
public readonly provisioners: FileProvisioner | LocalExecProvisioner | RemoteExecProvisioner[];
- Type: cdktf.FileProvisioner | cdktf.LocalExecProvisioner | cdktf.RemoteExecProvisioner[]
public readonly capacityGb: string;
- Type: string
public readonly createTime: string;
- Type: string
public readonly downloadBytes: string;
- Type: string
public readonly effectiveLabels: StringMap;
- Type: cdktf.StringMap
public readonly kmsKeyName: string;
- Type: string
public readonly sourceInstanceTier: string;
- Type: string
public readonly state: string;
- Type: string
public readonly storageBytes: string;
- Type: string
public readonly terraformLabels: StringMap;
- Type: cdktf.StringMap
public readonly timeouts: GoogleFilestoreBackupTimeoutsOutputReference;
public readonly descriptionInput: string;
- Type: string
public readonly idInput: string;
- Type: string
public readonly labelsInput: {[ key: string ]: string};
- Type: {[ key: string ]: string}
public readonly locationInput: string;
- Type: string
public readonly nameInput: string;
- Type: string
public readonly projectInput: string;
- Type: string
public readonly sourceFileShareInput: string;
- Type: string
public readonly sourceInstanceInput: string;
- Type: string
public readonly tagsInput: {[ key: string ]: string};
- Type: {[ key: string ]: string}
public readonly timeoutsInput: IResolvable | GoogleFilestoreBackupTimeouts;
- Type: cdktf.IResolvable | GoogleFilestoreBackupTimeouts
public readonly description: string;
- Type: string
public readonly id: string;
- Type: string
public readonly labels: {[ key: string ]: string};
- Type: {[ key: string ]: string}
public readonly location: string;
- Type: string
public readonly name: string;
- Type: string
public readonly project: string;
- Type: string
public readonly sourceFileShare: string;
- Type: string
public readonly sourceInstance: string;
- Type: string
public readonly tags: {[ key: string ]: string};
- Type: {[ key: string ]: string}
Name | Type | Description |
---|---|---|
tfResourceType |
string |
No description. |
public readonly tfResourceType: string;
- Type: string
import { googleFilestoreBackup } from '@cdktf/provider-google-beta'
const googleFilestoreBackupConfig: googleFilestoreBackup.GoogleFilestoreBackupConfig = { ... }
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. |
location |
string |
The name of the location of the instance. This can be a region for ENTERPRISE tier instances. |
name |
string |
The resource name of the backup. The name must be unique within the specified instance. |
sourceFileShare |
string |
Name of the file share in the source Cloud Filestore instance that the backup is created from. |
sourceInstance |
string |
The resource name of the source Cloud Filestore instance, in the format projects/{projectId}/locations/{locationId}/instances/{instanceId}, used to create this backup. |
description |
string |
A description of the backup with 2048 characters or less. Requests with longer descriptions will be rejected. |
id |
string |
Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google-beta/6.15.0/docs/resources/google_filestore_backup#id GoogleFilestoreBackup#id}. |
labels |
{[ key: string ]: string} |
Resource labels to represent user-provided metadata. |
project |
string |
Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google-beta/6.15.0/docs/resources/google_filestore_backup#project GoogleFilestoreBackup#project}. |
tags |
{[ key: string ]: string} |
A map of resource manager tags. |
timeouts |
GoogleFilestoreBackupTimeouts |
timeouts block. |
public readonly connection: SSHProvisionerConnection | WinrmProvisionerConnection;
- Type: cdktf.SSHProvisionerConnection | cdktf.WinrmProvisionerConnection
public readonly count: number | TerraformCount;
- Type: number | cdktf.TerraformCount
public readonly dependsOn: ITerraformDependable[];
- Type: cdktf.ITerraformDependable[]
public readonly forEach: ITerraformIterator;
- Type: cdktf.ITerraformIterator
public readonly lifecycle: TerraformResourceLifecycle;
- Type: cdktf.TerraformResourceLifecycle
public readonly provider: TerraformProvider;
- Type: cdktf.TerraformProvider
public readonly provisioners: FileProvisioner | LocalExecProvisioner | RemoteExecProvisioner[];
- Type: cdktf.FileProvisioner | cdktf.LocalExecProvisioner | cdktf.RemoteExecProvisioner[]
public readonly location: string;
- Type: string
The name of the location of the instance. This can be a region for ENTERPRISE tier instances.
Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google-beta/6.15.0/docs/resources/google_filestore_backup#location GoogleFilestoreBackup#location}
public readonly name: string;
- Type: string
The resource name of the backup. The name must be unique within the specified instance.
The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression 'a-z?' which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.
Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google-beta/6.15.0/docs/resources/google_filestore_backup#name GoogleFilestoreBackup#name}
public readonly sourceFileShare: string;
- Type: string
Name of the file share in the source Cloud Filestore instance that the backup is created from.
Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google-beta/6.15.0/docs/resources/google_filestore_backup#source_file_share GoogleFilestoreBackup#source_file_share}
public readonly sourceInstance: string;
- Type: string
The resource name of the source Cloud Filestore instance, in the format projects/{projectId}/locations/{locationId}/instances/{instanceId}, used to create this backup.
Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google-beta/6.15.0/docs/resources/google_filestore_backup#source_instance GoogleFilestoreBackup#source_instance}
public readonly description: string;
- Type: string
A description of the backup with 2048 characters or less. Requests with longer descriptions will be rejected.
Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google-beta/6.15.0/docs/resources/google_filestore_backup#description GoogleFilestoreBackup#description}
public readonly id: string;
- Type: string
Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google-beta/6.15.0/docs/resources/google_filestore_backup#id GoogleFilestoreBackup#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.
public readonly labels: {[ key: string ]: string};
- Type: {[ key: string ]: string}
Resource labels to represent user-provided metadata.
Note: This field is non-authoritative, and will only manage the labels present in your configuration. Please refer to the field 'effective_labels' for all of the labels present on the resource.
Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google-beta/6.15.0/docs/resources/google_filestore_backup#labels GoogleFilestoreBackup#labels}
public readonly project: string;
- Type: string
Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google-beta/6.15.0/docs/resources/google_filestore_backup#project GoogleFilestoreBackup#project}.
public readonly tags: {[ key: string ]: string};
- Type: {[ key: string ]: string}
A map of resource manager tags.
Resource manager tag keys and values have the same definition as resource manager tags. Keys must be in the format tagKeys/{tag_key_id}, and values are in the format tagValues/{tag_value_id}. The field is ignored (both PUT & PATCH) when empty.
Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google-beta/6.15.0/docs/resources/google_filestore_backup#tags GoogleFilestoreBackup#tags}
public readonly timeouts: GoogleFilestoreBackupTimeouts;
timeouts block.
Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google-beta/6.15.0/docs/resources/google_filestore_backup#timeouts GoogleFilestoreBackup#timeouts}
import { googleFilestoreBackup } from '@cdktf/provider-google-beta'
const googleFilestoreBackupTimeouts: googleFilestoreBackup.GoogleFilestoreBackupTimeouts = { ... }
Name | Type | Description |
---|---|---|
create |
string |
Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google-beta/6.15.0/docs/resources/google_filestore_backup#create GoogleFilestoreBackup#create}. |
delete |
string |
Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google-beta/6.15.0/docs/resources/google_filestore_backup#delete GoogleFilestoreBackup#delete}. |
update |
string |
Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google-beta/6.15.0/docs/resources/google_filestore_backup#update GoogleFilestoreBackup#update}. |
public readonly create: string;
- Type: string
Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google-beta/6.15.0/docs/resources/google_filestore_backup#create GoogleFilestoreBackup#create}.
public readonly delete: string;
- Type: string
Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google-beta/6.15.0/docs/resources/google_filestore_backup#delete GoogleFilestoreBackup#delete}.
public readonly update: string;
- Type: string
Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google-beta/6.15.0/docs/resources/google_filestore_backup#update GoogleFilestoreBackup#update}.
import { googleFilestoreBackup } from '@cdktf/provider-google-beta'
new googleFilestoreBackup.GoogleFilestoreBackupTimeoutsOutputReference(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. |
- Type: cdktf.IInterpolatingParent
The parent resource.
- Type: string
The attribute on the parent resource this class is referencing.
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. |
resetCreate |
No description. |
resetDelete |
No description. |
resetUpdate |
No description. |
public computeFqn(): string
public getAnyMapAttribute(terraformAttribute: string): {[ key: string ]: any}
- Type: string
public getBooleanAttribute(terraformAttribute: string): IResolvable
- Type: string
public getBooleanMapAttribute(terraformAttribute: string): {[ key: string ]: boolean}
- Type: string
public getListAttribute(terraformAttribute: string): string[]
- Type: string
public getNumberAttribute(terraformAttribute: string): number
- Type: string
public getNumberListAttribute(terraformAttribute: string): number[]
- Type: string
public getNumberMapAttribute(terraformAttribute: string): {[ key: string ]: number}
- Type: string
public getStringAttribute(terraformAttribute: string): string
- Type: string
public getStringMapAttribute(terraformAttribute: string): {[ key: string ]: string}
- Type: string
public interpolationForAttribute(property: string): IResolvable
- Type: string
public resolve(_context: IResolveContext): any
Produce the Token's value at resolution time.
- Type: cdktf.IResolveContext
public toString(): string
Return a string representation of this resolvable object.
Returns a reversible string representation.
public resetCreate(): void
public resetDelete(): void
public resetUpdate(): void
Name | Type | Description |
---|---|---|
creationStack |
string[] |
The creation stack of this resolvable which will be appended to errors thrown during resolution. |
fqn |
string |
No description. |
createInput |
string |
No description. |
deleteInput |
string |
No description. |
updateInput |
string |
No description. |
create |
string |
No description. |
delete |
string |
No description. |
update |
string |
No description. |
internalValue |
cdktf.IResolvable | GoogleFilestoreBackupTimeouts |
No description. |
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.
public readonly fqn: string;
- Type: string
public readonly createInput: string;
- Type: string
public readonly deleteInput: string;
- Type: string
public readonly updateInput: string;
- Type: string
public readonly create: string;
- Type: string
public readonly delete: string;
- Type: string
public readonly update: string;
- Type: string
public readonly internalValue: IResolvable | GoogleFilestoreBackupTimeouts;
- Type: cdktf.IResolvable | GoogleFilestoreBackupTimeouts