FunctionType class

Provides a CloudFront Function resource. With CloudFront Functions in Amazon CloudFront, you can write lightweight functions in JavaScript for high-scale, latency-sensitive CDN customizations.

See CloudFront Functions

> NOTE: You cannot delete a function if it’s associated with a cache behavior. First, update your distributions to remove the function association from all cache behaviors, then delete the function.

Example Usage

Import

Using pulumi import, import CloudFront Functions using the name. For example:

$ pulumi import aws:cloudfront/function:Function test my_test_function

Constructors

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

Properties

arn ↔ Output<String>: ARN identifying your CloudFront Function.
latefinal
childResources → Set<Resource>: finalinherited
code ↔ Output<String>: Source code of the function. Must be between 1 and 40960 bytes.
latefinal
comment ↔ Output<String?>: Comment. Must not exceed 128 characters.
latefinal
completionSources ↔ Map<String, IOutputCompletionSource>: latefinalinherited
etag ↔ Output<String>: ETag hash of the function. This is the value for the DEVELOPMENT stage of the function.
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
keyValueStoreAssociations ↔ Output<List<String>?>: List of aws.cloudfront.KeyValueStore ARNs to be associated to the function. AWS limits associations to one key value store per function.
latefinal
liveStageEtag ↔ Output<String>: ETag hash of any LIVE stage of the function.
latefinal
name ↔ Output<String>: Unique name for your CloudFront Function. Valid names contain only alphanumeric characters, hyphens, and underscores, and must be between 1 and 64 characters.
latefinal
publish ↔ Output<bool?>: Whether to publish creation/change as Live CloudFront Function Version. Defaults to true.
latefinal
resourceTransforms → List<ResourceTransform>: Inherited/explicit async transforms.
no setterinherited
runtime ↔ Output<String>: Identifier of the function's runtime. Valid values are cloudfront-js-1.0 and cloudfront-js-2.0.
latefinal
runtimeType → Type: A representation of the runtime type of the object.
no setterinherited
status ↔ Output<String>: Status of the function. Can be UNPUBLISHED, UNASSOCIATED or ASSOCIATED.
latefinal
tags ↔ Output<Map<String, String>?>: Map of tags to assign to the resource. If configured with a provider defaultTags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
latefinal
tagsAll ↔ Output<Map<String, String>>: Map of tags assigned to the resource, including those inherited from the provider defaultTags configuration block.
latefinal
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, {FunctionState? state, CustomResourceOptions? options}) → FunctionType: Gets an existing FunctionType resource's state with the given name and id.