java.lang.Object
- com.pulumi.resources.Resource
- - com.pulumi.resources.CustomResource
  - - com.pulumi.aws.cloudfront.OriginAccessIdentity

public class OriginAccessIdentity
extends com.pulumi.resources.CustomResource

Creates an Amazon CloudFront origin access identity. For information about CloudFront distributions, see the [Amazon CloudFront Developer Guide](http://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/Introduction.html). For more information on generating origin access identities, see [Using an Origin Access Identity to Restrict Access to Your Amazon S3 Content](http://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/private-content-restricting-access-to-s3.html). ## Example Usage The following example below creates a CloudFront origin access identity.

 
 package generated_program;
 
 import com.pulumi.Context;
 import com.pulumi.Pulumi;
 import com.pulumi.core.Output;
 import com.pulumi.aws.cloudfront.OriginAccessIdentity;
 import com.pulumi.aws.cloudfront.OriginAccessIdentityArgs;
 import java.util.ArrayList;
 import java.util.Arrays;
 import java.util.Map;
 import java.io.File;
 import java.nio.file.Files;
 import java.nio.file.Paths;
 
 public class App {
     public static void main(String[] args) {
         Pulumi.run(App::stack);
     }
 
     public static void stack(Context ctx) {
         var example = new OriginAccessIdentity("example", OriginAccessIdentityArgs.builder()
             .comment("Some comment")
             .build());
 
     }
 }

### Using With CloudFront Normally, when referencing an origin access identity in CloudFront, you need to prefix the ID with the `origin-access-identity/cloudfront/` special path. The `cloudfrontAccessIdentityPath` allows this to be circumvented. The below snippet demonstrates use with the `s3OriginConfig` structure for the `aws.cloudfront.Distribution` resource:

 
 package generated_program;
 
 import com.pulumi.Context;
 import com.pulumi.Pulumi;
 import com.pulumi.core.Output;
 import com.pulumi.aws.cloudfront.Distribution;
 import com.pulumi.aws.cloudfront.DistributionArgs;
 import com.pulumi.aws.cloudfront.inputs.DistributionOriginArgs;
 import com.pulumi.aws.cloudfront.inputs.DistributionOriginS3OriginConfigArgs;
 import java.util.ArrayList;
 import java.util.Arrays;
 import java.util.Map;
 import java.io.File;
 import java.nio.file.Files;
 import java.nio.file.Paths;
 
 public class App {
     public static void main(String[] args) {
         Pulumi.run(App::stack);
     }
 
     public static void stack(Context ctx) {
         var example = new Distribution("example", DistributionArgs.builder()
             .origins(DistributionOriginArgs.builder()
                 .s3OriginConfig(DistributionOriginS3OriginConfigArgs.builder()
                     .originAccessIdentity(exampleAwsCloudfrontOriginAccessIdentity.cloudfrontAccessIdentityPath())
                     .build())
                 .build())
             .build());
 
     }
 }

### Updating your bucket policy Note that the AWS API may translate the `s3CanonicalUserId` `CanonicalUser` principal into an `AWS` IAM ARN principal when supplied in an `aws.s3.Bucket` bucket policy, causing spurious diffs in Pulumi. If you see this behavior, use the `iamArn` instead:

 
 package generated_program;
 
 import com.pulumi.Context;
 import com.pulumi.Pulumi;
 import com.pulumi.core.Output;
 import com.pulumi.aws.iam.IamFunctions;
 import com.pulumi.aws.iam.inputs.GetPolicyDocumentArgs;
 import com.pulumi.aws.iam.inputs.GetPolicyDocumentStatementArgs;
 import com.pulumi.aws.iam.inputs.GetPolicyDocumentStatementPrincipalArgs;
 import com.pulumi.aws.s3.BucketPolicy;
 import com.pulumi.aws.s3.BucketPolicyArgs;
 import java.util.ArrayList;
 import java.util.Arrays;
 import java.util.Map;
 import java.io.File;
 import java.nio.file.Files;
 import java.nio.file.Paths;
 
 public class App {
     public static void main(String[] args) {
         Pulumi.run(App::stack);
     }
 
     public static void stack(Context ctx) {
         final var s3Policy = IamFunctions.getPolicyDocument(GetPolicyDocumentArgs.builder()
             .statements(GetPolicyDocumentStatementArgs.builder()
                 .principals(GetPolicyDocumentStatementPrincipalArgs.builder()
                     .type("AWS")
                     .identifiers(exampleAwsCloudfrontOriginAccessIdentity.iamArn())
                     .build())
                 .actions("s3:GetObject")
                 .resources(String.format("%s/*", exampleAwsS3Bucket.arn()))
                 .build())
             .build());
 
         var example = new BucketPolicy("example", BucketPolicyArgs.builder()
             .bucket(exampleAwsS3Bucket.id())
             .policy(s3Policy.json())
             .build());
 
     }
 }

## Import Using `pulumi import`, import CloudFront Origin Access Identities using the `id`. For example: ```sh $ pulumi import aws:cloudfront/originAccessIdentity:OriginAccessIdentity origin_access E74FTE3AEXAMPLE ```

Nested Class Summary
- 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
`OriginAccessIdentity(java.lang.String name)`
`OriginAccessIdentity(java.lang.String name, OriginAccessIdentityArgs args)`
`OriginAccessIdentity(java.lang.String name, OriginAccessIdentityArgs args, com.pulumi.resources.CustomResourceOptions options)`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`com.pulumi.core.Output<java.lang.String>`	`arn()`
`com.pulumi.core.Output<java.lang.String>`	`callerReference()`
`com.pulumi.core.Output<java.lang.String>`	`cloudfrontAccessIdentityPath()`
`com.pulumi.core.Output<java.util.Optional<java.lang.String>>`	`comment()`
`com.pulumi.core.Output<java.lang.String>`	`etag()`
`static OriginAccessIdentity`	`get(java.lang.String name, com.pulumi.core.Output<java.lang.String> id, OriginAccessIdentityState state, com.pulumi.resources.CustomResourceOptions options)`	Get an existing Host resource's state with the given name, ID, and optional extra properties used to qualify the lookup.
`com.pulumi.core.Output<java.lang.String>`	`iamArn()`
`com.pulumi.core.Output<java.lang.String>`	`s3CanonicalUserId()`

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
  - OriginAccessIdentity
```
public OriginAccessIdentity(java.lang.String name)
```
    Parameters:
    
    name - The _unique_ name of the resulting resource.
  - OriginAccessIdentity
```
public OriginAccessIdentity(java.lang.String name,
                            @Nullable
                            OriginAccessIdentityArgs args)
```
    Parameters:
    
    name - The _unique_ name of the resulting resource.
    
    args - The arguments to use to populate this resource's properties.
  - OriginAccessIdentity
```
public OriginAccessIdentity(java.lang.String name,
                            @Nullable
                            OriginAccessIdentityArgs 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
  - arn
```
public com.pulumi.core.Output<java.lang.String> arn()
```
    Returns:
    
    The origin access identity ARN.
  - callerReference
```
public com.pulumi.core.Output<java.lang.String> callerReference()
```
    Returns:
    
    Internal value used by CloudFront to allow future updates to the origin access identity.
  - cloudfrontAccessIdentityPath
```
public com.pulumi.core.Output<java.lang.String> cloudfrontAccessIdentityPath()
```
    Returns:
    
    A shortcut to the full path for the origin access identity to use in CloudFront, see below.
  - comment
```
public com.pulumi.core.Output<java.util.Optional<java.lang.String>> comment()
```
    Returns:
    
    An optional comment for the origin access identity.
  - etag
```
public com.pulumi.core.Output<java.lang.String> etag()
```
    Returns:
    
    The current version of the origin access identity's information. For example: `E2QWRUHAPOMQZL`.
  - iamArn
```
public com.pulumi.core.Output<java.lang.String> iamArn()
```
    Returns:
    
    A pre-generated ARN for use in S3 bucket policies (see below). Example: `arn:aws:iam::cloudfront:user/CloudFront Origin Access Identity E2QWRUHAPOMQZL`.
  - s3CanonicalUserId
```
public com.pulumi.core.Output<java.lang.String> s3CanonicalUserId()
```
    Returns:
    
    The Amazon S3 canonical user ID for the origin access identity, which you use when giving the origin access identity read permission to an object in Amazon S3.
  - get
```
public static OriginAccessIdentity get(java.lang.String name,
                                       com.pulumi.core.Output<java.lang.String> id,
                                       @Nullable
                                       OriginAccessIdentityState state,
                                       @Nullable
                                       com.pulumi.resources.CustomResourceOptions options)
```
    Get an existing Host resource's state with the given name, ID, and optional extra properties used to qualify the lookup.
    
    Parameters:
    
    name - The _unique_ name of the resulting resource.
    
    id - The _unique_ provider ID of the resource to lookup.
    
    state -
    
    options - Optional settings to control the behavior of the CustomResource.

Class OriginAccessIdentity

Nested Class Summary

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

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

Field Summary

Fields inherited from class com.pulumi.resources.Resource

Constructor Summary

Method Summary

Methods inherited from class com.pulumi.resources.CustomResource

Methods inherited from class com.pulumi.resources.Resource

Methods inherited from class java.lang.Object

Constructor Detail

OriginAccessIdentity

OriginAccessIdentity

OriginAccessIdentity

Method Detail

arn

callerReference

cloudfrontAccessIdentityPath

comment

etag

iamArn

s3CanonicalUserId

get