Parametri

Utilizza la sezione Parameters opzionale per personalizzare i modelli. I parametri consentono di immettere valori personalizzati nel modello ogni volta che crei o aggiorni uno stack.

Definizione di un parametro in un modello

L'esempio seguente dichiara un parametro denominato InstanceTypeParameter. Questo parametro consente di specificare il tipo di istanza Amazon EC2 per lo stack da utilizzare quando crei o aggiorni lo stack.

Osserva che il valore di default di InstanceTypeParameter è t2.micro. Questo è il valore AWS CloudFormation utilizzato per effettuare il provisioning dello stack a meno che non venga fornito un altro valore.

"Parameters" : {
  "InstanceTypeParameter" : {
    "Type" : "String",
    "Default" : "t2.micro",
    "AllowedValues" : ["t2.micro", "m1.small", "m1.large"],
    "Description" : "Enter t2.micro, m1.small, or m1.large. Default is t2.micro."
  }
}

Parameters:
  InstanceTypeParameter:
    Type: String
    Default: t2.micro
    AllowedValues:
      - t2.micro
      - m1.small
      - m1.large
    Description: Enter t2.micro, m1.small, or m1.large. Default is t2.micro.

Riferimento a un parametro all'interno di un modello

Si utilizza la funzione Ref intrinseca per fare riferimento a un parametro e si AWS CloudFormation utilizza il valore del parametro per eseguire il provisioning dello stack. Puoi fare riferimento ai parametri dalle sezioni Resources e Outputs dello stesso modello.

In questo esempio, la proprietà InstanceType della risorsa dell'istanza EC2 fa riferimento al valore del parametro InstanceTypeParameter:

"Ec2Instance" : {
  "Type" : "AWS::EC2::Instance",
  "Properties" : {
    "InstanceType" : { "Ref" : "InstanceTypeParameter" },
    "ImageId" : "ami-0ff8a91507f77f867"
  }
}

Ec2Instance:
  Type: AWS::EC2::Instance
  Properties:
    InstanceType:
      Ref: InstanceTypeParameter
    ImageId: ami-0ff8a91507f77f867

Requisiti generali per i parametri

Per l'utilizzo dei parametri sono validi i seguenti requisiti:

"Parameters" : {
  "ParameterLogicalID" : {
    "Type" : "DataType",
    "ParameterProperty" : "value"
  }
}

Parameters:
  ParameterLogicalID:
    Type: DataType
    ParameterProperty: value

Proprietà

Tipi di parametri specifici per AWS

I tipi di parametro specifici di AWS sono utili nell'individuazione dei valori non validi nelle fasi iniziali del processo di creazione o aggiornamento di uno stack. Per specificare parametri con tipi AWS specifici, un utente del modello deve inserire AWS i valori esistenti presenti nel proprio account. AWS AWS CloudFormation convalida questi valori di input rispetto ai valori esistenti nell'account. Ad esempio, con il tipo di parametro AWS::EC2::VPC::Id, un utente deve immettere un ID VPC esistente presente nell'account e nella Regione in cui sta creando lo stack.

Se desideri consentire agli utenti del modello di inserire valori di input da AWS account diversi, non definire parametri con tipi AWS specifici; definisci invece parametri di tipo String o. CommaDelimitedList

Tipi di AWS parametri specifici supportati

AWS CloudFormation supporta i seguenti tipi AWS specifici:

Tipi di parametro SSM

I tipi di parametri SSM corrispondono ai parametri esistenti in Systems Manager Parameter Store. Si specifica una chiave del parametro Systems Manager come valore del SSM parametro e si AWS CloudFormation recupera il valore più recente da Parameter Store da utilizzare per lo stack. Per i parametri SSM memorizzati nello stesso Account AWS, immettete il nome del parametro. Per i parametri SSM condivisi da un altro Account AWS utente, inserisci il parametro ARN completo. Per ulteriori informazioni sui parametri di Systems Manager, vedere Systems Manager Parameter Store e Working with shared parameters nella Guida per l'AWS Systems Manager utente.

Puoi inoltre utilizzare lo schema di parametri dinamici ssm o ssm-secure per specificare valori dei parametri nel modello. Per ulteriori informazioni, consulta Utilizzo di riferimenti dinamici per specificare valori di modello.

