Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi Cloud Packages Tutorials
  1. Packages
  2. Outscale Provider
  3. API Docs
  4. getAccessKey
outscale 1.0.1 published on Thursday, Mar 13, 2025 by outscale
outscale/terraform-provider-outscale

outscale.getAccessKey

Explore with Pulumi AI

outscale logo
outscale 1.0.1 published on Thursday, Mar 13, 2025 by outscale
outscale/terraform-provider-outscale

    Provides information about an access key.

    For more information on this resource, see the User Guide.
    For more information on this resource actions, see the API documentation.

    Example Usage

    Get one of your own access keys (root account or user)

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

const accessKey01 = outscale.getAccessKey({
    filters: [{
        name: "access_key_ids",
        values: ["ABCDEFGHIJ0123456789"],
    }],
});

    import pulumi
import pulumi_outscale as outscale

access_key01 = outscale.get_access_key(filters=[{
    "name": "access_key_ids",
    "values": ["ABCDEFGHIJ0123456789"],
}])

    package main

import (
	"github.com/pulumi/pulumi-terraform-provider/sdks/go/outscale/outscale"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := outscale.LookupAccessKey(ctx, &outscale.LookupAccessKeyArgs{
			Filters: []outscale.GetAccessKeyFilter{
				{
					Name: "access_key_ids",
					Values: []string{
						"ABCDEFGHIJ0123456789",
					},
				},
			},
		}, nil)
		if err != nil {
			return err
		}
		return nil
	})
}

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

return await Deployment.RunAsync(() => 
{
    var accessKey01 = Outscale.GetAccessKey.Invoke(new()
    {
        Filters = new[]
        {
            new Outscale.Inputs.GetAccessKeyFilterInputArgs
            {
                Name = "access_key_ids",
                Values = new[]
                {
                    "ABCDEFGHIJ0123456789",
                },
            },
        },
    });

});

    package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.outscale.OutscaleFunctions;
import com.pulumi.outscale.inputs.GetAccessKeyArgs;
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 accessKey01 = OutscaleFunctions.getAccessKey(GetAccessKeyArgs.builder()
            .filters(GetAccessKeyFilterArgs.builder()
                .name("access_key_ids")
                .values("ABCDEFGHIJ0123456789")
                .build())
            .build());

    }
}

    variables:
  accessKey01:
    fn::invoke:
      function: outscale:getAccessKey
      arguments:
        filters:
          - name: access_key_ids
            values:
              - ABCDEFGHIJ0123456789

    Get the access key of another user

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

const accessKey01 = outscale.getAccessKey({
    filters: [
        {
            name: "access_key_ids",
            values: ["XXXXXXXXX"],
        },
        {
            name: "states",
            values: ["ACTIVE"],
        },
    ],
    userName: "user_name",
});

    import pulumi
import pulumi_outscale as outscale

access_key01 = outscale.get_access_key(filters=[
        {
            "name": "access_key_ids",
            "values": ["XXXXXXXXX"],
        },
        {
            "name": "states",
            "values": ["ACTIVE"],
        },
    ],
    user_name="user_name")

    package main

import (
	"github.com/pulumi/pulumi-terraform-provider/sdks/go/outscale/outscale"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := outscale.LookupAccessKey(ctx, &outscale.LookupAccessKeyArgs{
			Filters: []outscale.GetAccessKeyFilter{
				{
					Name: "access_key_ids",
					Values: []string{
						"XXXXXXXXX",
					},
				},
				{
					Name: "states",
					Values: []string{
						"ACTIVE",
					},
				},
			},
			UserName: pulumi.StringRef("user_name"),
		}, nil)
		if err != nil {
			return err
		}
		return nil
	})
}

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

return await Deployment.RunAsync(() => 
{
    var accessKey01 = Outscale.GetAccessKey.Invoke(new()
    {
        Filters = new[]
        {
            new Outscale.Inputs.GetAccessKeyFilterInputArgs
            {
                Name = "access_key_ids",
                Values = new[]
                {
                    "XXXXXXXXX",
                },
            },
            new Outscale.Inputs.GetAccessKeyFilterInputArgs
            {
                Name = "states",
                Values = new[]
                {
                    "ACTIVE",
                },
            },
        },
        UserName = "user_name",
    });

});

    package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.outscale.OutscaleFunctions;
