Sign in Dashboard Get started
  1. Registry
  2. Packages
  3. AWS Cloud Control
  4. API Docs
  5. apigatewayv2
  6. ApiGatewayManagedOverrides

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

Viewing docs for AWS Cloud Control v1.76.0
published on Monday, Aug 24, 2026 by Pulumi
Schema (JSON)
pulumi/pulumi-aws-native

aws-native.apigatewayv2.ApiGatewayManagedOverrides

aws-native logo aws-native logo

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

Viewing docs for AWS Cloud Control v1.76.0
published on Monday, Aug 24, 2026 by Pulumi
Schema (JSON)
pulumi/pulumi-aws-native

    Resource Type definition for AWS::ApiGatewayV2::ApiGatewayManagedOverrides

    Create ApiGatewayManagedOverrides Resource

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

    Constructor syntax

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

@overload
def ApiGatewayManagedOverrides(resource_name: str,
                               opts: Optional[ResourceOptions] = None,
                               api_id: Optional[str] = None,
                               integration: Optional[ApiGatewayManagedOverridesIntegrationOverridesArgs] = None,
                               route: Optional[ApiGatewayManagedOverridesRouteOverridesArgs] = None,
                               stage: Optional[ApiGatewayManagedOverridesStageOverridesArgs] = None)
    func NewApiGatewayManagedOverrides(ctx *Context, name string, args ApiGatewayManagedOverridesArgs, opts ...ResourceOption) (*ApiGatewayManagedOverrides, error)
    public ApiGatewayManagedOverrides(string name, ApiGatewayManagedOverridesArgs args, CustomResourceOptions? opts = null)
    public ApiGatewayManagedOverrides(String name, ApiGatewayManagedOverridesArgs args)
