Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi Cloud Packages Tutorials
  1. Packages
  2. Cloudamqp Provider
  3. API Docs
  4. PrivatelinkAws
CloudAMQP v3.21.0 published on Tuesday, Apr 8, 2025 by Pulumi
pulumi/pulumi-cloudamqp

cloudamqp.PrivatelinkAws

Explore with Pulumi AI

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

    Import

    cloudamqp_privatelink_aws 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_privatelink_aws.privatelink

    id = cloudamqp_instance.instance.id

    }

    Or use Terraform CLI:

    $ pulumi import cloudamqp:index/privatelinkAws:PrivatelinkAws privatelink <id>`

    Create PrivatelinkAws Resource

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

    Constructor syntax

    new PrivatelinkAws(name: string, args: PrivatelinkAwsArgs, opts?: CustomResourceOptions);
    @overload
def PrivatelinkAws(resource_name: str,
                   args: PrivatelinkAwsArgs,
                   opts: Optional[ResourceOptions] = None)

@overload
def PrivatelinkAws(resource_name: str,
                   opts: Optional[ResourceOptions] = None,
                   allowed_principals: Optional[Sequence[str]] = None,
                   instance_id: Optional[int] = None,
                   sleep: Optional[int] = None,
                   timeout: Optional[int] = None)
    func NewPrivatelinkAws(ctx *Context, name string, args PrivatelinkAwsArgs, opts ...ResourceOption) (*PrivatelinkAws, error)
    public PrivatelinkAws(string name, PrivatelinkAwsArgs args, CustomResourceOptions? opts = null)
    public PrivatelinkAws(String name, PrivatelinkAwsArgs args)
public PrivatelinkAws(String name, PrivatelinkAwsArgs args, CustomResourceOptions options)

    type: cloudamqp:PrivatelinkAws
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 PrivatelinkAwsArgs
    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 PrivatelinkAwsArgs
    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 PrivatelinkAwsArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args PrivatelinkAwsArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args PrivatelinkAwsArgs
    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 privatelinkAwsResource = new CloudAmqp.PrivatelinkAws("privatelinkAwsResource", new()
{
    AllowedPrincipals = new[]
    {
        "string",
    },
    InstanceId = 0,
    Sleep = 0,
    Timeout = 0,
});

    example, err := cloudamqp.NewPrivatelinkAws(ctx, "privatelinkAwsResource", &cloudamqp.PrivatelinkAwsArgs{
	AllowedPrincipals: pulumi.StringArray{
		pulumi.String("string"),
	},
	InstanceId: pulumi.Int(0),
	Sleep:      pulumi.Int(0),
	Timeout:    pulumi.Int(0),
})

    var privatelinkAwsResource = new PrivatelinkAws("privatelinkAwsResource", PrivatelinkAwsArgs.builder()
    .allowedPrincipals("string")
    .instanceId(0)
    .sleep(0)
    .timeout(0)
    .build());

    privatelink_aws_resource = cloudamqp.PrivatelinkAws("privatelinkAwsResource",
    allowed_principals=["string"],
    instance_id=0,
    sleep=0,
    timeout=0)

    const privatelinkAwsResource = new cloudamqp.PrivatelinkAws("privatelinkAwsResource", {
    allowedPrincipals: ["string"],
    instanceId: 0,
    sleep: 0,
    timeout: 0,
});

    type: cloudamqp:PrivatelinkAws
properties:
    allowedPrincipals:
        - string
    instanceId: 0
    sleep: 0
    timeout: 0

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

    AllowedPrincipals List<string>
    Allowed principals to access the endpoint service.
    InstanceId int
    The CloudAMQP instance identifier.
    Sleep int

    Configurable sleep time (seconds) when enable PrivateLink. Default set to 10 seconds.

    Note: Available from [v1.29.0]

    Timeout int

    Configurable timeout time (seconds) when enable PrivateLink. Default set to 1800 seconds.

    Note: Available from [v1.29.0]

    Allowed principals format: arn:aws:iam::aws-account-id:root arn:aws:iam::aws-account-id:user/user-name arn:aws:iam::aws-account-id:role/role-name

    AllowedPrincipals []string
    Allowed principals to access the endpoint service.
    InstanceId int
    The CloudAMQP instance identifier.
    Sleep int

    Configurable sleep time (seconds) when enable PrivateLink. Default set to 10 seconds.

    Note: Available from [v1.29.0]

    Timeout int

    Configurable timeout time (seconds) when enable PrivateLink. Default set to 1800 seconds.

    Note: Available from [v1.29.0]

    Allowed principals format: arn:aws:iam::aws-account-id:root arn:aws:iam::aws-account-id:user/user-name arn:aws:iam::aws-account-id:role/role-name

    allowedPrincipals List<String>
    Allowed principals to access the endpoint service.
    instanceId Integer
    The CloudAMQP instance identifier.
    sleep Integer

    Configurable sleep time (seconds) when enable PrivateLink. Default set to 10 seconds.

    Note: Available from [v1.29.0]

    timeout Integer

    Configurable timeout time (seconds) when enable PrivateLink. Default set to 1800 seconds.

    Note: Available from [v1.29.0]

    Allowed principals format: arn:aws:iam::aws-account-id:root arn:aws:iam::aws-account-id:user/user-name arn:aws:iam::aws-account-id:role/role-name

    allowedPrincipals string[]
    Allowed principals to access the endpoint service.
    instanceId number
    The CloudAMQP instance identifier.
    sleep number

    Configurable sleep time (seconds) when enable PrivateLink. Default set to 10 seconds.

    Note: Available from [v1.29.0]

    timeout number

    Configurable timeout time (seconds) when enable PrivateLink. Default set to 1800 seconds.

    Note: Available from [v1.29.0]

    Allowed principals format: arn:aws:iam::aws-account-id:root arn:aws:iam::aws-account-id:user/user-name arn:aws:iam::aws-account-id:role/role-name

    allowed_principals Sequence[str]
    Allowed principals to access the endpoint service.
    instance_id int
    The CloudAMQP instance identifier.
    sleep int

    Configurable sleep time (seconds) when enable PrivateLink. Default set to 10 seconds.

    Note: Available from [v1.29.0]

    timeout int

    Configurable timeout time (seconds) when enable PrivateLink. Default set to 1800 seconds.

    Note: Available from [v1.29.0]

    Allowed principals format: arn:aws:iam::aws-account-id:root arn:aws:iam::aws-account-id:user/user-name arn:aws:iam::aws-account-id:role/role-name

    allowedPrincipals List<String>
    Allowed principals to access the endpoint service.
    instanceId Number
    The CloudAMQP instance identifier.
    sleep Number

    Configurable sleep time (seconds) when enable PrivateLink. Default set to 10 seconds.

    Note: Available from [v1.29.0]

    timeout Number

    Configurable timeout time (seconds) when enable PrivateLink. Default set to 1800 seconds.

    Note: Available from [v1.29.0]

    Allowed principals format: arn:aws:iam::aws-account-id:root arn:aws:iam::aws-account-id:user/user-name arn:aws:iam::aws-account-id:role/role-name

    Outputs

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

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

    Look up Existing PrivatelinkAws Resource

    Get an existing PrivatelinkAws 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?: PrivatelinkAwsState, opts?: CustomResourceOptions): PrivatelinkAws
    @staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        active_zones: Optional[Sequence[str]] = None,
        allowed_principals: Optional[Sequence[str]] = None,
        instance_id: Optional[int] = None,
        service_name: Optional[str] = None,
        sleep: Optional[int] = None,
        status: Optional[str] = None,
        timeout: Optional[int] = None) -> PrivatelinkAws
    func GetPrivatelinkAws(ctx *Context, name string, id IDInput, state *PrivatelinkAwsState, opts ...ResourceOption) (*PrivatelinkAws, error)
    public static PrivatelinkAws Get(string name, Input<string> id, PrivatelinkAwsState? state, CustomResourceOptions? opts = null)
    public static PrivatelinkAws get(String name, Output<String> id, PrivatelinkAwsState state, CustomResourceOptions options)
    resources:  _:    type: cloudamqp:PrivatelinkAws    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.
    AllowedPrincipals List<string>
    Allowed principals to access the endpoint service.
    InstanceId int
    The CloudAMQP instance identifier.
    ServiceName string
    Service name of the PrivateLink used when creating the endpoint from other VPC.
    Sleep int

    Configurable sleep time (seconds) when enable PrivateLink. Default set to 10 seconds.

    Note: Available from [v1.29.0]

    Status string
    PrivateLink status [enable, pending, disable]
    Timeout int

    Configurable timeout time (seconds) when enable PrivateLink. Default set to 1800 seconds.

    Note: Available from [v1.29.0]

    Allowed principals format: arn:aws:iam::aws-account-id:root arn:aws:iam::aws-account-id:user/user-name arn:aws:iam::aws-account-id:role/role-name

    ActiveZones []string
    Covering availability zones used when creating an Endpoint from other VPC.
    AllowedPrincipals []string
    Allowed principals to access the endpoint service.
    InstanceId int
    The CloudAMQP instance identifier.
    ServiceName string
    Service name of the PrivateLink used when creating the endpoint from other VPC.
    Sleep int

    Configurable sleep time (seconds) when enable PrivateLink. Default set to 10 seconds.

    Note: Available from [v1.29.0]

    Status string
    PrivateLink status [enable, pending, disable]
    Timeout int

    Configurable timeout time (seconds) when enable PrivateLink. Default set to 1800 seconds.

    Note: Available from [v1.29.0]

    Allowed principals format: arn:aws:iam::aws-account-id:root arn:aws:iam::aws-account-id:user/user-name arn:aws:iam::aws-account-id:role/role-name

    activeZones List<String>
    Covering availability zones used when creating an Endpoint from other VPC.
    allowedPrincipals List<String>
    Allowed principals to access the endpoint service.
    instanceId Integer
    The CloudAMQP instance identifier.
    serviceName String
    Service name of the PrivateLink used when creating the endpoint from other VPC.
    sleep Integer

    Configurable sleep time (seconds) when enable PrivateLink. Default set to 10 seconds.

    Note: Available from [v1.29.0]

    status String
    PrivateLink status [enable, pending, disable]
    timeout Integer

    Configurable timeout time (seconds) when enable PrivateLink. Default set to 1800 seconds.

    Note: Available from [v1.29.0]

    Allowed principals format: arn:aws:iam::aws-account-id:root arn:aws:iam::aws-account-id:user/user-name arn:aws:iam::aws-account-id:role/role-name

    activeZones string[]
    Covering availability zones used when creating an Endpoint from other VPC.
    allowedPrincipals string[]
    Allowed principals to access the endpoint service.
    instanceId number
    The CloudAMQP instance identifier.
    serviceName string
    Service name of the PrivateLink used when creating the endpoint from other VPC.
    sleep number

    Configurable sleep time (seconds) when enable PrivateLink. Default set to 10 seconds.

    Note: Available from [v1.29.0]

    status string
    PrivateLink status [enable, pending, disable]
    timeout number

    Configurable timeout time (seconds) when enable PrivateLink. Default set to 1800 seconds.

    Note: Available from [v1.29.0]

    Allowed principals format: arn:aws:iam::aws-account-id:root arn:aws:iam::aws-account-id:user/user-name arn:aws:iam::aws-account-id:role/role-name

    active_zones Sequence[str]
    Covering availability zones used when creating an Endpoint from other VPC.
    allowed_principals Sequence[str]
    Allowed principals to access the endpoint service.
    instance_id int
    The CloudAMQP instance identifier.
    service_name str
    Service name of the PrivateLink used when creating the endpoint from other VPC.
    sleep int

    Configurable sleep time (seconds) when enable PrivateLink. Default set to 10 seconds.

    Note: Available from [v1.29.0]

    status str
    PrivateLink status [enable, pending, disable]
    timeout int

    Configurable timeout time (seconds) when enable PrivateLink. Default set to 1800 seconds.

    Note: Available from [v1.29.0]

    Allowed principals format: arn:aws:iam::aws-account-id:root arn:aws:iam::aws-account-id:user/user-name arn:aws:iam::aws-account-id:role/role-name

    activeZones List<String>
    Covering availability zones used when creating an Endpoint from other VPC.
    allowedPrincipals List<String>
    Allowed principals to access the endpoint service.
    instanceId Number
    The CloudAMQP instance identifier.
    serviceName String
    Service name of the PrivateLink used when creating the endpoint from other VPC.
    sleep Number

    Configurable sleep time (seconds) when enable PrivateLink. Default set to 10 seconds.

    Note: Available from [v1.29.0]

    status String
    PrivateLink status [enable, pending, disable]
    timeout Number

    Configurable timeout time (seconds) when enable PrivateLink. Default set to 1800 seconds.

    Note: Available from [v1.29.0]

    Allowed principals format: arn:aws:iam::aws-account-id:root arn:aws:iam::aws-account-id:user/user-name arn:aws:iam::aws-account-id:role/role-name

    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
    pulumi/pulumi-cloudamqp