stage#

Autogenerated using pop-create-idem

hub.exec.boto3.client.apigatewayv2.create_stage hub.exec.boto3.client.apigatewayv2.delete_stage hub.exec.boto3.client.apigatewayv2.get_apis hub.exec.boto3.client.apigatewayv2.get_stage hub.exec.boto3.client.apigatewayv2.get_stages hub.exec.boto3.client.apigatewayv2.tag_resource hub.exec.boto3.client.apigatewayv2.untag_resource hub.exec.boto3.client.apigatewayv2.update_stage

async idem_aws.states.aws.apigatewayv2.stage.present(hub, ctx, name: str, api_id: str, resource_id: str = None, access_log_settings: AccessLogSettings = None, auto_deploy: bool = None, client_certificate_id: str = None, default_route_settings: RouteSettings = None, deployment_id: str = None, description: str = None, route_settings: Dict[str, RouteSettingsMap] = None, stage_variables: Dict[str, str] = None, tags: Dict = None) → Dict[str, Any][source]#

Creates an API Gateway v2 stage resource.

Parameters:

name (str) – An Idem name of the resource. This is also used as the name of the Stage during resource creation.
api_id (str) – The API resource identifier in Amazon Web Services.
resource_id (str, Optional) – The stage resource name in Amazon Web Services.
access_log_settings (Dict[str, Any], Optional) –
Settings for logging access in this stage. Defaults to None. * DestinationArn (str, Optional): The ARN of the CloudWatch Logs log group to receive access logs. * Format (str, Optional): A single line format of the access logs of data, as specified by selected $context variables.

The format must include at least $context.requestId.
auto_deploy (bool, Optional) – Specifies whether updates to an API automatically trigger a new deployment.
client_certificate_id (str, Optional) – The identifier of a client certificate for a Stage. Supported only for WebSocket APIs.
default_route_settings (Dict[str, Any], Optional) –
The default route settings for the stage. Defaults to None. * DataTraceEnabled (bool, Optional): Specifies whether (true) or not (false) data trace logging is enabled for this route. This

property affects the log entries pushed to Amazon CloudWatch Logs. Supported only for WebSocket APIs.
- DetailedMetricsEnabled (bool, Optional): Specifies whether detailed metrics are enabled.
- LoggingLevel (str, Optional): Specifies the logging level for this route: INFO, ERROR, or OFF. This property affects the log
  entries pushed to Amazon CloudWatch Logs. Supported only for WebSocket APIs.
- ThrottlingBurstLimit (int, Optional): Specifies the throttling burst limit.
- ThrottlingRateLimit (float, Optional): Specifies the throttling rate limit.
deployment_id (str, Optional) – The deployment identifier of the API stage.
description (str, Optional) – The description for the API stage.
route_settings (Dict[str, Dict[str, Any]], Optional) –
Route settings for the stage, by routeKey. Defaults to None. * DataTraceEnabled (bool, Optional): Specifies whether (true) or not (false) data trace logging is enabled for this route. This

property affects the log entries pushed to Amazon CloudWatch Logs. Supported only for WebSocket APIs.
- DetailedMetricsEnabled (bool, Optional): Specifies whether detailed metrics are enabled.
- LoggingLevel (str, Optional): Specifies the logging level for this route: INFO, ERROR, or OFF. This property affects the log
  entries pushed to Amazon CloudWatch Logs. Supported only for WebSocket APIs.
- ThrottlingBurstLimit (int, Optional): Specifies the throttling burst limit.
- ThrottlingRateLimit (float, Optional): Specifies the throttling rate limit.
stage_variables (Dict, Optional) – 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-._~:/?#&=,]+.
tags (Dict, Optional) – The collection of tags. Each tag element is associated with a given resource.

Request Syntax:

[idem_test_aws_apigatewayv2_stage]:

aws.apigatewayv2.stage.present:

name: ‘string’
api_id: ‘string’
access_log_settings: {
‘DestinationArn’: ‘string’, ‘Format’: ‘string’

}
auto_deploy: True|False
client_certificate_id: ‘string’
default_route_settings:{
‘DataTraceEnabled’: True|False, ‘DetailedMetricsEnabled’: True|False, ‘LoggingLevel’: ‘ERROR’|’INFO’|’OFF’, ‘ThrottlingBurstLimit’: int, ‘ThrottlingRateLimit’: int

} - deployment_id: ‘string’ - description: ‘string’ - route_settings: {

‘string’: {
‘DataTraceEnabled’: True|False, ‘DetailedMetricsEnabled’: True|False, ‘LoggingLevel’: ‘ERROR’|’INFO’|’OFF’, ‘ThrottlingBurstLimit’: int, ‘ThrottlingRateLimit’: int

}

}

stage_variables: {‘string’: ‘string’}
tags: {‘string’: ‘string’}

Returns:: Dict[str, Any]

Examples

idem_test_aws_apigatewayv2_stage:
  aws.apigatewayv2.stage.present:
    - name: value
    - api_id: value
    - access_log_settings: {}
    - auto_deploy: True|False
    - client_certificate_id: value
    - default_route_settings: {}
    - deployment_id: value
    - description: value
    - route_settings: {}
    - stage_variables: {}
    - tags: {}

async idem_aws.states.aws.apigatewayv2.stage.absent(hub, ctx, name: str, api_id: str = None, resource_id: str = None) → Dict[str, Any][source]#

Deletes an API Gateway v2 stage resource.

Parameters:

name (str) – An Idem name of the resource.
api_id (str) – The API resource identifier in Amazon Web Services.
resource_id (str, Optional) – The stage resource name in Amazon Web Services. Idem automatically considers this resource being absent if this field is not specified.

Returns:

Dict[str, Any]

Examples

idem_test_aws_apigatewayv2_stage:
  aws.apigatewayv2.stage.absent:
    - name: value
    - api_id: value
    - resource_id: value

async idem_aws.states.aws.apigatewayv2.stage.describe(hub, ctx) → Dict[str, Dict[str, Any]][source]#

Describe the resource in a way that can be recreated/managed with the corresponding “present” function

Gets the API Gateway v2 stage resources for an AWS account.

Returns:: Dict[str, Dict[str, Any]]

Examples

$ idem describe aws.apigatewayv2.stage