AWS serverless-application-model documentation change
Summary
Updated documentation to replace 'AWS CloudFormation' with 'CloudFormation' terminology consistently throughout the file
Security assessment
The changes are purely terminological updates (removing 'AWS' prefix from 'CloudFormation'). No security-related content was added, modified, or removed. The updates maintain the same technical meaning without introducing or addressing security considerations.
Diff
diff --git a/serverless-application-model/latest/developerguide/sam-specification-generated-resources-function.md b/serverless-application-model/latest/developerguide/sam-specification-generated-resources-function.md index 7dcbe1e78..c057b83f8 100644 --- a//serverless-application-model/latest/developerguide/sam-specification-generated-resources-function.md +++ b//serverless-application-model/latest/developerguide/sam-specification-generated-resources-function.md @@ -7 +7 @@ Core function propertiesEvent sourcesEvent configuration -# AWS CloudFormation resources generated when AWS::Serverless::Function is specified +# CloudFormation resources generated when AWS::Serverless::Function is specified @@ -9 +9 @@ Core function propertiesEvent sourcesEvent configuration -When an `AWS::Serverless::Function` is specified, AWS Serverless Application Model (AWS SAM) always creates an `AWS::Lambda::Function` base AWS CloudFormation resource. +When an `AWS::Serverless::Function` is specified, AWS Serverless Application Model (AWS SAM) always creates an `AWS::Lambda::Function` base CloudFormation resource. @@ -16 +16 @@ _`LogicalId`: _``<function‑LogicalId>`` -_Referenceable property:_ N/A (you must use the `LogicalId` to reference this AWS CloudFormation resource) +_Referenceable property:_ N/A (you must use the `LogicalId` to reference this CloudFormation resource) @@ -18 +18 @@ _Referenceable property:_ N/A (you must use the `LogicalId` to reference this AW -In addition to this AWS CloudFormation resource, when `AWS::Serverless::Function` is specified, AWS SAM also generates AWS CloudFormation resources for the following scenarios. +In addition to this CloudFormation resource, when `AWS::Serverless::Function` is specified, AWS SAM also generates CloudFormation resources for the following scenarios. @@ -33 +33 @@ In addition to this AWS CloudFormation resource, when `AWS::Serverless::Function -The following scenarios generate AWS CloudFormation resources based on core function properties: +The following scenarios generate CloudFormation resources based on core function properties: @@ -37 +37 @@ The following scenarios generate AWS CloudFormation resources based on core func -When the `Role` property of an `AWS::Serverless::Function` is _not_ specified, AWS SAM generates an `AWS::IAM::Role` AWS CloudFormation resource. +When the `Role` property of an `AWS::Serverless::Function` is _not_ specified, AWS SAM generates an `AWS::IAM::Role` CloudFormation resource. @@ -44 +44 @@ _`LogicalId`: _``<function‑LogicalId>`Role` -_Referenceable property:_ N/A (you must use the `LogicalId` to reference this AWS CloudFormation resource) +_Referenceable property:_ N/A (you must use the `LogicalId` to reference this CloudFormation resource) @@ -48 +48 @@ _Referenceable property:_ N/A (you must use the `LogicalId` to reference this AW -When the `AutoPublishAlias` property of an `AWS::Serverless::Function` is specified, AWS SAM generates the following AWS CloudFormation resources: `AWS::Lambda::Alias` and `AWS::Lambda::Version`. +When the `AutoPublishAlias` property of an `AWS::Serverless::Function` is specified, AWS SAM generates the following CloudFormation resources: `AWS::Lambda::Alias` and `AWS::Lambda::Version`. @@ -72 +72 @@ For additional information on the `AutoPublishAlias` property, see the [Properti -When the `DeploymentPreference` property of an `AWS::Serverless::Function` is specified, AWS SAM generates the following resources AWS CloudFormation resources: `AWS::CodeDeploy::Application` and `AWS::CodeDeploy::DeploymentGroup`. In addition, if the `Role` property of the `DeploymentPreference` object is _not_ specified, AWS SAM also generates an `AWS::IAM::Role` AWS CloudFormation resource. +When the `DeploymentPreference` property of an `AWS::Serverless::Function` is specified, AWS SAM generates the following resources CloudFormation resources: `AWS::CodeDeploy::Application` and `AWS::CodeDeploy::DeploymentGroup`. In addition, if the `Role` property of the `DeploymentPreference` object is _not_ specified, AWS SAM also generates an `AWS::IAM::Role` CloudFormation resource. @@ -79 +79 @@ _`LogicalId`: _`ServerlessDeploymentApplication` -_Referenceable property:_ N/A (you must use the `LogicalId` to reference this AWS CloudFormation resource) +_Referenceable property:_ N/A (you must use the `LogicalId` to reference this CloudFormation resource) @@ -86 +86 @@ _`LogicalId`: _``<function‑LogicalId>`DeploymentGroup` -_Referenceable property:_ N/A (you must use the `LogicalId` to reference this AWS CloudFormation resource) +_Referenceable property:_ N/A (you must use the `LogicalId` to reference this CloudFormation resource) @@ -93 +93 @@ _`LogicalId`: _`CodeDeployServiceRole` -_Referenceable property:_ N/A (you must use the `LogicalId` to reference this AWS CloudFormation resource) +_Referenceable property:_ N/A (you must use the `LogicalId` to reference this CloudFormation resource) @@ -97 +97 @@ _Referenceable property:_ N/A (you must use the `LogicalId` to reference this AW -When the `FunctionUrlConfig` property is specified, AWS SAM generates different AWS CloudFormation resources based on the `AuthType`. +When the `FunctionUrlConfig` property is specified, AWS SAM generates different CloudFormation resources based on the `AuthType`. @@ -99 +99 @@ When the `FunctionUrlConfig` property is specified, AWS SAM generates different -When `AuthType: NONE` is specified, AWS SAM generates the following AWS CloudFormation resources: +When `AuthType: NONE` is specified, AWS SAM generates the following CloudFormation resources: @@ -106 +106 @@ _`LogicalId`: _``<function‑LogicalId>`URLInvokeAllowPublicAccess` -_Referenceable property:_ N/A (you must use the `LogicalId` to reference this AWS CloudFormation resource) +_Referenceable property:_ N/A (you must use the `LogicalId` to reference this CloudFormation resource) @@ -113 +113 @@ _`LogicalId`: _``<function‑LogicalId>`UrlPublicPermissions` -_Referenceable property:_ N/A (you must use the `LogicalId` to reference this AWS CloudFormation resource) +_Referenceable property:_ N/A (you must use the `LogicalId` to reference this CloudFormation resource) @@ -120 +120 @@ _`LogicalId`: _``<function‑LogicalId>`Url` -_Referenceable property:_ N/A (you must use the `LogicalId` to reference this AWS CloudFormation resource) +_Referenceable property:_ N/A (you must use the `LogicalId` to reference this CloudFormation resource) @@ -129 +129 @@ _`LogicalId`: _``<function‑LogicalId>`Url` -_Referenceable property:_ N/A (you must use the `LogicalId` to reference this AWS CloudFormation resource) +_Referenceable property:_ N/A (you must use the `LogicalId` to reference this CloudFormation resource) @@ -135 +135 @@ For additional information on the `FunctionUrlConfig` property, see [FunctionUrl -The following scenarios generate AWS CloudFormation resources based on event sources: +The following scenarios generate CloudFormation resources based on event sources: @@ -139 +139 @@ The following scenarios generate AWS CloudFormation resources based on event sou -When the `Event` property of an `AWS::Serverless::Function` is set to `Api`, but the `RestApiId` property is _not_ specified, AWS SAM generates the `AWS::ApiGateway::RestApi` AWS CloudFormation resource. +When the `Event` property of an `AWS::Serverless::Function` is set to `Api`, but the `RestApiId` property is _not_ specified, AWS SAM generates the `AWS::ApiGateway::RestApi` CloudFormation resource. @@ -146 +146 @@ _`LogicalId`: _`ServerlessRestApi` -_Referenceable property:_ N/A (you must use the `LogicalId` to reference this AWS CloudFormation resource) +_Referenceable property:_ N/A (you must use the `LogicalId` to reference this CloudFormation resource) @@ -150 +150 @@ _Referenceable property:_ N/A (you must use the `LogicalId` to reference this AW -When the `Event` property of an `AWS::Serverless::Function` is set to `HttpApi`, but the `ApiId` property is _not_ specified, AWS SAM generates the `AWS::ApiGatewayV2::Api` AWS CloudFormation resource. +When the `Event` property of an `AWS::Serverless::Function` is set to `HttpApi`, but the `ApiId` property is _not_ specified, AWS SAM generates the `AWS::ApiGatewayV2::Api` CloudFormation resource. @@ -157 +157 @@ _`LogicalId`: _`ServerlessHttpApi` -_Referenceable property:_ N/A (you must use the `LogicalId` to reference this AWS CloudFormation resource) +_Referenceable property:_ N/A (you must use the `LogicalId` to reference this CloudFormation resource) @@ -161 +161 @@ _Referenceable property:_ N/A (you must use the `LogicalId` to reference this AW -When the `Event` property of an `AWS::Serverless::Function` is set to one of the streaming types, AWS SAM generates the `AWS::Lambda::EventSourceMapping` AWS CloudFormation resource. This applies to the following types: `DynamoDB`, `Kinesis`, `MQ`, `MSK`, and `SQS`. +When the `Event` property of an `AWS::Serverless::Function` is set to one of the streaming types, AWS SAM generates the `AWS::Lambda::EventSourceMapping` CloudFormation resource. This applies to the following types: `DynamoDB`, `Kinesis`, `MQ`, `MSK`, and `SQS`. @@ -168 +168 @@ _`LogicalId`: _``<function‑LogicalId><event‑LogicalId>`` -_Referenceable property:_ N/A (you must use the `LogicalId` to reference this AWS CloudFormation resource) +_Referenceable property:_ N/A (you must use the `LogicalId` to reference this CloudFormation resource) @@ -172 +172 @@ _Referenceable property:_ N/A (you must use the `LogicalId` to reference this AW -When the `Event` property of an `AWS::Serverless::Function` is set to one of the event bridge (or event bus) types, AWS SAM generates the `AWS::Events::Rule` AWS CloudFormation resource. This applies to the following types: `EventBridgeRule`, `Schedule`, and `CloudWatchEvents`. +When the `Event` property of an `AWS::Serverless::Function` is set to one of the event bridge (or event bus) types, AWS SAM generates the `AWS::Events::Rule` CloudFormation resource. This applies to the following types: `EventBridgeRule`, `Schedule`, and `CloudWatchEvents`. @@ -179 +179 @@ _`LogicalId`: _``<function‑LogicalId><event‑LogicalId>`` -_Referenceable property:_ N/A (you must use the `LogicalId` to reference this AWS CloudFormation resource) +_Referenceable property:_ N/A (you must use the `LogicalId` to reference this CloudFormation resource) @@ -183 +183 @@ _Referenceable property:_ N/A (you must use the `LogicalId` to reference this AW -When the `Event` property of an `AWS::Serverless::Function` is set to IoTRule, AWS SAM generates the `AWS::IoT::TopicRule` AWS CloudFormation resource. +When the `Event` property of an `AWS::Serverless::Function` is set to IoTRule, AWS SAM generates the `AWS::IoT::TopicRule` CloudFormation resource. @@ -190 +190 @@ _`LogicalId`: _``<function‑LogicalId><event‑LogicalId>`` -_Referenceable property:_ N/A (you must use the `LogicalId` to reference this AWS CloudFormation resource) +_Referenceable property:_ N/A (you must use the `LogicalId` to reference this CloudFormation resource) @@ -194 +194 @@ _Referenceable property:_ N/A (you must use the `LogicalId` to reference this AW -The following scenarios generate AWS CloudFormation resources based on event configuration: +The following scenarios generate CloudFormation resources based on event configuration: @@ -198 +198 @@ The following scenarios generate AWS CloudFormation resources based on event con -When the `OnSuccess` (or `OnFailure`) property of the `DestinationConfig` property of the `EventInvokeConfig` property of an `AWS::Serverless::Function` is specified, and the destination type is `SNS` but the destination ARN is _not_ specified, AWS SAM generates the following AWS CloudFormation resources: `AWS::Lambda::EventInvokeConfig` and `AWS::SNS::Topic`. +When the `OnSuccess` (or `OnFailure`) property of the `DestinationConfig` property of the `EventInvokeConfig` property of an `AWS::Serverless::Function` is specified, and the destination type is `SNS` but the destination ARN is _not_ specified, AWS SAM generates the following CloudFormation resources: `AWS::Lambda::EventInvokeConfig` and `AWS::SNS::Topic`. @@ -205 +205 @@ _`LogicalId`: _``<function‑LogicalId>`EventInvokeConfig` -_Referenceable property:_ N/A (you must use the `LogicalId` to reference this AWS CloudFormation resource) +_Referenceable property:_ N/A (you must use the `LogicalId` to reference this CloudFormation resource) @@ -218 +218 @@ If both `OnSuccess` and `OnFailure` are specified for an Amazon SNS event, to di -When the `OnSuccess` (or `OnFailure`) property of the `DestinationConfig` property of the `EventInvokeConfig` property of an `AWS::Serverless::Function` is specified, and the destination type is `SQS` but the destination ARN is _not_ specified, AWS SAM generates the following AWS CloudFormation resources: `AWS::Lambda::EventInvokeConfig` and `AWS::SQS::Queue`. +When the `OnSuccess` (or `OnFailure`) property of the `DestinationConfig` property of the `EventInvokeConfig` property of an `AWS::Serverless::Function` is specified, and the destination type is `SQS` but the destination ARN is _not_ specified, AWS SAM generates the following CloudFormation resources: `AWS::Lambda::EventInvokeConfig` and `AWS::SQS::Queue`. @@ -225 +225 @@ _`LogicalId`: _``<function‑LogicalId>`EventInvokeConfig` -_Referenceable property:_ N/A (you must use the `LogicalId` to reference this AWS CloudFormation resource) +_Referenceable property:_ N/A (you must use the `LogicalId` to reference this CloudFormation resource)