software.amazon.awscdk.services.sam

Class CfnFunction

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.sam.CfnFunction

All Implemented Interfaces:

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

@Generated(value="jsii-pacmak/1.30.0 (build adae23f)",
           date="2021-06-30T10:01:38.255Z")
 @Stability(value=Stable)
public class CfnFunction
extends CfnResource
implements IInspectable

A CloudFormation `AWS::Serverless::Function`.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	CfnFunction.AlexaSkillEventProperty
static interface	CfnFunction.ApiEventProperty
static interface	CfnFunction.BucketSAMPTProperty
static class	CfnFunction.Builder A fluent builder for CfnFunction.
static interface	CfnFunction.CloudWatchEventEventProperty
static interface	CfnFunction.CloudWatchLogsEventProperty
static interface	CfnFunction.CollectionSAMPTProperty
static interface	CfnFunction.DeadLetterQueueProperty
static interface	CfnFunction.DeploymentPreferenceProperty
static interface	CfnFunction.DestinationConfigProperty
static interface	CfnFunction.DomainSAMPTProperty
static interface	CfnFunction.DynamoDBEventProperty
static interface	CfnFunction.EmptySAMPTProperty
static interface	CfnFunction.EventBridgeRuleEventProperty
static interface	CfnFunction.EventSourceProperty
static interface	CfnFunction.FileSystemConfigProperty
static interface	CfnFunction.FunctionEnvironmentProperty
static interface	CfnFunction.FunctionSAMPTProperty
static interface	CfnFunction.IAMPolicyDocumentProperty
static interface	CfnFunction.IdentitySAMPTProperty
static interface	CfnFunction.IoTRuleEventProperty
static interface	CfnFunction.KeySAMPTProperty
static interface	CfnFunction.KinesisEventProperty
static interface	CfnFunction.LogGroupSAMPTProperty
static interface	CfnFunction.OnFailureProperty
static interface	CfnFunction.ProvisionedConcurrencyConfigProperty
static interface	CfnFunction.QueueSAMPTProperty
static interface	CfnFunction.S3EventProperty
static interface	CfnFunction.S3KeyFilterProperty
static interface	CfnFunction.S3KeyFilterRuleProperty
static interface	CfnFunction.S3LocationProperty
static interface	CfnFunction.S3NotificationFilterProperty
static interface	CfnFunction.SAMPolicyTemplateProperty
static interface	CfnFunction.ScheduleEventProperty
static interface	CfnFunction.SNSEventProperty
static interface	CfnFunction.SQSEventProperty
static interface	CfnFunction.StateMachineSAMPTProperty
static interface	CfnFunction.StreamSAMPTProperty
static interface	CfnFunction.TableSAMPTProperty
static interface	CfnFunction.TableStreamSAMPTProperty
static interface	CfnFunction.TopicSAMPTProperty
static interface	CfnFunction.VpcConfigProperty

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.
static String	REQUIRED_TRANSFORM The `Transform` a template must use in order to use this resource.

Constructor Summary

Constructors

Modifier	Constructor and Description
	CfnFunction(software.constructs.Construct scope, String id, CfnFunctionProps props) Create a new `AWS::Serverless::Function`.
