Package com.pulumi.gcp.vpcaccess

Class Connector

  • public class Connector
extends com.pulumi.resources.CustomResource
    Serverless VPC Access connector resource. To get more information about Connector, see: * [API documentation](https://cloud.google.com/vpc/docs/reference/vpcaccess/rest/v1/projects.locations.connectors) * How-to Guides * [Configuring Serverless VPC Access](https://cloud.google.com/vpc/docs/configure-serverless-vpc-access) ## Example Usage ### Vpc Access Connector ```java package generated_program; import com.pulumi.Context; import com.pulumi.Pulumi; import com.pulumi.core.Output; import com.pulumi.gcp.vpcaccess.Connector; import com.pulumi.gcp.vpcaccess.ConnectorArgs; 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 connector = new Connector("connector", ConnectorArgs.builder() .ipCidrRange("10.8.0.0/28") .network("default") .build()); } } ``` ### Vpc Access Connector Shared Vpc ```java package generated_program; import com.pulumi.Context; import com.pulumi.Pulumi; import com.pulumi.core.Output; import com.pulumi.gcp.compute.Network; import com.pulumi.gcp.compute.NetworkArgs; import com.pulumi.gcp.compute.Subnetwork; import com.pulumi.gcp.compute.SubnetworkArgs; import com.pulumi.gcp.vpcaccess.Connector; import com.pulumi.gcp.vpcaccess.ConnectorArgs; import com.pulumi.gcp.vpcaccess.inputs.ConnectorSubnetArgs; 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 customTestNetwork = new Network("customTestNetwork", NetworkArgs.builder() .autoCreateSubnetworks(false) .build()); var customTestSubnetwork = new Subnetwork("customTestSubnetwork", SubnetworkArgs.builder() .ipCidrRange("10.2.0.0/28") .region("us-central1") .network(customTestNetwork.id()) .build()); var connector = new Connector("connector", ConnectorArgs.builder() .subnet(ConnectorSubnetArgs.builder() .name(customTestSubnetwork.name()) .build()) .machineType("e2-standard-4") .build()); } } ``` ## Import Connector can be imported using any of these accepted formats* `projects/{{project}}/locations/{{region}}/connectors/{{name}}` * `{{project}}/{{region}}/{{name}}` * `{{region}}/{{name}}` * `{{name}}` In Terraform v1.5.0 and later, use an [`import` block](https://developer.hashicorp.com/terraform/language/import) to import Connector using one of the formats above. For exampletf import { id = "projects/{{project}}/locations/{{region}}/connectors/{{name}}" to = google_vpc_access_connector.default } ```sh $ pulumi import gcp:vpcaccess/connector:Connector When using the [`terraform import` command](https://developer.hashicorp.com/terraform/cli/commands/import), Connector can be imported using one of the formats above. For example ``` ```sh $ pulumi import gcp:vpcaccess/connector:Connector default projects/{{project}}/locations/{{region}}/connectors/{{name}} ``` ```sh $ pulumi import gcp:vpcaccess/connector:Connector default {{project}}/{{region}}/{{name}} ``` ```sh $ pulumi import gcp:vpcaccess/connector:Connector default {{region}}/{{name}} ``` ```sh $ pulumi import gcp:vpcaccess/connector:Connector default {{name}} ```

    • 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

    • Constructor Summary

      Constructors 
      Constructor Description
      Connector​(java.lang.String name)  
      Connector​(java.lang.String name, ConnectorArgs args)  
      Connector​(java.lang.String name, ConnectorArgs args, com.pulumi.resources.CustomResourceOptions options)  

    • 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>> connectedProjects()  
      static Connector get​(java.lang.String name, com.pulumi.core.Output<java.lang.String> id, ConnectorState 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.String>> ipCidrRange()  
      com.pulumi.core.Output<java.util.Optional<java.lang.String>> machineType()  
      com.pulumi.core.Output<java.lang.Integer> maxInstances()  
      com.pulumi.core.Output<java.util.Optional<java.lang.Integer>> maxThroughput()  
      com.pulumi.core.Output<java.lang.Integer> minInstances()  
      com.pulumi.core.Output<java.util.Optional<java.lang.Integer>> minThroughput()  
      com.pulumi.core.Output<java.lang.String> name()  
      com.pulumi.core.Output<java.lang.String> network()  
      com.pulumi.core.Output<java.lang.String> project()  
      com.pulumi.core.Output<java.lang.String> region()  
      com.pulumi.core.Output<java.lang.String> selfLink()  
      com.pulumi.core.Output<java.lang.String> state()  
      com.pulumi.core.Output<java.util.Optional<ConnectorSubnet>> subnet()  

      • 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

      • Connector

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

      • Connector

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

      • Connector

        public Connector​(java.lang.String name,
                 @Nullable
                 ConnectorArgs 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

      • connectedProjects

        public com.pulumi.core.Output<java.util.List<java.lang.String>> connectedProjects()
        Returns:
        List of projects using the connector.

      • ipCidrRange

        public com.pulumi.core.Output<java.util.Optional<java.lang.String>> ipCidrRange()
        Returns:
        The range of internal addresses that follows RFC 4632 notation. Example: `10.132.0.0/28`.

      • machineType

        public com.pulumi.core.Output<java.util.Optional<java.lang.String>> machineType()
        Returns:
        Machine type of VM Instance underlying connector. Default is e2-micro

      • maxInstances

        public com.pulumi.core.Output<java.lang.Integer> maxInstances()
        Returns:
        Maximum value of instances in autoscaling group underlying the connector.

      • maxThroughput

        public com.pulumi.core.Output<java.util.Optional<java.lang.Integer>> maxThroughput()
        Returns:
        Maximum throughput of the connector in Mbps, must be greater than `min_throughput`. Default is 300.

      • minInstances

        public com.pulumi.core.Output<java.lang.Integer> minInstances()
        Returns:
        Minimum value of instances in autoscaling group underlying the connector.

      • minThroughput

        public com.pulumi.core.Output<java.util.Optional<java.lang.Integer>> minThroughput()
        Returns:
        Minimum throughput of the connector in Mbps. Default and min is 200.

      • name

        public com.pulumi.core.Output<java.lang.String> name()
        Returns:
        The name of the resource (Max 25 characters). ***

      • network

        public com.pulumi.core.Output<java.lang.String> network()
        Returns:
        Name or self_link of the VPC network. Required if `ip_cidr_range` is set.

      • project

        public com.pulumi.core.Output<java.lang.String> project()
        Returns:
        The ID of the project in which the resource belongs. If it is not provided, the provider project is used.

      • region

        public com.pulumi.core.Output<java.lang.String> region()
        Returns:
        Region where the VPC Access connector resides. If it is not provided, the provider region is used.

      • selfLink

        public com.pulumi.core.Output<java.lang.String> selfLink()
        Returns:
        The fully qualified name of this VPC connector

      • state

        public com.pulumi.core.Output<java.lang.String> state()
        Returns:
        State of the VPC access connector.

      • subnet

        public com.pulumi.core.Output<java.util.Optional<ConnectorSubnet>> subnet()
        Returns:
        The subnet in which to house the connector Structure is documented below.

      • get

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