Partager via

API Microsoft.AwsConnectorGatewayStages

Définition de ressource Bicep

Le type de ressource apiGatewayStages peut être déployé avec des opérations qui ciblent :

Pour obtenir la liste des propriétés modifiées dans chaque version de l’API, consultez journal des modifications.

Format de ressource

Pour créer une ressource Microsoft.AwsConnector/apiGatewayStages, ajoutez le bicep suivant à votre modèle.

resource symbolicname 'Microsoft.AwsConnector/apiGatewayStages@2024-12-01' = {
  location: 'string'
  name: 'string'
  properties: {
    arn: 'string'
    awsAccountId: 'string'
    awsProperties: {
      accessLogSetting: {
        destinationArn: 'string'
        format: 'string'
      }
      cacheClusterEnabled: bool
      cacheClusterSize: 'string'
      canarySetting: {
        deploymentId: 'string'
        percentTraffic: int
        stageVariableOverrides: {
          {customized property}: 'string'
        }
        useStageCache: bool
      }
      clientCertificateId: 'string'
      deploymentId: 'string'
      description: 'string'
      documentationVersion: 'string'
      methodSettings: [
        {
          cacheDataEncrypted: bool
          cacheTtlInSeconds: int
          cachingEnabled: bool
          dataTraceEnabled: bool
          httpMethod: 'string'
          loggingLevel: 'string'
          metricsEnabled: bool
          resourcePath: 'string'
          throttlingBurstLimit: int
          throttlingRateLimit: int
        }
      ]
      restApiId: 'string'
      stageName: 'string'
      tags: [
        {
          key: 'string'
          value: 'string'
        }
      ]
      tracingEnabled: bool
      variables: {
        {customized property}: 'string'
      }
    }
    awsRegion: 'string'
    awsSourceSchema: 'string'
    awsTags: {
      {customized property}: 'string'
    }
    publicCloudConnectorsResourceId: 'string'
    publicCloudResourceName: 'string'
  }
  tags: {
    {customized property}: 'string'
  }
}

Valeurs de propriété

Microsoft.AwsConnector/apiGatewayStages

Nom Descriptif Valeur
emplacement Emplacement géographique où réside la ressource chaîne (obligatoire)
nom Nom de la ressource corde

