Package com.pulumi.aws.cloudfront

Class OriginAccessControl

  • public class OriginAccessControl
extends com.pulumi.resources.CustomResource
    Manages an AWS CloudFront Origin Access Control, which is used by CloudFront Distributions with an Amazon S3 bucket as the origin. Read more about Origin Access Control in the [CloudFront Developer Guide](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/private-content-restricting-access-to-s3.html). ## Example Usage ### Basic Usage 
     
 package generated_program;
 
 import com.pulumi.Context;
 import com.pulumi.Pulumi;
 import com.pulumi.core.Output;
 import com.pulumi.aws.cloudfront.OriginAccessControl;
 import com.pulumi.aws.cloudfront.OriginAccessControlArgs;
 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 OriginAccessControl("example", OriginAccessControlArgs.builder()
             .name("example")
             .description("Example Policy")
             .originAccessControlOriginType("s3")
             .signingBehavior("always")
             .signingProtocol("sigv4")
             .build());
 
     }
 }
    ## Import Using `pulumi import`, import CloudFront Origin Access Control using the `id`. For example: ```sh $ pulumi import aws:cloudfront/originAccessControl:OriginAccessControl example E327GJI25M56DG ```

    • 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

    • 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.util.Optional<java.lang.String>> description()  
      com.pulumi.core.Output<java.lang.String> etag()  
      static OriginAccessControl get​(java.lang.String name, com.pulumi.core.Output<java.lang.String> id, OriginAccessControlState 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> name()  
      com.pulumi.core.Output<java.lang.String> originAccessControlOriginType()  
      com.pulumi.core.Output<java.lang.String> signingBehavior()  
      com.pulumi.core.Output<java.lang.String> signingProtocol()  

      • 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

      • OriginAccessControl

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

      • OriginAccessControl

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

      • OriginAccessControl

        public OriginAccessControl​(java.lang.String name,
                           OriginAccessControlArgs 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 Control ARN.

      • description

        public com.pulumi.core.Output<java.util.Optional<java.lang.String>> description()
        Returns:
        The description of the Origin Access Control. Defaults to "Managed by Pulumi" if omitted.

      • etag

        public com.pulumi.core.Output<java.lang.String> etag()
        Returns:
        The current version of this Origin Access Control.

      • name

        public com.pulumi.core.Output<java.lang.String> name()
        Returns:
        A name that identifies the Origin Access Control.

      • originAccessControlOriginType

        public com.pulumi.core.Output<java.lang.String> originAccessControlOriginType()
        Returns:
        The type of origin that this Origin Access Control is for. Valid values are `lambda`, `mediapackagev2`, `mediastore`, and `s3`.

      • signingBehavior

        public com.pulumi.core.Output<java.lang.String> signingBehavior()
        Returns:
        Specifies which requests CloudFront signs. Specify `always` for the most common use case. Allowed values: `always`, `never`, and `no-override`.

      • signingProtocol

        public com.pulumi.core.Output<java.lang.String> signingProtocol()
        Returns:
        Determines how CloudFront signs (authenticates) requests. The only valid value is `sigv4`.

      • get

        public static OriginAccessControl get​(java.lang.String name,
                                      com.pulumi.core.Output<java.lang.String> id,
                                      @Nullable
                                      OriginAccessControlState 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.