CfnFunction¶
-
class
aws_cdk.aws_sam.
CfnFunction
(scope, id, *, architectures=None, assume_role_policy_document=None, auto_publish_alias=None, auto_publish_code_sha256=None, code_signing_config_arn=None, code_uri=None, dead_letter_queue=None, deployment_preference=None, description=None, environment=None, event_invoke_config=None, events=None, file_system_configs=None, function_name=None, handler=None, image_config=None, image_uri=None, inline_code=None, kms_key_arn=None, layers=None, memory_size=None, package_type=None, permissions_boundary=None, policies=None, provisioned_concurrency_config=None, reserved_concurrent_executions=None, role=None, runtime=None, tags=None, timeout=None, tracing=None, version_description=None, vpc_config=None)¶ Bases:
aws_cdk.core.CfnResource
A CloudFormation
AWS::Serverless::Function
.- CloudformationResource
AWS::Serverless::Function
- Link
- ExampleMetadata
fixture=_generated
Example:
# The code below shows an example of how to instantiate this type. # The values are placeholders you should change. import aws_cdk.aws_sam as sam # assume_role_policy_document: Any cfn_function = sam.CfnFunction(self, "MyCfnFunction", architectures=["architectures"], assume_role_policy_document=assume_role_policy_document, auto_publish_alias="autoPublishAlias", auto_publish_code_sha256="autoPublishCodeSha256", code_signing_config_arn="codeSigningConfigArn", code_uri="codeUri", dead_letter_queue=sam.CfnFunction.DeadLetterQueueProperty( target_arn="targetArn", type="type" ), deployment_preference=sam.CfnFunction.DeploymentPreferenceProperty( enabled=False, type="type", # the properties below are optional alarms=["alarms"], hooks=sam.CfnFunction.HooksProperty( post_traffic="postTraffic", pre_traffic="preTraffic" ) ), description="description", environment=sam.CfnFunction.FunctionEnvironmentProperty( variables={ "variables_key": "variables" } ), event_invoke_config=sam.CfnFunction.EventInvokeConfigProperty( destination_config=sam.CfnFunction.EventInvokeDestinationConfigProperty( on_failure=sam.CfnFunction.DestinationProperty( destination="destination", # the properties below are optional type="type" ), on_success=sam.CfnFunction.DestinationProperty( destination="destination", # the properties below are optional type="type" ) ), maximum_event_age_in_seconds=123, maximum_retry_attempts=123 ), events={ "events_key": sam.CfnFunction.EventSourceProperty( properties=sam.CfnFunction.S3EventProperty( variables={ "variables_key": "variables" } ), type="type" ) }, file_system_configs=[sam.CfnFunction.FileSystemConfigProperty( arn="arn", local_mount_path="localMountPath" )], function_name="functionName", handler="handler", image_config=sam.CfnFunction.ImageConfigProperty( command=["command"], entry_point=["entryPoint"], working_directory="workingDirectory" ), image_uri="imageUri", inline_code="inlineCode", kms_key_arn="kmsKeyArn", layers=["layers"], memory_size=123, package_type="packageType", permissions_boundary="permissionsBoundary", policies="policies", provisioned_concurrency_config=sam.CfnFunction.ProvisionedConcurrencyConfigProperty( provisioned_concurrent_executions="provisionedConcurrentExecutions" ), reserved_concurrent_executions=123, role="role", runtime="runtime", tags={ "tags_key": "tags" }, timeout=123, tracing="tracing", version_description="versionDescription", vpc_config=sam.CfnFunction.VpcConfigProperty( security_group_ids=["securityGroupIds"], subnet_ids=["subnetIds"] ) )
Create a new
AWS::Serverless::Function
.- Parameters
scope (
Construct
) –scope in which this resource is defined.
id (
str
) –scoped id of the resource.
architectures (
Optional
[Sequence
[str
]]) –AWS::Serverless::Function.Architectures
.assume_role_policy_document (
Optional
[Any
]) –AWS::Serverless::Function.AssumeRolePolicyDocument
.auto_publish_alias (
Optional
[str
]) –AWS::Serverless::Function.AutoPublishAlias
.auto_publish_code_sha256 (
Optional
[str
]) –AWS::Serverless::Function.AutoPublishCodeSha256
.code_signing_config_arn (
Optional
[str
]) –AWS::Serverless::Function.CodeSigningConfigArn
.code_uri (
Union
[str
,IResolvable
,S3LocationProperty
,None
]) –AWS::Serverless::Function.CodeUri
.dead_letter_queue (
Union
[IResolvable
,DeadLetterQueueProperty
,None
]) –AWS::Serverless::Function.DeadLetterQueue
.deployment_preference (
Union
[IResolvable
,DeploymentPreferenceProperty
,None
]) –AWS::Serverless::Function.DeploymentPreference
.description (
Optional
[str
]) –AWS::Serverless::Function.Description
.environment (
Union
[IResolvable
,FunctionEnvironmentProperty
,None
]) –AWS::Serverless::Function.Environment
.event_invoke_config (
Union
[IResolvable
,EventInvokeConfigProperty
,None
]) –AWS::Serverless::Function.EventInvokeConfig
.events (
Union
[IResolvable
,Mapping
[str
,Union
[IResolvable
,EventSourceProperty
]],None
]) –AWS::Serverless::Function.Events
.file_system_configs (
Union
[IResolvable
,Sequence
[Union
[IResolvable
,FileSystemConfigProperty
]],None
]) –AWS::Serverless::Function.FileSystemConfigs
.function_name (
Optional
[str
]) –AWS::Serverless::Function.FunctionName
.handler (
Optional
[str
]) –AWS::Serverless::Function.Handler
.image_config (
Union
[IResolvable
,ImageConfigProperty
,None
]) –AWS::Serverless::Function.ImageConfig
.image_uri (
Optional
[str
]) –AWS::Serverless::Function.ImageUri
.inline_code (
Optional
[str
]) –AWS::Serverless::Function.InlineCode
.kms_key_arn (
Optional
[str
]) –AWS::Serverless::Function.KmsKeyArn
.layers (
Optional
[Sequence
[str
]]) –AWS::Serverless::Function.Layers
.memory_size (
Union
[int
,float
,None
]) –AWS::Serverless::Function.MemorySize
.package_type (
Optional
[str
]) –AWS::Serverless::Function.PackageType
.permissions_boundary (
Optional
[str
]) –AWS::Serverless::Function.PermissionsBoundary
.policies (
Union
[str
,IResolvable
,IAMPolicyDocumentProperty
,Sequence
[Union
[str
,IResolvable
,IAMPolicyDocumentProperty
,SAMPolicyTemplateProperty
]],None
]) –AWS::Serverless::Function.Policies
.provisioned_concurrency_config (
Union
[IResolvable
,ProvisionedConcurrencyConfigProperty
,None
]) –AWS::Serverless::Function.ProvisionedConcurrencyConfig
.reserved_concurrent_executions (
Union
[int
,float
,None
]) –AWS::Serverless::Function.ReservedConcurrentExecutions
.role (
Optional
[str
]) –AWS::Serverless::Function.Role
.runtime (
Optional
[str
]) –AWS::Serverless::Function.Runtime
.tags (
Optional
[Mapping
[str
,str
]]) –AWS::Serverless::Function.Tags
.timeout (
Union
[int
,float
,None
]) –AWS::Serverless::Function.Timeout
.tracing (
Optional
[str
]) –AWS::Serverless::Function.Tracing
.version_description (
Optional
[str
]) –AWS::Serverless::Function.VersionDescription
.vpc_config (
Union
[IResolvable
,VpcConfigProperty
,None
]) –AWS::Serverless::Function.VpcConfig
.
Methods
-
add_deletion_override
(path)¶ Syntactic sugar for
addOverride(path, undefined)
.- Parameters
path (
str
) – The path of the value to delete.- Return type
None
-
add_depends_on
(target)¶ Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned.
This can be used for resources across stacks (or nested stack) boundaries and the dependency will automatically be transferred to the relevant scope.
- Parameters
target (
CfnResource
) –- Return type
None
-
add_metadata
(key, value)¶ Add a value to the CloudFormation Resource Metadata.
- Parameters
key (
str
) –value (
Any
) –
- See
https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html
Note that this is a different set of metadata from CDK node metadata; this metadata ends up in the stack template under the resource, whereas CDK node metadata ends up in the Cloud Assembly.
- Return type
None
-
add_override
(path, value)¶ Adds an override to the synthesized CloudFormation resource.
To add a property override, either use
addPropertyOverride
or prefixpath
with “Properties.” (i.e.Properties.TopicName
).If the override is nested, separate each nested level using a dot (.) in the path parameter. If there is an array as part of the nesting, specify the index in the path.
To include a literal
.
in the property name, prefix with a\
. In most programming languages you will need to write this as"\\."
because the\
itself will need to be escaped.For example:
cfn_resource.add_override("Properties.GlobalSecondaryIndexes.0.Projection.NonKeyAttributes", ["myattribute"]) cfn_resource.add_override("Properties.GlobalSecondaryIndexes.1.ProjectionType", "INCLUDE")
would add the overrides Example:
"Properties": { "GlobalSecondaryIndexes": [ { "Projection": { "NonKeyAttributes": [ "myattribute" ] ... } ... }, { "ProjectionType": "INCLUDE" ... }, ] ... }
The
value
argument toaddOverride
will not be processed or translated in any way. Pass raw JSON values in here with the correct capitalization for CloudFormation. If you pass CDK classes or structs, they will be rendered with lowercased key names, and CloudFormation will reject the template.- Parameters
path (
str
) –The path of the property, you can use dot notation to override values in complex types. Any intermdediate keys will be created as needed.
value (
Any
) –The value. Could be primitive or complex.
- Return type
None
-
add_property_deletion_override
(property_path)¶ Adds an override that deletes the value of a property from the resource definition.
- Parameters
property_path (
str
) – The path to the property.- Return type
None
-
add_property_override
(property_path, value)¶ Adds an override to a resource property.
Syntactic sugar for
addOverride("Properties.<...>", value)
.- Parameters
property_path (
str
) – The path of the property.value (
Any
) – The value.
- Return type
None
-
apply_removal_policy
(policy=None, *, apply_to_update_replace_policy=None, default=None)¶ Sets the deletion policy of the resource based on the removal policy specified.
The Removal Policy controls what happens to this resource when it stops being managed by CloudFormation, either because you’ve removed it from the CDK application or because you’ve made a change that requires the resource to be replaced.
The resource can be deleted (
RemovalPolicy.DESTROY
), or left in your AWS account for data recovery and cleanup later (RemovalPolicy.RETAIN
).- Parameters
policy (
Optional
[RemovalPolicy
]) –apply_to_update_replace_policy (
Optional
[bool
]) – Apply the same deletion policy to the resource’s “UpdateReplacePolicy”. Default: truedefault (
Optional
[RemovalPolicy
]) – The default policy to apply in case the removal policy is not defined. Default: - Default value is resource specific. To determine the default value for a resoure, please consult that specific resource’s documentation.
- Return type
None
-
get_att
(attribute_name)¶ Returns a token for an runtime attribute of this resource.
Ideally, use generated attribute accessors (e.g.
resource.arn
), but this can be used for future compatibility in case there is no generated attribute.- Parameters
attribute_name (
str
) – The name of the attribute.- Return type
-
get_metadata
(key)¶ Retrieve a value value from the CloudFormation Resource Metadata.
- Parameters
key (
str
) –- See
https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html
Note that this is a different set of metadata from CDK node metadata; this metadata ends up in the stack template under the resource, whereas CDK node metadata ends up in the Cloud Assembly.
- Return type
Any
-
inspect
(inspector)¶ Examines the CloudFormation resource and discloses attributes.
- Parameters
inspector (
TreeInspector
) –tree inspector to collect and process attributes.
- Return type
None
-
override_logical_id
(new_logical_id)¶ Overrides the auto-generated logical ID with a specific ID.
- Parameters
new_logical_id (
str
) – The new logical ID to use for this stack element.- Return type
None
-
to_string
()¶ Returns a string representation of this construct.
- Return type
str
- Returns
a string representation of this resource
Attributes
-
CFN_RESOURCE_TYPE_NAME
= 'AWS::Serverless::Function'¶
-
REQUIRED_TRANSFORM
= 'AWS::Serverless-2016-10-31'¶
-
architectures
¶ AWS::Serverless::Function.Architectures
.- Link
- Return type
Optional
[List
[str
]]
-
assume_role_policy_document
¶ AWS::Serverless::Function.AssumeRolePolicyDocument
.
-
auto_publish_alias
¶ AWS::Serverless::Function.AutoPublishAlias
.- Link
- Return type
Optional
[str
]
-
auto_publish_code_sha256
¶ AWS::Serverless::Function.AutoPublishCodeSha256
.
-
cfn_options
¶ Options for this resource, such as condition, update policy etc.
- Return type
-
cfn_resource_type
¶ AWS resource type.
- Return type
str
-
code_signing_config_arn
¶ AWS::Serverless::Function.CodeSigningConfigArn
.
-
code_uri
¶ AWS::Serverless::Function.CodeUri
.- Link
- Return type
Union
[str
,IResolvable
,S3LocationProperty
,None
]
-
creation_stack
¶ return:
the stack trace of the point where this Resource was created from, sourced from the +metadata+ entry typed +aws:cdk:logicalId+, and with the bottom-most node +internal+ entries filtered.
- Return type
List
[str
]
-
dead_letter_queue
¶ AWS::Serverless::Function.DeadLetterQueue
.
-
deployment_preference
¶ AWS::Serverless::Function.DeploymentPreference
.
-
description
¶ AWS::Serverless::Function.Description
.- Link
- Return type
Optional
[str
]
-
environment
¶ AWS::Serverless::Function.Environment
.
-
event_invoke_config
¶ AWS::Serverless::Function.EventInvokeConfig
.
-
events
¶ AWS::Serverless::Function.Events
.- Link
- Return type
Union
[IResolvable
,Mapping
[str
,Union
[IResolvable
,EventSourceProperty
]],None
]
-
file_system_configs
¶ AWS::Serverless::Function.FileSystemConfigs
.- Link
- Return type
Union
[IResolvable
,List
[Union
[IResolvable
,FileSystemConfigProperty
]],None
]
-
function_name
¶ AWS::Serverless::Function.FunctionName
.- Link
- Return type
Optional
[str
]
-
handler
¶ AWS::Serverless::Function.Handler
.- Link
- Return type
Optional
[str
]
-
image_config
¶ AWS::Serverless::Function.ImageConfig
.
-
image_uri
¶ AWS::Serverless::Function.ImageUri
.
-
inline_code
¶ AWS::Serverless::Function.InlineCode
.- Link
- Return type
Optional
[str
]
-
kms_key_arn
¶ AWS::Serverless::Function.KmsKeyArn
.- Link
- Return type
Optional
[str
]
-
layers
¶ AWS::Serverless::Function.Layers
.- Link
- Return type
Optional
[List
[str
]]
-
logical_id
¶ The logical ID for this CloudFormation stack element.
The logical ID of the element is calculated from the path of the resource node in the construct tree.
To override this value, use
overrideLogicalId(newLogicalId)
.- Return type
str
- Returns
the logical ID as a stringified token. This value will only get resolved during synthesis.
-
memory_size
¶ AWS::Serverless::Function.MemorySize
.- Link
- Return type
Union
[int
,float
,None
]
-
node
¶ The construct tree node associated with this construct.
- Return type
-
package_type
¶ AWS::Serverless::Function.PackageType
.
-
permissions_boundary
¶ AWS::Serverless::Function.PermissionsBoundary
.- Link
- Return type
Optional
[str
]
-
policies
¶ AWS::Serverless::Function.Policies
.- Link
- Return type
Union
[str
,IResolvable
,IAMPolicyDocumentProperty
,List
[Union
[str
,IResolvable
,IAMPolicyDocumentProperty
,SAMPolicyTemplateProperty
]],None
]
-
provisioned_concurrency_config
¶ AWS::Serverless::Function.ProvisionedConcurrencyConfig
.
-
ref
¶ Return a string that will be resolved to a CloudFormation
{ Ref }
for this element.If, by any chance, the intrinsic reference of a resource is not a string, you could coerce it to an IResolvable through
Lazy.any({ produce: resource.ref })
.- Return type
str
-
reserved_concurrent_executions
¶ AWS::Serverless::Function.ReservedConcurrentExecutions
.- Link
- Return type
Union
[int
,float
,None
]
-
role
¶ AWS::Serverless::Function.Role
.- Link
- Return type
Optional
[str
]
-
runtime
¶ AWS::Serverless::Function.Runtime
.- Link
- Return type
Optional
[str
]
-
stack
¶ The stack in which this element is defined.
CfnElements must be defined within a stack scope (directly or indirectly).
- Return type
AWS::Serverless::Function.Tags
.
-
timeout
¶ AWS::Serverless::Function.Timeout
.- Link
- Return type
Union
[int
,float
,None
]
-
tracing
¶ AWS::Serverless::Function.Tracing
.- Link
- Return type
Optional
[str
]
-
version_description
¶ AWS::Serverless::Function.VersionDescription
.- Link
- Return type
Optional
[str
]
-
vpc_config
¶ AWS::Serverless::Function.VpcConfig
.
Static Methods
-
classmethod
is_cfn_element
(x)¶ Returns
true
if a construct is a stack element (i.e. part of the synthesized cloudformation template).Uses duck-typing instead of
instanceof
to allow stack elements from different versions of this library to be included in the same stack.- Parameters
x (
Any
) –- Return type
bool
- Returns
The construct as a stack element or undefined if it is not a stack element.
-
classmethod
is_cfn_resource
(construct)¶ Check whether the given construct is a CfnResource.
- Parameters
construct (
IConstruct
) –- Return type
bool
-
classmethod
is_construct
(x)¶ Return whether the given object is a Construct.
- Parameters
x (
Any
) –- Return type
bool
AlexaSkillEventProperty¶
-
class
CfnFunction.
AlexaSkillEventProperty
(*, variables=None)¶ Bases:
object
- Parameters
variables (
Union
[IResolvable
,Mapping
[str
,str
],None
]) –CfnFunction.AlexaSkillEventProperty.Variables
.- Link
- ExampleMetadata
fixture=_generated
Example:
# The code below shows an example of how to instantiate this type. # The values are placeholders you should change. import aws_cdk.aws_sam as sam alexa_skill_event_property = sam.CfnFunction.AlexaSkillEventProperty( variables={ "variables_key": "variables" } )
Attributes
-
variables
¶ CfnFunction.AlexaSkillEventProperty.Variables
.- Link
- Return type
Union
[IResolvable
,Mapping
[str
,str
],None
]
ApiEventProperty¶
-
class
CfnFunction.
ApiEventProperty
(*, method, path, auth=None, request_model=None, request_parameters=None, rest_api_id=None)¶ Bases:
object
- Parameters
method (
str
) –CfnFunction.ApiEventProperty.Method
.path (
str
) –CfnFunction.ApiEventProperty.Path
.auth (
Union
[IResolvable
,AuthProperty
,None
]) –CfnFunction.ApiEventProperty.Auth
.request_model (
Union
[IResolvable
,RequestModelProperty
,None
]) –CfnFunction.ApiEventProperty.RequestModel
.request_parameters (
Union
[IResolvable
,Sequence
[Union
[str
,IResolvable
,RequestParameterProperty
]],None
]) –CfnFunction.ApiEventProperty.RequestParameters
.rest_api_id (
Optional
[str
]) –CfnFunction.ApiEventProperty.RestApiId
.
- Link
https://github.com/awslabs/serverless-application-model/blob/master/versions/2016-10-31.md#api
- ExampleMetadata
fixture=_generated
Example:
# The code below shows an example of how to instantiate this type. # The values are placeholders you should change. import aws_cdk.aws_sam as sam # custom_statements: Any api_event_property = sam.CfnFunction.ApiEventProperty( method="method", path="path", # the properties below are optional auth=sam.CfnFunction.AuthProperty( api_key_required=False, authorization_scopes=["authorizationScopes"], authorizer="authorizer", resource_policy=sam.CfnFunction.AuthResourcePolicyProperty( aws_account_blacklist=["awsAccountBlacklist"], aws_account_whitelist=["awsAccountWhitelist"], custom_statements=[custom_statements], intrinsic_vpc_blacklist=["intrinsicVpcBlacklist"], intrinsic_vpce_blacklist=["intrinsicVpceBlacklist"], intrinsic_vpce_whitelist=["intrinsicVpceWhitelist"], intrinsic_vpc_whitelist=["intrinsicVpcWhitelist"], ip_range_blacklist=["ipRangeBlacklist"], ip_range_whitelist=["ipRangeWhitelist"], source_vpc_blacklist=["sourceVpcBlacklist"], source_vpc_whitelist=["sourceVpcWhitelist"] ) ), request_model=sam.CfnFunction.RequestModelProperty( model="model", # the properties below are optional required=False, validate_body=False, validate_parameters=False ), request_parameters=["requestParameters"], rest_api_id="restApiId" )
Attributes
-
auth
¶ CfnFunction.ApiEventProperty.Auth
.- Link
https://github.com/awslabs/serverless-application-model/blob/master/versions/2016-10-31.md#api
- Return type
Union
[IResolvable
,AuthProperty
,None
]
-
method
¶ CfnFunction.ApiEventProperty.Method
.
-
path
¶ CfnFunction.ApiEventProperty.Path
.
-
request_model
¶ CfnFunction.ApiEventProperty.RequestModel
.- Link
https://github.com/awslabs/serverless-application-model/blob/master/versions/2016-10-31.md#api
- Return type
Union
[IResolvable
,RequestModelProperty
,None
]
-
request_parameters
¶ CfnFunction.ApiEventProperty.RequestParameters
.- Link
https://github.com/awslabs/serverless-application-model/blob/master/versions/2016-10-31.md#api
- Return type
Union
[IResolvable
,List
[Union
[str
,IResolvable
,RequestParameterProperty
]],None
]
-
rest_api_id
¶ CfnFunction.ApiEventProperty.RestApiId
.- Link
https://github.com/awslabs/serverless-application-model/blob/master/versions/2016-10-31.md#api
- Return type
Optional
[str
]
AuthProperty¶
-
class
CfnFunction.
AuthProperty
(*, api_key_required=None, authorization_scopes=None, authorizer=None, resource_policy=None)¶ Bases:
object
- Parameters
api_key_required (
Union
[bool
,IResolvable
,None
]) –CfnFunction.AuthProperty.ApiKeyRequired
.authorization_scopes (
Optional
[Sequence
[str
]]) –CfnFunction.AuthProperty.AuthorizationScopes
.authorizer (
Optional
[str
]) –CfnFunction.AuthProperty.Authorizer
.resource_policy (
Union
[IResolvable
,AuthResourcePolicyProperty
,None
]) –CfnFunction.AuthProperty.ResourcePolicy
.
- Link
- ExampleMetadata
fixture=_generated
Example:
# The code below shows an example of how to instantiate this type. # The values are placeholders you should change. import aws_cdk.aws_sam as sam # custom_statements: Any auth_property = sam.CfnFunction.AuthProperty( api_key_required=False, authorization_scopes=["authorizationScopes"], authorizer="authorizer", resource_policy=sam.CfnFunction.AuthResourcePolicyProperty( aws_account_blacklist=["awsAccountBlacklist"], aws_account_whitelist=["awsAccountWhitelist"], custom_statements=[custom_statements], intrinsic_vpc_blacklist=["intrinsicVpcBlacklist"], intrinsic_vpce_blacklist=["intrinsicVpceBlacklist"], intrinsic_vpce_whitelist=["intrinsicVpceWhitelist"], intrinsic_vpc_whitelist=["intrinsicVpcWhitelist"], ip_range_blacklist=["ipRangeBlacklist"], ip_range_whitelist=["ipRangeWhitelist"], source_vpc_blacklist=["sourceVpcBlacklist"], source_vpc_whitelist=["sourceVpcWhitelist"] ) )
Attributes
-
api_key_required
¶ CfnFunction.AuthProperty.ApiKeyRequired
.- Link
- Return type
Union
[bool
,IResolvable
,None
]
CfnFunction.AuthProperty.AuthorizationScopes
.- Link
- Return type
Optional
[List
[str
]]
CfnFunction.AuthProperty.Authorizer
.- Link
- Return type
Optional
[str
]
-
resource_policy
¶ CfnFunction.AuthProperty.ResourcePolicy
.
AuthResourcePolicyProperty¶
-
class
CfnFunction.
AuthResourcePolicyProperty
(*, aws_account_blacklist=None, aws_account_whitelist=None, custom_statements=None, intrinsic_vpc_blacklist=None, intrinsic_vpce_blacklist=None, intrinsic_vpce_whitelist=None, intrinsic_vpc_whitelist=None, ip_range_blacklist=None, ip_range_whitelist=None, source_vpc_blacklist=None, source_vpc_whitelist=None)¶ Bases:
object
- Parameters
aws_account_blacklist (
Optional
[Sequence
[str
]]) –CfnFunction.AuthResourcePolicyProperty.AwsAccountBlacklist
.aws_account_whitelist (
Optional
[Sequence
[str
]]) –CfnFunction.AuthResourcePolicyProperty.AwsAccountWhitelist
.custom_statements (
Union
[Sequence
[Any
],IResolvable
,None
]) –CfnFunction.AuthResourcePolicyProperty.CustomStatements
.intrinsic_vpc_blacklist (
Optional
[Sequence
[str
]]) –CfnFunction.AuthResourcePolicyProperty.IntrinsicVpcBlacklist
.intrinsic_vpce_blacklist (
Optional
[Sequence
[str
]]) –CfnFunction.AuthResourcePolicyProperty.IntrinsicVpceBlacklist
.intrinsic_vpce_whitelist (
Optional
[Sequence
[str
]]) –CfnFunction.AuthResourcePolicyProperty.IntrinsicVpceWhitelist
.intrinsic_vpc_whitelist (
Optional
[Sequence
[str
]]) –CfnFunction.AuthResourcePolicyProperty.IntrinsicVpcWhitelist
.ip_range_blacklist (
Optional
[Sequence
[str
]]) –CfnFunction.AuthResourcePolicyProperty.IpRangeBlacklist
.ip_range_whitelist (
Optional
[Sequence
[str
]]) –CfnFunction.AuthResourcePolicyProperty.IpRangeWhitelist
.source_vpc_blacklist (
Optional
[Sequence
[str
]]) –CfnFunction.AuthResourcePolicyProperty.SourceVpcBlacklist
.source_vpc_whitelist (
Optional
[Sequence
[str
]]) –CfnFunction.AuthResourcePolicyProperty.SourceVpcWhitelist
.
- Link
- ExampleMetadata
fixture=_generated
Example:
# The code below shows an example of how to instantiate this type. # The values are placeholders you should change. import aws_cdk.aws_sam as sam # custom_statements: Any auth_resource_policy_property = sam.CfnFunction.AuthResourcePolicyProperty( aws_account_blacklist=["awsAccountBlacklist"], aws_account_whitelist=["awsAccountWhitelist"], custom_statements=[custom_statements], intrinsic_vpc_blacklist=["intrinsicVpcBlacklist"], intrinsic_vpce_blacklist=["intrinsicVpceBlacklist"], intrinsic_vpce_whitelist=["intrinsicVpceWhitelist"], intrinsic_vpc_whitelist=["intrinsicVpcWhitelist"], ip_range_blacklist=["ipRangeBlacklist"], ip_range_whitelist=["ipRangeWhitelist"], source_vpc_blacklist=["sourceVpcBlacklist"], source_vpc_whitelist=["sourceVpcWhitelist"] )
Attributes
-
aws_account_blacklist
¶ CfnFunction.AuthResourcePolicyProperty.AwsAccountBlacklist
.- Link
- Return type
Optional
[List
[str
]]
-
aws_account_whitelist
¶ CfnFunction.AuthResourcePolicyProperty.AwsAccountWhitelist
.- Link
- Return type
Optional
[List
[str
]]
-
custom_statements
¶ CfnFunction.AuthResourcePolicyProperty.CustomStatements
.- Link
- Return type
Union
[List
[Any
],IResolvable
,None
]
-
intrinsic_vpc_blacklist
¶ CfnFunction.AuthResourcePolicyProperty.IntrinsicVpcBlacklist
.- Link
- Return type
Optional
[List
[str
]]
-
intrinsic_vpc_whitelist
¶ CfnFunction.AuthResourcePolicyProperty.IntrinsicVpcWhitelist
.- Link
- Return type
Optional
[List
[str
]]
-
intrinsic_vpce_blacklist
¶ CfnFunction.AuthResourcePolicyProperty.IntrinsicVpceBlacklist
.- Link
- Return type
Optional
[List
[str
]]
-
intrinsic_vpce_whitelist
¶ CfnFunction.AuthResourcePolicyProperty.IntrinsicVpceWhitelist
.- Link
- Return type
Optional
[List
[str
]]
-
ip_range_blacklist
¶ CfnFunction.AuthResourcePolicyProperty.IpRangeBlacklist
.- Link
- Return type
Optional
[List
[str
]]
-
ip_range_whitelist
¶ CfnFunction.AuthResourcePolicyProperty.IpRangeWhitelist
.- Link
- Return type
Optional
[List
[str
]]
-
source_vpc_blacklist
¶ CfnFunction.AuthResourcePolicyProperty.SourceVpcBlacklist
.- Link
- Return type
Optional
[List
[str
]]
-
source_vpc_whitelist
¶ CfnFunction.AuthResourcePolicyProperty.SourceVpcWhitelist
.- Link
- Return type
Optional
[List
[str
]]
BucketSAMPTProperty¶
-
class
CfnFunction.
BucketSAMPTProperty
(*, bucket_name)¶ Bases:
object
- Parameters
bucket_name (
str
) –CfnFunction.BucketSAMPTProperty.BucketName
.- Link
https://github.com/awslabs/serverless-application-model/blob/master/docs/policy_templates.rst
- ExampleMetadata
fixture=_generated
Example:
# The code below shows an example of how to instantiate this type. # The values are placeholders you should change. import aws_cdk.aws_sam as sam bucket_sAMPTProperty = sam.CfnFunction.BucketSAMPTProperty( bucket_name="bucketName" )
Attributes
-
bucket_name
¶ CfnFunction.BucketSAMPTProperty.BucketName
.
CloudWatchEventEventProperty¶
-
class
CfnFunction.
CloudWatchEventEventProperty
(*, pattern, input=None, input_path=None)¶ Bases:
object
- Parameters
pattern (
Any
) –CfnFunction.CloudWatchEventEventProperty.Pattern
.input (
Optional
[str
]) –CfnFunction.CloudWatchEventEventProperty.Input
.input_path (
Optional
[str
]) –CfnFunction.CloudWatchEventEventProperty.InputPath
.
- Link
- ExampleMetadata
fixture=_generated
Example:
# The code below shows an example of how to instantiate this type. # The values are placeholders you should change. import aws_cdk.aws_sam as sam # pattern: Any cloud_watch_event_event_property = sam.CfnFunction.CloudWatchEventEventProperty( pattern=pattern, # the properties below are optional input="input", input_path="inputPath" )
Attributes
-
input
¶ CfnFunction.CloudWatchEventEventProperty.Input
.- Link
- Return type
Optional
[str
]
-
input_path
¶ CfnFunction.CloudWatchEventEventProperty.InputPath
.- Link
- Return type
Optional
[str
]
-
pattern
¶ CfnFunction.CloudWatchEventEventProperty.Pattern
.
CloudWatchLogsEventProperty¶
-
class
CfnFunction.
CloudWatchLogsEventProperty
(*, filter_pattern, log_group_name)¶ Bases:
object
- Parameters
filter_pattern (
str
) –CfnFunction.CloudWatchLogsEventProperty.FilterPattern
.log_group_name (
str
) –CfnFunction.CloudWatchLogsEventProperty.LogGroupName
.
- Link
- ExampleMetadata
fixture=_generated
Example:
# The code below shows an example of how to instantiate this type. # The values are placeholders you should change. import aws_cdk.aws_sam as sam cloud_watch_logs_event_property = sam.CfnFunction.CloudWatchLogsEventProperty( filter_pattern="filterPattern", log_group_name="logGroupName" )
Attributes
-
filter_pattern
¶ CfnFunction.CloudWatchLogsEventProperty.FilterPattern
.
-
log_group_name
¶ CfnFunction.CloudWatchLogsEventProperty.LogGroupName
.
CollectionSAMPTProperty¶
-
class
CfnFunction.
CollectionSAMPTProperty
(*, collection_id)¶ Bases:
object
- Parameters
collection_id (
str
) –CfnFunction.CollectionSAMPTProperty.CollectionId
.- Link
https://github.com/awslabs/serverless-application-model/blob/master/docs/policy_templates.rst
- ExampleMetadata
fixture=_generated
Example:
# The code below shows an example of how to instantiate this type. # The values are placeholders you should change. import aws_cdk.aws_sam as sam collection_sAMPTProperty = sam.CfnFunction.CollectionSAMPTProperty( collection_id="collectionId" )
Attributes
-
collection_id
¶ CfnFunction.CollectionSAMPTProperty.CollectionId
.
DeadLetterQueueProperty¶
-
class
CfnFunction.
DeadLetterQueueProperty
(*, target_arn, type)¶ Bases:
object
- Parameters
target_arn (
str
) –CfnFunction.DeadLetterQueueProperty.TargetArn
.type (
str
) –CfnFunction.DeadLetterQueueProperty.Type
.
- Link
- ExampleMetadata
fixture=_generated
Example:
# The code below shows an example of how to instantiate this type. # The values are placeholders you should change. import aws_cdk.aws_sam as sam dead_letter_queue_property = sam.CfnFunction.DeadLetterQueueProperty( target_arn="targetArn", type="type" )
Attributes
-
target_arn
¶ CfnFunction.DeadLetterQueueProperty.TargetArn
.
-
type
¶ CfnFunction.DeadLetterQueueProperty.Type
.
DeploymentPreferenceProperty¶
-
class
CfnFunction.
DeploymentPreferenceProperty
(*, enabled, type, alarms=None, hooks=None)¶ Bases:
object
- Parameters
enabled (
Union
[bool
,IResolvable
]) –CfnFunction.DeploymentPreferenceProperty.Enabled
.type (
str
) –CfnFunction.DeploymentPreferenceProperty.Type
.alarms (
Optional
[Sequence
[str
]]) –CfnFunction.DeploymentPreferenceProperty.Alarms
.hooks (
Union
[IResolvable
,HooksProperty
,None
]) –CfnFunction.DeploymentPreferenceProperty.Hooks
.
- Link
https://github.com/awslabs/serverless-application-model/blob/master/docs/safe_lambda_deployments.rst
- ExampleMetadata
fixture=_generated
Example:
# The code below shows an example of how to instantiate this type. # The values are placeholders you should change. import aws_cdk.aws_sam as sam deployment_preference_property = sam.CfnFunction.DeploymentPreferenceProperty( enabled=False, type="type", # the properties below are optional alarms=["alarms"], hooks=sam.CfnFunction.HooksProperty( post_traffic="postTraffic", pre_traffic="preTraffic" ) )
Attributes
-
alarms
¶ CfnFunction.DeploymentPreferenceProperty.Alarms
.- Link
- Return type
Optional
[List
[str
]]
-
enabled
¶ CfnFunction.DeploymentPreferenceProperty.Enabled
.
-
hooks
¶ CfnFunction.DeploymentPreferenceProperty.Hooks
.
-
type
¶ CfnFunction.DeploymentPreferenceProperty.Type
.
DestinationConfigProperty¶
-
class
CfnFunction.
DestinationConfigProperty
(*, on_failure)¶ Bases:
object
- Parameters
on_failure (
Union
[IResolvable
,DestinationProperty
]) –CfnFunction.DestinationConfigProperty.OnFailure
.- Link
- ExampleMetadata
fixture=_generated
Example:
# The code below shows an example of how to instantiate this type. # The values are placeholders you should change. import aws_cdk.aws_sam as sam destination_config_property = sam.CfnFunction.DestinationConfigProperty( on_failure=sam.CfnFunction.DestinationProperty( destination="destination", # the properties below are optional type="type" ) )
Attributes
-
on_failure
¶ CfnFunction.DestinationConfigProperty.OnFailure
.
DestinationProperty¶
-
class
CfnFunction.
DestinationProperty
(*, destination, type=None)¶ Bases:
object
- Parameters
destination (
str
) –CfnFunction.DestinationProperty.Destination
.type (
Optional
[str
]) –CfnFunction.DestinationProperty.Type
.
- Link
- ExampleMetadata
fixture=_generated
Example:
# The code below shows an example of how to instantiate this type. # The values are placeholders you should change. import aws_cdk.aws_sam as sam destination_property = sam.CfnFunction.DestinationProperty( destination="destination", # the properties below are optional type="type" )
Attributes
-
destination
¶ CfnFunction.DestinationProperty.Destination
.
-
type
¶ CfnFunction.DestinationProperty.Type
.- Link
- Return type
Optional
[str
]
DomainSAMPTProperty¶
-
class
CfnFunction.
DomainSAMPTProperty
(*, domain_name)¶ Bases:
object
- Parameters
domain_name (
str
) –CfnFunction.DomainSAMPTProperty.DomainName
.- Link
https://github.com/awslabs/serverless-application-model/blob/master/docs/policy_templates.rst
- ExampleMetadata
fixture=_generated
Example:
# The code below shows an example of how to instantiate this type. # The values are placeholders you should change. import aws_cdk.aws_sam as sam domain_sAMPTProperty = sam.CfnFunction.DomainSAMPTProperty( domain_name="domainName" )
Attributes
-
domain_name
¶ CfnFunction.DomainSAMPTProperty.DomainName
.
DynamoDBEventProperty¶
-
class
CfnFunction.
DynamoDBEventProperty
(*, starting_position, stream, batch_size=None, bisect_batch_on_function_error=None, destination_config=None, enabled=None, maximum_batching_window_in_seconds=None, maximum_record_age_in_seconds=None, maximum_retry_attempts=None, parallelization_factor=None)¶ Bases:
object
- Parameters
starting_position (
str
) –CfnFunction.DynamoDBEventProperty.StartingPosition
.stream (
str
) –CfnFunction.DynamoDBEventProperty.Stream
.batch_size (
Union
[int
,float
,None
]) –CfnFunction.DynamoDBEventProperty.BatchSize
.bisect_batch_on_function_error (
Union
[bool
,IResolvable
,None
]) –CfnFunction.DynamoDBEventProperty.BisectBatchOnFunctionError
.destination_config (
Union
[IResolvable
,DestinationConfigProperty
,None
]) –CfnFunction.DynamoDBEventProperty.DestinationConfig
.enabled (
Union
[bool
,IResolvable
,None
]) –CfnFunction.DynamoDBEventProperty.Enabled
.maximum_batching_window_in_seconds (
Union
[int
,float
,None
]) –CfnFunction.DynamoDBEventProperty.MaximumBatchingWindowInSeconds
.maximum_record_age_in_seconds (
Union
[int
,float
,None
]) –CfnFunction.DynamoDBEventProperty.MaximumRecordAgeInSeconds
.maximum_retry_attempts (
Union
[int
,float
,None
]) –CfnFunction.DynamoDBEventProperty.MaximumRetryAttempts
.parallelization_factor (
Union
[int
,float
,None
]) –CfnFunction.DynamoDBEventProperty.ParallelizationFactor
.
- Link
https://github.com/awslabs/serverless-application-model/blob/master/versions/2016-10-31.md#dynamodb
- ExampleMetadata
fixture=_generated
Example:
# The code below shows an example of how to instantiate this type. # The values are placeholders you should change. import aws_cdk.aws_sam as sam dynamo_dBEvent_property = sam.CfnFunction.DynamoDBEventProperty( starting_position="startingPosition", stream="stream", # the properties below are optional batch_size=123, bisect_batch_on_function_error=False, destination_config=sam.CfnFunction.DestinationConfigProperty( on_failure=sam.CfnFunction.DestinationProperty( destination="destination", # the properties below are optional type="type" ) ), enabled=False, maximum_batching_window_in_seconds=123, maximum_record_age_in_seconds=123, maximum_retry_attempts=123, parallelization_factor=123 )
Attributes
-
batch_size
¶ CfnFunction.DynamoDBEventProperty.BatchSize
.- Link
https://github.com/awslabs/serverless-application-model/blob/master/versions/2016-10-31.md#dynamodb
- Return type
Union
[int
,float
,None
]
-
bisect_batch_on_function_error
¶ CfnFunction.DynamoDBEventProperty.BisectBatchOnFunctionError
.- Link
https://github.com/awslabs/serverless-application-model/blob/master/versions/2016-10-31.md#dynamodb
- Return type
Union
[bool
,IResolvable
,None
]
-
destination_config
¶ CfnFunction.DynamoDBEventProperty.DestinationConfig
.
-
enabled
¶ CfnFunction.DynamoDBEventProperty.Enabled
.- Link
https://github.com/awslabs/serverless-application-model/blob/master/versions/2016-10-31.md#dynamodb
- Return type
Union
[bool
,IResolvable
,None
]
-
maximum_batching_window_in_seconds
¶ CfnFunction.DynamoDBEventProperty.MaximumBatchingWindowInSeconds
.- Link
https://github.com/awslabs/serverless-application-model/blob/master/versions/2016-10-31.md#dynamodb
- Return type
Union
[int
,float
,None
]
-
maximum_record_age_in_seconds
¶ CfnFunction.DynamoDBEventProperty.MaximumRecordAgeInSeconds
.- Link
https://github.com/awslabs/serverless-application-model/blob/master/versions/2016-10-31.md#dynamodb
- Return type
Union
[int
,float
,None
]
-
maximum_retry_attempts
¶ CfnFunction.DynamoDBEventProperty.MaximumRetryAttempts
.- Link
https://github.com/awslabs/serverless-application-model/blob/master/versions/2016-10-31.md#dynamodb
- Return type
Union
[int
,float
,None
]
-
parallelization_factor
¶ CfnFunction.DynamoDBEventProperty.ParallelizationFactor
.- Link
https://github.com/awslabs/serverless-application-model/blob/master/versions/2016-10-31.md#dynamodb
- Return type
Union
[int
,float
,None
]
-
starting_position
¶ CfnFunction.DynamoDBEventProperty.StartingPosition
.
-
stream
¶ CfnFunction.DynamoDBEventProperty.Stream
.
EmptySAMPTProperty¶
-
class
CfnFunction.
EmptySAMPTProperty
¶ Bases:
object
- Link
https://github.com/awslabs/serverless-application-model/blob/master/docs/policy_templates.rst
- ExampleMetadata
fixture=_generated
Example:
# The code below shows an example of how to instantiate this type. # The values are placeholders you should change. import aws_cdk.aws_sam as sam empty_sAMPTProperty = sam.CfnFunction.EmptySAMPTProperty()
EventBridgeRuleEventProperty¶
-
class
CfnFunction.
EventBridgeRuleEventProperty
(*, pattern, event_bus_name=None, input=None, input_path=None)¶ Bases:
object
- Parameters
pattern (
Any
) –CfnFunction.EventBridgeRuleEventProperty.Pattern
.event_bus_name (
Optional
[str
]) –CfnFunction.EventBridgeRuleEventProperty.EventBusName
.input (
Optional
[str
]) –CfnFunction.EventBridgeRuleEventProperty.Input
.input_path (
Optional
[str
]) –CfnFunction.EventBridgeRuleEventProperty.InputPath
.
- Link
- ExampleMetadata
fixture=_generated
Example:
# The code below shows an example of how to instantiate this type. # The values are placeholders you should change. import aws_cdk.aws_sam as sam # pattern: Any event_bridge_rule_event_property = sam.CfnFunction.EventBridgeRuleEventProperty( pattern=pattern, # the properties below are optional event_bus_name="eventBusName", input="input", input_path="inputPath" )
Attributes
-
event_bus_name
¶ CfnFunction.EventBridgeRuleEventProperty.EventBusName
.- Link
- Return type
Optional
[str
]
-
input
¶ CfnFunction.EventBridgeRuleEventProperty.Input
.- Link
- Return type
Optional
[str
]
-
input_path
¶ CfnFunction.EventBridgeRuleEventProperty.InputPath
.- Link
- Return type
Optional
[str
]
-
pattern
¶ CfnFunction.EventBridgeRuleEventProperty.Pattern
.
EventInvokeConfigProperty¶
-
class
CfnFunction.
EventInvokeConfigProperty
(*, destination_config=None, maximum_event_age_in_seconds=None, maximum_retry_attempts=None)¶ Bases:
object
- Parameters
destination_config (
Union
[IResolvable
,EventInvokeDestinationConfigProperty
,None
]) –CfnFunction.EventInvokeConfigProperty.DestinationConfig
.maximum_event_age_in_seconds (
Union
[int
,float
,None
]) –CfnFunction.EventInvokeConfigProperty.MaximumEventAgeInSeconds
.maximum_retry_attempts (
Union
[int
,float
,None
]) –CfnFunction.EventInvokeConfigProperty.MaximumRetryAttempts
.
- Link
- ExampleMetadata
fixture=_generated
Example:
# The code below shows an example of how to instantiate this type. # The values are placeholders you should change. import aws_cdk.aws_sam as sam event_invoke_config_property = sam.CfnFunction.EventInvokeConfigProperty( destination_config=sam.CfnFunction.EventInvokeDestinationConfigProperty( on_failure=sam.CfnFunction.DestinationProperty( destination="destination", # the properties below are optional type="type" ), on_success=sam.CfnFunction.DestinationProperty( destination="destination", # the properties below are optional type="type" ) ), maximum_event_age_in_seconds=123, maximum_retry_attempts=123 )
Attributes
-
destination_config
¶ CfnFunction.EventInvokeConfigProperty.DestinationConfig
.
-
maximum_event_age_in_seconds
¶ CfnFunction.EventInvokeConfigProperty.MaximumEventAgeInSeconds
.- Link
- Return type
Union
[int
,float
,None
]
-
maximum_retry_attempts
¶ CfnFunction.EventInvokeConfigProperty.MaximumRetryAttempts
.- Link
- Return type
Union
[int
,float
,None
]
EventInvokeDestinationConfigProperty¶
-
class
CfnFunction.
EventInvokeDestinationConfigProperty
(*, on_failure, on_success)¶ Bases:
object
- Parameters
on_failure (
Union
[IResolvable
,DestinationProperty
]) –CfnFunction.EventInvokeDestinationConfigProperty.OnFailure
.on_success (
Union
[IResolvable
,DestinationProperty
]) –CfnFunction.EventInvokeDestinationConfigProperty.OnSuccess
.
- Link
- ExampleMetadata
fixture=_generated
Example:
# The code below shows an example of how to instantiate this type. # The values are placeholders you should change. import aws_cdk.aws_sam as sam event_invoke_destination_config_property = sam.CfnFunction.EventInvokeDestinationConfigProperty( on_failure=sam.CfnFunction.DestinationProperty( destination="destination", # the properties below are optional type="type" ), on_success=sam.CfnFunction.DestinationProperty( destination="destination", # the properties below are optional type="type" ) )
Attributes
-
on_failure
¶ CfnFunction.EventInvokeDestinationConfigProperty.OnFailure
.
-
on_success
¶ CfnFunction.EventInvokeDestinationConfigProperty.OnSuccess
.
EventSourceProperty¶
-
class
CfnFunction.
EventSourceProperty
(*, properties, type)¶ Bases:
object
- Parameters
properties (
Union
[IResolvable
,AlexaSkillEventProperty
,ApiEventProperty
,CloudWatchEventEventProperty
,CloudWatchLogsEventProperty
,DynamoDBEventProperty
,EventBridgeRuleEventProperty
,S3EventProperty
,SNSEventProperty
,SQSEventProperty
,KinesisEventProperty
,ScheduleEventProperty
,IoTRuleEventProperty
]) –CfnFunction.EventSourceProperty.Properties
.type (
str
) –CfnFunction.EventSourceProperty.Type
.
- Link
- ExampleMetadata
fixture=_generated
Example:
# The code below shows an example of how to instantiate this type. # The values are placeholders you should change. import aws_cdk.aws_sam as sam event_source_property = sam.CfnFunction.EventSourceProperty( properties=sam.CfnFunction.S3EventProperty( variables={ "variables_key": "variables" } ), type="type" )
Attributes
-
properties
¶ CfnFunction.EventSourceProperty.Properties
.- Link
- Return type
Union
[IResolvable
,AlexaSkillEventProperty
,ApiEventProperty
,CloudWatchEventEventProperty
,CloudWatchLogsEventProperty
,DynamoDBEventProperty
,EventBridgeRuleEventProperty
,S3EventProperty
,SNSEventProperty
,SQSEventProperty
,KinesisEventProperty
,ScheduleEventProperty
,IoTRuleEventProperty
]
-
type
¶ CfnFunction.EventSourceProperty.Type
.
FileSystemConfigProperty¶
-
class
CfnFunction.
FileSystemConfigProperty
(*, arn=None, local_mount_path=None)¶ Bases:
object
- Parameters
arn (
Optional
[str
]) –CfnFunction.FileSystemConfigProperty.Arn
.local_mount_path (
Optional
[str
]) –CfnFunction.FileSystemConfigProperty.LocalMountPath
.
- Link
- ExampleMetadata
fixture=_generated
Example:
# The code below shows an example of how to instantiate this type. # The values are placeholders you should change. import aws_cdk.aws_sam as sam file_system_config_property = sam.CfnFunction.FileSystemConfigProperty( arn="arn", local_mount_path="localMountPath" )
Attributes
-
arn
¶ CfnFunction.FileSystemConfigProperty.Arn
.
-
local_mount_path
¶ CfnFunction.FileSystemConfigProperty.LocalMountPath
.
FunctionEnvironmentProperty¶
-
class
CfnFunction.
FunctionEnvironmentProperty
(*, variables)¶ Bases:
object
- Parameters
variables (
Union
[IResolvable
,Mapping
[str
,str
]]) –CfnFunction.FunctionEnvironmentProperty.Variables
.- Link
- ExampleMetadata
fixture=_generated
Example:
# The code below shows an example of how to instantiate this type. # The values are placeholders you should change. import aws_cdk.aws_sam as sam function_environment_property = sam.CfnFunction.FunctionEnvironmentProperty( variables={ "variables_key": "variables" } )
Attributes
-
variables
¶ CfnFunction.FunctionEnvironmentProperty.Variables
.- Link
- Return type
Union
[IResolvable
,Mapping
[str
,str
]]
FunctionSAMPTProperty¶
-
class
CfnFunction.
FunctionSAMPTProperty
(*, function_name)¶ Bases:
object
- Parameters
function_name (
str
) –CfnFunction.FunctionSAMPTProperty.FunctionName
.- Link
https://github.com/awslabs/serverless-application-model/blob/master/docs/policy_templates.rst
- ExampleMetadata
fixture=_generated
Example:
# The code below shows an example of how to instantiate this type. # The values are placeholders you should change. import aws_cdk.aws_sam as sam function_sAMPTProperty = sam.CfnFunction.FunctionSAMPTProperty( function_name="functionName" )
Attributes
-
function_name
¶ CfnFunction.FunctionSAMPTProperty.FunctionName
.
HooksProperty¶
-
class
CfnFunction.
HooksProperty
(*, post_traffic=None, pre_traffic=None)¶ Bases:
object
- Parameters
post_traffic (
Optional
[str
]) –CfnFunction.HooksProperty.PostTraffic
.pre_traffic (
Optional
[str
]) –CfnFunction.HooksProperty.PreTraffic
.
- Link
https://github.com/awslabs/serverless-application-model/blob/master/docs/safe_lambda_deployments.rst
- ExampleMetadata
fixture=_generated
Example:
# The code below shows an example of how to instantiate this type. # The values are placeholders you should change. import aws_cdk.aws_sam as sam hooks_property = sam.CfnFunction.HooksProperty( post_traffic="postTraffic", pre_traffic="preTraffic" )
Attributes
-
post_traffic
¶ CfnFunction.HooksProperty.PostTraffic
.- Link
- Return type
Optional
[str
]
-
pre_traffic
¶ CfnFunction.HooksProperty.PreTraffic
.- Link
- Return type
Optional
[str
]
IAMPolicyDocumentProperty¶
-
class
CfnFunction.
IAMPolicyDocumentProperty
(*, statement, version)¶ Bases:
object
- Parameters
statement (
Any
) –CfnFunction.IAMPolicyDocumentProperty.Statement
.version (
str
) –CfnFunction.IAMPolicyDocumentProperty.Version
.
- Link
http://docs.aws.amazon.com/IAM/latest/UserGuide/reference_policies.html
- ExampleMetadata
fixture=_generated
Example:
# The code below shows an example of how to instantiate this type. # The values are placeholders you should change. import aws_cdk.aws_sam as sam # statement: Any i_aMPolicy_document_property = { "statement": statement, "version": "version" }
Attributes
-
statement
¶ CfnFunction.IAMPolicyDocumentProperty.Statement
.- Link
http://docs.aws.amazon.com/IAM/latest/UserGuide/reference_policies.html
- Return type
Any
-
version
¶ CfnFunction.IAMPolicyDocumentProperty.Version
.- Link
http://docs.aws.amazon.com/IAM/latest/UserGuide/reference_policies.html
- Return type
str
IdentitySAMPTProperty¶
-
class
CfnFunction.
IdentitySAMPTProperty
(*, identity_name)¶ Bases:
object
- Parameters
identity_name (
str
) –CfnFunction.IdentitySAMPTProperty.IdentityName
.- Link
https://github.com/awslabs/serverless-application-model/blob/master/docs/policy_templates.rst
- ExampleMetadata
fixture=_generated
Example:
# The code below shows an example of how to instantiate this type. # The values are placeholders you should change. import aws_cdk.aws_sam as sam identity_sAMPTProperty = sam.CfnFunction.IdentitySAMPTProperty( identity_name="identityName" )
Attributes
-
identity_name
¶ CfnFunction.IdentitySAMPTProperty.IdentityName
.
ImageConfigProperty¶
-
class
CfnFunction.
ImageConfigProperty
(*, command=None, entry_point=None, working_directory=None)¶ Bases:
object
- Parameters
command (
Optional
[Sequence
[str
]]) –CfnFunction.ImageConfigProperty.Command
.entry_point (
Optional
[Sequence
[str
]]) –CfnFunction.ImageConfigProperty.EntryPoint
.working_directory (
Optional
[str
]) –CfnFunction.ImageConfigProperty.WorkingDirectory
.
- Link
- ExampleMetadata
fixture=_generated
Example:
# The code below shows an example of how to instantiate this type. # The values are placeholders you should change. import aws_cdk.aws_sam as sam image_config_property = sam.CfnFunction.ImageConfigProperty( command=["command"], entry_point=["entryPoint"], working_directory="workingDirectory" )
Attributes
-
command
¶ CfnFunction.ImageConfigProperty.Command
.
-
entry_point
¶ CfnFunction.ImageConfigProperty.EntryPoint
.
-
working_directory
¶ CfnFunction.ImageConfigProperty.WorkingDirectory
.
IoTRuleEventProperty¶
-
class
CfnFunction.
IoTRuleEventProperty
(*, sql, aws_iot_sql_version=None)¶ Bases:
object
- Parameters
sql (
str
) –CfnFunction.IoTRuleEventProperty.Sql
.aws_iot_sql_version (
Optional
[str
]) –CfnFunction.IoTRuleEventProperty.AwsIotSqlVersion
.
- Link
https://github.com/awslabs/serverless-application-model/blob/master/versions/2016-10-31.md#iotrule
- ExampleMetadata
fixture=_generated
Example:
# The code below shows an example of how to instantiate this type. # The values are placeholders you should change. import aws_cdk.aws_sam as sam io_tRule_event_property = sam.CfnFunction.IoTRuleEventProperty( sql="sql", # the properties below are optional aws_iot_sql_version="awsIotSqlVersion" )
Attributes
-
aws_iot_sql_version
¶ CfnFunction.IoTRuleEventProperty.AwsIotSqlVersion
.- Link
https://github.com/awslabs/serverless-application-model/blob/master/versions/2016-10-31.md#iotrule
- Return type
Optional
[str
]
-
sql
¶ CfnFunction.IoTRuleEventProperty.Sql
.
KeySAMPTProperty¶
-
class
CfnFunction.
KeySAMPTProperty
(*, key_id)¶ Bases:
object
- Parameters
key_id (
str
) –CfnFunction.KeySAMPTProperty.KeyId
.- Link
https://github.com/awslabs/serverless-application-model/blob/master/docs/policy_templates.rst
- ExampleMetadata
fixture=_generated
Example:
# The code below shows an example of how to instantiate this type. # The values are placeholders you should change. import aws_cdk.aws_sam as sam key_sAMPTProperty = sam.CfnFunction.KeySAMPTProperty( key_id="keyId" )
Attributes
-
key_id
¶ CfnFunction.KeySAMPTProperty.KeyId
.
KinesisEventProperty¶
-
class
CfnFunction.
KinesisEventProperty
(*, starting_position, stream, batch_size=None, enabled=None)¶ Bases:
object
- Parameters
starting_position (
str
) –CfnFunction.KinesisEventProperty.StartingPosition
.stream (
str
) –CfnFunction.KinesisEventProperty.Stream
.batch_size (
Union
[int
,float
,None
]) –CfnFunction.KinesisEventProperty.BatchSize
.enabled (
Union
[bool
,IResolvable
,None
]) –CfnFunction.KinesisEventProperty.Enabled
.
- Link
https://github.com/awslabs/serverless-application-model/blob/master/versions/2016-10-31.md#kinesis
- ExampleMetadata
fixture=_generated
Example:
# The code below shows an example of how to instantiate this type. # The values are placeholders you should change. import aws_cdk.aws_sam as sam kinesis_event_property = sam.CfnFunction.KinesisEventProperty( starting_position="startingPosition", stream="stream", # the properties below are optional batch_size=123, enabled=False )
Attributes
-
batch_size
¶ CfnFunction.KinesisEventProperty.BatchSize
.- Link
https://github.com/awslabs/serverless-application-model/blob/master/versions/2016-10-31.md#kinesis
- Return type
Union
[int
,float
,None
]
-
enabled
¶ CfnFunction.KinesisEventProperty.Enabled
.- Link
https://github.com/awslabs/serverless-application-model/blob/master/versions/2016-10-31.md#kinesis
- Return type
Union
[bool
,IResolvable
,None
]
-
starting_position
¶ CfnFunction.KinesisEventProperty.StartingPosition
.
-
stream
¶ CfnFunction.KinesisEventProperty.Stream
.
LogGroupSAMPTProperty¶
-
class
CfnFunction.
LogGroupSAMPTProperty
(*, log_group_name)¶ Bases:
object
- Parameters
log_group_name (
str
) –CfnFunction.LogGroupSAMPTProperty.LogGroupName
.- Link
https://github.com/awslabs/serverless-application-model/blob/master/docs/policy_templates.rst
- ExampleMetadata
fixture=_generated
Example:
# The code below shows an example of how to instantiate this type. # The values are placeholders you should change. import aws_cdk.aws_sam as sam log_group_sAMPTProperty = sam.CfnFunction.LogGroupSAMPTProperty( log_group_name="logGroupName" )
Attributes
-
log_group_name
¶ CfnFunction.LogGroupSAMPTProperty.LogGroupName
.
ParameterNameSAMPTProperty¶
-
class
CfnFunction.
ParameterNameSAMPTProperty
(*, parameter_name)¶ Bases:
object
- Parameters
parameter_name (
str
) –CfnFunction.ParameterNameSAMPTProperty.ParameterName
.- Link
https://github.com/awslabs/serverless-application-model/blob/master/docs/policy_templates.rst
- ExampleMetadata
fixture=_generated
Example:
# The code below shows an example of how to instantiate this type. # The values are placeholders you should change. import aws_cdk.aws_sam as sam parameter_name_sAMPTProperty = sam.CfnFunction.ParameterNameSAMPTProperty( parameter_name="parameterName" )
Attributes
-
parameter_name
¶ CfnFunction.ParameterNameSAMPTProperty.ParameterName
.
ProvisionedConcurrencyConfigProperty¶
-
class
CfnFunction.
ProvisionedConcurrencyConfigProperty
(*, provisioned_concurrent_executions)¶ Bases:
object
- Parameters
provisioned_concurrent_executions (
str
) –CfnFunction.ProvisionedConcurrencyConfigProperty.ProvisionedConcurrentExecutions
.- Link
- ExampleMetadata
fixture=_generated
Example:
# The code below shows an example of how to instantiate this type. # The values are placeholders you should change. import aws_cdk.aws_sam as sam provisioned_concurrency_config_property = sam.CfnFunction.ProvisionedConcurrencyConfigProperty( provisioned_concurrent_executions="provisionedConcurrentExecutions" )
Attributes
-
provisioned_concurrent_executions
¶ CfnFunction.ProvisionedConcurrencyConfigProperty.ProvisionedConcurrentExecutions
.
QueueSAMPTProperty¶
-
class
CfnFunction.
QueueSAMPTProperty
(*, queue_name)¶ Bases:
object
- Parameters
queue_name (
str
) –CfnFunction.QueueSAMPTProperty.QueueName
.- Link
https://github.com/awslabs/serverless-application-model/blob/master/docs/policy_templates.rst
- ExampleMetadata
fixture=_generated
Example:
# The code below shows an example of how to instantiate this type. # The values are placeholders you should change. import aws_cdk.aws_sam as sam queue_sAMPTProperty = sam.CfnFunction.QueueSAMPTProperty( queue_name="queueName" )
Attributes
-
queue_name
¶ CfnFunction.QueueSAMPTProperty.QueueName
.
RequestModelProperty¶
-
class
CfnFunction.
RequestModelProperty
(*, model, required=None, validate_body=None, validate_parameters=None)¶ Bases:
object
- Parameters
model (
str
) –CfnFunction.RequestModelProperty.Model
.required (
Union
[bool
,IResolvable
,None
]) –CfnFunction.RequestModelProperty.Required
.validate_body (
Union
[bool
,IResolvable
,None
]) –CfnFunction.RequestModelProperty.ValidateBody
.validate_parameters (
Union
[bool
,IResolvable
,None
]) –CfnFunction.RequestModelProperty.ValidateParameters
.
- Link
- ExampleMetadata
fixture=_generated
Example:
# The code below shows an example of how to instantiate this type. # The values are placeholders you should change. import aws_cdk.aws_sam as sam request_model_property = sam.CfnFunction.RequestModelProperty( model="model", # the properties below are optional required=False, validate_body=False, validate_parameters=False )
Attributes
-
model
¶ CfnFunction.RequestModelProperty.Model
.
-
required
¶ CfnFunction.RequestModelProperty.Required
.
-
validate_body
¶ CfnFunction.RequestModelProperty.ValidateBody
.
-
validate_parameters
¶ CfnFunction.RequestModelProperty.ValidateParameters
.
RequestParameterProperty¶
-
class
CfnFunction.
RequestParameterProperty
(*, caching=None, required=None)¶ Bases:
object
- Parameters
caching (
Union
[bool
,IResolvable
,None
]) –CfnFunction.RequestParameterProperty.Caching
.required (
Union
[bool
,IResolvable
,None
]) –CfnFunction.RequestParameterProperty.Required
.
- Link
- ExampleMetadata
fixture=_generated
Example:
# The code below shows an example of how to instantiate this type. # The values are placeholders you should change. import aws_cdk.aws_sam as sam request_parameter_property = sam.CfnFunction.RequestParameterProperty( caching=False, required=False )
Attributes
-
caching
¶ CfnFunction.RequestParameterProperty.Caching
.
-
required
¶ CfnFunction.RequestParameterProperty.Required
.
S3EventProperty¶
-
class
CfnFunction.
S3EventProperty
(*, bucket, events, filter=None)¶ Bases:
object
- Parameters
bucket (
str
) –CfnFunction.S3EventProperty.Bucket
.events (
Union
[str
,IResolvable
,Sequence
[str
]]) –CfnFunction.S3EventProperty.Events
.filter (
Union
[IResolvable
,S3NotificationFilterProperty
,None
]) –CfnFunction.S3EventProperty.Filter
.
- Link
https://github.com/awslabs/serverless-application-model/blob/master/versions/2016-10-31.md#s3
- ExampleMetadata
fixture=_generated
Example:
# The code below shows an example of how to instantiate this type. # The values are placeholders you should change. import aws_cdk.aws_sam as sam s3_event_property = sam.CfnFunction.S3EventProperty( bucket="bucket", events="events", # the properties below are optional filter=sam.CfnFunction.S3NotificationFilterProperty( s3_key=sam.CfnFunction.S3KeyFilterProperty( rules=[sam.CfnFunction.S3KeyFilterRuleProperty( name="name", value="value" )] ) ) )
Attributes
-
bucket
¶ CfnFunction.S3EventProperty.Bucket
.
-
events
¶ CfnFunction.S3EventProperty.Events
.- Link
https://github.com/awslabs/serverless-application-model/blob/master/versions/2016-10-31.md#s3
- Return type
Union
[str
,IResolvable
,List
[str
]]
-
filter
¶ CfnFunction.S3EventProperty.Filter
.- Link
https://github.com/awslabs/serverless-application-model/blob/master/versions/2016-10-31.md#s3
- Return type
Union
[IResolvable
,S3NotificationFilterProperty
,None
]
S3KeyFilterProperty¶
-
class
CfnFunction.
S3KeyFilterProperty
(*, rules)¶ Bases:
object
- Parameters
rules (
Union
[IResolvable
,Sequence
[Union
[IResolvable
,S3KeyFilterRuleProperty
]]]) –CfnFunction.S3KeyFilterProperty.Rules
.- Link
- ExampleMetadata
fixture=_generated
Example:
# The code below shows an example of how to instantiate this type. # The values are placeholders you should change. import aws_cdk.aws_sam as sam s3_key_filter_property = sam.CfnFunction.S3KeyFilterProperty( rules=[sam.CfnFunction.S3KeyFilterRuleProperty( name="name", value="value" )] )
Attributes
-
rules
¶ CfnFunction.S3KeyFilterProperty.Rules
.
S3KeyFilterRuleProperty¶
-
class
CfnFunction.
S3KeyFilterRuleProperty
(*, name, value)¶ Bases:
object
- Parameters
name (
str
) –CfnFunction.S3KeyFilterRuleProperty.Name
.value (
str
) –CfnFunction.S3KeyFilterRuleProperty.Value
.
- Link
- ExampleMetadata
fixture=_generated
Example:
# The code below shows an example of how to instantiate this type. # The values are placeholders you should change. import aws_cdk.aws_sam as sam s3_key_filter_rule_property = sam.CfnFunction.S3KeyFilterRuleProperty( name="name", value="value" )
Attributes
-
name
¶ CfnFunction.S3KeyFilterRuleProperty.Name
.
-
value
¶ CfnFunction.S3KeyFilterRuleProperty.Value
.
S3LocationProperty¶
-
class
CfnFunction.
S3LocationProperty
(*, bucket, key, version=None)¶ Bases:
object
- Parameters
bucket (
str
) –CfnFunction.S3LocationProperty.Bucket
.key (
str
) –CfnFunction.S3LocationProperty.Key
.version (
Union
[int
,float
,None
]) –CfnFunction.S3LocationProperty.Version
.
- Link
- ExampleMetadata
fixture=_generated
Example:
# The code below shows an example of how to instantiate this type. # The values are placeholders you should change. import aws_cdk.aws_sam as sam s3_location_property = sam.CfnFunction.S3LocationProperty( bucket="bucket", key="key", # the properties below are optional version=123 )
Attributes
-
bucket
¶ CfnFunction.S3LocationProperty.Bucket
.
-
key
¶ CfnFunction.S3LocationProperty.Key
.
-
version
¶ CfnFunction.S3LocationProperty.Version
.- Link
- Return type
Union
[int
,float
,None
]
S3NotificationFilterProperty¶
-
class
CfnFunction.
S3NotificationFilterProperty
(*, s3_key)¶ Bases:
object
- Parameters
s3_key (
Union
[IResolvable
,S3KeyFilterProperty
]) –CfnFunction.S3NotificationFilterProperty.S3Key
.- Link
- ExampleMetadata
fixture=_generated
Example:
# The code below shows an example of how to instantiate this type. # The values are placeholders you should change. import aws_cdk.aws_sam as sam s3_notification_filter_property = sam.CfnFunction.S3NotificationFilterProperty( s3_key=sam.CfnFunction.S3KeyFilterProperty( rules=[sam.CfnFunction.S3KeyFilterRuleProperty( name="name", value="value" )] ) )
Attributes
-
s3_key
¶ CfnFunction.S3NotificationFilterProperty.S3Key
.
SAMPolicyTemplateProperty¶
-
class
CfnFunction.
SAMPolicyTemplateProperty
(*, ami_describe_policy=None, aws_secrets_manager_get_secret_value_policy=None, cloud_formation_describe_stacks_policy=None, cloud_watch_put_metric_policy=None, dynamo_db_crud_policy=None, dynamo_db_read_policy=None, dynamo_db_stream_read_policy=None, dynamo_db_write_policy=None, ec2_describe_policy=None, elasticsearch_http_post_policy=None, filter_log_events_policy=None, kinesis_crud_policy=None, kinesis_stream_read_policy=None, kms_decrypt_policy=None, lambda_invoke_policy=None, rekognition_detect_only_policy=None, rekognition_labels_policy=None, rekognition_no_data_access_policy=None, rekognition_read_policy=None, rekognition_write_only_access_policy=None, s3_crud_policy=None, s3_read_policy=None, s3_write_policy=None, ses_bulk_templated_crud_policy=None, ses_crud_policy=None, ses_email_template_crud_policy=None, ses_send_bounce_policy=None, sns_crud_policy=None, sns_publish_message_policy=None, sqs_poller_policy=None, sqs_send_message_policy=None, ssm_parameter_read_policy=None, step_functions_execution_policy=None, vpc_access_policy=None)¶ Bases:
object
- Parameters
ami_describe_policy (
Union
[IResolvable
,EmptySAMPTProperty
,None
]) –CfnFunction.SAMPolicyTemplateProperty.AMIDescribePolicy
.aws_secrets_manager_get_secret_value_policy (
Union
[IResolvable
,SecretArnSAMPTProperty
,None
]) –CfnFunction.SAMPolicyTemplateProperty.AWSSecretsManagerGetSecretValuePolicy
.cloud_formation_describe_stacks_policy (
Union
[IResolvable
,EmptySAMPTProperty
,None
]) –CfnFunction.SAMPolicyTemplateProperty.CloudFormationDescribeStacksPolicy
.cloud_watch_put_metric_policy (
Union
[IResolvable
,EmptySAMPTProperty
,None
]) –CfnFunction.SAMPolicyTemplateProperty.CloudWatchPutMetricPolicy
.dynamo_db_crud_policy (
Union
[IResolvable
,TableSAMPTProperty
,None
]) –CfnFunction.SAMPolicyTemplateProperty.DynamoDBCrudPolicy
.dynamo_db_read_policy (
Union
[IResolvable
,TableSAMPTProperty
,None
]) –CfnFunction.SAMPolicyTemplateProperty.DynamoDBReadPolicy
.dynamo_db_stream_read_policy (
Union
[IResolvable
,TableStreamSAMPTProperty
,None
]) –CfnFunction.SAMPolicyTemplateProperty.DynamoDBStreamReadPolicy
.dynamo_db_write_policy (
Union
[IResolvable
,TableSAMPTProperty
,None
]) –CfnFunction.SAMPolicyTemplateProperty.DynamoDBWritePolicy
.ec2_describe_policy (
Union
[IResolvable
,EmptySAMPTProperty
,None
]) –CfnFunction.SAMPolicyTemplateProperty.EC2DescribePolicy
.elasticsearch_http_post_policy (
Union
[IResolvable
,DomainSAMPTProperty
,None
]) –CfnFunction.SAMPolicyTemplateProperty.ElasticsearchHttpPostPolicy
.filter_log_events_policy (
Union
[IResolvable
,LogGroupSAMPTProperty
,None
]) –CfnFunction.SAMPolicyTemplateProperty.FilterLogEventsPolicy
.kinesis_crud_policy (
Union
[IResolvable
,StreamSAMPTProperty
,None
]) –CfnFunction.SAMPolicyTemplateProperty.KinesisCrudPolicy
.kinesis_stream_read_policy (
Union
[IResolvable
,StreamSAMPTProperty
,None
]) –CfnFunction.SAMPolicyTemplateProperty.KinesisStreamReadPolicy
.kms_decrypt_policy (
Union
[IResolvable
,KeySAMPTProperty
,None
]) –CfnFunction.SAMPolicyTemplateProperty.KMSDecryptPolicy
.lambda_invoke_policy (
Union
[IResolvable
,FunctionSAMPTProperty
,None
]) –CfnFunction.SAMPolicyTemplateProperty.LambdaInvokePolicy
.rekognition_detect_only_policy (
Union
[IResolvable
,EmptySAMPTProperty
,None
]) –CfnFunction.SAMPolicyTemplateProperty.RekognitionDetectOnlyPolicy
.rekognition_labels_policy (
Union
[IResolvable
,EmptySAMPTProperty
,None
]) –CfnFunction.SAMPolicyTemplateProperty.RekognitionLabelsPolicy
.rekognition_no_data_access_policy (
Union
[IResolvable
,CollectionSAMPTProperty
,None
]) –CfnFunction.SAMPolicyTemplateProperty.RekognitionNoDataAccessPolicy
.rekognition_read_policy (
Union
[IResolvable
,CollectionSAMPTProperty
,None
]) –CfnFunction.SAMPolicyTemplateProperty.RekognitionReadPolicy
.rekognition_write_only_access_policy (
Union
[IResolvable
,CollectionSAMPTProperty
,None
]) –CfnFunction.SAMPolicyTemplateProperty.RekognitionWriteOnlyAccessPolicy
.s3_crud_policy (
Union
[IResolvable
,BucketSAMPTProperty
,None
]) –CfnFunction.SAMPolicyTemplateProperty.S3CrudPolicy
.s3_read_policy (
Union
[IResolvable
,BucketSAMPTProperty
,None
]) –CfnFunction.SAMPolicyTemplateProperty.S3ReadPolicy
.s3_write_policy (
Union
[IResolvable
,BucketSAMPTProperty
,None
]) –CfnFunction.SAMPolicyTemplateProperty.S3WritePolicy
.ses_bulk_templated_crud_policy (
Union
[IResolvable
,IdentitySAMPTProperty
,None
]) –CfnFunction.SAMPolicyTemplateProperty.SESBulkTemplatedCrudPolicy
.ses_crud_policy (
Union
[IResolvable
,IdentitySAMPTProperty
,None
]) –CfnFunction.SAMPolicyTemplateProperty.SESCrudPolicy
.ses_email_template_crud_policy (
Union
[IResolvable
,EmptySAMPTProperty
,None
]) –CfnFunction.SAMPolicyTemplateProperty.SESEmailTemplateCrudPolicy
.ses_send_bounce_policy (
Union
[IResolvable
,IdentitySAMPTProperty
,None
]) –CfnFunction.SAMPolicyTemplateProperty.SESSendBouncePolicy
.sns_crud_policy (
Union
[IResolvable
,TopicSAMPTProperty
,None
]) –CfnFunction.SAMPolicyTemplateProperty.SNSCrudPolicy
.sns_publish_message_policy (
Union
[IResolvable
,TopicSAMPTProperty
,None
]) –CfnFunction.SAMPolicyTemplateProperty.SNSPublishMessagePolicy
.sqs_poller_policy (
Union
[IResolvable
,QueueSAMPTProperty
,None
]) –CfnFunction.SAMPolicyTemplateProperty.SQSPollerPolicy
.sqs_send_message_policy (
Union
[IResolvable
,QueueSAMPTProperty
,None
]) –CfnFunction.SAMPolicyTemplateProperty.SQSSendMessagePolicy
.ssm_parameter_read_policy (
Union
[IResolvable
,ParameterNameSAMPTProperty
,None
]) –CfnFunction.SAMPolicyTemplateProperty.SSMParameterReadPolicy
.step_functions_execution_policy (
Union
[IResolvable
,StateMachineSAMPTProperty
,None
]) –CfnFunction.SAMPolicyTemplateProperty.StepFunctionsExecutionPolicy
.vpc_access_policy (
Union
[IResolvable
,EmptySAMPTProperty
,None
]) –CfnFunction.SAMPolicyTemplateProperty.VPCAccessPolicy
.
- Link
https://github.com/awslabs/serverless-application-model/blob/master/docs/policy_templates.rst
- ExampleMetadata
fixture=_generated
Example:
# The code below shows an example of how to instantiate this type. # The values are placeholders you should change. import aws_cdk.aws_sam as sam s_aMPolicy_template_property = sam.CfnFunction.SAMPolicyTemplateProperty( ami_describe_policy=sam.CfnFunction.EmptySAMPTProperty(), aws_secrets_manager_get_secret_value_policy=sam.CfnFunction.SecretArnSAMPTProperty( secret_arn="secretArn" ), cloud_formation_describe_stacks_policy=sam.CfnFunction.EmptySAMPTProperty(), cloud_watch_put_metric_policy=sam.CfnFunction.EmptySAMPTProperty(), dynamo_db_crud_policy=sam.CfnFunction.TableSAMPTProperty( table_name="tableName" ), dynamo_db_read_policy=sam.CfnFunction.TableSAMPTProperty( table_name="tableName" ), dynamo_db_stream_read_policy=sam.CfnFunction.TableStreamSAMPTProperty( stream_name="streamName", table_name="tableName" ), dynamo_db_write_policy=sam.CfnFunction.TableSAMPTProperty( table_name="tableName" ), ec2_describe_policy=sam.CfnFunction.EmptySAMPTProperty(), elasticsearch_http_post_policy=sam.CfnFunction.DomainSAMPTProperty( domain_name="domainName" ), filter_log_events_policy=sam.CfnFunction.LogGroupSAMPTProperty( log_group_name="logGroupName" ), kinesis_crud_policy=sam.CfnFunction.StreamSAMPTProperty( stream_name="streamName" ), kinesis_stream_read_policy=sam.CfnFunction.StreamSAMPTProperty( stream_name="streamName" ), kms_decrypt_policy=sam.CfnFunction.KeySAMPTProperty( key_id="keyId" ), lambda_invoke_policy=sam.CfnFunction.FunctionSAMPTProperty( function_name="functionName" ), rekognition_detect_only_policy=sam.CfnFunction.EmptySAMPTProperty(), rekognition_labels_policy=sam.CfnFunction.EmptySAMPTProperty(), rekognition_no_data_access_policy=sam.CfnFunction.CollectionSAMPTProperty( collection_id="collectionId" ), rekognition_read_policy=sam.CfnFunction.CollectionSAMPTProperty( collection_id="collectionId" ), rekognition_write_only_access_policy=sam.CfnFunction.CollectionSAMPTProperty( collection_id="collectionId" ), s3_crud_policy=sam.CfnFunction.BucketSAMPTProperty( bucket_name="bucketName" ), s3_read_policy=sam.CfnFunction.BucketSAMPTProperty( bucket_name="bucketName" ), s3_write_policy=sam.CfnFunction.BucketSAMPTProperty( bucket_name="bucketName" ), ses_bulk_templated_crud_policy=sam.CfnFunction.IdentitySAMPTProperty( identity_name="identityName" ), ses_crud_policy=sam.CfnFunction.IdentitySAMPTProperty( identity_name="identityName" ), ses_email_template_crud_policy=sam.CfnFunction.EmptySAMPTProperty(), ses_send_bounce_policy=sam.CfnFunction.IdentitySAMPTProperty( identity_name="identityName" ), sns_crud_policy=sam.CfnFunction.TopicSAMPTProperty( topic_name="topicName" ), sns_publish_message_policy=sam.CfnFunction.TopicSAMPTProperty( topic_name="topicName" ), sqs_poller_policy=sam.CfnFunction.QueueSAMPTProperty( queue_name="queueName" ), sqs_send_message_policy=sam.CfnFunction.QueueSAMPTProperty( queue_name="queueName" ), ssm_parameter_read_policy=sam.CfnFunction.ParameterNameSAMPTProperty( parameter_name="parameterName" ), step_functions_execution_policy=sam.CfnFunction.StateMachineSAMPTProperty( state_machine_name="stateMachineName" ), vpc_access_policy=sam.CfnFunction.EmptySAMPTProperty() )
Attributes
-
ami_describe_policy
¶ CfnFunction.SAMPolicyTemplateProperty.AMIDescribePolicy
.- Link
https://github.com/awslabs/serverless-application-model/blob/master/docs/policy_templates.rst
- Return type
Union
[IResolvable
,EmptySAMPTProperty
,None
]
-
aws_secrets_manager_get_secret_value_policy
¶ CfnFunction.SAMPolicyTemplateProperty.AWSSecretsManagerGetSecretValuePolicy
.- Link
https://github.com/awslabs/serverless-application-model/blob/master/docs/policy_templates.rst
- Return type
Union
[IResolvable
,SecretArnSAMPTProperty
,None
]
-
cloud_formation_describe_stacks_policy
¶ CfnFunction.SAMPolicyTemplateProperty.CloudFormationDescribeStacksPolicy
.- Link
https://github.com/awslabs/serverless-application-model/blob/master/docs/policy_templates.rst
- Return type
Union
[IResolvable
,EmptySAMPTProperty
,None
]
-
cloud_watch_put_metric_policy
¶ CfnFunction.SAMPolicyTemplateProperty.CloudWatchPutMetricPolicy
.- Link
https://github.com/awslabs/serverless-application-model/blob/master/docs/policy_templates.rst
- Return type
Union
[IResolvable
,EmptySAMPTProperty
,None
]
-
dynamo_db_crud_policy
¶ CfnFunction.SAMPolicyTemplateProperty.DynamoDBCrudPolicy
.- Link
https://github.com/awslabs/serverless-application-model/blob/master/docs/policy_templates.rst
- Return type
Union
[IResolvable
,TableSAMPTProperty
,None
]
-
dynamo_db_read_policy
¶ CfnFunction.SAMPolicyTemplateProperty.DynamoDBReadPolicy
.- Link
https://github.com/awslabs/serverless-application-model/blob/master/docs/policy_templates.rst
- Return type
Union
[IResolvable
,TableSAMPTProperty
,None
]
-
dynamo_db_stream_read_policy
¶ CfnFunction.SAMPolicyTemplateProperty.DynamoDBStreamReadPolicy
.- Link
https://github.com/awslabs/serverless-application-model/blob/master/docs/policy_templates.rst
- Return type
Union
[IResolvable
,TableStreamSAMPTProperty
,None
]
-
dynamo_db_write_policy
¶ CfnFunction.SAMPolicyTemplateProperty.DynamoDBWritePolicy
.- Link
https://github.com/awslabs/serverless-application-model/blob/master/docs/policy_templates.rst
- Return type
Union
[IResolvable
,TableSAMPTProperty
,None
]
-
ec2_describe_policy
¶ CfnFunction.SAMPolicyTemplateProperty.EC2DescribePolicy
.- Link
https://github.com/awslabs/serverless-application-model/blob/master/docs/policy_templates.rst
- Return type
Union
[IResolvable
,EmptySAMPTProperty
,None
]
-
elasticsearch_http_post_policy
¶ CfnFunction.SAMPolicyTemplateProperty.ElasticsearchHttpPostPolicy
.- Link
https://github.com/awslabs/serverless-application-model/blob/master/docs/policy_templates.rst
- Return type
Union
[IResolvable
,DomainSAMPTProperty
,None
]
-
filter_log_events_policy
¶ CfnFunction.SAMPolicyTemplateProperty.FilterLogEventsPolicy
.- Link
https://github.com/awslabs/serverless-application-model/blob/master/docs/policy_templates.rst
- Return type
Union
[IResolvable
,LogGroupSAMPTProperty
,None
]
-
kinesis_crud_policy
¶ CfnFunction.SAMPolicyTemplateProperty.KinesisCrudPolicy
.- Link
https://github.com/awslabs/serverless-application-model/blob/master/docs/policy_templates.rst
- Return type
Union
[IResolvable
,StreamSAMPTProperty
,None
]
-
kinesis_stream_read_policy
¶ CfnFunction.SAMPolicyTemplateProperty.KinesisStreamReadPolicy
.- Link
https://github.com/awslabs/serverless-application-model/blob/master/docs/policy_templates.rst
- Return type
Union
[IResolvable
,StreamSAMPTProperty
,None
]
-
kms_decrypt_policy
¶ CfnFunction.SAMPolicyTemplateProperty.KMSDecryptPolicy
.- Link
https://github.com/awslabs/serverless-application-model/blob/master/docs/policy_templates.rst
- Return type
Union
[IResolvable
,KeySAMPTProperty
,None
]
-
lambda_invoke_policy
¶ CfnFunction.SAMPolicyTemplateProperty.LambdaInvokePolicy
.- Link
https://github.com/awslabs/serverless-application-model/blob/master/docs/policy_templates.rst
- Return type
Union
[IResolvable
,FunctionSAMPTProperty
,None
]
-
rekognition_detect_only_policy
¶ CfnFunction.SAMPolicyTemplateProperty.RekognitionDetectOnlyPolicy
.- Link
https://github.com/awslabs/serverless-application-model/blob/master/docs/policy_templates.rst
- Return type
Union
[IResolvable
,EmptySAMPTProperty
,None
]
-
rekognition_labels_policy
¶ CfnFunction.SAMPolicyTemplateProperty.RekognitionLabelsPolicy
.- Link
https://github.com/awslabs/serverless-application-model/blob/master/docs/policy_templates.rst
- Return type
Union
[IResolvable
,EmptySAMPTProperty
,None
]
-
rekognition_no_data_access_policy
¶ CfnFunction.SAMPolicyTemplateProperty.RekognitionNoDataAccessPolicy
.- Link
https://github.com/awslabs/serverless-application-model/blob/master/docs/policy_templates.rst
- Return type
Union
[IResolvable
,CollectionSAMPTProperty
,None
]
-
rekognition_read_policy
¶ CfnFunction.SAMPolicyTemplateProperty.RekognitionReadPolicy
.- Link
https://github.com/awslabs/serverless-application-model/blob/master/docs/policy_templates.rst
- Return type
Union
[IResolvable
,CollectionSAMPTProperty
,None
]
-
rekognition_write_only_access_policy
¶ CfnFunction.SAMPolicyTemplateProperty.RekognitionWriteOnlyAccessPolicy
.- Link
https://github.com/awslabs/serverless-application-model/blob/master/docs/policy_templates.rst
- Return type
Union
[IResolvable
,CollectionSAMPTProperty
,None
]
-
s3_crud_policy
¶ CfnFunction.SAMPolicyTemplateProperty.S3CrudPolicy
.- Link
https://github.com/awslabs/serverless-application-model/blob/master/docs/policy_templates.rst
- Return type
Union
[IResolvable
,BucketSAMPTProperty
,None
]
-
s3_read_policy
¶ CfnFunction.SAMPolicyTemplateProperty.S3ReadPolicy
.- Link
https://github.com/awslabs/serverless-application-model/blob/master/docs/policy_templates.rst
- Return type
Union
[IResolvable
,BucketSAMPTProperty
,None
]
-
s3_write_policy
¶ CfnFunction.SAMPolicyTemplateProperty.S3WritePolicy
.- Link
https://github.com/awslabs/serverless-application-model/blob/master/docs/policy_templates.rst
- Return type
Union
[IResolvable
,BucketSAMPTProperty
,None
]
-
ses_bulk_templated_crud_policy
¶ CfnFunction.SAMPolicyTemplateProperty.SESBulkTemplatedCrudPolicy
.- Link
https://github.com/awslabs/serverless-application-model/blob/master/docs/policy_templates.rst
- Return type
Union
[IResolvable
,IdentitySAMPTProperty
,None
]
-
ses_crud_policy
¶ CfnFunction.SAMPolicyTemplateProperty.SESCrudPolicy
.- Link
https://github.com/awslabs/serverless-application-model/blob/master/docs/policy_templates.rst
- Return type
Union
[IResolvable
,IdentitySAMPTProperty
,None
]
-
ses_email_template_crud_policy
¶ CfnFunction.SAMPolicyTemplateProperty.SESEmailTemplateCrudPolicy
.- Link
https://github.com/awslabs/serverless-application-model/blob/master/docs/policy_templates.rst
- Return type
Union
[IResolvable
,EmptySAMPTProperty
,None
]
-
ses_send_bounce_policy
¶ CfnFunction.SAMPolicyTemplateProperty.SESSendBouncePolicy
.- Link
https://github.com/awslabs/serverless-application-model/blob/master/docs/policy_templates.rst
- Return type
Union
[IResolvable
,IdentitySAMPTProperty
,None
]
-
sns_crud_policy
¶ CfnFunction.SAMPolicyTemplateProperty.SNSCrudPolicy
.- Link
https://github.com/awslabs/serverless-application-model/blob/master/docs/policy_templates.rst
- Return type
Union
[IResolvable
,TopicSAMPTProperty
,None
]
-
sns_publish_message_policy
¶ CfnFunction.SAMPolicyTemplateProperty.SNSPublishMessagePolicy
.- Link
https://github.com/awslabs/serverless-application-model/blob/master/docs/policy_templates.rst
- Return type
Union
[IResolvable
,TopicSAMPTProperty
,None
]
-
sqs_poller_policy
¶ CfnFunction.SAMPolicyTemplateProperty.SQSPollerPolicy
.- Link
https://github.com/awslabs/serverless-application-model/blob/master/docs/policy_templates.rst
- Return type
Union
[IResolvable
,QueueSAMPTProperty
,None
]
-
sqs_send_message_policy
¶ CfnFunction.SAMPolicyTemplateProperty.SQSSendMessagePolicy
.- Link
https://github.com/awslabs/serverless-application-model/blob/master/docs/policy_templates.rst
- Return type
Union
[IResolvable
,QueueSAMPTProperty
,None
]
-
ssm_parameter_read_policy
¶ CfnFunction.SAMPolicyTemplateProperty.SSMParameterReadPolicy
.- Link
https://github.com/awslabs/serverless-application-model/blob/master/docs/policy_templates.rst
- Return type
Union
[IResolvable
,ParameterNameSAMPTProperty
,None
]
-
step_functions_execution_policy
¶ CfnFunction.SAMPolicyTemplateProperty.StepFunctionsExecutionPolicy
.- Link
https://github.com/awslabs/serverless-application-model/blob/master/docs/policy_templates.rst
- Return type
Union
[IResolvable
,StateMachineSAMPTProperty
,None
]
-
vpc_access_policy
¶ CfnFunction.SAMPolicyTemplateProperty.VPCAccessPolicy
.- Link
https://github.com/awslabs/serverless-application-model/blob/master/docs/policy_templates.rst
- Return type
Union
[IResolvable
,EmptySAMPTProperty
,None
]
SNSEventProperty¶
-
class
CfnFunction.
SNSEventProperty
(*, topic)¶ Bases:
object
- Parameters
topic (
str
) –CfnFunction.SNSEventProperty.Topic
.- Link
https://github.com/awslabs/serverless-application-model/blob/master/versions/2016-10-31.md#sns
- ExampleMetadata
fixture=_generated
Example:
# The code below shows an example of how to instantiate this type. # The values are placeholders you should change. import aws_cdk.aws_sam as sam s_nSEvent_property = sam.CfnFunction.SNSEventProperty( topic="topic" )
Attributes
-
topic
¶ CfnFunction.SNSEventProperty.Topic
.
SQSEventProperty¶
-
class
CfnFunction.
SQSEventProperty
(*, queue, batch_size=None, enabled=None)¶ Bases:
object
- Parameters
queue (
str
) –CfnFunction.SQSEventProperty.Queue
.batch_size (
Union
[int
,float
,None
]) –CfnFunction.SQSEventProperty.BatchSize
.enabled (
Union
[bool
,IResolvable
,None
]) –CfnFunction.SQSEventProperty.Enabled
.
- Link
https://github.com/awslabs/serverless-application-model/blob/master/versions/2016-10-31.md#sqs
- ExampleMetadata
fixture=_generated
Example:
# The code below shows an example of how to instantiate this type. # The values are placeholders you should change. import aws_cdk.aws_sam as sam s_qSEvent_property = sam.CfnFunction.SQSEventProperty( queue="queue", # the properties below are optional batch_size=123, enabled=False )
Attributes
-
batch_size
¶ CfnFunction.SQSEventProperty.BatchSize
.- Link
https://github.com/awslabs/serverless-application-model/blob/master/versions/2016-10-31.md#sqs
- Return type
Union
[int
,float
,None
]
-
enabled
¶ CfnFunction.SQSEventProperty.Enabled
.- Link
https://github.com/awslabs/serverless-application-model/blob/master/versions/2016-10-31.md#sqs
- Return type
Union
[bool
,IResolvable
,None
]
-
queue
¶ CfnFunction.SQSEventProperty.Queue
.
ScheduleEventProperty¶
-
class
CfnFunction.
ScheduleEventProperty
(*, schedule, input=None)¶ Bases:
object
- Parameters
schedule (
str
) –CfnFunction.ScheduleEventProperty.Schedule
.input (
Optional
[str
]) –CfnFunction.ScheduleEventProperty.Input
.
- Link
https://github.com/awslabs/serverless-application-model/blob/master/versions/2016-10-31.md#schedule
- ExampleMetadata
fixture=_generated
Example:
# The code below shows an example of how to instantiate this type. # The values are placeholders you should change. import aws_cdk.aws_sam as sam schedule_event_property = sam.CfnFunction.ScheduleEventProperty( schedule="schedule", # the properties below are optional input="input" )
Attributes
-
input
¶ CfnFunction.ScheduleEventProperty.Input
.- Link
https://github.com/awslabs/serverless-application-model/blob/master/versions/2016-10-31.md#schedule
- Return type
Optional
[str
]
-
schedule
¶ CfnFunction.ScheduleEventProperty.Schedule
.
SecretArnSAMPTProperty¶
-
class
CfnFunction.
SecretArnSAMPTProperty
(*, secret_arn)¶ Bases:
object
- Parameters
secret_arn (
str
) –CfnFunction.SecretArnSAMPTProperty.SecretArn
.- Link
https://github.com/awslabs/serverless-application-model/blob/master/docs/policy_templates.rst
- ExampleMetadata
fixture=_generated
Example:
# The code below shows an example of how to instantiate this type. # The values are placeholders you should change. import aws_cdk.aws_sam as sam secret_arn_sAMPTProperty = sam.CfnFunction.SecretArnSAMPTProperty( secret_arn="secretArn" )
Attributes
-
secret_arn
¶ CfnFunction.SecretArnSAMPTProperty.SecretArn
.
StateMachineSAMPTProperty¶
-
class
CfnFunction.
StateMachineSAMPTProperty
(*, state_machine_name)¶ Bases:
object
- Parameters
state_machine_name (
str
) –CfnFunction.StateMachineSAMPTProperty.StateMachineName
.- Link
https://github.com/awslabs/serverless-application-model/blob/master/docs/policy_templates.rst
- ExampleMetadata
fixture=_generated
Example:
# The code below shows an example of how to instantiate this type. # The values are placeholders you should change. import aws_cdk.aws_sam as sam state_machine_sAMPTProperty = sam.CfnFunction.StateMachineSAMPTProperty( state_machine_name="stateMachineName" )
Attributes
-
state_machine_name
¶ CfnFunction.StateMachineSAMPTProperty.StateMachineName
.
StreamSAMPTProperty¶
-
class
CfnFunction.
StreamSAMPTProperty
(*, stream_name)¶ Bases:
object
- Parameters
stream_name (
str
) –CfnFunction.StreamSAMPTProperty.StreamName
.- Link
https://github.com/awslabs/serverless-application-model/blob/master/docs/policy_templates.rst
- ExampleMetadata
fixture=_generated
Example:
# The code below shows an example of how to instantiate this type. # The values are placeholders you should change. import aws_cdk.aws_sam as sam stream_sAMPTProperty = sam.CfnFunction.StreamSAMPTProperty( stream_name="streamName" )
Attributes
-
stream_name
¶ CfnFunction.StreamSAMPTProperty.StreamName
.
TableSAMPTProperty¶
-
class
CfnFunction.
TableSAMPTProperty
(*, table_name)¶ Bases:
object
- Parameters
table_name (
str
) –CfnFunction.TableSAMPTProperty.TableName
.- Link
https://github.com/awslabs/serverless-application-model/blob/master/docs/policy_templates.rst
- ExampleMetadata
fixture=_generated
Example:
# The code below shows an example of how to instantiate this type. # The values are placeholders you should change. import aws_cdk.aws_sam as sam table_sAMPTProperty = sam.CfnFunction.TableSAMPTProperty( table_name="tableName" )
Attributes
-
table_name
¶ CfnFunction.TableSAMPTProperty.TableName
.
TableStreamSAMPTProperty¶
-
class
CfnFunction.
TableStreamSAMPTProperty
(*, stream_name, table_name)¶ Bases:
object
- Parameters
stream_name (
str
) –CfnFunction.TableStreamSAMPTProperty.StreamName
.table_name (
str
) –CfnFunction.TableStreamSAMPTProperty.TableName
.
- Link
https://github.com/awslabs/serverless-application-model/blob/master/docs/policy_templates.rst
- ExampleMetadata
fixture=_generated
Example:
# The code below shows an example of how to instantiate this type. # The values are placeholders you should change. import aws_cdk.aws_sam as sam table_stream_sAMPTProperty = sam.CfnFunction.TableStreamSAMPTProperty( stream_name="streamName", table_name="tableName" )
Attributes
-
stream_name
¶ CfnFunction.TableStreamSAMPTProperty.StreamName
.
-
table_name
¶ CfnFunction.TableStreamSAMPTProperty.TableName
.
TopicSAMPTProperty¶
-
class
CfnFunction.
TopicSAMPTProperty
(*, topic_name)¶ Bases:
object
- Parameters
topic_name (
str
) –CfnFunction.TopicSAMPTProperty.TopicName
.- Link
https://github.com/awslabs/serverless-application-model/blob/master/docs/policy_templates.rst
- ExampleMetadata
fixture=_generated
Example:
# The code below shows an example of how to instantiate this type. # The values are placeholders you should change. import aws_cdk.aws_sam as sam topic_sAMPTProperty = sam.CfnFunction.TopicSAMPTProperty( topic_name="topicName" )
Attributes
-
topic_name
¶ CfnFunction.TopicSAMPTProperty.TopicName
.
VpcConfigProperty¶
-
class
CfnFunction.
VpcConfigProperty
(*, security_group_ids, subnet_ids)¶ Bases:
object
- Parameters
security_group_ids (
Sequence
[str
]) –CfnFunction.VpcConfigProperty.SecurityGroupIds
.subnet_ids (
Sequence
[str
]) –CfnFunction.VpcConfigProperty.SubnetIds
.
- Link
- ExampleMetadata
fixture=_generated
Example:
# The code below shows an example of how to instantiate this type. # The values are placeholders you should change. import aws_cdk.aws_sam as sam vpc_config_property = sam.CfnFunction.VpcConfigProperty( security_group_ids=["securityGroupIds"], subnet_ids=["subnetIds"] )
Attributes
-
security_group_ids
¶ CfnFunction.VpcConfigProperty.SecurityGroupIds
.- Link
- Return type
List
[str
]
-
subnet_ids
¶ CfnFunction.VpcConfigProperty.SubnetIds
.- Link
- Return type
List
[str
]