1. Packages
  2. Flexibleengine Provider
  3. API Docs
  4. ApigSignature
flexibleengine 1.46.0 published on Monday, Apr 14, 2025 by flexibleenginecloud

flexibleengine.ApigSignature

Explore with Pulumi AI

Manages a signature resource within FlexibleEngine.

Example Usage

Create a signature of the HMAC type

import * as pulumi from "@pulumi/pulumi";
import * as flexibleengine from "@pulumi/flexibleengine";

const config = new pulumi.Config();
const instanceId = config.requireObject("instanceId");
const signatureName = config.requireObject("signatureName");
const signatureKey = config.requireObject("signatureKey");
const signatureSecret = config.requireObject("signatureSecret");
const test = new flexibleengine.ApigSignature("test", {
    instanceId: instanceId,
    type: "hmac",
    key: signatureKey,
    secret: signatureSecret,
});
Copy
import pulumi
import pulumi_flexibleengine as flexibleengine

config = pulumi.Config()
instance_id = config.require_object("instanceId")
signature_name = config.require_object("signatureName")
signature_key = config.require_object("signatureKey")
signature_secret = config.require_object("signatureSecret")
test = flexibleengine.ApigSignature("test",
    instance_id=instance_id,
    type="hmac",
    key=signature_key,
    secret=signature_secret)
Copy
package main

import (
	"github.com/pulumi/pulumi-terraform-provider/sdks/go/flexibleengine/flexibleengine"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi/config"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		cfg := config.New(ctx, "")
		instanceId := cfg.RequireObject("instanceId")
		signatureName := cfg.RequireObject("signatureName")
		signatureKey := cfg.RequireObject("signatureKey")
		signatureSecret := cfg.RequireObject("signatureSecret")
		_, err := flexibleengine.NewApigSignature(ctx, "test", &flexibleengine.ApigSignatureArgs{
			InstanceId: pulumi.Any(instanceId),
			Type:       pulumi.String("hmac"),
			Key:        pulumi.Any(signatureKey),
			Secret:     pulumi.Any(signatureSecret),
		})
		if err != nil {
			return err
		}
		return nil
	})
}
Copy
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Flexibleengine = Pulumi.Flexibleengine;

return await Deployment.RunAsync(() => 
{
    var config = new Config();
    var instanceId = config.RequireObject<dynamic>("instanceId");
    var signatureName = config.RequireObject<dynamic>("signatureName");
    var signatureKey = config.RequireObject<dynamic>("signatureKey");
    var signatureSecret = config.RequireObject<dynamic>("signatureSecret");
    var test = new Flexibleengine.ApigSignature("test", new()
    {
        InstanceId = instanceId,
        Type = "hmac",
        Key = signatureKey,
        Secret = signatureSecret,
    });

});
Copy
package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.flexibleengine.ApigSignature;
import com.pulumi.flexibleengine.ApigSignatureArgs;
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) {
        final var config = ctx.config();
        final var instanceId = config.get("instanceId");
        final var signatureName = config.get("signatureName");
        final var signatureKey = config.get("signatureKey");
        final var signatureSecret = config.get("signatureSecret");
        var test = new ApigSignature("test", ApigSignatureArgs.builder()
            .instanceId(instanceId)
            .type("hmac")
            .key(signatureKey)
            .secret(signatureSecret)
            .build());

    }
}
Copy
configuration:
  instanceId:
    type: dynamic
  signatureName:
    type: dynamic
  signatureKey:
    type: dynamic
  signatureSecret:
    type: dynamic
resources:
  test:
    type: flexibleengine:ApigSignature
    properties:
      instanceId: ${instanceId}
      type: hmac
      key: ${signatureKey}
      secret: ${signatureSecret}
Copy

Create a signature and automatically generate key and secret

import * as pulumi from "@pulumi/pulumi";
import * as flexibleengine from "@pulumi/flexibleengine";

const config = new pulumi.Config();
const instanceId = config.requireObject("instanceId");
const signatureName = config.requireObject("signatureName");
const test = new flexibleengine.ApigSignature("test", {
    instanceId: instanceId,
    type: "hmac",
});
Copy
import pulumi
import pulumi_flexibleengine as flexibleengine

config = pulumi.Config()
instance_id = config.require_object("instanceId")
signature_name = config.require_object("signatureName")
test = flexibleengine.ApigSignature("test",
    instance_id=instance_id,
    type="hmac")
Copy
package main