protected	CfnFunction(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
protected	CfnFunction(software.amazon.jsii.JsiiObjectRef objRef)

Method Summary

Modifier and Type	Method and Description
String	getAutoPublishAlias() `AWS::Serverless::Function.AutoPublishAlias`.
protected Map<String,Object>	getCfnProperties()
Object	getCodeUri() `AWS::Serverless::Function.CodeUri`.
Object	getDeadLetterQueue() `AWS::Serverless::Function.DeadLetterQueue`.
Object	getDeploymentPreference() `AWS::Serverless::Function.DeploymentPreference`.
String	getDescription() `AWS::Serverless::Function.Description`.
Object	getEnvironment() `AWS::Serverless::Function.Environment`.
Object	getEvents() `AWS::Serverless::Function.Events`.
Object	getFileSystemConfigs() `AWS::Serverless::Function.FileSystemConfigs`.
String	getFunctionName() `AWS::Serverless::Function.FunctionName`.
String	getHandler() `AWS::Serverless::Function.Handler`.
String	getKmsKeyArn() `AWS::Serverless::Function.KmsKeyArn`.
List<String>	getLayers() `AWS::Serverless::Function.Layers`.
Number	getMemorySize() `AWS::Serverless::Function.MemorySize`.
String	getPermissionsBoundary() `AWS::Serverless::Function.PermissionsBoundary`.
Object	getPolicies() `AWS::Serverless::Function.Policies`.
Object	getProvisionedConcurrencyConfig() `AWS::Serverless::Function.ProvisionedConcurrencyConfig`.
Number	getReservedConcurrentExecutions() `AWS::Serverless::Function.ReservedConcurrentExecutions`.
String	getRole() `AWS::Serverless::Function.Role`.
String	getRuntime() `AWS::Serverless::Function.Runtime`.
TagManager	getTags() `AWS::Serverless::Function.Tags`.
Number	getTimeout() `AWS::Serverless::Function.Timeout`.
String	getTracing() `AWS::Serverless::Function.Tracing`.
Object	getVpcConfig() `AWS::Serverless::Function.VpcConfig`.
void	inspect(TreeInspector inspector) Examines the CloudFormation resource and discloses attributes.
protected Map<String,Object>	renderProperties(Map<String,Object> props)
void	setAutoPublishAlias(String value) `AWS::Serverless::Function.AutoPublishAlias`.
void	setCodeUri(CfnFunction.S3LocationProperty value) `AWS::Serverless::Function.CodeUri`.
void	setCodeUri(IResolvable value) `AWS::Serverless::Function.CodeUri`.
void	setCodeUri(String value) `AWS::Serverless::Function.CodeUri`.
void	setDeadLetterQueue(CfnFunction.DeadLetterQueueProperty value) `AWS::Serverless::Function.DeadLetterQueue`.
void	setDeadLetterQueue(IResolvable value) `AWS::Serverless::Function.DeadLetterQueue`.
void	setDeploymentPreference(CfnFunction.DeploymentPreferenceProperty value) `AWS::Serverless::Function.DeploymentPreference`.
void	setDeploymentPreference(IResolvable value) `AWS::Serverless::Function.DeploymentPreference`.
void	setDescription(String value) `AWS::Serverless::Function.Description`.
void	setEnvironment(CfnFunction.FunctionEnvironmentProperty value) `AWS::Serverless::Function.Environment`.
void	setEnvironment(IResolvable value) `AWS::Serverless::Function.Environment`.
void	setEvents(IResolvable value) `AWS::Serverless::Function.Events`.
void	setEvents(Map<String,Object> value) `AWS::Serverless::Function.Events`.
void	setFileSystemConfigs(IResolvable value) `AWS::Serverless::Function.FileSystemConfigs`.
void	setFileSystemConfigs(List<Object> value) `AWS::Serverless::Function.FileSystemConfigs`.
void	setFunctionName(String value) `AWS::Serverless::Function.FunctionName`.
void	setHandler(String value) `AWS::Serverless::Function.Handler`.
void	setKmsKeyArn(String value) `AWS::Serverless::Function.KmsKeyArn`.
void	setLayers(List<String> value) `AWS::Serverless::Function.Layers`.
void	setMemorySize(Number value) `AWS::Serverless::Function.MemorySize`.
void	setPermissionsBoundary(String value) `AWS::Serverless::Function.PermissionsBoundary`.
void	setPolicies(CfnFunction.IAMPolicyDocumentProperty value) `AWS::Serverless::Function.Policies`.
void	setPolicies(IResolvable value) `AWS::Serverless::Function.Policies`.
void	setPolicies(List<Object> value) `AWS::Serverless::Function.Policies`.
void	setPolicies(String value) `AWS::Serverless::Function.Policies`.
void	setProvisionedConcurrencyConfig(CfnFunction.ProvisionedConcurrencyConfigProperty value) `AWS::Serverless::Function.ProvisionedConcurrencyConfig`.
void	setProvisionedConcurrencyConfig(IResolvable value) `AWS::Serverless::Function.ProvisionedConcurrencyConfig`.
void	setReservedConcurrentExecutions(Number value) `AWS::Serverless::Function.ReservedConcurrentExecutions`.
void	setRole(String value) `AWS::Serverless::Function.Role`.
void	setRuntime(String value) `AWS::Serverless::Function.Runtime`.
void	setTimeout(Number value) `AWS::Serverless::Function.Timeout`.
void	setTracing(String value) `AWS::Serverless::Function.Tracing`.
void	setVpcConfig(CfnFunction.VpcConfigProperty value) `AWS::Serverless::Function.VpcConfig`.
void	setVpcConfig(IResolvable value) `AWS::Serverless::Function.VpcConfig`.

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.

REQUIRED_TRANSFORM

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

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

Constructor Detail

CfnFunction

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

CfnFunction

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

CfnFunction

@Stability(value=Stable)
public CfnFunction(@NotNull
                                            software.constructs.Construct scope,
                                            @NotNull
                                            String id,
                                            @NotNull
                                            CfnFunctionProps props)

Create a new `AWS::Serverless::Function`.

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.

getCfnProperties

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

Overrides:

getCfnProperties in class CfnResource

getTags

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

`AWS::Serverless::Function.Tags`.

getCodeUri

@Stability(value=Stable)
 @NotNull
public Object getCodeUri()

`AWS::Serverless::Function.CodeUri`.

setCodeUri

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

`AWS::Serverless::Function.CodeUri`.

setCodeUri

@Stability(value=Stable)
public void setCodeUri(@NotNull
                                                CfnFunction.S3LocationProperty value)

`AWS::Serverless::Function.CodeUri`.

setCodeUri

@Stability(value=Stable)
public void setCodeUri(@NotNull
                                                IResolvable value)

`AWS::Serverless::Function.CodeUri`.

getHandler

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

`AWS::Serverless::Function.Handler`.

setHandler

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

`AWS::Serverless::Function.Handler`.

getRuntime

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

`AWS::Serverless::Function.Runtime`.

setRuntime

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

`AWS::Serverless::Function.Runtime`.

getAutoPublishAlias

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

`AWS::Serverless::Function.AutoPublishAlias`.

setAutoPublishAlias

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

`AWS::Serverless::Function.AutoPublishAlias`.

getDeadLetterQueue

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

`AWS::Serverless::Function.DeadLetterQueue`.

setDeadLetterQueue

@Stability(value=Stable)
public void setDeadLetterQueue(@Nullable
                                                        CfnFunction.DeadLetterQueueProperty value)

`AWS::Serverless::Function.DeadLetterQueue`.

setDeadLetterQueue

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

`AWS::Serverless::Function.DeadLetterQueue`.

getDeploymentPreference

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

`AWS::Serverless::Function.DeploymentPreference`.

setDeploymentPreference

@Stability(value=Stable)
public void setDeploymentPreference(@Nullable
                                                             CfnFunction.DeploymentPreferenceProperty value)

`AWS::Serverless::Function.DeploymentPreference`.

setDeploymentPreference

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

`AWS::Serverless::Function.DeploymentPreference`.

getDescription

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

`AWS::Serverless::Function.Description`.

setDescription

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

`AWS::Serverless::Function.Description`.

getEnvironment

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

`AWS::Serverless::Function.Environment`.

setEnvironment

@Stability(value=Stable)
public void setEnvironment(@Nullable
                                                    CfnFunction.FunctionEnvironmentProperty value)

`AWS::Serverless::Function.Environment`.

setEnvironment

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

`AWS::Serverless::Function.Environment`.

getEvents

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

`AWS::Serverless::Function.Events`.

setEvents

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

`AWS::Serverless::Function.Events`.

setEvents

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

`AWS::Serverless::Function.Events`.

getFileSystemConfigs

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

`AWS::Serverless::Function.FileSystemConfigs`.

setFileSystemConfigs

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

`AWS::Serverless::Function.FileSystemConfigs`.

setFileSystemConfigs

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

`AWS::Serverless::Function.FileSystemConfigs`.

getFunctionName

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

`AWS::Serverless::Function.FunctionName`.

setFunctionName

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

`AWS::Serverless::Function.FunctionName`.

getKmsKeyArn

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

`AWS::Serverless::Function.KmsKeyArn`.

setKmsKeyArn

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

`AWS::Serverless::Function.KmsKeyArn`.

getLayers

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

`AWS::Serverless::Function.Layers`.

setLayers

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

`AWS::Serverless::Function.Layers`.

getMemorySize

@Stability(value=Stable)
 @Nullable
public Number getMemorySize()

`AWS::Serverless::Function.MemorySize`.

setMemorySize

@Stability(value=Stable)
public void setMemorySize(@Nullable
                                                   Number value)

`AWS::Serverless::Function.MemorySize`.

getPermissionsBoundary

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

`AWS::Serverless::Function.PermissionsBoundary`.

setPermissionsBoundary

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

`AWS::Serverless::Function.PermissionsBoundary`.

getPolicies

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

`AWS::Serverless::Function.Policies`.

setPolicies

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

`AWS::Serverless::Function.Policies`.

setPolicies

@Stability(value=Stable)
public void setPolicies(@Nullable
                                                 CfnFunction.IAMPolicyDocumentProperty value)

`AWS::Serverless::Function.Policies`.

setPolicies

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

`AWS::Serverless::Function.Policies`.

setPolicies

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

`AWS::Serverless::Function.Policies`.

getProvisionedConcurrencyConfig

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

`AWS::Serverless::Function.ProvisionedConcurrencyConfig`.

setProvisionedConcurrencyConfig

@Stability(value=Stable)
public void setProvisionedConcurrencyConfig(@Nullable
                                                                     CfnFunction.ProvisionedConcurrencyConfigProperty value)

`AWS::Serverless::Function.ProvisionedConcurrencyConfig`.

setProvisionedConcurrencyConfig

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

`AWS::Serverless::Function.ProvisionedConcurrencyConfig`.

getReservedConcurrentExecutions

@Stability(value=Stable)
 @Nullable
public Number getReservedConcurrentExecutions()

`AWS::Serverless::Function.ReservedConcurrentExecutions`.

setReservedConcurrentExecutions

@Stability(value=Stable)
public void setReservedConcurrentExecutions(@Nullable
                                                                     Number value)

`AWS::Serverless::Function.ReservedConcurrentExecutions`.

getRole

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

`AWS::Serverless::Function.Role`.

setRole

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

`AWS::Serverless::Function.Role`.

getTimeout

@Stability(value=Stable)
 @Nullable
public Number getTimeout()

`AWS::Serverless::Function.Timeout`.

setTimeout

@Stability(value=Stable)
public void setTimeout(@Nullable
                                                Number value)

`AWS::Serverless::Function.Timeout`.

getTracing

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

`AWS::Serverless::Function.Tracing`.

setTracing

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

`AWS::Serverless::Function.Tracing`.

getVpcConfig

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

`AWS::Serverless::Function.VpcConfig`.

setVpcConfig

@Stability(value=Stable)
public void setVpcConfig(@Nullable
                                                  CfnFunction.VpcConfigProperty value)

`AWS::Serverless::Function.VpcConfig`.

setVpcConfig

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

`AWS::Serverless::Function.VpcConfig`.