import com.pulumi.outscale.inputs.GetAccessKeyArgs;
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 accessKey01 = OutscaleFunctions.getAccessKey(GetAccessKeyArgs.builder()
            .filters(            
                GetAccessKeyFilterArgs.builder()
                    .name("access_key_ids")
                    .values("XXXXXXXXX")
                    .build(),
                GetAccessKeyFilterArgs.builder()
                    .name("states")
                    .values("ACTIVE")
                    .build())
            .userName("user_name")
            .build());

    }
}

    variables:
  accessKey01:
    fn::invoke:
      function: outscale:getAccessKey
      arguments:
        filters:
          - name: access_key_ids
            values:
              - XXXXXXXXX
          - name: states
            values:
              - ACTIVE
        userName: user_name

    Using getAccessKey

    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 getAccessKey(args: GetAccessKeyArgs, opts?: InvokeOptions): Promise<GetAccessKeyResult>
function getAccessKeyOutput(args: GetAccessKeyOutputArgs, opts?: InvokeOptions): Output<GetAccessKeyResult>
    def get_access_key(access_key_id: Optional[str] = None,
                   filters: Optional[Sequence[GetAccessKeyFilter]] = None,
                   id: Optional[str] = None,
                   state: Optional[str] = None,
                   user_name: Optional[str] = None,
                   opts: Optional[InvokeOptions] = None) -> GetAccessKeyResult
def get_access_key_output(access_key_id: Optional[pulumi.Input[str]] = None,
                   filters: Optional[pulumi.Input[Sequence[pulumi.Input[GetAccessKeyFilterArgs]]]] = None,
                   id: Optional[pulumi.Input[str]] = None,
                   state: Optional[pulumi.Input[str]] = None,
                   user_name: Optional[pulumi.Input[str]] = None,
                   opts: Optional[InvokeOptions] = None) -> Output[GetAccessKeyResult]
    func LookupAccessKey(ctx *Context, args *LookupAccessKeyArgs, opts ...InvokeOption) (*LookupAccessKeyResult, error)
func LookupAccessKeyOutput(ctx *Context, args *LookupAccessKeyOutputArgs, opts ...InvokeOption) LookupAccessKeyResultOutput

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

    public static class GetAccessKey 
{
    public static Task<GetAccessKeyResult> InvokeAsync(GetAccessKeyArgs args, InvokeOptions? opts = null)
    public static Output<GetAccessKeyResult> Invoke(GetAccessKeyInvokeArgs args, InvokeOptions? opts = null)
}
    public static CompletableFuture<GetAccessKeyResult> getAccessKey(GetAccessKeyArgs args, InvokeOptions options)
