FieldLevelEncryptionConfig class

Provides a CloudFront Field-level Encryption Config resource.

Example Usage

import * as pulumi from "@pulumi/pulumi";
import * as aws from "@pulumi/aws";

const test = new aws.cloudfront.FieldLevelEncryptionConfig("test", {
    contentTypeProfileConfig: {
        contentTypeProfiles: {
            items: [{
                contentType: "application/x-www-form-urlencoded",
                format: "URLEncoded",
            }],
        },
        forwardWhenContentTypeIsUnknown: true,
    },
    queryArgProfileConfig: {
        queryArgProfiles: {
            items: [{
                profileId: testAwsCloudfrontFieldLevelEncryptionProfile.id,
                queryArg: "Arg1",
            }],
        },
        forwardWhenQueryArgProfileIsUnknown: true,
    },
    comment: "test comment",
});

import pulumi
import pulumi_aws as aws

test = aws.cloudfront.FieldLevelEncryptionConfig("test",
    content_type_profile_config={
        "content_type_profiles": {
            "items": [{
                "content_type": "application/x-www-form-urlencoded",
                "format": "URLEncoded",
            }],
        },
        "forward_when_content_type_is_unknown": True,
    },
    query_arg_profile_config={
        "query_arg_profiles": {
            "items": [{
                "profile_id": test_aws_cloudfront_field_level_encryption_profile["id"],
                "query_arg": "Arg1",
            }],
        },
        "forward_when_query_arg_profile_is_unknown": True,
    },
    comment="test comment")

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

return await Deployment.RunAsync(() =>
{
    var test = new Aws.CloudFront.FieldLevelEncryptionConfig("test", new()
    {
        ContentTypeProfileConfig = new Aws.CloudFront.Inputs.FieldLevelEncryptionConfigContentTypeProfileConfigArgs
        {
            ContentTypeProfiles = new Aws.CloudFront.Inputs.FieldLevelEncryptionConfigContentTypeProfileConfigContentTypeProfilesArgs
            {
                Items = new[]
                {
                    new Aws.CloudFront.Inputs.FieldLevelEncryptionConfigContentTypeProfileConfigContentTypeProfilesItemArgs
                    {
                        ContentType = "application/x-www-form-urlencoded",
                        Format = "URLEncoded",
                    },
                },
            },
            ForwardWhenContentTypeIsUnknown = true,
        },
        QueryArgProfileConfig = new Aws.CloudFront.Inputs.FieldLevelEncryptionConfigQueryArgProfileConfigArgs
        {
            QueryArgProfiles = new Aws.CloudFront.Inputs.FieldLevelEncryptionConfigQueryArgProfileConfigQueryArgProfilesArgs
            {
                Items = new[]
                {
                    new Aws.CloudFront.Inputs.FieldLevelEncryptionConfigQueryArgProfileConfigQueryArgProfilesItemArgs
                    {
                        ProfileId = testAwsCloudfrontFieldLevelEncryptionProfile.Id,
                        QueryArg = "Arg1",
                    },
                },
            },
            ForwardWhenQueryArgProfileIsUnknown = true,
        },
        Comment = "test comment",
    });

});

package main

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

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := cloudfront.NewFieldLevelEncryptionConfig(ctx, "test", &cloudfront.FieldLevelEncryptionConfigArgs{
			ContentTypeProfileConfig: &cloudfront.FieldLevelEncryptionConfigContentTypeProfileConfigArgs{
				ContentTypeProfiles: &cloudfront.FieldLevelEncryptionConfigContentTypeProfileConfigContentTypeProfilesArgs{
					Items: cloudfront.FieldLevelEncryptionConfigContentTypeProfileConfigContentTypeProfilesItemArray{
						&cloudfront.FieldLevelEncryptionConfigContentTypeProfileConfigContentTypeProfilesItemArgs{
							ContentType: pulumi.String("application/x-www-form-urlencoded"),
							Format:      pulumi.String("URLEncoded"),
						},
					},
				},
				ForwardWhenContentTypeIsUnknown: pulumi.Bool(true),
			},
			QueryArgProfileConfig: &cloudfront.FieldLevelEncryptionConfigQueryArgProfileConfigArgs{
				QueryArgProfiles: &cloudfront.FieldLevelEncryptionConfigQueryArgProfileConfigQueryArgProfilesArgs{
					Items: cloudfront.FieldLevelEncryptionConfigQueryArgProfileConfigQueryArgProfilesItemArray{
						&cloudfront.FieldLevelEncryptionConfigQueryArgProfileConfigQueryArgProfilesItemArgs{
							ProfileId: pulumi.Any(testAwsCloudfrontFieldLevelEncryptionProfile.Id),
							QueryArg:  pulumi.String("Arg1"),
						},
					},
				},
				ForwardWhenQueryArgProfileIsUnknown: pulumi.Bool(true),
			},
			Comment: pulumi.String("test comment"),
		})
		if err != nil {
			return err
		}
		return nil
	})
}

