Package software.amazon.awscdk.services.appintegrations

Class CfnApplication

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.appintegrations.CfnApplication
All Implemented Interfaces:
IInspectable, IApplicationRef, IEnvironmentAware, ITaggableV2, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct, software.constructs.IDependable
@Generated(value="jsii-pacmak/1.119.0 (build 1634eac)", date="2025-12-01T16:02:13.841Z") @Stability(Stable) public class CfnApplication extends CfnResource implements IInspectable, IApplicationRef, ITaggableV2
Creates and persists an Application resource.

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.appintegrations.*;
 CfnApplication cfnApplication = CfnApplication.Builder.create(this, "MyCfnApplication")
         .applicationSourceConfig(ApplicationSourceConfigProperty.builder()
                 .externalUrlConfig(ExternalUrlConfigProperty.builder()
                         .accessUrl("accessUrl")
                         // the properties below are optional
                         .approvedOrigins(List.of("approvedOrigins"))
                         .build())
                 .build())
         .description("description")
         .name("name")
         .namespace("namespace")
         // the properties below are optional
         .applicationConfig(ApplicationConfigProperty.builder()
                 .contactHandling(ContactHandlingProperty.builder()
                         .scope("scope")
                         .build())
                 .build())
         .iframeConfig(IframeConfigProperty.builder()
                 .allow(List.of("allow"))
                 .sandbox(List.of("sandbox"))
                 .build())
         .initializationTimeout(123)
         .isService(false)
         .permissions(List.of("permissions"))
         .tags(List.of(CfnTag.builder()
                 .key("key")
                 .value("value")
                 .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

    • CfnApplication

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

    • CfnApplication

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

    • CfnApplication

      @Stability(Stable) public CfnApplication(@NotNull software.constructs.Construct scope, @NotNull String id, @NotNull CfnApplicationProps props)
      Create a new AWS::AppIntegrations::Application.

      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

    • arnForApplication

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

    • isCfnApplication

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

      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.

    • getApplicationRef

      @Stability(Stable) @NotNull public ApplicationReference getApplicationRef()
      A reference to a Application resource.
      Specified by:
      getApplicationRef in interface IApplicationRef

    • getAttrApplicationArn

      @Stability(Stable) @NotNull public String getAttrApplicationArn()
      The Amazon Resource Name (ARN) of the Application.

    • getAttrId

      @Stability(Stable) @NotNull public String getAttrId()
      A unique identifier for the Application.

    • getCdkTagManager

      @Stability(Stable) @NotNull public TagManager getCdkTagManager()
      Tag Manager which manages the tags for this resource.
      Specified by:
      getCdkTagManager in interface ITaggableV2

    • getCfnProperties

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

    • getApplicationSourceConfig

      @Stability(Stable) @NotNull public Object getApplicationSourceConfig()
      The configuration for where the application should be loaded from.

      Returns union: either IResolvable or CfnApplication.ApplicationSourceConfigProperty

    • setApplicationSourceConfig

      @Stability(Stable) public void setApplicationSourceConfig(@NotNull IResolvable value)
      The configuration for where the application should be loaded from.

    • setApplicationSourceConfig

      @Stability(Stable) public void setApplicationSourceConfig(@NotNull CfnApplication.ApplicationSourceConfigProperty value)
      The configuration for where the application should be loaded from.

    • getDescription

      @Stability(Stable) @NotNull public String getDescription()
      The description of the application.

    • setDescription

      @Stability(Stable) public void setDescription(@NotNull String value)
      The description of the application.

    • getName

      @Stability(Stable) @NotNull public String getName()
      The name of the application.

    • setName

      @Stability(Stable) public void setName(@NotNull String value)
      The name of the application.

    • getNamespace

      @Stability(Stable) @NotNull public String getNamespace()
      The namespace of the application.

    • setNamespace

      @Stability(Stable) public void setNamespace(@NotNull String value)
      The namespace of the application.

    • getApplicationConfig

      @Stability(Stable) @Nullable public Object getApplicationConfig()
      Returns union: either IResolvable or CfnApplication.ApplicationConfigProperty

    • setApplicationConfig

      @Stability(Stable) public void setApplicationConfig(@Nullable IResolvable value)

    • setApplicationConfig

      @Stability(Stable) public void setApplicationConfig(@Nullable CfnApplication.ApplicationConfigProperty value)

    • getIframeConfig

      @Stability(Stable) @Nullable public Object getIframeConfig()
      Returns union: either IResolvable or CfnApplication.IframeConfigProperty

    • setIframeConfig

      @Stability(Stable) public void setIframeConfig(@Nullable IResolvable value)

    • setIframeConfig

      @Stability(Stable) public void setIframeConfig(@Nullable CfnApplication.IframeConfigProperty value)

    • getInitializationTimeout

      @Stability(Stable) @Nullable public Number getInitializationTimeout()
      The initialization timeout in milliseconds.

    • setInitializationTimeout

      @Stability(Stable) public void setInitializationTimeout(@Nullable Number value)
      The initialization timeout in milliseconds.

    • getIsService

      @Stability(Stable) @Nullable public Object getIsService()
      Indicates whether the application is a service.

      Returns union: either Boolean or IResolvable

    • setIsService

      @Stability(Stable) public void setIsService(@Nullable Boolean value)
      Indicates whether the application is a service.

    • setIsService

      @Stability(Stable) public void setIsService(@Nullable IResolvable value)
      Indicates whether the application is a service.

    • getPermissions

      @Stability(Stable) @Nullable public List<String> getPermissions()
      The configuration of events or requests that the application has access to.

    • setPermissions

      @Stability(Stable) public void setPermissions(@Nullable List<String> value)
      The configuration of events or requests that the application has access to.

    • getTags

      @Stability(Stable) @Nullable public List<CfnTag> getTags()
      The tags used to organize, track, or control access for this resource.

    • setTags

      @Stability(Stable) public void setTags(@Nullable List<CfnTag> value)
      The tags used to organize, track, or control access for this resource.