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

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

AWS Cloud Control v1.26.0 published on Wednesday, Mar 12, 2025 by Pulumi
pulumi/pulumi-aws-native

aws-native.cloudfront.getCloudFrontOriginAccessIdentity

Explore with Pulumi AI

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

AWS Cloud Control v1.26.0 published on Wednesday, Mar 12, 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.

Using getCloudFrontOriginAccessIdentity

Two invocation forms are available. The direct form accepts plain arguments and either blocks until the result value is available, or returns a Promise-wrapped result. The output form accepts Input-wrapped arguments and returns an Output-wrapped result.

function getCloudFrontOriginAccessIdentity(args: GetCloudFrontOriginAccessIdentityArgs, opts?: InvokeOptions): Promise<GetCloudFrontOriginAccessIdentityResult>
function getCloudFrontOriginAccessIdentityOutput(args: GetCloudFrontOriginAccessIdentityOutputArgs, opts?: InvokeOptions): Output<GetCloudFrontOriginAccessIdentityResult>
Copy
def get_cloud_front_origin_access_identity(id: Optional[str] = None,
                                           opts: Optional[InvokeOptions] = None) -> GetCloudFrontOriginAccessIdentityResult
def get_cloud_front_origin_access_identity_output(id: Optional[pulumi.Input[str]] = None,
                                           opts: Optional[InvokeOptions] = None) -> Output[GetCloudFrontOriginAccessIdentityResult]
Copy
func LookupCloudFrontOriginAccessIdentity(ctx *Context, args *LookupCloudFrontOriginAccessIdentityArgs, opts ...InvokeOption) (*LookupCloudFrontOriginAccessIdentityResult, error)
func LookupCloudFrontOriginAccessIdentityOutput(ctx *Context, args *LookupCloudFrontOriginAccessIdentityOutputArgs, opts ...InvokeOption) LookupCloudFrontOriginAccessIdentityResultOutput
Copy

> Note: This function is named LookupCloudFrontOriginAccessIdentity in the Go SDK.

public static class GetCloudFrontOriginAccessIdentity 
{
    public static Task<GetCloudFrontOriginAccessIdentityResult> InvokeAsync(GetCloudFrontOriginAccessIdentityArgs args, InvokeOptions? opts = null)
    public static Output<GetCloudFrontOriginAccessIdentityResult> Invoke(GetCloudFrontOriginAccessIdentityInvokeArgs args, InvokeOptions? opts = null)
}
Copy
public static CompletableFuture<GetCloudFrontOriginAccessIdentityResult> getCloudFrontOriginAccessIdentity(GetCloudFrontOriginAccessIdentityArgs args, InvokeOptions options)
public static Output<GetCloudFrontOriginAccessIdentityResult> getCloudFrontOriginAccessIdentity(GetCloudFrontOriginAccessIdentityArgs args, InvokeOptions options)
Copy
fn::invoke:
  function: aws-native:cloudfront:getCloudFrontOriginAccessIdentity
  arguments:
    # arguments dictionary
Copy

The following arguments are supported:

Id This property is required. string
The ID for the origin access identity, for example, E74FTE3AJFJ256A .
Id This property is required. string
The ID for the origin access identity, for example, E74FTE3AJFJ256A .
id This property is required. String
The ID for the origin access identity, for example, E74FTE3AJFJ256A .
id This property is required. string
The ID for the origin access identity, for example, E74FTE3AJFJ256A .
id This property is required. str
The ID for the origin access identity, for example, E74FTE3AJFJ256A .
id This property is required. String
The ID for the origin access identity, for example, E74FTE3AJFJ256A .

getCloudFrontOriginAccessIdentity Result

The following output properties are available:

CloudFrontOriginAccessIdentityConfig Pulumi.AwsNative.CloudFront.Outputs.CloudFrontOriginAccessIdentityConfig
The current configuration information for the identity.
Id string
The ID for the origin access identity, for example, E74FTE3AJFJ256A .
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 .
CloudFrontOriginAccessIdentityConfig CloudFrontOriginAccessIdentityConfig
The current configuration information for the identity.
Id string
The ID for the origin access identity, for example, E74FTE3AJFJ256A .
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 .
cloudFrontOriginAccessIdentityConfig CloudFrontOriginAccessIdentityConfig
The current configuration information for the identity.
id String
The ID for the origin access identity, for example, E74FTE3AJFJ256A .
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 .
cloudFrontOriginAccessIdentityConfig CloudFrontOriginAccessIdentityConfig
The current configuration information for the identity.
id string
The ID for the origin access identity, for example, E74FTE3AJFJ256A .
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 .
cloud_front_origin_access_identity_config CloudFrontOriginAccessIdentityConfig
The current configuration information for the identity.
id str
The ID for the origin access identity, for example, E74FTE3AJFJ256A .
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 .
cloudFrontOriginAccessIdentityConfig Property Map
The current configuration information for the identity.
id String
The ID for the origin access identity, for example, E74FTE3AJFJ256A .
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

Comment This property is required. string
A comment to describe the origin access identity. The comment cannot be longer than 128 characters.
Comment This property is required. string
A comment to describe the origin access identity. The comment cannot be longer than 128 characters.
comment This property is required. String
A comment to describe the origin access identity. The comment cannot be longer than 128 characters.
comment This property is required. string
A comment to describe the origin access identity. The comment cannot be longer than 128 characters.
comment This property is required. str
A comment to describe the origin access identity. The comment cannot be longer than 128 characters.
comment This property is required. 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

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

AWS Cloud Control v1.26.0 published on Wednesday, Mar 12, 2025 by Pulumi
pulumi/pulumi-aws-native