Cloud Map

4 resource kinds. Generated from the operator's CRD schemas.

API Group: aws.konfig.io/v1alpha1

CloudMapNamespace # GA

CloudMapNamespace is the Schema for managing AWS Cloud Map namespaces.

kubectl get cloudmapnamespaces · example on GitHub

Example

# CloudMapNamespace — Cloud Map
# Full-options example generated from the CRD schema. Optional fields are
# included with sample values; delete what you don't need. Field reference:
# https://konfig-konector.io/docs/servicediscovery.html#cloudmapnamespace
apiVersion: aws.konfig.io/v1alpha1
kind: CloudMapNamespace
metadata:
  name: example-cloudmapnamespace
  namespace: default
spec:
  description: Managed by konfig-konector
  name: example-cloudmapnamespace
  providerRef:
    name: example-cloudmapnamespace
    region: us-east-1
  tags:
    environment: dev
    team: platform
  type: PRIVATE_DNS
  vpcRef:
    name: example-vpc

Spec

Field	Type	Required	Description
`description`	string	—	Description of the namespace.
`name`	string	yes	Name of the namespace (e.g.
`providerRef`	object	—	ProviderRef selects the AWSProvider (account/region) this resource is reconciled against.
`providerRef.name`	string	yes	Name of a cluster-scoped AWSProvider.
`providerRef.region`	string	—	Region overrides the provider's region for this resource only.
`tags`	map<string>	—	Tags are AWS resource tags to apply.
`type`	enum	yes	Type of the namespace. Allowed: `PRIVATE_DNS, PUBLIC_DNS, HTTP`
`vpcRef`	object	—	VPCRef references the VPC to associate with a PRIVATE_DNS namespace.
`vpcRef.id`	string	—	ID is a direct AWS VPC ID (e.g.
`vpcRef.name`	string	—	Name of a VPC CR in the same namespace.

Status

Field	Type	Required	Description
`arn`	string	—	ARN of the namespace.
`awsProvider`	object	—	AWSProvider confirms the account and region this resource was reconciled against.
`awsProvider.accountId`	string	—	AccountID the resource lives in.
`awsProvider.name`	string	—	Name of the AWSProvider used; empty when the operator's own credentials were used.
`awsProvider.region`	string	—	Region the resource lives in (empty for global services).
`conditions`	array<object>	—	Conditions describe the current state of the resource.
`conditions[].lastTransitionTime`	string	yes	lastTransitionTime is the last time the condition transitioned from one status to another.
`conditions[].message`	string	yes	message is a human readable message indicating details about the transition.
`conditions[].observedGeneration`	integer	—	observedGeneration represents the .metadata.generation that the condition was set based upon.
`conditions[].reason`	string	yes	reason contains a programmatic identifier indicating the reason for the condition's last transition.
`conditions[].status`	enum	yes	status of the condition, one of True, False, Unknown. Allowed: `True, False, Unknown`
`conditions[].type`	string	yes	type of condition in CamelCase or in foo.example.com/CamelCase.
`lastSyncTime`	string	—	LastSyncTime is when the resource was last successfully reconciled.
`namespaceId`	string	—	NamespaceID is the ID of the namespace.
`observedGeneration`	integer	—	ObservedGeneration is the most recent .metadata.generation reconciled.
`operationId`	string	—	OperationID tracks the async create operation until it completes.

CloudMapPrivateDnsNamespace # CLOUD CONTROL · AWS::ServiceDiscovery::PrivateDnsNamespace

CloudMapPrivateDnsNamespace manages AWS::ServiceDiscovery::PrivateDnsNamespace through the AWS Cloud Control API.

kubectl get cloudmapprivatednsnamespaces · example on GitHub

Example

# CloudMapPrivateDnsNamespace — Cloud Map
# Full-options example generated from the CRD schema. Optional fields are
# included with sample values; delete what you don't need. Field reference:
# https://konfig-konector.io/docs/servicediscovery.html#cloudmapprivatednsnamespace
apiVersion: aws.konfig.io/v1alpha1
kind: CloudMapPrivateDnsNamespace
metadata:
  name: example-cloudmapprivatednsnamespace
  namespace: default
spec:
  description: Managed by konfig-konector
  name: example-cloudmapprivatednsnamespace
  properties:
    dnsProperties:
      soa:
        ttl: 1
  providerRef:
    name: example-cloudmapprivatednsnamespace
    region: us-east-1
  tags:
  - key: example
    value: example
  vpc: example

Spec

Field	Type	Required	Description
`description`	string	—	A description of the namespace.
`name`	string	yes	The name that you want to assign to this namespace.
`properties`	object	—	Properties of the private DNS namespace.
`properties.dnsProperties`	object	—	CloudMapPrivateDnsNamespacePrivateDnsPropertiesMutable is a nested property type of AWS::ServiceDiscovery::PrivateDnsNamespace.
`properties.dnsProperties.soa`	object	—	CloudMapPrivateDnsNamespaceSOA is a nested property type of AWS::ServiceDiscovery::PrivateDnsNamespace.
`properties.dnsProperties.soa.ttl`	number	—
`providerRef`	object	—	ProviderRef selects the AWSProvider (account/region) this resource is reconciled against.
`providerRef.name`	string	yes	Name of a cluster-scoped AWSProvider.
`providerRef.region`	string	—	Region overrides the provider's region for this resource only.
`tags`	array<object>	—	The tags for the namespace.
`tags[].key`	string	yes
`tags[].value`	string	yes
`vpc`	string	—	The ID of the Amazon VPC that you want to associate the namespace with.

Status

Field	Type	Required	Description
`arn`	string	—	The Amazon Resource Name (ARN) of the private namespace.
`attempt`	integer	—	Attempt counts failed create/delete requests; it salts the Cloud Control idempotency token so a retry is not served the cached failure.
`awsProvider`	object	—	AWSProvider confirms the account and region this resource was reconciled against.
`awsProvider.accountId`	string	—	AccountID the resource lives in.
`awsProvider.name`	string	—	Name of the AWSProvider used; empty when the operator's own credentials were used.
`awsProvider.region`	string	—	Region the resource lives in (empty for global services).
`conditions`	array<object>	—	Conditions describe the current state of the resource.
`conditions[].lastTransitionTime`	string	yes	lastTransitionTime is the last time the condition transitioned from one status to another.
`conditions[].message`	string	yes	message is a human readable message indicating details about the transition.
`conditions[].observedGeneration`	integer	—	observedGeneration represents the .metadata.generation that the condition was set based upon.
`conditions[].reason`	string	yes	reason contains a programmatic identifier indicating the reason for the condition's last transition.
`conditions[].status`	enum	yes	status of the condition, one of True, False, Unknown. Allowed: `True, False, Unknown`
`conditions[].type`	string	yes	type of condition in CamelCase or in foo.example.com/CamelCase.
`hostedZoneId`	string	—	The ID for the Route 53 hosted zone that AWS Cloud Map creates when you create a namespace.
`id`	string	—	The ID of the private namespace.
`identifier`	string	—	Identifier is the Cloud Control primary identifier of the resource.
`lastSyncTime`	string	—
`observedGeneration`	integer	—
`operation`	string	—	Operation is the in-flight operation (CREATE, UPDATE, DELETE).
`operationStatus`	string	—	OperationStatus is the last reported operation status.
`requestToken`	string	—	RequestToken tracks an in-flight asynchronous operation.

CloudMapPublicDnsNamespace # CLOUD CONTROL · AWS::ServiceDiscovery::PublicDnsNamespace

CloudMapPublicDnsNamespace manages AWS::ServiceDiscovery::PublicDnsNamespace through the AWS Cloud Control API.

kubectl get cloudmappublicdnsnamespaces · example on GitHub

Example

# CloudMapPublicDnsNamespace — Cloud Map
# Full-options example generated from the CRD schema. Optional fields are
# included with sample values; delete what you don't need. Field reference:
# https://konfig-konector.io/docs/servicediscovery.html#cloudmappublicdnsnamespace
apiVersion: aws.konfig.io/v1alpha1
kind: CloudMapPublicDnsNamespace
metadata:
  name: example-cloudmappublicdnsnamespace
  namespace: default
spec:
  description: Managed by konfig-konector
  name: example-cloudmappublicdnsnamespace
  properties:
    dnsProperties:
      soa:
        ttl: 1
  providerRef:
    name: example-cloudmappublicdnsnamespace
    region: us-east-1
  tags:
  - key: example
    value: example

Spec

Field	Type	Required	Description
`description`	string	—	A description for the namespace.
`name`	string	yes	The name that you want to assign to this namespace.
`properties`	object	—	Properties for the public DNS namespace.
`properties.dnsProperties`	object	—	CloudMapPublicDnsNamespacePublicDnsPropertiesMutable is a nested property type of AWS::ServiceDiscovery::PublicDnsNamespace.
`properties.dnsProperties.soa`	object	—	CloudMapPublicDnsNamespaceSOA is a nested property type of AWS::ServiceDiscovery::PublicDnsNamespace.
`properties.dnsProperties.soa.ttl`	number	—
`providerRef`	object	—	ProviderRef selects the AWSProvider (account/region) this resource is reconciled against.
`providerRef.name`	string	yes	Name of a cluster-scoped AWSProvider.
`providerRef.region`	string	—	Region overrides the provider's region for this resource only.
`tags`	array<object>	—	The tags for the namespace.
`tags[].key`	string	yes
`tags[].value`	string	yes

Status

Field	Type	Required	Description
`arn`	string	—	The Amazon Resource Name (ARN) of the public namespace.
`attempt`	integer	—	Attempt counts failed create/delete requests; it salts the Cloud Control idempotency token so a retry is not served the cached failure.
`awsProvider`	object	—	AWSProvider confirms the account and region this resource was reconciled against.
`awsProvider.accountId`	string	—	AccountID the resource lives in.
`awsProvider.name`	string	—	Name of the AWSProvider used; empty when the operator's own credentials were used.
`awsProvider.region`	string	—	Region the resource lives in (empty for global services).
`conditions`	array<object>	—	Conditions describe the current state of the resource.
`conditions[].lastTransitionTime`	string	yes	lastTransitionTime is the last time the condition transitioned from one status to another.
`conditions[].message`	string	yes	message is a human readable message indicating details about the transition.
`conditions[].observedGeneration`	integer	—	observedGeneration represents the .metadata.generation that the condition was set based upon.
`conditions[].reason`	string	yes	reason contains a programmatic identifier indicating the reason for the condition's last transition.
`conditions[].status`	enum	yes	status of the condition, one of True, False, Unknown. Allowed: `True, False, Unknown`
`conditions[].type`	string	yes	type of condition in CamelCase or in foo.example.com/CamelCase.
`hostedZoneId`	string	—	The ID for the Route 53 hosted zone that AWS Cloud Map creates when you create a namespace.
`id`	string	—	The ID of the public namespace.
`identifier`	string	—	Identifier is the Cloud Control primary identifier of the resource.
`lastSyncTime`	string	—
`observedGeneration`	integer	—
`operation`	string	—	Operation is the in-flight operation (CREATE, UPDATE, DELETE).
`operationStatus`	string	—	OperationStatus is the last reported operation status.
`requestToken`	string	—	RequestToken tracks an in-flight asynchronous operation.

CloudMapService # GA

CloudMapService is the Schema for managing AWS Cloud Map services.

kubectl get cloudmapservices · example on GitHub

Example

# CloudMapService — Cloud Map
# Full-options example generated from the CRD schema. Optional fields are
# included with sample values; delete what you don't need. Field reference:
# https://konfig-konector.io/docs/servicediscovery.html#cloudmapservice
apiVersion: aws.konfig.io/v1alpha1
kind: CloudMapService
metadata:
  name: example-cloudmapservice
  namespace: default
spec:
  description: Managed by konfig-konector
  dnsConfig:
    recordType: A
    routingPolicy: MULTIVALUE
    ttl: 1
  healthCheckCustomConfig:
    failureThreshold: 1
  name: example-cloudmapservice
  namespaceRef:
    name: example-namespace
  providerRef:
    name: example-cloudmapservice
    region: us-east-1
  tags:
    environment: dev
    team: platform

Spec

Field	Type	Required	Description
`description`	string	—	Description of the service.
`dnsConfig`	object	—	DnsConfig configures the DNS records for registered instances.
`dnsConfig.recordType`	enum	yes	RecordType of the Route 53 record. Allowed: `A, AAAA, SRV, CNAME`
`dnsConfig.routingPolicy`	enum	—	RoutingPolicy applied to the records. Allowed: `MULTIVALUE, WEIGHTED`
`dnsConfig.ttl`	integer	yes	TTL of the record in seconds.
`healthCheckCustomConfig`	object	—	HealthCheckCustomConfig configures a custom health check.
`healthCheckCustomConfig.failureThreshold`	integer	—	FailureThreshold is deprecated by AWS and always treated as 1.
`name`	string	yes	Name of the service.
`namespaceRef`	object	yes	NamespaceRef references the namespace the service is created in.
`namespaceRef.id`	string	—	ID is a direct AWS Cloud Map namespace ID (e.g.
`namespaceRef.name`	string	—	Name of a CloudMapNamespace CR in the same namespace.
`providerRef`	object	—	ProviderRef selects the AWSProvider (account/region) this resource is reconciled against.
`providerRef.name`	string	yes	Name of a cluster-scoped AWSProvider.
`providerRef.region`	string	—	Region overrides the provider's region for this resource only.
`tags`	map<string>	—	Tags are AWS resource tags to apply.

Status

Field	Type	Required	Description
`arn`	string	—	ARN of the service.
`awsProvider`	object	—	AWSProvider confirms the account and region this resource was reconciled against.
`awsProvider.accountId`	string	—	AccountID the resource lives in.
`awsProvider.name`	string	—	Name of the AWSProvider used; empty when the operator's own credentials were used.
`awsProvider.region`	string	—	Region the resource lives in (empty for global services).
`conditions`	array<object>	—	Conditions describe the current state of the resource.
`conditions[].lastTransitionTime`	string	yes	lastTransitionTime is the last time the condition transitioned from one status to another.
`conditions[].message`	string	yes	message is a human readable message indicating details about the transition.
`conditions[].observedGeneration`	integer	—	observedGeneration represents the .metadata.generation that the condition was set based upon.
`conditions[].reason`	string	yes	reason contains a programmatic identifier indicating the reason for the condition's last transition.
`conditions[].status`	enum	yes	status of the condition, one of True, False, Unknown. Allowed: `True, False, Unknown`
`conditions[].type`	string	yes	type of condition in CamelCase or in foo.example.com/CamelCase.
`lastSyncTime`	string	—	LastSyncTime is when the resource was last successfully reconciled.
`observedGeneration`	integer	—	ObservedGeneration is the most recent .metadata.generation reconciled.
`serviceId`	string	—	ServiceID is the ID of the service.