Package com.pulumi.cloudamqp

Class PrivatelinkAws

  • public class PrivatelinkAws
extends com.pulumi.resources.CustomResource
    Enable PrivateLink for a CloudAMQP instance hosted in AWS. If no existing VPC available when enable PrivateLink, a new VPC will be created with subnet `10.52.72.0/24`. > **Note:** Enabling PrivateLink will automatically add firewall rules for the peered subnet. <details> <summary> <i>Default PrivateLink firewall rule</i> </summary> ```java package generated_program; import com.pulumi.Context; import com.pulumi.Pulumi; import com.pulumi.core.Output; import java.util.List; import java.util.ArrayList; import java.util.Map; import java.io.File; import java.nio.file.Files; import java.nio.file.Paths; public class App { public static void main(String[] args) { Pulumi.run(App::stack); } public static void stack(Context ctx) { } } ``` </details> Pricing is available at [cloudamqp.com](https://www.cloudamqp.com/plans.html) where you can also find more information about [CloudAMQP PrivateLink](https://www.cloudamqp.com/docs/cloudamqp-privatelink.html#aws-privatelink). Only available for dedicated subscription plans. > **Warning:** This resource considered deprecated and will be removed in next major version (v2.0). Recommended to start using the new resource`cloudamqp.VpcConnect`. ## Example Usage <details> <summary> <b> <i>CloudAMQP instance without existing VPC</i> </b> </summary> ```java package generated_program; import com.pulumi.Context; import com.pulumi.Pulumi; import com.pulumi.core.Output; import com.pulumi.cloudamqp.Instance; import com.pulumi.cloudamqp.InstanceArgs; import com.pulumi.cloudamqp.PrivatelinkAws; import com.pulumi.cloudamqp.PrivatelinkAwsArgs; import java.util.List; import java.util.ArrayList; import java.util.Map; import java.io.File; import java.nio.file.Files; import java.nio.file.Paths; public class App { public static void main(String[] args) { Pulumi.run(App::stack); } public static void stack(Context ctx) { var instance = new Instance("instance", InstanceArgs.builder() .plan("bunny-1") .region("amazon-web-services::us-west-1") .tags() .build()); var privatelink = new PrivatelinkAws("privatelink", PrivatelinkAwsArgs.builder() .instanceId(instance.id()) .allowedPrincipals("arn:aws:iam::aws-account-id:user/user-name") .build()); } } ``` </details> <details> <summary> <b> <i>CloudAMQP instance in an existing VPC</i> </b> </summary> ```java package generated_program; import com.pulumi.Context; import com.pulumi.Pulumi; import com.pulumi.core.Output; import com.pulumi.cloudamqp.Vpc; import com.pulumi.cloudamqp.VpcArgs; import com.pulumi.cloudamqp.Instance; import com.pulumi.cloudamqp.InstanceArgs; import com.pulumi.cloudamqp.PrivatelinkAws; import com.pulumi.cloudamqp.PrivatelinkAwsArgs; import java.util.List; import java.util.ArrayList; import java.util.Map; import java.io.File; import java.nio.file.Files; import java.nio.file.Paths; public class App { public static void main(String[] args) { Pulumi.run(App::stack); } public static void stack(Context ctx) { var vpc = new Vpc("vpc", VpcArgs.builder() .region("amazon-web-services::us-west-1") .subnet("10.56.72.0/24") .tags() .build()); var instance = new Instance("instance", InstanceArgs.builder() .plan("bunny-1") .region("amazon-web-services::us-west-1") .tags() .vpcId(vpc.id()) .keepAssociatedVpc(true) .build()); var privatelink = new PrivatelinkAws("privatelink", PrivatelinkAwsArgs.builder() .instanceId(instance.id()) .allowedPrincipals("arn:aws:iam::aws-account-id:user/user-name") .build()); } } ``` </details> ### With Additional Firewall Rules <details> <summary> <b> <i>CloudAMQP instance in an existing VPC with managed firewall rules</i> </b> </summary> ```java package generated_program; import com.pulumi.Context; import com.pulumi.Pulumi; import com.pulumi.core.Output; import com.pulumi.cloudamqp.Vpc; import com.pulumi.cloudamqp.VpcArgs; import com.pulumi.cloudamqp.Instance; import com.pulumi.cloudamqp.InstanceArgs; import com.pulumi.cloudamqp.PrivatelinkAws; import com.pulumi.cloudamqp.PrivatelinkAwsArgs; import com.pulumi.cloudamqp.SecurityFirewall; import com.pulumi.cloudamqp.SecurityFirewallArgs; import com.pulumi.cloudamqp.inputs.SecurityFirewallRuleArgs; import com.pulumi.resources.CustomResourceOptions; import java.util.List; import java.util.ArrayList; import java.util.Map; import java.io.File; import java.nio.file.Files; import java.nio.file.Paths; public class App { public static void main(String[] args) { Pulumi.run(App::stack); } public static void stack(Context ctx) { var vpc = new Vpc("vpc", VpcArgs.builder() .region("amazon-web-services::us-west-1") .subnet("10.56.72.0/24") .tags() .build()); var instance = new Instance("instance", InstanceArgs.builder() .plan("bunny-1") .region("amazon-web-services::us-west-1") .tags() .vpcId(vpc.id()) .keepAssociatedVpc(true) .build()); var privatelink = new PrivatelinkAws("privatelink", PrivatelinkAwsArgs.builder() .instanceId(instance.id()) .allowedPrincipals("arn:aws:iam::aws-account-id:user/user-name") .build()); var firewallSettings = new SecurityFirewall("firewallSettings", SecurityFirewallArgs.builder() .instanceId(instance.id()) .rules( SecurityFirewallRuleArgs.builder() .description("Custom PrivateLink setup") .ip(vpc.subnet()) .ports() .services( "AMQP", "AMQPS", "HTTPS", "STREAM", "STREAM_SSL") .build(), SecurityFirewallRuleArgs.builder() .description("MGMT interface") .ip("0.0.0.0/0") .ports() .services("HTTPS") .build()) .build(), CustomResourceOptions.builder() .dependsOn(privatelink) .build()); } } ``` </details> ## Depedency This resource depends on CloudAMQP instance identifier, `cloudamqp_instance.instance.id`. ## Create PrivateLink with additional firewall rules To create a PrivateLink configuration with additional firewall rules, it's required to chain the cloudamqp.SecurityFirewall resource to avoid parallel conflicting resource calls. You can do this by making the firewall resource depend on the PrivateLink resource, `cloudamqp_privatelink_aws.privatelink`. Furthermore, since all firewall rules are overwritten, the otherwise automatically added rules for the PrivateLink also needs to be added. ## Import `cloudamqp_privatelink_aws` can be imported using CloudAMQP internal identifier. ```sh $ pulumi import cloudamqp:index/privatelinkAws:PrivatelinkAws privatelink <id>` ``` The resource uses the same identifier as the CloudAMQP instance. To retrieve the identifier for an instance, either use [CloudAMQP customer API](https://docs.cloudamqp.com/#list-instances) or use the data source [`cloudamqp_account`](./data-sources/account.md).

    • Nested Class Summary

      • Nested classes/interfaces inherited from class com.pulumi.resources.CustomResource

        com.pulumi.resources.CustomResource.CustomResourceInternal

      • Nested classes/interfaces inherited from class com.pulumi.resources.Resource

        com.pulumi.resources.Resource.LazyField<T extends java.lang.Object>, com.pulumi.resources.Resource.LazyFields, com.pulumi.resources.Resource.ResourceInternal

    • Field Summary

      • Fields inherited from class com.pulumi.resources.Resource

        childResources, remote

    • Method Summary

      All Methods Static Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      com.pulumi.core.Output<java.util.List<java.lang.String>> activeZones()  
      com.pulumi.core.Output<java.util.List<java.lang.String>> allowedPrincipals()  
      static PrivatelinkAws get​(java.lang.String name, com.pulumi.core.Output<java.lang.String> id, PrivatelinkAwsState state, com.pulumi.resources.CustomResourceOptions options)
      Get an existing Host resource's state with the given name, ID, and optional extra properties used to qualify the lookup.
      com.pulumi.core.Output<java.lang.Integer> instanceId()  
      com.pulumi.core.Output<java.lang.String> serviceName()  
      com.pulumi.core.Output<java.util.Optional<java.lang.Integer>> sleep()  
      com.pulumi.core.Output<java.lang.String> status()  
      com.pulumi.core.Output<java.util.Optional<java.lang.Integer>> timeout()  

      • Methods inherited from class com.pulumi.resources.CustomResource

        getId, id, idFuture

      • Methods inherited from class com.pulumi.resources.Resource

        getChildResources, getResourceName, getResourceType, getUrn, pulumiChildResources, pulumiResourceName, pulumiResourceType, urn

      • Methods inherited from class java.lang.Object

        clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

    • Constructor Detail

      • PrivatelinkAws

        public PrivatelinkAws​(java.lang.String name)
        Parameters:
        name - The _unique_ name of the resulting resource.

      • PrivatelinkAws

        public PrivatelinkAws​(java.lang.String name,
                      PrivatelinkAwsArgs args)
        Parameters:
        name - The _unique_ name of the resulting resource.
        args - The arguments to use to populate this resource's properties.

      • PrivatelinkAws

        public PrivatelinkAws​(java.lang.String name,
                      PrivatelinkAwsArgs args,
                      @Nullable
                      com.pulumi.resources.CustomResourceOptions options)
        Parameters:
        name - The _unique_ name of the resulting resource.
        args - The arguments to use to populate this resource's properties.
        options - A bag of options that control this resource's behavior.

    • Method Detail

      • activeZones

        public com.pulumi.core.Output<java.util.List<java.lang.String>> activeZones()
        Returns:
        Covering availability zones used when creating an Endpoint from other VPC.

      • allowedPrincipals

        public com.pulumi.core.Output<java.util.List<java.lang.String>> allowedPrincipals()
        Returns:
        Allowed principals to access the endpoint service.

      • instanceId

        public com.pulumi.core.Output<java.lang.Integer> instanceId()
        Returns:
        The CloudAMQP instance identifier.

      • serviceName

        public com.pulumi.core.Output<java.lang.String> serviceName()
        Returns:
        Service name of the PrivateLink used when creating the endpoint from other VPC.

      • sleep

        public com.pulumi.core.Output<java.util.Optional<java.lang.Integer>> sleep()
        Returns:
        Configurable sleep time (seconds) when enable PrivateLink. Default set to 10 seconds. *Available from v1.29.0*

      • status

        public com.pulumi.core.Output<java.lang.String> status()
        Returns:
        PrivateLink status [enable, pending, disable]

      • timeout

        public com.pulumi.core.Output<java.util.Optional<java.lang.Integer>> timeout()
        Returns:
        Configurable timeout time (seconds) when enable PrivateLink. Default set to 1800 seconds. *Available from v1.29.0* Allowed principals format: <br> `arn:aws:iam::aws-account-id:root` <br> `arn:aws:iam::aws-account-id:user/user-name` <br> `arn:aws:iam::aws-account-id:role/role-name`

      • get

        public static PrivatelinkAws get​(java.lang.String name,
                                 com.pulumi.core.Output<java.lang.String> id,
                                 @Nullable
                                 PrivatelinkAwsState state,
                                 @Nullable
                                 com.pulumi.resources.CustomResourceOptions options)
        Get an existing Host resource's state with the given name, ID, and optional extra properties used to qualify the lookup.
        Parameters:
        name - The _unique_ name of the resulting resource.
        id - The _unique_ provider ID of the resource to lookup.
        state -
        options - Optional settings to control the behavior of the CustomResource.