Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi Cloud Packages Tutorials
  1. Packages
  2. OVH
  3. API Docs
  4. Okms
  5. ServiceKeyJWK
OVHCloud v2.1.1 published on Thursday, Apr 10, 2025 by OVHcloud
ovh/pulumi-ovh

ovh.Okms.ServiceKeyJWK

Explore with Pulumi AI

ovh logo
OVHCloud v2.1.1 published on Thursday, Apr 10, 2025 by OVHcloud
ovh/pulumi-ovh

    Import an existing key in the JWK format in an OVHcloud KMS.

    Create ServiceKeyJWK Resource

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

    Constructor syntax

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

@overload
def ServiceKeyJWK(resource_name: str,
                  opts: Optional[ResourceOptions] = None,
                  keys: Optional[Sequence[_okms.ServiceKeyJWKKeyArgs]] = None,
                  okms_id: Optional[str] = None,
                  context: Optional[str] = None,
                  name: Optional[str] = None)
    func NewServiceKeyJWK(ctx *Context, name string, args ServiceKeyJWKArgs, opts ...ResourceOption) (*ServiceKeyJWK, error)
    public ServiceKeyJWK(string name, ServiceKeyJWKArgs args, CustomResourceOptions? opts = null)
    public ServiceKeyJWK(String name, ServiceKeyJWKArgs args)
public ServiceKeyJWK(String name, ServiceKeyJWKArgs args, CustomResourceOptions options)

    type: ovh:Okms:ServiceKeyJWK
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 ServiceKeyJWKArgs
    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 ServiceKeyJWKArgs
    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 ServiceKeyJWKArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args ServiceKeyJWKArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args ServiceKeyJWKArgs
    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 serviceKeyJWKResource = new Ovh.Okms.ServiceKeyJWK("serviceKeyJWKResource", new()
{
    Keys = new[]
    {
        new Ovh.Okms.Inputs.ServiceKeyJWKKeyArgs
        {
            KeyOps = new[]
            {
                "string",
            },
            Kty = "string",
            Kid = "string",
            Crv = "string",
            Dq = "string",
            E = "string",
            K = "string",
            D = "string",
            Alg = "string",
            Dp = "string",
            N = "string",
            P = "string",
            Q = "string",
            Qi = "string",
            Use = "string",
            X = "string",
            Y = "string",
        },
    },
    OkmsId = "string",
    Context = "string",
    Name = "string",
});

    example, err := Okms.NewServiceKeyJWK(ctx, "serviceKeyJWKResource", &Okms.ServiceKeyJWKArgs{
	Keys: okms.ServiceKeyJWKKeyArray{
		&okms.ServiceKeyJWKKeyArgs{
			KeyOps: pulumi.StringArray{
				pulumi.String("string"),
			},
			Kty: pulumi.String("string"),
			Kid: pulumi.String("string"),
			Crv: pulumi.String("string"),
			Dq:  pulumi.String("string"),
			E:   pulumi.String("string"),
			K:   pulumi.String("string"),
			D:   pulumi.String("string"),
			Alg: pulumi.String("string"),
			Dp:  pulumi.String("string"),
			N:   pulumi.String("string"),
			P:   pulumi.String("string"),
			Q:   pulumi.String("string"),
			Qi:  pulumi.String("string"),
			Use: pulumi.String("string"),
			X:   pulumi.String("string"),
			Y:   pulumi.String("string"),
		},
	},
	OkmsId:  pulumi.String("string"),
	Context: pulumi.String("string"),
	Name:    pulumi.String("string"),
})

    var serviceKeyJWKResource = new ServiceKeyJWK("serviceKeyJWKResource", ServiceKeyJWKArgs.builder()
    .keys(ServiceKeyJWKKeyArgs.builder()
        .keyOps("string")
        .kty("string")
        .kid("string")
        .crv("string")
        .dq("string")
        .e("string")
        .k("string")
        .d("string")
        .alg("string")
        .dp("string")
        .n("string")
        .p("string")
        .q("string")
        .qi("string")
        .use("string")
        .x("string")
        .y("string")
        .build())
    .okmsId("string")
    .context("string")
    .name("string")
    .build());

    service_key_jwk_resource = ovh.okms.ServiceKeyJWK("serviceKeyJWKResource",
    keys=[{
        "key_ops": ["string"],
        "kty": "string",
        "kid": "string",
        "crv": "string",
        "dq": "string",
        "e": "string",
        "k": "string",
        "d": "string",
        "alg": "string",
        "dp": "string",
        "n": "string",
        "p": "string",
        "q": "string",
        "qi": "string",
        "use": "string",
        "x": "string",
        "y": "string",
    }],
    okms_id="string",
    context="string",
    name="string")

    const serviceKeyJWKResource = new ovh.okms.ServiceKeyJWK("serviceKeyJWKResource", {
    keys: [{
        keyOps: ["string"],
        kty: "string",
        kid: "string",
        crv: "string",
        dq: "string",
        e: "string",
        k: "string",
        d: "string",
        alg: "string",
        dp: "string",
        n: "string",
        p: "string",
        q: "string",
        qi: "string",
        use: "string",
        x: "string",
        y: "string",
    }],
    okmsId: "string",
    context: "string",
    name: "string",
});

    type: ovh:Okms:ServiceKeyJWK
