Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi IDP Pulumi Cloud Packages Tutorials
  1. Packages
  2. AWS Cloud Control
  3. API Docs
  4. cloudfront
  5. CloudFrontOriginAccessIdentity

We recommend new projects start with resources from the AWS provider.

AWS Cloud Control v1.28.0 published on Monday, May 19, 2025 by Pulumi
pulumi/pulumi-aws-native

aws-native.cloudfront.CloudFrontOriginAccessIdentity

Explore with Pulumi AI

aws-native logo

We recommend new projects start with resources from the AWS provider.

AWS Cloud Control v1.28.0 published on Monday, May 19, 2025 by Pulumi
pulumi/pulumi-aws-native

    The request to create a new origin access identity (OAI). An origin access identity is a special CloudFront user that you can associate with Amazon S3 origins, so that you can secure all or just some of your Amazon S3 content. For more information, see Restricting Access to Amazon S3 Content by Using an Origin Access Identity in the Amazon CloudFront Developer Guide.

    Example Usage

    Example

    using System.Collections.Generic;
using System.Linq;
using Pulumi;
using AwsNative = Pulumi.AwsNative;

return await Deployment.RunAsync(() => 
{
    var cloudfrontoriginaccessidentity = new AwsNative.CloudFront.CloudFrontOriginAccessIdentity("cloudfrontoriginaccessidentity", new()
    {
        CloudFrontOriginAccessIdentityConfig = new AwsNative.CloudFront.Inputs.CloudFrontOriginAccessIdentityConfigArgs
        {
            Comment = "string-value",
        },
    });

});

    package main

import (
	"github.com/pulumi/pulumi-aws-native/sdk/go/aws/cloudfront"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := cloudfront.NewCloudFrontOriginAccessIdentity(ctx, "cloudfrontoriginaccessidentity", &cloudfront.CloudFrontOriginAccessIdentityArgs{
			CloudFrontOriginAccessIdentityConfig: &cloudfront.CloudFrontOriginAccessIdentityConfigArgs{
				Comment: pulumi.String("string-value"),
			},
		})
		if err != nil {
			return err
		}
		return nil
	})
}

    Coming soon!

    import * as pulumi from "@pulumi/pulumi";
import * as aws_native from "@pulumi/aws-native";

const cloudfrontoriginaccessidentity = new aws_native.cloudfront.CloudFrontOriginAccessIdentity("cloudfrontoriginaccessidentity", {cloudFrontOriginAccessIdentityConfig: {
    comment: "string-value",
}});

    import pulumi
import pulumi_aws_native as aws_native

cloudfrontoriginaccessidentity = aws_native.cloudfront.CloudFrontOriginAccessIdentity("cloudfrontoriginaccessidentity", cloud_front_origin_access_identity_config={
    "comment": "string-value",
})

    Coming soon!

    Example

    using System.Collections.Generic;
using System.Linq;
using Pulumi;
using AwsNative = Pulumi.AwsNative;

return await Deployment.RunAsync(() => 
{
    var cloudfrontoriginaccessidentity = new AwsNative.CloudFront.CloudFrontOriginAccessIdentity("cloudfrontoriginaccessidentity", new()
    {
        CloudFrontOriginAccessIdentityConfig = new AwsNative.CloudFront.Inputs.CloudFrontOriginAccessIdentityConfigArgs
        {
            Comment = "string-value",
        },
    });

});

    package main

import (
	"github.com/pulumi/pulumi-aws-native/sdk/go/aws/cloudfront"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := cloudfront.NewCloudFrontOriginAccessIdentity(ctx, "cloudfrontoriginaccessidentity", &cloudfront.CloudFrontOriginAccessIdentityArgs{
			CloudFrontOriginAccessIdentityConfig: &cloudfront.CloudFrontOriginAccessIdentityConfigArgs{
				Comment: pulumi.String("string-value"),
			},
		})
		if err != nil {
			return err
		}
		return nil
	})
}

    Coming soon!

    import * as pulumi from "@pulumi/pulumi";
import * as aws_native from "@pulumi/aws-native";

const cloudfrontoriginaccessidentity = new aws_native.cloudfront.CloudFrontOriginAccessIdentity("cloudfrontoriginaccessidentity", {cloudFrontOriginAccessIdentityConfig: {
    comment: "string-value",
}});

    import pulumi
import pulumi_aws_native as aws_native

cloudfrontoriginaccessidentity = aws_native.cloudfront.CloudFrontOriginAccessIdentity("cloudfrontoriginaccessidentity", cloud_front_origin_access_identity_config={
    "comment": "string-value",
})

    Coming soon!

    Create CloudFrontOriginAccessIdentity Resource

    Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.

    Constructor syntax

    new CloudFrontOriginAccessIdentity(name: string, args: CloudFrontOriginAccessIdentityArgs, opts?: CustomResourceOptions);
    @overload
def CloudFrontOriginAccessIdentity(resource_name: str,
                                   args: CloudFrontOriginAccessIdentityArgs,
                                   opts: Optional[ResourceOptions] = None)

@overload
def CloudFrontOriginAccessIdentity(resource_name: str,
                                   opts: Optional[ResourceOptions] = None,
                                   cloud_front_origin_access_identity_config: Optional[CloudFrontOriginAccessIdentityConfigArgs] = None)
    func NewCloudFrontOriginAccessIdentity(ctx *Context, name string, args CloudFrontOriginAccessIdentityArgs, opts ...ResourceOption) (*CloudFrontOriginAccessIdentity, error)
    public CloudFrontOriginAccessIdentity(string name, CloudFrontOriginAccessIdentityArgs args, CustomResourceOptions? opts = null)
    public CloudFrontOriginAccessIdentity(String name, CloudFrontOriginAccessIdentityArgs args)
