AWS Native

Pulumi Official
Package maintained by Pulumi
v0.19.0 published on Wednesday, Jun 8, 2022 by Pulumi

getStage

Resource Type definition for AWS::ApiGateway::Stage

Using getStage

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 getStage(args: GetStageArgs, opts?: InvokeOptions): Promise<GetStageResult>
function getStageOutput(args: GetStageOutputArgs, opts?: InvokeOptions): Output<GetStageResult>
def get_stage(rest_api_id: Optional[str] = None,
              stage_name: Optional[str] = None,
              opts: Optional[InvokeOptions] = None) -> GetStageResult
def get_stage_output(rest_api_id: Optional[pulumi.Input[str]] = None,
              stage_name: Optional[pulumi.Input[str]] = None,
              opts: Optional[InvokeOptions] = None) -> Output[GetStageResult]
func LookupStage(ctx *Context, args *LookupStageArgs, opts ...InvokeOption) (*LookupStageResult, error)
func LookupStageOutput(ctx *Context, args *LookupStageOutputArgs, opts ...InvokeOption) LookupStageResultOutput

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

public static class GetStage 
{
    public static Task<GetStageResult> InvokeAsync(GetStageArgs args, InvokeOptions? opts = null)
    public static Output<GetStageResult> Invoke(GetStageInvokeArgs args, InvokeOptions? opts = null)
}
public static CompletableFuture<GetStageResult> getStage(GetStageArgs args, InvokeOptions options)
// Output-based functions aren't available in Java yet
Fn::Invoke:
  Function: aws-native:apigateway:getStage
  Arguments:
    # Arguments dictionary

The following arguments are supported:

RestApiId string

The ID of the RestApi resource that you're deploying with this stage.

StageName string

The name of the stage, which API Gateway uses as the first path segment in the invoked Uniform Resource Identifier (URI).

RestApiId string

The ID of the RestApi resource that you're deploying with this stage.

StageName string

The name of the stage, which API Gateway uses as the first path segment in the invoked Uniform Resource Identifier (URI).

restApiId String

The ID of the RestApi resource that you're deploying with this stage.

stageName String

The name of the stage, which API Gateway uses as the first path segment in the invoked Uniform Resource Identifier (URI).

restApiId string

The ID of the RestApi resource that you're deploying with this stage.

stageName string

The name of the stage, which API Gateway uses as the first path segment in the invoked Uniform Resource Identifier (URI).

rest_api_id str

The ID of the RestApi resource that you're deploying with this stage.

stage_name str

The name of the stage, which API Gateway uses as the first path segment in the invoked Uniform Resource Identifier (URI).

restApiId String

The ID of the RestApi resource that you're deploying with this stage.

stageName String

The name of the stage, which API Gateway uses as the first path segment in the invoked Uniform Resource Identifier (URI).

getStage Result

The following output properties are available:

AccessLogSetting Pulumi.AwsNative.ApiGateway.Outputs.StageAccessLogSetting

Specifies settings for logging access in this stage.

CacheClusterEnabled bool

Indicates whether cache clustering is enabled for the stage.

CacheClusterSize string

The stage's cache cluster size.

CanarySetting Pulumi.AwsNative.ApiGateway.Outputs.StageCanarySetting

Specifies settings for the canary deployment in this stage.

ClientCertificateId string

The ID of the client certificate that API Gateway uses to call your integration endpoints in the stage.

DeploymentId string

The ID of the deployment that the stage is associated with. This parameter is required to create a stage.

Description string

A description of the stage.

DocumentationVersion string

The version ID of the API documentation snapshot.

MethodSettings List<Pulumi.AwsNative.ApiGateway.Outputs.StageMethodSetting>

Settings for all methods in the stage.

Tags List<Pulumi.AwsNative.ApiGateway.Outputs.StageTag>

An array of arbitrary tags (key-value pairs) to associate with the stage.

TracingEnabled bool

Specifies whether active X-Ray tracing is enabled for this stage.

Variables object

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.

AccessLogSetting StageAccessLogSetting

Specifies settings for logging access in this stage.

CacheClusterEnabled bool

Indicates whether cache clustering is enabled for the stage.

CacheClusterSize string

The stage's cache cluster size.

CanarySetting StageCanarySetting

Specifies settings for the canary deployment in this stage.

ClientCertificateId string

The ID of the client certificate that API Gateway uses to call your integration endpoints in the stage.

DeploymentId string

The ID of the deployment that the stage is associated with. This parameter is required to create a stage.

Description string

A description of the stage.

DocumentationVersion string

The version ID of the API documentation snapshot.

MethodSettings []StageMethodSetting

Settings for all methods in the stage.

