HostedZone

route53.services.k8s.aws/v1alpha1

TypeLink
GoDocroute53-controller/apis/v1alpha1#HostedZone

Metadata

PropertyValue
ScopeNamespaced
KindHostedZone
ListKindHostedZoneList
Pluralhostedzones
Singularhostedzone

A complex type that contains general information about the hosted zone.

Spec

delegationSetID: string
hostedZoneConfig: 
  comment: string
  privateZone: boolean
name: string
tags:
- key: string
  value: string
vpc: 
  vpcID: string
  vpcRegion: string
FieldDescription
delegationSetID
Optional
string
If you want to associate a reusable delegation set with this hosted zone,
the ID that Amazon Route 53 assigned to the reusable delegation set when
you created it. For more information about reusable delegation sets, see
CreateReusableDelegationSet (https://docs.aws.amazon.com/Route53/latest/APIReference/API_CreateReusableDelegationSet.html).

If you are using a reusable delegation set to create a public hosted zone
for a subdomain, make sure that the parent hosted zone doesn’t use one or
more of the same name servers. If you have overlapping nameservers, the operation
will cause a ConflictingDomainsExist error.
hostedZoneConfig
Optional
object
(Optional) A complex type that contains the following optional values:

* For public and private hosted zones, an optional comment

* For private hosted zones, an optional PrivateZone element

If you don’t specify a comment or the PrivateZone element, omit HostedZoneConfig
and the other elements.
hostedZoneConfig.comment
Optional
string
hostedZoneConfig.privateZone
Optional
boolean
name
Required
string
The name of the domain. Specify a fully qualified domain name, for example,
www.example.com. The trailing dot is optional; Amazon Route 53 assumes that
the domain name is fully qualified. This means that Route 53 treats www.example.com
(without a trailing dot) and www.example.com. (with a trailing dot) as identical.

If you’re creating a public hosted zone, this is the name you have registered
with your DNS registrar. If your domain name is registered with a registrar
other than Route 53, change the name servers for your domain to the set of
NameServers that CreateHostedZone returns in DelegationSet.
tags
Optional
array
A complex type that contains a list of the tags that you want to add to the
specified health check or hosted zone and/or the tags that you want to edit
Value for.

You can add a maximum of 10 tags to a health check or a hosted zone.
tags.[]
Required
object
A complex type that contains information about a tag that you want to add
or edit for the specified health check or hosted zone.
tags.[].value
Optional
string
vpc
Optional
object
(Private hosted zones only) A complex type that contains information about
the Amazon VPC that you’re associating with this hosted zone.

You can specify only one Amazon VPC when you create a private hosted zone.
If you are associating a VPC with a hosted zone with this request, the paramaters
VPCId and VPCRegion are also required.

To associate additional Amazon VPCs with the hosted zone, use AssociateVPCWithHostedZone
(https://docs.aws.amazon.com/Route53/latest/APIReference/API_AssociateVPCWithHostedZone.html)
after you create a hosted zone.
vpc.vpcID
Optional
string
(Private hosted zones only) The ID of an Amazon VPC.
vpc.vpcRegion
Optional
string

Status

ackResourceMetadata: 
  arn: string
  ownerAccountID: string
  region: string
callerReference: string
conditions:
- lastTransitionTime: string
  message: string
  reason: string
  status: string
  type: string
config: 
  comment: string
  privateZone: boolean
id: string
linkedService: 
  description: string
  servicePrincipal: string
resourceRecordSetCount: integer
FieldDescription
ackResourceMetadata
Optional
object
All CRs managed by ACK have a common Status.ACKResourceMetadata member
that 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.
callerReference
Optional
string
The value that you specified for CallerReference when you created the hosted
zone.
conditions
Optional
array
All CRS managed by ACK have a common Status.Conditions member that
contains a collection of ackv1alpha1.Condition objects that describe
the 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
config
Optional
object
A complex type that includes the Comment and PrivateZone elements. If you
omitted the HostedZoneConfig and Comment elements from the request, the Config
and Comment elements don’t appear in the response.
config.comment
Optional
string
config.privateZone
Optional
boolean
id
Optional
string
The ID that Amazon Route 53 assigned to the hosted zone when you created
it.
linkedService
Optional
object
If the hosted zone was created by another service, the service that created
the hosted zone. When a hosted zone is created by another service, you can’t
edit or delete it using Route 53.
linkedService.description
Optional
string
linkedService.servicePrincipal
Optional
string
resourceRecordSetCount
Optional
integer
The number of resource record sets in the hosted zone.