Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi Cloud Packages Tutorials
  1. Packages
  2. Linode Provider
  3. API Docs
  4. getObjectStorageEndpoints
Linode v4.36.0 published on Thursday, Mar 27, 2025 by Pulumi
pulumi/pulumi-linode

linode.getObjectStorageEndpoints

Explore with Pulumi AI

linode logo
Linode v4.36.0 published on Thursday, Mar 27, 2025 by Pulumi
pulumi/pulumi-linode

    Provides information about Linode Object Storage endpoints available to the user. For more information, see the Linode APIv4 docs.

    Example Usage

    Get an endpoint of E3 type (highest performance and capacity) of Linode Object Storage services:

    import * as pulumi from "@pulumi/pulumi";
import * as linode from "@pulumi/linode";

export = async () => {
    const test = await linode.getObjectStorageEndpoints({
        filters: [{
            name: "endpoint_type",
            values: ["E3"],
        }],
    });
    return {
        "high-performance-obj-endpoint": test.endpoints?.[0]?.s3Endpoint,
    };
}

    import pulumi
import pulumi_linode as linode

test = linode.get_object_storage_endpoints(filters=[{
    "name": "endpoint_type",
    "values": ["E3"],
}])
pulumi.export("high-performance-obj-endpoint", test.endpoints[0].s3_endpoint)

    package main

import (
	"github.com/pulumi/pulumi-linode/sdk/v4/go/linode"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		test, err := linode.GetObjectStorageEndpoints(ctx, &linode.GetObjectStorageEndpointsArgs{
			Filters: []linode.GetObjectStorageEndpointsFilter{
				{
					Name: "endpoint_type",
					Values: []string{
						"E3",
					},
				},
			},
		}, nil)
		if err != nil {
			return err
		}
		ctx.Export("high-performance-obj-endpoint", test.Endpoints[0].S3Endpoint)
		return nil
	})
}

    using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Linode = Pulumi.Linode;

return await Deployment.RunAsync(() => 
{
    var test = Linode.GetObjectStorageEndpoints.Invoke(new()
    {
        Filters = new[]
        {
            new Linode.Inputs.GetObjectStorageEndpointsFilterInputArgs
            {
                Name = "endpoint_type",
                Values = new[]
                {
                    "E3",
                },
            },
        },
    });

    return new Dictionary<string, object?>
    {
        ["high-performance-obj-endpoint"] = test.Apply(getObjectStorageEndpointsResult => getObjectStorageEndpointsResult.Endpoints[0]?.S3Endpoint),
    };
});

    package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.linode.LinodeFunctions;
import com.pulumi.linode.inputs.GetObjectStorageEndpointsArgs;
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) {
        final var test = LinodeFunctions.getObjectStorageEndpoints(GetObjectStorageEndpointsArgs.builder()
            .filters(GetObjectStorageEndpointsFilterArgs.builder()
                .name("endpoint_type")
                .values("E3")
                .build())
            .build());

        ctx.export("high-performance-obj-endpoint", test.applyValue(getObjectStorageEndpointsResult -> getObjectStorageEndpointsResult.endpoints()[0].s3Endpoint()));
    }
}

    variables:
  test:
    fn::invoke:
      function: linode:getObjectStorageEndpoints
      arguments:
        filters:
          - name: endpoint_type
            values:
              - E3
outputs:
  high-performance-obj-endpoint: ${test.endpoints[0].s3Endpoint}

    Get a list of all available endpoints of Linode Object Storage services.

    import * as pulumi from "@pulumi/pulumi";
import * as linode from "@pulumi/linode";

export = async () => {
    const test = await linode.getObjectStorageEndpoints({});
    return {
        "available-endpoints": test.endpoints,
    };
}

    import pulumi
import pulumi_linode as linode

test = linode.get_object_storage_endpoints()
pulumi.export("available-endpoints", test.endpoints)

    package main

import (
	"github.com/pulumi/pulumi-linode/sdk/v4/go/linode"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		test, err := linode.GetObjectStorageEndpoints(ctx, &linode.GetObjectStorageEndpointsArgs{}, nil)
		if err != nil {
			return err
		}
		ctx.Export("available-endpoints", test.Endpoints)
		return nil
	})
}

    using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Linode = Pulumi.Linode;

return await Deployment.RunAsync(() => 
{
    var test = Linode.GetObjectStorageEndpoints.Invoke();

    return new Dictionary<string, object?>
    {
        ["available-endpoints"] = test.Apply(getObjectStorageEndpointsResult => getObjectStorageEndpointsResult.Endpoints),
    };
});

    package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.linode.LinodeFunctions;