import (
	"github.com/pulumi/pulumi-terraform-provider/sdks/go/flexibleengine/flexibleengine"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi/config"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		cfg := config.New(ctx, "")
		instanceId := cfg.RequireObject("instanceId")
		signatureName := cfg.RequireObject("signatureName")
		_, err := flexibleengine.NewApigSignature(ctx, "test", &flexibleengine.ApigSignatureArgs{
			InstanceId: pulumi.Any(instanceId),
			Type:       pulumi.String("hmac"),
		})
		if err != nil {
			return err
		}
		return nil
	})
}
Copy
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Flexibleengine = Pulumi.Flexibleengine;

return await Deployment.RunAsync(() => 
{
    var config = new Config();
    var instanceId = config.RequireObject<dynamic>("instanceId");
    var signatureName = config.RequireObject<dynamic>("signatureName");
    var test = new Flexibleengine.ApigSignature("test", new()
    {
        InstanceId = instanceId,
        Type = "hmac",
    });

});
Copy
package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.flexibleengine.ApigSignature;
import com.pulumi.flexibleengine.ApigSignatureArgs;
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) {
        final var config = ctx.config();
        final var instanceId = config.get("instanceId");
        final var signatureName = config.get("signatureName");
        var test = new ApigSignature("test", ApigSignatureArgs.builder()
            .instanceId(instanceId)
            .type("hmac")
            .build());

    }
}
Copy
configuration:
  instanceId:
    type: dynamic
  signatureName:
    type: dynamic
resources:
  test:
    type: flexibleengine:ApigSignature
    properties:
      instanceId: ${instanceId}
      type: hmac
Copy

Create a signature of the AES type

import * as pulumi from "@pulumi/pulumi";
import * as flexibleengine from "@pulumi/flexibleengine";

const config = new pulumi.Config();
const instanceId = config.requireObject("instanceId");
const signatureName = config.requireObject("signatureName");
const signatureKey = config.requireObject("signatureKey");
const signatureSecret = config.requireObject("signatureSecret");
const test = new flexibleengine.ApigSignature("test", {
    instanceId: instanceId,
    type: "aes",
    algorithm: "aes-128-cfb",
    key: signatureKey,
    secret: signatureSecret,
});
Copy
import pulumi
import pulumi_flexibleengine as flexibleengine

config = pulumi.Config()
instance_id = config.require_object("instanceId")
signature_name = config.require_object("signatureName")
signature_key = config.require_object("signatureKey")
signature_secret = config.require_object("signatureSecret")
test = flexibleengine.ApigSignature("test",
    instance_id=instance_id,
    type="aes",
    algorithm="aes-128-cfb",
    key=signature_key,
    secret=signature_secret)
Copy
package main

import (
	"github.com/pulumi/pulumi-terraform-provider/sdks/go/flexibleengine/flexibleengine"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi/config"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		cfg := config.New(ctx, "")
		instanceId := cfg.RequireObject("instanceId")
		signatureName := cfg.RequireObject("signatureName")
		signatureKey := cfg.RequireObject("signatureKey")
		signatureSecret := cfg.RequireObject("signatureSecret")
		_, err := flexibleengine.NewApigSignature(ctx, "test", &flexibleengine.ApigSignatureArgs{
			InstanceId: pulumi.Any(instanceId),
			Type:       pulumi.String("aes"),
			Algorithm:  pulumi.String("aes-128-cfb"),
			Key:        pulumi.Any(signatureKey),
			Secret:     pulumi.Any(signatureSecret),
		})
		if err != nil {
			return err
		}
		return nil
	})
}
Copy
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Flexibleengine = Pulumi.Flexibleengine;

return await Deployment.RunAsync(() => 
{
    var config = new Config();
    var instanceId = config.RequireObject<dynamic>("instanceId");
    var signatureName = config.RequireObject<dynamic>("signatureName");
    var signatureKey = config.RequireObject<dynamic>("signatureKey");
    var signatureSecret = config.RequireObject<dynamic>("signatureSecret");
    var test = new Flexibleengine.ApigSignature("test", new()
    {
        InstanceId = instanceId,
        Type = "aes",
        Algorithm = "aes-128-cfb",
        Key = signatureKey,
        Secret = signatureSecret,
    });

});
Copy
package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.flexibleengine.ApigSignature;
import com.pulumi.flexibleengine.ApigSignatureArgs;
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) {
        final var config = ctx.config();
        final var instanceId = config.get("instanceId");
        final var signatureName = config.get("signatureName");
        final var signatureKey = config.get("signatureKey");
        final var signatureSecret = config.get("signatureSecret");
        var test = new ApigSignature("test", ApigSignatureArgs.builder()
            .instanceId(instanceId)
            .type("aes")
            .algorithm("aes-128-cfb")
            .key(signatureKey)
            .secret(signatureSecret)
            .build());

    }
}
Copy
configuration:
  instanceId:
    type: dynamic
  signatureName:
    type: dynamic
  signatureKey:
    type: dynamic
  signatureSecret:
    type: dynamic
