Documentation
¶
Index ¶
- func GetAccessKey(ctx *pulumi.Context) string
- func GetAllowedAccountIds(ctx *pulumi.Context) string
- func GetAssumeRole(ctx *pulumi.Context) string
- func GetDefaultTags(ctx *pulumi.Context) string
- func GetEndpoints(ctx *pulumi.Context) string
- func GetForbiddenAccountIds(ctx *pulumi.Context) string
- func GetIgnoreTags(ctx *pulumi.Context) string
- func GetInsecure(ctx *pulumi.Context) bool
- func GetMaxRetries(ctx *pulumi.Context) int
- func GetProfile(ctx *pulumi.Context) string
- func GetRegion(ctx *pulumi.Context) string
- func GetRoleArn(ctx *pulumi.Context) string
- func GetS3ForcePathStyle(ctx *pulumi.Context) bool
- func GetSecretKey(ctx *pulumi.Context) string
- func GetSharedCredentialsFile(ctx *pulumi.Context) string
- func GetSkipCredentialsValidation(ctx *pulumi.Context) bool
- func GetSkipGetEc2Platforms(ctx *pulumi.Context) bool
- func GetSkipMetadataApiCheck(ctx *pulumi.Context) bool
- func GetSkipRegionValidation(ctx *pulumi.Context) bool
- func GetSkipRequestingAccountId(ctx *pulumi.Context) bool
- func GetToken(ctx *pulumi.Context) string
- type AssumeRole
- type DefaultTags
- type Endpoints
- type IgnoreTags
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
func GetAccessKey ¶
The access key for API operations. You can retrieve this from the ‘Security & Credentials’ section of the AWS console.
func GetAllowedAccountIds ¶
List of allowed AWS account IDs to prevent you from mistakenly using an incorrect one. Conflicts with `forbiddenAccountIds`.
func GetAssumeRole ¶
Configuration for retrieving temporary credentials from the STS service.
func GetDefaultTags ¶
Configuration block with resource tag settings to apply across all resources handled by this provider. This is designed to replace redundant per-resource `tags` configurations. Provider tags can be overridden with new values, but not excluded from specific resources. To override provider tag values, use the `tags` argument within a resource to configure new tag values for matching keys.
func GetEndpoints ¶
Configuration block for customizing service endpoints.
func GetForbiddenAccountIds ¶
List of forbidden AWS account IDs to prevent you from mistakenly using the wrong one (and potentially end up destroying a live environment). Conflicts with `allowedAccountIds`.
func GetIgnoreTags ¶
Configuration block with resource tag settings to ignore across all resources handled by this provider (except any individual service tag resources such as `ec2.Tag`) for situations where external systems are managing certain resource tags.
func GetInsecure ¶
Explicitly allow the provider to perform "insecure" SSL requests. If omitted,default value is `false`.
func GetMaxRetries ¶
The maximum number of times an AWS API request is being executed. If the API request still fails, an error is thrown.
func GetProfile ¶
The profile for API operations. If not set, the default profile created with `aws configure` will be used.
func GetRegion ¶
The region where AWS operations will take place. Examples are `us-east-1`, `us-west-2`, etc.
func GetRoleArn ¶ added in v0.18.0
The Amazon Resource Name (ARN) of the AWS Identity and Access Management (IAM) role for Cloud Control API to use when performing this resource operation. Note, this is a unique feature for server side security enforcement, not to be confused with assumeRole, which is used to obtain temporary client credentials. If you do not specify a role, Cloud Control API uses a temporary session created using your AWS user credentials instead.
func GetS3ForcePathStyle ¶
Set this to true to force the request to use path-style addressing, i.e., `http://s3.amazonaws.com/BUCKET/KEY`. By default, the S3 client will use virtual hosted bucket addressing when possible (`http://BUCKET.s3.amazonaws.com/KEY`). Specific to the Amazon S3 service.
func GetSecretKey ¶
The secret key for API operations. You can retrieve this from the 'Security & Credentials' section of the AWS console.
func GetSharedCredentialsFile ¶
The path to the shared credentials file. If not set this defaults to `~/.aws/credentials`.
func GetSkipCredentialsValidation ¶
Skip the credentials validation via STS API. Used for AWS API implementations that do not have STS available/implemented.
func GetSkipGetEc2Platforms ¶
Skip getting the supported EC2 platforms. Used by users that don't have `ec2:DescribeAccountAttributes` permissions.
func GetSkipMetadataApiCheck ¶
Skip the AWS Metadata API check. Useful for AWS API implementations that do not have a metadata API endpoint. Setting to true prevents Pulumi from authenticating via the Metadata API. You may need to use other authentication methods like static credentials, configuration variables, or environment variables.
func GetSkipRegionValidation ¶
Skip static validation of region name. Used by users of alternative AWS-like APIs or users with access to regions that are not public.
func GetSkipRequestingAccountId ¶
Skip requesting the account ID. Used for AWS API implementations that do not have IAM/STS API and/or metadata API.
Types ¶
type AssumeRole ¶
type AssumeRole struct { // Number of seconds to restrict the assume role session duration. DurationSeconds *int `pulumi:"durationSeconds"` // External identifier to use when assuming the role. ExternalId *string `pulumi:"externalId"` // IAM Policy JSON describing further restricting permissions for the IAM Role being assumed. Policy *string `pulumi:"policy"` // Set of Amazon Resource Names (ARNs) of IAM Policies describing further restricting permissions for the role. PolicyArns []string `pulumi:"policyArns"` // Amazon Resource Name (ARN) of the IAM Role to assume. RoleArn *string `pulumi:"roleArn"` // Session name to use when assuming the role. SessionName *string `pulumi:"sessionName"` // Map of assume role session tags. Tags map[string]string `pulumi:"tags"` // A list of keys for session tags that you want to set as transitive. If you set a tag key as transitive, the corresponding key and value passes to subsequent sessions in a role chain. TransitiveTagKeys []string `pulumi:"transitiveTagKeys"` }
The configuration for a Provider to assume a role.
type DefaultTags ¶
type DefaultTags struct { // A group of tags to set across all resources. Tags map[string]string `pulumi:"tags"` }
The configuration with resource tag settings to apply across all resources handled by this provider. This is designed to replace redundant per-resource `tags` configurations. Provider tags can be overridden with new values, but not excluded from specific resources. To override provider tag values, use the `tags` argument within a resource to configure new tag values for matching keys.
type Endpoints ¶
type Endpoints struct { // Override the default endpoint for AWS Access Analyzer Accessanalyzer *string `pulumi:"accessanalyzer"` // Override the default endpoint for AWS Certificate Manager Acm *string `pulumi:"acm"` // Override the default endpoint for AWS Certificate Manager Private Certificate Authority Acmpca *string `pulumi:"acmpca"` // Override the default endpoint for AWS Amplify Console Amplify *string `pulumi:"amplify"` // Override the default endpoint for AWS AppConfig Appconfig *string `pulumi:"appconfig"` // Override the default endpoint for AWS Application Auto Scaling Applicationautoscaling *string `pulumi:"applicationautoscaling"` // Override the default endpoint for AWS CloudWatch Application Insights Applicationinsights *string `pulumi:"applicationinsights"` // Override the default endpoint for AWS App Mesh Appmesh *string `pulumi:"appmesh"` // Override the default endpoint for AWS App Runner Apprunner *string `pulumi:"apprunner"` // Override the default endpoint for AWS AppStream 2.0 Appstream *string `pulumi:"appstream"` // Override the default endpoint for AWS AppSync Appsync *string `pulumi:"appsync"` // Override the default endpoint for AWS Athena Athena *string `pulumi:"athena"` // Override the default endpoint for AWS Audit Manager Auditmanager *string `pulumi:"auditmanager"` // Override the default endpoint for AWS Auto Scaling Autoscaling *string `pulumi:"autoscaling"` // Override the default endpoint for AWS Backup Backup *string `pulumi:"backup"` // Override the default endpoint for AWS Batch Batch *string `pulumi:"batch"` // Override the default endpoint for AWS Budgets Budgets *string `pulumi:"budgets"` // Override the default endpoint for Amazon Chime Chime *string `pulumi:"chime"` // Override the default endpoint for AWS Cloud9 Cloud9 *string `pulumi:"cloud9"` // Override the default endpoint for AWS CloudFormation Cloudformation *string `pulumi:"cloudformation"` // Override the default endpoint for AWS CloudFront Cloudfront *string `pulumi:"cloudfront"` // Override the default endpoint for AWS CloudHSM Cloudhsm *string `pulumi:"cloudhsm"` // Override the default endpoint for AWS CloudSearch Cloudsearch *string `pulumi:"cloudsearch"` // Override the default endpoint for AWS CloudTrail Cloudtrail *string `pulumi:"cloudtrail"` // Override the default endpoint for AWS CloudWatch Cloudwatch *string `pulumi:"cloudwatch"` // Override the default endpoint for AWS CloudWatch Events Cloudwatchevents *string `pulumi:"cloudwatchevents"` // Override the default endpoint for AWS CloudWatch Logs Cloudwatchlogs *string `pulumi:"cloudwatchlogs"` // Override the default endpoint for AWS CodeArtifact Codeartifact *string `pulumi:"codeartifact"` // Override the default endpoint for AWS CodeBuild Codebuild *string `pulumi:"codebuild"` // Override the default endpoint for AWS CodeCommit Codecommit *string `pulumi:"codecommit"` // Override the default endpoint for AWS CodeDeploy Codedeploy *string `pulumi:"codedeploy"` // Override the default endpoint for AWS CodePipeline Codepipeline *string `pulumi:"codepipeline"` // Override the default endpoint for AWS CodeStart Connections Codestarconnections *string `pulumi:"codestarconnections"` // Override the default endpoint for Amazon Cognito Cognitoidentity *string `pulumi:"cognitoidentity"` // Override the default endpoint for AWS Config Configservice *string `pulumi:"configservice"` // Override the default endpoint for Amazon Connect Connect *string `pulumi:"connect"` // Override the default endpoint for AWS Cost and Usage Reports Cur *string `pulumi:"cur"` // Override the default endpoint for AWS Data Exchange Dataexchange *string `pulumi:"dataexchange"` // Override the default endpoint for AWS Data Pipeline Datapipeline *string `pulumi:"datapipeline"` // Override the default endpoint for AWS DataSync Datasync *string `pulumi:"datasync"` // Override the default endpoint for AWS DynamoDB Accelerator Dax *string `pulumi:"dax"` // Override the default endpoint for AWS Detective Detective *string `pulumi:"detective"` // Override the default endpoint for AWS Device Farm Devicefarm *string `pulumi:"devicefarm"` // Override the default endpoint for AWS Direct Connect Directconnect *string `pulumi:"directconnect"` // Override the default endpoint for AWS Data Lifecycle Manager Dlm *string `pulumi:"dlm"` // Override the default endpoint for AWS Database Migration Service Dms *string `pulumi:"dms"` // Override the default endpoint for AWS DocumentDB Docdb *string `pulumi:"docdb"` // Override the default endpoint for AWS Directory Service Ds *string `pulumi:"ds"` // Override the default endpoint for AWS DynamoDB Dynamodb *string `pulumi:"dynamodb"` // Override the default endpoint for AWS Elastic Compute Cloud (EC2) Ec2 *string `pulumi:"ec2"` // Override the default endpoint for AWS Elastic Container Registry (ECR) Ecr *string `pulumi:"ecr"` // Override the default endpoint for AWS Elastic Container Registry (ECR) Public Ecrpublic *string `pulumi:"ecrpublic"` // Override the default endpoint for AWS Elastic Container Service (ECS) Ecs *string `pulumi:"ecs"` // Override the default endpoint for AWS Elastic File System (EFS) Efs *string `pulumi:"efs"` // Override the default endpoint for AWS Elastic Kubernetes Service (EKS) Eks *string `pulumi:"eks"` // Override the default endpoint for AWS ElastiCache Elasticache *string `pulumi:"elasticache"` // Override the default endpoint for AWS Elastic Beanstalk Elasticbeanstalk *string `pulumi:"elasticbeanstalk"` // Override the default endpoint for AWS Elastic Transcoder Elastictranscoder *string `pulumi:"elastictranscoder"` // Override the default endpoint for AWS Elastic Load Balancing Elb *string `pulumi:"elb"` // Override the default endpoint for AWS Elastic Load Balancing V2 Elbv2 *string `pulumi:"elbv2"` // Override the default endpoint for AWS EMR Emr *string `pulumi:"emr"` // Override the default endpoint for AWS EMR on EKS Emrcontainers *string `pulumi:"emrcontainers"` // Override the default endpoint for AWS OpenSearch Service (formerly Elasticsearch) Es *string `pulumi:"es"` // Override the default endpoint for AWS Kinesis Data Firehose Firehose *string `pulumi:"firehose"` // Override the default endpoint for AWS Firewall Manager Fms *string `pulumi:"fms"` // Override the default endpoint for Amazon Forecast Forecast *string `pulumi:"forecast"` // Override the default endpoint for AWS FSx Fsx *string `pulumi:"fsx"` // Override the default endpoint for AWS GameLift Gamelift *string `pulumi:"gamelift"` // Override the default endpoint for Amazon S3 Glacier Glacier *string `pulumi:"glacier"` // Override the default endpoint for AWS Global Accelerator Globalaccelerator *string `pulumi:"globalaccelerator"` // Override the default endpoint for AWS Glue Glue *string `pulumi:"glue"` // Override the default endpoint for AWS IoT Greengrass Greengrass *string `pulumi:"greengrass"` // Override the default endpoint for AWS GuardDuty Guardduty *string `pulumi:"guardduty"` // Override the default endpoint for AWS Identity and Access Management Iam *string `pulumi:"iam"` // Override the default endpoint for AWS Single Sign-On (SSO) Identity Store Identitystore *string `pulumi:"identitystore"` // Override the default endpoint for AWS Image Builder Imagebuilder *string `pulumi:"imagebuilder"` // Override the default endpoint for Amazon Inspector Inspector *string `pulumi:"inspector"` // Override the default endpoint for AWS IoT Iot *string `pulumi:"iot"` // Override the default endpoint for AWS IoT Analytics Iotanalytics *string `pulumi:"iotanalytics"` // Override the default endpoint for AWS IoT Events Iotevents *string `pulumi:"iotevents"` // Override the default endpoint for Amazon Managed Streaming for Apache Kafka (MSK) Kafka *string `pulumi:"kafka"` // Override the default endpoint for Amazon Kinesis Kinesis *string `pulumi:"kinesis"` // Override the default endpoint for Amazon Kinesis Data Analytics Kinesisanalytics *string `pulumi:"kinesisanalytics"` // Override the default endpoint for Amazon Kinesis Data Analytics V2 Kinesisanalyticsv2 *string `pulumi:"kinesisanalyticsv2"` // Override the default endpoint for Amazon Kinesis Video Streams Kinesisvideo *string `pulumi:"kinesisvideo"` // Override the default endpoint for AWS Key Management Service Kms *string `pulumi:"kms"` // Override the default endpoint for AWS Lake Formation Lakeformation *string `pulumi:"lakeformation"` // Override the default endpoint for AWS Lambda Lambda *string `pulumi:"lambda"` // Override the default endpoint for Amazon Lex Lexmodels *string `pulumi:"lexmodels"` // Override the default endpoint for AWS License Manager Licensemanager *string `pulumi:"licensemanager"` // Override the default endpoint for Amazon Lightsail Lightsail *string `pulumi:"lightsail"` // Override the default endpoint for Amazon Location Location *string `pulumi:"location"` // Override the default endpoint for Amazon Macie Macie *string `pulumi:"macie"` // Override the default endpoint for Amazon Macie V2 Macie2 *string `pulumi:"macie2"` // Override the default endpoint for Amazon Managed Blockchain Managedblockchain *string `pulumi:"managedblockchain"` // Override the default endpoint for AWS Marketplace Catalog Marketplacecatalog *string `pulumi:"marketplacecatalog"` // Override the default endpoint for AWS MediaConnect Mediaconnect *string `pulumi:"mediaconnect"` // Override the default endpoint for AWS MediaConvert Mediaconvert *string `pulumi:"mediaconvert"` // Override the default endpoint for AWS MediaLive Medialive *string `pulumi:"medialive"` // Override the default endpoint for AWS MediaPackage Mediapackage *string `pulumi:"mediapackage"` // Override the default endpoint for AWS Elemental MediaStore container Mediastore *string `pulumi:"mediastore"` // Override the default endpoint for AWS Elemental MediaStore asset Mediastoredata *string `pulumi:"mediastoredata"` // Override the default endpoint for AWS MemoryDB for Redis Memorydb *string `pulumi:"memorydb"` // Override the default endpoint for Amazon MQ Mq *string `pulumi:"mq"` // Override the default endpoint for Amazon Managed Workflows for Apache Airflow Mwaa *string `pulumi:"mwaa"` // Override the default endpoint for Amazon Neptune Neptune *string `pulumi:"neptune"` // Override the default endpoint for AWS Network Firewall Networkfirewall *string `pulumi:"networkfirewall"` // Override the default endpoint for AWS Network Manager Networkmanager *string `pulumi:"networkmanager"` // Override the default endpoint for AWS OpsWorks Opsworks *string `pulumi:"opsworks"` // Override the default endpoint for AWS Organizations Organizations *string `pulumi:"organizations"` // Override the default endpoint for AWS Outposts Outposts *string `pulumi:"outposts"` // Override the default endpoint for Amazon Personalize Personalize *string `pulumi:"personalize"` // Override the default endpoint for Amazon Pinpoint Pinpoint *string `pulumi:"pinpoint"` // Override the default endpoint for Amazon Web Services Price List Service Pricing *string `pulumi:"pricing"` // Override the default endpoint for Amazon QLDB Qldb *string `pulumi:"qldb"` // Override the default endpoint for Amazon QuickSight Quicksight *string `pulumi:"quicksight"` // Override the default endpoint for AWS Resource Access Manager Ram *string `pulumi:"ram"` // Override the default endpoint for Amazon Relational Database Service Rds *string `pulumi:"rds"` // Override the default endpoint for Amazon Redshift Redshift *string `pulumi:"redshift"` // Override the default endpoint for AWS Resource Groups Resourcegroups *string `pulumi:"resourcegroups"` // Override the default endpoint for AWS Resource Groups Tagging API Resourcegroupstaggingapi *string `pulumi:"resourcegroupstaggingapi"` // Override the default endpoint for Amazon Route 53 Route53 *string `pulumi:"route53"` // Override the default endpoint for Amazon Route 53 Domains Route53domains *string `pulumi:"route53domains"` // Override the default endpoint for Amazon Route 53 Recovery Control Route53recoverycontrolconfig *string `pulumi:"route53recoverycontrolconfig"` // Override the default endpoint for Amazon Route 53 Recovery Readiness Route53recoveryreadiness *string `pulumi:"route53recoveryreadiness"` // Override the default endpoint for Amazon Route 53 Resolver Route53resolver *string `pulumi:"route53resolver"` // Override the default endpoint for Amazon Simple Storage Service (S3) S3 *string `pulumi:"s3"` // Override the default endpoint for Amazon Simple Storage Service (S3) Control S3control *string `pulumi:"s3control"` // Override the default endpoint for Amazon S3 on Outposts S3outposts *string `pulumi:"s3outposts"` // Override the default endpoint for AWS SageMaker Sagemaker *string `pulumi:"sagemaker"` // Override the default endpoint for Amazon EventBridge Schema Registry Schemas *string `pulumi:"schemas"` // Override the default endpoint for Amazon SimpleDB Sdb *string `pulumi:"sdb"` // Override the default endpoint for AWS Secrets Manager Secretsmanager *string `pulumi:"secretsmanager"` // Override the default endpoint for AWS Security Hub Securityhub *string `pulumi:"securityhub"` // Override the default endpoint for AWS Serverless Application Repository Serverlessrepo *string `pulumi:"serverlessrepo"` // Override the default endpoint for AWS Service Catalog Servicecatalog *string `pulumi:"servicecatalog"` // Override the default endpoint for AWS Cloud Map Servicediscovery *string `pulumi:"servicediscovery"` // Override the default endpoint for AWS Service Quotas Servicequotas *string `pulumi:"servicequotas"` // Override the default endpoint for Amazon Simple Email Service (SES) Ses *string `pulumi:"ses"` // Override the default endpoint for AWS Shield Advanced API Shield *string `pulumi:"shield"` // Override the default endpoint for AWS Signer Signer *string `pulumi:"signer"` // Override the default endpoint for Amazon Simple Notification Service (SNS) Sns *string `pulumi:"sns"` // Override the default endpoint for Amazon Simple Queue Service (SQS) Sqs *string `pulumi:"sqs"` // Override the default endpoint for AWS Systems Manager Ssm *string `pulumi:"ssm"` // Override the default endpoint for AWS Single Sign On (SSO) Ssoadmin *string `pulumi:"ssoadmin"` // Override the default endpoint for AWS Step Functions Stepfunctions *string `pulumi:"stepfunctions"` // Override the default endpoint for AWS Storage Gateway Storagegateway *string `pulumi:"storagegateway"` // Override the default endpoint for AWS Security Token Service (STS) Sts *string `pulumi:"sts"` // Override the default endpoint for Amazon Simple Workflow Service (SWF) Swf *string `pulumi:"swf"` // Override the default endpoint for Amazon CloudWatch Synthetics Synthetics *string `pulumi:"synthetics"` // Override the default endpoint for Amazon Timestream Timestreamwrite *string `pulumi:"timestreamwrite"` // Override the default endpoint for AWS Transfer Family Transfer *string `pulumi:"transfer"` // Override the default endpoint for AWS WAF Classic Waf *string `pulumi:"waf"` // Override the default endpoint for AWS WAF Regional Classic Wafregional *string `pulumi:"wafregional"` // Override the default endpoint for AWS WAF V2 Wafv2 *string `pulumi:"wafv2"` // Override the default endpoint for Amazon WorkLink Worklink *string `pulumi:"worklink"` // Override the default endpoint for Amazon WorkMail Workmail *string `pulumi:"workmail"` // Override the default endpoint for Amazon WorkSpaces Workspaces *string `pulumi:"workspaces"` // Override the default endpoint for AWS X-Ray Xray *string `pulumi:"xray"` }
The configuration for for customizing service endpoints.
type IgnoreTags ¶
type IgnoreTags struct { // List of exact resource tag keys to ignore across all resources handled by this provider. This configuration prevents Pulumi from returning the tag in any `tags` attributes and displaying any configuration difference for the tag value. If any resource configuration still has this tag key configured in the `tags` argument, it will display a perpetual difference until the tag is removed from the argument or `ignoreChanges` is also used. KeyPrefixes []string `pulumi:"keyPrefixes"` // List of resource tag key prefixes to ignore across all resources handled by this provider. This configuration prevents Pulumi from returning any tag key matching the prefixes in any `tags` attributes and displaying any configuration difference for those tag values. If any resource configuration still has a tag matching one of the prefixes configured in the `tags` argument, it will display a perpetual difference until the tag is removed from the argument or `ignoreChanges` is also used. Keys []string `pulumi:"keys"` }
The configuration with resource tag settings to ignore across all resources handled by this provider (except any individual service tag resources such as `ec2.Tag`) for situations where external systems are managing certain resource tags.