@pulumi/aws
Version:
A Pulumi package for creating and managing Amazon Web Services (AWS) cloud resources.
117 lines (116 loc) • 4.3 kB
TypeScript
import * as pulumi from "@pulumi/pulumi";
import * as inputs from "../types/input";
import * as outputs from "../types/output";
/**
* Information about single EC2 Instance Type Offering.
*
* ## Example Usage
*
* ```typescript
* import * as pulumi from "@pulumi/pulumi";
* import * as aws from "@pulumi/aws";
*
* const example = aws.ec2.getInstanceTypeOffering({
* filters: [{
* name: "instance-type",
* values: [
* "t2.micro",
* "t3.micro",
* ],
* }],
* preferredInstanceTypes: [
* "t3.micro",
* "t2.micro",
* ],
* });
* ```
*/
export declare function getInstanceTypeOffering(args?: GetInstanceTypeOfferingArgs, opts?: pulumi.InvokeOptions): Promise<GetInstanceTypeOfferingResult>;
/**
* A collection of arguments for invoking getInstanceTypeOffering.
*/
export interface GetInstanceTypeOfferingArgs {
/**
* One or more configuration blocks containing name-values filters. See the [EC2 API Reference](https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_DescribeInstanceTypeOfferings.html) for supported filters. Detailed below.
*/
filters?: inputs.ec2.GetInstanceTypeOfferingFilter[];
/**
* Location type. Defaults to `region`. Valid values: `availability-zone`, `availability-zone-id`, and `region`.
*/
locationType?: string;
/**
* Ordered list of preferred EC2 Instance Types. The first match in this list will be returned. If no preferred matches are found and the original search returned more than one result, an error is returned.
*/
preferredInstanceTypes?: 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 getInstanceTypeOffering.
*/
export interface GetInstanceTypeOfferingResult {
readonly filters?: outputs.ec2.GetInstanceTypeOfferingFilter[];
/**
* The provider-assigned unique ID for this managed resource.
*/
readonly id: string;
/**
* EC2 Instance Type.
*/
readonly instanceType: string;
/**
* Identifier for the location.
*/
readonly location: string;
readonly locationType?: string;
readonly preferredInstanceTypes?: string[];
readonly region: string;
}
/**
* Information about single EC2 Instance Type Offering.
*
* ## Example Usage
*
* ```typescript
* import * as pulumi from "@pulumi/pulumi";
* import * as aws from "@pulumi/aws";
*
* const example = aws.ec2.getInstanceTypeOffering({
* filters: [{
* name: "instance-type",
* values: [
* "t2.micro",
* "t3.micro",
* ],
* }],
* preferredInstanceTypes: [
* "t3.micro",
* "t2.micro",
* ],
* });
* ```
*/
export declare function getInstanceTypeOfferingOutput(args?: GetInstanceTypeOfferingOutputArgs, opts?: pulumi.InvokeOutputOptions): pulumi.Output<GetInstanceTypeOfferingResult>;
/**
* A collection of arguments for invoking getInstanceTypeOffering.
*/
export interface GetInstanceTypeOfferingOutputArgs {
/**
* One or more configuration blocks containing name-values filters. See the [EC2 API Reference](https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_DescribeInstanceTypeOfferings.html) for supported filters. Detailed below.
*/
filters?: pulumi.Input<pulumi.Input<inputs.ec2.GetInstanceTypeOfferingFilterArgs>[]>;
/**
* Location type. Defaults to `region`. Valid values: `availability-zone`, `availability-zone-id`, and `region`.
*/
locationType?: pulumi.Input<string>;
/**
* Ordered list of preferred EC2 Instance Types. The first match in this list will be returned. If no preferred matches are found and the original search returned more than one result, an error is returned.
*/
preferredInstanceTypes?: pulumi.Input<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>;
}