software.amazon.awscdk.services.greengrass

Class CfnFunctionDefinition

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.greengrass.CfnFunctionDefinition

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:06.688Z")
 @Stability(value=Stable)
public class CfnFunctionDefinition
extends CfnResource
implements IInspectable

A CloudFormation `AWS::Greengrass::FunctionDefinition`.

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.greengrass.*;
 Object tags;
 Object variables;
 CfnFunctionDefinition cfnFunctionDefinition = CfnFunctionDefinition.Builder.create(this, "MyCfnFunctionDefinition")
         .name("name")
         // the properties below are optional
         .initialVersion(FunctionDefinitionVersionProperty.builder()
                 .functions(List.of(FunctionProperty.builder()
                         .functionArn("functionArn")
                         .functionConfiguration(FunctionConfigurationProperty.builder()
                                 .encodingType("encodingType")
                                 .environment(EnvironmentProperty.builder()
                                         .accessSysfs(false)
                                         .execution(ExecutionProperty.builder()
                                                 .isolationMode("isolationMode")
                                                 .runAs(RunAsProperty.builder()
                                                         .gid(123)
                                                         .uid(123)
                                                         .build())
                                                 .build())
                                         .resourceAccessPolicies(List.of(ResourceAccessPolicyProperty.builder()
                                                 .resourceId("resourceId")
                                                 // the properties below are optional
                                                 .permission("permission")
                                                 .build()))
                                         .variables(variables)
                                         .build())
                                 .execArgs("execArgs")
                                 .executable("executable")
                                 .memorySize(123)
                                 .pinned(false)
                                 .timeout(123)
                                 .build())
                         .id("id")
                         .build()))
                 // the properties below are optional
                 .defaultConfig(DefaultConfigProperty.builder()
                         .execution(ExecutionProperty.builder()
                                 .isolationMode("isolationMode")
                                 .runAs(RunAsProperty.builder()
                                         .gid(123)
                                         .uid(123)
                                         .build())
                                 .build())
                         .build())
                 .build())
         .tags(tags)
         .build();
 

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	CfnFunctionDefinition.Builder A fluent builder for CfnFunctionDefinition.
static interface	CfnFunctionDefinition.DefaultConfigProperty Example:
static interface	CfnFunctionDefinition.EnvironmentProperty Example:
static interface	CfnFunctionDefinition.ExecutionProperty Example:
static interface	CfnFunctionDefinition.FunctionConfigurationProperty Example:
static interface	CfnFunctionDefinition.FunctionDefinitionVersionProperty Example:
static interface	CfnFunctionDefinition.FunctionProperty Example:
static interface	CfnFunctionDefinition.ResourceAccessPolicyProperty Example:
static interface	CfnFunctionDefinition.RunAsProperty 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
	CfnFunctionDefinition(software.constructs.Construct scope, String id, CfnFunctionDefinitionProps props) Create a new `AWS::Greengrass::FunctionDefinition`.
protected	CfnFunctionDefinition(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
protected	CfnFunctionDefinition(software.amazon.jsii.JsiiObjectRef objRef)

Method Summary

Modifier and Type	Method and Description
String	getAttrArn()
String	getAttrId()
String	getAttrLatestVersionArn()
String	getAttrName()
protected Map<String,Object>	getCfnProperties()
Object	getInitialVersion() `AWS::Greengrass::FunctionDefinition.InitialVersion`.
String	getName() `AWS::Greengrass::FunctionDefinition.Name`.
TagManager	getTags() `AWS::Greengrass::FunctionDefinition.Tags`.
void	inspect(TreeInspector inspector) Examines the CloudFormation resource and discloses attributes.
protected Map<String,Object>	renderProperties(Map<String,Object> props)
void	setInitialVersion(CfnFunctionDefinition.FunctionDefinitionVersionProperty value) `AWS::Greengrass::FunctionDefinition.InitialVersion`.
void	setInitialVersion(IResolvable value) `AWS::Greengrass::FunctionDefinition.InitialVersion`.
void	setName(String value) `AWS::Greengrass::FunctionDefinition.Name`.

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

CfnFunctionDefinition

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

CfnFunctionDefinition

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

CfnFunctionDefinition

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

Create a new `AWS::Greengrass::FunctionDefinition`.

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.

getAttrArn

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

getAttrId

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

getAttrLatestVersionArn

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

getAttrName

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

getCfnProperties

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

Overrides:

getCfnProperties in class CfnResource

getInitialVersion

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

`AWS::Greengrass::FunctionDefinition.InitialVersion`.

setInitialVersion

@Stability(value=Stable)
public void setInitialVersion(@Nullable
                                                       CfnFunctionDefinition.FunctionDefinitionVersionProperty value)

`AWS::Greengrass::FunctionDefinition.InitialVersion`.

setInitialVersion

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

`AWS::Greengrass::FunctionDefinition.InitialVersion`.

getName

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

`AWS::Greengrass::FunctionDefinition.Name`.

setName

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

`AWS::Greengrass::FunctionDefinition.Name`.

getTags

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

`AWS::Greengrass::FunctionDefinition.Tags`.