@cdktf/provider-aws
Version:
Prebuilt aws Provider for Terraform CDK (cdktf)
315 lines (314 loc) • 14.7 kB
TypeScript
/**
* Copyright (c) HashiCorp, Inc.
* SPDX-License-Identifier: MPL-2.0
*/
import { Construct } from 'constructs';
import * as cdktf from 'cdktf';
export interface DaxClusterConfig extends cdktf.TerraformMetaArguments {
/**
* Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.84.0/docs/resources/dax_cluster#availability_zones DaxCluster#availability_zones}
*/
readonly availabilityZones?: string[];
/**
* Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.84.0/docs/resources/dax_cluster#cluster_endpoint_encryption_type DaxCluster#cluster_endpoint_encryption_type}
*/
readonly clusterEndpointEncryptionType?: string;
/**
* Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.84.0/docs/resources/dax_cluster#cluster_name DaxCluster#cluster_name}
*/
readonly clusterName: string;
/**
* Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.84.0/docs/resources/dax_cluster#description DaxCluster#description}
*/
readonly description?: string;
/**
* Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.84.0/docs/resources/dax_cluster#iam_role_arn DaxCluster#iam_role_arn}
*/
readonly iamRoleArn: string;
/**
* Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.84.0/docs/resources/dax_cluster#id DaxCluster#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/dax_cluster#maintenance_window DaxCluster#maintenance_window}
*/
readonly maintenanceWindow?: string;
/**
* Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.84.0/docs/resources/dax_cluster#node_type DaxCluster#node_type}
*/
readonly nodeType: string;
/**
* Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.84.0/docs/resources/dax_cluster#notification_topic_arn DaxCluster#notification_topic_arn}
*/
readonly notificationTopicArn?: string;
/**
* Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.84.0/docs/resources/dax_cluster#parameter_group_name DaxCluster#parameter_group_name}
*/
readonly parameterGroupName?: string;
/**
* Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.84.0/docs/resources/dax_cluster#replication_factor DaxCluster#replication_factor}
*/
readonly replicationFactor: number;
/**
* Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.84.0/docs/resources/dax_cluster#security_group_ids DaxCluster#security_group_ids}
*/
readonly securityGroupIds?: string[];
/**
* Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.84.0/docs/resources/dax_cluster#subnet_group_name DaxCluster#subnet_group_name}
*/
readonly subnetGroupName?: string;
/**
* Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.84.0/docs/resources/dax_cluster#tags DaxCluster#tags}
*/
readonly tags?: {
[key: string]: string;
};
/**
* Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.84.0/docs/resources/dax_cluster#tags_all DaxCluster#tags_all}
*/
readonly tagsAll?: {
[key: string]: string;
};
/**
* server_side_encryption block
*
* Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.84.0/docs/resources/dax_cluster#server_side_encryption DaxCluster#server_side_encryption}
*/
readonly serverSideEncryption?: DaxClusterServerSideEncryption;
/**
* timeouts block
*
* Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.84.0/docs/resources/dax_cluster#timeouts DaxCluster#timeouts}
*/
readonly timeouts?: DaxClusterTimeouts;
}
export interface DaxClusterNodes {
}
export declare function daxClusterNodesToTerraform(struct?: DaxClusterNodes): any;
export declare function daxClusterNodesToHclTerraform(struct?: DaxClusterNodes): any;
export declare class DaxClusterNodesOutputReference 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(): DaxClusterNodes | undefined;
set internalValue(value: DaxClusterNodes | undefined);
get address(): string;
get availabilityZone(): string;
get id(): string;
get port(): number;
}
export declare class DaxClusterNodesList 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): DaxClusterNodesOutputReference;
}
export interface DaxClusterServerSideEncryption {
/**
* Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.84.0/docs/resources/dax_cluster#enabled DaxCluster#enabled}
*/
readonly enabled?: boolean | cdktf.IResolvable;
}
export declare function daxClusterServerSideEncryptionToTerraform(struct?: DaxClusterServerSideEncryptionOutputReference | DaxClusterServerSideEncryption): any;
export declare function daxClusterServerSideEncryptionToHclTerraform(struct?: DaxClusterServerSideEncryptionOutputReference | DaxClusterServerSideEncryption): any;
export declare class DaxClusterServerSideEncryptionOutputReference 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(): DaxClusterServerSideEncryption | undefined;
set internalValue(value: DaxClusterServerSideEncryption | undefined);
private _enabled?;
get enabled(): boolean | cdktf.IResolvable;
set enabled(value: boolean | cdktf.IResolvable);
resetEnabled(): void;
get enabledInput(): boolean | cdktf.IResolvable | undefined;
}
export interface DaxClusterTimeouts {
/**
* Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.84.0/docs/resources/dax_cluster#create DaxCluster#create}
*/
readonly create?: string;
/**
* Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.84.0/docs/resources/dax_cluster#delete DaxCluster#delete}
*/
readonly delete?: string;
/**
* Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.84.0/docs/resources/dax_cluster#update DaxCluster#update}
*/
readonly update?: string;
}
export declare function daxClusterTimeoutsToTerraform(struct?: DaxClusterTimeouts | cdktf.IResolvable): any;
export declare function daxClusterTimeoutsToHclTerraform(struct?: DaxClusterTimeouts | cdktf.IResolvable): any;
export declare class DaxClusterTimeoutsOutputReference 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(): DaxClusterTimeouts | cdktf.IResolvable | undefined;
set internalValue(value: DaxClusterTimeouts | 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/5.84.0/docs/resources/dax_cluster aws_dax_cluster}
*/
export declare class DaxCluster extends cdktf.TerraformResource {
static readonly tfResourceType = "aws_dax_cluster";
/**
* Generates CDKTF code for importing a DaxCluster 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 DaxCluster to import
* @param importFromId The id of the existing DaxCluster that should be imported. Refer to the {@link https://registry.terraform.io/providers/hashicorp/aws/5.84.0/docs/resources/dax_cluster#import import section} in the documentation of this resource for the id to use
* @param provider? Optional instance of the provider where the DaxCluster 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/dax_cluster aws_dax_cluster} 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 DaxClusterConfig
*/
constructor(scope: Construct, id: string, config: DaxClusterConfig);
get arn(): string;
private _availabilityZones?;
get availabilityZones(): string[];
set availabilityZones(value: string[]);
resetAvailabilityZones(): void;
get availabilityZonesInput(): string[] | undefined;
get clusterAddress(): string;
private _clusterEndpointEncryptionType?;
get clusterEndpointEncryptionType(): string;
set clusterEndpointEncryptionType(value: string);
resetClusterEndpointEncryptionType(): void;
get clusterEndpointEncryptionTypeInput(): string | undefined;
private _clusterName?;
get clusterName(): string;
set clusterName(value: string);
get clusterNameInput(): string | undefined;
get configurationEndpoint(): string;
private _description?;
get description(): string;
set description(value: string);
resetDescription(): void;
get descriptionInput(): string | undefined;
private _iamRoleArn?;
get iamRoleArn(): string;
set iamRoleArn(value: string);
get iamRoleArnInput(): string | undefined;
private _id?;
get id(): string;
set id(value: string);
resetId(): void;
get idInput(): string | undefined;
private _maintenanceWindow?;
get maintenanceWindow(): string;
set maintenanceWindow(value: string);
resetMaintenanceWindow(): void;
get maintenanceWindowInput(): string | undefined;
private _nodeType?;
get nodeType(): string;
set nodeType(value: string);
get nodeTypeInput(): string | undefined;
private _nodes;
get nodes(): DaxClusterNodesList;
private _notificationTopicArn?;
get notificationTopicArn(): string;
set notificationTopicArn(value: string);
resetNotificationTopicArn(): void;
get notificationTopicArnInput(): string | undefined;
private _parameterGroupName?;
get parameterGroupName(): string;
set parameterGroupName(value: string);
resetParameterGroupName(): void;
get parameterGroupNameInput(): string | undefined;
get port(): number;
private _replicationFactor?;
get replicationFactor(): number;
set replicationFactor(value: number);
get replicationFactorInput(): number | undefined;
private _securityGroupIds?;
get securityGroupIds(): string[];
set securityGroupIds(value: string[]);
resetSecurityGroupIds(): void;
get securityGroupIdsInput(): string[] | undefined;
private _subnetGroupName?;
get subnetGroupName(): string;
set subnetGroupName(value: string);
resetSubnetGroupName(): void;
get subnetGroupNameInput(): string | undefined;
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 _serverSideEncryption;
get serverSideEncryption(): DaxClusterServerSideEncryptionOutputReference;
putServerSideEncryption(value: DaxClusterServerSideEncryption): void;
resetServerSideEncryption(): void;
get serverSideEncryptionInput(): DaxClusterServerSideEncryption | undefined;
private _timeouts;
get timeouts(): DaxClusterTimeoutsOutputReference;
putTimeouts(value: DaxClusterTimeouts): void;
resetTimeouts(): void;
get timeoutsInput(): cdktf.IResolvable | DaxClusterTimeouts | undefined;
protected synthesizeAttributes(): {
[name: string]: any;
};
protected synthesizeHclAttributes(): {
[name: string]: any;
};
}