ibm 1.78.0, Apr 30 25

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

ibm.getKmsKmipAdapters

Explore with Pulumi AI

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

ibm-cloud/terraform-provider-ibm

Example Usage

Sample example to retrieve all KMIP adapters in a given KMIP instance

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

const kmsInstance = new ibm.ResourceInstance("kmsInstance", {
    service: "kms",
    plan: "tiered-pricing",
    location: "us-south",
});
const myadapter = ibm.getKmsKmipAdapters({
    instanceId: ibm_resource_instance.kp_instance.guid,
});

import pulumi
import pulumi_ibm as ibm

kms_instance = ibm.ResourceInstance("kmsInstance",
    service="kms",
    plan="tiered-pricing",
    location="us-south")
myadapter = ibm.get_kms_kmip_adapters(instance_id=ibm_resource_instance["kp_instance"]["guid"])

package main

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

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := ibm.NewResourceInstance(ctx, "kmsInstance", &ibm.ResourceInstanceArgs{
			Service:  pulumi.String("kms"),
			Plan:     pulumi.String("tiered-pricing"),
			Location: pulumi.String("us-south"),
		})
		if err != nil {
			return err
		}
		_, err = ibm.GetKmsKmipAdapters(ctx, &ibm.GetKmsKmipAdaptersArgs{
			InstanceId: ibm_resource_instance.Kp_instance.Guid,
		}, nil)
		if err != nil {
			return err
		}
		return nil
	})
}

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

return await Deployment.RunAsync(() => 
{
    var kmsInstance = new Ibm.ResourceInstance("kmsInstance", new()
    {
        Service = "kms",
        Plan = "tiered-pricing",
        Location = "us-south",
    });

    var myadapter = Ibm.GetKmsKmipAdapters.Invoke(new()
    {
        InstanceId = ibm_resource_instance.Kp_instance.Guid,
    });

});

package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.ibm.ResourceInstance;
import com.pulumi.ibm.ResourceInstanceArgs;
import com.pulumi.ibm.IbmFunctions;
import com.pulumi.ibm.inputs.GetKmsKmipAdaptersArgs;
import java.util.List;
import java.util.ArrayList;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;

public class App {
    public static void main(String[] args) {
        Pulumi.run(App::stack);
    }

    public static void stack(Context ctx) {
        var kmsInstance = new ResourceInstance("kmsInstance", ResourceInstanceArgs.builder()
            .service("kms")
            .plan("tiered-pricing")
            .location("us-south")
            .build());

        final var myadapter = IbmFunctions.getKmsKmipAdapters(GetKmsKmipAdaptersArgs.builder()
            .instanceId(ibm_resource_instance.kp_instance().guid())
            .build());

    }
}

resources:
  kmsInstance:
    type: ibm:ResourceInstance
    properties:
      service: kms
      plan: tiered-pricing
      location: us-south
variables:
  myadapter:
    fn::invoke:
      function: ibm:getKmsKmipAdapters
      arguments:
        instanceId: ${ibm_resource_instance.kp_instance.guid}

Using getKmsKmipAdapters

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 getKmsKmipAdapters(args: GetKmsKmipAdaptersArgs, opts?: InvokeOptions): Promise<GetKmsKmipAdaptersResult>
function getKmsKmipAdaptersOutput(args: GetKmsKmipAdaptersOutputArgs, opts?: InvokeOptions): Output<GetKmsKmipAdaptersResult>

def get_kms_kmip_adapters(endpoint_type: Optional[str] = None,
                          id: Optional[str] = None,
                          instance_id: Optional[str] = None,
                          limit: Optional[float] = None,
                          offset: Optional[float] = None,
                          show_total_count: Optional[bool] = None,
                          opts: Optional[InvokeOptions] = None) -> GetKmsKmipAdaptersResult
def get_kms_kmip_adapters_output(endpoint_type: Optional[pulumi.Input[str]] = None,
                          id: Optional[pulumi.Input[str]] = None,
                          instance_id: Optional[pulumi.Input[str]] = None,
                          limit: Optional[pulumi.Input[float]] = None,
                          offset: Optional[pulumi.Input[float]] = None,
                          show_total_count: Optional[pulumi.Input[bool]] = None,
                          opts: Optional[InvokeOptions] = None) -> Output[GetKmsKmipAdaptersResult]

