Package software.amazon.awscdk.services.sam

Class CfnApplication

java.lang.Object

software.amazon.jsii.JsiiObject

software.constructs.Construct

software.amazon.awscdk.core.Construct

software.amazon.awscdk.core.CfnElement

software.amazon.awscdk.core.CfnRefElement

software.amazon.awscdk.core.CfnResource

software.amazon.awscdk.services.sam.CfnApplication

All Implemented Interfaces:

IConstruct, IDependable, IInspectable, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct

@Generated(value="jsii-pacmak/1.84.0 (build 5404dcf)",
           date="2023-06-19T16:30:35.589Z")
@Stability(Stable)
public class CfnApplication
extends CfnResource
implements IInspectable

A CloudFormation AWS::Serverless::Application.

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.sam.*;
 CfnApplication cfnApplication = CfnApplication.Builder.create(this, "MyCfnApplication")
         .location("location")
         // the properties below are optional
         .notificationArns(List.of("notificationArns"))
         .parameters(Map.of(
                 "parametersKey", "parameters"))
         .tags(Map.of(
                 "tagsKey", "tags"))
         .timeoutInMinutes(123)
         .build();
 

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	CfnApplication.ApplicationLocationProperty	Example:
static final class	CfnApplication.Builder	A fluent builder for CfnApplication.

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

software.amazon.jsii.JsiiObject.InitializationMode

Nested classes/interfaces inherited from interface software.amazon.awscdk.core.IConstruct

IConstruct.Jsii$Default

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

software.constructs.IConstruct.Jsii$Default

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

IInspectable.Jsii$Default, IInspectable.Jsii$Proxy

Field Summary

Fields

Modifier and Type	Field	Description
static final String	CFN_RESOURCE_TYPE_NAME	The CloudFormation resource type name for this resource class.
static final String	REQUIRED_TRANSFORM	The Transform a template must use in order to use this resource.

Constructor Summary

Constructors

Modifier	Constructor	Description
	CfnApplication(Construct scope, String id, CfnApplicationProps props)	Create a new AWS::Serverless::Application.
protected	CfnApplication(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
protected	CfnApplication(software.amazon.jsii.JsiiObjectRef objRef)

Method Summary

Modifier and Type	Method	Description
protected Map<String,Object>	getCfnProperties()
Object	getLocation()	AWS::Serverless::Application.Location.
List<String>	getNotificationArns()	AWS::Serverless::Application.NotificationArns.
Object	getParameters()	AWS::Serverless::Application.Parameters.
TagManager	getTags()	AWS::Serverless::Application.Tags.
Number	getTimeoutInMinutes()	AWS::Serverless::Application.TimeoutInMinutes.
void	inspect(TreeInspector inspector)	Examines the CloudFormation resource and discloses attributes.
protected Map<String,Object>	renderProperties(Map<String,Object> props)
void	setLocation(String value)	AWS::Serverless::Application.Location.
void	setLocation(IResolvable value)	AWS::Serverless::Application.Location.
void	setLocation(CfnApplication.ApplicationLocationProperty value)	AWS::Serverless::Application.Location.
void	setNotificationArns(List<String> value)	AWS::Serverless::Application.NotificationArns.
void	setParameters(Map<String,String> value)	AWS::Serverless::Application.Parameters.
void	setParameters(IResolvable value)	AWS::Serverless::Application.Parameters.
void	setTimeoutInMinutes(Number value)	AWS::Serverless::Application.TimeoutInMinutes.

Methods inherited from class software.amazon.awscdk.core.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.core.CfnRefElement

getRef

Methods inherited from class software.amazon.awscdk.core.CfnElement

getCreationStack, getLogicalId, getStack, isCfnElement, overrideLogicalId

Methods inherited from class software.amazon.awscdk.core.Construct

getNode, isConstruct, onPrepare, onSynthesize, onValidate, prepare, synthesize, validate

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

@Stability(Stable)
public static final String CFN_RESOURCE_TYPE_NAME

The CloudFormation resource type name for this resource class.

REQUIRED_TRANSFORM

@Stability(Stable)
public static final String REQUIRED_TRANSFORM

The Transform a template must use in order to use this resource.

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
 Construct scope,
 @NotNull
 String id,
 @NotNull
 CfnApplicationProps props)

Create a new AWS::Serverless::Application.

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 Details

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.

getCfnProperties

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

Overrides:

getCfnProperties in class CfnResource

getTags

@Stability(Stable)
@NotNull
public TagManager getTags()

AWS::Serverless::Application.Tags.

getLocation

@Stability(Stable)
@NotNull
public Object getLocation()

AWS::Serverless::Application.Location.

setLocation

@Stability(Stable)
public void setLocation(@NotNull
 String value)

AWS::Serverless::Application.Location.

setLocation

@Stability(Stable)
public void setLocation(@NotNull
 IResolvable value)

AWS::Serverless::Application.Location.

setLocation

@Stability(Stable)
public void setLocation(@NotNull
 CfnApplication.ApplicationLocationProperty value)

AWS::Serverless::Application.Location.

getNotificationArns

@Stability(Stable)
@Nullable
public List<String> getNotificationArns()

AWS::Serverless::Application.NotificationArns.

setNotificationArns

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

AWS::Serverless::Application.NotificationArns.

getParameters

@Stability(Stable)
@Nullable
public Object getParameters()

AWS::Serverless::Application.Parameters.

setParameters

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

AWS::Serverless::Application.Parameters.

setParameters

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

AWS::Serverless::Application.Parameters.

getTimeoutInMinutes

@Stability(Stable)
@Nullable
public Number getTimeoutInMinutes()

AWS::Serverless::Application.TimeoutInMinutes.

setTimeoutInMinutes

@Stability(Stable)
public void setTimeoutInMinutes(@Nullable
 Number value)

AWS::Serverless::Application.TimeoutInMinutes.