resources:
  test:
    type: flexibleengine:ApigSignature
    properties:
      instanceId: ${instanceId}
      type: aes
      algorithm: aes-128-cfb
      key: ${signatureKey}
      secret: ${signatureSecret}
Copy

Create ApigSignature Resource

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

Constructor syntax

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

@overload
def ApigSignature(resource_name: str,
                  opts: Optional[ResourceOptions] = None,
                  instance_id: Optional[str] = None,
                  type: Optional[str] = None,
                  algorithm: Optional[str] = None,
                  apig_signature_id: Optional[str] = None,
                  key: Optional[str] = None,
                  name: Optional[str] = None,
                  region: Optional[str] = None,
                  secret: Optional[str] = None)
func NewApigSignature(ctx *Context, name string, args ApigSignatureArgs, opts ...ResourceOption) (*ApigSignature, error)
public ApigSignature(string name, ApigSignatureArgs args, CustomResourceOptions? opts = null)
public ApigSignature(String name, ApigSignatureArgs args)
public ApigSignature(String name, ApigSignatureArgs args, CustomResourceOptions options)
type: flexibleengine:ApigSignature
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

Parameters

name This property is required. string
The unique name of the resource.
args This property is required. ApigSignatureArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
resource_name This property is required. str
The unique name of the resource.
args This property is required. ApigSignatureArgs
The arguments to resource properties.
opts ResourceOptions
Bag of options to control resource's behavior.
ctx Context
Context object for the current deployment.
name This property is required. string
The unique name of the resource.
args This property is required. ApigSignatureArgs
The arguments to resource properties.
opts ResourceOption
Bag of options to control resource's behavior.
name This property is required. string
The unique name of the resource.
args This property is required. ApigSignatureArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
name This property is required. String
The unique name of the resource.
args This property is required. ApigSignatureArgs
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 apigSignatureResource = new Flexibleengine.ApigSignature("apigSignatureResource", new()
{
    InstanceId = "string",
    Type = "string",
    Algorithm = "string",
    ApigSignatureId = "string",
    Key = "string",
    Name = "string",
    Region = "string",
    Secret = "string",
});
Copy
example, err := flexibleengine.NewApigSignature(ctx, "apigSignatureResource", &flexibleengine.ApigSignatureArgs{
InstanceId: pulumi.String("string"),
Type: pulumi.String("string"),
Algorithm: pulumi.String("string"),
ApigSignatureId: pulumi.String("string"),
Key: pulumi.String("string"),
Name: pulumi.String("string"),
Region: pulumi.String("string"),
Secret: pulumi.String("string"),
})
Copy
var apigSignatureResource = new ApigSignature("apigSignatureResource", ApigSignatureArgs.builder()
    .instanceId("string")
    .type("string")
    .algorithm("string")
    .apigSignatureId("string")
    .key("string")
    .name("string")
    .region("string")
    .secret("string")
    .build());
Copy
apig_signature_resource = flexibleengine.ApigSignature("apigSignatureResource",
    instance_id="string",
    type="string",
    algorithm="string",
    apig_signature_id="string",
    key="string",
    name="string",
    region="string",
    secret="string")
Copy
const apigSignatureResource = new flexibleengine.ApigSignature("apigSignatureResource", {
    instanceId: "string",
    type: "string",
    algorithm: "string",
    apigSignatureId: "string",
    key: "string",
    name: "string",
    region: "string",
    secret: "string",
});
Copy
type: flexibleengine:ApigSignature
properties:
    algorithm: string
    apigSignatureId: string
    instanceId: string
    key: string
    name: string
    region: string
    secret: string
    type: string
Copy

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

InstanceId This property is required. string
Specifies the ID of the dedicated instance to which the signature belongs. Changing this will create a new resource.
Type This property is required. string

Specifies the type of signature.
The valid values are as follows:

  • basic: Basic auth type.
  • hmac: HMAC type.
  • aes: AES type

Changing this will create a new resource.

Algorithm string

Specifies the signature algorithm.
This parameter is required and only available when signature type is aes. The valid values are as follows:

  • aes-128-cfb
  • aes-256-cfb

Changing this will create a new resource.

