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
,software.amazon.jsii.JsiiSerializable
,software.constructs.IConstruct
,software.constructs.IDependable
@Generated(value="jsii-pacmak/1.104.0 (build e79254c)",
date="2024-11-27T16:51:00.892Z")
@Stability(Stable)
public class CfnApp
extends CfnResource
implements IInspectable
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();
-
Nested Class Summary
Modifier and TypeClassDescriptionstatic final class
A fluent builder forCfnApp
.static interface
Example:static interface
Example:static interface
Example:static interface
Example:Nested classes/interfaces inherited from class software.amazon.jsii.JsiiObject
software.amazon.jsii.JsiiObject.InitializationMode
Nested classes/interfaces inherited from interface software.constructs.IConstruct
software.constructs.IConstruct.Jsii$Default
Nested classes/interfaces inherited from interface software.amazon.awscdk.IInspectable
IInspectable.Jsii$Default, IInspectable.Jsii$Proxy
-
Field Summary
Modifier and TypeFieldDescriptionstatic final String
The CloudFormation resource type name for this resource class. -
Constructor Summary
ModifierConstructorDescriptionprotected
CfnApp
(software.amazon.jsii.JsiiObject.InitializationMode initializationMode) protected
CfnApp
(software.amazon.jsii.JsiiObjectRef objRef) CfnApp
(software.constructs.Construct scope, String id, CfnAppProps props) -
Method Summary
Modifier and TypeMethodDescriptionASource
object that specifies the app repository.One or more user-defined key/value pairs to be added to the stack attributes.The app's data source.A description of the app.The app virtual host settings, with multiple domains separated by commas.Whether to enable SSL for the app.An array ofEnvironmentVariable
objects that specify environment variables to be associated with the app.getName()
The app name.The app's short name.AnSslConfiguration
object with the SSL configuration.The stack ID.getType()
The app type.void
inspect
(TreeInspector inspector) Examines the CloudFormation resource and discloses attributes.renderProperties
(Map<String, Object> props) void
setAppSource
(IResolvable value) ASource
object that specifies the app repository.void
ASource
object that specifies the app repository.void
setAttributes
(Map<String, String> value) One or more user-defined key/value pairs to be added to the stack attributes.void
setAttributes
(IResolvable value) One or more user-defined key/value pairs to be added to the stack attributes.void
setDataSources
(List<Object> value) The app's data source.void
setDataSources
(IResolvable value) The app's data source.void
setDescription
(String value) A description of the app.void
setDomains
(List<String> value) The app virtual host settings, with multiple domains separated by commas.void
setEnableSsl
(Boolean value) Whether to enable SSL for the app.void
setEnableSsl
(IResolvable value) Whether to enable SSL for the app.void
setEnvironment
(List<Object> value) An array ofEnvironmentVariable
objects that specify environment variables to be associated with the app.void
setEnvironment
(IResolvable value) An array ofEnvironmentVariable
objects that specify environment variables to be associated with the app.void
The app name.void
setShortname
(String value) The app's short name.void
setSslConfiguration
(IResolvable value) AnSslConfiguration
object with the SSL configuration.void
AnSslConfiguration
object with the SSL configuration.void
setStackId
(String value) The stack ID.void
The app type.Methods inherited from class software.amazon.awscdk.CfnResource
addDeletionOverride, addDependency, addDependsOn, addMetadata, addOverride, addPropertyDeletionOverride, addPropertyOverride, applyRemovalPolicy, applyRemovalPolicy, applyRemovalPolicy, getAtt, getAtt, getCfnOptions, getCfnResourceType, getMetadata, getUpdatedProperites, getUpdatedProperties, isCfnResource, obtainDependencies, obtainResourceDependencies, removeDependency, replaceDependency, shouldSynthesize, toString, validateProperties
Methods inherited from class software.amazon.awscdk.CfnRefElement
getRef
Methods inherited from class software.amazon.awscdk.CfnElement
getCreationStack, getLogicalId, getStack, isCfnElement, overrideLogicalId
Methods inherited from class software.constructs.Construct
getNode, isConstruct
Methods inherited from class software.amazon.jsii.JsiiObject
jsiiAsyncCall, jsiiAsyncCall, jsiiCall, jsiiCall, jsiiGet, jsiiGet, jsiiSet, jsiiStaticCall, jsiiStaticCall, jsiiStaticGet, jsiiStaticGet, jsiiStaticSet, jsiiStaticSet
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
Methods inherited from interface software.amazon.jsii.JsiiSerializable
$jsii$toJson
-
Field Details
-
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) - 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
-
inspect
Examines the CloudFormation resource and discloses attributes.- Specified by:
inspect
in interfaceIInspectable
- 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 classCfnResource
- Parameters:
props
- This parameter is required.
-
getAttrId
-
getCfnProperties
- Overrides:
getCfnProperties
in classCfnResource
-
getName
The app name. -
setName
The app name. -
getStackId
The stack ID. -
setStackId
The stack ID. -
getType
The app type. -
setType
The app type. -
getAppSource
ASource
object that specifies the app repository. -
setAppSource
ASource
object that specifies the app repository. -
setAppSource
ASource
object that specifies the app repository. -
getAttributes
One or more user-defined key/value pairs to be added to the stack attributes. -
setAttributes
One or more user-defined key/value pairs to be added to the stack attributes. -
setAttributes
One or more user-defined key/value pairs to be added to the stack attributes. -
getDataSources
The app's data source. -
setDataSources
The app's data source. -
setDataSources
The app's data source. -
getDescription
A description of the app. -
setDescription
A description of the app. -
getDomains
The app virtual host settings, with multiple domains separated by commas. -
setDomains
The app virtual host settings, with multiple domains separated by commas. -
getEnableSsl
Whether to enable SSL for the app. -
setEnableSsl
Whether to enable SSL for the app. -
setEnableSsl
Whether to enable SSL for the app. -
getEnvironment
An array ofEnvironmentVariable
objects that specify environment variables to be associated with the app. -
setEnvironment
An array ofEnvironmentVariable
objects that specify environment variables to be associated with the app. -
setEnvironment
An array ofEnvironmentVariable
objects that specify environment variables to be associated with the app. -
getShortname
The app's short name. -
setShortname
The app's short name. -
getSslConfiguration
AnSslConfiguration
object with the SSL configuration. -
setSslConfiguration
AnSslConfiguration
object with the SSL configuration. -
setSslConfiguration
AnSslConfiguration
object with the SSL configuration.
-