Package com.pulumi.gcp.compute

Class ServiceAttachment

  • public class ServiceAttachment
extends com.pulumi.resources.CustomResource
    Represents a ServiceAttachment resource. To get more information about ServiceAttachment, see: * [API documentation](https://cloud.google.com/compute/docs/reference/beta/serviceAttachments) * How-to Guides * [Configuring Private Service Connect to access services](https://cloud.google.com/vpc/docs/configure-private-service-connect-services) ## Example Usage ### Service Attachment Basic ```java package generated_program; import com.pulumi.Context; import com.pulumi.Pulumi; import com.pulumi.core.Output; import com.pulumi.gcp.compute.HealthCheck; import com.pulumi.gcp.compute.HealthCheckArgs; import com.pulumi.gcp.compute.inputs.HealthCheckTcpHealthCheckArgs; import com.pulumi.gcp.compute.RegionBackendService; import com.pulumi.gcp.compute.RegionBackendServiceArgs; 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.compute.ForwardingRule; import com.pulumi.gcp.compute.ForwardingRuleArgs; import com.pulumi.gcp.compute.ServiceAttachment; import com.pulumi.gcp.compute.ServiceAttachmentArgs; import com.pulumi.gcp.compute.Address; import com.pulumi.gcp.compute.AddressArgs; 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 producerServiceHealthCheck = new HealthCheck("producerServiceHealthCheck", HealthCheckArgs.builder() .checkIntervalSec(1) .timeoutSec(1) .tcpHealthCheck(HealthCheckTcpHealthCheckArgs.builder() .port("80") .build()) .build()); var producerServiceBackend = new RegionBackendService("producerServiceBackend", RegionBackendServiceArgs.builder() .region("us-west2") .healthChecks(producerServiceHealthCheck.id()) .build()); var pscIlbNetwork = new Network("pscIlbNetwork", NetworkArgs.builder() .autoCreateSubnetworks(false) .build()); var pscIlbProducerSubnetwork = new Subnetwork("pscIlbProducerSubnetwork", SubnetworkArgs.builder() .region("us-west2") .network(pscIlbNetwork.id()) .ipCidrRange("10.0.0.0/16") .build()); var pscIlbTargetService = new ForwardingRule("pscIlbTargetService", ForwardingRuleArgs.builder() .region("us-west2") .loadBalancingScheme("INTERNAL") .backendService(producerServiceBackend.id()) .allPorts(true) .network(pscIlbNetwork.name()) .subnetwork(pscIlbProducerSubnetwork.name()) .build()); var pscIlbNat = new Subnetwork("pscIlbNat", SubnetworkArgs.builder() .region("us-west2") .network(pscIlbNetwork.id()) .purpose("PRIVATE_SERVICE_CONNECT") .ipCidrRange("10.1.0.0/16") .build()); var pscIlbServiceAttachment = new ServiceAttachment("pscIlbServiceAttachment", ServiceAttachmentArgs.builder() .region("us-west2") .description("A service attachment configured with Terraform") .domainNames("gcp.tfacc.hashicorptest.com.") .enableProxyProtocol(true) .connectionPreference("ACCEPT_AUTOMATIC") .natSubnets(pscIlbNat.id()) .targetService(pscIlbTargetService.id()) .build()); var pscIlbConsumerAddress = new Address("pscIlbConsumerAddress", AddressArgs.builder() .region("us-west2") .subnetwork("default") .addressType("INTERNAL") .build()); var pscIlbConsumer = new ForwardingRule("pscIlbConsumer", ForwardingRuleArgs.builder() .region("us-west2") .target(pscIlbServiceAttachment.id()) .loadBalancingScheme("") .network("default") .ipAddress(pscIlbConsumerAddress.id()) .build()); } } ``` ### Service Attachment Explicit Projects ```java package generated_program; import com.pulumi.Context; import com.pulumi.Pulumi; import com.pulumi.core.Output; import com.pulumi.gcp.compute.HealthCheck; import com.pulumi.gcp.compute.HealthCheckArgs; import com.pulumi.gcp.compute.inputs.HealthCheckTcpHealthCheckArgs; import com.pulumi.gcp.compute.RegionBackendService; import com.pulumi.gcp.compute.RegionBackendServiceArgs; 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.compute.ForwardingRule; import com.pulumi.gcp.compute.ForwardingRuleArgs; import com.pulumi.gcp.compute.ServiceAttachment; import com.pulumi.gcp.compute.ServiceAttachmentArgs; import com.pulumi.gcp.compute.inputs.ServiceAttachmentConsumerAcceptListArgs; import com.pulumi.gcp.compute.Address; import com.pulumi.gcp.compute.AddressArgs; 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 producerServiceHealthCheck = new HealthCheck("producerServiceHealthCheck", HealthCheckArgs.builder() .checkIntervalSec(1) .timeoutSec(1) .tcpHealthCheck(HealthCheckTcpHealthCheckArgs.builder() .port("80") .build()) .build()); var producerServiceBackend = new RegionBackendService("producerServiceBackend", RegionBackendServiceArgs.builder() .region("us-west2") .healthChecks(producerServiceHealthCheck.id()) .build()); var pscIlbNetwork = new Network("pscIlbNetwork", NetworkArgs.builder() .autoCreateSubnetworks(false) .build()); var pscIlbProducerSubnetwork = new Subnetwork("pscIlbProducerSubnetwork", SubnetworkArgs.builder() .region("us-west2") .network(pscIlbNetwork.id()) .ipCidrRange("10.0.0.0/16") .build()); var pscIlbTargetService = new ForwardingRule("pscIlbTargetService", ForwardingRuleArgs.builder() .region("us-west2") .loadBalancingScheme("INTERNAL") .backendService(producerServiceBackend.id()) .allPorts(true) .network(pscIlbNetwork.name()) .subnetwork(pscIlbProducerSubnetwork.name()) .build()); var pscIlbNat = new Subnetwork("pscIlbNat", SubnetworkArgs.builder() .region("us-west2") .network(pscIlbNetwork.id()) .purpose("PRIVATE_SERVICE_CONNECT") .ipCidrRange("10.1.0.0/16") .build()); var pscIlbServiceAttachment = new ServiceAttachment("pscIlbServiceAttachment", ServiceAttachmentArgs.builder() .region("us-west2") .description("A service attachment configured with Terraform") .domainNames("gcp.tfacc.hashicorptest.com.") .enableProxyProtocol(true) .connectionPreference("ACCEPT_MANUAL") .natSubnets(pscIlbNat.id()) .targetService(pscIlbTargetService.id()) .consumerRejectLists( "673497134629", "482878270665") .consumerAcceptLists(ServiceAttachmentConsumerAcceptListArgs.builder() .projectIdOrNum("658859330310") .connectionLimit(4) .build()) .build()); var pscIlbConsumerAddress = new Address("pscIlbConsumerAddress", AddressArgs.builder() .region("us-west2") .subnetwork("default") .addressType("INTERNAL") .build()); var pscIlbConsumer = new ForwardingRule("pscIlbConsumer", ForwardingRuleArgs.builder() .region("us-west2") .target(pscIlbServiceAttachment.id()) .loadBalancingScheme("") .network("default") .ipAddress(pscIlbConsumerAddress.id()) .build()); } } ``` ### Service Attachment Reconcile Connections ```java package generated_program; import com.pulumi.Context; import com.pulumi.Pulumi; import com.pulumi.core.Output; import com.pulumi.gcp.compute.HealthCheck; import com.pulumi.gcp.compute.HealthCheckArgs; import com.pulumi.gcp.compute.inputs.HealthCheckTcpHealthCheckArgs; import com.pulumi.gcp.compute.RegionBackendService; import com.pulumi.gcp.compute.RegionBackendServiceArgs; 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.compute.ForwardingRule; import com.pulumi.gcp.compute.ForwardingRuleArgs; import com.pulumi.gcp.compute.ServiceAttachment; import com.pulumi.gcp.compute.ServiceAttachmentArgs; import com.pulumi.gcp.compute.inputs.ServiceAttachmentConsumerAcceptListArgs; 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 producerServiceHealthCheck = new HealthCheck("producerServiceHealthCheck", HealthCheckArgs.builder() .checkIntervalSec(1) .timeoutSec(1) .tcpHealthCheck(HealthCheckTcpHealthCheckArgs.builder() .port("80") .build()) .build()); var producerServiceBackend = new RegionBackendService("producerServiceBackend", RegionBackendServiceArgs.builder() .region("us-west2") .healthChecks(producerServiceHealthCheck.id()) .build()); var pscIlbNetwork = new Network("pscIlbNetwork", NetworkArgs.builder() .autoCreateSubnetworks(false) .build()); var pscIlbProducerSubnetwork = new Subnetwork("pscIlbProducerSubnetwork", SubnetworkArgs.builder() .region("us-west2") .network(pscIlbNetwork.id()) .ipCidrRange("10.0.0.0/16") .build()); var pscIlbTargetService = new ForwardingRule("pscIlbTargetService", ForwardingRuleArgs.builder() .region("us-west2") .loadBalancingScheme("INTERNAL") .backendService(producerServiceBackend.id()) .allPorts(true) .network(pscIlbNetwork.name()) .subnetwork(pscIlbProducerSubnetwork.name()) .build()); var pscIlbNat = new Subnetwork("pscIlbNat", SubnetworkArgs.builder() .region("us-west2") .network(pscIlbNetwork.id()) .purpose("PRIVATE_SERVICE_CONNECT") .ipCidrRange("10.1.0.0/16") .build()); var pscIlbServiceAttachment = new ServiceAttachment("pscIlbServiceAttachment", ServiceAttachmentArgs.builder() .region("us-west2") .description("A service attachment configured with Terraform") .domainNames("gcp.tfacc.hashicorptest.com.") .enableProxyProtocol(true) .connectionPreference("ACCEPT_MANUAL") .natSubnets(pscIlbNat.id()) .targetService(pscIlbTargetService.id()) .consumerRejectLists( "673497134629", "482878270665") .consumerAcceptLists(ServiceAttachmentConsumerAcceptListArgs.builder() .projectIdOrNum("658859330310") .connectionLimit(4) .build()) .reconcileConnections(false) .build()); } } ``` ## Import ServiceAttachment can be imported using any of these accepted formats ```sh $ pulumi import gcp:compute/serviceAttachment:ServiceAttachment default projects/{{project}}/regions/{{region}}/serviceAttachments/{{name}} ``` ```sh $ pulumi import gcp:compute/serviceAttachment:ServiceAttachment default {{project}}/{{region}}/{{name}} ``` ```sh $ pulumi import gcp:compute/serviceAttachment:ServiceAttachment default {{region}}/{{name}} ``` ```sh $ pulumi import gcp:compute/serviceAttachment:ServiceAttachment 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

    • Method Summary

      All Methods Static Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      com.pulumi.core.Output<java.util.List<ServiceAttachmentConnectedEndpoint>> connectedEndpoints()  
      com.pulumi.core.Output<java.lang.String> connectionPreference()  
      com.pulumi.core.Output<java.util.Optional<java.util.List<ServiceAttachmentConsumerAcceptList>>> consumerAcceptLists()  
      com.pulumi.core.Output<java.util.Optional<java.util.List<java.lang.String>>> consumerRejectLists()  
      com.pulumi.core.Output<java.util.Optional<java.lang.String>> description()  
      com.pulumi.core.Output<java.util.Optional<java.util.List<java.lang.String>>> domainNames()  
      com.pulumi.core.Output<java.lang.Boolean> enableProxyProtocol()  
      com.pulumi.core.Output<java.lang.String> fingerprint()  
      static ServiceAttachment get​(java.lang.String name, com.pulumi.core.Output<java.lang.String> id, ServiceAttachmentState 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.String> name()  
      com.pulumi.core.Output<java.util.List<java.lang.String>> natSubnets()  
      com.pulumi.core.Output<java.lang.String> project()  
      com.pulumi.core.Output<java.util.Optional<java.lang.Boolean>> reconcileConnections()  
      com.pulumi.core.Output<java.lang.String> region()  
      com.pulumi.core.Output<java.lang.String> selfLink()  
      com.pulumi.core.Output<java.lang.String> targetService()  

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

        getId, idFuture

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

        getChildResources, getResourceName, getResourceType, getUrn

      • Methods inherited from class java.lang.Object

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

    • Constructor Detail

      • ServiceAttachment

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

      • ServiceAttachment

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

      • ServiceAttachment

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

      • connectedEndpoints

        public com.pulumi.core.Output<java.util.List<ServiceAttachmentConnectedEndpoint>> connectedEndpoints()
        Returns:
        An array of the consumer forwarding rules connected to this service attachment. Structure is documented below.

      • connectionPreference

        public com.pulumi.core.Output<java.lang.String> connectionPreference()
        Returns:
        The connection preference to use for this service attachment. Valid values include "ACCEPT_AUTOMATIC", "ACCEPT_MANUAL".

      • consumerAcceptLists

        public com.pulumi.core.Output<java.util.Optional<java.util.List<ServiceAttachmentConsumerAcceptList>>> consumerAcceptLists()
        Returns:
        An array of projects that are allowed to connect to this service attachment. Structure is documented below.

      • consumerRejectLists

        public com.pulumi.core.Output<java.util.Optional<java.util.List<java.lang.String>>> consumerRejectLists()
        Returns:
        An array of projects that are not allowed to connect to this service attachment.

      • description

        public com.pulumi.core.Output<java.util.Optional<java.lang.String>> description()
        Returns:
        An optional description of this resource.

      • domainNames

        public com.pulumi.core.Output<java.util.Optional<java.util.List<java.lang.String>>> domainNames()
        Returns:
        If specified, the domain name will be used during the integration between the PSC connected endpoints and the Cloud DNS. For example, this is a valid domain name: "p.mycompany.com.". Current max number of domain names supported is 1.

      • enableProxyProtocol

        public com.pulumi.core.Output<java.lang.Boolean> enableProxyProtocol()
        Returns:
        If true, enable the proxy protocol which is for supplying client TCP/IP address data in TCP connections that traverse proxies on their way to destination servers. ***

      • fingerprint

        public com.pulumi.core.Output<java.lang.String> fingerprint()
        Returns:
        Fingerprint of this resource. This field is used internally during updates of this resource.

      • name

        public com.pulumi.core.Output<java.lang.String> name()
        Returns:
        Name of the resource. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression `a-z?` which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.

      • natSubnets

        public com.pulumi.core.Output<java.util.List<java.lang.String>> natSubnets()
        Returns:
        An array of subnets that is provided for NAT in this service attachment.

      • 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.

      • reconcileConnections

        public com.pulumi.core.Output<java.util.Optional<java.lang.Boolean>> reconcileConnections()
        Returns:
        This flag determines whether a consumer accept/reject list change can reconcile the statuses of existing ACCEPTED or REJECTED PSC endpoints. If false, connection policy update will only affect existing PENDING PSC endpoints. Existing ACCEPTED/REJECTED endpoints will remain untouched regardless how the connection policy is modified . If true, update will affect both PENDING and ACCEPTED/REJECTED PSC endpoints. For example, an ACCEPTED PSC endpoint will be moved to REJECTED if its project is added to the reject list. For newly created service attachment, this boolean defaults to true.

      • region

        public com.pulumi.core.Output<java.lang.String> region()
        Returns:
        URL of the region where the resource resides.

      • selfLink

        public com.pulumi.core.Output<java.lang.String> selfLink()
        Returns:
        The URI of the created resource.

      • targetService

        public com.pulumi.core.Output<java.lang.String> targetService()
        Returns:
        The URL of a forwarding rule that represents the service identified by this service attachment.

      • get

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