Fn::GetAtt - AWS CloudFormation
DeclaraçãoParâmetrosValor de retornoExemplosFunções compatíveis

Fn::GetAtt

A função intrínseca Fn::GetAtt retorna o valor de um atributo obtido de um recurso no modelo. Quando a transformação Transformação AWS::LanguageExtensions é usada, é possível usar funções intrínsecas como parâmetro para Fn::GetAtt. Para obter mais informações sobre valores de retorno GetAtt para um recurso específico, consulte a documentação desse recurso na Referência de propriedades e recursos.

Declaração

JSON

{ "Fn::GetAtt" : [ "logicalNameOfResource", "attributeName" ] }

YAML

Sintaxe para o nome da função completo:

Fn::GetAtt: [ logicalNameOfResource, attributeName ]

Sintaxe para a forma resumida:

!GetAtt logicalNameOfResource.attributeName

Parâmetros

logicalNameOfResource

O nome lógico (também chamado de ID lógico) do recurso que contém o atributo que você deseja.

attributeName

O nome do atributo específico do recurso cujo valor é desejado. Consulte a página de referência do recurso para obter mais detalhes sobre os atributos disponíveis para esse tipo de recurso.

Valor de retorno

O valor de atributo.

Exemplos

Retornar uma string

Este snippet retorna uma string que contém o nome DNS do load balancer com o nome lógico myELB.

JSON

"Fn::GetAtt" : [ "myELB" , "DNSName" ]

YAML

!GetAtt myELB.DNSName

Retornar várias strings

O modelo de exemplo a seguir retorna SourceSecurityGroup.OwnerAlias e SourceSecurityGroup.GroupName do load balancer com o nome lógico myELB.

JSON
{
    "AWSTemplateFormatVersion": "2010-09-09",
    "Resources": {
        "myELB": {
            "Type": "AWS::ElasticLoadBalancing::LoadBalancer",
            "Properties": {
                "AvailabilityZones": [
                    "eu-west-1a"
                ],
                "Listeners": [
                    {
                        "LoadBalancerPort": "80",
                        "InstancePort": "80",
                        "Protocol": "HTTP"
                    }
                ]
            }
        },
        "myELBIngressGroup": {
            "Type": "AWS::EC2::SecurityGroup",
            "Properties": {
                "GroupDescription": "ELB ingress group",
                "SecurityGroupIngress": [
                    {
                        "IpProtocol": "tcp",
                        "FromPort": 80,
                        "ToPort": 80,
                        "SourceSecurityGroupOwnerId": {
                            "Fn::GetAtt": [
                                "myELB",
                                "SourceSecurityGroup.OwnerAlias"
                            ]
                        },
                        "SourceSecurityGroupName": {
                            "Fn::GetAtt": [
                                "myELB",
                                "SourceSecurityGroup.GroupName"
                            ]
                        }
                    }
                ]
            }
        }
    }
}
YAML
AWSTemplateFormatVersion: 2010-09-09
Resources:
  myELB:
    Type: AWS::ElasticLoadBalancing::LoadBalancer
    Properties:
      AvailabilityZones:
        - eu-west-1a
      Listeners:
        - LoadBalancerPort: '80'
          InstancePort: '80'
          Protocol: HTTP
  myELBIngressGroup:
    Type: AWS::EC2::SecurityGroup
    Properties:
      GroupDescription: ELB ingress group
      SecurityGroupIngress:
        - IpProtocol: tcp
          FromPort: 80
          ToPort: 80
          SourceSecurityGroupOwnerId: !GetAtt myELB.SourceSecurityGroup.OwnerAlias
          SourceSecurityGroupName: !GetAtt myELB.SourceSecurityGroup.GroupName

Exemplo: use um identificador padrão para vários recursos usando Fn::Sub dentro de Fn::GetAtt, Ref e Fn::ForEach

Os exemplos a seguir mostram como usar Fn::GetAtt com Fn::Sub, em conjunto com Fn::ForEach, no Outputs de um modelo para reduzir o comprimento e a verbosidade do modelo. O uso de Fn::Sub em Fn::GetAtt permite que o modelo contenha uma função intrínseca que pode fazer referência a um bucket diferente em cada iteração da chamada Fn::ForEach.

