domain_name#

State module for managing AWS Api Gateway Domain Name.

async idem_aws.states.aws.apigateway.domain_name.present(hub, ctx, name: str, certificate_name: str = None, certificate_arn: str = None, regional_certificate_name: str = None, regional_certificate_arn: str = None, resource_id: str = None, endpoint_configuration: endpointConfigurationInput = None, mutual_tls_authentication: MutualTlsAuthenticationInput = None, security_policy: str = None, tags: Dict[str, str] = None, timeout: Timeout = None) → Dict[str, Any][source]#

Creates or updates the apigateway domain name resource.

Parameters:

name (str) – The name of the DomainName resource
certificate_name (str, Optional) – The user-friendly name of the certificate that will be used by edge-optimized endpoint for this domain name.
certificate_arn (str, Optional) – The reference to an AWS-managed certificate that will be used by edge-optimized endpoint for this domain name. AWS Certificate Manager is the only supported source.
regional_certificate_name (str, Optional) – The user-friendly name of the certificate that will be used by regional endpoint for this domain name.
regional_certificate_arn (str, Optional) – The reference to an AWS-managed certificate that will be used by regional endpoint for this domain name. AWS Certificate Manager is the only supported source.
resource_id (str, Optional) – idem required name for the AWS API Gateway domain
endpoint_configuration (dict, Optional) –
The endpoint configuration of this DomainName showing the endpoint types of the domain name. - types(list, Optional):

A list of endpoint types of an API (RestApi) or its custom domain name (DomainName). For an edge-optimized API and its custom domain name, the endpoint type is “EDGE” . For a regional API and its custom domain name, the endpoint type is REGIONAL . For a private API, the endpoint type is PRIVATE . string) – The endpoint type. The valid values are EDGE for edge-optimized API setup, most suitable for mobile applications; REGIONAL for regional API endpoint setup, most suitable for calling from AWS Region; and PRIVATE for private APIs.
- vpcEndpointIds (list, Optional):
  A list of VpcEndpointIds of an API (RestApi) against which to create Route53 ALIASes. It is only supported for PRIVATE endpoint type.
mutual_tls_authentication (dict, Optional) –
The mutual TLS authentication configuration for a custom domain name. If specified, API Gateway performs two-way authentication between the client and the server. Clients must present a trusted certificate to access your API. - TruststoreUri(str, Optional)–

An Amazon S3 URL that specifies the truststore for mutual TLS authentication, for example s3://bucket-name/key-name . The truststore can contain certificates from public or private certificate authorities. To update the truststore, upload a new version to S3, and then update your custom domain name to use the new version. To update the truststore, you must have permissions to access the S3 object.
- TruststoreVersion(str, Optional):
  The version of the S3 object that contains your truststore. To specify a version, you must have versioning enabled for the S3 bucket
security_policy (str, Optional) – The Transport Layer Security (TLS) version + cipher suite for this DomainName. The valid values are TLS_1_0 and TLS_1_2
tags (dict, Optional) – The key-value map of strings. The valid character set is [a-zA-Z+-=._:/]. The tag key can be up to 128 characters and must not start with aws: . The tag value can be up to 256 characters.
Name (Timeout configuration for create/update of AWS ApiGateway Domain) –
- update(dict, Optional):
  Timeout configuration for updating AWS ApiGateway Domain Name
  
  delay(int, Optional): The amount of time in seconds to wait between attempts. Default value is 15.
  
  max_attempts(int, Optional): Customized timeout configuration containing delay and max attempts. Default value is 40.

Request Syntax:

idem-test.idem-jedi-test.com:
 aws.apigateway.domain_name.present:
 - domain_name: string
 - regional_certificate_name: string
 - regional_certificate_arn: string
 - security_policy: string
 - endpoint_configuration: dict

Returns:: Dict[str, Any]

Example

idem-test.idem-jedi-test.com:
  aws.apigateway.domain_name.present:
  - domain_name: idem-test.idem-jedi-test.com
  - regional_certificate_arn: arn:aws:acm:us-west-2:746014882121:certificate/bb79ca7e-0fd0-485b-a977-cf96ba19f62c
  - security_policy: TLS_1_2
  - endpoint_configuration:
      types:
      - REGIONAL
  - tags:
      -Key: 'idem-resource-name'
       Value: 'idem-fixture-acm07f548a9-ad28-4b73-bc17-28559c357784.example.com'

async idem_aws.states.aws.apigateway.domain_name.absent(hub, ctx, name: str, resource_id: str = None, timeout: ~types.Specifies timeout for deletion of domain.Timeout = None) → Dict[str, Any][source]#

Deletes an API Gateway domain name resource.

Parameters:

name (str) – An Idem name of the resource.
resource_id (str, Optional) – AWS API Gateway domain name. Idem automatically considers this resource being absent if this field is not specified.
timeout (dict, Optional) –
Timeout configuration for AWS Elasticsearch domain
- delete(dict, Optional):
  
  Timeout configuration when deleting an AWS Elasticsearch domain
  
  delay(int, Optional) – The amount of time in seconds to wait between attempts. Default value is 40.
  
  max_attempts(int, Optional) – Max attempts of waiting for change. Default value is 60.

Returns:

Dict[str, Any]

Request syntax:

idem_test_aws_apigateway_domain_name::
  aws.apigateway.domain_name.absent:
    - name: 'str'
    - resource_id: 'str'

Examples

idem-test.idem-jedi-test.com:
  aws.apigateway.domain_name.present:
  - name: idem-test.idem-jedi-test.com
  - resource_id: idem-test.idem-jedi-test.com

async idem_aws.states.aws.apigateway.domain_name.describe(hub, ctx) → Dict[str, Dict[str, Any]][source]#

Describe all the API Gateway domain_name.

Returns:: Dict[str, Dict[str, Any]]

Request Syntax:

$ idem describe aws.apigateway.domain_name