@cdktf/provider-aws
Version:
Prebuilt aws Provider for Terraform CDK (cdktf)
108 lines (107 loc) • 5.14 kB
TypeScript
/**
* Copyright (c) HashiCorp, Inc.
* SPDX-License-Identifier: MPL-2.0
*/
import { Construct } from 'constructs';
import * as cdktf from 'cdktf';
export interface ApiGatewayGatewayResponseConfig extends cdktf.TerraformMetaArguments {
/**
* Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.84.0/docs/resources/api_gateway_gateway_response#id ApiGatewayGatewayResponse#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;
/**
* Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.84.0/docs/resources/api_gateway_gateway_response#response_parameters ApiGatewayGatewayResponse#response_parameters}
*/
readonly responseParameters?: {
[key: string]: string;
};
/**
* Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.84.0/docs/resources/api_gateway_gateway_response#response_templates ApiGatewayGatewayResponse#response_templates}
*/
readonly responseTemplates?: {
[key: string]: string;
};
/**
* Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.84.0/docs/resources/api_gateway_gateway_response#response_type ApiGatewayGatewayResponse#response_type}
*/
readonly responseType: string;
/**
* Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.84.0/docs/resources/api_gateway_gateway_response#rest_api_id ApiGatewayGatewayResponse#rest_api_id}
*/
readonly restApiId: string;
/**
* Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.84.0/docs/resources/api_gateway_gateway_response#status_code ApiGatewayGatewayResponse#status_code}
*/
readonly statusCode?: string;
}
/**
* Represents a {@link https://registry.terraform.io/providers/hashicorp/aws/5.84.0/docs/resources/api_gateway_gateway_response aws_api_gateway_gateway_response}
*/
export declare class ApiGatewayGatewayResponse extends cdktf.TerraformResource {
static readonly tfResourceType = "aws_api_gateway_gateway_response";
/**
* Generates CDKTF code for importing a ApiGatewayGatewayResponse 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 ApiGatewayGatewayResponse to import
* @param importFromId The id of the existing ApiGatewayGatewayResponse that should be imported. Refer to the {@link https://registry.terraform.io/providers/hashicorp/aws/5.84.0/docs/resources/api_gateway_gateway_response#import import section} in the documentation of this resource for the id to use
* @param provider? Optional instance of the provider where the ApiGatewayGatewayResponse 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/aws/5.84.0/docs/resources/api_gateway_gateway_response aws_api_gateway_gateway_response} 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 ApiGatewayGatewayResponseConfig
*/
constructor(scope: Construct, id: string, config: ApiGatewayGatewayResponseConfig);
private _id?;
get id(): string;
set id(value: string);
resetId(): void;
get idInput(): string | undefined;
private _responseParameters?;
get responseParameters(): {
[key: string]: string;
};
set responseParameters(value: {
[key: string]: string;
});
resetResponseParameters(): void;
get responseParametersInput(): {
[key: string]: string;
} | undefined;
private _responseTemplates?;
get responseTemplates(): {
[key: string]: string;
};
set responseTemplates(value: {
[key: string]: string;
});
resetResponseTemplates(): void;
get responseTemplatesInput(): {
[key: string]: string;
} | undefined;
private _responseType?;
get responseType(): string;
set responseType(value: string);
get responseTypeInput(): string | undefined;
private _restApiId?;
get restApiId(): string;
set restApiId(value: string);
get restApiIdInput(): string | undefined;
private _statusCode?;
get statusCode(): string;
set statusCode(value: string);
resetStatusCode(): void;
get statusCodeInput(): string | undefined;
protected synthesizeAttributes(): {
[name: string]: any;
};
protected synthesizeHclAttributes(): {
[name: string]: any;
};
}