@pulumi/aws
Version:
A Pulumi package for creating and managing Amazon Web Services (AWS) cloud resources.
177 lines (176 loc) • 4.83 kB
TypeScript
import * as pulumi from "@pulumi/pulumi";
import * as inputs from "../types/input";
import * as outputs from "../types/output";
/**
* Retrieve information about an EC2 DHCP Options configuration.
*
* ## Example Usage
*
* ### Lookup by DHCP Options ID
*
* ```typescript
* import * as pulumi from "@pulumi/pulumi";
* import * as aws from "@pulumi/aws";
*
* const example = aws.ec2.getVpcDhcpOptions({
* dhcpOptionsId: "dopts-12345678",
* });
* ```
*
* ### Lookup by Filter
*
* ```typescript
* import * as pulumi from "@pulumi/pulumi";
* import * as aws from "@pulumi/aws";
*
* const example = aws.ec2.getVpcDhcpOptions({
* filters: [
* {
* name: "key",
* values: ["domain-name"],
* },
* {
* name: "value",
* values: ["example.com"],
* },
* ],
* });
* ```
*/
export declare function getVpcDhcpOptions(args?: GetVpcDhcpOptionsArgs, opts?: pulumi.InvokeOptions): Promise<GetVpcDhcpOptionsResult>;
/**
* A collection of arguments for invoking getVpcDhcpOptions.
*/
export interface GetVpcDhcpOptionsArgs {
/**
* EC2 DHCP Options ID.
*/
dhcpOptionsId?: string;
/**
* List of custom filters as described below.
*/
filters?: inputs.ec2.GetVpcDhcpOptionsFilter[];
/**
* 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;
/**
* Map of tags assigned to the resource.
*/
tags?: {
[key: string]: string;
};
}
/**
* A collection of values returned by getVpcDhcpOptions.
*/
export interface GetVpcDhcpOptionsResult {
/**
* ARN of the DHCP Options Set.
*/
readonly arn: string;
/**
* EC2 DHCP Options ID
*/
readonly dhcpOptionsId: string;
/**
* Suffix domain name to used when resolving non Fully Qualified Domain NamesE.g., the `search` value in the `/etc/resolv.conf` file.
*/
readonly domainName: string;
/**
* List of name servers.
*/
readonly domainNameServers: string[];
readonly filters?: outputs.ec2.GetVpcDhcpOptionsFilter[];
/**
* The provider-assigned unique ID for this managed resource.
*/
readonly id: string;
/**
* How frequently, in seconds, a running instance with an IPv6 assigned to it goes through DHCPv6 lease renewal.
*/
readonly ipv6AddressPreferredLeaseTime: string;
/**
* List of NETBIOS name servers.
*/
readonly netbiosNameServers: string[];
/**
* NetBIOS node type (1, 2, 4, or 8). For more information about these node types, see [RFC 2132](http://www.ietf.org/rfc/rfc2132.txt).
*/
readonly netbiosNodeType: string;
/**
* List of NTP servers.
*/
readonly ntpServers: string[];
/**
* ID of the AWS account that owns the DHCP options set.
*/
readonly ownerId: string;
readonly region: string;
/**
* Map of tags assigned to the resource.
*/
readonly tags: {
[key: string]: string;
};
}
/**
* Retrieve information about an EC2 DHCP Options configuration.
*
* ## Example Usage
*
* ### Lookup by DHCP Options ID
*
* ```typescript
* import * as pulumi from "@pulumi/pulumi";
* import * as aws from "@pulumi/aws";
*
* const example = aws.ec2.getVpcDhcpOptions({
* dhcpOptionsId: "dopts-12345678",
* });
* ```
*
* ### Lookup by Filter
*
* ```typescript
* import * as pulumi from "@pulumi/pulumi";
* import * as aws from "@pulumi/aws";
*
* const example = aws.ec2.getVpcDhcpOptions({
* filters: [
* {
* name: "key",
* values: ["domain-name"],
* },
* {
* name: "value",
* values: ["example.com"],
* },
* ],
* });
* ```
*/
export declare function getVpcDhcpOptionsOutput(args?: GetVpcDhcpOptionsOutputArgs, opts?: pulumi.InvokeOutputOptions): pulumi.Output<GetVpcDhcpOptionsResult>;
/**
* A collection of arguments for invoking getVpcDhcpOptions.
*/
export interface GetVpcDhcpOptionsOutputArgs {
/**
* EC2 DHCP Options ID.
*/
dhcpOptionsId?: pulumi.Input<string>;
/**
* List of custom filters as described below.
*/
filters?: pulumi.Input<pulumi.Input<inputs.ec2.GetVpcDhcpOptionsFilterArgs>[]>;
/**
* 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>;
/**
* Map of tags assigned to the resource.
*/
tags?: pulumi.Input<{
[key: string]: pulumi.Input<string>;
}>;
}