public ApiGatewayManagedOverrides(String name, ApiGatewayManagedOverridesArgs args, CustomResourceOptions options)

    type: aws-native:apigatewayv2:ApiGatewayManagedOverrides
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.


    resource "aws-native_apigatewayv2_api_gateway_managed_overrides" "name" {
    # resource properties
}

    Parameters

    name string
    The unique name of the resource.
    args ApiGatewayManagedOverridesArgs
    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 ApiGatewayManagedOverridesArgs
    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 ApiGatewayManagedOverridesArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args ApiGatewayManagedOverridesArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args ApiGatewayManagedOverridesArgs
    The arguments to resource properties.
    options CustomResourceOptions
    Bag of options to control resource's behavior.

    ApiGatewayManagedOverrides 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 ApiGatewayManagedOverrides resource accepts the following input properties:

    ApiId string
    The ID of the API for which to override the configuration of API Gateway-managed resources.
    Integration Pulumi.AwsNative.ApiGatewayV2.Inputs.ApiGatewayManagedOverridesIntegrationOverrides
    Overrides the integration configuration for an API Gateway-managed integration.
    Route Pulumi.AwsNative.ApiGatewayV2.Inputs.ApiGatewayManagedOverridesRouteOverrides
    Overrides the route configuration for an API Gateway-managed route.
    Stage Pulumi.AwsNative.ApiGatewayV2.Inputs.ApiGatewayManagedOverridesStageOverrides
    Overrides the stage configuration for an API Gateway-managed stage.
    ApiId string
    The ID of the API for which to override the configuration of API Gateway-managed resources.
    Integration ApiGatewayManagedOverridesIntegrationOverridesArgs
    Overrides the integration configuration for an API Gateway-managed integration.
    Route ApiGatewayManagedOverridesRouteOverridesArgs
    Overrides the route configuration for an API Gateway-managed route.
    Stage ApiGatewayManagedOverridesStageOverridesArgs
    Overrides the stage configuration for an API Gateway-managed stage.
    api_id string
    The ID of the API for which to override the configuration of API Gateway-managed resources.
    integration object
    Overrides the integration configuration for an API Gateway-managed integration.
    route object
    Overrides the route configuration for an API Gateway-managed route.
    stage object
    Overrides the stage configuration for an API Gateway-managed stage.
    apiId String
    The ID of the API for which to override the configuration of API Gateway-managed resources.
    integration ApiGatewayManagedOverridesIntegrationOverrides
    Overrides the integration configuration for an API Gateway-managed integration.
    route ApiGatewayManagedOverridesRouteOverrides
    Overrides the route configuration for an API Gateway-managed route.
    stage ApiGatewayManagedOverridesStageOverrides
    Overrides the stage configuration for an API Gateway-managed stage.
    apiId string
    The ID of the API for which to override the configuration of API Gateway-managed resources.
    integration ApiGatewayManagedOverridesIntegrationOverrides
    Overrides the integration configuration for an API Gateway-managed integration.
    route ApiGatewayManagedOverridesRouteOverrides
    Overrides the route configuration for an API Gateway-managed route.
    stage ApiGatewayManagedOverridesStageOverrides
    Overrides the stage configuration for an API Gateway-managed stage.
    api_id str
    The ID of the API for which to override the configuration of API Gateway-managed resources.
    integration ApiGatewayManagedOverridesIntegrationOverridesArgs
    Overrides the integration configuration for an API Gateway-managed integration.
    route ApiGatewayManagedOverridesRouteOverridesArgs
    Overrides the route configuration for an API Gateway-managed route.
    stage ApiGatewayManagedOverridesStageOverridesArgs
    Overrides the stage configuration for an API Gateway-managed stage.
    apiId String
    The ID of the API for which to override the configuration of API Gateway-managed resources.
    integration Property Map
    Overrides the integration configuration for an API Gateway-managed integration.
    route Property Map
    Overrides the route configuration for an API Gateway-managed route.
    stage Property Map
    Overrides the stage configuration for an API Gateway-managed stage.

    Outputs

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

    AwsId string
    A TPS Code is automatically generated on creation and assigned as the unique identifier.
    Id string
    The provider-assigned unique ID for this managed resource.
    AwsId string
    A TPS Code is automatically generated on creation and assigned as the unique identifier.
    Id string
    The provider-assigned unique ID for this managed resource.
    aws_id string
    A TPS Code is automatically generated on creation and assigned as the unique identifier.
    id string
    The provider-assigned unique ID for this managed resource.
    awsId String
    A TPS Code is automatically generated on creation and assigned as the unique identifier.
    id String
    The provider-assigned unique ID for this managed resource.
    awsId string
    A TPS Code is automatically generated on creation and assigned as the unique identifier.
    id string
    The provider-assigned unique ID for this managed resource.
    aws_id str
    A TPS Code is automatically generated on creation and assigned as the unique identifier.
    id str
    The provider-assigned unique ID for this managed resource.
    awsId String
    A TPS Code is automatically generated on creation and assigned as the unique identifier.
    id String
    The provider-assigned unique ID for this managed resource.

    Supporting Types

    ApiGatewayManagedOverridesAccessLogSettings, ApiGatewayManagedOverridesAccessLogSettingsArgs

    DestinationArn string
    The ARN of the CloudWatch Logs log group to receive access logs.
    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 ARN of the CloudWatch Logs log group to receive access logs.
    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 string
    The ARN of the CloudWatch Logs log group to receive access logs.
    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 ARN of the CloudWatch Logs log group to receive access logs.
    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 ARN of the CloudWatch Logs log group to receive access logs.
    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 ARN of the CloudWatch Logs log group to receive access logs.
    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 ARN of the CloudWatch Logs log group to receive access logs.
    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.

    ApiGatewayManagedOverridesIntegrationOverrides, ApiGatewayManagedOverridesIntegrationOverridesArgs

    Description string
    The description of the integration.
    IntegrationMethod string
    Specifies the integration's HTTP method type. For WebSocket APIs, if you use a Lambda integration, you must set the integration method to POST.
    PayloadFormatVersion string
    Specifies the format of the payload sent to an integration. Required for HTTP APIs. For HTTP APIs, supported values for Lambda proxy integrations are 1.0 and 2.0. For all other integrations, 1.0 is the only supported value
    TimeoutInMillis int
    Custom timeout between 50 and 29,000 milliseconds for WebSocket APIs and between 50 and 30,000 milliseconds for HTTP APIs. The default timeout is 29 seconds for WebSocket APIs and 30 seconds for HTTP APIs.
    Description string
    The description of the integration.
    IntegrationMethod string
    Specifies the integration's HTTP method type. For WebSocket APIs, if you use a Lambda integration, you must set the integration method to POST.
    PayloadFormatVersion string
    Specifies the format of the payload sent to an integration. Required for HTTP APIs. For HTTP APIs, supported values for Lambda proxy integrations are 1.0 and 2.0. For all other integrations, 1.0 is the only supported value
    TimeoutInMillis int
    Custom timeout between 50 and 29,000 milliseconds for WebSocket APIs and between 50 and 30,000 milliseconds for HTTP APIs. The default timeout is 29 seconds for WebSocket APIs and 30 seconds for HTTP APIs.
    description string
    The description of the integration.
    integration_method string
    Specifies the integration's HTTP method type. For WebSocket APIs, if you use a Lambda integration, you must set the integration method to POST.
    payload_format_version string
    Specifies the format of the payload sent to an integration. Required for HTTP APIs. For HTTP APIs, supported values for Lambda proxy integrations are 1.0 and 2.0. For all other integrations, 1.0 is the only supported value
    timeout_in_millis number
    Custom timeout between 50 and 29,000 milliseconds for WebSocket APIs and between 50 and 30,000 milliseconds for HTTP APIs. The default timeout is 29 seconds for WebSocket APIs and 30 seconds for HTTP APIs.
    description String
    The description of the integration.
    integrationMethod String
    Specifies the integration's HTTP method type. For WebSocket APIs, if you use a Lambda integration, you must set the integration method to POST.
    payloadFormatVersion String
    Specifies the format of the payload sent to an integration. Required for HTTP APIs. For HTTP APIs, supported values for Lambda proxy integrations are 1.0 and 2.0. For all other integrations, 1.0 is the only supported value
    timeoutInMillis Integer
    Custom timeout between 50 and 29,000 milliseconds for WebSocket APIs and between 50 and 30,000 milliseconds for HTTP APIs. The default timeout is 29 seconds for WebSocket APIs and 30 seconds for HTTP APIs.
    description string
    The description of the integration.
    integrationMethod string
    Specifies the integration's HTTP method type. For WebSocket APIs, if you use a Lambda integration, you must set the integration method to POST.
    payloadFormatVersion string
    Specifies the format of the payload sent to an integration. Required for HTTP APIs. For HTTP APIs, supported values for Lambda proxy integrations are 1.0 and 2.0. For all other integrations, 1.0 is the only supported value
    timeoutInMillis number
    Custom timeout between 50 and 29,000 milliseconds for WebSocket APIs and between 50 and 30,000 milliseconds for HTTP APIs. The default timeout is 29 seconds for WebSocket APIs and 30 seconds for HTTP APIs.
    description str
    The description of the integration.
    integration_method str
    Specifies the integration's HTTP method type. For WebSocket APIs, if you use a Lambda integration, you must set the integration method to POST.
    payload_format_version str
    Specifies the format of the payload sent to an integration. Required for HTTP APIs. For HTTP APIs, supported values for Lambda proxy integrations are 1.0 and 2.0. For all other integrations, 1.0 is the only supported value
    timeout_in_millis int
    Custom timeout between 50 and 29,000 milliseconds for WebSocket APIs and between 50 and 30,000 milliseconds for HTTP APIs. The default timeout is 29 seconds for WebSocket APIs and 30 seconds for HTTP APIs.
    description String
    The description of the integration.
    integrationMethod String
    Specifies the integration's HTTP method type. For WebSocket APIs, if you use a Lambda integration, you must set the integration method to POST.
    payloadFormatVersion String
    Specifies the format of the payload sent to an integration. Required for HTTP APIs. For HTTP APIs, supported values for Lambda proxy integrations are 1.0 and 2.0. For all other integrations, 1.0 is the only supported value
    timeoutInMillis Number
    Custom timeout between 50 and 29,000 milliseconds for WebSocket APIs and between 50 and 30,000 milliseconds for HTTP APIs. The default timeout is 29 seconds for WebSocket APIs and 30 seconds for HTTP APIs.

    ApiGatewayManagedOverridesRouteOverrides, ApiGatewayManagedOverridesRouteOverridesArgs

    AuthorizationScopes List<string>
    The authorization scopes supported by this route.
    AuthorizationType string
    The authorization type for the route. To learn more, see AuthorizationType.
    AuthorizerId string
    The identifier of the Authorizer resource to be associated with this route. The authorizer identifier is generated by API Gateway when you created the authorizer.
    OperationName string
    The operation name for the route.
    Target string
    For HTTP integrations, specify a fully qualified URL. For Lambda integrations, specify a function ARN. The type of the integration will be HTTP_PROXY or AWS_PROXY, respectively.
    AuthorizationScopes []string
    The authorization scopes supported by this route.
    AuthorizationType string
    The authorization type for the route. To learn more, see AuthorizationType.
    AuthorizerId string
    The identifier of the Authorizer resource to be associated with this route. The authorizer identifier is generated by API Gateway when you created the authorizer.
    OperationName string
    The operation name for the route.
    Target string
    For HTTP integrations, specify a fully qualified URL. For Lambda integrations, specify a function ARN. The type of the integration will be HTTP_PROXY or AWS_PROXY, respectively.
    authorization_scopes list(string)
    The authorization scopes supported by this route.
    authorization_type string
    The authorization type for the route. To learn more, see AuthorizationType.
    authorizer_id string
    The identifier of the Authorizer resource to be associated with this route. The authorizer identifier is generated by API Gateway when you created the authorizer.
    operation_name string
    The operation name for the route.
    target string
    For HTTP integrations, specify a fully qualified URL. For Lambda integrations, specify a function ARN. The type of the integration will be HTTP_PROXY or AWS_PROXY, respectively.
    authorizationScopes List<String>
    The authorization scopes supported by this route.
    authorizationType String
    The authorization type for the route. To learn more, see AuthorizationType.
    authorizerId String
    The identifier of the Authorizer resource to be associated with this route. The authorizer identifier is generated by API Gateway when you created the authorizer.
    operationName String
    The operation name for the route.
    target String
    For HTTP integrations, specify a fully qualified URL. For Lambda integrations, specify a function ARN. The type of the integration will be HTTP_PROXY or AWS_PROXY, respectively.
    authorizationScopes string[]
    The authorization scopes supported by this route.
    authorizationType string
    The authorization type for the route. To learn more, see AuthorizationType.
    authorizerId string
    The identifier of the Authorizer resource to be associated with this route. The authorizer identifier is generated by API Gateway when you created the authorizer.
    operationName string
    The operation name for the route.
    target string
    For HTTP integrations, specify a fully qualified URL. For Lambda integrations, specify a function ARN. The type of the integration will be HTTP_PROXY or AWS_PROXY, respectively.
    authorization_scopes Sequence[str]
    The authorization scopes supported by this route.
    authorization_type str
    The authorization type for the route. To learn more, see AuthorizationType.
    authorizer_id str
    The identifier of the Authorizer resource to be associated with this route. The authorizer identifier is generated by API Gateway when you created the authorizer.
    operation_name str
    The operation name for the route.
    target str
    For HTTP integrations, specify a fully qualified URL. For Lambda integrations, specify a function ARN. The type of the integration will be HTTP_PROXY or AWS_PROXY, respectively.
    authorizationScopes List<String>
    The authorization scopes supported by this route.
    authorizationType String
    The authorization type for the route. To learn more, see AuthorizationType.
    authorizerId String
    The identifier of the Authorizer resource to be associated with this route. The authorizer identifier is generated by API Gateway when you created the authorizer.
    operationName String
    The operation name for the route.
    target String
    For HTTP integrations, specify a fully qualified URL. For Lambda integrations, specify a function ARN. The type of the integration will be HTTP_PROXY or AWS_PROXY, respectively.

    ApiGatewayManagedOverridesRouteSettings, ApiGatewayManagedOverridesRouteSettingsArgs

    DetailedMetricsEnabled bool
    Specifies whether detailed metrics are enabled.
    ThrottlingBurstLimit int
    Specifies the throttling burst limit.
    ThrottlingRateLimit double
    Specifies the throttling rate limit.
    DetailedMetricsEnabled bool
    Specifies whether detailed metrics are enabled.
    ThrottlingBurstLimit int
    Specifies the throttling burst limit.
    ThrottlingRateLimit float64
    Specifies the throttling rate limit.
    detailed_metrics_enabled bool
    Specifies whether detailed metrics are enabled.
    throttling_burst_limit number
    Specifies the throttling burst limit.
    throttling_rate_limit number
    Specifies the throttling rate limit.
    detailedMetricsEnabled Boolean
    Specifies whether detailed metrics are enabled.
    throttlingBurstLimit Integer
    Specifies the throttling burst limit.
    throttlingRateLimit Double
    Specifies the throttling rate limit.
    detailedMetricsEnabled boolean
    Specifies whether detailed metrics are enabled.
    throttlingBurstLimit number
    Specifies the throttling burst limit.
    throttlingRateLimit number
    Specifies the throttling rate limit.
    detailed_metrics_enabled bool
    Specifies whether detailed metrics are enabled.
    throttling_burst_limit int
    Specifies the throttling burst limit.
    throttling_rate_limit float
    Specifies the throttling rate limit.
    detailedMetricsEnabled Boolean
    Specifies whether detailed metrics are enabled.
    throttlingBurstLimit Number
    Specifies the throttling burst limit.
    throttlingRateLimit Number
    Specifies the throttling rate limit.

    ApiGatewayManagedOverridesStageOverrides, ApiGatewayManagedOverridesStageOverridesArgs

    AccessLogSettings Pulumi.AwsNative.ApiGatewayV2.Inputs.ApiGatewayManagedOverridesAccessLogSettings
    Settings for logging access in a stage.
    AutoDeploy bool
    Specifies whether updates to an API automatically trigger a new deployment. The default value is true.
    DefaultRouteSettings Pulumi.AwsNative.ApiGatewayV2.Inputs.ApiGatewayManagedOverridesRouteSettings
    The default route settings for the stage.
    Description string
    The description for the API stage.
    RouteSettings Dictionary<string, Pulumi.AwsNative.ApiGatewayV2.Inputs.ApiGatewayManagedOverridesRouteSettings>
    Route settings for the stage.
    StageVariables Dictionary<string, string>
    A map that defines the stage variables for a Stage. Variable names can have alphanumeric and underscore characters, and the values must match [A-Za-z0-9-._~:/?#&=,]+.
    AccessLogSettings ApiGatewayManagedOverridesAccessLogSettings
    Settings for logging access in a stage.
    AutoDeploy bool
    Specifies whether updates to an API automatically trigger a new deployment. The default value is true.
    DefaultRouteSettings ApiGatewayManagedOverridesRouteSettings
    The default route settings for the stage.
    Description string
    The description for the API stage.
    RouteSettings map[string]ApiGatewayManagedOverridesRouteSettings
    Route settings for the stage.
    StageVariables map[string]string
    A map that defines the stage variables for a Stage. Variable names can have alphanumeric and underscore characters, and the values must match [A-Za-z0-9-._~:/?#&=,]+.
    access_log_settings object
    Settings for logging access in a stage.
    auto_deploy bool
    Specifies whether updates to an API automatically trigger a new deployment. The default value is true.
    default_route_settings object
    The default route settings for the stage.
    description string
    The description for the API stage.
    route_settings map(object)
    Route settings for the stage.
    stage_variables map(string)
    A map that defines the stage variables for a Stage. Variable names can have alphanumeric and underscore characters, and the values must match [A-Za-z0-9-._~:/?#&=,]+.
    accessLogSettings ApiGatewayManagedOverridesAccessLogSettings
    Settings for logging access in a stage.
    autoDeploy Boolean
    Specifies whether updates to an API automatically trigger a new deployment. The default value is true.
    defaultRouteSettings ApiGatewayManagedOverridesRouteSettings
    The default route settings for the stage.
    description String
    The description for the API stage.
    routeSettings Map<String,ApiGatewayManagedOverridesRouteSettings>
    Route settings for the stage.
    stageVariables Map<String,String>
    A map that defines the stage variables for a Stage. Variable names can have alphanumeric and underscore characters, and the values must match [A-Za-z0-9-._~:/?#&=,]+.
    accessLogSettings ApiGatewayManagedOverridesAccessLogSettings
    Settings for logging access in a stage.
    autoDeploy boolean
    Specifies whether updates to an API automatically trigger a new deployment. The default value is true.
    defaultRouteSettings ApiGatewayManagedOverridesRouteSettings
    The default route settings for the stage.
    description string
    The description for the API stage.
    routeSettings {[key: string]: ApiGatewayManagedOverridesRouteSettings}
    Route settings for the stage.
    stageVariables {[key: string]: string}
    A map that defines the stage variables for a Stage. Variable names can have alphanumeric and underscore characters, and the values must match [A-Za-z0-9-._~:/?#&=,]+.
    access_log_settings ApiGatewayManagedOverridesAccessLogSettings
    Settings for logging access in a stage.
    auto_deploy bool
    Specifies whether updates to an API automatically trigger a new deployment. The default value is true.
    default_route_settings ApiGatewayManagedOverridesRouteSettings
    The default route settings for the stage.
    description str
    The description for the API stage.
    route_settings Mapping[str, ApiGatewayManagedOverridesRouteSettings]
    Route settings for the stage.
    stage_variables Mapping[str, str]
    A map that defines the stage variables for a Stage. Variable names can have alphanumeric and underscore characters, and the values must match [A-Za-z0-9-._~:/?#&=,]+.
    accessLogSettings Property Map
    Settings for logging access in a stage.
    autoDeploy Boolean
    Specifies whether updates to an API automatically trigger a new deployment. The default value is true.
    defaultRouteSettings Property Map
    The default route settings for the stage.
    description String
    The description for the API stage.
    routeSettings Map<Property Map>
    Route settings for the stage.
    stageVariables Map<String>
    A map that defines the stage variables for a Stage. Variable names can have alphanumeric and underscore characters, and the values must match [A-Za-z0-9-._~:/?#&=,]+.

    Package Details

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

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

    Viewing docs for AWS Cloud Control v1.76.0
    published on Monday, Aug 24, 2026 by Pulumi
    Schema (JSON)
    pulumi/pulumi-aws-native

      Try Pulumi Cloud free.
      Your team will thank you.

      Start free trial