DomainName is the Schema for the DomainNames API. Registers a custom domain name for use with AWS API Gateway.
Type
CRD
Group
apigateway.aws.upbound.io
Version
v1beta1
apiVersion: apigateway.aws.upbound.io/v1beta1
kind: DomainName
DomainNameSpec defines the desired state of DomainName
No description provided.
Reference to a CertificateValidation in acm to populate certificateArn.
Policies for referencing.
Selector for a CertificateValidation in acm to populate certificateArn.
Policies for selection.
Configuration block defining API endpoint information including type. See below.
List of endpoint types. This resource currently only supports managing a single value. Valid values: EDGE or REGIONAL. If unspecified, defaults to EDGE. Must be declared as REGIONAL in non-Commercial partitions. Refer to the documentation for more information on the difference between edge-optimized and regional APIs.
Mutual TLS authentication configuration for the domain name. See below.
Reference to a CertificateValidation in acm to populate regionalCertificateArn.
Policies for referencing.
Selector for a CertificateValidation in acm to populate regionalCertificateArn.
Policies for selection.
THIS IS A BETA FIELD. It will be honored unless the Management Policies feature flag is disabled. InitProvider holds the same fields as ForProvider, with the exception of Identifier and other resource reference fields. The fields that are in InitProvider are merged into ForProvider when the resource is created. The same fields are also added to the terraform ignore_changes hook, to avoid updating them after creation. This is useful for fields that are required on creation, but we do not desire to update them after creation, for example because of an external controller is managing them, like an autoscaler.
Reference to a CertificateValidation in acm to populate certificateArn.
Policies for referencing.
Selector for a CertificateValidation in acm to populate certificateArn.
Policies for selection.
Configuration block defining API endpoint information including type. See below.
List of endpoint types. This resource currently only supports managing a single value. Valid values: EDGE or REGIONAL. If unspecified, defaults to EDGE. Must be declared as REGIONAL in non-Commercial partitions. Refer to the documentation for more information on the difference between edge-optimized and regional APIs.
Mutual TLS authentication configuration for the domain name. See below.
Reference to a CertificateValidation in acm to populate regionalCertificateArn.
Policies for referencing.
Selector for a CertificateValidation in acm to populate regionalCertificateArn.
Policies for selection.
THIS IS A BETA FIELD. It is on by default but can be opted out through a Crossplane feature flag. ManagementPolicies specify the array of actions Crossplane is allowed to take on the managed and external resources. This field is planned to replace the DeletionPolicy field in a future release. Currently, both could be set independently and non-default values would be honored if the feature flag is enabled. If both are custom, the DeletionPolicy field will be ignored. See the design doc for more information: https://github.com/crossplane/crossplane/blob/499895a25d1a1a0ba1604944ef98ac7a1a71f197/design/design-doc-observe-only-resources.md?plain=1#L223 and this one: https://github.com/crossplane/crossplane/blob/444267e84783136daa93568b364a5f01228cacbe/design/one-pager-ignore-changes.md
ProviderConfigReference specifies how the provider that will be used to create, observe, update, and delete this managed resource should be configured.
Policies for referencing.
PublishConnectionDetailsTo specifies the connection secret config which contains a name, metadata and a reference to secret store config to which any connection details for this managed resource should be written. Connection details frequently include the endpoint, username, and password required to connect to the managed resource.
WriteConnectionSecretToReference specifies the namespace and name of a Secret to which any connection details for this managed resource should be written. Connection details frequently include the endpoint, username, and password required to connect to the managed resource. This field is planned to be replaced in a future release in favor of PublishConnectionDetailsTo. Currently, both could be set independently and connection details would be published to both without affecting each other.
DomainNameStatus defines the observed state of DomainName.
No description provided.
Configuration block defining API endpoint information including type. See below.
List of endpoint types. This resource currently only supports managing a single value. Valid values: EDGE or REGIONAL. If unspecified, defaults to EDGE. Must be declared as REGIONAL in non-Commercial partitions. Refer to the documentation for more information on the difference between edge-optimized and regional APIs.
Mutual TLS authentication configuration for the domain name. See below.
Conditions of the resource.
example
apiVersion: apigateway.aws.upbound.io/v1beta1
kind: DomainName
metadata:
annotations:
upjet.upbound.io/manual-intervention: The DomainName resource needs valid certificates.
labels:
testing.upbound.io/example-name: domainname
name: example
spec:
forProvider:
certificateBody: <content of 'example.crt'>
certificateChain: <content of ca.crt>
certificateName: example-api
certificatePrivateKeySecretRef:
key: attribute.example.key
name: example-secret
namespace: upbound-system
domainName: example.com
region: us-west-1
© 2022 Upbound, Inc.
Discover the building blocksfor your internal cloud platform.