Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi Cloud Packages Tutorials
  1. Packages
  2. Flexibleengine Provider
  3. API Docs
  4. ApigSignatureAssociate
flexibleengine 1.46.0 published on Monday, Apr 14, 2025 by flexibleenginecloud
flexibleenginecloud/terraform-provider-flexibleengine

flexibleengine.ApigSignatureAssociate

Explore with Pulumi AI

flexibleengine logo
flexibleengine 1.46.0 published on Monday, Apr 14, 2025 by flexibleenginecloud
flexibleenginecloud/terraform-provider-flexibleengine

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

    A signature can only create one flexibleengine.ApigSignatureAssociate resource. And a published ID for API can only bind a signature.

    Example Usage

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

const config = new pulumi.Config();
const instanceId = config.requireObject("instanceId");
const signatureId = config.requireObject("signatureId");
const apiPublishIds = config.requireObject<Array<string>>("apiPublishIds");
const test = new flexibleengine.ApigSignatureAssociate("test", {
    instanceId: instanceId,
    signatureId: signatureId,
    publishIds: apiPublishIds,
});

    import pulumi
import pulumi_flexibleengine as flexibleengine

config = pulumi.Config()
instance_id = config.require_object("instanceId")
signature_id = config.require_object("signatureId")
api_publish_ids = config.require_object("apiPublishIds")
test = flexibleengine.ApigSignatureAssociate("test",
    instance_id=instance_id,
    signature_id=signature_id,
    publish_ids=api_publish_ids)

    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")
		signatureId := cfg.RequireObject("signatureId")
		apiPublishIds := cfg.Require("apiPublishIds")
		_, err := flexibleengine.NewApigSignatureAssociate(ctx, "test", &flexibleengine.ApigSignatureAssociateArgs{
			InstanceId:  pulumi.Any(instanceId),
			SignatureId: pulumi.Any(signatureId),
			PublishIds:  apiPublishIds,
		})
		if err != nil {
			return err
		}
		return nil
	})
}

    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 signatureId = config.RequireObject<dynamic>("signatureId");
    var apiPublishIds = config.RequireObject<string[]>("apiPublishIds");
    var test = new Flexibleengine.ApigSignatureAssociate("test", new()
    {
        InstanceId = instanceId,
        SignatureId = signatureId,
        PublishIds = apiPublishIds,
    });

});

    package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.flexibleengine.ApigSignatureAssociate;
import com.pulumi.flexibleengine.ApigSignatureAssociateArgs;
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 signatureId = config.get("signatureId");
        final var apiPublishIds = config.get("apiPublishIds");
        var test = new ApigSignatureAssociate("test", ApigSignatureAssociateArgs.builder()
            .instanceId(instanceId)
            .signatureId(signatureId)
            .publishIds(apiPublishIds)
            .build());

    }
}

    configuration:
  instanceId:
    type: dynamic
  signatureId:
    type: dynamic
  apiPublishIds:
    type: list(string)
resources:
  test:
    type: flexibleengine:ApigSignatureAssociate
    properties:
      instanceId: ${instanceId}
      signatureId: ${signatureId}
      publishIds: ${apiPublishIds}

    Create ApigSignatureAssociate Resource

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

    Constructor syntax

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

@overload
def ApigSignatureAssociate(resource_name: str,
                           opts: Optional[ResourceOptions] = None,
                           instance_id: Optional[str] = None,
                           publish_ids: Optional[Sequence[str]] = None,
                           signature_id: Optional[str] = None,
                           apig_signature_associate_id: Optional[str] = None,
                           region: Optional[str] = None,
                           timeouts: Optional[ApigSignatureAssociateTimeoutsArgs] = None)
    func NewApigSignatureAssociate(ctx *Context, name string, args ApigSignatureAssociateArgs, opts ...ResourceOption) (*ApigSignatureAssociate, error)
    public ApigSignatureAssociate(string name, ApigSignatureAssociateArgs args, CustomResourceOptions? opts = null)
    public ApigSignatureAssociate(String name, ApigSignatureAssociateArgs args)