public static Output<GetAccessKeyResult> getAccessKey(GetAccessKeyArgs args, InvokeOptions options)

    fn::invoke:
  function: outscale:index/getAccessKey:getAccessKey
  arguments:
    # arguments dictionary

    The following arguments are supported:

    AccessKeyId string
    The ID of the access key.
    Filters List<GetAccessKeyFilter>
    A combination of a filter name and one or more filter values. You can specify this argument for as many filter names as you need. The filter name can be any of the following:
    Id string
    State string
    The state of the access key (ACTIVE if the key is valid for API calls, or INACTIVE if not).
    UserName string
    The name of the EIM user. By default, the user who sends the request (which can be the root account).
    AccessKeyId string
    The ID of the access key.
    Filters []GetAccessKeyFilter
    A combination of a filter name and one or more filter values. You can specify this argument for as many filter names as you need. The filter name can be any of the following:
    Id string
    State string
    The state of the access key (ACTIVE if the key is valid for API calls, or INACTIVE if not).
    UserName string
    The name of the EIM user. By default, the user who sends the request (which can be the root account).
    accessKeyId String
    The ID of the access key.
    filters List<GetAccessKeyFilter>
    A combination of a filter name and one or more filter values. You can specify this argument for as many filter names as you need. The filter name can be any of the following:
    id String
    state String
    The state of the access key (ACTIVE if the key is valid for API calls, or INACTIVE if not).
    userName String
    The name of the EIM user. By default, the user who sends the request (which can be the root account).
    accessKeyId string
    The ID of the access key.
    filters GetAccessKeyFilter[]
    A combination of a filter name and one or more filter values. You can specify this argument for as many filter names as you need. The filter name can be any of the following:
    id string
    state string
    The state of the access key (ACTIVE if the key is valid for API calls, or INACTIVE if not).
    userName string
    The name of the EIM user. By default, the user who sends the request (which can be the root account).
    access_key_id str
    The ID of the access key.
    filters Sequence[GetAccessKeyFilter]
    A combination of a filter name and one or more filter values. You can specify this argument for as many filter names as you need. The filter name can be any of the following:
    id str
    state str
    The state of the access key (ACTIVE if the key is valid for API calls, or INACTIVE if not).
    user_name str
    The name of the EIM user. By default, the user who sends the request (which can be the root account).
    accessKeyId String
    The ID of the access key.
    filters List<Property Map>
    A combination of a filter name and one or more filter values. You can specify this argument for as many filter names as you need. The filter name can be any of the following:
    id String
    state String
    The state of the access key (ACTIVE if the key is valid for API calls, or INACTIVE if not).
    userName String
    The name of the EIM user. By default, the user who sends the request (which can be the root account).

    getAccessKey Result

    The following output properties are available:

    CreationDate string
    The date and time (UTC) at which the access key was created.
    ExpirationDate string
    The date and time (UTC) at which the access key expires.
    Id string
    LastModificationDate string
    The date and time (UTC) at which the access key was last modified.
    RequestId string
    AccessKeyId string
    The ID of the access key.
    Filters List<GetAccessKeyFilter>
    State string
    The state of the access key (ACTIVE if the key is valid for API calls, or INACTIVE if not).
    UserName string
    CreationDate string
    The date and time (UTC) at which the access key was created.
    ExpirationDate string
    The date and time (UTC) at which the access key expires.
    Id string
    LastModificationDate string
    The date and time (UTC) at which the access key was last modified.
    RequestId string
    AccessKeyId string
    The ID of the access key.
    Filters []GetAccessKeyFilter
    State string
    The state of the access key (ACTIVE if the key is valid for API calls, or INACTIVE if not).
    UserName string
    creationDate String
    The date and time (UTC) at which the access key was created.
    expirationDate String
    The date and time (UTC) at which the access key expires.
    id String
    lastModificationDate String
    The date and time (UTC) at which the access key was last modified.
    requestId String
    accessKeyId String
    The ID of the access key.
    filters List<GetAccessKeyFilter>
    state String
    The state of the access key (ACTIVE if the key is valid for API calls, or INACTIVE if not).
    userName String
    creationDate string
    The date and time (UTC) at which the access key was created.
    expirationDate string
    The date and time (UTC) at which the access key expires.
    id string
    lastModificationDate string
    The date and time (UTC) at which the access key was last modified.
    requestId string
    accessKeyId string
    The ID of the access key.
    filters GetAccessKeyFilter[]
    state string
    The state of the access key (ACTIVE if the key is valid for API calls, or INACTIVE if not).
    userName string
    creation_date str
    The date and time (UTC) at which the access key was created.
    expiration_date str
    The date and time (UTC) at which the access key expires.
    id str
    last_modification_date str
    The date and time (UTC) at which the access key was last modified.
    request_id str
    access_key_id str
    The ID of the access key.
    filters Sequence[GetAccessKeyFilter]
    state str
    The state of the access key (ACTIVE if the key is valid for API calls, or INACTIVE if not).
    user_name str
    creationDate String
    The date and time (UTC) at which the access key was created.
    expirationDate String
    The date and time (UTC) at which the access key expires.
    id String
    lastModificationDate String
    The date and time (UTC) at which the access key was last modified.
    requestId String
    accessKeyId String
    The ID of the access key.
    filters List<Property Map>
    state String
    The state of the access key (ACTIVE if the key is valid for API calls, or INACTIVE if not).
    userName String

    Supporting Types

    GetAccessKeyFilter

    Name string
    Values List<string>
    Name string
    Values []string
    name String
    values List<String>
    name string
    values string[]
    name str
    values Sequence[str]
    name String
    values List<String>

    Package Details

    Repository
    outscale outscale/terraform-provider-outscale
    License
    Notes
    This Pulumi package is based on the outscale Terraform Provider.
    outscale logo
    outscale 1.0.1 published on Thursday, Mar 13, 2025 by outscale
    outscale/terraform-provider-outscale