1. Packages
  2. AWS Native
  3. API Docs
  4. apprunner
  5. VpcConnector

AWS Native is in preview. AWS Classic is fully supported.

AWS Native v0.102.0 published on Tuesday, Apr 16, 2024 by Pulumi

aws-native.apprunner.VpcConnector

Explore with Pulumi AI

aws-native logo

AWS Native is in preview. AWS Classic is fully supported.

AWS Native v0.102.0 published on Tuesday, Apr 16, 2024 by Pulumi

    The AWS::AppRunner::VpcConnector resource specifies an App Runner VpcConnector.

    Create VpcConnector Resource

    Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.

    Constructor syntax

    new VpcConnector(name: string, args: VpcConnectorArgs, opts?: CustomResourceOptions);
    @overload
    def VpcConnector(resource_name: str,
                     args: VpcConnectorArgs,
                     opts: Optional[ResourceOptions] = None)
    
    @overload
    def VpcConnector(resource_name: str,
                     opts: Optional[ResourceOptions] = None,
                     subnets: Optional[Sequence[str]] = None,
                     security_groups: Optional[Sequence[str]] = None,
                     tags: Optional[Sequence[_root_inputs.CreateOnlyTagArgs]] = None,
                     vpc_connector_name: Optional[str] = None)
    func NewVpcConnector(ctx *Context, name string, args VpcConnectorArgs, opts ...ResourceOption) (*VpcConnector, error)
    public VpcConnector(string name, VpcConnectorArgs args, CustomResourceOptions? opts = null)
    public VpcConnector(String name, VpcConnectorArgs args)
    public VpcConnector(String name, VpcConnectorArgs args, CustomResourceOptions options)
    
    type: aws-native:apprunner:VpcConnector
    properties: # The arguments to resource properties.
    options: # Bag of options to control resource's behavior.
    
    

    Parameters

    name string
    The unique name of the resource.
    args VpcConnectorArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    resource_name str
    The unique name of the resource.
    args VpcConnectorArgs
    The arguments to resource properties.
    opts ResourceOptions
    Bag of options to control resource's behavior.
    ctx Context
    Context object for the current deployment.
    name string
    The unique name of the resource.
    args VpcConnectorArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args VpcConnectorArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args VpcConnectorArgs
    The arguments to resource properties.
    options CustomResourceOptions
    Bag of options to control resource's behavior.

    Example

    The following reference example uses placeholder values for all input properties.

    Coming soon!
    
    Coming soon!
    
    Coming soon!
    
    Coming soon!
    
    const vpcConnectorResource = new aws_native.apprunner.VpcConnector("vpcConnectorResource", {
        subnets: ["string"],
        securityGroups: ["string"],
        tags: [{
            key: "string",
            value: "string",
        }],
        vpcConnectorName: "string",
    });
    
    Coming soon!
    

    VpcConnector Resource Properties

    To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.

    Inputs

    The VpcConnector resource accepts the following input properties:

    Subnets List<string>
    A 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.
    SecurityGroups List<string>
    A 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.
    Tags List<Pulumi.AwsNative.Inputs.CreateOnlyTag>
    A list of metadata items that you can associate with your VPC connector resource. A tag is a key-value pair.
    VpcConnectorName string
    A name for the VPC connector. If you don't specify a name, AWS CloudFormation generates a name for your VPC connector.
    Subnets []string
    A 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.
    SecurityGroups []string
    A 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.
    Tags CreateOnlyTagArgs
    A list of metadata items that you can associate with your VPC connector resource. A tag is a key-value pair.
    VpcConnectorName string
    A name for the VPC connector. If you don't specify a name, AWS CloudFormation generates a name for your VPC connector.
    subnets List<String>
    A 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.
    securityGroups List<String>
    A 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.
    tags List<CreateOnlyTag>
    A list of metadata items that you can associate with your VPC connector resource. A tag is a key-value pair.
    vpcConnectorName String
    A name for the VPC connector. If you don't specify a name, AWS CloudFormation generates a name for your VPC connector.
    subnets string[]
    A 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.
    securityGroups string[]
    A 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.
    tags CreateOnlyTag[]
    A list of metadata items that you can associate with your VPC connector resource. A tag is a key-value pair.
    vpcConnectorName string
    A name for the VPC connector. If you don't specify a name, AWS CloudFormation generates a name for your VPC connector.
    subnets Sequence[str]
    A 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.
    security_groups Sequence[str]
    A 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.
    tags Sequence[CreateOnlyTagArgs]
    A list of metadata items that you can associate with your VPC connector resource. A tag is a key-value pair.
    vpc_connector_name str
    A name for the VPC connector. If you don't specify a name, AWS CloudFormation generates a name for your VPC connector.
    subnets List<String>
    A 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.
    securityGroups List<String>
    A 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.
    tags List<Property Map>
    A list of metadata items that you can associate with your VPC connector resource. A tag is a key-value pair.
    vpcConnectorName String
    A name for the VPC connector. If you don't specify a name, AWS CloudFormation generates a name for your VPC connector.

    Outputs

    All input properties are implicitly available as output properties. Additionally, the VpcConnector resource produces the following output properties:

    Id string
    The provider-assigned unique ID for this managed resource.
    VpcConnectorArn string
    The Amazon Resource Name (ARN) of this VPC connector.
    VpcConnectorRevision int
    The revision of this VPC connector. It's unique among all the active connectors ("Status": "ACTIVE") that share the same Name.
    Id string
    The provider-assigned unique ID for this managed resource.
    VpcConnectorArn string
    The Amazon Resource Name (ARN) of this VPC connector.
    VpcConnectorRevision int
    The revision of this VPC connector. It's unique among all the active connectors ("Status": "ACTIVE") that share the same Name.
    id String
    The provider-assigned unique ID for this managed resource.
    vpcConnectorArn String
    The Amazon Resource Name (ARN) of this VPC connector.
    vpcConnectorRevision Integer
    The revision of this VPC connector. It's unique among all the active connectors ("Status": "ACTIVE") that share the same Name.
    id string
    The provider-assigned unique ID for this managed resource.
    vpcConnectorArn string
    The Amazon Resource Name (ARN) of this VPC connector.
    vpcConnectorRevision number
    The revision of this VPC connector. It's unique among all the active connectors ("Status": "ACTIVE") that share the same Name.
    id str
    The provider-assigned unique ID for this managed resource.
    vpc_connector_arn str
    The Amazon Resource Name (ARN) of this VPC connector.
    vpc_connector_revision int
    The revision of this VPC connector. It's unique among all the active connectors ("Status": "ACTIVE") that share the same Name.
    id String
    The provider-assigned unique ID for this managed resource.
    vpcConnectorArn String
    The Amazon Resource Name (ARN) of this VPC connector.
    vpcConnectorRevision Number
    The revision of this VPC connector. It's unique among all the active connectors ("Status": "ACTIVE") that share the same Name.

    Supporting Types

    CreateOnlyTag, CreateOnlyTagArgs

    Key string
    The key name of the tag
    Value string
    The value of the tag
    Key string
    The key name of the tag
    Value string
    The value of the tag
    key String
    The key name of the tag
    value String
    The value of the tag
    key string
    The key name of the tag
    value string
    The value of the tag
    key str
    The key name of the tag
    value str
    The value of the tag
    key String
    The key name of the tag
    value String
    The value of the tag

    Package Details

    Repository
    AWS Native pulumi/pulumi-aws-native
    License
    Apache-2.0
    aws-native logo

    AWS Native is in preview. AWS Classic is fully supported.

    AWS Native v0.102.0 published on Tuesday, Apr 16, 2024 by Pulumi