Package com.pulumi.aws.cloudfront

Class ConnectionFunction

  • public class ConnectionFunction
extends com.pulumi.resources.CustomResource
    Manages an AWS CloudFront Connection Function. ## Example Usage ### Basic Usage 
     
 package generated_program;
 
 import com.pulumi.Context;
 import com.pulumi.Pulumi;
 import com.pulumi.core.Output;
 import com.pulumi.aws.cloudfront.ConnectionFunction;
 import com.pulumi.aws.cloudfront.ConnectionFunctionArgs;
 import com.pulumi.aws.cloudfront.inputs.ConnectionFunctionConnectionFunctionConfigArgs;
 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 ConnectionFunction("example", ConnectionFunctionArgs.builder()
             .connectionFunctionConfig(ConnectionFunctionConnectionFunctionConfigArgs.builder()
                 .runtime("cloudfront-js-2.0")
                 .comment("Example connection function")
                 .build())
             .name("example-connection-function")
             .connectionFunctionCode("function handler(event) { return event.request; }")
             .build());
 
     }
 }
    ### With Publish Enabled 
     
 package generated_program;
 
 import com.pulumi.Context;
 import com.pulumi.Pulumi;
 import com.pulumi.core.Output;
 import com.pulumi.aws.cloudfront.ConnectionFunction;
 import com.pulumi.aws.cloudfront.ConnectionFunctionArgs;
 import com.pulumi.aws.cloudfront.inputs.ConnectionFunctionConnectionFunctionConfigArgs;
 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 ConnectionFunction("example", ConnectionFunctionArgs.builder()
             .connectionFunctionConfig(ConnectionFunctionConnectionFunctionConfigArgs.builder()
                 .runtime("cloudfront-js-2.0")
                 .comment("Example connection function")
                 .build())
             .name("example-connection-function")
             .connectionFunctionCode("function handler(event) { return event.request; }")
             .publish(true)
             .build());
 
     }
 }
    ### With Key Value Store Associations 
     
 package generated_program;
 
 import com.pulumi.Context;
 import com.pulumi.Pulumi;
 import com.pulumi.core.Output;
 import com.pulumi.aws.cloudfront.KeyValueStore;
 import com.pulumi.aws.cloudfront.KeyValueStoreArgs;
 import com.pulumi.aws.cloudfront.ConnectionFunction;
 import com.pulumi.aws.cloudfront.ConnectionFunctionArgs;
 import com.pulumi.aws.cloudfront.inputs.ConnectionFunctionConnectionFunctionConfigArgs;
 import com.pulumi.aws.cloudfront.inputs.ConnectionFunctionConnectionFunctionConfigKeyValueStoreAssociationArgs;
 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 KeyValueStore("example", KeyValueStoreArgs.builder()
             .name("example-kvs")
             .comment("Example key value store")
             .build());
 
         var exampleConnectionFunction = new ConnectionFunction("exampleConnectionFunction", ConnectionFunctionArgs.builder()
             .connectionFunctionConfig(ConnectionFunctionConnectionFunctionConfigArgs.builder()
                 .keyValueStoreAssociation(ConnectionFunctionConnectionFunctionConfigKeyValueStoreAssociationArgs.builder()
                     .keyValueStoreArn(example.arn())
                     .build())
                 .runtime("cloudfront-js-2.0")
                 .comment("Example connection function")
                 .build())
             .name("example-connection-function")
             .connectionFunctionCode("function handler(event) { return event.request; }")
             .build());
 
     }
 }
    ### With Tags 
     
 package generated_program;
 
 import com.pulumi.Context;
 import com.pulumi.Pulumi;
 import com.pulumi.core.Output;
 import com.pulumi.aws.cloudfront.ConnectionFunction;
 import com.pulumi.aws.cloudfront.ConnectionFunctionArgs;
 import com.pulumi.aws.cloudfront.inputs.ConnectionFunctionConnectionFunctionConfigArgs;
 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 ConnectionFunction("example", ConnectionFunctionArgs.builder()
             .connectionFunctionConfig(ConnectionFunctionConnectionFunctionConfigArgs.builder()
                 .runtime("cloudfront-js-2.0")
                 .comment("Example connection function")
                 .build())
             .name("example-connection-function")
             .connectionFunctionCode("function handler(event) { return event.request; }")
             .tags(Map.ofEntries(
                 Map.entry("Environment", "production"),
                 Map.entry("Team", "web")
             ))
             .build());
 
     }
 }
    ## Import Using `pulumi import`, import CloudFront Connection Function using the function ID. For example: ```sh $ pulumi import aws:cloudfront/connectionFunction:ConnectionFunction example E1PA6795UKMFR9 ```

    • Nested Class Summary

      • Nested classes/interfaces inherited from class com.pulumi.resources.CustomResource

        com.pulumi.resources.CustomResource.CustomResourceInternal

      • Nested classes/interfaces inherited from class com.pulumi.resources.Resource

        com.pulumi.resources.Resource.LazyField<T extends java.lang.Object>, com.pulumi.resources.Resource.LazyFields, com.pulumi.resources.Resource.ResourceInternal

    • Field Summary

      • Fields inherited from class com.pulumi.resources.Resource

        childResources, remote

    • Method Summary

      All Methods Static Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      com.pulumi.core.Output<java.lang.String> connectionFunctionArn()  
      com.pulumi.core.Output<java.lang.String> connectionFunctionCode()  
      com.pulumi.core.Output<ConnectionFunctionConnectionFunctionConfig> connectionFunctionConfig()  
      com.pulumi.core.Output<java.lang.String> etag()  
      static ConnectionFunction get​(java.lang.String name, com.pulumi.core.Output<java.lang.String> id, ConnectionFunctionState state, com.pulumi.resources.CustomResourceOptions options)
      Get an existing Host resource's state with the given name, ID, and optional extra properties used to qualify the lookup.
      com.pulumi.core.Output<java.lang.String> liveStageEtag()  
      com.pulumi.core.Output<java.lang.String> name()  
      com.pulumi.core.Output<java.lang.Boolean> publish()  
      com.pulumi.core.Output<java.lang.String> status()  
      com.pulumi.core.Output<java.util.Optional<java.util.Map<java.lang.String,​java.lang.String>>> tags()  
      com.pulumi.core.Output<java.util.Map<java.lang.String,​java.lang.String>> tagsAll()  

      • Methods inherited from class com.pulumi.resources.CustomResource

        getId, id, idFuture

      • Methods inherited from class com.pulumi.resources.Resource

        getChildResources, getResourceName, getResourceType, getUrn, pulumiChildResources, pulumiResourceName, pulumiResourceType, urn

      • Methods inherited from class java.lang.Object

        clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

    • Constructor Detail

      • ConnectionFunction

        public ConnectionFunction​(java.lang.String name)
        Parameters:
        name - The _unique_ name of the resulting resource.

      • ConnectionFunction

        public ConnectionFunction​(java.lang.String name,
                          ConnectionFunctionArgs args)
        Parameters:
        name - The _unique_ name of the resulting resource.
        args - The arguments to use to populate this resource's properties.

      • ConnectionFunction

        public ConnectionFunction​(java.lang.String name,
                          ConnectionFunctionArgs args,
                          @Nullable
                          com.pulumi.resources.CustomResourceOptions options)
        Parameters:
        name - The _unique_ name of the resulting resource.
        args - The arguments to use to populate this resource's properties.
        options - A bag of options that control this resource's behavior.

    • Method Detail

      • connectionFunctionArn

        public com.pulumi.core.Output<java.lang.String> connectionFunctionArn()
        Returns:
        ARN of the connection function.

      • connectionFunctionCode

        public com.pulumi.core.Output<java.lang.String> connectionFunctionCode()
        Returns:
        Code for the connection function. Maximum length is 40960 characters.

      • connectionFunctionConfig

        public com.pulumi.core.Output<ConnectionFunctionConnectionFunctionConfig> connectionFunctionConfig()
        Returns:
        Configuration information for the connection function. See `connectionFunctionConfig` below.

      • etag

        public com.pulumi.core.Output<java.lang.String> etag()
        Returns:
        ETag of the connection function.

      • liveStageEtag

        public com.pulumi.core.Output<java.lang.String> liveStageEtag()
        Returns:
        ETag of the function's LIVE stage. Will be empty if the function has not been published.

      • name

        public com.pulumi.core.Output<java.lang.String> name()
        Returns:
        Name for the connection function. Must be 1-64 characters and can contain letters, numbers, hyphens, and underscores. Changing this forces a new resource to be created. The following arguments are optional:

      • publish

        public com.pulumi.core.Output<java.lang.Boolean> publish()
        Returns:
        Whether to publish the function to the `LIVE` stage after creation or update. Defaults to `false`.

      • status

        public com.pulumi.core.Output<java.lang.String> status()
        Returns:
        Status of the connection function.

      • tags

        public com.pulumi.core.Output<java.util.Optional<java.util.Map<java.lang.String,​java.lang.String>>> tags()
        Returns:
        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.

      • tagsAll

        public com.pulumi.core.Output<java.util.Map<java.lang.String,​java.lang.String>> tagsAll()
        Returns:
        Map of tags assigned to the resource, including those inherited from the provider `defaultTags` configuration block.

      • get

        public static ConnectionFunction get​(java.lang.String name,
                                     com.pulumi.core.Output<java.lang.String> id,
                                     @Nullable
                                     ConnectionFunctionState state,
                                     @Nullable
                                     com.pulumi.resources.CustomResourceOptions options)
        Get an existing Host resource's state with the given name, ID, and optional extra properties used to qualify the lookup.
        Parameters:
        name - The _unique_ name of the resulting resource.
        id - The _unique_ provider ID of the resource to lookup.
        state -
        options - Optional settings to control the behavior of the CustomResource.