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, opts=None, access_key=None, allowed_account_ids=None, assume_role=None, endpoints=None, forbidden_account_ids=None, ignore_tags=None, insecure=None, max_retries=None, profile=None, region=None, s3_force_path_style=None, secret_key=None, shared_credentials_file=None, skip_credentials_validation=None, skip_get_ec2_platforms=None, skip_metadata_api_check=None, skip_region_validation=None, skip_requesting_account_id=None, token=None, __props__=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
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.
Region string: The region where AWS operations will take place. Examples are us-east-1, us-west-2, etc.
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
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.
Region string: The region where AWS operations will take place. Examples are us-east-1, us-west-2, etc.
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
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.
region Region: The region where AWS operations will take place. Examples are us-east-1, us-west-2, etc.
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 List[str]
assume_role Dict[ProviderAssumeRole]
endpoints List[ProviderEndpoint]
forbidden_account_ids List[str]
ignore_tags Dict[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
max_retries float: 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.
region str: The region where AWS operations will take place. Examples are us-east-1, us-west-2, etc.
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.