1. Packages
  2. Opentelekomcloud Provider
  3. API Docs
  4. ApigwSignatureV2
opentelekomcloud 1.36.37 published on Thursday, Apr 24, 2025 by opentelekomcloud

opentelekomcloud.ApigwSignatureV2

Explore with Pulumi AI

opentelekomcloud logo
opentelekomcloud 1.36.37 published on Thursday, Apr 24, 2025 by opentelekomcloud

    Up-to-date reference of API arguments for API Gateway signature service you can get at documentation portal

    Manages a signature resource within OpenTelekomCloud.

    Example Usage

    Create a signature of the HMAC type

    Coming soon!
    
    Coming soon!
    
    Coming soon!
    
    Coming soon!
    
    Coming soon!
    
    configuration:
      gatewayId:
        type: dynamic
      signatureName:
        type: dynamic
      signatureKey:
        type: dynamic
      signatureSecret:
        type: dynamic
    resources:
      hmac:
        type: opentelekomcloud:ApigwSignatureV2
        properties:
          instanceId: ${gatewayId}
          type: hmac
          key: ${signatureKey}
          secret: ${signatureSecret}
    

    Create a signature and automatically generate key and secret

    Coming soon!
    
    Coming soon!
    
    Coming soon!
    
    Coming soon!
    
    Coming soon!
    
    configuration:
      gatewayId:
        type: dynamic
      signatureName:
        type: dynamic
    resources:
      hmac:
        type: opentelekomcloud:ApigwSignatureV2
        properties:
          instanceId: ${gatewayId}
          type: hmac
    

    Create a signature of the AES type

    Coming soon!
    
    Coming soon!
    
    Coming soon!
    
    Coming soon!
    
    Coming soon!
    
    configuration:
      gatewayId:
        type: dynamic
      signatureName:
        type: dynamic
      signatureKey:
        type: dynamic
      signatureSecret:
        type: dynamic
    resources:
      aes:
        type: opentelekomcloud:ApigwSignatureV2
        properties:
          instanceId: ${gatewayId}
          type: aes
          algorithm: aes-128-cfb
          key: ${signatureKey}
          secret: ${signatureSecret}
    

    Create ApigwSignatureV2 Resource

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

    Constructor syntax

    new ApigwSignatureV2(name: string, args: ApigwSignatureV2Args, opts?: CustomResourceOptions);
    @overload
    def ApigwSignatureV2(resource_name: str,
                         args: ApigwSignatureV2Args,
                         opts: Optional[ResourceOptions] = None)
    
    @overload
    def ApigwSignatureV2(resource_name: str,
                         opts: Optional[ResourceOptions] = None,
                         gateway_id: Optional[str] = None,
                         type: Optional[str] = None,
                         algorithm: Optional[str] = None,
                         apigw_signature_v2_id: Optional[str] = None,
                         key: Optional[str] = None,
                         name: Optional[str] = None,
                         secret: Optional[str] = None)
    func NewApigwSignatureV2(ctx *Context, name string, args ApigwSignatureV2Args, opts ...ResourceOption) (*ApigwSignatureV2, error)
    public ApigwSignatureV2(string name, ApigwSignatureV2Args args, CustomResourceOptions? opts = null)
    public ApigwSignatureV2(String name, ApigwSignatureV2Args args)
    public ApigwSignatureV2(String name, ApigwSignatureV2Args args, CustomResourceOptions options)
    
    type: opentelekomcloud:ApigwSignatureV2
    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 ApigwSignatureV2Args
    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 ApigwSignatureV2Args
    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 ApigwSignatureV2Args
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args ApigwSignatureV2Args
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args ApigwSignatureV2Args
    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 apigwSignatureV2Resource = new Opentelekomcloud.ApigwSignatureV2("apigwSignatureV2Resource", new()
    {
        GatewayId = "string",
        Type = "string",
        Algorithm = "string",
        ApigwSignatureV2Id = "string",
        Key = "string",
        Name = "string",
        Secret = "string",
    });
    
    example, err := opentelekomcloud.NewApigwSignatureV2(ctx, "apigwSignatureV2Resource", &opentelekomcloud.ApigwSignatureV2Args{
    	GatewayId:          pulumi.String("string"),
    	Type:               pulumi.String("string"),
    	Algorithm:          pulumi.String("string"),
    	ApigwSignatureV2Id: pulumi.String("string"),
    	Key:                pulumi.String("string"),
    	Name:               pulumi.String("string"),
    	Secret:             pulumi.String("string"),
    })
    
    var apigwSignatureV2Resource = new ApigwSignatureV2("apigwSignatureV2Resource", ApigwSignatureV2Args.builder()
        .gatewayId("string")
        .type("string")
        .algorithm("string")
        .apigwSignatureV2Id("string")
        .key("string")
        .name("string")
        .secret("string")
        .build());
    
    apigw_signature_v2_resource = opentelekomcloud.ApigwSignatureV2("apigwSignatureV2Resource",
        gateway_id="string",
        type="string",
        algorithm="string",
        apigw_signature_v2_id="string",
        key="string",
        name="string",
        secret="string")
    
    const apigwSignatureV2Resource = new opentelekomcloud.ApigwSignatureV2("apigwSignatureV2Resource", {
        gatewayId: "string",
        type: "string",
        algorithm: "string",
        apigwSignatureV2Id: "string",
        key: "string",
        name: "string",
        secret: "string",
    });
    
    type: opentelekomcloud:ApigwSignatureV2
    properties:
        algorithm: string
        apigwSignatureV2Id: string
        gatewayId: string
        key: string
        name: string
        secret: string
        type: string
    

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

    GatewayId string
    Specifies the ID of the dedicated gateway to which the signature belongs. Changing this will create a new resource.
    Type string
    Specifies the type of signature. The valid values are as follows:
    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.
    ApigwSignatureV2Id 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.
    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.

    • For basic type: The value contains 8 to 64 characters. Letters, digits, and special characters _-!@#$% are allowed. It must start with a letter or digit. If not specified, a value is automatically generated.
    • For hmac type: The value contains 16 to 64 characters. Letters, digits, and special characters _-!@#$% are allowed. It must start with a letter or digit. If not specified, a value is automatically generated.
    • For aes type: The value contains 16 characters, including letters, digits, and special characters _-!@#$%+/=. It must start with a letter, digit, plus sign +, or slash /. If not specified, a value is automatically generated.
    GatewayId string
    Specifies the ID of the dedicated gateway to which the signature belongs. Changing this will create a new resource.
    Type string
    Specifies the type of signature. The valid values are as follows:
    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.
    ApigwSignatureV2Id 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.
    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.

    • For basic type: The value contains 8 to 64 characters. Letters, digits, and special characters _-!@#$% are allowed. It must start with a letter or digit. If not specified, a value is automatically generated.
    • For hmac type: The value contains 16 to 64 characters. Letters, digits, and special characters _-!@#$% are allowed. It must start with a letter or digit. If not specified, a value is automatically generated.
    • For aes type: The value contains 16 characters, including letters, digits, and special characters _-!@#$%+/=. It must start with a letter, digit, plus sign +, or slash /. If not specified, a value is automatically generated.
    gatewayId String
    Specifies the ID of the dedicated gateway to which the signature belongs. Changing this will create a new resource.
    type String
    Specifies the type of signature. The valid values are as follows:
    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.
    apigwSignatureV2Id 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.
    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.

    • For basic type: The value contains 8 to 64 characters. Letters, digits, and special characters _-!@#$% are allowed. It must start with a letter or digit. If not specified, a value is automatically generated.
    • For hmac type: The value contains 16 to 64 characters. Letters, digits, and special characters _-!@#$% are allowed. It must start with a letter or digit. If not specified, a value is automatically generated.
    • For aes type: The value contains 16 characters, including letters, digits, and special characters _-!@#$%+/=. It must start with a letter, digit, plus sign +, or slash /. If not specified, a value is automatically generated.
    gatewayId string
    Specifies the ID of the dedicated gateway to which the signature belongs. Changing this will create a new resource.
    type string
    Specifies the type of signature. The valid values are as follows:
    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.
    apigwSignatureV2Id 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.
    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.

    • For basic type: The value contains 8 to 64 characters. Letters, digits, and special characters _-!@#$% are allowed. It must start with a letter or digit. If not specified, a value is automatically generated.
    • For hmac type: The value contains 16 to 64 characters. Letters, digits, and special characters _-!@#$% are allowed. It must start with a letter or digit. If not specified, a value is automatically generated.
    • For aes type: The value contains 16 characters, including letters, digits, and special characters _-!@#$%+/=. It must start with a letter, digit, plus sign +, or slash /. If not specified, a value is automatically generated.
    gateway_id str
    Specifies the ID of the dedicated gateway to which the signature belongs. Changing this will create a new resource.
    type str
    Specifies the type of signature. The valid values are as follows:
    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.
    apigw_signature_v2_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.
    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.

    • For basic type: The value contains 8 to 64 characters. Letters, digits, and special characters _-!@#$% are allowed. It must start with a letter or digit. If not specified, a value is automatically generated.
    • For hmac type: The value contains 16 to 64 characters. Letters, digits, and special characters _-!@#$% are allowed. It must start with a letter or digit. If not specified, a value is automatically generated.
    • For aes type: The value contains 16 characters, including letters, digits, and special characters _-!@#$%+/=. It must start with a letter, digit, plus sign +, or slash /. If not specified, a value is automatically generated.
    gatewayId String
    Specifies the ID of the dedicated gateway to which the signature belongs. Changing this will create a new resource.
    type String
    Specifies the type of signature. The valid values are as follows:
    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.
    apigwSignatureV2Id 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.
    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.

    • For basic type: The value contains 8 to 64 characters. Letters, digits, and special characters _-!@#$% are allowed. It must start with a letter or digit. If not specified, a value is automatically generated.
    • For hmac type: The value contains 16 to 64 characters. Letters, digits, and special characters _-!@#$% are allowed. It must start with a letter or digit. If not specified, a value is automatically generated.
    • For aes type: The value contains 16 characters, including letters, digits, and special characters _-!@#$%+/=. It must start with a letter, digit, plus sign +, or slash /. If not specified, a value is automatically generated.

    Outputs

    All input properties are implicitly available as output properties. Additionally, the ApigwSignatureV2 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.
    Region string
    Region where the signature is located.
    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.
    Region string
    Region where the signature is located.
    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.
    region String
    Region where the signature is located.
    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.
    region string
    Region where the signature is located.
    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.
    region str
    Region where the signature is located.
    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.
    region String
    Region where the signature is located.
    updatedAt String
    The latest update time of the signature.

    Look up Existing ApigwSignatureV2 Resource

    Get an existing ApigwSignatureV2 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?: ApigwSignatureV2State, opts?: CustomResourceOptions): ApigwSignatureV2
    @staticmethod
    def get(resource_name: str,
            id: str,
            opts: Optional[ResourceOptions] = None,
            algorithm: Optional[str] = None,
            apigw_signature_v2_id: Optional[str] = None,
            created_at: Optional[str] = None,
            gateway_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) -> ApigwSignatureV2
    func GetApigwSignatureV2(ctx *Context, name string, id IDInput, state *ApigwSignatureV2State, opts ...ResourceOption) (*ApigwSignatureV2, error)
    public static ApigwSignatureV2 Get(string name, Input<string> id, ApigwSignatureV2State? state, CustomResourceOptions? opts = null)
    public static ApigwSignatureV2 get(String name, Output<String> id, ApigwSignatureV2State state, CustomResourceOptions options)
    resources:  _:    type: opentelekomcloud:ApigwSignatureV2    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:
    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.
    ApigwSignatureV2Id string
    The ID of the signature.
    CreatedAt string
    The creation time of the signature.
    GatewayId string
    Specifies the ID of the dedicated gateway 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
    Region where the signature is located.
    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.

    • For basic type: The value contains 8 to 64 characters. Letters, digits, and special characters _-!@#$% are allowed. It must start with a letter or digit. If not specified, a value is automatically generated.
    • For hmac type: The value contains 16 to 64 characters. Letters, digits, and special characters _-!@#$% are allowed. It must start with a letter or digit. If not specified, a value is automatically generated.
    • For aes type: The value contains 16 characters, including letters, digits, and special characters _-!@#$%+/=. It must start with a letter, digit, plus sign +, or slash /. If not specified, a value is automatically generated.
    Type string
    Specifies the type of signature. The valid values are as follows:
    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.
    ApigwSignatureV2Id string
    The ID of the signature.
    CreatedAt string
    The creation time of the signature.
    GatewayId string
    Specifies the ID of the dedicated gateway 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
    Region where the signature is located.
    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.

    • For basic type: The value contains 8 to 64 characters. Letters, digits, and special characters _-!@#$% are allowed. It must start with a letter or digit. If not specified, a value is automatically generated.
    • For hmac type: The value contains 16 to 64 characters. Letters, digits, and special characters _-!@#$% are allowed. It must start with a letter or digit. If not specified, a value is automatically generated.
    • For aes type: The value contains 16 characters, including letters, digits, and special characters _-!@#$%+/=. It must start with a letter, digit, plus sign +, or slash /. If not specified, a value is automatically generated.
    Type string
    Specifies the type of signature. The valid values are as follows:
    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.
    apigwSignatureV2Id String
    The ID of the signature.
    createdAt String
    The creation time of the signature.
    gatewayId String
    Specifies the ID of the dedicated gateway 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
    Region where the signature is located.
    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.

    • For basic type: The value contains 8 to 64 characters. Letters, digits, and special characters _-!@#$% are allowed. It must start with a letter or digit. If not specified, a value is automatically generated.
    • For hmac type: The value contains 16 to 64 characters. Letters, digits, and special characters _-!@#$% are allowed. It must start with a letter or digit. If not specified, a value is automatically generated.
    • For aes type: The value contains 16 characters, including letters, digits, and special characters _-!@#$%+/=. It must start with a letter, digit, plus sign +, or slash /. If not specified, a value is automatically generated.
    type String
    Specifies the type of signature. The valid values are as follows:
    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.
    apigwSignatureV2Id string
    The ID of the signature.
    createdAt string
    The creation time of the signature.
    gatewayId string
    Specifies the ID of the dedicated gateway 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
    Region where the signature is located.
    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.

    • For basic type: The value contains 8 to 64 characters. Letters, digits, and special characters _-!@#$% are allowed. It must start with a letter or digit. If not specified, a value is automatically generated.
    • For hmac type: The value contains 16 to 64 characters. Letters, digits, and special characters _-!@#$% are allowed. It must start with a letter or digit. If not specified, a value is automatically generated.
    • For aes type: The value contains 16 characters, including letters, digits, and special characters _-!@#$%+/=. It must start with a letter, digit, plus sign +, or slash /. If not specified, a value is automatically generated.
    type string
    Specifies the type of signature. The valid values are as follows:
    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.
    apigw_signature_v2_id str
    The ID of the signature.
    created_at str
    The creation time of the signature.
    gateway_id str
    Specifies the ID of the dedicated gateway 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
    Region where the signature is located.
    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.

    • For basic type: The value contains 8 to 64 characters. Letters, digits, and special characters _-!@#$% are allowed. It must start with a letter or digit. If not specified, a value is automatically generated.
    • For hmac type: The value contains 16 to 64 characters. Letters, digits, and special characters _-!@#$% are allowed. It must start with a letter or digit. If not specified, a value is automatically generated.
    • For aes type: The value contains 16 characters, including letters, digits, and special characters _-!@#$%+/=. It must start with a letter, digit, plus sign +, or slash /. If not specified, a value is automatically generated.
    type str
    Specifies the type of signature. The valid values are as follows:
    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.
    apigwSignatureV2Id String
    The ID of the signature.
    createdAt String
    The creation time of the signature.
    gatewayId String
    Specifies the ID of the dedicated gateway 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
    Region where the signature is located.
    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.

    • For basic type: The value contains 8 to 64 characters. Letters, digits, and special characters _-!@#$% are allowed. It must start with a letter or digit. If not specified, a value is automatically generated.
    • For hmac type: The value contains 16 to 64 characters. Letters, digits, and special characters _-!@#$% are allowed. It must start with a letter or digit. If not specified, a value is automatically generated.
    • For aes type: The value contains 16 characters, including letters, digits, and special characters _-!@#$%+/=. It must start with a letter, digit, plus sign +, or slash /. If not specified, a value is automatically generated.
    type String
    Specifies the type of signature. The valid values are as follows:
    updatedAt String
    The latest update time of the signature.

    Import

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

    bash

    $ pulumi import opentelekomcloud:index/apigwSignatureV2:ApigwSignatureV2 sig <gateway_id>/<id>
    

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

    Package Details

    Repository
    opentelekomcloud opentelekomcloud/terraform-provider-opentelekomcloud
    License
    Notes
    This Pulumi package is based on the opentelekomcloud Terraform Provider.
    opentelekomcloud logo
    opentelekomcloud 1.36.37 published on Thursday, Apr 24, 2025 by opentelekomcloud