@cdktf/provider-aws
Version:
Prebuilt aws Provider for Terraform CDK (cdktf)
235 lines (234 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 ApiGatewayRestApiConfig extends cdktf.TerraformMetaArguments {
/**
* Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.84.0/docs/resources/api_gateway_rest_api#api_key_source ApiGatewayRestApi#api_key_source}
*/
readonly apiKeySource?: string;
/**
* Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.84.0/docs/resources/api_gateway_rest_api#binary_media_types ApiGatewayRestApi#binary_media_types}
*/
readonly binaryMediaTypes?: string[];
/**
* Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.84.0/docs/resources/api_gateway_rest_api#body ApiGatewayRestApi#body}
*/
readonly body?: string;
/**
* Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.84.0/docs/resources/api_gateway_rest_api#description ApiGatewayRestApi#description}
*/
readonly description?: string;
/**
* Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.84.0/docs/resources/api_gateway_rest_api#disable_execute_api_endpoint ApiGatewayRestApi#disable_execute_api_endpoint}
*/
readonly disableExecuteApiEndpoint?: boolean | cdktf.IResolvable;
/**
* Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.84.0/docs/resources/api_gateway_rest_api#fail_on_warnings ApiGatewayRestApi#fail_on_warnings}
*/
readonly failOnWarnings?: boolean | cdktf.IResolvable;
/**
* Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.84.0/docs/resources/api_gateway_rest_api#id ApiGatewayRestApi#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_rest_api#minimum_compression_size ApiGatewayRestApi#minimum_compression_size}
*/
readonly minimumCompressionSize?: string;
/**
* Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.84.0/docs/resources/api_gateway_rest_api#name ApiGatewayRestApi#name}
*/
readonly name: string;
/**
* Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.84.0/docs/resources/api_gateway_rest_api#parameters ApiGatewayRestApi#parameters}
*/
readonly parameters?: {
[key: string]: string;
};
/**
* Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.84.0/docs/resources/api_gateway_rest_api#policy ApiGatewayRestApi#policy}
*/
readonly policy?: string;
/**
* Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.84.0/docs/resources/api_gateway_rest_api#put_rest_api_mode ApiGatewayRestApi#put_rest_api_mode}
*/
readonly putRestApiMode?: string;
/**
* Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.84.0/docs/resources/api_gateway_rest_api#tags ApiGatewayRestApi#tags}
*/
readonly tags?: {
[key: string]: string;
};
/**
* Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.84.0/docs/resources/api_gateway_rest_api#tags_all ApiGatewayRestApi#tags_all}
*/
readonly tagsAll?: {
[key: string]: string;
};
/**
* endpoint_configuration block
*
* Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.84.0/docs/resources/api_gateway_rest_api#endpoint_configuration ApiGatewayRestApi#endpoint_configuration}
*/
readonly endpointConfiguration?: ApiGatewayRestApiEndpointConfiguration;
}
export interface ApiGatewayRestApiEndpointConfiguration {
/**
* Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.84.0/docs/resources/api_gateway_rest_api#types ApiGatewayRestApi#types}
*/
readonly types: string[];
/**
* Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.84.0/docs/resources/api_gateway_rest_api#vpc_endpoint_ids ApiGatewayRestApi#vpc_endpoint_ids}
*/
readonly vpcEndpointIds?: string[];
}
export declare function apiGatewayRestApiEndpointConfigurationToTerraform(struct?: ApiGatewayRestApiEndpointConfigurationOutputReference | ApiGatewayRestApiEndpointConfiguration): any;
export declare function apiGatewayRestApiEndpointConfigurationToHclTerraform(struct?: ApiGatewayRestApiEndpointConfigurationOutputReference | ApiGatewayRestApiEndpointConfiguration): any;
export declare class ApiGatewayRestApiEndpointConfigurationOutputReference extends cdktf.ComplexObject {
private isEmptyObject;
/**
* @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(): ApiGatewayRestApiEndpointConfiguration | undefined;
set internalValue(value: ApiGatewayRestApiEndpointConfiguration | undefined);
private _types?;
get types(): string[];
set types(value: string[]);
get typesInput(): string[] | undefined;
private _vpcEndpointIds?;
get vpcEndpointIds(): string[];
set vpcEndpointIds(value: string[]);
resetVpcEndpointIds(): void;
get vpcEndpointIdsInput(): string[] | undefined;
}
/**
* Represents a {@link https://registry.terraform.io/providers/hashicorp/aws/5.84.0/docs/resources/api_gateway_rest_api aws_api_gateway_rest_api}
*/
export declare class ApiGatewayRestApi extends cdktf.TerraformResource {
static readonly tfResourceType = "aws_api_gateway_rest_api";
/**
* Generates CDKTF code for importing a ApiGatewayRestApi 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 ApiGatewayRestApi to import
* @param importFromId The id of the existing ApiGatewayRestApi that should be imported. Refer to the {@link https://registry.terraform.io/providers/hashicorp/aws/5.84.0/docs/resources/api_gateway_rest_api#import import section} in the documentation of this resource for the id to use
* @param provider? Optional instance of the provider where the ApiGatewayRestApi 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_rest_api aws_api_gateway_rest_api} 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 ApiGatewayRestApiConfig
*/
constructor(scope: Construct, id: string, config: ApiGatewayRestApiConfig);
private _apiKeySource?;
get apiKeySource(): string;
set apiKeySource(value: string);
resetApiKeySource(): void;
get apiKeySourceInput(): string | undefined;
get arn(): string;
private _binaryMediaTypes?;
get binaryMediaTypes(): string[];
set binaryMediaTypes(value: string[]);
resetBinaryMediaTypes(): void;
get binaryMediaTypesInput(): string[] | undefined;
private _body?;
get body(): string;
set body(value: string);
resetBody(): void;
get bodyInput(): string | undefined;
get createdDate(): string;
private _description?;
get description(): string;
set description(value: string);
resetDescription(): void;
get descriptionInput(): string | undefined;
private _disableExecuteApiEndpoint?;
get disableExecuteApiEndpoint(): boolean | cdktf.IResolvable;
set disableExecuteApiEndpoint(value: boolean | cdktf.IResolvable);
resetDisableExecuteApiEndpoint(): void;
get disableExecuteApiEndpointInput(): boolean | cdktf.IResolvable | undefined;
get executionArn(): string;
private _failOnWarnings?;
get failOnWarnings(): boolean | cdktf.IResolvable;
set failOnWarnings(value: boolean | cdktf.IResolvable);
resetFailOnWarnings(): void;
get failOnWarningsInput(): boolean | cdktf.IResolvable | undefined;
private _id?;
get id(): string;
set id(value: string);
resetId(): void;
get idInput(): string | undefined;
private _minimumCompressionSize?;
get minimumCompressionSize(): string;
set minimumCompressionSize(value: string);
resetMinimumCompressionSize(): void;
get minimumCompressionSizeInput(): string | undefined;
private _name?;
get name(): string;
set name(value: string);
get nameInput(): string | undefined;
private _parameters?;
get parameters(): {
[key: string]: string;
};
set parameters(value: {
[key: string]: string;
});
resetParameters(): void;
get parametersInput(): {
[key: string]: string;
} | undefined;
private _policy?;
get policy(): string;
set policy(value: string);
resetPolicy(): void;
get policyInput(): string | undefined;
private _putRestApiMode?;
get putRestApiMode(): string;
set putRestApiMode(value: string);
resetPutRestApiMode(): void;
get putRestApiModeInput(): string | undefined;
get rootResourceId(): string;
private _tags?;
get tags(): {
[key: string]: string;
};
set tags(value: {
[key: string]: string;
});
resetTags(): void;
get tagsInput(): {
[key: string]: string;
} | undefined;
private _tagsAll?;
get tagsAll(): {
[key: string]: string;
};
set tagsAll(value: {
[key: string]: string;
});
resetTagsAll(): void;
get tagsAllInput(): {
[key: string]: string;
} | undefined;
private _endpointConfiguration;
get endpointConfiguration(): ApiGatewayRestApiEndpointConfigurationOutputReference;
putEndpointConfiguration(value: ApiGatewayRestApiEndpointConfiguration): void;
resetEndpointConfiguration(): void;
get endpointConfigurationInput(): ApiGatewayRestApiEndpointConfiguration | undefined;
protected synthesizeAttributes(): {
[name: string]: any;
};
protected synthesizeHclAttributes(): {
[name: string]: any;
};
}