@cdktf/provider-aws
Version:
Prebuilt aws Provider for Terraform CDK (cdktf)
193 lines (192 loc) • 8.71 kB
TypeScript
/**
* Copyright (c) HashiCorp, Inc.
* SPDX-License-Identifier: MPL-2.0
*/
import { Construct } from 'constructs';
import * as cdktf from 'cdktf';
export interface DatasyncAgentConfig extends cdktf.TerraformMetaArguments {
/**
* Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/6.25.0/docs/resources/datasync_agent#activation_key DatasyncAgent#activation_key}
*/
readonly activationKey?: string;
/**
* Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/6.25.0/docs/resources/datasync_agent#id DatasyncAgent#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/6.25.0/docs/resources/datasync_agent#ip_address DatasyncAgent#ip_address}
*/
readonly ipAddress?: string;
/**
* Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/6.25.0/docs/resources/datasync_agent#name DatasyncAgent#name}
*/
readonly name?: string;
/**
* Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/6.25.0/docs/resources/datasync_agent#private_link_endpoint DatasyncAgent#private_link_endpoint}
*/
readonly privateLinkEndpoint?: 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/datasync_agent#region DatasyncAgent#region}
*/
readonly region?: string;
/**
* Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/6.25.0/docs/resources/datasync_agent#security_group_arns DatasyncAgent#security_group_arns}
*/
readonly securityGroupArns?: string[];
/**
* Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/6.25.0/docs/resources/datasync_agent#subnet_arns DatasyncAgent#subnet_arns}
*/
readonly subnetArns?: string[];
/**
* Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/6.25.0/docs/resources/datasync_agent#tags DatasyncAgent#tags}
*/
readonly tags?: {
[key: string]: string;
};
/**
* Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/6.25.0/docs/resources/datasync_agent#tags_all DatasyncAgent#tags_all}
*/
readonly tagsAll?: {
[key: string]: string;
};
/**
* Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/6.25.0/docs/resources/datasync_agent#vpc_endpoint_id DatasyncAgent#vpc_endpoint_id}
*/
readonly vpcEndpointId?: string;
/**
* timeouts block
*
* Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/6.25.0/docs/resources/datasync_agent#timeouts DatasyncAgent#timeouts}
*/
readonly timeouts?: DatasyncAgentTimeouts;
}
export interface DatasyncAgentTimeouts {
/**
* Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/6.25.0/docs/resources/datasync_agent#create DatasyncAgent#create}
*/
readonly create?: string;
}
export declare function datasyncAgentTimeoutsToTerraform(struct?: DatasyncAgentTimeouts | cdktf.IResolvable): any;
export declare function datasyncAgentTimeoutsToHclTerraform(struct?: DatasyncAgentTimeouts | cdktf.IResolvable): any;
export declare class DatasyncAgentTimeoutsOutputReference 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(): DatasyncAgentTimeouts | cdktf.IResolvable | undefined;
set internalValue(value: DatasyncAgentTimeouts | cdktf.IResolvable | undefined);
private _create?;
get create(): string;
set create(value: string);
resetCreate(): void;
get createInput(): string | undefined;
}
/**
* Represents a {@link https://registry.terraform.io/providers/hashicorp/aws/6.25.0/docs/resources/datasync_agent aws_datasync_agent}
*/
export declare class DatasyncAgent extends cdktf.TerraformResource {
static readonly tfResourceType = "aws_datasync_agent";
/**
* Generates CDKTF code for importing a DatasyncAgent 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 DatasyncAgent to import
* @param importFromId The id of the existing DatasyncAgent that should be imported. Refer to the {@link https://registry.terraform.io/providers/hashicorp/aws/6.25.0/docs/resources/datasync_agent#import import section} in the documentation of this resource for the id to use
* @param provider? Optional instance of the provider where the DatasyncAgent 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/datasync_agent aws_datasync_agent} 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 DatasyncAgentConfig = {}
*/
constructor(scope: Construct, id: string, config?: DatasyncAgentConfig);
private _activationKey?;
get activationKey(): string;
set activationKey(value: string);
resetActivationKey(): void;
get activationKeyInput(): string | undefined;
get arn(): string;
private _id?;
get id(): string;
set id(value: string);
resetId(): void;
get idInput(): string | undefined;
private _ipAddress?;
get ipAddress(): string;
set ipAddress(value: string);
resetIpAddress(): void;
get ipAddressInput(): string | undefined;
private _name?;
get name(): string;
set name(value: string);
resetName(): void;
get nameInput(): string | undefined;
private _privateLinkEndpoint?;
get privateLinkEndpoint(): string;
set privateLinkEndpoint(value: string);
resetPrivateLinkEndpoint(): void;
get privateLinkEndpointInput(): string | undefined;
private _region?;
get region(): string;
set region(value: string);
resetRegion(): void;
get regionInput(): string | undefined;
private _securityGroupArns?;
get securityGroupArns(): string[];
set securityGroupArns(value: string[]);
resetSecurityGroupArns(): void;
get securityGroupArnsInput(): string[] | undefined;
private _subnetArns?;
get subnetArns(): string[];
set subnetArns(value: string[]);
resetSubnetArns(): void;
get subnetArnsInput(): 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 _vpcEndpointId?;
get vpcEndpointId(): string;
set vpcEndpointId(value: string);
resetVpcEndpointId(): void;
get vpcEndpointIdInput(): string | undefined;
private _timeouts;
get timeouts(): DatasyncAgentTimeoutsOutputReference;
putTimeouts(value: DatasyncAgentTimeouts): void;
resetTimeouts(): void;
get timeoutsInput(): cdktf.IResolvable | DatasyncAgentTimeouts | undefined;
protected synthesizeAttributes(): {
[name: string]: any;
};
protected synthesizeHclAttributes(): {
[name: string]: any;
};
}