import com.pulumi.linode.inputs.GetObjectStorageEndpointsArgs;
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) {
        final var test = LinodeFunctions.getObjectStorageEndpoints();

        ctx.export("available-endpoints", test.applyValue(getObjectStorageEndpointsResult -> getObjectStorageEndpointsResult.endpoints()));
    }
}

    variables:
  test:
    fn::invoke:
      function: linode:getObjectStorageEndpoints
      arguments: {}
outputs:
  available-endpoints: ${test.endpoints}

    Filterable Fields

    • endpoint_type

    • region

    • s3_endpoint

    Using getObjectStorageEndpoints

    Two invocation forms are available. The direct form accepts plain arguments and either blocks until the result value is available, or returns a Promise-wrapped result. The output form accepts Input-wrapped arguments and returns an Output-wrapped result.

    function getObjectStorageEndpoints(args: GetObjectStorageEndpointsArgs, opts?: InvokeOptions): Promise<GetObjectStorageEndpointsResult>
function getObjectStorageEndpointsOutput(args: GetObjectStorageEndpointsOutputArgs, opts?: InvokeOptions): Output<GetObjectStorageEndpointsResult>
    def get_object_storage_endpoints(endpoints: Optional[Sequence[GetObjectStorageEndpointsEndpoint]] = None,
                                 filters: Optional[Sequence[GetObjectStorageEndpointsFilter]] = None,
                                 order: Optional[str] = None,
                                 order_by: Optional[str] = None,
                                 opts: Optional[InvokeOptions] = None) -> GetObjectStorageEndpointsResult
def get_object_storage_endpoints_output(endpoints: Optional[pulumi.Input[Sequence[pulumi.Input[GetObjectStorageEndpointsEndpointArgs]]]] = None,
                                 filters: Optional[pulumi.Input[Sequence[pulumi.Input[GetObjectStorageEndpointsFilterArgs]]]] = None,
                                 order: Optional[pulumi.Input[str]] = None,
                                 order_by: Optional[pulumi.Input[str]] = None,
                                 opts: Optional[InvokeOptions] = None) -> Output[GetObjectStorageEndpointsResult]
    func GetObjectStorageEndpoints(ctx *Context, args *GetObjectStorageEndpointsArgs, opts ...InvokeOption) (*GetObjectStorageEndpointsResult, error)
func GetObjectStorageEndpointsOutput(ctx *Context, args *GetObjectStorageEndpointsOutputArgs, opts ...InvokeOption) GetObjectStorageEndpointsResultOutput

    > Note: This function is named GetObjectStorageEndpoints in the Go SDK.

    public static class GetObjectStorageEndpoints 
{
    public static Task<GetObjectStorageEndpointsResult> InvokeAsync(GetObjectStorageEndpointsArgs args, InvokeOptions? opts = null)
    public static Output<GetObjectStorageEndpointsResult> Invoke(GetObjectStorageEndpointsInvokeArgs args, InvokeOptions? opts = null)
}
    public static CompletableFuture<GetObjectStorageEndpointsResult> getObjectStorageEndpoints(GetObjectStorageEndpointsArgs args, InvokeOptions options)
