hosted_zone_association#

State module for managing Route53 Hosted zone associations.

async idem_aws.states.aws.route53.hosted_zone_association.present(hub, ctx, name: str, zone_id: str, vpc_id: str, vpc_region: str = None, resource_id: str = None, comment: str = None, timeout: Timeout = None) → Dict[str, Any][source]#

Associates the specified vpc to the specified hosted zone.

Parameters:

  • name (str) – An Idem name of the AWS hosted zone vpc association.

  • zone_id (str) – The id of hosted zone to associate to a vpc

  • vpc_id (str) – The id of the vpc to associate to a hosted zone.

  • vpc_region (str, Optional) – The AWS region where the vpc belongs to. If the vpc_region is not specified, AWS region from credentials file will be used.

  • resource_id (str, Optional) – The identifier for this object, combination of hosted_zone id, vpc id and vpc region separated by a separator ‘:’

  • comment (str, Optional) – A comment about the association request.

  • timeout (dict, Optional) –

    Timeout configuration for hosted zone and vpc association.

    • create (dict): Timeout configuration for creating nat gateway

      • delay (int): The amount of time in seconds to wait between attempts. Defaults to 15.

      • max_attempts(int): Customized timeout configuration containing delay and max attempts. Defaults to 40.

Request Syntax:
[zone_id:vpc_id:vpc_region]:
  aws.route53.hosted_zone_association.present:
    - resource_id: 'string'
    - zone_id: 'string'
    - vpc_id: 'string'
    - vpc_region: 'string'
    - comment: 'string'
    - timeout:
        create:
          delay: 'integer'
          max_attempts: 'integer'
Returns:

Dict[str, Any]

Examples

Z09756241DYDBTZK8J11E:vpc-9aacf0f2:eu-central-1:
  aws.route53.hosted_zone_association.present:
    - zone_id: Z09756241DYDBTZK8J11E
    - vpc_id: vpc-9aacf0f2
    - vpc_region: eu-central-1
    - resource_id: Z09756241DYDBTZK8J11E:vpc-9aacf0f2:eu-central-1
    - timeout:
        create:
            delay: 15
            max_attempts: 40
async idem_aws.states.aws.route53.hosted_zone_association.absent(hub, ctx, name: str, resource_id: str = None, comment: str = None, timeout: Dict = None) → Dict[str, Any][source]#

Removes the specified managed policy from the specified role.

Parameters:

  • name (str) – An Idem name of the AWS hosted zone vpc association.

  • resource_id (str, Optional) – The id of the hosted zone and vpc association. Idem automatically considers this resource being absent if this field is not specified.

  • comment (str, Optional) – A comment about the disassociation request.

  • timeout (dict, Optional) –

    Timeout configuration for hosted zone and vpc association.

    • delete (dict): Timeout configuration for creating nat gateway

      • delay (int): The amount of time in seconds to wait between attempts. Defaults to 15.

      • max_attempts(int): Customized timeout configuration containing delay and max attempts. Defaults to 40.

Request Syntax:
[hosted_zone_association-resource-id]:
  aws.route53.hosted_zone_association.absent:
    - name: "string"
    - resource_id: "string"
    - comment: "string"
    - timeout:
        delete:
            delay: "integer"
            max_attempts: "integer"
Returns:

Dict[str, Any]

Examples

Z09756241DYDBTZK8J11E:vpc-9aacf0f2:eu-central-1:
  aws.route53.hosted_zone_association.absent:
    - name: Z09756241DYDBTZK8J11E:vpc-9aacf0f2:eu-central-1
    - resource_id: Z09756241DYDBTZK8J11E:vpc-9aacf0f2:eu-central-1
    - timeout:
        delete:
            delay: 15
            max_attempts: 40
async idem_aws.states.aws.route53.hosted_zone_association.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

Lists the associated vpc’s with respective hosted zones. If there are no vpc associated with the specified hosted zone, the operation returns an empty dict.

Returns:

Dict[str, Any]

Examples

$ idem describe aws.route53.hosted_zone_association