Contraintes:
Modèle = ^(?=.{0,259}[^\s.]$)(?!.*[<>%&\?/#]) (obligatoire)
Propriétés Propriétés spécifiques à la ressource pour cette ressource. ApiGatewayStageProperties
étiquettes Balises de ressource Dictionnaire de noms et de valeurs d’étiquettes. Consultez les balises dans les modèles

AccessLogSetting

Nom Descriptif Valeur
destinationArn Nom de la ressource Amazon (ARN) du groupe de journaux CloudWatch Logs ou flux de remise de data Firehose de données De Secours pour recevoir les journaux d’accès. Si vous spécifiez un flux de livraison Firehose Data Data Data, le nom du flux doit commencer par amazon-apigateway-. Ce paramètre est requis pour activer la journalisation des accès. corde
format Format de ligne unique des journaux d’accès des données, comme spécifié par les variables $context sélectionnées. Le format doit inclure au moins $context.requestId. Ce paramètre est requis pour activer la journalisation des accès. corde

ApiGatewayStageProperties

Nom Descriptif Valeur
ARN Nom de la ressource Amazon (ARN) corde
awsAccountId ID de compte AWS corde
Propriétés awsProperties Propriétés AWS AwsApiGatewayStageProperties
Région aws(s) Région AWS corde
awsSourceSchema Schéma source AWS corde
mots-clés Balises AWS ApiGatewayStagePropertiesAwsTags
publicCloudConnectorsResourceId ID de ressource des connecteurs cloud public corde
publicCloudResourceName Nom de la ressource cloud public corde

ApiGatewayStagePropertiesAwsTags

Nom Descriptif Valeur

AwsApiGatewayStageProperties

Nom Descriptif Valeur
accessLogSetting Paramètres du journal d’accès, y compris le format du journal d’accès et l’ARN de destination du journal d’accès. Le type de propriété AccessLogSetting spécifie les paramètres de journalisation de l’accès à cette étape. AccessLogSetting est une propriété de la ressource AWS ::ApiGateway ::Stage. AccessLogSetting
cacheClusterEnabled Spécifie si un cluster de cache est activé pour l’étape. Bool
cacheClusterSize Capacité du cache de la phase en Go. Pour plus d’informations sur le choix d’une taille de cache, consultez Activation de la mise en cache des API pour améliorer la réactivité. corde
canarySetting Paramètres du déploiement canary à cette étape. Paramètres de configuration d’un déploiement canary. CanarySetting
clientCertificateId Identificateur d’un certificat client pour une phase d’API. corde
IdDéploiement Identificateur du déploiement vers lequel pointe l’étape. corde
descriptif Description de la phase. corde
documentationVersion Version de la documentation de l’API associée. corde
méthodeParamètres Carte qui définit les paramètres de méthode d’une ressource Stage. Les clés (désignées comme /{method_setting_key ci-dessous) sont des chemins d’accès de méthode définis comme {resource_path}/{http_method} pour un remplacement de méthode individuelle, ou /\*/\* pour remplacer toutes les méthodes à l’étape. Réglage de la méthode[]
restApiId Identificateur de chaîne du RestApi associé. corde
stageName Le nom de l’étape est le premier segment de chemin d’accès dans l’URI (Uniform Resource Identifier) d’un appel à la passerelle API. Les noms d’étape ne peuvent contenir que des caractères alphanumériques, des traits d’union et des traits de soulignement. La longueur maximale est de 128 caractères. corde
étiquettes Collection d’étiquettes. Chaque élément de balise est associé à une ressource donnée. BaliseAutoGenerated2[]
traçageActivé Spécifie si le traçage actif avec des rayons X est activé pour l’étape. Bool
Variables Carte (mappage de chaîne à chaîne) qui définit les variables d’étape, où le nom de la variable est la clé et la valeur de la variable est la valeur. Les noms de variables sont limités aux caractères alphanumériques. Les valeurs doivent correspondre à l’expression régulière suivante : [A-Za-z0-9-._~:/?#&=,]+. AwsApiGatewayStagePropertiesVariables

AwsApiGatewayStagePropertiesVariables

Nom Descriptif Valeur

CanarySetting

Nom Descriptif Valeur
IdDéploiement ID du déploiement canary. corde
pourcentageTrafic Pourcentage (0-100) du trafic détourné vers un déploiement canary. Int
stageVariableRemplacements Variables intermédiaires remplacées pour un déploiement de mise en production canary, y compris les nouvelles variables intermédiaires introduites dans le canari. Ces variables intermédiaires sont représentées sous forme de mappage de chaîne à chaîne entre les noms de variables intermédiaires et leurs valeurs. CanarySettingStageVariableRemplacements
useStageCache Indicateur booléen pour indiquer si le déploiement canary utilise le cache d’étape ou non. Bool

CanarySettingStageVariableRemplacements

Nom Descriptif Valeur

Réglage de la méthode

Nom Descriptif Valeur
cacheDataEncrypted Spécifie si les réponses mises en cache sont chiffrées. Bool
cacheTtlInSeconds Spécifie la durée de vie (TTL), en secondes, pour les réponses mises en cache. Plus la durée de vie est élevée, plus la réponse sera mise en cache. Int
mise en cacheActivé Spécifie si les réponses doivent être mises en cache et retournées pour les demandes. Un cluster de cache doit être activé à l’étape pour que les réponses soient mises en cache. Bool
dataTraceEnabled Spécifie si la journalisation des traces de données est activée pour cette méthode, ce qui affecte les entrées de journal envoyées à Amazon CloudWatch Logs. Cela peut être utile pour résoudre les problèmes d’API, mais peut entraîner la journalisation des données sensibles. Nous vous recommandons de ne pas activer cette option pour les API de production. Bool
httpMethod Méthode HTTP. Pour appliquer des paramètres à plusieurs ressources et méthodes, spécifiez un astérisque (*) pour le HttpMethod et /* pour le ResourcePath. Ce paramètre est obligatoire lorsque vous spécifiez un MethodSetting. corde
journalisationNiveau Spécifie le niveau de journalisation de cette méthode, qui affecte les entrées de journal envoyées à Amazon CloudWatch Logs. Les valeurs valides sont OFF, ERRORet INFO. Choisissez ERROR pour écrire uniquement des entrées au niveau des erreurs dans les journaux CloudWatch, ou choisissez INFO pour inclure tous les événements ERROR ainsi que des événements d’information supplémentaires. corde
métriqueActivé Spécifie si les métriques Amazon CloudWatch sont activées pour cette méthode. Bool
resourcePath Chemin d’accès aux ressources de cette méthode. Les barres obliques (/) sont encodées en tant que ~1 et la barre oblique initiale doit inclure une barre oblique. Par exemple, la valeur du chemin d’accès /resource/subresource doit être encodée en tant que /~1resource~1subresource. Pour spécifier le chemin d’accès racine, utilisez uniquement une barre oblique (/). Pour appliquer des paramètres à plusieurs ressources et méthodes, spécifiez un astérisque (*) pour le HttpMethod et /* pour le ResourcePath. Ce paramètre est obligatoire lorsque vous spécifiez un MethodSetting. corde
throttlingBurstLimit Spécifie la limite de rafale de limitation. Int
throttlingRateLimit Spécifie la limite de débit de limitation. Int

BaliseAutoGenerated2

Nom Descriptif Valeur
clé Nom de clé de la balise. Vous pouvez spécifier une valeur de 1 à 128 caractères Unicode de longueur et ne peut pas être précédée d’aws :. corde
valeur Valeur de la balise. Vous pouvez spécifier une valeur de 0 à 256 caractères Unicode de longueur et ne peut pas être précédée d’aws :. corde

TrackedResourceTags

Nom Descriptif Valeur

Définition de ressource de modèle ARM

Le type de ressource apiGatewayStages peut être déployé avec des opérations qui ciblent :

Pour obtenir la liste des propriétés modifiées dans chaque version de l’API, consultez journal des modifications.

Format de ressource

Pour créer une ressource Microsoft.AwsConnector/apiGatewayStages, ajoutez le code JSON suivant à votre modèle.

{
  "type": "Microsoft.AwsConnector/apiGatewayStages",
  "apiVersion": "2024-12-01",
  "name": "string",
  "location": "string",
  "properties": {
    "arn": "string",
    "awsAccountId": "string",
    "awsProperties": {
      "accessLogSetting": {
        "destinationArn": "string",
        "format": "string"
      },
      "cacheClusterEnabled": "bool",
      "cacheClusterSize": "string",
      "canarySetting": {
        "deploymentId": "string",
        "percentTraffic": "int",
        "stageVariableOverrides": {
          "{customized property}": "string"
        },
        "useStageCache": "bool"
      },
      "clientCertificateId": "string",
      "deploymentId": "string",
      "description": "string",
      "documentationVersion": "string",
      "methodSettings": [
        {
          "cacheDataEncrypted": "bool",
          "cacheTtlInSeconds": "int",
          "cachingEnabled": "bool",
          "dataTraceEnabled": "bool",
          "httpMethod": "string",
          "loggingLevel": "string",
          "metricsEnabled": "bool",
          "resourcePath": "string",
          "throttlingBurstLimit": "int",
          "throttlingRateLimit": "int"
        }
      ],
      "restApiId": "string",
      "stageName": "string",
      "tags": [
        {
          "key": "string",
          "value": "string"
        }
      ],
      "tracingEnabled": "bool",
      "variables": {
        "{customized property}": "string"
      }
    },
    "awsRegion": "string",
    "awsSourceSchema": "string",
    "awsTags": {
      "{customized property}": "string"
    },
    "publicCloudConnectorsResourceId": "string",
    "publicCloudResourceName": "string"
  },
  "tags": {
    "{customized property}": "string"
  }
}

Valeurs de propriété

Microsoft.AwsConnector/apiGatewayStages

Nom Descriptif Valeur
apiVersion Version de l’API '2024-12-01'
emplacement Emplacement géographique où réside la ressource chaîne (obligatoire)
nom Nom de la ressource corde

Contraintes:
Modèle = ^(?=.{0,259}[^\s.]$)(?!.*[<>%&\?/#]) (obligatoire)
Propriétés Propriétés spécifiques à la ressource pour cette ressource. ApiGatewayStageProperties
étiquettes Balises de ressource Dictionnaire de noms et de valeurs d’étiquettes. Consultez les balises dans les modèles
type Type de ressource « Microsoft.AwsConnector/apiGatewayStages »

AccessLogSetting

Nom Descriptif Valeur
destinationArn Nom de la ressource Amazon (ARN) du groupe de journaux CloudWatch Logs ou flux de remise de data Firehose de données De Secours pour recevoir les journaux d’accès. Si vous spécifiez un flux de livraison Firehose Data Data Data, le nom du flux doit commencer par amazon-apigateway-. Ce paramètre est requis pour activer la journalisation des accès. corde
format Format de ligne unique des journaux d’accès des données, comme spécifié par les variables $context sélectionnées. Le format doit inclure au moins $context.requestId. Ce paramètre est requis pour activer la journalisation des accès. corde

ApiGatewayStageProperties

Nom Descriptif Valeur
ARN Nom de la ressource Amazon (ARN) corde
awsAccountId ID de compte AWS corde
Propriétés awsProperties Propriétés AWS AwsApiGatewayStageProperties
Région aws(s) Région AWS corde
awsSourceSchema Schéma source AWS corde
mots-clés Balises AWS ApiGatewayStagePropertiesAwsTags
publicCloudConnectorsResourceId ID de ressource des connecteurs cloud public corde
publicCloudResourceName Nom de la ressource cloud public corde

ApiGatewayStagePropertiesAwsTags

Nom Descriptif Valeur

AwsApiGatewayStageProperties

Nom Descriptif Valeur
accessLogSetting Paramètres du journal d’accès, y compris le format du journal d’accès et l’ARN de destination du journal d’accès. Le type de propriété AccessLogSetting spécifie les paramètres de journalisation de l’accès à cette étape. AccessLogSetting est une propriété de la ressource AWS ::ApiGateway ::Stage. AccessLogSetting
cacheClusterEnabled Spécifie si un cluster de cache est activé pour l’étape. Bool
cacheClusterSize Capacité du cache de la phase en Go. Pour plus d’informations sur le choix d’une taille de cache, consultez Activation de la mise en cache des API pour améliorer la réactivité. corde
canarySetting Paramètres du déploiement canary à cette étape. Paramètres de configuration d’un déploiement canary. CanarySetting
clientCertificateId Identificateur d’un certificat client pour une phase d’API. corde
IdDéploiement Identificateur du déploiement vers lequel pointe l’étape. corde
descriptif Description de la phase. corde
documentationVersion Version de la documentation de l’API associée. corde
méthodeParamètres Carte qui définit les paramètres de méthode d’une ressource Stage. Les clés (désignées comme /{method_setting_key ci-dessous) sont des chemins d’accès de méthode définis comme {resource_path}/{http_method} pour un remplacement de méthode individuelle, ou /\*/\* pour remplacer toutes les méthodes à l’étape. Réglage de la méthode[]
restApiId Identificateur de chaîne du RestApi associé. corde
stageName Le nom de l’étape est le premier segment de chemin d’accès dans l’URI (Uniform Resource Identifier) d’un appel à la passerelle API. Les noms d’étape ne peuvent contenir que des caractères alphanumériques, des traits d’union et des traits de soulignement. La longueur maximale est de 128 caractères. corde
étiquettes Collection d’étiquettes. Chaque élément de balise est associé à une ressource donnée. BaliseAutoGenerated2[]
traçageActivé Spécifie si le traçage actif avec des rayons X est activé pour l’étape. Bool
Variables Carte (mappage de chaîne à chaîne) qui définit les variables d’étape, où le nom de la variable est la clé et la valeur de la variable est la valeur. Les noms de variables sont limités aux caractères alphanumériques. Les valeurs doivent correspondre à l’expression régulière suivante : [A-Za-z0-9-._~:/?#&=,]+. AwsApiGatewayStagePropertiesVariables

AwsApiGatewayStagePropertiesVariables

Nom Descriptif Valeur

CanarySetting

Nom Descriptif Valeur
IdDéploiement ID du déploiement canary. corde
pourcentageTrafic Pourcentage (0-100) du trafic détourné vers un déploiement canary. Int
stageVariableRemplacements Variables intermédiaires remplacées pour un déploiement de mise en production canary, y compris les nouvelles variables intermédiaires introduites dans le canari. Ces variables intermédiaires sont représentées sous forme de mappage de chaîne à chaîne entre les noms de variables intermédiaires et leurs valeurs. CanarySettingStageVariableRemplacements
useStageCache Indicateur booléen pour indiquer si le déploiement canary utilise le cache d’étape ou non. Bool

CanarySettingStageVariableRemplacements

Nom Descriptif Valeur

Réglage de la méthode

Nom Descriptif Valeur
cacheDataEncrypted Spécifie si les réponses mises en cache sont chiffrées. Bool
cacheTtlInSeconds Spécifie la durée de vie (TTL), en secondes, pour les réponses mises en cache. Plus la durée de vie est élevée, plus la réponse sera mise en cache. Int
mise en cacheActivé Spécifie si les réponses doivent être mises en cache et retournées pour les demandes. Un cluster de cache doit être activé à l’étape pour que les réponses soient mises en cache. Bool
dataTraceEnabled Spécifie si la journalisation des traces de données est activée pour cette méthode, ce qui affecte les entrées de journal envoyées à Amazon CloudWatch Logs. Cela peut être utile pour résoudre les problèmes d’API, mais peut entraîner la journalisation des données sensibles. Nous vous recommandons de ne pas activer cette option pour les API de production. Bool
httpMethod Méthode HTTP. Pour appliquer des paramètres à plusieurs ressources et méthodes, spécifiez un astérisque (*) pour le HttpMethod et /* pour le ResourcePath. Ce paramètre est obligatoire lorsque vous spécifiez un MethodSetting. corde
journalisationNiveau Spécifie le niveau de journalisation de cette méthode, qui affecte les entrées de journal envoyées à Amazon CloudWatch Logs. Les valeurs valides sont OFF, ERRORet INFO. Choisissez ERROR pour écrire uniquement des entrées au niveau des erreurs dans les journaux CloudWatch, ou choisissez INFO pour inclure tous les événements ERROR ainsi que des événements d’information supplémentaires. corde
métriqueActivé Spécifie si les métriques Amazon CloudWatch sont activées pour cette méthode. Bool
resourcePath Chemin d’accès aux ressources de cette méthode. Les barres obliques (/) sont encodées en tant que ~1 et la barre oblique initiale doit inclure une barre oblique. Par exemple, la valeur du chemin d’accès /resource/subresource doit être encodée en tant que /~1resource~1subresource. Pour spécifier le chemin d’accès racine, utilisez uniquement une barre oblique (/). Pour appliquer des paramètres à plusieurs ressources et méthodes, spécifiez un astérisque (*) pour le HttpMethod et /* pour le ResourcePath. Ce paramètre est obligatoire lorsque vous spécifiez un MethodSetting. corde
throttlingBurstLimit Spécifie la limite de rafale de limitation. Int
throttlingRateLimit Spécifie la limite de débit de limitation. Int

BaliseAutoGenerated2

Nom Descriptif Valeur
clé Nom de clé de la balise. Vous pouvez spécifier une valeur de 1 à 128 caractères Unicode de longueur et ne peut pas être précédée d’aws :. corde
valeur Valeur de la balise. Vous pouvez spécifier une valeur de 0 à 256 caractères Unicode de longueur et ne peut pas être précédée d’aws :. corde

TrackedResourceTags

Nom Descriptif Valeur

Exemples d’utilisation

Définition de ressource Terraform (fournisseur AzAPI)

Le type de ressource apiGatewayStages peut être déployé avec des opérations qui ciblent :

  • groupes de ressources

Pour obtenir la liste des propriétés modifiées dans chaque version de l’API, consultez journal des modifications.

Format de ressource

Pour créer une ressource Microsoft.AwsConnector/apiGatewayStages, ajoutez terraform suivant à votre modèle.

resource "azapi_resource" "symbolicname" {
  type = "Microsoft.AwsConnector/apiGatewayStages@2024-12-01"
  name = "string"
  parent_id = "string"
  location = "string"
  tags = {
    {customized property} = "string"
  }
  body = {
    properties = {
      arn = "string"
      awsAccountId = "string"
      awsProperties = {
        accessLogSetting = {
          destinationArn = "string"
          format = "string"
        }
        cacheClusterEnabled = bool
        cacheClusterSize = "string"
        canarySetting = {
          deploymentId = "string"
          percentTraffic = int
          stageVariableOverrides = {
            {customized property} = "string"
          }
          useStageCache = bool
        }
        clientCertificateId = "string"
        deploymentId = "string"
        description = "string"
        documentationVersion = "string"
        methodSettings = [
          {
            cacheDataEncrypted = bool
            cacheTtlInSeconds = int
            cachingEnabled = bool
            dataTraceEnabled = bool
            httpMethod = "string"
            loggingLevel = "string"
            metricsEnabled = bool
            resourcePath = "string"
            throttlingBurstLimit = int
            throttlingRateLimit = int
          }
        ]
        restApiId = "string"
        stageName = "string"
        tags = [
          {
            key = "string"
            value = "string"
          }
        ]
        tracingEnabled = bool
        variables = {
          {customized property} = "string"
        }
      }
      awsRegion = "string"
      awsSourceSchema = "string"
      awsTags = {
        {customized property} = "string"
      }
      publicCloudConnectorsResourceId = "string"
      publicCloudResourceName = "string"
    }
  }
}

Valeurs de propriété

Microsoft.AwsConnector/apiGatewayStages

Nom Descriptif Valeur
emplacement Emplacement géographique où réside la ressource chaîne (obligatoire)
nom Nom de la ressource corde

Contraintes:
Modèle = ^(?=.{0,259}[^\s.]$)(?!.*[<>%&\?/#]) (obligatoire)
Propriétés Propriétés spécifiques à la ressource pour cette ressource. ApiGatewayStageProperties
étiquettes Balises de ressource Dictionnaire de noms et de valeurs d’étiquettes.
type Type de ressource « Microsoft.AwsConnector/apiGatewayStages@2024-12-01 »

AccessLogSetting

Nom Descriptif Valeur
destinationArn Nom de la ressource Amazon (ARN) du groupe de journaux CloudWatch Logs ou flux de remise de data Firehose de données De Secours pour recevoir les journaux d’accès. Si vous spécifiez un flux de livraison Firehose Data Data Data, le nom du flux doit commencer par amazon-apigateway-. Ce paramètre est requis pour activer la journalisation des accès. corde
format Format de ligne unique des journaux d’accès des données, comme spécifié par les variables $context sélectionnées. Le format doit inclure au moins $context.requestId. Ce paramètre est requis pour activer la journalisation des accès. corde

ApiGatewayStageProperties

Nom Descriptif Valeur
ARN Nom de la ressource Amazon (ARN) corde
awsAccountId ID de compte AWS corde
Propriétés awsProperties Propriétés AWS AwsApiGatewayStageProperties
Région aws(s) Région AWS corde
awsSourceSchema Schéma source AWS corde
mots-clés Balises AWS ApiGatewayStagePropertiesAwsTags
publicCloudConnectorsResourceId ID de ressource des connecteurs cloud public corde
publicCloudResourceName Nom de la ressource cloud public corde

ApiGatewayStagePropertiesAwsTags

Nom Descriptif Valeur

AwsApiGatewayStageProperties

Nom Descriptif Valeur
accessLogSetting Paramètres du journal d’accès, y compris le format du journal d’accès et l’ARN de destination du journal d’accès. Le type de propriété AccessLogSetting spécifie les paramètres de journalisation de l’accès à cette étape. AccessLogSetting est une propriété de la ressource AWS ::ApiGateway ::Stage. AccessLogSetting
cacheClusterEnabled Spécifie si un cluster de cache est activé pour l’étape. Bool
cacheClusterSize Capacité du cache de la phase en Go. Pour plus d’informations sur le choix d’une taille de cache, consultez Activation de la mise en cache des API pour améliorer la réactivité. corde
canarySetting Paramètres du déploiement canary à cette étape. Paramètres de configuration d’un déploiement canary. CanarySetting
clientCertificateId Identificateur d’un certificat client pour une phase d’API. corde
IdDéploiement Identificateur du déploiement vers lequel pointe l’étape. corde
descriptif Description de la phase. corde
documentationVersion Version de la documentation de l’API associée. corde
méthodeParamètres Carte qui définit les paramètres de méthode d’une ressource Stage. Les clés (désignées comme /{method_setting_key ci-dessous) sont des chemins d’accès de méthode définis comme {resource_path}/{http_method} pour un remplacement de méthode individuelle, ou /\*/\* pour remplacer toutes les méthodes à l’étape. Réglage de la méthode[]
restApiId Identificateur de chaîne du RestApi associé. corde
stageName Le nom de l’étape est le premier segment de chemin d’accès dans l’URI (Uniform Resource Identifier) d’un appel à la passerelle API. Les noms d’étape ne peuvent contenir que des caractères alphanumériques, des traits d’union et des traits de soulignement. La longueur maximale est de 128 caractères. corde
étiquettes Collection d’étiquettes. Chaque élément de balise est associé à une ressource donnée. BaliseAutoGenerated2[]
traçageActivé Spécifie si le traçage actif avec des rayons X est activé pour l’étape. Bool
Variables Carte (mappage de chaîne à chaîne) qui définit les variables d’étape, où le nom de la variable est la clé et la valeur de la variable est la valeur. Les noms de variables sont limités aux caractères alphanumériques. Les valeurs doivent correspondre à l’expression régulière suivante : [A-Za-z0-9-._~:/?#&=,]+. AwsApiGatewayStagePropertiesVariables

AwsApiGatewayStagePropertiesVariables

Nom Descriptif Valeur

CanarySetting

Nom Descriptif Valeur
IdDéploiement ID du déploiement canary. corde
pourcentageTrafic Pourcentage (0-100) du trafic détourné vers un déploiement canary. Int
stageVariableRemplacements Variables intermédiaires remplacées pour un déploiement de mise en production canary, y compris les nouvelles variables intermédiaires introduites dans le canari. Ces variables intermédiaires sont représentées sous forme de mappage de chaîne à chaîne entre les noms de variables intermédiaires et leurs valeurs. CanarySettingStageVariableRemplacements
useStageCache Indicateur booléen pour indiquer si le déploiement canary utilise le cache d’étape ou non. Bool

CanarySettingStageVariableRemplacements

Nom Descriptif Valeur

Réglage de la méthode

Nom Descriptif Valeur
cacheDataEncrypted Spécifie si les réponses mises en cache sont chiffrées. Bool
cacheTtlInSeconds Spécifie la durée de vie (TTL), en secondes, pour les réponses mises en cache. Plus la durée de vie est élevée, plus la réponse sera mise en cache. Int
mise en cacheActivé Spécifie si les réponses doivent être mises en cache et retournées pour les demandes. Un cluster de cache doit être activé à l’étape pour que les réponses soient mises en cache. Bool
dataTraceEnabled Spécifie si la journalisation des traces de données est activée pour cette méthode, ce qui affecte les entrées de journal envoyées à Amazon CloudWatch Logs. Cela peut être utile pour résoudre les problèmes d’API, mais peut entraîner la journalisation des données sensibles. Nous vous recommandons de ne pas activer cette option pour les API de production. Bool
httpMethod Méthode HTTP. Pour appliquer des paramètres à plusieurs ressources et méthodes, spécifiez un astérisque (*) pour le HttpMethod et /* pour le ResourcePath. Ce paramètre est obligatoire lorsque vous spécifiez un MethodSetting. corde
journalisationNiveau Spécifie le niveau de journalisation de cette méthode, qui affecte les entrées de journal envoyées à Amazon CloudWatch Logs. Les valeurs valides sont OFF, ERRORet INFO. Choisissez ERROR pour écrire uniquement des entrées au niveau des erreurs dans les journaux CloudWatch, ou choisissez INFO pour inclure tous les événements ERROR ainsi que des événements d’information supplémentaires. corde
métriqueActivé Spécifie si les métriques Amazon CloudWatch sont activées pour cette méthode. Bool
resourcePath Chemin d’accès aux ressources de cette méthode. Les barres obliques (/) sont encodées en tant que ~1 et la barre oblique initiale doit inclure une barre oblique. Par exemple, la valeur du chemin d’accès /resource/subresource doit être encodée en tant que /~1resource~1subresource. Pour spécifier le chemin d’accès racine, utilisez uniquement une barre oblique (/). Pour appliquer des paramètres à plusieurs ressources et méthodes, spécifiez un astérisque (*) pour le HttpMethod et /* pour le ResourcePath. Ce paramètre est obligatoire lorsque vous spécifiez un MethodSetting. corde
throttlingBurstLimit Spécifie la limite de rafale de limitation. Int
throttlingRateLimit Spécifie la limite de débit de limitation. Int

BaliseAutoGenerated2

Nom Descriptif Valeur
clé Nom de clé de la balise. Vous pouvez spécifier une valeur de 1 à 128 caractères Unicode de longueur et ne peut pas être précédée d’aws :. corde
valeur Valeur de la balise. Vous pouvez spécifier une valeur de 0 à 256 caractères Unicode de longueur et ne peut pas être précédée d’aws :. corde

TrackedResourceTags

Nom Descriptif Valeur