certificate_validation#

States module for managing ACM certificate validations.

async idem_aws.states.aws.acm.certificate_validation.present(hub, ctx, name: str, certificate_arn: str = None, resource_id: str = None, validation_record_fqdns: List[str] = None, timeout: Timeout = None) → Dict[str, Any][source]#

Validate ACM Certificate.

Before the Amazon certificate authority (CA) can issue a certificate for your site, AWS Certificate Manager (ACM) must prove that you own or control all of the domain names that you specify in your request. You can choose to prove your ownership with either Domain Name System (DNS) validation or with email validation at the time you request a certificate. In case of email validation, manual email approval of ACM certificate is required. Validation applies only to publicly trusted certificates issued by ACM. ACM does not validate domain ownership for imported certificates or for certificates signed by a private CA.

Parameters:

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

  • certificate_arn (str, Optional) – The Amazon Resource Name (ARN) of certificate. Either certificate_arn or resource_id is required.

  • resource_id (str, Optional) – The Amazon Resource Name (ARN) of certificate to identify the resource. Either certificate_arn or resource_id is required.

  • validation_record_fqdns (list[str], Optional) – List of FQDNs that implement the validation. Only valid for DNS validation method ACM certificates. If this is set, the resource can implement additional sanity checks and has an explicit dependency on the resource that is implementing the validation.

  • timeout (dict[str, Any], Optional) –

    Timeout configuration for waiting for Aws Certificate to get issued.

    • describe (dict[str, Any])

      Timeout configuration for describing certificate

      • delay (int, Optional):

        The amount of time in seconds to wait between attempts.

      • max_attempts (int, Optional):

        Customized timeout configuration containing delay and max attempts.

Returns:

Dict[str, Any]

Examples

[certificate-validation-resource-id]:
  aws.acm.certificate_validation.present:
  - certificate_arn: arn:aws:acm:eu-west-2:sample_arn
  - resource_id: arn:aws:acm:eu-west-2:sample_arn
  - validation_record_fqdns:
    - abc.dp.example.net.
    - abc2.testing.example.net.
  - timeout:
    describe:
      delay: 10
      max_attempts: 20
async idem_aws.states.aws.acm.certificate_validation.absent(hub, ctx, name: str, resource_id: str = None) → Dict[str, Any][source]#

A No-Op function for certificate_validation.

This is a configuration resource of the certificate_manager resource. It’s not possible to delete certificate_validations, You can delete a certificate_manager resource by calling certificate_manager.absent, while providing the certificate_manager id.

Parameters:

  • name – The name of the resource.

  • resource_id (str, Optional) – The Amazon Resource Name (ARN) of certificate to identify the resource. Either certificate_arn or resource_id is required.

Request Syntax:
[certificate-validation-resource-id]:
  aws.acm.certificate_validation.absent:
    - name: "string"
Returns:

Dict[str, Any]

async idem_aws.states.aws.acm.certificate_validation.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 detailed metadata about ACM certificates required for certificates validations.

Returns:

Dict[str, Dict[str, Any]]

Examples

$ idem describe aws.acm.certificate_validation