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, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct, software.constructs.IDependable

@Generated(value="jsii-pacmak/1.46.0 (build cd08c55)",
           date="2021-11-25T20:11:07.412Z")
 @Stability(value=Stable)
public class CfnApp
extends CfnResource
implements IInspectable

A CloudFormation `AWS::OpsWorks::App`.

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

Nested Classes

Modifier and Type	Class and Description
static class	CfnApp.Builder A fluent builder for CfnApp.
static interface	CfnApp.DataSourceProperty Example:
static interface	CfnApp.EnvironmentVariableProperty Example:
static interface	CfnApp.SourceProperty Example:
static interface	CfnApp.SslConfigurationProperty Example:

Nested classes/interfaces inherited from class software.amazon.jsii.JsiiObject

software.amazon.jsii.JsiiObject.InitializationMode

Nested classes/interfaces inherited from interface software.amazon.awscdk.IInspectable

IInspectable.Jsii$Default, IInspectable.Jsii$Proxy

Nested classes/interfaces inherited from interface software.constructs.IConstruct

software.constructs.IConstruct.Jsii$Default

Field Summary

Fields

Modifier and Type	Field and Description
static String	CFN_RESOURCE_TYPE_NAME The CloudFormation resource type name for this resource class.

Constructor Summary

Constructors

Modifier	Constructor and Description
	CfnApp(software.constructs.Construct scope, String id, CfnAppProps props) Create a new `AWS::OpsWorks::App`.