Tags []StageTag

An array of arbitrary tags (key-value pairs) to associate with the stage.

TracingEnabled bool

Specifies whether active X-Ray tracing is enabled for this stage.

Variables interface{}

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.

accessLogSetting StageAccessLogSetting

Specifies settings for logging access in this stage.

cacheClusterEnabled Boolean

Indicates whether cache clustering is enabled for the stage.

cacheClusterSize String

The stage's cache cluster size.

canarySetting StageCanarySetting

Specifies settings for the canary deployment in this stage.

clientCertificateId String

The ID of the client certificate that API Gateway uses to call your integration endpoints in the stage.

deploymentId String

The ID of the deployment that the stage is associated with. This parameter is required to create a stage.

description String

A description of the stage.

documentationVersion String

The version ID of the API documentation snapshot.

methodSettings List<StageMethodSetting>

Settings for all methods in the stage.

tags List<StageTag>

An array of arbitrary tags (key-value pairs) to associate with the stage.

tracingEnabled Boolean

Specifies whether active X-Ray tracing is enabled for this stage.

variables Object

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.

accessLogSetting StageAccessLogSetting

Specifies settings for logging access in this stage.

cacheClusterEnabled boolean

Indicates whether cache clustering is enabled for the stage.

cacheClusterSize string

The stage's cache cluster size.

canarySetting StageCanarySetting

Specifies settings for the canary deployment in this stage.

clientCertificateId string

The ID of the client certificate that API Gateway uses to call your integration endpoints in the stage.

deploymentId string

The ID of the deployment that the stage is associated with. This parameter is required to create a stage.

description string

A description of the stage.

documentationVersion string

The version ID of the API documentation snapshot.

methodSettings StageMethodSetting[]

Settings for all methods in the stage.

tags StageTag[]

An array of arbitrary tags (key-value pairs) to associate with the stage.

tracingEnabled boolean

Specifies whether active X-Ray tracing is enabled for this stage.

variables any

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.

access_log_setting StageAccessLogSetting

Specifies settings for logging access in this stage.

cache_cluster_enabled bool

Indicates whether cache clustering is enabled for the stage.

cache_cluster_size str

The stage's cache cluster size.

canary_setting StageCanarySetting

Specifies settings for the canary deployment in this stage.

client_certificate_id str

The ID of the client certificate that API Gateway uses to call your integration endpoints in the stage.

deployment_id str

The ID of the deployment that the stage is associated with. This parameter is required to create a stage.

description str

A description of the stage.

documentation_version str

The version ID of the API documentation snapshot.

method_settings Sequence[StageMethodSetting]

Settings for all methods in the stage.

tags Sequence[StageTag]

An array of arbitrary tags (key-value pairs) to associate with the stage.

tracing_enabled bool

Specifies whether active X-Ray tracing is enabled for this stage.

variables Any

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.

accessLogSetting Property Map

Specifies settings for logging access in this stage.

cacheClusterEnabled Boolean

Indicates whether cache clustering is enabled for the stage.

cacheClusterSize String

The stage's cache cluster size.

canarySetting Property Map

Specifies settings for the canary deployment in this stage.

clientCertificateId String

The ID of the client certificate that API Gateway uses to call your integration endpoints in the stage.

deploymentId String

The ID of the deployment that the stage is associated with. This parameter is required to create a stage.

description String

A description of the stage.

documentationVersion String

The version ID of the API documentation snapshot.

methodSettings List<Property Map>

Settings for all methods in the stage.

tags List<Property Map>

An array of arbitrary tags (key-value pairs) to associate with the stage.

tracingEnabled Boolean

Specifies whether active X-Ray tracing is enabled for this stage.

variables Any

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.

Supporting Types

