1. Packages
  2. Ibm Provider
  3. API Docs
  4. IsPrivatePathServiceGateway
ibm 1.78.0 published on Wednesday, Apr 30, 2025 by ibm-cloud

ibm.IsPrivatePathServiceGateway

Explore with Pulumi AI

ibm logo
ibm 1.78.0 published on Wednesday, Apr 30, 2025 by ibm-cloud

    Provides a resource for PrivatePathServiceGateway. This allows PrivatePathServiceGateway to be created, updated and deleted.

    Example Usage

    import * as pulumi from "@pulumi/pulumi";
    import * as ibm from "@pulumi/ibm";
    
    const example = new ibm.IsPrivatePathServiceGateway("example", {
        defaultAccessPolicy: "permit",
        loadBalancer: ibm_is_lb.testacc_LB.id,
        zonalAffinity: true,
        serviceEndpoints: ["myexamplefqdn"],
    });
    
    import pulumi
    import pulumi_ibm as ibm
    
    example = ibm.IsPrivatePathServiceGateway("example",
        default_access_policy="permit",
        load_balancer=ibm_is_lb["testacc_LB"]["id"],
        zonal_affinity=True,
        service_endpoints=["myexamplefqdn"])
    
    package main
    
    import (
    	"github.com/pulumi/pulumi-terraform-provider/sdks/go/ibm/ibm"
    	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
    )
    
    func main() {
    	pulumi.Run(func(ctx *pulumi.Context) error {
    		_, err := ibm.NewIsPrivatePathServiceGateway(ctx, "example", &ibm.IsPrivatePathServiceGatewayArgs{
    			DefaultAccessPolicy: pulumi.String("permit"),
    			LoadBalancer:        pulumi.Any(ibm_is_lb.Testacc_LB.Id),
    			ZonalAffinity:       pulumi.Bool(true),
    			ServiceEndpoints: pulumi.StringArray{
    				pulumi.String("myexamplefqdn"),
    			},
    		})
    		if err != nil {
    			return err
    		}
    		return nil
    	})
    }
    
    using System.Collections.Generic;
    using System.Linq;
    using Pulumi;
    using Ibm = Pulumi.Ibm;
    
    return await Deployment.RunAsync(() => 
    {
        var example = new Ibm.IsPrivatePathServiceGateway("example", new()
        {
            DefaultAccessPolicy = "permit",
            LoadBalancer = ibm_is_lb.Testacc_LB.Id,
            ZonalAffinity = true,
            ServiceEndpoints = new[]
            {
                "myexamplefqdn",
            },
        });
    
    });
    
    package generated_program;
    
    import com.pulumi.Context;
    import com.pulumi.Pulumi;
    import com.pulumi.core.Output;
    import com.pulumi.ibm.IsPrivatePathServiceGateway;
    import com.pulumi.ibm.IsPrivatePathServiceGatewayArgs;
    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 example = new IsPrivatePathServiceGateway("example", IsPrivatePathServiceGatewayArgs.builder()
                .defaultAccessPolicy("permit")
                .loadBalancer(ibm_is_lb.testacc_LB().id())
                .zonalAffinity(true)
                .serviceEndpoints("myexamplefqdn")
                .build());
    
        }
    }
    
    resources:
      example:
        type: ibm:IsPrivatePathServiceGateway
        properties:
          defaultAccessPolicy: permit
          loadBalancer: ${ibm_is_lb.testacc_LB.id}
          zonalAffinity: true
          serviceEndpoints:
            - myexamplefqdn
    

    Create IsPrivatePathServiceGateway Resource

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

    Constructor syntax

    new IsPrivatePathServiceGateway(name: string, args: IsPrivatePathServiceGatewayArgs, opts?: CustomResourceOptions);
    @overload
    def IsPrivatePathServiceGateway(resource_name: str,
                                    args: IsPrivatePathServiceGatewayArgs,
                                    opts: Optional[ResourceOptions] = None)
    
    @overload
    def IsPrivatePathServiceGateway(resource_name: str,
                                    opts: Optional[ResourceOptions] = None,
                                    load_balancer: Optional[str] = None,
                                    service_endpoints: Optional[Sequence[str]] = None,
                                    default_access_policy: Optional[str] = None,
                                    is_private_path_service_gateway_id: Optional[str] = None,
                                    name: Optional[str] = None,
                                    resource_group: Optional[str] = None,
                                    zonal_affinity: Optional[bool] = None)
    func NewIsPrivatePathServiceGateway(ctx *Context, name string, args IsPrivatePathServiceGatewayArgs, opts ...ResourceOption) (*IsPrivatePathServiceGateway, error)
    public IsPrivatePathServiceGateway(string name, IsPrivatePathServiceGatewayArgs args, CustomResourceOptions? opts = null)
    public IsPrivatePathServiceGateway(String name, IsPrivatePathServiceGatewayArgs args)
    public IsPrivatePathServiceGateway(String name, IsPrivatePathServiceGatewayArgs args, CustomResourceOptions options)
    
    type: ibm:IsPrivatePathServiceGateway
    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 IsPrivatePathServiceGatewayArgs
    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 IsPrivatePathServiceGatewayArgs
    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 IsPrivatePathServiceGatewayArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args IsPrivatePathServiceGatewayArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args IsPrivatePathServiceGatewayArgs
    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 isPrivatePathServiceGatewayResource = new Ibm.IsPrivatePathServiceGateway("isPrivatePathServiceGatewayResource", new()
    {
        LoadBalancer = "string",
        ServiceEndpoints = new[]
        {
            "string",
        },
        DefaultAccessPolicy = "string",
        IsPrivatePathServiceGatewayId = "string",
        Name = "string",
        ResourceGroup = "string",
        ZonalAffinity = false,
    });
    
    example, err := ibm.NewIsPrivatePathServiceGateway(ctx, "isPrivatePathServiceGatewayResource", &ibm.IsPrivatePathServiceGatewayArgs{
    	LoadBalancer: pulumi.String("string"),
    	ServiceEndpoints: pulumi.StringArray{
    		pulumi.String("string"),
    	},
    	DefaultAccessPolicy:           pulumi.String("string"),
    	IsPrivatePathServiceGatewayId: pulumi.String("string"),
    	Name:                          pulumi.String("string"),
    	ResourceGroup:                 pulumi.String("string"),
    	ZonalAffinity:                 pulumi.Bool(false),
    })
    
    var isPrivatePathServiceGatewayResource = new IsPrivatePathServiceGateway("isPrivatePathServiceGatewayResource", IsPrivatePathServiceGatewayArgs.builder()
        .loadBalancer("string")
        .serviceEndpoints("string")
        .defaultAccessPolicy("string")
        .isPrivatePathServiceGatewayId("string")
        .name("string")
        .resourceGroup("string")
        .zonalAffinity(false)
        .build());
    
    is_private_path_service_gateway_resource = ibm.IsPrivatePathServiceGateway("isPrivatePathServiceGatewayResource",
        load_balancer="string",
        service_endpoints=["string"],
        default_access_policy="string",
        is_private_path_service_gateway_id="string",
        name="string",
        resource_group="string",
        zonal_affinity=False)
    
    const isPrivatePathServiceGatewayResource = new ibm.IsPrivatePathServiceGateway("isPrivatePathServiceGatewayResource", {
        loadBalancer: "string",
        serviceEndpoints: ["string"],
        defaultAccessPolicy: "string",
        isPrivatePathServiceGatewayId: "string",
        name: "string",
        resourceGroup: "string",
        zonalAffinity: false,
    });
    
    type: ibm:IsPrivatePathServiceGateway
    properties:
        defaultAccessPolicy: string
        isPrivatePathServiceGatewayId: string
        loadBalancer: string
        name: string
        resourceGroup: string
        serviceEndpoints:
            - string
        zonalAffinity: false
    

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

    LoadBalancer string
    The ID of the load balancer for this private path service gateway. This load balancer must be in the same VPC as the private path service gateway and must have is_private_path set to true.
    ServiceEndpoints List<string>
    The fully qualified domain names for this private path service gateway.
    DefaultAccessPolicy string
    The policy to use for bindings from accounts without an explicit account policy. permit: access will be permitted. deny: access will be denied. review: access will be manually reviewed. Allowable values are: deny, permit, review.
    IsPrivatePathServiceGatewayId string
    The unique identifier of the PrivatePathServiceGateway
    Name string
    The name for this private path service gateway. The name must not be used by another private path service gateway in the VPC.
    ResourceGroup string
    ID of the resource group to use.
    ZonalAffinity bool
    Indicates whether this private path service gateway has zonal affinity.
    LoadBalancer string
    The ID of the load balancer for this private path service gateway. This load balancer must be in the same VPC as the private path service gateway and must have is_private_path set to true.
    ServiceEndpoints []string
    The fully qualified domain names for this private path service gateway.
    DefaultAccessPolicy string
    The policy to use for bindings from accounts without an explicit account policy. permit: access will be permitted. deny: access will be denied. review: access will be manually reviewed. Allowable values are: deny, permit, review.
    IsPrivatePathServiceGatewayId string
    The unique identifier of the PrivatePathServiceGateway
    Name string
    The name for this private path service gateway. The name must not be used by another private path service gateway in the VPC.
    ResourceGroup string
    ID of the resource group to use.
    ZonalAffinity bool
    Indicates whether this private path service gateway has zonal affinity.
    loadBalancer String
    The ID of the load balancer for this private path service gateway. This load balancer must be in the same VPC as the private path service gateway and must have is_private_path set to true.
    serviceEndpoints List<String>
    The fully qualified domain names for this private path service gateway.
    defaultAccessPolicy String
    The policy to use for bindings from accounts without an explicit account policy. permit: access will be permitted. deny: access will be denied. review: access will be manually reviewed. Allowable values are: deny, permit, review.
    isPrivatePathServiceGatewayId String
    The unique identifier of the PrivatePathServiceGateway
    name String
    The name for this private path service gateway. The name must not be used by another private path service gateway in the VPC.
    resourceGroup String
    ID of the resource group to use.
    zonalAffinity Boolean
    Indicates whether this private path service gateway has zonal affinity.
    loadBalancer string
    The ID of the load balancer for this private path service gateway. This load balancer must be in the same VPC as the private path service gateway and must have is_private_path set to true.
    serviceEndpoints string[]
    The fully qualified domain names for this private path service gateway.
    defaultAccessPolicy string
    The policy to use for bindings from accounts without an explicit account policy. permit: access will be permitted. deny: access will be denied. review: access will be manually reviewed. Allowable values are: deny, permit, review.
    isPrivatePathServiceGatewayId string
    The unique identifier of the PrivatePathServiceGateway
    name string
    The name for this private path service gateway. The name must not be used by another private path service gateway in the VPC.
    resourceGroup string
    ID of the resource group to use.
    zonalAffinity boolean
    Indicates whether this private path service gateway has zonal affinity.
    load_balancer str
    The ID of the load balancer for this private path service gateway. This load balancer must be in the same VPC as the private path service gateway and must have is_private_path set to true.
    service_endpoints Sequence[str]
    The fully qualified domain names for this private path service gateway.
    default_access_policy str
    The policy to use for bindings from accounts without an explicit account policy. permit: access will be permitted. deny: access will be denied. review: access will be manually reviewed. Allowable values are: deny, permit, review.
    is_private_path_service_gateway_id str
    The unique identifier of the PrivatePathServiceGateway
    name str
    The name for this private path service gateway. The name must not be used by another private path service gateway in the VPC.
    resource_group str
    ID of the resource group to use.
    zonal_affinity bool
    Indicates whether this private path service gateway has zonal affinity.
    loadBalancer String
    The ID of the load balancer for this private path service gateway. This load balancer must be in the same VPC as the private path service gateway and must have is_private_path set to true.
    serviceEndpoints List<String>
    The fully qualified domain names for this private path service gateway.
    defaultAccessPolicy String
    The policy to use for bindings from accounts without an explicit account policy. permit: access will be permitted. deny: access will be denied. review: access will be manually reviewed. Allowable values are: deny, permit, review.
    isPrivatePathServiceGatewayId String
    The unique identifier of the PrivatePathServiceGateway
    name String
    The name for this private path service gateway. The name must not be used by another private path service gateway in the VPC.
    resourceGroup String
    ID of the resource group to use.
    zonalAffinity Boolean
    Indicates whether this private path service gateway has zonal affinity.

    Outputs

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

    CreatedAt string
    (String) The date and time that the private path service gateway was created.
    Crn string
    (String) The CRN for this private path service gateway.
    EndpointGatewayBindingAutoDelete bool
    (Boolean) Indicates whether endpoint gateway bindings will be automatically deleted after endpoint_gateway_binding_auto_delete_timeout hours have passed. At present, this is always true, but may be modifiable in the future.
    EndpointGatewayBindingAutoDeleteTimeout double
    (Integer) If endpoint_gateway_binding_auto_delete is true, the hours after which endpoint gateway bindings will be automatically deleted. If the value is 0, abandoned endpoint gateway bindings will be deleted immediately. At present, this is always set to 0. This value may be modifiable in the future.
    EndpointGatewayCount double
    (Integer) The number of endpoint gateways using this private path service gateway.
    Href string
    (String) The URL for this private path service gateway.
    Id string
    The provider-assigned unique ID for this managed resource.
    LifecycleState string
    (String) The lifecycle state of the private path service gateway.
    PrivatePathServiceGateway string
    The unique identifier for this account policy.
    Published bool
    (Boolean) Indicates the availability of this private path service gateway- true: Any account can request access to this private path service gateway.- false: Access is restricted to the account that created this private path service gateway.
    ResourceType string
    (String) The resource type.
    UpdatedAt string
    The date and time that the account policy was updated.
    Vpc string
    (String) The VPC this private path service gateway resides in.
    CreatedAt string
    (String) The date and time that the private path service gateway was created.
    Crn string
    (String) The CRN for this private path service gateway.
    EndpointGatewayBindingAutoDelete bool
    (Boolean) Indicates whether endpoint gateway bindings will be automatically deleted after endpoint_gateway_binding_auto_delete_timeout hours have passed. At present, this is always true, but may be modifiable in the future.
    EndpointGatewayBindingAutoDeleteTimeout float64
    (Integer) If endpoint_gateway_binding_auto_delete is true, the hours after which endpoint gateway bindings will be automatically deleted. If the value is 0, abandoned endpoint gateway bindings will be deleted immediately. At present, this is always set to 0. This value may be modifiable in the future.
    EndpointGatewayCount float64
    (Integer) The number of endpoint gateways using this private path service gateway.
    Href string
    (String) The URL for this private path service gateway.
    Id string
    The provider-assigned unique ID for this managed resource.
    LifecycleState string
    (String) The lifecycle state of the private path service gateway.
    PrivatePathServiceGateway string
    The unique identifier for this account policy.
    Published bool
    (Boolean) Indicates the availability of this private path service gateway- true: Any account can request access to this private path service gateway.- false: Access is restricted to the account that created this private path service gateway.
    ResourceType string
    (String) The resource type.
    UpdatedAt string
    The date and time that the account policy was updated.
    Vpc string
    (String) The VPC this private path service gateway resides in.
    createdAt String
    (String) The date and time that the private path service gateway was created.
    crn String
    (String) The CRN for this private path service gateway.
    endpointGatewayBindingAutoDelete Boolean
    (Boolean) Indicates whether endpoint gateway bindings will be automatically deleted after endpoint_gateway_binding_auto_delete_timeout hours have passed. At present, this is always true, but may be modifiable in the future.
    endpointGatewayBindingAutoDeleteTimeout Double
    (Integer) If endpoint_gateway_binding_auto_delete is true, the hours after which endpoint gateway bindings will be automatically deleted. If the value is 0, abandoned endpoint gateway bindings will be deleted immediately. At present, this is always set to 0. This value may be modifiable in the future.
    endpointGatewayCount Double
    (Integer) The number of endpoint gateways using this private path service gateway.
    href String
    (String) The URL for this private path service gateway.
    id String
    The provider-assigned unique ID for this managed resource.
    lifecycleState String
    (String) The lifecycle state of the private path service gateway.
    privatePathServiceGateway String
    The unique identifier for this account policy.
    published Boolean
    (Boolean) Indicates the availability of this private path service gateway- true: Any account can request access to this private path service gateway.- false: Access is restricted to the account that created this private path service gateway.
    resourceType String
    (String) The resource type.
    updatedAt String
    The date and time that the account policy was updated.
    vpc String
    (String) The VPC this private path service gateway resides in.
    createdAt string
    (String) The date and time that the private path service gateway was created.
    crn string
    (String) The CRN for this private path service gateway.
    endpointGatewayBindingAutoDelete boolean
    (Boolean) Indicates whether endpoint gateway bindings will be automatically deleted after endpoint_gateway_binding_auto_delete_timeout hours have passed. At present, this is always true, but may be modifiable in the future.
    endpointGatewayBindingAutoDeleteTimeout number
    (Integer) If endpoint_gateway_binding_auto_delete is true, the hours after which endpoint gateway bindings will be automatically deleted. If the value is 0, abandoned endpoint gateway bindings will be deleted immediately. At present, this is always set to 0. This value may be modifiable in the future.
    endpointGatewayCount number
    (Integer) The number of endpoint gateways using this private path service gateway.
    href string
    (String) The URL for this private path service gateway.
    id string
    The provider-assigned unique ID for this managed resource.
    lifecycleState string
    (String) The lifecycle state of the private path service gateway.
    privatePathServiceGateway string
    The unique identifier for this account policy.
    published boolean
    (Boolean) Indicates the availability of this private path service gateway- true: Any account can request access to this private path service gateway.- false: Access is restricted to the account that created this private path service gateway.
    resourceType string
    (String) The resource type.
    updatedAt string
    The date and time that the account policy was updated.
    vpc string
    (String) The VPC this private path service gateway resides in.
    created_at str
    (String) The date and time that the private path service gateway was created.
    crn str
    (String) The CRN for this private path service gateway.
    endpoint_gateway_binding_auto_delete bool
    (Boolean) Indicates whether endpoint gateway bindings will be automatically deleted after endpoint_gateway_binding_auto_delete_timeout hours have passed. At present, this is always true, but may be modifiable in the future.
    endpoint_gateway_binding_auto_delete_timeout float
    (Integer) If endpoint_gateway_binding_auto_delete is true, the hours after which endpoint gateway bindings will be automatically deleted. If the value is 0, abandoned endpoint gateway bindings will be deleted immediately. At present, this is always set to 0. This value may be modifiable in the future.
    endpoint_gateway_count float
    (Integer) The number of endpoint gateways using this private path service gateway.
    href str
    (String) The URL for this private path service gateway.
    id str
    The provider-assigned unique ID for this managed resource.
    lifecycle_state str
    (String) The lifecycle state of the private path service gateway.
    private_path_service_gateway str
    The unique identifier for this account policy.
    published bool
    (Boolean) Indicates the availability of this private path service gateway- true: Any account can request access to this private path service gateway.- false: Access is restricted to the account that created this private path service gateway.
    resource_type str
    (String) The resource type.
    updated_at str
    The date and time that the account policy was updated.
    vpc str
    (String) The VPC this private path service gateway resides in.
    createdAt String
    (String) The date and time that the private path service gateway was created.
    crn String
    (String) The CRN for this private path service gateway.
    endpointGatewayBindingAutoDelete Boolean
    (Boolean) Indicates whether endpoint gateway bindings will be automatically deleted after endpoint_gateway_binding_auto_delete_timeout hours have passed. At present, this is always true, but may be modifiable in the future.
    endpointGatewayBindingAutoDeleteTimeout Number
    (Integer) If endpoint_gateway_binding_auto_delete is true, the hours after which endpoint gateway bindings will be automatically deleted. If the value is 0, abandoned endpoint gateway bindings will be deleted immediately. At present, this is always set to 0. This value may be modifiable in the future.
    endpointGatewayCount Number
    (Integer) The number of endpoint gateways using this private path service gateway.
    href String
    (String) The URL for this private path service gateway.
    id String
    The provider-assigned unique ID for this managed resource.
    lifecycleState String
    (String) The lifecycle state of the private path service gateway.
    privatePathServiceGateway String
    The unique identifier for this account policy.
    published Boolean
    (Boolean) Indicates the availability of this private path service gateway- true: Any account can request access to this private path service gateway.- false: Access is restricted to the account that created this private path service gateway.
    resourceType String
    (String) The resource type.
    updatedAt String
    The date and time that the account policy was updated.
    vpc String
    (String) The VPC this private path service gateway resides in.

    Look up Existing IsPrivatePathServiceGateway Resource

    Get an existing IsPrivatePathServiceGateway 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?: IsPrivatePathServiceGatewayState, opts?: CustomResourceOptions): IsPrivatePathServiceGateway
    @staticmethod
    def get(resource_name: str,
            id: str,
            opts: Optional[ResourceOptions] = None,
            created_at: Optional[str] = None,
            crn: Optional[str] = None,
            default_access_policy: Optional[str] = None,
            endpoint_gateway_binding_auto_delete: Optional[bool] = None,
            endpoint_gateway_binding_auto_delete_timeout: Optional[float] = None,
            endpoint_gateway_count: Optional[float] = None,
            href: Optional[str] = None,
            is_private_path_service_gateway_id: Optional[str] = None,
            lifecycle_state: Optional[str] = None,
            load_balancer: Optional[str] = None,
            name: Optional[str] = None,
            private_path_service_gateway: Optional[str] = None,
            published: Optional[bool] = None,
            resource_group: Optional[str] = None,
            resource_type: Optional[str] = None,
            service_endpoints: Optional[Sequence[str]] = None,
            updated_at: Optional[str] = None,
            vpc: Optional[str] = None,
            zonal_affinity: Optional[bool] = None) -> IsPrivatePathServiceGateway
    func GetIsPrivatePathServiceGateway(ctx *Context, name string, id IDInput, state *IsPrivatePathServiceGatewayState, opts ...ResourceOption) (*IsPrivatePathServiceGateway, error)
    public static IsPrivatePathServiceGateway Get(string name, Input<string> id, IsPrivatePathServiceGatewayState? state, CustomResourceOptions? opts = null)
    public static IsPrivatePathServiceGateway get(String name, Output<String> id, IsPrivatePathServiceGatewayState state, CustomResourceOptions options)
    resources:  _:    type: ibm:IsPrivatePathServiceGateway    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:
    CreatedAt string
    (String) The date and time that the private path service gateway was created.
    Crn string
    (String) The CRN for this private path service gateway.
    DefaultAccessPolicy string
    The policy to use for bindings from accounts without an explicit account policy. permit: access will be permitted. deny: access will be denied. review: access will be manually reviewed. Allowable values are: deny, permit, review.
    EndpointGatewayBindingAutoDelete bool
    (Boolean) Indicates whether endpoint gateway bindings will be automatically deleted after endpoint_gateway_binding_auto_delete_timeout hours have passed. At present, this is always true, but may be modifiable in the future.
    EndpointGatewayBindingAutoDeleteTimeout double
    (Integer) If endpoint_gateway_binding_auto_delete is true, the hours after which endpoint gateway bindings will be automatically deleted. If the value is 0, abandoned endpoint gateway bindings will be deleted immediately. At present, this is always set to 0. This value may be modifiable in the future.
    EndpointGatewayCount double
    (Integer) The number of endpoint gateways using this private path service gateway.
    Href string
    (String) The URL for this private path service gateway.
    IsPrivatePathServiceGatewayId string
    The unique identifier of the PrivatePathServiceGateway
    LifecycleState string
    (String) The lifecycle state of the private path service gateway.
    LoadBalancer string
    The ID of the load balancer for this private path service gateway. This load balancer must be in the same VPC as the private path service gateway and must have is_private_path set to true.
    Name string
    The name for this private path service gateway. The name must not be used by another private path service gateway in the VPC.
    PrivatePathServiceGateway string
    The unique identifier for this account policy.
    Published bool
    (Boolean) Indicates the availability of this private path service gateway- true: Any account can request access to this private path service gateway.- false: Access is restricted to the account that created this private path service gateway.
    ResourceGroup string
    ID of the resource group to use.
    ResourceType string
    (String) The resource type.
    ServiceEndpoints List<string>
    The fully qualified domain names for this private path service gateway.
    UpdatedAt string
    The date and time that the account policy was updated.
    Vpc string
    (String) The VPC this private path service gateway resides in.
    ZonalAffinity bool
    Indicates whether this private path service gateway has zonal affinity.
    CreatedAt string
    (String) The date and time that the private path service gateway was created.
    Crn string
    (String) The CRN for this private path service gateway.
    DefaultAccessPolicy string
    The policy to use for bindings from accounts without an explicit account policy. permit: access will be permitted. deny: access will be denied. review: access will be manually reviewed. Allowable values are: deny, permit, review.
    EndpointGatewayBindingAutoDelete bool
    (Boolean) Indicates whether endpoint gateway bindings will be automatically deleted after endpoint_gateway_binding_auto_delete_timeout hours have passed. At present, this is always true, but may be modifiable in the future.
    EndpointGatewayBindingAutoDeleteTimeout float64
    (Integer) If endpoint_gateway_binding_auto_delete is true, the hours after which endpoint gateway bindings will be automatically deleted. If the value is 0, abandoned endpoint gateway bindings will be deleted immediately. At present, this is always set to 0. This value may be modifiable in the future.
    EndpointGatewayCount float64
    (Integer) The number of endpoint gateways using this private path service gateway.
    Href string
    (String) The URL for this private path service gateway.
    IsPrivatePathServiceGatewayId string
    The unique identifier of the PrivatePathServiceGateway
    LifecycleState string
    (String) The lifecycle state of the private path service gateway.
    LoadBalancer string
    The ID of the load balancer for this private path service gateway. This load balancer must be in the same VPC as the private path service gateway and must have is_private_path set to true.
    Name string
    The name for this private path service gateway. The name must not be used by another private path service gateway in the VPC.
    PrivatePathServiceGateway string
    The unique identifier for this account policy.
    Published bool
    (Boolean) Indicates the availability of this private path service gateway- true: Any account can request access to this private path service gateway.- false: Access is restricted to the account that created this private path service gateway.
    ResourceGroup string
    ID of the resource group to use.
    ResourceType string
    (String) The resource type.
    ServiceEndpoints []string
    The fully qualified domain names for this private path service gateway.
    UpdatedAt string
    The date and time that the account policy was updated.
    Vpc string
    (String) The VPC this private path service gateway resides in.
    ZonalAffinity bool
    Indicates whether this private path service gateway has zonal affinity.
    createdAt String
    (String) The date and time that the private path service gateway was created.
    crn String
    (String) The CRN for this private path service gateway.
    defaultAccessPolicy String
    The policy to use for bindings from accounts without an explicit account policy. permit: access will be permitted. deny: access will be denied. review: access will be manually reviewed. Allowable values are: deny, permit, review.
    endpointGatewayBindingAutoDelete Boolean
    (Boolean) Indicates whether endpoint gateway bindings will be automatically deleted after endpoint_gateway_binding_auto_delete_timeout hours have passed. At present, this is always true, but may be modifiable in the future.
    endpointGatewayBindingAutoDeleteTimeout Double
    (Integer) If endpoint_gateway_binding_auto_delete is true, the hours after which endpoint gateway bindings will be automatically deleted. If the value is 0, abandoned endpoint gateway bindings will be deleted immediately. At present, this is always set to 0. This value may be modifiable in the future.
    endpointGatewayCount Double
    (Integer) The number of endpoint gateways using this private path service gateway.
    href String
    (String) The URL for this private path service gateway.
    isPrivatePathServiceGatewayId String
    The unique identifier of the PrivatePathServiceGateway
    lifecycleState String
    (String) The lifecycle state of the private path service gateway.
    loadBalancer String
    The ID of the load balancer for this private path service gateway. This load balancer must be in the same VPC as the private path service gateway and must have is_private_path set to true.
    name String
    The name for this private path service gateway. The name must not be used by another private path service gateway in the VPC.
    privatePathServiceGateway String
    The unique identifier for this account policy.
    published Boolean
    (Boolean) Indicates the availability of this private path service gateway- true: Any account can request access to this private path service gateway.- false: Access is restricted to the account that created this private path service gateway.
    resourceGroup String
    ID of the resource group to use.
    resourceType String
    (String) The resource type.
    serviceEndpoints List<String>
    The fully qualified domain names for this private path service gateway.
    updatedAt String
    The date and time that the account policy was updated.
    vpc String
    (String) The VPC this private path service gateway resides in.
    zonalAffinity Boolean
    Indicates whether this private path service gateway has zonal affinity.
    createdAt string
    (String) The date and time that the private path service gateway was created.
    crn string
    (String) The CRN for this private path service gateway.
    defaultAccessPolicy string
    The policy to use for bindings from accounts without an explicit account policy. permit: access will be permitted. deny: access will be denied. review: access will be manually reviewed. Allowable values are: deny, permit, review.
    endpointGatewayBindingAutoDelete boolean
    (Boolean) Indicates whether endpoint gateway bindings will be automatically deleted after endpoint_gateway_binding_auto_delete_timeout hours have passed. At present, this is always true, but may be modifiable in the future.
    endpointGatewayBindingAutoDeleteTimeout number
    (Integer) If endpoint_gateway_binding_auto_delete is true, the hours after which endpoint gateway bindings will be automatically deleted. If the value is 0, abandoned endpoint gateway bindings will be deleted immediately. At present, this is always set to 0. This value may be modifiable in the future.
    endpointGatewayCount number
    (Integer) The number of endpoint gateways using this private path service gateway.
    href string
    (String) The URL for this private path service gateway.
    isPrivatePathServiceGatewayId string
    The unique identifier of the PrivatePathServiceGateway
    lifecycleState string
    (String) The lifecycle state of the private path service gateway.
    loadBalancer string
    The ID of the load balancer for this private path service gateway. This load balancer must be in the same VPC as the private path service gateway and must have is_private_path set to true.
    name string
    The name for this private path service gateway. The name must not be used by another private path service gateway in the VPC.
    privatePathServiceGateway string
    The unique identifier for this account policy.
    published boolean
    (Boolean) Indicates the availability of this private path service gateway- true: Any account can request access to this private path service gateway.- false: Access is restricted to the account that created this private path service gateway.
    resourceGroup string
    ID of the resource group to use.
    resourceType string
    (String) The resource type.
    serviceEndpoints string[]
    The fully qualified domain names for this private path service gateway.
    updatedAt string
    The date and time that the account policy was updated.
    vpc string
    (String) The VPC this private path service gateway resides in.
    zonalAffinity boolean
    Indicates whether this private path service gateway has zonal affinity.
    created_at str
    (String) The date and time that the private path service gateway was created.
    crn str
    (String) The CRN for this private path service gateway.
    default_access_policy str
    The policy to use for bindings from accounts without an explicit account policy. permit: access will be permitted. deny: access will be denied. review: access will be manually reviewed. Allowable values are: deny, permit, review.
    endpoint_gateway_binding_auto_delete bool
    (Boolean) Indicates whether endpoint gateway bindings will be automatically deleted after endpoint_gateway_binding_auto_delete_timeout hours have passed. At present, this is always true, but may be modifiable in the future.
    endpoint_gateway_binding_auto_delete_timeout float
    (Integer) If endpoint_gateway_binding_auto_delete is true, the hours after which endpoint gateway bindings will be automatically deleted. If the value is 0, abandoned endpoint gateway bindings will be deleted immediately. At present, this is always set to 0. This value may be modifiable in the future.
    endpoint_gateway_count float
    (Integer) The number of endpoint gateways using this private path service gateway.
    href str
    (String) The URL for this private path service gateway.
    is_private_path_service_gateway_id str
    The unique identifier of the PrivatePathServiceGateway
    lifecycle_state str
    (String) The lifecycle state of the private path service gateway.
    load_balancer str
    The ID of the load balancer for this private path service gateway. This load balancer must be in the same VPC as the private path service gateway and must have is_private_path set to true.
    name str
    The name for this private path service gateway. The name must not be used by another private path service gateway in the VPC.
    private_path_service_gateway str
    The unique identifier for this account policy.
    published bool
    (Boolean) Indicates the availability of this private path service gateway- true: Any account can request access to this private path service gateway.- false: Access is restricted to the account that created this private path service gateway.
    resource_group str
    ID of the resource group to use.
    resource_type str
    (String) The resource type.
    service_endpoints Sequence[str]
    The fully qualified domain names for this private path service gateway.
    updated_at str
    The date and time that the account policy was updated.
    vpc str
    (String) The VPC this private path service gateway resides in.
    zonal_affinity bool
    Indicates whether this private path service gateway has zonal affinity.
    createdAt String
    (String) The date and time that the private path service gateway was created.
    crn String
    (String) The CRN for this private path service gateway.
    defaultAccessPolicy String
    The policy to use for bindings from accounts without an explicit account policy. permit: access will be permitted. deny: access will be denied. review: access will be manually reviewed. Allowable values are: deny, permit, review.
    endpointGatewayBindingAutoDelete Boolean
    (Boolean) Indicates whether endpoint gateway bindings will be automatically deleted after endpoint_gateway_binding_auto_delete_timeout hours have passed. At present, this is always true, but may be modifiable in the future.
    endpointGatewayBindingAutoDeleteTimeout Number
    (Integer) If endpoint_gateway_binding_auto_delete is true, the hours after which endpoint gateway bindings will be automatically deleted. If the value is 0, abandoned endpoint gateway bindings will be deleted immediately. At present, this is always set to 0. This value may be modifiable in the future.
    endpointGatewayCount Number
    (Integer) The number of endpoint gateways using this private path service gateway.
    href String
    (String) The URL for this private path service gateway.
    isPrivatePathServiceGatewayId String
    The unique identifier of the PrivatePathServiceGateway
    lifecycleState String
    (String) The lifecycle state of the private path service gateway.
    loadBalancer String
    The ID of the load balancer for this private path service gateway. This load balancer must be in the same VPC as the private path service gateway and must have is_private_path set to true.
    name String
    The name for this private path service gateway. The name must not be used by another private path service gateway in the VPC.
    privatePathServiceGateway String
    The unique identifier for this account policy.
    published Boolean
    (Boolean) Indicates the availability of this private path service gateway- true: Any account can request access to this private path service gateway.- false: Access is restricted to the account that created this private path service gateway.
    resourceGroup String
    ID of the resource group to use.
    resourceType String
    (String) The resource type.
    serviceEndpoints List<String>
    The fully qualified domain names for this private path service gateway.
    updatedAt String
    The date and time that the account policy was updated.
    vpc String
    (String) The VPC this private path service gateway resides in.
    zonalAffinity Boolean
    Indicates whether this private path service gateway has zonal affinity.

    Import

    You can import the ibm_is_private_path_service_gateway resource by using id. The unique identifier for this private path service gateway.

    Syntax

    $ pulumi import ibm:index/isPrivatePathServiceGateway:IsPrivatePathServiceGateway example <id>
    

    Example

    $ pulumi import ibm:index/isPrivatePathServiceGateway:IsPrivatePathServiceGateway example 0767-fa41aecb-4f21-423d-8082-630bfba1e1d9
    

    To learn more about importing existing cloud resources, see Importing resources.

    Package Details

    Repository
    ibm ibm-cloud/terraform-provider-ibm
    License
    Notes
    This Pulumi package is based on the ibm Terraform Provider.
    ibm logo
    ibm 1.78.0 published on Wednesday, Apr 30, 2025 by ibm-cloud