domain_identity#

State module for managing SES Domain Identity.

async idem_aws.states.aws.ses.domain_identity.present(hub, ctx, name: str, domain: str, resource_id: str = None) → Dict[str, Any][source]#

Adds a domain to the list of identities for your Amazon SES account in the current AWS Region and attempts to verify it.

Parameters:

name (str) – An Idem name to identify SES Domain Identity resource.
domain (str) – The domain to be verified.
resource_id (str, Optional) – The domain name.

Request Syntax:

[domain_identity-resource-id]:
  aws.ses.domain_identity.present:
    - name: "string"
    - domain: "string"

Returns:: Dict[str, Any]

Examples

example.com:
  aws.ses.domain_identity.present:
    - name: example.com
    - domain: example.com

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

Deletes the specified identity

Parameters:

name (str) – An Idem name to identify SES Domain Identity resource.
resource_id (str, Optional) – The domain name. Idem automatically considers this resource being absent if this field is not specified.

Request Syntax:

[domain_identity-resource-id]:
  aws.ses.domain_identity.absent:
    - name: "string"
    - resource_id: "string"

Returns:: Dict[str, Any]

Examples

example.com:
  aws.ses.domain_identity.absent:
    - name: example.com
    - domain: example.com

async idem_aws.states.aws.ses.domain_identity.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.

Returns:: Dict[str, Any]

Examples

idem describe aws.ses.domain_identity