domain_name

Autogenerated using pop-create-idem

hub.exec.boto3.client.apigatewayv2.create_domain_name hub.exec.boto3.client.apigatewayv2.delete_domain_name hub.exec.boto3.client.apigatewayv2.get_domain_name hub.exec.boto3.client.apigatewayv2.get_domain_names hub.exec.boto3.client.apigatewayv2.tag_resource hub.exec.boto3.client.apigatewayv2.untag_resource hub.exec.boto3.client.apigatewayv2.update_domain_name

async idem_aws.states.aws.apigatewayv2.domain_name.present(hub, ctx, name: str, resource_id: str = None, domain_name_configurations: List[DomainNameConfiguration] = None, mutual_tls_authentication: MutualTlsAuthenticationInput = None, tags: Dict[str, str] = None) → Dict[str, Any]

Creates an API Gateway v2 domain name resource.

Parameters:

• name (str) – An Idem name of the resource. This is also used as the name of the domain name during resource creation.

• resource_id (str, Optional) – AWS API Gateway v2 domain name.

• domain_name_configurations (List[Dict[str, Any]], Optional) –

  The domain name configurations. Defaults to None. * ApiGatewayDomainName (str, Optional): A domain name for the API. * CertificateArn (str, Optional): An AWS-managed certificate that will be used by the edge-optimized endpoint for this domain

  name. AWS Certificate Manager is the only supported source.

  • CertificateName (str, Optional): The user-friendly name of the certificate that will be used by the edge-optimized endpoint for

    this domain name.

  • CertificateUploadDate (str, Optional): The timestamp when the certificate that was used by edge-optimized endpoint for this domain name

    was uploaded.

  • DomainNameStatus (str, Optional): The status of the domain name migration. The valid values are AVAILABLE, UPDATING,

    PENDING_CERTIFICATE_REIMPORT, and PENDING_OWNERSHIP_VERIFICATION. If the status is UPDATING, the domain cannot be modified further until the existing operation is complete. If it is AVAILABLE, the domain can be updated.

  • DomainNameStatusMessage (str, Optional): An optional text message containing detailed information about status of the domain name

    migration.

  • EndpointType (str, Optional): The endpoint type.

  • HostedZoneId (str, Optional): The Amazon Route 53 Hosted Zone ID of the endpoint.

  • SecurityPolicy (str, Optional): The Transport Layer Security (TLS) version of the security policy for this domain name. The

    valid values are TLS_1_0 and TLS_1_2.

  • OwnershipVerificationCertificateArn (str, Optional): The ARN of the public certificate issued by ACM to validate ownership of your custom domain.

    Only required when configuring mutual TLS and using an ACM imported or private CA certificate ARN as the regionalCertificateArn

• mutual_tls_authentication (Dict[str, Any], Optional) –

  The mutual TLS authentication configuration for a custom domain name. Defaults to None. * 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.

• tags (Dict, Optional) – The collection of tags associated with a domain name.

Request Syntax:

[idem_test_aws_apigatewayv2_domain_name]:

aws.apigatewayv2.domain_name.present:

• name: ‘string’

• domain_name_configurations: [

  {

  ‘ApiGatewayDomainName’: ‘string’, ‘CertificateArn’: ‘string’, ‘CertificateName’: ‘string’, ‘CertificateUploadDate’: datetime(2015, 1, 1), ‘DomainNameStatus’: ‘AVAILABLE’|’UPDATING’|’PENDING_CERTIFICATE_REIMPORT’|’PENDING_OWNERSHIP_VERIFICATION’, ‘DomainNameStatusMessage’: ‘string’, ‘EndpointType’: ‘REGIONAL’|’EDGE’, ‘HostedZoneId’: ‘string’, ‘SecurityPolicy’: ‘TLS_1_0’|’TLS_1_2’, ‘OwnershipVerificationCertificateArn’: ‘string’

  }

] - mutual_tls_authentication: {

‘TruststoreUri’: ‘string’, ‘TruststoreVersion’: ‘string

}

• tags: {

  ‘string’: ‘string’

  }

Returns:

Dict[str, Any]

Examples

idem_test_aws_apigatewayv2_domain_name:
  aws.apigatewayv2.domain_name.present:
    - name: value
    - domain_name_configurations: [
        {
            'ApiGatewayDomainName': value,
            'CertificateArn': 'value,
            'CertificateName': 'value,
            'CertificateUploadDate': value,
            'DomainNameStatus': value,
            'DomainNameStatusMessage': value,
            'EndpointType': value,
            'HostedZoneId': value,
            'SecurityPolicy': value,
            'OwnershipVerificationCertificateArn': value
        }
    ]
    - mutual_tls_authentication: {
        'TruststoreUri': 'string',
        'TruststoreVersion': 'string
    }
    - tags: {
        value: value
    }

async idem_aws.states.aws.apigatewayv2.domain_name.absent(hub, ctx, name: str, resource_id: str = None) → Dict[str, Any]

Deletes an API Gateway v2 domain name resource.

Parameters:

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

• resource_id (str, Optional) – AWS API Gateway v2 domain name. Idem automatically considers this resource being absent if this field is not specified.

Request syntax:

[idem_test_aws_apigatewayv2_domain_name]:

aws.apigatewayv2.domain_name.absent:

• name: ‘string’

• resource_id: ‘string’

Returns:

Dict[str, Any]

Examples

idem_test_aws_apigatewayv2_domain_name:
  aws.apigatewayv2.domain_name.absent:
    - name: value
    - resource_id: value

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

Describe the resource in a way that can be recreated/managed with the corresponding “present” function

Gets the API Gateway v2 domain name resources for an AWS account.

Returns:

Dict[str, Dict[str, Any]]

Examples

$ idem describe aws.apigatewayv2.domain_name