names

package
v0.1.4 Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: Nov 8, 2023 License: MPL-2.0 Imports: 5 Imported by: 0

README

names

Package names provides AWS service-name information that is critical to the Terraform AWS Provider working correctly. If you are unsure about a change you are making, please do not hesitate to ask!

NOTE: The information in names_data.csv affects the provider, generators, documentation, website navigation, etc. working correctly. Please do not make any changes until you understand the table below.

The core of the names package is names_data.csv, which contains raw, comma-separated data about naming in the AWS Provider, AWS Go SDKs v1 and v2, and AWS CLI. The file is dynamically embedded at build time in the AWS Provider and referenced by generators when generating code. The information it contains must be correct. Please double-check any changes.

Consumers of names include:

  • Package provider (internal/provider)
  • Package conns (internal/conns)
  • AWS Provider generators
  • skaff tool

After any edits to names_data.csv, run make gen. Doing so regenerates code and performs checks on names_data.csv.

The columns of names_data.csv are as follows:

Index Name Use Description
0 AWSCLIV2Command Reference Service command in AWS CLI v2
1 AWSCLIV2CommandNoDashes Reference Same as AWSCLIV2Command without dashes
2 GoV1Package Code AWS SDK for Go v1 package name
3 GoV2Package Code AWS SDK for Go v2 package name
4 ProviderPackageActual Code Actual TF AWS provide package name if ProviderPackageCorrect is not used; takes precedence over ProviderPackageCorrect if both are defined
5 ProviderPackageCorrect Code Shorter of AWSCLIV2CommandNoDashes and GoV2Package; should not be blank if either exists; same as Service Identifier; what the TF AWS Provider package name should be; ProviderPackageActual takes precedence
6 SplitPackageRealPackage Code If multiple "services" live in one service, this is the package where the service's Go files live (e.g., VPC is part of EC2)
7 Aliases Code Semicolon-separated list of name variations (e.g., for "AMP", prometheus;prometheusservice). Do not include ProviderPackageActual (or ProviderPackageCorrect, if blank) since that will create duplicates in the Custom Endpoints guide.
8 ProviderNameUpper Code Correctly capitalized ProviderPackageActual, if it exists, otherwise ProviderPackageCorrect
9 GoV1ClientTypeName Code Exact name (i.e., spelling and capitalization) of the AWS SDK for Go v1 client type (e.g., see the New() return type for SES)
10 SkipClientGenerate Code Some service clients need special configuration rather than the default generated configuration; use a non-empty value to skip generation but you must then manually configure the client in internal/conns/config.go
11 ClientSDKV1 Code Whether, in the TF AWS Provider, the service currently uses AWS SDK for Go v1; use 1 or leave empty
12 ClientSDKV2 Code Whether, in the TF AWS Provider, the service currently uses AWS SDK for Go v2; use 2 or leave emtpy
13 ResourcePrefixActual Code Regular expression to match anomalous TF resource name prefixes (e.g., for the resource name aws_config_config_rule, aws_config_ will match all resources); only use if ResourcePrefixCorrect is not suitable (e.g., aws_codepipeline_ won't work as there is only one resource named aws_codepipeline); takes precedence over ResourcePrefixCorrect
14 ResourcePrefixCorrect Code Regular expression to match what resource name prefixes should be (i.e., aws_ + ProviderPackageCorrect + _); used if ResourcePrefixActual is blank
15 FilePrefix Code If multiple "services" live in one service, this is the prefix that files must have to be associated with this sub-service (e.g., VPC files in the EC2 service are prefixed with vpc_); see also SplitPackageRealPackage
16 DocPrefix Code Semicolon-separated list of prefixes for service documentation files in website/docs/r and website/docs/d; usually only one prefix, i.e., <**ProviderPackageCorrect**>_
17 HumanFriendly Code [REQUIRED] Human-friendly name of service as used by AWS; documentation subcategory must exactly match this value; used in website navigation and error messages
18 Brand Code Either Amazon, AWS, or blank (rare) as used by AWS; used in error messages
19 Exclude Code Whether or not the service should be included; if included (blank), ProviderPackageActual or ProviderPackageCorrect must have a value
20 AllowedSubcategory Code If Exclude is non-blank, whether to include HumanFriendly in website/allowed-subcategories.txt anyway. In other words, if non-blank, overrides Exclude in some situations. Some excluded pseudo-services (e.g., VPC is part of EC2) are still subcategories. Only applies if Exclude is non-blank.
21 DeprecatedEnvVar Code Deprecated environment variable name
22 EnvVar Code Current environment variable associated with service
23 Note Reference Very brief note usually to explain why excluded

For more information about service naming, see the Naming Guide.

Documentation

Overview

Code generated by internal/generate/namesconsts/main.go; DO NOT EDIT.

Package names provides constants for AWS service names that are used as keys for the endpoints slice in internal/conns/conns.go. The package also exposes access to data found in the names_data.csv file, which provides additional service-related name information.

Consumers of the names package include the conns package (internal/conn/conns.go), the provider package (internal/provider/provider.go), generators, and the skaff tool.

It is very important that information in the names_data.csv be exactly correct because the Terrform AWS Provider relies on the information to function correctly.

Index

Constants

View Source 
const (
	AttrARN         = "arn"
	AttrDescription = "description"
	AttrEnabled     = "enabled"
	AttrID          = "id" // Should be explicitly declared only for Framework resources
	AttrKMSKeyARN   = "kms_key_arn"
	AttrName        = "name"
	AttrTags        = "tags"
	AttrTagsAll     = "tags_all"
	AttrTimeouts    = "timeouts" // Should be explicitly declared only for Framework resources
	AttrType        = "type"
)
View Source 
const (
	ColAWSCLIV2Command         = 0
	ColAWSCLIV2CommandNoDashes = 1
	ColGoV1Package             = 2
	ColGoV2Package             = 3
	ColProviderPackageActual   = 4
	ColProviderPackageCorrect  = 5
	ColSplitPackageRealPackage = 6
	ColAliases                 = 7
	ColProviderNameUpper       = 8
	ColGoV1ClientTypeName      = 9
	ColSkipClientGenerate      = 10
	ColClientSDKV1             = 11
	ColClientSDKV2             = 12
	ColResourcePrefixActual    = 13
	ColResourcePrefixCorrect   = 14
	ColFilePrefix              = 15
	ColDocPrefix               = 16
	ColHumanFriendly           = 17
	ColBrand                   = 18
	ColExclude                 = 19 // If set, the service is completely ignored
	ColNotImplemented          = 20 // If set, the service will be included in, e.g. labels, but not have a service client
	ColAllowedSubcategory      = 21
	ColDeprecatedEnvVar        = 22
	ColEnvVar                  = 23
	ColNote                    = 24
)
View Source 
const (
	ACM                          = "acm"
	ACMPCA                       = "acmpca"
	AMP                          = "amp"
	APIGateway                   = "apigateway"
	APIGatewayV2                 = "apigatewayv2"
	AccessAnalyzer               = "accessanalyzer"
	Account                      = "account"
	Amplify                      = "amplify"
	AppAutoScaling               = "appautoscaling"
	AppConfig                    = "appconfig"
	AppFlow                      = "appflow"
	AppIntegrations              = "appintegrations"
	AppMesh                      = "appmesh"
	AppRunner                    = "apprunner"
	AppStream                    = "appstream"
	AppSync                      = "appsync"
	ApplicationInsights          = "applicationinsights"
	Athena                       = "athena"
	AuditManager                 = "auditmanager"
	AutoScaling                  = "autoscaling"
	AutoScalingPlans             = "autoscalingplans"
	Backup                       = "backup"
	Batch                        = "batch"
	Bedrock                      = "bedrock"
	Budgets                      = "budgets"
	CE                           = "ce"
	CUR                          = "cur"
	Chime                        = "chime"
	ChimeSDKMediaPipelines       = "chimesdkmediapipelines"
	ChimeSDKVoice                = "chimesdkvoice"
	CleanRooms                   = "cleanrooms"
	Cloud9                       = "cloud9"
	CloudControl                 = "cloudcontrol"
	CloudFormation               = "cloudformation"
	CloudFront                   = "cloudfront"
	CloudHSMV2                   = "cloudhsmv2"
	CloudSearch                  = "cloudsearch"
	CloudTrail                   = "cloudtrail"
	CloudWatch                   = "cloudwatch"
	CodeArtifact                 = "codeartifact"
	CodeBuild                    = "codebuild"
	CodeCatalyst                 = "codecatalyst"
	CodeCommit                   = "codecommit"
	CodeGuruReviewer             = "codegurureviewer"
	CodePipeline                 = "codepipeline"
	CodeStarConnections          = "codestarconnections"
	CodeStarNotifications        = "codestarnotifications"
	CognitoIDP                   = "cognitoidp"
	CognitoIdentity              = "cognitoidentity"
	Comprehend                   = "comprehend"
	ComputeOptimizer             = "computeoptimizer"
	ConfigService                = "configservice"
	Connect                      = "connect"
	ControlTower                 = "controltower"
	DAX                          = "dax"
	DLM                          = "dlm"
	DMS                          = "dms"
	DS                           = "ds"
	DataExchange                 = "dataexchange"
	DataPipeline                 = "datapipeline"
	DataSync                     = "datasync"
	Deploy                       = "deploy"
	Detective                    = "detective"
	DeviceFarm                   = "devicefarm"
	DirectConnect                = "directconnect"
	DocDB                        = "docdb"
	DocDBElastic                 = "docdbelastic"
	DynamoDB                     = "dynamodb"
	EC2                          = "ec2"
	ECR                          = "ecr"
	ECRPublic                    = "ecrpublic"
	ECS                          = "ecs"
	EFS                          = "efs"
	EKS                          = "eks"
	ELB                          = "elb"
	ELBV2                        = "elbv2"
	EMR                          = "emr"
	EMRContainers                = "emrcontainers"
	EMRServerless                = "emrserverless"
	ElastiCache                  = "elasticache"
	ElasticBeanstalk             = "elasticbeanstalk"
	ElasticTranscoder            = "elastictranscoder"
	Elasticsearch                = "elasticsearch"
	Events                       = "events"
	Evidently                    = "evidently"
	FIS                          = "fis"
	FMS                          = "fms"
	FSx                          = "fsx"
	FinSpace                     = "finspace"
	Firehose                     = "firehose"
	GameLift                     = "gamelift"
	Glacier                      = "glacier"
	GlobalAccelerator            = "globalaccelerator"
	Glue                         = "glue"
	Grafana                      = "grafana"
	Greengrass                   = "greengrass"
	GuardDuty                    = "guardduty"
	HealthLake                   = "healthlake"
	IAM                          = "iam"
	IVS                          = "ivs"
	IVSChat                      = "ivschat"
	IdentityStore                = "identitystore"
	ImageBuilder                 = "imagebuilder"
	Inspector                    = "inspector"
	Inspector2                   = "inspector2"
	InternetMonitor              = "internetmonitor"
	IoT                          = "iot"
	IoTAnalytics                 = "iotanalytics"
	IoTEvents                    = "iotevents"
	KMS                          = "kms"
	Kafka                        = "kafka"
	KafkaConnect                 = "kafkaconnect"
	Kendra                       = "kendra"
	Keyspaces                    = "keyspaces"
	Kinesis                      = "kinesis"
	KinesisAnalytics             = "kinesisanalytics"
	KinesisAnalyticsV2           = "kinesisanalyticsv2"
	KinesisVideo                 = "kinesisvideo"
	LakeFormation                = "lakeformation"
	Lambda                       = "lambda"
	LexModels                    = "lexmodels"
	LexV2Models                  = "lexv2models"
	LicenseManager               = "licensemanager"
	Lightsail                    = "lightsail"
	Location                     = "location"
	Logs                         = "logs"
	MQ                           = "mq"
	MWAA                         = "mwaa"
	Macie2                       = "macie2"
	MediaConnect                 = "mediaconnect"
	MediaConvert                 = "mediaconvert"
	MediaLive                    = "medialive"
	MediaPackage                 = "mediapackage"
	MediaStore                   = "mediastore"
	MemoryDB                     = "memorydb"
	Neptune                      = "neptune"
	NetworkFirewall              = "networkfirewall"
	NetworkManager               = "networkmanager"
	ObservabilityAccessManager   = "oam"
	OpenSearch                   = "opensearch"
	OpenSearchServerless         = "opensearchserverless"
	OpsWorks                     = "opsworks"
	Organizations                = "organizations"
	Outposts                     = "outposts"
	Pinpoint                     = "pinpoint"
	Pipes                        = "pipes"
	Pricing                      = "pricing"
	QLDB                         = "qldb"
	QuickSight                   = "quicksight"
	RAM                          = "ram"
	RBin                         = "rbin"
	RDS                          = "rds"
	RUM                          = "rum"
	Redshift                     = "redshift"
	RedshiftData                 = "redshiftdata"
	RedshiftServerless           = "redshiftserverless"
	ResourceExplorer2            = "resourceexplorer2"
	ResourceGroups               = "resourcegroups"
	ResourceGroupsTaggingAPI     = "resourcegroupstaggingapi"
	RolesAnywhere                = "rolesanywhere"
	Route53                      = "route53"
	Route53Domains               = "route53domains"
	Route53RecoveryControlConfig = "route53recoverycontrolconfig"
	Route53RecoveryReadiness     = "route53recoveryreadiness"
	Route53Resolver              = "route53resolver"
	S3                           = "s3"
	S3Control                    = "s3control"
	S3Outposts                   = "s3outposts"
	SES                          = "ses"
	SESV2                        = "sesv2"
	SFN                          = "sfn"
	SNS                          = "sns"
	SQS                          = "sqs"
	SSM                          = "ssm"
	SSMContacts                  = "ssmcontacts"
	SSMIncidents                 = "ssmincidents"
	SSOAdmin                     = "ssoadmin"
	STS                          = "sts"
	SWF                          = "swf"
	SageMaker                    = "sagemaker"
	Scheduler                    = "scheduler"
	Schemas                      = "schemas"
	SecretsManager               = "secretsmanager"
	SecurityHub                  = "securityhub"
	SecurityLake                 = "securitylake"
	ServerlessRepo               = "serverlessrepo"
	ServiceCatalog               = "servicecatalog"
	ServiceDiscovery             = "servicediscovery"
	ServiceQuotas                = "servicequotas"
	Shield                       = "shield"
	Signer                       = "signer"
	SimpleDB                     = "simpledb"
	StorageGateway               = "storagegateway"
	Synthetics                   = "synthetics"
	TimestreamWrite              = "timestreamwrite"
	Transcribe                   = "transcribe"
	Transfer                     = "transfer"
	VPCLattice                   = "vpclattice"
	VerifiedPermissions          = "verifiedpermissions"
	WAF                          = "waf"
	WAFRegional                  = "wafregional"
	WAFV2                        = "wafv2"
	WorkLink                     = "worklink"
	WorkSpaces                   = "workspaces"
	XRay                         = "xray"
)
View Source 
const (
	AccessAnalyzerEndpointID             = "access-analyzer"
	AccountEndpointID                    = "account"
	ACMEndpointID                        = "acm"
	AuditManagerEndpointID               = "auditmanager"
	CleanRoomsEndpointID                 = "cleanrooms"
	CloudWatchLogsEndpointID             = "logs"
	CodeStarConnectionsEndpointID        = "codestar-connections"
	CodeStarNotificationsEndpointID      = "codestar-notifications"
	ComprehendEndpointID                 = "comprehend"
	ComputeOptimizerEndpointID           = "computeoptimizer"
	DSEndpointID                         = "ds"
	EMRServerlessEndpointID              = "emrserverless"
	GlacierEndpointID                    = "glacier"
	IdentityStoreEndpointID              = "identitystore"
	Inspector2EndpointID                 = "inspector2"
	InternetMonitorEndpointID            = "internetmonitor"
	IVSChatEndpointID                    = "ivschat"
	KendraEndpointID                     = "kendra"
	KeyspacesEndpointID                  = "keyspaces"
	LambdaEndpointID                     = "lambda"
	LexV2ModelsEndpointID                = "models-v2-lex"
	MediaLiveEndpointID                  = "medialive"
	ObservabilityAccessManagerEndpointID = "oam"
	OpenSearchServerlessEndpointID       = "aoss"
	PipesEndpointID                      = "pipes"
	PricingEndpointID                    = "pricing"
	QLDBEndpointID                       = "qldb"
	RedshiftDataEndpointID               = "redshift-data"
	ResourceExplorer2EndpointID          = "resource-explorer-2"
	ResourceGroupsEndpointID             = "resource-groups"
	ResourceGroupsTaggingAPIEndpointID   = "tagging"
	RolesAnywhereEndpointID              = "rolesanywhere"
	Route53DomainsEndpointID             = "route53domains"
	SchedulerEndpointID                  = "scheduler"
	ServiceQuotasEndpointID              = "servicequotas"
	S3EndpointID                         = "s3"
	S3ControlEndpointID                  = "s3-control"
	SESV2EndpointID                      = "sesv2"
	SSMEndpointID                        = "ssm"
	SSMContactsEndpointID                = "ssm-contacts"
	SSMIncidentsEndpointID               = "ssm-incidents"
	SWFEndpointID                        = "swf"
	TimestreamWriteEndpointID            = "ingest.timestream"
	TranscribeEndpointID                 = "transcribe"
	VPCLatticeEndpointID                 = "vpc-lattice"
	XRayEndpointID                       = "xray"
)

These "should" be defined by the AWS Go SDK v2, but currently aren't.

View Source 
const (
	StandardPartitionID   = "aws"        // AWS Standard partition.
	USGovCloudPartitionID = "aws-us-gov" // AWS GovCloud (US) partition.
)

These should move to aws-sdk-go-base. See https://github.com/hashicorp/aws-sdk-go-base/issues/649.

View Source 
const (
	USEast1RegionID = "us-east-1" // US East (N. Virginia).
	USWest1RegionID = "us-west-1" // US West (N. California).
	USWest2RegionID = "us-west-2" // US West (Oregon).

	USGovEast1RegionID = "us-gov-east-1" // AWS GovCloud (US-East).
	USGovWest1RegionID = "us-gov-west-1" // AWS GovCloud (US-West).
)

Variables

This section is empty.

Functions

func AWSGoClientTypeName 

func AWSGoClientTypeName(providerPackage string, version int) (string, error)

func AWSGoPackage 

func AWSGoPackage(providerPackage string, version int) (string, error)

func AWSGoV1ClientTypeName 

func AWSGoV1ClientTypeName(providerPackage string) (string, error)

func AWSGoV1Package 

func AWSGoV1Package(providerPackage string) (string, error)

func AWSGoV2Package 

func AWSGoV2Package(providerPackage string) (string, error)

func Aliases 

func Aliases() []string

func DeprecatedEnvVar 

func DeprecatedEnvVar(service string) string

func EnvVar 

func EnvVar(service string) string

func FullHumanFriendly 

func FullHumanFriendly(service string) (string, error)

func HumanFriendly 

func HumanFriendly(service string) (string, error)

func ProviderNameUpper 

func ProviderNameUpper(service string) (string, error)

func ProviderPackageForAlias 

func ProviderPackageForAlias(serviceAlias string) (string, error)

func ProviderPackages 

func ProviderPackages() []string

Types

type ServiceDatum 

type ServiceDatum struct {
	Aliases            []string
	Brand              string
	DeprecatedEnvVar   string
	EnvVar             string
	GoV1ClientTypeName string
	GoV1Package        string
	GoV2Package        string
	HumanFriendly      string
	ProviderNameUpper  string
}

Type ServiceDatum corresponds closely to columns in `names_data.csv` and are described in detail in README.md.

Source Files

View all Source files

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.