Docs Home Pulumi IaC Pulumi ESC Pulumi Cloud Packages Tutorials
  1. Packages
  2. Azure Native
  3. API Docs
  4. awsconnector
  5. getApiGatewayRestApi
This is the latest version of Azure Native. Use the Azure Native v1 docs if using the v1 version of this package.
Azure Native v2.73.0 published on Wednesday, Nov 20, 2024 by Pulumi
pulumi/pulumi-azure-native

azure-native.awsconnector.getApiGatewayRestApi

Explore with Pulumi AI

azure-native logo
This is the latest version of Azure Native. Use the Azure Native v1 docs if using the v1 version of this package.
Azure Native v2.73.0 published on Wednesday, Nov 20, 2024 by Pulumi
pulumi/pulumi-azure-native

    Get a ApiGatewayRestApi Azure REST API version: 2024-12-01.

    Using getApiGatewayRestApi

    Two invocation forms are available. The direct form accepts plain arguments and either blocks until the result value is available, or returns a Promise-wrapped result. The output form accepts Input-wrapped arguments and returns an Output-wrapped result.

    function getApiGatewayRestApi(args: GetApiGatewayRestApiArgs, opts?: InvokeOptions): Promise<GetApiGatewayRestApiResult>
function getApiGatewayRestApiOutput(args: GetApiGatewayRestApiOutputArgs, opts?: InvokeOptions): Output<GetApiGatewayRestApiResult>
    def get_api_gateway_rest_api(name: Optional[str] = None,
                             resource_group_name: Optional[str] = None,
                             opts: Optional[InvokeOptions] = None) -> GetApiGatewayRestApiResult
def get_api_gateway_rest_api_output(name: Optional[pulumi.Input[str]] = None,
                             resource_group_name: Optional[pulumi.Input[str]] = None,
                             opts: Optional[InvokeOptions] = None) -> Output[GetApiGatewayRestApiResult]
    func LookupApiGatewayRestApi(ctx *Context, args *LookupApiGatewayRestApiArgs, opts ...InvokeOption) (*LookupApiGatewayRestApiResult, error)
func LookupApiGatewayRestApiOutput(ctx *Context, args *LookupApiGatewayRestApiOutputArgs, opts ...InvokeOption) LookupApiGatewayRestApiResultOutput

    > Note: This function is named LookupApiGatewayRestApi in the Go SDK.

    public static class GetApiGatewayRestApi 
{
    public static Task<GetApiGatewayRestApiResult> InvokeAsync(GetApiGatewayRestApiArgs args, InvokeOptions? opts = null)
    public static Output<GetApiGatewayRestApiResult> Invoke(GetApiGatewayRestApiInvokeArgs args, InvokeOptions? opts = null)
}
    public static CompletableFuture<GetApiGatewayRestApiResult> getApiGatewayRestApi(GetApiGatewayRestApiArgs args, InvokeOptions options)
