1. Packages
  2. Alibaba Cloud
  3. API Docs
  4. ecp
  5. getKeyPairs
Alibaba Cloud v3.59.0 published on Friday, Jul 12, 2024 by Pulumi

alicloud.ecp.getKeyPairs

Explore with Pulumi AI

alicloud logo
Alibaba Cloud v3.59.0 published on Friday, Jul 12, 2024 by Pulumi

    This data source provides the Ecp Key Pairs of the current Alibaba Cloud user.

    NOTE: Available in v1.130.0+.

    Example Usage

    Basic Usage

    import * as pulumi from "@pulumi/pulumi";
    import * as alicloud from "@pulumi/alicloud";
    
    const ids = alicloud.ecp.getKeyPairs({});
    export const ecpKeyPairId1 = ids.then(ids => ids.pairs?.[0]?.id);
    const nameRegex = alicloud.ecp.getKeyPairs({
        nameRegex: "^my-KeyPair",
    });
    export const ecpKeyPairId2 = nameRegex.then(nameRegex => nameRegex.pairs?.[0]?.id);
    
    import pulumi
    import pulumi_alicloud as alicloud
    
    ids = alicloud.ecp.get_key_pairs()
    pulumi.export("ecpKeyPairId1", ids.pairs[0].id)
    name_regex = alicloud.ecp.get_key_pairs(name_regex="^my-KeyPair")
    pulumi.export("ecpKeyPairId2", name_regex.pairs[0].id)
    
    package main
    
    import (
    	"github.com/pulumi/pulumi-alicloud/sdk/v3/go/alicloud/ecp"
    	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
    )
    
    func main() {
    	pulumi.Run(func(ctx *pulumi.Context) error {
    		ids, err := ecp.GetKeyPairs(ctx, nil, nil)
    		if err != nil {
    			return err
    		}
    		ctx.Export("ecpKeyPairId1", ids.Pairs[0].Id)
    		nameRegex, err := ecp.GetKeyPairs(ctx, &ecp.GetKeyPairsArgs{
    			NameRegex: pulumi.StringRef("^my-KeyPair"),
    		}, nil)
    		if err != nil {
    			return err
    		}
    		ctx.Export("ecpKeyPairId2", nameRegex.Pairs[0].Id)
    		return nil
    	})
    }
    
    using System.Collections.Generic;
    using System.Linq;
    using Pulumi;
    using AliCloud = Pulumi.AliCloud;
    
    return await Deployment.RunAsync(() => 
    {
        var ids = AliCloud.Ecp.GetKeyPairs.Invoke();
    
        var nameRegex = AliCloud.Ecp.GetKeyPairs.Invoke(new()
        {
            NameRegex = "^my-KeyPair",
        });
    
        return new Dictionary<string, object?>
        {
            ["ecpKeyPairId1"] = ids.Apply(getKeyPairsResult => getKeyPairsResult.Pairs[0]?.Id),
            ["ecpKeyPairId2"] = nameRegex.Apply(getKeyPairsResult => getKeyPairsResult.Pairs[0]?.Id),
        };
    });
    
    package generated_program;
    
    import com.pulumi.Context;
    import com.pulumi.Pulumi;
    import com.pulumi.core.Output;
    import com.pulumi.alicloud.ecp.EcpFunctions;
    import com.pulumi.alicloud.ecp.inputs.GetKeyPairsArgs;
    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 ids = EcpFunctions.getKeyPairs();
    
            ctx.export("ecpKeyPairId1", ids.applyValue(getKeyPairsResult -> getKeyPairsResult.pairs()[0].id()));
            final var nameRegex = EcpFunctions.getKeyPairs(GetKeyPairsArgs.builder()
                .nameRegex("^my-KeyPair")
                .build());
    
            ctx.export("ecpKeyPairId2", nameRegex.applyValue(getKeyPairsResult -> getKeyPairsResult.pairs()[0].id()));
        }
    }
    
    variables:
      ids:
        fn::invoke:
          Function: alicloud:ecp:getKeyPairs
          Arguments: {}
      nameRegex:
        fn::invoke:
          Function: alicloud:ecp:getKeyPairs
          Arguments:
            nameRegex: ^my-KeyPair
    outputs:
      ecpKeyPairId1: ${ids.pairs[0].id}
      ecpKeyPairId2: ${nameRegex.pairs[0].id}
    

    Using getKeyPairs

    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 getKeyPairs(args: GetKeyPairsArgs, opts?: InvokeOptions): Promise<GetKeyPairsResult>
    function getKeyPairsOutput(args: GetKeyPairsOutputArgs, opts?: InvokeOptions): Output<GetKeyPairsResult>
    def get_key_pairs(ids: Optional[Sequence[str]] = None,
                      key_pair_finger_print: Optional[str] = None,
                      name_regex: Optional[str] = None,
                      output_file: Optional[str] = None,
                      opts: Optional[InvokeOptions] = None) -> GetKeyPairsResult
    def get_key_pairs_output(ids: Optional[pulumi.Input[Sequence[pulumi.Input[str]]]] = None,
                      key_pair_finger_print: Optional[pulumi.Input[str]] = None,
                      name_regex: Optional[pulumi.Input[str]] = None,
                      output_file: Optional[pulumi.Input[str]] = None,
                      opts: Optional[InvokeOptions] = None) -> Output[GetKeyPairsResult]
    func GetKeyPairs(ctx *Context, args *GetKeyPairsArgs, opts ...InvokeOption) (*GetKeyPairsResult, error)
    func GetKeyPairsOutput(ctx *Context, args *GetKeyPairsOutputArgs, opts ...InvokeOption) GetKeyPairsResultOutput

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

    public static class GetKeyPairs 
    {
        public static Task<GetKeyPairsResult> InvokeAsync(GetKeyPairsArgs args, InvokeOptions? opts = null)
        public static Output<GetKeyPairsResult> Invoke(GetKeyPairsInvokeArgs args, InvokeOptions? opts = null)
    }
    public static CompletableFuture<GetKeyPairsResult> getKeyPairs(GetKeyPairsArgs args, InvokeOptions options)
    // Output-based functions aren't available in Java yet
    
    fn::invoke:
      function: alicloud:ecp/getKeyPairs:getKeyPairs
      arguments:
        # arguments dictionary

    The following arguments are supported:

    Ids List<string>
    A list of Key Pair IDs. Its element value is same as Key Pair Name.
    KeyPairFingerPrint string
    The Private Key of the Fingerprint.
    NameRegex string
    A regex string to filter results by Key Pair name.
    OutputFile string
    File name where to save data source results (after running pulumi preview).
    Ids []string
    A list of Key Pair IDs. Its element value is same as Key Pair Name.
    KeyPairFingerPrint string
    The Private Key of the Fingerprint.
    NameRegex string
    A regex string to filter results by Key Pair name.
    OutputFile string
    File name where to save data source results (after running pulumi preview).
    ids List<String>
    A list of Key Pair IDs. Its element value is same as Key Pair Name.
    keyPairFingerPrint String
    The Private Key of the Fingerprint.
    nameRegex String
    A regex string to filter results by Key Pair name.
    outputFile String
    File name where to save data source results (after running pulumi preview).
    ids string[]
    A list of Key Pair IDs. Its element value is same as Key Pair Name.
    keyPairFingerPrint string
    The Private Key of the Fingerprint.
    nameRegex string
    A regex string to filter results by Key Pair name.
    outputFile string
    File name where to save data source results (after running pulumi preview).
    ids Sequence[str]
    A list of Key Pair IDs. Its element value is same as Key Pair Name.
    key_pair_finger_print str
    The Private Key of the Fingerprint.
    name_regex str
    A regex string to filter results by Key Pair name.
    output_file str
    File name where to save data source results (after running pulumi preview).
    ids List<String>
    A list of Key Pair IDs. Its element value is same as Key Pair Name.
    keyPairFingerPrint String
    The Private Key of the Fingerprint.
    nameRegex String
    A regex string to filter results by Key Pair name.
    outputFile String
    File name where to save data source results (after running pulumi preview).

    getKeyPairs Result

    The following output properties are available:

    Id string
    The provider-assigned unique ID for this managed resource.
    Ids List<string>
    Names List<string>
    Pairs List<Pulumi.AliCloud.Ecp.Outputs.GetKeyPairsPair>
    KeyPairFingerPrint string
    NameRegex string
    OutputFile string
    Id string
    The provider-assigned unique ID for this managed resource.
    Ids []string
    Names []string
    Pairs []GetKeyPairsPair
    KeyPairFingerPrint string
    NameRegex string
    OutputFile string
    id String
    The provider-assigned unique ID for this managed resource.
    ids List<String>
    names List<String>
    pairs List<GetKeyPairsPair>
    keyPairFingerPrint String
    nameRegex String
    outputFile String
    id string
    The provider-assigned unique ID for this managed resource.
    ids string[]
    names string[]
    pairs GetKeyPairsPair[]
    keyPairFingerPrint string
    nameRegex string
    outputFile string
    id str
    The provider-assigned unique ID for this managed resource.
    ids Sequence[str]
    names Sequence[str]
    pairs Sequence[GetKeyPairsPair]
    key_pair_finger_print str
    name_regex str
    output_file str
    id String
    The provider-assigned unique ID for this managed resource.
    ids List<String>
    names List<String>
    pairs List<Property Map>
    keyPairFingerPrint String
    nameRegex String
    outputFile String

    Supporting Types

    GetKeyPairsPair

    Id string
    The ID of the Key Pair. Its value is same as Queue Name.
    KeyPairFingerPrint string
    The Private Key of the Fingerprint.
    KeyPairName string
    The Key Name.
    Id string
    The ID of the Key Pair. Its value is same as Queue Name.
    KeyPairFingerPrint string
    The Private Key of the Fingerprint.
    KeyPairName string
    The Key Name.
    id String
    The ID of the Key Pair. Its value is same as Queue Name.
    keyPairFingerPrint String
    The Private Key of the Fingerprint.
    keyPairName String
    The Key Name.
    id string
    The ID of the Key Pair. Its value is same as Queue Name.
    keyPairFingerPrint string
    The Private Key of the Fingerprint.
    keyPairName string
    The Key Name.
    id str
    The ID of the Key Pair. Its value is same as Queue Name.
    key_pair_finger_print str
    The Private Key of the Fingerprint.
    key_pair_name str
    The Key Name.
    id String
    The ID of the Key Pair. Its value is same as Queue Name.
    keyPairFingerPrint String
    The Private Key of the Fingerprint.
    keyPairName String
    The Key Name.

    Package Details

    Repository
    Alibaba Cloud pulumi/pulumi-alicloud
    License
    Apache-2.0
    Notes
    This Pulumi package is based on the alicloud Terraform Provider.
    alicloud logo
    Alibaba Cloud v3.59.0 published on Friday, Jul 12, 2024 by Pulumi