Azure Native v3.8.0, Sep 3 25

This is the latest version of Azure Native. Use the Azure Native v2 docs if using the v2 version of this package.

Azure Native v3.8.0 published on Wednesday, Sep 3, 2025 by Pulumi

pulumi/pulumi-azure-native

azure-native.awsconnector.getApiGatewayStage

This is the latest version of Azure Native. Use the Azure Native v2 docs if using the v2 version of this package.

Azure Native v3.8.0 published on Wednesday, Sep 3, 2025 by Pulumi

pulumi/pulumi-azure-native

Using getApiGatewayStage

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 getApiGatewayStage(args: GetApiGatewayStageArgs, opts?: InvokeOptions): Promise<GetApiGatewayStageResult>
function getApiGatewayStageOutput(args: GetApiGatewayStageOutputArgs, opts?: InvokeOptions): Output<GetApiGatewayStageResult>

def get_api_gateway_stage(name: Optional[str] = None,
                          resource_group_name: Optional[str] = None,
                          opts: Optional[InvokeOptions] = None) -> GetApiGatewayStageResult
def get_api_gateway_stage_output(name: Optional[pulumi.Input[str]] = None,
                          resource_group_name: Optional[pulumi.Input[str]] = None,
                          opts: Optional[InvokeOptions] = None) -> Output[GetApiGatewayStageResult]

func LookupApiGatewayStage(ctx *Context, args *LookupApiGatewayStageArgs, opts ...InvokeOption) (*LookupApiGatewayStageResult, error)
func LookupApiGatewayStageOutput(ctx *Context, args *LookupApiGatewayStageOutputArgs, opts ...InvokeOption) LookupApiGatewayStageResultOutput

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

public static class GetApiGatewayStage 
{
    public static Task<GetApiGatewayStageResult> InvokeAsync(GetApiGatewayStageArgs args, InvokeOptions? opts = null)
    public static Output<GetApiGatewayStageResult> Invoke(GetApiGatewayStageInvokeArgs args, InvokeOptions? opts = null)
}

public static CompletableFuture<GetApiGatewayStageResult> getApiGatewayStage(GetApiGatewayStageArgs args, InvokeOptions options)
public static Output<GetApiGatewayStageResult> getApiGatewayStage(GetApiGatewayStageArgs args, InvokeOptions options)

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

The following arguments are supported:

Name string: Name of ApiGatewayStage
ResourceGroupName string: The name of the resource group. The name is case insensitive.

Name string: Name of ApiGatewayStage
ResourceGroupName string: The name of the resource group. The name is case insensitive.

name String: Name of ApiGatewayStage
resourceGroupName String: The name of the resource group. The name is case insensitive.

name string: Name of ApiGatewayStage
resourceGroupName string: The name of the resource group. The name is case insensitive.

name str: Name of ApiGatewayStage
resource_group_name str: The name of the resource group. The name is case insensitive.

name String: Name of ApiGatewayStage
resourceGroupName String: The name of the resource group. The name is case insensitive.

getApiGatewayStage Result

The following output properties are available:

AzureApiVersion string: The Azure API version of the resource.
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.ApiGatewayStagePropertiesResponse: 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.

AzureApiVersion string: The Azure API version of the resource.
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 ApiGatewayStagePropertiesResponse: 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.

azureApiVersion String: The Azure API version of the resource.
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 ApiGatewayStagePropertiesResponse: 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.

azureApiVersion string: The Azure API version of the resource.
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 ApiGatewayStagePropertiesResponse: 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.

azure_api_version str: The Azure API version of the resource.
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 ApiGatewayStagePropertiesResponse: 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.

azureApiVersion String: The Azure API version of the resource.
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

AccessLogSettingResponse