properties:
    context: string
    keys:
        - alg: string
          crv: string
          d: string
          dp: string
          dq: string
          e: string
          k: string
          keyOps:
            - string
          kid: string
          kty: string
          "n": string
          p: string
          q: string
          qi: string
          use: string
          x: string
          "y": string
    name: string
    okmsId: string

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

    Keys List<ServiceKeyJWKKey>
    Set of JSON Web Keys to import
    OkmsId string
    Okms ID
    Context string
    Context of the key
    Name string
    Key name
    Keys []ServiceKeyJWKKeyArgs
    Set of JSON Web Keys to import
    OkmsId string
    Okms ID
    Context string
    Context of the key
    Name string
    Key name
    keys List<ServiceKeyJWKKey>
    Set of JSON Web Keys to import
    okmsId String
    Okms ID
    context String
    Context of the key
    name String
    Key name
    keys ServiceKeyJWKKey[]
    Set of JSON Web Keys to import
    okmsId string
    Okms ID
    context string
    Context of the key
    name string
    Key name
    keys Sequence[okms.ServiceKeyJWKKeyArgs]
    Set of JSON Web Keys to import
    okms_id str
    Okms ID
    context str
    Context of the key
    name str
    Key name
    keys List<Property Map>
    Set of JSON Web Keys to import
    okmsId String
    Okms ID
    context String
    Context of the key
    name String
    Key name

    Outputs

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

    CreatedAt string
    Creation time of the key
    DeactivationReason string
    Key deactivation reason
    Iam ServiceKeyJWKIam
    IAM resource metadata
    Id string
    The provider-assigned unique ID for this managed resource.
    Size double
    Size of the key to be created
    State string
    State of the key
    Type string
    Type of the key to be created
    CreatedAt string
    Creation time of the key
    DeactivationReason string
    Key deactivation reason
    Iam ServiceKeyJWKIam
    IAM resource metadata
    Id string
    The provider-assigned unique ID for this managed resource.
    Size float64
    Size of the key to be created
    State string
    State of the key
    Type string
    Type of the key to be created
    createdAt String
    Creation time of the key
    deactivationReason String
    Key deactivation reason
    iam ServiceKeyJWKIam
    IAM resource metadata
    id String
    The provider-assigned unique ID for this managed resource.
    size Double
    Size of the key to be created
    state String
    State of the key
    type String
    Type of the key to be created
    createdAt string
    Creation time of the key
    deactivationReason string
    Key deactivation reason
    iam ServiceKeyJWKIam
    IAM resource metadata
    id string
    The provider-assigned unique ID for this managed resource.
    size number
    Size of the key to be created
    state string
    State of the key
    type string
    Type of the key to be created
    created_at str
    Creation time of the key
    deactivation_reason str
    Key deactivation reason
    iam okms.ServiceKeyJWKIam
    IAM resource metadata
    id str
    The provider-assigned unique ID for this managed resource.
    size float
    Size of the key to be created
    state str
    State of the key
    type str
    Type of the key to be created
    createdAt String
    Creation time of the key
    deactivationReason String
    Key deactivation reason
    iam Property Map
    IAM resource metadata
    id String
    The provider-assigned unique ID for this managed resource.
    size Number
    Size of the key to be created
    state String
    State of the key
    type String
    Type of the key to be created

    Look up Existing ServiceKeyJWK Resource

    Get an existing ServiceKeyJWK 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?: ServiceKeyJWKState, opts?: CustomResourceOptions): ServiceKeyJWK
    @staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        context: Optional[str] = None,
        created_at: Optional[str] = None,
        deactivation_reason: Optional[str] = None,
        iam: Optional[_okms.ServiceKeyJWKIamArgs] = None,
        keys: Optional[Sequence[_okms.ServiceKeyJWKKeyArgs]] = None,
        name: Optional[str] = None,
        okms_id: Optional[str] = None,
        size: Optional[float] = None,
        state: Optional[str] = None,
        type: Optional[str] = None) -> ServiceKeyJWK
    func GetServiceKeyJWK(ctx *Context, name string, id IDInput, state *ServiceKeyJWKState, opts ...ResourceOption) (*ServiceKeyJWK, error)
    public static ServiceKeyJWK Get(string name, Input<string> id, ServiceKeyJWKState? state, CustomResourceOptions? opts = null)
    public static ServiceKeyJWK get(String name, Output<String> id, ServiceKeyJWKState state, CustomResourceOptions options)
    resources:  _:    type: ovh:Okms:ServiceKeyJWK    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:
    Context string
    Context of the key
    CreatedAt string
    Creation time of the key
    DeactivationReason string
    Key deactivation reason
    Iam ServiceKeyJWKIam
    IAM resource metadata
    Keys List<ServiceKeyJWKKey>
    Set of JSON Web Keys to import
    Name string
    Key name
    OkmsId string
    Okms ID
    Size double
    Size of the key to be created
    State string
    State of the key
    Type string
    Type of the key to be created
    Context string
    Context of the key
    CreatedAt string
    Creation time of the key
    DeactivationReason string
    Key deactivation reason
    Iam ServiceKeyJWKIamArgs
    IAM resource metadata
    Keys []ServiceKeyJWKKeyArgs
    Set of JSON Web Keys to import
    Name string
    Key name
    OkmsId string
    Okms ID
    Size float64
    Size of the key to be created
    State string
    State of the key
    Type string
    Type of the key to be created
    context String
    Context of the key
    createdAt String
    Creation time of the key
    deactivationReason String
    Key deactivation reason
    iam ServiceKeyJWKIam
    IAM resource metadata
    keys List<ServiceKeyJWKKey>
    Set of JSON Web Keys to import
    name String
    Key name
    okmsId String
    Okms ID
    size Double
    Size of the key to be created
    state String
    State of the key
    type String
    Type of the key to be created
    context string
    Context of the key
    createdAt string
    Creation time of the key
    deactivationReason string
    Key deactivation reason
    iam ServiceKeyJWKIam
    IAM resource metadata
    keys ServiceKeyJWKKey[]
    Set of JSON Web Keys to import
    name string
    Key name
    okmsId string
    Okms ID
    size number
    Size of the key to be created
    state string
    State of the key
    type string
    Type of the key to be created
    context str
    Context of the key
    created_at str
    Creation time of the key
    deactivation_reason str
    Key deactivation reason
    iam okms.ServiceKeyJWKIamArgs
    IAM resource metadata
    keys Sequence[okms.ServiceKeyJWKKeyArgs]
    Set of JSON Web Keys to import
    name str
    Key name
    okms_id str
    Okms ID
    size float
    Size of the key to be created
    state str
    State of the key
    type str
    Type of the key to be created
    context String
    Context of the key
    createdAt String
    Creation time of the key
    deactivationReason String
    Key deactivation reason
    iam Property Map
    IAM resource metadata
    keys List<Property Map>
    Set of JSON Web Keys to import
    name String
    Key name
    okmsId String
    Okms ID
    size Number
    Size of the key to be created
    state String
    State of the key
    type String
    Type of the key to be created

    Supporting Types

    ServiceKeyJWKIam, ServiceKeyJWKIamArgs

    DisplayName string
    Resource display name
    Id string
    Unique identifier of the resource
    Tags Dictionary<string, string>
    Resource tags. Tags that were internally computed are prefixed with ovh:
    Urn string
    Unique resource name used in policies
    DisplayName string
    Resource display name
    Id string
    Unique identifier of the resource
    Tags map[string]string
    Resource tags. Tags that were internally computed are prefixed with ovh:
    Urn string
    Unique resource name used in policies
    displayName String
    Resource display name
    id String
    Unique identifier of the resource
    tags Map<String,String>
    Resource tags. Tags that were internally computed are prefixed with ovh:
    urn String
    Unique resource name used in policies
    displayName string
    Resource display name
    id string
    Unique identifier of the resource
    tags {[key: string]: string}
    Resource tags. Tags that were internally computed are prefixed with ovh:
    urn string
    Unique resource name used in policies
    display_name str
    Resource display name
    id str
    Unique identifier of the resource
    tags Mapping[str, str]
    Resource tags. Tags that were internally computed are prefixed with ovh:
    urn str
    Unique resource name used in policies
    displayName String
    Resource display name
    id String
    Unique identifier of the resource
    tags Map<String>
    Resource tags. Tags that were internally computed are prefixed with ovh:
    urn String
    Unique resource name used in policies

    ServiceKeyJWKKey, ServiceKeyJWKKeyArgs

    KeyOps List<string>
    The operation for which the key is intended to be used
    Kty string
    Key type parameter identifies the cryptographic algorithm family used with the key, such as RSA or EC
    Alg string
    The algorithm intended to be used with the key
    Crv string
    The cryptographic curve used with the key
    D string
    The RSA or EC private exponent
    Dp string
    The RSA private key's first factor CRT exponent
    Dq string
    The RSA private key's second factor CRT exponent
    E string
    The exponent value for the RSA public key
    K string
    The value of the symmetric (or other single-valued) key
    Kid string
    key ID parameter used to match a specific key
    N string
    The modulus value for the RSA public key
    P string
    The first prime factor of the RSA private key
    Q string
    The second prime factor of the RSA private key
    Qi string
    The CRT coefficient of the second factor of the RSA private key
    Use string
    The intended use of the public key
    X string
    The x coordinate for the Elliptic Curve point
    Y string
    The y coordinate for the Elliptic Curve point
    KeyOps []string
    The operation for which the key is intended to be used
    Kty string
    Key type parameter identifies the cryptographic algorithm family used with the key, such as RSA or EC
    Alg string
    The algorithm intended to be used with the key
    Crv string
    The cryptographic curve used with the key
    D string
    The RSA or EC private exponent
    Dp string
    The RSA private key's first factor CRT exponent
    Dq string
    The RSA private key's second factor CRT exponent
    E string
    The exponent value for the RSA public key
    K string
    The value of the symmetric (or other single-valued) key
    Kid string
    key ID parameter used to match a specific key
    N string
    The modulus value for the RSA public key
    P string
    The first prime factor of the RSA private key
    Q string
    The second prime factor of the RSA private key
    Qi string
    The CRT coefficient of the second factor of the RSA private key
    Use string
    The intended use of the public key
    X string
    The x coordinate for the Elliptic Curve point
    Y string
    The y coordinate for the Elliptic Curve point
    keyOps List<String>
    The operation for which the key is intended to be used
    kty String
    Key type parameter identifies the cryptographic algorithm family used with the key, such as RSA or EC
    alg String
    The algorithm intended to be used with the key
    crv String
    The cryptographic curve used with the key
    d String
    The RSA or EC private exponent
    dp String
    The RSA private key's first factor CRT exponent
    dq String
    The RSA private key's second factor CRT exponent
    e String
    The exponent value for the RSA public key
    k String
    The value of the symmetric (or other single-valued) key
    kid String
    key ID parameter used to match a specific key
    n String
    The modulus value for the RSA public key
    p String
    The first prime factor of the RSA private key
    q String
    The second prime factor of the RSA private key
    qi String
    The CRT coefficient of the second factor of the RSA private key
    use String
    The intended use of the public key
    x String
    The x coordinate for the Elliptic Curve point
    y String
    The y coordinate for the Elliptic Curve point
    keyOps string[]
    The operation for which the key is intended to be used
    kty string
    Key type parameter identifies the cryptographic algorithm family used with the key, such as RSA or EC
    alg string
    The algorithm intended to be used with the key
    crv string
    The cryptographic curve used with the key
    d string
    The RSA or EC private exponent
    dp string
    The RSA private key's first factor CRT exponent
    dq string
    The RSA private key's second factor CRT exponent
    e string
    The exponent value for the RSA public key
    k string
    The value of the symmetric (or other single-valued) key
    kid string
    key ID parameter used to match a specific key
    n string
    The modulus value for the RSA public key
    p string
    The first prime factor of the RSA private key
    q string
    The second prime factor of the RSA private key
    qi string
    The CRT coefficient of the second factor of the RSA private key
    use string
    The intended use of the public key
    x string
    The x coordinate for the Elliptic Curve point
    y string
    The y coordinate for the Elliptic Curve point
    key_ops Sequence[str]
    The operation for which the key is intended to be used
    kty str
    Key type parameter identifies the cryptographic algorithm family used with the key, such as RSA or EC
    alg str
    The algorithm intended to be used with the key
    crv str
    The cryptographic curve used with the key
    d str
    The RSA or EC private exponent
    dp str
    The RSA private key's first factor CRT exponent
    dq str
    The RSA private key's second factor CRT exponent
    e str
    The exponent value for the RSA public key
    k str
    The value of the symmetric (or other single-valued) key
    kid str
    key ID parameter used to match a specific key
    n str
    The modulus value for the RSA public key
    p str
    The first prime factor of the RSA private key
    q str
    The second prime factor of the RSA private key
    qi str
    The CRT coefficient of the second factor of the RSA private key
    use str
    The intended use of the public key
    x str
    The x coordinate for the Elliptic Curve point
    y str
    The y coordinate for the Elliptic Curve point
    keyOps List<String>
    The operation for which the key is intended to be used
    kty String
    Key type parameter identifies the cryptographic algorithm family used with the key, such as RSA or EC
    alg String
    The algorithm intended to be used with the key
    crv String
    The cryptographic curve used with the key
    d String
    The RSA or EC private exponent
    dp String
    The RSA private key's first factor CRT exponent
    dq String
    The RSA private key's second factor CRT exponent
    e String
    The exponent value for the RSA public key
    k String
    The value of the symmetric (or other single-valued) key
    kid String
    key ID parameter used to match a specific key
    n String
    The modulus value for the RSA public key
    p String
    The first prime factor of the RSA private key
    q String
    The second prime factor of the RSA private key
    qi String
    The CRT coefficient of the second factor of the RSA private key
    use String
    The intended use of the public key
    x String
    The x coordinate for the Elliptic Curve point
    y String
    The y coordinate for the Elliptic Curve point

    Package Details

    Repository
    ovh ovh/pulumi-ovh
    License
    Apache-2.0
    Notes
    This Pulumi package is based on the ovh Terraform Provider.
    ovh logo
    OVHCloud v2.1.1 published on Thursday, Apr 10, 2025 by OVHcloud
    ovh/pulumi-ovh