@pulumi/aws
Version:
A Pulumi package for creating and managing Amazon Web Services (AWS) cloud resources.
175 lines (174 loc) • 7.74 kB
TypeScript
import * as pulumi from "@pulumi/pulumi";
/**
* Manages an App Runner VPC Connector.
*
* ## Example Usage
*
* ```typescript
* import * as pulumi from "@pulumi/pulumi";
* import * as aws from "@pulumi/aws";
*
* const connector = new aws.apprunner.VpcConnector("connector", {
* vpcConnectorName: "name",
* subnets: [
* "subnet1",
* "subnet2",
* ],
* securityGroups: [
* "sg1",
* "sg2",
* ],
* });
* ```
*
* ## Import
*
* ### Identity Schema
*
* #### Required
*
* - `arn` (String) Amazon Resource Name (ARN) of the App Runner VPC connector.
*
* Using `pulumi import`, import App Runner vpc connector using the `arn`. For example:
*
* console
*
* % pulumi import aws_apprunner_vpc_connector.example arn:aws:apprunner:us-east-1:1234567890:vpcconnector/example/1/0a03292a89764e5882c41d8f991c82fe
*/
export declare class VpcConnector extends pulumi.CustomResource {
/**
* Get an existing VpcConnector 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?: VpcConnectorState, opts?: pulumi.CustomResourceOptions): VpcConnector;
/**
* Returns true if the given object is an instance of VpcConnector. 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 VpcConnector;
/**
* ARN of VPC connector.
*/
readonly arn: pulumi.Output<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.
*/
readonly region: pulumi.Output<string>;
/**
* List of IDs of security groups that App Runner should use for access to AWS resources under the specified subnets. If not specified, App Runner uses the default security group of the Amazon VPC. The default security group allows all outbound traffic.
*/
readonly securityGroups: pulumi.Output<string[]>;
/**
* Current state of the VPC connector. If the status of a connector revision is INACTIVE, it was deleted and can't be used. Inactive connector revisions are permanently removed some time after they are deleted.
*/
readonly status: pulumi.Output<string>;
/**
* List of IDs of subnets that App Runner should use when it associates your service with a custom Amazon VPC. Specify IDs of subnets of a single Amazon VPC. App Runner determines the Amazon VPC from the subnets you specify.
*/
readonly subnets: pulumi.Output<string[]>;
/**
* Key-value map of resource tags. 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;
}>;
/**
* Name for the VPC connector.
*/
readonly vpcConnectorName: pulumi.Output<string>;
/**
* The revision of VPC connector. It's unique among all the active connectors ("Status": "ACTIVE") that share the same Name.
*/
readonly vpcConnectorRevision: pulumi.Output<number>;
/**
* Create a VpcConnector 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: VpcConnectorArgs, opts?: pulumi.CustomResourceOptions);
}
/**
* Input properties used for looking up and filtering VpcConnector resources.
*/
export interface VpcConnectorState {
/**
* ARN of VPC connector.
*/
arn?: 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>;
/**
* List of IDs of security groups that App Runner should use for access to AWS resources under the specified subnets. If not specified, App Runner uses the default security group of the Amazon VPC. The default security group allows all outbound traffic.
*/
securityGroups?: pulumi.Input<pulumi.Input<string>[]>;
/**
* Current state of the VPC connector. If the status of a connector revision is INACTIVE, it was deleted and can't be used. Inactive connector revisions are permanently removed some time after they are deleted.
*/
status?: pulumi.Input<string>;
/**
* List of IDs of subnets that App Runner should use when it associates your service with a custom Amazon VPC. Specify IDs of subnets of a single Amazon VPC. App Runner determines the Amazon VPC from the subnets you specify.
*/
subnets?: pulumi.Input<pulumi.Input<string>[]>;
/**
* Key-value map of resource tags. 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>;
}>;
/**
* Name for the VPC connector.
*/
vpcConnectorName?: pulumi.Input<string>;
/**
* The revision of VPC connector. It's unique among all the active connectors ("Status": "ACTIVE") that share the same Name.
*/
vpcConnectorRevision?: pulumi.Input<number>;
}
/**
* The set of arguments for constructing a VpcConnector resource.
*/
export interface VpcConnectorArgs {
/**
* 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>;
/**
* List of IDs of security groups that App Runner should use for access to AWS resources under the specified subnets. If not specified, App Runner uses the default security group of the Amazon VPC. The default security group allows all outbound traffic.
*/
securityGroups: pulumi.Input<pulumi.Input<string>[]>;
/**
* List of IDs of subnets that App Runner should use when it associates your service with a custom Amazon VPC. Specify IDs of subnets of a single Amazon VPC. App Runner determines the Amazon VPC from the subnets you specify.
*/
subnets: pulumi.Input<pulumi.Input<string>[]>;
/**
* Key-value map of resource tags. 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>;
}>;
/**
* Name for the VPC connector.
*/
vpcConnectorName: pulumi.Input<string>;
}