alicloud.apigateway.AppAttachment
Explore with Pulumi AI
Example Usage
Basic Usage
import * as pulumi from "@pulumi/pulumi";
import * as alicloud from "@pulumi/alicloud";
const config = new pulumi.Config();
const name = config.get("name") || "terraform_example";
const example = new alicloud.apigateway.Group("example", {
name: name,
description: name,
});
const exampleApi = new alicloud.apigateway.Api("example", {
groupId: example.id,
name: name,
description: name,
authType: "APP",
forceNonceCheck: false,
requestConfig: {
protocol: "HTTP",
method: "GET",
path: "/example/path",
mode: "MAPPING",
},
serviceType: "HTTP",
httpServiceConfig: {
address: "http://apigateway-backend.alicloudapi.com:8080",
method: "GET",
path: "/web/cloudapi",
timeout: 12,
aoneName: "cloudapi-openapi",
},
requestParameters: [{
name: "example",
type: "STRING",
required: "OPTIONAL",
"in": "QUERY",
inService: "QUERY",
nameService: "exampleservice",
}],
stageNames: [
"RELEASE",
"TEST",
],
});
const exampleApp = new alicloud.apigateway.App("example", {
name: name,
description: name,
});
const exampleAppAttachment = new alicloud.apigateway.AppAttachment("example", {
apiId: exampleApi.apiId,
groupId: example.id,
appId: exampleApp.id,
stageName: "PRE",
});
import pulumi
import pulumi_alicloud as alicloud
config = pulumi.Config()
name = config.get("name")
if name is None:
name = "terraform_example"
example = alicloud.apigateway.Group("example",
name=name,
description=name)
example_api = alicloud.apigateway.Api("example",
group_id=example.id,
name=name,
description=name,
auth_type="APP",
force_nonce_check=False,
request_config={
"protocol": "HTTP",
"method": "GET",
"path": "/example/path",
"mode": "MAPPING",
},
service_type="HTTP",
http_service_config={
"address": "http://apigateway-backend.alicloudapi.com:8080",
"method": "GET",
"path": "/web/cloudapi",
"timeout": 12,
"aone_name": "cloudapi-openapi",
},
request_parameters=[{
"name": "example",
"type": "STRING",
"required": "OPTIONAL",
"in_": "QUERY",
"in_service": "QUERY",
"name_service": "exampleservice",
}],
stage_names=[
"RELEASE",
"TEST",
])
example_app = alicloud.apigateway.App("example",
name=name,
description=name)
example_app_attachment = alicloud.apigateway.AppAttachment("example",
api_id=example_api.api_id,
group_id=example.id,
app_id=example_app.id,
stage_name="PRE")
package main
import (
"github.com/pulumi/pulumi-alicloud/sdk/v3/go/alicloud/apigateway"
"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, "")
name := "terraform_example"
if param := cfg.Get("name"); param != "" {
name = param
}
example, err := apigateway.NewGroup(ctx, "example", &apigateway.GroupArgs{
Name: pulumi.String(name),
Description: pulumi.String(name),
})
if err != nil {
return err
}
exampleApi, err := apigateway.NewApi(ctx, "example", &apigateway.ApiArgs{
GroupId: example.ID(),
Name: pulumi.String(name),
Description: pulumi.String(name),
AuthType: pulumi.String("APP"),
ForceNonceCheck: pulumi.Bool(false),
RequestConfig: &apigateway.ApiRequestConfigArgs{
Protocol: pulumi.String("HTTP"),
Method: pulumi.String("GET"),
Path: pulumi.String("/example/path"),
Mode: pulumi.String("MAPPING"),
},
ServiceType: pulumi.String("HTTP"),
HttpServiceConfig: &apigateway.ApiHttpServiceConfigArgs{
Address: pulumi.String("http://apigateway-backend.alicloudapi.com:8080"),
Method: pulumi.String("GET"),
Path: pulumi.String("/web/cloudapi"),
Timeout: pulumi.Int(12),
AoneName: pulumi.String("cloudapi-openapi"),
},
RequestParameters: apigateway.ApiRequestParameterArray{
&apigateway.ApiRequestParameterArgs{
Name: pulumi.String("example"),
Type: pulumi.String("STRING"),
Required: pulumi.String("OPTIONAL"),
In: pulumi.String("QUERY"),
InService: pulumi.String("QUERY"),
NameService: pulumi.String("exampleservice"),
},
},
StageNames: pulumi.StringArray{
pulumi.String("RELEASE"),
pulumi.String("TEST"),
},
})
if err != nil {
return err
}
exampleApp, err := apigateway.NewApp(ctx, "example", &apigateway.AppArgs{
Name: pulumi.String(name),
Description: pulumi.String(name),
})
if err != nil {
return err
}
_, err = apigateway.NewAppAttachment(ctx, "example", &apigateway.AppAttachmentArgs{
ApiId: exampleApi.ApiId,
GroupId: example.ID(),
AppId: exampleApp.ID(),
StageName: pulumi.String("PRE"),
})
if err != nil {
return err
}
return nil
})
}
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using AliCloud = Pulumi.AliCloud;
return await Deployment.RunAsync(() =>
{
var config = new Config();
var name = config.Get("name") ?? "terraform_example";
var example = new AliCloud.ApiGateway.Group("example", new()
{
Name = name,
Description = name,
});
var exampleApi = new AliCloud.ApiGateway.Api("example", new()
{
GroupId = example.Id,
Name = name,
Description = name,
AuthType = "APP",
ForceNonceCheck = false,
RequestConfig = new AliCloud.ApiGateway.Inputs.ApiRequestConfigArgs
{
Protocol = "HTTP",
Method = "GET",
Path = "/example/path",
Mode = "MAPPING",
},
ServiceType = "HTTP",
HttpServiceConfig = new AliCloud.ApiGateway.Inputs.ApiHttpServiceConfigArgs
{
Address = "http://apigateway-backend.alicloudapi.com:8080",
Method = "GET",
Path = "/web/cloudapi",
Timeout = 12,
AoneName = "cloudapi-openapi",
},
RequestParameters = new[]
{
new AliCloud.ApiGateway.Inputs.ApiRequestParameterArgs
{
Name = "example",
Type = "STRING",
Required = "OPTIONAL",
In = "QUERY",
InService = "QUERY",
NameService = "exampleservice",
},
},
StageNames = new[]
{
"RELEASE",
"TEST",
},
});
var exampleApp = new AliCloud.ApiGateway.App("example", new()
{
Name = name,
Description = name,
});
var exampleAppAttachment = new AliCloud.ApiGateway.AppAttachment("example", new()
{
ApiId = exampleApi.ApiId,
GroupId = example.Id,
AppId = exampleApp.Id,
StageName = "PRE",
});
});
package generated_program;
import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.alicloud.apigateway.Group;
import com.pulumi.alicloud.apigateway.GroupArgs;
import com.pulumi.alicloud.apigateway.Api;
import com.pulumi.alicloud.apigateway.ApiArgs;
import com.pulumi.alicloud.apigateway.inputs.ApiRequestConfigArgs;
import com.pulumi.alicloud.apigateway.inputs.ApiHttpServiceConfigArgs;
import com.pulumi.alicloud.apigateway.inputs.ApiRequestParameterArgs;
import com.pulumi.alicloud.apigateway.App;
import com.pulumi.alicloud.apigateway.AppArgs;
import com.pulumi.alicloud.apigateway.AppAttachment;
import com.pulumi.alicloud.apigateway.AppAttachmentArgs;
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 name = config.get("name").orElse("terraform_example");
var example = new Group("example", GroupArgs.builder()
.name(name)
.description(name)
.build());
var exampleApi = new Api("exampleApi", ApiArgs.builder()
.groupId(example.id())
.name(name)
.description(name)
.authType("APP")
.forceNonceCheck(false)
.requestConfig(ApiRequestConfigArgs.builder()
.protocol("HTTP")
.method("GET")
.path("/example/path")
.mode("MAPPING")
.build())
.serviceType("HTTP")
.httpServiceConfig(ApiHttpServiceConfigArgs.builder()
.address("http://apigateway-backend.alicloudapi.com:8080")
.method("GET")
.path("/web/cloudapi")
.timeout(12)
.aoneName("cloudapi-openapi")
.build())
.requestParameters(ApiRequestParameterArgs.builder()
.name("example")
.type("STRING")
.required("OPTIONAL")
.in("QUERY")
.inService("QUERY")
.nameService("exampleservice")
.build())
.stageNames(
"RELEASE",
"TEST")
.build());
var exampleApp = new App("exampleApp", AppArgs.builder()
.name(name)
.description(name)
.build());
var exampleAppAttachment = new AppAttachment("exampleAppAttachment", AppAttachmentArgs.builder()
.apiId(exampleApi.apiId())
.groupId(example.id())
.appId(exampleApp.id())
.stageName("PRE")
.build());
}
}
configuration:
name:
type: string
default: terraform_example
resources:
example:
type: alicloud:apigateway:Group
properties:
name: ${name}
description: ${name}
exampleApi:
type: alicloud:apigateway:Api
name: example
properties:
groupId: ${example.id}
name: ${name}
description: ${name}
authType: APP
forceNonceCheck: false
requestConfig:
protocol: HTTP
method: GET
path: /example/path
mode: MAPPING
serviceType: HTTP
httpServiceConfig:
address: http://apigateway-backend.alicloudapi.com:8080
method: GET
path: /web/cloudapi
timeout: 12
aoneName: cloudapi-openapi
requestParameters:
- name: example
type: STRING
required: OPTIONAL
in: QUERY
inService: QUERY
nameService: exampleservice
stageNames:
- RELEASE
- TEST
exampleApp:
type: alicloud:apigateway:App
name: example
properties:
name: ${name}
description: ${name}
exampleAppAttachment:
type: alicloud:apigateway:AppAttachment
name: example
properties:
apiId: ${exampleApi.apiId}
groupId: ${example.id}
appId: ${exampleApp.id}
stageName: PRE
Create AppAttachment Resource
Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.
Constructor syntax
new AppAttachment(name: string, args: AppAttachmentArgs, opts?: CustomResourceOptions);
@overload
def AppAttachment(resource_name: str,
args: AppAttachmentArgs,
opts: Optional[ResourceOptions] = None)
@overload
def AppAttachment(resource_name: str,
opts: Optional[ResourceOptions] = None,
api_id: Optional[str] = None,
app_id: Optional[str] = None,
group_id: Optional[str] = None,
stage_name: Optional[str] = None)
func NewAppAttachment(ctx *Context, name string, args AppAttachmentArgs, opts ...ResourceOption) (*AppAttachment, error)
public AppAttachment(string name, AppAttachmentArgs args, CustomResourceOptions? opts = null)
public AppAttachment(String name, AppAttachmentArgs args)
public AppAttachment(String name, AppAttachmentArgs args, CustomResourceOptions options)
type: alicloud:apigateway:AppAttachment
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. AppAttachmentArgs - 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. AppAttachmentArgs - 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. AppAttachmentArgs - 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. AppAttachmentArgs - 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. AppAttachmentArgs - 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 appAttachmentResource = new AliCloud.ApiGateway.AppAttachment("appAttachmentResource", new()
{
ApiId = "string",
AppId = "string",
GroupId = "string",
StageName = "string",
});
example, err := apigateway.NewAppAttachment(ctx, "appAttachmentResource", &apigateway.AppAttachmentArgs{
ApiId: pulumi.String("string"),
AppId: pulumi.String("string"),
GroupId: pulumi.String("string"),
StageName: pulumi.String("string"),
})
var appAttachmentResource = new AppAttachment("appAttachmentResource", AppAttachmentArgs.builder()
.apiId("string")
.appId("string")
.groupId("string")
.stageName("string")
.build());
app_attachment_resource = alicloud.apigateway.AppAttachment("appAttachmentResource",
api_id="string",
app_id="string",
group_id="string",
stage_name="string")
const appAttachmentResource = new alicloud.apigateway.AppAttachment("appAttachmentResource", {
apiId: "string",
appId: "string",
groupId: "string",
stageName: "string",
});
type: alicloud:apigateway:AppAttachment
properties:
apiId: string
appId: string
groupId: string
stageName: string
AppAttachment 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 AppAttachment resource accepts the following input properties:
- Api
Id This property is required. Changes to this property will trigger replacement.
- The api_id that app apply to access.
- App
Id This property is required. Changes to this property will trigger replacement.
- The app that apply to the authorization.
- Group
Id This property is required. Changes to this property will trigger replacement.
- The group that the api belongs to.
- Stage
Name This property is required. Changes to this property will trigger replacement.
- Stage that the app apply to access.
- Api
Id This property is required. Changes to this property will trigger replacement.
- The api_id that app apply to access.
- App
Id This property is required. Changes to this property will trigger replacement.
- The app that apply to the authorization.
- Group
Id This property is required. Changes to this property will trigger replacement.
- The group that the api belongs to.
- Stage
Name This property is required. Changes to this property will trigger replacement.
- Stage that the app apply to access.
- api
Id This property is required. Changes to this property will trigger replacement.
- The api_id that app apply to access.
- app
Id This property is required. Changes to this property will trigger replacement.
- The app that apply to the authorization.
- group
Id This property is required. Changes to this property will trigger replacement.
- The group that the api belongs to.
- stage
Name This property is required. Changes to this property will trigger replacement.
- Stage that the app apply to access.
- api
Id This property is required. Changes to this property will trigger replacement.
- The api_id that app apply to access.
- app
Id This property is required. Changes to this property will trigger replacement.
- The app that apply to the authorization.
- group
Id This property is required. Changes to this property will trigger replacement.
- The group that the api belongs to.
- stage
Name This property is required. Changes to this property will trigger replacement.
- Stage that the app apply to access.
- api_
id This property is required. Changes to this property will trigger replacement.
- The api_id that app apply to access.
- app_
id This property is required. Changes to this property will trigger replacement.
- The app that apply to the authorization.
- group_
id This property is required. Changes to this property will trigger replacement.
- The group that the api belongs to.
- stage_
name This property is required. Changes to this property will trigger replacement.
- Stage that the app apply to access.
- api
Id This property is required. Changes to this property will trigger replacement.
- The api_id that app apply to access.
- app
Id This property is required. Changes to this property will trigger replacement.
- The app that apply to the authorization.
- group
Id This property is required. Changes to this property will trigger replacement.
- The group that the api belongs to.
- stage
Name This property is required. Changes to this property will trigger replacement.
- Stage that the app apply to access.
Outputs
All input properties are implicitly available as output properties. Additionally, the AppAttachment 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 AppAttachment Resource
Get an existing AppAttachment 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?: AppAttachmentState, opts?: CustomResourceOptions): AppAttachment
@staticmethod
def get(resource_name: str,
id: str,
opts: Optional[ResourceOptions] = None,
api_id: Optional[str] = None,
app_id: Optional[str] = None,
group_id: Optional[str] = None,
stage_name: Optional[str] = None) -> AppAttachment
func GetAppAttachment(ctx *Context, name string, id IDInput, state *AppAttachmentState, opts ...ResourceOption) (*AppAttachment, error)
public static AppAttachment Get(string name, Input<string> id, AppAttachmentState? state, CustomResourceOptions? opts = null)
public static AppAttachment get(String name, Output<String> id, AppAttachmentState state, CustomResourceOptions options)
resources: _: type: alicloud:apigateway:AppAttachment 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.
- Api
Id Changes to this property will trigger replacement.
- The api_id that app apply to access.
- App
Id Changes to this property will trigger replacement.
- The app that apply to the authorization.
- Group
Id Changes to this property will trigger replacement.
- The group that the api belongs to.
- Stage
Name Changes to this property will trigger replacement.
- Stage that the app apply to access.
- Api
Id Changes to this property will trigger replacement.
- The api_id that app apply to access.
- App
Id Changes to this property will trigger replacement.
- The app that apply to the authorization.
- Group
Id Changes to this property will trigger replacement.
- The group that the api belongs to.
- Stage
Name Changes to this property will trigger replacement.
- Stage that the app apply to access.
- api
Id Changes to this property will trigger replacement.
- The api_id that app apply to access.
- app
Id Changes to this property will trigger replacement.
- The app that apply to the authorization.
- group
Id Changes to this property will trigger replacement.
- The group that the api belongs to.
- stage
Name Changes to this property will trigger replacement.
- Stage that the app apply to access.
- api
Id Changes to this property will trigger replacement.
- The api_id that app apply to access.
- app
Id Changes to this property will trigger replacement.
- The app that apply to the authorization.
- group
Id Changes to this property will trigger replacement.
- The group that the api belongs to.
- stage
Name Changes to this property will trigger replacement.
- Stage that the app apply to access.
- api_
id Changes to this property will trigger replacement.
- The api_id that app apply to access.
- app_
id Changes to this property will trigger replacement.
- The app that apply to the authorization.
- group_
id Changes to this property will trigger replacement.
- The group that the api belongs to.
- stage_
name Changes to this property will trigger replacement.
- Stage that the app apply to access.
- api
Id Changes to this property will trigger replacement.
- The api_id that app apply to access.
- app
Id Changes to this property will trigger replacement.
- The app that apply to the authorization.
- group
Id Changes to this property will trigger replacement.
- The group that the api belongs to.
- stage
Name Changes to this property will trigger replacement.
- Stage that the app apply to access.
Package Details
- Repository
- Alibaba Cloud pulumi/pulumi-alicloud
- License
- Apache-2.0
- Notes
- This Pulumi package is based on the
alicloud
Terraform Provider.