azure-native.awsconnector.ApiGatewayRestApi
Explore with Pulumi AI
A Microsoft.AwsConnector resource Azure REST API version: 2024-12-01.
Example Usage
ApiGatewayRestApis_CreateOrReplace
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using AzureNative = Pulumi.AzureNative;
return await Deployment.RunAsync(() => 
{
    var apiGatewayRestApi = new AzureNative.AwsConnector.ApiGatewayRestApi("apiGatewayRestApi", new()
    {
        Location = "lvqczthlir",
        Name = "Replace this value with a string matching RegExp ^(z=.{0,259}[^zs.]$)(z!.*[zzzzzzzz])",
        Properties = new AzureNative.AwsConnector.Inputs.ApiGatewayRestApiPropertiesArgs
        {
            Arn = "mjkvrfpgenxbfozh",
            AwsAccountId = "qjcvyhdegwhvzsiuqjwnvdqs",
            AwsProperties = new AzureNative.AwsConnector.Inputs.AwsApiGatewayRestApiPropertiesArgs
            {
                ApiKeySourceType = "f",
                BinaryMediaTypes = new[]
                {
                    "ahebgkheozatj",
                },
                Body = null,
                BodyS3Location = new AzureNative.AwsConnector.Inputs.S3LocationArgs
                {
                    Bucket = "oyosqpl",
                    ETag = "uuzlkbqlua",
                    Key = "nsks",
                    Version = "lxbmxdrsftqwazmgxlokuvf",
                },
                CloneFrom = "boxfqilij",
                Description = "ngqhnoniiohuwofr",
                DisableExecuteApiEndpoint = true,
                EndpointConfiguration = new AzureNative.AwsConnector.Inputs.EndpointConfigurationArgs
                {
                    Types = new[]
                    {
                        "dfhdcsvbasfadeuneaz",
                    },
                    VpcEndpointIds = new[]
                    {
                        "evzbafcpdpklwppge",
                    },
                },
                FailOnWarnings = true,
                MinimumCompressionSize = 11,
                Mode = "odjmjlcgkmskasrasoegyxnuqr",
                Name = "ioyxag",
                Parameters = 
                {
                    { "key9886", "kwxjcmpsfptfkdeajrzqt" },
                },
                Policy = "jefpbspvgtinulqfyjxuxcunzkpgvw",
                RestApiId = "hlyfcdcgknhbjezdxgbg",
                RootResourceId = "jfmgp",
                Tags = new[]
                {
                    new AzureNative.AwsConnector.Inputs.TagArgs
                    {
                        Key = "zvkbvzxmbhtugr",
                        Value = "uozcrgrc",
                    },
                },
            },
            AwsRegion = "bzj",
            AwsSourceSchema = "oagqktjiz",
            AwsTags = 
            {
                { "key5478", "g" },
            },
            PublicCloudConnectorsResourceId = "diszsfnljduoshvzzgcyypsjnxs",
            PublicCloudResourceName = "tvtpphxonsvnvtmccbpcsvvvslbxxc",
        },
        ResourceGroupName = "rgapiGatewayRestApi",
        Tags = 
        {
            { "key4163", "gqwufsfmbcznfkcfnjsejmna" },
        },
    });
});
package main
import (
	awsconnector "github.com/pulumi/pulumi-azure-native-sdk/awsconnector/v2"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)
func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := awsconnector.NewApiGatewayRestApi(ctx, "apiGatewayRestApi", &awsconnector.ApiGatewayRestApiArgs{
			Location: pulumi.String("lvqczthlir"),
			Name:     pulumi.String("Replace this value with a string matching RegExp ^(z=.{0,259}[^zs.]$)(z!.*[zzzzzzzz])"),
			Properties: &awsconnector.ApiGatewayRestApiPropertiesArgs{
				Arn:          pulumi.String("mjkvrfpgenxbfozh"),
				AwsAccountId: pulumi.String("qjcvyhdegwhvzsiuqjwnvdqs"),
				AwsProperties: &awsconnector.AwsApiGatewayRestApiPropertiesArgs{
					ApiKeySourceType: pulumi.String("f"),
					BinaryMediaTypes: pulumi.StringArray{
						pulumi.String("ahebgkheozatj"),
					},
					Body: pulumi.Any(map[string]interface{}{}),
					BodyS3Location: &awsconnector.S3LocationArgs{
						Bucket:  pulumi.String("oyosqpl"),
						ETag:    pulumi.String("uuzlkbqlua"),
						Key:     pulumi.String("nsks"),
						Version: pulumi.String("lxbmxdrsftqwazmgxlokuvf"),
					},
					CloneFrom:                 pulumi.String("boxfqilij"),
					Description:               pulumi.String("ngqhnoniiohuwofr"),
					DisableExecuteApiEndpoint: pulumi.Bool(true),
					EndpointConfiguration: &awsconnector.EndpointConfigurationArgs{
						Types: pulumi.StringArray{
							pulumi.String("dfhdcsvbasfadeuneaz"),
						},
						VpcEndpointIds: pulumi.StringArray{
							pulumi.String("evzbafcpdpklwppge"),
						},
					},
					FailOnWarnings:         pulumi.Bool(true),
					MinimumCompressionSize: pulumi.Int(11),
					Mode:                   pulumi.String("odjmjlcgkmskasrasoegyxnuqr"),
					Name:                   pulumi.String("ioyxag"),
					Parameters: pulumi.StringMap{
						"key9886": pulumi.String("kwxjcmpsfptfkdeajrzqt"),
					},
					Policy:         pulumi.String("jefpbspvgtinulqfyjxuxcunzkpgvw"),
					RestApiId:      pulumi.String("hlyfcdcgknhbjezdxgbg"),
					RootResourceId: pulumi.String("jfmgp"),
					Tags: awsconnector.TagArray{
						&awsconnector.TagArgs{
							Key:   pulumi.String("zvkbvzxmbhtugr"),
							Value: pulumi.String("uozcrgrc"),
						},
					},
				},
				AwsRegion:       pulumi.String("bzj"),
				AwsSourceSchema: pulumi.String("oagqktjiz"),
				AwsTags: pulumi.StringMap{
					"key5478": pulumi.String("g"),
				},
				PublicCloudConnectorsResourceId: pulumi.String("diszsfnljduoshvzzgcyypsjnxs"),
				PublicCloudResourceName:         pulumi.String("tvtpphxonsvnvtmccbpcsvvvslbxxc"),
			},
			ResourceGroupName: pulumi.String("rgapiGatewayRestApi"),
			Tags: pulumi.StringMap{
				"key4163": pulumi.String("gqwufsfmbcznfkcfnjsejmna"),
			},
		})
		if err != nil {
			return err
		}
		return nil
	})
}
package generated_program;
import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.azurenative.awsconnector.ApiGatewayRestApi;
import com.pulumi.azurenative.awsconnector.ApiGatewayRestApiArgs;
import com.pulumi.azurenative.awsconnector.inputs.ApiGatewayRestApiPropertiesArgs;
import com.pulumi.azurenative.awsconnector.inputs.AwsApiGatewayRestApiPropertiesArgs;
import com.pulumi.azurenative.awsconnector.inputs.S3LocationArgs;
import com.pulumi.azurenative.awsconnector.inputs.EndpointConfigurationArgs;
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) {
        var apiGatewayRestApi = new ApiGatewayRestApi("apiGatewayRestApi", ApiGatewayRestApiArgs.builder()
            .location("lvqczthlir")
            .name("Replace this value with a string matching RegExp ^(z=.{0,259}[^zs.]$)(z!.*[zzzzzzzz])")
            .properties(ApiGatewayRestApiPropertiesArgs.builder()
                .arn("mjkvrfpgenxbfozh")
                .awsAccountId("qjcvyhdegwhvzsiuqjwnvdqs")
                .awsProperties(AwsApiGatewayRestApiPropertiesArgs.builder()
                    .apiKeySourceType("f")
                    .binaryMediaTypes("ahebgkheozatj")
                    .body()
                    .bodyS3Location(S3LocationArgs.builder()
                        .bucket("oyosqpl")
                        .eTag("uuzlkbqlua")
                        .key("nsks")
                        .version("lxbmxdrsftqwazmgxlokuvf")
                        .build())
                    .cloneFrom("boxfqilij")
                    .description("ngqhnoniiohuwofr")
                    .disableExecuteApiEndpoint(true)
                    .endpointConfiguration(EndpointConfigurationArgs.builder()
                        .types("dfhdcsvbasfadeuneaz")
                        .vpcEndpointIds("evzbafcpdpklwppge")
                        .build())
                    .failOnWarnings(true)
                    .minimumCompressionSize(11)
                    .mode("odjmjlcgkmskasrasoegyxnuqr")
                    .name("ioyxag")
                    .parameters(Map.of("key9886", "kwxjcmpsfptfkdeajrzqt"))
                    .policy("jefpbspvgtinulqfyjxuxcunzkpgvw")
                    .restApiId("hlyfcdcgknhbjezdxgbg")
                    .rootResourceId("jfmgp")
                    .tags(TagArgs.builder()
                        .key("zvkbvzxmbhtugr")
                        .value("uozcrgrc")
                        .build())
                    .build())
                .awsRegion("bzj")
                .awsSourceSchema("oagqktjiz")
                .awsTags(Map.of("key5478", "g"))
                .publicCloudConnectorsResourceId("diszsfnljduoshvzzgcyypsjnxs")
                .publicCloudResourceName("tvtpphxonsvnvtmccbpcsvvvslbxxc")
                .build())
            .resourceGroupName("rgapiGatewayRestApi")
            .tags(Map.of("key4163", "gqwufsfmbcznfkcfnjsejmna"))
            .build());
    }
}
import * as pulumi from "@pulumi/pulumi";
import * as azure_native from "@pulumi/azure-native";
const apiGatewayRestApi = new azure_native.awsconnector.ApiGatewayRestApi("apiGatewayRestApi", {
    location: "lvqczthlir",
    name: "Replace this value with a string matching RegExp ^(z=.{0,259}[^zs.]$)(z!.*[zzzzzzzz])",
    properties: {
        arn: "mjkvrfpgenxbfozh",
        awsAccountId: "qjcvyhdegwhvzsiuqjwnvdqs",
        awsProperties: {
            apiKeySourceType: "f",
            binaryMediaTypes: ["ahebgkheozatj"],
            body: {},
            bodyS3Location: {
                bucket: "oyosqpl",
                eTag: "uuzlkbqlua",
                key: "nsks",
                version: "lxbmxdrsftqwazmgxlokuvf",
            },
            cloneFrom: "boxfqilij",
            description: "ngqhnoniiohuwofr",
            disableExecuteApiEndpoint: true,
            endpointConfiguration: {
                types: ["dfhdcsvbasfadeuneaz"],
                vpcEndpointIds: ["evzbafcpdpklwppge"],
            },
            failOnWarnings: true,
            minimumCompressionSize: 11,
            mode: "odjmjlcgkmskasrasoegyxnuqr",
            name: "ioyxag",
            parameters: {
                key9886: "kwxjcmpsfptfkdeajrzqt",
            },
            policy: "jefpbspvgtinulqfyjxuxcunzkpgvw",
            restApiId: "hlyfcdcgknhbjezdxgbg",
            rootResourceId: "jfmgp",
            tags: [{
                key: "zvkbvzxmbhtugr",
                value: "uozcrgrc",
            }],
        },
        awsRegion: "bzj",
        awsSourceSchema: "oagqktjiz",
        awsTags: {
            key5478: "g",
        },
        publicCloudConnectorsResourceId: "diszsfnljduoshvzzgcyypsjnxs",
        publicCloudResourceName: "tvtpphxonsvnvtmccbpcsvvvslbxxc",
    },
    resourceGroupName: "rgapiGatewayRestApi",
    tags: {
        key4163: "gqwufsfmbcznfkcfnjsejmna",
    },
});
import pulumi
import pulumi_azure_native as azure_native
api_gateway_rest_api = azure_native.awsconnector.ApiGatewayRestApi("apiGatewayRestApi",
    location="lvqczthlir",
    name="Replace this value with a string matching RegExp ^(z=.{0,259}[^zs.]$)(z!.*[zzzzzzzz])",
    properties={
        "arn": "mjkvrfpgenxbfozh",
        "aws_account_id": "qjcvyhdegwhvzsiuqjwnvdqs",
        "aws_properties": {
            "api_key_source_type": "f",
            "binary_media_types": ["ahebgkheozatj"],
            "body": {},
            "body_s3_location": {
                "bucket": "oyosqpl",
                "e_tag": "uuzlkbqlua",
                "key": "nsks",
                "version": "lxbmxdrsftqwazmgxlokuvf",
            },
            "clone_from": "boxfqilij",
            "description": "ngqhnoniiohuwofr",
            "disable_execute_api_endpoint": True,
            "endpoint_configuration": {
                "types": ["dfhdcsvbasfadeuneaz"],
                "vpc_endpoint_ids": ["evzbafcpdpklwppge"],
            },
            "fail_on_warnings": True,
            "minimum_compression_size": 11,
            "mode": "odjmjlcgkmskasrasoegyxnuqr",
            "name": "ioyxag",
            "parameters": {
                "key9886": "kwxjcmpsfptfkdeajrzqt",
            },
            "policy": "jefpbspvgtinulqfyjxuxcunzkpgvw",
            "rest_api_id": "hlyfcdcgknhbjezdxgbg",
            "root_resource_id": "jfmgp",
            "tags": [{
                "key": "zvkbvzxmbhtugr",
                "value": "uozcrgrc",
            }],
        },
        "aws_region": "bzj",
        "aws_source_schema": "oagqktjiz",
        "aws_tags": {
            "key5478": "g",
        },
        "public_cloud_connectors_resource_id": "diszsfnljduoshvzzgcyypsjnxs",
        "public_cloud_resource_name": "tvtpphxonsvnvtmccbpcsvvvslbxxc",
    },
    resource_group_name="rgapiGatewayRestApi",
    tags={
        "key4163": "gqwufsfmbcznfkcfnjsejmna",
    })
