names

package
v1.60.1-0...-eae23a8 Latest Latest
Warning

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

 Go to latest Published: May 20, 2024 License: MPL-2.0 Imports: 4 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 data/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 data/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 data/names_data.csv, run make gen. Doing so regenerates code and performs checks on data/names_data.csv.

The columns of data/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 the service should be included; if included (blank), ProviderPackageActual or ProviderPackageCorrect must have a value
20 NotImplemented Code Whether the service is implemented by the provider
21 EndpointOnly Code If NotImplemented is non-blank, whether the service endpoint should be included in the provider endpoints configuration
22 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.
23 DeprecatedEnvVar Code Deprecated AWS_<service>_ENDPOINT envvar defined for some services
24 TFAWSEnvVar Code TF_AWS_<service>_ENDPOINT envvar defined for some services
25 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 data/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 data/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"
	AttrARNs                       = "arns"
	AttrAccessKey                  = "access_key"
	AttrAccountID                  = "account_id"
	AttrAction                     = "action"
	AttrAddress                    = "address"
	AttrAlias                      = "alias"
	AttrApplyImmediately           = "apply_immediately"
	AttrAttributes                 = "attributes"
	AttrAutoMinorVersionUpgrade    = "auto_minor_version_upgrade"
	AttrAvailabilityZone           = "availability_zone"
	AttrAvailabilityZones          = "availability_zones"
	AttrBucket                     = "bucket"
	AttrBucketName                 = "bucket_name"
	AttrBucketPrefix               = "bucket_prefix"
	AttrCatalogID                  = "catalog_id"
	AttrCertificate                = "certificate"
	AttrCertificateARN             = "certificate_arn"
	AttrCertificateChain           = "certificate_chain"
	AttrClientID                   = "client_id"
	AttrClientSecret               = "client_secret"
	AttrClusterIdentifier          = "cluster_identifier"
	AttrClusterName                = "cluster_name"
	AttrComment                    = "comment"
	AttrCondition                  = "condition"
	AttrConfiguration              = "configuration"
	AttrContent                    = "content"
	AttrContentType                = "content_type"
	AttrCreateTime                 = "create_time"
	AttrCreatedAt                  = "created_at"
	AttrCreatedDate                = "created_date"
	AttrCreatedTime                = "created_time"
	AttrCreationDate               = "creation_date"
	AttrCreationTime               = "creation_time"
	AttrDNSName                    = "dns_name"
	AttrDatabase                   = "database"
	AttrDatabaseName               = "database_name"
	AttrDefaultAction              = "default_action"
	AttrDefaultValue               = "default_value"
	AttrDeleteOnTermination        = "delete_on_termination"
	AttrDescription                = "description"
	AttrDestination                = "destination"
	AttrDestinationARN             = "destination_arn"
	AttrDeviceName                 = "device_name"
	AttrDisplayName                = "display_name"
	AttrDomain                     = "domain"
	AttrDomainName                 = "domain_name"
	AttrDuration                   = "duration"
	AttrEmail                      = "email"
	AttrEnabled                    = "enabled"
	AttrEncrypted                  = "encrypted"
	AttrEncryptionConfiguration    = "encryption_configuration"
	AttrEndpoint                   = "endpoint"
	AttrEndpointType               = "endpoint_type"
	AttrEndpoints                  = "endpoints"
	AttrEngineVersion              = "engine_version"
	AttrEnvironment                = "environment"
	AttrExecutionRoleARN           = "execution_role_arn"
	AttrExpression                 = "expression"
	AttrExternalID                 = "external_id"
	AttrFamily                     = "family"
	AttrField                      = "field"
	AttrFileSystemID               = "file_system_id"
	AttrFilter                     = "filter"
	AttrForceDelete                = "force_delete"
	AttrForceDestroy               = "force_destroy"
	AttrFormat                     = "format"
	AttrFunctionARN                = "function_arn"
	AttrGroupName                  = "group_name"
	AttrHeader                     = "header"
	AttrHealthCheck                = "health_check"
	AttrHostedZoneID               = "hosted_zone_id"
	AttrIAMRoleARN                 = "iam_role_arn"
	AttrID                         = "id"
	AttrIDs                        = "ids"
	AttrIOPS                       = "iops"
	AttrIPAddress                  = "ip_address"
	AttrIPAddressType              = "ip_address_type"
	AttrIdentifier                 = "identifier"
	AttrInstanceCount              = "instance_count"
	AttrInstanceID                 = "instance_id"
	AttrInstanceType               = "instance_type"
	AttrInterval                   = "interval"
	AttrIssuer                     = "issuer"
	AttrJSON                       = "json"
	AttrKMSKey                     = "kms_key"
	AttrKMSKeyARN                  = "kms_key_arn"
	AttrKMSKeyID                   = "kms_key_id"
	AttrKey                        = "key"
	AttrKeyID                      = "key_id"
	AttrLanguageCode               = "language_code"
	AttrLastUpdatedDate            = "last_updated_date"
	AttrLaunchTemplate             = "launch_template"
	AttrLogGroupName               = "log_group_name"
	AttrLoggingConfiguration       = "logging_configuration"
	AttrMax                        = "max"
	AttrMaxCapacity                = "max_capacity"
	AttrMessage                    = "message"
	AttrMetricName                 = "metric_name"
	AttrMin                        = "min"
	AttrMode                       = "mode"
	AttrMostRecent                 = "most_recent"
	AttrName                       = "name"
	AttrNamePrefix                 = "name_prefix"
	AttrNames                      = "names"
	AttrNamespace                  = "namespace"
	AttrNetworkConfiguration       = "network_configuration"
	AttrNetworkInterfaceID         = "network_interface_id"
	AttrOwner                      = "owner"
	AttrOwnerID                    = "owner_id"
	AttrParameter                  = "parameter"
	AttrParameters                 = "parameters"
	AttrPassword                   = "password"
	AttrPath                       = "path"
	AttrPermissions                = "permissions"
	AttrPolicy                     = "policy"
	AttrPort                       = "port"
	AttrPreferredMaintenanceWindow = "preferred_maintenance_window"
	AttrPrefix                     = "prefix"
	AttrPrincipal                  = "principal"
	AttrPriority                   = "priority"
	AttrPrivateKey                 = "private_key"
	AttrProfile                    = "profile"
	AttrPropagateTags              = "propagate_tags"
	AttrProperties                 = "properties"
	AttrProtocol                   = "protocol"
	AttrProviderName               = "provider_name"
	AttrPublicKey                  = "public_key"
	AttrPubliclyAccessible         = "publicly_accessible"
	AttrRegion                     = "region"
	AttrRepositoryName             = "repository_name"
	AttrResourceARN                = "resource_arn"
	AttrResourceID                 = "resource_id"
	AttrResourceTags               = "resource_tags"
	AttrResourceType               = "resource_type"
	AttrResources                  = "resources"
	AttrRetentionPeriod            = "retention_period"
	AttrRole                       = "role"
	AttrRoleARN                    = "role_arn"
	AttrRule                       = "rule"
	AttrS3Bucket                   = "s3_bucket"
	AttrS3BucketName               = "s3_bucket_name"
	AttrS3KeyPrefix                = "s3_key_prefix"
	AttrSNSTopicARN                = "sns_topic_arn"
	AttrSchedule                   = "schedule"
	AttrScheduleExpression         = "schedule_expression"
	AttrSchema                     = "schema"
	AttrScope                      = "scope"
	AttrSecretKey                  = "secret_key"
	AttrSecurityGroupIDs           = "security_group_ids"
	AttrSecurityGroups             = "security_groups"
	AttrServiceName                = "service_name"
	AttrServiceRole                = "service_role"
	AttrServiceRoleARN             = "service_role_arn"
	AttrSession                    = "session"
	AttrSharedConfigFiles          = "shared_config_files"
	AttrSize                       = "size"
	AttrSkipCredentialsValidation  = "skip_credentials_validation"
	AttrSkipDestroy                = "skip_destroy"
	AttrSkipRequestingAccountID    = "skip_requesting_account_id"
	AttrSnapshotID                 = "snapshot_id"
	AttrSource                     = "source"
	AttrSourceType                 = "source_type"
	AttrStage                      = "stage"
	AttrStartTime                  = "start_time"
	AttrState                      = "state"
	AttrStatus                     = "status"
	AttrStatusCode                 = "status_code"
	AttrStatusMessage              = "status_message"
	AttrStatusReason               = "status_reason"
	AttrStorageType                = "storage_type"
	AttrStreamARN                  = "stream_arn"
	AttrSubnetID                   = "subnet_id"
	AttrSubnetIDs                  = "subnet_ids"
	AttrSubnets                    = "subnets"
	AttrTableName                  = "table_name"
	AttrTags                       = "tags"
	AttrTagsAll                    = "tags_all"
	AttrTarget                     = "target"
	AttrTargetARN                  = "target_arn"
	AttrTimeout                    = "timeout"
	AttrTimeouts                   = "timeouts"
	AttrTopicARN                   = "topic_arn"
	AttrTransitGatewayAttachmentID = "transit_gateway_attachment_id"
	AttrTransitGatewayID           = "transit_gateway_id"
	AttrTriggers                   = "triggers"
	AttrType                       = "type"
	AttrURI                        = "uri"
	AttrURL                        = "url"
	AttrUnit                       = "unit"
	AttrUserName                   = "user_name"
	AttrUsername                   = "username"
	AttrVPCConfig                  = "vpc_config"
	AttrVPCConfiguration           = "vpc_configuration"
	AttrVPCEndpointID              = "vpc_endpoint_id"
	AttrVPCID                      = "vpc_id"
	AttrVPCSecurityGroupIDs        = "vpc_security_group_ids"
	AttrValue                      = "value"
	AttrValues                     = "values"
	AttrVersion                    = "version"
	AttrVolumeSize                 = "volume_size"
	AttrVolumeType                 = "volume_type"
	AttrWeight                     = "weight"
)
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
	ColEndpointOnly            = 21 // If set, the service is included in list of endpoints
	ColAllowedSubcategory      = 22
	ColDeprecatedEnvVar        = 23 // Deprecated `AWS_<service>_ENDPOINT` envvar defined for some services
	ColTfAwsEnvVar             = 24 // `TF_AWS_<service>_ENDPOINT` envvar defined for some services
	ColNote                    = 25
)
View Source 
const (
	ACM                          = "acm"
	ACMPCA                       = "acmpca"
	AMP                          = "amp"
	APIGateway                   = "apigateway"
	APIGatewayV2                 = "apigatewayv2"
	AccessAnalyzer               = "accessanalyzer"
	Account                      = "account"
	Amplify                      = "amplify"
	AppAutoScaling               = "appautoscaling"
	AppConfig                    = "appconfig"
	AppFabric                    = "appfabric"
	AppFlow                      = "appflow"
	AppIntegrations              = "appintegrations"
	AppMesh                      = "appmesh"
	AppRunner                    = "apprunner"
	AppStream                    = "appstream"
	AppSync                      = "appsync"
	ApplicationInsights          = "applicationinsights"
	Athena                       = "athena"
	AuditManager                 = "auditmanager"
	AutoScaling                  = "autoscaling"
	AutoScalingPlans             = "autoscalingplans"
	BCMDataExports               = "bcmdataexports"
	Backup                       = "backup"
	Batch                        = "batch"
	Bedrock                      = "bedrock"
	BedrockAgent                 = "bedrockagent"
	Budgets                      = "budgets"
	CE                           = "ce"
	CUR                          = "cur"
	Chatbot                      = "chatbot"
	Chime                        = "chime"
	ChimeSDKMediaPipelines       = "chimesdkmediapipelines"
	ChimeSDKVoice                = "chimesdkvoice"
	CleanRooms                   = "cleanrooms"
	Cloud9                       = "cloud9"
	CloudControl                 = "cloudcontrol"
	CloudFormation               = "cloudformation"
	CloudFront                   = "cloudfront"
	CloudFrontKeyValueStore      = "cloudfrontkeyvaluestore"
	CloudHSMV2                   = "cloudhsmv2"
	CloudSearch                  = "cloudsearch"
	CloudTrail                   = "cloudtrail"
	CloudWatch                   = "cloudwatch"
	CodeArtifact                 = "codeartifact"
	CodeBuild                    = "codebuild"
	CodeCatalyst                 = "codecatalyst"
	CodeCommit                   = "codecommit"
	CodeGuruProfiler             = "codeguruprofiler"
	CodeGuruReviewer             = "codegurureviewer"
	CodePipeline                 = "codepipeline"
	CodeStarConnections          = "codestarconnections"
	CodeStarNotifications        = "codestarnotifications"
	CognitoIDP                   = "cognitoidp"
	CognitoIdentity              = "cognitoidentity"
	Comprehend                   = "comprehend"
	ComputeOptimizer             = "computeoptimizer"
	ConfigService                = "configservice"
	Connect                      = "connect"
	ConnectCases                 = "connectcases"
	ControlTower                 = "controltower"
	CostOptimizationHub          = "costoptimizationhub"
	CustomerProfiles             = "customerprofiles"
	DAX                          = "dax"
	DLM                          = "dlm"
	DMS                          = "dms"
	DS                           = "ds"
	DataExchange                 = "dataexchange"
	DataPipeline                 = "datapipeline"
	DataSync                     = "datasync"
	DataZone                     = "datazone"
	Deploy                       = "deploy"
	Detective                    = "detective"
	DevOpsGuru                   = "devopsguru"
	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"
	GroundStation                = "groundstation"
	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"
	LaunchWizard                 = "launchwizard"
	LexModels                    = "lexmodels"
	LexV2Models                  = "lexv2models"
	LicenseManager               = "licensemanager"
	Lightsail                    = "lightsail"
	Location                     = "location"
	Logs                         = "logs"
	LookoutMetrics               = "lookoutmetrics"
	M2                           = "m2"
	MQ                           = "mq"
	MWAA                         = "mwaa"
	Macie2                       = "macie2"
	MediaConnect                 = "mediaconnect"
	MediaConvert                 = "mediaconvert"
	MediaLive                    = "medialive"
	MediaPackage                 = "mediapackage"
	MediaPackageV2               = "mediapackagev2"
	MediaStore                   = "mediastore"
	MemoryDB                     = "memorydb"
	Neptune                      = "neptune"
	NeptuneGraph                 = "neptunegraph"
	NetworkFirewall              = "networkfirewall"
	NetworkManager               = "networkmanager"
	ObservabilityAccessManager   = "oam"
	OpenSearch                   = "opensearch"
	OpenSearchIngestion          = "osis"
	OpenSearchServerless         = "opensearchserverless"
	OpsWorks                     = "opsworks"
	Organizations                = "organizations"
	Outposts                     = "outposts"
	PCAConnectorAD               = "pcaconnectorad"
	PaymentCryptography          = "paymentcryptography"
	Pinpoint                     = "pinpoint"
	Pipes                        = "pipes"
	Polly                        = "polly"
	Pricing                      = "pricing"
	QBusiness                    = "qbusiness"
	QLDB                         = "qldb"
	QuickSight                   = "quicksight"
	RAM                          = "ram"
	RBin                         = "rbin"
	RDS                          = "rds"
	RUM                          = "rum"
	Redshift                     = "redshift"
	RedshiftData                 = "redshiftdata"
	RedshiftServerless           = "redshiftserverless"
	Rekognition                  = "rekognition"
	ResourceExplorer2            = "resourceexplorer2"
	ResourceGroups               = "resourcegroups"
	ResourceGroupsTaggingAPI     = "resourcegroupstaggingapi"
	RolesAnywhere                = "rolesanywhere"
	Route53                      = "route53"
	Route53Domains               = "route53domains"
	Route53Profiles              = "route53profiles"
	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"
	SSMSAP                       = "ssmsap"
	SSO                          = "sso"
	SSOAdmin                     = "ssoadmin"
	STS                          = "sts"
	SWF                          = "swf"
	SageMaker                    = "sagemaker"
	Scheduler                    = "scheduler"
	Schemas                      = "schemas"
	SecretsManager               = "secretsmanager"
	SecurityHub                  = "securityhub"
	SecurityLake                 = "securitylake"
	ServerlessRepo               = "serverlessrepo"
	ServiceCatalog               = "servicecatalog"
	ServiceCatalogAppRegistry    = "servicecatalogappregistry"
	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"
	WellArchitected              = "wellarchitected"
	WorkLink                     = "worklink"
	WorkSpaces                   = "workspaces"
	WorkSpacesWeb                = "workspacesweb"
	XRay                         = "xray"
)
View Source 
const (
	ACMServiceID                          = "ACM"
	ACMPCAServiceID                       = "ACM PCA"
	AMPServiceID                          = "amp"
	APIGatewayServiceID                   = "API Gateway"
	APIGatewayV2ServiceID                 = "ApiGatewayV2"
	AccessAnalyzerServiceID               = "AccessAnalyzer"
	AccountServiceID                      = "Account"
	AmplifyServiceID                      = "Amplify"
	AppAutoScalingServiceID               = "Application Auto Scaling"
	AppConfigServiceID                    = "AppConfig"
	AppFabricServiceID                    = "AppFabric"
	AppFlowServiceID                      = "Appflow"
	AppIntegrationsServiceID              = "AppIntegrations"
	AppMeshServiceID                      = "App Mesh"
	AppRunnerServiceID                    = "AppRunner"
	AppStreamServiceID                    = "AppStream"
	AppSyncServiceID                      = "AppSync"
	ApplicationInsightsServiceID          = "Application Insights"
	AthenaServiceID                       = "Athena"
	AuditManagerServiceID                 = "AuditManager"
	AutoScalingServiceID                  = "Auto Scaling"
	AutoScalingPlansServiceID             = "Auto Scaling Plans"
	BCMDataExportsServiceID               = "BCM Data Exports"
	BackupServiceID                       = "Backup"
	BatchServiceID                        = "Batch"
	BedrockServiceID                      = "Bedrock"
	BedrockAgentServiceID                 = "Bedrock Agent"
	BudgetsServiceID                      = "Budgets"
	CEServiceID                           = "Cost Explorer"
	CURServiceID                          = "Cost and Usage Report Service"
	ChatbotServiceID                      = "Chatbot"
	ChimeServiceID                        = "Chime"
	ChimeSDKMediaPipelinesServiceID       = "Chime SDK Media Pipelines"
	ChimeSDKVoiceServiceID                = "Chime SDK Voice"
	CleanRoomsServiceID                   = "CleanRooms"
	Cloud9ServiceID                       = "Cloud9"
	CloudControlServiceID                 = "CloudControl"
	CloudFormationServiceID               = "CloudFormation"
	CloudFrontServiceID                   = "CloudFront"
	CloudFrontKeyValueStoreServiceID      = "CloudFront KeyValueStore"
	CloudHSMV2ServiceID                   = "CloudHSM V2"
	CloudSearchServiceID                  = "CloudSearch"
	CloudTrailServiceID                   = "CloudTrail"
	CloudWatchServiceID                   = "CloudWatch"
	CodeArtifactServiceID                 = "codeartifact"
	CodeBuildServiceID                    = "CodeBuild"
	CodeCatalystServiceID                 = "CodeCatalyst"
	CodeCommitServiceID                   = "CodeCommit"
	CodeGuruProfilerServiceID             = "CodeGuruProfiler"
	CodeGuruReviewerServiceID             = "CodeGuru Reviewer"
	CodePipelineServiceID                 = "CodePipeline"
	CodeStarConnectionsServiceID          = "CodeStar connections"
	CodeStarNotificationsServiceID        = "codestar notifications"
	CognitoIDPServiceID                   = "Cognito Identity Provider"
	CognitoIdentityServiceID              = "Cognito Identity"
	ComprehendServiceID                   = "Comprehend"
	ComputeOptimizerServiceID             = "Compute Optimizer"
	ConfigServiceServiceID                = "Config Service"
	ConnectServiceID                      = "Connect"
	ConnectCasesServiceID                 = "ConnectCases"
	ControlTowerServiceID                 = "ControlTower"
	CostOptimizationHubServiceID          = "Cost Optimization Hub"
	CustomerProfilesServiceID             = "Customer Profiles"
	DAXServiceID                          = "DAX"
	DLMServiceID                          = "DLM"
	DMSServiceID                          = "Database Migration Service"
	DSServiceID                           = "Directory Service"
	DataExchangeServiceID                 = "DataExchange"
	DataPipelineServiceID                 = "Data Pipeline"
	DataSyncServiceID                     = "DataSync"
	DataZoneServiceID                     = "DataZone"
	DeployServiceID                       = "CodeDeploy"
	DetectiveServiceID                    = "Detective"
	DevOpsGuruServiceID                   = "DevOps Guru"
	DeviceFarmServiceID                   = "Device Farm"
	DirectConnectServiceID                = "Direct Connect"
	DocDBServiceID                        = "DocDB"
	DocDBElasticServiceID                 = "DocDB Elastic"
	DynamoDBServiceID                     = "DynamoDB"
	EC2ServiceID                          = "EC2"
	ECRServiceID                          = "ECR"
	ECRPublicServiceID                    = "ECR PUBLIC"
	ECSServiceID                          = "ECS"
	EFSServiceID                          = "EFS"
	EKSServiceID                          = "EKS"
	ELBServiceID                          = "Elastic Load Balancing"
	ELBV2ServiceID                        = "Elastic Load Balancing v2"
	EMRServiceID                          = "EMR"
	EMRContainersServiceID                = "EMR containers"
	EMRServerlessServiceID                = "EMR Serverless"
	ElastiCacheServiceID                  = "ElastiCache"
	ElasticBeanstalkServiceID             = "Elastic Beanstalk"
	ElasticTranscoderServiceID            = "Elastic Transcoder"
	ElasticsearchServiceID                = "Elasticsearch Service"
	EventsServiceID                       = "EventBridge"
	EvidentlyServiceID                    = "Evidently"
	FISServiceID                          = "fis"
	FMSServiceID                          = "FMS"
	FSxServiceID                          = "FSx"
	FinSpaceServiceID                     = "finspace"
	FirehoseServiceID                     = "Firehose"
	GameLiftServiceID                     = "GameLift"
	GlacierServiceID                      = "Glacier"
	GlobalAcceleratorServiceID            = "Global Accelerator"
	GlueServiceID                         = "Glue"
	GrafanaServiceID                      = "grafana"
	GreengrassServiceID                   = "Greengrass"
	GroundStationServiceID                = "GroundStation"
	GuardDutyServiceID                    = "GuardDuty"
	HealthLakeServiceID                   = "HealthLake"
	IAMServiceID                          = "IAM"
	IVSServiceID                          = "ivs"
	IVSChatServiceID                      = "ivschat"
	IdentityStoreServiceID                = "identitystore"
	ImageBuilderServiceID                 = "imagebuilder"
	InspectorServiceID                    = "Inspector"
	Inspector2ServiceID                   = "Inspector2"
	InternetMonitorServiceID              = "InternetMonitor"
	IoTServiceID                          = "IoT"
	IoTAnalyticsServiceID                 = "IoTAnalytics"
	IoTEventsServiceID                    = "IoT Events"
	KMSServiceID                          = "KMS"
	KafkaServiceID                        = "Kafka"
	KafkaConnectServiceID                 = "KafkaConnect"
	KendraServiceID                       = "kendra"
	KeyspacesServiceID                    = "Keyspaces"
	KinesisServiceID                      = "Kinesis"
	KinesisAnalyticsServiceID             = "Kinesis Analytics"
	KinesisAnalyticsV2ServiceID           = "Kinesis Analytics V2"
	KinesisVideoServiceID                 = "Kinesis Video"
	LakeFormationServiceID                = "LakeFormation"
	LambdaServiceID                       = "Lambda"
	LaunchWizardServiceID                 = "Launch Wizard"
	LexModelsServiceID                    = "Lex Model Building Service"
	LexV2ModelsServiceID                  = "Lex Models V2"
	LicenseManagerServiceID               = "License Manager"
	LightsailServiceID                    = "Lightsail"
	LocationServiceID                     = "Location"
	LogsServiceID                         = "CloudWatch Logs"
	LookoutMetricsServiceID               = "LookoutMetrics"
	M2ServiceID                           = "m2"
	MQServiceID                           = "mq"
	MWAAServiceID                         = "MWAA"
	Macie2ServiceID                       = "Macie2"
	MediaConnectServiceID                 = "MediaConnect"
	MediaConvertServiceID                 = "MediaConvert"
	MediaLiveServiceID                    = "MediaLive"
	MediaPackageServiceID                 = "MediaPackage"
	MediaPackageV2ServiceID               = "MediaPackageV2"
	MediaStoreServiceID                   = "MediaStore"
	MemoryDBServiceID                     = "MemoryDB"
	NeptuneServiceID                      = "Neptune"
	NeptuneGraphServiceID                 = "Neptune Graph"
	NetworkFirewallServiceID              = "Network Firewall"
	NetworkManagerServiceID               = "NetworkManager"
	ObservabilityAccessManagerServiceID   = "OAM"
	OpenSearchServiceID                   = "OpenSearch"
	OpenSearchIngestionServiceID          = "OSIS"
	OpenSearchServerlessServiceID         = "OpenSearchServerless"
	OpsWorksServiceID                     = "OpsWorks"
	OrganizationsServiceID                = "Organizations"
	OutpostsServiceID                     = "Outposts"
	PCAConnectorADServiceID               = "Pca Connector Ad"
	PaymentCryptographyServiceID          = "PaymentCryptography"
	PinpointServiceID                     = "Pinpoint"
	PipesServiceID                        = "Pipes"
	PollyServiceID                        = "Polly"
	PricingServiceID                      = "Pricing"
	QBusinessServiceID                    = "QBusiness"
	QLDBServiceID                         = "QLDB"
	QuickSightServiceID                   = "QuickSight"
	RAMServiceID                          = "RAM"
	RBinServiceID                         = "rbin"
	RDSServiceID                          = "RDS"
	RUMServiceID                          = "RUM"
	RedshiftServiceID                     = "Redshift"
	RedshiftDataServiceID                 = "Redshift Data"
	RedshiftServerlessServiceID           = "Redshift Serverless"
	RekognitionServiceID                  = "Rekognition"
	ResourceExplorer2ServiceID            = "Resource Explorer 2"
	ResourceGroupsServiceID               = "Resource Groups"
	ResourceGroupsTaggingAPIServiceID     = "Resource Groups Tagging API"
	RolesAnywhereServiceID                = "RolesAnywhere"
	Route53ServiceID                      = "Route 53"
	Route53DomainsServiceID               = "Route 53 Domains"
	Route53ProfilesServiceID              = "Route 53 Profiles"
	Route53RecoveryControlConfigServiceID = "Route53 Recovery Control Config"
	Route53RecoveryReadinessServiceID     = "Route53 Recovery Readiness"
	Route53ResolverServiceID              = "Route53Resolver"
	S3ServiceID                           = "S3"
	S3ControlServiceID                    = "S3 Control"
	S3OutpostsServiceID                   = "S3Outposts"
	SESServiceID                          = "SES"
	SESV2ServiceID                        = "SESv2"
	SFNServiceID                          = "SFN"
	SNSServiceID                          = "SNS"
	SQSServiceID                          = "SQS"
	SSMServiceID                          = "SSM"
	SSMContactsServiceID                  = "SSM Contacts"
	SSMIncidentsServiceID                 = "SSM Incidents"
	SSMSAPServiceID                       = "Ssm Sap"
	SSOServiceID                          = "SSO"
	SSOAdminServiceID                     = "SSO Admin"
	STSServiceID                          = "STS"
	SWFServiceID                          = "SWF"
	SageMakerServiceID                    = "SageMaker"
	SchedulerServiceID                    = "Scheduler"
	SchemasServiceID                      = "schemas"
	SecretsManagerServiceID               = "Secrets Manager"
	SecurityHubServiceID                  = "SecurityHub"
	SecurityLakeServiceID                 = "SecurityLake"
	ServerlessRepoServiceID               = "ServerlessApplicationRepository"
	ServiceCatalogServiceID               = "Service Catalog"
	ServiceCatalogAppRegistryServiceID    = "Service Catalog AppRegistry"
	ServiceDiscoveryServiceID             = "ServiceDiscovery"
	ServiceQuotasServiceID                = "Service Quotas"
	ShieldServiceID                       = "Shield"
	SignerServiceID                       = "signer"
	SimpleDBServiceID                     = "SimpleDB"
	StorageGatewayServiceID               = "Storage Gateway"
	SyntheticsServiceID                   = "synthetics"
	TimestreamWriteServiceID              = "Timestream Write"
	TranscribeServiceID                   = "Transcribe"
	TransferServiceID                     = "Transfer"
	VPCLatticeServiceID                   = "VPC Lattice"
	VerifiedPermissionsServiceID          = "VerifiedPermissions"
	WAFServiceID                          = "WAF"
	WAFRegionalServiceID                  = "WAF Regional"
	WAFV2ServiceID                        = "WAFV2"
	WellArchitectedServiceID              = "WellArchitected"
	WorkLinkServiceID                     = "WorkLink"
	WorkSpacesServiceID                   = "WorkSpaces"
	WorkSpacesWebServiceID                = "WorkSpaces Web"
	XRayServiceID                         = "XRay"
)

