@pulumi/aws
Version:
A Pulumi package for creating and managing Amazon Web Services (AWS) cloud resources.
131 lines (130 loc) • 4.72 kB
TypeScript
import * as pulumi from "@pulumi/pulumi";
/**
* Provides information about an Elastic File System Mount Target (EFS).
*
* ## Example Usage
*
* ```typescript
* import * as pulumi from "@pulumi/pulumi";
* import * as aws from "@pulumi/aws";
*
* const config = new pulumi.Config();
* const mountTargetId = config.get("mountTargetId") || "";
* const byId = aws.efs.getMountTarget({
* mountTargetId: mountTargetId,
* });
* ```
*/
export declare function getMountTarget(args?: GetMountTargetArgs, opts?: pulumi.InvokeOptions): Promise<GetMountTargetResult>;
/**
* A collection of arguments for invoking getMountTarget.
*/
export interface GetMountTargetArgs {
/**
* ID or ARN of the access point whose mount target that you want to find. It must be included if a `fileSystemId` and `mountTargetId` are not included.
*/
accessPointId?: string;
/**
* ID or ARN of the file system whose mount target that you want to find. It must be included if an `accessPointId` and `mountTargetId` are not included.
*/
fileSystemId?: string;
/**
* ID or ARN of the mount target that you want to find. It must be included in your request if an `accessPointId` and `fileSystemId` are not included.
*/
mountTargetId?: 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.
*/
region?: string;
}
/**
* A collection of values returned by getMountTarget.
*/
export interface GetMountTargetResult {
readonly accessPointId?: string;
/**
* The unique and consistent identifier of the Availability Zone (AZ) that the mount target resides in.
*/
readonly availabilityZoneId: string;
/**
* The name of the Availability Zone (AZ) that the mount target resides in.
*/
readonly availabilityZoneName: string;
/**
* DNS name for the EFS file system.
*/
readonly dnsName: string;
/**
* Amazon Resource Name of the file system for which the mount target is intended.
*/
readonly fileSystemArn: string;
readonly fileSystemId: string;
/**
* The provider-assigned unique ID for this managed resource.
*/
readonly id: string;
/**
* Address at which the file system may be mounted via the mount target.
*/
readonly ipAddress: string;
/**
* The DNS name for the given subnet/AZ per [documented convention](http://docs.aws.amazon.com/efs/latest/ug/mounting-fs-mount-cmd-dns-name.html).
*/
readonly mountTargetDnsName: string;
readonly mountTargetId: string;
/**
* The ID of the network interface that Amazon EFS created when it created the mount target.
*/
readonly networkInterfaceId: string;
/**
* AWS account ID that owns the resource.
*/
readonly ownerId: string;
readonly region: string;
/**
* List of VPC security group IDs attached to the mount target.
*/
readonly securityGroups: string[];
/**
* ID of the mount target's subnet.
*/
readonly subnetId: string;
}
/**
* Provides information about an Elastic File System Mount Target (EFS).
*
* ## Example Usage
*
* ```typescript
* import * as pulumi from "@pulumi/pulumi";
* import * as aws from "@pulumi/aws";
*
* const config = new pulumi.Config();
* const mountTargetId = config.get("mountTargetId") || "";
* const byId = aws.efs.getMountTarget({
* mountTargetId: mountTargetId,
* });
* ```
*/
export declare function getMountTargetOutput(args?: GetMountTargetOutputArgs, opts?: pulumi.InvokeOutputOptions): pulumi.Output<GetMountTargetResult>;
/**
* A collection of arguments for invoking getMountTarget.
*/
export interface GetMountTargetOutputArgs {
/**
* ID or ARN of the access point whose mount target that you want to find. It must be included if a `fileSystemId` and `mountTargetId` are not included.
*/
accessPointId?: pulumi.Input<string>;
/**
* ID or ARN of the file system whose mount target that you want to find. It must be included if an `accessPointId` and `mountTargetId` are not included.
*/
fileSystemId?: pulumi.Input<string>;
/**
* ID or ARN of the mount target that you want to find. It must be included in your request if an `accessPointId` and `fileSystemId` are not included.
*/
mountTargetId?: pulumi.Input<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.
*/
region?: pulumi.Input<string>;
}