Package software.amazon.awscdk.services.opsworks

Class CfnApp

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.opsworks.CfnApp
All Implemented Interfaces:
IInspectable, IEnvironmentAware, IAppRef, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct, software.constructs.IDependable
@Generated(value="jsii-pacmak/1.121.0 (build d7af9b9)", date="2025-12-18T18:20:14.219Z") @Stability(Stable) public class CfnApp extends CfnResource implements IInspectable, IAppRef
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-opsworks-app.html.

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.opsworks.*;
 CfnApp cfnApp = CfnApp.Builder.create(this, "MyCfnApp")
         .name("name")
         .stackId("stackId")
         .type("type")
         // the properties below are optional
         .appSource(SourceProperty.builder()
                 .password("password")
                 .revision("revision")
                 .sshKey("sshKey")
                 .type("type")
                 .url("url")
                 .username("username")
                 .build())
         .attributes(Map.of(
                 "attributesKey", "attributes"))
         .dataSources(List.of(DataSourceProperty.builder()
                 .arn("arn")
                 .databaseName("databaseName")
                 .type("type")
                 .build()))
         .description("description")
         .domains(List.of("domains"))
         .enableSsl(false)
         .environment(List.of(EnvironmentVariableProperty.builder()
                 .key("key")
                 .value("value")
                 // the properties below are optional
                 .secure(false)
                 .build()))
         .shortname("shortname")
         .sslConfiguration(SslConfigurationProperty.builder()
                 .certificate("certificate")
                 .chain("chain")
                 .privateKey("privateKey")
                 .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

    • CfnApp

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

    • CfnApp

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

    • CfnApp

      @Stability(Stable) public CfnApp(@NotNull software.constructs.Construct scope, @NotNull String id, @NotNull CfnAppProps props)
      Create a new AWS::OpsWorks::App.

      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

    • isCfnApp

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

      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.

    • getAppRef

      @Stability(Stable) @NotNull public AppReference getAppRef()
      A reference to a App resource.
      Specified by:
      getAppRef in interface IAppRef

    • getAttrId

      @Stability(Stable) @NotNull public String getAttrId()

    • getCfnProperties

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

    • getName

      @Stability(Stable) @NotNull public String getName()
      The app name.

    • setName

      @Stability(Stable) public void setName(@NotNull String value)
      The app name.

    • getStackId

      @Stability(Stable) @NotNull public String getStackId()
      The stack ID.

    • setStackId

      @Stability(Stable) public void setStackId(@NotNull String value)
      The stack ID.

    • getType

      @Stability(Stable) @NotNull public String getType()
      The app type.

    • setType

      @Stability(Stable) public void setType(@NotNull String value)
      The app type.

    • getAppSource

      @Stability(Stable) @Nullable public Object getAppSource()
      A Source object that specifies the app repository.

      Returns union: either IResolvable or CfnApp.SourceProperty

    • setAppSource

      @Stability(Stable) public void setAppSource(@Nullable IResolvable value)
      A Source object that specifies the app repository.

    • setAppSource

      @Stability(Stable) public void setAppSource(@Nullable CfnApp.SourceProperty value)
      A Source object that specifies the app repository.

    • getAttributes

      @Stability(Stable) @Nullable public Object getAttributes()
      One or more user-defined key/value pairs to be added to the stack attributes.

      Returns union: either Mapinvalid input: '<'String, String> or IResolvable

    • setAttributes

      @Stability(Stable) public void setAttributes(@Nullable Map<String,String> value)
      One or more user-defined key/value pairs to be added to the stack attributes.

    • setAttributes

      @Stability(Stable) public void setAttributes(@Nullable IResolvable value)
      One or more user-defined key/value pairs to be added to the stack attributes.

    • getDataSources

      @Stability(Stable) @Nullable public Object getDataSources()
      The app's data source.

      Returns union: either IResolvable or Listinvalid input: '<'either IResolvable or CfnApp.DataSourceProperty>

    • setDataSources

      @Stability(Stable) public void setDataSources(@Nullable IResolvable value)
      The app's data source.

    • setDataSources

      @Stability(Stable) public void setDataSources(@Nullable List<Object> value)
      The app's data source.

    • getDescription

      @Stability(Stable) @Nullable public String getDescription()
      A description of the app.

    • setDescription

      @Stability(Stable) public void setDescription(@Nullable String value)
      A description of the app.

    • getDomains

      @Stability(Stable) @Nullable public List<String> getDomains()
      The app virtual host settings, with multiple domains separated by commas.

    • setDomains

      @Stability(Stable) public void setDomains(@Nullable List<String> value)
      The app virtual host settings, with multiple domains separated by commas.

    • getEnableSsl

      @Stability(Stable) @Nullable public Object getEnableSsl()
      Whether to enable SSL for the app.

      Returns union: either Boolean or IResolvable

    • setEnableSsl

      @Stability(Stable) public void setEnableSsl(@Nullable Boolean value)
      Whether to enable SSL for the app.

    • setEnableSsl

      @Stability(Stable) public void setEnableSsl(@Nullable IResolvable value)
      Whether to enable SSL for the app.

    • getEnvironment

      @Stability(Stable) @Nullable public Object getEnvironment()
      An array of EnvironmentVariable objects that specify environment variables to be associated with the app.

      Returns union: either IResolvable or Listinvalid input: '<'either IResolvable or CfnApp.EnvironmentVariableProperty>

    • setEnvironment

      @Stability(Stable) public void setEnvironment(@Nullable IResolvable value)
      An array of EnvironmentVariable objects that specify environment variables to be associated with the app.

    • setEnvironment

      @Stability(Stable) public void setEnvironment(@Nullable List<Object> value)
      An array of EnvironmentVariable objects that specify environment variables to be associated with the app.

    • getShortname

      @Stability(Stable) @Nullable public String getShortname()
      The app's short name.

    • setShortname

      @Stability(Stable) public void setShortname(@Nullable String value)
      The app's short name.

    • getSslConfiguration

      @Stability(Stable) @Nullable public Object getSslConfiguration()
      An SslConfiguration object with the SSL configuration.

      Returns union: either IResolvable or CfnApp.SslConfigurationProperty

    • setSslConfiguration

      @Stability(Stable) public void setSslConfiguration(@Nullable IResolvable value)
      An SslConfiguration object with the SSL configuration.

    • setSslConfiguration

      @Stability(Stable) public void setSslConfiguration(@Nullable CfnApp.SslConfigurationProperty value)
      An SslConfiguration object with the SSL configuration.