region

Description

Venue	Equivalent Concept(s)
	Regions
	Regions

Describes a physical location. The region controls the placement of objects and data in the infrastructure. Each region may have different capabilities, and most regions are geographically distinct from others within the same venue. A region specification without any properties indicates there are no restrictions on placement. Add properties to restrict placement to desired locations. The current recommended method for region selection is using region specific definitions for AWS and Azure outlined in each cloud providers regions specifications.

Required Properties

This object has no required properties, but it likely requires a combination of optional properties to be useful.

Optional Properties

area (string)

A cardinal direction describing an area of a country based on the city/state of region's physical presence.

Allowed Values:

• central

• east

• north

• northeast

• northwest

• south

• southeast

• southwest

• west

aws (string)

The name of the AWS-specific region to use. If you specify this property then you do not need to specify country, area, state, or city.

azure (string)

The name of the Azure-specific region to use. If you specify this property then you do not need to specify country, area, state, or city.

city (string)

The name of a city.

country (string)

The full name, ISO 3166-1 alpha-2, or ISO 3166-1 alpha-3 code of a country.

state (string)

The name of a state or province.

Common Properties

name (string)

The name of this region. The name can be different than the blueprint object name. When the name property is not present we apply automatic naming strategies to make resources easier to identify in each venue's management console. When the name property is specified we will use it exactly as specified.

readonly (boolean)

Indicates whether or not this region is read-only. If so, we verify only the existence and correctness of this region to its specification rather than creating or modifying it.

The default value if not specified is false.

Discovered Properties

These properties are populated and available in the inventory following a successful apply.

id (string)

The venue-specific identifier of this region.

Examples

The recommended method is to use the venue-specific region names, you can define a portable Tuono region by specifying them directly per venue:

location:
  region:
    portable-specific-region:
      aws: us-west-2
      azure: westus2

Define a region:

location:
  region:
    example-region:
      area: west
      country: USA

Define a region with further restrictions on location:

location:
  region:
    specific-region:
      area: northwest
      city: Seattle
      country: USA
      state: WA