ApigSignatureId string
The ID of the signature.
Key string

Specifies the signature key.

  • For basic type: The value contains 4 to 32 characters, including letters, digits, underscores (_) and hyphens (-). It must start with a letter.
  • For hmac type: The value contains 8 to 32 characters, including letters, digits, underscores (_) and hyphens (-). It must start with a letter or digit.
  • For aes type: The value contains 16 characters if the aes-128-cfb algorithm is used, or 32 characters if the aes-256-cfb algorithm is used. Only letters, digits, and special characters (_-!@#$%+/=) are allowed. It must start with a letter, digit, plus sign (+), or slash (/).

If not specified, the key will automatically generated. The auto-generation is only supported on first creation. Changing this will create a new resource.

Name string
Specifies the signature name.
The valid length is limited from 3 to 64, only English letters, Chinese characters, digits and underscores (_) are allowed. The name must start with an English letter or Chinese character.
Region string
Specifies the region where the signature is located.
If omitted, the provider-level region will be used. Changing this will create a new resource.
Secret string
Specifies the signature secret.
If not specified, the secret will automatically generated. The auto-generation is only supported on first creation. Changing this will create a new resource.
InstanceId This property is required. string
Specifies the ID of the dedicated instance to which the signature belongs. Changing this will create a new resource.
Type This property is required. string

Specifies the type of signature.
The valid values are as follows:

  • basic: Basic auth type.
  • hmac: HMAC type.
  • aes: AES type

Changing this will create a new resource.

Algorithm string

Specifies the signature algorithm.
This parameter is required and only available when signature type is aes. The valid values are as follows:

  • aes-128-cfb
  • aes-256-cfb

Changing this will create a new resource.

ApigSignatureId string
The ID of the signature.
Key string

Specifies the signature key.

  • For basic type: The value contains 4 to 32 characters, including letters, digits, underscores (_) and hyphens (-). It must start with a letter.
  • For hmac type: The value contains 8 to 32 characters, including letters, digits, underscores (_) and hyphens (-). It must start with a letter or digit.
  • For aes type: The value contains 16 characters if the aes-128-cfb algorithm is used, or 32 characters if the aes-256-cfb algorithm is used. Only letters, digits, and special characters (_-!@#$%+/=) are allowed. It must start with a letter, digit, plus sign (+), or slash (/).

If not specified, the key will automatically generated. The auto-generation is only supported on first creation. Changing this will create a new resource.

Name string
Specifies the signature name.
The valid length is limited from 3 to 64, only English letters, Chinese characters, digits and underscores (_) are allowed. The name must start with an English letter or Chinese character.
Region string
Specifies the region where the signature is located.
If omitted, the provider-level region will be used. Changing this will create a new resource.
Secret string
Specifies the signature secret.
If not specified, the secret will automatically generated. The auto-generation is only supported on first creation. Changing this will create a new resource.
instanceId This property is required. String
Specifies the ID of the dedicated instance to which the signature belongs. Changing this will create a new resource.
type This property is required. String

Specifies the type of signature.
The valid values are as follows:

  • basic: Basic auth type.
  • hmac: HMAC type.
  • aes: AES type

Changing this will create a new resource.

algorithm String

Specifies the signature algorithm.
This parameter is required and only available when signature type is aes. The valid values are as follows:

  • aes-128-cfb
  • aes-256-cfb

Changing this will create a new resource.

apigSignatureId String
The ID of the signature.
key String

Specifies the signature key.

  • For basic type: The value contains 4 to 32 characters, including letters, digits, underscores (_) and hyphens (-). It must start with a letter.
  • For hmac type: The value contains 8 to 32 characters, including letters, digits, underscores (_) and hyphens (-). It must start with a letter or digit.
  • For aes type: The value contains 16 characters if the aes-128-cfb algorithm is used, or 32 characters if the aes-256-cfb algorithm is used. Only letters, digits, and special characters (_-!@#$%+/=) are allowed. It must start with a letter, digit, plus sign (+), or slash (/).

If not specified, the key will automatically generated. The auto-generation is only supported on first creation. Changing this will create a new resource.

name String
Specifies the signature name.
The valid length is limited from 3 to 64, only English letters, Chinese characters, digits and underscores (_) are allowed. The name must start with an English letter or Chinese character.
region String
Specifies the region where the signature is located.
If omitted, the provider-level region will be used. Changing this will create a new resource.
secret String
Specifies the signature secret.
If not specified, the secret will automatically generated. The auto-generation is only supported on first creation. Changing this will create a new resource.
instanceId This property is required. string
Specifies the ID of the dedicated instance to which the signature belongs. Changing this will create a new resource.
type This property is required. string

Specifies the type of signature.
The valid values are as follows:

  • basic: Basic auth type.
  • hmac: HMAC type.
  • aes: AES type

Changing this will create a new resource.

algorithm string

Specifies the signature algorithm.
This parameter is required and only available when signature type is aes. The valid values are as follows:

  • aes-128-cfb
  • aes-256-cfb

Changing this will create a new resource.

apigSignatureId string
The ID of the signature.
key string

Specifies the signature key.

  • For basic type: The value contains 4 to 32 characters, including letters, digits, underscores (_) and hyphens (-). It must start with a letter.
  • For hmac type: The value contains 8 to 32 characters, including letters, digits, underscores (_) and hyphens (-). It must start with a letter or digit.
  • For aes type: The value contains 16 characters if the aes-128-cfb algorithm is used, or 32 characters if the aes-256-cfb algorithm is used. Only letters, digits, and special characters (_-!@#$%+/=) are allowed. It must start with a letter, digit, plus sign (+), or slash (/).

If not specified, the key will automatically generated. The auto-generation is only supported on first creation. Changing this will create a new resource.

name string
Specifies the signature name.
The valid length is limited from 3 to 64, only English letters, Chinese characters, digits and underscores (_) are allowed. The name must start with an English letter or Chinese character.
region string
Specifies the region where the signature is located.
If omitted, the provider-level region will be used. Changing this will create a new resource.
secret string
Specifies the signature secret.
If not specified, the secret will automatically generated. The auto-generation is only supported on first creation. Changing this will create a new resource.
instance_id This property is required. str
Specifies the ID of the dedicated instance to which the signature belongs. Changing this will create a new resource.
type This property is required. str

Specifies the type of signature.
The valid values are as follows:

  • basic: Basic auth type.
  • hmac: HMAC type.
  • aes: AES type

Changing this will create a new resource.

algorithm str

Specifies the signature algorithm.
This parameter is required and only available when signature type is aes. The valid values are as follows:

  • aes-128-cfb
  • aes-256-cfb

Changing this will create a new resource.

apig_signature_id str
The ID of the signature.
key str

Specifies the signature key.

  • For basic type: The value contains 4 to 32 characters, including letters, digits, underscores (_) and hyphens (-). It must start with a letter.
  • For hmac type: The value contains 8 to 32 characters, including letters, digits, underscores (_) and hyphens (-). It must start with a letter or digit.
  • For aes type: The value contains 16 characters if the aes-128-cfb algorithm is used, or 32 characters if the aes-256-cfb algorithm is used. Only letters, digits, and special characters (_-!@#$%+/=) are allowed. It must start with a letter, digit, plus sign (+), or slash (/).

If not specified, the key will automatically generated. The auto-generation is only supported on first creation. Changing this will create a new resource.

name str
Specifies the signature name.
The valid length is limited from 3 to 64, only English letters, Chinese characters, digits and underscores (_) are allowed. The name must start with an English letter or Chinese character.
region str
Specifies the region where the signature is located.
If omitted, the provider-level region will be used. Changing this will create a new resource.
secret str
Specifies the signature secret.
If not specified, the secret will automatically generated. The auto-generation is only supported on first creation. Changing this will create a new resource.
instanceId This property is required. String
Specifies the ID of the dedicated instance to which the signature belongs. Changing this will create a new resource.
type This property is required. String

Specifies the type of signature.
The valid values are as follows:

  • basic: Basic auth type.
  • hmac: HMAC type.
  • aes: AES type

Changing this will create a new resource.

algorithm String

Specifies the signature algorithm.
This parameter is required and only available when signature type is aes. The valid values are as follows:

  • aes-128-cfb
  • aes-256-cfb

Changing this will create a new resource.

apigSignatureId String
The ID of the signature.
key String

Specifies the signature key.

  • For basic type: The value contains 4 to 32 characters, including letters, digits, underscores (_) and hyphens (-). It must start with a letter.
  • For hmac type: The value contains 8 to 32 characters, including letters, digits, underscores (_) and hyphens (-). It must start with a letter or digit.
  • For aes type: The value contains 16 characters if the aes-128-cfb algorithm is used, or 32 characters if the aes-256-cfb algorithm is used. Only letters, digits, and special characters (_-!@#$%+/=) are allowed. It must start with a letter, digit, plus sign (+), or slash (/).

If not specified, the key will automatically generated. The auto-generation is only supported on first creation. Changing this will create a new resource.

name String
Specifies the signature name.
The valid length is limited from 3 to 64, only English letters, Chinese characters, digits and underscores (_) are allowed. The name must start with an English letter or Chinese character.
region String
Specifies the region where the signature is located.
If omitted, the provider-level region will be used. Changing this will create a new resource.
secret String
Specifies the signature secret.
If not specified, the secret will automatically generated. The auto-generation is only supported on first creation. Changing this will create a new resource.

Outputs

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

CreatedAt string
The creation time of the signature.
Id string
The provider-assigned unique ID for this managed resource.
UpdatedAt string
The latest update time of the signature.
CreatedAt string
The creation time of the signature.
Id string
The provider-assigned unique ID for this managed resource.
UpdatedAt string
The latest update time of the signature.
createdAt String
The creation time of the signature.
id String
The provider-assigned unique ID for this managed resource.
updatedAt String
The latest update time of the signature.
createdAt string
The creation time of the signature.
id string
The provider-assigned unique ID for this managed resource.
updatedAt string
The latest update time of the signature.
created_at str
The creation time of the signature.
id str
The provider-assigned unique ID for this managed resource.
updated_at str
The latest update time of the signature.
createdAt String
The creation time of the signature.
id String
The provider-assigned unique ID for this managed resource.
updatedAt String
The latest update time of the signature.

Look up Existing ApigSignature Resource

Get an existing ApigSignature 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?: ApigSignatureState, opts?: CustomResourceOptions): ApigSignature
@staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        algorithm: Optional[str] = None,
        apig_signature_id: Optional[str] = None,
        created_at: Optional[str] = None,
        instance_id: Optional[str] = None,
        key: Optional[str] = None,
        name: Optional[str] = None,
        region: Optional[str] = None,
        secret: Optional[str] = None,
        type: Optional[str] = None,
        updated_at: Optional[str] = None) -> ApigSignature
func GetApigSignature(ctx *Context, name string, id IDInput, state *ApigSignatureState, opts ...ResourceOption) (*ApigSignature, error)
public static ApigSignature Get(string name, Input<string> id, ApigSignatureState? state, CustomResourceOptions? opts = null)
public static ApigSignature get(String name, Output<String> id, ApigSignatureState state, CustomResourceOptions options)
resources:  _:    type: flexibleengine:ApigSignature    get:      id: ${id}
name This property is required.
The unique name of the resulting resource.
id This property is required.
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 This property is required.
The unique name of the resulting resource.
id This property is required.
The unique provider ID of the resource to lookup.
name This property is required.
The unique name of the resulting resource.
id This property is required.
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 This property is required.
The unique name of the resulting resource.
id This property is required.
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 This property is required.
The unique name of the resulting resource.
id This property is required.
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:
Algorithm string

Specifies the signature algorithm.
This parameter is required and only available when signature type is aes. The valid values are as follows:

  • aes-128-cfb
  • aes-256-cfb

Changing this will create a new resource.

ApigSignatureId string
The ID of the signature.
CreatedAt string
The creation time of the signature.
InstanceId string
Specifies the ID of the dedicated instance to which the signature belongs. Changing this will create a new resource.
Key string

Specifies the signature key.

  • For basic type: The value contains 4 to 32 characters, including letters, digits, underscores (_) and hyphens (-). It must start with a letter.
  • For hmac type: The value contains 8 to 32 characters, including letters, digits, underscores (_) and hyphens (-). It must start with a letter or digit.
  • For aes type: The value contains 16 characters if the aes-128-cfb algorithm is used, or 32 characters if the aes-256-cfb algorithm is used. Only letters, digits, and special characters (_-!@#$%+/=) are allowed. It must start with a letter, digit, plus sign (+), or slash (/).

If not specified, the key will automatically generated. The auto-generation is only supported on first creation. Changing this will create a new resource.

Name string
Specifies the signature name.
The valid length is limited from 3 to 64, only English letters, Chinese characters, digits and underscores (_) are allowed. The name must start with an English letter or Chinese character.
Region string
Specifies the region where the signature is located.
If omitted, the provider-level region will be used. Changing this will create a new resource.
Secret string
Specifies the signature secret.
If not specified, the secret will automatically generated. The auto-generation is only supported on first creation. Changing this will create a new resource.
Type string

Specifies the type of signature.
The valid values are as follows:

  • basic: Basic auth type.
  • hmac: HMAC type.
  • aes: AES type

Changing this will create a new resource.

UpdatedAt string
The latest update time of the signature.
Algorithm string

Specifies the signature algorithm.
This parameter is required and only available when signature type is aes. The valid values are as follows:

  • aes-128-cfb
  • aes-256-cfb

Changing this will create a new resource.

ApigSignatureId string
The ID of the signature.
CreatedAt string
The creation time of the signature.
InstanceId string
Specifies the ID of the dedicated instance to which the signature belongs. Changing this will create a new resource.
Key string

Specifies the signature key.

  • For basic type: The value contains 4 to 32 characters, including letters, digits, underscores (_) and hyphens (-). It must start with a letter.
  • For hmac type: The value contains 8 to 32 characters, including letters, digits, underscores (_) and hyphens (-). It must start with a letter or digit.
  • For aes type: The value contains 16 characters if the aes-128-cfb algorithm is used, or 32 characters if the aes-256-cfb algorithm is used. Only letters, digits, and special characters (_-!@#$%+/=) are allowed. It must start with a letter, digit, plus sign (+), or slash (/).

If not specified, the key will automatically generated. The auto-generation is only supported on first creation. Changing this will create a new resource.

Name string
Specifies the signature name.
The valid length is limited from 3 to 64, only English letters, Chinese characters, digits and underscores (_) are allowed. The name must start with an English letter or Chinese character.
Region string
Specifies the region where the signature is located.
If omitted, the provider-level region will be used. Changing this will create a new resource.
Secret string
Specifies the signature secret.
If not specified, the secret will automatically generated. The auto-generation is only supported on first creation. Changing this will create a new resource.
Type string

Specifies the type of signature.
The valid values are as follows:

  • basic: Basic auth type.
  • hmac: HMAC type.
  • aes: AES type

Changing this will create a new resource.

UpdatedAt string
The latest update time of the signature.
algorithm String

Specifies the signature algorithm.
This parameter is required and only available when signature type is aes. The valid values are as follows:

  • aes-128-cfb
  • aes-256-cfb

Changing this will create a new resource.

apigSignatureId String
The ID of the signature.
createdAt String
The creation time of the signature.
instanceId String
Specifies the ID of the dedicated instance to which the signature belongs. Changing this will create a new resource.
key String

Specifies the signature key.

  • For basic type: The value contains 4 to 32 characters, including letters, digits, underscores (_) and hyphens (-). It must start with a letter.
  • For hmac type: The value contains 8 to 32 characters, including letters, digits, underscores (_) and hyphens (-). It must start with a letter or digit.
  • For aes type: The value contains 16 characters if the aes-128-cfb algorithm is used, or 32 characters if the aes-256-cfb algorithm is used. Only letters, digits, and special characters (_-!@#$%+/=) are allowed. It must start with a letter, digit, plus sign (+), or slash (/).

If not specified, the key will automatically generated. The auto-generation is only supported on first creation. Changing this will create a new resource.

name String
Specifies the signature name.
The valid length is limited from 3 to 64, only English letters, Chinese characters, digits and underscores (_) are allowed. The name must start with an English letter or Chinese character.
region String
Specifies the region where the signature is located.
If omitted, the provider-level region will be used. Changing this will create a new resource.
secret String
Specifies the signature secret.
If not specified, the secret will automatically generated. The auto-generation is only supported on first creation. Changing this will create a new resource.
type String

Specifies the type of signature.
The valid values are as follows:

  • basic: Basic auth type.
  • hmac: HMAC type.
  • aes: AES type

Changing this will create a new resource.

updatedAt String
The latest update time of the signature.
algorithm string

Specifies the signature algorithm.
This parameter is required and only available when signature type is aes. The valid values are as follows:

  • aes-128-cfb
  • aes-256-cfb

Changing this will create a new resource.

apigSignatureId string
The ID of the signature.
createdAt string
The creation time of the signature.
instanceId string
Specifies the ID of the dedicated instance to which the signature belongs. Changing this will create a new resource.
key string

Specifies the signature key.

  • For basic type: The value contains 4 to 32 characters, including letters, digits, underscores (_) and hyphens (-). It must start with a letter.
  • For hmac type: The value contains 8 to 32 characters, including letters, digits, underscores (_) and hyphens (-). It must start with a letter or digit.
  • For aes type: The value contains 16 characters if the aes-128-cfb algorithm is used, or 32 characters if the aes-256-cfb algorithm is used. Only letters, digits, and special characters (_-!@#$%+/=) are allowed. It must start with a letter, digit, plus sign (+), or slash (/).

If not specified, the key will automatically generated. The auto-generation is only supported on first creation. Changing this will create a new resource.

name string
Specifies the signature name.
The valid length is limited from 3 to 64, only English letters, Chinese characters, digits and underscores (_) are allowed. The name must start with an English letter or Chinese character.
region string
Specifies the region where the signature is located.
If omitted, the provider-level region will be used. Changing this will create a new resource.
secret string
Specifies the signature secret.
If not specified, the secret will automatically generated. The auto-generation is only supported on first creation. Changing this will create a new resource.
type string

Specifies the type of signature.
The valid values are as follows:

  • basic: Basic auth type.
  • hmac: HMAC type.
  • aes: AES type

Changing this will create a new resource.

updatedAt string
The latest update time of the signature.
algorithm str

Specifies the signature algorithm.
This parameter is required and only available when signature type is aes. The valid values are as follows:

  • aes-128-cfb
  • aes-256-cfb

Changing this will create a new resource.

apig_signature_id str
The ID of the signature.
created_at str
The creation time of the signature.
instance_id str
Specifies the ID of the dedicated instance to which the signature belongs. Changing this will create a new resource.
key str

Specifies the signature key.

  • For basic type: The value contains 4 to 32 characters, including letters, digits, underscores (_) and hyphens (-). It must start with a letter.
  • For hmac type: The value contains 8 to 32 characters, including letters, digits, underscores (_) and hyphens (-). It must start with a letter or digit.
  • For aes type: The value contains 16 characters if the aes-128-cfb algorithm is used, or 32 characters if the aes-256-cfb algorithm is used. Only letters, digits, and special characters (_-!@#$%+/=) are allowed. It must start with a letter, digit, plus sign (+), or slash (/).

If not specified, the key will automatically generated. The auto-generation is only supported on first creation. Changing this will create a new resource.

name str
Specifies the signature name.
The valid length is limited from 3 to 64, only English letters, Chinese characters, digits and underscores (_) are allowed. The name must start with an English letter or Chinese character.
region str
Specifies the region where the signature is located.
If omitted, the provider-level region will be used. Changing this will create a new resource.
secret str
Specifies the signature secret.
If not specified, the secret will automatically generated. The auto-generation is only supported on first creation. Changing this will create a new resource.
type str

Specifies the type of signature.
The valid values are as follows:

  • basic: Basic auth type.
  • hmac: HMAC type.
  • aes: AES type

Changing this will create a new resource.

updated_at str
The latest update time of the signature.
algorithm String

Specifies the signature algorithm.
This parameter is required and only available when signature type is aes. The valid values are as follows:

  • aes-128-cfb
  • aes-256-cfb

Changing this will create a new resource.

apigSignatureId String
The ID of the signature.
createdAt String
The creation time of the signature.
instanceId String
Specifies the ID of the dedicated instance to which the signature belongs. Changing this will create a new resource.
key String

Specifies the signature key.

  • For basic type: The value contains 4 to 32 characters, including letters, digits, underscores (_) and hyphens (-). It must start with a letter.
  • For hmac type: The value contains 8 to 32 characters, including letters, digits, underscores (_) and hyphens (-). It must start with a letter or digit.
  • For aes type: The value contains 16 characters if the aes-128-cfb algorithm is used, or 32 characters if the aes-256-cfb algorithm is used. Only letters, digits, and special characters (_-!@#$%+/=) are allowed. It must start with a letter, digit, plus sign (+), or slash (/).

If not specified, the key will automatically generated. The auto-generation is only supported on first creation. Changing this will create a new resource.

name String
Specifies the signature name.
The valid length is limited from 3 to 64, only English letters, Chinese characters, digits and underscores (_) are allowed. The name must start with an English letter or Chinese character.
region String
Specifies the region where the signature is located.
If omitted, the provider-level region will be used. Changing this will create a new resource.
secret String
Specifies the signature secret.
If not specified, the secret will automatically generated. The auto-generation is only supported on first creation. Changing this will create a new resource.
type String

Specifies the type of signature.
The valid values are as follows:

  • basic: Basic auth type.
  • hmac: HMAC type.
  • aes: AES type

Changing this will create a new resource.

updatedAt String
The latest update time of the signature.

Import

Signatures can be imported using their id and related dedicated instance ID, separated by a slash, e.g.

bash

$ pulumi import flexibleengine:index/apigSignature:ApigSignature test <instance_id>/<id>
Copy

To learn more about importing existing cloud resources, see Importing resources.

Package Details

Repository
flexibleengine flexibleenginecloud/terraform-provider-flexibleengine
License
Notes
This Pulumi package is based on the flexibleengine Terraform Provider.