protected	CfnApp(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
protected	CfnApp(software.amazon.jsii.JsiiObjectRef objRef)

Method Summary

Modifier and Type	Method and Description
Object	getAppSource() `AWS::OpsWorks::App.AppSource`.
Object	getAttributes() `AWS::OpsWorks::App.Attributes`.
protected Map<String,Object>	getCfnProperties()
Object	getDataSources() `AWS::OpsWorks::App.DataSources`.
String	getDescription() `AWS::OpsWorks::App.Description`.
List<String>	getDomains() `AWS::OpsWorks::App.Domains`.
Object	getEnableSsl() `AWS::OpsWorks::App.EnableSsl`.
Object	getEnvironment() `AWS::OpsWorks::App.Environment`.
String	getName() `AWS::OpsWorks::App.Name`.
String	getShortname() `AWS::OpsWorks::App.Shortname`.
Object	getSslConfiguration() `AWS::OpsWorks::App.SslConfiguration`.
String	getStackId() `AWS::OpsWorks::App.StackId`.
String	getType() `AWS::OpsWorks::App.Type`.
void	inspect(TreeInspector inspector) Examines the CloudFormation resource and discloses attributes.
protected Map<String,Object>	renderProperties(Map<String,Object> props)
void	setAppSource(CfnApp.SourceProperty value) `AWS::OpsWorks::App.AppSource`.
void	setAppSource(IResolvable value) `AWS::OpsWorks::App.AppSource`.
void	setAttributes(IResolvable value) `AWS::OpsWorks::App.Attributes`.
void	setAttributes(Map<String,String> value) `AWS::OpsWorks::App.Attributes`.
void	setDataSources(IResolvable value) `AWS::OpsWorks::App.DataSources`.
void	setDataSources(List<Object> value) `AWS::OpsWorks::App.DataSources`.
void	setDescription(String value) `AWS::OpsWorks::App.Description`.
void	setDomains(List<String> value) `AWS::OpsWorks::App.Domains`.
void	setEnableSsl(Boolean value) `AWS::OpsWorks::App.EnableSsl`.
void	setEnableSsl(IResolvable value) `AWS::OpsWorks::App.EnableSsl`.
void	setEnvironment(IResolvable value) `AWS::OpsWorks::App.Environment`.
void	setEnvironment(List<Object> value) `AWS::OpsWorks::App.Environment`.
void	setName(String value) `AWS::OpsWorks::App.Name`.
void	setShortname(String value) `AWS::OpsWorks::App.Shortname`.
void	setSslConfiguration(CfnApp.SslConfigurationProperty value) `AWS::OpsWorks::App.SslConfiguration`.
void	setSslConfiguration(IResolvable value) `AWS::OpsWorks::App.SslConfiguration`.
void	setStackId(String value) `AWS::OpsWorks::App.StackId`.
void	setType(String value) `AWS::OpsWorks::App.Type`.

Methods inherited from class software.amazon.awscdk.CfnResource

addDeletionOverride, addDependsOn, addMetadata, addOverride, addPropertyDeletionOverride, addPropertyOverride, applyRemovalPolicy, applyRemovalPolicy, applyRemovalPolicy, getAtt, getCfnOptions, getCfnResourceType, getMetadata, getUpdatedProperites, isCfnResource, 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 Detail

CFN_RESOURCE_TYPE_NAME

@Stability(value=Stable)
public static final String CFN_RESOURCE_TYPE_NAME

The CloudFormation resource type name for this resource class.

Constructor Detail

CfnApp

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

CfnApp

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

CfnApp

@Stability(value=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 - - scoped id of the resource. This parameter is required.

props - - resource properties. This parameter is required.

Method Detail

inspect

@Stability(value=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(value=Stable)
 @NotNull
protected Map<String,Object> renderProperties(@NotNull
                                                                                 Map<String,Object> props)

Overrides:

renderProperties in class CfnResource

Parameters:

props - This parameter is required.

getAppSource

@Stability(value=Stable)
 @Nullable
public Object getAppSource()

`AWS::OpsWorks::App.AppSource`.

setAppSource

@Stability(value=Stable)
public void setAppSource(@Nullable
                                                  CfnApp.SourceProperty value)

`AWS::OpsWorks::App.AppSource`.

setAppSource

@Stability(value=Stable)
public void setAppSource(@Nullable
                                                  IResolvable value)

`AWS::OpsWorks::App.AppSource`.

getAttributes

@Stability(value=Stable)
 @Nullable
public Object getAttributes()

`AWS::OpsWorks::App.Attributes`.

setAttributes

@Stability(value=Stable)
public void setAttributes(@Nullable
                                                   IResolvable value)

`AWS::OpsWorks::App.Attributes`.

setAttributes

@Stability(value=Stable)
public void setAttributes(@Nullable
                                                   Map<String,String> value)

`AWS::OpsWorks::App.Attributes`.

getCfnProperties

@Stability(value=Stable)
 @NotNull
protected Map<String,Object> getCfnProperties()

Overrides:

getCfnProperties in class CfnResource

getDataSources

@Stability(value=Stable)
 @Nullable
public Object getDataSources()

`AWS::OpsWorks::App.DataSources`.

setDataSources

@Stability(value=Stable)
public void setDataSources(@Nullable
                                                    IResolvable value)

`AWS::OpsWorks::App.DataSources`.

setDataSources

@Stability(value=Stable)
public void setDataSources(@Nullable
                                                    List<Object> value)

`AWS::OpsWorks::App.DataSources`.

getDescription

@Stability(value=Stable)
 @Nullable
public String getDescription()

`AWS::OpsWorks::App.Description`.

setDescription

@Stability(value=Stable)
public void setDescription(@Nullable
                                                    String value)

`AWS::OpsWorks::App.Description`.

getDomains

@Stability(value=Stable)
 @Nullable
public List<String> getDomains()

`AWS::OpsWorks::App.Domains`.

setDomains

@Stability(value=Stable)
public void setDomains(@Nullable
                                                List<String> value)

`AWS::OpsWorks::App.Domains`.

getEnableSsl

@Stability(value=Stable)
 @Nullable
public Object getEnableSsl()

`AWS::OpsWorks::App.EnableSsl`.

setEnableSsl

@Stability(value=Stable)
public void setEnableSsl(@Nullable
                                                  Boolean value)

`AWS::OpsWorks::App.EnableSsl`.

setEnableSsl

@Stability(value=Stable)
public void setEnableSsl(@Nullable
                                                  IResolvable value)

`AWS::OpsWorks::App.EnableSsl`.

getEnvironment

@Stability(value=Stable)
 @Nullable
public Object getEnvironment()

`AWS::OpsWorks::App.Environment`.

setEnvironment

@Stability(value=Stable)
public void setEnvironment(@Nullable
                                                    IResolvable value)

`AWS::OpsWorks::App.Environment`.

setEnvironment

@Stability(value=Stable)
public void setEnvironment(@Nullable
                                                    List<Object> value)

`AWS::OpsWorks::App.Environment`.

getName

@Stability(value=Stable)
 @NotNull
public String getName()

`AWS::OpsWorks::App.Name`.

setName

@Stability(value=Stable)
public void setName(@NotNull
                                             String value)

`AWS::OpsWorks::App.Name`.

getShortname

@Stability(value=Stable)
 @Nullable
public String getShortname()

`AWS::OpsWorks::App.Shortname`.

setShortname

@Stability(value=Stable)
public void setShortname(@Nullable
                                                  String value)

`AWS::OpsWorks::App.Shortname`.

getSslConfiguration

@Stability(value=Stable)
 @Nullable
public Object getSslConfiguration()

`AWS::OpsWorks::App.SslConfiguration`.

setSslConfiguration

@Stability(value=Stable)
public void setSslConfiguration(@Nullable
                                                         CfnApp.SslConfigurationProperty value)

`AWS::OpsWorks::App.SslConfiguration`.

setSslConfiguration

@Stability(value=Stable)
public void setSslConfiguration(@Nullable
                                                         IResolvable value)

`AWS::OpsWorks::App.SslConfiguration`.

getStackId

@Stability(value=Stable)
 @NotNull
public String getStackId()

`AWS::OpsWorks::App.StackId`.

setStackId

@Stability(value=Stable)
public void setStackId(@NotNull
                                                String value)

`AWS::OpsWorks::App.StackId`.

getType

@Stability(value=Stable)
 @NotNull
public String getType()

`AWS::OpsWorks::App.Type`.

setType

@Stability(value=Stable)
public void setType(@NotNull
                                             String value)

`AWS::OpsWorks::App.Type`.