resources:
  apiGatewayRestApi:
    type: azure-native:awsconnector:ApiGatewayRestApi
    properties:
      location: lvqczthlir
      name: Replace this value with a string matching RegExp ^(z=.{0,259}[^zs.]$)(z!.*[zzzzzzzz])
      properties:
        arn: mjkvrfpgenxbfozh
        awsAccountId: qjcvyhdegwhvzsiuqjwnvdqs
        awsProperties:
          apiKeySourceType: f
          binaryMediaTypes:
            - ahebgkheozatj
          body: {}
          bodyS3Location:
            bucket: oyosqpl
            eTag: uuzlkbqlua
            key: nsks
            version: lxbmxdrsftqwazmgxlokuvf
          cloneFrom: boxfqilij
          description: ngqhnoniiohuwofr
          disableExecuteApiEndpoint: true
          endpointConfiguration:
            types:
              - dfhdcsvbasfadeuneaz
            vpcEndpointIds:
              - evzbafcpdpklwppge
          failOnWarnings: true
          minimumCompressionSize: 11
          mode: odjmjlcgkmskasrasoegyxnuqr
          name: ioyxag
          parameters:
            key9886: kwxjcmpsfptfkdeajrzqt
          policy: jefpbspvgtinulqfyjxuxcunzkpgvw
          restApiId: hlyfcdcgknhbjezdxgbg
          rootResourceId: jfmgp
          tags:
            - key: zvkbvzxmbhtugr
              value: uozcrgrc
        awsRegion: bzj
        awsSourceSchema: oagqktjiz
        awsTags:
          key5478: g
        publicCloudConnectorsResourceId: diszsfnljduoshvzzgcyypsjnxs
        publicCloudResourceName: tvtpphxonsvnvtmccbpcsvvvslbxxc
      resourceGroupName: rgapiGatewayRestApi
      tags:
        key4163: gqwufsfmbcznfkcfnjsejmna
Create ApiGatewayRestApi Resource
Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.
Constructor syntax
new ApiGatewayRestApi(name: string, args: ApiGatewayRestApiArgs, opts?: CustomResourceOptions);@overload
def ApiGatewayRestApi(resource_name: str,
                      args: ApiGatewayRestApiArgs,
                      opts: Optional[ResourceOptions] = None)
@overload
def ApiGatewayRestApi(resource_name: str,
                      opts: Optional[ResourceOptions] = None,
                      resource_group_name: Optional[str] = None,
                      location: Optional[str] = None,
                      name: Optional[str] = None,
                      properties: Optional[ApiGatewayRestApiPropertiesArgs] = None,
                      tags: Optional[Mapping[str, str]] = None)func NewApiGatewayRestApi(ctx *Context, name string, args ApiGatewayRestApiArgs, opts ...ResourceOption) (*ApiGatewayRestApi, error)public ApiGatewayRestApi(string name, ApiGatewayRestApiArgs args, CustomResourceOptions? opts = null)
public ApiGatewayRestApi(String name, ApiGatewayRestApiArgs args)
public ApiGatewayRestApi(String name, ApiGatewayRestApiArgs args, CustomResourceOptions options)
type: azure-native:awsconnector:ApiGatewayRestApi
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 ApiGatewayRestApiArgs
- 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 ApiGatewayRestApiArgs
- 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 ApiGatewayRestApiArgs
- The arguments to resource properties.
- opts ResourceOption
- Bag of options to control resource's behavior.
- name string
- The unique name of the resource.
- args ApiGatewayRestApiArgs
- The arguments to resource properties.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- name String
- The unique name of the resource.
- args ApiGatewayRestApiArgs
- 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 apiGatewayRestApiResource = new AzureNative.AwsConnector.ApiGatewayRestApi("apiGatewayRestApiResource", new()
{
    ResourceGroupName = "string",
    Location = "string",
    Name = "string",
    Properties = new AzureNative.AwsConnector.Inputs.ApiGatewayRestApiPropertiesArgs
    {
        Arn = "string",
        AwsAccountId = "string",
        AwsProperties = new AzureNative.AwsConnector.Inputs.AwsApiGatewayRestApiPropertiesArgs
        {
            ApiKeySourceType = "string",
            BinaryMediaTypes = new[]
            {
                "string",
            },
            Body = "any",
            BodyS3Location = new AzureNative.AwsConnector.Inputs.S3LocationArgs
            {
                Bucket = "string",
                ETag = "string",
                Key = "string",
                Version = "string",
            },
            CloneFrom = "string",
            Description = "string",
            DisableExecuteApiEndpoint = false,
            EndpointConfiguration = new AzureNative.AwsConnector.Inputs.EndpointConfigurationArgs
            {
                Types = new[]
                {
                    "string",
                },
                VpcEndpointIds = new[]
                {
                    "string",
                },
            },
            FailOnWarnings = false,
            MinimumCompressionSize = 0,
            Mode = "string",
            Name = "string",
            Parameters = 
            {
                { "string", "string" },
            },
            Policy = "string",
            RestApiId = "string",
            RootResourceId = "string",
            Tags = new[]
            {
                new AzureNative.AwsConnector.Inputs.TagArgs
                {
                    Key = "string",
                    Value = "string",
                },
            },
        },
        AwsRegion = "string",
        AwsSourceSchema = "string",
        AwsTags = 
        {
            { "string", "string" },
        },
        PublicCloudConnectorsResourceId = "string",
        PublicCloudResourceName = "string",
    },
    Tags = 
    {
        { "string", "string" },
    },
});
example, err := awsconnector.NewApiGatewayRestApi(ctx, "apiGatewayRestApiResource", &awsconnector.ApiGatewayRestApiArgs{
	ResourceGroupName: pulumi.String("string"),
	Location:          pulumi.String("string"),
	Name:              pulumi.String("string"),
	Properties: &awsconnector.ApiGatewayRestApiPropertiesArgs{
		Arn:          pulumi.String("string"),
		AwsAccountId: pulumi.String("string"),
		AwsProperties: &awsconnector.AwsApiGatewayRestApiPropertiesArgs{
			ApiKeySourceType: pulumi.String("string"),
			BinaryMediaTypes: pulumi.StringArray{
				pulumi.String("string"),
			},
			Body: pulumi.Any("any"),
			BodyS3Location: &awsconnector.S3LocationArgs{
				Bucket:  pulumi.String("string"),
				ETag:    pulumi.String("string"),
				Key:     pulumi.String("string"),
				Version: pulumi.String("string"),
			},
			CloneFrom:                 pulumi.String("string"),
			Description:               pulumi.String("string"),
			DisableExecuteApiEndpoint: pulumi.Bool(false),
			EndpointConfiguration: &awsconnector.EndpointConfigurationArgs{
				Types: pulumi.StringArray{
					pulumi.String("string"),
				},
				VpcEndpointIds: pulumi.StringArray{
					pulumi.String("string"),
				},
			},
			FailOnWarnings:         pulumi.Bool(false),
			MinimumCompressionSize: pulumi.Int(0),
			Mode:                   pulumi.String("string"),
			Name:                   pulumi.String("string"),
			Parameters: pulumi.StringMap{
				"string": pulumi.String("string"),
			},
			Policy:         pulumi.String("string"),
			RestApiId:      pulumi.String("string"),
			RootResourceId: pulumi.String("string"),
			Tags: awsconnector.TagArray{
				&awsconnector.TagArgs{
					Key:   pulumi.String("string"),
					Value: pulumi.String("string"),
				},
			},
		},
		AwsRegion:       pulumi.String("string"),
		AwsSourceSchema: pulumi.String("string"),
		AwsTags: pulumi.StringMap{
			"string": pulumi.String("string"),
		},
		PublicCloudConnectorsResourceId: pulumi.String("string"),
		PublicCloudResourceName:         pulumi.String("string"),
	},
	Tags: pulumi.StringMap{
		"string": pulumi.String("string"),
	},
})
var apiGatewayRestApiResource = new ApiGatewayRestApi("apiGatewayRestApiResource", ApiGatewayRestApiArgs.builder()
    .resourceGroupName("string")
    .location("string")
    .name("string")
    .properties(ApiGatewayRestApiPropertiesArgs.builder()
        .arn("string")
        .awsAccountId("string")
        .awsProperties(AwsApiGatewayRestApiPropertiesArgs.builder()
            .apiKeySourceType("string")
            .binaryMediaTypes("string")
            .body("any")
            .bodyS3Location(S3LocationArgs.builder()
                .bucket("string")
                .eTag("string")
                .key("string")
                .version("string")
                .build())
            .cloneFrom("string")
            .description("string")
            .disableExecuteApiEndpoint(false)
            .endpointConfiguration(EndpointConfigurationArgs.builder()
                .types("string")
                .vpcEndpointIds("string")
                .build())
            .failOnWarnings(false)
            .minimumCompressionSize(0)
            .mode("string")
            .name("string")
            .parameters(Map.of("string", "string"))
            .policy("string")
            .restApiId("string")
            .rootResourceId("string")
            .tags(TagArgs.builder()
                .key("string")
                .value("string")
                .build())
            .build())
        .awsRegion("string")
        .awsSourceSchema("string")
        .awsTags(Map.of("string", "string"))
        .publicCloudConnectorsResourceId("string")
        .publicCloudResourceName("string")
        .build())
    .tags(Map.of("string", "string"))
    .build());
api_gateway_rest_api_resource = azure_native.awsconnector.ApiGatewayRestApi("apiGatewayRestApiResource",
    resource_group_name="string",
    location="string",
    name="string",
    properties={
        "arn": "string",
        "aws_account_id": "string",
        "aws_properties": {
            "api_key_source_type": "string",
            "binary_media_types": ["string"],
            "body": "any",
            "body_s3_location": {
                "bucket": "string",
                "e_tag": "string",
                "key": "string",
                "version": "string",
            },
            "clone_from": "string",
            "description": "string",
            "disable_execute_api_endpoint": False,
            "endpoint_configuration": {
                "types": ["string"],
                "vpc_endpoint_ids": ["string"],
            },
            "fail_on_warnings": False,
            "minimum_compression_size": 0,
            "mode": "string",
            "name": "string",
            "parameters": {
                "string": "string",
            },
            "policy": "string",
            "rest_api_id": "string",
            "root_resource_id": "string",
            "tags": [{
                "key": "string",
                "value": "string",
            }],
        },
        "aws_region": "string",
        "aws_source_schema": "string",
        "aws_tags": {
            "string": "string",
        },
        "public_cloud_connectors_resource_id": "string",
        "public_cloud_resource_name": "string",
    },
    tags={
        "string": "string",
    })
