@cdktf/provider-google
Version:
Prebuilt google Provider for Terraform CDK (cdktf)
220 lines (219 loc) • 11 kB
TypeScript
/**
* Copyright (c) HashiCorp, Inc.
* SPDX-License-Identifier: MPL-2.0
*/
import { Construct } from 'constructs';
import * as cdktf from 'cdktf';
export interface ParameterManagerParameterConfig extends cdktf.TerraformMetaArguments {
/**
* The format type of the parameter resource. Default value: "UNFORMATTED" Possible values: ["UNFORMATTED", "YAML", "JSON"]
*
* Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.36.0/docs/resources/parameter_manager_parameter#format ParameterManagerParameter#format}
*/
readonly format?: string;
/**
* Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.36.0/docs/resources/parameter_manager_parameter#id ParameterManagerParameter#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.
*/
readonly id?: string;
/**
* The resource name of the Cloud KMS CryptoKey used to encrypt parameter version payload. Format
* 'projects/{{project}}/locations/global/keyRings/{{key_ring}}/cryptoKeys/{{crypto_key}}'
*
* Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.36.0/docs/resources/parameter_manager_parameter#kms_key ParameterManagerParameter#kms_key}
*/
readonly kmsKey?: string;
/**
* The labels assigned to this Parameter.
*
* Label keys must be between 1 and 63 characters long, have a UTF-8 encoding of maximum 128 bytes,
* and must conform to the following PCRE regular expression: [\p{Ll}\p{Lo}][\p{Ll}\p{Lo}\p{N}_-]{0,62}
*
* Label values must be between 0 and 63 characters long, have a UTF-8 encoding of maximum 128 bytes,
* and must conform to the following PCRE regular expression: [\p{Ll}\p{Lo}\p{N}_-]{0,63}
*
* No more than 64 labels can be assigned to a given resource.
*
* An object containing a list of "key": value pairs. Example:
* { "name": "wrench", "mass": "1.3kg", "count": "3" }.
*
*
* **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/6.36.0/docs/resources/parameter_manager_parameter#labels ParameterManagerParameter#labels}
*/
readonly labels?: {
[key: string]: string;
};
/**
* This must be unique within the project.
*
* Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.36.0/docs/resources/parameter_manager_parameter#parameter_id ParameterManagerParameter#parameter_id}
*/
readonly parameterId: string;
/**
* Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.36.0/docs/resources/parameter_manager_parameter#project ParameterManagerParameter#project}
*/
readonly project?: string;
/**
* timeouts block
*
* Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.36.0/docs/resources/parameter_manager_parameter#timeouts ParameterManagerParameter#timeouts}
*/
readonly timeouts?: ParameterManagerParameterTimeouts;
}
export interface ParameterManagerParameterPolicyMember {
}
export declare function parameterManagerParameterPolicyMemberToTerraform(struct?: ParameterManagerParameterPolicyMember): any;
export declare function parameterManagerParameterPolicyMemberToHclTerraform(struct?: ParameterManagerParameterPolicyMember): any;
export declare class ParameterManagerParameterPolicyMemberOutputReference extends cdktf.ComplexObject {
private isEmptyObject;
/**
* @param terraformResource The parent resource
* @param terraformAttribute The attribute on the parent resource this class is referencing
* @param complexObjectIndex the index of this item in the list
* @param complexObjectIsFromSet whether the list is wrapping a set (will add tolist() to be able to access an item via an index)
*/
constructor(terraformResource: cdktf.IInterpolatingParent, terraformAttribute: string, complexObjectIndex: number, complexObjectIsFromSet: boolean);
get internalValue(): ParameterManagerParameterPolicyMember | undefined;
set internalValue(value: ParameterManagerParameterPolicyMember | undefined);
get iamPolicyNamePrincipal(): string;
get iamPolicyUidPrincipal(): string;
}
export declare class ParameterManagerParameterPolicyMemberList extends cdktf.ComplexList {
protected terraformResource: cdktf.IInterpolatingParent;
protected terraformAttribute: string;
protected wrapsSet: boolean;
/**
* @param terraformResource The parent resource
* @param terraformAttribute The attribute on the parent resource this class is referencing
* @param wrapsSet whether the list is wrapping a set (will add tolist() to be able to access an item via an index)
*/
constructor(terraformResource: cdktf.IInterpolatingParent, terraformAttribute: string, wrapsSet: boolean);
/**
* @param index the index of the item to return
*/
get(index: number): ParameterManagerParameterPolicyMemberOutputReference;
}
export interface ParameterManagerParameterTimeouts {
/**
* Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.36.0/docs/resources/parameter_manager_parameter#create ParameterManagerParameter#create}
*/
readonly create?: string;
/**
* Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.36.0/docs/resources/parameter_manager_parameter#delete ParameterManagerParameter#delete}
*/
readonly delete?: string;
/**
* Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.36.0/docs/resources/parameter_manager_parameter#update ParameterManagerParameter#update}
*/
readonly update?: string;
}
export declare function parameterManagerParameterTimeoutsToTerraform(struct?: ParameterManagerParameterTimeouts | cdktf.IResolvable): any;
export declare function parameterManagerParameterTimeoutsToHclTerraform(struct?: ParameterManagerParameterTimeouts | cdktf.IResolvable): any;
export declare class ParameterManagerParameterTimeoutsOutputReference extends cdktf.ComplexObject {
private isEmptyObject;
private resolvableValue?;
/**
* @param terraformResource The parent resource
* @param terraformAttribute The attribute on the parent resource this class is referencing
*/
constructor(terraformResource: cdktf.IInterpolatingParent, terraformAttribute: string);
get internalValue(): ParameterManagerParameterTimeouts | cdktf.IResolvable | undefined;
set internalValue(value: ParameterManagerParameterTimeouts | cdktf.IResolvable | undefined);
private _create?;
get create(): string;
set create(value: string);
resetCreate(): void;
get createInput(): string | undefined;
private _delete?;
get delete(): string;
set delete(value: string);
resetDelete(): void;
get deleteInput(): string | undefined;
private _update?;
get update(): string;
set update(value: string);
resetUpdate(): void;
get updateInput(): string | undefined;
}
/**
* Represents a {@link https://registry.terraform.io/providers/hashicorp/google/6.36.0/docs/resources/parameter_manager_parameter google_parameter_manager_parameter}
*/
export declare class ParameterManagerParameter extends cdktf.TerraformResource {
static readonly tfResourceType = "google_parameter_manager_parameter";
/**
* Generates CDKTF code for importing a ParameterManagerParameter resource upon running "cdktf plan <stack-name>"
* @param scope The scope in which to define this construct
* @param importToId The construct id used in the generated config for the ParameterManagerParameter to import
* @param importFromId The id of the existing ParameterManagerParameter that should be imported. Refer to the {@link https://registry.terraform.io/providers/hashicorp/google/6.36.0/docs/resources/parameter_manager_parameter#import import section} in the documentation of this resource for the id to use
* @param provider? Optional instance of the provider where the ParameterManagerParameter to import is found
*/
static generateConfigForImport(scope: Construct, importToId: string, importFromId: string, provider?: cdktf.TerraformProvider): cdktf.ImportableResource;
/**
* Create a new {@link https://registry.terraform.io/providers/hashicorp/google/6.36.0/docs/resources/parameter_manager_parameter google_parameter_manager_parameter} Resource
*
* @param scope The scope in which to define this construct
* @param id The scoped construct ID. Must be unique amongst siblings in the same scope
* @param options ParameterManagerParameterConfig
*/
constructor(scope: Construct, id: string, config: ParameterManagerParameterConfig);
get createTime(): string;
private _effectiveLabels;
get effectiveLabels(): cdktf.StringMap;
private _format?;
get format(): string;
set format(value: string);
resetFormat(): void;
get formatInput(): string | undefined;
private _id?;
get id(): string;
set id(value: string);
resetId(): void;
get idInput(): string | undefined;
private _kmsKey?;
get kmsKey(): string;
set kmsKey(value: string);
resetKmsKey(): void;
get kmsKeyInput(): string | undefined;
private _labels?;
get labels(): {
[key: string]: string;
};
set labels(value: {
[key: string]: string;
});
resetLabels(): void;
get labelsInput(): {
[key: string]: string;
} | undefined;
get name(): string;
private _parameterId?;
get parameterId(): string;
set parameterId(value: string);
get parameterIdInput(): string | undefined;
private _policyMember;
get policyMember(): ParameterManagerParameterPolicyMemberList;
private _project?;
get project(): string;
set project(value: string);
resetProject(): void;
get projectInput(): string | undefined;
private _terraformLabels;
get terraformLabels(): cdktf.StringMap;
get updateTime(): string;
private _timeouts;
get timeouts(): ParameterManagerParameterTimeoutsOutputReference;
putTimeouts(value: ParameterManagerParameterTimeouts): void;
resetTimeouts(): void;
get timeoutsInput(): cdktf.IResolvable | ParameterManagerParameterTimeouts | undefined;
protected synthesizeAttributes(): {
[name: string]: any;
};
protected synthesizeHclAttributes(): {
[name: string]: any;
};
}