Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi Cloud Packages Tutorials
  1. Packages
  2. Ibm Provider
  3. API Docs
  4. getKmsKmipAdapters
ibm 1.77.1 published on Monday, Apr 14, 2025 by ibm-cloud
ibm-cloud/terraform-provider-ibm

ibm.getKmsKmipAdapters

Explore with Pulumi AI

ibm 1.77.1 published on Monday, Apr 14, 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,
});
Copy
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"])
Copy
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
	})
}
Copy
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,
    });

});
Copy
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());

    }
}
Copy
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}
Copy

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>
Copy
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]
Copy
func GetKmsKmipAdapters(ctx *Context, args *GetKmsKmipAdaptersArgs, opts ...InvokeOption) (*GetKmsKmipAdaptersResult, error)
func GetKmsKmipAdaptersOutput(ctx *Context, args *GetKmsKmipAdaptersOutputArgs, opts ...InvokeOption) GetKmsKmipAdaptersResultOutput
Copy

> 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)
}
Copy
public static CompletableFuture<GetKmsKmipAdaptersResult> getKmsKmipAdapters(GetKmsKmipAdaptersArgs args, InvokeOptions options)
public static Output<GetKmsKmipAdaptersResult> getKmsKmipAdapters(GetKmsKmipAdaptersArgs args, InvokeOptions options)
Copy
fn::invoke:
  function: ibm:index/getKmsKmipAdapters:getKmsKmipAdapters
  arguments:
    # arguments dictionary
Copy

The following arguments are supported:

InstanceId This property is required. 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 This property is required. 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 This property is required. 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 This property is required. 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 This property is required. 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 This property is required. 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 This property is required. string
(String) The UUID of the KMIP adapter.
CreatedAt This property is required. string
(String) The date the resource was created, in RFC 3339 format
CreatedBy This property is required. string
(String) The IBM-ID of the identity that created the resource
Description This property is required. string
(String) The description of the KMIP adapter.
Name This property is required. string
(String) The name of the KMIP adapter.
Profile This property is required. string
(String) The profile of the KMIP adapter.
ProfileData This property is required. Dictionary<string, string>
(Map) The profile data of the KMIP adapter.
UpdatedAt This property is required. string
(String) The date the resource was updated, in RFC 3339 format
UpdatedBy This property is required. string
(String) The IBM-ID of the identity that updated the resource
AdapterId This property is required. string
(String) The UUID of the KMIP adapter.
CreatedAt This property is required. string
(String) The date the resource was created, in RFC 3339 format
CreatedBy This property is required. string
(String) The IBM-ID of the identity that created the resource
Description This property is required. string
(String) The description of the KMIP adapter.
Name This property is required. string
(String) The name of the KMIP adapter.
Profile This property is required. string
(String) The profile of the KMIP adapter.
ProfileData This property is required. map[string]string
(Map) The profile data of the KMIP adapter.
UpdatedAt This property is required. string
(String) The date the resource was updated, in RFC 3339 format
UpdatedBy This property is required. string
(String) The IBM-ID of the identity that updated the resource
adapterId This property is required. String
(String) The UUID of the KMIP adapter.
createdAt This property is required. String
(String) The date the resource was created, in RFC 3339 format
createdBy This property is required. String
(String) The IBM-ID of the identity that created the resource
description This property is required. String
(String) The description of the KMIP adapter.
name This property is required. String
(String) The name of the KMIP adapter.
profile This property is required. String
(String) The profile of the KMIP adapter.
profileData This property is required. Map<String,String>
(Map) The profile data of the KMIP adapter.
updatedAt This property is required. String
(String) The date the resource was updated, in RFC 3339 format
updatedBy This property is required. String
(String) The IBM-ID of the identity that updated the resource
adapterId This property is required. string
(String) The UUID of the KMIP adapter.
createdAt This property is required. string
(String) The date the resource was created, in RFC 3339 format
createdBy This property is required. string
(String) The IBM-ID of the identity that created the resource
description This property is required. string
(String) The description of the KMIP adapter.
name This property is required. string
(String) The name of the KMIP adapter.
profile This property is required. string
(String) The profile of the KMIP adapter.
profileData This property is required. {[key: string]: string}
(Map) The profile data of the KMIP adapter.
updatedAt This property is required. string
(String) The date the resource was updated, in RFC 3339 format
updatedBy This property is required. string
(String) The IBM-ID of the identity that updated the resource
adapter_id This property is required. str
(String) The UUID of the KMIP adapter.
created_at This property is required. str
(String) The date the resource was created, in RFC 3339 format
created_by This property is required. str
(String) The IBM-ID of the identity that created the resource
description This property is required. str
(String) The description of the KMIP adapter.
name This property is required. str
(String) The name of the KMIP adapter.
profile This property is required. str
(String) The profile of the KMIP adapter.
profile_data This property is required. Mapping[str, str]
(Map) The profile data of the KMIP adapter.
updated_at This property is required. str
(String) The date the resource was updated, in RFC 3339 format
updated_by This property is required. str
(String) The IBM-ID of the identity that updated the resource
adapterId This property is required. String
(String) The UUID of the KMIP adapter.
createdAt This property is required. String
(String) The date the resource was created, in RFC 3339 format
createdBy This property is required. String
(String) The IBM-ID of the identity that created the resource
description This property is required. String
(String) The description of the KMIP adapter.
name This property is required. String
(String) The name of the KMIP adapter.
profile This property is required. String
(String) The profile of the KMIP adapter.
profileData This property is required. Map<String>
(Map) The profile data of the KMIP adapter.
updatedAt This property is required. String
(String) The date the resource was updated, in RFC 3339 format
updatedBy This property is required. 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.77.1 published on Monday, Apr 14, 2025 by ibm-cloud
ibm-cloud/terraform-provider-ibm