Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi Cloud Packages Tutorials
  1. Packages
  2. Ibm Provider
  3. API Docs
  4. ServiceKey
ibm 1.78.0 published on Wednesday, Apr 30, 2025 by ibm-cloud
ibm-cloud/terraform-provider-ibm

ibm.ServiceKey

Explore with Pulumi AI

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

    Create ServiceKey Resource

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

    Constructor syntax

    new ServiceKey(name: string, args: ServiceKeyArgs, opts?: CustomResourceOptions);
    @overload
def ServiceKey(resource_name: str,
               args: ServiceKeyArgs,
               opts: Optional[ResourceOptions] = None)

@overload
def ServiceKey(resource_name: str,
               opts: Optional[ResourceOptions] = None,
               service_instance_guid: Optional[str] = None,
               name: Optional[str] = None,
               parameters: Optional[Mapping[str, str]] = None,
               service_key_id: Optional[str] = None,
               tags: Optional[Sequence[str]] = None)
    func NewServiceKey(ctx *Context, name string, args ServiceKeyArgs, opts ...ResourceOption) (*ServiceKey, error)
    public ServiceKey(string name, ServiceKeyArgs args, CustomResourceOptions? opts = null)
    public ServiceKey(String name, ServiceKeyArgs args)
public ServiceKey(String name, ServiceKeyArgs args, CustomResourceOptions options)

    type: ibm:ServiceKey
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 ServiceKeyArgs
    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 ServiceKeyArgs
    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 ServiceKeyArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args ServiceKeyArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args ServiceKeyArgs
    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 serviceKeyResource = new Ibm.ServiceKey("serviceKeyResource", new()
{
    ServiceInstanceGuid = "string",
    Name = "string",
    Parameters = 
    {
        { "string", "string" },
    },
    ServiceKeyId = "string",
    Tags = new[]
    {
        "string",
    },
});

    example, err := ibm.NewServiceKey(ctx, "serviceKeyResource", &ibm.ServiceKeyArgs{
	ServiceInstanceGuid: pulumi.String("string"),
	Name:                pulumi.String("string"),
	Parameters: pulumi.StringMap{
		"string": pulumi.String("string"),
	},
	ServiceKeyId: pulumi.String("string"),
	Tags: pulumi.StringArray{
		pulumi.String("string"),
	},
})

    var serviceKeyResource = new ServiceKey("serviceKeyResource", ServiceKeyArgs.builder()
    .serviceInstanceGuid("string")
    .name("string")
    .parameters(Map.of("string", "string"))
    .serviceKeyId("string")
    .tags("string")
    .build());

    service_key_resource = ibm.ServiceKey("serviceKeyResource",
    service_instance_guid="string",
    name="string",
    parameters={
        "string": "string",
    },
    service_key_id="string",
    tags=["string"])

    const serviceKeyResource = new ibm.ServiceKey("serviceKeyResource", {
    serviceInstanceGuid: "string",
    name: "string",
    parameters: {
        string: "string",
    },
    serviceKeyId: "string",
    tags: ["string"],
});

    type: ibm:ServiceKey
