1. Packages
  2. Cloudamqp Provider
  3. API Docs
  4. VpcConnect
CloudAMQP v3.21.0 published on Tuesday, Apr 8, 2025 by Pulumi

cloudamqp.VpcConnect

Explore with Pulumi AI

cloudamqp logo
CloudAMQP v3.21.0 published on Tuesday, Apr 8, 2025 by Pulumi

    Import

    cloudamqp_vpc_connect can be imported using CloudAMQP instance identifier. To

    retrieve the identifier, use [CloudAMQP API list intances].

    From Terraform v1.5.0, the import block can be used to import this resource:

    hcl

    import {

    to = cloudamqp_vpc_connect.this

    id = cloudamqp_instance.instance.id

    }

    Or use Terraform CLI:

    $ pulumi import cloudamqp:index/vpcConnect:VpcConnect vpc_connect <id>`
    

    Create VpcConnect Resource

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

    Constructor syntax

    new VpcConnect(name: string, args: VpcConnectArgs, opts?: CustomResourceOptions);
    @overload
    def VpcConnect(resource_name: str,
                   args: VpcConnectArgs,
                   opts: Optional[ResourceOptions] = None)
    
    @overload
    def VpcConnect(resource_name: str,
                   opts: Optional[ResourceOptions] = None,
                   instance_id: Optional[int] = None,
                   region: Optional[str] = None,
                   allowed_principals: Optional[Sequence[str]] = None,
                   allowed_projects: Optional[Sequence[str]] = None,
                   approved_subscriptions: Optional[Sequence[str]] = None,
                   sleep: Optional[int] = None,
                   timeout: Optional[int] = None)
    func NewVpcConnect(ctx *Context, name string, args VpcConnectArgs, opts ...ResourceOption) (*VpcConnect, error)
    public VpcConnect(string name, VpcConnectArgs args, CustomResourceOptions? opts = null)
    public VpcConnect(String name, VpcConnectArgs args)
    public VpcConnect(String name, VpcConnectArgs args, CustomResourceOptions options)
    
    type: cloudamqp:VpcConnect
    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 VpcConnectArgs
    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 VpcConnectArgs
    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 VpcConnectArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args VpcConnectArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args VpcConnectArgs
    The arguments to resource properties.
    options CustomResourceOptions
    Bag of options to control resource's behavior.

    Constructor example

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

    var vpcConnectResource = new CloudAmqp.VpcConnect("vpcConnectResource", new()
    {
        InstanceId = 0,
        Region = "string",
        AllowedPrincipals = new[]
        {
            "string",
        },
        AllowedProjects = new[]
        {
            "string",
        },
        ApprovedSubscriptions = new[]
        {
            "string",
        },
        Sleep = 0,
        Timeout = 0,
    });
    
    example, err := cloudamqp.NewVpcConnect(ctx, "vpcConnectResource", &cloudamqp.VpcConnectArgs{
    	InstanceId: pulumi.Int(0),
    	Region:     pulumi.String("string"),
    	AllowedPrincipals: pulumi.StringArray{
    		pulumi.String("string"),
    	},
    	AllowedProjects: pulumi.StringArray{
    		pulumi.String("string"),
    	},
    	ApprovedSubscriptions: pulumi.StringArray{
    		pulumi.String("string"),
    	},
    	Sleep:   pulumi.Int(0),
    	Timeout: pulumi.Int(0),
    })
    
    var vpcConnectResource = new VpcConnect("vpcConnectResource", VpcConnectArgs.builder()
        .instanceId(0)
        .region("string")
        .allowedPrincipals("string")
        .allowedProjects("string")
        .approvedSubscriptions("string")
        .sleep(0)
        .timeout(0)
        .build());
    
    vpc_connect_resource = cloudamqp.VpcConnect("vpcConnectResource",
        instance_id=0,
        region="string",
        allowed_principals=["string"],
        allowed_projects=["string"],
        approved_subscriptions=["string"],
        sleep=0,
        timeout=0)
    
    const vpcConnectResource = new cloudamqp.VpcConnect("vpcConnectResource", {
        instanceId: 0,
        region: "string",
        allowedPrincipals: ["string"],
        allowedProjects: ["string"],
        approvedSubscriptions: ["string"],
        sleep: 0,
        timeout: 0,
    });
    
    type: cloudamqp:VpcConnect
    properties:
        allowedPrincipals:
            - string
        allowedProjects:
            - string
        approvedSubscriptions:
            - string
        instanceId: 0
        region: string
        sleep: 0
        timeout: 0
    

    VpcConnect Resource Properties

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

    Inputs

    In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.

    The VpcConnect resource accepts the following input properties:

    InstanceId int
    The CloudAMQP instance identifier.
    Region string
    The region where the CloudAMQP instance is hosted.
    AllowedPrincipals List<string>
    List of allowed prinicpals used by AWS, see below table.
    AllowedProjects List<string>
    List of allowed projects used by GCP, see below table.
    ApprovedSubscriptions List<string>
    List of approved subscriptions used by Azure, see below table.
    Sleep int
    Configurable sleep time (seconds) when enable Private Service Connect. Default set to 10 seconds.
    Timeout int

    Configurable timeout time (seconds) when enable Private Service Connect. Default set to 1800 seconds.


    The allowed_principals, approved_subscriptions or allowed_projects data depends on the provider platform:

    | Platform | Description | Format | |---|---|---| | AWS | IAM ARN principals | arn:aws:iam::aws-account-id:rootarn:aws:iam::aws-account-id:user/user-name arn:aws:iam::aws-account-id:role/role-name | | Azure | Subscription (GUID) | XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX | | GCP | Project IDs [Google docs] | 6 to 30 lowercase letters, digits, or hyphens |

    InstanceId int
    The CloudAMQP instance identifier.
    Region string
    The region where the CloudAMQP instance is hosted.
    AllowedPrincipals []string
    List of allowed prinicpals used by AWS, see below table.
    AllowedProjects []string
    List of allowed projects used by GCP, see below table.
    ApprovedSubscriptions []string
    List of approved subscriptions used by Azure, see below table.
    Sleep int
    Configurable sleep time (seconds) when enable Private Service Connect. Default set to 10 seconds.
    Timeout int

    Configurable timeout time (seconds) when enable Private Service Connect. Default set to 1800 seconds.


    The allowed_principals, approved_subscriptions or allowed_projects data depends on the provider platform:

    | Platform | Description | Format | |---|---|---| | AWS | IAM ARN principals | arn:aws:iam::aws-account-id:rootarn:aws:iam::aws-account-id:user/user-name arn:aws:iam::aws-account-id:role/role-name | | Azure | Subscription (GUID) | XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX | | GCP | Project IDs [Google docs] | 6 to 30 lowercase letters, digits, or hyphens |

    instanceId Integer
    The CloudAMQP instance identifier.
    region String
    The region where the CloudAMQP instance is hosted.
    allowedPrincipals List<String>
    List of allowed prinicpals used by AWS, see below table.
    allowedProjects List<String>
    List of allowed projects used by GCP, see below table.
    approvedSubscriptions List<String>
    List of approved subscriptions used by Azure, see below table.
    sleep Integer
    Configurable sleep time (seconds) when enable Private Service Connect. Default set to 10 seconds.
    timeout Integer

    Configurable timeout time (seconds) when enable Private Service Connect. Default set to 1800 seconds.


    The allowed_principals, approved_subscriptions or allowed_projects data depends on the provider platform:

    | Platform | Description | Format | |---|---|---| | AWS | IAM ARN principals | arn:aws:iam::aws-account-id:rootarn:aws:iam::aws-account-id:user/user-name arn:aws:iam::aws-account-id:role/role-name | | Azure | Subscription (GUID) | XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX | | GCP | Project IDs [Google docs] | 6 to 30 lowercase letters, digits, or hyphens |

    instanceId number
    The CloudAMQP instance identifier.
    region string
    The region where the CloudAMQP instance is hosted.
    allowedPrincipals string[]
    List of allowed prinicpals used by AWS, see below table.
    allowedProjects string[]
    List of allowed projects used by GCP, see below table.
    approvedSubscriptions string[]
    List of approved subscriptions used by Azure, see below table.
    sleep number
    Configurable sleep time (seconds) when enable Private Service Connect. Default set to 10 seconds.
    timeout number

    Configurable timeout time (seconds) when enable Private Service Connect. Default set to 1800 seconds.


    The allowed_principals, approved_subscriptions or allowed_projects data depends on the provider platform:

    | Platform | Description | Format | |---|---|---| | AWS | IAM ARN principals | arn:aws:iam::aws-account-id:rootarn:aws:iam::aws-account-id:user/user-name arn:aws:iam::aws-account-id:role/role-name | | Azure | Subscription (GUID) | XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX | | GCP | Project IDs [Google docs] | 6 to 30 lowercase letters, digits, or hyphens |

    instance_id int
    The CloudAMQP instance identifier.
    region str
    The region where the CloudAMQP instance is hosted.
    allowed_principals Sequence[str]
    List of allowed prinicpals used by AWS, see below table.
    allowed_projects Sequence[str]
    List of allowed projects used by GCP, see below table.
    approved_subscriptions Sequence[str]
    List of approved subscriptions used by Azure, see below table.
    sleep int
    Configurable sleep time (seconds) when enable Private Service Connect. Default set to 10 seconds.
    timeout int

    Configurable timeout time (seconds) when enable Private Service Connect. Default set to 1800 seconds.


    The allowed_principals, approved_subscriptions or allowed_projects data depends on the provider platform:

    | Platform | Description | Format | |---|---|---| | AWS | IAM ARN principals | arn:aws:iam::aws-account-id:rootarn:aws:iam::aws-account-id:user/user-name arn:aws:iam::aws-account-id:role/role-name | | Azure | Subscription (GUID) | XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX | | GCP | Project IDs [Google docs] | 6 to 30 lowercase letters, digits, or hyphens |

    instanceId Number
    The CloudAMQP instance identifier.
    region String
    The region where the CloudAMQP instance is hosted.
    allowedPrincipals List<String>
    List of allowed prinicpals used by AWS, see below table.
    allowedProjects List<String>
    List of allowed projects used by GCP, see below table.
    approvedSubscriptions List<String>
    List of approved subscriptions used by Azure, see below table.
    sleep Number
    Configurable sleep time (seconds) when enable Private Service Connect. Default set to 10 seconds.
    timeout Number

    Configurable timeout time (seconds) when enable Private Service Connect. Default set to 1800 seconds.


    The allowed_principals, approved_subscriptions or allowed_projects data depends on the provider platform:

    | Platform | Description | Format | |---|---|---| | AWS | IAM ARN principals | arn:aws:iam::aws-account-id:rootarn:aws:iam::aws-account-id:user/user-name arn:aws:iam::aws-account-id:role/role-name | | Azure | Subscription (GUID) | XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX | | GCP | Project IDs [Google docs] | 6 to 30 lowercase letters, digits, or hyphens |

    Outputs

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

    ActiveZones List<string>
    Covering availability zones used when creating an endpoint from other VPC. (AWS)
    Id string
    The provider-assigned unique ID for this managed resource.
    ServiceName string
    Service name (alias for Azure, see example above) of the PrivateLink.
    Status string
    Private Service Connect status [enable, pending, disable]
    ActiveZones []string
    Covering availability zones used when creating an endpoint from other VPC. (AWS)
    Id string
    The provider-assigned unique ID for this managed resource.
    ServiceName string
    Service name (alias for Azure, see example above) of the PrivateLink.
    Status string
    Private Service Connect status [enable, pending, disable]
    activeZones List<String>
    Covering availability zones used when creating an endpoint from other VPC. (AWS)
    id String
    The provider-assigned unique ID for this managed resource.
    serviceName String
    Service name (alias for Azure, see example above) of the PrivateLink.
    status String
    Private Service Connect status [enable, pending, disable]
    activeZones string[]
    Covering availability zones used when creating an endpoint from other VPC. (AWS)
    id string
    The provider-assigned unique ID for this managed resource.
    serviceName string
    Service name (alias for Azure, see example above) of the PrivateLink.
    status string
    Private Service Connect status [enable, pending, disable]
    active_zones Sequence[str]
    Covering availability zones used when creating an endpoint from other VPC. (AWS)
    id str
    The provider-assigned unique ID for this managed resource.
    service_name str
    Service name (alias for Azure, see example above) of the PrivateLink.
    status str
    Private Service Connect status [enable, pending, disable]
    activeZones List<String>
    Covering availability zones used when creating an endpoint from other VPC. (AWS)
    id String
    The provider-assigned unique ID for this managed resource.
    serviceName String
    Service name (alias for Azure, see example above) of the PrivateLink.
    status String
    Private Service Connect status [enable, pending, disable]

    Look up Existing VpcConnect Resource

    Get an existing VpcConnect resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.

    public static get(name: string, id: Input<ID>, state?: VpcConnectState, opts?: CustomResourceOptions): VpcConnect
    @staticmethod
    def get(resource_name: str,
            id: str,
            opts: Optional[ResourceOptions] = None,
            active_zones: Optional[Sequence[str]] = None,
            allowed_principals: Optional[Sequence[str]] = None,
            allowed_projects: Optional[Sequence[str]] = None,
            approved_subscriptions: Optional[Sequence[str]] = None,
            instance_id: Optional[int] = None,
            region: Optional[str] = None,
            service_name: Optional[str] = None,
            sleep: Optional[int] = None,
            status: Optional[str] = None,
            timeout: Optional[int] = None) -> VpcConnect
    func GetVpcConnect(ctx *Context, name string, id IDInput, state *VpcConnectState, opts ...ResourceOption) (*VpcConnect, error)
    public static VpcConnect Get(string name, Input<string> id, VpcConnectState? state, CustomResourceOptions? opts = null)
    public static VpcConnect get(String name, Output<String> id, VpcConnectState state, CustomResourceOptions options)
    resources:  _:    type: cloudamqp:VpcConnect    get:      id: ${id}
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    resource_name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    The following state arguments are supported:
    ActiveZones List<string>
    Covering availability zones used when creating an endpoint from other VPC. (AWS)
    AllowedPrincipals List<string>
    List of allowed prinicpals used by AWS, see below table.
    AllowedProjects List<string>
    List of allowed projects used by GCP, see below table.
    ApprovedSubscriptions List<string>
    List of approved subscriptions used by Azure, see below table.
    InstanceId int
    The CloudAMQP instance identifier.
    Region string
    The region where the CloudAMQP instance is hosted.
    ServiceName string
    Service name (alias for Azure, see example above) of the PrivateLink.
    Sleep int
    Configurable sleep time (seconds) when enable Private Service Connect. Default set to 10 seconds.
    Status string
    Private Service Connect status [enable, pending, disable]
    Timeout int

    Configurable timeout time (seconds) when enable Private Service Connect. Default set to 1800 seconds.


    The allowed_principals, approved_subscriptions or allowed_projects data depends on the provider platform:

    | Platform | Description | Format | |---|---|---| | AWS | IAM ARN principals | arn:aws:iam::aws-account-id:rootarn:aws:iam::aws-account-id:user/user-name arn:aws:iam::aws-account-id:role/role-name | | Azure | Subscription (GUID) | XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX | | GCP | Project IDs [Google docs] | 6 to 30 lowercase letters, digits, or hyphens |

    ActiveZones []string
    Covering availability zones used when creating an endpoint from other VPC. (AWS)
    AllowedPrincipals []string
    List of allowed prinicpals used by AWS, see below table.
    AllowedProjects []string
    List of allowed projects used by GCP, see below table.
    ApprovedSubscriptions []string
    List of approved subscriptions used by Azure, see below table.
    InstanceId int
    The CloudAMQP instance identifier.
    Region string
    The region where the CloudAMQP instance is hosted.
    ServiceName string
    Service name (alias for Azure, see example above) of the PrivateLink.
    Sleep int
    Configurable sleep time (seconds) when enable Private Service Connect. Default set to 10 seconds.
    Status string
    Private Service Connect status [enable, pending, disable]
    Timeout int

    Configurable timeout time (seconds) when enable Private Service Connect. Default set to 1800 seconds.


    The allowed_principals, approved_subscriptions or allowed_projects data depends on the provider platform:

    | Platform | Description | Format | |---|---|---| | AWS | IAM ARN principals | arn:aws:iam::aws-account-id:rootarn:aws:iam::aws-account-id:user/user-name arn:aws:iam::aws-account-id:role/role-name | | Azure | Subscription (GUID) | XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX | | GCP | Project IDs [Google docs] | 6 to 30 lowercase letters, digits, or hyphens |

    activeZones List<String>
    Covering availability zones used when creating an endpoint from other VPC. (AWS)
    allowedPrincipals List<String>
    List of allowed prinicpals used by AWS, see below table.
    allowedProjects List<String>
    List of allowed projects used by GCP, see below table.
    approvedSubscriptions List<String>
    List of approved subscriptions used by Azure, see below table.
    instanceId Integer
    The CloudAMQP instance identifier.
    region String
    The region where the CloudAMQP instance is hosted.
    serviceName String
    Service name (alias for Azure, see example above) of the PrivateLink.
    sleep Integer
    Configurable sleep time (seconds) when enable Private Service Connect. Default set to 10 seconds.
    status String
    Private Service Connect status [enable, pending, disable]
    timeout Integer

    Configurable timeout time (seconds) when enable Private Service Connect. Default set to 1800 seconds.


    The allowed_principals, approved_subscriptions or allowed_projects data depends on the provider platform:

    | Platform | Description | Format | |---|---|---| | AWS | IAM ARN principals | arn:aws:iam::aws-account-id:rootarn:aws:iam::aws-account-id:user/user-name arn:aws:iam::aws-account-id:role/role-name | | Azure | Subscription (GUID) | XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX | | GCP | Project IDs [Google docs] | 6 to 30 lowercase letters, digits, or hyphens |

    activeZones string[]
    Covering availability zones used when creating an endpoint from other VPC. (AWS)
    allowedPrincipals string[]
    List of allowed prinicpals used by AWS, see below table.
    allowedProjects string[]
    List of allowed projects used by GCP, see below table.
    approvedSubscriptions string[]
    List of approved subscriptions used by Azure, see below table.
    instanceId number
    The CloudAMQP instance identifier.
    region string
    The region where the CloudAMQP instance is hosted.
    serviceName string
    Service name (alias for Azure, see example above) of the PrivateLink.
    sleep number
    Configurable sleep time (seconds) when enable Private Service Connect. Default set to 10 seconds.
    status string
    Private Service Connect status [enable, pending, disable]
    timeout number

    Configurable timeout time (seconds) when enable Private Service Connect. Default set to 1800 seconds.


    The allowed_principals, approved_subscriptions or allowed_projects data depends on the provider platform:

    | Platform | Description | Format | |---|---|---| | AWS | IAM ARN principals | arn:aws:iam::aws-account-id:rootarn:aws:iam::aws-account-id:user/user-name arn:aws:iam::aws-account-id:role/role-name | | Azure | Subscription (GUID) | XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX | | GCP | Project IDs [Google docs] | 6 to 30 lowercase letters, digits, or hyphens |

    active_zones Sequence[str]
    Covering availability zones used when creating an endpoint from other VPC. (AWS)
    allowed_principals Sequence[str]
    List of allowed prinicpals used by AWS, see below table.
    allowed_projects Sequence[str]
    List of allowed projects used by GCP, see below table.
    approved_subscriptions Sequence[str]
    List of approved subscriptions used by Azure, see below table.
    instance_id int
    The CloudAMQP instance identifier.
    region str
    The region where the CloudAMQP instance is hosted.
    service_name str
    Service name (alias for Azure, see example above) of the PrivateLink.
    sleep int
    Configurable sleep time (seconds) when enable Private Service Connect. Default set to 10 seconds.
    status str
    Private Service Connect status [enable, pending, disable]
    timeout int

    Configurable timeout time (seconds) when enable Private Service Connect. Default set to 1800 seconds.


    The allowed_principals, approved_subscriptions or allowed_projects data depends on the provider platform:

    | Platform | Description | Format | |---|---|---| | AWS | IAM ARN principals | arn:aws:iam::aws-account-id:rootarn:aws:iam::aws-account-id:user/user-name arn:aws:iam::aws-account-id:role/role-name | | Azure | Subscription (GUID) | XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX | | GCP | Project IDs [Google docs] | 6 to 30 lowercase letters, digits, or hyphens |

    activeZones List<String>
    Covering availability zones used when creating an endpoint from other VPC. (AWS)
    allowedPrincipals List<String>
    List of allowed prinicpals used by AWS, see below table.
    allowedProjects List<String>
    List of allowed projects used by GCP, see below table.
    approvedSubscriptions List<String>
    List of approved subscriptions used by Azure, see below table.
    instanceId Number
    The CloudAMQP instance identifier.
    region String
    The region where the CloudAMQP instance is hosted.
    serviceName String
    Service name (alias for Azure, see example above) of the PrivateLink.
    sleep Number
    Configurable sleep time (seconds) when enable Private Service Connect. Default set to 10 seconds.
    status String
    Private Service Connect status [enable, pending, disable]
    timeout Number

    Configurable timeout time (seconds) when enable Private Service Connect. Default set to 1800 seconds.


    The allowed_principals, approved_subscriptions or allowed_projects data depends on the provider platform:

    | Platform | Description | Format | |---|---|---| | AWS | IAM ARN principals | arn:aws:iam::aws-account-id:rootarn:aws:iam::aws-account-id:user/user-name arn:aws:iam::aws-account-id:role/role-name | | Azure | Subscription (GUID) | XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX | | GCP | Project IDs [Google docs] | 6 to 30 lowercase letters, digits, or hyphens |

    Package Details

    Repository
    CloudAMQP pulumi/pulumi-cloudamqp
    License
    Apache-2.0
    Notes
    This Pulumi package is based on the cloudamqp Terraform Provider.
    cloudamqp logo
    CloudAMQP v3.21.0 published on Tuesday, Apr 8, 2025 by Pulumi