Package software.amazon.awscdk.services.glue

Class CfnUserDefinedFunction

java.lang.Object
software.amazon.jsii.JsiiObject
software.constructs.Construct
software.amazon.awscdk.CfnElement
software.amazon.awscdk.CfnRefElement
software.amazon.awscdk.CfnResource
software.amazon.awscdk.services.glue.CfnUserDefinedFunction
All Implemented Interfaces:
IInspectable, IUserDefinedFunctionRef, IEnvironmentAware, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct, software.constructs.IDependable
@Generated(value="jsii-pacmak/1.138.0 (build 0ca7ee8)", date="2026-08-10T14:51:04.460Z") @Stability(Stable) public class CfnUserDefinedFunction extends CfnResource implements IInspectable, IUserDefinedFunctionRef
Represents a user-defined function (UDF) definition in the AWS Glue Data Catalog.

Example: 

 // The code below shows an example of how to instantiate this type.
 // The values are placeholders you should change.
 import software.amazon.awscdk.services.glue.*;
 CfnUserDefinedFunction cfnUserDefinedFunction = CfnUserDefinedFunction.Builder.create(this, "MyCfnUserDefinedFunction")
         .databaseName("databaseName")
         .functionName("functionName")
         // the properties below are optional
         .className("className")
         .functionType("functionType")
         .ownerName("ownerName")
         .ownerType("ownerType")
         .resourceUris(List.of(ResourceUriProperty.builder()
                 .resourceType("resourceType")
                 .uri("uri")
                 .build()))
         .build();

See Also:

  • Field Details

    • CFN_RESOURCE_TYPE_NAME

      @Stability(Stable) public static final String CFN_RESOURCE_TYPE_NAME
      The CloudFormation resource type name for this resource class.

  • Constructor Details

    • CfnUserDefinedFunction

      protected CfnUserDefinedFunction(software.amazon.jsii.JsiiObjectRef objRef)

    • CfnUserDefinedFunction

      protected CfnUserDefinedFunction(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)

    • CfnUserDefinedFunction

      @Stability(Stable) public CfnUserDefinedFunction(@NotNull software.constructs.Construct scope, @NotNull String id, @NotNull CfnUserDefinedFunctionProps props)
      Create a new AWS::Glue::UserDefinedFunction.

      Parameters:
      scope - Scope in which this resource is defined. This parameter is required.
      id - Construct identifier for this resource (unique in its scope). This parameter is required.
      props - Resource properties. This parameter is required.

  • Method Details

    • arnForUserDefinedFunction

      @Stability(Stable) @NotNull public static String arnForUserDefinedFunction(@NotNull IUserDefinedFunctionRef resource)
      Parameters:
      resource - This parameter is required.

    • isCfnUserDefinedFunction

      @Stability(Stable) @NotNull public static Boolean isCfnUserDefinedFunction(@NotNull Object x)
      Checks whether the given object is a CfnUserDefinedFunction.

      Parameters:
      x - This parameter is required.

    • inspect

      @Stability(Stable) public void inspect(@NotNull TreeInspector inspector)
      Examines the CloudFormation resource and discloses attributes.

      Specified by:
      inspect in interface IInspectable
      Parameters:
      inspector - tree inspector to collect and process attributes. This parameter is required.

    • renderProperties

      @Stability(Stable) @NotNull protected Map<String,Object> renderProperties(@NotNull Map<String,Object> props)
      Overrides:
      renderProperties in class CfnResource
      Parameters:
      props - This parameter is required.

    • getAttrArn

      @Stability(Stable) @NotNull public String getAttrArn()
      The Amazon Resource Name (ARN) of the user-defined function.

    • getCfnProperties

      @Stability(Stable) @NotNull protected Map<String,Object> getCfnProperties()
      Overrides:
      getCfnProperties in class CfnResource

    • getCfnPropertyNames

      @Stability(Stable) @NotNull protected Map<String,String> getCfnPropertyNames()
      Overrides:
      getCfnPropertyNames in class CfnResource

    • getUserDefinedFunctionRef

      @Stability(Stable) @NotNull public UserDefinedFunctionReference getUserDefinedFunctionRef()
      A reference to a UserDefinedFunction resource.
      Specified by:
      getUserDefinedFunctionRef in interface IUserDefinedFunctionRef

    • getDatabaseName

      @Stability(Stable) @NotNull public String getDatabaseName()
      The name of the catalog database in which the function is located.

    • setDatabaseName

      @Stability(Stable) public void setDatabaseName(@NotNull String value)
      The name of the catalog database in which the function is located.

    • getFunctionName

      @Stability(Stable) @NotNull public String getFunctionName()
      The name of the function.

    • setFunctionName

      @Stability(Stable) public void setFunctionName(@NotNull String value)
      The name of the function.

    • getClassName

      @Stability(Stable) @Nullable public String getClassName()
      The Java class that contains the function code.

    • setClassName

      @Stability(Stable) public void setClassName(@Nullable String value)
      The Java class that contains the function code.

    • getFunctionType

      @Stability(Stable) @Nullable public String getFunctionType()
      The type of the function.

    • setFunctionType

      @Stability(Stable) public void setFunctionType(@Nullable String value)
      The type of the function.

    • getOwnerName

      @Stability(Stable) @Nullable public String getOwnerName()
      The owner of the function.

    • setOwnerName

      @Stability(Stable) public void setOwnerName(@Nullable String value)
      The owner of the function.

    • getOwnerType

      @Stability(Stable) @Nullable public String getOwnerType()
      The owner type.

    • setOwnerType

      @Stability(Stable) public void setOwnerType(@Nullable String value)
      The owner type.

    • getResourceUris

      @Stability(Stable) @Nullable public Object getResourceUris()
      The resource URIs for the function.

      Returns union: either IResolvable or Listinvalid input: '<'either IResolvable or CfnUserDefinedFunction.ResourceUriProperty>

    • setResourceUris

      @Stability(Stable) public void setResourceUris(@Nullable IResolvable value)
      The resource URIs for the function.

    • setResourceUris

      @Stability(Stable) public void setResourceUris(@Nullable List<Object> value)
      The resource URIs for the function.