UNPKG

@cdktf/provider-aws

Version:

Prebuilt aws Provider for Terraform CDK (cdktf)

484 lines (483 loc) 25.6 kB
/** * Copyright (c) HashiCorp, Inc. * SPDX-License-Identifier: MPL-2.0 */ import { Construct } from 'constructs'; import * as cdktf from 'cdktf'; export interface OdbNetworkConfig extends cdktf.TerraformMetaArguments { /** * The name of the Availability Zone (AZ) where the odb network is located. Changing this will force terraform to create new resource * * Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/6.25.0/docs/resources/odb_network#availability_zone OdbNetwork#availability_zone} */ readonly availabilityZone?: string; /** * The AZ ID of the AZ where the ODB network is located. Changing this will force terraform to create new resource. * * Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/6.25.0/docs/resources/odb_network#availability_zone_id OdbNetwork#availability_zone_id} */ readonly availabilityZoneId: string; /** * The CIDR range of the backup subnet for the ODB network. Changing this will force terraform to create new resource. * Constraints: * - Must not overlap with the CIDR range of the client subnet. * - Must not overlap with the CIDR ranges of the VPCs that are connected to the * ODB network. * - Must not use the following CIDR ranges that are reserved by OCI: * - 100.106.0.0/16 and 100.107.0.0/16 * - 169.254.0.0/16 * - 224.0.0.0 - 239.255.255.255 * - 240.0.0.0 - 255.255.255.255 * * Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/6.25.0/docs/resources/odb_network#backup_subnet_cidr OdbNetwork#backup_subnet_cidr} */ readonly backupSubnetCidr: string; /** * The CIDR notation for the network resource. Changing this will force terraform to create new resource. * Constraints: * - Must not overlap with the CIDR range of the backup subnet. * - Must not overlap with the CIDR ranges of the VPCs that are connected to the * ODB network. * - Must not use the following CIDR ranges that are reserved by OCI: * - 100.106.0.0/16 and 100.107.0.0/16 * - 169.254.0.0/16 * - 224.0.0.0 - 239.255.255.255 * - 240.0.0.0 - 255.255.255.255 * * Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/6.25.0/docs/resources/odb_network#client_subnet_cidr OdbNetwork#client_subnet_cidr} */ readonly clientSubnetCidr: string; /** * The name of the custom domain that the network is located. custom_domain_name and default_dns_prefix both can't be given. * * Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/6.25.0/docs/resources/odb_network#custom_domain_name OdbNetwork#custom_domain_name} */ readonly customDomainName?: string; /** * The default DNS prefix for the network resource. Changing this will force terraform to create new resource. * * Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/6.25.0/docs/resources/odb_network#default_dns_prefix OdbNetwork#default_dns_prefix} */ readonly defaultDnsPrefix?: string; /** * If set to true deletes associated OCI resources. Default false. * * Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/6.25.0/docs/resources/odb_network#delete_associated_resources OdbNetwork#delete_associated_resources} */ readonly deleteAssociatedResources?: boolean | cdktf.IResolvable; /** * The user-friendly name for the odb network. Changing this will force terraform to create a new resource. * * Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/6.25.0/docs/resources/odb_network#display_name OdbNetwork#display_name} */ readonly displayName: string; /** * Region where this resource will be [managed](https://docs.aws.amazon.com/general/latest/gr/rande.html#regional-endpoints). Defaults to the Region set in the [provider configuration](https://registry.terraform.io/providers/hashicorp/aws/latest/docs#aws-configuration-reference). * * Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/6.25.0/docs/resources/odb_network#region OdbNetwork#region} */ readonly region?: string; /** * Specifies the configuration for Amazon S3 access from the ODB network. * * Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/6.25.0/docs/resources/odb_network#s3_access OdbNetwork#s3_access} */ readonly s3Access: string; /** * Specifies the endpoint policy for Amazon S3 access from the ODB network. * * Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/6.25.0/docs/resources/odb_network#s3_policy_document OdbNetwork#s3_policy_document} */ readonly s3PolicyDocument?: string; /** * Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/6.25.0/docs/resources/odb_network#tags OdbNetwork#tags} */ readonly tags?: { [key: string]: string; }; /** * Specifies the configuration for Zero-ETL access from the ODB network. * * Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/6.25.0/docs/resources/odb_network#zero_etl_access OdbNetwork#zero_etl_access} */ readonly zeroEtlAccess: string; /** * timeouts block * * Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/6.25.0/docs/resources/odb_network#timeouts OdbNetwork#timeouts} */ readonly timeouts?: OdbNetworkTimeouts; } export interface OdbNetworkManagedServicesManagedS3BackupAccess { } export declare function odbNetworkManagedServicesManagedS3BackupAccessToTerraform(struct?: OdbNetworkManagedServicesManagedS3BackupAccess): any; export declare function odbNetworkManagedServicesManagedS3BackupAccessToHclTerraform(struct?: OdbNetworkManagedServicesManagedS3BackupAccess): any; export declare class OdbNetworkManagedServicesManagedS3BackupAccessOutputReference 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(): OdbNetworkManagedServicesManagedS3BackupAccess | undefined; set internalValue(value: OdbNetworkManagedServicesManagedS3BackupAccess | undefined); get ipv4Addresses(): string[]; get status(): string; } export declare class OdbNetworkManagedServicesManagedS3BackupAccessList 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): OdbNetworkManagedServicesManagedS3BackupAccessOutputReference; } export interface OdbNetworkManagedServicesS3Access { } export declare function odbNetworkManagedServicesS3AccessToTerraform(struct?: OdbNetworkManagedServicesS3Access): any; export declare function odbNetworkManagedServicesS3AccessToHclTerraform(struct?: OdbNetworkManagedServicesS3Access): any; export declare class OdbNetworkManagedServicesS3AccessOutputReference 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(): OdbNetworkManagedServicesS3Access | undefined; set internalValue(value: OdbNetworkManagedServicesS3Access | undefined); get domainName(): string; get ipv4Addresses(): string[]; get s3PolicyDocument(): string; get status(): string; } export declare class OdbNetworkManagedServicesS3AccessList 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): OdbNetworkManagedServicesS3AccessOutputReference; } export interface OdbNetworkManagedServicesServiceNetworkEndpoint { } export declare function odbNetworkManagedServicesServiceNetworkEndpointToTerraform(struct?: OdbNetworkManagedServicesServiceNetworkEndpoint): any; export declare function odbNetworkManagedServicesServiceNetworkEndpointToHclTerraform(struct?: OdbNetworkManagedServicesServiceNetworkEndpoint): any; export declare class OdbNetworkManagedServicesServiceNetworkEndpointOutputReference 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(): OdbNetworkManagedServicesServiceNetworkEndpoint | undefined; set internalValue(value: OdbNetworkManagedServicesServiceNetworkEndpoint | undefined); get vpcEndpointId(): string; get vpcEndpointType(): string; } export declare class OdbNetworkManagedServicesServiceNetworkEndpointList 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): OdbNetworkManagedServicesServiceNetworkEndpointOutputReference; } export interface OdbNetworkManagedServicesZeroEtlAccess { } export declare function odbNetworkManagedServicesZeroEtlAccessToTerraform(struct?: OdbNetworkManagedServicesZeroEtlAccess): any; export declare function odbNetworkManagedServicesZeroEtlAccessToHclTerraform(struct?: OdbNetworkManagedServicesZeroEtlAccess): any; export declare class OdbNetworkManagedServicesZeroEtlAccessOutputReference 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(): OdbNetworkManagedServicesZeroEtlAccess | undefined; set internalValue(value: OdbNetworkManagedServicesZeroEtlAccess | undefined); get cidr(): string; get status(): string; } export declare class OdbNetworkManagedServicesZeroEtlAccessList 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): OdbNetworkManagedServicesZeroEtlAccessOutputReference; } export interface OdbNetworkManagedServices { } export declare function odbNetworkManagedServicesToTerraform(struct?: OdbNetworkManagedServices): any; export declare function odbNetworkManagedServicesToHclTerraform(struct?: OdbNetworkManagedServices): any; export declare class OdbNetworkManagedServicesOutputReference 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(): OdbNetworkManagedServices | undefined; set internalValue(value: OdbNetworkManagedServices | undefined); private _managedS3BackupAccess; get managedS3BackupAccess(): OdbNetworkManagedServicesManagedS3BackupAccessList; get managedServiceIpv4Cidrs(): string[]; get resourceGatewayArn(): string; private _s3Access; get s3Access(): OdbNetworkManagedServicesS3AccessList; get serviceNetworkArn(): string; private _serviceNetworkEndpoint; get serviceNetworkEndpoint(): OdbNetworkManagedServicesServiceNetworkEndpointList; private _zeroEtlAccess; get zeroEtlAccess(): OdbNetworkManagedServicesZeroEtlAccessList; } export declare class OdbNetworkManagedServicesList 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): OdbNetworkManagedServicesOutputReference; } export interface OdbNetworkOciDnsForwardingConfigs { } export declare function odbNetworkOciDnsForwardingConfigsToTerraform(struct?: OdbNetworkOciDnsForwardingConfigs): any; export declare function odbNetworkOciDnsForwardingConfigsToHclTerraform(struct?: OdbNetworkOciDnsForwardingConfigs): any; export declare class OdbNetworkOciDnsForwardingConfigsOutputReference 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(): OdbNetworkOciDnsForwardingConfigs | undefined; set internalValue(value: OdbNetworkOciDnsForwardingConfigs | undefined); get domainName(): string; get ociDnsListenerIp(): string; } export declare class OdbNetworkOciDnsForwardingConfigsList 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): OdbNetworkOciDnsForwardingConfigsOutputReference; } export interface OdbNetworkTimeouts { /** * A string that can be [parsed as a duration](https://pkg.go.dev/time#ParseDuration) consisting of numbers and unit suffixes, such as "30s" or "2h45m". Valid time units are "s" (seconds), "m" (minutes), "h" (hours). * * Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/6.25.0/docs/resources/odb_network#create OdbNetwork#create} */ readonly create?: string; /** * A string that can be [parsed as a duration](https://pkg.go.dev/time#ParseDuration) consisting of numbers and unit suffixes, such as "30s" or "2h45m". Valid time units are "s" (seconds), "m" (minutes), "h" (hours). Setting a timeout for a Delete operation is only applicable if changes are saved into state before the destroy operation occurs. * * Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/6.25.0/docs/resources/odb_network#delete OdbNetwork#delete} */ readonly delete?: string; /** * A string that can be [parsed as a duration](https://pkg.go.dev/time#ParseDuration) consisting of numbers and unit suffixes, such as "30s" or "2h45m". Valid time units are "s" (seconds), "m" (minutes), "h" (hours). * * Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/6.25.0/docs/resources/odb_network#update OdbNetwork#update} */ readonly update?: string; } export declare function odbNetworkTimeoutsToTerraform(struct?: OdbNetworkTimeouts | cdktf.IResolvable): any; export declare function odbNetworkTimeoutsToHclTerraform(struct?: OdbNetworkTimeouts | cdktf.IResolvable): any; export declare class OdbNetworkTimeoutsOutputReference 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(): OdbNetworkTimeouts | cdktf.IResolvable | undefined; set internalValue(value: OdbNetworkTimeouts | 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/aws/6.25.0/docs/resources/odb_network aws_odb_network} */ export declare class OdbNetwork extends cdktf.TerraformResource { static readonly tfResourceType = "aws_odb_network"; /** * Generates CDKTF code for importing a OdbNetwork 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 OdbNetwork to import * @param importFromId The id of the existing OdbNetwork that should be imported. Refer to the {@link https://registry.terraform.io/providers/hashicorp/aws/6.25.0/docs/resources/odb_network#import import section} in the documentation of this resource for the id to use * @param provider? Optional instance of the provider where the OdbNetwork 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/6.25.0/docs/resources/odb_network aws_odb_network} 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 OdbNetworkConfig */ constructor(scope: Construct, id: string, config: OdbNetworkConfig); get arn(): string; private _availabilityZone?; get availabilityZone(): string; set availabilityZone(value: string); resetAvailabilityZone(): void; get availabilityZoneInput(): string | undefined; private _availabilityZoneId?; get availabilityZoneId(): string; set availabilityZoneId(value: string); get availabilityZoneIdInput(): string | undefined; private _backupSubnetCidr?; get backupSubnetCidr(): string; set backupSubnetCidr(value: string); get backupSubnetCidrInput(): string | undefined; private _clientSubnetCidr?; get clientSubnetCidr(): string; set clientSubnetCidr(value: string); get clientSubnetCidrInput(): string | undefined; get createdAt(): string; private _customDomainName?; get customDomainName(): string; set customDomainName(value: string); resetCustomDomainName(): void; get customDomainNameInput(): string | undefined; private _defaultDnsPrefix?; get defaultDnsPrefix(): string; set defaultDnsPrefix(value: string); resetDefaultDnsPrefix(): void; get defaultDnsPrefixInput(): string | undefined; private _deleteAssociatedResources?; get deleteAssociatedResources(): boolean | cdktf.IResolvable; set deleteAssociatedResources(value: boolean | cdktf.IResolvable); resetDeleteAssociatedResources(): void; get deleteAssociatedResourcesInput(): boolean | cdktf.IResolvable | undefined; private _displayName?; get displayName(): string; set displayName(value: string); get displayNameInput(): string | undefined; get id(): string; private _managedServices; get managedServices(): OdbNetworkManagedServicesList; private _ociDnsForwardingConfigs; get ociDnsForwardingConfigs(): OdbNetworkOciDnsForwardingConfigsList; get ociNetworkAnchorId(): string; get ociNetworkAnchorUrl(): string; get ociResourceAnchorName(): string; get ociVcnId(): string; get ociVcnUrl(): string; get peeredCidrs(): string[]; get percentProgress(): number; private _region?; get region(): string; set region(value: string); resetRegion(): void; get regionInput(): string | undefined; private _s3Access?; get s3Access(): string; set s3Access(value: string); get s3AccessInput(): string | undefined; private _s3PolicyDocument?; get s3PolicyDocument(): string; set s3PolicyDocument(value: string); resetS3PolicyDocument(): void; get s3PolicyDocumentInput(): string | undefined; get status(): string; get statusReason(): 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(): cdktf.StringMap; private _zeroEtlAccess?; get zeroEtlAccess(): string; set zeroEtlAccess(value: string); get zeroEtlAccessInput(): string | undefined; private _timeouts; get timeouts(): OdbNetworkTimeoutsOutputReference; putTimeouts(value: OdbNetworkTimeouts): void; resetTimeouts(): void; get timeoutsInput(): cdktf.IResolvable | OdbNetworkTimeouts | undefined; protected synthesizeAttributes(): { [name: string]: any; }; protected synthesizeHclAttributes(): { [name: string]: any; }; }