Copied from AWS SDK v2 Equivalent to <service>.ServiceID

View Source 
const (
	AccessAnalyzerEndpointID             = "access-analyzer"
	ACMPCAEndpointID                     = "acm-pca"
	AMPEndpointID                        = "aps"
	AppStreamEndpointID                  = "appstream2"
	ApplicationAutoscalingEndpointID     = "application-autoscaling"
	AppIntegrationsEndpointID            = "app-integrations"
	AppConfigEndpointID                  = "appconfig"
	AmplifyEndpointID                    = "amplify"
	APIGatewayID                         = "apigateway"
	APIGatewayV2EndpointID               = "apigateway"
	AthenaEndpointID                     = "athena"
	AuditManagerEndpointID               = "auditmanager"
	AutoScalingPlansEndpointID           = "autoscaling-plans"
	BatchEndpointID                      = "batch"
	BedrockAgentEndpointID               = "bedrockagent"
	BedrockEndpointID                    = "bedrock"
	BCMDataExportsEndpointID             = "bcm-data-exports"
	BudgetsEndpointID                    = "budgets"
	ChimeSDKMediaPipelinesEndpointID     = "media-pipelines-chime"
	ChimeSDKVoiceEndpointID              = "voice-chime"
	CloudFormationEndpointID             = "cloudformation"
	CloudFrontEndpointID                 = "cloudfront"
	CloudSearchEndpointID                = "cloudsearch"
	CloudWatchEndpointID                 = "monitoring"
	Cloud9EndpointID                     = "cloud9"
	CodeArtifactEndpointID               = "codeartifact"
	CodeGuruReviewerEndpointID           = "codeguru-reviewer"
	CodeStarConnectionsEndpointID        = "codestar-connections"
	CognitoIdentityEndpointID            = "cognito-identity"
	ComprehendEndpointID                 = "comprehend"
	ConfigServiceEndpointID              = "config"
	DevOpsGuruEndpointID                 = "devops-guru"
	ECREndpointID                        = "api.ecr"
	EKSEndpointID                        = "eks"
	EMREndpointID                        = "elasticmapreduce"
	EventsEndpointID                     = "events"
	EvidentlyEndpointID                  = "evidently"
	FMSEndpointID                        = "fms"
	IdentityStoreEndpointID              = "identitystore"
	Inspector2EndpointID                 = "inspector2"
	IVSChatEndpointID                    = "ivschat"
	KendraEndpointID                     = "kendra"
	KMSEndpointID                        = "kms"
	LambdaEndpointID                     = "lambda"
	LexV2ModelsEndpointID                = "models-v2-lex"
	M2EndpointID                         = "m2"
	MediaConvertEndpointID               = "mediaconvert"
	MediaLiveEndpointID                  = "medialive"
	MQEndpointID                         = "mq"
	ObservabilityAccessManagerEndpointID = "oam"
	OpenSearchServerlessEndpointID       = "aoss"
	OpenSearchIngestionEndpointID        = "osis"
	PipesEndpointID                      = "pipes"
	PollyEndpointID                      = "polly"
	QLDBEndpointID                       = "qldb"
	RedshiftServerlessEndpointID         = "redshift-serverless"
	RedshiftEndpointID                   = "redshift"
	RekognitionEndpointID                = "rekognition"
	ResourceExplorer2EndpointID          = "resource-explorer-2"
	RolesAnywhereEndpointID              = "rolesanywhere"
	Route53DomainsEndpointID             = "route53domains"
	SchedulerEndpointID                  = "scheduler"
	ServiceQuotasEndpointID              = "servicequotas"
	ServiceCatalogAppRegistryEndpointID  = "servicecatalog-appregistry"
	ShieldEndpointID                     = "shield"
	SSMEndpointID                        = "ssm"
	SSMIncidentsEndpointID               = "ssm-incidents"
	SSOAdminEndpointID                   = "sso"
	STSEndpointID                        = "sts"
	TranscribeEndpointID                 = "transcribe"
	VerifiedPermissionsEndpointID        = "verifiedpermissions"
	VPCLatticeEndpointID                 = "vpc-lattice"
	WAFEndpointID                        = "waf"
	WAFRegionalEndpointID                = "waf-regional"
)

