1. Registry
  2. Packages
  3. Google Cloud Native
  4. API Docs
  5. networkconnectivity
  6. networkconnectivity/v1alpha1
  7. InternalRange

This package is deprecated. Active development has stopped. We recommend using the Google Cloud package instead.

Viewing docs for Google Cloud Native v0.32.0
published on Wednesday, Nov 29, 2023 by Pulumi
google-native logo Google Cloud Native

This package is deprecated. Active development has stopped. We recommend using the Google Cloud package instead.

Viewing docs for Google Cloud Native v0.32.0
published on Wednesday, Nov 29, 2023 by Pulumi

    Creates a new internal range in a given project and location.

    Create InternalRange Resource

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

    Constructor syntax

    new InternalRange(name: string, args?: InternalRangeArgs, opts?: CustomResourceOptions);
    @overload
    def InternalRange(resource_name: str,
                      args: Optional[InternalRangeArgs] = None,
                      opts: Optional[ResourceOptions] = None)
    
    @overload
    def InternalRange(resource_name: str,
                      opts: Optional[ResourceOptions] = None,
                      create_time: Optional[str] = None,
                      description: Optional[str] = None,
                      internal_range_id: Optional[str] = None,
                      ip_cidr_range: Optional[str] = None,
                      labels: Optional[Mapping[str, str]] = None,
                      location: Optional[str] = None,
                      name: Optional[str] = None,
                      network: Optional[str] = None,
                      overlaps: Optional[Sequence[InternalRangeOverlapsItem]] = None,
                      peering: Optional[InternalRangePeering] = None,
                      prefix_length: Optional[int] = None,
                      project: Optional[str] = None,
                      request_id: Optional[str] = None,
                      target_cidr_range: Optional[Sequence[str]] = None,
                      update_time: Optional[str] = None,
                      usage: Optional[InternalRangeUsage] = None)
    func NewInternalRange(ctx *Context, name string, args *InternalRangeArgs, opts ...ResourceOption) (*InternalRange, error)
    public InternalRange(string name, InternalRangeArgs? args = null, CustomResourceOptions? opts = null)
    public InternalRange(String name, InternalRangeArgs args)
    public InternalRange(String name, InternalRangeArgs args, CustomResourceOptions options)
    
    type: google-native:networkconnectivity/v1alpha1:InternalRange
    properties: # The arguments to resource properties.
    options: # Bag of options to control resource's behavior.
    
    
    resource "google-native_networkconnectivity_v1alpha1_internal_range" "name" {
        # resource properties
    }

    Parameters

    name string
    The unique name of the resource.
    args InternalRangeArgs
    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 InternalRangeArgs
    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 InternalRangeArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args InternalRangeArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args InternalRangeArgs
    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 google_nativeInternalRangeResource = new GoogleNative.NetworkConnectivity.V1Alpha1.InternalRange("google-nativeInternalRangeResource", new()
    {
        CreateTime = "string",
        Description = "string",
        InternalRangeId = "string",
        IpCidrRange = "string",
        Labels = 
        {
            { "string", "string" },
        },
        Location = "string",
        Name = "string",
        Network = "string",
        Overlaps = new[]
        {
            GoogleNative.NetworkConnectivity.V1Alpha1.InternalRangeOverlapsItem.OverlapUnspecified,
        },
        Peering = GoogleNative.NetworkConnectivity.V1Alpha1.InternalRangePeering.PeeringUnspecified,
        PrefixLength = 0,
        Project = "string",
        RequestId = "string",
        TargetCidrRange = new[]
        {
            "string",
        },
        UpdateTime = "string",
        Usage = GoogleNative.NetworkConnectivity.V1Alpha1.InternalRangeUsage.UsageUnspecified,
    });
    
    example, err := networkconnectivityv1alpha1.NewInternalRange(ctx, "google-nativeInternalRangeResource", &networkconnectivityv1alpha1.InternalRangeArgs{
    	CreateTime:      pulumi.String("string"),
    	Description:     pulumi.String("string"),
    	InternalRangeId: pulumi.String("string"),
    	IpCidrRange:     pulumi.String("string"),
    	Labels: pulumi.StringMap{
    		"string": pulumi.String("string"),
    	},
    	Location: pulumi.String("string"),
    	Name:     pulumi.String("string"),
    	Network:  pulumi.String("string"),
    	Overlaps: networkconnectivity.InternalRangeOverlapsItemArray{
    		networkconnectivityv1alpha1.InternalRangeOverlapsItemOverlapUnspecified,
    	},
    	Peering:      networkconnectivityv1alpha1.InternalRangePeeringPeeringUnspecified,
    	PrefixLength: pulumi.Int(0),
    	Project:      pulumi.String("string"),
    	RequestId:    pulumi.String("string"),
    	TargetCidrRange: pulumi.StringArray{
    		pulumi.String("string"),
    	},
    	UpdateTime: pulumi.String("string"),
    	Usage:      networkconnectivityv1alpha1.InternalRangeUsageUsageUnspecified,
    })
    
    resource "google-native_networkconnectivity_v1alpha1_internal_range" "google-nativeInternalRangeResource" {
      lifecycle {
        create_before_destroy = true
      }
      create_time       = "string"
      description       = "string"
      internal_range_id = "string"
      ip_cidr_range     = "string"
      labels = {
        "string" = "string"
      }
      location          = "string"
      name              = "string"
      network           = "string"
      overlaps          = ["OVERLAP_UNSPECIFIED"]
      peering           = "PEERING_UNSPECIFIED"
      prefix_length     = 0
      project           = "string"
      request_id        = "string"
      target_cidr_range = ["string"]
      update_time       = "string"
      usage             = "USAGE_UNSPECIFIED"
    }
    
    var google_nativeInternalRangeResource = new com.pulumi.googlenative.networkconnectivity_v1alpha1.InternalRange("google-nativeInternalRangeResource", com.pulumi.googlenative.networkconnectivity_v1alpha1.InternalRangeArgs.builder()
        .createTime("string")
        .description("string")
        .internalRangeId("string")
        .ipCidrRange("string")
        .labels(Map.of("string", "string"))
        .location("string")
        .name("string")
        .network("string")
        .overlaps("OVERLAP_UNSPECIFIED")
        .peering(com.pulumi.googlenative.networkconnectivity_v1alpha1.enums.InternalRangePeering.PeeringUnspecified)
        .prefixLength(0)
        .project("string")
        .requestId("string")
        .targetCidrRange("string")
        .updateTime("string")
        .usage(com.pulumi.googlenative.networkconnectivity_v1alpha1.enums.InternalRangeUsage.UsageUnspecified)
        .build());
    
    google_native_internal_range_resource = google_native.networkconnectivity.v1alpha1.InternalRange("google-nativeInternalRangeResource",
        create_time="string",
        description="string",
        internal_range_id="string",
        ip_cidr_range="string",
        labels={
            "string": "string",
        },
        location="string",
        name="string",
        network="string",
        overlaps=[google_native.networkconnectivity.v1alpha1.InternalRangeOverlapsItem.OVERLAP_UNSPECIFIED],
        peering=google_native.networkconnectivity.v1alpha1.InternalRangePeering.PEERING_UNSPECIFIED,
        prefix_length=0,
        project="string",
        request_id="string",
        target_cidr_range=["string"],
        update_time="string",
        usage=google_native.networkconnectivity.v1alpha1.InternalRangeUsage.USAGE_UNSPECIFIED)
    
    const google_nativeInternalRangeResource = new google_native.networkconnectivity.v1alpha1.InternalRange("google-nativeInternalRangeResource", {
        createTime: "string",
        description: "string",
        internalRangeId: "string",
        ipCidrRange: "string",
        labels: {
            string: "string",
        },
        location: "string",
        name: "string",
        network: "string",
        overlaps: [google_native.networkconnectivity.v1alpha1.InternalRangeOverlapsItem.OverlapUnspecified],
        peering: google_native.networkconnectivity.v1alpha1.InternalRangePeering.PeeringUnspecified,
        prefixLength: 0,
        project: "string",
        requestId: "string",
        targetCidrRange: ["string"],
        updateTime: "string",
        usage: google_native.networkconnectivity.v1alpha1.InternalRangeUsage.UsageUnspecified,
    });
    
    type: google-native:networkconnectivity/v1alpha1:InternalRange
    properties:
        createTime: string
        description: string
        internalRangeId: string
        ipCidrRange: string
        labels:
            string: string
        location: string
        name: string
        network: string
        overlaps:
            - OVERLAP_UNSPECIFIED
        peering: PEERING_UNSPECIFIED
        prefixLength: 0
        project: string
        requestId: string
        targetCidrRange:
            - string
        updateTime: string
        usage: USAGE_UNSPECIFIED
    

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

    CreateTime string
    Time when the internal range was created.
    Description string
    A description of this resource.
    InternalRangeId string
    Optional. Resource ID (i.e. 'foo' in '[...]/projects/p/locations/l/internalRanges/foo') See https://google.aip.dev/122#resource-id-segments Unique per location.
    IpCidrRange string
    IP range that this internal range defines.
    Labels Dictionary<string, string>
    User-defined labels.
    Location string
    Name string
    Immutable. The name of an internal range. Format: projects/{project}/locations/{location}/internalRanges/{internal_range} See: https://google.aip.dev/122#fields-representing-resource-names
    Network string
    The URL or resource ID of the network in which to reserve the internal range. The network cannot be deleted if there are any reserved internal ranges referring to it. Legacy networks are not supported. This can only be specified for a global internal address. Example: - URL: /compute/v1/projects/{project}/global/networks/{resourceId} - ID: network123
    Overlaps List<Pulumi.GoogleNative.NetworkConnectivity.V1Alpha1.InternalRangeOverlapsItem>
    Optional. Types of resources that are allowed to overlap with the current internal range.
    Peering Pulumi.GoogleNative.NetworkConnectivity.V1Alpha1.InternalRangePeering
    The type of peering set for this internal range.
    PrefixLength int
    An alternative to ip_cidr_range. Can be set when trying to create a reservation that automatically finds a free range of the given size. If both ip_cidr_range and prefix_length are set, there is an error if the range sizes do not match. Can also be used during updates to change the range size.
    Project string
    RequestId string
    Optional. An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee that for at least 60 minutes since the first request. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if the original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).
    TargetCidrRange List<string>
    Optional. Can be set to narrow down or pick a different address space while searching for a free range. If not set, defaults to the "10.0.0.0/8" address space. This can be used to search in other rfc-1918 address spaces like "172.16.0.0/12" and "192.168.0.0/16" or non-rfc-1918 address spaces used in the VPC.
    UpdateTime string
    Time when the internal range was updated.
    Usage Pulumi.GoogleNative.NetworkConnectivity.V1Alpha1.InternalRangeUsage
    The type of usage set for this internal range.
    CreateTime string
    Time when the internal range was created.
    Description string
    A description of this resource.
    InternalRangeId string
    Optional. Resource ID (i.e. 'foo' in '[...]/projects/p/locations/l/internalRanges/foo') See https://google.aip.dev/122#resource-id-segments Unique per location.
    IpCidrRange string
    IP range that this internal range defines.
    Labels map[string]string
    User-defined labels.
    Location string
    Name string
    Immutable. The name of an internal range. Format: projects/{project}/locations/{location}/internalRanges/{internal_range} See: https://google.aip.dev/122#fields-representing-resource-names
    Network string
    The URL or resource ID of the network in which to reserve the internal range. The network cannot be deleted if there are any reserved internal ranges referring to it. Legacy networks are not supported. This can only be specified for a global internal address. Example: - URL: /compute/v1/projects/{project}/global/networks/{resourceId} - ID: network123
    Overlaps []InternalRangeOverlapsItem
    Optional. Types of resources that are allowed to overlap with the current internal range.
    Peering InternalRangePeering
    The type of peering set for this internal range.
    PrefixLength int
    An alternative to ip_cidr_range. Can be set when trying to create a reservation that automatically finds a free range of the given size. If both ip_cidr_range and prefix_length are set, there is an error if the range sizes do not match. Can also be used during updates to change the range size.
    Project string
    RequestId string
    Optional. An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee that for at least 60 minutes since the first request. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if the original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).
    TargetCidrRange []string
    Optional. Can be set to narrow down or pick a different address space while searching for a free range. If not set, defaults to the "10.0.0.0/8" address space. This can be used to search in other rfc-1918 address spaces like "172.16.0.0/12" and "192.168.0.0/16" or non-rfc-1918 address spaces used in the VPC.
    UpdateTime string
    Time when the internal range was updated.
    Usage InternalRangeUsage
    The type of usage set for this internal range.
    create_time string
    Time when the internal range was created.
    description string
    A description of this resource.
    internal_range_id string
    Optional. Resource ID (i.e. 'foo' in '[...]/projects/p/locations/l/internalRanges/foo') See https://google.aip.dev/122#resource-id-segments Unique per location.
    ip_cidr_range string
    IP range that this internal range defines.
    labels map(string)
    User-defined labels.
    location string
    name string
    Immutable. The name of an internal range. Format: projects/{project}/locations/{location}/internalRanges/{internal_range} See: https://google.aip.dev/122#fields-representing-resource-names
    network string
    The URL or resource ID of the network in which to reserve the internal range. The network cannot be deleted if there are any reserved internal ranges referring to it. Legacy networks are not supported. This can only be specified for a global internal address. Example: - URL: /compute/v1/projects/{project}/global/networks/{resourceId} - ID: network123
    overlaps list("OVERLAP_UNSPECIFIED" | "OVERLAP_ROUTE_RANGE" | "OVERLAP_EXISTING_SUBNET_RANGE")
    Optional. Types of resources that are allowed to overlap with the current internal range.
    peering "PEERING_UNSPECIFIED" | "FOR_SELF" | "FOR_PEER" | "NOT_SHARED"
    The type of peering set for this internal range.
    prefix_length number
    An alternative to ip_cidr_range. Can be set when trying to create a reservation that automatically finds a free range of the given size. If both ip_cidr_range and prefix_length are set, there is an error if the range sizes do not match. Can also be used during updates to change the range size.
    project string
    request_id string
    Optional. An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee that for at least 60 minutes since the first request. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if the original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).
    target_cidr_range list(string)
    Optional. Can be set to narrow down or pick a different address space while searching for a free range. If not set, defaults to the "10.0.0.0/8" address space. This can be used to search in other rfc-1918 address spaces like "172.16.0.0/12" and "192.168.0.0/16" or non-rfc-1918 address spaces used in the VPC.
    update_time string
    Time when the internal range was updated.
    usage "USAGE_UNSPECIFIED" | "FOR_VPC" | "EXTERNAL_TO_VPC"
    The type of usage set for this internal range.
    createTime String
    Time when the internal range was created.
    description String
    A description of this resource.
    internalRangeId String
    Optional. Resource ID (i.e. 'foo' in '[...]/projects/p/locations/l/internalRanges/foo') See https://google.aip.dev/122#resource-id-segments Unique per location.
    ipCidrRange String
    IP range that this internal range defines.
    labels Map<String,String>
    User-defined labels.
    location String
    name String
    Immutable. The name of an internal range. Format: projects/{project}/locations/{location}/internalRanges/{internal_range} See: https://google.aip.dev/122#fields-representing-resource-names
    network String
    The URL or resource ID of the network in which to reserve the internal range. The network cannot be deleted if there are any reserved internal ranges referring to it. Legacy networks are not supported. This can only be specified for a global internal address. Example: - URL: /compute/v1/projects/{project}/global/networks/{resourceId} - ID: network123
    overlaps List<InternalRangeOverlapsItem>
    Optional. Types of resources that are allowed to overlap with the current internal range.
    peering InternalRangePeering
    The type of peering set for this internal range.
    prefixLength Integer
    An alternative to ip_cidr_range. Can be set when trying to create a reservation that automatically finds a free range of the given size. If both ip_cidr_range and prefix_length are set, there is an error if the range sizes do not match. Can also be used during updates to change the range size.
    project String
    requestId String
    Optional. An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee that for at least 60 minutes since the first request. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if the original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).
    targetCidrRange List<String>
    Optional. Can be set to narrow down or pick a different address space while searching for a free range. If not set, defaults to the "10.0.0.0/8" address space. This can be used to search in other rfc-1918 address spaces like "172.16.0.0/12" and "192.168.0.0/16" or non-rfc-1918 address spaces used in the VPC.
    updateTime String
    Time when the internal range was updated.
    usage InternalRangeUsage
    The type of usage set for this internal range.
    createTime string
    Time when the internal range was created.
    description string
    A description of this resource.
    internalRangeId string
    Optional. Resource ID (i.e. 'foo' in '[...]/projects/p/locations/l/internalRanges/foo') See https://google.aip.dev/122#resource-id-segments Unique per location.
    ipCidrRange string
    IP range that this internal range defines.
    labels {[key: string]: string}
    User-defined labels.
    location string
    name string
    Immutable. The name of an internal range. Format: projects/{project}/locations/{location}/internalRanges/{internal_range} See: https://google.aip.dev/122#fields-representing-resource-names
    network string
    The URL or resource ID of the network in which to reserve the internal range. The network cannot be deleted if there are any reserved internal ranges referring to it. Legacy networks are not supported. This can only be specified for a global internal address. Example: - URL: /compute/v1/projects/{project}/global/networks/{resourceId} - ID: network123
    overlaps InternalRangeOverlapsItem[]
    Optional. Types of resources that are allowed to overlap with the current internal range.
    peering InternalRangePeering
    The type of peering set for this internal range.
    prefixLength number
    An alternative to ip_cidr_range. Can be set when trying to create a reservation that automatically finds a free range of the given size. If both ip_cidr_range and prefix_length are set, there is an error if the range sizes do not match. Can also be used during updates to change the range size.
    project string
    requestId string
    Optional. An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee that for at least 60 minutes since the first request. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if the original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).
    targetCidrRange string[]
    Optional. Can be set to narrow down or pick a different address space while searching for a free range. If not set, defaults to the "10.0.0.0/8" address space. This can be used to search in other rfc-1918 address spaces like "172.16.0.0/12" and "192.168.0.0/16" or non-rfc-1918 address spaces used in the VPC.
    updateTime string
    Time when the internal range was updated.
    usage InternalRangeUsage
    The type of usage set for this internal range.
    create_time str
    Time when the internal range was created.
    description str
    A description of this resource.
    internal_range_id str
    Optional. Resource ID (i.e. 'foo' in '[...]/projects/p/locations/l/internalRanges/foo') See https://google.aip.dev/122#resource-id-segments Unique per location.
    ip_cidr_range str
    IP range that this internal range defines.
    labels Mapping[str, str]
    User-defined labels.
    location str
    name str
    Immutable. The name of an internal range. Format: projects/{project}/locations/{location}/internalRanges/{internal_range} See: https://google.aip.dev/122#fields-representing-resource-names
    network str
    The URL or resource ID of the network in which to reserve the internal range. The network cannot be deleted if there are any reserved internal ranges referring to it. Legacy networks are not supported. This can only be specified for a global internal address. Example: - URL: /compute/v1/projects/{project}/global/networks/{resourceId} - ID: network123
    overlaps Sequence[InternalRangeOverlapsItem]
    Optional. Types of resources that are allowed to overlap with the current internal range.
    peering InternalRangePeering
    The type of peering set for this internal range.
    prefix_length int
    An alternative to ip_cidr_range. Can be set when trying to create a reservation that automatically finds a free range of the given size. If both ip_cidr_range and prefix_length are set, there is an error if the range sizes do not match. Can also be used during updates to change the range size.
    project str
    request_id str
    Optional. An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee that for at least 60 minutes since the first request. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if the original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).
    target_cidr_range Sequence[str]
    Optional. Can be set to narrow down or pick a different address space while searching for a free range. If not set, defaults to the "10.0.0.0/8" address space. This can be used to search in other rfc-1918 address spaces like "172.16.0.0/12" and "192.168.0.0/16" or non-rfc-1918 address spaces used in the VPC.
    update_time str
    Time when the internal range was updated.
    usage InternalRangeUsage
    The type of usage set for this internal range.
    createTime String
    Time when the internal range was created.
    description String
    A description of this resource.
    internalRangeId String
    Optional. Resource ID (i.e. 'foo' in '[...]/projects/p/locations/l/internalRanges/foo') See https://google.aip.dev/122#resource-id-segments Unique per location.
    ipCidrRange String
    IP range that this internal range defines.
    labels Map<String>
    User-defined labels.
    location String
    name String
    Immutable. The name of an internal range. Format: projects/{project}/locations/{location}/internalRanges/{internal_range} See: https://google.aip.dev/122#fields-representing-resource-names
    network String
    The URL or resource ID of the network in which to reserve the internal range. The network cannot be deleted if there are any reserved internal ranges referring to it. Legacy networks are not supported. This can only be specified for a global internal address. Example: - URL: /compute/v1/projects/{project}/global/networks/{resourceId} - ID: network123
    overlaps List<"OVERLAP_UNSPECIFIED" | "OVERLAP_ROUTE_RANGE" | "OVERLAP_EXISTING_SUBNET_RANGE">
    Optional. Types of resources that are allowed to overlap with the current internal range.
    peering "PEERING_UNSPECIFIED" | "FOR_SELF" | "FOR_PEER" | "NOT_SHARED"
    The type of peering set for this internal range.
    prefixLength Number
    An alternative to ip_cidr_range. Can be set when trying to create a reservation that automatically finds a free range of the given size. If both ip_cidr_range and prefix_length are set, there is an error if the range sizes do not match. Can also be used during updates to change the range size.
    project String
    requestId String
    Optional. An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee that for at least 60 minutes since the first request. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if the original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).
    targetCidrRange List<String>
    Optional. Can be set to narrow down or pick a different address space while searching for a free range. If not set, defaults to the "10.0.0.0/8" address space. This can be used to search in other rfc-1918 address spaces like "172.16.0.0/12" and "192.168.0.0/16" or non-rfc-1918 address spaces used in the VPC.
    updateTime String
    Time when the internal range was updated.
    usage "USAGE_UNSPECIFIED" | "FOR_VPC" | "EXTERNAL_TO_VPC"
    The type of usage set for this internal range.

    Outputs

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

    Id string
    The provider-assigned unique ID for this managed resource.
    Users List<string>
    The list of resources that refer to this internal range. Resources that use the internal range for their range allocation are referred to as users of the range. Other resources mark themselves as users while doing so by creating a reference to this internal range. Having a user, based on this reference, prevents deletion of the internal range that is referred to. Can be empty.
    Id string
    The provider-assigned unique ID for this managed resource.
    Users []string
    The list of resources that refer to this internal range. Resources that use the internal range for their range allocation are referred to as users of the range. Other resources mark themselves as users while doing so by creating a reference to this internal range. Having a user, based on this reference, prevents deletion of the internal range that is referred to. Can be empty.
    id string
    The provider-assigned unique ID for this managed resource.
    users list(string)
    The list of resources that refer to this internal range. Resources that use the internal range for their range allocation are referred to as users of the range. Other resources mark themselves as users while doing so by creating a reference to this internal range. Having a user, based on this reference, prevents deletion of the internal range that is referred to. Can be empty.
    id String
    The provider-assigned unique ID for this managed resource.
    users List<String>
    The list of resources that refer to this internal range. Resources that use the internal range for their range allocation are referred to as users of the range. Other resources mark themselves as users while doing so by creating a reference to this internal range. Having a user, based on this reference, prevents deletion of the internal range that is referred to. Can be empty.
    id string
    The provider-assigned unique ID for this managed resource.
    users string[]
    The list of resources that refer to this internal range. Resources that use the internal range for their range allocation are referred to as users of the range. Other resources mark themselves as users while doing so by creating a reference to this internal range. Having a user, based on this reference, prevents deletion of the internal range that is referred to. Can be empty.
    id str
    The provider-assigned unique ID for this managed resource.
    users Sequence[str]
    The list of resources that refer to this internal range. Resources that use the internal range for their range allocation are referred to as users of the range. Other resources mark themselves as users while doing so by creating a reference to this internal range. Having a user, based on this reference, prevents deletion of the internal range that is referred to. Can be empty.
    id String
    The provider-assigned unique ID for this managed resource.
    users List<String>
    The list of resources that refer to this internal range. Resources that use the internal range for their range allocation are referred to as users of the range. Other resources mark themselves as users while doing so by creating a reference to this internal range. Having a user, based on this reference, prevents deletion of the internal range that is referred to. Can be empty.

    Look up Existing InternalRange Resource

    Get an existing InternalRange 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>, opts?: CustomResourceOptions): InternalRange
    @staticmethod
    def get(resource_name: str,
            id: str,
            opts: Optional[ResourceOptions] = None) -> InternalRange
    func GetInternalRange(ctx *Context, name string, id IDInput, state *InternalRangeState, opts ...ResourceOption) (*InternalRange, error)
    public static InternalRange Get(string name, Input<string> id, CustomResourceOptions? opts = null)
    public static InternalRange get(String name, Output<String> id, CustomResourceOptions options)
    resources:  existingInternalRange:    type: google-native:networkconnectivity/v1alpha1:InternalRange    get:      id: ${id}
    import {
      to = google-native_networkconnectivity_v1alpha1_internal_range.example
      id = "${id}"
    }
    
    name string
    The unique name of the resulting resource.
    id Input<ID>
    The unique provider ID of the resource to look up.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    resource_name str
    The unique name of the resulting resource.
    id str
    The unique provider ID of the resource to look up.
    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 resulting resource.
    id IDInput
    The unique provider ID of the resource to look up.
    state InternalRangeState
    Pass nil. This resource has no state arguments.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resulting resource.
    id Input<string>
    The unique provider ID of the resource to look up.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resulting resource.
    id Output<String>
    The unique provider ID of the resource to look up.
    options CustomResourceOptions
    Bag of options to control resource's behavior.

    Supporting Types

    InternalRangeOverlapsItem, InternalRangeOverlapsItemArgs

    NameValueDescription
    OverlapUnspecifiedOVERLAP_UNSPECIFIEDNo overlap overrides.
    OverlapRouteRangeOVERLAP_ROUTE_RANGEAllow creation of static routes more specific than the current internal range.
    OverlapExistingSubnetRangeOVERLAP_EXISTING_SUBNET_RANGEAllow creation of internal ranges that overlap with existing subnets.
    NameValueDescription
    InternalRangeOverlapsItemOverlapUnspecifiedOVERLAP_UNSPECIFIEDNo overlap overrides.
    InternalRangeOverlapsItemOverlapRouteRangeOVERLAP_ROUTE_RANGEAllow creation of static routes more specific than the current internal range.
    InternalRangeOverlapsItemOverlapExistingSubnetRangeOVERLAP_EXISTING_SUBNET_RANGEAllow creation of internal ranges that overlap with existing subnets.
    ValueDescription
    OVERLAP_UNSPECIFIEDNo overlap overrides.
    OVERLAP_ROUTE_RANGEAllow creation of static routes more specific than the current internal range.
    OVERLAP_EXISTING_SUBNET_RANGEAllow creation of internal ranges that overlap with existing subnets.
    NameValueDescription
    OverlapUnspecifiedOVERLAP_UNSPECIFIEDNo overlap overrides.
    OverlapRouteRangeOVERLAP_ROUTE_RANGEAllow creation of static routes more specific than the current internal range.
    OverlapExistingSubnetRangeOVERLAP_EXISTING_SUBNET_RANGEAllow creation of internal ranges that overlap with existing subnets.
    NameValueDescription
    OverlapUnspecifiedOVERLAP_UNSPECIFIEDNo overlap overrides.
    OverlapRouteRangeOVERLAP_ROUTE_RANGEAllow creation of static routes more specific than the current internal range.
    OverlapExistingSubnetRangeOVERLAP_EXISTING_SUBNET_RANGEAllow creation of internal ranges that overlap with existing subnets.
    NameValueDescription
    OVERLAP_UNSPECIFIEDOVERLAP_UNSPECIFIEDNo overlap overrides.
    OVERLAP_ROUTE_RANGEOVERLAP_ROUTE_RANGEAllow creation of static routes more specific than the current internal range.
    OVERLAP_EXISTING_SUBNET_RANGEOVERLAP_EXISTING_SUBNET_RANGEAllow creation of internal ranges that overlap with existing subnets.
    ValueDescription
    OVERLAP_UNSPECIFIEDNo overlap overrides.
    OVERLAP_ROUTE_RANGEAllow creation of static routes more specific than the current internal range.
    OVERLAP_EXISTING_SUBNET_RANGEAllow creation of internal ranges that overlap with existing subnets.

    InternalRangePeering, InternalRangePeeringArgs

    The type of peering set for this internal range.
    NameValueDescription
    PeeringUnspecifiedPEERING_UNSPECIFIEDIf Peering is left unspecified in CreateInternalRange or UpdateInternalRange, it will be defaulted to FOR_SELF.
    ForSelfFOR_SELFThis is the default behavior and represents the case that this internal range is intended to be used in the VPC in which it is created and is accessible from its peers. This implies that peers or peers-of-peers cannot use this range.
    ForPeerFOR_PEERThis behavior can be set when the internal range is being reserved for usage by the peers. This means that no resource within the VPC in which it is being created can use this to associate with a VPC resource, but one of the peers can. This represents donating a range for peers to use.
    NotSharedNOT_SHAREDThis behavior can be set when the internal range is being reserved for usage by the VPC in which it is created but not shared with the peers. In a sense it is local to the VPC. This can be used to create internal ranges for various purposes like HTTP_INTERNAL_LOAD_BALANCER or for Interconnect routes that are not shared with peers. This also implies that peers cannot use this range in a way that is visible to this VPC, but can re-use this range as long as it is NOT_SHARED from the peer VPC, too.
    NameValueDescription
    InternalRangePeeringPeeringUnspecifiedPEERING_UNSPECIFIEDIf Peering is left unspecified in CreateInternalRange or UpdateInternalRange, it will be defaulted to FOR_SELF.
    InternalRangePeeringForSelfFOR_SELFThis is the default behavior and represents the case that this internal range is intended to be used in the VPC in which it is created and is accessible from its peers. This implies that peers or peers-of-peers cannot use this range.
    InternalRangePeeringForPeerFOR_PEERThis behavior can be set when the internal range is being reserved for usage by the peers. This means that no resource within the VPC in which it is being created can use this to associate with a VPC resource, but one of the peers can. This represents donating a range for peers to use.
    InternalRangePeeringNotSharedNOT_SHAREDThis behavior can be set when the internal range is being reserved for usage by the VPC in which it is created but not shared with the peers. In a sense it is local to the VPC. This can be used to create internal ranges for various purposes like HTTP_INTERNAL_LOAD_BALANCER or for Interconnect routes that are not shared with peers. This also implies that peers cannot use this range in a way that is visible to this VPC, but can re-use this range as long as it is NOT_SHARED from the peer VPC, too.
    ValueDescription
    PEERING_UNSPECIFIEDIf Peering is left unspecified in CreateInternalRange or UpdateInternalRange, it will be defaulted to FOR_SELF.
    FOR_SELFThis is the default behavior and represents the case that this internal range is intended to be used in the VPC in which it is created and is accessible from its peers. This implies that peers or peers-of-peers cannot use this range.
    FOR_PEERThis behavior can be set when the internal range is being reserved for usage by the peers. This means that no resource within the VPC in which it is being created can use this to associate with a VPC resource, but one of the peers can. This represents donating a range for peers to use.
    NOT_SHAREDThis behavior can be set when the internal range is being reserved for usage by the VPC in which it is created but not shared with the peers. In a sense it is local to the VPC. This can be used to create internal ranges for various purposes like HTTP_INTERNAL_LOAD_BALANCER or for Interconnect routes that are not shared with peers. This also implies that peers cannot use this range in a way that is visible to this VPC, but can re-use this range as long as it is NOT_SHARED from the peer VPC, too.
    NameValueDescription
    PeeringUnspecifiedPEERING_UNSPECIFIEDIf Peering is left unspecified in CreateInternalRange or UpdateInternalRange, it will be defaulted to FOR_SELF.
    ForSelfFOR_SELFThis is the default behavior and represents the case that this internal range is intended to be used in the VPC in which it is created and is accessible from its peers. This implies that peers or peers-of-peers cannot use this range.
    ForPeerFOR_PEERThis behavior can be set when the internal range is being reserved for usage by the peers. This means that no resource within the VPC in which it is being created can use this to associate with a VPC resource, but one of the peers can. This represents donating a range for peers to use.
    NotSharedNOT_SHAREDThis behavior can be set when the internal range is being reserved for usage by the VPC in which it is created but not shared with the peers. In a sense it is local to the VPC. This can be used to create internal ranges for various purposes like HTTP_INTERNAL_LOAD_BALANCER or for Interconnect routes that are not shared with peers. This also implies that peers cannot use this range in a way that is visible to this VPC, but can re-use this range as long as it is NOT_SHARED from the peer VPC, too.
    NameValueDescription
    PeeringUnspecifiedPEERING_UNSPECIFIEDIf Peering is left unspecified in CreateInternalRange or UpdateInternalRange, it will be defaulted to FOR_SELF.
    ForSelfFOR_SELFThis is the default behavior and represents the case that this internal range is intended to be used in the VPC in which it is created and is accessible from its peers. This implies that peers or peers-of-peers cannot use this range.
    ForPeerFOR_PEERThis behavior can be set when the internal range is being reserved for usage by the peers. This means that no resource within the VPC in which it is being created can use this to associate with a VPC resource, but one of the peers can. This represents donating a range for peers to use.
    NotSharedNOT_SHAREDThis behavior can be set when the internal range is being reserved for usage by the VPC in which it is created but not shared with the peers. In a sense it is local to the VPC. This can be used to create internal ranges for various purposes like HTTP_INTERNAL_LOAD_BALANCER or for Interconnect routes that are not shared with peers. This also implies that peers cannot use this range in a way that is visible to this VPC, but can re-use this range as long as it is NOT_SHARED from the peer VPC, too.
    NameValueDescription
    PEERING_UNSPECIFIEDPEERING_UNSPECIFIEDIf Peering is left unspecified in CreateInternalRange or UpdateInternalRange, it will be defaulted to FOR_SELF.
    FOR_SELFFOR_SELFThis is the default behavior and represents the case that this internal range is intended to be used in the VPC in which it is created and is accessible from its peers. This implies that peers or peers-of-peers cannot use this range.
    FOR_PEERFOR_PEERThis behavior can be set when the internal range is being reserved for usage by the peers. This means that no resource within the VPC in which it is being created can use this to associate with a VPC resource, but one of the peers can. This represents donating a range for peers to use.
    NOT_SHAREDNOT_SHAREDThis behavior can be set when the internal range is being reserved for usage by the VPC in which it is created but not shared with the peers. In a sense it is local to the VPC. This can be used to create internal ranges for various purposes like HTTP_INTERNAL_LOAD_BALANCER or for Interconnect routes that are not shared with peers. This also implies that peers cannot use this range in a way that is visible to this VPC, but can re-use this range as long as it is NOT_SHARED from the peer VPC, too.
    ValueDescription
    PEERING_UNSPECIFIEDIf Peering is left unspecified in CreateInternalRange or UpdateInternalRange, it will be defaulted to FOR_SELF.
    FOR_SELFThis is the default behavior and represents the case that this internal range is intended to be used in the VPC in which it is created and is accessible from its peers. This implies that peers or peers-of-peers cannot use this range.
    FOR_PEERThis behavior can be set when the internal range is being reserved for usage by the peers. This means that no resource within the VPC in which it is being created can use this to associate with a VPC resource, but one of the peers can. This represents donating a range for peers to use.
    NOT_SHAREDThis behavior can be set when the internal range is being reserved for usage by the VPC in which it is created but not shared with the peers. In a sense it is local to the VPC. This can be used to create internal ranges for various purposes like HTTP_INTERNAL_LOAD_BALANCER or for Interconnect routes that are not shared with peers. This also implies that peers cannot use this range in a way that is visible to this VPC, but can re-use this range as long as it is NOT_SHARED from the peer VPC, too.

    InternalRangeUsage, InternalRangeUsageArgs

    The type of usage set for this internal range.
    NameValueDescription
    UsageUnspecifiedUSAGE_UNSPECIFIEDUnspecified usage is allowed in calls which identify the resource by other fields and do not need Usage set to complete. These are, i.e.: GetInternalRange and DeleteInternalRange. Usage needs to be specified explicitly in CreateInternalRange or UpdateInternalRange calls.
    ForVpcFOR_VPCA VPC resource can use the reserved CIDR block by associating it with the internal range resource if usage is set to FOR_VPC.
    ExternalToVpcEXTERNAL_TO_VPCRanges created with EXTERNAL_TO_VPC cannot be associated with VPC resources and are meant to block out address ranges for various use cases such as usage on-premises, with dynamic route announcements via Interconnect.
    NameValueDescription
    InternalRangeUsageUsageUnspecifiedUSAGE_UNSPECIFIEDUnspecified usage is allowed in calls which identify the resource by other fields and do not need Usage set to complete. These are, i.e.: GetInternalRange and DeleteInternalRange. Usage needs to be specified explicitly in CreateInternalRange or UpdateInternalRange calls.
    InternalRangeUsageForVpcFOR_VPCA VPC resource can use the reserved CIDR block by associating it with the internal range resource if usage is set to FOR_VPC.
    InternalRangeUsageExternalToVpcEXTERNAL_TO_VPCRanges created with EXTERNAL_TO_VPC cannot be associated with VPC resources and are meant to block out address ranges for various use cases such as usage on-premises, with dynamic route announcements via Interconnect.
    ValueDescription
    USAGE_UNSPECIFIEDUnspecified usage is allowed in calls which identify the resource by other fields and do not need Usage set to complete. These are, i.e.: GetInternalRange and DeleteInternalRange. Usage needs to be specified explicitly in CreateInternalRange or UpdateInternalRange calls.
    FOR_VPCA VPC resource can use the reserved CIDR block by associating it with the internal range resource if usage is set to FOR_VPC.
    EXTERNAL_TO_VPCRanges created with EXTERNAL_TO_VPC cannot be associated with VPC resources and are meant to block out address ranges for various use cases such as usage on-premises, with dynamic route announcements via Interconnect.
    NameValueDescription
    UsageUnspecifiedUSAGE_UNSPECIFIEDUnspecified usage is allowed in calls which identify the resource by other fields and do not need Usage set to complete. These are, i.e.: GetInternalRange and DeleteInternalRange. Usage needs to be specified explicitly in CreateInternalRange or UpdateInternalRange calls.
    ForVpcFOR_VPCA VPC resource can use the reserved CIDR block by associating it with the internal range resource if usage is set to FOR_VPC.
    ExternalToVpcEXTERNAL_TO_VPCRanges created with EXTERNAL_TO_VPC cannot be associated with VPC resources and are meant to block out address ranges for various use cases such as usage on-premises, with dynamic route announcements via Interconnect.
    NameValueDescription
    UsageUnspecifiedUSAGE_UNSPECIFIEDUnspecified usage is allowed in calls which identify the resource by other fields and do not need Usage set to complete. These are, i.e.: GetInternalRange and DeleteInternalRange. Usage needs to be specified explicitly in CreateInternalRange or UpdateInternalRange calls.
    ForVpcFOR_VPCA VPC resource can use the reserved CIDR block by associating it with the internal range resource if usage is set to FOR_VPC.
    ExternalToVpcEXTERNAL_TO_VPCRanges created with EXTERNAL_TO_VPC cannot be associated with VPC resources and are meant to block out address ranges for various use cases such as usage on-premises, with dynamic route announcements via Interconnect.
    NameValueDescription
    USAGE_UNSPECIFIEDUSAGE_UNSPECIFIEDUnspecified usage is allowed in calls which identify the resource by other fields and do not need Usage set to complete. These are, i.e.: GetInternalRange and DeleteInternalRange. Usage needs to be specified explicitly in CreateInternalRange or UpdateInternalRange calls.
    FOR_VPCFOR_VPCA VPC resource can use the reserved CIDR block by associating it with the internal range resource if usage is set to FOR_VPC.
    EXTERNAL_TO_VPCEXTERNAL_TO_VPCRanges created with EXTERNAL_TO_VPC cannot be associated with VPC resources and are meant to block out address ranges for various use cases such as usage on-premises, with dynamic route announcements via Interconnect.
    ValueDescription
    USAGE_UNSPECIFIEDUnspecified usage is allowed in calls which identify the resource by other fields and do not need Usage set to complete. These are, i.e.: GetInternalRange and DeleteInternalRange. Usage needs to be specified explicitly in CreateInternalRange or UpdateInternalRange calls.
    FOR_VPCA VPC resource can use the reserved CIDR block by associating it with the internal range resource if usage is set to FOR_VPC.
    EXTERNAL_TO_VPCRanges created with EXTERNAL_TO_VPC cannot be associated with VPC resources and are meant to block out address ranges for various use cases such as usage on-premises, with dynamic route announcements via Interconnect.

    Package Details

    Repository
    Google Cloud Native pulumi/pulumi-google-native
    License
    Apache-2.0
    google-native logo Google Cloud Native

    This package is deprecated. Active development has stopped. We recommend using the Google Cloud package instead.

    Viewing docs for Google Cloud Native v0.32.0
    published on Wednesday, Nov 29, 2023 by Pulumi

      Try Pulumi Cloud free.
      Your team will thank you.

      Start free trial