

本文属于机器翻译版本。若本译文内容与英语原文存在差异，则一律以英文原文为准。

# AWS::Serverless::NetworkConnector
<a name="sam-resource-networkconnector"></a>

 创建 AWS Lambda 网络连接器，用于定义 Lambda 计算资源的网络连接。网络连接器指定计算资源如何连接到网络，例如，使用服务在指定子网和安全组中配置的弹性网络接口 (ENI) 通过客户 VPC 路由出口流量。

**注意**  
部署到时 AWS CloudFormation， AWS SAM 会将您的 AWS SAM 资源转换为 CloudFormation 资源。有关更多信息，请参阅 [生成 CloudFormation 的资源 AWS SAM](sam-specification-generated-resources.md)。

## 语法
<a name="sam-resource-networkconnector-syntax"></a>

要在 AWS Serverless Application Model (AWS SAM) 模板中声明此实体，请使用以下语法。

### YAML
<a name="sam-resource-networkconnector-syntax.yaml"></a>

```
Type: AWS::Serverless::NetworkConnector
Properties:
  [Name](#sam-networkconnector-name): {{String}}
  [OperatorRole](#sam-networkconnector-operatorrole): {{String}}
  [PropagateTags](#sam-networkconnector-propagatetags): {{Boolean}}
  [Tags](#sam-networkconnector-tags): {{Map}}
  [VpcConfig](#sam-networkconnector-vpcconfig): {{VpcConfig}}
```

## Properties
<a name="sam-resource-networkconnector-properties"></a>

 `Name`   <a name="sam-networkconnector-name"></a>
网络连接器的名称。该名称在您的账户和地区内必须是唯一的。  
*类型*：字符串  
*必需*：否  
*CloudFormation 兼容性*：此属性直接传递给`AWS::Lambda::NetworkConnector`资源的`[Name](https://docs.aws.amazon.com/AWSCloudFormation/latest/TemplateReference/aws-resource-lambda-networkconnector.html#cfn-lambda-networkconnector-name)`属性。

 `OperatorRole`   <a name="sam-networkconnector-operatorrole"></a>
网络连接器服务承担的用于创建和管理弹性网络接口 (ENI) 的 IAM 角色的 ARN。  
*类型*：字符串  
*必需*：否  
*CloudFormation 兼容性*：此属性类似于`AWS::Lambda::NetworkConnector`资源的`[OperatorRole](https://docs.aws.amazon.com/AWSCloudFormation/latest/TemplateReference/aws-resource-lambda-networkconnector.html#cfn-lambda-networkconnector-operatorrole)`属性。这在 CloudFormation 中为必需，但在 AWS SAM中并非必需。如果您未指定角色，则 AWS SAM 创建一个逻辑 ID 为的角色`{{<resource-logical-id>}}OperatorRole`。

 `PropagateTags`   <a name="sam-networkconnector-propagatetags"></a>
指定是否将`Tags`属性中的标签传递给生成的资源，例如自动生成的操作员角色。  
*类型*：布尔值  
*必需*：否  
*默认值*：`False`  
*CloudFormation 兼容性*：此属性是独有的 AWS SAM ，没有 CloudFormation 等效属性。

 `Tags`   <a name="sam-networkconnector-tags"></a>
键值对地图，用于指定添加到此网络连接器的标签。  
*类型*：映射  
*必需*：否  
*CloudFormation 兼容性*：此属性类似于`AWS::Lambda::NetworkConnector`资源的`[Tags](https://docs.aws.amazon.com/AWSCloudFormation/latest/TemplateReference/aws-resource-lambda-networkconnector.html#cfn-lambda-networkconnector-tags)`属性。中的`Tags`属性由键值对 AWS SAM 组成（而 CloudFormation 在此属性中则由`Tag`对象列表组成）。此外，还 AWS SAM 会自动向该网络连接器以及为其生成的默认角色添加`lambda:createdBy:SAM`标签。

 `VpcConfig`   <a name="sam-networkconnector-vpcconfig"></a>
网络连接器的 VPC 出口配置。指定用于通过您的 VPC 路由出站流量的子网、安全组和网络协议。  
*类型*：[VpcConfig](sam-property-networkconnector-vpcconfig.md)  
*是否必需*：是  
*CloudFormation 兼容性*：此`[Configuration.VpcEgressConfiguration](https://docs.aws.amazon.com/AWSCloudFormation/latest/TemplateReference/aws-properties-lambda-networkconnector-vpcegressconfiguration.html)`属性被转换为`AWS::Lambda::NetworkConnector`资源的属性。 AWS SAM 也会`AssociatedComputeResourceTypes: [MicroVm]`自动注入。

## 返回值
<a name="sam-resource-networkconnector-return-values"></a>

### Ref
<a name="sam-resource-networkconnector-return-values-ref"></a>

当向`Ref`内部函数提供此资源的逻辑 ID 时，它将返回网络连接器的 ARN。

有关使用 `Ref` 函数的更多信息，请参阅*《AWS CloudFormation 用户指南》*中的 [https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/intrinsic-function-reference-ref.html](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/intrinsic-function-reference-ref.html)。

### Fn:: GetAtt
<a name="sam-resource-networkconnector-return-values-fn--getatt"></a>

`Fn::GetAtt` 返回一个此类型指定属性的值。以下为可用属性和示例返回值。

有关使用 `Fn::GetAtt` 的更多信息，请参阅*《AWS CloudFormation 用户指南》*中的 [https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/intrinsic-function-reference-getatt.html](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/intrinsic-function-reference-getatt.html)。

`Arn`  <a name="sam-networkconnector-getatt-arn"></a>
网络连接器的亚马逊资源名称 (ARN)。

`State`  <a name="sam-networkconnector-getatt-state"></a>
网络连接器的当前状态。有效值为 `PENDING`、`ACTIVE`、`INACTIVE`、`FAILED`、`DELETING` 和 `DELETE_FAILED`。

## 示例
<a name="sam-resource-networkconnector-examples"></a>

### 具有自动生成角色的基本网络连接器
<a name="sam-resource-networkconnector-example-basic"></a>

以下示例创建一个 VPC 出口网络连接器。 AWS SAM 自动生成操作员角色。

```
AWSTemplateFormatVersion: '2010-09-09'
Transform: AWS::Serverless-2016-10-31

Resources:
  MyVpcConnector:
    Type: AWS::Serverless::NetworkConnector
    Properties:
      Name: my-vpc-connector
      VpcConfig:
        SubnetIds:
          - subnet-0abc123def4567890
          - subnet-0def456abc7890123
        SecurityGroupIds:
          - sg-0abc1234abcde0001
        NetworkProtocol: IPv4
      Tags:
        Environment: Production
```