Class VpcGcpPeering


  • public class VpcGcpPeering
    extends com.pulumi.resources.CustomResource
    This resouce creates a VPC peering configuration for the CloudAMQP instance. The configuration will connect to another VPC network hosted on Google Cloud Platform (GCP). See the [GCP documentation](https://cloud.google.com/vpc/docs/using-vpc-peering) for more information on how to create the VPC peering configuration. > **Note:** Creating a VPC peering will automatically add firewall rules for the peered subnet. <details> <summary> <i>Default VPC peering 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). Only available for dedicated subscription plans. ## Example Usage ### With Additional Firewall Rules <details> <summary> <b> <i>VPC peering pre v1.16.0</i> </b> </summary> ```java package generated_program; import com.pulumi.Context; import com.pulumi.Pulumi; import com.pulumi.core.Output; import com.pulumi.cloudamqp.VpcGcpPeering; import com.pulumi.cloudamqp.VpcGcpPeeringArgs; 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 vpcPeeringRequest = new VpcGcpPeering("vpcPeeringRequest", VpcGcpPeeringArgs.builder() .instanceId(cloudamqp_instance.instance().id()) .peerNetworkUri(var_.peer_network_uri()) .build()); var firewallSettings = new SecurityFirewall("firewallSettings", SecurityFirewallArgs.builder() .instanceId(cloudamqp_instance.instance().id()) .rules( SecurityFirewallRuleArgs.builder() .ip(var_.peer_subnet()) .ports(15672) .services( "AMQP", "AMQPS", "STREAM", "STREAM_SSL") .description("VPC peering for <NETWORK>") .build(), SecurityFirewallRuleArgs.builder() .ip("192.168.0.0/24") .ports( 4567, 4568) .services( "AMQP", "AMQPS", "HTTPS") .build()) .build(), CustomResourceOptions.builder() .dependsOn(vpcPeeringRequest) .build()); } } ``` </details> <details> <summary> <b> <i>VPC peering post v1.16.0 (Managed 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.VpcGcpPeering; import com.pulumi.cloudamqp.VpcGcpPeeringArgs; 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 vpcPeeringRequest = new VpcGcpPeering("vpcPeeringRequest", VpcGcpPeeringArgs.builder() .vpcId(cloudamqp_vpc.vpc().id()) .peerNetworkUri(var_.peer_network_uri()) .build()); var firewallSettings = new SecurityFirewall("firewallSettings", SecurityFirewallArgs.builder() .instanceId(cloudamqp_instance.instance().id()) .rules( SecurityFirewallRuleArgs.builder() .ip(var_.peer_subnet()) .ports(15672) .services( "AMQP", "AMQPS", "STREAM", "STREAM_SSL") .description("VPC peering for <NETWORK>") .build(), SecurityFirewallRuleArgs.builder() .ip("0.0.0.0/0") .ports() .services("HTTPS") .description("MGMT interface") .build()) .build(), CustomResourceOptions.builder() .dependsOn(vpcPeeringRequest) .build()); } } ``` </details> ## Depedency *Pre v1.16.0* This resource depends on CloudAMQP instance identifier, `cloudamqp_instance.instance.id`. *Post v1.16.0* This resource depends on CloudAMQP managed VPC identifier, `cloudamqp_vpc.vpc.id` or instance identifier, `cloudamqp_instance.instance.id`. ## Create VPC Peering with additional firewall rules To create a VPC peering configuration with additional firewall rules, it's required to chain the cloudamqp.SecurityFirewall resource to avoid parallel conflicting resource calls. This is done by adding dependency from the firewall resource to the VPC peering resource. Furthermore, since all firewall rules are overwritten, the otherwise automatically added rules for the VPC peering also needs to be added. See example below. ## Import Not possible to import this resource.
    • 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.lang.Boolean> autoCreateRoutes()  
      static VpcGcpPeering get​(java.lang.String name, com.pulumi.core.Output<java.lang.String> id, VpcGcpPeeringState 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.util.Optional<java.lang.Integer>> instanceId()  
      com.pulumi.core.Output<java.lang.String> peerNetworkUri()  
      com.pulumi.core.Output<java.util.Optional<java.lang.Integer>> sleep()  
      com.pulumi.core.Output<java.lang.String> state()  
      com.pulumi.core.Output<java.lang.String> stateDetails()  
      com.pulumi.core.Output<java.util.Optional<java.lang.Integer>> timeout()  
      com.pulumi.core.Output<java.util.Optional<java.lang.String>> vpcId()  
      com.pulumi.core.Output<java.util.Optional<java.lang.Boolean>> waitOnPeeringStatus()  
      • 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

      • VpcGcpPeering

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

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

        public VpcGcpPeering​(java.lang.String name,
                             VpcGcpPeeringArgs 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

      • autoCreateRoutes

        public com.pulumi.core.Output<java.lang.Boolean> autoCreateRoutes()
        Returns:
        VPC peering auto created routes
      • instanceId

        public com.pulumi.core.Output<java.util.Optional<java.lang.Integer>> instanceId()
        Returns:
        The CloudAMQP instance identifier. *Deprecated from v1.16.0*
      • peerNetworkUri

        public com.pulumi.core.Output<java.lang.String> peerNetworkUri()
        Returns:
        Network uri of the VPC network to which you will peer with.
      • sleep

        public com.pulumi.core.Output<java.util.Optional<java.lang.Integer>> sleep()
        Returns:
        Configurable sleep time (seconds) between retries when requesting or reading peering. Default set to 10 seconds. *Available from v1.29.0*
      • state

        public com.pulumi.core.Output<java.lang.String> state()
        Returns:
        VPC peering state
      • stateDetails

        public com.pulumi.core.Output<java.lang.String> stateDetails()
        Returns:
        VPC peering state details
      • timeout

        public com.pulumi.core.Output<java.util.Optional<java.lang.Integer>> timeout()
        Returns:
        Configurable timeout time (seconds) before retries times out. Default set to 1800 seconds. *Available from v1.29.0*
      • vpcId

        public com.pulumi.core.Output<java.util.Optional<java.lang.String>> vpcId()
        Returns:
        The managed VPC identifier. *Available from v1.16.0*
      • waitOnPeeringStatus

        public com.pulumi.core.Output<java.util.Optional<java.lang.Boolean>> waitOnPeeringStatus()
        Returns:
        Makes the resource wait until the peering is connected. Default set to false. *Available from v1.28.0*
      • get

        public static VpcGcpPeering get​(java.lang.String name,
                                        com.pulumi.core.Output<java.lang.String> id,
                                        @Nullable
                                        VpcGcpPeeringState 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.