public ApigSignatureAssociate(String name, ApigSignatureAssociateArgs args, CustomResourceOptions options)

    type: flexibleengine:ApigSignatureAssociate
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 ApigSignatureAssociateArgs
    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 ApigSignatureAssociateArgs
    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 ApigSignatureAssociateArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args ApigSignatureAssociateArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args ApigSignatureAssociateArgs
    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 apigSignatureAssociateResource = new Flexibleengine.ApigSignatureAssociate("apigSignatureAssociateResource", new()
{
    InstanceId = "string",
    PublishIds = new[]
    {
        "string",
    },
    SignatureId = "string",
    ApigSignatureAssociateId = "string",
    Region = "string",
    Timeouts = new Flexibleengine.Inputs.ApigSignatureAssociateTimeoutsArgs
    {
        Create = "string",
        Delete = "string",
        Update = "string",
    },
});

    example, err := flexibleengine.NewApigSignatureAssociate(ctx, "apigSignatureAssociateResource", &flexibleengine.ApigSignatureAssociateArgs{
	InstanceId: pulumi.String("string"),
	PublishIds: pulumi.StringArray{
		pulumi.String("string"),
	},
	SignatureId:              pulumi.String("string"),
	ApigSignatureAssociateId: pulumi.String("string"),
	Region:                   pulumi.String("string"),
	Timeouts: &flexibleengine.ApigSignatureAssociateTimeoutsArgs{
		Create: pulumi.String("string"),
		Delete: pulumi.String("string"),
		Update: pulumi.String("string"),
	},
})

    var apigSignatureAssociateResource = new ApigSignatureAssociate("apigSignatureAssociateResource", ApigSignatureAssociateArgs.builder()
    .instanceId("string")
    .publishIds("string")
    .signatureId("string")
    .apigSignatureAssociateId("string")
    .region("string")
    .timeouts(ApigSignatureAssociateTimeoutsArgs.builder()
        .create("string")
        .delete("string")
        .update("string")
        .build())
    .build());

    apig_signature_associate_resource = flexibleengine.ApigSignatureAssociate("apigSignatureAssociateResource",
    instance_id="string",
    publish_ids=["string"],
    signature_id="string",
    apig_signature_associate_id="string",
    region="string",
    timeouts={
        "create": "string",
        "delete": "string",
        "update": "string",
    })

    const apigSignatureAssociateResource = new flexibleengine.ApigSignatureAssociate("apigSignatureAssociateResource", {
    instanceId: "string",
    publishIds: ["string"],
    signatureId: "string",
    apigSignatureAssociateId: "string",
    region: "string",
    timeouts: {
        create: "string",
        "delete": "string",
        update: "string",
    },
});

    type: flexibleengine:ApigSignatureAssociate
