Docs Home Pulumi IaC Pulumi ESC Pulumi Cloud Packages Tutorials
  1. Packages
  2. OVH
  3. API Docs
  4. Okms
  5. ServiceKey
OVHCloud v1.0.0 published on Wednesday, Oct 30, 2024 by OVHcloud
ovh/pulumi-ovh

ovh.Okms.ServiceKey

Explore with Pulumi AI

ovh logo
OVHCloud v1.0.0 published on Wednesday, Oct 30, 2024 by OVHcloud
ovh/pulumi-ovh

    Creates a Service Key in an OVHcloud KMS.

    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,
               okms_id: Optional[str] = None,
               operations: Optional[Sequence[str]] = None,
               type: Optional[str] = None,
               context: Optional[str] = None,
               curve: Optional[str] = None,
               name: Optional[str] = None,
               size: Optional[float] = 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: ovh:Okms: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 Ovh.Okms.ServiceKey("serviceKeyResource", new()
{
    OkmsId = "string",
    Operations = new[]
    {
        "string",
    },
    Type = "string",
    Context = "string",
    Curve = "string",
    Name = "string",
    Size = 0,
});

    example, err := Okms.NewServiceKey(ctx, "serviceKeyResource", &Okms.ServiceKeyArgs{
	OkmsId: pulumi.String("string"),
	Operations: pulumi.StringArray{
		pulumi.String("string"),
	},
	Type:    pulumi.String("string"),
	Context: pulumi.String("string"),
	Curve:   pulumi.String("string"),
	Name:    pulumi.String("string"),
	Size:    pulumi.Float64(0),
})

    var serviceKeyResource = new ServiceKey("serviceKeyResource", ServiceKeyArgs.builder()
    .okmsId("string")
    .operations("string")
    .type("string")
    .context("string")
    .curve("string")
    .name("string")
    .size(0)
    .build());

    service_key_resource = ovh.okms.ServiceKey("serviceKeyResource",
    okms_id="string",
    operations=["string"],
    type="string",
    context="string",
    curve="string",
    name="string",
    size=0)

    const serviceKeyResource = new ovh.okms.ServiceKey("serviceKeyResource", {
    okmsId: "string",
    operations: ["string"],
    type: "string",
    context: "string",
    curve: "string",
    name: "string",
    size: 0,
});

    type: ovh:Okms:ServiceKey
properties:
    context: string
    curve: string
    name: string
    okmsId: string
    operations:
        - string
    size: 0
    type: 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:

    OkmsId string
    Okms ID
    Operations List<string>
    The operations for which the key is intended to be used
    Type string
    Type of the key to be created
    Context string
    Context of the key
    Curve string
    Curve type for Elliptic Curve (EC) keys
    Name string
    Key name
    Size double
    Size of the key to be created
    OkmsId string
    Okms ID
    Operations []string
    The operations for which the key is intended to be used
    Type string
    Type of the key to be created
    Context string
    Context of the key
    Curve string
    Curve type for Elliptic Curve (EC) keys
    Name string
    Key name
    Size float64
    Size of the key to be created
    okmsId String
    Okms ID
    operations List<String>
    The operations for which the key is intended to be used
    type String
    Type of the key to be created
    context String
    Context of the key
    curve String
    Curve type for Elliptic Curve (EC) keys
    name String
    Key name
    size Double
    Size of the key to be created
    okmsId string
    Okms ID
    operations string[]
    The operations for which the key is intended to be used
    type string
    Type of the key to be created
    context string
    Context of the key
    curve string
    Curve type for Elliptic Curve (EC) keys
    name string
    Key name
    size number
    Size of the key to be created
    okms_id str
    Okms ID
    operations Sequence[str]
    The operations for which the key is intended to be used
    type str
    Type of the key to be created
    context str
    Context of the key
    curve str
    Curve type for Elliptic Curve (EC) keys
    name str
    Key name
    size float
    Size of the key to be created
    okmsId String
    Okms ID
    operations List<String>
    The operations for which the key is intended to be used
    type String
    Type of the key to be created
    context String
    Context of the key
    curve String
    Curve type for Elliptic Curve (EC) keys
    name String
    Key name
    size Number
    Size of the key to be created

    Outputs

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

    CreatedAt string
    Creation time of the key
    DeactivationReason string
    Key deactivation reason
    Id string
    The provider-assigned unique ID for this managed resource.
    State string
    State of the key
    CreatedAt string
    Creation time of the key
    DeactivationReason string
    Key deactivation reason
    Id string
    The provider-assigned unique ID for this managed resource.
    State string
    State of the key
    createdAt String
    Creation time of the key
    deactivationReason String
    Key deactivation reason
    id String
    The provider-assigned unique ID for this managed resource.
    state String
    State of the key
    createdAt string
    Creation time of the key
    deactivationReason string
    Key deactivation reason
    id string
    The provider-assigned unique ID for this managed resource.
    state string
    State of the key
    created_at str
    Creation time of the key
    deactivation_reason str
    Key deactivation reason
    id str
    The provider-assigned unique ID for this managed resource.
    state str
    State of the key
    createdAt String
    Creation time of the key
    deactivationReason String
    Key deactivation reason
    id String
    The provider-assigned unique ID for this managed resource.
    state String
    State of the key

    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,
        context: Optional[str] = None,
        created_at: Optional[str] = None,
        curve: Optional[str] = None,
        deactivation_reason: Optional[str] = None,
        name: Optional[str] = None,
        okms_id: Optional[str] = None,
        operations: Optional[Sequence[str]] = None,
        size: Optional[float] = None,
        state: Optional[str] = None,
        type: Optional[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)
    Resource lookup is not supported in YAML
    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
    Curve string
    Curve type for Elliptic Curve (EC) keys
    DeactivationReason string
    Key deactivation reason
    Name string
    Key name
    OkmsId string
    Okms ID
    Operations List<string>
    The operations for which the key is intended to be used
    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
    Curve string
    Curve type for Elliptic Curve (EC) keys
    DeactivationReason string
    Key deactivation reason
    Name string
    Key name
    OkmsId string
    Okms ID
    Operations []string
    The operations for which the key is intended to be used
    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
    curve String
    Curve type for Elliptic Curve (EC) keys
    deactivationReason String
    Key deactivation reason
    name String
    Key name
    okmsId String
    Okms ID
    operations List<String>
    The operations for which the key is intended to be used
    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
    curve string
    Curve type for Elliptic Curve (EC) keys
    deactivationReason string
    Key deactivation reason
    name string
    Key name
    okmsId string
    Okms ID
    operations string[]
    The operations for which the key is intended to be used
    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
    curve str
    Curve type for Elliptic Curve (EC) keys
    deactivation_reason str
    Key deactivation reason
    name str
    Key name
    okms_id str
    Okms ID
    operations Sequence[str]
    The operations for which the key is intended to be used
    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
    curve String
    Curve type for Elliptic Curve (EC) keys
    deactivationReason String
    Key deactivation reason
    name String
    Key name
    okmsId String
    Okms ID
    operations List<String>
    The operations for which the key is intended to be used
    size Number
    Size of the key to be created
    state String
    State of the key
    type String
    Type of the key to be created

    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 v1.0.0 published on Wednesday, Oct 30, 2024 by OVHcloud
    ovh/pulumi-ovh