StageAccessLogSetting

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 (https://docs.aws.amazon.com/apigateway/latest/developerguide/api-gateway-mapping-template-reference.html#context-variable-reference). 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 (https://docs.aws.amazon.com/apigateway/latest/developerguide/api-gateway-mapping-template-reference.html#context-variable-reference). 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 (https://docs.aws.amazon.com/apigateway/latest/developerguide/api-gateway-mapping-template-reference.html#context-variable-reference). 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 (https://docs.aws.amazon.com/apigateway/latest/developerguide/api-gateway-mapping-template-reference.html#context-variable-reference). 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 (https://docs.aws.amazon.com/apigateway/latest/developerguide/api-gateway-mapping-template-reference.html#context-variable-reference). 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 (https://docs.aws.amazon.com/apigateway/latest/developerguide/api-gateway-mapping-template-reference.html#context-variable-reference). The format must include at least $context.requestId. This parameter is required to enable access logging.

StageCanarySetting

DeploymentId string

The identifier of the deployment that the stage points to.

PercentTraffic double

The percentage (0-100) of traffic diverted to a canary deployment.

StageVariableOverrides object

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

Whether the canary deployment uses the stage cache or not.

DeploymentId string

The identifier of the deployment that the stage points to.

PercentTraffic float64

The percentage (0-100) of traffic diverted to a canary deployment.

StageVariableOverrides interface{}

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

Whether the canary deployment uses the stage cache or not.

deploymentId String

The identifier of the deployment that the stage points to.

percentTraffic Double

The percentage (0-100) of traffic diverted to a canary deployment.

stageVariableOverrides Object

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

Whether the canary deployment uses the stage cache or not.

deploymentId string

The identifier of the deployment that the stage points to.

percentTraffic number

The percentage (0-100) of traffic diverted to a canary deployment.

stageVariableOverrides any

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

Whether the canary deployment uses the stage cache or not.

deployment_id str

The identifier of the deployment that the stage points to.

percent_traffic float

The percentage (0-100) of traffic diverted to a canary deployment.

stage_variable_overrides Any

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

Whether the canary deployment uses the stage cache or not.

deploymentId String

The identifier of the deployment that the stage points to.

percentTraffic Number

The percentage (0-100) of traffic diverted to a canary deployment.

stageVariableOverrides Any

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

Whether the canary deployment uses the stage cache or not.

StageMethodSetting

CacheDataEncrypted bool

Indicates whether the cached responses are encrypted.

CacheTtlInSeconds int

The time-to-live (TTL) period, in seconds, that specifies how long API Gateway caches responses.

CachingEnabled bool

Indicates whether responses are cached and returned for requests. You must enable a cache cluster on the stage to cache responses.

DataTraceEnabled bool

Indicates whether data trace logging is enabled for methods in the stage. API Gateway pushes these logs to Amazon CloudWatch Logs.

HttpMethod string

The HTTP method. You can use an asterisk (*) as a wildcard to apply method settings to multiple methods.

LoggingLevel string

The logging level for this method. For valid values, see the loggingLevel property of the Stage (https://docs.aws.amazon.com/apigateway/api-reference/resource/stage/#loggingLevel) resource in the Amazon API Gateway API Reference.

MetricsEnabled bool

Indicates whether Amazon CloudWatch metrics are enabled for methods in the stage.

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 (/). You can use an asterisk (*) as a wildcard to apply method settings to multiple methods.

ThrottlingBurstLimit int

The number of burst requests per second that API Gateway permits across all APIs, stages, and methods in your AWS account.

ThrottlingRateLimit double

The number of steady-state requests per second that API Gateway permits across all APIs, stages, and methods in your AWS account.

CacheDataEncrypted bool

Indicates whether the cached responses are encrypted.

CacheTtlInSeconds int

The time-to-live (TTL) period, in seconds, that specifies how long API Gateway caches responses.

CachingEnabled bool

Indicates whether responses are cached and returned for requests. You must enable a cache cluster on the stage to cache responses.

DataTraceEnabled bool

Indicates whether data trace logging is enabled for methods in the stage. API Gateway pushes these logs to Amazon CloudWatch Logs.

HttpMethod string

The HTTP method. You can use an asterisk (*) as a wildcard to apply method settings to multiple methods.

LoggingLevel string

The logging level for this method. For valid values, see the loggingLevel property of the Stage (https://docs.aws.amazon.com/apigateway/api-reference/resource/stage/#loggingLevel) resource in the Amazon API Gateway API Reference.

MetricsEnabled bool

Indicates whether Amazon CloudWatch metrics are enabled for methods in the stage.

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 (/). You can use an asterisk (*) as a wildcard to apply method settings to multiple methods.

ThrottlingBurstLimit int

The number of burst requests per second that API Gateway permits across all APIs, stages, and methods in your AWS account.

ThrottlingRateLimit float64

The number of steady-state requests per second that API Gateway permits across all APIs, stages, and methods in your AWS account.

cacheDataEncrypted Boolean

Indicates whether the cached responses are encrypted.

cacheTtlInSeconds Integer

The time-to-live (TTL) period, in seconds, that specifies how long API Gateway caches responses.

cachingEnabled Boolean

Indicates whether responses are cached and returned for requests. You must enable a cache cluster on the stage to cache responses.

dataTraceEnabled Boolean

Indicates whether data trace logging is enabled for methods in the stage. API Gateway pushes these logs to Amazon CloudWatch Logs.

httpMethod String

The HTTP method. You can use an asterisk (*) as a wildcard to apply method settings to multiple methods.

loggingLevel String

The logging level for this method. For valid values, see the loggingLevel property of the Stage (https://docs.aws.amazon.com/apigateway/api-reference/resource/stage/#loggingLevel) resource in the Amazon API Gateway API Reference.

metricsEnabled Boolean

Indicates whether Amazon CloudWatch metrics are enabled for methods in the stage.

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 (/). You can use an asterisk (*) as a wildcard to apply method settings to multiple methods.

throttlingBurstLimit Integer

The number of burst requests per second that API Gateway permits across all APIs, stages, and methods in your AWS account.

throttlingRateLimit Double

The number of steady-state requests per second that API Gateway permits across all APIs, stages, and methods in your AWS account.

cacheDataEncrypted boolean

Indicates whether the cached responses are encrypted.

cacheTtlInSeconds number

The time-to-live (TTL) period, in seconds, that specifies how long API Gateway caches responses.

cachingEnabled boolean

Indicates whether responses are cached and returned for requests. You must enable a cache cluster on the stage to cache responses.

dataTraceEnabled boolean

Indicates whether data trace logging is enabled for methods in the stage. API Gateway pushes these logs to Amazon CloudWatch Logs.

httpMethod string

The HTTP method. You can use an asterisk (*) as a wildcard to apply method settings to multiple methods.

loggingLevel string

The logging level for this method. For valid values, see the loggingLevel property of the Stage (https://docs.aws.amazon.com/apigateway/api-reference/resource/stage/#loggingLevel) resource in the Amazon API Gateway API Reference.

metricsEnabled boolean

Indicates whether Amazon CloudWatch metrics are enabled for methods in the stage.

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 (/). You can use an asterisk (*) as a wildcard to apply method settings to multiple methods.

throttlingBurstLimit number

The number of burst requests per second that API Gateway permits across all APIs, stages, and methods in your AWS account.

throttlingRateLimit number

The number of steady-state requests per second that API Gateway permits across all APIs, stages, and methods in your AWS account.

cache_data_encrypted bool

Indicates whether the cached responses are encrypted.

cache_ttl_in_seconds int

The time-to-live (TTL) period, in seconds, that specifies how long API Gateway caches responses.

caching_enabled bool

Indicates whether responses are cached and returned for requests. You must enable a cache cluster on the stage to cache responses.

data_trace_enabled bool

Indicates whether data trace logging is enabled for methods in the stage. API Gateway pushes these logs to Amazon CloudWatch Logs.

http_method str

The HTTP method. You can use an asterisk (*) as a wildcard to apply method settings to multiple methods.

logging_level str

The logging level for this method. For valid values, see the loggingLevel property of the Stage (https://docs.aws.amazon.com/apigateway/api-reference/resource/stage/#loggingLevel) resource in the Amazon API Gateway API Reference.

metrics_enabled bool

Indicates whether Amazon CloudWatch metrics are enabled for methods in the stage.

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 (/). You can use an asterisk (*) as a wildcard to apply method settings to multiple methods.

throttling_burst_limit int

The number of burst requests per second that API Gateway permits across all APIs, stages, and methods in your AWS account.

throttling_rate_limit float

The number of steady-state requests per second that API Gateway permits across all APIs, stages, and methods in your AWS account.

cacheDataEncrypted Boolean

Indicates whether the cached responses are encrypted.

cacheTtlInSeconds Number

The time-to-live (TTL) period, in seconds, that specifies how long API Gateway caches responses.

cachingEnabled Boolean

Indicates whether responses are cached and returned for requests. You must enable a cache cluster on the stage to cache responses.

dataTraceEnabled Boolean

Indicates whether data trace logging is enabled for methods in the stage. API Gateway pushes these logs to Amazon CloudWatch Logs.

httpMethod String

The HTTP method. You can use an asterisk (*) as a wildcard to apply method settings to multiple methods.

loggingLevel String

The logging level for this method. For valid values, see the loggingLevel property of the Stage (https://docs.aws.amazon.com/apigateway/api-reference/resource/stage/#loggingLevel) resource in the Amazon API Gateway API Reference.

metricsEnabled Boolean

Indicates whether Amazon CloudWatch metrics are enabled for methods in the stage.

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 (/). You can use an asterisk (*) as a wildcard to apply method settings to multiple methods.

throttlingBurstLimit Number

The number of burst requests per second that API Gateway permits across all APIs, stages, and methods in your AWS account.

throttlingRateLimit Number

The number of steady-state requests per second that API Gateway permits across all APIs, stages, and methods in your AWS account.

StageTag

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

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

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

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

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

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

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

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

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

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

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

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

Package Details

Repository
https://github.com/pulumi/pulumi-aws-native
License
Apache-2.0