properties:
    apigSignatureAssociateId: string
    instanceId: string
    publishIds:
        - string
    region: string
    signatureId: string
    timeouts:
        create: string
        delete: string
        update: string

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

    InstanceId 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.
    ApigSignatureAssociateId string
    Resource ID. The format is <instance_id>/<signature_id>.
    Region string
    Specifies the region where the signature and the APIs are located.
    If omitted, the provider-level region will be used. Changing this will create a new resource.
    Timeouts ApigSignatureAssociateTimeouts
    InstanceId 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.
    ApigSignatureAssociateId string
    Resource ID. The format is <instance_id>/<signature_id>.
    Region string
    Specifies the region where the signature and the APIs are located.
    If omitted, the provider-level region will be used. Changing this will create a new resource.
    Timeouts ApigSignatureAssociateTimeoutsArgs
    instanceId 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.
    apigSignatureAssociateId String
    Resource ID. The format is <instance_id>/<signature_id>.
    region String
    Specifies the region where the signature and the APIs are located.
    If omitted, the provider-level region will be used. Changing this will create a new resource.
    timeouts ApigSignatureAssociateTimeouts
    instanceId 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.
    apigSignatureAssociateId string
    Resource ID. The format is <instance_id>/<signature_id>.
    region string
    Specifies the region where the signature and the APIs are located.
    If omitted, the provider-level region will be used. Changing this will create a new resource.
    timeouts ApigSignatureAssociateTimeouts
    instance_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.
    apig_signature_associate_id str
    Resource ID. The format is <instance_id>/<signature_id>.
    region str
    Specifies the region where the signature and the APIs are located.
    If omitted, the provider-level region will be used. Changing this will create a new resource.
    timeouts ApigSignatureAssociateTimeoutsArgs
    instanceId 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.
    apigSignatureAssociateId String
    Resource ID. The format is <instance_id>/<signature_id>.
    region String
    Specifies the region where the signature and the APIs are located.
    If omitted, the provider-level region will be used. Changing this will create a new resource.
    timeouts Property Map

    Outputs

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

    Id string
    The provider-assigned unique ID for this managed resource.
    Id string
    The provider-assigned unique ID for this managed resource.
    id String
    The provider-assigned unique ID for this managed resource.
    id string
    The provider-assigned unique ID for this managed resource.
    id str
    The provider-assigned unique ID for this managed resource.
    id String
    The provider-assigned unique ID for this managed resource.

    Look up Existing ApigSignatureAssociate Resource

    Get an existing ApigSignatureAssociate 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?: ApigSignatureAssociateState, opts?: CustomResourceOptions): ApigSignatureAssociate
    @staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        apig_signature_associate_id: Optional[str] = None,
        instance_id: Optional[str] = None,
        publish_ids: Optional[Sequence[str]] = None,
        region: Optional[str] = None,
        signature_id: Optional[str] = None,
        timeouts: Optional[ApigSignatureAssociateTimeoutsArgs] = None) -> ApigSignatureAssociate
    func GetApigSignatureAssociate(ctx *Context, name string, id IDInput, state *ApigSignatureAssociateState, opts ...ResourceOption) (*ApigSignatureAssociate, error)
    public static ApigSignatureAssociate Get(string name, Input<string> id, ApigSignatureAssociateState? state, CustomResourceOptions? opts = null)
    public static ApigSignatureAssociate get(String name, Output<String> id, ApigSignatureAssociateState state, CustomResourceOptions options)
    resources:  _:    type: flexibleengine:ApigSignatureAssociate    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:
    ApigSignatureAssociateId string
    Resource ID. The format is <instance_id>/<signature_id>.
    InstanceId 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
    Specifies the region where the signature and the APIs are located.
    If omitted, the provider-level region will be used. Changing this will create a new resource.
    SignatureId string
    Specifies the signature ID for APIs binding.
    Changing this will create a new resource.
    Timeouts ApigSignatureAssociateTimeouts
    ApigSignatureAssociateId string
    Resource ID. The format is <instance_id>/<signature_id>.
    InstanceId 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
    Specifies the region where the signature and the APIs are located.
    If omitted, the provider-level region will be used. Changing this will create a new resource.
    SignatureId string
    Specifies the signature ID for APIs binding.
    Changing this will create a new resource.
    Timeouts ApigSignatureAssociateTimeoutsArgs
    apigSignatureAssociateId String
    Resource ID. The format is <instance_id>/<signature_id>.
    instanceId 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
    Specifies the region where the signature and the APIs are located.
    If omitted, the provider-level region will be used. Changing this will create a new resource.
    signatureId String
    Specifies the signature ID for APIs binding.
    Changing this will create a new resource.
    timeouts ApigSignatureAssociateTimeouts
    apigSignatureAssociateId string
    Resource ID. The format is <instance_id>/<signature_id>.
    instanceId 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
    Specifies the region where the signature and the APIs are located.
    If omitted, the provider-level region will be used. Changing this will create a new resource.
    signatureId string
    Specifies the signature ID for APIs binding.
    Changing this will create a new resource.
    timeouts ApigSignatureAssociateTimeouts
    apig_signature_associate_id str
    Resource ID. The format is <instance_id>/<signature_id>.
    instance_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
    Specifies the region where the signature and the APIs are located.
    If omitted, the provider-level region will be used. Changing this will create a new resource.
    signature_id str
    Specifies the signature ID for APIs binding.
    Changing this will create a new resource.
    timeouts ApigSignatureAssociateTimeoutsArgs
    apigSignatureAssociateId String
    Resource ID. The format is <instance_id>/<signature_id>.
    instanceId 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
    Specifies the region where the signature and the APIs are located.
    If omitted, the provider-level region will be used. Changing this will create a new resource.
    signatureId String
    Specifies the signature ID for APIs binding.
    Changing this will create a new resource.
    timeouts Property Map

    Supporting Types

    ApigSignatureAssociateTimeouts, ApigSignatureAssociateTimeoutsArgs

    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 APIG dedicated instance ID to which the signature

    belongs, separated by a slash, e.g.

    bash

    $ pulumi import flexibleengine:index/apigSignatureAssociate:ApigSignatureAssociate test <instance_id>/<signature_id>

    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.
    flexibleengine logo
    flexibleengine 1.46.0 published on Monday, Apr 14, 2025 by flexibleenginecloud
    flexibleenginecloud/terraform-provider-flexibleengine