@pulumi/aws
Version:
A Pulumi package for creating and managing Amazon Web Services (AWS) cloud resources.
183 lines (182 loc) • 7.63 kB
TypeScript
import * as pulumi from "@pulumi/pulumi";
import * as inputs from "../types/input";
import * as outputs from "../types/output";
/**
* Manages an AWS Lambda Capacity Provider.
*
* ## Example Usage
*
* ### Basic Usage
*
* ```typescript
* import * as pulumi from "@pulumi/pulumi";
* import * as aws from "@pulumi/aws";
*
* const example = new aws.lambda.CapacityProvider("example", {
* name: "example",
* vpcConfig: {
* subnetIds: exampleAwsSubnet.map(__item => __item.id),
* securityGroupIds: [exampleAwsSecurityGroup.id],
* },
* permissionsConfig: {
* capacityProviderOperatorRoleArn: exampleAwsIamRole.arn,
* },
* });
* ```
*
* ## Import
*
* Using `pulumi import`, import Lambda Capacity Provider using the `name`. For example:
*
* ```sh
* $ pulumi import aws:lambda/capacityProvider:CapacityProvider example example
* ```
*/
export declare class CapacityProvider extends pulumi.CustomResource {
/**
* Get an existing CapacityProvider resource's state with the given name, ID, and optional extra
* properties used to qualify the lookup.
*
* @param name The _unique_ name of the resulting resource.
* @param id The _unique_ provider ID of the resource to lookup.
* @param state Any extra arguments used during the lookup.
* @param opts Optional settings to control the behavior of the CustomResource.
*/
static get(name: string, id: pulumi.Input<pulumi.ID>, state?: CapacityProviderState, opts?: pulumi.CustomResourceOptions): CapacityProvider;
/**
* Returns true if the given object is an instance of CapacityProvider. This is designed to work even
* when multiple copies of the Pulumi SDK have been loaded into the same process.
*/
static isInstance(obj: any): obj is CapacityProvider;
/**
* ARN of the Capacity Provider.
*/
readonly arn: pulumi.Output<string>;
readonly capacityProviderScalingConfigs: pulumi.Output<outputs.lambda.CapacityProviderCapacityProviderScalingConfig[]>;
/**
* Configuration block for instance requirements settings. See Instance Requirements below.
*/
readonly instanceRequirements: pulumi.Output<outputs.lambda.CapacityProviderInstanceRequirement[]>;
readonly kmsKeyArn: pulumi.Output<string | undefined>;
/**
* The name of the Capacity Provider.
*/
readonly name: pulumi.Output<string>;
/**
* Configuration block for permissions settings. See Permissions Config below.
*
* The following arguments are optional:
*/
readonly permissionsConfig: pulumi.Output<outputs.lambda.CapacityProviderPermissionsConfig | undefined>;
/**
* 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.
*/
readonly region: pulumi.Output<string>;
/**
* Map of tags assigned to the resource. If configured with a provider `defaultTags` configuration block present, tags with matching keys will overwrite those defined at the provider-level.
*/
readonly tags: pulumi.Output<{
[key: string]: string;
} | undefined>;
/**
* Map of tags assigned to the resource, including those inherited from the provider `defaultTags` configuration block.
*/
readonly tagsAll: pulumi.Output<{
[key: string]: string;
}>;
readonly timeouts: pulumi.Output<outputs.lambda.CapacityProviderTimeouts | undefined>;
/**
* Configuration block for VPC settings. See VPC Config below.
*/
readonly vpcConfig: pulumi.Output<outputs.lambda.CapacityProviderVpcConfig | undefined>;
/**
* Create a CapacityProvider resource with the given unique name, arguments, and options.
*
* @param name The _unique_ name of the resource.
* @param args The arguments to use to populate this resource's properties.
* @param opts A bag of options that control this resource's behavior.
*/
constructor(name: string, args?: CapacityProviderArgs, opts?: pulumi.CustomResourceOptions);
}
/**
* Input properties used for looking up and filtering CapacityProvider resources.
*/
export interface CapacityProviderState {
/**
* ARN of the Capacity Provider.
*/
arn?: pulumi.Input<string>;
capacityProviderScalingConfigs?: pulumi.Input<pulumi.Input<inputs.lambda.CapacityProviderCapacityProviderScalingConfig>[]>;
/**
* Configuration block for instance requirements settings. See Instance Requirements below.
*/
instanceRequirements?: pulumi.Input<pulumi.Input<inputs.lambda.CapacityProviderInstanceRequirement>[]>;
kmsKeyArn?: pulumi.Input<string>;
/**
* The name of the Capacity Provider.
*/
name?: pulumi.Input<string>;
/**
* Configuration block for permissions settings. See Permissions Config below.
*
* The following arguments are optional:
*/
permissionsConfig?: pulumi.Input<inputs.lambda.CapacityProviderPermissionsConfig>;
/**
* 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. If configured with a provider `defaultTags` configuration block present, tags with matching keys will overwrite those defined at the provider-level.
*/
tags?: pulumi.Input<{
[key: string]: pulumi.Input<string>;
}>;
/**
* Map of tags assigned to the resource, including those inherited from the provider `defaultTags` configuration block.
*/
tagsAll?: pulumi.Input<{
[key: string]: pulumi.Input<string>;
}>;
timeouts?: pulumi.Input<inputs.lambda.CapacityProviderTimeouts>;
/**
* Configuration block for VPC settings. See VPC Config below.
*/
vpcConfig?: pulumi.Input<inputs.lambda.CapacityProviderVpcConfig>;
}
/**
* The set of arguments for constructing a CapacityProvider resource.
*/
export interface CapacityProviderArgs {
capacityProviderScalingConfigs?: pulumi.Input<pulumi.Input<inputs.lambda.CapacityProviderCapacityProviderScalingConfig>[]>;
/**
* Configuration block for instance requirements settings. See Instance Requirements below.
*/
instanceRequirements?: pulumi.Input<pulumi.Input<inputs.lambda.CapacityProviderInstanceRequirement>[]>;
kmsKeyArn?: pulumi.Input<string>;
/**
* The name of the Capacity Provider.
*/
name?: pulumi.Input<string>;
/**
* Configuration block for permissions settings. See Permissions Config below.
*
* The following arguments are optional:
*/
permissionsConfig?: pulumi.Input<inputs.lambda.CapacityProviderPermissionsConfig>;
/**
* 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. If configured with a provider `defaultTags` configuration block present, tags with matching keys will overwrite those defined at the provider-level.
*/
tags?: pulumi.Input<{
[key: string]: pulumi.Input<string>;
}>;
timeouts?: pulumi.Input<inputs.lambda.CapacityProviderTimeouts>;
/**
* Configuration block for VPC settings. See VPC Config below.
*/
vpcConfig?: pulumi.Input<inputs.lambda.CapacityProviderVpcConfig>;
}