ProviderProvider class
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.
Constructors
- ProviderProvider(String name, {ProviderArgs? args, CustomResourceOptions? options})
-
Creates a new ProviderProvider.
nameThe Pulumi resource name.argsArguments used to configure this ProviderProvider. The set of arguments for Provider.optionsResource options controlling this resource's behavior.
Properties
-
accessKey
↔ Output<
String?> -
The access key for API operations. You can retrieve this
from the 'Security & Credentials' section of the AWS console.
latefinal
-
childResources
→ Set<
Resource> -
finalinherited
-
completionSources
↔ Map<
String, IOutputCompletionSource> -
latefinalinherited
-
customCaBundle
↔ Output<
String?> -
File containing custom root and intermediate certificates. Can also be configured using the
AWS_CA_BUNDLEenvironment variable. (SettingcaBundlein the shared config file is not supported.)latefinal -
ec2MetadataServiceEndpoint
↔ Output<
String?> -
Address of the EC2 metadata service endpoint to use. Can also be configured using the
AWS_EC2_METADATA_SERVICE_ENDPOINTenvironment variable.latefinal -
ec2MetadataServiceEndpointMode
↔ Output<
String?> -
Protocol to use with EC2 metadata service endpoint.Valid values are
IPv4andIPv6. Can also be configured using theAWS_EC2_METADATA_SERVICE_ENDPOINT_MODEenvironment variable.latefinal - hashCode → int
-
The hash code for this object.
no setterinherited
-
httpProxy
↔ Output<
String?> -
URL of a proxy to use for HTTP requests when accessing the AWS API. Can also be set using the
HTTP_PROXYorhttpProxyenvironment variables.latefinal -
httpsProxy
↔ Output<
String?> -
URL of a proxy to use for HTTPS requests when accessing the AWS API. Can also be set using the
HTTPS_PROXYorhttpsProxyenvironment variables.latefinal -
id
↔ Output<
String> -
getter/setter pairinherited
- isCustom → bool
-
Returns whether this resource is provider-managed.
no setterinherited
- isProtected → bool
-
Returns whether this resource is protected from deletion.
no setterinherited
- isRemote → bool
-
Whether this resource is registered as remote.
no setterinherited
- isResourceReference → bool
-
Whether this instance represents a resource value returned over RPC.
finalinherited
-
noProxy
↔ Output<
String?> -
Comma-separated list of hosts that should not use HTTP or HTTPS proxies. Can also be set using the
NO_PROXYornoProxyenvironment variables.latefinal - package → String
-
finalinherited
-
profile
↔ Output<
String?> -
The profile for API operations. If not set, the default profile
created with
aws configurewill be used.latefinal -
region
↔ Output<
String?> -
The region where AWS operations will take place. Examples
are us-east-1, us-west-2, etc.
latefinal
- registrationId ↔ String?
-
getter/setter pairinherited
-
resourceTransforms
→ List<
ResourceTransform> -
Inherited/explicit async transforms.
no setterinherited
-
retryMode
↔ Output<
String?> -
Specifies how retries are attempted. Valid values are
standardandadaptive. Can also be configured using theAWS_RETRY_MODEenvironment variable.latefinal - runtimeType → Type
-
A representation of the runtime type of the object.
no setterinherited
-
s3UsEast1RegionalEndpoint
↔ Output<
String?> -
Specifies whether S3 API calls in the
us-east-1region use the legacy global endpoint or a regional endpoint. Valid values arelegacyorregional. Can also be configured using theAWS_S3_US_EAST_1_REGIONAL_ENDPOINTenvironment variable or thes3UsEast1RegionalEndpointshared config file parameterlatefinal -
secretKey
↔ Output<
String?> -
The secret key for API operations. You can retrieve this
from the 'Security & Credentials' section of the AWS console.
latefinal
-
stsRegion
↔ Output<
String?> -
The region where AWS STS operations will take place. Examples
are us-east-1 and us-west-2.
latefinal
-
tagPolicyCompliance
↔ Output<
String?> -
The severity with which to enforce organizational tagging policies on resources managed by this provider instance. At this time this only includes compliance with required tag keys by resource type. Valid values are "error", "warning", and "disabled". When unset or "disabled", tag policy compliance will not be enforced by the provider. Can also be configured with the TF_AWS_TAG_POLICY_COMPLIANCE environment variable.
latefinal
-
token
↔ Output<
String?> -
session token. A session token is only required if you are
using temporary security credentials.
latefinal
-
transformations
→ List<
ResourceTransformation> -
Inherited/explicit legacy transformations.
no setterinherited
-
urn
↔ Output<
String> -
latefinalinherited
Methods
-
failId(
Object error) → void -
Completes this resource ID with an error when registration fails.
inherited
-
failOutputs(
Object error) → void -
Completes all output properties with
error.inherited -
failUrn(
Object error) → void -
Completes this resource URN with an error when registration fails.
inherited
-
getProvider(
String moduleMember) → ProviderResource? -
Returns provider for
moduleMember's package, if configured.inherited -
getResourceName(
) → String -
Returns this resource's logical name.
inherited
-
getResourceType(
) → String -
Returns this resource's Pulumi type token.
inherited
-
noSuchMethod(
Invocation invocation) → dynamic -
Invoked when a nonexistent method or property is accessed.
inherited
-
registerOutput<
T> (String propertyName, {Object? decoder(Object?)?, bool isSecret = false}) → Output< T> -
Registers a dynamic output property for this resource.
inherited
-
resolveId(
String? value, {required bool isKnown}) → void -
Resolves the provider-assigned ID for this resource.
inherited
-
resolveOutputs(
Struct outputs) → void -
Resolves all output properties from a monitor response payload.
inherited
-
resolveUrn(
String value) → void -
Resolves this resource's URN once assigned by the engine.
inherited
-
serializeProperties(
Map< String, dynamic> properties) → Future<Struct> -
Serializes resource properties for RPC transmission.
inherited
-
terraformConfig(
) → Future< ProviderTerraformConfigResult> - This function returns a Terraform config object with terraform-namecased keys,to be used with the Terraform Module Provider.
-
toString(
) → String -
A string representation of this object.
inherited
Operators
-
operator ==(
Object other) → bool -
The equality operator.
inherited