func GetKmsKmipAdapters(ctx *Context, args *GetKmsKmipAdaptersArgs, opts ...InvokeOption) (*GetKmsKmipAdaptersResult, error)
func GetKmsKmipAdaptersOutput(ctx *Context, args *GetKmsKmipAdaptersOutputArgs, opts ...InvokeOption) GetKmsKmipAdaptersResultOutput

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

public static class GetKmsKmipAdapters 
{
    public static Task<GetKmsKmipAdaptersResult> InvokeAsync(GetKmsKmipAdaptersArgs args, InvokeOptions? opts = null)
    public static Output<GetKmsKmipAdaptersResult> Invoke(GetKmsKmipAdaptersInvokeArgs args, InvokeOptions? opts = null)
}

public static CompletableFuture<GetKmsKmipAdaptersResult> getKmsKmipAdapters(GetKmsKmipAdaptersArgs args, InvokeOptions options)
public static Output<GetKmsKmipAdaptersResult> getKmsKmipAdapters(GetKmsKmipAdaptersArgs args, InvokeOptions options)

fn::invoke:
  function: ibm:index/getKmsKmipAdapters:getKmsKmipAdapters
  arguments:
    # arguments dictionary

The following arguments are supported:

InstanceId string: The key protect instance GUID.
EndpointType string: The type of the public endpoint, or private endpoint to be used for creating keys.
Id string
Limit double: Limit of how many adapters to be fetched.
Offset double: Offset of adapters to be fetched.
ShowTotalCount bool: Flag to return the count of how many adapters there are in total.

InstanceId string: The key protect instance GUID.
EndpointType string: The type of the public endpoint, or private endpoint to be used for creating keys.
Id string
Limit float64: Limit of how many adapters to be fetched.
Offset float64: Offset of adapters to be fetched.
ShowTotalCount bool: Flag to return the count of how many adapters there are in total.

instanceId String: The key protect instance GUID.
endpointType String: The type of the public endpoint, or private endpoint to be used for creating keys.
id String
limit Double: Limit of how many adapters to be fetched.
offset Double: Offset of adapters to be fetched.
showTotalCount Boolean: Flag to return the count of how many adapters there are in total.

instanceId string: The key protect instance GUID.
endpointType string: The type of the public endpoint, or private endpoint to be used for creating keys.
id string
limit number: Limit of how many adapters to be fetched.
offset number: Offset of adapters to be fetched.
showTotalCount boolean: Flag to return the count of how many adapters there are in total.

instance_id str: The key protect instance GUID.
endpoint_type str: The type of the public endpoint, or private endpoint to be used for creating keys.
id str
limit float: Limit of how many adapters to be fetched.
offset float: Offset of adapters to be fetched.
show_total_count bool: Flag to return the count of how many adapters there are in total.

instanceId String: The key protect instance GUID.
endpointType String: The type of the public endpoint, or private endpoint to be used for creating keys.
id String
limit Number: Limit of how many adapters to be fetched.
offset Number: Offset of adapters to be fetched.
showTotalCount Boolean: Flag to return the count of how many adapters there are in total.

getKmsKmipAdapters Result

The following output properties are available:

Adapters List<GetKmsKmipAdaptersAdapter>: (List of Objects) The IBM-ID of the identity that created the resource
EndpointType string
Id string
InstanceId string
TotalCount double: (Integer) If show_total_count is true, this will contain the total number of adapters
Limit double
Offset double
ShowTotalCount bool

Adapters []GetKmsKmipAdaptersAdapter: (List of Objects) The IBM-ID of the identity that created the resource
EndpointType string
Id string
InstanceId string
TotalCount float64: (Integer) If show_total_count is true, this will contain the total number of adapters
Limit float64
Offset float64
ShowTotalCount bool

adapters List<GetKmsKmipAdaptersAdapter>: (List of Objects) The IBM-ID of the identity that created the resource
endpointType String
id String
instanceId String
totalCount Double: (Integer) If show_total_count is true, this will contain the total number of adapters
limit Double
offset Double
showTotalCount Boolean

adapters GetKmsKmipAdaptersAdapter[]: (List of Objects) The IBM-ID of the identity that created the resource
endpointType string
id string
instanceId string
totalCount number: (Integer) If show_total_count is true, this will contain the total number of adapters
limit number
offset number
showTotalCount boolean

