Package com.pulumi.aws

Class Provider

  • public class Provider
extends com.pulumi.resources.ProviderResource
    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](https://www.pulumi.com/docs/reference/programming-model/#providers) for more information.

    • Nested Class Summary

      • Nested classes/interfaces inherited from class com.pulumi.resources.ProviderResource

        com.pulumi.resources.ProviderResource.ProviderResourceInternal

      • Nested classes/interfaces inherited from class com.pulumi.resources.CustomResource

        com.pulumi.resources.CustomResource.CustomResourceInternal

      • Nested classes/interfaces inherited from class com.pulumi.resources.Resource

        com.pulumi.resources.Resource.LazyField<T extends java.lang.Object>, com.pulumi.resources.Resource.LazyFields, com.pulumi.resources.Resource.ResourceInternal

    • Field Summary

      • Fields inherited from class com.pulumi.resources.Resource

        childResources, remote

    • Constructor Summary

      Constructors 
      Constructor Description
      Provider​(java.lang.String name)  
      Provider​(java.lang.String name, ProviderArgs args)  
      Provider​(java.lang.String name, ProviderArgs args, com.pulumi.resources.CustomResourceOptions options)  

    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      com.pulumi.core.Output<java.util.Optional<java.lang.String>> accessKey()  
      com.pulumi.core.Output<java.util.Optional<java.lang.String>> customCaBundle()  
      com.pulumi.core.Output<java.util.Optional<java.lang.String>> ec2MetadataServiceEndpoint()  
      com.pulumi.core.Output<java.util.Optional<java.lang.String>> ec2MetadataServiceEndpointMode()  
      com.pulumi.core.Output<java.util.Optional<java.lang.String>> httpProxy()  
      com.pulumi.core.Output<java.util.Optional<java.lang.String>> httpsProxy()  
      com.pulumi.core.Output<java.util.Optional<java.lang.String>> noProxy()  
      com.pulumi.core.Output<java.util.Optional<java.lang.String>> profile()  
      com.pulumi.core.Output<java.util.Optional<java.lang.String>> region()  
      com.pulumi.core.Output<java.util.Optional<java.lang.String>> retryMode()  
      com.pulumi.core.Output<java.util.Optional<java.lang.String>> s3UsEast1RegionalEndpoint()  
      com.pulumi.core.Output<java.util.Optional<java.lang.String>> secretKey()  
      com.pulumi.core.Output<java.util.Optional<java.lang.String>> stsRegion()  
      com.pulumi.core.Output<java.util.Optional<java.lang.String>> tagPolicyCompliance()  
      com.pulumi.core.Output<java.util.Optional<java.lang.String>> token()  

      • Methods inherited from class com.pulumi.resources.CustomResource

        getId, id, idFuture

      • Methods inherited from class com.pulumi.resources.Resource

        getChildResources, getResourceName, getResourceType, getUrn, pulumiChildResources, pulumiResourceName, pulumiResourceType, urn

      • Methods inherited from class java.lang.Object

        clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

    • Constructor Detail

      • Provider

        public Provider​(java.lang.String name)
        Parameters:
        name - The _unique_ name of the resulting resource.

      • Provider

        public Provider​(java.lang.String name,
                @Nullable
                ProviderArgs args)
        Parameters:
        name - The _unique_ name of the resulting resource.
        args - The arguments to use to populate this resource's properties.

      • Provider

        public Provider​(java.lang.String name,
                @Nullable
                ProviderArgs args,
                @Nullable
                com.pulumi.resources.CustomResourceOptions options)
        Parameters:
        name - The _unique_ name of the resulting resource.
        args - The arguments to use to populate this resource's properties.
        options - A bag of options that control this resource's behavior.

    • Method Detail

      • accessKey

        public com.pulumi.core.Output<java.util.Optional<java.lang.String>> accessKey()
        Returns:
        The access key for API operations. You can retrieve this from the 'Security & Credentials' section of the AWS console.

      • customCaBundle

        public com.pulumi.core.Output<java.util.Optional<java.lang.String>> customCaBundle()
        Returns:
        File containing custom root and intermediate certificates. Can also be configured using the `AWS_CA_BUNDLE` environment variable. (Setting `caBundle` in the shared config file is not supported.)

      • ec2MetadataServiceEndpoint

        public com.pulumi.core.Output<java.util.Optional<java.lang.String>> ec2MetadataServiceEndpoint()
        Returns:
        Address of the EC2 metadata service endpoint to use. Can also be configured using the `AWS_EC2_METADATA_SERVICE_ENDPOINT` environment variable.

      • ec2MetadataServiceEndpointMode

        public com.pulumi.core.Output<java.util.Optional<java.lang.String>> ec2MetadataServiceEndpointMode()
        Returns:
        Protocol to use with EC2 metadata service endpoint.Valid values are `IPv4` and `IPv6`. Can also be configured using the `AWS_EC2_METADATA_SERVICE_ENDPOINT_MODE` environment variable.

      • httpProxy

        public com.pulumi.core.Output<java.util.Optional<java.lang.String>> httpProxy()
        Returns:
        URL of a proxy to use for HTTP requests when accessing the AWS API. Can also be set using the `HTTP_PROXY` or `httpProxy` environment variables.

      • httpsProxy

        public com.pulumi.core.Output<java.util.Optional<java.lang.String>> httpsProxy()
        Returns:
        URL of a proxy to use for HTTPS requests when accessing the AWS API. Can also be set using the `HTTPS_PROXY` or `httpsProxy` environment variables.

      • noProxy

        public com.pulumi.core.Output<java.util.Optional<java.lang.String>> noProxy()
        Returns:
        Comma-separated list of hosts that should not use HTTP or HTTPS proxies. Can also be set using the `NO_PROXY` or `noProxy` environment variables.

      • profile

        public com.pulumi.core.Output<java.util.Optional<java.lang.String>> profile()
        Returns:
        The profile for API operations. If not set, the default profile created with `aws configure` will be used.

      • region

        public com.pulumi.core.Output<java.util.Optional<java.lang.String>> region()
        Returns:
        The region where AWS operations will take place. Examples are us-east-1, us-west-2, etc.

      • retryMode

        public com.pulumi.core.Output<java.util.Optional<java.lang.String>> retryMode()
        Returns:
        Specifies how retries are attempted. Valid values are `standard` and `adaptive`. Can also be configured using the `AWS_RETRY_MODE` environment variable.

      • s3UsEast1RegionalEndpoint

        public com.pulumi.core.Output<java.util.Optional<java.lang.String>> s3UsEast1RegionalEndpoint()
        Returns:
        Specifies whether S3 API calls in the `us-east-1` region use the legacy global endpoint or a regional endpoint. Valid values are `legacy` or `regional`. Can also be configured using the `AWS_S3_US_EAST_1_REGIONAL_ENDPOINT` environment variable or the `s3UsEast1RegionalEndpoint` shared config file parameter

      • secretKey

        public com.pulumi.core.Output<java.util.Optional<java.lang.String>> secretKey()
        Returns:
        The secret key for API operations. You can retrieve this from the 'Security & Credentials' section of the AWS console.

      • stsRegion

        public com.pulumi.core.Output<java.util.Optional<java.lang.String>> stsRegion()
        Returns:
        The region where AWS STS operations will take place. Examples are us-east-1 and us-west-2.

      • tagPolicyCompliance

        public com.pulumi.core.Output<java.util.Optional<java.lang.String>> tagPolicyCompliance()
        Returns:
        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.

      • token

        public com.pulumi.core.Output<java.util.Optional<java.lang.String>> token()
        Returns:
        session token. A session token is only required if you are using temporary security credentials.