pulumi {
  required_providers {
    aws = {
      source = "pulumi/aws"
    }
  }
}

resource "aws_cloudfront_fieldlevelencryptionconfig" "test" {
  content_type_profile_config = {
    content_type_profiles = {
      items = [{
        "contentType" = "application/x-www-form-urlencoded"
        "format"      = "URLEncoded"
      }]
    }
    forward_when_content_type_is_unknown = true
  }
  query_arg_profile_config = {
    query_arg_profiles = {
      items = [{
        "profileId" = testAwsCloudfrontFieldLevelEncryptionProfile.id
        "queryArg"  = "Arg1"
      }]
    }
    forward_when_query_arg_profile_is_unknown = true
  }
  comment = "test comment"
}

package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.aws.cloudfront.FieldLevelEncryptionConfig;
import com.pulumi.aws.cloudfront.FieldLevelEncryptionConfigArgs;
import com.pulumi.aws.cloudfront.inputs.FieldLevelEncryptionConfigContentTypeProfileConfigArgs;
import com.pulumi.aws.cloudfront.inputs.FieldLevelEncryptionConfigContentTypeProfileConfigContentTypeProfilesArgs;
import com.pulumi.aws.cloudfront.inputs.FieldLevelEncryptionConfigContentTypeProfileConfigContentTypeProfilesItemArgs;
import com.pulumi.aws.cloudfront.inputs.FieldLevelEncryptionConfigQueryArgProfileConfigArgs;
import com.pulumi.aws.cloudfront.inputs.FieldLevelEncryptionConfigQueryArgProfileConfigQueryArgProfilesArgs;
import com.pulumi.aws.cloudfront.inputs.FieldLevelEncryptionConfigQueryArgProfileConfigQueryArgProfilesItemArgs;
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 test = new FieldLevelEncryptionConfig("test", FieldLevelEncryptionConfigArgs.builder()
            .contentTypeProfileConfig(FieldLevelEncryptionConfigContentTypeProfileConfigArgs.builder()
                .contentTypeProfiles(FieldLevelEncryptionConfigContentTypeProfileConfigContentTypeProfilesArgs.builder()
                    .items(FieldLevelEncryptionConfigContentTypeProfileConfigContentTypeProfilesItemArgs.builder()
                        .contentType("application/x-www-form-urlencoded")
                        .format("URLEncoded")
                        .build())
                    .build())
                .forwardWhenContentTypeIsUnknown(true)
                .build())
            .queryArgProfileConfig(FieldLevelEncryptionConfigQueryArgProfileConfigArgs.builder()
                .queryArgProfiles(FieldLevelEncryptionConfigQueryArgProfileConfigQueryArgProfilesArgs.builder()
                    .items(FieldLevelEncryptionConfigQueryArgProfileConfigQueryArgProfilesItemArgs.builder()
                        .profileId(testAwsCloudfrontFieldLevelEncryptionProfile.id())
                        .queryArg("Arg1")
                        .build())
                    .build())
                .forwardWhenQueryArgProfileIsUnknown(true)
                .build())
            .comment("test comment")
            .build());

    }
}

resources:
  test:
    type: aws:cloudfront:FieldLevelEncryptionConfig
    properties:
      contentTypeProfileConfig:
        contentTypeProfiles:
          items:
            - contentType: application/x-www-form-urlencoded
              format: URLEncoded
        forwardWhenContentTypeIsUnknown: true
      queryArgProfileConfig:
        queryArgProfiles:
          items:
            - profileId: ${testAwsCloudfrontFieldLevelEncryptionProfile.id}
              queryArg: Arg1
        forwardWhenQueryArgProfileIsUnknown: true
      comment: test comment

