如何在Cloudformation中获取区域AWS API网关的自定义域的目标域名?

时间:2018-01-31 00:53:29

标签: amazon-web-services aws-api-gateway amazon-cloudformation serverless-framework regional

我试图在AWS上创建一个多区域无服务器应用程序。我已按照here给出的说明进行操作。我使用的是无服务器框架,它使用Cloudformation脚本在AWS上创建所有资源。

我想为API网关创建一个自定义域作为区域端点。创建区域端点时,它会生成目标域。我想知道如何在Cloudformation脚本中获取目标域的值?

当我创建Edge优化端点时,我使用DistributionDomainName属性获取CloudFront部署的值。但是,在创建区域端点时,我看不到目标域名的任何属性。我尝试使用DistributionDomainName属性作为区域端点,但它会抛出一个错误,表示没有DistributionDomainName

以下是我脚本的一部分 -

# Creates a custom domain for the ApiGateway
customDomain:
  Type: 'AWS::ApiGateway::DomainName'
  Properties:
    DomainName: ${self:custom.domain}
    EndpointConfiguration:
      Types:
        - REGIONAL
    RegionalCertificateArn: ${self:custom.certificateArn}

# Insert a DNS record in route53 hosted zone to redirect from the custom domain to CF distribution
dnsRecord:
  Type: AWS::Route53::RecordSet
  Properties:
    Region: ${self:provider.region}
    SetIdentifier: ${self:provider.region}
    HostedZoneId: ${self:custom.hostedZoneId}
    Name: ${self:custom.domain}
    Type: CNAME
    TTL: 60
    ResourceRecords:
      - "Fn::GetAtt": [customDomain, DistributionDomainName]

请帮忙。谢谢!

更新

Cloudformation现在通过RegionalDomainName属性返回区域域名。它可以用作Fn:GetAtt : [customDomain, RegionalDomainName]

2 个答案:

答案 0 :(得分:5)

目前无法做到这一点。

正如您所提到的,唯一公开的参数是DistributionDomainName,这仅适用于边缘优化的端点。

作为一种解决方法(直到它将在CloudFormation中实现),您可以使用由您自己的Lambda函数备份的CustomResource来返回regionalDomainName属性。

以下是执行此操作的示例CloudFormation YAML代码:

Resources:
  # The workaround Lambda that returns the regionalDomainName property
  RegionalDomainLambda:
    Type: AWS::Lambda::Function
    Properties:
      Runtime: python2.7
      Handler: index.handler
      Role:
        'Fn::GetAtt': [YOUR_ROLE_GOES_HERE, Arn] # make sure you include apigateway:GET
      Timeout: 50
      Code:
        ZipFile: |
          import cfnresponse
          import json
          import boto3

          client = boto3.client('apigateway')
          def handler(event, context):
              response_data = {}
              try:
                  domainName = event['ResourceProperties']['DomainName']
                  regional_domain_name = client.get_domain_name(domainName=domainName)['regionalDomainName']
                  response_data['value'] = regional_domain_name

                  cfnresponse.send(event, context, cfnresponse.SUCCESS,response_data, "RegionalDomainNameString")
              except Exception as e:
                  response_data['exception'] = e
                  cfnresponse.send(event, context, cfnresponse.FAILED, response_data, "RegionalDomainNameString")

  # The resource that serves as a placeholder
  RegionalDomain:
    Type: Custom::CustomResource
    Properties:
      ServiceToken:
        'Fn::GetAtt': [RegionalDomainLambda, Arn]
      DomainName: {Ref: YOUR_API_GATEWAY_DOMAIN_NAME_GOES_HERE}

  # And here's how to use it
  SomeOtherResource:
    SomeOtherProperty: {'Fn::GetAtt': [RegionalDomain, value]}

答案 1 :(得分:-1)

我在云编队中编写了相同的问题脚本。当我阅读更多相关信息时,截至目前我所研究的区域端点没有支持的返回值。

您可以使用此脚本使用Python脚本读取区域端点使用AWS Lambda创建自定义资源,以便您的自动化不会因返回值不可用而中断。

client = boto3.client('apigateway') response = client.get_domain_name( domainName='api.example.com' ) print(response['regionalDomainName'])