README
¶
AWS Serverless Application Model Construct Library
This module is part of the AWS Cloud Development Kit project.
import serverless "github.com/aws/aws-cdk-go/awscdk"
There are no official hand-written (L2) constructs for this service yet. Here are some suggestions on how to proceed:
- Search Construct Hub for Serverless construct libraries
- Use the automatically generated L1 constructs, in the same way you would use the CloudFormation AWS::Serverless resources directly.
There are no hand-written (L2) constructs for this service yet. However, you can still use the automatically generated L1 constructs, and use this service exactly as you would using CloudFormation directly.
For more information on the resources and properties available for this service, see the CloudFormation documentation for AWS::Serverless.
(Read the CDK Contributing Guide and submit an RFC if you are interested in contributing to this construct library.)
Documentation
¶
Index ¶
- func CfnApi_CFN_RESOURCE_TYPE_NAME() *string
- func CfnApi_IsCfnElement(x interface{}) *bool
- func CfnApi_IsCfnResource(construct constructs.IConstruct) *bool
- func CfnApi_IsConstruct(x interface{}) *bool
- func CfnApi_REQUIRED_TRANSFORM() *string
- func CfnApplication_CFN_RESOURCE_TYPE_NAME() *string
- func CfnApplication_IsCfnElement(x interface{}) *bool
- func CfnApplication_IsCfnResource(construct constructs.IConstruct) *bool
- func CfnApplication_IsConstruct(x interface{}) *bool
- func CfnApplication_REQUIRED_TRANSFORM() *string
- func CfnFunction_CFN_RESOURCE_TYPE_NAME() *string
- func CfnFunction_IsCfnElement(x interface{}) *bool
- func CfnFunction_IsCfnResource(construct constructs.IConstruct) *bool
- func CfnFunction_IsConstruct(x interface{}) *bool
- func CfnFunction_REQUIRED_TRANSFORM() *string
- func CfnHttpApi_CFN_RESOURCE_TYPE_NAME() *string
- func CfnHttpApi_IsCfnElement(x interface{}) *bool
- func CfnHttpApi_IsCfnResource(construct constructs.IConstruct) *bool
- func CfnHttpApi_IsConstruct(x interface{}) *bool
- func CfnHttpApi_REQUIRED_TRANSFORM() *string
- func CfnLayerVersion_CFN_RESOURCE_TYPE_NAME() *string
- func CfnLayerVersion_IsCfnElement(x interface{}) *bool
- func CfnLayerVersion_IsCfnResource(construct constructs.IConstruct) *bool
- func CfnLayerVersion_IsConstruct(x interface{}) *bool
- func CfnLayerVersion_REQUIRED_TRANSFORM() *string
- func CfnSimpleTable_CFN_RESOURCE_TYPE_NAME() *string
- func CfnSimpleTable_IsCfnElement(x interface{}) *bool
- func CfnSimpleTable_IsCfnResource(construct constructs.IConstruct) *bool
- func CfnSimpleTable_IsConstruct(x interface{}) *bool
- func CfnSimpleTable_REQUIRED_TRANSFORM() *string
- func CfnStateMachine_CFN_RESOURCE_TYPE_NAME() *string
- func CfnStateMachine_IsCfnElement(x interface{}) *bool
- func CfnStateMachine_IsCfnResource(construct constructs.IConstruct) *bool
- func CfnStateMachine_IsConstruct(x interface{}) *bool
- func CfnStateMachine_REQUIRED_TRANSFORM() *string
- func NewCfnApi_Override(c CfnApi, scope constructs.Construct, id *string, props *CfnApiProps)
- func NewCfnApplication_Override(c CfnApplication, scope constructs.Construct, id *string, ...)
- func NewCfnFunction_Override(c CfnFunction, scope constructs.Construct, id *string, props *CfnFunctionProps)
- func NewCfnHttpApi_Override(c CfnHttpApi, scope constructs.Construct, id *string, props *CfnHttpApiProps)
- func NewCfnLayerVersion_Override(c CfnLayerVersion, scope constructs.Construct, id *string, ...)
- func NewCfnSimpleTable_Override(c CfnSimpleTable, scope constructs.Construct, id *string, ...)
- func NewCfnStateMachine_Override(c CfnStateMachine, scope constructs.Construct, id *string, ...)
- type CfnApi
- type CfnApiProps
- type CfnApi_AccessLogSettingProperty
- type CfnApi_AuthProperty
- type CfnApi_CanarySettingProperty
- type CfnApi_CorsConfigurationProperty
- type CfnApi_DomainConfigurationProperty
- type CfnApi_EndpointConfigurationProperty
- type CfnApi_MutualTlsAuthenticationProperty
- type CfnApi_Route53ConfigurationProperty
- type CfnApi_S3LocationProperty
- type CfnApplication
- type CfnApplicationProps
- type CfnApplication_ApplicationLocationProperty
- type CfnFunction
- type CfnFunctionProps
- type CfnFunction_AlexaSkillEventProperty
- type CfnFunction_ApiEventProperty
- type CfnFunction_AuthProperty
- type CfnFunction_AuthResourcePolicyProperty
- type CfnFunction_BucketSAMPTProperty
- type CfnFunction_CloudWatchEventEventProperty
- type CfnFunction_CloudWatchLogsEventProperty
- type CfnFunction_CognitoEventProperty
- type CfnFunction_CollectionSAMPTProperty
- type CfnFunction_DeadLetterQueueProperty
- type CfnFunction_DeploymentPreferenceProperty
- type CfnFunction_DestinationConfigProperty
- type CfnFunction_DestinationProperty
- type CfnFunction_DomainSAMPTProperty
- type CfnFunction_DynamoDBEventProperty
- type CfnFunction_EmptySAMPTProperty
- type CfnFunction_EventBridgeRuleEventProperty
- type CfnFunction_EventInvokeConfigProperty
- type CfnFunction_EventInvokeDestinationConfigProperty
- type CfnFunction_EventSourceProperty
- type CfnFunction_FileSystemConfigProperty
- type CfnFunction_FunctionEnvironmentProperty
- type CfnFunction_FunctionSAMPTProperty
- type CfnFunction_HooksProperty
- type CfnFunction_HttpApiEventProperty
- type CfnFunction_HttpApiFunctionAuthProperty
- type CfnFunction_IAMPolicyDocumentProperty
- type CfnFunction_IdentitySAMPTProperty
- type CfnFunction_ImageConfigProperty
- type CfnFunction_IoTRuleEventProperty
- type CfnFunction_KeySAMPTProperty
- type CfnFunction_KinesisEventProperty
- type CfnFunction_LogGroupSAMPTProperty
- type CfnFunction_ParameterNameSAMPTProperty
- type CfnFunction_ProvisionedConcurrencyConfigProperty
- type CfnFunction_QueueSAMPTProperty
- type CfnFunction_RequestModelProperty
- type CfnFunction_RequestParameterProperty
- type CfnFunction_RouteSettingsProperty
- type CfnFunction_S3EventProperty
- type CfnFunction_S3KeyFilterProperty
- type CfnFunction_S3KeyFilterRuleProperty
- type CfnFunction_S3LocationProperty
- type CfnFunction_S3NotificationFilterProperty
- type CfnFunction_SAMPolicyTemplateProperty
- type CfnFunction_SNSEventProperty
- type CfnFunction_SQSEventProperty
- type CfnFunction_ScheduleEventProperty
- type CfnFunction_SecretArnSAMPTProperty
- type CfnFunction_StateMachineSAMPTProperty
- type CfnFunction_StreamSAMPTProperty
- type CfnFunction_TableSAMPTProperty
- type CfnFunction_TableStreamSAMPTProperty
- type CfnFunction_TopicSAMPTProperty
- type CfnFunction_VpcConfigProperty
- type CfnHttpApi
- type CfnHttpApiProps
- type CfnHttpApi_AccessLogSettingProperty
- type CfnHttpApi_CorsConfigurationObjectProperty
- type CfnHttpApi_HttpApiAuthProperty
- type CfnHttpApi_HttpApiDomainConfigurationProperty
- type CfnHttpApi_MutualTlsAuthenticationProperty
- type CfnHttpApi_Route53ConfigurationProperty
- type CfnHttpApi_RouteSettingsProperty
- type CfnHttpApi_S3LocationProperty
- type CfnLayerVersion
- type CfnLayerVersionProps
- type CfnLayerVersion_S3LocationProperty
- type CfnSimpleTable
- type CfnSimpleTableProps
- type CfnSimpleTable_PrimaryKeyProperty
- type CfnSimpleTable_ProvisionedThroughputProperty
- type CfnSimpleTable_SSESpecificationProperty
- type CfnStateMachine
- type CfnStateMachineProps
- type CfnStateMachine_ApiEventProperty
- type CfnStateMachine_CloudWatchEventEventProperty
- type CfnStateMachine_CloudWatchLogsLogGroupProperty
- type CfnStateMachine_EventBridgeRuleEventProperty
- type CfnStateMachine_EventSourceProperty
- type CfnStateMachine_FunctionSAMPTProperty
- type CfnStateMachine_IAMPolicyDocumentProperty
- type CfnStateMachine_LogDestinationProperty
- type CfnStateMachine_LoggingConfigurationProperty
- type CfnStateMachine_S3LocationProperty
- type CfnStateMachine_SAMPolicyTemplateProperty
- type CfnStateMachine_ScheduleEventProperty
- type CfnStateMachine_StateMachineSAMPTProperty
- type CfnStateMachine_TracingConfigurationProperty
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
func CfnApi_CFN_RESOURCE_TYPE_NAME ¶
func CfnApi_CFN_RESOURCE_TYPE_NAME() *string
func CfnApi_IsCfnElement ¶
func CfnApi_IsCfnElement(x interface{}) *bool
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.
Returns: The construct as a stack element or undefined if it is not a stack element.
func CfnApi_IsCfnResource ¶
func CfnApi_IsCfnResource(construct constructs.IConstruct) *bool
Check whether the given construct is a CfnResource.
func CfnApi_IsConstruct ¶
func CfnApi_IsConstruct(x interface{}) *bool
Checks if `x` is a construct.
Use this method instead of `instanceof` to properly detect `Construct` instances, even when the construct library is symlinked.
Explanation: in JavaScript, multiple copies of the `constructs` library on disk are seen as independent, completely different libraries. As a consequence, the class `Construct` in each copy of the `constructs` library is seen as a different class, and an instance of one class will not test as `instanceof` the other class. `npm install` will not create installations like this, but users may manually symlink construct libraries together or use a monorepo tool: in those cases, multiple copies of the `constructs` library can be accidentally installed, and `instanceof` will behave unpredictably. It is safest to avoid using `instanceof`, and using this type-testing method instead.
Returns: true if `x` is an object created from a class which extends `Construct`.
func CfnApi_REQUIRED_TRANSFORM ¶
func CfnApi_REQUIRED_TRANSFORM() *string
func CfnApplication_CFN_RESOURCE_TYPE_NAME ¶
func CfnApplication_CFN_RESOURCE_TYPE_NAME() *string
func CfnApplication_IsCfnElement ¶
func CfnApplication_IsCfnElement(x interface{}) *bool
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.
Returns: The construct as a stack element or undefined if it is not a stack element.
func CfnApplication_IsCfnResource ¶
func CfnApplication_IsCfnResource(construct constructs.IConstruct) *bool
Check whether the given construct is a CfnResource.
func CfnApplication_IsConstruct ¶
func CfnApplication_IsConstruct(x interface{}) *bool
Checks if `x` is a construct.
Use this method instead of `instanceof` to properly detect `Construct` instances, even when the construct library is symlinked.
Explanation: in JavaScript, multiple copies of the `constructs` library on disk are seen as independent, completely different libraries. As a consequence, the class `Construct` in each copy of the `constructs` library is seen as a different class, and an instance of one class will not test as `instanceof` the other class. `npm install` will not create installations like this, but users may manually symlink construct libraries together or use a monorepo tool: in those cases, multiple copies of the `constructs` library can be accidentally installed, and `instanceof` will behave unpredictably. It is safest to avoid using `instanceof`, and using this type-testing method instead.
Returns: true if `x` is an object created from a class which extends `Construct`.
func CfnApplication_REQUIRED_TRANSFORM ¶
func CfnApplication_REQUIRED_TRANSFORM() *string
func CfnFunction_CFN_RESOURCE_TYPE_NAME ¶
func CfnFunction_CFN_RESOURCE_TYPE_NAME() *string
func CfnFunction_IsCfnElement ¶
func CfnFunction_IsCfnElement(x interface{}) *bool
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.
Returns: The construct as a stack element or undefined if it is not a stack element.
func CfnFunction_IsCfnResource ¶
func CfnFunction_IsCfnResource(construct constructs.IConstruct) *bool
Check whether the given construct is a CfnResource.
func CfnFunction_IsConstruct ¶
func CfnFunction_IsConstruct(x interface{}) *bool
Checks if `x` is a construct.
Use this method instead of `instanceof` to properly detect `Construct` instances, even when the construct library is symlinked.
Explanation: in JavaScript, multiple copies of the `constructs` library on disk are seen as independent, completely different libraries. As a consequence, the class `Construct` in each copy of the `constructs` library is seen as a different class, and an instance of one class will not test as `instanceof` the other class. `npm install` will not create installations like this, but users may manually symlink construct libraries together or use a monorepo tool: in those cases, multiple copies of the `constructs` library can be accidentally installed, and `instanceof` will behave unpredictably. It is safest to avoid using `instanceof`, and using this type-testing method instead.
Returns: true if `x` is an object created from a class which extends `Construct`.
func CfnFunction_REQUIRED_TRANSFORM ¶
func CfnFunction_REQUIRED_TRANSFORM() *string
func CfnHttpApi_CFN_RESOURCE_TYPE_NAME ¶
func CfnHttpApi_CFN_RESOURCE_TYPE_NAME() *string
func CfnHttpApi_IsCfnElement ¶
func CfnHttpApi_IsCfnElement(x interface{}) *bool
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.
Returns: The construct as a stack element or undefined if it is not a stack element.
func CfnHttpApi_IsCfnResource ¶
func CfnHttpApi_IsCfnResource(construct constructs.IConstruct) *bool
Check whether the given construct is a CfnResource.
func CfnHttpApi_IsConstruct ¶
func CfnHttpApi_IsConstruct(x interface{}) *bool
Checks if `x` is a construct.
Use this method instead of `instanceof` to properly detect `Construct` instances, even when the construct library is symlinked.
Explanation: in JavaScript, multiple copies of the `constructs` library on disk are seen as independent, completely different libraries. As a consequence, the class `Construct` in each copy of the `constructs` library is seen as a different class, and an instance of one class will not test as `instanceof` the other class. `npm install` will not create installations like this, but users may manually symlink construct libraries together or use a monorepo tool: in those cases, multiple copies of the `constructs` library can be accidentally installed, and `instanceof` will behave unpredictably. It is safest to avoid using `instanceof`, and using this type-testing method instead.
Returns: true if `x` is an object created from a class which extends `Construct`.
func CfnHttpApi_REQUIRED_TRANSFORM ¶
func CfnHttpApi_REQUIRED_TRANSFORM() *string
func CfnLayerVersion_CFN_RESOURCE_TYPE_NAME ¶
func CfnLayerVersion_CFN_RESOURCE_TYPE_NAME() *string
func CfnLayerVersion_IsCfnElement ¶
func CfnLayerVersion_IsCfnElement(x interface{}) *bool
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.
Returns: The construct as a stack element or undefined if it is not a stack element.
func CfnLayerVersion_IsCfnResource ¶
func CfnLayerVersion_IsCfnResource(construct constructs.IConstruct) *bool
Check whether the given construct is a CfnResource.
func CfnLayerVersion_IsConstruct ¶
func CfnLayerVersion_IsConstruct(x interface{}) *bool
Checks if `x` is a construct.
Use this method instead of `instanceof` to properly detect `Construct` instances, even when the construct library is symlinked.
Explanation: in JavaScript, multiple copies of the `constructs` library on disk are seen as independent, completely different libraries. As a consequence, the class `Construct` in each copy of the `constructs` library is seen as a different class, and an instance of one class will not test as `instanceof` the other class. `npm install` will not create installations like this, but users may manually symlink construct libraries together or use a monorepo tool: in those cases, multiple copies of the `constructs` library can be accidentally installed, and `instanceof` will behave unpredictably. It is safest to avoid using `instanceof`, and using this type-testing method instead.
Returns: true if `x` is an object created from a class which extends `Construct`.
func CfnLayerVersion_REQUIRED_TRANSFORM ¶
func CfnLayerVersion_REQUIRED_TRANSFORM() *string
func CfnSimpleTable_CFN_RESOURCE_TYPE_NAME ¶
func CfnSimpleTable_CFN_RESOURCE_TYPE_NAME() *string
func CfnSimpleTable_IsCfnElement ¶
func CfnSimpleTable_IsCfnElement(x interface{}) *bool
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.
Returns: The construct as a stack element or undefined if it is not a stack element.
func CfnSimpleTable_IsCfnResource ¶
func CfnSimpleTable_IsCfnResource(construct constructs.IConstruct) *bool
Check whether the given construct is a CfnResource.
func CfnSimpleTable_IsConstruct ¶
func CfnSimpleTable_IsConstruct(x interface{}) *bool
Checks if `x` is a construct.
Use this method instead of `instanceof` to properly detect `Construct` instances, even when the construct library is symlinked.
Explanation: in JavaScript, multiple copies of the `constructs` library on disk are seen as independent, completely different libraries. As a consequence, the class `Construct` in each copy of the `constructs` library is seen as a different class, and an instance of one class will not test as `instanceof` the other class. `npm install` will not create installations like this, but users may manually symlink construct libraries together or use a monorepo tool: in those cases, multiple copies of the `constructs` library can be accidentally installed, and `instanceof` will behave unpredictably. It is safest to avoid using `instanceof`, and using this type-testing method instead.
Returns: true if `x` is an object created from a class which extends `Construct`.
func CfnSimpleTable_REQUIRED_TRANSFORM ¶
func CfnSimpleTable_REQUIRED_TRANSFORM() *string
func CfnStateMachine_CFN_RESOURCE_TYPE_NAME ¶
func CfnStateMachine_CFN_RESOURCE_TYPE_NAME() *string
func CfnStateMachine_IsCfnElement ¶
func CfnStateMachine_IsCfnElement(x interface{}) *bool
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.
Returns: The construct as a stack element or undefined if it is not a stack element.
func CfnStateMachine_IsCfnResource ¶
func CfnStateMachine_IsCfnResource(construct constructs.IConstruct) *bool
Check whether the given construct is a CfnResource.
func CfnStateMachine_IsConstruct ¶
func CfnStateMachine_IsConstruct(x interface{}) *bool
Checks if `x` is a construct.
Use this method instead of `instanceof` to properly detect `Construct` instances, even when the construct library is symlinked.
Explanation: in JavaScript, multiple copies of the `constructs` library on disk are seen as independent, completely different libraries. As a consequence, the class `Construct` in each copy of the `constructs` library is seen as a different class, and an instance of one class will not test as `instanceof` the other class. `npm install` will not create installations like this, but users may manually symlink construct libraries together or use a monorepo tool: in those cases, multiple copies of the `constructs` library can be accidentally installed, and `instanceof` will behave unpredictably. It is safest to avoid using `instanceof`, and using this type-testing method instead.
Returns: true if `x` is an object created from a class which extends `Construct`.
func CfnStateMachine_REQUIRED_TRANSFORM ¶
func CfnStateMachine_REQUIRED_TRANSFORM() *string
func NewCfnApi_Override ¶
func NewCfnApi_Override(c CfnApi, scope constructs.Construct, id *string, props *CfnApiProps)
func NewCfnApplication_Override ¶
func NewCfnApplication_Override(c CfnApplication, scope constructs.Construct, id *string, props *CfnApplicationProps)
func NewCfnFunction_Override ¶
func NewCfnFunction_Override(c CfnFunction, scope constructs.Construct, id *string, props *CfnFunctionProps)
func NewCfnHttpApi_Override ¶
func NewCfnHttpApi_Override(c CfnHttpApi, scope constructs.Construct, id *string, props *CfnHttpApiProps)
func NewCfnLayerVersion_Override ¶
func NewCfnLayerVersion_Override(c CfnLayerVersion, scope constructs.Construct, id *string, props *CfnLayerVersionProps)
func NewCfnSimpleTable_Override ¶
func NewCfnSimpleTable_Override(c CfnSimpleTable, scope constructs.Construct, id *string, props *CfnSimpleTableProps)
func NewCfnStateMachine_Override ¶
func NewCfnStateMachine_Override(c CfnStateMachine, scope constructs.Construct, id *string, props *CfnStateMachineProps)
Types ¶
type CfnApi ¶
type CfnApi interface { awscdk.CfnResource awscdk.IInspectable awscdk.ITaggable AccessLogSetting() interface{} SetAccessLogSetting(val interface{}) Auth() interface{} SetAuth(val interface{}) BinaryMediaTypes() *[]*string SetBinaryMediaTypes(val *[]*string) CacheClusterEnabled() interface{} SetCacheClusterEnabled(val interface{}) CacheClusterSize() *string SetCacheClusterSize(val *string) CanarySetting() interface{} SetCanarySetting(val interface{}) // Options for this resource, such as condition, update policy etc. CfnOptions() awscdk.ICfnResourceOptions CfnProperties() *map[string]interface{} // AWS resource type. CfnResourceType() *string Cors() interface{} SetCors(val interface{}) // Returns: 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. CreationStack() *[]*string DefinitionBody() interface{} SetDefinitionBody(val interface{}) DefinitionUri() interface{} SetDefinitionUri(val interface{}) Description() *string SetDescription(val *string) DisableExecuteApiEndpoint() interface{} SetDisableExecuteApiEndpoint(val interface{}) Domain() interface{} SetDomain(val interface{}) EndpointConfiguration() interface{} SetEndpointConfiguration(val interface{}) GatewayResponses() interface{} SetGatewayResponses(val interface{}) // 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)`. // // Returns: the logical ID as a stringified token. This value will only get // resolved during synthesis. LogicalId() *string MethodSettings() interface{} SetMethodSettings(val interface{}) MinimumCompressionSize() *float64 SetMinimumCompressionSize(val *float64) Models() interface{} SetModels(val interface{}) Name() *string SetName(val *string) // The tree node. Node() constructs.Node OpenApiVersion() *string SetOpenApiVersion(val *string) // 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 })`. Ref() *string // The stack in which this element is defined. // // CfnElements must be defined within a stack scope (directly or indirectly). Stack() awscdk.Stack StageName() *string SetStageName(val *string) // Tag Manager which manages the tags for this resource. Tags() awscdk.TagManager TagsRaw() *map[string]*string SetTagsRaw(val *map[string]*string) TracingEnabled() interface{} SetTracingEnabled(val interface{}) // Deprecated. // Deprecated: use `updatedProperties` // // Return properties modified after initiation // // Resources that expose mutable properties should override this function to // collect and return the properties object for this resource. UpdatedProperites() *map[string]interface{} // Return properties modified after initiation. // // Resources that expose mutable properties should override this function to // collect and return the properties object for this resource. UpdatedProperties() *map[string]interface{} Variables() interface{} SetVariables(val interface{}) // Syntactic sugar for `addOverride(path, undefined)`. AddDeletionOverride(path *string) // 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. AddDependency(target awscdk.CfnResource) // Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned. // Deprecated: use addDependency. AddDependsOn(target awscdk.CfnResource) // Add a value to the CloudFormation Resource Metadata. // 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. // AddMetadata(key *string, value interface{}) // Adds an override to the synthesized CloudFormation resource. // // To add a // property override, either use `addPropertyOverride` or prefix `path` 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, // “`typescript // cfnResource.addOverride('Properties.GlobalSecondaryIndexes.0.Projection.NonKeyAttributes', ['myattribute']); // cfnResource.addOverride('Properties.GlobalSecondaryIndexes.1.ProjectionType', 'INCLUDE'); // “` // would add the overrides // “`json // "Properties": { // "GlobalSecondaryIndexes": [ // { // "Projection": { // "NonKeyAttributes": [ "myattribute" ] // ... // } // ... // }, // { // "ProjectionType": "INCLUDE" // ... // }, // ] // ... // } // “` // // The `value` argument to `addOverride` 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. AddOverride(path *string, value interface{}) // Adds an override that deletes the value of a property from the resource definition. AddPropertyDeletionOverride(propertyPath *string) // Adds an override to a resource property. // // Syntactic sugar for `addOverride("Properties.<...>", value)`. AddPropertyOverride(propertyPath *string, value interface{}) // 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`). In some // cases, a snapshot can be taken of the resource prior to deletion // (`RemovalPolicy.SNAPSHOT`). A list of resources that support this policy // can be found in the following link:. // See: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-attribute-deletionpolicy.html#aws-attribute-deletionpolicy-options // ApplyRemovalPolicy(policy awscdk.RemovalPolicy, options *awscdk.RemovalPolicyOptions) // 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. GetAtt(attributeName *string, typeHint awscdk.ResolutionTypeHint) awscdk.Reference // Retrieve a value value from the CloudFormation Resource Metadata. // 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. // GetMetadata(key *string) interface{} // Examines the CloudFormation resource and discloses attributes. Inspect(inspector awscdk.TreeInspector) // Retrieves an array of resources this resource depends on. // // This assembles dependencies on resources across stacks (including nested stacks) // automatically. ObtainDependencies() *[]interface{} // Get a shallow copy of dependencies between this resource and other resources in the same stack. ObtainResourceDependencies() *[]awscdk.CfnResource // Overrides the auto-generated logical ID with a specific ID. OverrideLogicalId(newLogicalId *string) // Indicates that this resource no longer depends on another resource. // // This can be used for resources across stacks (including nested stacks) // and the dependency will automatically be removed from the relevant scope. RemoveDependency(target awscdk.CfnResource) RenderProperties(props *map[string]interface{}) *map[string]interface{} // Replaces one dependency with another. ReplaceDependency(target awscdk.CfnResource, newTarget awscdk.CfnResource) // Can be overridden by subclasses to determine if this resource will be rendered into the cloudformation template. // // Returns: `true` if the resource should be included or `false` is the resource // should be omitted. ShouldSynthesize() *bool // Returns a string representation of this construct. // // Returns: a string representation of this resource. ToString() *string ValidateProperties(_properties interface{}) }
Definition of AWS::Serverless::Api.
Example:
// The code below shows an example of how to instantiate this type. // The values are placeholders you should change. import "github.com/aws/aws-cdk-go/awscdk" var authorizers interface{} var definitionBody interface{} var gatewayResponses interface{} var methodSettings interface{} var models interface{} cfnApi := awscdk.Aws_sam.NewCfnApi(this, jsii.String("MyCfnApi"), &CfnApiProps{ StageName: jsii.String("stageName"), // the properties below are optional AccessLogSetting: &AccessLogSettingProperty{ DestinationArn: jsii.String("destinationArn"), Format: jsii.String("format"), }, Auth: &AuthProperty{ AddDefaultAuthorizerToCorsPreflight: jsii.Boolean(false), Authorizers: authorizers, DefaultAuthorizer: jsii.String("defaultAuthorizer"), }, BinaryMediaTypes: []*string{ jsii.String("binaryMediaTypes"), }, CacheClusterEnabled: jsii.Boolean(false), CacheClusterSize: jsii.String("cacheClusterSize"), CanarySetting: &CanarySettingProperty{ DeploymentId: jsii.String("deploymentId"), PercentTraffic: jsii.Number(123), StageVariableOverrides: map[string]*string{ "stageVariableOverridesKey": jsii.String("stageVariableOverrides"), }, UseStageCache: jsii.Boolean(false), }, Cors: jsii.String("cors"), DefinitionBody: definitionBody, DefinitionUri: jsii.String("definitionUri"), Description: jsii.String("description"), DisableExecuteApiEndpoint: jsii.Boolean(false), Domain: &DomainConfigurationProperty{ CertificateArn: jsii.String("certificateArn"), DomainName: jsii.String("domainName"), // the properties below are optional BasePath: []*string{ jsii.String("basePath"), }, EndpointConfiguration: jsii.String("endpointConfiguration"), MutualTlsAuthentication: &MutualTlsAuthenticationProperty{ TruststoreUri: jsii.String("truststoreUri"), TruststoreVersion: jsii.String("truststoreVersion"), }, OwnershipVerificationCertificateArn: jsii.String("ownershipVerificationCertificateArn"), Route53: &Route53ConfigurationProperty{ DistributedDomainName: jsii.String("distributedDomainName"), EvaluateTargetHealth: jsii.Boolean(false), HostedZoneId: jsii.String("hostedZoneId"), HostedZoneName: jsii.String("hostedZoneName"), IpV6: jsii.Boolean(false), }, SecurityPolicy: jsii.String("securityPolicy"), }, EndpointConfiguration: jsii.String("endpointConfiguration"), GatewayResponses: gatewayResponses, MethodSettings: []interface{}{ methodSettings, }, MinimumCompressionSize: jsii.Number(123), Models: models, Name: jsii.String("name"), OpenApiVersion: jsii.String("openApiVersion"), Tags: map[string]*string{ "tagsKey": jsii.String("tags"), }, TracingEnabled: jsii.Boolean(false), Variables: map[string]*string{ "variablesKey": jsii.String("variables"), }, })
See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-serverless-api.html
func NewCfnApi ¶
func NewCfnApi(scope constructs.Construct, id *string, props *CfnApiProps) CfnApi
type CfnApiProps ¶
type CfnApiProps struct { // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-serverless-api.html#cfn-serverless-api-stagename // StageName *string `field:"required" json:"stageName" yaml:"stageName"` // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-serverless-api.html#cfn-serverless-api-accesslogsetting // AccessLogSetting interface{} `field:"optional" json:"accessLogSetting" yaml:"accessLogSetting"` // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-serverless-api.html#cfn-serverless-api-auth // Auth interface{} `field:"optional" json:"auth" yaml:"auth"` // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-serverless-api.html#cfn-serverless-api-binarymediatypes // BinaryMediaTypes *[]*string `field:"optional" json:"binaryMediaTypes" yaml:"binaryMediaTypes"` // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-serverless-api.html#cfn-serverless-api-cacheclusterenabled // CacheClusterEnabled interface{} `field:"optional" json:"cacheClusterEnabled" yaml:"cacheClusterEnabled"` // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-serverless-api.html#cfn-serverless-api-cacheclustersize // CacheClusterSize *string `field:"optional" json:"cacheClusterSize" yaml:"cacheClusterSize"` // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-serverless-api.html#cfn-serverless-api-canarysetting // CanarySetting interface{} `field:"optional" json:"canarySetting" yaml:"canarySetting"` // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-serverless-api.html#cfn-serverless-api-cors // Cors interface{} `field:"optional" json:"cors" yaml:"cors"` // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-serverless-api.html#cfn-serverless-api-definitionbody // DefinitionBody interface{} `field:"optional" json:"definitionBody" yaml:"definitionBody"` // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-serverless-api.html#cfn-serverless-api-definitionuri // DefinitionUri interface{} `field:"optional" json:"definitionUri" yaml:"definitionUri"` // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-serverless-api.html#cfn-serverless-api-description // Description *string `field:"optional" json:"description" yaml:"description"` // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-serverless-api.html#cfn-serverless-api-disableexecuteapiendpoint // DisableExecuteApiEndpoint interface{} `field:"optional" json:"disableExecuteApiEndpoint" yaml:"disableExecuteApiEndpoint"` // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-serverless-api.html#cfn-serverless-api-domain // Domain interface{} `field:"optional" json:"domain" yaml:"domain"` // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-serverless-api.html#cfn-serverless-api-endpointconfiguration // EndpointConfiguration interface{} `field:"optional" json:"endpointConfiguration" yaml:"endpointConfiguration"` // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-serverless-api.html#cfn-serverless-api-gatewayresponses // GatewayResponses interface{} `field:"optional" json:"gatewayResponses" yaml:"gatewayResponses"` // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-serverless-api.html#cfn-serverless-api-methodsettings // MethodSettings interface{} `field:"optional" json:"methodSettings" yaml:"methodSettings"` // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-serverless-api.html#cfn-serverless-api-minimumcompressionsize // MinimumCompressionSize *float64 `field:"optional" json:"minimumCompressionSize" yaml:"minimumCompressionSize"` // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-serverless-api.html#cfn-serverless-api-models // Models interface{} `field:"optional" json:"models" yaml:"models"` // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-serverless-api.html#cfn-serverless-api-name // Name *string `field:"optional" json:"name" yaml:"name"` // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-serverless-api.html#cfn-serverless-api-openapiversion // OpenApiVersion *string `field:"optional" json:"openApiVersion" yaml:"openApiVersion"` // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-serverless-api.html#cfn-serverless-api-tags // Tags *map[string]*string `field:"optional" json:"tags" yaml:"tags"` // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-serverless-api.html#cfn-serverless-api-tracingenabled // TracingEnabled interface{} `field:"optional" json:"tracingEnabled" yaml:"tracingEnabled"` // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-serverless-api.html#cfn-serverless-api-variables // Variables interface{} `field:"optional" json:"variables" yaml:"variables"` }
Properties for defining a `CfnApi`.
Example:
// The code below shows an example of how to instantiate this type. // The values are placeholders you should change. import "github.com/aws/aws-cdk-go/awscdk" var authorizers interface{} var definitionBody interface{} var gatewayResponses interface{} var methodSettings interface{} var models interface{} cfnApiProps := &CfnApiProps{ StageName: jsii.String("stageName"), // the properties below are optional AccessLogSetting: &AccessLogSettingProperty{ DestinationArn: jsii.String("destinationArn"), Format: jsii.String("format"), }, Auth: &AuthProperty{ AddDefaultAuthorizerToCorsPreflight: jsii.Boolean(false), Authorizers: authorizers, DefaultAuthorizer: jsii.String("defaultAuthorizer"), }, BinaryMediaTypes: []*string{ jsii.String("binaryMediaTypes"), }, CacheClusterEnabled: jsii.Boolean(false), CacheClusterSize: jsii.String("cacheClusterSize"), CanarySetting: &CanarySettingProperty{ DeploymentId: jsii.String("deploymentId"), PercentTraffic: jsii.Number(123), StageVariableOverrides: map[string]*string{ "stageVariableOverridesKey": jsii.String("stageVariableOverrides"), }, UseStageCache: jsii.Boolean(false), }, Cors: jsii.String("cors"), DefinitionBody: definitionBody, DefinitionUri: jsii.String("definitionUri"), Description: jsii.String("description"), DisableExecuteApiEndpoint: jsii.Boolean(false), Domain: &DomainConfigurationProperty{ CertificateArn: jsii.String("certificateArn"), DomainName: jsii.String("domainName"), // the properties below are optional BasePath: []*string{ jsii.String("basePath"), }, EndpointConfiguration: jsii.String("endpointConfiguration"), MutualTlsAuthentication: &MutualTlsAuthenticationProperty{ TruststoreUri: jsii.String("truststoreUri"), TruststoreVersion: jsii.String("truststoreVersion"), }, OwnershipVerificationCertificateArn: jsii.String("ownershipVerificationCertificateArn"), Route53: &Route53ConfigurationProperty{ DistributedDomainName: jsii.String("distributedDomainName"), EvaluateTargetHealth: jsii.Boolean(false), HostedZoneId: jsii.String("hostedZoneId"), HostedZoneName: jsii.String("hostedZoneName"), IpV6: jsii.Boolean(false), }, SecurityPolicy: jsii.String("securityPolicy"), }, EndpointConfiguration: jsii.String("endpointConfiguration"), GatewayResponses: gatewayResponses, MethodSettings: []interface{}{ methodSettings, }, MinimumCompressionSize: jsii.Number(123), Models: models, Name: jsii.String("name"), OpenApiVersion: jsii.String("openApiVersion"), Tags: map[string]*string{ "tagsKey": jsii.String("tags"), }, TracingEnabled: jsii.Boolean(false), Variables: map[string]*string{ "variablesKey": jsii.String("variables"), }, }
See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-serverless-api.html
type CfnApi_AccessLogSettingProperty ¶
type CfnApi_AccessLogSettingProperty struct { // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-serverless-api-accesslogsetting.html#cfn-serverless-api-accesslogsetting-destinationarn // DestinationArn *string `field:"optional" json:"destinationArn" yaml:"destinationArn"` // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-serverless-api-accesslogsetting.html#cfn-serverless-api-accesslogsetting-format // Format *string `field:"optional" json:"format" yaml:"format"` }
Example:
// The code below shows an example of how to instantiate this type. // The values are placeholders you should change. import "github.com/aws/aws-cdk-go/awscdk" accessLogSettingProperty := &AccessLogSettingProperty{ DestinationArn: jsii.String("destinationArn"), Format: jsii.String("format"), }
type CfnApi_AuthProperty ¶
type CfnApi_AuthProperty struct { // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-serverless-api-auth.html#cfn-serverless-api-auth-adddefaultauthorizertocorspreflight // AddDefaultAuthorizerToCorsPreflight interface{} `field:"optional" json:"addDefaultAuthorizerToCorsPreflight" yaml:"addDefaultAuthorizerToCorsPreflight"` // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-serverless-api-auth.html#cfn-serverless-api-auth-authorizers // Authorizers interface{} `field:"optional" json:"authorizers" yaml:"authorizers"` // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-serverless-api-auth.html#cfn-serverless-api-auth-defaultauthorizer // DefaultAuthorizer *string `field:"optional" json:"defaultAuthorizer" yaml:"defaultAuthorizer"` }
Example:
// The code below shows an example of how to instantiate this type. // The values are placeholders you should change. import "github.com/aws/aws-cdk-go/awscdk" var authorizers interface{} authProperty := &AuthProperty{ AddDefaultAuthorizerToCorsPreflight: jsii.Boolean(false), Authorizers: authorizers, DefaultAuthorizer: jsii.String("defaultAuthorizer"), }
type CfnApi_CanarySettingProperty ¶
type CfnApi_CanarySettingProperty struct { // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-serverless-api-canarysetting.html#cfn-serverless-api-canarysetting-deploymentid // DeploymentId *string `field:"optional" json:"deploymentId" yaml:"deploymentId"` // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-serverless-api-canarysetting.html#cfn-serverless-api-canarysetting-percenttraffic // PercentTraffic *float64 `field:"optional" json:"percentTraffic" yaml:"percentTraffic"` // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-serverless-api-canarysetting.html#cfn-serverless-api-canarysetting-stagevariableoverrides // StageVariableOverrides interface{} `field:"optional" json:"stageVariableOverrides" yaml:"stageVariableOverrides"` // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-serverless-api-canarysetting.html#cfn-serverless-api-canarysetting-usestagecache // UseStageCache interface{} `field:"optional" json:"useStageCache" yaml:"useStageCache"` }
Example:
// The code below shows an example of how to instantiate this type. // The values are placeholders you should change. import "github.com/aws/aws-cdk-go/awscdk" canarySettingProperty := &CanarySettingProperty{ DeploymentId: jsii.String("deploymentId"), PercentTraffic: jsii.Number(123), StageVariableOverrides: map[string]*string{ "stageVariableOverridesKey": jsii.String("stageVariableOverrides"), }, UseStageCache: jsii.Boolean(false), }
type CfnApi_CorsConfigurationProperty ¶
type CfnApi_CorsConfigurationProperty struct { // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-serverless-api-corsconfiguration.html#cfn-serverless-api-corsconfiguration-alloworigin // AllowOrigin *string `field:"required" json:"allowOrigin" yaml:"allowOrigin"` // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-serverless-api-corsconfiguration.html#cfn-serverless-api-corsconfiguration-allowcredentials // AllowCredentials interface{} `field:"optional" json:"allowCredentials" yaml:"allowCredentials"` // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-serverless-api-corsconfiguration.html#cfn-serverless-api-corsconfiguration-allowheaders // AllowHeaders *string `field:"optional" json:"allowHeaders" yaml:"allowHeaders"` // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-serverless-api-corsconfiguration.html#cfn-serverless-api-corsconfiguration-allowmethods // AllowMethods *string `field:"optional" json:"allowMethods" yaml:"allowMethods"` // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-serverless-api-corsconfiguration.html#cfn-serverless-api-corsconfiguration-maxage // MaxAge *string `field:"optional" json:"maxAge" yaml:"maxAge"` }
Example:
// The code below shows an example of how to instantiate this type. // The values are placeholders you should change. import "github.com/aws/aws-cdk-go/awscdk" corsConfigurationProperty := &CorsConfigurationProperty{ AllowOrigin: jsii.String("allowOrigin"), // the properties below are optional AllowCredentials: jsii.Boolean(false), AllowHeaders: jsii.String("allowHeaders"), AllowMethods: jsii.String("allowMethods"), MaxAge: jsii.String("maxAge"), }
type CfnApi_DomainConfigurationProperty ¶ added in v2.23.0
type CfnApi_DomainConfigurationProperty struct { // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-serverless-api-domainconfiguration.html#cfn-serverless-api-domainconfiguration-certificatearn // CertificateArn *string `field:"required" json:"certificateArn" yaml:"certificateArn"` // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-serverless-api-domainconfiguration.html#cfn-serverless-api-domainconfiguration-domainname // DomainName *string `field:"required" json:"domainName" yaml:"domainName"` // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-serverless-api-domainconfiguration.html#cfn-serverless-api-domainconfiguration-basepath // BasePath *[]*string `field:"optional" json:"basePath" yaml:"basePath"` // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-serverless-api-domainconfiguration.html#cfn-serverless-api-domainconfiguration-endpointconfiguration // EndpointConfiguration *string `field:"optional" json:"endpointConfiguration" yaml:"endpointConfiguration"` // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-serverless-api-domainconfiguration.html#cfn-serverless-api-domainconfiguration-mutualtlsauthentication // MutualTlsAuthentication interface{} `field:"optional" json:"mutualTlsAuthentication" yaml:"mutualTlsAuthentication"` // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-serverless-api-domainconfiguration.html#cfn-serverless-api-domainconfiguration-ownershipverificationcertificatearn // OwnershipVerificationCertificateArn *string `field:"optional" json:"ownershipVerificationCertificateArn" yaml:"ownershipVerificationCertificateArn"` // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-serverless-api-domainconfiguration.html#cfn-serverless-api-domainconfiguration-route53 // Route53 interface{} `field:"optional" json:"route53" yaml:"route53"` // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-serverless-api-domainconfiguration.html#cfn-serverless-api-domainconfiguration-securitypolicy // SecurityPolicy *string `field:"optional" json:"securityPolicy" yaml:"securityPolicy"` }
Example:
// The code below shows an example of how to instantiate this type. // The values are placeholders you should change. import "github.com/aws/aws-cdk-go/awscdk" domainConfigurationProperty := &DomainConfigurationProperty{ CertificateArn: jsii.String("certificateArn"), DomainName: jsii.String("domainName"), // the properties below are optional BasePath: []*string{ jsii.String("basePath"), }, EndpointConfiguration: jsii.String("endpointConfiguration"), MutualTlsAuthentication: &MutualTlsAuthenticationProperty{ TruststoreUri: jsii.String("truststoreUri"), TruststoreVersion: jsii.String("truststoreVersion"), }, OwnershipVerificationCertificateArn: jsii.String("ownershipVerificationCertificateArn"), Route53: &Route53ConfigurationProperty{ DistributedDomainName: jsii.String("distributedDomainName"), EvaluateTargetHealth: jsii.Boolean(false), HostedZoneId: jsii.String("hostedZoneId"), HostedZoneName: jsii.String("hostedZoneName"), IpV6: jsii.Boolean(false), }, SecurityPolicy: jsii.String("securityPolicy"), }
type CfnApi_EndpointConfigurationProperty ¶
type CfnApi_EndpointConfigurationProperty struct { // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-serverless-api-endpointconfiguration.html#cfn-serverless-api-endpointconfiguration-type // Type *string `field:"optional" json:"type" yaml:"type"` // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-serverless-api-endpointconfiguration.html#cfn-serverless-api-endpointconfiguration-vpcendpointids // VpcEndpointIds *[]*string `field:"optional" json:"vpcEndpointIds" yaml:"vpcEndpointIds"` }
Example:
// The code below shows an example of how to instantiate this type. // The values are placeholders you should change. import "github.com/aws/aws-cdk-go/awscdk" endpointConfigurationProperty := &EndpointConfigurationProperty{ Type: jsii.String("type"), VpcEndpointIds: []*string{ jsii.String("vpcEndpointIds"), }, }
type CfnApi_MutualTlsAuthenticationProperty ¶ added in v2.23.0
type CfnApi_MutualTlsAuthenticationProperty struct { // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-serverless-api-mutualtlsauthentication.html#cfn-serverless-api-mutualtlsauthentication-truststoreuri // TruststoreUri *string `field:"optional" json:"truststoreUri" yaml:"truststoreUri"` // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-serverless-api-mutualtlsauthentication.html#cfn-serverless-api-mutualtlsauthentication-truststoreversion // TruststoreVersion *string `field:"optional" json:"truststoreVersion" yaml:"truststoreVersion"` }
Example:
// The code below shows an example of how to instantiate this type. // The values are placeholders you should change. import "github.com/aws/aws-cdk-go/awscdk" mutualTlsAuthenticationProperty := &MutualTlsAuthenticationProperty{ TruststoreUri: jsii.String("truststoreUri"), TruststoreVersion: jsii.String("truststoreVersion"), }
type CfnApi_Route53ConfigurationProperty ¶ added in v2.23.0
type CfnApi_Route53ConfigurationProperty struct { // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-serverless-api-route53configuration.html#cfn-serverless-api-route53configuration-distributeddomainname // DistributedDomainName *string `field:"optional" json:"distributedDomainName" yaml:"distributedDomainName"` // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-serverless-api-route53configuration.html#cfn-serverless-api-route53configuration-evaluatetargethealth // EvaluateTargetHealth interface{} `field:"optional" json:"evaluateTargetHealth" yaml:"evaluateTargetHealth"` // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-serverless-api-route53configuration.html#cfn-serverless-api-route53configuration-hostedzoneid // HostedZoneId *string `field:"optional" json:"hostedZoneId" yaml:"hostedZoneId"` // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-serverless-api-route53configuration.html#cfn-serverless-api-route53configuration-hostedzonename // HostedZoneName *string `field:"optional" json:"hostedZoneName" yaml:"hostedZoneName"` // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-serverless-api-route53configuration.html#cfn-serverless-api-route53configuration-ipv6 // IpV6 interface{} `field:"optional" json:"ipV6" yaml:"ipV6"` }
Example:
// The code below shows an example of how to instantiate this type. // The values are placeholders you should change. import "github.com/aws/aws-cdk-go/awscdk" route53ConfigurationProperty := &Route53ConfigurationProperty{ DistributedDomainName: jsii.String("distributedDomainName"), EvaluateTargetHealth: jsii.Boolean(false), HostedZoneId: jsii.String("hostedZoneId"), HostedZoneName: jsii.String("hostedZoneName"), IpV6: jsii.Boolean(false), }
type CfnApi_S3LocationProperty ¶
type CfnApi_S3LocationProperty struct { // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-serverless-api-s3location.html#cfn-serverless-api-s3location-bucket // Bucket *string `field:"required" json:"bucket" yaml:"bucket"` // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-serverless-api-s3location.html#cfn-serverless-api-s3location-key // Key *string `field:"required" json:"key" yaml:"key"` // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-serverless-api-s3location.html#cfn-serverless-api-s3location-version // Version *float64 `field:"required" json:"version" yaml:"version"` }
Example:
// The code below shows an example of how to instantiate this type. // The values are placeholders you should change. import "github.com/aws/aws-cdk-go/awscdk" s3LocationProperty := &S3LocationProperty{ Bucket: jsii.String("bucket"), Key: jsii.String("key"), Version: jsii.Number(123), }
type CfnApplication ¶
type CfnApplication interface { awscdk.CfnResource awscdk.IInspectable awscdk.ITaggable // Options for this resource, such as condition, update policy etc. CfnOptions() awscdk.ICfnResourceOptions CfnProperties() *map[string]interface{} // AWS resource type. CfnResourceType() *string // Returns: 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. CreationStack() *[]*string Location() interface{} SetLocation(val interface{}) // 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)`. // // Returns: the logical ID as a stringified token. This value will only get // resolved during synthesis. LogicalId() *string // The tree node. Node() constructs.Node NotificationArns() *[]*string SetNotificationArns(val *[]*string) Parameters() interface{} SetParameters(val interface{}) // 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 })`. Ref() *string // The stack in which this element is defined. // // CfnElements must be defined within a stack scope (directly or indirectly). Stack() awscdk.Stack // Tag Manager which manages the tags for this resource. Tags() awscdk.TagManager TagsRaw() *map[string]*string SetTagsRaw(val *map[string]*string) TimeoutInMinutes() *float64 SetTimeoutInMinutes(val *float64) // Deprecated. // Deprecated: use `updatedProperties` // // Return properties modified after initiation // // Resources that expose mutable properties should override this function to // collect and return the properties object for this resource. UpdatedProperites() *map[string]interface{} // Return properties modified after initiation. // // Resources that expose mutable properties should override this function to // collect and return the properties object for this resource. UpdatedProperties() *map[string]interface{} // Syntactic sugar for `addOverride(path, undefined)`. AddDeletionOverride(path *string) // 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. AddDependency(target awscdk.CfnResource) // Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned. // Deprecated: use addDependency. AddDependsOn(target awscdk.CfnResource) // Add a value to the CloudFormation Resource Metadata. // 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. // AddMetadata(key *string, value interface{}) // Adds an override to the synthesized CloudFormation resource. // // To add a // property override, either use `addPropertyOverride` or prefix `path` 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, // “`typescript // cfnResource.addOverride('Properties.GlobalSecondaryIndexes.0.Projection.NonKeyAttributes', ['myattribute']); // cfnResource.addOverride('Properties.GlobalSecondaryIndexes.1.ProjectionType', 'INCLUDE'); // “` // would add the overrides // “`json // "Properties": { // "GlobalSecondaryIndexes": [ // { // "Projection": { // "NonKeyAttributes": [ "myattribute" ] // ... // } // ... // }, // { // "ProjectionType": "INCLUDE" // ... // }, // ] // ... // } // “` // // The `value` argument to `addOverride` 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. AddOverride(path *string, value interface{}) // Adds an override that deletes the value of a property from the resource definition. AddPropertyDeletionOverride(propertyPath *string) // Adds an override to a resource property. // // Syntactic sugar for `addOverride("Properties.<...>", value)`. AddPropertyOverride(propertyPath *string, value interface{}) // 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`). In some // cases, a snapshot can be taken of the resource prior to deletion // (`RemovalPolicy.SNAPSHOT`). A list of resources that support this policy // can be found in the following link:. // See: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-attribute-deletionpolicy.html#aws-attribute-deletionpolicy-options // ApplyRemovalPolicy(policy awscdk.RemovalPolicy, options *awscdk.RemovalPolicyOptions) // 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. GetAtt(attributeName *string, typeHint awscdk.ResolutionTypeHint) awscdk.Reference // Retrieve a value value from the CloudFormation Resource Metadata. // 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. // GetMetadata(key *string) interface{} // Examines the CloudFormation resource and discloses attributes. Inspect(inspector awscdk.TreeInspector) // Retrieves an array of resources this resource depends on. // // This assembles dependencies on resources across stacks (including nested stacks) // automatically. ObtainDependencies() *[]interface{} // Get a shallow copy of dependencies between this resource and other resources in the same stack. ObtainResourceDependencies() *[]awscdk.CfnResource // Overrides the auto-generated logical ID with a specific ID. OverrideLogicalId(newLogicalId *string) // Indicates that this resource no longer depends on another resource. // // This can be used for resources across stacks (including nested stacks) // and the dependency will automatically be removed from the relevant scope. RemoveDependency(target awscdk.CfnResource) RenderProperties(props *map[string]interface{}) *map[string]interface{} // Replaces one dependency with another. ReplaceDependency(target awscdk.CfnResource, newTarget awscdk.CfnResource) // Can be overridden by subclasses to determine if this resource will be rendered into the cloudformation template. // // Returns: `true` if the resource should be included or `false` is the resource // should be omitted. ShouldSynthesize() *bool // Returns a string representation of this construct. // // Returns: a string representation of this resource. ToString() *string ValidateProperties(_properties interface{}) }
Definition of AWS::Serverless::Application.
Example:
// The code below shows an example of how to instantiate this type. // The values are placeholders you should change. import "github.com/aws/aws-cdk-go/awscdk" cfnApplication := awscdk.Aws_sam.NewCfnApplication(this, jsii.String("MyCfnApplication"), &CfnApplicationProps{ Location: jsii.String("location"), // the properties below are optional NotificationArns: []*string{ jsii.String("notificationArns"), }, Parameters: map[string]*string{ "parametersKey": jsii.String("parameters"), }, Tags: map[string]*string{ "tagsKey": jsii.String("tags"), }, TimeoutInMinutes: jsii.Number(123), })
func NewCfnApplication ¶
func NewCfnApplication(scope constructs.Construct, id *string, props *CfnApplicationProps) CfnApplication
type CfnApplicationProps ¶
type CfnApplicationProps struct { // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-serverless-application.html#cfn-serverless-application-location // Location interface{} `field:"required" json:"location" yaml:"location"` // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-serverless-application.html#cfn-serverless-application-notificationarns // NotificationArns *[]*string `field:"optional" json:"notificationArns" yaml:"notificationArns"` // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-serverless-application.html#cfn-serverless-application-parameters // Parameters interface{} `field:"optional" json:"parameters" yaml:"parameters"` // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-serverless-application.html#cfn-serverless-application-tags // Tags *map[string]*string `field:"optional" json:"tags" yaml:"tags"` // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-serverless-application.html#cfn-serverless-application-timeoutinminutes // TimeoutInMinutes *float64 `field:"optional" json:"timeoutInMinutes" yaml:"timeoutInMinutes"` }
Properties for defining a `CfnApplication`.
Example:
// The code below shows an example of how to instantiate this type. // The values are placeholders you should change. import "github.com/aws/aws-cdk-go/awscdk" cfnApplicationProps := &CfnApplicationProps{ Location: jsii.String("location"), // the properties below are optional NotificationArns: []*string{ jsii.String("notificationArns"), }, Parameters: map[string]*string{ "parametersKey": jsii.String("parameters"), }, Tags: map[string]*string{ "tagsKey": jsii.String("tags"), }, TimeoutInMinutes: jsii.Number(123), }
type CfnApplication_ApplicationLocationProperty ¶
type CfnApplication_ApplicationLocationProperty struct { // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-serverless-application-applicationlocation.html#cfn-serverless-application-applicationlocation-applicationid // ApplicationId *string `field:"required" json:"applicationId" yaml:"applicationId"` // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-serverless-application-applicationlocation.html#cfn-serverless-application-applicationlocation-semanticversion // SemanticVersion *string `field:"required" json:"semanticVersion" yaml:"semanticVersion"` }
Example:
// The code below shows an example of how to instantiate this type. // The values are placeholders you should change. import "github.com/aws/aws-cdk-go/awscdk" applicationLocationProperty := &ApplicationLocationProperty{ ApplicationId: jsii.String("applicationId"), SemanticVersion: jsii.String("semanticVersion"), }
type CfnFunction ¶
type CfnFunction interface { awscdk.CfnResource awscdk.IInspectable awscdk.ITaggable Architectures() *[]*string SetArchitectures(val *[]*string) AssumeRolePolicyDocument() interface{} SetAssumeRolePolicyDocument(val interface{}) AutoPublishAlias() *string SetAutoPublishAlias(val *string) AutoPublishCodeSha256() *string SetAutoPublishCodeSha256(val *string) // Options for this resource, such as condition, update policy etc. CfnOptions() awscdk.ICfnResourceOptions CfnProperties() *map[string]interface{} // AWS resource type. CfnResourceType() *string CodeSigningConfigArn() *string SetCodeSigningConfigArn(val *string) CodeUri() interface{} SetCodeUri(val interface{}) // Returns: 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. CreationStack() *[]*string DeadLetterQueue() interface{} SetDeadLetterQueue(val interface{}) DeploymentPreference() interface{} SetDeploymentPreference(val interface{}) Description() *string SetDescription(val *string) Environment() interface{} SetEnvironment(val interface{}) EventInvokeConfig() interface{} SetEventInvokeConfig(val interface{}) Events() interface{} SetEvents(val interface{}) FileSystemConfigs() interface{} SetFileSystemConfigs(val interface{}) FunctionName() *string SetFunctionName(val *string) Handler() *string SetHandler(val *string) ImageConfig() interface{} SetImageConfig(val interface{}) ImageUri() *string SetImageUri(val *string) InlineCode() *string SetInlineCode(val *string) KmsKeyArn() *string SetKmsKeyArn(val *string) Layers() *[]*string SetLayers(val *[]*string) // 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)`. // // Returns: the logical ID as a stringified token. This value will only get // resolved during synthesis. LogicalId() *string MemorySize() *float64 SetMemorySize(val *float64) // The tree node. Node() constructs.Node PackageType() *string SetPackageType(val *string) PermissionsBoundary() *string SetPermissionsBoundary(val *string) Policies() interface{} SetPolicies(val interface{}) ProvisionedConcurrencyConfig() interface{} SetProvisionedConcurrencyConfig(val interface{}) // 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 })`. Ref() *string ReservedConcurrentExecutions() *float64 SetReservedConcurrentExecutions(val *float64) Role() *string SetRole(val *string) Runtime() *string SetRuntime(val *string) // The stack in which this element is defined. // // CfnElements must be defined within a stack scope (directly or indirectly). Stack() awscdk.Stack // Tag Manager which manages the tags for this resource. Tags() awscdk.TagManager TagsRaw() *map[string]*string SetTagsRaw(val *map[string]*string) Timeout() *float64 SetTimeout(val *float64) Tracing() *string SetTracing(val *string) // Deprecated. // Deprecated: use `updatedProperties` // // Return properties modified after initiation // // Resources that expose mutable properties should override this function to // collect and return the properties object for this resource. UpdatedProperites() *map[string]interface{} // Return properties modified after initiation. // // Resources that expose mutable properties should override this function to // collect and return the properties object for this resource. UpdatedProperties() *map[string]interface{} VersionDescription() *string SetVersionDescription(val *string) VpcConfig() interface{} SetVpcConfig(val interface{}) // Syntactic sugar for `addOverride(path, undefined)`. AddDeletionOverride(path *string) // 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. AddDependency(target awscdk.CfnResource) // Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned. // Deprecated: use addDependency. AddDependsOn(target awscdk.CfnResource) // Add a value to the CloudFormation Resource Metadata. // 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. // AddMetadata(key *string, value interface{}) // Adds an override to the synthesized CloudFormation resource. // // To add a // property override, either use `addPropertyOverride` or prefix `path` 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, // “`typescript // cfnResource.addOverride('Properties.GlobalSecondaryIndexes.0.Projection.NonKeyAttributes', ['myattribute']); // cfnResource.addOverride('Properties.GlobalSecondaryIndexes.1.ProjectionType', 'INCLUDE'); // “` // would add the overrides // “`json // "Properties": { // "GlobalSecondaryIndexes": [ // { // "Projection": { // "NonKeyAttributes": [ "myattribute" ] // ... // } // ... // }, // { // "ProjectionType": "INCLUDE" // ... // }, // ] // ... // } // “` // // The `value` argument to `addOverride` 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. AddOverride(path *string, value interface{}) // Adds an override that deletes the value of a property from the resource definition. AddPropertyDeletionOverride(propertyPath *string) // Adds an override to a resource property. // // Syntactic sugar for `addOverride("Properties.<...>", value)`. AddPropertyOverride(propertyPath *string, value interface{}) // 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`). In some // cases, a snapshot can be taken of the resource prior to deletion // (`RemovalPolicy.SNAPSHOT`). A list of resources that support this policy // can be found in the following link:. // See: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-attribute-deletionpolicy.html#aws-attribute-deletionpolicy-options // ApplyRemovalPolicy(policy awscdk.RemovalPolicy, options *awscdk.RemovalPolicyOptions) // 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. GetAtt(attributeName *string, typeHint awscdk.ResolutionTypeHint) awscdk.Reference // Retrieve a value value from the CloudFormation Resource Metadata. // 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. // GetMetadata(key *string) interface{} // Examines the CloudFormation resource and discloses attributes. Inspect(inspector awscdk.TreeInspector) // Retrieves an array of resources this resource depends on. // // This assembles dependencies on resources across stacks (including nested stacks) // automatically. ObtainDependencies() *[]interface{} // Get a shallow copy of dependencies between this resource and other resources in the same stack. ObtainResourceDependencies() *[]awscdk.CfnResource // Overrides the auto-generated logical ID with a specific ID. OverrideLogicalId(newLogicalId *string) // Indicates that this resource no longer depends on another resource. // // This can be used for resources across stacks (including nested stacks) // and the dependency will automatically be removed from the relevant scope. RemoveDependency(target awscdk.CfnResource) RenderProperties(props *map[string]interface{}) *map[string]interface{} // Replaces one dependency with another. ReplaceDependency(target awscdk.CfnResource, newTarget awscdk.CfnResource) // Can be overridden by subclasses to determine if this resource will be rendered into the cloudformation template. // // Returns: `true` if the resource should be included or `false` is the resource // should be omitted. ShouldSynthesize() *bool // Returns a string representation of this construct. // // Returns: a string representation of this resource. ToString() *string ValidateProperties(_properties interface{}) }
Definition of AWS::Serverless::Function.
Example:
// The code below shows an example of how to instantiate this type. // The values are placeholders you should change. import "github.com/aws/aws-cdk-go/awscdk" var assumeRolePolicyDocument interface{} cfnFunction := awscdk.Aws_sam.NewCfnFunction(this, jsii.String("MyCfnFunction"), &CfnFunctionProps{ Architectures: []*string{ jsii.String("architectures"), }, AssumeRolePolicyDocument: assumeRolePolicyDocument, AutoPublishAlias: jsii.String("autoPublishAlias"), AutoPublishCodeSha256: jsii.String("autoPublishCodeSha256"), CodeSigningConfigArn: jsii.String("codeSigningConfigArn"), CodeUri: jsii.String("codeUri"), DeadLetterQueue: &DeadLetterQueueProperty{ TargetArn: jsii.String("targetArn"), Type: jsii.String("type"), }, DeploymentPreference: &DeploymentPreferenceProperty{ Alarms: []*string{ jsii.String("alarms"), }, Enabled: jsii.Boolean(false), Hooks: &HooksProperty{ PostTraffic: jsii.String("postTraffic"), PreTraffic: jsii.String("preTraffic"), }, Role: jsii.String("role"), Type: jsii.String("type"), }, Description: jsii.String("description"), Environment: &FunctionEnvironmentProperty{ Variables: map[string]*string{ "variablesKey": jsii.String("variables"), }, }, EventInvokeConfig: &EventInvokeConfigProperty{ DestinationConfig: &EventInvokeDestinationConfigProperty{ OnFailure: &DestinationProperty{ Destination: jsii.String("destination"), // the properties below are optional Type: jsii.String("type"), }, OnSuccess: &DestinationProperty{ Destination: jsii.String("destination"), // the properties below are optional Type: jsii.String("type"), }, }, MaximumEventAgeInSeconds: jsii.Number(123), MaximumRetryAttempts: jsii.Number(123), }, Events: map[string]interface{}{ "eventsKey": &EventSourceProperty{ "properties": &AlexaSkillEventProperty{ "variables": map[string]*string{ "variablesKey": jsii.String("variables"), }, }, "type": jsii.String("type"), }, }, FileSystemConfigs: []interface{}{ &FileSystemConfigProperty{ Arn: jsii.String("arn"), LocalMountPath: jsii.String("localMountPath"), }, }, FunctionName: jsii.String("functionName"), Handler: jsii.String("handler"), ImageConfig: &ImageConfigProperty{ Command: []*string{ jsii.String("command"), }, EntryPoint: []*string{ jsii.String("entryPoint"), }, WorkingDirectory: jsii.String("workingDirectory"), }, ImageUri: jsii.String("imageUri"), InlineCode: jsii.String("inlineCode"), KmsKeyArn: jsii.String("kmsKeyArn"), Layers: []*string{ jsii.String("layers"), }, MemorySize: jsii.Number(123), PackageType: jsii.String("packageType"), PermissionsBoundary: jsii.String("permissionsBoundary"), Policies: jsii.String("policies"), ProvisionedConcurrencyConfig: &ProvisionedConcurrencyConfigProperty{ ProvisionedConcurrentExecutions: jsii.String("provisionedConcurrentExecutions"), }, ReservedConcurrentExecutions: jsii.Number(123), Role: jsii.String("role"), Runtime: jsii.String("runtime"), Tags: map[string]*string{ "tagsKey": jsii.String("tags"), }, Timeout: jsii.Number(123), Tracing: jsii.String("tracing"), VersionDescription: jsii.String("versionDescription"), VpcConfig: &VpcConfigProperty{ SecurityGroupIds: []*string{ jsii.String("securityGroupIds"), }, SubnetIds: []*string{ jsii.String("subnetIds"), }, }, })
See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-serverless-function.html
func NewCfnFunction ¶
func NewCfnFunction(scope constructs.Construct, id *string, props *CfnFunctionProps) CfnFunction
type CfnFunctionProps ¶
type CfnFunctionProps struct { // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-serverless-function.html#cfn-serverless-function-architectures // Architectures *[]*string `field:"optional" json:"architectures" yaml:"architectures"` // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-serverless-function.html#cfn-serverless-function-assumerolepolicydocument // AssumeRolePolicyDocument interface{} `field:"optional" json:"assumeRolePolicyDocument" yaml:"assumeRolePolicyDocument"` // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-serverless-function.html#cfn-serverless-function-autopublishalias // AutoPublishAlias *string `field:"optional" json:"autoPublishAlias" yaml:"autoPublishAlias"` // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-serverless-function.html#cfn-serverless-function-autopublishcodesha256 // AutoPublishCodeSha256 *string `field:"optional" json:"autoPublishCodeSha256" yaml:"autoPublishCodeSha256"` // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-serverless-function.html#cfn-serverless-function-codesigningconfigarn // CodeSigningConfigArn *string `field:"optional" json:"codeSigningConfigArn" yaml:"codeSigningConfigArn"` // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-serverless-function.html#cfn-serverless-function-codeuri // CodeUri interface{} `field:"optional" json:"codeUri" yaml:"codeUri"` // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-serverless-function.html#cfn-serverless-function-deadletterqueue // DeadLetterQueue interface{} `field:"optional" json:"deadLetterQueue" yaml:"deadLetterQueue"` // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-serverless-function.html#cfn-serverless-function-deploymentpreference // DeploymentPreference interface{} `field:"optional" json:"deploymentPreference" yaml:"deploymentPreference"` // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-serverless-function.html#cfn-serverless-function-description // Description *string `field:"optional" json:"description" yaml:"description"` // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-serverless-function.html#cfn-serverless-function-environment // Environment interface{} `field:"optional" json:"environment" yaml:"environment"` // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-serverless-function.html#cfn-serverless-function-eventinvokeconfig // EventInvokeConfig interface{} `field:"optional" json:"eventInvokeConfig" yaml:"eventInvokeConfig"` // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-serverless-function.html#cfn-serverless-function-events // Events interface{} `field:"optional" json:"events" yaml:"events"` // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-serverless-function.html#cfn-serverless-function-filesystemconfigs // FileSystemConfigs interface{} `field:"optional" json:"fileSystemConfigs" yaml:"fileSystemConfigs"` // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-serverless-function.html#cfn-serverless-function-functionname // FunctionName *string `field:"optional" json:"functionName" yaml:"functionName"` // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-serverless-function.html#cfn-serverless-function-handler // Handler *string `field:"optional" json:"handler" yaml:"handler"` // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-serverless-function.html#cfn-serverless-function-imageconfig // ImageConfig interface{} `field:"optional" json:"imageConfig" yaml:"imageConfig"` // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-serverless-function.html#cfn-serverless-function-imageuri // ImageUri *string `field:"optional" json:"imageUri" yaml:"imageUri"` // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-serverless-function.html#cfn-serverless-function-inlinecode // InlineCode *string `field:"optional" json:"inlineCode" yaml:"inlineCode"` // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-serverless-function.html#cfn-serverless-function-kmskeyarn // KmsKeyArn *string `field:"optional" json:"kmsKeyArn" yaml:"kmsKeyArn"` // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-serverless-function.html#cfn-serverless-function-layers // Layers *[]*string `field:"optional" json:"layers" yaml:"layers"` // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-serverless-function.html#cfn-serverless-function-memorysize // MemorySize *float64 `field:"optional" json:"memorySize" yaml:"memorySize"` // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-serverless-function.html#cfn-serverless-function-packagetype // PackageType *string `field:"optional" json:"packageType" yaml:"packageType"` // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-serverless-function.html#cfn-serverless-function-permissionsboundary // PermissionsBoundary *string `field:"optional" json:"permissionsBoundary" yaml:"permissionsBoundary"` // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-serverless-function.html#cfn-serverless-function-policies // Policies interface{} `field:"optional" json:"policies" yaml:"policies"` // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-serverless-function.html#cfn-serverless-function-provisionedconcurrencyconfig // ProvisionedConcurrencyConfig interface{} `field:"optional" json:"provisionedConcurrencyConfig" yaml:"provisionedConcurrencyConfig"` // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-serverless-function.html#cfn-serverless-function-reservedconcurrentexecutions // ReservedConcurrentExecutions *float64 `field:"optional" json:"reservedConcurrentExecutions" yaml:"reservedConcurrentExecutions"` // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-serverless-function.html#cfn-serverless-function-role // Role *string `field:"optional" json:"role" yaml:"role"` // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-serverless-function.html#cfn-serverless-function-runtime // Runtime *string `field:"optional" json:"runtime" yaml:"runtime"` // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-serverless-function.html#cfn-serverless-function-tags // Tags *map[string]*string `field:"optional" json:"tags" yaml:"tags"` // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-serverless-function.html#cfn-serverless-function-timeout // Timeout *float64 `field:"optional" json:"timeout" yaml:"timeout"` // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-serverless-function.html#cfn-serverless-function-tracing // Tracing *string `field:"optional" json:"tracing" yaml:"tracing"` // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-serverless-function.html#cfn-serverless-function-versiondescription // VersionDescription *string `field:"optional" json:"versionDescription" yaml:"versionDescription"` // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-serverless-function.html#cfn-serverless-function-vpcconfig // VpcConfig interface{} `field:"optional" json:"vpcConfig" yaml:"vpcConfig"` }
Properties for defining a `CfnFunction`.
Example:
// The code below shows an example of how to instantiate this type. // The values are placeholders you should change. import "github.com/aws/aws-cdk-go/awscdk" var assumeRolePolicyDocument interface{} cfnFunctionProps := &CfnFunctionProps{ Architectures: []*string{ jsii.String("architectures"), }, AssumeRolePolicyDocument: assumeRolePolicyDocument, AutoPublishAlias: jsii.String("autoPublishAlias"), AutoPublishCodeSha256: jsii.String("autoPublishCodeSha256"), CodeSigningConfigArn: jsii.String("codeSigningConfigArn"), CodeUri: jsii.String("codeUri"), DeadLetterQueue: &DeadLetterQueueProperty{ TargetArn: jsii.String("targetArn"), Type: jsii.String("type"), }, DeploymentPreference: &DeploymentPreferenceProperty{ Alarms: []*string{ jsii.String("alarms"), }, Enabled: jsii.Boolean(false), Hooks: &HooksProperty{ PostTraffic: jsii.String("postTraffic"), PreTraffic: jsii.String("preTraffic"), }, Role: jsii.String("role"), Type: jsii.String("type"), }, Description: jsii.String("description"), Environment: &FunctionEnvironmentProperty{ Variables: map[string]*string{ "variablesKey": jsii.String("variables"), }, }, EventInvokeConfig: &EventInvokeConfigProperty{ DestinationConfig: &EventInvokeDestinationConfigProperty{ OnFailure: &DestinationProperty{ Destination: jsii.String("destination"), // the properties below are optional Type: jsii.String("type"), }, OnSuccess: &DestinationProperty{ Destination: jsii.String("destination"), // the properties below are optional Type: jsii.String("type"), }, }, MaximumEventAgeInSeconds: jsii.Number(123), MaximumRetryAttempts: jsii.Number(123), }, Events: map[string]interface{}{ "eventsKey": &EventSourceProperty{ "properties": &AlexaSkillEventProperty{ "variables": map[string]*string{ "variablesKey": jsii.String("variables"), }, }, "type": jsii.String("type"), }, }, FileSystemConfigs: []interface{}{ &FileSystemConfigProperty{ Arn: jsii.String("arn"), LocalMountPath: jsii.String("localMountPath"), }, }, FunctionName: jsii.String("functionName"), Handler: jsii.String("handler"), ImageConfig: &ImageConfigProperty{ Command: []*string{ jsii.String("command"), }, EntryPoint: []*string{ jsii.String("entryPoint"), }, WorkingDirectory: jsii.String("workingDirectory"), }, ImageUri: jsii.String("imageUri"), InlineCode: jsii.String("inlineCode"), KmsKeyArn: jsii.String("kmsKeyArn"), Layers: []*string{ jsii.String("layers"), }, MemorySize: jsii.Number(123), PackageType: jsii.String("packageType"), PermissionsBoundary: jsii.String("permissionsBoundary"), Policies: jsii.String("policies"), ProvisionedConcurrencyConfig: &ProvisionedConcurrencyConfigProperty{ ProvisionedConcurrentExecutions: jsii.String("provisionedConcurrentExecutions"), }, ReservedConcurrentExecutions: jsii.Number(123), Role: jsii.String("role"), Runtime: jsii.String("runtime"), Tags: map[string]*string{ "tagsKey": jsii.String("tags"), }, Timeout: jsii.Number(123), Tracing: jsii.String("tracing"), VersionDescription: jsii.String("versionDescription"), VpcConfig: &VpcConfigProperty{ SecurityGroupIds: []*string{ jsii.String("securityGroupIds"), }, SubnetIds: []*string{ jsii.String("subnetIds"), }, }, }
See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-serverless-function.html
type CfnFunction_AlexaSkillEventProperty ¶
type CfnFunction_AlexaSkillEventProperty struct { // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-serverless-function-alexaskillevent.html#cfn-serverless-function-alexaskillevent-variables // Variables interface{} `field:"optional" json:"variables" yaml:"variables"` }
Example:
// The code below shows an example of how to instantiate this type. // The values are placeholders you should change. import "github.com/aws/aws-cdk-go/awscdk" alexaSkillEventProperty := &AlexaSkillEventProperty{ Variables: map[string]*string{ "variablesKey": jsii.String("variables"), }, }
type CfnFunction_ApiEventProperty ¶
type CfnFunction_ApiEventProperty struct { // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-serverless-function-apievent.html#cfn-serverless-function-apievent-method // Method *string `field:"required" json:"method" yaml:"method"` // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-serverless-function-apievent.html#cfn-serverless-function-apievent-path // Path *string `field:"required" json:"path" yaml:"path"` // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-serverless-function-apievent.html#cfn-serverless-function-apievent-auth // Auth interface{} `field:"optional" json:"auth" yaml:"auth"` // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-serverless-function-apievent.html#cfn-serverless-function-apievent-requestmodel // RequestModel interface{} `field:"optional" json:"requestModel" yaml:"requestModel"` // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-serverless-function-apievent.html#cfn-serverless-function-apievent-requestparameters // RequestParameters interface{} `field:"optional" json:"requestParameters" yaml:"requestParameters"` // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-serverless-function-apievent.html#cfn-serverless-function-apievent-restapiid // RestApiId *string `field:"optional" json:"restApiId" yaml:"restApiId"` }
Example:
// The code below shows an example of how to instantiate this type. // The values are placeholders you should change. import "github.com/aws/aws-cdk-go/awscdk" var customStatements interface{} apiEventProperty := &ApiEventProperty{ Method: jsii.String("method"), Path: jsii.String("path"), // the properties below are optional Auth: &AuthProperty{ ApiKeyRequired: jsii.Boolean(false), AuthorizationScopes: []*string{ jsii.String("authorizationScopes"), }, Authorizer: jsii.String("authorizer"), ResourcePolicy: &AuthResourcePolicyProperty{ AwsAccountBlacklist: []*string{ jsii.String("awsAccountBlacklist"), }, AwsAccountWhitelist: []*string{ jsii.String("awsAccountWhitelist"), }, CustomStatements: []interface{}{ customStatements, }, IntrinsicVpcBlacklist: []*string{ jsii.String("intrinsicVpcBlacklist"), }, IntrinsicVpceBlacklist: []*string{ jsii.String("intrinsicVpceBlacklist"), }, IntrinsicVpceWhitelist: []*string{ jsii.String("intrinsicVpceWhitelist"), }, IntrinsicVpcWhitelist: []*string{ jsii.String("intrinsicVpcWhitelist"), }, IpRangeBlacklist: []*string{ jsii.String("ipRangeBlacklist"), }, IpRangeWhitelist: []*string{ jsii.String("ipRangeWhitelist"), }, SourceVpcBlacklist: []*string{ jsii.String("sourceVpcBlacklist"), }, SourceVpcWhitelist: []*string{ jsii.String("sourceVpcWhitelist"), }, }, }, RequestModel: &RequestModelProperty{ Model: jsii.String("model"), // the properties below are optional Required: jsii.Boolean(false), ValidateBody: jsii.Boolean(false), ValidateParameters: jsii.Boolean(false), }, RequestParameters: []interface{}{ jsii.String("requestParameters"), }, RestApiId: jsii.String("restApiId"), }
type CfnFunction_AuthProperty ¶
type CfnFunction_AuthProperty struct { // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-serverless-function-auth.html#cfn-serverless-function-auth-apikeyrequired // ApiKeyRequired interface{} `field:"optional" json:"apiKeyRequired" yaml:"apiKeyRequired"` // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-serverless-function-auth.html#cfn-serverless-function-auth-authorizationscopes // AuthorizationScopes *[]*string `field:"optional" json:"authorizationScopes" yaml:"authorizationScopes"` // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-serverless-function-auth.html#cfn-serverless-function-auth-authorizer // Authorizer *string `field:"optional" json:"authorizer" yaml:"authorizer"` // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-serverless-function-auth.html#cfn-serverless-function-auth-resourcepolicy // ResourcePolicy interface{} `field:"optional" json:"resourcePolicy" yaml:"resourcePolicy"` }
Example:
// The code below shows an example of how to instantiate this type. // The values are placeholders you should change. import "github.com/aws/aws-cdk-go/awscdk" var customStatements interface{} authProperty := &AuthProperty{ ApiKeyRequired: jsii.Boolean(false), AuthorizationScopes: []*string{ jsii.String("authorizationScopes"), }, Authorizer: jsii.String("authorizer"), ResourcePolicy: &AuthResourcePolicyProperty{ AwsAccountBlacklist: []*string{ jsii.String("awsAccountBlacklist"), }, AwsAccountWhitelist: []*string{ jsii.String("awsAccountWhitelist"), }, CustomStatements: []interface{}{ customStatements, }, IntrinsicVpcBlacklist: []*string{ jsii.String("intrinsicVpcBlacklist"), }, IntrinsicVpceBlacklist: []*string{ jsii.String("intrinsicVpceBlacklist"), }, IntrinsicVpceWhitelist: []*string{ jsii.String("intrinsicVpceWhitelist"), }, IntrinsicVpcWhitelist: []*string{ jsii.String("intrinsicVpcWhitelist"), }, IpRangeBlacklist: []*string{ jsii.String("ipRangeBlacklist"), }, IpRangeWhitelist: []*string{ jsii.String("ipRangeWhitelist"), }, SourceVpcBlacklist: []*string{ jsii.String("sourceVpcBlacklist"), }, SourceVpcWhitelist: []*string{ jsii.String("sourceVpcWhitelist"), }, }, }
type CfnFunction_AuthResourcePolicyProperty ¶
type CfnFunction_AuthResourcePolicyProperty struct { // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-serverless-function-authresourcepolicy.html#cfn-serverless-function-authresourcepolicy-awsaccountblacklist // AwsAccountBlacklist *[]*string `field:"optional" json:"awsAccountBlacklist" yaml:"awsAccountBlacklist"` // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-serverless-function-authresourcepolicy.html#cfn-serverless-function-authresourcepolicy-awsaccountwhitelist // AwsAccountWhitelist *[]*string `field:"optional" json:"awsAccountWhitelist" yaml:"awsAccountWhitelist"` // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-serverless-function-authresourcepolicy.html#cfn-serverless-function-authresourcepolicy-customstatements // CustomStatements interface{} `field:"optional" json:"customStatements" yaml:"customStatements"` // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-serverless-function-authresourcepolicy.html#cfn-serverless-function-authresourcepolicy-intrinsicvpcblacklist // IntrinsicVpcBlacklist *[]*string `field:"optional" json:"intrinsicVpcBlacklist" yaml:"intrinsicVpcBlacklist"` // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-serverless-function-authresourcepolicy.html#cfn-serverless-function-authresourcepolicy-intrinsicvpceblacklist // IntrinsicVpceBlacklist *[]*string `field:"optional" json:"intrinsicVpceBlacklist" yaml:"intrinsicVpceBlacklist"` // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-serverless-function-authresourcepolicy.html#cfn-serverless-function-authresourcepolicy-intrinsicvpcewhitelist // IntrinsicVpceWhitelist *[]*string `field:"optional" json:"intrinsicVpceWhitelist" yaml:"intrinsicVpceWhitelist"` // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-serverless-function-authresourcepolicy.html#cfn-serverless-function-authresourcepolicy-intrinsicvpcwhitelist // IntrinsicVpcWhitelist *[]*string `field:"optional" json:"intrinsicVpcWhitelist" yaml:"intrinsicVpcWhitelist"` // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-serverless-function-authresourcepolicy.html#cfn-serverless-function-authresourcepolicy-iprangeblacklist // IpRangeBlacklist *[]*string `field:"optional" json:"ipRangeBlacklist" yaml:"ipRangeBlacklist"` // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-serverless-function-authresourcepolicy.html#cfn-serverless-function-authresourcepolicy-iprangewhitelist // IpRangeWhitelist *[]*string `field:"optional" json:"ipRangeWhitelist" yaml:"ipRangeWhitelist"` // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-serverless-function-authresourcepolicy.html#cfn-serverless-function-authresourcepolicy-sourcevpcblacklist // SourceVpcBlacklist *[]*string `field:"optional" json:"sourceVpcBlacklist" yaml:"sourceVpcBlacklist"` // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-serverless-function-authresourcepolicy.html#cfn-serverless-function-authresourcepolicy-sourcevpcwhitelist // SourceVpcWhitelist *[]*string `field:"optional" json:"sourceVpcWhitelist" yaml:"sourceVpcWhitelist"` }
Example:
// The code below shows an example of how to instantiate this type. // The values are placeholders you should change. import "github.com/aws/aws-cdk-go/awscdk" var customStatements interface{} authResourcePolicyProperty := &AuthResourcePolicyProperty{ AwsAccountBlacklist: []*string{ jsii.String("awsAccountBlacklist"), }, AwsAccountWhitelist: []*string{ jsii.String("awsAccountWhitelist"), }, CustomStatements: []interface{}{ customStatements, }, IntrinsicVpcBlacklist: []*string{ jsii.String("intrinsicVpcBlacklist"), }, IntrinsicVpceBlacklist: []*string{ jsii.String("intrinsicVpceBlacklist"), }, IntrinsicVpceWhitelist: []*string{ jsii.String("intrinsicVpceWhitelist"), }, IntrinsicVpcWhitelist: []*string{ jsii.String("intrinsicVpcWhitelist"), }, IpRangeBlacklist: []*string{ jsii.String("ipRangeBlacklist"), }, IpRangeWhitelist: []*string{ jsii.String("ipRangeWhitelist"), }, SourceVpcBlacklist: []*string{ jsii.String("sourceVpcBlacklist"), }, SourceVpcWhitelist: []*string{ jsii.String("sourceVpcWhitelist"), }, }
type CfnFunction_BucketSAMPTProperty ¶
type CfnFunction_BucketSAMPTProperty struct { // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-serverless-function-bucketsampt.html#cfn-serverless-function-bucketsampt-bucketname // BucketName *string `field:"required" json:"bucketName" yaml:"bucketName"` }
Example:
// The code below shows an example of how to instantiate this type. // The values are placeholders you should change. import "github.com/aws/aws-cdk-go/awscdk" bucketSAMPTProperty := &BucketSAMPTProperty{ BucketName: jsii.String("bucketName"), }
type CfnFunction_CloudWatchEventEventProperty ¶
type CfnFunction_CloudWatchEventEventProperty struct { // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-serverless-function-cloudwatcheventevent.html#cfn-serverless-function-cloudwatcheventevent-pattern // Pattern interface{} `field:"required" json:"pattern" yaml:"pattern"` // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-serverless-function-cloudwatcheventevent.html#cfn-serverless-function-cloudwatcheventevent-input // Input *string `field:"optional" json:"input" yaml:"input"` // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-serverless-function-cloudwatcheventevent.html#cfn-serverless-function-cloudwatcheventevent-inputpath // InputPath *string `field:"optional" json:"inputPath" yaml:"inputPath"` }
Example:
// The code below shows an example of how to instantiate this type. // The values are placeholders you should change. import "github.com/aws/aws-cdk-go/awscdk" var pattern interface{} cloudWatchEventEventProperty := &CloudWatchEventEventProperty{ Pattern: pattern, // the properties below are optional Input: jsii.String("input"), InputPath: jsii.String("inputPath"), }
type CfnFunction_CloudWatchLogsEventProperty ¶
type CfnFunction_CloudWatchLogsEventProperty struct { // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-serverless-function-cloudwatchlogsevent.html#cfn-serverless-function-cloudwatchlogsevent-filterpattern // FilterPattern *string `field:"required" json:"filterPattern" yaml:"filterPattern"` // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-serverless-function-cloudwatchlogsevent.html#cfn-serverless-function-cloudwatchlogsevent-loggroupname // LogGroupName *string `field:"required" json:"logGroupName" yaml:"logGroupName"` }
Example:
// The code below shows an example of how to instantiate this type. // The values are placeholders you should change. import "github.com/aws/aws-cdk-go/awscdk" cloudWatchLogsEventProperty := &CloudWatchLogsEventProperty{ FilterPattern: jsii.String("filterPattern"), LogGroupName: jsii.String("logGroupName"), }
type CfnFunction_CognitoEventProperty ¶ added in v2.78.0
type CfnFunction_CognitoEventProperty struct { // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-serverless-function-cognitoevent.html#cfn-serverless-function-cognitoevent-trigger // Trigger *string `field:"required" json:"trigger" yaml:"trigger"` // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-serverless-function-cognitoevent.html#cfn-serverless-function-cognitoevent-userpool // UserPool *string `field:"required" json:"userPool" yaml:"userPool"` }
Example:
// The code below shows an example of how to instantiate this type. // The values are placeholders you should change. import "github.com/aws/aws-cdk-go/awscdk" cognitoEventProperty := &CognitoEventProperty{ Trigger: jsii.String("trigger"), UserPool: jsii.String("userPool"), }
type CfnFunction_CollectionSAMPTProperty ¶
type CfnFunction_CollectionSAMPTProperty struct { // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-serverless-function-collectionsampt.html#cfn-serverless-function-collectionsampt-collectionid // CollectionId *string `field:"required" json:"collectionId" yaml:"collectionId"` }
Example:
// The code below shows an example of how to instantiate this type. // The values are placeholders you should change. import "github.com/aws/aws-cdk-go/awscdk" collectionSAMPTProperty := &CollectionSAMPTProperty{ CollectionId: jsii.String("collectionId"), }
type CfnFunction_DeadLetterQueueProperty ¶
type CfnFunction_DeadLetterQueueProperty struct { // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-serverless-function-deadletterqueue.html#cfn-serverless-function-deadletterqueue-targetarn // TargetArn *string `field:"required" json:"targetArn" yaml:"targetArn"` // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-serverless-function-deadletterqueue.html#cfn-serverless-function-deadletterqueue-type // Type *string `field:"required" json:"type" yaml:"type"` }
Example:
// The code below shows an example of how to instantiate this type. // The values are placeholders you should change. import "github.com/aws/aws-cdk-go/awscdk" deadLetterQueueProperty := &DeadLetterQueueProperty{ TargetArn: jsii.String("targetArn"), Type: jsii.String("type"), }
type CfnFunction_DeploymentPreferenceProperty ¶
type CfnFunction_DeploymentPreferenceProperty struct { // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-serverless-function-deploymentpreference.html#cfn-serverless-function-deploymentpreference-alarms // Alarms *[]*string `field:"optional" json:"alarms" yaml:"alarms"` // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-serverless-function-deploymentpreference.html#cfn-serverless-function-deploymentpreference-enabled // Enabled interface{} `field:"optional" json:"enabled" yaml:"enabled"` // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-serverless-function-deploymentpreference.html#cfn-serverless-function-deploymentpreference-hooks // Hooks interface{} `field:"optional" json:"hooks" yaml:"hooks"` // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-serverless-function-deploymentpreference.html#cfn-serverless-function-deploymentpreference-role // Role *string `field:"optional" json:"role" yaml:"role"` // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-serverless-function-deploymentpreference.html#cfn-serverless-function-deploymentpreference-type // Type *string `field:"optional" json:"type" yaml:"type"` }
Example:
// The code below shows an example of how to instantiate this type. // The values are placeholders you should change. import "github.com/aws/aws-cdk-go/awscdk" deploymentPreferenceProperty := &DeploymentPreferenceProperty{ Alarms: []*string{ jsii.String("alarms"), }, Enabled: jsii.Boolean(false), Hooks: &HooksProperty{ PostTraffic: jsii.String("postTraffic"), PreTraffic: jsii.String("preTraffic"), }, Role: jsii.String("role"), Type: jsii.String("type"), }
type CfnFunction_DestinationConfigProperty ¶
type CfnFunction_DestinationConfigProperty struct { // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-serverless-function-destinationconfig.html#cfn-serverless-function-destinationconfig-onfailure // OnFailure interface{} `field:"required" json:"onFailure" yaml:"onFailure"` }
Example:
// The code below shows an example of how to instantiate this type. // The values are placeholders you should change. import "github.com/aws/aws-cdk-go/awscdk" destinationConfigProperty := &DestinationConfigProperty{ OnFailure: &DestinationProperty{ Destination: jsii.String("destination"), // the properties below are optional Type: jsii.String("type"), }, }
type CfnFunction_DestinationProperty ¶
type CfnFunction_DestinationProperty struct { // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-serverless-function-destination.html#cfn-serverless-function-destination-destination // Destination *string `field:"required" json:"destination" yaml:"destination"` // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-serverless-function-destination.html#cfn-serverless-function-destination-type // Type *string `field:"optional" json:"type" yaml:"type"` }
Example:
// The code below shows an example of how to instantiate this type. // The values are placeholders you should change. import "github.com/aws/aws-cdk-go/awscdk" destinationProperty := &DestinationProperty{ Destination: jsii.String("destination"), // the properties below are optional Type: jsii.String("type"), }
type CfnFunction_DomainSAMPTProperty ¶
type CfnFunction_DomainSAMPTProperty struct { // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-serverless-function-domainsampt.html#cfn-serverless-function-domainsampt-domainname // DomainName *string `field:"required" json:"domainName" yaml:"domainName"` }
Example:
// The code below shows an example of how to instantiate this type. // The values are placeholders you should change. import "github.com/aws/aws-cdk-go/awscdk" domainSAMPTProperty := &DomainSAMPTProperty{ DomainName: jsii.String("domainName"), }
type CfnFunction_DynamoDBEventProperty ¶
type CfnFunction_DynamoDBEventProperty struct { // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-serverless-function-dynamodbevent.html#cfn-serverless-function-dynamodbevent-startingposition // StartingPosition *string `field:"required" json:"startingPosition" yaml:"startingPosition"` // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-serverless-function-dynamodbevent.html#cfn-serverless-function-dynamodbevent-stream // Stream *string `field:"required" json:"stream" yaml:"stream"` // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-serverless-function-dynamodbevent.html#cfn-serverless-function-dynamodbevent-batchsize // BatchSize *float64 `field:"optional" json:"batchSize" yaml:"batchSize"` // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-serverless-function-dynamodbevent.html#cfn-serverless-function-dynamodbevent-bisectbatchonfunctionerror // BisectBatchOnFunctionError interface{} `field:"optional" json:"bisectBatchOnFunctionError" yaml:"bisectBatchOnFunctionError"` // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-serverless-function-dynamodbevent.html#cfn-serverless-function-dynamodbevent-destinationconfig // DestinationConfig interface{} `field:"optional" json:"destinationConfig" yaml:"destinationConfig"` // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-serverless-function-dynamodbevent.html#cfn-serverless-function-dynamodbevent-enabled // Enabled interface{} `field:"optional" json:"enabled" yaml:"enabled"` // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-serverless-function-dynamodbevent.html#cfn-serverless-function-dynamodbevent-maximumbatchingwindowinseconds // MaximumBatchingWindowInSeconds *float64 `field:"optional" json:"maximumBatchingWindowInSeconds" yaml:"maximumBatchingWindowInSeconds"` // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-serverless-function-dynamodbevent.html#cfn-serverless-function-dynamodbevent-maximumrecordageinseconds // MaximumRecordAgeInSeconds *float64 `field:"optional" json:"maximumRecordAgeInSeconds" yaml:"maximumRecordAgeInSeconds"` // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-serverless-function-dynamodbevent.html#cfn-serverless-function-dynamodbevent-maximumretryattempts // MaximumRetryAttempts *float64 `field:"optional" json:"maximumRetryAttempts" yaml:"maximumRetryAttempts"` // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-serverless-function-dynamodbevent.html#cfn-serverless-function-dynamodbevent-parallelizationfactor // ParallelizationFactor *float64 `field:"optional" json:"parallelizationFactor" yaml:"parallelizationFactor"` }
Example:
// The code below shows an example of how to instantiate this type. // The values are placeholders you should change. import "github.com/aws/aws-cdk-go/awscdk" dynamoDBEventProperty := &DynamoDBEventProperty{ StartingPosition: jsii.String("startingPosition"), Stream: jsii.String("stream"), // the properties below are optional BatchSize: jsii.Number(123), BisectBatchOnFunctionError: jsii.Boolean(false), DestinationConfig: &DestinationConfigProperty{ OnFailure: &DestinationProperty{ Destination: jsii.String("destination"), // the properties below are optional Type: jsii.String("type"), }, }, Enabled: jsii.Boolean(false), MaximumBatchingWindowInSeconds: jsii.Number(123), MaximumRecordAgeInSeconds: jsii.Number(123), MaximumRetryAttempts: jsii.Number(123), ParallelizationFactor: jsii.Number(123), }
type CfnFunction_EmptySAMPTProperty ¶
type CfnFunction_EmptySAMPTProperty struct { }
Example:
// The code below shows an example of how to instantiate this type. // The values are placeholders you should change. import "github.com/aws/aws-cdk-go/awscdk" emptySAMPTProperty := &EmptySAMPTProperty{ }
type CfnFunction_EventBridgeRuleEventProperty ¶
type CfnFunction_EventBridgeRuleEventProperty struct { // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-serverless-function-eventbridgeruleevent.html#cfn-serverless-function-eventbridgeruleevent-pattern // Pattern interface{} `field:"required" json:"pattern" yaml:"pattern"` // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-serverless-function-eventbridgeruleevent.html#cfn-serverless-function-eventbridgeruleevent-eventbusname // EventBusName *string `field:"optional" json:"eventBusName" yaml:"eventBusName"` // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-serverless-function-eventbridgeruleevent.html#cfn-serverless-function-eventbridgeruleevent-input // Input *string `field:"optional" json:"input" yaml:"input"` // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-serverless-function-eventbridgeruleevent.html#cfn-serverless-function-eventbridgeruleevent-inputpath // InputPath *string `field:"optional" json:"inputPath" yaml:"inputPath"` }
Example:
// The code below shows an example of how to instantiate this type. // The values are placeholders you should change. import "github.com/aws/aws-cdk-go/awscdk" var pattern interface{} eventBridgeRuleEventProperty := &EventBridgeRuleEventProperty{ Pattern: pattern, // the properties below are optional EventBusName: jsii.String("eventBusName"), Input: jsii.String("input"), InputPath: jsii.String("inputPath"), }
type CfnFunction_EventInvokeConfigProperty ¶
type CfnFunction_EventInvokeConfigProperty struct { // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-serverless-function-eventinvokeconfig.html#cfn-serverless-function-eventinvokeconfig-destinationconfig // DestinationConfig interface{} `field:"optional" json:"destinationConfig" yaml:"destinationConfig"` // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-serverless-function-eventinvokeconfig.html#cfn-serverless-function-eventinvokeconfig-maximumeventageinseconds // MaximumEventAgeInSeconds *float64 `field:"optional" json:"maximumEventAgeInSeconds" yaml:"maximumEventAgeInSeconds"` // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-serverless-function-eventinvokeconfig.html#cfn-serverless-function-eventinvokeconfig-maximumretryattempts // MaximumRetryAttempts *float64 `field:"optional" json:"maximumRetryAttempts" yaml:"maximumRetryAttempts"` }
Example:
// The code below shows an example of how to instantiate this type. // The values are placeholders you should change. import "github.com/aws/aws-cdk-go/awscdk" eventInvokeConfigProperty := &EventInvokeConfigProperty{ DestinationConfig: &EventInvokeDestinationConfigProperty{ OnFailure: &DestinationProperty{ Destination: jsii.String("destination"), // the properties below are optional Type: jsii.String("type"), }, OnSuccess: &DestinationProperty{ Destination: jsii.String("destination"), // the properties below are optional Type: jsii.String("type"), }, }, MaximumEventAgeInSeconds: jsii.Number(123), MaximumRetryAttempts: jsii.Number(123), }
type CfnFunction_EventInvokeDestinationConfigProperty ¶
type CfnFunction_EventInvokeDestinationConfigProperty struct { // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-serverless-function-eventinvokedestinationconfig.html#cfn-serverless-function-eventinvokedestinationconfig-onfailure // OnFailure interface{} `field:"required" json:"onFailure" yaml:"onFailure"` // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-serverless-function-eventinvokedestinationconfig.html#cfn-serverless-function-eventinvokedestinationconfig-onsuccess // OnSuccess interface{} `field:"required" json:"onSuccess" yaml:"onSuccess"` }
Example:
// The code below shows an example of how to instantiate this type. // The values are placeholders you should change. import "github.com/aws/aws-cdk-go/awscdk" eventInvokeDestinationConfigProperty := &EventInvokeDestinationConfigProperty{ OnFailure: &DestinationProperty{ Destination: jsii.String("destination"), // the properties below are optional Type: jsii.String("type"), }, OnSuccess: &DestinationProperty{ Destination: jsii.String("destination"), // the properties below are optional Type: jsii.String("type"), }, }
type CfnFunction_EventSourceProperty ¶
type CfnFunction_EventSourceProperty struct { // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-serverless-function-eventsource.html#cfn-serverless-function-eventsource-properties // Properties interface{} `field:"required" json:"properties" yaml:"properties"` // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-serverless-function-eventsource.html#cfn-serverless-function-eventsource-type // Type *string `field:"required" json:"type" yaml:"type"` }
Example:
// The code below shows an example of how to instantiate this type. // The values are placeholders you should change. import "github.com/aws/aws-cdk-go/awscdk" eventSourceProperty := &EventSourceProperty{ Properties: &AlexaSkillEventProperty{ Variables: map[string]*string{ "variablesKey": jsii.String("variables"), }, }, Type: jsii.String("type"), }
type CfnFunction_FileSystemConfigProperty ¶
type CfnFunction_FileSystemConfigProperty struct { // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-serverless-function-filesystemconfig.html#cfn-serverless-function-filesystemconfig-arn // Arn *string `field:"optional" json:"arn" yaml:"arn"` // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-serverless-function-filesystemconfig.html#cfn-serverless-function-filesystemconfig-localmountpath // LocalMountPath *string `field:"optional" json:"localMountPath" yaml:"localMountPath"` }
Example:
// The code below shows an example of how to instantiate this type. // The values are placeholders you should change. import "github.com/aws/aws-cdk-go/awscdk" fileSystemConfigProperty := &FileSystemConfigProperty{ Arn: jsii.String("arn"), LocalMountPath: jsii.String("localMountPath"), }
type CfnFunction_FunctionEnvironmentProperty ¶
type CfnFunction_FunctionEnvironmentProperty struct { // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-serverless-function-functionenvironment.html#cfn-serverless-function-functionenvironment-variables // Variables interface{} `field:"required" json:"variables" yaml:"variables"` }
Example:
// The code below shows an example of how to instantiate this type. // The values are placeholders you should change. import "github.com/aws/aws-cdk-go/awscdk" functionEnvironmentProperty := &FunctionEnvironmentProperty{ Variables: map[string]*string{ "variablesKey": jsii.String("variables"), }, }
type CfnFunction_FunctionSAMPTProperty ¶
type CfnFunction_FunctionSAMPTProperty struct { // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-serverless-function-functionsampt.html#cfn-serverless-function-functionsampt-functionname // FunctionName *string `field:"required" json:"functionName" yaml:"functionName"` }
Example:
// The code below shows an example of how to instantiate this type. // The values are placeholders you should change. import "github.com/aws/aws-cdk-go/awscdk" functionSAMPTProperty := &FunctionSAMPTProperty{ FunctionName: jsii.String("functionName"), }
type CfnFunction_HooksProperty ¶ added in v2.21.0
type CfnFunction_HooksProperty struct { // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-serverless-function-hooks.html#cfn-serverless-function-hooks-posttraffic // PostTraffic *string `field:"optional" json:"postTraffic" yaml:"postTraffic"` // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-serverless-function-hooks.html#cfn-serverless-function-hooks-pretraffic // PreTraffic *string `field:"optional" json:"preTraffic" yaml:"preTraffic"` }
Example:
// The code below shows an example of how to instantiate this type. // The values are placeholders you should change. import "github.com/aws/aws-cdk-go/awscdk" hooksProperty := &HooksProperty{ PostTraffic: jsii.String("postTraffic"), PreTraffic: jsii.String("preTraffic"), }
type CfnFunction_HttpApiEventProperty ¶ added in v2.62.0
type CfnFunction_HttpApiEventProperty struct { // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-serverless-function-httpapievent.html#cfn-serverless-function-httpapievent-apiid // ApiId *string `field:"optional" json:"apiId" yaml:"apiId"` // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-serverless-function-httpapievent.html#cfn-serverless-function-httpapievent-auth // Auth interface{} `field:"optional" json:"auth" yaml:"auth"` // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-serverless-function-httpapievent.html#cfn-serverless-function-httpapievent-method // Method *string `field:"optional" json:"method" yaml:"method"` // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-serverless-function-httpapievent.html#cfn-serverless-function-httpapievent-path // Path *string `field:"optional" json:"path" yaml:"path"` // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-serverless-function-httpapievent.html#cfn-serverless-function-httpapievent-payloadformatversion // PayloadFormatVersion *string `field:"optional" json:"payloadFormatVersion" yaml:"payloadFormatVersion"` // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-serverless-function-httpapievent.html#cfn-serverless-function-httpapievent-routesettings // RouteSettings interface{} `field:"optional" json:"routeSettings" yaml:"routeSettings"` // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-serverless-function-httpapievent.html#cfn-serverless-function-httpapievent-timeoutinmillis // TimeoutInMillis *float64 `field:"optional" json:"timeoutInMillis" yaml:"timeoutInMillis"` }
Example:
// The code below shows an example of how to instantiate this type. // The values are placeholders you should change. import "github.com/aws/aws-cdk-go/awscdk" httpApiEventProperty := &HttpApiEventProperty{ ApiId: jsii.String("apiId"), Auth: &HttpApiFunctionAuthProperty{ AuthorizationScopes: []*string{ jsii.String("authorizationScopes"), }, Authorizer: jsii.String("authorizer"), }, Method: jsii.String("method"), Path: jsii.String("path"), PayloadFormatVersion: jsii.String("payloadFormatVersion"), RouteSettings: &RouteSettingsProperty{ DataTraceEnabled: jsii.Boolean(false), DetailedMetricsEnabled: jsii.Boolean(false), LoggingLevel: jsii.String("loggingLevel"), ThrottlingBurstLimit: jsii.Number(123), ThrottlingRateLimit: jsii.Number(123), }, TimeoutInMillis: jsii.Number(123), }
type CfnFunction_HttpApiFunctionAuthProperty ¶ added in v2.62.0
type CfnFunction_HttpApiFunctionAuthProperty struct { // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-serverless-function-httpapifunctionauth.html#cfn-serverless-function-httpapifunctionauth-authorizationscopes // AuthorizationScopes *[]*string `field:"optional" json:"authorizationScopes" yaml:"authorizationScopes"` // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-serverless-function-httpapifunctionauth.html#cfn-serverless-function-httpapifunctionauth-authorizer // Authorizer *string `field:"optional" json:"authorizer" yaml:"authorizer"` }
Example:
// The code below shows an example of how to instantiate this type. // The values are placeholders you should change. import "github.com/aws/aws-cdk-go/awscdk" httpApiFunctionAuthProperty := &HttpApiFunctionAuthProperty{ AuthorizationScopes: []*string{ jsii.String("authorizationScopes"), }, Authorizer: jsii.String("authorizer"), }
type CfnFunction_IAMPolicyDocumentProperty ¶
type CfnFunction_IAMPolicyDocumentProperty struct { // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-serverless-function-iampolicydocument.html#cfn-serverless-function-iampolicydocument-statement // Statement interface{} `field:"required" json:"statement" yaml:"statement"` // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-serverless-function-iampolicydocument.html#cfn-serverless-function-iampolicydocument-version // Version *string `field:"optional" json:"version" yaml:"version"` }
Example:
// The code below shows an example of how to instantiate this type. // The values are placeholders you should change. import "github.com/aws/aws-cdk-go/awscdk" var statement interface{} iAMPolicyDocumentProperty := map[string]interface{}{ "statement": statement, // the properties below are optional "version": jsii.String("version"), }
type CfnFunction_IdentitySAMPTProperty ¶
type CfnFunction_IdentitySAMPTProperty struct { // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-serverless-function-identitysampt.html#cfn-serverless-function-identitysampt-identityname // IdentityName *string `field:"required" json:"identityName" yaml:"identityName"` }
Example:
// The code below shows an example of how to instantiate this type. // The values are placeholders you should change. import "github.com/aws/aws-cdk-go/awscdk" identitySAMPTProperty := &IdentitySAMPTProperty{ IdentityName: jsii.String("identityName"), }
type CfnFunction_ImageConfigProperty ¶
type CfnFunction_ImageConfigProperty struct { // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-serverless-function-imageconfig.html#cfn-serverless-function-imageconfig-command // Command *[]*string `field:"optional" json:"command" yaml:"command"` // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-serverless-function-imageconfig.html#cfn-serverless-function-imageconfig-entrypoint // EntryPoint *[]*string `field:"optional" json:"entryPoint" yaml:"entryPoint"` // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-serverless-function-imageconfig.html#cfn-serverless-function-imageconfig-workingdirectory // WorkingDirectory *string `field:"optional" json:"workingDirectory" yaml:"workingDirectory"` }
Example:
// The code below shows an example of how to instantiate this type. // The values are placeholders you should change. import "github.com/aws/aws-cdk-go/awscdk" imageConfigProperty := &ImageConfigProperty{ Command: []*string{ jsii.String("command"), }, EntryPoint: []*string{ jsii.String("entryPoint"), }, WorkingDirectory: jsii.String("workingDirectory"), }
type CfnFunction_IoTRuleEventProperty ¶
type CfnFunction_IoTRuleEventProperty struct { // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-serverless-function-iotruleevent.html#cfn-serverless-function-iotruleevent-sql // Sql *string `field:"required" json:"sql" yaml:"sql"` // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-serverless-function-iotruleevent.html#cfn-serverless-function-iotruleevent-awsiotsqlversion // AwsIotSqlVersion *string `field:"optional" json:"awsIotSqlVersion" yaml:"awsIotSqlVersion"` }
Example:
// The code below shows an example of how to instantiate this type. // The values are placeholders you should change. import "github.com/aws/aws-cdk-go/awscdk" ioTRuleEventProperty := &IoTRuleEventProperty{ Sql: jsii.String("sql"), // the properties below are optional AwsIotSqlVersion: jsii.String("awsIotSqlVersion"), }
type CfnFunction_KeySAMPTProperty ¶
type CfnFunction_KeySAMPTProperty struct { // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-serverless-function-keysampt.html#cfn-serverless-function-keysampt-keyid // KeyId *string `field:"required" json:"keyId" yaml:"keyId"` }
Example:
// The code below shows an example of how to instantiate this type. // The values are placeholders you should change. import "github.com/aws/aws-cdk-go/awscdk" keySAMPTProperty := &KeySAMPTProperty{ KeyId: jsii.String("keyId"), }
type CfnFunction_KinesisEventProperty ¶
type CfnFunction_KinesisEventProperty struct { // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-serverless-function-kinesisevent.html#cfn-serverless-function-kinesisevent-startingposition // StartingPosition *string `field:"required" json:"startingPosition" yaml:"startingPosition"` // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-serverless-function-kinesisevent.html#cfn-serverless-function-kinesisevent-stream // Stream *string `field:"required" json:"stream" yaml:"stream"` // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-serverless-function-kinesisevent.html#cfn-serverless-function-kinesisevent-batchsize // BatchSize *float64 `field:"optional" json:"batchSize" yaml:"batchSize"` // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-serverless-function-kinesisevent.html#cfn-serverless-function-kinesisevent-enabled // Enabled interface{} `field:"optional" json:"enabled" yaml:"enabled"` // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-serverless-function-kinesisevent.html#cfn-serverless-function-kinesisevent-functionresponsetypes // FunctionResponseTypes *[]*string `field:"optional" json:"functionResponseTypes" yaml:"functionResponseTypes"` }
Example:
// The code below shows an example of how to instantiate this type. // The values are placeholders you should change. import "github.com/aws/aws-cdk-go/awscdk" kinesisEventProperty := &KinesisEventProperty{ StartingPosition: jsii.String("startingPosition"), Stream: jsii.String("stream"), // the properties below are optional BatchSize: jsii.Number(123), Enabled: jsii.Boolean(false), FunctionResponseTypes: []*string{ jsii.String("functionResponseTypes"), }, }
type CfnFunction_LogGroupSAMPTProperty ¶
type CfnFunction_LogGroupSAMPTProperty struct { // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-serverless-function-loggroupsampt.html#cfn-serverless-function-loggroupsampt-loggroupname // LogGroupName *string `field:"required" json:"logGroupName" yaml:"logGroupName"` }
Example:
// The code below shows an example of how to instantiate this type. // The values are placeholders you should change. import "github.com/aws/aws-cdk-go/awscdk" logGroupSAMPTProperty := &LogGroupSAMPTProperty{ LogGroupName: jsii.String("logGroupName"), }
type CfnFunction_ParameterNameSAMPTProperty ¶ added in v2.23.0
type CfnFunction_ParameterNameSAMPTProperty struct { // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-serverless-function-parameternamesampt.html#cfn-serverless-function-parameternamesampt-parametername // ParameterName *string `field:"required" json:"parameterName" yaml:"parameterName"` }
Example:
// The code below shows an example of how to instantiate this type. // The values are placeholders you should change. import "github.com/aws/aws-cdk-go/awscdk" parameterNameSAMPTProperty := &ParameterNameSAMPTProperty{ ParameterName: jsii.String("parameterName"), }
type CfnFunction_ProvisionedConcurrencyConfigProperty ¶
type CfnFunction_ProvisionedConcurrencyConfigProperty struct { // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-serverless-function-provisionedconcurrencyconfig.html#cfn-serverless-function-provisionedconcurrencyconfig-provisionedconcurrentexecutions // ProvisionedConcurrentExecutions *string `field:"required" json:"provisionedConcurrentExecutions" yaml:"provisionedConcurrentExecutions"` }
Example:
// The code below shows an example of how to instantiate this type. // The values are placeholders you should change. import "github.com/aws/aws-cdk-go/awscdk" provisionedConcurrencyConfigProperty := &ProvisionedConcurrencyConfigProperty{ ProvisionedConcurrentExecutions: jsii.String("provisionedConcurrentExecutions"), }
type CfnFunction_QueueSAMPTProperty ¶
type CfnFunction_QueueSAMPTProperty struct { // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-serverless-function-queuesampt.html#cfn-serverless-function-queuesampt-queuename // QueueName *string `field:"required" json:"queueName" yaml:"queueName"` }
Example:
// The code below shows an example of how to instantiate this type. // The values are placeholders you should change. import "github.com/aws/aws-cdk-go/awscdk" queueSAMPTProperty := &QueueSAMPTProperty{ QueueName: jsii.String("queueName"), }
type CfnFunction_RequestModelProperty ¶ added in v2.25.0
type CfnFunction_RequestModelProperty struct { // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-serverless-function-requestmodel.html#cfn-serverless-function-requestmodel-model // Model *string `field:"required" json:"model" yaml:"model"` // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-serverless-function-requestmodel.html#cfn-serverless-function-requestmodel-required // Required interface{} `field:"optional" json:"required" yaml:"required"` // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-serverless-function-requestmodel.html#cfn-serverless-function-requestmodel-validatebody // ValidateBody interface{} `field:"optional" json:"validateBody" yaml:"validateBody"` // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-serverless-function-requestmodel.html#cfn-serverless-function-requestmodel-validateparameters // ValidateParameters interface{} `field:"optional" json:"validateParameters" yaml:"validateParameters"` }
Example:
// The code below shows an example of how to instantiate this type. // The values are placeholders you should change. import "github.com/aws/aws-cdk-go/awscdk" requestModelProperty := &RequestModelProperty{ Model: jsii.String("model"), // the properties below are optional Required: jsii.Boolean(false), ValidateBody: jsii.Boolean(false), ValidateParameters: jsii.Boolean(false), }
type CfnFunction_RequestParameterProperty ¶ added in v2.25.0
type CfnFunction_RequestParameterProperty struct { // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-serverless-function-requestparameter.html#cfn-serverless-function-requestparameter-caching // Caching interface{} `field:"optional" json:"caching" yaml:"caching"` // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-serverless-function-requestparameter.html#cfn-serverless-function-requestparameter-required // Required interface{} `field:"optional" json:"required" yaml:"required"` }
Example:
// The code below shows an example of how to instantiate this type. // The values are placeholders you should change. import "github.com/aws/aws-cdk-go/awscdk" requestParameterProperty := &RequestParameterProperty{ Caching: jsii.Boolean(false), Required: jsii.Boolean(false), }
type CfnFunction_RouteSettingsProperty ¶ added in v2.62.0
type CfnFunction_RouteSettingsProperty struct { // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-serverless-function-routesettings.html#cfn-serverless-function-routesettings-datatraceenabled // DataTraceEnabled interface{} `field:"optional" json:"dataTraceEnabled" yaml:"dataTraceEnabled"` // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-serverless-function-routesettings.html#cfn-serverless-function-routesettings-detailedmetricsenabled // DetailedMetricsEnabled interface{} `field:"optional" json:"detailedMetricsEnabled" yaml:"detailedMetricsEnabled"` // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-serverless-function-routesettings.html#cfn-serverless-function-routesettings-logginglevel // LoggingLevel *string `field:"optional" json:"loggingLevel" yaml:"loggingLevel"` // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-serverless-function-routesettings.html#cfn-serverless-function-routesettings-throttlingburstlimit // ThrottlingBurstLimit *float64 `field:"optional" json:"throttlingBurstLimit" yaml:"throttlingBurstLimit"` // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-serverless-function-routesettings.html#cfn-serverless-function-routesettings-throttlingratelimit // ThrottlingRateLimit *float64 `field:"optional" json:"throttlingRateLimit" yaml:"throttlingRateLimit"` }
Example:
// The code below shows an example of how to instantiate this type. // The values are placeholders you should change. import "github.com/aws/aws-cdk-go/awscdk" routeSettingsProperty := &RouteSettingsProperty{ DataTraceEnabled: jsii.Boolean(false), DetailedMetricsEnabled: jsii.Boolean(false), LoggingLevel: jsii.String("loggingLevel"), ThrottlingBurstLimit: jsii.Number(123), ThrottlingRateLimit: jsii.Number(123), }
type CfnFunction_S3EventProperty ¶
type CfnFunction_S3EventProperty struct { // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-serverless-function-s3event.html#cfn-serverless-function-s3event-bucket // Bucket *string `field:"required" json:"bucket" yaml:"bucket"` // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-serverless-function-s3event.html#cfn-serverless-function-s3event-events // Events *string `field:"required" json:"events" yaml:"events"` // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-serverless-function-s3event.html#cfn-serverless-function-s3event-filter // Filter interface{} `field:"optional" json:"filter" yaml:"filter"` }
Example:
// The code below shows an example of how to instantiate this type. // The values are placeholders you should change. import "github.com/aws/aws-cdk-go/awscdk" s3EventProperty := &S3EventProperty{ Bucket: jsii.String("bucket"), Events: jsii.String("events"), // the properties below are optional Filter: &S3NotificationFilterProperty{ S3Key: &S3KeyFilterProperty{ Rules: []interface{}{ &S3KeyFilterRuleProperty{ Name: jsii.String("name"), Value: jsii.String("value"), }, }, }, }, }
type CfnFunction_S3KeyFilterProperty ¶
type CfnFunction_S3KeyFilterProperty struct { // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-serverless-function-s3keyfilter.html#cfn-serverless-function-s3keyfilter-rules // Rules interface{} `field:"required" json:"rules" yaml:"rules"` }
Example:
// The code below shows an example of how to instantiate this type. // The values are placeholders you should change. import "github.com/aws/aws-cdk-go/awscdk" s3KeyFilterProperty := &S3KeyFilterProperty{ Rules: []interface{}{ &S3KeyFilterRuleProperty{ Name: jsii.String("name"), Value: jsii.String("value"), }, }, }
type CfnFunction_S3KeyFilterRuleProperty ¶
type CfnFunction_S3KeyFilterRuleProperty struct { // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-serverless-function-s3keyfilterrule.html#cfn-serverless-function-s3keyfilterrule-name // Name *string `field:"required" json:"name" yaml:"name"` // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-serverless-function-s3keyfilterrule.html#cfn-serverless-function-s3keyfilterrule-value // Value *string `field:"required" json:"value" yaml:"value"` }
Example:
// The code below shows an example of how to instantiate this type. // The values are placeholders you should change. import "github.com/aws/aws-cdk-go/awscdk" s3KeyFilterRuleProperty := &S3KeyFilterRuleProperty{ Name: jsii.String("name"), Value: jsii.String("value"), }
type CfnFunction_S3LocationProperty ¶
type CfnFunction_S3LocationProperty struct { // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-serverless-function-s3location.html#cfn-serverless-function-s3location-bucket // Bucket *string `field:"required" json:"bucket" yaml:"bucket"` // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-serverless-function-s3location.html#cfn-serverless-function-s3location-key // Key *string `field:"required" json:"key" yaml:"key"` // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-serverless-function-s3location.html#cfn-serverless-function-s3location-version // Version *float64 `field:"optional" json:"version" yaml:"version"` }
Example:
// The code below shows an example of how to instantiate this type. // The values are placeholders you should change. import "github.com/aws/aws-cdk-go/awscdk" s3LocationProperty := &S3LocationProperty{ Bucket: jsii.String("bucket"), Key: jsii.String("key"), // the properties below are optional Version: jsii.Number(123), }
type CfnFunction_S3NotificationFilterProperty ¶
type CfnFunction_S3NotificationFilterProperty struct { // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-serverless-function-s3notificationfilter.html#cfn-serverless-function-s3notificationfilter-s3key // S3Key interface{} `field:"required" json:"s3Key" yaml:"s3Key"` }
Example:
// The code below shows an example of how to instantiate this type. // The values are placeholders you should change. import "github.com/aws/aws-cdk-go/awscdk" s3NotificationFilterProperty := &S3NotificationFilterProperty{ S3Key: &S3KeyFilterProperty{ Rules: []interface{}{ &S3KeyFilterRuleProperty{ Name: jsii.String("name"), Value: jsii.String("value"), }, }, }, }
type CfnFunction_SAMPolicyTemplateProperty ¶
type CfnFunction_SAMPolicyTemplateProperty struct { // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-serverless-function-sampolicytemplate.html#cfn-serverless-function-sampolicytemplate-amidescribepolicy // AmiDescribePolicy interface{} `field:"optional" json:"amiDescribePolicy" yaml:"amiDescribePolicy"` // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-serverless-function-sampolicytemplate.html#cfn-serverless-function-sampolicytemplate-awssecretsmanagergetsecretvaluepolicy // AwsSecretsManagerGetSecretValuePolicy interface{} `field:"optional" json:"awsSecretsManagerGetSecretValuePolicy" yaml:"awsSecretsManagerGetSecretValuePolicy"` // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-serverless-function-sampolicytemplate.html#cfn-serverless-function-sampolicytemplate-cloudformationdescribestackspolicy // CloudFormationDescribeStacksPolicy interface{} `field:"optional" json:"cloudFormationDescribeStacksPolicy" yaml:"cloudFormationDescribeStacksPolicy"` // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-serverless-function-sampolicytemplate.html#cfn-serverless-function-sampolicytemplate-cloudwatchputmetricpolicy // CloudWatchPutMetricPolicy interface{} `field:"optional" json:"cloudWatchPutMetricPolicy" yaml:"cloudWatchPutMetricPolicy"` // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-serverless-function-sampolicytemplate.html#cfn-serverless-function-sampolicytemplate-dynamodbcrudpolicy // DynamoDbCrudPolicy interface{} `field:"optional" json:"dynamoDbCrudPolicy" yaml:"dynamoDbCrudPolicy"` // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-serverless-function-sampolicytemplate.html#cfn-serverless-function-sampolicytemplate-dynamodbreadpolicy // DynamoDbReadPolicy interface{} `field:"optional" json:"dynamoDbReadPolicy" yaml:"dynamoDbReadPolicy"` // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-serverless-function-sampolicytemplate.html#cfn-serverless-function-sampolicytemplate-dynamodbstreamreadpolicy // DynamoDbStreamReadPolicy interface{} `field:"optional" json:"dynamoDbStreamReadPolicy" yaml:"dynamoDbStreamReadPolicy"` // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-serverless-function-sampolicytemplate.html#cfn-serverless-function-sampolicytemplate-dynamodbwritepolicy // DynamoDbWritePolicy interface{} `field:"optional" json:"dynamoDbWritePolicy" yaml:"dynamoDbWritePolicy"` // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-serverless-function-sampolicytemplate.html#cfn-serverless-function-sampolicytemplate-ec2describepolicy // Ec2DescribePolicy interface{} `field:"optional" json:"ec2DescribePolicy" yaml:"ec2DescribePolicy"` // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-serverless-function-sampolicytemplate.html#cfn-serverless-function-sampolicytemplate-elasticsearchhttppostpolicy // ElasticsearchHttpPostPolicy interface{} `field:"optional" json:"elasticsearchHttpPostPolicy" yaml:"elasticsearchHttpPostPolicy"` // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-serverless-function-sampolicytemplate.html#cfn-serverless-function-sampolicytemplate-filterlogeventspolicy // FilterLogEventsPolicy interface{} `field:"optional" json:"filterLogEventsPolicy" yaml:"filterLogEventsPolicy"` // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-serverless-function-sampolicytemplate.html#cfn-serverless-function-sampolicytemplate-kinesiscrudpolicy // KinesisCrudPolicy interface{} `field:"optional" json:"kinesisCrudPolicy" yaml:"kinesisCrudPolicy"` // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-serverless-function-sampolicytemplate.html#cfn-serverless-function-sampolicytemplate-kinesisstreamreadpolicy // KinesisStreamReadPolicy interface{} `field:"optional" json:"kinesisStreamReadPolicy" yaml:"kinesisStreamReadPolicy"` // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-serverless-function-sampolicytemplate.html#cfn-serverless-function-sampolicytemplate-kmsdecryptpolicy // KmsDecryptPolicy interface{} `field:"optional" json:"kmsDecryptPolicy" yaml:"kmsDecryptPolicy"` // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-serverless-function-sampolicytemplate.html#cfn-serverless-function-sampolicytemplate-lambdainvokepolicy // LambdaInvokePolicy interface{} `field:"optional" json:"lambdaInvokePolicy" yaml:"lambdaInvokePolicy"` // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-serverless-function-sampolicytemplate.html#cfn-serverless-function-sampolicytemplate-rekognitiondetectonlypolicy // RekognitionDetectOnlyPolicy interface{} `field:"optional" json:"rekognitionDetectOnlyPolicy" yaml:"rekognitionDetectOnlyPolicy"` // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-serverless-function-sampolicytemplate.html#cfn-serverless-function-sampolicytemplate-rekognitionlabelspolicy // RekognitionLabelsPolicy interface{} `field:"optional" json:"rekognitionLabelsPolicy" yaml:"rekognitionLabelsPolicy"` // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-serverless-function-sampolicytemplate.html#cfn-serverless-function-sampolicytemplate-rekognitionnodataaccesspolicy // RekognitionNoDataAccessPolicy interface{} `field:"optional" json:"rekognitionNoDataAccessPolicy" yaml:"rekognitionNoDataAccessPolicy"` // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-serverless-function-sampolicytemplate.html#cfn-serverless-function-sampolicytemplate-rekognitionreadpolicy // RekognitionReadPolicy interface{} `field:"optional" json:"rekognitionReadPolicy" yaml:"rekognitionReadPolicy"` // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-serverless-function-sampolicytemplate.html#cfn-serverless-function-sampolicytemplate-rekognitionwriteonlyaccesspolicy // RekognitionWriteOnlyAccessPolicy interface{} `field:"optional" json:"rekognitionWriteOnlyAccessPolicy" yaml:"rekognitionWriteOnlyAccessPolicy"` // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-serverless-function-sampolicytemplate.html#cfn-serverless-function-sampolicytemplate-s3crudpolicy // S3CrudPolicy interface{} `field:"optional" json:"s3CrudPolicy" yaml:"s3CrudPolicy"` // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-serverless-function-sampolicytemplate.html#cfn-serverless-function-sampolicytemplate-s3readpolicy // S3ReadPolicy interface{} `field:"optional" json:"s3ReadPolicy" yaml:"s3ReadPolicy"` // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-serverless-function-sampolicytemplate.html#cfn-serverless-function-sampolicytemplate-s3writepolicy // S3WritePolicy interface{} `field:"optional" json:"s3WritePolicy" yaml:"s3WritePolicy"` // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-serverless-function-sampolicytemplate.html#cfn-serverless-function-sampolicytemplate-sesbulktemplatedcrudpolicy // SesBulkTemplatedCrudPolicy interface{} `field:"optional" json:"sesBulkTemplatedCrudPolicy" yaml:"sesBulkTemplatedCrudPolicy"` // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-serverless-function-sampolicytemplate.html#cfn-serverless-function-sampolicytemplate-sescrudpolicy // SesCrudPolicy interface{} `field:"optional" json:"sesCrudPolicy" yaml:"sesCrudPolicy"` // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-serverless-function-sampolicytemplate.html#cfn-serverless-function-sampolicytemplate-sesemailtemplatecrudpolicy // SesEmailTemplateCrudPolicy interface{} `field:"optional" json:"sesEmailTemplateCrudPolicy" yaml:"sesEmailTemplateCrudPolicy"` // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-serverless-function-sampolicytemplate.html#cfn-serverless-function-sampolicytemplate-sessendbouncepolicy // SesSendBouncePolicy interface{} `field:"optional" json:"sesSendBouncePolicy" yaml:"sesSendBouncePolicy"` // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-serverless-function-sampolicytemplate.html#cfn-serverless-function-sampolicytemplate-snscrudpolicy // SnsCrudPolicy interface{} `field:"optional" json:"snsCrudPolicy" yaml:"snsCrudPolicy"` // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-serverless-function-sampolicytemplate.html#cfn-serverless-function-sampolicytemplate-snspublishmessagepolicy // SnsPublishMessagePolicy interface{} `field:"optional" json:"snsPublishMessagePolicy" yaml:"snsPublishMessagePolicy"` // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-serverless-function-sampolicytemplate.html#cfn-serverless-function-sampolicytemplate-sqspollerpolicy // SqsPollerPolicy interface{} `field:"optional" json:"sqsPollerPolicy" yaml:"sqsPollerPolicy"` // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-serverless-function-sampolicytemplate.html#cfn-serverless-function-sampolicytemplate-sqssendmessagepolicy // SqsSendMessagePolicy interface{} `field:"optional" json:"sqsSendMessagePolicy" yaml:"sqsSendMessagePolicy"` // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-serverless-function-sampolicytemplate.html#cfn-serverless-function-sampolicytemplate-ssmparameterreadpolicy // SsmParameterReadPolicy interface{} `field:"optional" json:"ssmParameterReadPolicy" yaml:"ssmParameterReadPolicy"` // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-serverless-function-sampolicytemplate.html#cfn-serverless-function-sampolicytemplate-stepfunctionsexecutionpolicy // StepFunctionsExecutionPolicy interface{} `field:"optional" json:"stepFunctionsExecutionPolicy" yaml:"stepFunctionsExecutionPolicy"` // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-serverless-function-sampolicytemplate.html#cfn-serverless-function-sampolicytemplate-vpcaccesspolicy // VpcAccessPolicy interface{} `field:"optional" json:"vpcAccessPolicy" yaml:"vpcAccessPolicy"` }
Example:
// The code below shows an example of how to instantiate this type. // The values are placeholders you should change. import "github.com/aws/aws-cdk-go/awscdk" sAMPolicyTemplateProperty := &SAMPolicyTemplateProperty{ AmiDescribePolicy: &EmptySAMPTProperty{ }, AwsSecretsManagerGetSecretValuePolicy: &SecretArnSAMPTProperty{ SecretArn: jsii.String("secretArn"), }, CloudFormationDescribeStacksPolicy: &EmptySAMPTProperty{ }, CloudWatchPutMetricPolicy: &EmptySAMPTProperty{ }, DynamoDbCrudPolicy: &TableSAMPTProperty{ TableName: jsii.String("tableName"), }, DynamoDbReadPolicy: &TableSAMPTProperty{ TableName: jsii.String("tableName"), }, DynamoDbStreamReadPolicy: &TableStreamSAMPTProperty{ StreamName: jsii.String("streamName"), TableName: jsii.String("tableName"), }, DynamoDbWritePolicy: &TableSAMPTProperty{ TableName: jsii.String("tableName"), }, Ec2DescribePolicy: &EmptySAMPTProperty{ }, ElasticsearchHttpPostPolicy: &DomainSAMPTProperty{ DomainName: jsii.String("domainName"), }, FilterLogEventsPolicy: &LogGroupSAMPTProperty{ LogGroupName: jsii.String("logGroupName"), }, KinesisCrudPolicy: &StreamSAMPTProperty{ StreamName: jsii.String("streamName"), }, KinesisStreamReadPolicy: &StreamSAMPTProperty{ StreamName: jsii.String("streamName"), }, KmsDecryptPolicy: &KeySAMPTProperty{ KeyId: jsii.String("keyId"), }, LambdaInvokePolicy: &FunctionSAMPTProperty{ FunctionName: jsii.String("functionName"), }, RekognitionDetectOnlyPolicy: &EmptySAMPTProperty{ }, RekognitionLabelsPolicy: &EmptySAMPTProperty{ }, RekognitionNoDataAccessPolicy: &CollectionSAMPTProperty{ CollectionId: jsii.String("collectionId"), }, RekognitionReadPolicy: &CollectionSAMPTProperty{ CollectionId: jsii.String("collectionId"), }, RekognitionWriteOnlyAccessPolicy: &CollectionSAMPTProperty{ CollectionId: jsii.String("collectionId"), }, S3CrudPolicy: &BucketSAMPTProperty{ BucketName: jsii.String("bucketName"), }, S3ReadPolicy: &BucketSAMPTProperty{ BucketName: jsii.String("bucketName"), }, S3WritePolicy: &BucketSAMPTProperty{ BucketName: jsii.String("bucketName"), }, SesBulkTemplatedCrudPolicy: &IdentitySAMPTProperty{ IdentityName: jsii.String("identityName"), }, SesCrudPolicy: &IdentitySAMPTProperty{ IdentityName: jsii.String("identityName"), }, SesEmailTemplateCrudPolicy: &EmptySAMPTProperty{ }, SesSendBouncePolicy: &IdentitySAMPTProperty{ IdentityName: jsii.String("identityName"), }, SnsCrudPolicy: &TopicSAMPTProperty{ TopicName: jsii.String("topicName"), }, SnsPublishMessagePolicy: &TopicSAMPTProperty{ TopicName: jsii.String("topicName"), }, SqsPollerPolicy: &QueueSAMPTProperty{ QueueName: jsii.String("queueName"), }, SqsSendMessagePolicy: &QueueSAMPTProperty{ QueueName: jsii.String("queueName"), }, SsmParameterReadPolicy: &ParameterNameSAMPTProperty{ ParameterName: jsii.String("parameterName"), }, StepFunctionsExecutionPolicy: &StateMachineSAMPTProperty{ StateMachineName: jsii.String("stateMachineName"), }, VpcAccessPolicy: &EmptySAMPTProperty{ }, }
type CfnFunction_SNSEventProperty ¶
type CfnFunction_SNSEventProperty struct { // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-serverless-function-snsevent.html#cfn-serverless-function-snsevent-topic // Topic *string `field:"required" json:"topic" yaml:"topic"` }
Example:
// The code below shows an example of how to instantiate this type. // The values are placeholders you should change. import "github.com/aws/aws-cdk-go/awscdk" sNSEventProperty := &SNSEventProperty{ Topic: jsii.String("topic"), }
type CfnFunction_SQSEventProperty ¶
type CfnFunction_SQSEventProperty struct { // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-serverless-function-sqsevent.html#cfn-serverless-function-sqsevent-queue // Queue *string `field:"required" json:"queue" yaml:"queue"` // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-serverless-function-sqsevent.html#cfn-serverless-function-sqsevent-batchsize // BatchSize *float64 `field:"optional" json:"batchSize" yaml:"batchSize"` // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-serverless-function-sqsevent.html#cfn-serverless-function-sqsevent-enabled // Enabled interface{} `field:"optional" json:"enabled" yaml:"enabled"` }
Example:
// The code below shows an example of how to instantiate this type. // The values are placeholders you should change. import "github.com/aws/aws-cdk-go/awscdk" sQSEventProperty := &SQSEventProperty{ Queue: jsii.String("queue"), // the properties below are optional BatchSize: jsii.Number(123), Enabled: jsii.Boolean(false), }
type CfnFunction_ScheduleEventProperty ¶
type CfnFunction_ScheduleEventProperty struct { // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-serverless-function-scheduleevent.html#cfn-serverless-function-scheduleevent-schedule // Schedule *string `field:"required" json:"schedule" yaml:"schedule"` // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-serverless-function-scheduleevent.html#cfn-serverless-function-scheduleevent-description // Description *string `field:"optional" json:"description" yaml:"description"` // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-serverless-function-scheduleevent.html#cfn-serverless-function-scheduleevent-enabled // Enabled interface{} `field:"optional" json:"enabled" yaml:"enabled"` // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-serverless-function-scheduleevent.html#cfn-serverless-function-scheduleevent-input // Input *string `field:"optional" json:"input" yaml:"input"` // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-serverless-function-scheduleevent.html#cfn-serverless-function-scheduleevent-name // Name *string `field:"optional" json:"name" yaml:"name"` }
Example:
// The code below shows an example of how to instantiate this type. // The values are placeholders you should change. import "github.com/aws/aws-cdk-go/awscdk" scheduleEventProperty := &ScheduleEventProperty{ Schedule: jsii.String("schedule"), // the properties below are optional Description: jsii.String("description"), Enabled: jsii.Boolean(false), Input: jsii.String("input"), Name: jsii.String("name"), }
type CfnFunction_SecretArnSAMPTProperty ¶ added in v2.23.0
type CfnFunction_SecretArnSAMPTProperty struct { // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-serverless-function-secretarnsampt.html#cfn-serverless-function-secretarnsampt-secretarn // SecretArn *string `field:"required" json:"secretArn" yaml:"secretArn"` }
Example:
// The code below shows an example of how to instantiate this type. // The values are placeholders you should change. import "github.com/aws/aws-cdk-go/awscdk" secretArnSAMPTProperty := &SecretArnSAMPTProperty{ SecretArn: jsii.String("secretArn"), }
type CfnFunction_StateMachineSAMPTProperty ¶
type CfnFunction_StateMachineSAMPTProperty struct { // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-serverless-function-statemachinesampt.html#cfn-serverless-function-statemachinesampt-statemachinename // StateMachineName *string `field:"required" json:"stateMachineName" yaml:"stateMachineName"` }
Example:
// The code below shows an example of how to instantiate this type. // The values are placeholders you should change. import "github.com/aws/aws-cdk-go/awscdk" stateMachineSAMPTProperty := &StateMachineSAMPTProperty{ StateMachineName: jsii.String("stateMachineName"), }
type CfnFunction_StreamSAMPTProperty ¶
type CfnFunction_StreamSAMPTProperty struct { // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-serverless-function-streamsampt.html#cfn-serverless-function-streamsampt-streamname // StreamName *string `field:"required" json:"streamName" yaml:"streamName"` }
Example:
// The code below shows an example of how to instantiate this type. // The values are placeholders you should change. import "github.com/aws/aws-cdk-go/awscdk" streamSAMPTProperty := &StreamSAMPTProperty{ StreamName: jsii.String("streamName"), }
type CfnFunction_TableSAMPTProperty ¶
type CfnFunction_TableSAMPTProperty struct { // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-serverless-function-tablesampt.html#cfn-serverless-function-tablesampt-tablename // TableName *string `field:"required" json:"tableName" yaml:"tableName"` }
Example:
// The code below shows an example of how to instantiate this type. // The values are placeholders you should change. import "github.com/aws/aws-cdk-go/awscdk" tableSAMPTProperty := &TableSAMPTProperty{ TableName: jsii.String("tableName"), }
type CfnFunction_TableStreamSAMPTProperty ¶
type CfnFunction_TableStreamSAMPTProperty struct { // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-serverless-function-tablestreamsampt.html#cfn-serverless-function-tablestreamsampt-streamname // StreamName *string `field:"required" json:"streamName" yaml:"streamName"` // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-serverless-function-tablestreamsampt.html#cfn-serverless-function-tablestreamsampt-tablename // TableName *string `field:"required" json:"tableName" yaml:"tableName"` }
Example:
// The code below shows an example of how to instantiate this type. // The values are placeholders you should change. import "github.com/aws/aws-cdk-go/awscdk" tableStreamSAMPTProperty := &TableStreamSAMPTProperty{ StreamName: jsii.String("streamName"), TableName: jsii.String("tableName"), }
type CfnFunction_TopicSAMPTProperty ¶
type CfnFunction_TopicSAMPTProperty struct { // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-serverless-function-topicsampt.html#cfn-serverless-function-topicsampt-topicname // TopicName *string `field:"required" json:"topicName" yaml:"topicName"` }
Example:
// The code below shows an example of how to instantiate this type. // The values are placeholders you should change. import "github.com/aws/aws-cdk-go/awscdk" topicSAMPTProperty := &TopicSAMPTProperty{ TopicName: jsii.String("topicName"), }
type CfnFunction_VpcConfigProperty ¶
type CfnFunction_VpcConfigProperty struct { // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-serverless-function-vpcconfig.html#cfn-serverless-function-vpcconfig-securitygroupids // SecurityGroupIds *[]*string `field:"required" json:"securityGroupIds" yaml:"securityGroupIds"` // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-serverless-function-vpcconfig.html#cfn-serverless-function-vpcconfig-subnetids // SubnetIds *[]*string `field:"required" json:"subnetIds" yaml:"subnetIds"` }
Example:
// The code below shows an example of how to instantiate this type. // The values are placeholders you should change. import "github.com/aws/aws-cdk-go/awscdk" vpcConfigProperty := &VpcConfigProperty{ SecurityGroupIds: []*string{ jsii.String("securityGroupIds"), }, SubnetIds: []*string{ jsii.String("subnetIds"), }, }
type CfnHttpApi ¶
type CfnHttpApi interface { awscdk.CfnResource awscdk.IInspectable awscdk.ITaggable AccessLogSetting() interface{} SetAccessLogSetting(val interface{}) Auth() interface{} SetAuth(val interface{}) // Options for this resource, such as condition, update policy etc. CfnOptions() awscdk.ICfnResourceOptions CfnProperties() *map[string]interface{} // AWS resource type. CfnResourceType() *string CorsConfiguration() interface{} SetCorsConfiguration(val interface{}) // Returns: 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. CreationStack() *[]*string DefaultRouteSettings() interface{} SetDefaultRouteSettings(val interface{}) DefinitionBody() interface{} SetDefinitionBody(val interface{}) DefinitionUri() interface{} SetDefinitionUri(val interface{}) Description() *string SetDescription(val *string) DisableExecuteApiEndpoint() interface{} SetDisableExecuteApiEndpoint(val interface{}) Domain() interface{} SetDomain(val interface{}) FailOnWarnings() interface{} SetFailOnWarnings(val interface{}) // 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)`. // // Returns: the logical ID as a stringified token. This value will only get // resolved during synthesis. LogicalId() *string // The tree node. Node() constructs.Node // 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 })`. Ref() *string RouteSettings() interface{} SetRouteSettings(val interface{}) // The stack in which this element is defined. // // CfnElements must be defined within a stack scope (directly or indirectly). Stack() awscdk.Stack StageName() *string SetStageName(val *string) StageVariables() interface{} SetStageVariables(val interface{}) // Tag Manager which manages the tags for this resource. Tags() awscdk.TagManager TagsRaw() *map[string]*string SetTagsRaw(val *map[string]*string) // Deprecated. // Deprecated: use `updatedProperties` // // Return properties modified after initiation // // Resources that expose mutable properties should override this function to // collect and return the properties object for this resource. UpdatedProperites() *map[string]interface{} // Return properties modified after initiation. // // Resources that expose mutable properties should override this function to // collect and return the properties object for this resource. UpdatedProperties() *map[string]interface{} // Syntactic sugar for `addOverride(path, undefined)`. AddDeletionOverride(path *string) // 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. AddDependency(target awscdk.CfnResource) // Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned. // Deprecated: use addDependency. AddDependsOn(target awscdk.CfnResource) // Add a value to the CloudFormation Resource Metadata. // 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. // AddMetadata(key *string, value interface{}) // Adds an override to the synthesized CloudFormation resource. // // To add a // property override, either use `addPropertyOverride` or prefix `path` 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, // “`typescript // cfnResource.addOverride('Properties.GlobalSecondaryIndexes.0.Projection.NonKeyAttributes', ['myattribute']); // cfnResource.addOverride('Properties.GlobalSecondaryIndexes.1.ProjectionType', 'INCLUDE'); // “` // would add the overrides // “`json // "Properties": { // "GlobalSecondaryIndexes": [ // { // "Projection": { // "NonKeyAttributes": [ "myattribute" ] // ... // } // ... // }, // { // "ProjectionType": "INCLUDE" // ... // }, // ] // ... // } // “` // // The `value` argument to `addOverride` 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. AddOverride(path *string, value interface{}) // Adds an override that deletes the value of a property from the resource definition. AddPropertyDeletionOverride(propertyPath *string) // Adds an override to a resource property. // // Syntactic sugar for `addOverride("Properties.<...>", value)`. AddPropertyOverride(propertyPath *string, value interface{}) // 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`). In some // cases, a snapshot can be taken of the resource prior to deletion // (`RemovalPolicy.SNAPSHOT`). A list of resources that support this policy // can be found in the following link:. // See: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-attribute-deletionpolicy.html#aws-attribute-deletionpolicy-options // ApplyRemovalPolicy(policy awscdk.RemovalPolicy, options *awscdk.RemovalPolicyOptions) // 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. GetAtt(attributeName *string, typeHint awscdk.ResolutionTypeHint) awscdk.Reference // Retrieve a value value from the CloudFormation Resource Metadata. // 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. // GetMetadata(key *string) interface{} // Examines the CloudFormation resource and discloses attributes. Inspect(inspector awscdk.TreeInspector) // Retrieves an array of resources this resource depends on. // // This assembles dependencies on resources across stacks (including nested stacks) // automatically. ObtainDependencies() *[]interface{} // Get a shallow copy of dependencies between this resource and other resources in the same stack. ObtainResourceDependencies() *[]awscdk.CfnResource // Overrides the auto-generated logical ID with a specific ID. OverrideLogicalId(newLogicalId *string) // Indicates that this resource no longer depends on another resource. // // This can be used for resources across stacks (including nested stacks) // and the dependency will automatically be removed from the relevant scope. RemoveDependency(target awscdk.CfnResource) RenderProperties(props *map[string]interface{}) *map[string]interface{} // Replaces one dependency with another. ReplaceDependency(target awscdk.CfnResource, newTarget awscdk.CfnResource) // Can be overridden by subclasses to determine if this resource will be rendered into the cloudformation template. // // Returns: `true` if the resource should be included or `false` is the resource // should be omitted. ShouldSynthesize() *bool // Returns a string representation of this construct. // // Returns: a string representation of this resource. ToString() *string ValidateProperties(_properties interface{}) }
Definition of AWS::Serverless::HttpApi.
Example:
// The code below shows an example of how to instantiate this type. // The values are placeholders you should change. import "github.com/aws/aws-cdk-go/awscdk" var authorizers interface{} var definitionBody interface{} cfnHttpApi := awscdk.Aws_sam.NewCfnHttpApi(this, jsii.String("MyCfnHttpApi"), &CfnHttpApiProps{ AccessLogSetting: &AccessLogSettingProperty{ DestinationArn: jsii.String("destinationArn"), Format: jsii.String("format"), }, Auth: &HttpApiAuthProperty{ Authorizers: authorizers, DefaultAuthorizer: jsii.String("defaultAuthorizer"), }, CorsConfiguration: jsii.Boolean(false), DefaultRouteSettings: &RouteSettingsProperty{ DataTraceEnabled: jsii.Boolean(false), DetailedMetricsEnabled: jsii.Boolean(false), LoggingLevel: jsii.String("loggingLevel"), ThrottlingBurstLimit: jsii.Number(123), ThrottlingRateLimit: jsii.Number(123), }, DefinitionBody: definitionBody, DefinitionUri: jsii.String("definitionUri"), Description: jsii.String("description"), DisableExecuteApiEndpoint: jsii.Boolean(false), Domain: &HttpApiDomainConfigurationProperty{ CertificateArn: jsii.String("certificateArn"), DomainName: jsii.String("domainName"), // the properties below are optional BasePath: jsii.String("basePath"), EndpointConfiguration: jsii.String("endpointConfiguration"), MutualTlsAuthentication: &MutualTlsAuthenticationProperty{ TruststoreUri: jsii.String("truststoreUri"), TruststoreVersion: jsii.Boolean(false), }, Route53: &Route53ConfigurationProperty{ DistributedDomainName: jsii.String("distributedDomainName"), EvaluateTargetHealth: jsii.Boolean(false), HostedZoneId: jsii.String("hostedZoneId"), HostedZoneName: jsii.String("hostedZoneName"), IpV6: jsii.Boolean(false), }, SecurityPolicy: jsii.String("securityPolicy"), }, FailOnWarnings: jsii.Boolean(false), RouteSettings: &RouteSettingsProperty{ DataTraceEnabled: jsii.Boolean(false), DetailedMetricsEnabled: jsii.Boolean(false), LoggingLevel: jsii.String("loggingLevel"), ThrottlingBurstLimit: jsii.Number(123), ThrottlingRateLimit: jsii.Number(123), }, StageName: jsii.String("stageName"), StageVariables: map[string]*string{ "stageVariablesKey": jsii.String("stageVariables"), }, Tags: map[string]*string{ "tagsKey": jsii.String("tags"), }, })
See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-serverless-httpapi.html
func NewCfnHttpApi ¶
func NewCfnHttpApi(scope constructs.Construct, id *string, props *CfnHttpApiProps) CfnHttpApi
type CfnHttpApiProps ¶
type CfnHttpApiProps struct { // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-serverless-httpapi.html#cfn-serverless-httpapi-accesslogsetting // AccessLogSetting interface{} `field:"optional" json:"accessLogSetting" yaml:"accessLogSetting"` // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-serverless-httpapi.html#cfn-serverless-httpapi-auth // Auth interface{} `field:"optional" json:"auth" yaml:"auth"` // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-serverless-httpapi.html#cfn-serverless-httpapi-corsconfiguration // CorsConfiguration interface{} `field:"optional" json:"corsConfiguration" yaml:"corsConfiguration"` // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-serverless-httpapi.html#cfn-serverless-httpapi-defaultroutesettings // DefaultRouteSettings interface{} `field:"optional" json:"defaultRouteSettings" yaml:"defaultRouteSettings"` // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-serverless-httpapi.html#cfn-serverless-httpapi-definitionbody // DefinitionBody interface{} `field:"optional" json:"definitionBody" yaml:"definitionBody"` // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-serverless-httpapi.html#cfn-serverless-httpapi-definitionuri // DefinitionUri interface{} `field:"optional" json:"definitionUri" yaml:"definitionUri"` // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-serverless-httpapi.html#cfn-serverless-httpapi-description // Description *string `field:"optional" json:"description" yaml:"description"` // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-serverless-httpapi.html#cfn-serverless-httpapi-disableexecuteapiendpoint // DisableExecuteApiEndpoint interface{} `field:"optional" json:"disableExecuteApiEndpoint" yaml:"disableExecuteApiEndpoint"` // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-serverless-httpapi.html#cfn-serverless-httpapi-domain // Domain interface{} `field:"optional" json:"domain" yaml:"domain"` // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-serverless-httpapi.html#cfn-serverless-httpapi-failonwarnings // FailOnWarnings interface{} `field:"optional" json:"failOnWarnings" yaml:"failOnWarnings"` // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-serverless-httpapi.html#cfn-serverless-httpapi-routesettings // RouteSettings interface{} `field:"optional" json:"routeSettings" yaml:"routeSettings"` // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-serverless-httpapi.html#cfn-serverless-httpapi-stagename // StageName *string `field:"optional" json:"stageName" yaml:"stageName"` // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-serverless-httpapi.html#cfn-serverless-httpapi-stagevariables // StageVariables interface{} `field:"optional" json:"stageVariables" yaml:"stageVariables"` // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-serverless-httpapi.html#cfn-serverless-httpapi-tags // Tags *map[string]*string `field:"optional" json:"tags" yaml:"tags"` }
Properties for defining a `CfnHttpApi`.
Example:
// The code below shows an example of how to instantiate this type. // The values are placeholders you should change. import "github.com/aws/aws-cdk-go/awscdk" var authorizers interface{} var definitionBody interface{} cfnHttpApiProps := &CfnHttpApiProps{ AccessLogSetting: &AccessLogSettingProperty{ DestinationArn: jsii.String("destinationArn"), Format: jsii.String("format"), }, Auth: &HttpApiAuthProperty{ Authorizers: authorizers, DefaultAuthorizer: jsii.String("defaultAuthorizer"), }, CorsConfiguration: jsii.Boolean(false), DefaultRouteSettings: &RouteSettingsProperty{ DataTraceEnabled: jsii.Boolean(false), DetailedMetricsEnabled: jsii.Boolean(false), LoggingLevel: jsii.String("loggingLevel"), ThrottlingBurstLimit: jsii.Number(123), ThrottlingRateLimit: jsii.Number(123), }, DefinitionBody: definitionBody, DefinitionUri: jsii.String("definitionUri"), Description: jsii.String("description"), DisableExecuteApiEndpoint: jsii.Boolean(false), Domain: &HttpApiDomainConfigurationProperty{ CertificateArn: jsii.String("certificateArn"), DomainName: jsii.String("domainName"), // the properties below are optional BasePath: jsii.String("basePath"), EndpointConfiguration: jsii.String("endpointConfiguration"), MutualTlsAuthentication: &MutualTlsAuthenticationProperty{ TruststoreUri: jsii.String("truststoreUri"), TruststoreVersion: jsii.Boolean(false), }, Route53: &Route53ConfigurationProperty{ DistributedDomainName: jsii.String("distributedDomainName"), EvaluateTargetHealth: jsii.Boolean(false), HostedZoneId: jsii.String("hostedZoneId"), HostedZoneName: jsii.String("hostedZoneName"), IpV6: jsii.Boolean(false), }, SecurityPolicy: jsii.String("securityPolicy"), }, FailOnWarnings: jsii.Boolean(false), RouteSettings: &RouteSettingsProperty{ DataTraceEnabled: jsii.Boolean(false), DetailedMetricsEnabled: jsii.Boolean(false), LoggingLevel: jsii.String("loggingLevel"), ThrottlingBurstLimit: jsii.Number(123), ThrottlingRateLimit: jsii.Number(123), }, StageName: jsii.String("stageName"), StageVariables: map[string]*string{ "stageVariablesKey": jsii.String("stageVariables"), }, Tags: map[string]*string{ "tagsKey": jsii.String("tags"), }, }
See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-serverless-httpapi.html
type CfnHttpApi_AccessLogSettingProperty ¶
type CfnHttpApi_AccessLogSettingProperty struct { // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-serverless-httpapi-accesslogsetting.html#cfn-serverless-httpapi-accesslogsetting-destinationarn // DestinationArn *string `field:"optional" json:"destinationArn" yaml:"destinationArn"` // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-serverless-httpapi-accesslogsetting.html#cfn-serverless-httpapi-accesslogsetting-format // Format *string `field:"optional" json:"format" yaml:"format"` }
Example:
// The code below shows an example of how to instantiate this type. // The values are placeholders you should change. import "github.com/aws/aws-cdk-go/awscdk" accessLogSettingProperty := &AccessLogSettingProperty{ DestinationArn: jsii.String("destinationArn"), Format: jsii.String("format"), }
type CfnHttpApi_CorsConfigurationObjectProperty ¶
type CfnHttpApi_CorsConfigurationObjectProperty struct { // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-serverless-httpapi-corsconfigurationobject.html#cfn-serverless-httpapi-corsconfigurationobject-allowcredentials // AllowCredentials interface{} `field:"optional" json:"allowCredentials" yaml:"allowCredentials"` // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-serverless-httpapi-corsconfigurationobject.html#cfn-serverless-httpapi-corsconfigurationobject-allowheaders // AllowHeaders *[]*string `field:"optional" json:"allowHeaders" yaml:"allowHeaders"` // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-serverless-httpapi-corsconfigurationobject.html#cfn-serverless-httpapi-corsconfigurationobject-allowmethods // AllowMethods *[]*string `field:"optional" json:"allowMethods" yaml:"allowMethods"` // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-serverless-httpapi-corsconfigurationobject.html#cfn-serverless-httpapi-corsconfigurationobject-alloworigins // AllowOrigins *[]*string `field:"optional" json:"allowOrigins" yaml:"allowOrigins"` // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-serverless-httpapi-corsconfigurationobject.html#cfn-serverless-httpapi-corsconfigurationobject-exposeheaders // ExposeHeaders *[]*string `field:"optional" json:"exposeHeaders" yaml:"exposeHeaders"` // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-serverless-httpapi-corsconfigurationobject.html#cfn-serverless-httpapi-corsconfigurationobject-maxage // MaxAge *float64 `field:"optional" json:"maxAge" yaml:"maxAge"` }
Example:
// The code below shows an example of how to instantiate this type. // The values are placeholders you should change. import "github.com/aws/aws-cdk-go/awscdk" corsConfigurationObjectProperty := &CorsConfigurationObjectProperty{ AllowCredentials: jsii.Boolean(false), AllowHeaders: []*string{ jsii.String("allowHeaders"), }, AllowMethods: []*string{ jsii.String("allowMethods"), }, AllowOrigins: []*string{ jsii.String("allowOrigins"), }, ExposeHeaders: []*string{ jsii.String("exposeHeaders"), }, MaxAge: jsii.Number(123), }
type CfnHttpApi_HttpApiAuthProperty ¶
type CfnHttpApi_HttpApiAuthProperty struct { // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-serverless-httpapi-httpapiauth.html#cfn-serverless-httpapi-httpapiauth-authorizers // Authorizers interface{} `field:"optional" json:"authorizers" yaml:"authorizers"` // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-serverless-httpapi-httpapiauth.html#cfn-serverless-httpapi-httpapiauth-defaultauthorizer // DefaultAuthorizer *string `field:"optional" json:"defaultAuthorizer" yaml:"defaultAuthorizer"` }
Example:
// The code below shows an example of how to instantiate this type. // The values are placeholders you should change. import "github.com/aws/aws-cdk-go/awscdk" var authorizers interface{} httpApiAuthProperty := &HttpApiAuthProperty{ Authorizers: authorizers, DefaultAuthorizer: jsii.String("defaultAuthorizer"), }
type CfnHttpApi_HttpApiDomainConfigurationProperty ¶
type CfnHttpApi_HttpApiDomainConfigurationProperty struct { // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-serverless-httpapi-httpapidomainconfiguration.html#cfn-serverless-httpapi-httpapidomainconfiguration-certificatearn // CertificateArn *string `field:"required" json:"certificateArn" yaml:"certificateArn"` // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-serverless-httpapi-httpapidomainconfiguration.html#cfn-serverless-httpapi-httpapidomainconfiguration-domainname // DomainName *string `field:"required" json:"domainName" yaml:"domainName"` // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-serverless-httpapi-httpapidomainconfiguration.html#cfn-serverless-httpapi-httpapidomainconfiguration-basepath // BasePath *string `field:"optional" json:"basePath" yaml:"basePath"` // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-serverless-httpapi-httpapidomainconfiguration.html#cfn-serverless-httpapi-httpapidomainconfiguration-endpointconfiguration // EndpointConfiguration *string `field:"optional" json:"endpointConfiguration" yaml:"endpointConfiguration"` // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-serverless-httpapi-httpapidomainconfiguration.html#cfn-serverless-httpapi-httpapidomainconfiguration-mutualtlsauthentication // MutualTlsAuthentication interface{} `field:"optional" json:"mutualTlsAuthentication" yaml:"mutualTlsAuthentication"` // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-serverless-httpapi-httpapidomainconfiguration.html#cfn-serverless-httpapi-httpapidomainconfiguration-route53 // Route53 interface{} `field:"optional" json:"route53" yaml:"route53"` // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-serverless-httpapi-httpapidomainconfiguration.html#cfn-serverless-httpapi-httpapidomainconfiguration-securitypolicy // SecurityPolicy *string `field:"optional" json:"securityPolicy" yaml:"securityPolicy"` }
Example:
// The code below shows an example of how to instantiate this type. // The values are placeholders you should change. import "github.com/aws/aws-cdk-go/awscdk" httpApiDomainConfigurationProperty := &HttpApiDomainConfigurationProperty{ CertificateArn: jsii.String("certificateArn"), DomainName: jsii.String("domainName"), // the properties below are optional BasePath: jsii.String("basePath"), EndpointConfiguration: jsii.String("endpointConfiguration"), MutualTlsAuthentication: &MutualTlsAuthenticationProperty{ TruststoreUri: jsii.String("truststoreUri"), TruststoreVersion: jsii.Boolean(false), }, Route53: &Route53ConfigurationProperty{ DistributedDomainName: jsii.String("distributedDomainName"), EvaluateTargetHealth: jsii.Boolean(false), HostedZoneId: jsii.String("hostedZoneId"), HostedZoneName: jsii.String("hostedZoneName"), IpV6: jsii.Boolean(false), }, SecurityPolicy: jsii.String("securityPolicy"), }
type CfnHttpApi_MutualTlsAuthenticationProperty ¶
type CfnHttpApi_MutualTlsAuthenticationProperty struct { // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-serverless-httpapi-mutualtlsauthentication.html#cfn-serverless-httpapi-mutualtlsauthentication-truststoreuri // TruststoreUri *string `field:"optional" json:"truststoreUri" yaml:"truststoreUri"` // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-serverless-httpapi-mutualtlsauthentication.html#cfn-serverless-httpapi-mutualtlsauthentication-truststoreversion // TruststoreVersion interface{} `field:"optional" json:"truststoreVersion" yaml:"truststoreVersion"` }
Example:
// The code below shows an example of how to instantiate this type. // The values are placeholders you should change. import "github.com/aws/aws-cdk-go/awscdk" mutualTlsAuthenticationProperty := &MutualTlsAuthenticationProperty{ TruststoreUri: jsii.String("truststoreUri"), TruststoreVersion: jsii.Boolean(false), }
type CfnHttpApi_Route53ConfigurationProperty ¶
type CfnHttpApi_Route53ConfigurationProperty struct { // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-serverless-httpapi-route53configuration.html#cfn-serverless-httpapi-route53configuration-distributeddomainname // DistributedDomainName *string `field:"optional" json:"distributedDomainName" yaml:"distributedDomainName"` // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-serverless-httpapi-route53configuration.html#cfn-serverless-httpapi-route53configuration-evaluatetargethealth // EvaluateTargetHealth interface{} `field:"optional" json:"evaluateTargetHealth" yaml:"evaluateTargetHealth"` // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-serverless-httpapi-route53configuration.html#cfn-serverless-httpapi-route53configuration-hostedzoneid // HostedZoneId *string `field:"optional" json:"hostedZoneId" yaml:"hostedZoneId"` // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-serverless-httpapi-route53configuration.html#cfn-serverless-httpapi-route53configuration-hostedzonename // HostedZoneName *string `field:"optional" json:"hostedZoneName" yaml:"hostedZoneName"` // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-serverless-httpapi-route53configuration.html#cfn-serverless-httpapi-route53configuration-ipv6 // IpV6 interface{} `field:"optional" json:"ipV6" yaml:"ipV6"` }
Example:
// The code below shows an example of how to instantiate this type. // The values are placeholders you should change. import "github.com/aws/aws-cdk-go/awscdk" route53ConfigurationProperty := &Route53ConfigurationProperty{ DistributedDomainName: jsii.String("distributedDomainName"), EvaluateTargetHealth: jsii.Boolean(false), HostedZoneId: jsii.String("hostedZoneId"), HostedZoneName: jsii.String("hostedZoneName"), IpV6: jsii.Boolean(false), }
type CfnHttpApi_RouteSettingsProperty ¶
type CfnHttpApi_RouteSettingsProperty struct { // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-serverless-httpapi-routesettings.html#cfn-serverless-httpapi-routesettings-datatraceenabled // DataTraceEnabled interface{} `field:"optional" json:"dataTraceEnabled" yaml:"dataTraceEnabled"` // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-serverless-httpapi-routesettings.html#cfn-serverless-httpapi-routesettings-detailedmetricsenabled // DetailedMetricsEnabled interface{} `field:"optional" json:"detailedMetricsEnabled" yaml:"detailedMetricsEnabled"` // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-serverless-httpapi-routesettings.html#cfn-serverless-httpapi-routesettings-logginglevel // LoggingLevel *string `field:"optional" json:"loggingLevel" yaml:"loggingLevel"` // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-serverless-httpapi-routesettings.html#cfn-serverless-httpapi-routesettings-throttlingburstlimit // ThrottlingBurstLimit *float64 `field:"optional" json:"throttlingBurstLimit" yaml:"throttlingBurstLimit"` // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-serverless-httpapi-routesettings.html#cfn-serverless-httpapi-routesettings-throttlingratelimit // ThrottlingRateLimit *float64 `field:"optional" json:"throttlingRateLimit" yaml:"throttlingRateLimit"` }
Example:
// The code below shows an example of how to instantiate this type. // The values are placeholders you should change. import "github.com/aws/aws-cdk-go/awscdk" routeSettingsProperty := &RouteSettingsProperty{ DataTraceEnabled: jsii.Boolean(false), DetailedMetricsEnabled: jsii.Boolean(false), LoggingLevel: jsii.String("loggingLevel"), ThrottlingBurstLimit: jsii.Number(123), ThrottlingRateLimit: jsii.Number(123), }
type CfnHttpApi_S3LocationProperty ¶
type CfnHttpApi_S3LocationProperty struct { // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-serverless-httpapi-s3location.html#cfn-serverless-httpapi-s3location-bucket // Bucket *string `field:"required" json:"bucket" yaml:"bucket"` // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-serverless-httpapi-s3location.html#cfn-serverless-httpapi-s3location-key // Key *string `field:"required" json:"key" yaml:"key"` // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-serverless-httpapi-s3location.html#cfn-serverless-httpapi-s3location-version // Version *float64 `field:"required" json:"version" yaml:"version"` }
Example:
// The code below shows an example of how to instantiate this type. // The values are placeholders you should change. import "github.com/aws/aws-cdk-go/awscdk" s3LocationProperty := &S3LocationProperty{ Bucket: jsii.String("bucket"), Key: jsii.String("key"), Version: jsii.Number(123), }
type CfnLayerVersion ¶
type CfnLayerVersion interface { awscdk.CfnResource awscdk.IInspectable // Options for this resource, such as condition, update policy etc. CfnOptions() awscdk.ICfnResourceOptions CfnProperties() *map[string]interface{} // AWS resource type. CfnResourceType() *string CompatibleRuntimes() *[]*string SetCompatibleRuntimes(val *[]*string) ContentUri() interface{} SetContentUri(val interface{}) // Returns: 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. CreationStack() *[]*string Description() *string SetDescription(val *string) LayerName() *string SetLayerName(val *string) LicenseInfo() *string SetLicenseInfo(val *string) // 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)`. // // Returns: the logical ID as a stringified token. This value will only get // resolved during synthesis. LogicalId() *string // The tree node. Node() constructs.Node // 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 })`. Ref() *string RetentionPolicy() *string SetRetentionPolicy(val *string) // The stack in which this element is defined. // // CfnElements must be defined within a stack scope (directly or indirectly). Stack() awscdk.Stack // Deprecated. // Deprecated: use `updatedProperties` // // Return properties modified after initiation // // Resources that expose mutable properties should override this function to // collect and return the properties object for this resource. UpdatedProperites() *map[string]interface{} // Return properties modified after initiation. // // Resources that expose mutable properties should override this function to // collect and return the properties object for this resource. UpdatedProperties() *map[string]interface{} // Syntactic sugar for `addOverride(path, undefined)`. AddDeletionOverride(path *string) // 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. AddDependency(target awscdk.CfnResource) // Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned. // Deprecated: use addDependency. AddDependsOn(target awscdk.CfnResource) // Add a value to the CloudFormation Resource Metadata. // 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. // AddMetadata(key *string, value interface{}) // Adds an override to the synthesized CloudFormation resource. // // To add a // property override, either use `addPropertyOverride` or prefix `path` 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, // “`typescript // cfnResource.addOverride('Properties.GlobalSecondaryIndexes.0.Projection.NonKeyAttributes', ['myattribute']); // cfnResource.addOverride('Properties.GlobalSecondaryIndexes.1.ProjectionType', 'INCLUDE'); // “` // would add the overrides // “`json // "Properties": { // "GlobalSecondaryIndexes": [ // { // "Projection": { // "NonKeyAttributes": [ "myattribute" ] // ... // } // ... // }, // { // "ProjectionType": "INCLUDE" // ... // }, // ] // ... // } // “` // // The `value` argument to `addOverride` 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. AddOverride(path *string, value interface{}) // Adds an override that deletes the value of a property from the resource definition. AddPropertyDeletionOverride(propertyPath *string) // Adds an override to a resource property. // // Syntactic sugar for `addOverride("Properties.<...>", value)`. AddPropertyOverride(propertyPath *string, value interface{}) // 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`). In some // cases, a snapshot can be taken of the resource prior to deletion // (`RemovalPolicy.SNAPSHOT`). A list of resources that support this policy // can be found in the following link:. // See: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-attribute-deletionpolicy.html#aws-attribute-deletionpolicy-options // ApplyRemovalPolicy(policy awscdk.RemovalPolicy, options *awscdk.RemovalPolicyOptions) // 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. GetAtt(attributeName *string, typeHint awscdk.ResolutionTypeHint) awscdk.Reference // Retrieve a value value from the CloudFormation Resource Metadata. // 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. // GetMetadata(key *string) interface{} // Examines the CloudFormation resource and discloses attributes. Inspect(inspector awscdk.TreeInspector) // Retrieves an array of resources this resource depends on. // // This assembles dependencies on resources across stacks (including nested stacks) // automatically. ObtainDependencies() *[]interface{} // Get a shallow copy of dependencies between this resource and other resources in the same stack. ObtainResourceDependencies() *[]awscdk.CfnResource // Overrides the auto-generated logical ID with a specific ID. OverrideLogicalId(newLogicalId *string) // Indicates that this resource no longer depends on another resource. // // This can be used for resources across stacks (including nested stacks) // and the dependency will automatically be removed from the relevant scope. RemoveDependency(target awscdk.CfnResource) RenderProperties(props *map[string]interface{}) *map[string]interface{} // Replaces one dependency with another. ReplaceDependency(target awscdk.CfnResource, newTarget awscdk.CfnResource) // Can be overridden by subclasses to determine if this resource will be rendered into the cloudformation template. // // Returns: `true` if the resource should be included or `false` is the resource // should be omitted. ShouldSynthesize() *bool // Returns a string representation of this construct. // // Returns: a string representation of this resource. ToString() *string ValidateProperties(_properties interface{}) }
Definition of AWS::Serverless::LayerVersion.
Example:
// The code below shows an example of how to instantiate this type. // The values are placeholders you should change. import "github.com/aws/aws-cdk-go/awscdk" cfnLayerVersion := awscdk.Aws_sam.NewCfnLayerVersion(this, jsii.String("MyCfnLayerVersion"), &CfnLayerVersionProps{ CompatibleRuntimes: []*string{ jsii.String("compatibleRuntimes"), }, ContentUri: jsii.String("contentUri"), Description: jsii.String("description"), LayerName: jsii.String("layerName"), LicenseInfo: jsii.String("licenseInfo"), RetentionPolicy: jsii.String("retentionPolicy"), })
func NewCfnLayerVersion ¶
func NewCfnLayerVersion(scope constructs.Construct, id *string, props *CfnLayerVersionProps) CfnLayerVersion
type CfnLayerVersionProps ¶
type CfnLayerVersionProps struct { // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-serverless-layerversion.html#cfn-serverless-layerversion-compatibleruntimes // CompatibleRuntimes *[]*string `field:"optional" json:"compatibleRuntimes" yaml:"compatibleRuntimes"` // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-serverless-layerversion.html#cfn-serverless-layerversion-contenturi // ContentUri interface{} `field:"optional" json:"contentUri" yaml:"contentUri"` // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-serverless-layerversion.html#cfn-serverless-layerversion-description // Description *string `field:"optional" json:"description" yaml:"description"` // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-serverless-layerversion.html#cfn-serverless-layerversion-layername // LayerName *string `field:"optional" json:"layerName" yaml:"layerName"` // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-serverless-layerversion.html#cfn-serverless-layerversion-licenseinfo // LicenseInfo *string `field:"optional" json:"licenseInfo" yaml:"licenseInfo"` // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-serverless-layerversion.html#cfn-serverless-layerversion-retentionpolicy // RetentionPolicy *string `field:"optional" json:"retentionPolicy" yaml:"retentionPolicy"` }
Properties for defining a `CfnLayerVersion`.
Example:
// The code below shows an example of how to instantiate this type. // The values are placeholders you should change. import "github.com/aws/aws-cdk-go/awscdk" cfnLayerVersionProps := &CfnLayerVersionProps{ CompatibleRuntimes: []*string{ jsii.String("compatibleRuntimes"), }, ContentUri: jsii.String("contentUri"), Description: jsii.String("description"), LayerName: jsii.String("layerName"), LicenseInfo: jsii.String("licenseInfo"), RetentionPolicy: jsii.String("retentionPolicy"), }
type CfnLayerVersion_S3LocationProperty ¶
type CfnLayerVersion_S3LocationProperty struct { // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-serverless-layerversion-s3location.html#cfn-serverless-layerversion-s3location-bucket // Bucket *string `field:"required" json:"bucket" yaml:"bucket"` // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-serverless-layerversion-s3location.html#cfn-serverless-layerversion-s3location-key // Key *string `field:"required" json:"key" yaml:"key"` // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-serverless-layerversion-s3location.html#cfn-serverless-layerversion-s3location-version // Version *float64 `field:"optional" json:"version" yaml:"version"` }
Example:
// The code below shows an example of how to instantiate this type. // The values are placeholders you should change. import "github.com/aws/aws-cdk-go/awscdk" s3LocationProperty := &S3LocationProperty{ Bucket: jsii.String("bucket"), Key: jsii.String("key"), // the properties below are optional Version: jsii.Number(123), }
type CfnSimpleTable ¶
type CfnSimpleTable interface { awscdk.CfnResource awscdk.IInspectable awscdk.ITaggable // Options for this resource, such as condition, update policy etc. CfnOptions() awscdk.ICfnResourceOptions CfnProperties() *map[string]interface{} // AWS resource type. CfnResourceType() *string // Returns: 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. CreationStack() *[]*string // 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)`. // // Returns: the logical ID as a stringified token. This value will only get // resolved during synthesis. LogicalId() *string // The tree node. Node() constructs.Node PrimaryKey() interface{} SetPrimaryKey(val interface{}) ProvisionedThroughput() interface{} SetProvisionedThroughput(val interface{}) // 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 })`. Ref() *string SseSpecification() interface{} SetSseSpecification(val interface{}) // The stack in which this element is defined. // // CfnElements must be defined within a stack scope (directly or indirectly). Stack() awscdk.Stack TableName() *string SetTableName(val *string) // Tag Manager which manages the tags for this resource. Tags() awscdk.TagManager TagsRaw() *map[string]*string SetTagsRaw(val *map[string]*string) // Deprecated. // Deprecated: use `updatedProperties` // // Return properties modified after initiation // // Resources that expose mutable properties should override this function to // collect and return the properties object for this resource. UpdatedProperites() *map[string]interface{} // Return properties modified after initiation. // // Resources that expose mutable properties should override this function to // collect and return the properties object for this resource. UpdatedProperties() *map[string]interface{} // Syntactic sugar for `addOverride(path, undefined)`. AddDeletionOverride(path *string) // 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. AddDependency(target awscdk.CfnResource) // Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned. // Deprecated: use addDependency. AddDependsOn(target awscdk.CfnResource) // Add a value to the CloudFormation Resource Metadata. // 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. // AddMetadata(key *string, value interface{}) // Adds an override to the synthesized CloudFormation resource. // // To add a // property override, either use `addPropertyOverride` or prefix `path` 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, // “`typescript // cfnResource.addOverride('Properties.GlobalSecondaryIndexes.0.Projection.NonKeyAttributes', ['myattribute']); // cfnResource.addOverride('Properties.GlobalSecondaryIndexes.1.ProjectionType', 'INCLUDE'); // “` // would add the overrides // “`json // "Properties": { // "GlobalSecondaryIndexes": [ // { // "Projection": { // "NonKeyAttributes": [ "myattribute" ] // ... // } // ... // }, // { // "ProjectionType": "INCLUDE" // ... // }, // ] // ... // } // “` // // The `value` argument to `addOverride` 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. AddOverride(path *string, value interface{}) // Adds an override that deletes the value of a property from the resource definition. AddPropertyDeletionOverride(propertyPath *string) // Adds an override to a resource property. // // Syntactic sugar for `addOverride("Properties.<...>", value)`. AddPropertyOverride(propertyPath *string, value interface{}) // 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`). In some // cases, a snapshot can be taken of the resource prior to deletion // (`RemovalPolicy.SNAPSHOT`). A list of resources that support this policy // can be found in the following link:. // See: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-attribute-deletionpolicy.html#aws-attribute-deletionpolicy-options // ApplyRemovalPolicy(policy awscdk.RemovalPolicy, options *awscdk.RemovalPolicyOptions) // 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. GetAtt(attributeName *string, typeHint awscdk.ResolutionTypeHint) awscdk.Reference // Retrieve a value value from the CloudFormation Resource Metadata. // 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. // GetMetadata(key *string) interface{} // Examines the CloudFormation resource and discloses attributes. Inspect(inspector awscdk.TreeInspector) // Retrieves an array of resources this resource depends on. // // This assembles dependencies on resources across stacks (including nested stacks) // automatically. ObtainDependencies() *[]interface{} // Get a shallow copy of dependencies between this resource and other resources in the same stack. ObtainResourceDependencies() *[]awscdk.CfnResource // Overrides the auto-generated logical ID with a specific ID. OverrideLogicalId(newLogicalId *string) // Indicates that this resource no longer depends on another resource. // // This can be used for resources across stacks (including nested stacks) // and the dependency will automatically be removed from the relevant scope. RemoveDependency(target awscdk.CfnResource) RenderProperties(props *map[string]interface{}) *map[string]interface{} // Replaces one dependency with another. ReplaceDependency(target awscdk.CfnResource, newTarget awscdk.CfnResource) // Can be overridden by subclasses to determine if this resource will be rendered into the cloudformation template. // // Returns: `true` if the resource should be included or `false` is the resource // should be omitted. ShouldSynthesize() *bool // Returns a string representation of this construct. // // Returns: a string representation of this resource. ToString() *string ValidateProperties(_properties interface{}) }
Definition of AWS::Serverless::SimpleTable.
Example:
// The code below shows an example of how to instantiate this type. // The values are placeholders you should change. import "github.com/aws/aws-cdk-go/awscdk" cfnSimpleTable := awscdk.Aws_sam.NewCfnSimpleTable(this, jsii.String("MyCfnSimpleTable"), &CfnSimpleTableProps{ PrimaryKey: &PrimaryKeyProperty{ Type: jsii.String("type"), // the properties below are optional Name: jsii.String("name"), }, ProvisionedThroughput: &ProvisionedThroughputProperty{ WriteCapacityUnits: jsii.Number(123), // the properties below are optional ReadCapacityUnits: jsii.Number(123), }, SseSpecification: &SSESpecificationProperty{ SseEnabled: jsii.Boolean(false), }, TableName: jsii.String("tableName"), Tags: map[string]*string{ "tagsKey": jsii.String("tags"), }, })
func NewCfnSimpleTable ¶
func NewCfnSimpleTable(scope constructs.Construct, id *string, props *CfnSimpleTableProps) CfnSimpleTable
type CfnSimpleTableProps ¶
type CfnSimpleTableProps struct { // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-serverless-simpletable.html#cfn-serverless-simpletable-primarykey // PrimaryKey interface{} `field:"optional" json:"primaryKey" yaml:"primaryKey"` // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-serverless-simpletable.html#cfn-serverless-simpletable-provisionedthroughput // ProvisionedThroughput interface{} `field:"optional" json:"provisionedThroughput" yaml:"provisionedThroughput"` // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-serverless-simpletable.html#cfn-serverless-simpletable-ssespecification // SseSpecification interface{} `field:"optional" json:"sseSpecification" yaml:"sseSpecification"` // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-serverless-simpletable.html#cfn-serverless-simpletable-tablename // TableName *string `field:"optional" json:"tableName" yaml:"tableName"` // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-serverless-simpletable.html#cfn-serverless-simpletable-tags // Tags *map[string]*string `field:"optional" json:"tags" yaml:"tags"` }
Properties for defining a `CfnSimpleTable`.
Example:
// The code below shows an example of how to instantiate this type. // The values are placeholders you should change. import "github.com/aws/aws-cdk-go/awscdk" cfnSimpleTableProps := &CfnSimpleTableProps{ PrimaryKey: &PrimaryKeyProperty{ Type: jsii.String("type"), // the properties below are optional Name: jsii.String("name"), }, ProvisionedThroughput: &ProvisionedThroughputProperty{ WriteCapacityUnits: jsii.Number(123), // the properties below are optional ReadCapacityUnits: jsii.Number(123), }, SseSpecification: &SSESpecificationProperty{ SseEnabled: jsii.Boolean(false), }, TableName: jsii.String("tableName"), Tags: map[string]*string{ "tagsKey": jsii.String("tags"), }, }
type CfnSimpleTable_PrimaryKeyProperty ¶
type CfnSimpleTable_PrimaryKeyProperty struct { // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-serverless-simpletable-primarykey.html#cfn-serverless-simpletable-primarykey-type // Type *string `field:"required" json:"type" yaml:"type"` // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-serverless-simpletable-primarykey.html#cfn-serverless-simpletable-primarykey-name // Name *string `field:"optional" json:"name" yaml:"name"` }
Example:
// The code below shows an example of how to instantiate this type. // The values are placeholders you should change. import "github.com/aws/aws-cdk-go/awscdk" primaryKeyProperty := &PrimaryKeyProperty{ Type: jsii.String("type"), // the properties below are optional Name: jsii.String("name"), }
type CfnSimpleTable_ProvisionedThroughputProperty ¶
type CfnSimpleTable_ProvisionedThroughputProperty struct { // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-serverless-simpletable-provisionedthroughput.html#cfn-serverless-simpletable-provisionedthroughput-writecapacityunits // WriteCapacityUnits *float64 `field:"required" json:"writeCapacityUnits" yaml:"writeCapacityUnits"` // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-serverless-simpletable-provisionedthroughput.html#cfn-serverless-simpletable-provisionedthroughput-readcapacityunits // ReadCapacityUnits *float64 `field:"optional" json:"readCapacityUnits" yaml:"readCapacityUnits"` }
Example:
// The code below shows an example of how to instantiate this type. // The values are placeholders you should change. import "github.com/aws/aws-cdk-go/awscdk" provisionedThroughputProperty := &ProvisionedThroughputProperty{ WriteCapacityUnits: jsii.Number(123), // the properties below are optional ReadCapacityUnits: jsii.Number(123), }
type CfnSimpleTable_SSESpecificationProperty ¶
type CfnSimpleTable_SSESpecificationProperty struct { // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-serverless-simpletable-ssespecification.html#cfn-serverless-simpletable-ssespecification-sseenabled // SseEnabled interface{} `field:"optional" json:"sseEnabled" yaml:"sseEnabled"` }
Example:
// The code below shows an example of how to instantiate this type. // The values are placeholders you should change. import "github.com/aws/aws-cdk-go/awscdk" sSESpecificationProperty := &SSESpecificationProperty{ SseEnabled: jsii.Boolean(false), }
type CfnStateMachine ¶
type CfnStateMachine interface { awscdk.CfnResource awscdk.IInspectable awscdk.ITaggable // Options for this resource, such as condition, update policy etc. CfnOptions() awscdk.ICfnResourceOptions CfnProperties() *map[string]interface{} // AWS resource type. CfnResourceType() *string // Returns: 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. CreationStack() *[]*string Definition() interface{} SetDefinition(val interface{}) DefinitionSubstitutions() interface{} SetDefinitionSubstitutions(val interface{}) DefinitionUri() interface{} SetDefinitionUri(val interface{}) Events() interface{} SetEvents(val interface{}) Logging() interface{} SetLogging(val interface{}) // 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)`. // // Returns: the logical ID as a stringified token. This value will only get // resolved during synthesis. LogicalId() *string Name() *string SetName(val *string) // The tree node. Node() constructs.Node PermissionsBoundaries() *string SetPermissionsBoundaries(val *string) Policies() interface{} SetPolicies(val interface{}) // 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 })`. Ref() *string Role() *string SetRole(val *string) // The stack in which this element is defined. // // CfnElements must be defined within a stack scope (directly or indirectly). Stack() awscdk.Stack // Tag Manager which manages the tags for this resource. Tags() awscdk.TagManager TagsRaw() *map[string]*string SetTagsRaw(val *map[string]*string) Tracing() interface{} SetTracing(val interface{}) Type() *string SetType(val *string) // Deprecated. // Deprecated: use `updatedProperties` // // Return properties modified after initiation // // Resources that expose mutable properties should override this function to // collect and return the properties object for this resource. UpdatedProperites() *map[string]interface{} // Return properties modified after initiation. // // Resources that expose mutable properties should override this function to // collect and return the properties object for this resource. UpdatedProperties() *map[string]interface{} // Syntactic sugar for `addOverride(path, undefined)`. AddDeletionOverride(path *string) // 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. AddDependency(target awscdk.CfnResource) // Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned. // Deprecated: use addDependency. AddDependsOn(target awscdk.CfnResource) // Add a value to the CloudFormation Resource Metadata. // 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. // AddMetadata(key *string, value interface{}) // Adds an override to the synthesized CloudFormation resource. // // To add a // property override, either use `addPropertyOverride` or prefix `path` 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, // “`typescript // cfnResource.addOverride('Properties.GlobalSecondaryIndexes.0.Projection.NonKeyAttributes', ['myattribute']); // cfnResource.addOverride('Properties.GlobalSecondaryIndexes.1.ProjectionType', 'INCLUDE'); // “` // would add the overrides // “`json // "Properties": { // "GlobalSecondaryIndexes": [ // { // "Projection": { // "NonKeyAttributes": [ "myattribute" ] // ... // } // ... // }, // { // "ProjectionType": "INCLUDE" // ... // }, // ] // ... // } // “` // // The `value` argument to `addOverride` 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. AddOverride(path *string, value interface{}) // Adds an override that deletes the value of a property from the resource definition. AddPropertyDeletionOverride(propertyPath *string) // Adds an override to a resource property. // // Syntactic sugar for `addOverride("Properties.<...>", value)`. AddPropertyOverride(propertyPath *string, value interface{}) // 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`). In some // cases, a snapshot can be taken of the resource prior to deletion // (`RemovalPolicy.SNAPSHOT`). A list of resources that support this policy // can be found in the following link:. // See: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-attribute-deletionpolicy.html#aws-attribute-deletionpolicy-options // ApplyRemovalPolicy(policy awscdk.RemovalPolicy, options *awscdk.RemovalPolicyOptions) // 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. GetAtt(attributeName *string, typeHint awscdk.ResolutionTypeHint) awscdk.Reference // Retrieve a value value from the CloudFormation Resource Metadata. // 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. // GetMetadata(key *string) interface{} // Examines the CloudFormation resource and discloses attributes. Inspect(inspector awscdk.TreeInspector) // Retrieves an array of resources this resource depends on. // // This assembles dependencies on resources across stacks (including nested stacks) // automatically. ObtainDependencies() *[]interface{} // Get a shallow copy of dependencies between this resource and other resources in the same stack. ObtainResourceDependencies() *[]awscdk.CfnResource // Overrides the auto-generated logical ID with a specific ID. OverrideLogicalId(newLogicalId *string) // Indicates that this resource no longer depends on another resource. // // This can be used for resources across stacks (including nested stacks) // and the dependency will automatically be removed from the relevant scope. RemoveDependency(target awscdk.CfnResource) RenderProperties(props *map[string]interface{}) *map[string]interface{} // Replaces one dependency with another. ReplaceDependency(target awscdk.CfnResource, newTarget awscdk.CfnResource) // Can be overridden by subclasses to determine if this resource will be rendered into the cloudformation template. // // Returns: `true` if the resource should be included or `false` is the resource // should be omitted. ShouldSynthesize() *bool // Returns a string representation of this construct. // // Returns: a string representation of this resource. ToString() *string ValidateProperties(_properties interface{}) }
Definition of AWS::Serverless::StateMachine.
Example:
// The code below shows an example of how to instantiate this type. // The values are placeholders you should change. import "github.com/aws/aws-cdk-go/awscdk" var definition interface{} cfnStateMachine := awscdk.Aws_sam.NewCfnStateMachine(this, jsii.String("MyCfnStateMachine"), &CfnStateMachineProps{ Definition: definition, DefinitionSubstitutions: map[string]*string{ "definitionSubstitutionsKey": jsii.String("definitionSubstitutions"), }, DefinitionUri: jsii.String("definitionUri"), Events: map[string]interface{}{ "eventsKey": &EventSourceProperty{ "properties": &ApiEventProperty{ "method": jsii.String("method"), "path": jsii.String("path"), // the properties below are optional "restApiId": jsii.String("restApiId"), }, "type": jsii.String("type"), }, }, Logging: &LoggingConfigurationProperty{ Destinations: []interface{}{ &LogDestinationProperty{ CloudWatchLogsLogGroup: &CloudWatchLogsLogGroupProperty{ LogGroupArn: jsii.String("logGroupArn"), }, }, }, IncludeExecutionData: jsii.Boolean(false), Level: jsii.String("level"), }, Name: jsii.String("name"), PermissionsBoundaries: jsii.String("permissionsBoundaries"), Policies: jsii.String("policies"), Role: jsii.String("role"), Tags: map[string]*string{ "tagsKey": jsii.String("tags"), }, Tracing: &TracingConfigurationProperty{ Enabled: jsii.Boolean(false), }, Type: jsii.String("type"), })
func NewCfnStateMachine ¶
func NewCfnStateMachine(scope constructs.Construct, id *string, props *CfnStateMachineProps) CfnStateMachine
type CfnStateMachineProps ¶
type CfnStateMachineProps struct { // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-serverless-statemachine.html#cfn-serverless-statemachine-definition // Definition interface{} `field:"optional" json:"definition" yaml:"definition"` // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-serverless-statemachine.html#cfn-serverless-statemachine-definitionsubstitutions // DefinitionSubstitutions interface{} `field:"optional" json:"definitionSubstitutions" yaml:"definitionSubstitutions"` // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-serverless-statemachine.html#cfn-serverless-statemachine-definitionuri // DefinitionUri interface{} `field:"optional" json:"definitionUri" yaml:"definitionUri"` // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-serverless-statemachine.html#cfn-serverless-statemachine-events // Events interface{} `field:"optional" json:"events" yaml:"events"` // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-serverless-statemachine.html#cfn-serverless-statemachine-logging // Logging interface{} `field:"optional" json:"logging" yaml:"logging"` // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-serverless-statemachine.html#cfn-serverless-statemachine-name // Name *string `field:"optional" json:"name" yaml:"name"` // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-serverless-statemachine.html#cfn-serverless-statemachine-permissionsboundaries // PermissionsBoundaries *string `field:"optional" json:"permissionsBoundaries" yaml:"permissionsBoundaries"` // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-serverless-statemachine.html#cfn-serverless-statemachine-policies // Policies interface{} `field:"optional" json:"policies" yaml:"policies"` // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-serverless-statemachine.html#cfn-serverless-statemachine-role // Role *string `field:"optional" json:"role" yaml:"role"` // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-serverless-statemachine.html#cfn-serverless-statemachine-tags // Tags *map[string]*string `field:"optional" json:"tags" yaml:"tags"` // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-serverless-statemachine.html#cfn-serverless-statemachine-tracing // Tracing interface{} `field:"optional" json:"tracing" yaml:"tracing"` // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-serverless-statemachine.html#cfn-serverless-statemachine-type // Type *string `field:"optional" json:"type" yaml:"type"` }
Properties for defining a `CfnStateMachine`.
Example:
// The code below shows an example of how to instantiate this type. // The values are placeholders you should change. import "github.com/aws/aws-cdk-go/awscdk" var definition interface{} cfnStateMachineProps := &CfnStateMachineProps{ Definition: definition, DefinitionSubstitutions: map[string]*string{ "definitionSubstitutionsKey": jsii.String("definitionSubstitutions"), }, DefinitionUri: jsii.String("definitionUri"), Events: map[string]interface{}{ "eventsKey": &EventSourceProperty{ "properties": &ApiEventProperty{ "method": jsii.String("method"), "path": jsii.String("path"), // the properties below are optional "restApiId": jsii.String("restApiId"), }, "type": jsii.String("type"), }, }, Logging: &LoggingConfigurationProperty{ Destinations: []interface{}{ &LogDestinationProperty{ CloudWatchLogsLogGroup: &CloudWatchLogsLogGroupProperty{ LogGroupArn: jsii.String("logGroupArn"), }, }, }, IncludeExecutionData: jsii.Boolean(false), Level: jsii.String("level"), }, Name: jsii.String("name"), PermissionsBoundaries: jsii.String("permissionsBoundaries"), Policies: jsii.String("policies"), Role: jsii.String("role"), Tags: map[string]*string{ "tagsKey": jsii.String("tags"), }, Tracing: &TracingConfigurationProperty{ Enabled: jsii.Boolean(false), }, Type: jsii.String("type"), }
type CfnStateMachine_ApiEventProperty ¶
type CfnStateMachine_ApiEventProperty struct { // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-serverless-statemachine-apievent.html#cfn-serverless-statemachine-apievent-method // Method *string `field:"required" json:"method" yaml:"method"` // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-serverless-statemachine-apievent.html#cfn-serverless-statemachine-apievent-path // Path *string `field:"required" json:"path" yaml:"path"` // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-serverless-statemachine-apievent.html#cfn-serverless-statemachine-apievent-restapiid // RestApiId *string `field:"optional" json:"restApiId" yaml:"restApiId"` }
Example:
// The code below shows an example of how to instantiate this type. // The values are placeholders you should change. import "github.com/aws/aws-cdk-go/awscdk" apiEventProperty := &ApiEventProperty{ Method: jsii.String("method"), Path: jsii.String("path"), // the properties below are optional RestApiId: jsii.String("restApiId"), }
type CfnStateMachine_CloudWatchEventEventProperty ¶
type CfnStateMachine_CloudWatchEventEventProperty struct { // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-serverless-statemachine-cloudwatcheventevent.html#cfn-serverless-statemachine-cloudwatcheventevent-pattern // Pattern interface{} `field:"required" json:"pattern" yaml:"pattern"` // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-serverless-statemachine-cloudwatcheventevent.html#cfn-serverless-statemachine-cloudwatcheventevent-eventbusname // EventBusName *string `field:"optional" json:"eventBusName" yaml:"eventBusName"` // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-serverless-statemachine-cloudwatcheventevent.html#cfn-serverless-statemachine-cloudwatcheventevent-input // Input *string `field:"optional" json:"input" yaml:"input"` // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-serverless-statemachine-cloudwatcheventevent.html#cfn-serverless-statemachine-cloudwatcheventevent-inputpath // InputPath *string `field:"optional" json:"inputPath" yaml:"inputPath"` }
Example:
// The code below shows an example of how to instantiate this type. // The values are placeholders you should change. import "github.com/aws/aws-cdk-go/awscdk" var pattern interface{} cloudWatchEventEventProperty := &CloudWatchEventEventProperty{ Pattern: pattern, // the properties below are optional EventBusName: jsii.String("eventBusName"), Input: jsii.String("input"), InputPath: jsii.String("inputPath"), }
type CfnStateMachine_CloudWatchLogsLogGroupProperty ¶
type CfnStateMachine_CloudWatchLogsLogGroupProperty struct { // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-serverless-statemachine-cloudwatchlogsloggroup.html#cfn-serverless-statemachine-cloudwatchlogsloggroup-loggrouparn // LogGroupArn *string `field:"required" json:"logGroupArn" yaml:"logGroupArn"` }
Example:
// The code below shows an example of how to instantiate this type. // The values are placeholders you should change. import "github.com/aws/aws-cdk-go/awscdk" cloudWatchLogsLogGroupProperty := &CloudWatchLogsLogGroupProperty{ LogGroupArn: jsii.String("logGroupArn"), }
type CfnStateMachine_EventBridgeRuleEventProperty ¶
type CfnStateMachine_EventBridgeRuleEventProperty struct { // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-serverless-statemachine-eventbridgeruleevent.html#cfn-serverless-statemachine-eventbridgeruleevent-pattern // Pattern interface{} `field:"required" json:"pattern" yaml:"pattern"` // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-serverless-statemachine-eventbridgeruleevent.html#cfn-serverless-statemachine-eventbridgeruleevent-eventbusname // EventBusName *string `field:"optional" json:"eventBusName" yaml:"eventBusName"` // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-serverless-statemachine-eventbridgeruleevent.html#cfn-serverless-statemachine-eventbridgeruleevent-input // Input *string `field:"optional" json:"input" yaml:"input"` // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-serverless-statemachine-eventbridgeruleevent.html#cfn-serverless-statemachine-eventbridgeruleevent-inputpath // InputPath *string `field:"optional" json:"inputPath" yaml:"inputPath"` }
Example:
// The code below shows an example of how to instantiate this type. // The values are placeholders you should change. import "github.com/aws/aws-cdk-go/awscdk" var pattern interface{} eventBridgeRuleEventProperty := &EventBridgeRuleEventProperty{ Pattern: pattern, // the properties below are optional EventBusName: jsii.String("eventBusName"), Input: jsii.String("input"), InputPath: jsii.String("inputPath"), }
type CfnStateMachine_EventSourceProperty ¶
type CfnStateMachine_EventSourceProperty struct { // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-serverless-statemachine-eventsource.html#cfn-serverless-statemachine-eventsource-properties // Properties interface{} `field:"required" json:"properties" yaml:"properties"` // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-serverless-statemachine-eventsource.html#cfn-serverless-statemachine-eventsource-type // Type *string `field:"required" json:"type" yaml:"type"` }
Example:
// The code below shows an example of how to instantiate this type. // The values are placeholders you should change. import "github.com/aws/aws-cdk-go/awscdk" eventSourceProperty := &EventSourceProperty{ Properties: &ApiEventProperty{ Method: jsii.String("method"), Path: jsii.String("path"), // the properties below are optional RestApiId: jsii.String("restApiId"), }, Type: jsii.String("type"), }
type CfnStateMachine_FunctionSAMPTProperty ¶
type CfnStateMachine_FunctionSAMPTProperty struct { // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-serverless-statemachine-functionsampt.html#cfn-serverless-statemachine-functionsampt-functionname // FunctionName *string `field:"required" json:"functionName" yaml:"functionName"` }
Example:
// The code below shows an example of how to instantiate this type. // The values are placeholders you should change. import "github.com/aws/aws-cdk-go/awscdk" functionSAMPTProperty := &FunctionSAMPTProperty{ FunctionName: jsii.String("functionName"), }
type CfnStateMachine_IAMPolicyDocumentProperty ¶
type CfnStateMachine_IAMPolicyDocumentProperty struct { // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-serverless-statemachine-iampolicydocument.html#cfn-serverless-statemachine-iampolicydocument-statement // Statement interface{} `field:"required" json:"statement" yaml:"statement"` // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-serverless-statemachine-iampolicydocument.html#cfn-serverless-statemachine-iampolicydocument-version // Version *string `field:"required" json:"version" yaml:"version"` }
Example:
// The code below shows an example of how to instantiate this type. // The values are placeholders you should change. import "github.com/aws/aws-cdk-go/awscdk" var statement interface{} iAMPolicyDocumentProperty := map[string]interface{}{ "statement": statement, "version": jsii.String("version"), }
type CfnStateMachine_LogDestinationProperty ¶
type CfnStateMachine_LogDestinationProperty struct { // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-serverless-statemachine-logdestination.html#cfn-serverless-statemachine-logdestination-cloudwatchlogsloggroup // CloudWatchLogsLogGroup interface{} `field:"required" json:"cloudWatchLogsLogGroup" yaml:"cloudWatchLogsLogGroup"` }
Example:
// The code below shows an example of how to instantiate this type. // The values are placeholders you should change. import "github.com/aws/aws-cdk-go/awscdk" logDestinationProperty := &LogDestinationProperty{ CloudWatchLogsLogGroup: &CloudWatchLogsLogGroupProperty{ LogGroupArn: jsii.String("logGroupArn"), }, }
type CfnStateMachine_LoggingConfigurationProperty ¶
type CfnStateMachine_LoggingConfigurationProperty struct { // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-serverless-statemachine-loggingconfiguration.html#cfn-serverless-statemachine-loggingconfiguration-destinations // Destinations interface{} `field:"required" json:"destinations" yaml:"destinations"` // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-serverless-statemachine-loggingconfiguration.html#cfn-serverless-statemachine-loggingconfiguration-includeexecutiondata // IncludeExecutionData interface{} `field:"required" json:"includeExecutionData" yaml:"includeExecutionData"` // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-serverless-statemachine-loggingconfiguration.html#cfn-serverless-statemachine-loggingconfiguration-level // Level *string `field:"required" json:"level" yaml:"level"` }
Example:
// The code below shows an example of how to instantiate this type. // The values are placeholders you should change. import "github.com/aws/aws-cdk-go/awscdk" loggingConfigurationProperty := &LoggingConfigurationProperty{ Destinations: []interface{}{ &LogDestinationProperty{ CloudWatchLogsLogGroup: &CloudWatchLogsLogGroupProperty{ LogGroupArn: jsii.String("logGroupArn"), }, }, }, IncludeExecutionData: jsii.Boolean(false), Level: jsii.String("level"), }
type CfnStateMachine_S3LocationProperty ¶
type CfnStateMachine_S3LocationProperty struct { // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-serverless-statemachine-s3location.html#cfn-serverless-statemachine-s3location-bucket // Bucket *string `field:"required" json:"bucket" yaml:"bucket"` // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-serverless-statemachine-s3location.html#cfn-serverless-statemachine-s3location-key // Key *string `field:"required" json:"key" yaml:"key"` // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-serverless-statemachine-s3location.html#cfn-serverless-statemachine-s3location-version // Version *float64 `field:"optional" json:"version" yaml:"version"` }
Example:
// The code below shows an example of how to instantiate this type. // The values are placeholders you should change. import "github.com/aws/aws-cdk-go/awscdk" s3LocationProperty := &S3LocationProperty{ Bucket: jsii.String("bucket"), Key: jsii.String("key"), // the properties below are optional Version: jsii.Number(123), }
type CfnStateMachine_SAMPolicyTemplateProperty ¶
type CfnStateMachine_SAMPolicyTemplateProperty struct { // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-serverless-statemachine-sampolicytemplate.html#cfn-serverless-statemachine-sampolicytemplate-lambdainvokepolicy // LambdaInvokePolicy interface{} `field:"optional" json:"lambdaInvokePolicy" yaml:"lambdaInvokePolicy"` // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-serverless-statemachine-sampolicytemplate.html#cfn-serverless-statemachine-sampolicytemplate-stepfunctionsexecutionpolicy // StepFunctionsExecutionPolicy interface{} `field:"optional" json:"stepFunctionsExecutionPolicy" yaml:"stepFunctionsExecutionPolicy"` }
Example:
// The code below shows an example of how to instantiate this type. // The values are placeholders you should change. import "github.com/aws/aws-cdk-go/awscdk" sAMPolicyTemplateProperty := &SAMPolicyTemplateProperty{ LambdaInvokePolicy: &FunctionSAMPTProperty{ FunctionName: jsii.String("functionName"), }, StepFunctionsExecutionPolicy: &StateMachineSAMPTProperty{ StateMachineName: jsii.String("stateMachineName"), }, }
type CfnStateMachine_ScheduleEventProperty ¶
type CfnStateMachine_ScheduleEventProperty struct { // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-serverless-statemachine-scheduleevent.html#cfn-serverless-statemachine-scheduleevent-schedule // Schedule *string `field:"required" json:"schedule" yaml:"schedule"` // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-serverless-statemachine-scheduleevent.html#cfn-serverless-statemachine-scheduleevent-input // Input *string `field:"optional" json:"input" yaml:"input"` }
Example:
// The code below shows an example of how to instantiate this type. // The values are placeholders you should change. import "github.com/aws/aws-cdk-go/awscdk" scheduleEventProperty := &ScheduleEventProperty{ Schedule: jsii.String("schedule"), // the properties below are optional Input: jsii.String("input"), }
type CfnStateMachine_StateMachineSAMPTProperty ¶
type CfnStateMachine_StateMachineSAMPTProperty struct { // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-serverless-statemachine-statemachinesampt.html#cfn-serverless-statemachine-statemachinesampt-statemachinename // StateMachineName *string `field:"required" json:"stateMachineName" yaml:"stateMachineName"` }
Example:
// The code below shows an example of how to instantiate this type. // The values are placeholders you should change. import "github.com/aws/aws-cdk-go/awscdk" stateMachineSAMPTProperty := &StateMachineSAMPTProperty{ StateMachineName: jsii.String("stateMachineName"), }
type CfnStateMachine_TracingConfigurationProperty ¶
type CfnStateMachine_TracingConfigurationProperty struct { // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-serverless-statemachine-tracingconfiguration.html#cfn-serverless-statemachine-tracingconfiguration-enabled // Enabled interface{} `field:"optional" json:"enabled" yaml:"enabled"` }
Example:
// The code below shows an example of how to instantiate this type. // The values are placeholders you should change. import "github.com/aws/aws-cdk-go/awscdk" tracingConfigurationProperty := &TracingConfigurationProperty{ Enabled: jsii.Boolean(false), }
Source Files
¶
- CfnApi.go
- CfnApiProps.go
- CfnApi_AccessLogSettingProperty.go
- CfnApi_AuthProperty.go
- CfnApi_CanarySettingProperty.go
- CfnApi_CorsConfigurationProperty.go
- CfnApi_DomainConfigurationProperty.go
- CfnApi_EndpointConfigurationProperty.go
- CfnApi_MutualTlsAuthenticationProperty.go
- CfnApi_Route53ConfigurationProperty.go
- CfnApi_S3LocationProperty.go
- CfnApi__checks.go
- CfnApplication.go
- CfnApplicationProps.go
- CfnApplication_ApplicationLocationProperty.go
- CfnApplication__checks.go
- CfnFunction.go
- CfnFunctionProps.go
- CfnFunction_AlexaSkillEventProperty.go
- CfnFunction_ApiEventProperty.go
- CfnFunction_AuthProperty.go
- CfnFunction_AuthResourcePolicyProperty.go
- CfnFunction_BucketSAMPTProperty.go
- CfnFunction_CloudWatchEventEventProperty.go
- CfnFunction_CloudWatchLogsEventProperty.go
- CfnFunction_CognitoEventProperty.go
- CfnFunction_CollectionSAMPTProperty.go
- CfnFunction_DeadLetterQueueProperty.go
- CfnFunction_DeploymentPreferenceProperty.go
- CfnFunction_DestinationConfigProperty.go
- CfnFunction_DestinationProperty.go
- CfnFunction_DomainSAMPTProperty.go
- CfnFunction_DynamoDBEventProperty.go
- CfnFunction_EmptySAMPTProperty.go
- CfnFunction_EventBridgeRuleEventProperty.go
- CfnFunction_EventInvokeConfigProperty.go
- CfnFunction_EventInvokeDestinationConfigProperty.go
- CfnFunction_EventSourceProperty.go
- CfnFunction_FileSystemConfigProperty.go
- CfnFunction_FunctionEnvironmentProperty.go
- CfnFunction_FunctionSAMPTProperty.go
- CfnFunction_HooksProperty.go
- CfnFunction_HttpApiEventProperty.go
- CfnFunction_HttpApiFunctionAuthProperty.go
- CfnFunction_IAMPolicyDocumentProperty.go
- CfnFunction_IdentitySAMPTProperty.go
- CfnFunction_ImageConfigProperty.go
- CfnFunction_IoTRuleEventProperty.go
- CfnFunction_KeySAMPTProperty.go
- CfnFunction_KinesisEventProperty.go
- CfnFunction_LogGroupSAMPTProperty.go
- CfnFunction_ParameterNameSAMPTProperty.go
- CfnFunction_ProvisionedConcurrencyConfigProperty.go
- CfnFunction_QueueSAMPTProperty.go
- CfnFunction_RequestModelProperty.go
- CfnFunction_RequestParameterProperty.go
- CfnFunction_RouteSettingsProperty.go
- CfnFunction_S3EventProperty.go
- CfnFunction_S3KeyFilterProperty.go
- CfnFunction_S3KeyFilterRuleProperty.go
- CfnFunction_S3LocationProperty.go
- CfnFunction_S3NotificationFilterProperty.go
- CfnFunction_SAMPolicyTemplateProperty.go
- CfnFunction_SNSEventProperty.go
- CfnFunction_SQSEventProperty.go
- CfnFunction_ScheduleEventProperty.go
- CfnFunction_SecretArnSAMPTProperty.go
- CfnFunction_StateMachineSAMPTProperty.go
- CfnFunction_StreamSAMPTProperty.go
- CfnFunction_TableSAMPTProperty.go
- CfnFunction_TableStreamSAMPTProperty.go
- CfnFunction_TopicSAMPTProperty.go
- CfnFunction_VpcConfigProperty.go
- CfnFunction__checks.go
- CfnHttpApi.go
- CfnHttpApiProps.go
- CfnHttpApi_AccessLogSettingProperty.go
- CfnHttpApi_CorsConfigurationObjectProperty.go
- CfnHttpApi_HttpApiAuthProperty.go
- CfnHttpApi_HttpApiDomainConfigurationProperty.go
- CfnHttpApi_MutualTlsAuthenticationProperty.go
- CfnHttpApi_Route53ConfigurationProperty.go
- CfnHttpApi_RouteSettingsProperty.go
- CfnHttpApi_S3LocationProperty.go
- CfnHttpApi__checks.go
- CfnLayerVersion.go
- CfnLayerVersionProps.go
- CfnLayerVersion_S3LocationProperty.go
- CfnLayerVersion__checks.go
- CfnSimpleTable.go
- CfnSimpleTableProps.go
- CfnSimpleTable_PrimaryKeyProperty.go
- CfnSimpleTable_ProvisionedThroughputProperty.go
- CfnSimpleTable_SSESpecificationProperty.go
- CfnSimpleTable__checks.go
- CfnStateMachine.go
- CfnStateMachineProps.go
- CfnStateMachine_ApiEventProperty.go
- CfnStateMachine_CloudWatchEventEventProperty.go
- CfnStateMachine_CloudWatchLogsLogGroupProperty.go
- CfnStateMachine_EventBridgeRuleEventProperty.go
- CfnStateMachine_EventSourceProperty.go
- CfnStateMachine_FunctionSAMPTProperty.go
- CfnStateMachine_IAMPolicyDocumentProperty.go
- CfnStateMachine_LogDestinationProperty.go
- CfnStateMachine_LoggingConfigurationProperty.go
- CfnStateMachine_S3LocationProperty.go
- CfnStateMachine_SAMPolicyTemplateProperty.go
- CfnStateMachine_ScheduleEventProperty.go
- CfnStateMachine_StateMachineSAMPTProperty.go
- CfnStateMachine_TracingConfigurationProperty.go
- CfnStateMachine__checks.go
- main.go