const apiGatewayRestApiResource = new azure_native.awsconnector.ApiGatewayRestApi("apiGatewayRestApiResource", {
    resourceGroupName: "string",
    location: "string",
    name: "string",
    properties: {
        arn: "string",
        awsAccountId: "string",
        awsProperties: {
            apiKeySourceType: "string",
            binaryMediaTypes: ["string"],
            body: "any",
            bodyS3Location: {
                bucket: "string",
                eTag: "string",
                key: "string",
                version: "string",
            },
            cloneFrom: "string",
            description: "string",
            disableExecuteApiEndpoint: false,
            endpointConfiguration: {
                types: ["string"],
                vpcEndpointIds: ["string"],
            },
            failOnWarnings: false,
            minimumCompressionSize: 0,
            mode: "string",
            name: "string",
            parameters: {
                string: "string",
            },
            policy: "string",
            restApiId: "string",
            rootResourceId: "string",
            tags: [{
                key: "string",
                value: "string",
            }],
        },
        awsRegion: "string",
        awsSourceSchema: "string",
        awsTags: {
            string: "string",
        },
        publicCloudConnectorsResourceId: "string",
        publicCloudResourceName: "string",
    },
    tags: {
        string: "string",
    },
});
type: azure-native:awsconnector:ApiGatewayRestApi
properties:
    location: string
    name: string
    properties:
        arn: string
        awsAccountId: string
        awsProperties:
            apiKeySourceType: string
            binaryMediaTypes:
                - string
            body: any
            bodyS3Location:
                bucket: string
                eTag: string
                key: string
                version: string
            cloneFrom: string
            description: string
            disableExecuteApiEndpoint: false
            endpointConfiguration:
                types:
                    - string
                vpcEndpointIds:
                    - string
            failOnWarnings: false
            minimumCompressionSize: 0
            mode: string
            name: string
            parameters:
                string: string
            policy: string
            restApiId: string
            rootResourceId: string
            tags:
                - key: string
                  value: string
        awsRegion: string
        awsSourceSchema: string
        awsTags:
            string: string
        publicCloudConnectorsResourceId: string
        publicCloudResourceName: string
    resourceGroupName: string
    tags:
        string: string