DestinationArn string: The Amazon Resource Name (ARN) of the CloudWatch Logs log group or Kinesis Data Firehose delivery stream to receive access logs. If you specify a Kinesis Data Firehose delivery stream, the stream name must begin with amazon-apigateway-. This parameter is required to enable access logging.
Format string: A single line format of the access logs of data, as specified by selected $context variables. The format must include at least $context.requestId. This parameter is required to enable access logging.

DestinationArn string: The Amazon Resource Name (ARN) of the CloudWatch Logs log group or Kinesis Data Firehose delivery stream to receive access logs. If you specify a Kinesis Data Firehose delivery stream, the stream name must begin with amazon-apigateway-. This parameter is required to enable access logging.
Format string: A single line format of the access logs of data, as specified by selected $context variables. The format must include at least $context.requestId. This parameter is required to enable access logging.

destinationArn String: The Amazon Resource Name (ARN) of the CloudWatch Logs log group or Kinesis Data Firehose delivery stream to receive access logs. If you specify a Kinesis Data Firehose delivery stream, the stream name must begin with amazon-apigateway-. This parameter is required to enable access logging.
format String: A single line format of the access logs of data, as specified by selected $context variables. The format must include at least $context.requestId. This parameter is required to enable access logging.

destinationArn string: The Amazon Resource Name (ARN) of the CloudWatch Logs log group or Kinesis Data Firehose delivery stream to receive access logs. If you specify a Kinesis Data Firehose delivery stream, the stream name must begin with amazon-apigateway-. This parameter is required to enable access logging.
format string: A single line format of the access logs of data, as specified by selected $context variables. The format must include at least $context.requestId. This parameter is required to enable access logging.

destination_arn str: The Amazon Resource Name (ARN) of the CloudWatch Logs log group or Kinesis Data Firehose delivery stream to receive access logs. If you specify a Kinesis Data Firehose delivery stream, the stream name must begin with amazon-apigateway-. This parameter is required to enable access logging.
format str: A single line format of the access logs of data, as specified by selected $context variables. The format must include at least $context.requestId. This parameter is required to enable access logging.

destinationArn String: The Amazon Resource Name (ARN) of the CloudWatch Logs log group or Kinesis Data Firehose delivery stream to receive access logs. If you specify a Kinesis Data Firehose delivery stream, the stream name must begin with amazon-apigateway-. This parameter is required to enable access logging.
format String: A single line format of the access logs of data, as specified by selected $context variables. The format must include at least $context.requestId. This parameter is required to enable access logging.

ApiGatewayStagePropertiesResponse

ProvisioningState string: The status of the last operation.
Arn string: Amazon Resource Name (ARN)
AwsAccountId string: AWS Account ID
AwsProperties Pulumi.AzureNative.AwsConnector.Inputs.AwsApiGatewayStagePropertiesResponse: 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 AwsApiGatewayStagePropertiesResponse: 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 AwsApiGatewayStagePropertiesResponse: 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 AwsApiGatewayStagePropertiesResponse: 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 AwsApiGatewayStagePropertiesResponse: 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

AwsApiGatewayStagePropertiesResponse