public static Output<GetObjectStorageEndpointsResult> getObjectStorageEndpoints(GetObjectStorageEndpointsArgs args, InvokeOptions options)

    fn::invoke:
  function: linode:index/getObjectStorageEndpoints:getObjectStorageEndpoints
  arguments:
    # arguments dictionary

    The following arguments are supported:

    Endpoints List<GetObjectStorageEndpointsEndpoint>
    Filters List<GetObjectStorageEndpointsFilter>
    Order string
    The order in which results should be returned. (asc, desc; default asc)
    OrderBy string
    The attribute to order the results by. See the Filterable Fields section for a list of valid fields.
    Endpoints []GetObjectStorageEndpointsEndpoint
    Filters []GetObjectStorageEndpointsFilter
    Order string
    The order in which results should be returned. (asc, desc; default asc)
    OrderBy string
    The attribute to order the results by. See the Filterable Fields section for a list of valid fields.
    endpoints List<GetObjectStorageEndpointsEndpoint>
    filters List<GetObjectStorageEndpointsFilter>
    order String
    The order in which results should be returned. (asc, desc; default asc)
    orderBy String
    The attribute to order the results by. See the Filterable Fields section for a list of valid fields.
    endpoints GetObjectStorageEndpointsEndpoint[]
    filters GetObjectStorageEndpointsFilter[]
    order string
    The order in which results should be returned. (asc, desc; default asc)
    orderBy string
    The attribute to order the results by. See the Filterable Fields section for a list of valid fields.
    endpoints Sequence[GetObjectStorageEndpointsEndpoint]
    filters Sequence[GetObjectStorageEndpointsFilter]
    order str
    The order in which results should be returned. (asc, desc; default asc)
    order_by str
    The attribute to order the results by. See the Filterable Fields section for a list of valid fields.
    endpoints List<Property Map>
    filters List<Property Map>
    order String
    The order in which results should be returned. (asc, desc; default asc)
    orderBy String
    The attribute to order the results by. See the Filterable Fields section for a list of valid fields.

    getObjectStorageEndpoints Result

    The following output properties are available:

    Supporting Types

    GetObjectStorageEndpointsEndpoint

    EndpointType string
    The type of s3_endpoint available to the active user. See Endpoint types for more information.
    Region string
    The Akamai cloud computing region, represented by its slug value. The list regions API is available to see all regions available.
    S3Endpoint string
    Your s3 endpoint URL, based on the endpoint_type and region. Output as null if you haven't assigned an endpoint for your user in this region with the specific endpoint type.
    EndpointType string
    The type of s3_endpoint available to the active user. See Endpoint types for more information.
    Region string
    The Akamai cloud computing region, represented by its slug value. The list regions API is available to see all regions available.
    S3Endpoint string
    Your s3 endpoint URL, based on the endpoint_type and region. Output as null if you haven't assigned an endpoint for your user in this region with the specific endpoint type.
    endpointType String
    The type of s3_endpoint available to the active user. See Endpoint types for more information.
    region String
    The Akamai cloud computing region, represented by its slug value. The list regions API is available to see all regions available.
    s3Endpoint String
    Your s3 endpoint URL, based on the endpoint_type and region. Output as null if you haven't assigned an endpoint for your user in this region with the specific endpoint type.
    endpointType string
    The type of s3_endpoint available to the active user. See Endpoint types for more information.
    region string
    The Akamai cloud computing region, represented by its slug value. The list regions API is available to see all regions available.
    s3Endpoint string
    Your s3 endpoint URL, based on the endpoint_type and region. Output as null if you haven't assigned an endpoint for your user in this region with the specific endpoint type.
    endpoint_type str
    The type of s3_endpoint available to the active user. See Endpoint types for more information.
    region str
    The Akamai cloud computing region, represented by its slug value. The list regions API is available to see all regions available.
    s3_endpoint str
    Your s3 endpoint URL, based on the endpoint_type and region. Output as null if you haven't assigned an endpoint for your user in this region with the specific endpoint type.
    endpointType String
    The type of s3_endpoint available to the active user. See Endpoint types for more information.
    region String
    The Akamai cloud computing region, represented by its slug value. The list regions API is available to see all regions available.
    s3Endpoint String
    Your s3 endpoint URL, based on the endpoint_type and region. Output as null if you haven't assigned an endpoint for your user in this region with the specific endpoint type.

    GetObjectStorageEndpointsFilter

    Name string
    The name of the field to filter by. See the Filterable Fields section for a complete list of filterable fields.
    Values List<string>
    A list of values for the filter to allow. These values should all be in string form.
    MatchBy string
    The method to match the field by. (exact, regex, substring; default exact)
    Name string
    The name of the field to filter by. See the Filterable Fields section for a complete list of filterable fields.
    Values []string
    A list of values for the filter to allow. These values should all be in string form.
    MatchBy string
    The method to match the field by. (exact, regex, substring; default exact)
    name String
    The name of the field to filter by. See the Filterable Fields section for a complete list of filterable fields.
    values List<String>
    A list of values for the filter to allow. These values should all be in string form.
    matchBy String
    The method to match the field by. (exact, regex, substring; default exact)
    name string
    The name of the field to filter by. See the Filterable Fields section for a complete list of filterable fields.
    values string[]
    A list of values for the filter to allow. These values should all be in string form.
    matchBy string
    The method to match the field by. (exact, regex, substring; default exact)
    name str
    The name of the field to filter by. See the Filterable Fields section for a complete list of filterable fields.
    values Sequence[str]
    A list of values for the filter to allow. These values should all be in string form.
    match_by str
    The method to match the field by. (exact, regex, substring; default exact)
    name String
    The name of the field to filter by. See the Filterable Fields section for a complete list of filterable fields.
    values List<String>
    A list of values for the filter to allow. These values should all be in string form.
    matchBy String
    The method to match the field by. (exact, regex, substring; default exact)

    Package Details

    Repository
    Linode pulumi/pulumi-linode
    License
    Apache-2.0
    Notes
    This Pulumi package is based on the linode Terraform Provider.
    linode logo
    Linode v4.36.0 published on Thursday, Mar 27, 2025 by Pulumi
    pulumi/pulumi-linode