ProviderArgs

data class ProviderArgs(val accessKey: Output<String>? = null, val allowedAccountIds: Output<List<String>>? = null, val assumeRole: Output<ProviderAssumeRoleArgs>? = null, val autoNaming: Output<ProviderAutoNamingArgs>? = null, val defaultTags: Output<ProviderDefaultTagsArgs>? = null, val endpoints: Output<List<ProviderEndpointArgs>>? = null, val forbiddenAccountIds: Output<List<String>>? = null, val ignoreTags: Output<ProviderIgnoreTagsArgs>? = null, val insecure: Output<Boolean>? = null, val maxRetries: Output<Int>? = null, val profile: Output<String>? = null, val region: Output<String>? = null, val roleArn: Output<String>? = null, val s3ForcePathStyle: Output<Boolean>? = null, val secretKey: Output<String>? = null, val sharedCredentialsFile: Output<String>? = null, val skipCredentialsValidation: Output<Boolean>? = null, val skipGetEc2Platforms: Output<Boolean>? = null, val skipMetadataApiCheck: Output<Boolean>? = null, val skipRegionValidation: Output<Boolean>? = null, val skipRequestingAccountId: Output<Boolean>? = null, val token: Output<String>? = null) : ConvertibleToJava<ProviderArgs>

The provider type for the AWS Cloud Control 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.

Constructors

Link copied to clipboard
constructor(accessKey: Output<String>? = null, allowedAccountIds: Output<List<String>>? = null, assumeRole: Output<ProviderAssumeRoleArgs>? = null, autoNaming: Output<ProviderAutoNamingArgs>? = null, defaultTags: Output<ProviderDefaultTagsArgs>? = null, endpoints: Output<List<ProviderEndpointArgs>>? = null, forbiddenAccountIds: Output<List<String>>? = null, ignoreTags: Output<ProviderIgnoreTagsArgs>? = null, insecure: Output<Boolean>? = null, maxRetries: Output<Int>? = null, profile: Output<String>? = null, region: Output<String>? = null, roleArn: Output<String>? = null, s3ForcePathStyle: Output<Boolean>? = null, secretKey: Output<String>? = null, sharedCredentialsFile: Output<String>? = null, skipCredentialsValidation: Output<Boolean>? = null, skipGetEc2Platforms: Output<Boolean>? = null, skipMetadataApiCheck: Output<Boolean>? = null, skipRegionValidation: Output<Boolean>? = null, skipRequestingAccountId: Output<Boolean>? = null, token: Output<String>? = null)

Properties

Link copied to clipboard
val accessKey: Output<String>? = null

The access key for API operations. You can retrieve this from the ‘Security & Credentials’ section of the AWS console.

Link copied to clipboard
val allowedAccountIds: Output<List<String>>? = null

List of allowed AWS account IDs to prevent you from mistakenly using an incorrect one. Conflicts with forbiddenAccountIds.

Link copied to clipboard
val assumeRole: Output<ProviderAssumeRoleArgs>? = null

Configuration for retrieving temporary credentials from the STS service.

Link copied to clipboard
val autoNaming: Output<ProviderAutoNamingArgs>? = null

The configuration for automatically naming resources.

Link copied to clipboard

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.

Link copied to clipboard
val endpoints: Output<List<ProviderEndpointArgs>>? = null

Configuration block for customizing service endpoints.

Link copied to clipboard
val forbiddenAccountIds: Output<List<String>>? = null

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.

Link copied to clipboard
val ignoreTags: Output<ProviderIgnoreTagsArgs>? = null

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.

Link copied to clipboard
val insecure: Output<Boolean>? = null

Explicitly allow the provider to perform "insecure" SSL requests. If omitted,default value is false.

Link copied to clipboard
val maxRetries: Output<Int>? = null

The maximum number of times an AWS API request is being executed. If the API request still fails, an error is thrown.

Link copied to clipboard
val profile: Output<String>? = null

The profile for API operations. If not set, the default profile created with aws configure will be used.

Link copied to clipboard
val region: Output<String>? = null

The region where AWS operations will take place. Examples are us-east-1, us-west-2, etc.

Link copied to clipboard
val roleArn: Output<String>? = null

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.

Link copied to clipboard
val s3ForcePathStyle: Output<Boolean>? = null

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.

Link copied to clipboard
val secretKey: Output<String>? = null

The secret key for API operations. You can retrieve this from the 'Security & Credentials' section of the AWS console.

Link copied to clipboard
val sharedCredentialsFile: Output<String>? = null

The path to the shared credentials file. If not set this defaults to ~/.aws/credentials.

Link copied to clipboard
val skipCredentialsValidation: Output<Boolean>? = null

Skip the credentials validation via STS API. Used for AWS API implementations that do not have STS available/implemented.

Link copied to clipboard
val skipGetEc2Platforms: Output<Boolean>? = null

Skip getting the supported EC2 platforms. Used by users that don't have ec2:DescribeAccountAttributes permissions.

Link copied to clipboard
val skipMetadataApiCheck: Output<Boolean>? = null

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.

Link copied to clipboard
val skipRegionValidation: Output<Boolean>? = null

Skip static validation of region name. Used by users of alternative AWS-like APIs or users with access to regions that are not public.

Link copied to clipboard
val skipRequestingAccountId: Output<Boolean>? = null

Skip requesting the account ID. Used for AWS API implementations that do not have IAM/STS API and/or metadata API.

Link copied to clipboard
val token: Output<String>? = null

Session token for validating temporary credentials. Typically provided after successful identity federation or Multi-Factor Authentication (MFA) login. With MFA login, this is the session token provided afterward, not the 6 digit MFA code used to get temporary credentials.

Functions

Link copied to clipboard
open override fun toJava(): ProviderArgs