ApiGatewayRestApi 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 ApiGatewayRestApi resource accepts the following input properties:
- ResourceGroup stringName 
- The name of the resource group. The name is case insensitive.
- Location string
- The geo-location where the resource lives
- Name string
- Name of ApiGatewayRestApi
- Properties
Pulumi.Azure Native. Aws Connector. Inputs. Api Gateway Rest Api Properties 
- The resource-specific properties for this resource.
- Dictionary<string, string>
- Resource tags.
- ResourceGroup stringName 
- The name of the resource group. The name is case insensitive.
- Location string
- The geo-location where the resource lives
- Name string
- Name of ApiGatewayRestApi
- Properties
ApiGateway Rest Api Properties Args 
- The resource-specific properties for this resource.
- map[string]string
- Resource tags.
- resourceGroup StringName 
- The name of the resource group. The name is case insensitive.
- location String
- The geo-location where the resource lives
- name String
- Name of ApiGatewayRestApi
- properties
ApiGateway Rest Api Properties 
- The resource-specific properties for this resource.
- Map<String,String>
- Resource tags.
- resourceGroup stringName 
- The name of the resource group. The name is case insensitive.
- location string
- The geo-location where the resource lives
- name string
- Name of ApiGatewayRestApi
- properties
ApiGateway Rest Api Properties 
- The resource-specific properties for this resource.
- {[key: string]: string}
- Resource tags.
- resource_group_ strname 
- The name of the resource group. The name is case insensitive.
- location str
- The geo-location where the resource lives
- name str
- Name of ApiGatewayRestApi
- properties
ApiGateway Rest Api Properties Args 
- The resource-specific properties for this resource.
- Mapping[str, str]
- Resource tags.
- resourceGroup StringName 
- The name of the resource group. The name is case insensitive.
- location String
- The geo-location where the resource lives
- name String
- Name of ApiGatewayRestApi
- properties Property Map
- The resource-specific properties for this resource.
- Map<String>
- Resource tags.
Outputs
All input properties are implicitly available as output properties. Additionally, the ApiGatewayRestApi resource produces the following output properties:
- Id string
- The provider-assigned unique ID for this managed resource.
- SystemData Pulumi.Azure Native. Aws Connector. Outputs. System Data Response 
- Azure Resource Manager metadata containing createdBy and modifiedBy information.
- Type string
- The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
- Id string
- The provider-assigned unique ID for this managed resource.
- SystemData SystemData Response 
- Azure Resource Manager metadata containing createdBy and modifiedBy information.
- Type string
- The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
- id String
- The provider-assigned unique ID for this managed resource.
- systemData SystemData Response 
- Azure Resource Manager metadata containing createdBy and modifiedBy information.
- type String
- The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
- id string
- The provider-assigned unique ID for this managed resource.
- systemData SystemData Response 
- Azure Resource Manager metadata containing createdBy and modifiedBy information.
- type string
- The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
- id str
- The provider-assigned unique ID for this managed resource.
- system_data SystemData Response 
- Azure Resource Manager metadata containing createdBy and modifiedBy information.
- type str
- The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
- id String
- The provider-assigned unique ID for this managed resource.
- systemData Property Map
- Azure Resource Manager metadata containing createdBy and modifiedBy information.
- type String
- The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
Supporting Types
ApiGatewayRestApiProperties, ApiGatewayRestApiPropertiesArgs          
- Arn string
- Amazon Resource Name (ARN)
- AwsAccount stringId 
- AWS Account ID
- AwsProperties Pulumi.Azure Native. Aws Connector. Inputs. Aws Api Gateway Rest Api Properties 
- AWS Properties
- AwsRegion string
- AWS Region
- AwsSource stringSchema 
- AWS Source Schema
- Dictionary<string, string>
- AWS Tags
- PublicCloud stringConnectors Resource Id 
- Public Cloud Connectors Resource ID
- PublicCloud stringResource Name 
- Public Cloud Resource Name
- Arn string
- Amazon Resource Name (ARN)
- AwsAccount stringId 
- AWS Account ID
- AwsProperties AwsApi Gateway Rest Api Properties 
- AWS Properties
- AwsRegion string
- AWS Region
- AwsSource stringSchema 
- AWS Source Schema
- map[string]string
- AWS Tags
- PublicCloud stringConnectors Resource Id 
- Public Cloud Connectors Resource ID
- PublicCloud stringResource Name 
- Public Cloud Resource Name
- arn String
- Amazon Resource Name (ARN)
- awsAccount StringId 
- AWS Account ID
- awsProperties AwsApi Gateway Rest Api Properties 
- AWS Properties
- awsRegion String
- AWS Region
- awsSource StringSchema 
- AWS Source Schema
- Map<String,String>
- AWS Tags
- publicCloud StringConnectors Resource Id 
- Public Cloud Connectors Resource ID
- publicCloud StringResource Name 
- Public Cloud Resource Name
- arn string
- Amazon Resource Name (ARN)
- awsAccount stringId 
- AWS Account ID
- awsProperties AwsApi Gateway Rest Api Properties 
- AWS Properties
- awsRegion string
- AWS Region
- awsSource stringSchema 
- AWS Source Schema
- {[key: string]: string}
- AWS Tags
- publicCloud stringConnectors Resource Id 
- Public Cloud Connectors Resource ID
- publicCloud stringResource Name 
- Public Cloud Resource Name
- arn str
- Amazon Resource Name (ARN)
- aws_account_ strid 
- AWS Account ID
- aws_properties AwsApi Gateway Rest Api Properties 
- AWS Properties
- aws_region str
- AWS Region
- aws_source_ strschema 
- AWS Source Schema
- Mapping[str, str]
- AWS Tags
- public_cloud_ strconnectors_ resource_ id 
- Public Cloud Connectors Resource ID
- public_cloud_ strresource_ name 
- Public Cloud Resource Name
- arn String
- Amazon Resource Name (ARN)
- awsAccount StringId 
- AWS Account ID
- awsProperties Property Map
- AWS Properties
- awsRegion String
- AWS Region
- awsSource StringSchema 
- AWS Source Schema
- Map<String>
- AWS Tags
- publicCloud StringConnectors Resource Id 
- Public Cloud Connectors Resource ID
- publicCloud StringResource Name 
- Public Cloud Resource Name
ApiGatewayRestApiPropertiesResponse, ApiGatewayRestApiPropertiesResponseArgs            
- ProvisioningState string
- The status of the last operation.
- Arn string
- Amazon Resource Name (ARN)
- AwsAccount stringId 
- AWS Account ID
- AwsProperties Pulumi.Azure Native. Aws Connector. Inputs. Aws Api Gateway Rest Api Properties Response 
- AWS Properties
- AwsRegion string
- AWS Region
- AwsSource stringSchema 
- AWS Source Schema
- Dictionary<string, string>
- AWS Tags
- PublicCloud stringConnectors Resource Id 
- Public Cloud Connectors Resource ID
- PublicCloud stringResource Name 
- Public Cloud Resource Name
- ProvisioningState string
- The status of the last operation.
- Arn string
- Amazon Resource Name (ARN)
- AwsAccount stringId 
- AWS Account ID
- AwsProperties AwsApi Gateway Rest Api Properties Response 
- AWS Properties
- AwsRegion string
- AWS Region
- AwsSource stringSchema 
- AWS Source Schema
- map[string]string
- AWS Tags
- PublicCloud stringConnectors Resource Id 
- Public Cloud Connectors Resource ID
- PublicCloud stringResource Name 
- Public Cloud Resource Name
- provisioningState String
- The status of the last operation.
- arn String
- Amazon Resource Name (ARN)
- awsAccount StringId 
- AWS Account ID
- awsProperties AwsApi Gateway Rest Api Properties Response 
- AWS Properties
- awsRegion String
- AWS Region
- awsSource StringSchema 
- AWS Source Schema
- Map<String,String>
- AWS Tags
- publicCloud StringConnectors Resource Id 
- Public Cloud Connectors Resource ID
- publicCloud StringResource Name 
- Public Cloud Resource Name
- provisioningState string
- The status of the last operation.
- arn string
- Amazon Resource Name (ARN)
- awsAccount stringId 
- AWS Account ID
- awsProperties AwsApi Gateway Rest Api Properties Response 
- AWS Properties
- awsRegion string
- AWS Region
- awsSource stringSchema 
- AWS Source Schema
- {[key: string]: string}
- AWS Tags
- publicCloud stringConnectors Resource Id 
- Public Cloud Connectors Resource ID
- publicCloud stringResource Name 
- Public Cloud Resource Name
- provisioning_state str
- The status of the last operation.
- arn str
- Amazon Resource Name (ARN)
- aws_account_ strid 
- AWS Account ID
- aws_properties AwsApi Gateway Rest Api Properties Response 
- AWS Properties
- aws_region str
- AWS Region
- aws_source_ strschema 
- AWS Source Schema
- Mapping[str, str]
- AWS Tags
- public_cloud_ strconnectors_ resource_ id 
- Public Cloud Connectors Resource ID
- public_cloud_ strresource_ name 
- Public Cloud Resource Name
- provisioningState String
- The status of the last operation.
- arn String
- Amazon Resource Name (ARN)
- awsAccount StringId 
- AWS Account ID
- awsProperties Property Map
- AWS Properties
- awsRegion String
- AWS Region
- awsSource StringSchema 
- AWS Source Schema
- Map<String>
- AWS Tags
- publicCloud StringConnectors Resource Id 
- Public Cloud Connectors Resource ID
- publicCloud StringResource Name 
- Public Cloud Resource Name
AwsApiGatewayRestApiProperties, AwsApiGatewayRestApiPropertiesArgs            
- ApiKey stringSource Type 
- The source of the API key for metering requests according to a usage plan. Valid values are: HEADERto read the API key from theX-API-Keyheader of a request.AUTHORIZERto read the API key from theUsageIdentifierKeyfrom a custom authorizer.
- BinaryMedia List<string>Types 
- The list of binary media types supported by the RestApi. By default, the RestApi supports only UTF-8-encoded text payloads.
- Body object
- An OpenAPI specification that defines a set of RESTful APIs in JSON format. For YAML templates, you can also provide the specification in YAML format.
- BodyS3Location Pulumi.Azure Native. Aws Connector. Inputs. S3Location 
- The Amazon Simple Storage Service (Amazon S3) location that points to an OpenAPI file, which defines a set of RESTful APIs in JSON or YAML format. S3Locationis a property of the AWS::ApiGateway::RestApi resource that specifies the Amazon S3 location of a OpenAPI (formerly Swagger) file that defines a set of RESTful APIs in JSON or YAML. On January 1, 2016, the Swagger Specification was donated to the OpenAPI initiative, becoming the foundation of the OpenAPI Specification.
- CloneFrom string
- The ID of the RestApi that you want to clone from.
- Description string
- The description of the RestApi.
- DisableExecute boolApi Endpoint 
- Specifies whether clients can invoke your API by using the default execute-apiendpoint. By default, clients can invoke your API with the defaulthttps://{api_id}.execute-api.{region}.amazonaws.comendpoint. To require that clients use a custom domain name to invoke your API, disable the default endpoint
- EndpointConfiguration Pulumi.Azure Native. Aws Connector. Inputs. Endpoint Configuration 
- A list of the endpoint types of the API. Use this property when creating an API. When importing an existing API, specify the endpoint configuration types using the Parametersproperty. TheEndpointConfigurationproperty type specifies the endpoint types of a REST API.EndpointConfigurationis a property of the AWS::ApiGateway::RestApi resource.
- FailOn boolWarnings 
- A query parameter to indicate whether to rollback the API update (true) or not (false) when a warning is encountered. The default value isfalse.
- MinimumCompression intSize 
- A nullable integer that is used to enable compression (with non-negative between 0 and 10485760 (10M) bytes, inclusive) or disable compression (with a null value) on an API. When compression is enabled, compression or decompression is not applied on the payload if the payload size is smaller than this value. Setting it to zero allows compression for any payload size.
- Mode string
- This property applies only when you use OpenAPI to define your REST API. The Modedetermines how API Gateway handles resource updates. Valid values areoverwriteormerge. Foroverwrite, the new API definition replaces the existing one. The existing API identifier remains unchanged. Formerge, the new API definition is merged with the existing API. If you don't specify this property, a default value is chosen. For REST APIs created before March 29, 2021, the default isoverwrite. For REST APIs created after March 29, 2021, the new API definition takes precedence, but any container types such as endpoint configurations and binary media types are merged with the existing API. Use the default mode to define top-levelRestApiproperties in addition to using OpenAPI. Generally, it's preferred to use API Gateway's OpenAPI extensions to model these properties.
- Name string
- The name of the RestApi. A name is required if the REST API is not based on an OpenAPI specification.
- Parameters Dictionary<string, string>
- Custom header parameters as part of the request. For example, to exclude DocumentationParts from an imported API, set ignore=documentationas aparametersvalue, as in the AWS CLI command ofaws apigateway import-rest-api --parameters ignore=documentation --body 'file:///path/to/imported-api-body.json'.
- Policy string
- A policy document that contains the permissions for the RestApiresource. To set the ARN for the policy, use the!Joinintrinsic function with''as delimiter and values of'execute-api:/'and'*'.
- RestApi stringId 
- Property restApiId
- RootResource stringId 
- Property rootResourceId
- 
List<Pulumi.Azure Native. Aws Connector. Inputs. Tag> 
- The key-value map of strings. The valid character set is [a-zA-Z+-=._:/]. The tag key can be up to 128 characters and must not start with aws:. The tag value can be up to 256 characters.
- ApiKey stringSource Type 
- The source of the API key for metering requests according to a usage plan. Valid values are: HEADERto read the API key from theX-API-Keyheader of a request.AUTHORIZERto read the API key from theUsageIdentifierKeyfrom a custom authorizer.
- BinaryMedia []stringTypes 
- The list of binary media types supported by the RestApi. By default, the RestApi supports only UTF-8-encoded text payloads.
- Body interface{}
- An OpenAPI specification that defines a set of RESTful APIs in JSON format. For YAML templates, you can also provide the specification in YAML format.
- BodyS3Location S3Location
- The Amazon Simple Storage Service (Amazon S3) location that points to an OpenAPI file, which defines a set of RESTful APIs in JSON or YAML format. S3Locationis a property of the AWS::ApiGateway::RestApi resource that specifies the Amazon S3 location of a OpenAPI (formerly Swagger) file that defines a set of RESTful APIs in JSON or YAML. On January 1, 2016, the Swagger Specification was donated to the OpenAPI initiative, becoming the foundation of the OpenAPI Specification.
- CloneFrom string
- The ID of the RestApi that you want to clone from.
- Description string
- The description of the RestApi.
- DisableExecute boolApi Endpoint 
- Specifies whether clients can invoke your API by using the default execute-apiendpoint. By default, clients can invoke your API with the defaulthttps://{api_id}.execute-api.{region}.amazonaws.comendpoint. To require that clients use a custom domain name to invoke your API, disable the default endpoint
- EndpointConfiguration EndpointConfiguration 
- A list of the endpoint types of the API. Use this property when creating an API. When importing an existing API, specify the endpoint configuration types using the Parametersproperty. TheEndpointConfigurationproperty type specifies the endpoint types of a REST API.EndpointConfigurationis a property of the AWS::ApiGateway::RestApi resource.
- FailOn boolWarnings 
- A query parameter to indicate whether to rollback the API update (true) or not (false) when a warning is encountered. The default value isfalse.
- MinimumCompression intSize 
- A nullable integer that is used to enable compression (with non-negative between 0 and 10485760 (10M) bytes, inclusive) or disable compression (with a null value) on an API. When compression is enabled, compression or decompression is not applied on the payload if the payload size is smaller than this value. Setting it to zero allows compression for any payload size.
- Mode string
- This property applies only when you use OpenAPI to define your REST API. The Modedetermines how API Gateway handles resource updates. Valid values areoverwriteormerge. Foroverwrite, the new API definition replaces the existing one. The existing API identifier remains unchanged. Formerge, the new API definition is merged with the existing API. If you don't specify this property, a default value is chosen. For REST APIs created before March 29, 2021, the default isoverwrite. For REST APIs created after March 29, 2021, the new API definition takes precedence, but any container types such as endpoint configurations and binary media types are merged with the existing API. Use the default mode to define top-levelRestApiproperties in addition to using OpenAPI. Generally, it's preferred to use API Gateway's OpenAPI extensions to model these properties.
- Name string
- The name of the RestApi. A name is required if the REST API is not based on an OpenAPI specification.
- Parameters map[string]string
- Custom header parameters as part of the request. For example, to exclude DocumentationParts from an imported API, set ignore=documentationas aparametersvalue, as in the AWS CLI command ofaws apigateway import-rest-api --parameters ignore=documentation --body 'file:///path/to/imported-api-body.json'.
- Policy string
- A policy document that contains the permissions for the RestApiresource. To set the ARN for the policy, use the!Joinintrinsic function with''as delimiter and values of'execute-api:/'and'*'.
- RestApi stringId 
- Property restApiId
- RootResource stringId 
- Property rootResourceId
- []Tag
- The key-value map of strings. The valid character set is [a-zA-Z+-=._:/]. The tag key can be up to 128 characters and must not start with aws:. The tag value can be up to 256 characters.
- apiKey StringSource Type 
- The source of the API key for metering requests according to a usage plan. Valid values are: HEADERto read the API key from theX-API-Keyheader of a request.AUTHORIZERto read the API key from theUsageIdentifierKeyfrom a custom authorizer.
- binaryMedia List<String>Types 
- The list of binary media types supported by the RestApi. By default, the RestApi supports only UTF-8-encoded text payloads.
- body Object
- An OpenAPI specification that defines a set of RESTful APIs in JSON format. For YAML templates, you can also provide the specification in YAML format.
- bodyS3Location S3Location
- The Amazon Simple Storage Service (Amazon S3) location that points to an OpenAPI file, which defines a set of RESTful APIs in JSON or YAML format. S3Locationis a property of the AWS::ApiGateway::RestApi resource that specifies the Amazon S3 location of a OpenAPI (formerly Swagger) file that defines a set of RESTful APIs in JSON or YAML. On January 1, 2016, the Swagger Specification was donated to the OpenAPI initiative, becoming the foundation of the OpenAPI Specification.
- cloneFrom String
- The ID of the RestApi that you want to clone from.
- description String
- The description of the RestApi.
- disableExecute BooleanApi Endpoint 
- Specifies whether clients can invoke your API by using the default execute-apiendpoint. By default, clients can invoke your API with the defaulthttps://{api_id}.execute-api.{region}.amazonaws.comendpoint. To require that clients use a custom domain name to invoke your API, disable the default endpoint
- endpointConfiguration EndpointConfiguration 
- A list of the endpoint types of the API. Use this property when creating an API. When importing an existing API, specify the endpoint configuration types using the Parametersproperty. TheEndpointConfigurationproperty type specifies the endpoint types of a REST API.EndpointConfigurationis a property of the AWS::ApiGateway::RestApi resource.
- failOn BooleanWarnings 
- A query parameter to indicate whether to rollback the API update (true) or not (false) when a warning is encountered. The default value isfalse.
- minimumCompression IntegerSize 
- A nullable integer that is used to enable compression (with non-negative between 0 and 10485760 (10M) bytes, inclusive) or disable compression (with a null value) on an API. When compression is enabled, compression or decompression is not applied on the payload if the payload size is smaller than this value. Setting it to zero allows compression for any payload size.
- mode String
- This property applies only when you use OpenAPI to define your REST API. The Modedetermines how API Gateway handles resource updates. Valid values areoverwriteormerge. Foroverwrite, the new API definition replaces the existing one. The existing API identifier remains unchanged. Formerge, the new API definition is merged with the existing API. If you don't specify this property, a default value is chosen. For REST APIs created before March 29, 2021, the default isoverwrite. For REST APIs created after March 29, 2021, the new API definition takes precedence, but any container types such as endpoint configurations and binary media types are merged with the existing API. Use the default mode to define top-levelRestApiproperties in addition to using OpenAPI. Generally, it's preferred to use API Gateway's OpenAPI extensions to model these properties.
- name String
- The name of the RestApi. A name is required if the REST API is not based on an OpenAPI specification.
- parameters Map<String,String>
- Custom header parameters as part of the request. For example, to exclude DocumentationParts from an imported API, set ignore=documentationas aparametersvalue, as in the AWS CLI command ofaws apigateway import-rest-api --parameters ignore=documentation --body 'file:///path/to/imported-api-body.json'.
- policy String
- A policy document that contains the permissions for the RestApiresource. To set the ARN for the policy, use the!Joinintrinsic function with''as delimiter and values of'execute-api:/'and'*'.
- restApi StringId 
- Property restApiId
- rootResource StringId 
- Property rootResourceId
- List<Tag>
- The key-value map of strings. The valid character set is [a-zA-Z+-=._:/]. The tag key can be up to 128 characters and must not start with aws:. The tag value can be up to 256 characters.
- apiKey stringSource Type 
- The source of the API key for metering requests according to a usage plan. Valid values are: HEADERto read the API key from theX-API-Keyheader of a request.AUTHORIZERto read the API key from theUsageIdentifierKeyfrom a custom authorizer.
- binaryMedia string[]Types 
- The list of binary media types supported by the RestApi. By default, the RestApi supports only UTF-8-encoded text payloads.
- body any
- An OpenAPI specification that defines a set of RESTful APIs in JSON format. For YAML templates, you can also provide the specification in YAML format.
- bodyS3Location S3Location
- The Amazon Simple Storage Service (Amazon S3) location that points to an OpenAPI file, which defines a set of RESTful APIs in JSON or YAML format. S3Locationis a property of the AWS::ApiGateway::RestApi resource that specifies the Amazon S3 location of a OpenAPI (formerly Swagger) file that defines a set of RESTful APIs in JSON or YAML. On January 1, 2016, the Swagger Specification was donated to the OpenAPI initiative, becoming the foundation of the OpenAPI Specification.
- cloneFrom string
- The ID of the RestApi that you want to clone from.
- description string
- The description of the RestApi.
- disableExecute booleanApi Endpoint 
- Specifies whether clients can invoke your API by using the default execute-apiendpoint. By default, clients can invoke your API with the defaulthttps://{api_id}.execute-api.{region}.amazonaws.comendpoint. To require that clients use a custom domain name to invoke your API, disable the default endpoint
- endpointConfiguration EndpointConfiguration 
- A list of the endpoint types of the API. Use this property when creating an API. When importing an existing API, specify the endpoint configuration types using the Parametersproperty. TheEndpointConfigurationproperty type specifies the endpoint types of a REST API.EndpointConfigurationis a property of the AWS::ApiGateway::RestApi resource.
- failOn booleanWarnings 
- A query parameter to indicate whether to rollback the API update (true) or not (false) when a warning is encountered. The default value isfalse.
- minimumCompression numberSize 
- A nullable integer that is used to enable compression (with non-negative between 0 and 10485760 (10M) bytes, inclusive) or disable compression (with a null value) on an API. When compression is enabled, compression or decompression is not applied on the payload if the payload size is smaller than this value. Setting it to zero allows compression for any payload size.
- mode string
- This property applies only when you use OpenAPI to define your REST API. The Modedetermines how API Gateway handles resource updates. Valid values areoverwriteormerge. Foroverwrite, the new API definition replaces the existing one. The existing API identifier remains unchanged. Formerge, the new API definition is merged with the existing API. If you don't specify this property, a default value is chosen. For REST APIs created before March 29, 2021, the default isoverwrite. For REST APIs created after March 29, 2021, the new API definition takes precedence, but any container types such as endpoint configurations and binary media types are merged with the existing API. Use the default mode to define top-levelRestApiproperties in addition to using OpenAPI. Generally, it's preferred to use API Gateway's OpenAPI extensions to model these properties.
- name string
- The name of the RestApi. A name is required if the REST API is not based on an OpenAPI specification.
- parameters {[key: string]: string}
- Custom header parameters as part of the request. For example, to exclude DocumentationParts from an imported API, set ignore=documentationas aparametersvalue, as in the AWS CLI command ofaws apigateway import-rest-api --parameters ignore=documentation --body 'file:///path/to/imported-api-body.json'.
- policy string
- A policy document that contains the permissions for the RestApiresource. To set the ARN for the policy, use the!Joinintrinsic function with''as delimiter and values of'execute-api:/'and'*'.
- restApi stringId 
- Property restApiId
- rootResource stringId 
- Property rootResourceId
- Tag[]
- The key-value map of strings. The valid character set is [a-zA-Z+-=._:/]. The tag key can be up to 128 characters and must not start with aws:. The tag value can be up to 256 characters.
- api_key_ strsource_ type 
- The source of the API key for metering requests according to a usage plan. Valid values are: HEADERto read the API key from theX-API-Keyheader of a request.AUTHORIZERto read the API key from theUsageIdentifierKeyfrom a custom authorizer.
- binary_media_ Sequence[str]types 
- The list of binary media types supported by the RestApi. By default, the RestApi supports only UTF-8-encoded text payloads.
- body Any
- An OpenAPI specification that defines a set of RESTful APIs in JSON format. For YAML templates, you can also provide the specification in YAML format.
- body_s3_ S3Locationlocation 
- The Amazon Simple Storage Service (Amazon S3) location that points to an OpenAPI file, which defines a set of RESTful APIs in JSON or YAML format. S3Locationis a property of the AWS::ApiGateway::RestApi resource that specifies the Amazon S3 location of a OpenAPI (formerly Swagger) file that defines a set of RESTful APIs in JSON or YAML. On January 1, 2016, the Swagger Specification was donated to the OpenAPI initiative, becoming the foundation of the OpenAPI Specification.
- clone_from str
- The ID of the RestApi that you want to clone from.
- description str
- The description of the RestApi.
- disable_execute_ boolapi_ endpoint 
- Specifies whether clients can invoke your API by using the default execute-apiendpoint. By default, clients can invoke your API with the defaulthttps://{api_id}.execute-api.{region}.amazonaws.comendpoint. To require that clients use a custom domain name to invoke your API, disable the default endpoint
- endpoint_configuration EndpointConfiguration 
- A list of the endpoint types of the API. Use this property when creating an API. When importing an existing API, specify the endpoint configuration types using the Parametersproperty. TheEndpointConfigurationproperty type specifies the endpoint types of a REST API.EndpointConfigurationis a property of the AWS::ApiGateway::RestApi resource.
- fail_on_ boolwarnings 
- A query parameter to indicate whether to rollback the API update (true) or not (false) when a warning is encountered. The default value isfalse.
- minimum_compression_ intsize 
- A nullable integer that is used to enable compression (with non-negative between 0 and 10485760 (10M) bytes, inclusive) or disable compression (with a null value) on an API. When compression is enabled, compression or decompression is not applied on the payload if the payload size is smaller than this value. Setting it to zero allows compression for any payload size.
- mode str
- This property applies only when you use OpenAPI to define your REST API. The Modedetermines how API Gateway handles resource updates. Valid values areoverwriteormerge. Foroverwrite, the new API definition replaces the existing one. The existing API identifier remains unchanged. Formerge, the new API definition is merged with the existing API. If you don't specify this property, a default value is chosen. For REST APIs created before March 29, 2021, the default isoverwrite. For REST APIs created after March 29, 2021, the new API definition takes precedence, but any container types such as endpoint configurations and binary media types are merged with the existing API. Use the default mode to define top-levelRestApiproperties in addition to using OpenAPI. Generally, it's preferred to use API Gateway's OpenAPI extensions to model these properties.
- name str
- The name of the RestApi. A name is required if the REST API is not based on an OpenAPI specification.
- parameters Mapping[str, str]
- Custom header parameters as part of the request. For example, to exclude DocumentationParts from an imported API, set ignore=documentationas aparametersvalue, as in the AWS CLI command ofaws apigateway import-rest-api --parameters ignore=documentation --body 'file:///path/to/imported-api-body.json'.
- policy str
- A policy document that contains the permissions for the RestApiresource. To set the ARN for the policy, use the!Joinintrinsic function with''as delimiter and values of'execute-api:/'and'*'.
- rest_api_ strid 
- Property restApiId
- root_resource_ strid 
- Property rootResourceId
- Sequence[Tag]
- The key-value map of strings. The valid character set is [a-zA-Z+-=._:/]. The tag key can be up to 128 characters and must not start with aws:. The tag value can be up to 256 characters.
- apiKey StringSource Type 
- The source of the API key for metering requests according to a usage plan. Valid values are: HEADERto read the API key from theX-API-Keyheader of a request.AUTHORIZERto read the API key from theUsageIdentifierKeyfrom a custom authorizer.
- binaryMedia List<String>Types 
- The list of binary media types supported by the RestApi. By default, the RestApi supports only UTF-8-encoded text payloads.
- body Any
- An OpenAPI specification that defines a set of RESTful APIs in JSON format. For YAML templates, you can also provide the specification in YAML format.
- bodyS3Location Property Map
- The Amazon Simple Storage Service (Amazon S3) location that points to an OpenAPI file, which defines a set of RESTful APIs in JSON or YAML format. S3Locationis a property of the AWS::ApiGateway::RestApi resource that specifies the Amazon S3 location of a OpenAPI (formerly Swagger) file that defines a set of RESTful APIs in JSON or YAML. On January 1, 2016, the Swagger Specification was donated to the OpenAPI initiative, becoming the foundation of the OpenAPI Specification.
- cloneFrom String
- The ID of the RestApi that you want to clone from.
- description String
- The description of the RestApi.
- disableExecute BooleanApi Endpoint 
- Specifies whether clients can invoke your API by using the default execute-apiendpoint. By default, clients can invoke your API with the defaulthttps://{api_id}.execute-api.{region}.amazonaws.comendpoint. To require that clients use a custom domain name to invoke your API, disable the default endpoint
- endpointConfiguration Property Map
- A list of the endpoint types of the API. Use this property when creating an API. When importing an existing API, specify the endpoint configuration types using the Parametersproperty. TheEndpointConfigurationproperty type specifies the endpoint types of a REST API.EndpointConfigurationis a property of the AWS::ApiGateway::RestApi resource.
- failOn BooleanWarnings 
- A query parameter to indicate whether to rollback the API update (true) or not (false) when a warning is encountered. The default value isfalse.
- minimumCompression NumberSize 
- A nullable integer that is used to enable compression (with non-negative between 0 and 10485760 (10M) bytes, inclusive) or disable compression (with a null value) on an API. When compression is enabled, compression or decompression is not applied on the payload if the payload size is smaller than this value. Setting it to zero allows compression for any payload size.
- mode String
- This property applies only when you use OpenAPI to define your REST API. The Modedetermines how API Gateway handles resource updates. Valid values areoverwriteormerge. Foroverwrite, the new API definition replaces the existing one. The existing API identifier remains unchanged. Formerge, the new API definition is merged with the existing API. If you don't specify this property, a default value is chosen. For REST APIs created before March 29, 2021, the default isoverwrite. For REST APIs created after March 29, 2021, the new API definition takes precedence, but any container types such as endpoint configurations and binary media types are merged with the existing API. Use the default mode to define top-levelRestApiproperties in addition to using OpenAPI. Generally, it's preferred to use API Gateway's OpenAPI extensions to model these properties.
- name String
- The name of the RestApi. A name is required if the REST API is not based on an OpenAPI specification.
- parameters Map<String>
- Custom header parameters as part of the request. For example, to exclude DocumentationParts from an imported API, set ignore=documentationas aparametersvalue, as in the AWS CLI command ofaws apigateway import-rest-api --parameters ignore=documentation --body 'file:///path/to/imported-api-body.json'.
- policy String
- A policy document that contains the permissions for the RestApiresource. To set the ARN for the policy, use the!Joinintrinsic function with''as delimiter and values of'execute-api:/'and'*'.
- restApi StringId 
- Property restApiId
- rootResource StringId 
- Property rootResourceId
- List<Property Map>
- The key-value map of strings. The valid character set is [a-zA-Z+-=._:/]. The tag key can be up to 128 characters and must not start with aws:. The tag value can be up to 256 characters.
AwsApiGatewayRestApiPropertiesResponse, AwsApiGatewayRestApiPropertiesResponseArgs              
- ApiKey stringSource Type 
- The source of the API key for metering requests according to a usage plan. Valid values are: HEADERto read the API key from theX-API-Keyheader of a request.AUTHORIZERto read the API key from theUsageIdentifierKeyfrom a custom authorizer.
- BinaryMedia List<string>Types 
- The list of binary media types supported by the RestApi. By default, the RestApi supports only UTF-8-encoded text payloads.
- Body object
- An OpenAPI specification that defines a set of RESTful APIs in JSON format. For YAML templates, you can also provide the specification in YAML format.
- BodyS3Location Pulumi.Azure Native. Aws Connector. Inputs. S3Location Response 
- The Amazon Simple Storage Service (Amazon S3) location that points to an OpenAPI file, which defines a set of RESTful APIs in JSON or YAML format. S3Locationis a property of the AWS::ApiGateway::RestApi resource that specifies the Amazon S3 location of a OpenAPI (formerly Swagger) file that defines a set of RESTful APIs in JSON or YAML. On January 1, 2016, the Swagger Specification was donated to the OpenAPI initiative, becoming the foundation of the OpenAPI Specification.
- CloneFrom string
- The ID of the RestApi that you want to clone from.
- Description string
- The description of the RestApi.
- DisableExecute boolApi Endpoint 
- Specifies whether clients can invoke your API by using the default execute-apiendpoint. By default, clients can invoke your API with the defaulthttps://{api_id}.execute-api.{region}.amazonaws.comendpoint. To require that clients use a custom domain name to invoke your API, disable the default endpoint
- EndpointConfiguration Pulumi.Azure Native. Aws Connector. Inputs. Endpoint Configuration Response 
- A list of the endpoint types of the API. Use this property when creating an API. When importing an existing API, specify the endpoint configuration types using the Parametersproperty. TheEndpointConfigurationproperty type specifies the endpoint types of a REST API.EndpointConfigurationis a property of the AWS::ApiGateway::RestApi resource.
- FailOn boolWarnings 
- A query parameter to indicate whether to rollback the API update (true) or not (false) when a warning is encountered. The default value isfalse.
- MinimumCompression intSize 
- A nullable integer that is used to enable compression (with non-negative between 0 and 10485760 (10M) bytes, inclusive) or disable compression (with a null value) on an API. When compression is enabled, compression or decompression is not applied on the payload if the payload size is smaller than this value. Setting it to zero allows compression for any payload size.
- Mode string
- This property applies only when you use OpenAPI to define your REST API. The Modedetermines how API Gateway handles resource updates. Valid values areoverwriteormerge. Foroverwrite, the new API definition replaces the existing one. The existing API identifier remains unchanged. Formerge, the new API definition is merged with the existing API. If you don't specify this property, a default value is chosen. For REST APIs created before March 29, 2021, the default isoverwrite. For REST APIs created after March 29, 2021, the new API definition takes precedence, but any container types such as endpoint configurations and binary media types are merged with the existing API. Use the default mode to define top-levelRestApiproperties in addition to using OpenAPI. Generally, it's preferred to use API Gateway's OpenAPI extensions to model these properties.
- Name string
- The name of the RestApi. A name is required if the REST API is not based on an OpenAPI specification.
- Parameters Dictionary<string, string>
- Custom header parameters as part of the request. For example, to exclude DocumentationParts from an imported API, set ignore=documentationas aparametersvalue, as in the AWS CLI command ofaws apigateway import-rest-api --parameters ignore=documentation --body 'file:///path/to/imported-api-body.json'.
- Policy string
- A policy document that contains the permissions for the RestApiresource. To set the ARN for the policy, use the!Joinintrinsic function with''as delimiter and values of'execute-api:/'and'*'.
- RestApi stringId 
- Property restApiId
- RootResource stringId 
- Property rootResourceId
- 
List<Pulumi.Azure Native. Aws Connector. Inputs. Tag Response> 
- The key-value map of strings. The valid character set is [a-zA-Z+-=._:/]. The tag key can be up to 128 characters and must not start with aws:. The tag value can be up to 256 characters.
- ApiKey stringSource Type 
- The source of the API key for metering requests according to a usage plan. Valid values are: HEADERto read the API key from theX-API-Keyheader of a request.AUTHORIZERto read the API key from theUsageIdentifierKeyfrom a custom authorizer.
- BinaryMedia []stringTypes 
- The list of binary media types supported by the RestApi. By default, the RestApi supports only UTF-8-encoded text payloads.
- Body interface{}
- An OpenAPI specification that defines a set of RESTful APIs in JSON format. For YAML templates, you can also provide the specification in YAML format.
- BodyS3Location S3LocationResponse 
- The Amazon Simple Storage Service (Amazon S3) location that points to an OpenAPI file, which defines a set of RESTful APIs in JSON or YAML format. S3Locationis a property of the AWS::ApiGateway::RestApi resource that specifies the Amazon S3 location of a OpenAPI (formerly Swagger) file that defines a set of RESTful APIs in JSON or YAML. On January 1, 2016, the Swagger Specification was donated to the OpenAPI initiative, becoming the foundation of the OpenAPI Specification.
- CloneFrom string
- The ID of the RestApi that you want to clone from.
- Description string
- The description of the RestApi.
- DisableExecute boolApi Endpoint 
- Specifies whether clients can invoke your API by using the default execute-apiendpoint. By default, clients can invoke your API with the defaulthttps://{api_id}.execute-api.{region}.amazonaws.comendpoint. To require that clients use a custom domain name to invoke your API, disable the default endpoint
- EndpointConfiguration EndpointConfiguration Response 
- A list of the endpoint types of the API. Use this property when creating an API. When importing an existing API, specify the endpoint configuration types using the Parametersproperty. TheEndpointConfigurationproperty type specifies the endpoint types of a REST API.EndpointConfigurationis a property of the AWS::ApiGateway::RestApi resource.
- FailOn boolWarnings 
- A query parameter to indicate whether to rollback the API update (true) or not (false) when a warning is encountered. The default value isfalse.
- MinimumCompression intSize 
- A nullable integer that is used to enable compression (with non-negative between 0 and 10485760 (10M) bytes, inclusive) or disable compression (with a null value) on an API. When compression is enabled, compression or decompression is not applied on the payload if the payload size is smaller than this value. Setting it to zero allows compression for any payload size.
- Mode string
- This property applies only when you use OpenAPI to define your REST API. The Modedetermines how API Gateway handles resource updates. Valid values areoverwriteormerge. Foroverwrite, the new API definition replaces the existing one. The existing API identifier remains unchanged. Formerge, the new API definition is merged with the existing API. If you don't specify this property, a default value is chosen. For REST APIs created before March 29, 2021, the default isoverwrite. For REST APIs created after March 29, 2021, the new API definition takes precedence, but any container types such as endpoint configurations and binary media types are merged with the existing API. Use the default mode to define top-levelRestApiproperties in addition to using OpenAPI. Generally, it's preferred to use API Gateway's OpenAPI extensions to model these properties.
- Name string
- The name of the RestApi. A name is required if the REST API is not based on an OpenAPI specification.
- Parameters map[string]string
- Custom header parameters as part of the request. For example, to exclude DocumentationParts from an imported API, set ignore=documentationas aparametersvalue, as in the AWS CLI command ofaws apigateway import-rest-api --parameters ignore=documentation --body 'file:///path/to/imported-api-body.json'.
- Policy string
- A policy document that contains the permissions for the RestApiresource. To set the ARN for the policy, use the!Joinintrinsic function with''as delimiter and values of'execute-api:/'and'*'.
- RestApi stringId 
- Property restApiId
- RootResource stringId 
- Property rootResourceId
- 
[]TagResponse 
- The key-value map of strings. The valid character set is [a-zA-Z+-=._:/]. The tag key can be up to 128 characters and must not start with aws:. The tag value can be up to 256 characters.
- apiKey StringSource Type 
- The source of the API key for metering requests according to a usage plan. Valid values are: HEADERto read the API key from theX-API-Keyheader of a request.AUTHORIZERto read the API key from theUsageIdentifierKeyfrom a custom authorizer.
- binaryMedia List<String>Types 
- The list of binary media types supported by the RestApi. By default, the RestApi supports only UTF-8-encoded text payloads.
- body Object
- An OpenAPI specification that defines a set of RESTful APIs in JSON format. For YAML templates, you can also provide the specification in YAML format.
- bodyS3Location S3LocationResponse 
- The Amazon Simple Storage Service (Amazon S3) location that points to an OpenAPI file, which defines a set of RESTful APIs in JSON or YAML format. S3Locationis a property of the AWS::ApiGateway::RestApi resource that specifies the Amazon S3 location of a OpenAPI (formerly Swagger) file that defines a set of RESTful APIs in JSON or YAML. On January 1, 2016, the Swagger Specification was donated to the OpenAPI initiative, becoming the foundation of the OpenAPI Specification.
- cloneFrom String
- The ID of the RestApi that you want to clone from.
- description String
- The description of the RestApi.
- disableExecute BooleanApi Endpoint 
- Specifies whether clients can invoke your API by using the default execute-apiendpoint. By default, clients can invoke your API with the defaulthttps://{api_id}.execute-api.{region}.amazonaws.comendpoint. To require that clients use a custom domain name to invoke your API, disable the default endpoint
- endpointConfiguration EndpointConfiguration Response 
- A list of the endpoint types of the API. Use this property when creating an API. When importing an existing API, specify the endpoint configuration types using the Parametersproperty. TheEndpointConfigurationproperty type specifies the endpoint types of a REST API.EndpointConfigurationis a property of the AWS::ApiGateway::RestApi resource.
- failOn BooleanWarnings 
- A query parameter to indicate whether to rollback the API update (true) or not (false) when a warning is encountered. The default value isfalse.
- minimumCompression IntegerSize 
- A nullable integer that is used to enable compression (with non-negative between 0 and 10485760 (10M) bytes, inclusive) or disable compression (with a null value) on an API. When compression is enabled, compression or decompression is not applied on the payload if the payload size is smaller than this value. Setting it to zero allows compression for any payload size.
- mode String
- This property applies only when you use OpenAPI to define your REST API. The Modedetermines how API Gateway handles resource updates. Valid values areoverwriteormerge. Foroverwrite, the new API definition replaces the existing one. The existing API identifier remains unchanged. Formerge, the new API definition is merged with the existing API. If you don't specify this property, a default value is chosen. For REST APIs created before March 29, 2021, the default isoverwrite. For REST APIs created after March 29, 2021, the new API definition takes precedence, but any container types such as endpoint configurations and binary media types are merged with the existing API. Use the default mode to define top-levelRestApiproperties in addition to using OpenAPI. Generally, it's preferred to use API Gateway's OpenAPI extensions to model these properties.
- name String
- The name of the RestApi. A name is required if the REST API is not based on an OpenAPI specification.
- parameters Map<String,String>
- Custom header parameters as part of the request. For example, to exclude DocumentationParts from an imported API, set ignore=documentationas aparametersvalue, as in the AWS CLI command ofaws apigateway import-rest-api --parameters ignore=documentation --body 'file:///path/to/imported-api-body.json'.
- policy String
- A policy document that contains the permissions for the RestApiresource. To set the ARN for the policy, use the!Joinintrinsic function with''as delimiter and values of'execute-api:/'and'*'.
- restApi StringId 
- Property restApiId
- rootResource StringId 
- Property rootResourceId
- 
List<TagResponse> 
- The key-value map of strings. The valid character set is [a-zA-Z+-=._:/]. The tag key can be up to 128 characters and must not start with aws:. The tag value can be up to 256 characters.
- apiKey stringSource Type 
- The source of the API key for metering requests according to a usage plan. Valid values are: HEADERto read the API key from theX-API-Keyheader of a request.AUTHORIZERto read the API key from theUsageIdentifierKeyfrom a custom authorizer.
- binaryMedia string[]Types 
- The list of binary media types supported by the RestApi. By default, the RestApi supports only UTF-8-encoded text payloads.
- body any
- An OpenAPI specification that defines a set of RESTful APIs in JSON format. For YAML templates, you can also provide the specification in YAML format.
- bodyS3Location S3LocationResponse 
- The Amazon Simple Storage Service (Amazon S3) location that points to an OpenAPI file, which defines a set of RESTful APIs in JSON or YAML format. S3Locationis a property of the AWS::ApiGateway::RestApi resource that specifies the Amazon S3 location of a OpenAPI (formerly Swagger) file that defines a set of RESTful APIs in JSON or YAML. On January 1, 2016, the Swagger Specification was donated to the OpenAPI initiative, becoming the foundation of the OpenAPI Specification.
- cloneFrom string
- The ID of the RestApi that you want to clone from.
- description string
- The description of the RestApi.
- disableExecute booleanApi Endpoint 
- Specifies whether clients can invoke your API by using the default execute-apiendpoint. By default, clients can invoke your API with the defaulthttps://{api_id}.execute-api.{region}.amazonaws.comendpoint. To require that clients use a custom domain name to invoke your API, disable the default endpoint
- endpointConfiguration EndpointConfiguration Response 
- A list of the endpoint types of the API. Use this property when creating an API. When importing an existing API, specify the endpoint configuration types using the Parametersproperty. TheEndpointConfigurationproperty type specifies the endpoint types of a REST API.EndpointConfigurationis a property of the AWS::ApiGateway::RestApi resource.
- failOn booleanWarnings 
- A query parameter to indicate whether to rollback the API update (true) or not (false) when a warning is encountered. The default value isfalse.
- minimumCompression numberSize 
- A nullable integer that is used to enable compression (with non-negative between 0 and 10485760 (10M) bytes, inclusive) or disable compression (with a null value) on an API. When compression is enabled, compression or decompression is not applied on the payload if the payload size is smaller than this value. Setting it to zero allows compression for any payload size.
- mode string
- This property applies only when you use OpenAPI to define your REST API. The Modedetermines how API Gateway handles resource updates. Valid values areoverwriteormerge. Foroverwrite, the new API definition replaces the existing one. The existing API identifier remains unchanged. Formerge, the new API definition is merged with the existing API. If you don't specify this property, a default value is chosen. For REST APIs created before March 29, 2021, the default isoverwrite. For REST APIs created after March 29, 2021, the new API definition takes precedence, but any container types such as endpoint configurations and binary media types are merged with the existing API. Use the default mode to define top-levelRestApiproperties in addition to using OpenAPI. Generally, it's preferred to use API Gateway's OpenAPI extensions to model these properties.
- name string
- The name of the RestApi. A name is required if the REST API is not based on an OpenAPI specification.
- parameters {[key: string]: string}
- Custom header parameters as part of the request. For example, to exclude DocumentationParts from an imported API, set ignore=documentationas aparametersvalue, as in the AWS CLI command ofaws apigateway import-rest-api --parameters ignore=documentation --body 'file:///path/to/imported-api-body.json'.
- policy string
- A policy document that contains the permissions for the RestApiresource. To set the ARN for the policy, use the!Joinintrinsic function with''as delimiter and values of'execute-api:/'and'*'.
- restApi stringId 
- Property restApiId
- rootResource stringId 
- Property rootResourceId
- 
TagResponse[] 
- The key-value map of strings. The valid character set is [a-zA-Z+-=._:/]. The tag key can be up to 128 characters and must not start with aws:. The tag value can be up to 256 characters.
- api_key_ strsource_ type 
- The source of the API key for metering requests according to a usage plan. Valid values are: HEADERto read the API key from theX-API-Keyheader of a request.AUTHORIZERto read the API key from theUsageIdentifierKeyfrom a custom authorizer.
- binary_media_ Sequence[str]types 
- The list of binary media types supported by the RestApi. By default, the RestApi supports only UTF-8-encoded text payloads.
- body Any
- An OpenAPI specification that defines a set of RESTful APIs in JSON format. For YAML templates, you can also provide the specification in YAML format.
- body_s3_ S3Locationlocation Response 
- The Amazon Simple Storage Service (Amazon S3) location that points to an OpenAPI file, which defines a set of RESTful APIs in JSON or YAML format. S3Locationis a property of the AWS::ApiGateway::RestApi resource that specifies the Amazon S3 location of a OpenAPI (formerly Swagger) file that defines a set of RESTful APIs in JSON or YAML. On January 1, 2016, the Swagger Specification was donated to the OpenAPI initiative, becoming the foundation of the OpenAPI Specification.
- clone_from str
- The ID of the RestApi that you want to clone from.
- description str
- The description of the RestApi.
- disable_execute_ boolapi_ endpoint 
- Specifies whether clients can invoke your API by using the default execute-apiendpoint. By default, clients can invoke your API with the defaulthttps://{api_id}.execute-api.{region}.amazonaws.comendpoint. To require that clients use a custom domain name to invoke your API, disable the default endpoint
- endpoint_configuration EndpointConfiguration Response 
- A list of the endpoint types of the API. Use this property when creating an API. When importing an existing API, specify the endpoint configuration types using the Parametersproperty. TheEndpointConfigurationproperty type specifies the endpoint types of a REST API.EndpointConfigurationis a property of the AWS::ApiGateway::RestApi resource.
- fail_on_ boolwarnings 
- A query parameter to indicate whether to rollback the API update (true) or not (false) when a warning is encountered. The default value isfalse.
- minimum_compression_ intsize 
- A nullable integer that is used to enable compression (with non-negative between 0 and 10485760 (10M) bytes, inclusive) or disable compression (with a null value) on an API. When compression is enabled, compression or decompression is not applied on the payload if the payload size is smaller than this value. Setting it to zero allows compression for any payload size.
- mode str
- This property applies only when you use OpenAPI to define your REST API. The Modedetermines how API Gateway handles resource updates. Valid values areoverwriteormerge. Foroverwrite, the new API definition replaces the existing one. The existing API identifier remains unchanged. Formerge, the new API definition is merged with the existing API. If you don't specify this property, a default value is chosen. For REST APIs created before March 29, 2021, the default isoverwrite. For REST APIs created after March 29, 2021, the new API definition takes precedence, but any container types such as endpoint configurations and binary media types are merged with the existing API. Use the default mode to define top-levelRestApiproperties in addition to using OpenAPI. Generally, it's preferred to use API Gateway's OpenAPI extensions to model these properties.
- name str
- The name of the RestApi. A name is required if the REST API is not based on an OpenAPI specification.
- parameters Mapping[str, str]
- Custom header parameters as part of the request. For example, to exclude DocumentationParts from an imported API, set ignore=documentationas aparametersvalue, as in the AWS CLI command ofaws apigateway import-rest-api --parameters ignore=documentation --body 'file:///path/to/imported-api-body.json'.
- policy str
- A policy document that contains the permissions for the RestApiresource. To set the ARN for the policy, use the!Joinintrinsic function with''as delimiter and values of'execute-api:/'and'*'.
- rest_api_ strid 
- Property restApiId
- root_resource_ strid 
- Property rootResourceId
- 
Sequence[TagResponse] 
- The key-value map of strings. The valid character set is [a-zA-Z+-=._:/]. The tag key can be up to 128 characters and must not start with aws:. The tag value can be up to 256 characters.
- apiKey StringSource Type 
- The source of the API key for metering requests according to a usage plan. Valid values are: HEADERto read the API key from theX-API-Keyheader of a request.AUTHORIZERto read the API key from theUsageIdentifierKeyfrom a custom authorizer.
- binaryMedia List<String>Types 
- The list of binary media types supported by the RestApi. By default, the RestApi supports only UTF-8-encoded text payloads.
- body Any
- An OpenAPI specification that defines a set of RESTful APIs in JSON format. For YAML templates, you can also provide the specification in YAML format.
- bodyS3Location Property Map
- The Amazon Simple Storage Service (Amazon S3) location that points to an OpenAPI file, which defines a set of RESTful APIs in JSON or YAML format. S3Locationis a property of the AWS::ApiGateway::RestApi resource that specifies the Amazon S3 location of a OpenAPI (formerly Swagger) file that defines a set of RESTful APIs in JSON or YAML. On January 1, 2016, the Swagger Specification was donated to the OpenAPI initiative, becoming the foundation of the OpenAPI Specification.
- cloneFrom String
- The ID of the RestApi that you want to clone from.
- description String
- The description of the RestApi.
- disableExecute BooleanApi Endpoint 
- Specifies whether clients can invoke your API by using the default execute-apiendpoint. By default, clients can invoke your API with the defaulthttps://{api_id}.execute-api.{region}.amazonaws.comendpoint. To require that clients use a custom domain name to invoke your API, disable the default endpoint
- endpointConfiguration Property Map
- A list of the endpoint types of the API. Use this property when creating an API. When importing an existing API, specify the endpoint configuration types using the Parametersproperty. TheEndpointConfigurationproperty type specifies the endpoint types of a REST API.EndpointConfigurationis a property of the AWS::ApiGateway::RestApi resource.
- failOn BooleanWarnings 
- A query parameter to indicate whether to rollback the API update (true) or not (false) when a warning is encountered. The default value isfalse.
- minimumCompression NumberSize 
- A nullable integer that is used to enable compression (with non-negative between 0 and 10485760 (10M) bytes, inclusive) or disable compression (with a null value) on an API. When compression is enabled, compression or decompression is not applied on the payload if the payload size is smaller than this value. Setting it to zero allows compression for any payload size.
- mode String
- This property applies only when you use OpenAPI to define your REST API. The Modedetermines how API Gateway handles resource updates. Valid values areoverwriteormerge. Foroverwrite, the new API definition replaces the existing one. The existing API identifier remains unchanged. Formerge, the new API definition is merged with the existing API. If you don't specify this property, a default value is chosen. For REST APIs created before March 29, 2021, the default isoverwrite. For REST APIs created after March 29, 2021, the new API definition takes precedence, but any container types such as endpoint configurations and binary media types are merged with the existing API. Use the default mode to define top-levelRestApiproperties in addition to using OpenAPI. Generally, it's preferred to use API Gateway's OpenAPI extensions to model these properties.
- name String
- The name of the RestApi. A name is required if the REST API is not based on an OpenAPI specification.
- parameters Map<String>
- Custom header parameters as part of the request. For example, to exclude DocumentationParts from an imported API, set ignore=documentationas aparametersvalue, as in the AWS CLI command ofaws apigateway import-rest-api --parameters ignore=documentation --body 'file:///path/to/imported-api-body.json'.
- policy String
- A policy document that contains the permissions for the RestApiresource. To set the ARN for the policy, use the!Joinintrinsic function with''as delimiter and values of'execute-api:/'and'*'.
- restApi StringId 
- Property restApiId
- rootResource StringId 
- Property rootResourceId
- List<Property Map>
- The key-value map of strings. The valid character set is [a-zA-Z+-=._:/]. The tag key can be up to 128 characters and must not start with aws:. The tag value can be up to 256 characters.
EndpointConfiguration, EndpointConfigurationArgs    
- Types List<string>
- A list of endpoint types of an API (RestApi) or its custom domain name (DomainName). For an edge-optimized API and its custom domain name, the endpoint type is 'EDGE'. For a regional API and its custom domain name, the endpoint type isREGIONAL. For a private API, the endpoint type isPRIVATE.
- VpcEndpoint List<string>Ids 
- A list of VpcEndpointIds of an API (RestApi) against which to create Route53 ALIASes. It is only supported for PRIVATEendpoint type.
- Types []string
- A list of endpoint types of an API (RestApi) or its custom domain name (DomainName). For an edge-optimized API and its custom domain name, the endpoint type is 'EDGE'. For a regional API and its custom domain name, the endpoint type isREGIONAL. For a private API, the endpoint type isPRIVATE.
- VpcEndpoint []stringIds 
- A list of VpcEndpointIds of an API (RestApi) against which to create Route53 ALIASes. It is only supported for PRIVATEendpoint type.
- types List<String>
- A list of endpoint types of an API (RestApi) or its custom domain name (DomainName). For an edge-optimized API and its custom domain name, the endpoint type is 'EDGE'. For a regional API and its custom domain name, the endpoint type isREGIONAL. For a private API, the endpoint type isPRIVATE.
- vpcEndpoint List<String>Ids 
- A list of VpcEndpointIds of an API (RestApi) against which to create Route53 ALIASes. It is only supported for PRIVATEendpoint type.
- types string[]
- A list of endpoint types of an API (RestApi) or its custom domain name (DomainName). For an edge-optimized API and its custom domain name, the endpoint type is 'EDGE'. For a regional API and its custom domain name, the endpoint type isREGIONAL. For a private API, the endpoint type isPRIVATE.
- vpcEndpoint string[]Ids 
- A list of VpcEndpointIds of an API (RestApi) against which to create Route53 ALIASes. It is only supported for PRIVATEendpoint type.
- types Sequence[str]
- A list of endpoint types of an API (RestApi) or its custom domain name (DomainName). For an edge-optimized API and its custom domain name, the endpoint type is 'EDGE'. For a regional API and its custom domain name, the endpoint type isREGIONAL. For a private API, the endpoint type isPRIVATE.
- vpc_endpoint_ Sequence[str]ids 
- A list of VpcEndpointIds of an API (RestApi) against which to create Route53 ALIASes. It is only supported for PRIVATEendpoint type.
- types List<String>
- A list of endpoint types of an API (RestApi) or its custom domain name (DomainName). For an edge-optimized API and its custom domain name, the endpoint type is 'EDGE'. For a regional API and its custom domain name, the endpoint type isREGIONAL. For a private API, the endpoint type isPRIVATE.
- vpcEndpoint List<String>Ids 
- A list of VpcEndpointIds of an API (RestApi) against which to create Route53 ALIASes. It is only supported for PRIVATEendpoint type.
EndpointConfigurationResponse, EndpointConfigurationResponseArgs      
- Types List<string>
- A list of endpoint types of an API (RestApi) or its custom domain name (DomainName). For an edge-optimized API and its custom domain name, the endpoint type is 'EDGE'. For a regional API and its custom domain name, the endpoint type isREGIONAL. For a private API, the endpoint type isPRIVATE.
- VpcEndpoint List<string>Ids 
- A list of VpcEndpointIds of an API (RestApi) against which to create Route53 ALIASes. It is only supported for PRIVATEendpoint type.
- Types []string
- A list of endpoint types of an API (RestApi) or its custom domain name (DomainName). For an edge-optimized API and its custom domain name, the endpoint type is 'EDGE'. For a regional API and its custom domain name, the endpoint type isREGIONAL. For a private API, the endpoint type isPRIVATE.
- VpcEndpoint []stringIds 
- A list of VpcEndpointIds of an API (RestApi) against which to create Route53 ALIASes. It is only supported for PRIVATEendpoint type.
- types List<String>
- A list of endpoint types of an API (RestApi) or its custom domain name (DomainName). For an edge-optimized API and its custom domain name, the endpoint type is 'EDGE'. For a regional API and its custom domain name, the endpoint type isREGIONAL. For a private API, the endpoint type isPRIVATE.
- vpcEndpoint List<String>Ids 
- A list of VpcEndpointIds of an API (RestApi) against which to create Route53 ALIASes. It is only supported for PRIVATEendpoint type.
- types string[]
- A list of endpoint types of an API (RestApi) or its custom domain name (DomainName). For an edge-optimized API and its custom domain name, the endpoint type is 'EDGE'. For a regional API and its custom domain name, the endpoint type isREGIONAL. For a private API, the endpoint type isPRIVATE.
- vpcEndpoint string[]Ids 
- A list of VpcEndpointIds of an API (RestApi) against which to create Route53 ALIASes. It is only supported for PRIVATEendpoint type.
- types Sequence[str]
- A list of endpoint types of an API (RestApi) or its custom domain name (DomainName). For an edge-optimized API and its custom domain name, the endpoint type is 'EDGE'. For a regional API and its custom domain name, the endpoint type isREGIONAL. For a private API, the endpoint type isPRIVATE.
- vpc_endpoint_ Sequence[str]ids 
- A list of VpcEndpointIds of an API (RestApi) against which to create Route53 ALIASes. It is only supported for PRIVATEendpoint type.
- types List<String>
- A list of endpoint types of an API (RestApi) or its custom domain name (DomainName). For an edge-optimized API and its custom domain name, the endpoint type is 'EDGE'. For a regional API and its custom domain name, the endpoint type isREGIONAL. For a private API, the endpoint type isPRIVATE.
- vpcEndpoint List<String>Ids 
- A list of VpcEndpointIds of an API (RestApi) against which to create Route53 ALIASes. It is only supported for PRIVATEendpoint type.
S3Location, S3LocationArgs  
- Bucket string
- The name of the S3 bucket where the OpenAPI file is stored.
- ETag string
- The Amazon S3 ETag (a file checksum) of the OpenAPI file. If you don't specify a value, API Gateway skips ETag validation of your OpenAPI file.
- Key string
- The file name of the OpenAPI file (Amazon S3 object name).
- Version string
- For versioning-enabled buckets, a specific version of the OpenAPI file.
- Bucket string
- The name of the S3 bucket where the OpenAPI file is stored.
- ETag string
- The Amazon S3 ETag (a file checksum) of the OpenAPI file. If you don't specify a value, API Gateway skips ETag validation of your OpenAPI file.
- Key string
- The file name of the OpenAPI file (Amazon S3 object name).
- Version string
- For versioning-enabled buckets, a specific version of the OpenAPI file.
- bucket String
- The name of the S3 bucket where the OpenAPI file is stored.
- eTag String
- The Amazon S3 ETag (a file checksum) of the OpenAPI file. If you don't specify a value, API Gateway skips ETag validation of your OpenAPI file.
- key String
- The file name of the OpenAPI file (Amazon S3 object name).
- version String
- For versioning-enabled buckets, a specific version of the OpenAPI file.
- bucket string
- The name of the S3 bucket where the OpenAPI file is stored.
- eTag string
- The Amazon S3 ETag (a file checksum) of the OpenAPI file. If you don't specify a value, API Gateway skips ETag validation of your OpenAPI file.
- key string
- The file name of the OpenAPI file (Amazon S3 object name).
- version string
- For versioning-enabled buckets, a specific version of the OpenAPI file.
- bucket str
- The name of the S3 bucket where the OpenAPI file is stored.
- e_tag str
- The Amazon S3 ETag (a file checksum) of the OpenAPI file. If you don't specify a value, API Gateway skips ETag validation of your OpenAPI file.
- key str
- The file name of the OpenAPI file (Amazon S3 object name).
- version str
- For versioning-enabled buckets, a specific version of the OpenAPI file.
- bucket String
- The name of the S3 bucket where the OpenAPI file is stored.
- eTag String
- The Amazon S3 ETag (a file checksum) of the OpenAPI file. If you don't specify a value, API Gateway skips ETag validation of your OpenAPI file.
- key String
- The file name of the OpenAPI file (Amazon S3 object name).
- version String
- For versioning-enabled buckets, a specific version of the OpenAPI file.
S3LocationResponse, S3LocationResponseArgs    
- Bucket string
- The name of the S3 bucket where the OpenAPI file is stored.
- ETag string
- The Amazon S3 ETag (a file checksum) of the OpenAPI file. If you don't specify a value, API Gateway skips ETag validation of your OpenAPI file.
- Key string
- The file name of the OpenAPI file (Amazon S3 object name).
- Version string
- For versioning-enabled buckets, a specific version of the OpenAPI file.
- Bucket string
- The name of the S3 bucket where the OpenAPI file is stored.
- ETag string
- The Amazon S3 ETag (a file checksum) of the OpenAPI file. If you don't specify a value, API Gateway skips ETag validation of your OpenAPI file.
- Key string
- The file name of the OpenAPI file (Amazon S3 object name).
- Version string
- For versioning-enabled buckets, a specific version of the OpenAPI file.
- bucket String
- The name of the S3 bucket where the OpenAPI file is stored.
- eTag String
- The Amazon S3 ETag (a file checksum) of the OpenAPI file. If you don't specify a value, API Gateway skips ETag validation of your OpenAPI file.
- key String
- The file name of the OpenAPI file (Amazon S3 object name).
- version String
- For versioning-enabled buckets, a specific version of the OpenAPI file.
- bucket string
- The name of the S3 bucket where the OpenAPI file is stored.
- eTag string
- The Amazon S3 ETag (a file checksum) of the OpenAPI file. If you don't specify a value, API Gateway skips ETag validation of your OpenAPI file.
- key string
- The file name of the OpenAPI file (Amazon S3 object name).
- version string
- For versioning-enabled buckets, a specific version of the OpenAPI file.
- bucket str
- The name of the S3 bucket where the OpenAPI file is stored.
- e_tag str
- The Amazon S3 ETag (a file checksum) of the OpenAPI file. If you don't specify a value, API Gateway skips ETag validation of your OpenAPI file.
- key str
- The file name of the OpenAPI file (Amazon S3 object name).
- version str
- For versioning-enabled buckets, a specific version of the OpenAPI file.
- bucket String
- The name of the S3 bucket where the OpenAPI file is stored.
- eTag String
- The Amazon S3 ETag (a file checksum) of the OpenAPI file. If you don't specify a value, API Gateway skips ETag validation of your OpenAPI file.
- key String
- The file name of the OpenAPI file (Amazon S3 object name).
- version String
- For versioning-enabled buckets, a specific version of the OpenAPI file.
SystemDataResponse, SystemDataResponseArgs      
- CreatedAt string
- The timestamp of resource creation (UTC).
- CreatedBy string
- The identity that created the resource.
- CreatedBy stringType 
- The type of identity that created the resource.
- LastModified stringAt 
- The timestamp of resource last modification (UTC)
- LastModified stringBy 
- The identity that last modified the resource.
- LastModified stringBy Type 
- The type of identity that last modified the resource.
- CreatedAt string
- The timestamp of resource creation (UTC).
- CreatedBy string
- The identity that created the resource.
- CreatedBy stringType 
- The type of identity that created the resource.
- LastModified stringAt 
- The timestamp of resource last modification (UTC)
- LastModified stringBy 
- The identity that last modified the resource.
- LastModified stringBy Type 
- The type of identity that last modified the resource.
- createdAt String
- The timestamp of resource creation (UTC).
- createdBy String
- The identity that created the resource.
- createdBy StringType 
- The type of identity that created the resource.
- lastModified StringAt 
- The timestamp of resource last modification (UTC)
- lastModified StringBy 
- The identity that last modified the resource.
- lastModified StringBy Type 
- The type of identity that last modified the resource.
- createdAt string
- The timestamp of resource creation (UTC).
- createdBy string
- The identity that created the resource.
- createdBy stringType 
- The type of identity that created the resource.
- lastModified stringAt 
- The timestamp of resource last modification (UTC)
- lastModified stringBy 
- The identity that last modified the resource.
- lastModified stringBy Type 
- The type of identity that last modified the resource.
- created_at str
- The timestamp of resource creation (UTC).
- created_by str
- The identity that created the resource.
- created_by_ strtype 
- The type of identity that created the resource.
- last_modified_ strat 
- The timestamp of resource last modification (UTC)
- last_modified_ strby 
- The identity that last modified the resource.
- last_modified_ strby_ type 
- The type of identity that last modified the resource.
- createdAt String
- The timestamp of resource creation (UTC).
- createdBy String
- The identity that created the resource.
- createdBy StringType 
- The type of identity that created the resource.
- lastModified StringAt 
- The timestamp of resource last modification (UTC)
- lastModified StringBy 
- The identity that last modified the resource.
- lastModified StringBy Type 
- The type of identity that last modified the resource.
Tag, TagArgs  
- Key string
- The key name of the tag. You can specify a value that is 1 to 128 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -.
- Value string
- The value for the tag. You can specify a value that is 0 to 256 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -.
- Key string
- The key name of the tag. You can specify a value that is 1 to 128 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -.
- Value string
- The value for the tag. You can specify a value that is 0 to 256 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -.
- key String
- The key name of the tag. You can specify a value that is 1 to 128 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -.
- value String
- The value for the tag. You can specify a value that is 0 to 256 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -.
- key string
- The key name of the tag. You can specify a value that is 1 to 128 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -.
- value string
- The value for the tag. You can specify a value that is 0 to 256 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -.
- key str
- The key name of the tag. You can specify a value that is 1 to 128 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -.
- value str
- The value for the tag. You can specify a value that is 0 to 256 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -.
- key String
- The key name of the tag. You can specify a value that is 1 to 128 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -.
- value String
- The value for the tag. You can specify a value that is 0 to 256 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -.
TagResponse, TagResponseArgs    
- Key string
- The key name of the tag. You can specify a value that is 1 to 128 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -.
- Value string
- The value for the tag. You can specify a value that is 0 to 256 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -.
- Key string
- The key name of the tag. You can specify a value that is 1 to 128 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -.
- Value string
- The value for the tag. You can specify a value that is 0 to 256 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -.
- key String
- The key name of the tag. You can specify a value that is 1 to 128 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -.
- value String
- The value for the tag. You can specify a value that is 0 to 256 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -.
- key string
- The key name of the tag. You can specify a value that is 1 to 128 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -.
- value string
- The value for the tag. You can specify a value that is 0 to 256 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -.
- key str
- The key name of the tag. You can specify a value that is 1 to 128 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -.
- value str
- The value for the tag. You can specify a value that is 0 to 256 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -.
- key String
- The key name of the tag. You can specify a value that is 1 to 128 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -.
- value String
- The value for the tag. You can specify a value that is 0 to 256 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -.
Import
An existing resource can be imported using its type token, name, and identifier, e.g.
$ pulumi import azure-native:awsconnector:ApiGatewayRestApi fkngxaddvxbddxbt /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AwsConnector/apiGatewayRestApis/{name} 
To learn more about importing existing cloud resources, see Importing resources.
Package Details
- Repository
- Azure Native pulumi/pulumi-azure-native
- License
- Apache-2.0