Docs Home Pulumi IaC Pulumi ESC Pulumi Cloud Packages Tutorials
  1. Packages
  2. AWS Cloud Control
  3. API Docs
  4. apigateway
  5. Deployment

We recommend new projects start with resources from the AWS provider.

AWS Cloud Control v1.9.0 published on Monday, Nov 18, 2024 by Pulumi
pulumi/pulumi-aws-native

aws-native.apigateway.Deployment

Explore with Pulumi AI

aws-native logo

We recommend new projects start with resources from the AWS provider.

AWS Cloud Control v1.9.0 published on Monday, Nov 18, 2024 by Pulumi
pulumi/pulumi-aws-native

    The AWS::ApiGateway::Deployment resource deploys an API Gateway RestApi resource to a stage so that clients can call the API over the internet. The stage acts as an environment.

    Create Deployment Resource

    Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.

    Constructor syntax

    new Deployment(name: string, args: DeploymentArgs, opts?: CustomResourceOptions);
    @overload
def Deployment(resource_name: str,
               args: DeploymentArgs,
               opts: Optional[ResourceOptions] = None)

@overload
def Deployment(resource_name: str,
               opts: Optional[ResourceOptions] = None,
               rest_api_id: Optional[str] = None,
               deployment_canary_settings: Optional[DeploymentCanarySettingsArgs] = None,
               description: Optional[str] = None,
               stage_description: Optional[DeploymentStageDescriptionArgs] = None,
               stage_name: Optional[str] = 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.

    Parameters

    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

    In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.

    The Deployment resource accepts the following input properties:

    RestApiId string
    The string identifier of the associated RestApi.
    DeploymentCanarySettings Pulumi.AwsNative.ApiGateway.Inputs.DeploymentCanarySettings
    The input configuration for a canary deployment.
    Description string
    The description for the Deployment resource to create.
    StageDescription Pulumi.AwsNative.ApiGateway.Inputs.DeploymentStageDescription
    The description of the Stage resource for the Deployment resource to create. To specify a stage description, you must also provide a stage name.
    StageName string
    The name of the Stage resource for the Deployment resource to create.
    RestApiId string
    The string identifier of the associated RestApi.
    DeploymentCanarySettings DeploymentCanarySettingsArgs
    The input configuration for a canary deployment.
    Description string
    The description for the Deployment resource to create.
    StageDescription DeploymentStageDescriptionArgs
    The description of the Stage resource for the Deployment resource to create. To specify a stage description, you must also provide a stage name.
    StageName string
    The name of the Stage resource for the Deployment resource to create.
    restApiId String
    The string identifier of the associated RestApi.
    deploymentCanarySettings DeploymentCanarySettings
    The input configuration for a canary deployment.
    description String
    The description for the Deployment resource to create.
    stageDescription DeploymentStageDescription
    The description of the Stage resource for the Deployment resource to create. To specify a stage description, you must also provide a stage name.
    stageName String
    The name of the Stage resource for the Deployment resource to create.
    restApiId string
    The string identifier of the associated RestApi.
    deploymentCanarySettings DeploymentCanarySettings
    The input configuration for a canary deployment.
    description string
    The description for the Deployment resource to create.
    stageDescription DeploymentStageDescription
    The description of the Stage resource for the Deployment resource to create. To specify a stage description, you must also provide a stage name.
    stageName string
    The name of the Stage resource for the Deployment resource to create.
    rest_api_id str
    The string identifier of the associated RestApi.
    deployment_canary_settings DeploymentCanarySettingsArgs
    The input configuration for a canary deployment.
    description str
    The description for the Deployment resource to create.
    stage_description DeploymentStageDescriptionArgs
    The description of the Stage resource for the Deployment resource to create. To specify a stage description, you must also provide a stage name.
    stage_name str
    The name of the Stage resource for the Deployment resource to create.
    restApiId String
    The string identifier of the associated RestApi.
    deploymentCanarySettings Property Map
    The input configuration for a canary deployment.
    description String
    The description for the Deployment resource to create.
    stageDescription Property Map
    The description of the Stage resource for the Deployment resource to create. To specify a stage description, you must also provide a stage name.
    stageName String
    The name of the Stage resource for the Deployment resource to create.

    Outputs

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

    DeploymentId string
    The ID for the deployment. For example: abc123 .
    Id string
    The provider-assigned unique ID for this managed resource.
    DeploymentId string
    The ID for the deployment. For example: abc123 .
    Id string
    The provider-assigned unique ID for this managed resource.
    deploymentId String
    The ID for the deployment. For example: abc123 .
    id String
    The provider-assigned unique ID for this managed resource.
    deploymentId string
    The ID for the deployment. For example: abc123 .
    id string
    The provider-assigned unique ID for this managed resource.
    deployment_id str
    The ID for the deployment. For example: abc123 .
    id str
    The provider-assigned unique ID for this managed resource.
    deploymentId String
    The ID for the deployment. For example: abc123 .
    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 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.
    PercentTraffic float64
    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.
    percentTraffic Double
    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.
    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.
    percent_traffic float
    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.
    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.

    DeploymentCanarySettings, DeploymentCanarySettingsArgs

    PercentTraffic double
    The percentage (0.0-100.0) of traffic routed to the canary deployment.
    StageVariableOverrides Dictionary<string, string>
    A stage variable overrides used for the canary release deployment. They can override existing stage variables or add new stage variables for the canary release deployment. 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 release deployment uses the stage cache or not.
    PercentTraffic float64
    The percentage (0.0-100.0) of traffic routed to the canary deployment.
    StageVariableOverrides map[string]string
    A stage variable overrides used for the canary release deployment. They can override existing stage variables or add new stage variables for the canary release deployment. 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 release deployment uses the stage cache or not.
    percentTraffic Double
    The percentage (0.0-100.0) of traffic routed to the canary deployment.
    stageVariableOverrides Map<String,String>
    A stage variable overrides used for the canary release deployment. They can override existing stage variables or add new stage variables for the canary release deployment. 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 release deployment uses the stage cache or not.
    percentTraffic number
    The percentage (0.0-100.0) of traffic routed to the canary deployment.
    stageVariableOverrides {[key: string]: string}
    A stage variable overrides used for the canary release deployment. They can override existing stage variables or add new stage variables for the canary release deployment. 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 release deployment uses the stage cache or not.
    percent_traffic float
    The percentage (0.0-100.0) of traffic routed to the canary deployment.
    stage_variable_overrides Mapping[str, str]
    A stage variable overrides used for the canary release deployment. They can override existing stage variables or add new stage variables for the canary release deployment. 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 release deployment uses the stage cache or not.
    percentTraffic Number
    The percentage (0.0-100.0) of traffic routed to the canary deployment.
    stageVariableOverrides Map<String>
    A stage variable overrides used for the canary release deployment. They can override existing stage variables or add new stage variables for the canary release deployment. 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 release deployment uses the stage cache or not.

    DeploymentMethodSetting, DeploymentMethodSettingArgs

    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.
    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 (/).
    ThrottlingBurstLimit int
    Specifies the throttling burst limit.
    ThrottlingRateLimit double
    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.
    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 (/).
    ThrottlingBurstLimit int
    Specifies the throttling burst limit.
    ThrottlingRateLimit float64
    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.
    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 (/).
    throttlingBurstLimit Integer
    Specifies the throttling burst limit.
    throttlingRateLimit Double
    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.
    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 (/).
    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.
    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 (/).
    throttling_burst_limit int
    Specifies the throttling burst limit.
    throttling_rate_limit float
    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.
    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 (/).
    throttlingBurstLimit Number
    Specifies the throttling burst limit.
    throttlingRateLimit Number
    Specifies the throttling rate limit.

    DeploymentStageDescription, DeploymentStageDescriptionArgs

    AccessLogSetting Pulumi.AwsNative.ApiGateway.Inputs.DeploymentAccessLogSetting
    Specifies settings for logging access in this stage.
    CacheClusterEnabled bool
    Specifies whether a cache cluster is enabled for the stage. To activate a method-level cache, set CachingEnabled to true for a method.
    CacheClusterSize string
    The size of the stage's cache cluster. For more information, see cacheClusterSize in the API Gateway API Reference.
    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. For more information, see Enable API Gateway Caching in a Stage to Enhance API Performance in the API Gateway Developer Guide.
    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 MethodSetting 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 target request burst rate limit. This allows more requests through for a period of time than the target rate limit. For more information, see Manage API Request Throttling in the API Gateway Developer Guide.
    ThrottlingRateLimit double
    The target request steady-state rate limit. For more information, see Manage API Request Throttling in the API Gateway Developer Guide.
    TracingEnabled bool
    Specifies whether active tracing with X-ray is enabled for this stage. For more information, see Trace API Gateway API Execution with X-Ray in the API Gateway Developer Guide.
    Variables Dictionary<string, string>
    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
    Specifies whether a cache cluster is enabled for the stage. To activate a method-level cache, set CachingEnabled to true for a method.
    CacheClusterSize string
    The size of the stage's cache cluster. For more information, see cacheClusterSize in the API Gateway API Reference.
    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. For more information, see Enable API Gateway Caching in a Stage to Enhance API Performance in the API Gateway Developer Guide.
    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 MethodSetting 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 target request burst rate limit. This allows more requests through for a period of time than the target rate limit. For more information, see Manage API Request Throttling in the API Gateway Developer Guide.
    ThrottlingRateLimit float64
    The target request steady-state rate limit. For more information, see Manage API Request Throttling in the API Gateway Developer Guide.
    TracingEnabled bool
    Specifies whether active tracing with X-ray is enabled for this stage. For more information, see Trace API Gateway API Execution with X-Ray in the API Gateway Developer Guide.
    Variables map[string]string
    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
    Specifies whether a cache cluster is enabled for the stage. To activate a method-level cache, set CachingEnabled to true for a method.
    cacheClusterSize String
    The size of the stage's cache cluster. For more information, see cacheClusterSize in the API Gateway API Reference.
    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. For more information, see Enable API Gateway Caching in a Stage to Enhance API Performance in the API Gateway Developer Guide.
    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 MethodSetting 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 target request burst rate limit. This allows more requests through for a period of time than the target rate limit. For more information, see Manage API Request Throttling in the API Gateway Developer Guide.
    throttlingRateLimit Double
    The target request steady-state rate limit. For more information, see Manage API Request Throttling in the API Gateway Developer Guide.
    tracingEnabled Boolean
    Specifies whether active tracing with X-ray is enabled for this stage. For more information, see Trace API Gateway API Execution with X-Ray in the API Gateway Developer Guide.
    variables Map<String,String>
    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
    Specifies whether a cache cluster is enabled for the stage. To activate a method-level cache, set CachingEnabled to true for a method.
    cacheClusterSize string
    The size of the stage's cache cluster. For more information, see cacheClusterSize in the API Gateway API Reference.
    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. For more information, see Enable API Gateway Caching in a Stage to Enhance API Performance in the API Gateway Developer Guide.
    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 MethodSetting 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 target request burst rate limit. This allows more requests through for a period of time than the target rate limit. For more information, see Manage API Request Throttling in the API Gateway Developer Guide.
    throttlingRateLimit number
    The target request steady-state rate limit. For more information, see Manage API Request Throttling in the API Gateway Developer Guide.
    tracingEnabled boolean
    Specifies whether active tracing with X-ray is enabled for this stage. For more information, see Trace API Gateway API Execution with X-Ray in the API Gateway Developer Guide.
    variables {[key: string]: string}
    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
    Specifies whether a cache cluster is enabled for the stage. To activate a method-level cache, set CachingEnabled to true for a method.
    cache_cluster_size str
    The size of the stage's cache cluster. For more information, see cacheClusterSize in the API Gateway API Reference.
    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. For more information, see Enable API Gateway Caching in a Stage to Enhance API Performance in the API Gateway Developer Guide.
    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 MethodSetting 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 target request burst rate limit. This allows more requests through for a period of time than the target rate limit. For more information, see Manage API Request Throttling in the API Gateway Developer Guide.
    throttling_rate_limit float
    The target request steady-state rate limit. For more information, see Manage API Request Throttling in the API Gateway Developer Guide.
    tracing_enabled bool
    Specifies whether active tracing with X-ray is enabled for this stage. For more information, see Trace API Gateway API Execution with X-Ray in the API Gateway Developer Guide.
    variables Mapping[str, str]
    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
    Specifies whether a cache cluster is enabled for the stage. To activate a method-level cache, set CachingEnabled to true for a method.
    cacheClusterSize String
    The size of the stage's cache cluster. For more information, see cacheClusterSize in the API Gateway API Reference.
    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. For more information, see Enable API Gateway Caching in a Stage to Enhance API Performance in the API Gateway Developer Guide.
    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 MethodSetting 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 target request burst rate limit. This allows more requests through for a period of time than the target rate limit. For more information, see Manage API Request Throttling in the API Gateway Developer Guide.
    throttlingRateLimit Number
    The target request steady-state rate limit. For more information, see Manage API Request Throttling in the API Gateway Developer Guide.
    tracingEnabled Boolean
    Specifies whether active tracing with X-ray is enabled for this stage. For more information, see Trace API Gateway API Execution with X-Ray in the API Gateway Developer Guide.
    variables Map<String>
    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

    We recommend new projects start with resources from the AWS provider.

    AWS Cloud Control v1.9.0 published on Monday, Nov 18, 2024 by Pulumi
    pulumi/pulumi-aws-native