PulumiUP: Hear from technical leaders as they present the vision for the future of cloud engineering. Save Your Spot

Provider

The provider type for the aws package. By default, resources use package-wide configuration settings, however an explicit Provider instance may be created and passed during resource construction to achieve fine-grained programmatic control over provider settings. See the documentation for more information.

Create a Provider Resource

new Provider(name: string, args?: ProviderArgs, opts?: CustomResourceOptions);
def Provider(resource_name: str, opts: Optional[ResourceOptions] = None, access_key: Optional[str] = None, allowed_account_ids: Optional[Sequence[str]] = None, assume_role: Optional[ProviderAssumeRoleArgs] = None, default_tags: Optional[ProviderDefaultTagsArgs] = None, endpoints: Optional[Sequence[ProviderEndpointArgs]] = None, forbidden_account_ids: Optional[Sequence[str]] = None, ignore_tags: Optional[ProviderIgnoreTagsArgs] = None, insecure: Optional[bool] = None, max_retries: Optional[int] = None, profile: Optional[str] = None, region: Optional[str] = None, s3_force_path_style: Optional[bool] = None, secret_key: Optional[str] = None, shared_credentials_file: Optional[str] = None, skip_credentials_validation: Optional[bool] = None, skip_get_ec2_platforms: Optional[bool] = None, skip_metadata_api_check: Optional[bool] = None, skip_region_validation: Optional[bool] = None, skip_requesting_account_id: Optional[bool] = None, token: Optional[str] = None)
func NewProvider(ctx *Context, name string, args *ProviderArgs, opts ...ResourceOption) (*Provider, error)
public Provider(string name, ProviderArgs? args = null, CustomResourceOptions? opts = null)
name string
The unique name of the resource.
args ProviderArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
resource_name str
The unique name of the resource.
opts ResourceOptions
A bag of options that control this resource's behavior.
ctx Context
Context object for the current deployment.
name string
The unique name of the resource.
args ProviderArgs
The arguments to resource properties.
opts ResourceOption
Bag of options to control resource's behavior.
name string
The unique name of the resource.
args ProviderArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.

Provider Resource Properties

To learn more about resource properties and how to use them, see Inputs and Outputs in the Programming Model docs.

Inputs

The Provider resource accepts the following input properties:

