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

opentelekomcloud.ApigwSignatureAssociateV2

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 associate service you can get at documentation portal

    Use this resource to bind the APIs to the signature within OpenTelekomCloud.

    A signature can only create one opentelekomcloud.ApigwSignatureAssociateV2 resource. And a published ID for API can only bind a signature.

    Example Usage

    Coming soon!
    
    Coming soon!
    
    Coming soon!
    
    Coming soon!
    
    Coming soon!
    
    configuration:
      gatewayId:
        type: dynamic
      signatureId:
        type: dynamic
      apiPublishIds:
        type: list(string)
    resources:
      test:
        type: opentelekomcloud:ApigwSignatureAssociateV2
        properties:
          instanceId: ${gatewayId}
          signatureId: ${signatureId}
          publishIds: ${apiPublishIds}
    

    Create ApigwSignatureAssociateV2 Resource

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

    Constructor syntax

    new ApigwSignatureAssociateV2(name: string, args: ApigwSignatureAssociateV2Args, opts?: CustomResourceOptions);
    @overload
    def ApigwSignatureAssociateV2(resource_name: str,
                                  args: ApigwSignatureAssociateV2Args,
                                  opts: Optional[ResourceOptions] = None)
    
    @overload
    def ApigwSignatureAssociateV2(resource_name: str,
                                  opts: Optional[ResourceOptions] = None,
                                  gateway_id: Optional[str] = None,
                                  publish_ids: Optional[Sequence[str]] = None,
                                  signature_id: Optional[str] = None,
                                  apigw_signature_associate_v2_id: Optional[str] = None,
                                  timeouts: Optional[ApigwSignatureAssociateV2TimeoutsArgs] = None)
    func NewApigwSignatureAssociateV2(ctx *Context, name string, args ApigwSignatureAssociateV2Args, opts ...ResourceOption) (*ApigwSignatureAssociateV2, error)
    public ApigwSignatureAssociateV2(string name, ApigwSignatureAssociateV2Args args, CustomResourceOptions? opts = null)
    public ApigwSignatureAssociateV2(String name, ApigwSignatureAssociateV2Args args)
    public ApigwSignatureAssociateV2(String name, ApigwSignatureAssociateV2Args args, CustomResourceOptions options)
    
    type: opentelekomcloud:ApigwSignatureAssociateV2
    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 ApigwSignatureAssociateV2Args
    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 ApigwSignatureAssociateV2Args
    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 ApigwSignatureAssociateV2Args
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args ApigwSignatureAssociateV2Args
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args ApigwSignatureAssociateV2Args
    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 apigwSignatureAssociateV2Resource = new Opentelekomcloud.ApigwSignatureAssociateV2("apigwSignatureAssociateV2Resource", new()
    {
        GatewayId = "string",
        PublishIds = new[]
        {
            "string",
        },
        SignatureId = "string",
        ApigwSignatureAssociateV2Id = "string",
        Timeouts = new Opentelekomcloud.Inputs.ApigwSignatureAssociateV2TimeoutsArgs
        {
            Create = "string",
            Delete = "string",
            Update = "string",
        },
    });
    
    example, err := opentelekomcloud.NewApigwSignatureAssociateV2(ctx, "apigwSignatureAssociateV2Resource", &opentelekomcloud.ApigwSignatureAssociateV2Args{
    	GatewayId: pulumi.String("string"),
    	PublishIds: pulumi.StringArray{
    		pulumi.String("string"),
    	},
    	SignatureId:                 pulumi.String("string"),
    	ApigwSignatureAssociateV2Id: pulumi.String("string"),
    	Timeouts: &opentelekomcloud.ApigwSignatureAssociateV2TimeoutsArgs{
    		Create: pulumi.String("string"),
    		Delete: pulumi.String("string"),
    		Update: pulumi.String("string"),
    	},
    })
    
    var apigwSignatureAssociateV2Resource = new ApigwSignatureAssociateV2("apigwSignatureAssociateV2Resource", ApigwSignatureAssociateV2Args.builder()
        .gatewayId("string")
        .publishIds("string")
        .signatureId("string")
        .apigwSignatureAssociateV2Id("string")
        .timeouts(ApigwSignatureAssociateV2TimeoutsArgs.builder()
            .create("string")
            .delete("string")
            .update("string")
            .build())
        .build());
    
    apigw_signature_associate_v2_resource = opentelekomcloud.ApigwSignatureAssociateV2("apigwSignatureAssociateV2Resource",
        gateway_id="string",
        publish_ids=["string"],
        signature_id="string",
        apigw_signature_associate_v2_id="string",
        timeouts={
            "create": "string",
            "delete": "string",
            "update": "string",
        })
    
    const apigwSignatureAssociateV2Resource = new opentelekomcloud.ApigwSignatureAssociateV2("apigwSignatureAssociateV2Resource", {
        gatewayId: "string",
        publishIds: ["string"],
        signatureId: "string",
        apigwSignatureAssociateV2Id: "string",
        timeouts: {
            create: "string",
            "delete": "string",
            update: "string",
        },
    });
    
    type: opentelekomcloud:ApigwSignatureAssociateV2
    properties:
        apigwSignatureAssociateV2Id: string
        gatewayId: string
        publishIds:
            - string
        signatureId: string
        timeouts:
            create: string
            delete: string
            update: string
    

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

    GatewayId string
    Specifies the ID of the dedicated instance to which the APIs and the signature belong. Changing this will create a new resource.
    PublishIds List<string>
    Specifies the publish IDs corresponding to the APIs bound by the signature.
    SignatureId string
    Specifies the signature ID for APIs binding. Changing this will create a new resource.
    ApigwSignatureAssociateV2Id string
    Resource ID. The format is <gateway_id>/<signature_id>.
    Timeouts ApigwSignatureAssociateV2Timeouts
    GatewayId string
    Specifies the ID of the dedicated instance to which the APIs and the signature belong. Changing this will create a new resource.
    PublishIds []string
    Specifies the publish IDs corresponding to the APIs bound by the signature.
    SignatureId string
    Specifies the signature ID for APIs binding. Changing this will create a new resource.
    ApigwSignatureAssociateV2Id string
    Resource ID. The format is <gateway_id>/<signature_id>.
    Timeouts ApigwSignatureAssociateV2TimeoutsArgs
    gatewayId String
    Specifies the ID of the dedicated instance to which the APIs and the signature belong. Changing this will create a new resource.
    publishIds List<String>
    Specifies the publish IDs corresponding to the APIs bound by the signature.
    signatureId String
    Specifies the signature ID for APIs binding. Changing this will create a new resource.
    apigwSignatureAssociateV2Id String
    Resource ID. The format is <gateway_id>/<signature_id>.
    timeouts ApigwSignatureAssociateV2Timeouts
    gatewayId string
    Specifies the ID of the dedicated instance to which the APIs and the signature belong. Changing this will create a new resource.
    publishIds string[]
    Specifies the publish IDs corresponding to the APIs bound by the signature.
    signatureId string
    Specifies the signature ID for APIs binding. Changing this will create a new resource.
    apigwSignatureAssociateV2Id string
    Resource ID. The format is <gateway_id>/<signature_id>.
    timeouts ApigwSignatureAssociateV2Timeouts
    gateway_id str
    Specifies the ID of the dedicated instance to which the APIs and the signature belong. Changing this will create a new resource.
    publish_ids Sequence[str]
    Specifies the publish IDs corresponding to the APIs bound by the signature.
    signature_id str
    Specifies the signature ID for APIs binding. Changing this will create a new resource.
    apigw_signature_associate_v2_id str
    Resource ID. The format is <gateway_id>/<signature_id>.
    timeouts ApigwSignatureAssociateV2TimeoutsArgs
    gatewayId String
    Specifies the ID of the dedicated instance to which the APIs and the signature belong. Changing this will create a new resource.
    publishIds List<String>
    Specifies the publish IDs corresponding to the APIs bound by the signature.
    signatureId String
    Specifies the signature ID for APIs binding. Changing this will create a new resource.
    apigwSignatureAssociateV2Id String
    Resource ID. The format is <gateway_id>/<signature_id>.
    timeouts Property Map

    Outputs

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

    Id string
    The provider-assigned unique ID for this managed resource.
    Region string
    Region where the signature and the APIs are located.
    Id string
    The provider-assigned unique ID for this managed resource.
    Region string
    Region where the signature and the APIs are located.
    id String
    The provider-assigned unique ID for this managed resource.
    region String
    Region where the signature and the APIs are located.
    id string
    The provider-assigned unique ID for this managed resource.
    region string
    Region where the signature and the APIs are located.
    id str
    The provider-assigned unique ID for this managed resource.
    region str
    Region where the signature and the APIs are located.
    id String
    The provider-assigned unique ID for this managed resource.
    region String
    Region where the signature and the APIs are located.

    Look up Existing ApigwSignatureAssociateV2 Resource

    Get an existing ApigwSignatureAssociateV2 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?: ApigwSignatureAssociateV2State, opts?: CustomResourceOptions): ApigwSignatureAssociateV2
    @staticmethod
    def get(resource_name: str,
            id: str,
            opts: Optional[ResourceOptions] = None,
            apigw_signature_associate_v2_id: Optional[str] = None,
            gateway_id: Optional[str] = None,
            publish_ids: Optional[Sequence[str]] = None,
            region: Optional[str] = None,
            signature_id: Optional[str] = None,
            timeouts: Optional[ApigwSignatureAssociateV2TimeoutsArgs] = None) -> ApigwSignatureAssociateV2
    func GetApigwSignatureAssociateV2(ctx *Context, name string, id IDInput, state *ApigwSignatureAssociateV2State, opts ...ResourceOption) (*ApigwSignatureAssociateV2, error)
    public static ApigwSignatureAssociateV2 Get(string name, Input<string> id, ApigwSignatureAssociateV2State? state, CustomResourceOptions? opts = null)
    public static ApigwSignatureAssociateV2 get(String name, Output<String> id, ApigwSignatureAssociateV2State state, CustomResourceOptions options)
    resources:  _:    type: opentelekomcloud:ApigwSignatureAssociateV2    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:
    ApigwSignatureAssociateV2Id string
    Resource ID. The format is <gateway_id>/<signature_id>.
    GatewayId string
    Specifies the ID of the dedicated instance to which the APIs and the signature belong. Changing this will create a new resource.
    PublishIds List<string>
    Specifies the publish IDs corresponding to the APIs bound by the signature.
    Region string
    Region where the signature and the APIs are located.
    SignatureId string
    Specifies the signature ID for APIs binding. Changing this will create a new resource.
    Timeouts ApigwSignatureAssociateV2Timeouts
    ApigwSignatureAssociateV2Id string
    Resource ID. The format is <gateway_id>/<signature_id>.
    GatewayId string
    Specifies the ID of the dedicated instance to which the APIs and the signature belong. Changing this will create a new resource.
    PublishIds []string
    Specifies the publish IDs corresponding to the APIs bound by the signature.
    Region string
    Region where the signature and the APIs are located.
    SignatureId string
    Specifies the signature ID for APIs binding. Changing this will create a new resource.
    Timeouts ApigwSignatureAssociateV2TimeoutsArgs
    apigwSignatureAssociateV2Id String
    Resource ID. The format is <gateway_id>/<signature_id>.
    gatewayId String
    Specifies the ID of the dedicated instance to which the APIs and the signature belong. Changing this will create a new resource.
    publishIds List<String>
    Specifies the publish IDs corresponding to the APIs bound by the signature.
    region String
    Region where the signature and the APIs are located.
    signatureId String
    Specifies the signature ID for APIs binding. Changing this will create a new resource.
    timeouts ApigwSignatureAssociateV2Timeouts
    apigwSignatureAssociateV2Id string
    Resource ID. The format is <gateway_id>/<signature_id>.
    gatewayId string
    Specifies the ID of the dedicated instance to which the APIs and the signature belong. Changing this will create a new resource.
    publishIds string[]
    Specifies the publish IDs corresponding to the APIs bound by the signature.
    region string
    Region where the signature and the APIs are located.
    signatureId string
    Specifies the signature ID for APIs binding. Changing this will create a new resource.
    timeouts ApigwSignatureAssociateV2Timeouts
    apigw_signature_associate_v2_id str
    Resource ID. The format is <gateway_id>/<signature_id>.
    gateway_id str
    Specifies the ID of the dedicated instance to which the APIs and the signature belong. Changing this will create a new resource.
    publish_ids Sequence[str]
    Specifies the publish IDs corresponding to the APIs bound by the signature.
    region str
    Region where the signature and the APIs are located.
    signature_id str
    Specifies the signature ID for APIs binding. Changing this will create a new resource.
    timeouts ApigwSignatureAssociateV2TimeoutsArgs
    apigwSignatureAssociateV2Id String
    Resource ID. The format is <gateway_id>/<signature_id>.
    gatewayId String
    Specifies the ID of the dedicated instance to which the APIs and the signature belong. Changing this will create a new resource.
    publishIds List<String>
    Specifies the publish IDs corresponding to the APIs bound by the signature.
    region String
    Region where the signature and the APIs are located.
    signatureId String
    Specifies the signature ID for APIs binding. Changing this will create a new resource.
    timeouts Property Map

    Supporting Types

    ApigwSignatureAssociateV2Timeouts, ApigwSignatureAssociateV2TimeoutsArgs

    Create string
    Delete string
    Update string
    Create string
    Delete string
    Update string
    create String
    delete String
    update String
    create string
    delete string
    update string
    create str
    delete str
    update str
    create String
    delete String
    update String

    Import

    Associate resources can be imported using their signature_id and the APIGW dedicated gateway ID to which the signature

    belongs, separated by a slash, e.g.

    bash

    $ pulumi import opentelekomcloud:index/apigwSignatureAssociateV2:ApigwSignatureAssociateV2 test <gateway_id>/<signature_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