properties:
    name: string
    parameters:
        string: string
    serviceInstanceGuid: string
    serviceKeyId: string
    tags:
        - string

    ServiceKey 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 ServiceKey resource accepts the following input properties:

    ServiceInstanceGuid string
    The guid of the service instance for which to create service key
    Name string
    The name of the service key
    Parameters Dictionary<string, string>
    Arbitrary parameters to pass along to the service broker. Must be a JSON object
    ServiceKeyId string
    Tags List<string>
    ServiceInstanceGuid string
    The guid of the service instance for which to create service key
    Name string
    The name of the service key
    Parameters map[string]string
    Arbitrary parameters to pass along to the service broker. Must be a JSON object
    ServiceKeyId string
    Tags []string
    serviceInstanceGuid String
    The guid of the service instance for which to create service key
    name String
    The name of the service key
    parameters Map<String,String>
    Arbitrary parameters to pass along to the service broker. Must be a JSON object
    serviceKeyId String
    tags List<String>
    serviceInstanceGuid string
    The guid of the service instance for which to create service key
    name string
    The name of the service key
    parameters {[key: string]: string}
    Arbitrary parameters to pass along to the service broker. Must be a JSON object
    serviceKeyId string
    tags string[]
    service_instance_guid str
    The guid of the service instance for which to create service key
    name str
    The name of the service key
    parameters Mapping[str, str]
    Arbitrary parameters to pass along to the service broker. Must be a JSON object
    service_key_id str
    tags Sequence[str]
    serviceInstanceGuid String
    The guid of the service instance for which to create service key
    name String
    The name of the service key
    parameters Map<String>
    Arbitrary parameters to pass along to the service broker. Must be a JSON object
    serviceKeyId String
    tags List<String>

    Outputs

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

    Credentials Dictionary<string, string>
    Credentials asociated with the key
    Id string
    The provider-assigned unique ID for this managed resource.
    Credentials map[string]string
    Credentials asociated with the key
    Id string
    The provider-assigned unique ID for this managed resource.
    credentials Map<String,String>
    Credentials asociated with the key
    id String
    The provider-assigned unique ID for this managed resource.
    credentials {[key: string]: string}
    Credentials asociated with the key
    id string
    The provider-assigned unique ID for this managed resource.
    credentials Mapping[str, str]
    Credentials asociated with the key
    id str
    The provider-assigned unique ID for this managed resource.
    credentials Map<String>
    Credentials asociated with the key
    id String
    The provider-assigned unique ID for this managed resource.

    Look up Existing ServiceKey Resource

    Get an existing ServiceKey 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?: ServiceKeyState, opts?: CustomResourceOptions): ServiceKey
    @staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        credentials: Optional[Mapping[str, str]] = None,
        name: Optional[str] = None,
        parameters: Optional[Mapping[str, str]] = None,
        service_instance_guid: Optional[str] = None,
        service_key_id: Optional[str] = None,
        tags: Optional[Sequence[str]] = None) -> ServiceKey
    func GetServiceKey(ctx *Context, name string, id IDInput, state *ServiceKeyState, opts ...ResourceOption) (*ServiceKey, error)
    public static ServiceKey Get(string name, Input<string> id, ServiceKeyState? state, CustomResourceOptions? opts = null)
    public static ServiceKey get(String name, Output<String> id, ServiceKeyState state, CustomResourceOptions options)
    resources:  _:    type: ibm:ServiceKey    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:
    Credentials Dictionary<string, string>
    Credentials asociated with the key
    Name string
    The name of the service key
    Parameters Dictionary<string, string>
    Arbitrary parameters to pass along to the service broker. Must be a JSON object
    ServiceInstanceGuid string
    The guid of the service instance for which to create service key
    ServiceKeyId string
    Tags List<string>
    Credentials map[string]string
    Credentials asociated with the key
    Name string
    The name of the service key
    Parameters map[string]string
    Arbitrary parameters to pass along to the service broker. Must be a JSON object
    ServiceInstanceGuid string
    The guid of the service instance for which to create service key
    ServiceKeyId string
    Tags []string
    credentials Map<String,String>
    Credentials asociated with the key
    name String
    The name of the service key
    parameters Map<String,String>
    Arbitrary parameters to pass along to the service broker. Must be a JSON object
    serviceInstanceGuid String
    The guid of the service instance for which to create service key
    serviceKeyId String
    tags List<String>
    credentials {[key: string]: string}
    Credentials asociated with the key
    name string
    The name of the service key
    parameters {[key: string]: string}
    Arbitrary parameters to pass along to the service broker. Must be a JSON object
    serviceInstanceGuid string
    The guid of the service instance for which to create service key
    serviceKeyId string
    tags string[]
    credentials Mapping[str, str]
    Credentials asociated with the key
    name str
    The name of the service key
    parameters Mapping[str, str]
    Arbitrary parameters to pass along to the service broker. Must be a JSON object
    service_instance_guid str
    The guid of the service instance for which to create service key
    service_key_id str
    tags Sequence[str]
    credentials Map<String>
    Credentials asociated with the key
    name String
    The name of the service key
    parameters Map<String>
    Arbitrary parameters to pass along to the service broker. Must be a JSON object
    serviceInstanceGuid String
    The guid of the service instance for which to create service key
    serviceKeyId String
    tags List<String>

    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
    ibm-cloud/terraform-provider-ibm