AccessKey string
The access key for API operations. You can retrieve this from the ‘Security & Credentials’ section of the AWS console.
AllowedAccountIds List<string>
AssumeRole ProviderAssumeRoleArgs
DefaultTags ProviderDefaultTagsArgs
Configuration block with settings to default resource tags across all resources.
Endpoints List<ProviderEndpointArgs>
ForbiddenAccountIds List<string>
IgnoreTags ProviderIgnoreTagsArgs
Configuration block with settings to ignore resource tags across all resources.
Insecure bool
Explicitly allow the provider to perform “insecure” SSL requests. If omitted,default value is false
MaxRetries int
The maximum number of times an AWS API request is being executed. If the API request still fails, an error is thrown.
Profile string
The profile for API operations. If not set, the default profile created with aws configure will be used. It can also be sourced from the following environment variable: AWS_PROFILE
Region string
The region where AWS operations will take place. Examples are us-east-1, us-west-2, etc. It can also be sourced from the following environment variables: AWS_REGION, AWS_DEFAULT_REGION
S3ForcePathStyle bool
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.
SecretKey string
The secret key for API operations. You can retrieve this from the ‘Security & Credentials’ section of the AWS console.
SharedCredentialsFile string
The path to the shared credentials file. If not set this defaults to ~/.aws/credentials.
SkipCredentialsValidation bool
Skip the credentials validation via STS API. Used for AWS API implementations that do not have STS available/implemented.
SkipGetEc2Platforms bool
Skip getting the supported EC2 platforms. Used by users that don’t have ec2:DescribeAccountAttributes permissions.
SkipMetadataApiCheck bool
SkipRegionValidation bool
Skip static validation of region name. Used by users of alternative AWS-like APIs or users w/ access to regions that are not public (yet).
SkipRequestingAccountId bool
Skip requesting the account ID. Used for AWS API implementations that do not have IAM/STS API and/or metadata API.
Token string
session token. A session token is only required if you are using temporary security credentials.
AccessKey string
The access key for API operations. You can retrieve this from the ‘Security & Credentials’ section of the AWS console.
AllowedAccountIds []string
AssumeRole ProviderAssumeRole
DefaultTags ProviderDefaultTags
Configuration block with settings to default resource tags across all resources.
Endpoints []ProviderEndpoint
ForbiddenAccountIds []string
IgnoreTags ProviderIgnoreTags
Configuration block with settings to ignore resource tags across all resources.
Insecure bool
Explicitly allow the provider to perform “insecure” SSL requests. If omitted,default value is false
MaxRetries int
The maximum number of times an AWS API request is being executed. If the API request still fails, an error is thrown.
Profile string
The profile for API operations. If not set, the default profile created with aws configure will be used. It can also be sourced from the following environment variable: AWS_PROFILE
Region string
The region where AWS operations will take place. Examples are us-east-1, us-west-2, etc. It can also be sourced from the following environment variables: AWS_REGION, AWS_DEFAULT_REGION
S3ForcePathStyle bool
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.
SecretKey string
The secret key for API operations. You can retrieve this from the ‘Security & Credentials’ section of the AWS console.
SharedCredentialsFile string
The path to the shared credentials file. If not set this defaults to ~/.aws/credentials.
SkipCredentialsValidation bool
Skip the credentials validation via STS API. Used for AWS API implementations that do not have STS available/implemented.
SkipGetEc2Platforms bool
Skip getting the supported EC2 platforms. Used by users that don’t have ec2:DescribeAccountAttributes permissions.
SkipMetadataApiCheck bool
SkipRegionValidation bool
Skip static validation of region name. Used by users of alternative AWS-like APIs or users w/ access to regions that are not public (yet).
SkipRequestingAccountId bool
Skip requesting the account ID. Used for AWS API implementations that do not have IAM/STS API and/or metadata API.
Token string
session token. A session token is only required if you are using temporary security credentials.
accessKey string
The access key for API operations. You can retrieve this from the ‘Security & Credentials’ section of the AWS console.
allowedAccountIds string[]
assumeRole ProviderAssumeRole
defaultTags ProviderDefaultTags
Configuration block with settings to default resource tags across all resources.
endpoints ProviderEndpoint[]
forbiddenAccountIds string[]
ignoreTags ProviderIgnoreTags
Configuration block with settings to ignore resource tags across all resources.
insecure boolean
Explicitly allow the provider to perform “insecure” SSL requests. If omitted,default value is false
maxRetries number
The maximum number of times an AWS API request is being executed. If the API request still fails, an error is thrown.
profile string
The profile for API operations. If not set, the default profile created with aws configure will be used. It can also be sourced from the following environment variable: AWS_PROFILE
region Region
The region where AWS operations will take place. Examples are us-east-1, us-west-2, etc. It can also be sourced from the following environment variables: AWS_REGION, AWS_DEFAULT_REGION
s3ForcePathStyle boolean
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.
secretKey string
The secret key for API operations. You can retrieve this from the ‘Security & Credentials’ section of the AWS console.
sharedCredentialsFile string
The path to the shared credentials file. If not set this defaults to ~/.aws/credentials.
skipCredentialsValidation boolean
Skip the credentials validation via STS API. Used for AWS API implementations that do not have STS available/implemented.
skipGetEc2Platforms boolean
Skip getting the supported EC2 platforms. Used by users that don’t have ec2:DescribeAccountAttributes permissions.
skipMetadataApiCheck boolean
skipRegionValidation boolean
Skip static validation of region name. Used by users of alternative AWS-like APIs or users w/ access to regions that are not public (yet).
skipRequestingAccountId boolean
Skip requesting the account ID. Used for AWS API implementations that do not have IAM/STS API and/or metadata API.
token string
session token. A session token is only required if you are using temporary security credentials.
access_key str
The access key for API operations. You can retrieve this from the ‘Security & Credentials’ section of the AWS console.
allowed_account_ids Sequence[str]
assume_role ProviderAssumeRoleArgs
default_tags ProviderDefaultTagsArgs
Configuration block with settings to default resource tags across all resources.
endpoints Sequence[ProviderEndpointArgs]
forbidden_account_ids Sequence[str]
ignore_tags ProviderIgnoreTagsArgs
Configuration block with settings to ignore resource tags across all resources.
insecure bool
Explicitly allow the provider to perform “insecure” SSL requests. If omitted,default value is false
max_retries int
The maximum number of times an AWS API request is being executed. If the API request still fails, an error is thrown.
profile str
The profile for API operations. If not set, the default profile created with aws configure will be used. It can also be sourced from the following environment variable: AWS_PROFILE
region str
The region where AWS operations will take place. Examples are us-east-1, us-west-2, etc. It can also be sourced from the following environment variables: AWS_REGION, AWS_DEFAULT_REGION
s3_force_path_style bool
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.
secret_key str
The secret key for API operations. You can retrieve this from the ‘Security & Credentials’ section of the AWS console.
shared_credentials_file str
The path to the shared credentials file. If not set this defaults to ~/.aws/credentials.
skip_credentials_validation bool
Skip the credentials validation via STS API. Used for AWS API implementations that do not have STS available/implemented.
skip_get_ec2_platforms bool
Skip getting the supported EC2 platforms. Used by users that don’t have ec2:DescribeAccountAttributes permissions.
skip_metadata_api_check bool
skip_region_validation bool
Skip static validation of region name. Used by users of alternative AWS-like APIs or users w/ access to regions that are not public (yet).
skip_requesting_account_id bool
Skip requesting the account ID. Used for AWS API implementations that do not have IAM/STS API and/or metadata API.
token str
session token. A session token is only required if you are using temporary security credentials.