Endpoint constants defined by the AWS SDK v1 but not defined in the AWS SDK v2.

View Source 
const (
	ChinaPartitionID      = "aws-cn"     // AWS China partition.
	ISOPartitionID        = "aws-iso"    // AWS ISO (US) partition.
	ISOBPartitionID       = "aws-iso-b"  // AWS ISOB (US) partition.
	ISOEPartitionID       = "aws-iso-e"  // AWS ISOE (Europe) partition.
	ISOFPartitionID       = "aws-iso-f"  // AWS ISOF partition.
	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 (
	// AWS Standard partition's regions.
	GlobalRegionID = "aws-global" // AWS Standard global region.

	AFSouth1RegionID     = "af-south-1"     // Africa (Cape Town).
	APEast1RegionID      = "ap-east-1"      // Asia Pacific (Hong Kong).
	APNortheast1RegionID = "ap-northeast-1" // Asia Pacific (Tokyo).
	APNortheast2RegionID = "ap-northeast-2" // Asia Pacific (Seoul).
	APNortheast3RegionID = "ap-northeast-3" // Asia Pacific (Osaka).
	APSouth1RegionID     = "ap-south-1"     // Asia Pacific (Mumbai).
	APSouth2RegionID     = "ap-south-2"     // Asia Pacific (Hyderabad).
	APSoutheast1RegionID = "ap-southeast-1" // Asia Pacific (Singapore).
	APSoutheast2RegionID = "ap-southeast-2" // Asia Pacific (Sydney).
	APSoutheast3RegionID = "ap-southeast-3" // Asia Pacific (Jakarta).
	APSoutheast4RegionID = "ap-southeast-4" // Asia Pacific (Melbourne).
	CACentral1RegionID   = "ca-central-1"   // Canada (Central).
	CAWest1RegionID      = "ca-west-1"      // Canada West (Calgary).
	EUCentral1RegionID   = "eu-central-1"   // Europe (Frankfurt).
	EUCentral2RegionID   = "eu-central-2"   // Europe (Zurich).
	EUNorth1RegionID     = "eu-north-1"     // Europe (Stockholm).
	EUSouth1RegionID     = "eu-south-1"     // Europe (Milan).
	EUSouth2RegionID     = "eu-south-2"     // Europe (Spain).
	EUWest1RegionID      = "eu-west-1"      // Europe (Ireland).
	EUWest2RegionID      = "eu-west-2"      // Europe (London).
	EUWest3RegionID      = "eu-west-3"      // Europe (Paris).
	ILCentral1RegionID   = "il-central-1"   // Israel (Tel Aviv).
	MECentral1RegionID   = "me-central-1"   // Middle East (UAE).
	MESouth1RegionID     = "me-south-1"     // Middle East (Bahrain).
	SAEast1RegionID      = "sa-east-1"      // South America (Sao Paulo).
	USEast1RegionID      = "us-east-1"      // US East (N. Virginia).
	USEast2RegionID      = "us-east-2"      // US East (Ohio).
	USWest1RegionID      = "us-west-1"      // US West (N. California).
	USWest2RegionID      = "us-west-2"      // US West (Oregon).

	// AWS China partition's regions.
	CNNorth1RegionID     = "cn-north-1"     // China (Beijing).
	CNNorthwest1RegionID = "cn-northwest-1" // China (Ningxia).

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

	// AWS ISO (US) partition's regions.
	USISOEast1RegionID = "us-iso-east-1" // US ISO East.
	USISOWest1RegionID = "us-iso-west-1" // US ISO WEST.

	// AWS ISOB (US) partition's regions.
	USISOBEast1RegionID = "us-isob-east-1" // US ISOB East (Ohio).
)

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 AWSServiceEnvVar 

func AWSServiceEnvVar(service string) string

Standard service endpoint envvar defined by AWS

func Aliases 

func Aliases() []string

func ClientSDKV1 

func ClientSDKV1(service string) bool

func ConstOrQuote 

func ConstOrQuote(constant string) string

ConstOrQuote returns the constant name for the given attribute if it exists. Otherwise, it returns the attribute quoted. This is intended for use in generated code and templates.

func DNSSuffixForPartition 

func DNSSuffixForPartition(partition string) string

func DeprecatedEnvVar 

func DeprecatedEnvVar(service string) string

Deprecated `AWS_<service>_ENDPOINT` envvar defined for some services

func FullHumanFriendly 

func FullHumanFriendly(service string) (string, error)

func HumanFriendly 

func HumanFriendly(service string) (string, error)

func IsOptInRegion 

func IsOptInRegion(region string) bool

func PartitionForRegion 

func PartitionForRegion(region string) string

func ProviderNameUpper 

func ProviderNameUpper(service string) (string, error)

func ProviderPackageForAlias 

func ProviderPackageForAlias(serviceAlias string) (string, error)

func ProviderPackages 

func ProviderPackages() []string

func ReverseDNS 

func ReverseDNS(hostname string) string

ReverseDNS switches a DNS hostname to reverse DNS and vice-versa.

func SDKID 

func SDKID(service string) string

Service SDK ID from AWS SDK for Go v2

func TFAWSEnvVar 

func TFAWSEnvVar(service string) string

Deprecated `TF_AWS_<service>_ENDPOINT` envvar defined for some services

Types

type Endpoint 

type Endpoint struct {
	ProviderPackage string
	Aliases         []string
}

func Endpoints 

func Endpoints() []Endpoint

type ServiceDatum 

type ServiceDatum struct {
	Aliases            []string
	AWSServiceEnvVar   string
	Brand              string
	ClientSDKV1        bool
	DeprecatedEnvVar   string
	EndpointOnly       bool
	GoV1ClientTypeName string
	GoV1Package        string
	GoV2Package        string
	HumanFriendly      string
	ProviderNameUpper  string
	SDKID              string
	TFAWSEnvVar        string
}

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

type ServiceNameUpper 

type ServiceNameUpper struct {
	ProviderPackage   string
	ProviderNameUpper string
	SDKID             string
}

func ServiceNamesUpper 

func ServiceNamesUpper() []ServiceNameUpper

Source Files

View all Source files

Directories

Path Synopsis

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.