FieldLevelEncryptionProfile class
Provides a CloudFront Field-level Encryption Profile resource.
Example Usage
import * as pulumi from "@pulumi/pulumi";
import * as aws from "@pulumi/aws";
import * as std from "@pulumi/std";
const example = new aws.cloudfront.PublicKey("example", {
comment: "test public key",
encodedKey: std.file({
input: "public_key.pem",
}).then(invoke => invoke.result),
name: "test_key",
});
const test = new aws.cloudfront.FieldLevelEncryptionProfile("test", {
encryptionEntities: {
items: [{
fieldPatterns: {
items: ["DateOfBirth"],
},
publicKeyId: example.id,
providerId: "test provider",
}],
},
comment: "test comment",
name: "test profile",
});
import pulumi
import pulumi_aws as aws
import pulumi_std as std
example = aws.cloudfront.PublicKey("example",
comment="test public key",
encoded_key=std.file(input="public_key.pem").result,
name="test_key")
test = aws.cloudfront.FieldLevelEncryptionProfile("test",
encryption_entities={
"items": [{
"field_patterns": {
"items": ["DateOfBirth"],
},
"public_key_id": example.id,
"provider_id": "test provider",
}],
},
comment="test comment",
name="test profile")
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Aws = Pulumi.Aws;
using Std = Pulumi.Std;
return await Deployment.RunAsync(() =>
{
var example = new Aws.CloudFront.PublicKey("example", new()
{
Comment = "test public key",
EncodedKey = Std.File.Invoke(new()
{
Input = "public_key.pem",
}).Apply(invoke => invoke.Result),
Name = "test_key",
});
var test = new Aws.CloudFront.FieldLevelEncryptionProfile("test", new()
{
EncryptionEntities = new Aws.CloudFront.Inputs.FieldLevelEncryptionProfileEncryptionEntitiesArgs
{
Items = new[]
{
new Aws.CloudFront.Inputs.FieldLevelEncryptionProfileEncryptionEntitiesItemArgs
{
FieldPatterns = new Aws.CloudFront.Inputs.FieldLevelEncryptionProfileEncryptionEntitiesItemFieldPatternsArgs
{
Items = new[]
{
"DateOfBirth",
},
},
PublicKeyId = example.Id,
ProviderId = "test provider",
},
},
},
Comment = "test comment",
Name = "test profile",
});
});
package main
import (
"github.com/pulumi/pulumi-aws/sdk/v7/go/aws/cloudfront"
"github.com/pulumi/pulumi-std/sdk/go/std"
"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)
func main() {
pulumi.Run(func(ctx *pulumi.Context) error {
invokeFile, err := std.File(ctx, &std.FileArgs{
Input: "public_key.pem",
}, nil)
if err != nil {
return err
}
example, err := cloudfront.NewPublicKey(ctx, "example", &cloudfront.PublicKeyArgs{
Comment: pulumi.String("test public key"),
EncodedKey: pulumi.String(invokeFile.Result),
Name: pulumi.String("test_key"),
})
if err != nil {
return err
}
_, err = cloudfront.NewFieldLevelEncryptionProfile(ctx, "test", &cloudfront.FieldLevelEncryptionProfileArgs{
EncryptionEntities: &cloudfront.FieldLevelEncryptionProfileEncryptionEntitiesArgs{
Items: cloudfront.FieldLevelEncryptionProfileEncryptionEntitiesItemArray{
&cloudfront.FieldLevelEncryptionProfileEncryptionEntitiesItemArgs{
FieldPatterns: &cloudfront.FieldLevelEncryptionProfileEncryptionEntitiesItemFieldPatternsArgs{
Items: pulumi.StringArray{
pulumi.String("DateOfBirth"),
},
},
PublicKeyId: example.ID().ToIDOutput().ToStringOutput(),
ProviderId: pulumi.String("test provider"),
},
},
},
Comment: pulumi.String("test comment"),
Name: pulumi.String("test profile"),
})
if err != nil {
return err
}
return nil
})
}
pulumi {
required_providers {
aws = {
source = "pulumi/aws"
}
std = {
source = "pulumi/std"
}
}
}
resource "aws_cloudfront_publickey" "example" {
comment = "test public key"
encoded_key = file("public_key.pem")
name = "test_key"
}
resource "aws_cloudfront_fieldlevelencryptionprofile" "test" {
encryption_entities = {
items = [{
"fieldPatterns" = {
"items" = ["DateOfBirth"]
}
"publicKeyId" = aws_cloudfront_publickey.example.id
"providerId" = "test provider"
}]
}
comment = "test comment"
name = "test profile"
}
package generated_program;
import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.aws.cloudfront.PublicKey;
import com.pulumi.aws.cloudfront.PublicKeyArgs;
import com.pulumi.std.StdFunctions;
import com.pulumi.std.inputs.FileArgs;
import com.pulumi.aws.cloudfront.FieldLevelEncryptionProfile;
import com.pulumi.aws.cloudfront.FieldLevelEncryptionProfileArgs;
import com.pulumi.aws.cloudfront.inputs.FieldLevelEncryptionProfileEncryptionEntitiesArgs;
import com.pulumi.aws.cloudfront.inputs.FieldLevelEncryptionProfileEncryptionEntitiesItemArgs;
import com.pulumi.aws.cloudfront.inputs.FieldLevelEncryptionProfileEncryptionEntitiesItemFieldPatternsArgs;
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 PublicKey("example", PublicKeyArgs.builder()
.comment("test public key")
.encodedKey(StdFunctions.file(FileArgs.builder()
.input("public_key.pem")
.build()).result())
.name("test_key")
.build());
var test = new FieldLevelEncryptionProfile("test", FieldLevelEncryptionProfileArgs.builder()
.encryptionEntities(FieldLevelEncryptionProfileEncryptionEntitiesArgs.builder()
.items(FieldLevelEncryptionProfileEncryptionEntitiesItemArgs.builder()
.fieldPatterns(FieldLevelEncryptionProfileEncryptionEntitiesItemFieldPatternsArgs.builder()
.items("DateOfBirth")
.build())
.publicKeyId(example.id())
.providerId("test provider")
.build())
.build())
.comment("test comment")
.name("test profile")
.build());
}
}
resources:
example:
type: aws:cloudfront:PublicKey
properties:
comment: test public key
encodedKey:
fn::invoke:
function: std:file
arguments:
input: public_key.pem
return: result
name: test_key
test:
type: aws:cloudfront:FieldLevelEncryptionProfile
properties:
encryptionEntities:
items:
- fieldPatterns:
items:
- DateOfBirth
publicKeyId: ${example.id}
providerId: test provider
comment: test comment
name: test profile
Import
Using pulumi import, import Cloudfront Field Level Encryption Profile using the id. For example:
$ pulumi import aws:cloudfront/fieldLevelEncryptionProfile:FieldLevelEncryptionProfile profile K3D5EWEUDCCXON
Constructors
- FieldLevelEncryptionProfile(String name, {FieldLevelEncryptionProfileArgs? args, CustomResourceOptions? options})
-
Creates a new FieldLevelEncryptionProfile.
nameThe Pulumi resource name.argsArguments used to configure this FieldLevelEncryptionProfile. The set of arguments for FieldLevelEncryptionProfile.optionsResource options controlling this resource's behavior. - FieldLevelEncryptionProfile.reference(String urn)
- Creates a typed reference to an existing FieldLevelEncryptionProfile resource.
Properties
-
arn
↔ Output<
String> -
The Field Level Encryption Profile ARN.
latefinal
-
callerReference
↔ Output<
String> -
Internal value used by CloudFront to allow future updates to the Field Level Encryption Profile.
latefinal
-
childResources
→ Set<
Resource> -
finalinherited
-
comment
↔ Output<
String?> -
An optional comment about the Field Level Encryption Profile.
latefinal
-
completionSources
↔ Map<
String, IOutputCompletionSource> -
latefinalinherited
-
encryptionEntities
↔ Output<
FieldLevelEncryptionProfileEncryptionEntities> -
The encryption entities config block for field-level encryption profiles that contains an attribute
itemswhich includes the encryption key and field pattern specifications.latefinal -
etag
↔ Output<
String> -
The current version of the Field Level Encryption Profile. 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
-
name
↔ Output<
String> -
The name of the Field Level Encryption Profile.
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, {FieldLevelEncryptionProfileState? state, CustomResourceOptions? options}) → FieldLevelEncryptionProfile -
Gets an existing FieldLevelEncryptionProfile resource's state with the given
nameandid.