AccessLogSetting Pulumi.AzureNative.AwsConnector.Inputs.AccessLogSettingResponse: Access log settings, including the access log format and access log destination ARN. The AccessLogSetting property type specifies settings for logging access in this stage. AccessLogSetting is a property of the AWS::ApiGateway::Stage resource.
CacheClusterEnabled bool: Specifies whether a cache cluster is enabled for the stage.
CacheClusterSize string: The stage's cache capacity in GB. For more information about choosing a cache size, see Enabling API caching to enhance responsiveness.
CanarySetting Pulumi.AzureNative.AwsConnector.Inputs.CanarySettingResponse: Settings for the canary deployment in this stage. Configuration settings of a canary deployment.
ClientCertificateId string: The identifier of a client certificate for an API stage.
DeploymentId string: The identifier of the Deployment that the stage points to.
Description string: The stage's description.
DocumentationVersion string: The version of the associated API documentation.
MethodSettings List<Pulumi.AzureNative.AwsConnector.Inputs.MethodSettingResponse>: A map that defines the method settings for a Stage resource. Keys (designated as /{method_setting_key below) are method paths defined as {resource_path}/{http_method} for an individual method override, or /\*/\* for overriding all methods in the stage.
RestApiId string: The string identifier of the associated RestApi.
StageName string: The name of the stage is the first path segment in the Uniform Resource Identifier (URI) of a call to API Gateway. Stage names can only contain alphanumeric characters, hyphens, and underscores. Maximum length is 128 characters.
Tags List<Pulumi.AzureNative.AwsConnector.Inputs.TagResponse>: The collection of tags. Each tag element is associated with a given resource.
TracingEnabled bool: Specifies whether active tracing with X-ray is enabled for the Stage.
Variables Dictionary<string, string>: A map (string-to-string map) that defines the stage variables, where the variable name is the key and the variable value is the value. Variable names are limited to alphanumeric characters. Values must match the following regular expression: [A-Za-z0-9-._~:/?#&=,]+.

AccessLogSetting AccessLogSettingResponse: Access log settings, including the access log format and access log destination ARN. The AccessLogSetting property type specifies settings for logging access in this stage. AccessLogSetting is a property of the AWS::ApiGateway::Stage resource.
CacheClusterEnabled bool: Specifies whether a cache cluster is enabled for the stage.
CacheClusterSize string: The stage's cache capacity in GB. For more information about choosing a cache size, see Enabling API caching to enhance responsiveness.
CanarySetting CanarySettingResponse: Settings for the canary deployment in this stage. Configuration settings of a canary deployment.
ClientCertificateId string: The identifier of a client certificate for an API stage.
DeploymentId string: The identifier of the Deployment that the stage points to.
Description string: The stage's description.
DocumentationVersion string: The version of the associated API documentation.
MethodSettings []MethodSettingResponse: A map that defines the method settings for a Stage resource. Keys (designated as /{method_setting_key below) are method paths defined as {resource_path}/{http_method} for an individual method override, or /\*/\* for overriding all methods in the stage.
RestApiId string: The string identifier of the associated RestApi.
StageName string: The name of the stage is the first path segment in the Uniform Resource Identifier (URI) of a call to API Gateway. Stage names can only contain alphanumeric characters, hyphens, and underscores. Maximum length is 128 characters.
Tags []TagResponse: The collection of tags. Each tag element is associated with a given resource.
TracingEnabled bool: Specifies whether active tracing with X-ray is enabled for the Stage.
Variables map[string]string: A map (string-to-string map) that defines the stage variables, where the variable name is the key and the variable value is the value. Variable names are limited to alphanumeric characters. Values must match the following regular expression: [A-Za-z0-9-._~:/?#&=,]+.

accessLogSetting AccessLogSettingResponse: Access log settings, including the access log format and access log destination ARN. The AccessLogSetting property type specifies settings for logging access in this stage. AccessLogSetting is a property of the AWS::ApiGateway::Stage resource.
cacheClusterEnabled Boolean: Specifies whether a cache cluster is enabled for the stage.
cacheClusterSize String: The stage's cache capacity in GB. For more information about choosing a cache size, see Enabling API caching to enhance responsiveness.
canarySetting CanarySettingResponse: Settings for the canary deployment in this stage. Configuration settings of a canary deployment.
clientCertificateId String: The identifier of a client certificate for an API stage.
deploymentId String: The identifier of the Deployment that the stage points to.
description String: The stage's description.
documentationVersion String: The version of the associated API documentation.
methodSettings List<MethodSettingResponse>: A map that defines the method settings for a Stage resource. Keys (designated as /{method_setting_key below) are method paths defined as {resource_path}/{http_method} for an individual method override, or /\*/\* for overriding all methods in the stage.
restApiId String: The string identifier of the associated RestApi.
stageName String: The name of the stage is the first path segment in the Uniform Resource Identifier (URI) of a call to API Gateway. Stage names can only contain alphanumeric characters, hyphens, and underscores. Maximum length is 128 characters.
tags List<TagResponse>: The collection of tags. Each tag element is associated with a given resource.
tracingEnabled Boolean: Specifies whether active tracing with X-ray is enabled for the Stage.
variables Map<String,String>: A map (string-to-string map) that defines the stage variables, where the variable name is the key and the variable value is the value. Variable names are limited to alphanumeric characters. Values must match the following regular expression: [A-Za-z0-9-._~:/?#&=,]+.

accessLogSetting AccessLogSettingResponse: Access log settings, including the access log format and access log destination ARN. The AccessLogSetting property type specifies settings for logging access in this stage. AccessLogSetting is a property of the AWS::ApiGateway::Stage resource.
cacheClusterEnabled boolean: Specifies whether a cache cluster is enabled for the stage.
cacheClusterSize string: The stage's cache capacity in GB. For more information about choosing a cache size, see Enabling API caching to enhance responsiveness.
canarySetting CanarySettingResponse: Settings for the canary deployment in this stage. Configuration settings of a canary deployment.
clientCertificateId string: The identifier of a client certificate for an API stage.
deploymentId string: The identifier of the Deployment that the stage points to.
description string: The stage's description.
documentationVersion string: The version of the associated API documentation.
methodSettings MethodSettingResponse[]: A map that defines the method settings for a Stage resource. Keys (designated as /{method_setting_key below) are method paths defined as {resource_path}/{http_method} for an individual method override, or /\*/\* for overriding all methods in the stage.
restApiId string: The string identifier of the associated RestApi.
stageName string: The name of the stage is the first path segment in the Uniform Resource Identifier (URI) of a call to API Gateway. Stage names can only contain alphanumeric characters, hyphens, and underscores. Maximum length is 128 characters.
tags TagResponse[]: The collection of tags. Each tag element is associated with a given resource.
tracingEnabled boolean: Specifies whether active tracing with X-ray is enabled for the Stage.
variables {[key: string]: string}: A map (string-to-string map) that defines the stage variables, where the variable name is the key and the variable value is the value. Variable names are limited to alphanumeric characters. Values must match the following regular expression: [A-Za-z0-9-._~:/?#&=,]+.

access_log_setting AccessLogSettingResponse: Access log settings, including the access log format and access log destination ARN. The AccessLogSetting property type specifies settings for logging access in this stage. AccessLogSetting is a property of the AWS::ApiGateway::Stage resource.
cache_cluster_enabled bool: Specifies whether a cache cluster is enabled for the stage.
cache_cluster_size str: The stage's cache capacity in GB. For more information about choosing a cache size, see Enabling API caching to enhance responsiveness.
canary_setting CanarySettingResponse: Settings for the canary deployment in this stage. Configuration settings of a canary deployment.
client_certificate_id str: The identifier of a client certificate for an API stage.
deployment_id str: The identifier of the Deployment that the stage points to.
description str: The stage's description.
documentation_version str: The version of the associated API documentation.
method_settings Sequence[MethodSettingResponse]: A map that defines the method settings for a Stage resource. Keys (designated as /{method_setting_key below) are method paths defined as {resource_path}/{http_method} for an individual method override, or /\*/\* for overriding all methods in the stage.
rest_api_id str: The string identifier of the associated RestApi.
stage_name str: The name of the stage is the first path segment in the Uniform Resource Identifier (URI) of a call to API Gateway. Stage names can only contain alphanumeric characters, hyphens, and underscores. Maximum length is 128 characters.
tags Sequence[TagResponse]: The collection of tags. Each tag element is associated with a given resource.
tracing_enabled bool: Specifies whether active tracing with X-ray is enabled for the Stage.
variables Mapping[str, str]: A map (string-to-string map) that defines the stage variables, where the variable name is the key and the variable value is the value. Variable names are limited to alphanumeric characters. Values must match the following regular expression: [A-Za-z0-9-._~:/?#&=,]+.

accessLogSetting Property Map: Access log settings, including the access log format and access log destination ARN. The AccessLogSetting property type specifies settings for logging access in this stage. AccessLogSetting is a property of the AWS::ApiGateway::Stage resource.
cacheClusterEnabled Boolean: Specifies whether a cache cluster is enabled for the stage.
cacheClusterSize String: The stage's cache capacity in GB. For more information about choosing a cache size, see Enabling API caching to enhance responsiveness.
canarySetting Property Map: Settings for the canary deployment in this stage. Configuration settings of a canary deployment.
clientCertificateId String: The identifier of a client certificate for an API stage.
deploymentId String: The identifier of the Deployment that the stage points to.
description String: The stage's description.
documentationVersion String: The version of the associated API documentation.
methodSettings List<Property Map>: A map that defines the method settings for a Stage resource. Keys (designated as /{method_setting_key below) are method paths defined as {resource_path}/{http_method} for an individual method override, or /\*/\* for overriding all methods in the stage.
restApiId String: The string identifier of the associated RestApi.
stageName String: The name of the stage is the first path segment in the Uniform Resource Identifier (URI) of a call to API Gateway. Stage names can only contain alphanumeric characters, hyphens, and underscores. Maximum length is 128 characters.
tags List<Property Map>: The collection of tags. Each tag element is associated with a given resource.
tracingEnabled Boolean: Specifies whether active tracing with X-ray is enabled for the Stage.
variables Map<String>: A map (string-to-string map) that defines the stage variables, where the variable name is the key and the variable value is the value. Variable names are limited to alphanumeric characters. Values must match the following regular expression: [A-Za-z0-9-._~:/?#&=,]+.

CanarySettingResponse

DeploymentId string: The ID of the canary deployment.
PercentTraffic int: The percent (0-100) of traffic diverted to a canary deployment.
StageVariableOverrides Dictionary<string, string>: Stage variables overridden for a canary release deployment, including new stage variables introduced in the canary. These stage variables are represented as a string-to-string map between stage variable names and their values.
UseStageCache bool: A Boolean flag to indicate whether the canary deployment uses the stage cache or not.

DeploymentId string: The ID of the canary deployment.
PercentTraffic int: The percent (0-100) of traffic diverted to a canary deployment.
StageVariableOverrides map[string]string: Stage variables overridden for a canary release deployment, including new stage variables introduced in the canary. These stage variables are represented as a string-to-string map between stage variable names and their values.
UseStageCache bool: A Boolean flag to indicate whether the canary deployment uses the stage cache or not.

deploymentId String: The ID of the canary deployment.
percentTraffic Integer: The percent (0-100) of traffic diverted to a canary deployment.
stageVariableOverrides Map<String,String>: Stage variables overridden for a canary release deployment, including new stage variables introduced in the canary. These stage variables are represented as a string-to-string map between stage variable names and their values.
useStageCache Boolean: A Boolean flag to indicate whether the canary deployment uses the stage cache or not.

deploymentId string: The ID of the canary deployment.
percentTraffic number: The percent (0-100) of traffic diverted to a canary deployment.
stageVariableOverrides {[key: string]: string}: Stage variables overridden for a canary release deployment, including new stage variables introduced in the canary. These stage variables are represented as a string-to-string map between stage variable names and their values.
useStageCache boolean: A Boolean flag to indicate whether the canary deployment uses the stage cache or not.

deployment_id str: The ID of the canary deployment.
percent_traffic int: The percent (0-100) of traffic diverted to a canary deployment.
stage_variable_overrides Mapping[str, str]: Stage variables overridden for a canary release deployment, including new stage variables introduced in the canary. These stage variables are represented as a string-to-string map between stage variable names and their values.
use_stage_cache bool: A Boolean flag to indicate whether the canary deployment uses the stage cache or not.

deploymentId String: The ID of the canary deployment.
percentTraffic Number: The percent (0-100) of traffic diverted to a canary deployment.
stageVariableOverrides Map<String>: Stage variables overridden for a canary release deployment, including new stage variables introduced in the canary. These stage variables are represented as a string-to-string map between stage variable names and their values.
useStageCache Boolean: A Boolean flag to indicate whether the canary deployment uses the stage cache or not.

MethodSettingResponse

CacheDataEncrypted bool: Specifies whether the cached responses are encrypted.
CacheTtlInSeconds int: Specifies the time to live (TTL), in seconds, for cached responses. The higher the TTL, the longer the response will be cached.
CachingEnabled bool: Specifies whether responses should be cached and returned for requests. A cache cluster must be enabled on the stage for responses to be cached.
DataTraceEnabled bool: Specifies whether data trace logging is enabled for this method, which affects the log entries pushed to Amazon CloudWatch Logs. This can be useful to troubleshoot APIs, but can result in logging sensitive data. We recommend that you don't enable this option for production APIs.
HttpMethod string: The HTTP method. To apply settings to multiple resources and methods, specify an asterisk (*) for the HttpMethod and /* for the ResourcePath. This parameter is required when you specify a MethodSetting.
LoggingLevel string: Specifies the logging level for this method, which affects the log entries pushed to Amazon CloudWatch Logs. Valid values are OFF, ERROR, and INFO. Choose ERROR to write only error-level entries to CloudWatch Logs, or choose INFO to include all ERROR events as well as extra informational events.
MetricsEnabled bool: Specifies whether Amazon CloudWatch metrics are enabled for this method.
ResourcePath string: The resource path for this method. Forward slashes (/) are encoded as ~1 and the initial slash must include a forward slash. For example, the path value /resource/subresource must be encoded as /~1resource~1subresource. To specify the root path, use only a slash (/). To apply settings to multiple resources and methods, specify an asterisk (*) for the HttpMethod and /* for the ResourcePath. This parameter is required when you specify a MethodSetting.
ThrottlingBurstLimit int: Specifies the throttling burst limit.
ThrottlingRateLimit int: Specifies the throttling rate limit.

CacheDataEncrypted bool: Specifies whether the cached responses are encrypted.
CacheTtlInSeconds int: Specifies the time to live (TTL), in seconds, for cached responses. The higher the TTL, the longer the response will be cached.
CachingEnabled bool: Specifies whether responses should be cached and returned for requests. A cache cluster must be enabled on the stage for responses to be cached.
DataTraceEnabled bool: Specifies whether data trace logging is enabled for this method, which affects the log entries pushed to Amazon CloudWatch Logs. This can be useful to troubleshoot APIs, but can result in logging sensitive data. We recommend that you don't enable this option for production APIs.
HttpMethod string: The HTTP method. To apply settings to multiple resources and methods, specify an asterisk (*) for the HttpMethod and /* for the ResourcePath. This parameter is required when you specify a MethodSetting.
LoggingLevel string: Specifies the logging level for this method, which affects the log entries pushed to Amazon CloudWatch Logs. Valid values are OFF, ERROR, and INFO. Choose ERROR to write only error-level entries to CloudWatch Logs, or choose INFO to include all ERROR events as well as extra informational events.
MetricsEnabled bool: Specifies whether Amazon CloudWatch metrics are enabled for this method.
ResourcePath string: The resource path for this method. Forward slashes (/) are encoded as ~1 and the initial slash must include a forward slash. For example, the path value /resource/subresource must be encoded as /~1resource~1subresource. To specify the root path, use only a slash (/). To apply settings to multiple resources and methods, specify an asterisk (*) for the HttpMethod and /* for the ResourcePath. This parameter is required when you specify a MethodSetting.
ThrottlingBurstLimit int: Specifies the throttling burst limit.
ThrottlingRateLimit int: Specifies the throttling rate limit.

cacheDataEncrypted Boolean: Specifies whether the cached responses are encrypted.
cacheTtlInSeconds Integer: Specifies the time to live (TTL), in seconds, for cached responses. The higher the TTL, the longer the response will be cached.
cachingEnabled Boolean: Specifies whether responses should be cached and returned for requests. A cache cluster must be enabled on the stage for responses to be cached.
dataTraceEnabled Boolean: Specifies whether data trace logging is enabled for this method, which affects the log entries pushed to Amazon CloudWatch Logs. This can be useful to troubleshoot APIs, but can result in logging sensitive data. We recommend that you don't enable this option for production APIs.
httpMethod String: The HTTP method. To apply settings to multiple resources and methods, specify an asterisk (*) for the HttpMethod and /* for the ResourcePath. This parameter is required when you specify a MethodSetting.
loggingLevel String: Specifies the logging level for this method, which affects the log entries pushed to Amazon CloudWatch Logs. Valid values are OFF, ERROR, and INFO. Choose ERROR to write only error-level entries to CloudWatch Logs, or choose INFO to include all ERROR events as well as extra informational events.
metricsEnabled Boolean: Specifies whether Amazon CloudWatch metrics are enabled for this method.
resourcePath String: The resource path for this method. Forward slashes (/) are encoded as ~1 and the initial slash must include a forward slash. For example, the path value /resource/subresource must be encoded as /~1resource~1subresource. To specify the root path, use only a slash (/). To apply settings to multiple resources and methods, specify an asterisk (*) for the HttpMethod and /* for the ResourcePath. This parameter is required when you specify a MethodSetting.
throttlingBurstLimit Integer: Specifies the throttling burst limit.
throttlingRateLimit Integer: Specifies the throttling rate limit.

cacheDataEncrypted boolean: Specifies whether the cached responses are encrypted.
cacheTtlInSeconds number: Specifies the time to live (TTL), in seconds, for cached responses. The higher the TTL, the longer the response will be cached.
cachingEnabled boolean: Specifies whether responses should be cached and returned for requests. A cache cluster must be enabled on the stage for responses to be cached.
dataTraceEnabled boolean: Specifies whether data trace logging is enabled for this method, which affects the log entries pushed to Amazon CloudWatch Logs. This can be useful to troubleshoot APIs, but can result in logging sensitive data. We recommend that you don't enable this option for production APIs.
httpMethod string: The HTTP method. To apply settings to multiple resources and methods, specify an asterisk (*) for the HttpMethod and /* for the ResourcePath. This parameter is required when you specify a MethodSetting.
loggingLevel string: Specifies the logging level for this method, which affects the log entries pushed to Amazon CloudWatch Logs. Valid values are OFF, ERROR, and INFO. Choose ERROR to write only error-level entries to CloudWatch Logs, or choose INFO to include all ERROR events as well as extra informational events.
metricsEnabled boolean: Specifies whether Amazon CloudWatch metrics are enabled for this method.
resourcePath string: The resource path for this method. Forward slashes (/) are encoded as ~1 and the initial slash must include a forward slash. For example, the path value /resource/subresource must be encoded as /~1resource~1subresource. To specify the root path, use only a slash (/). To apply settings to multiple resources and methods, specify an asterisk (*) for the HttpMethod and /* for the ResourcePath. This parameter is required when you specify a MethodSetting.
throttlingBurstLimit number: Specifies the throttling burst limit.
throttlingRateLimit number: Specifies the throttling rate limit.

cache_data_encrypted bool: Specifies whether the cached responses are encrypted.
cache_ttl_in_seconds int: Specifies the time to live (TTL), in seconds, for cached responses. The higher the TTL, the longer the response will be cached.
caching_enabled bool: Specifies whether responses should be cached and returned for requests. A cache cluster must be enabled on the stage for responses to be cached.
data_trace_enabled bool: Specifies whether data trace logging is enabled for this method, which affects the log entries pushed to Amazon CloudWatch Logs. This can be useful to troubleshoot APIs, but can result in logging sensitive data. We recommend that you don't enable this option for production APIs.
http_method str: The HTTP method. To apply settings to multiple resources and methods, specify an asterisk (*) for the HttpMethod and /* for the ResourcePath. This parameter is required when you specify a MethodSetting.
logging_level str: Specifies the logging level for this method, which affects the log entries pushed to Amazon CloudWatch Logs. Valid values are OFF, ERROR, and INFO. Choose ERROR to write only error-level entries to CloudWatch Logs, or choose INFO to include all ERROR events as well as extra informational events.
metrics_enabled bool: Specifies whether Amazon CloudWatch metrics are enabled for this method.
resource_path str: The resource path for this method. Forward slashes (/) are encoded as ~1 and the initial slash must include a forward slash. For example, the path value /resource/subresource must be encoded as /~1resource~1subresource. To specify the root path, use only a slash (/). To apply settings to multiple resources and methods, specify an asterisk (*) for the HttpMethod and /* for the ResourcePath. This parameter is required when you specify a MethodSetting.
throttling_burst_limit int: Specifies the throttling burst limit.
throttling_rate_limit int: Specifies the throttling rate limit.

cacheDataEncrypted Boolean: Specifies whether the cached responses are encrypted.
cacheTtlInSeconds Number: Specifies the time to live (TTL), in seconds, for cached responses. The higher the TTL, the longer the response will be cached.
cachingEnabled Boolean: Specifies whether responses should be cached and returned for requests. A cache cluster must be enabled on the stage for responses to be cached.
dataTraceEnabled Boolean: Specifies whether data trace logging is enabled for this method, which affects the log entries pushed to Amazon CloudWatch Logs. This can be useful to troubleshoot APIs, but can result in logging sensitive data. We recommend that you don't enable this option for production APIs.
httpMethod String: The HTTP method. To apply settings to multiple resources and methods, specify an asterisk (*) for the HttpMethod and /* for the ResourcePath. This parameter is required when you specify a MethodSetting.
loggingLevel String: Specifies the logging level for this method, which affects the log entries pushed to Amazon CloudWatch Logs. Valid values are OFF, ERROR, and INFO. Choose ERROR to write only error-level entries to CloudWatch Logs, or choose INFO to include all ERROR events as well as extra informational events.
metricsEnabled Boolean: Specifies whether Amazon CloudWatch metrics are enabled for this method.
resourcePath String: The resource path for this method. Forward slashes (/) are encoded as ~1 and the initial slash must include a forward slash. For example, the path value /resource/subresource must be encoded as /~1resource~1subresource. To specify the root path, use only a slash (/). To apply settings to multiple resources and methods, specify an asterisk (*) for the HttpMethod and /* for the ResourcePath. This parameter is required when you specify a MethodSetting.
throttlingBurstLimit Number: Specifies the throttling burst limit.
throttlingRateLimit Number: Specifies the throttling rate limit.

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

This is the latest version of Azure Native. Use the Azure Native v2 docs if using the v2 version of this package.

Azure Native v3.8.0 published on Wednesday, Sep 3, 2025 by Pulumi

pulumi/pulumi-azure-native

azure-native.awsconnector.getApiGatewayStage

On this page

On this page

Using getApiGatewayStage

getApiGatewayStage Result

Supporting Types

AccessLogSettingResponse

ApiGatewayStagePropertiesResponse

AwsApiGatewayStagePropertiesResponse

CanarySettingResponse

MethodSettingResponse

SystemDataResponse

TagResponse

Package Details

On this page

On this page