Quando si creano o si aggiornano pile e si creano set di modifiche, AWS CloudFormation vengono utilizzati i valori presenti in Parameter Store al momento dell'esecuzione dell'operazione. Se un parametro specificato non esiste in Parameter Store nell' AWS account del chiamante, AWS CloudFormation restituisce un errore di convalida.

Quando si esegue un set di modifiche, AWS CloudFormation utilizza i valori specificati nel set di modifiche. Esamina questi valori prima di eseguire il set di modifiche perché potrebbero variare in Archivio parametri tra il momento in cui crei il set di modifiche e l'esecuzione dello stesso.

Poiché il valore di un parametro SSM è una chiave di parametro Systems Manager, è importante considerare il comportamento seguente:

Consulta la sezione relativa ai tipi di parametro SSM per alcuni esempi che utilizzano i tipi di parametro SSM.

Tipi di parametro SSM supportati

AWS CloudFormation supporta i seguenti tipi di SSM parametri:

Tipi di parametro SSM non supportati

AWS CloudFormation non supporta il seguente tipo di SSM parametro:

Inoltre, non AWS CloudFormation supporta la definizione dei parametri del modello come tipi di parametri SecureString Systems Manager. Tuttavia, puoi specificare stringhe sicure come valori dei parametri per alcune risorse utilizzando schemi di parametri dinamici. Per ulteriori informazioni, consulta Utilizzo di riferimenti dinamici per specificare valori di modello.

Raggruppamento e ordinamento di parametri nella console AWS CloudFormation

Quando si utilizza la AWS CloudFormation console per creare o aggiornare uno stack, la console elenca alfabeticamente i parametri di input in base al relativo ID logico. Per ignorare l'ordinamento di default, puoi usare la chiave di metadati AWS::CloudFormation::Interface. Il raggruppamento e l'ordinamento dei parametri ti permettono di semplificare l'immissione dei valori dei parametri da parte degli utenti. Ad esempio, puoi raggruppare tutti i parametri relativi a VPC in modo che non sono distribuiti all'interno di elenco in ordine alfabetico.

Nel chiave di metadati puoi specificare i gruppi da creare, i parametri da includere in ciascun gruppo e l'ordine in base al quale la console mostra ciascun parametro all'interno del relativo gruppo. Puoi anche definire nomi di parametro descrittivi in modo che la console mostri nomi descrittivi invece degli ID logici. Tutti i parametri a cui fai riferimento nella chiave di metadati devono essere dichiarati nella sezione Parameters del modello.

Per ulteriori informazioni e un esempio della chiave di metadati AWS::CloudFormation::Interface, consulta AWS::CloudFormation::Interface.

Esempi

Parametri di input di base

Nella seguente sezione Parameters dii esempio vengono dichiarati due parametri. Il parametro DBPort è di tipo Number con un valore di default pari a 3306. Il valore minimo che può essere specificato è 1150e il valore massimo che può essere specificato è 65535. Il parametro DBPwd è di tipo String senza alcun valore di default. La NoEcho proprietà è impostata true per impedire che le chiamate di descrizione dello stack, ad esempio il aws cloudformation describe-stacks AWS CLI comando, restituiscano il valore del parametro. La lunghezza minima che può essere specificata è 1e la lunghezza massima che può essere specificata è 41. Il modello consente l'uso di caratteri alfabetici in maiuscolo e minuscolo e di numeri.

"Parameters" : {
  "DBPort" : {
    "Default" : "3306",
    "Description" : "TCP/IP port for the database",
    "Type" : "Number",
    "MinValue" : "1150",
    "MaxValue" : "65535"
  },
  "DBPwd" : {
    "NoEcho" : "true",
    "Description" : "The database admin account password",
    "Type" : "String",
    "MinLength" : "1",
    "MaxLength" : "41",
    "AllowedPattern" : "^[a-zA-Z0-9]*$"
  }
}

Parameters: 
  DBPort: 
    Default: 3306
    Description: TCP/IP port for the database
    Type: Number
    MinValue: 1150
    MaxValue: 65535
  DBPwd: 
    NoEcho: true
    Description: The database admin account password
    Type: String
    MinLength: 1
    MaxLength: 41
    AllowedPattern: ^[a-zA-Z0-9]*$

Tipi di parametri specifici per AWS