Import

Using pulumi import, import Cloudfront Field Level Encryption Config using the id. For example:

$ pulumi import aws:cloudfront/fieldLevelEncryptionConfig:FieldLevelEncryptionConfig config E74FTE3AEXAMPLE

Constructors

FieldLevelEncryptionConfig(String name, {FieldLevelEncryptionConfigArgs? args, CustomResourceOptions? options}): Creates a new FieldLevelEncryptionConfig. name The Pulumi resource name. args Arguments used to configure this FieldLevelEncryptionConfig. The set of arguments for FieldLevelEncryptionConfig. options Resource options controlling this resource's behavior.
FieldLevelEncryptionConfig.reference(String urn): Creates a typed reference to an existing FieldLevelEncryptionConfig resource.

Properties

arn ↔ Output<String>: The Field Level Encryption Config ARN.
latefinal
callerReference ↔ Output<String>: Internal value used by CloudFront to allow future updates to the Field Level Encryption Config.
latefinal
childResources → Set<Resource>: finalinherited
comment ↔ Output<String?>: An optional comment about the Field Level Encryption Config.
latefinal
completionSources ↔ Map<String, IOutputCompletionSource>: latefinalinherited
contentTypeProfileConfig ↔ Output<FieldLevelEncryptionConfigContentTypeProfileConfig>: Content Type Profile Config specifies when to forward content if a content type isn't recognized and profiles to use as by default in a request if a query argument doesn't specify a profile to use.
latefinal
etag ↔ Output<String>: The current version of the Field Level Encryption Config. For example: E2QWRUHAPOMQZL.
latefinal
hashCode → int: The hash code for this object.
no setterinherited
id ↔ Output<String>: getter/setter pairinherited
isCustom → bool: Returns whether this resource is provider-managed.
no setterinherited
isProtected → bool: Returns whether this resource is protected from deletion.
no setterinherited
isRemote → bool: Whether this resource is registered as remote.
no setterinherited
isResourceReference → bool: Whether this instance represents a resource value returned over RPC.
finalinherited
queryArgProfileConfig ↔ Output<FieldLevelEncryptionConfigQueryArgProfileConfig>: Query Arg Profile Config that specifies when to forward content if a profile isn't found and the profile that can be provided as a query argument in a request.
latefinal
resourceTransforms → List<ResourceTransform>: Inherited/explicit async transforms.
no setterinherited
runtimeType → Type: A representation of the runtime type of the object.
no setterinherited
transformations → List<ResourceTransformation>: Inherited/explicit legacy transformations.
no setterinherited
urn ↔ Output<String>: latefinalinherited

Methods

failId(Object error) → void: Completes this resource ID with an error when registration fails.
inherited
failOutputs(Object error) → void: Completes all output properties with error.
inherited
failUrn(Object error) → void: Completes this resource URN with an error when registration fails.
inherited
getProvider(String moduleMember) → ProviderResource?: Returns provider for moduleMember's package, if configured.
inherited
getResourceName() → String: Returns this resource's logical name.
inherited
getResourceType() → String: Returns this resource's Pulumi type token.
inherited
noSuchMethod(Invocation invocation) → dynamic: Invoked when a nonexistent method or property is accessed.
inherited
registerOutput<T>(String propertyName, {Object? decoder(Object?)?, bool isSecret = false}) → Output<T>: Registers a dynamic output property for this resource.
inherited
resolveId(String? value, {required bool isKnown}) → void: Resolves the provider-assigned ID for this resource.
inherited
resolveOutputs(Struct outputs) → void: Resolves all output properties from a monitor response payload.
inherited
resolveUrn(String value) → void: Resolves this resource's URN once assigned by the engine.
inherited
serializeProperties(Map<String, dynamic> properties) → Future<Struct>: Serializes resource properties for RPC transmission.
inherited
toString() → String: A string representation of this object.
inherited

Operators

operator ==(Object other) → bool: The equality operator.
inherited

Static Methods

get(String name, Input<String> id, {FieldLevelEncryptionConfigState? state, CustomResourceOptions? options}) → FieldLevelEncryptionConfig: Gets an existing FieldLevelEncryptionConfig resource's state with the given name and id.

FieldLevelEncryptionConfig class

Example Usage

Import

Constructors

Properties

Methods

Operators

Static Methods

cloudfront library