1. Packages
  2. AWS Native
  3. API Docs
  4. apigateway
  5. Deployment

AWS Native is in preview. AWS Classic is fully supported.

AWS Native v0.77.0 published on Wednesday, Sep 20, 2023 by Pulumi

aws-native.apigateway.Deployment

Explore with Pulumi AI

aws-native logo

AWS Native is in preview. AWS Classic is fully supported.

AWS Native v0.77.0 published on Wednesday, Sep 20, 2023 by Pulumi

    Resource Type definition for AWS::ApiGateway::Deployment

    Create Deployment Resource

    new Deployment(name: string, args: DeploymentArgs, opts?: CustomResourceOptions);
    @overload
    def Deployment(resource_name: str,
                   opts: Optional[ResourceOptions] = None,
                   deployment_canary_settings: Optional[DeploymentCanarySettingsArgs] = None,
                   description: Optional[str] = None,
                   rest_api_id: Optional[str] = None,
                   stage_description: Optional[DeploymentStageDescriptionArgs] = None,
                   stage_name: Optional[str] = None)
    @overload
    def Deployment(resource_name: str,
                   args: DeploymentArgs,
                   opts: Optional[ResourceOptions] = None)
    func NewDeployment(ctx *Context, name string, args DeploymentArgs, opts ...ResourceOption) (*Deployment, error)
    public Deployment(string name, DeploymentArgs args, CustomResourceOptions? opts = null)
    public Deployment(String name, DeploymentArgs args)
    public Deployment(String name, DeploymentArgs args, CustomResourceOptions options)
    
    type: aws-native:apigateway:Deployment
    properties: # The arguments to resource properties.
    options: # Bag of options to control resource's behavior.
    
    
    name string
    The unique name of the resource.
    args DeploymentArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    resource_name str
    The unique name of the resource.
    args DeploymentArgs
    The arguments to resource properties.
    opts ResourceOptions
    Bag of options to control resource's behavior.
    ctx Context
    Context object for the current deployment.
    name string
    The unique name of the resource.
    args DeploymentArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args DeploymentArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args DeploymentArgs
    The arguments to resource properties.
    options CustomResourceOptions
    Bag of options to control resource's behavior.

    Deployment Resource Properties

    To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.

    Inputs

    The Deployment resource accepts the following input properties:

    RestApiId string

    The ID of the RestApi resource to deploy.

    DeploymentCanarySettings Pulumi.AwsNative.ApiGateway.Inputs.DeploymentCanarySettings

    Specifies settings for the canary deployment.

    Description string

    A description of the purpose of the API Gateway deployment.

    StageDescription Pulumi.AwsNative.ApiGateway.Inputs.DeploymentStageDescription

    Configures the stage that API Gateway creates with this deployment.

    StageName string

    A name for the stage that API Gateway creates with this deployment. Use only alphanumeric characters.

    RestApiId string

    The ID of the RestApi resource to deploy.

    DeploymentCanarySettings DeploymentCanarySettingsArgs

    Specifies settings for the canary deployment.

    Description string

    A description of the purpose of the API Gateway deployment.

    StageDescription DeploymentStageDescriptionArgs

    Configures the stage that API Gateway creates with this deployment.

    StageName string

    A name for the stage that API Gateway creates with this deployment. Use only alphanumeric characters.

    restApiId String

    The ID of the RestApi resource to deploy.

    deploymentCanarySettings DeploymentCanarySettings

    Specifies settings for the canary deployment.

    description String

    A description of the purpose of the API Gateway deployment.

    stageDescription DeploymentStageDescription

    Configures the stage that API Gateway creates with this deployment.

    stageName String

    A name for the stage that API Gateway creates with this deployment. Use only alphanumeric characters.

    restApiId string

    The ID of the RestApi resource to deploy.

    deploymentCanarySettings DeploymentCanarySettings

    Specifies settings for the canary deployment.

    description string

    A description of the purpose of the API Gateway deployment.

    stageDescription DeploymentStageDescription

    Configures the stage that API Gateway creates with this deployment.

    stageName string

    A name for the stage that API Gateway creates with this deployment. Use only alphanumeric characters.

    rest_api_id str

    The ID of the RestApi resource to deploy.

    deployment_canary_settings DeploymentCanarySettingsArgs

    Specifies settings for the canary deployment.

    description str

    A description of the purpose of the API Gateway deployment.

    stage_description DeploymentStageDescriptionArgs

    Configures the stage that API Gateway creates with this deployment.

    stage_name str

    A name for the stage that API Gateway creates with this deployment. Use only alphanumeric characters.

    restApiId String

    The ID of the RestApi resource to deploy.

    deploymentCanarySettings Property Map

    Specifies settings for the canary deployment.

    description String

    A description of the purpose of the API Gateway deployment.

    stageDescription Property Map

    Configures the stage that API Gateway creates with this deployment.

    stageName String

    A name for the stage that API Gateway creates with this deployment. Use only alphanumeric characters.

    Outputs

    All input properties are implicitly available as output properties. Additionally, the Deployment resource produces the following output properties:

    DeploymentId string

    Primary Id for this resource

    Id string

    The provider-assigned unique ID for this managed resource.

    DeploymentId string

    Primary Id for this resource

    Id string

    The provider-assigned unique ID for this managed resource.

    deploymentId String

    Primary Id for this resource

    id String

    The provider-assigned unique ID for this managed resource.

    deploymentId string

    Primary Id for this resource

    id string

    The provider-assigned unique ID for this managed resource.

    deployment_id str

    Primary Id for this resource

    id str

    The provider-assigned unique ID for this managed resource.

    deploymentId String

    Primary Id for this resource

    id String

    The provider-assigned unique ID for this managed resource.

    Supporting Types

    DeploymentAccessLogSetting, DeploymentAccessLogSettingArgs

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

    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.

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

    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.

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

    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.

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

    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.

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

    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.

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

    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.

    DeploymentCanarySetting, DeploymentCanarySettingArgs

    PercentTraffic double

    The percent (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.

    PercentTraffic float64

    The percent (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.

    percentTraffic Double

    The percent (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.

    percentTraffic number

    The percent (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.

    percent_traffic float

    The percent (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.

    percentTraffic Number

    The percent (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.

    DeploymentCanarySettings, DeploymentCanarySettingsArgs

    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. Duplicates are not allowed.

    UseStageCache bool

    Whether the canary deployment uses the stage cache.

    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. Duplicates are not allowed.

    UseStageCache bool

    Whether the canary deployment uses the stage cache.

    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. Duplicates are not allowed.

    useStageCache Boolean

    Whether the canary deployment uses the stage cache.

    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. Duplicates are not allowed.

    useStageCache boolean

    Whether the canary deployment uses the stage cache.

    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. Duplicates are not allowed.

    use_stage_cache bool

    Whether the canary deployment uses the stage cache.

    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. Duplicates are not allowed.

    useStageCache Boolean

    Whether the canary deployment uses the stage cache.

    DeploymentMethodSetting, DeploymentMethodSettingArgs

    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.

    LoggingLevel string

    The logging level for this method. For valid values, see the loggingLevel property of the Stage 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.

    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.

    LoggingLevel string

    The logging level for this method. For valid values, see the loggingLevel property of the Stage 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.

    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.

    loggingLevel String

    The logging level for this method. For valid values, see the loggingLevel property of the Stage 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.

    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.

    loggingLevel string

    The logging level for this method. For valid values, see the loggingLevel property of the Stage 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.

    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.

    logging_level str

    The logging level for this method. For valid values, see the loggingLevel property of the Stage 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.

    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.

    loggingLevel String

    The logging level for this method. For valid values, see the loggingLevel property of the Stage 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.

    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.

    DeploymentStageDescription, DeploymentStageDescriptionArgs

    AccessLogSetting Pulumi.AwsNative.ApiGateway.Inputs.DeploymentAccessLogSetting

    Specifies settings for logging access in this stage.

    CacheClusterEnabled bool

    Indicates whether cache clustering is enabled for the stage.

    CacheClusterSize string

    The size of the stage's cache cluster.

    CacheDataEncrypted bool

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

    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.

    CanarySetting Pulumi.AwsNative.ApiGateway.Inputs.DeploymentCanarySetting

    Specifies settings for the canary deployment in this stage.

    ClientCertificateId string

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

    DataTraceEnabled bool

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

    Description string

    A description of the purpose of the stage.

    DocumentationVersion string

    The version identifier of the API documentation snapshot.

    LoggingLevel string

    The logging level for this method. For valid values, see the loggingLevel property of the Stage resource in the Amazon API Gateway API Reference.

    MethodSettings List<Pulumi.AwsNative.ApiGateway.Inputs.DeploymentMethodSetting>

    Configures settings for all of the stage's methods.

    MetricsEnabled bool

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

    Tags List<Pulumi.AwsNative.ApiGateway.Inputs.DeploymentTag>

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

    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.

    TracingEnabled bool

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

    Variables object

    A map that defines the stage variables. Variable names must consist of alphanumeric characters, and the values must match the following regular expression: [A-Za-z0-9-._~:/?#&=,]+.

    AccessLogSetting DeploymentAccessLogSetting

    Specifies settings for logging access in this stage.

    CacheClusterEnabled bool

    Indicates whether cache clustering is enabled for the stage.

    CacheClusterSize string

    The size of the stage's cache cluster.

    CacheDataEncrypted bool

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

    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.

    CanarySetting DeploymentCanarySetting

    Specifies settings for the canary deployment in this stage.

    ClientCertificateId string

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

    DataTraceEnabled bool

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

    Description string

    A description of the purpose of the stage.

    DocumentationVersion string

    The version identifier of the API documentation snapshot.

    LoggingLevel string

    The logging level for this method. For valid values, see the loggingLevel property of the Stage resource in the Amazon API Gateway API Reference.

    MethodSettings []DeploymentMethodSetting

    Configures settings for all of the stage's methods.

    MetricsEnabled bool

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

    Tags []DeploymentTag

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

    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.

    TracingEnabled bool

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

    Variables interface{}

    A map that defines the stage variables. Variable names must consist of alphanumeric characters, and the values must match the following regular expression: [A-Za-z0-9-._~:/?#&=,]+.

    accessLogSetting DeploymentAccessLogSetting

    Specifies settings for logging access in this stage.

    cacheClusterEnabled Boolean

    Indicates whether cache clustering is enabled for the stage.

    cacheClusterSize String

    The size of the stage's cache cluster.

    cacheDataEncrypted Boolean

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

    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.

    canarySetting DeploymentCanarySetting

    Specifies settings for the canary deployment in this stage.

    clientCertificateId String

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

    dataTraceEnabled Boolean

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

    description String

    A description of the purpose of the stage.

    documentationVersion String

    The version identifier of the API documentation snapshot.

    loggingLevel String

    The logging level for this method. For valid values, see the loggingLevel property of the Stage resource in the Amazon API Gateway API Reference.

    methodSettings List<DeploymentMethodSetting>

    Configures settings for all of the stage's methods.

    metricsEnabled Boolean

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

    tags List<DeploymentTag>

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

    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.

    tracingEnabled Boolean

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

    variables Object

    A map that defines the stage variables. Variable names must consist of alphanumeric characters, and the values must match the following regular expression: [A-Za-z0-9-._~:/?#&=,]+.

    accessLogSetting DeploymentAccessLogSetting

    Specifies settings for logging access in this stage.

    cacheClusterEnabled boolean

    Indicates whether cache clustering is enabled for the stage.

    cacheClusterSize string

    The size of the stage's cache cluster.

    cacheDataEncrypted boolean

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

    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.

    canarySetting DeploymentCanarySetting

    Specifies settings for the canary deployment in this stage.

    clientCertificateId string

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

    dataTraceEnabled boolean

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

    description string

    A description of the purpose of the stage.

    documentationVersion string

    The version identifier of the API documentation snapshot.

    loggingLevel string

    The logging level for this method. For valid values, see the loggingLevel property of the Stage resource in the Amazon API Gateway API Reference.

    methodSettings DeploymentMethodSetting[]

    Configures settings for all of the stage's methods.

    metricsEnabled boolean

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

    tags DeploymentTag[]

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

    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.

    tracingEnabled boolean

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

    variables any

    A map that defines the stage variables. Variable names must consist of alphanumeric characters, and the values must match the following regular expression: [A-Za-z0-9-._~:/?#&=,]+.

    access_log_setting DeploymentAccessLogSetting

    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 size of the stage's cache cluster.

    cache_data_encrypted bool

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

    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.

    canary_setting DeploymentCanarySetting

    Specifies settings for the canary deployment in this stage.

    client_certificate_id str

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

    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.

    description str

    A description of the purpose of the stage.

    documentation_version str

    The version identifier of the API documentation snapshot.

    logging_level str

    The logging level for this method. For valid values, see the loggingLevel property of the Stage resource in the Amazon API Gateway API Reference.

    method_settings Sequence[DeploymentMethodSetting]

    Configures settings for all of the stage's methods.

    metrics_enabled bool

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

    tags Sequence[DeploymentTag]

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

    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.

    tracing_enabled bool

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

    variables Any

    A map that defines the stage variables. Variable names must consist of alphanumeric characters, and the values must match the following regular expression: [A-Za-z0-9-._~:/?#&=,]+.

    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 size of the stage's cache cluster.

    cacheDataEncrypted Boolean

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

    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.

    canarySetting Property Map

    Specifies settings for the canary deployment in this stage.

    clientCertificateId String

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

    dataTraceEnabled Boolean

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

    description String

    A description of the purpose of the stage.

    documentationVersion String

    The version identifier of the API documentation snapshot.

    loggingLevel String

    The logging level for this method. For valid values, see the loggingLevel property of the Stage resource in the Amazon API Gateway API Reference.

    methodSettings List<Property Map>

    Configures settings for all of the stage's methods.

    metricsEnabled Boolean

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

    tags List<Property Map>

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

    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.

    tracingEnabled Boolean

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

    variables Any

    A map that defines the stage variables. Variable names must consist of alphanumeric characters, and the values must match the following regular expression: [A-Za-z0-9-._~:/?#&=,]+.

    DeploymentTag, DeploymentTagArgs

    Key string

    The key name of the tag

    Value string

    The value for the tag

    Key string

    The key name of the tag

    Value string

    The value for the tag

    key String

    The key name of the tag

    value String

    The value for the tag

    key string

    The key name of the tag

    value string

    The value for the tag

    key str

    The key name of the tag

    value str

    The value for the tag

    key String

    The key name of the tag

    value String

    The value for the tag

    Package Details

    Repository
    AWS Native pulumi/pulumi-aws-native
    License
    Apache-2.0
    aws-native logo

    AWS Native is in preview. AWS Classic is fully supported.

    AWS Native v0.77.0 published on Wednesday, Sep 20, 2023 by Pulumi