adapters Sequence[GetKmsKmipAdaptersAdapter]: (List of Objects) The IBM-ID of the identity that created the resource
endpoint_type str
id str
instance_id str
total_count float: (Integer) If show_total_count is true, this will contain the total number of adapters
limit float
offset float
show_total_count bool

adapters List<Property Map>: (List of Objects) The IBM-ID of the identity that created the resource
endpointType String
id String
instanceId String
totalCount Number: (Integer) If show_total_count is true, this will contain the total number of adapters
limit Number
offset Number
showTotalCount Boolean

Supporting Types

GetKmsKmipAdaptersAdapter

AdapterId string: (String) The UUID of the KMIP adapter.
CreatedAt string: (String) The date the resource was created, in RFC 3339 format
CreatedBy string: (String) The IBM-ID of the identity that created the resource
Description string: (String) The description of the KMIP adapter.
Name string: (String) The name of the KMIP adapter.
Profile string: (String) The profile of the KMIP adapter.
ProfileData Dictionary<string, string>: (Map) The profile data of the KMIP adapter.
UpdatedAt string: (String) The date the resource was updated, in RFC 3339 format
UpdatedBy string: (String) The IBM-ID of the identity that updated the resource

AdapterId string: (String) The UUID of the KMIP adapter.
CreatedAt string: (String) The date the resource was created, in RFC 3339 format
CreatedBy string: (String) The IBM-ID of the identity that created the resource
Description string: (String) The description of the KMIP adapter.
Name string: (String) The name of the KMIP adapter.
Profile string: (String) The profile of the KMIP adapter.
ProfileData map[string]string: (Map) The profile data of the KMIP adapter.
UpdatedAt string: (String) The date the resource was updated, in RFC 3339 format
UpdatedBy string: (String) The IBM-ID of the identity that updated the resource

adapterId String: (String) The UUID of the KMIP adapter.
createdAt String: (String) The date the resource was created, in RFC 3339 format
createdBy String: (String) The IBM-ID of the identity that created the resource
description String: (String) The description of the KMIP adapter.
name String: (String) The name of the KMIP adapter.
profile String: (String) The profile of the KMIP adapter.
profileData Map<String,String>: (Map) The profile data of the KMIP adapter.
updatedAt String: (String) The date the resource was updated, in RFC 3339 format
updatedBy String: (String) The IBM-ID of the identity that updated the resource

adapterId string: (String) The UUID of the KMIP adapter.
createdAt string: (String) The date the resource was created, in RFC 3339 format
createdBy string: (String) The IBM-ID of the identity that created the resource
description string: (String) The description of the KMIP adapter.
name string: (String) The name of the KMIP adapter.
profile string: (String) The profile of the KMIP adapter.
profileData {[key: string]: string}: (Map) The profile data of the KMIP adapter.
updatedAt string: (String) The date the resource was updated, in RFC 3339 format
updatedBy string: (String) The IBM-ID of the identity that updated the resource

adapter_id str: (String) The UUID of the KMIP adapter.
created_at str: (String) The date the resource was created, in RFC 3339 format
created_by str: (String) The IBM-ID of the identity that created the resource
description str: (String) The description of the KMIP adapter.
name str: (String) The name of the KMIP adapter.
profile str: (String) The profile of the KMIP adapter.
profile_data Mapping[str, str]: (Map) The profile data of the KMIP adapter.
updated_at str: (String) The date the resource was updated, in RFC 3339 format
updated_by str: (String) The IBM-ID of the identity that updated the resource

adapterId String: (String) The UUID of the KMIP adapter.
createdAt String: (String) The date the resource was created, in RFC 3339 format
createdBy String: (String) The IBM-ID of the identity that created the resource
description String: (String) The description of the KMIP adapter.
name String: (String) The name of the KMIP adapter.
profile String: (String) The profile of the KMIP adapter.
profileData Map<String>: (Map) The profile data of the KMIP adapter.
updatedAt String: (String) The date the resource was updated, in RFC 3339 format
updatedBy String: (String) The IBM-ID of the identity that updated the resource

Package Details

Repository: ibm ibm-cloud/terraform-provider-ibm
License
Notes: This Pulumi package is based on the ibm Terraform Provider.

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

ibm-cloud/terraform-provider-ibm

ibm.getKmsKmipAdapters

On this page

On this page

Example Usage

Using getKmsKmipAdapters

getKmsKmipAdapters Result

Supporting Types

GetKmsKmipAdaptersAdapter

Package Details

On this page

On this page