1. Packages
  2. Ibm Provider
  3. API Docs
  4. KmsKmipAdapter
ibm 1.78.0 published on Wednesday, Apr 30, 2025 by ibm-cloud

ibm.KmsKmipAdapter

Explore with Pulumi AI

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

    Create KmsKmipAdapter Resource

    Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.

    Constructor syntax

    new KmsKmipAdapter(name: string, args: KmsKmipAdapterArgs, opts?: CustomResourceOptions);
    @overload
    def KmsKmipAdapter(resource_name: str,
                       args: KmsKmipAdapterArgs,
                       opts: Optional[ResourceOptions] = None)
    
    @overload
    def KmsKmipAdapter(resource_name: str,
                       opts: Optional[ResourceOptions] = None,
                       instance_id: Optional[str] = None,
                       profile: Optional[str] = None,
                       profile_data: Optional[Mapping[str, str]] = None,
                       description: Optional[str] = None,
                       endpoint_type: Optional[str] = None,
                       kms_kmip_adapter_id: Optional[str] = None,
                       name: Optional[str] = None)
    func NewKmsKmipAdapter(ctx *Context, name string, args KmsKmipAdapterArgs, opts ...ResourceOption) (*KmsKmipAdapter, error)
    public KmsKmipAdapter(string name, KmsKmipAdapterArgs args, CustomResourceOptions? opts = null)
    public KmsKmipAdapter(String name, KmsKmipAdapterArgs args)
    public KmsKmipAdapter(String name, KmsKmipAdapterArgs args, CustomResourceOptions options)
    
    type: ibm:KmsKmipAdapter
    properties: # The arguments to resource properties.
    options: # Bag of options to control resource's behavior.
    
    

    Parameters

    name string
    The unique name of the resource.
    args KmsKmipAdapterArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    resource_name str
    The unique name of the resource.
    args KmsKmipAdapterArgs
    The arguments to resource properties.
    opts ResourceOptions
    Bag of options to control resource's behavior.
    ctx Context
    Context object for the current deployment.
    name string
    The unique name of the resource.
    args KmsKmipAdapterArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args KmsKmipAdapterArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args KmsKmipAdapterArgs
    The arguments to resource properties.
    options CustomResourceOptions
    Bag of options to control resource's behavior.

    Constructor example

    The following reference example uses placeholder values for all input properties.

    var kmsKmipAdapterResource = new Ibm.KmsKmipAdapter("kmsKmipAdapterResource", new()
    {
        InstanceId = "string",
        Profile = "string",
        ProfileData = 
        {
            { "string", "string" },
        },
        Description = "string",
        EndpointType = "string",
        KmsKmipAdapterId = "string",
        Name = "string",
    });
    
    example, err := ibm.NewKmsKmipAdapter(ctx, "kmsKmipAdapterResource", &ibm.KmsKmipAdapterArgs{
    	InstanceId: pulumi.String("string"),
    	Profile:    pulumi.String("string"),
    	ProfileData: pulumi.StringMap{
    		"string": pulumi.String("string"),
    	},
    	Description:      pulumi.String("string"),
    	EndpointType:     pulumi.String("string"),
    	KmsKmipAdapterId: pulumi.String("string"),
    	Name:             pulumi.String("string"),
    })
    
    var kmsKmipAdapterResource = new KmsKmipAdapter("kmsKmipAdapterResource", KmsKmipAdapterArgs.builder()
        .instanceId("string")
        .profile("string")
        .profileData(Map.of("string", "string"))
        .description("string")
        .endpointType("string")
        .kmsKmipAdapterId("string")
        .name("string")
        .build());
    
    kms_kmip_adapter_resource = ibm.KmsKmipAdapter("kmsKmipAdapterResource",
        instance_id="string",
        profile="string",
        profile_data={
            "string": "string",
        },
        description="string",
        endpoint_type="string",
        kms_kmip_adapter_id="string",
        name="string")
    
    const kmsKmipAdapterResource = new ibm.KmsKmipAdapter("kmsKmipAdapterResource", {
        instanceId: "string",
        profile: "string",
        profileData: {
            string: "string",
        },
        description: "string",
        endpointType: "string",
        kmsKmipAdapterId: "string",
        name: "string",
    });
    
    type: ibm:KmsKmipAdapter
    properties:
        description: string
        endpointType: string
        instanceId: string
        kmsKmipAdapterId: string
        name: string
        profile: string
        profileData:
            string: string
    

    KmsKmipAdapter Resource Properties

    To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.

    Inputs

    In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.

    The KmsKmipAdapter resource accepts the following input properties:

    InstanceId string
    Key protect Instance GUID
    Profile string
    The profile of the KMIP adapter
    ProfileData Dictionary<string, string>
    The data specific to the KMIP Adapter profile
    Description string
    The description of the KMIP adapter
    EndpointType string
    public or private
    KmsKmipAdapterId string
    Name string
    The name of the KMIP adapter
    InstanceId string
    Key protect Instance GUID
    Profile string
    The profile of the KMIP adapter
    ProfileData map[string]string
    The data specific to the KMIP Adapter profile
    Description string
    The description of the KMIP adapter
    EndpointType string
    public or private
    KmsKmipAdapterId string
    Name string
    The name of the KMIP adapter
    instanceId String
    Key protect Instance GUID
    profile String
    The profile of the KMIP adapter
    profileData Map<String,String>
    The data specific to the KMIP Adapter profile
    description String
    The description of the KMIP adapter
    endpointType String
    public or private
    kmsKmipAdapterId String
    name String
    The name of the KMIP adapter
    instanceId string
    Key protect Instance GUID
    profile string
    The profile of the KMIP adapter
    profileData {[key: string]: string}
    The data specific to the KMIP Adapter profile
    description string
    The description of the KMIP adapter
    endpointType string
    public or private
    kmsKmipAdapterId string
    name string
    The name of the KMIP adapter
    instance_id str
    Key protect Instance GUID
    profile str
    The profile of the KMIP adapter
    profile_data Mapping[str, str]
    The data specific to the KMIP Adapter profile
    description str
    The description of the KMIP adapter
    endpoint_type str
    public or private
    kms_kmip_adapter_id str
    name str
    The name of the KMIP adapter
    instanceId String
    Key protect Instance GUID
    profile String
    The profile of the KMIP adapter
    profileData Map<String>
    The data specific to the KMIP Adapter profile
    description String
    The description of the KMIP adapter
    endpointType String
    public or private
    kmsKmipAdapterId String
    name String
    The name of the KMIP adapter

    Outputs

    All input properties are implicitly available as output properties. Additionally, the KmsKmipAdapter resource produces the following output properties:

    AdapterId string
    The ID of the KMIP adapter
    CreatedAt string
    The date when a resource was created. The date format follows RFC 3339.
    CreatedBy string
    The unique identifier that is associated with the entity that created the adapter.
    Id string
    The provider-assigned unique ID for this managed resource.
    UpdatedAt string
    The date when a resource was updated. The date format follows RFC 3339.
    UpdatedBy string
    The unique identifier that is associated with the entity that updated the adapter.
    AdapterId string
    The ID of the KMIP adapter
    CreatedAt string
    The date when a resource was created. The date format follows RFC 3339.
    CreatedBy string
    The unique identifier that is associated with the entity that created the adapter.
    Id string
    The provider-assigned unique ID for this managed resource.
    UpdatedAt string
    The date when a resource was updated. The date format follows RFC 3339.
    UpdatedBy string
    The unique identifier that is associated with the entity that updated the adapter.
    adapterId String
    The ID of the KMIP adapter
    createdAt String
    The date when a resource was created. The date format follows RFC 3339.
    createdBy String
    The unique identifier that is associated with the entity that created the adapter.
    id String
    The provider-assigned unique ID for this managed resource.
    updatedAt String
    The date when a resource was updated. The date format follows RFC 3339.
    updatedBy String
    The unique identifier that is associated with the entity that updated the adapter.
    adapterId string
    The ID of the KMIP adapter
    createdAt string
    The date when a resource was created. The date format follows RFC 3339.
    createdBy string
    The unique identifier that is associated with the entity that created the adapter.
    id string
    The provider-assigned unique ID for this managed resource.
    updatedAt string
    The date when a resource was updated. The date format follows RFC 3339.
    updatedBy string
    The unique identifier that is associated with the entity that updated the adapter.
    adapter_id str
    The ID of the KMIP adapter
    created_at str
    The date when a resource was created. The date format follows RFC 3339.
    created_by str
    The unique identifier that is associated with the entity that created the adapter.
    id str
    The provider-assigned unique ID for this managed resource.
    updated_at str
    The date when a resource was updated. The date format follows RFC 3339.
    updated_by str
    The unique identifier that is associated with the entity that updated the adapter.
    adapterId String
    The ID of the KMIP adapter
    createdAt String
    The date when a resource was created. The date format follows RFC 3339.
    createdBy String
    The unique identifier that is associated with the entity that created the adapter.
    id String
    The provider-assigned unique ID for this managed resource.
    updatedAt String
    The date when a resource was updated. The date format follows RFC 3339.
    updatedBy String
    The unique identifier that is associated with the entity that updated the adapter.

    Look up Existing KmsKmipAdapter Resource

    Get an existing KmsKmipAdapter resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.

    public static get(name: string, id: Input<ID>, state?: KmsKmipAdapterState, opts?: CustomResourceOptions): KmsKmipAdapter
    @staticmethod
    def get(resource_name: str,
            id: str,
            opts: Optional[ResourceOptions] = None,
            adapter_id: Optional[str] = None,
            created_at: Optional[str] = None,
            created_by: Optional[str] = None,
            description: Optional[str] = None,
            endpoint_type: Optional[str] = None,
            instance_id: Optional[str] = None,
            kms_kmip_adapter_id: Optional[str] = None,
            name: Optional[str] = None,
            profile: Optional[str] = None,
            profile_data: Optional[Mapping[str, str]] = None,
            updated_at: Optional[str] = None,
            updated_by: Optional[str] = None) -> KmsKmipAdapter
    func GetKmsKmipAdapter(ctx *Context, name string, id IDInput, state *KmsKmipAdapterState, opts ...ResourceOption) (*KmsKmipAdapter, error)
    public static KmsKmipAdapter Get(string name, Input<string> id, KmsKmipAdapterState? state, CustomResourceOptions? opts = null)
    public static KmsKmipAdapter get(String name, Output<String> id, KmsKmipAdapterState state, CustomResourceOptions options)
    resources:  _:    type: ibm:KmsKmipAdapter    get:      id: ${id}
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    resource_name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    The following state arguments are supported:
    AdapterId string
    The ID of the KMIP adapter
    CreatedAt string
    The date when a resource was created. The date format follows RFC 3339.
    CreatedBy string
    The unique identifier that is associated with the entity that created the adapter.
    Description string
    The description of the KMIP adapter
    EndpointType string
    public or private
    InstanceId string
    Key protect Instance GUID
    KmsKmipAdapterId string
    Name string
    The name of the KMIP adapter
    Profile string
    The profile of the KMIP adapter
    ProfileData Dictionary<string, string>
    The data specific to the KMIP Adapter profile
    UpdatedAt string
    The date when a resource was updated. The date format follows RFC 3339.
    UpdatedBy string
    The unique identifier that is associated with the entity that updated the adapter.
    AdapterId string
    The ID of the KMIP adapter
    CreatedAt string
    The date when a resource was created. The date format follows RFC 3339.
    CreatedBy string
    The unique identifier that is associated with the entity that created the adapter.
    Description string
    The description of the KMIP adapter
    EndpointType string
    public or private
    InstanceId string
    Key protect Instance GUID
    KmsKmipAdapterId string
    Name string
    The name of the KMIP adapter
    Profile string
    The profile of the KMIP adapter
    ProfileData map[string]string
    The data specific to the KMIP Adapter profile
    UpdatedAt string
    The date when a resource was updated. The date format follows RFC 3339.
    UpdatedBy string
    The unique identifier that is associated with the entity that updated the adapter.
    adapterId String
    The ID of the KMIP adapter
    createdAt String
    The date when a resource was created. The date format follows RFC 3339.
    createdBy String
    The unique identifier that is associated with the entity that created the adapter.
    description String
    The description of the KMIP adapter
    endpointType String
    public or private
    instanceId String
    Key protect Instance GUID
    kmsKmipAdapterId String
    name String
    The name of the KMIP adapter
    profile String
    The profile of the KMIP adapter
    profileData Map<String,String>
    The data specific to the KMIP Adapter profile
    updatedAt String
    The date when a resource was updated. The date format follows RFC 3339.
    updatedBy String
    The unique identifier that is associated with the entity that updated the adapter.
    adapterId string
    The ID of the KMIP adapter
    createdAt string
    The date when a resource was created. The date format follows RFC 3339.
    createdBy string
    The unique identifier that is associated with the entity that created the adapter.
    description string
    The description of the KMIP adapter
    endpointType string
    public or private
    instanceId string
    Key protect Instance GUID
    kmsKmipAdapterId string
    name string
    The name of the KMIP adapter
    profile string
    The profile of the KMIP adapter
    profileData {[key: string]: string}
    The data specific to the KMIP Adapter profile
    updatedAt string
    The date when a resource was updated. The date format follows RFC 3339.
    updatedBy string
    The unique identifier that is associated with the entity that updated the adapter.
    adapter_id str
    The ID of the KMIP adapter
    created_at str
    The date when a resource was created. The date format follows RFC 3339.
    created_by str
    The unique identifier that is associated with the entity that created the adapter.
    description str
    The description of the KMIP adapter
    endpoint_type str
    public or private
    instance_id str
    Key protect Instance GUID
    kms_kmip_adapter_id str
    name str
    The name of the KMIP adapter
    profile str
    The profile of the KMIP adapter
    profile_data Mapping[str, str]
    The data specific to the KMIP Adapter profile
    updated_at str
    The date when a resource was updated. The date format follows RFC 3339.
    updated_by str
    The unique identifier that is associated with the entity that updated the adapter.
    adapterId String
    The ID of the KMIP adapter
    createdAt String
    The date when a resource was created. The date format follows RFC 3339.
    createdBy String
    The unique identifier that is associated with the entity that created the adapter.
    description String
    The description of the KMIP adapter
    endpointType String
    public or private
    instanceId String
    Key protect Instance GUID
    kmsKmipAdapterId String
    name String
    The name of the KMIP adapter
    profile String
    The profile of the KMIP adapter
    profileData Map<String>
    The data specific to the KMIP Adapter profile
    updatedAt String
    The date when a resource was updated. The date format follows RFC 3339.
    updatedBy String
    The unique identifier that is associated with the entity that updated the adapter.

    Package Details

    Repository
    ibm ibm-cloud/terraform-provider-ibm
    License
    Notes
    This Pulumi package is based on the ibm Terraform Provider.
    ibm logo
    ibm 1.78.0 published on Wednesday, Apr 30, 2025 by ibm-cloud