DomainName
apigatewayv2.services.k8s.aws/v1alpha1
| Type | Link |
|---|---|
| GoDoc | apigatewayv2-controller/apis/v1alpha1#DomainName |
Metadata
| Property | Value |
|---|---|
| Scope | Namespaced |
| Kind | DomainName |
| ListKind | DomainNameList |
| Plural | domainnames |
| Singular | domainname |
Represents a domain name.
Spec
domainName: string
domainNameConfigurations:
- certificateARN: string
certificateName: string
endpointType: string
ownershipVerificationCertificateARN: string
securityPolicy: string
mutualTLSAuthentication:
truststoreURI: string
truststoreVersion: string
tags: {}
| Field | Description |
|---|---|
| domainName Required | string |
| domainNameConfigurations Optional | array |
| domainNameConfigurations.[] Required | object The domain name configuration. |
| domainNameConfigurations.[].certificateName Optional | string A string with a length between [1-128]. |
| domainNameConfigurations.[].endpointType Optional | string Represents an endpoint type. |
| domainNameConfigurations.[].ownershipVerificationCertificateARN Optional | string Represents an Amazon Resource Name (ARN). |
| domainNameConfigurations.[].securityPolicy Optional | string 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. |
| mutualTLSAuthentication Optional | object If specified, API Gateway performs two-way authentication between the client and the server. Clients must present a trusted certificate to access your API. |
| mutualTLSAuthentication.truststoreURI Optional | string A string representation of a URI with a length between [1-2048]. |
| mutualTLSAuthentication.truststoreVersion Optional | string A string with a length between [1-64]. |
| tags Optional | object |
Status
ackResourceMetadata:
arn: string
ownerAccountID: string
region: string
apiMappingSelectionExpression: string
conditions:
- lastTransitionTime: string
message: string
reason: string
status: string
type: string
| Field | Description |
|---|---|
| ackResourceMetadata Optional | object All CRs managed by ACK have a common Status.ACKResourceMetadata memberthat is used to contain resource sync state, account ownership, constructed ARN for the resource |
| ackResourceMetadata.arn Optional | string ARN is the Amazon Resource Name for the resource. This is a globally-unique identifier and is set only by the ACK service controller once the controller has orchestrated the creation of the resource OR when it has verified that an “adopted” resource (a resource where the ARN annotation was set by the Kubernetes user on the CR) exists and matches the supplied CR’s Spec field values. https://github.com/aws/aws-controllers-k8s/issues/270 |
| ackResourceMetadata.ownerAccountID Required | string OwnerAccountID is the AWS Account ID of the account that owns the backend AWS service API resource. |
| ackResourceMetadata.region Required | string Region is the AWS region in which the resource exists or will exist. |
| apiMappingSelectionExpression Optional | string |
| conditions Optional | array All CRS managed by ACK have a common Status.Conditions member thatcontains a collection of ackv1alpha1.Condition objects that describethe various terminal states of the CR and its backend AWS service API resource |
| conditions.[] Required | object Condition is the common struct used by all CRDs managed by ACK service |
| controllers to indicate terminal states of the CR and its backend AWS | |
| service API resource | |
| conditions.[].message Optional | string A human readable message indicating details about the transition. |
| conditions.[].reason Optional | string The reason for the condition’s last transition. |
| conditions.[].status Optional | string Status of the condition, one of True, False, Unknown. |
| conditions.[].type Optional | string Type is the type of the Condition |