Documentation
¶
Index ¶
- Variables
- type Account
- type CloudActor
- type CloudActorTimeStamp
- type CloudRegion
- type CloudRegionsDecoder
- type Credential
- type Division
- type ImportMigration
- type Provider
- type ProviderToResourceImportMap
- type RemoteCloudReference
- type ResourceActionMap
- type ResourceActions
- type ResourceImportMap
- type ResourceName
- type ResourceNameList
- type TerraformConfigLocation
- type Timestamp
- type Version
Constants ¶
This section is empty.
Variables ¶
var AwsRegions = map[string]bool{ "us-east-2": true, "us-east-1": true, "us-west-1": true, "us-west-2": true, "af-south-1": true, "ap-east-1": true, "ap-south-2": true, "ap-southeast-3": true, "ap-southeast-4": true, "ap-south-1": true, "ap-northeast-3": true, "ap-northeast-2": true, "ap-southeast-1": true, "ap-southeast-2": true, "ap-northeast-1": true, "ca-central-1": true, "eu-central-1": true, "eu-west-1": true, "eu-west-2": true, "eu-south-1": true, "eu-west-3": true, "eu-south-2": true, "eu-north-1": true, "eu-central-2": true, "me-south-1": true, "me-central-1": true, "sa-east-1": true, "us-gov-east-1": true, "us-gov-west-": true, }
var AzureRegions = map[string]bool{ "australiacentral": true, "australiacentral2": true, "australiaeast": true, "australiasoutheast": true, "brazilsouth": true, "brazilsoutheast": true, "canadacentral": true, "canadaeast": true, "centralindia": true, "centralus": true, "centraluseuap": true, "eastasia": true, "eastus": true, "eastus2": true, "eastus2euap": true, "francecentral": true, "francesouth": true, "germanycentral": true, "germanynorth": true, "germanywestcentral": true, "japaneast": true, "japanwest": true, "koreacentral": true, "koreasouth": true, "northcentralus": true, "northeurope": true, "southafricanorth": true, "southafricawest": true, "southcentralus": true, "southeastasia": true, "southindia": true, "switzerlandnorth": true, "switzerlandwest": true, "uksouth": true, "ukwest": true, "westcentralus": true, "westeurope": true, "westindia": true, "westus": true, "westus2": true, "westus3": true, }
var GoogleRegions = map[string]bool{ "us-west1": true, "asia-south1": true, "asia-south2": true, "asia-east1": true, "asia-east2": true, "asia-northeast1": true, "asia-northeast2": true, "asia-northeast3": true, "asia-southeast1": true, "australia-southeast1": true, "australia-southeast2": true, "europe-central2": true, "europe-north2": true, "europe-southwest1": true, "europe-west1": true, "europe-west2": true, "europe-west3": true, "europe-west4": true, "europe-west6": true, "europe-west8": true, "europe-west9": true, "northamerica-northeast1": true, "northamerica-northeast2": true, "southamerica-east1": true, "us-central1": true, "us-east1": true, "us-east4": true, "us-west2": true, "us-west3": true, "us-west4": true, }
Functions ¶
This section is empty.
Types ¶
type CloudActor ¶
type CloudActor string
CloudActor an entity that make changes to a cloud environment.
type CloudActorTimeStamp ¶
type CloudActorTimeStamp struct {
// Actor is an entity that make changes to a cloud environment.
Actor CloudActor `json:"actor"`
// Timestamp is a string that represents the time of a cloud actor's action.
Timestamp Timestamp `json:"timestamp"`
}
CloudActorTimeStamp is a struct containing a cloud actor and a timestamp for one of their actions.
type CloudRegion ¶
type CloudRegion string
type CloudRegionsDecoder ¶
type CloudRegionsDecoder []CloudRegion
func (*CloudRegionsDecoder) Decode ¶
func (d *CloudRegionsDecoder) Decode(value string) error
type Credential ¶
type Credential string
Credential is a credential which can be used to read resources within a cloud footprint. The string is a json structure in json format.
type Division ¶
type Division string
Division is the name of a division within a cloud provider. For AWS a region, for Azure a resource group, and for GCP this is a project name.
type ImportMigration ¶
type ImportMigration struct {
TerraformConfigLocation TerraformConfigLocation
RemoteCloudReference RemoteCloudReference
}
ImportMigration are the full args for terraform import statement
type ProviderToResourceImportMap ¶
type ProviderToResourceImportMap map[Provider]map[Division]ResourceImportMap
ProviderToResourceImportMap is a map of structure {Provider: {Division: ResourceImportMap}}
type RemoteCloudReference ¶
type RemoteCloudReference string
RemoteCloudReference is the identifying string where a resource is located within a remote cloud environment for use within a `terraform import` statement
type ResourceActionMap ¶
type ResourceActionMap map[ResourceName]*ResourceActions
ResourceActionMap is a mapping between a resource name and resource actions.
type ResourceActions ¶
type ResourceActions struct {
// Creator is the cloud actor and timestamp of the resource creation.
Creator *CloudActorTimeStamp `json:"creation,omitempty"`
// Modifier is the cloud actor and timestamp of the most recent (if any) resource modification.
Modifier *CloudActorTimeStamp `json:"modified,omitempty"`
}
ResourceActions is a struct containing the cloud actor and timestamp of the most recent (if any) resource modification.
type ResourceImportMap ¶
type ResourceImportMap map[ResourceName]ImportMigration
ResourceImportMap is the import migration statement for the resource name
type ResourceNameList ¶
type ResourceNameList []ResourceName
ResourceNameList is a list of ResourceNames
func (*ResourceNameList) Decode ¶
func (rnl *ResourceNameList) Decode(value string) error
Decode allows ResourceNameList to be decoded by the ENVConfig function.
type TerraformConfigLocation ¶
type TerraformConfigLocation string
TerraformConfigLocation is the location where a resource can be identified within Terraform by the {TerraformResourceType}.{TerraformResourceName} syntax.
Source Files