JSON
{
    "AWSTemplateFormatVersion": "2010-09-09",
    "Transform": "AWS::LanguageExtensions",
    "Mappings": {
        "Buckets": {
            "Properties": {
                "Identifiers": ["A", "B", "C"]
            }
        }
    },
    "Resources": {
        "Fn::ForEach::Buckets": [
            "Identifier",
            {"Fn::FindInMap": ["Buckets", "Properties", "Identifiers"]},
            {
                "S3Bucket${Identifier}": {
                    "Type": "AWS::S3::Bucket",
                    "Properties": {
                        "AccessControl": "PublicRead",
                        "MetricsConfigurations": [
                            {
                                "Id": {"Fn::Sub": "EntireBucket${Identifier}"}
                            }
                        ],
                        "WebsiteConfiguration": {
                            "IndexDocument": "index.html",
                            "ErrorDocument": "error.html",
                            "RoutingRules": [
                                {
                                    "RoutingRuleCondition": {
                                        "HttpErrorCodeReturnedEquals": "404",
                                        "KeyPrefixEquals": "out1/"
                                    },
                                    "RedirectRule": {
                                        "HostName": "ec2-11-22-333-44.compute-1.amazonaws.com",
                                        "ReplaceKeyPrefixWith": "report-404/"
                                    }
                                }
                            ]
                        }
                    },
                    "DeletionPolicy": "Retain",
                    "UpdateReplacePolicy": "Retain"
                }
            }
        ]
    },
    "Outputs": {
        "Fn::ForEach::BucketOutputs": [
            "Identifier",
            {"Fn::FindInMap": ["Buckets", "Properties", "Identifiers"]},
            {
                "Fn::ForEach::GetAttLoop": [
                    "Property",
                    ["Arn", "DomainName", "WebsiteURL"],
                    {
                        "S3Bucket${Identifier}${Property}": {
                            "Value": {
                                "Fn::GetAtt": [{"Fn::Sub": "S3Bucket${Identifier}"}, {"Ref": "Property"}]
                            }
                        }
                    }
                ]
            }
        ]
    }
}
YAML
AWSTemplateFormatVersion: 2010-09-09
Transform: 'AWS::LanguageExtensions'
Mappings:
  Buckets:
    Properties:
      Identifiers:
        - A
        - B
        - C
Resources:
  'Fn::ForEach::Buckets':
    - Identifier
    - Fn::FindInMap: 
      - Buckets
      - Properties
      - Identifiers
    - 'S3Bucket${Identifier}':
        Type: 'AWS::S3::Bucket'
        Properties:
          AccessControl: PublicRead
          MetricsConfigurations:
            - Id: 
                Fn::Sub: 'EntireBucket${Identifier}'
          WebsiteConfiguration:
            IndexDocument: index.html
            ErrorDocument: error.html
            RoutingRules:
              - RoutingRuleCondition:
                  HttpErrorCodeReturnedEquals: '404'
                  KeyPrefixEquals: out1/
                RedirectRule:
                  HostName: ec2-11-22-333-44.compute-1.amazonaws.com
                  ReplaceKeyPrefixWith: report-404/
        DeletionPolicy: Retain
        UpdateReplacePolicy: Retain
Outputs:
  'Fn::ForEach::BucketOutputs':
    - Identifier
    - Fn::FindInMap:
      - Buckets
      - Properties
      - Identifiers
    - 'Fn::ForEach::GetAttLoop':
        - Property
        - - Arn
          - DomainName
          - WebsiteURL
        - 'S3Bucket${Identifier}${Property}':
            Value: !GetAtt 
              - !Sub 'S3Bucket${Identifier}'
              - !Ref Property

Funções compatíveis

Quando a transformação Transformação AWS::LanguageExtensions não é usada:

  • O nome do recurso lógico Fn::GetAtt não pode usar funções. É necessário especificar uma string que seja um ID lógico do recurso. Para o nome de atributo Fn::GetAtt, você pode usar a função Ref.

  • O nome de atributo Fn::GetAtt pode usar a função Ref.

Quando a transformação Transformação AWS::LanguageExtensions é usada dentro da função Fn::GetAtt, é possível usar as funções a seguir. Isso é verdade com o nome do recurso lógico Fn::GetAtt ou o nome do atributo Fn::GetAtt.