@cdktf/provider-google
Version:
Prebuilt google Provider for Terraform CDK (cdktf)
149 lines (148 loc) • 7.16 kB
TypeScript
/**
* Copyright (c) HashiCorp, Inc.
* SPDX-License-Identifier: MPL-2.0
*/
import { Construct } from 'constructs';
import * as cdktf from 'cdktf';
export interface PubsubSchemaConfig extends cdktf.TerraformMetaArguments {
/**
* The definition of the schema.
* This should contain a string representing the full definition of the schema
* that is a valid schema definition of the type specified in type. Changes
* to the definition commit new [schema revisions](https://cloud.google.com/pubsub/docs/commit-schema-revision).
* A schema can only have up to 20 revisions, so updates that fail with an
* error indicating that the limit has been reached require manually
* [deleting old revisions](https://cloud.google.com/pubsub/docs/delete-schema-revision).
*
* Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.13.0/docs/resources/pubsub_schema#definition PubsubSchema#definition}
*/
readonly definition?: string;
/**
* Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.13.0/docs/resources/pubsub_schema#id PubsubSchema#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 ID to use for the schema, which will become the final component of the schema's resource name.
*
* Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.13.0/docs/resources/pubsub_schema#name PubsubSchema#name}
*/
readonly name: string;
/**
* Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.13.0/docs/resources/pubsub_schema#project PubsubSchema#project}
*/
readonly project?: string;
/**
* The type of the schema definition Default value: "TYPE_UNSPECIFIED" Possible values: ["TYPE_UNSPECIFIED", "PROTOCOL_BUFFER", "AVRO"]
*
* Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.13.0/docs/resources/pubsub_schema#type PubsubSchema#type}
*/
readonly type?: string;
/**
* timeouts block
*
* Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.13.0/docs/resources/pubsub_schema#timeouts PubsubSchema#timeouts}
*/
readonly timeouts?: PubsubSchemaTimeouts;
}
export interface PubsubSchemaTimeouts {
/**
* Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.13.0/docs/resources/pubsub_schema#create PubsubSchema#create}
*/
readonly create?: string;
/**
* Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.13.0/docs/resources/pubsub_schema#delete PubsubSchema#delete}
*/
readonly delete?: string;
/**
* Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.13.0/docs/resources/pubsub_schema#update PubsubSchema#update}
*/
readonly update?: string;
}
export declare function pubsubSchemaTimeoutsToTerraform(struct?: PubsubSchemaTimeouts | cdktf.IResolvable): any;
export declare function pubsubSchemaTimeoutsToHclTerraform(struct?: PubsubSchemaTimeouts | cdktf.IResolvable): any;
export declare class PubsubSchemaTimeoutsOutputReference 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(): PubsubSchemaTimeouts | cdktf.IResolvable | undefined;
set internalValue(value: PubsubSchemaTimeouts | 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.13.0/docs/resources/pubsub_schema google_pubsub_schema}
*/
export declare class PubsubSchema extends cdktf.TerraformResource {
static readonly tfResourceType = "google_pubsub_schema";
/**
* Generates CDKTF code for importing a PubsubSchema 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 PubsubSchema to import
* @param importFromId The id of the existing PubsubSchema that should be imported. Refer to the {@link https://registry.terraform.io/providers/hashicorp/google/6.13.0/docs/resources/pubsub_schema#import import section} in the documentation of this resource for the id to use
* @param provider? Optional instance of the provider where the PubsubSchema 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.13.0/docs/resources/pubsub_schema google_pubsub_schema} 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 PubsubSchemaConfig
*/
constructor(scope: Construct, id: string, config: PubsubSchemaConfig);
private _definition?;
get definition(): string;
set definition(value: string);
resetDefinition(): void;
get definitionInput(): string | undefined;
private _id?;
get id(): string;
set id(value: string);
resetId(): void;
get idInput(): string | undefined;
private _name?;
get name(): string;
set name(value: string);
get nameInput(): string | undefined;
private _project?;
get project(): string;
set project(value: string);
resetProject(): void;
get projectInput(): string | undefined;
private _type?;
get type(): string;
set type(value: string);
resetType(): void;
get typeInput(): string | undefined;
private _timeouts;
get timeouts(): PubsubSchemaTimeoutsOutputReference;
putTimeouts(value: PubsubSchemaTimeouts): void;
resetTimeouts(): void;
get timeoutsInput(): cdktf.IResolvable | PubsubSchemaTimeouts | undefined;
protected synthesizeAttributes(): {
[name: string]: any;
};
protected synthesizeHclAttributes(): {
[name: string]: any;
};
}