deployment#

State module for managing Amazon API Gateway Deployments.

async idem_aws.states.aws.apigateway.deployment.present(hub, ctx, name: str, rest_api_id: str, resource_id: str = None, stage_name: str = None, stage_description: str = None, description: str = None, cache_cluster_enabled: bool = None, cache_cluster_size: str = None, variables: Dict = None, canary_settings: canarySettings = None, tracing_enabled: bool = None) → Dict[str, Any][source]#

Creates an API Gateway Deployment resource.

Parameters:

  • name (str) – An Idem name of the resource.

  • rest_api_id (str) – The string identifier of the associated RestApi.

  • resource_id (str, Optional) – AWS API Gateway Deployment ID.

  • stage_name (str, Optional) – The name of the Stage resource for the Deployment resource to create. This parameter is only valid during creation. Defaults to None.

  • stage_description (str, Optional) – The description of the Stage resource for the Deployment resource to create. This parameter is only valid during creation. Defaults to None.

  • description (str, Optional) – The description for the Deployment resource to create. Defaults to None.

  • cache_cluster_enabled (bool, Optional) – Enables a cache cluster for the Stage resource specified in the input. This parameter is only valid during creation. Defaults to None.

  • cache_cluster_size (str, Optional) – Specifies the cache cluster size for the Stage resource specified in the input, if a cache cluster is enabled. This parameter is only valid during creation. Defaults to None.

  • variables (dict, Optional) – A map that defines the stage variables for the Stage resource that is associated with the new deployment. Variable names can have alphanumeric and underscore characters, and the values must match [A-Za-z0-9-._~:/?#&=,]+. This parameter is only valid during creation. Defaults to None.

  • canary_settings (dict, Optional) – The input configuration for the canary deployment when the deployment is a canary release deployment. This parameter is only valid during creation. Defaults to None.

  • tracing_enabled (bool, Optional) – Specifies whether active tracing with X-ray is enabled for the Stage. This parameter is only valid during creation. Defaults to None.

Request Syntax:
[idem_test_aws_apigateway_deployment]:
aws.apigateway.deployment.present:
    - name: 'string'
    - resource_id: 'string'
    - stage_name: 'string'
    - stage_description: 'string'
    - description: 'string'
    - cache_cluster_enabled: bool
    - cache_cluster_size: 'string'
    - variables:
    - 'string' : 'string'
    - canary_settings:
    - percentTraffic: float
    - stageVariableOverrides:
        - 'string: 'string'
    useStageCache: bool
    - tracing_enabled: bool
Returns:

Dict[str, Any]

Examples

resource_is_present:
  aws.apigateway.deployment.present:
    - name: value
    - rest_api_id: value
async idem_aws.states.aws.apigateway.deployment.absent(hub, ctx, name: str, rest_api_id: str = None, resource_id: str = None) → Dict[str, Any][source]#

Deletes a Deployment resource.

Deleting a deployment will only succeed if there are no Stage resources associated with it.

Parameters:

  • name (str) – An Idem name of the resource.

  • rest_api_id (str, Optional) – The string identifier of the associated RestApi.

  • resource_id (str, Optional) – AWS API Gateway Deployment ID. Idem automatically considers this resource being absent if this field is not specified.

Returns:

Dict[str, Any]

Examples

resource_is_absent:
  aws.apigateway.deployment.absent:
    - name: value
    - resource_id: value
    - rest_api_id: value
async idem_aws.states.aws.apigateway.deployment.describe(hub, ctx) → Dict[str, Dict[str, Any]][source]#

Describe the API Gateway Deployments.

Returns a list of apigateway.deployment descriptions

Returns:

Dict[str, Any]

Examples

$ idem describe aws.apigateway.deployment