Outputs

All input properties are implicitly available as output properties. Additionally, the Provider resource produces the following output properties:

Id string
The provider-assigned unique ID for this managed resource.
Id string
The provider-assigned unique ID for this managed resource.
id string
The provider-assigned unique ID for this managed resource.
id str
The provider-assigned unique ID for this managed resource.

Supporting Types

ProviderAssumeRole

DurationSeconds int
ExternalId string
Policy string
PolicyArns List<string>
RoleArn string
SessionName string
Tags Dictionary<string, string>
TransitiveTagKeys List<string>
DurationSeconds int
ExternalId string
Policy string
PolicyArns []string
RoleArn string
SessionName string
Tags map[string]string
TransitiveTagKeys []string
durationSeconds number
externalId string
policy string
policyArns string[]
roleArn string
sessionName string
tags {[key: string]: string}
transitiveTagKeys string[]
duration_seconds int
external_id str
policy str
policy_arns Sequence[str]
role_arn str
session_name str
tags Mapping[str, str]
transitive_tag_keys Sequence[str]

ProviderDefaultTags

Tags Dictionary<string, string>
Tags map[string]string
tags {[key: string]: string}
tags Mapping[str, str]

ProviderEndpoint

Accessanalyzer string
Acm string
Acmpca string
Amplify string
Apigateway string
Applicationautoscaling string
Applicationinsights string
Appmesh string
Appstream string
Appsync string
Athena string
Auditmanager string
Autoscaling string
Autoscalingplans string
Backup string
Batch string
Budgets string
Cloud9 string
Cloudformation string
Cloudfront string
Cloudhsm string
Cloudsearch string
Cloudtrail string
Cloudwatch string
Cloudwatchevents string
Cloudwatchlogs string
Codeartifact string
Codebuild string
Codecommit string
Codedeploy string
Codepipeline string
Codestarconnections string
Cognitoidentity string
Cognitoidp string
Configservice string
Connect string
Cur string
Dataexchange string
Datapipeline string
Datasync string
Dax string
Devicefarm string
Directconnect string
Dlm string
Dms string
Docdb string
Ds string
Dynamodb string
Ec2 string
Ecr string
Ecrpublic string
Ecs string
Efs string
Eks string
Elasticache string
Elasticbeanstalk string
Elastictranscoder string
Elb string
Emr string
Emrcontainers string
Es string
Firehose string
Fms string
Forecast string
Fsx string
Gamelift string
Glacier string
Globalaccelerator string
Glue string
Greengrass string
Guardduty string
Iam string
Identitystore string
Imagebuilder string
Inspector string
Iot string
Iotanalytics string
Iotevents string
Kafka string
Kinesis string
Kinesisanalytics string
Kinesisanalyticsv2 string
Kinesisvideo string
Kms string
Lakeformation string
Lambda string
Lexmodels string
Licensemanager string
Lightsail string
Macie string
Macie2 string
Managedblockchain string
Marketplacecatalog string
Mediaconnect string
Mediaconvert string
Medialive string
Mediapackage string
Mediastore string
Mediastoredata string
Mq string
Mwaa string
Neptune string
Networkfirewall string
Networkmanager string
Opsworks string
Organizations string
Outposts string
Personalize string
Pinpoint string
Pricing string
Qldb string
Quicksight string
Ram string
Rds string
Redshift string
Resourcegroups string
Resourcegroupstaggingapi string
Route53 string
Route53domains string
Route53resolver string
S3 string
S3control string
S3outposts string
Sagemaker string
Sdb string
Secretsmanager string
Securityhub string
Serverlessrepo string
Servicecatalog string
Servicediscovery string
Servicequotas string
Ses string
Shield string
Signer string
Sns string
Sqs string
Ssm string
Ssoadmin string
Stepfunctions string
Storagegateway string
Sts string
Swf string
Synthetics string
Timestreamwrite string
Transfer string
Waf string
Wafregional string
Wafv2 string
Worklink string
Workmail string
Workspaces string
Xray string
Accessanalyzer string
Acm string
Acmpca string
Amplify string
Apigateway string
Applicationautoscaling string
Applicationinsights string
Appmesh string
Appstream string
Appsync string
Athena string
Auditmanager string
Autoscaling string
Autoscalingplans string
Backup string
Batch string
Budgets string
Cloud9 string
Cloudformation string
Cloudfront string
Cloudhsm string
Cloudsearch string
Cloudtrail string
Cloudwatch string
Cloudwatchevents string
Cloudwatchlogs string
Codeartifact string
Codebuild string
Codecommit string
Codedeploy string
Codepipeline string
Codestarconnections string
Cognitoidentity string
Cognitoidp string
Configservice string
Connect string
Cur string
Dataexchange string
Datapipeline string
Datasync string
Dax string
Devicefarm string
Directconnect string
Dlm string
Dms string
Docdb string
Ds string
Dynamodb string
Ec2 string
Ecr string
Ecrpublic string
Ecs string
Efs string
Eks string
Elasticache string
Elasticbeanstalk string
Elastictranscoder string
Elb string
Emr string
Emrcontainers string
Es string
Firehose string
Fms string
Forecast string
Fsx string
Gamelift string
Glacier string
Globalaccelerator string
Glue string
Greengrass string
Guardduty string
Iam string
Identitystore string
Imagebuilder string
Inspector string
Iot string
Iotanalytics string
Iotevents string
Kafka string
Kinesis string
Kinesisanalytics string
Kinesisanalyticsv2 string
Kinesisvideo string
Kms string
Lakeformation string
Lambda string
Lexmodels string
Licensemanager string
Lightsail string
Macie string
Macie2 string
Managedblockchain string
Marketplacecatalog string
Mediaconnect string
Mediaconvert string
Medialive string
Mediapackage string
Mediastore string
Mediastoredata string
Mq string
Mwaa string
Neptune string
Networkfirewall string
Networkmanager string
Opsworks string
Organizations string
Outposts string
Personalize string
Pinpoint string
Pricing string
Qldb string
Quicksight string
Ram string
Rds string
Redshift string
Resourcegroups string
Resourcegroupstaggingapi string
Route53 string
Route53domains string
Route53resolver string
S3 string
S3control string
S3outposts string
Sagemaker string
Sdb string
Secretsmanager string
Securityhub string
Serverlessrepo string
Servicecatalog string
Servicediscovery string
Servicequotas string
Ses string
Shield string
Signer string
Sns string
Sqs string
Ssm string
Ssoadmin string
Stepfunctions string
Storagegateway string
Sts string
Swf string
Synthetics string
Timestreamwrite string
Transfer string
Waf string
Wafregional string
Wafv2 string
Worklink string
Workmail string
Workspaces string
Xray string
accessanalyzer string
acm string
acmpca string
amplify string
apigateway string
applicationautoscaling string
applicationinsights string
appmesh string
appstream string
appsync string
athena string
auditmanager string
autoscaling string
autoscalingplans string
backup string
batch string
budgets string
cloud9 string
cloudformation string
cloudfront string
cloudhsm string
cloudsearch string
cloudtrail string
cloudwatch string
cloudwatchevents string
cloudwatchlogs string
codeartifact string
codebuild string
codecommit string
codedeploy string
codepipeline string
codestarconnections string
cognitoidentity string
cognitoidp string
configservice string
connect string
cur string
dataexchange string
datapipeline string
datasync string
dax string
devicefarm string
directconnect string
dlm string
dms string
docdb string
ds string
dynamodb string
ec2 string
ecr string
ecrpublic string
ecs string
efs string
eks string
elasticache string
elasticbeanstalk string
elastictranscoder string
elb string
emr string
emrcontainers string
es string
firehose string
fms string
forecast string
fsx string
gamelift string
glacier string
globalaccelerator string
glue string
greengrass string
guardduty string
iam string
identitystore string
imagebuilder string
inspector string
iot string
iotanalytics string
iotevents string
kafka string
kinesis string
kinesisanalytics string
kinesisanalyticsv2 string
kinesisvideo string
kms string
lakeformation string
lambda string
lexmodels string
licensemanager string
lightsail string
macie string
macie2 string
managedblockchain string
marketplacecatalog string
mediaconnect string
mediaconvert string
medialive string
mediapackage string
mediastore string
mediastoredata string
mq string
mwaa string
neptune string
networkfirewall string
networkmanager string
opsworks string
organizations string
outposts string
personalize string
pinpoint string
pricing string
qldb string
quicksight string
ram string
rds string
redshift string
resourcegroups string
resourcegroupstaggingapi string
route53 string
route53domains string
route53resolver string
s3 string
s3control string
s3outposts string
sagemaker string
sdb string
secretsmanager string
securityhub string
serverlessrepo string
servicecatalog string
servicediscovery string
servicequotas string
ses string
shield string
signer string
sns string
sqs string
ssm string
ssoadmin string
stepfunctions string
storagegateway string
sts string
swf string
synthetics string
timestreamwrite string
transfer string
waf string
wafregional string
wafv2 string
worklink string
workmail string
workspaces string
xray string
accessanalyzer str
acm str
acmpca str
amplify str
apigateway str
applicationautoscaling str
applicationinsights str
appmesh str
appstream str
appsync str
athena str
auditmanager str
autoscaling str
autoscalingplans str
backup str
batch str
budgets str
cloud9 str
cloudformation str
cloudfront str
cloudhsm str
cloudsearch str
cloudtrail str
cloudwatch str
cloudwatchevents str
cloudwatchlogs str
codeartifact str
codebuild str
codecommit str
codedeploy str
codepipeline str
codestarconnections str
cognitoidentity str
cognitoidp str
configservice str
connect str
cur str
dataexchange str
datapipeline str
datasync str
dax str
devicefarm str
directconnect str
dlm str
dms str
docdb str
ds str
dynamodb str
ec2 str
ecr str
ecrpublic str
ecs str
efs str
eks str
elasticache str
elasticbeanstalk str
elastictranscoder str
elb str
emr str
emrcontainers str
es str
firehose str
fms str
forecast str
fsx str
gamelift str
glacier str
globalaccelerator str
glue str
greengrass str
guardduty str
iam str
identitystore str
imagebuilder str
inspector str
iot str
iotanalytics str
iotevents str
kafka str
kinesis str
kinesisanalytics str
kinesisanalyticsv2 str
kinesisvideo str
kms str
lakeformation str
lambda_ str
lexmodels str
licensemanager str
lightsail str
macie str
macie2 str
managedblockchain str
marketplacecatalog str
mediaconnect str
mediaconvert str
medialive str
mediapackage str
mediastore str
mediastoredata str
mq str
mwaa str
neptune str
networkfirewall str
networkmanager str
opsworks str
organizations str
outposts str
personalize str
pinpoint str
pricing str
qldb str
quicksight str
ram str
rds str
redshift str
resourcegroups str
resourcegroupstaggingapi str
route53 str
route53domains str
route53resolver str
s3 str
s3control str
s3outposts str
sagemaker str
sdb str
secretsmanager str
securityhub str
serverlessrepo str
servicecatalog str
servicediscovery str
servicequotas str
ses str
shield str
signer str
sns str
sqs str
ssm str
ssoadmin str
stepfunctions str
storagegateway str
sts str
swf str
synthetics str
timestreamwrite str
transfer str
waf str
wafregional str
wafv2 str
worklink str
workmail str
workspaces str
xray str

ProviderIgnoreTags

KeyPrefixes List<string>
Keys List<string>
KeyPrefixes []string
Keys []string
keyPrefixes string[]
keys string[]
key_prefixes Sequence[str]
keys Sequence[str]

Package Details

Repository
https://github.com/pulumi/pulumi-aws
License
Apache-2.0
Notes
This Pulumi package is based on the aws Terraform Provider.