public CloudFrontOriginAccessIdentity(String name, CloudFrontOriginAccessIdentityArgs args, CustomResourceOptions options)

    type: aws-native:cloudfront:CloudFrontOriginAccessIdentity
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

    Parameters

    name string
    The unique name of the resource.
    args CloudFrontOriginAccessIdentityArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    resource_name str
    The unique name of the resource.
    args CloudFrontOriginAccessIdentityArgs
    The arguments to resource properties.
    opts ResourceOptions
    Bag of options to control resource's behavior.
    ctx Context
    Context object for the current deployment.
    name string
    The unique name of the resource.
    args CloudFrontOriginAccessIdentityArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args CloudFrontOriginAccessIdentityArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args CloudFrontOriginAccessIdentityArgs
    The arguments to resource properties.
    options CustomResourceOptions
    Bag of options to control resource's behavior.

    CloudFrontOriginAccessIdentity Resource Properties

    To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.

    Inputs

    In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.

    The CloudFrontOriginAccessIdentity resource accepts the following input properties:

    CloudFrontOriginAccessIdentityConfig CloudFrontOriginAccessIdentityConfigArgs
    The current configuration information for the identity.
    cloudFrontOriginAccessIdentityConfig CloudFrontOriginAccessIdentityConfig
    The current configuration information for the identity.
    cloudFrontOriginAccessIdentityConfig CloudFrontOriginAccessIdentityConfig
    The current configuration information for the identity.
    cloud_front_origin_access_identity_config CloudFrontOriginAccessIdentityConfigArgs
    The current configuration information for the identity.
    cloudFrontOriginAccessIdentityConfig Property Map
    The current configuration information for the identity.

    Outputs

    All input properties are implicitly available as output properties. Additionally, the CloudFrontOriginAccessIdentity resource produces the following output properties:

    AwsId string
    The ID for the origin access identity, for example, E74FTE3AJFJ256A .
    Id string
    The provider-assigned unique ID for this managed resource.
    S3CanonicalUserId string
    The Amazon S3 canonical user ID for the origin access identity, used when giving the origin access identity read permission to an object in Amazon S3. For example: b970b42360b81c8ddbd79d2f5df0069ba9033c8a79655752abe380cd6d63ba8bcf23384d568fcf89fc49700b5e11a0fd .
    AwsId string
    The ID for the origin access identity, for example, E74FTE3AJFJ256A .
    Id string
    The provider-assigned unique ID for this managed resource.
    S3CanonicalUserId string
    The Amazon S3 canonical user ID for the origin access identity, used when giving the origin access identity read permission to an object in Amazon S3. For example: b970b42360b81c8ddbd79d2f5df0069ba9033c8a79655752abe380cd6d63ba8bcf23384d568fcf89fc49700b5e11a0fd .
    awsId String
    The ID for the origin access identity, for example, E74FTE3AJFJ256A .
    id String
    The provider-assigned unique ID for this managed resource.
    s3CanonicalUserId String
    The Amazon S3 canonical user ID for the origin access identity, used when giving the origin access identity read permission to an object in Amazon S3. For example: b970b42360b81c8ddbd79d2f5df0069ba9033c8a79655752abe380cd6d63ba8bcf23384d568fcf89fc49700b5e11a0fd .
    awsId string
    The ID for the origin access identity, for example, E74FTE3AJFJ256A .
    id string
    The provider-assigned unique ID for this managed resource.
    s3CanonicalUserId string
    The Amazon S3 canonical user ID for the origin access identity, used when giving the origin access identity read permission to an object in Amazon S3. For example: b970b42360b81c8ddbd79d2f5df0069ba9033c8a79655752abe380cd6d63ba8bcf23384d568fcf89fc49700b5e11a0fd .
    aws_id str
    The ID for the origin access identity, for example, E74FTE3AJFJ256A .
    id str
    The provider-assigned unique ID for this managed resource.
    s3_canonical_user_id str
    The Amazon S3 canonical user ID for the origin access identity, used when giving the origin access identity read permission to an object in Amazon S3. For example: b970b42360b81c8ddbd79d2f5df0069ba9033c8a79655752abe380cd6d63ba8bcf23384d568fcf89fc49700b5e11a0fd .
    awsId String
    The ID for the origin access identity, for example, E74FTE3AJFJ256A .
    id String
    The provider-assigned unique ID for this managed resource.
    s3CanonicalUserId String
    The Amazon S3 canonical user ID for the origin access identity, used when giving the origin access identity read permission to an object in Amazon S3. For example: b970b42360b81c8ddbd79d2f5df0069ba9033c8a79655752abe380cd6d63ba8bcf23384d568fcf89fc49700b5e11a0fd .

    Supporting Types

    CloudFrontOriginAccessIdentityConfig, CloudFrontOriginAccessIdentityConfigArgs

    Comment string
    A comment to describe the origin access identity. The comment cannot be longer than 128 characters.
    Comment string
    A comment to describe the origin access identity. The comment cannot be longer than 128 characters.
    comment String
    A comment to describe the origin access identity. The comment cannot be longer than 128 characters.
    comment string
    A comment to describe the origin access identity. The comment cannot be longer than 128 characters.
    comment str
    A comment to describe the origin access identity. The comment cannot be longer than 128 characters.
    comment String
    A comment to describe the origin access identity. The comment cannot be longer than 128 characters.

    Package Details

    Repository
    AWS Native pulumi/pulumi-aws-native
    License
    Apache-2.0
    aws-native logo

    We recommend new projects start with resources from the AWS provider.

    AWS Cloud Control v1.28.0 published on Monday, May 19, 2025 by Pulumi
    pulumi/pulumi-aws-native