Quando si utilizzano tipi di parametri AWS specifici, un utente che utilizza il modello per creare o aggiornare uno stack deve specificare AWS i valori esistenti presenti nell'account dell'utente e nella regione dello stack corrente. AWS i tipi di parametri -specific aiutano a garantire che i valori di input per questi tipi esistano e siano corretti prima di AWS CloudFormation creare o aggiornare qualsiasi risorsa. Ad esempio, se utilizzi il tipo di parametro AWS::EC2::KeyPair::KeyName, AWS CloudFormation convalida il valore di input in base ai nomi delle coppie di chiave esistenti degli utenti prima di creare qualsiasi risorsa, ad esempio istanze Amazon EC2.

Se un utente utilizza AWS Management Console, AWS CloudFormation precompila i tipi di parametri AWS specifici con valori validi. In questo modo l'utente non dovrà ricordare alcuna informazione e immetterà correttamente un nome o un ID specifico. Si dovrebbe solo selezionare uno o più valori da un elenco a discesa. Inoltre, a seconda del tipo di parametro, gli utenti possono cercare i valori per ID, nome o valore del tag Name. Per ulteriori informazioni, consulta Specificazione del nome e dei parametri di uno stack.

L'esempio seguente dichiara due parametri con i tipi AWS::EC2::KeyPair::KeyName e AWS::EC2::Subnet::Id. Questi tipi limitano i valori validi a nomi di coppie di chiavi o a ID sottorete esistenti. Poiché il parametro mySubnetIDs è specificato come un elenco, un utente può specificare uno o più ID sottorete.

"Parameters" : {
  "myKeyPair" : {
    "Description" : "Amazon EC2 Key Pair",
    "Type" : "AWS::EC2::KeyPair::KeyName"
  },
  "mySubnetIDs" : {
    "Description" : "Subnet IDs",
    "Type" : "List<AWS::EC2::Subnet::Id>"
  }
}

Parameters: 
  myKeyPair: 
    Description: Amazon EC2 Key Pair
    Type: "AWS::EC2::KeyPair::KeyName"
  mySubnetIDs: 
    Description: Subnet IDs
    Type: "List<AWS::EC2::Subnet::Id>"

AWS CLI e supporto per le API

Attualmente, gli utenti non possono utilizzare l' AWS CloudFormation API AWS CLI or per visualizzare un elenco di valori validi per parametri AWS specifici. Tuttavia, possono visualizzare informazioni su ciascun parametro, ad esempio il tipo di parametro, utilizzando il comando aws cloudformation get-template-summary o l'API GetTemplateSummary.

Tipo di parametro CommaDelimitedList

Puoi usare il tipo di parametro CommaDelimitedList per specificare più valori di stringa in un unico parametro. In questo modo, puoi utilizzare un unico parametro anziché diversi parametri per specificare più valori. Ad esempio, se creai tre sottoreti differenti con i propri blocchi CIDR, puoi utilizzare tre diversi parametri per specificare tre blocchi CIDR differenti. Tuttavia, risulta più semplice utilizzare un unico parametro che supporta un elenco di tre blocchi CIDR, come mostrato nel segmento di codice seguente:

"Parameters" : {
  "DbSubnetIpBlocks": {
    "Description": "Comma-delimited list of three CIDR blocks",
    "Type": "CommaDelimitedList",
    "Default": "10.0.48.0/24, 10.0.112.0/24, 10.0.176.0/24"
  }
}

Parameters: 
  DbSubnetIpBlocks: 
    Description: "Comma-delimited list of three CIDR blocks"
    Type: CommaDelimitedList
    Default: "10.0.48.0/24, 10.0.112.0/24, 10.0.176.0/24"

Restituzione un valore da un parametro CommaDelimitedList

Per fare riferimento a un valore specifico in un elenco, utilizza la funzione intrinseca Fn::Select nella sezione Resources del modello. Puoi passare il valore di indice dell'oggetto desiderato e un elenco di oggetti, come mostrato nel segmento di codice seguente:

