Initializers
| Name | Type | Description |
|---|---|---|
scope | constructs.Construct | No description. |
id | str | No description. |
defaults | typing.Mapping[typing.Any] | No description. |
workspace | str | No description. |
bucket | str | (Required) The name of the GCS bucket. |
access_token | str | (Optional) A temporary [OAuth 2.0 access token] obtained from the Google Authorization server, i.e. the Authorization: Bearer token used to authenticate HTTP requests to GCP APIs. This is an alternative to credentials. If both are specified, access_token will be used over the credentials field. |
credentials | str | (Optional) Local path to Google Cloud Platform account credentials in JSON format. |
encryption_key | str | (Optional) A 32 byte base64 encoded ‘customer supplied encryption key’ used to encrypt all state. |
impersonate_service_account | str | (Optional) The service account to impersonate for accessing the State Bucket. |
impersonate_service_account_delegates | typing.List[str] | (Optional) The delegation chain for an impersonating a service account. |
kms_encryption_key | str | (Optional) A Cloud KMS key (‘customer-managed encryption key’) used when reading and writing state files in the bucket. |
prefix | str | (Optional) GCS prefix inside the bucket. |
storeage_custom_endpoint | str | (Optional) A URL containing three parts: the protocol, the DNS name pointing to a Private Service Connect endpoint, and the path for the Cloud Storage API (/storage/v1/b). |
scopeRequired
- Type: constructs.Construct
idRequired
- Type: str
defaultsOptional
- Type: typing.Mapping[typing.Any]
workspaceOptional
- Type: str
bucketRequired
- Type: str
access_tokenOptional
- Type: str
credentialsOptional
- Type: str
encryption_keyOptional
- Type: str
impersonate_service_accountOptional
- Type: str
impersonate_service_account_delegatesOptional
- Type: typing.List[str]
kms_encryption_keyOptional
- Type: str
prefixOptional
- Type: str
storeage_custom_endpointOptional
- Type: str
Methods
| Name | Description |
|---|---|
to_string | Returns a string representation of this construct. |
add_override | No description. |
override_logical_id | Overrides the auto-generated logical ID with a specific ID. |
reset_override_logical_id | Resets a previously passed logical Id to use the auto-generated logical id again. |
to_hcl_terraform | Adds this resource to the terraform JSON output. |
to_metadata | No description. |
to_terraform | Adds this resource to the terraform JSON output. |
get | No description. |
get_boolean | No description. |
get_list | No description. |
get_number | No description. |
get_string | No description. |
to_string
add_override
pathRequired
- Type: str
valueRequired
- Type: typing.Any
override_logical_id
new_logical_idRequired
- Type: str
reset_override_logical_id
to_hcl_terraform
to_metadata
to_terraform
get
outputRequired
- Type: str
get_boolean
outputRequired
- Type: str
get_list
outputRequired
- Type: str
get_number
outputRequired
- Type: str
get_string
outputRequired
- Type: str
Static Functions
| Name | Description |
|---|---|
is_construct | Checks if x is a construct. |
is_terraform_element | No description. |
is_construct
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: typing.Any
is_terraform_element
xRequired
- Type: typing.Any
Properties
| Name | Type | Description |
|---|---|---|
node | constructs.Node | The tree node. |
cdktf_stack | TerraformStack | No description. |
fqn | str | No description. |
friendly_unique_id | str | No description. |
nodeRequired
- Type: constructs.Node
cdktf_stackRequired
- Type: TerraformStack
fqnRequired
- Type: str
friendly_unique_idRequired
- Type: str
Constants
| Name | Type | Description |
|---|---|---|
tfResourceType | str | No description. |
tfResourceTypeRequired
- Type: str