domain_name#

Exec module for AWS API Gateway Domain Name resources.

async idem_aws.exec.aws.apigateway.domain_name.get(hub, ctx, name: str, resource_id: str) → Dict[source]#

Get an API Gateway domain name resource from AWS with the domain name as the resource_id.

Parameters:

name (str) – The name of the Idem state domain name.
resource_id (str) – AWS API Gateway domain name.

Returns:

Dict[str, Any]

Examples

Calling from the CLI:

$ idem exec aws.apigateway.domain_name.get name="unmanaged_domain_names"

Using in a state:

my_unmanaged_resource:
  exec.run:
    - path: aws.apigateway.domain_name.get
    - kwargs:
        name: unmanaged_domain_name
        resource_id: resource_id

async idem_aws.exec.aws.apigateway.domain_name.list_(hub, ctx, name: str = None)[source]#

Get the list of domain names for AWS APIGateway.

Parameters:: name (str, Optional) – The name of the Idem state for logging.
Returns:: Dict[str, Any]

Examples

Calling from the CLI:

idem exec aws.apigateway.domain_name.list

Calling this exec module function from within a state:

my_unmanaged_resource:
  exec.run:
    - path: aws.apigateway.domain_name.list
    - kwargs:
        name: my-resource-name