"DbSubnet1" : {
  "Type" : "AWS::EC2::Subnet",
  "Properties" : {
    "AvailabilityZone" : {"Fn::Join" : ["",[ { "Ref" : "AWS::Region" }, { "Fn::Select" : [ "0", {"Ref" : "VpcAzs"} ] } ] ]} ,
    "VpcId" :  { "Ref" : "VPC" },
    "CidrBlock" : { "Fn::Select" : [ "0", {"Ref" : "DbSubnetIpBlocks"} ] }
  }
},
"DbSubnet2" : {
  "Type" : "AWS::EC2::Subnet",
  "Properties" : {
    "AvailabilityZone" : {"Fn::Join" : ["",[ { "Ref" : "AWS::Region" }, { "Fn::Select" : [ "1", {"Ref" : "VpcAzs"} ] } ] ]} ,
    "VpcId" : { "Ref" : "VPC" },
    "CidrBlock" : { "Fn::Select" : [ "1", {"Ref" : "DbSubnetIpBlocks"} ] }
  }
},
"DbSubnet3" : {
  "Type" : "AWS::EC2::Subnet",
  "Properties" : {
    "AvailabilityZone" : {"Fn::Join" : ["",[ { "Ref" : "AWS::Region" }, { "Fn::Select" : [ "2", {"Ref" : "VpcAzs"} ] } ] ]} ,
    "VpcId" : { "Ref" : "VPC" },
    "CidrBlock" : { "Fn::Select" : [ "2", {"Ref" : "DbSubnetIpBlocks"} ] }
  }
}

DbSubnet1:
  Type: AWS::EC2::Subnet
  Properties:
    AvailabilityZone: !Sub
      - "${AWS::Region}${AZ}"
      - AZ: !Select [0, !Ref VpcAzs]
    VpcId: !Ref VPC
    CidrBlock: !Select [0, !Ref DbSubnetIpBlocks]
DbSubnet2: 
  Type: AWS::EC2::Subnet
  Properties:
    AvailabilityZone: !Sub
      - "${AWS::Region}${AZ}"
      - AZ: !Select [1, !Ref VpcAzs]
    VpcId: !Ref VPC
    CidrBlock: !Select [1, !Ref DbSubnetIpBlocks]
DbSubnet3: 
  Type: AWS::EC2::Subnet
  Properties:
    AvailabilityZone: !Sub
      - "${AWS::Region}${AZ}"
      - AZ: !Select [2, !Ref VpcAzs]
    VpcId: !Ref VPC
    CidrBlock: !Select [2, !Ref DbSubnetIpBlocks]

Tipi di parametro SSM

Tipo AWS::SSM::Parameter::Value<String>

Il modello seguente dichiara un tipo di parametro AWS::SSM::Parameter::Value<String>.

{
  "Parameters": {
    "InstanceType": {
      "Type": "AWS::SSM::Parameter::Value<String>"
    }
  },
  "Resources": {
    "Instance": {
      "Type": "AWS::EC2::Instance",
      "Properties": {
        "InstanceType": {
          "Ref": "InstanceType"
        }
      }
    }
  }
}

Parameters: 
  InstanceType: 
    Type: 'AWS::SSM::Parameter::Value<String>'
Resources: 
  Instance: 
    Type: 'AWS::EC2::Instance'
    Properties: 
      InstanceType: !Ref InstanceType

Il comando seguente crea uno stack in base al modello di esempio. Fornisce la chiave di parametro Systems Manager (myInstanceType) come valore per il parametro di modello InstanceType. L'esempio presuppone l'esistenza del parametro myInstanceType in Archivio parametri nell'account AWS del chiamante.

aws cloudformation create-stack --stack-name S1 --template-body example template --parameters ParameterKey=InstanceType,ParameterValue=myInstanceType

Tipo AWS::SSM::Parameter::Value<AWS::EC2::Image::Id>

Il modello seguente dichiara un tipo di parametro AWS::SSM::Parameter::Value<AWS::EC2::Image::Id>.

{
  "Parameters": {
    "ImageId": {
      "Type": "AWS::SSM::Parameter::Value<AWS::EC2::Image::Id>"
    }
  },
  "Resources": {
    "Instance": {
      "Type": "AWS::EC2::Instance",
      "Properties": {
        "ImageId": {
          "Ref": "ImageId"
        }
      }
    }
  }
}

Parameters: 
  ImageId: 
    Type: 'AWS::SSM::Parameter::Value<AWS::EC2::Image::Id>'
Resources: 
  Instance: 
    Type: 'AWS::EC2::Instance'
    Properties:
      ImageId: !Ref ImageId

Il comando seguente crea uno stack in base al modello di esempio. Fornisce la chiave di parametro Systems Manager (myLatestAMI) come valore per il parametro di modello ImageId. Ciò presuppone che il myLatestAMI parametro esista in Parameter Store sotto l'account del chiamante. AWS

aws cloudformation create-stack --stack-name S2 --template-body example template --parameters ParameterKey=ImageId,ParameterValue=myLatestAMI