View a markdown version of this page

AWS::Serverless::NetworkConnector - AWS Serverless Application Model
構文プロパティ戻り値例

翻訳は機械翻訳により提供されています。提供された翻訳内容と英語版の間で齟齬、不一致または矛盾がある場合、英語版が優先します。

AWS::Serverless::NetworkConnector

Lambda コンピューティングリソースのネットワーク接続を定義する AWS Lambda Network Connector を作成します。ネットワークコネクタは、コンピューティングリソースがネットワークに接続する方法を指定します。たとえば、サービスが指定されたサブネットとセキュリティグループでプロビジョニングする Elastic Network Interface (ENIs) を使用して、お客様の VPC 経由で送信トラフィックをルーティングします。

注記

にデプロイすると AWS CloudFormation、 は AWS SAM リソースを CloudFormation リソース AWS SAM に変換します。詳細については、「の生成済み CloudFormation リソース AWS SAM」を参照してください。

構文

AWS Serverless Application Model (AWS SAM) テンプレートでこのエンティティを宣言するには、次の構文を使用します。

YAML

Type: AWS::Serverless::NetworkConnector
Properties:
  Name: String
  OperatorRole: String
  PropagateTags: Boolean
  Tags: Map
  VpcConfig: VpcConfig

プロパティ

Name

ネットワークコネクタの名前。名前はアカウントとリージョン内で一意である必要があります。

タイプ: 文字列

必須: いいえ

CloudFormation 互換性: このプロパティは、 AWS::Lambda::NetworkConnectorリソースの Nameプロパティに直接渡されます。

OperatorRole

Elastic Network Interface (ENIs) を作成および管理するためにネットワークコネクタサービスが引き受ける IAM ロールの ARN。

タイプ: 文字列

必須: いいえ

CloudFormation 互換性: このプロパティは、 AWS::Lambda::NetworkConnectorリソースの OperatorRoleプロパティに似ています。これは、 CloudFormation では必須ですが、 AWS SAMでは必須ではありません。ロールを指定しない場合、 は論理 ID が のロール AWS SAM を作成します<resource-logical-id>OperatorRole。

PropagateTags

自動生成されたオペレータロールなど、 Tagsプロパティから生成されたリソースにタグを渡すかどうかを指定します。

型: ブール

必須: いいえ

デフォルト: False

CloudFormation 互換性: このプロパティは に固有 AWS SAM であり、 CloudFormation 同等のものはありません。

Tags

このネットワークコネクタに追加されたタグを指定するキーと値のペアのマップ。

タイプ: マップ

必須: いいえ

CloudFormation 互換性: このプロパティは、 AWS::Lambda::NetworkConnectorリソースの Tagsプロパティに似ています。の Tagsプロパティ AWS SAM は、キーと値のペアで構成されます ( CloudFormation このプロパティはTagオブジェクトのリストで構成されます）。また、 は、このネットワークコネクタと、それに対して生成されるデフォルトのロールにlambda:createdBy:SAMタグ AWS SAM を自動的に追加します。

VpcConfig

ネットワークコネクタの VPC 出力設定。VPC 経由でアウトバウンドトラフィックをルーティングするためのサブネット、セキュリティグループ、ネットワークプロトコルを指定します。

タイプ: VpcConfig

必須: はい

CloudFormation 互換性: このプロパティは、 AWS::Lambda::NetworkConnectorリソースの Configuration.VpcEgressConfigurationプロパティに変換されます。 AWS SAM もAssociatedComputeResourceTypes: [MicroVm]自動的に挿入します。

戻り値

参照番号

このリソースの論理 ID がRef組み込み関数に提供されると、ネットワークコネクタの ARN が返されます。

Ref 関数の使用方法の詳細については、「AWS CloudFormation ユーザーガイド」の「Ref」を参照してください。

Fn::GetAtt

Fn::GetAtt は、このタイプの指定された属性の値を返します。利用可能な属性とサンプル戻り値は以下のとおりです。

Fn::GetAtt の使用の詳細については、「AWS CloudFormation ユーザーガイド」の「Fn::GetAtt」を参照してください。

Arn

ネットワークコネクタの Amazon リソースネーム (ARN)。

State

ネットワークコネクタの現在の状態。有効な値は、PENDING、ACTIVE、INACTIVE、FAILED、DELETING および DELETE_FAILED です。

例

自動生成されたロールを持つ基本的なネットワークコネクタ

次の例では、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