1. Packages
  2. AWS Cloud Control
  3. API Docs
  4. ec2
  5. VpcPeeringConnection

We recommend new projects start with resources from the AWS provider.

AWS Cloud Control v1.0.1 published on Tuesday, Oct 1, 2024 by Pulumi

aws-native.ec2.VpcPeeringConnection

Explore with Pulumi AI

aws-native logo

We recommend new projects start with resources from the AWS provider.

AWS Cloud Control v1.0.1 published on Tuesday, Oct 1, 2024 by Pulumi

    Resource Type definition for AWS::EC2::VPCPeeringConnection

    Create VpcPeeringConnection Resource

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

    Constructor syntax

    new VpcPeeringConnection(name: string, args: VpcPeeringConnectionArgs, opts?: CustomResourceOptions);
    @overload
    def VpcPeeringConnection(resource_name: str,
                             args: VpcPeeringConnectionArgs,
                             opts: Optional[ResourceOptions] = None)
    
    @overload
    def VpcPeeringConnection(resource_name: str,
                             opts: Optional[ResourceOptions] = None,
                             peer_vpc_id: Optional[str] = None,
                             vpc_id: Optional[str] = None,
                             peer_owner_id: Optional[str] = None,
                             peer_region: Optional[str] = None,
                             peer_role_arn: Optional[str] = None,
                             tags: Optional[Sequence[_root_inputs.TagArgs]] = None)
    func NewVpcPeeringConnection(ctx *Context, name string, args VpcPeeringConnectionArgs, opts ...ResourceOption) (*VpcPeeringConnection, error)
    public VpcPeeringConnection(string name, VpcPeeringConnectionArgs args, CustomResourceOptions? opts = null)
    public VpcPeeringConnection(String name, VpcPeeringConnectionArgs args)
    public VpcPeeringConnection(String name, VpcPeeringConnectionArgs args, CustomResourceOptions options)
    
    type: aws-native:ec2:VpcPeeringConnection
    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 VpcPeeringConnectionArgs
    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 VpcPeeringConnectionArgs
    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 VpcPeeringConnectionArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args VpcPeeringConnectionArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args VpcPeeringConnectionArgs
    The arguments to resource properties.
    options CustomResourceOptions
    Bag of options to control resource's behavior.

    VpcPeeringConnection 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 VpcPeeringConnection resource accepts the following input properties:

    PeerVpcId string
    The ID of the VPC with which you are creating the VPC peering connection. You must specify this parameter in the request.
    VpcId string
    The ID of the VPC.
    PeerOwnerId string
    The AWS account ID of the owner of the accepter VPC.
    PeerRegion string
    The Region code for the accepter VPC, if the accepter VPC is located in a Region other than the Region in which you make the request.
    PeerRoleArn string
    The Amazon Resource Name (ARN) of the VPC peer role for the peering connection in another AWS account.
    Tags List<Pulumi.AwsNative.Inputs.Tag>
    Any tags assigned to the resource.
    PeerVpcId string
    The ID of the VPC with which you are creating the VPC peering connection. You must specify this parameter in the request.
    VpcId string
    The ID of the VPC.
    PeerOwnerId string
    The AWS account ID of the owner of the accepter VPC.
    PeerRegion string
    The Region code for the accepter VPC, if the accepter VPC is located in a Region other than the Region in which you make the request.
    PeerRoleArn string
    The Amazon Resource Name (ARN) of the VPC peer role for the peering connection in another AWS account.
    Tags TagArgs
    Any tags assigned to the resource.
    peerVpcId String
    The ID of the VPC with which you are creating the VPC peering connection. You must specify this parameter in the request.
    vpcId String
    The ID of the VPC.
    peerOwnerId String
    The AWS account ID of the owner of the accepter VPC.
    peerRegion String
    The Region code for the accepter VPC, if the accepter VPC is located in a Region other than the Region in which you make the request.
    peerRoleArn String
    The Amazon Resource Name (ARN) of the VPC peer role for the peering connection in another AWS account.
    tags List<Tag>
    Any tags assigned to the resource.
    peerVpcId string
    The ID of the VPC with which you are creating the VPC peering connection. You must specify this parameter in the request.
    vpcId string
    The ID of the VPC.
    peerOwnerId string
    The AWS account ID of the owner of the accepter VPC.
    peerRegion string
    The Region code for the accepter VPC, if the accepter VPC is located in a Region other than the Region in which you make the request.
    peerRoleArn string
    The Amazon Resource Name (ARN) of the VPC peer role for the peering connection in another AWS account.
    tags Tag[]
    Any tags assigned to the resource.
    peer_vpc_id str
    The ID of the VPC with which you are creating the VPC peering connection. You must specify this parameter in the request.
    vpc_id str
    The ID of the VPC.
    peer_owner_id str
    The AWS account ID of the owner of the accepter VPC.
    peer_region str
    The Region code for the accepter VPC, if the accepter VPC is located in a Region other than the Region in which you make the request.
    peer_role_arn str
    The Amazon Resource Name (ARN) of the VPC peer role for the peering connection in another AWS account.
    tags Sequence[TagArgs]
    Any tags assigned to the resource.
    peerVpcId String
    The ID of the VPC with which you are creating the VPC peering connection. You must specify this parameter in the request.
    vpcId String
    The ID of the VPC.
    peerOwnerId String
    The AWS account ID of the owner of the accepter VPC.
    peerRegion String
    The Region code for the accepter VPC, if the accepter VPC is located in a Region other than the Region in which you make the request.
    peerRoleArn String
    The Amazon Resource Name (ARN) of the VPC peer role for the peering connection in another AWS account.
    tags List<Property Map>
    Any tags assigned to the resource.

    Outputs

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

    AwsId string
    The ID of the peering connection.
    Id string
    The provider-assigned unique ID for this managed resource.
    AwsId string
    The ID of the peering connection.
    Id string
    The provider-assigned unique ID for this managed resource.
    awsId String
    The ID of the peering connection.
    id String
    The provider-assigned unique ID for this managed resource.
    awsId string
    The ID of the peering connection.
    id string
    The provider-assigned unique ID for this managed resource.
    aws_id str
    The ID of the peering connection.
    id str
    The provider-assigned unique ID for this managed resource.
    awsId String
    The ID of the peering connection.
    id String
    The provider-assigned unique ID for this managed resource.

    Supporting Types

    Tag, TagArgs

    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

    We recommend new projects start with resources from the AWS provider.

    AWS Cloud Control v1.0.1 published on Tuesday, Oct 1, 2024 by Pulumi