// Output-based functions aren't available in Java yet

    fn::invoke:
  function: azure-native:awsconnector:getApiGatewayRestApi
  arguments:
    # arguments dictionary

    The following arguments are supported:

    Name string
    Name of ApiGatewayRestApi
    ResourceGroupName string
    The name of the resource group. The name is case insensitive.
    Name string
    Name of ApiGatewayRestApi
    ResourceGroupName string
    The name of the resource group. The name is case insensitive.
    name String
    Name of ApiGatewayRestApi
    resourceGroupName String
    The name of the resource group. The name is case insensitive.
    name string
    Name of ApiGatewayRestApi
    resourceGroupName string
    The name of the resource group. The name is case insensitive.
    name str
    Name of ApiGatewayRestApi
    resource_group_name str
    The name of the resource group. The name is case insensitive.
    name String
    Name of ApiGatewayRestApi
    resourceGroupName String
    The name of the resource group. The name is case insensitive.

    getApiGatewayRestApi Result

    The following output properties are available:

    Id string
    Fully qualified resource ID for the resource. E.g. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
    Location string
    The geo-location where the resource lives
    Name string
    The name of the resource
    Properties Pulumi.AzureNative.AwsConnector.Outputs.ApiGatewayRestApiPropertiesResponse
    The resource-specific properties for this resource.
    SystemData Pulumi.AzureNative.AwsConnector.Outputs.SystemDataResponse
    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"
    Tags Dictionary<string, string>
    Resource tags.
    Id string
    Fully qualified resource ID for the resource. E.g. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
    Location string
    The geo-location where the resource lives
    Name string
    The name of the resource
    Properties ApiGatewayRestApiPropertiesResponse
    The resource-specific properties for this resource.
    SystemData SystemDataResponse
    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"
    Tags map[string]string
    Resource tags.
    id String
    Fully qualified resource ID for the resource. E.g. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
    location String
    The geo-location where the resource lives
    name String
    The name of the resource
    properties ApiGatewayRestApiPropertiesResponse
    The resource-specific properties for this resource.
    systemData SystemDataResponse
    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"
    tags Map<String,String>
    Resource tags.
    id string
    Fully qualified resource ID for the resource. E.g. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
    location string
    The geo-location where the resource lives
    name string
    The name of the resource
    properties ApiGatewayRestApiPropertiesResponse
    The resource-specific properties for this resource.
    systemData SystemDataResponse
    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"
    tags {[key: string]: string}
    Resource tags.
    id str
    Fully qualified resource ID for the resource. E.g. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
    location str
    The geo-location where the resource lives
    name str
    The name of the resource
    properties ApiGatewayRestApiPropertiesResponse
    The resource-specific properties for this resource.
    system_data SystemDataResponse
    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"
    tags Mapping[str, str]
    Resource tags.
    id String
    Fully qualified resource ID for the resource. E.g. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
    location String
    The geo-location where the resource lives
    name String
    The name of the resource
    properties Property Map
    The resource-specific properties for this 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"
    tags Map<String>
    Resource tags.

    Supporting Types

    ApiGatewayRestApiPropertiesResponse

    ProvisioningState string
    The status of the last operation.
    Arn string
    Amazon Resource Name (ARN)
    AwsAccountId string
    AWS Account ID
    AwsProperties Pulumi.AzureNative.AwsConnector.Inputs.AwsApiGatewayRestApiPropertiesResponse
    AWS Properties
    AwsRegion string
    AWS Region
    AwsSourceSchema string
    AWS Source Schema
    AwsTags Dictionary<string, string>
    AWS Tags
    PublicCloudConnectorsResourceId string
    Public Cloud Connectors Resource ID
    PublicCloudResourceName string
    Public Cloud Resource Name
    ProvisioningState string
    The status of the last operation.
    Arn string
    Amazon Resource Name (ARN)
    AwsAccountId string
    AWS Account ID
    AwsProperties AwsApiGatewayRestApiPropertiesResponse
    AWS Properties
    AwsRegion string
    AWS Region
    AwsSourceSchema string
    AWS Source Schema
    AwsTags map[string]string
    AWS Tags
    PublicCloudConnectorsResourceId string
    Public Cloud Connectors Resource ID
    PublicCloudResourceName string
    Public Cloud Resource Name
    provisioningState String
    The status of the last operation.
    arn String
    Amazon Resource Name (ARN)
    awsAccountId String
    AWS Account ID
    awsProperties AwsApiGatewayRestApiPropertiesResponse
    AWS Properties
    awsRegion String
    AWS Region
    awsSourceSchema String
    AWS Source Schema
    awsTags Map<String,String>
    AWS Tags
    publicCloudConnectorsResourceId String
    Public Cloud Connectors Resource ID
    publicCloudResourceName String
    Public Cloud Resource Name
    provisioningState string
    The status of the last operation.
    arn string
    Amazon Resource Name (ARN)
    awsAccountId string
    AWS Account ID
    awsProperties AwsApiGatewayRestApiPropertiesResponse
    AWS Properties
    awsRegion string
    AWS Region
    awsSourceSchema string
    AWS Source Schema
    awsTags {[key: string]: string}
    AWS Tags
    publicCloudConnectorsResourceId string
    Public Cloud Connectors Resource ID
    publicCloudResourceName string
    Public Cloud Resource Name
    provisioning_state str
    The status of the last operation.
    arn str
    Amazon Resource Name (ARN)
    aws_account_id str
    AWS Account ID
    aws_properties AwsApiGatewayRestApiPropertiesResponse
    AWS Properties
    aws_region str
    AWS Region
    aws_source_schema str
    AWS Source Schema
    aws_tags Mapping[str, str]
    AWS Tags
    public_cloud_connectors_resource_id str
    Public Cloud Connectors Resource ID
    public_cloud_resource_name str
    Public Cloud Resource Name
    provisioningState String
    The status of the last operation.
    arn String
    Amazon Resource Name (ARN)
    awsAccountId String
    AWS Account ID
    awsProperties Property Map
    AWS Properties
    awsRegion String
    AWS Region
    awsSourceSchema String
    AWS Source Schema
    awsTags Map<String>
    AWS Tags
    publicCloudConnectorsResourceId String
    Public Cloud Connectors Resource ID
    publicCloudResourceName String
    Public Cloud Resource Name

    AwsApiGatewayRestApiPropertiesResponse

    ApiKeySourceType string
    The source of the API key for metering requests according to a usage plan. Valid values are: HEADER to read the API key from the X-API-Key header of a request. AUTHORIZER to read the API key from the UsageIdentifierKey from a custom authorizer.
    BinaryMediaTypes List<string>
    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.AzureNative.AwsConnector.Inputs.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. S3Location is 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.
    DisableExecuteApiEndpoint bool
    Specifies whether clients can invoke your API by using the default execute-api endpoint. By default, clients can invoke your API with the default https://{api_id}.execute-api.{region}.amazonaws.com endpoint. To require that clients use a custom domain name to invoke your API, disable the default endpoint
    EndpointConfiguration Pulumi.AzureNative.AwsConnector.Inputs.EndpointConfigurationResponse
    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 Parameters property. The EndpointConfiguration property type specifies the endpoint types of a REST API. EndpointConfiguration is a property of the AWS::ApiGateway::RestApi resource.
    FailOnWarnings bool
    A query parameter to indicate whether to rollback the API update (true) or not (false) when a warning is encountered. The default value is false.
    MinimumCompressionSize int
    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 Mode determines how API Gateway handles resource updates. Valid values are overwrite or merge. For overwrite, the new API definition replaces the existing one. The existing API identifier remains unchanged. For merge, 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 is overwrite. 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-level RestApi properties 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=documentation as a parameters value, as in the AWS CLI command of aws 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 RestApi resource. To set the ARN for the policy, use the !Join intrinsic function with '' as delimiter and values of 'execute-api:/' and '*'.
    RestApiId string
    Property restApiId
    RootResourceId string
    Property rootResourceId
    Tags List<Pulumi.AzureNative.AwsConnector.Inputs.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.
    ApiKeySourceType string
    The source of the API key for metering requests according to a usage plan. Valid values are: HEADER to read the API key from the X-API-Key header of a request. AUTHORIZER to read the API key from the UsageIdentifierKey from a custom authorizer.
    BinaryMediaTypes []string
    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. S3Location is 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.
    DisableExecuteApiEndpoint bool
    Specifies whether clients can invoke your API by using the default execute-api endpoint. By default, clients can invoke your API with the default https://{api_id}.execute-api.{region}.amazonaws.com endpoint. To require that clients use a custom domain name to invoke your API, disable the default endpoint
    EndpointConfiguration EndpointConfigurationResponse
    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 Parameters property. The EndpointConfiguration property type specifies the endpoint types of a REST API. EndpointConfiguration is a property of the AWS::ApiGateway::RestApi resource.
    FailOnWarnings bool
    A query parameter to indicate whether to rollback the API update (true) or not (false) when a warning is encountered. The default value is false.
    MinimumCompressionSize int
    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 Mode determines how API Gateway handles resource updates. Valid values are overwrite or merge. For overwrite, the new API definition replaces the existing one. The existing API identifier remains unchanged. For merge, 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 is overwrite. 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-level RestApi properties 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=documentation as a parameters value, as in the AWS CLI command of aws 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 RestApi resource. To set the ARN for the policy, use the !Join intrinsic function with '' as delimiter and values of 'execute-api:/' and '*'.
    RestApiId string
    Property restApiId
    RootResourceId string
    Property rootResourceId
    Tags []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.
    apiKeySourceType String
    The source of the API key for metering requests according to a usage plan. Valid values are: HEADER to read the API key from the X-API-Key header of a request. AUTHORIZER to read the API key from the UsageIdentifierKey from a custom authorizer.
    binaryMediaTypes List<String>
    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. S3Location is 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.
    disableExecuteApiEndpoint Boolean
    Specifies whether clients can invoke your API by using the default execute-api endpoint. By default, clients can invoke your API with the default https://{api_id}.execute-api.{region}.amazonaws.com endpoint. To require that clients use a custom domain name to invoke your API, disable the default endpoint
    endpointConfiguration EndpointConfigurationResponse
    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 Parameters property. The EndpointConfiguration property type specifies the endpoint types of a REST API. EndpointConfiguration is a property of the AWS::ApiGateway::RestApi resource.
    failOnWarnings Boolean
    A query parameter to indicate whether to rollback the API update (true) or not (false) when a warning is encountered. The default value is false.
    minimumCompressionSize Integer
    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 Mode determines how API Gateway handles resource updates. Valid values are overwrite or merge. For overwrite, the new API definition replaces the existing one. The existing API identifier remains unchanged. For merge, 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 is overwrite. 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-level RestApi properties 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=documentation as a parameters value, as in the AWS CLI command of aws 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 RestApi resource. To set the ARN for the policy, use the !Join intrinsic function with '' as delimiter and values of 'execute-api:/' and '*'.
    restApiId String
    Property restApiId
    rootResourceId String
    Property rootResourceId
    tags 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.
    apiKeySourceType string
    The source of the API key for metering requests according to a usage plan. Valid values are: HEADER to read the API key from the X-API-Key header of a request. AUTHORIZER to read the API key from the UsageIdentifierKey from a custom authorizer.
    binaryMediaTypes string[]
    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. S3Location is 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.
    disableExecuteApiEndpoint boolean
    Specifies whether clients can invoke your API by using the default execute-api endpoint. By default, clients can invoke your API with the default https://{api_id}.execute-api.{region}.amazonaws.com endpoint. To require that clients use a custom domain name to invoke your API, disable the default endpoint
    endpointConfiguration EndpointConfigurationResponse
    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 Parameters property. The EndpointConfiguration property type specifies the endpoint types of a REST API. EndpointConfiguration is a property of the AWS::ApiGateway::RestApi resource.
    failOnWarnings boolean
    A query parameter to indicate whether to rollback the API update (true) or not (false) when a warning is encountered. The default value is false.
    minimumCompressionSize number
    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 Mode determines how API Gateway handles resource updates. Valid values are overwrite or merge. For overwrite, the new API definition replaces the existing one. The existing API identifier remains unchanged. For merge, 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 is overwrite. 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-level RestApi properties 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=documentation as a parameters value, as in the AWS CLI command of aws 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 RestApi resource. To set the ARN for the policy, use the !Join intrinsic function with '' as delimiter and values of 'execute-api:/' and '*'.
    restApiId string
    Property restApiId
    rootResourceId string
    Property rootResourceId
    tags 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_source_type str
    The source of the API key for metering requests according to a usage plan. Valid values are: HEADER to read the API key from the X-API-Key header of a request. AUTHORIZER to read the API key from the UsageIdentifierKey from a custom authorizer.
    binary_media_types Sequence[str]
    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_location 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. S3Location is 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_api_endpoint bool
    Specifies whether clients can invoke your API by using the default execute-api endpoint. By default, clients can invoke your API with the default https://{api_id}.execute-api.{region}.amazonaws.com endpoint. To require that clients use a custom domain name to invoke your API, disable the default endpoint
    endpoint_configuration EndpointConfigurationResponse
    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 Parameters property. The EndpointConfiguration property type specifies the endpoint types of a REST API. EndpointConfiguration is a property of the AWS::ApiGateway::RestApi resource.
    fail_on_warnings bool
    A query parameter to indicate whether to rollback the API update (true) or not (false) when a warning is encountered. The default value is false.
    minimum_compression_size int
    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 Mode determines how API Gateway handles resource updates. Valid values are overwrite or merge. For overwrite, the new API definition replaces the existing one. The existing API identifier remains unchanged. For merge, 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 is overwrite. 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-level RestApi properties 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=documentation as a parameters value, as in the AWS CLI command of aws 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 RestApi resource. To set the ARN for the policy, use the !Join intrinsic function with '' as delimiter and values of 'execute-api:/' and '*'.
    rest_api_id str
    Property restApiId
    root_resource_id str
    Property rootResourceId
    tags 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.
    apiKeySourceType String
    The source of the API key for metering requests according to a usage plan. Valid values are: HEADER to read the API key from the X-API-Key header of a request. AUTHORIZER to read the API key from the UsageIdentifierKey from a custom authorizer.
    binaryMediaTypes List<String>
    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. S3Location is 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.
    disableExecuteApiEndpoint Boolean
    Specifies whether clients can invoke your API by using the default execute-api endpoint. By default, clients can invoke your API with the default https://{api_id}.execute-api.{region}.amazonaws.com endpoint. 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 Parameters property. The EndpointConfiguration property type specifies the endpoint types of a REST API. EndpointConfiguration is a property of the AWS::ApiGateway::RestApi resource.
    failOnWarnings Boolean
    A query parameter to indicate whether to rollback the API update (true) or not (false) when a warning is encountered. The default value is false.
    minimumCompressionSize Number
    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 Mode determines how API Gateway handles resource updates. Valid values are overwrite or merge. For overwrite, the new API definition replaces the existing one. The existing API identifier remains unchanged. For merge, 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 is overwrite. 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-level RestApi properties 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=documentation as a parameters value, as in the AWS CLI command of aws 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 RestApi resource. To set the ARN for the policy, use the !Join intrinsic function with '' as delimiter and values of 'execute-api:/' and '*'.
    restApiId String
    Property restApiId
    rootResourceId String
    Property rootResourceId
    tags 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.

    EndpointConfigurationResponse

    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 is REGIONAL. For a private API, the endpoint type is PRIVATE.
    VpcEndpointIds List<string>
    A list of VpcEndpointIds of an API (RestApi) against which to create Route53 ALIASes. It is only supported for PRIVATE endpoint 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 is REGIONAL. For a private API, the endpoint type is PRIVATE.
    VpcEndpointIds []string
    A list of VpcEndpointIds of an API (RestApi) against which to create Route53 ALIASes. It is only supported for PRIVATE endpoint 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 is REGIONAL. For a private API, the endpoint type is PRIVATE.
    vpcEndpointIds List<String>
    A list of VpcEndpointIds of an API (RestApi) against which to create Route53 ALIASes. It is only supported for PRIVATE endpoint 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 is REGIONAL. For a private API, the endpoint type is PRIVATE.
    vpcEndpointIds string[]
    A list of VpcEndpointIds of an API (RestApi) against which to create Route53 ALIASes. It is only supported for PRIVATE endpoint 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 is REGIONAL. For a private API, the endpoint type is PRIVATE.
    vpc_endpoint_ids Sequence[str]
    A list of VpcEndpointIds of an API (RestApi) against which to create Route53 ALIASes. It is only supported for PRIVATE endpoint 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 is REGIONAL. For a private API, the endpoint type is PRIVATE.
    vpcEndpointIds List<String>
    A list of VpcEndpointIds of an API (RestApi) against which to create Route53 ALIASes. It is only supported for PRIVATE endpoint type.

    S3LocationResponse

    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

    CreatedAt string
    The timestamp of resource creation (UTC).
    CreatedBy string
    The identity that created the resource.
    CreatedByType string
    The type of identity that created the resource.
    LastModifiedAt string
    The timestamp of resource last modification (UTC)
    LastModifiedBy string
    The identity that last modified the resource.
    LastModifiedByType string
    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.
    CreatedByType string
    The type of identity that created the resource.
    LastModifiedAt string
    The timestamp of resource last modification (UTC)
    LastModifiedBy string
    The identity that last modified the resource.
    LastModifiedByType string
    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.
    createdByType String
    The type of identity that created the resource.
    lastModifiedAt String
    The timestamp of resource last modification (UTC)
    lastModifiedBy String
    The identity that last modified the resource.
    lastModifiedByType String
    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.
    createdByType string
    The type of identity that created the resource.
    lastModifiedAt string
    The timestamp of resource last modification (UTC)
    lastModifiedBy string
    The identity that last modified the resource.
    lastModifiedByType string
    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_type str
    The type of identity that created the resource.
    last_modified_at str
    The timestamp of resource last modification (UTC)
    last_modified_by str
    The identity that last modified the resource.
    last_modified_by_type str
    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.
    createdByType String
    The type of identity that created the resource.
    lastModifiedAt String
    The timestamp of resource last modification (UTC)
    lastModifiedBy String
    The identity that last modified the resource.
    lastModifiedByType String
    The type of identity that last modified the resource.

    TagResponse

    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 -.

    Package Details

    Repository
    Azure Native pulumi/pulumi-azure-native
    License
    Apache-2.0
    azure-native logo
    This is the latest version of Azure Native. Use the Azure Native v1 docs if using the v1 version of this package.
    Azure Native v2.73.0 published on Wednesday, Nov 20, 2024 by Pulumi
    pulumi/pulumi-azure-native