cloudformation-declarations

import * as C from '../core'; export declare namespace AWS.AmazonMQ { /** * A broker is a message broker environment running on Amazon MQ. It is the basic building block of Amazon MQ. * * Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-amazonmq-broker.html */ interface Broker extends C.CommonResourceProps { Type: 'AWS::AmazonMQ::Broker'; Properties: AWS.AmazonMQ.Broker.Properties; } /** * A broker is a message broker environment running on Amazon MQ. It is the basic building block of Amazon MQ. * * Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-amazonmq-broker.html */ function Broker(props: C.Omit<Broker, 'Type'>): Broker; } export declare namespace AWS.AmazonMQ.Broker { interface Properties { /** * List of String values * * The list of rules (1 minimum, 125 maximum) that authorize connections to brokers. * * UpdateType: Immutable * Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-amazonmq-broker.html#cfn-amazonmq-broker-securitygroups */ SecurityGroups?: C.CFList<C.CFString>; /** * String * * The version of the broker engine. * * UpdateType: Immutable * Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-amazonmq-broker.html#cfn-amazonmq-broker-engineversion */ EngineVersion: C.CFString; /** * Amazon MQ Broker ConfigurationId * * The broker configuration. If no configuration exists for a broker, Amazon MQ creates a default configuration. * * UpdateType: Mutable * Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-amazonmq-broker.html#cfn-amazonmq-broker-configuration */ Configuration?: AWS.AmazonMQ.Broker.ConfigurationId; /** * Amazon MQ Broker MaintenanceWindow * * The parameters that determine the WeeklyStartTime. * * UpdateType: Immutable * Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-amazonmq-broker.html#cfn-amazonmq-broker-maintenancewindowstarttime */ MaintenanceWindowStartTime?: AWS.AmazonMQ.Broker.MaintenanceWindow; /** * String * * The broker's instance type. For more information, see Instance Types in the Amazon MQ Developer Guide. * * UpdateType: Immutable * Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-amazonmq-broker.html#cfn-amazonmq-broker-hostinstancetype */ HostInstanceType: C.CFString; /** * Boolean * * Enables automatic upgrades to new minor versions for brokers, as Apache releases the versions. The automatic upgrades occur during the maintenance window of the broker or after a manual broker reboot. * * UpdateType: Immutable * Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-amazonmq-broker.html#cfn-amazonmq-broker-autominorversionupgrade */ AutoMinorVersionUpgrade: C.CFBoolean; /** * List of Amazon MQ Broker User property types * * The list of all ActiveMQ usernames for the specified broker. * * UpdateType: Mutable * Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-amazonmq-broker.html#cfn-amazonmq-broker-users */ Users: C.CFList<AWS.AmazonMQ.Broker.User>; /** * Amazon MQ Broker LogsConfiguration * * The Amazon CloudWatch Logs configuration for the broker. * * UpdateType: Mutable * Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-amazonmq-broker.html#cfn-amazonmq-broker-logs */ Logs?: AWS.AmazonMQ.Broker.LogList; /** * List of String values * * The list of groups (2 maximum) that define which subnets and IP ranges the broker can use from different Availability Zones. A SINGLE_INSTANCE deployment requires one subnet (for example, the default subnet). An ACTIVE_STANDBY_MULTI_AZ deployment requires two subnets. * * UpdateType: Immutable * Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-amazonmq-broker.html#cfn-amazonmq-broker-subnetids */ SubnetIds?: C.CFList<C.CFString>; /** * String * * The name of the broker. This value must be unique in your AWS account, 1-50 characters long, must contain only letters, numbers, dashes, and underscores, and must not contain whitespaces, brackets, wildcard characters, or special characters. * * UpdateType: Immutable * Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-amazonmq-broker.html#cfn-amazonmq-broker-brokername */ BrokerName: C.CFString; /** * String * * The deployment mode of the broker. SINGLE_INSTANCE creates a single-instance broker in a single Availability Zone. ACTIVE_STANDBY_MULTI_AZ creates an active/standby broker for high availability. * * UpdateType: Immutable * Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-amazonmq-broker.html#cfn-amazonmq-broker-deploymentmode */ DeploymentMode: C.CFString; /** * String * * The type of broker engine. * * UpdateType: Immutable * Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-amazonmq-broker.html#cfn-amazonmq-broker-enginetype */ EngineType: C.CFString; /** * Boolean * * Enables connections from applications outside of the VPC that hosts the broker's subnets. * * UpdateType: Immutable * Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-amazonmq-broker.html#cfn-amazonmq-broker-publiclyaccessible */ PubliclyAccessible: C.CFBoolean; } } export declare namespace AWS.AmazonMQ.Broker { interface ConfigurationId { /** * Integer * * The revision number of the configuration. * * UpdateType: Mutable * Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-amazonmq-broker-configurationid.html#cfn-amazonmq-broker-configurationid-revision */ Revision: C.CFInteger; /** * String * * The unique ID that Amazon MQ generates for the configuration. * * UpdateType: Mutable * Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-amazonmq-broker-configurationid.html#cfn-amazonmq-broker-configurationid-id */ Id: C.CFString; } } export declare namespace AWS.AmazonMQ.Broker { interface LogList { /** * * * * * UpdateType: Mutable * Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-amazonmq-broker-loglist.html#cfn-amazonmq-broker-loglist-audit */ Audit?: C.CFBoolean; /** * * * * * UpdateType: Mutable * Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-amazonmq-broker-loglist.html#cfn-amazonmq-broker-loglist-general */ General?: C.CFBoolean; } } export declare namespace AWS.AmazonMQ.Broker { interface MaintenanceWindow { /** * String * * The day of the week, for example MONDAY, TUESDAY. * * UpdateType: Mutable * Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-amazonmq-broker-maintenancewindow.html#cfn-amazonmq-broker-maintenancewindow-dayofweek */ DayOfWeek: C.CFString; /** * String * * The time, in 24-hour format. * * UpdateType: Mutable * Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-amazonmq-broker-maintenancewindow.html#cfn-amazonmq-broker-maintenancewindow-timeofday */ TimeOfDay: C.CFString; /** * String * * The time zone, UTC by default, in either the Country/City format, or the UTC offset format. * * UpdateType: Mutable * Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-amazonmq-broker-maintenancewindow.html#cfn-amazonmq-broker-maintenancewindow-timezone */ TimeZone: C.CFString; } } export declare namespace AWS.AmazonMQ.Broker { interface User { /** * String * * The username of the ActiveMQ user. This value can contain only alphanumeric characters, dashes, periods, underscores, and tildes (- . _ ~). This value must be 2-100 characters long. * * UpdateType: Mutable * Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-amazonmq-broker-user.html#cfn-amazonmq-broker-user-username */ Username: C.CFString; /** * List of String values * * The list of groups (20 maximum) to which the ActiveMQ user belongs. This value can contain only alphanumeric characters, dashes, periods, underscores, and tildes (- . _ ~). This value must be 2-100 characters long. * * UpdateType: Mutable * Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-amazonmq-broker-user.html#cfn-amazonmq-broker-user-groups */ Groups?: C.CFList<C.CFString>; /** * Boolean * * Enables access to the ActiveMQ Web Console for the ActiveMQ user. * * UpdateType: Mutable * Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-amazonmq-broker-user.html#cfn-amazonmq-broker-user-consoleaccess */ ConsoleAccess?: C.CFBoolean; /** * String * * The password of the user. This value must be at least 12 characters long, must contain at least 4 unique characters, and must not contain commas. * * UpdateType: Mutable * Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-amazonmq-broker-user.html#cfn-amazonmq-broker-user-password */ Password: C.CFString; } } export declare namespace AWS.AmazonMQ { /** * A configuration contains all of the settings for your ActiveMQ broker, in XML format. * * Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-amazonmq-configuration.html */ interface Configuration extends C.CommonResourceProps { Type: 'AWS::AmazonMQ::Configuration'; Properties: AWS.AmazonMQ.Configuration.Properties; } /** * A configuration contains all of the settings for your ActiveMQ broker, in XML format. * * Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-amazonmq-configuration.html */ function Configuration(props: C.Omit<Configuration, 'Type'>): Configuration; } export declare namespace AWS.AmazonMQ.Configuration { interface Properties { /** * String * * The version of the broker engine. * * UpdateType: Immutable * Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-amazonmq-configuration.html#cfn-amazonmq-configuration-engineversion */ EngineVersion: C.CFString; /** * String * * The description of the configuration. * * UpdateType: Mutable * Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-amazonmq-configuration.html#cfn-amazonmq-configuration-description */ Description?: C.CFString; /** * String * * The type of broker engine. * * UpdateType: Immutable * Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-amazonmq-configuration.html#cfn-amazonmq-configuration-enginetype */ EngineType: C.CFString; /** * String * * The base64-encoded XML configuration. * * UpdateType: Mutable * Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-amazonmq-configuration.html#cfn-amazonmq-configuration-data */ Data: C.CFString; /** * String * * The name of the configuration. This value can contain only alphanumeric characters, dashes, periods, underscores, and tildes (- . _ ~). This value must be 1-150 characters long. * * UpdateType: Immutable * Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-amazonmq-configuration.html#cfn-amazonmq-configuration-name */ Name: C.CFString; } } export declare namespace AWS.ApiGateway { /** * The AWS::ApiGateway::Account resource specifies the AWS Identity and Access Management (IAM) role that Amazon API Gateway (API Gateway) uses to write API logs to Amazon CloudWatch Logs (CloudWatch Logs). * * Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-account.html */ interface Account extends C.CommonResourceProps { Type: 'AWS::ApiGateway::Account'; Properties: AWS.ApiGateway.Account.Properties; } /** * The AWS::ApiGateway::Account resource specifies the AWS Identity and Access Management (IAM) role that Amazon API Gateway (API Gateway) uses to write API logs to Amazon CloudWatch Logs (CloudWatch Logs). * * Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-account.html */ function Account(props: C.Omit<Account, 'Type'>): Account; } export declare namespace AWS.ApiGateway.Account { interface Properties { /** * String * * The Amazon Resource Name (ARN) of an IAM role that has write access to CloudWatch Logs in your account. * * UpdateType: Mutable * Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-account.html#cfn-apigateway-account-cloudwatchrolearn */ CloudWatchRoleArn?: C.CFString; } } export declare namespace AWS.ApiGateway { /** * The AWS::ApiGateway::ApiKey resource creates a unique key that you can distribute to clients who are executing Amazon API Gateway (API Gateway) Method resources that require an API key. To specify which API key clients must use, map the API key with the RestApi and Stage resources that include the methods that require a key. * * Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-apikey.html */ interface ApiKey extends C.CommonResourceProps { Type: 'AWS::ApiGateway::ApiKey'; Properties: AWS.ApiGateway.ApiKey.Properties; } /** * The AWS::ApiGateway::ApiKey resource creates a unique key that you can distribute to clients who are executing Amazon API Gateway (API Gateway) Method resources that require an API key. To specify which API key clients must use, map the API key with the RestApi and Stage resources that include the methods that require a key. * * Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-apikey.html */ function ApiKey(props: C.Omit<ApiKey, 'Type'>): ApiKey; } export declare namespace AWS.ApiGateway.ApiKey { interface Properties { /** * String * * An AWS Marketplace customer identifier to use when integrating with the AWS SaaS Marketplace. * * UpdateType: Mutable * Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-apikey.html#cfn-apigateway-apikey-customerid */ CustomerId?: C.CFString; /** * String * * A description of the purpose of the API key. * * UpdateType: Mutable * Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-apikey.html#cfn-apigateway-apikey-description */ Description?: C.CFString; /** * Boolean * * Indicates whether the API key can be used by clients. * * UpdateType: Mutable * Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-apikey.html#cfn-apigateway-apikey-enabled */ Enabled?: C.CFBoolean; /** * Boolean * * Specifies whether the key identifier is distinct from the created API key value. * * UpdateType: Immutable * Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-apikey.html#cfn-apigateway-apikey-generatedistinctid */ GenerateDistinctId?: C.CFBoolean; /** * String * * A name for the API key. If you don't specify a name, AWS CloudFormation generates a unique physical ID and uses that ID for the API key name. For more information, see Name Type. * * UpdateType: Immutable * Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-apikey.html#cfn-apigateway-apikey-name */ Name?: C.CFString; /** * List of Amazon API Gateway ApiKey StageKey property types * * A list of stages to associate with this API key. * * UpdateType: Mutable * Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-apikey.html#cfn-apigateway-apikey-stagekeys */ StageKeys?: C.CFList<AWS.ApiGateway.ApiKey.StageKey>; } } export declare namespace AWS.ApiGateway.ApiKey { interface StageKey { /** * * * * * UpdateType: Mutable * Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apigateway-apikey-stagekey.html#cfn-apigateway-apikey-stagekey-restapiid */ RestApiId?: C.CFString; /** * * * * * UpdateType: Mutable * Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apigateway-apikey-stagekey.html#cfn-apigateway-apikey-stagekey-stagename */ StageName?: C.CFString; } } export declare namespace AWS.ApiGateway { /** * The AWS::ApiGateway::Authorizer resource creates an authorization layer that Amazon API Gateway (API Gateway) activates for methods that have authorization enabled. API Gateway activates the authorizer when a client calls those methods. * * Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-authorizer.html */ interface Authorizer extends C.CommonResourceProps { Type: 'AWS::ApiGateway::Authorizer'; Properties: AWS.ApiGateway.Authorizer.Properties; } /** * The AWS::ApiGateway::Authorizer resource creates an authorization layer that Amazon API Gateway (API Gateway) activates for methods that have authorization enabled. API Gateway activates the authorizer when a client calls those methods. * * Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-authorizer.html */ function Authorizer(props: C.Omit<Authorizer, 'Type'>): Authorizer; } export declare namespace AWS.ApiGateway.Authorizer { interface Properties { /** * String * * An optional customer-defined field that's used in Swagger imports and exports without functional impact. * * UpdateType: Mutable * Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-authorizer.html#cfn-apigateway-authorizer-authtype */ AuthType?: C.CFString; /** * String * * The credentials that are required for the authorizer. To specify an AWS Identity and Access Management (IAM) role that API Gateway assumes, specify the role's Amazon Resource Name (ARN). To use resource-based permissions on the AWS Lambda (Lambda) function, specify null. * * UpdateType: Mutable * Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-authorizer.html#cfn-apigateway-authorizer-authorizercredentials */ AuthorizerCredentials?: C.CFString; /** * Integer * * The time-to-live (TTL) period, in seconds, that specifies how long API Gateway caches authorizer results. If you specify a value greater than 0, API Gateway caches the authorizer responses. By default, API Gateway sets this property to 300. The maximum value is 3600, or 1 hour. * * UpdateType: Mutable * Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-authorizer.html#cfn-apigateway-authorizer-authorizerresultttlinseconds */ AuthorizerResultTtlInSeconds?: C.CFInteger; /** * String * * The authorizer's Uniform Resource Identifier (URI). If you specify TOKEN for the authorizer's Type property, specify a Lambda function URI that has the form arn:aws:apigateway:region:lambda:path/path. The path usually has the form /2015-03-31/functions/LambdaFunctionARN/invocations. * * UpdateType: Mutable * Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-authorizer.html#cfn-apigateway-authorizer-authorizeruri */ AuthorizerUri?: C.CFString; /** * String * * The source of the identity in an incoming request. If you specify TOKEN for the authorizer's Type property, specify a mapping expression. The custom header mapping expression has the form method.request.header.name, where name is the name of a custom authorization header that clients submit as part of their requests. * * UpdateType: Mutable * Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-authorizer.html#cfn-apigateway-authorizer-identitysource */ IdentitySource?: C.CFString; /** * String * * A validation expression for the incoming identity. If you specify TOKEN for the authorizer's Type property, specify a regular expression. API Gateway uses the expression to attempt to match the incoming client token, and proceeds if the token matches. If the token doesn't match, API Gateway responds with a 401 (unauthorized request) error code. * * UpdateType: Mutable * Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-authorizer.html#cfn-apigateway-authorizer-identityvalidationexpression */ IdentityValidationExpression?: C.CFString; /** * String * * The name of the authorizer. * * UpdateType: Mutable * Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-authorizer.html#cfn-apigateway-authorizer-name */ Name?: C.CFString; /** * List of String values * * A list of the Amazon Cognito user pool Amazon Resource Names (ARNs) to associate with this authorizer. For more information, see Use Amazon Cognito Your User Pool in the API Gateway Developer Guide. * * UpdateType: Mutable * Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-authorizer.html#cfn-apigateway-authorizer-providerarns */ ProviderARNs?: C.CFList<C.CFString>; /** * String * * The ID of the RestApi resource that API Gateway creates the authorizer in. * * UpdateType: Immutable * Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-authorizer.html#cfn-apigateway-authorizer-restapiid */ RestApiId: C.CFString; /** * String * * The type of authorizer. Valid values include: * * UpdateType: Mutable * Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-authorizer.html#cfn-apigateway-authorizer-type */ Type?: C.CFString; } } export declare namespace AWS.ApiGateway { /** * The AWS::ApiGateway::BasePathMapping resource creates a base path that clients who call your Amazon API Gateway API must use in the invocation URL. * * Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-basepathmapping.html */ interface BasePathMapping extends C.CommonResourceProps { Type: 'AWS::ApiGateway::BasePathMapping'; Properties: AWS.ApiGateway.BasePathMapping.Properties; } /** * The AWS::ApiGateway::BasePathMapping resource creates a base path that clients who call your Amazon API Gateway API must use in the invocation URL. * * Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-basepathmapping.html */ function BasePathMapping(props: C.Omit<BasePathMapping, 'Type'>): BasePathMapping; } export declare namespace AWS.ApiGateway.BasePathMapping { interface Properties { /** * String * * The base path name that callers of the API must provide in the URL after the domain name. If you specify this property, it can't be an empty string. * * UpdateType: Immutable * Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-basepathmapping.html#cfn-apigateway-basepathmapping-basepath */ BasePath?: C.CFString; /** * String * * The domain name of a DomainName resource. * * UpdateType: Immutable * Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-basepathmapping.html#cfn-apigateway-basepathmapping-domainname */ DomainName: C.CFString; /** * String * * The name of the API. * * UpdateType: Mutable * Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-basepathmapping.html#cfn-apigateway-basepathmapping-restapiid */ RestApiId?: C.CFString; /** * String * * The name of the API's stage. * * UpdateType: Mutable * Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-basepathmapping.html#cfn-apigateway-basepathmapping-stage */ Stage?: C.CFString; } } export declare namespace AWS.ApiGateway { /** * The AWS::ApiGateway::ClientCertificate resource creates a client certificate that Amazon API Gateway (API Gateway) uses to configure client-side SSL authentication for sending requests to the integration endpoint. * * Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-clientcertificate.html */ interface ClientCertificate extends C.CommonResourceProps { Type: 'AWS::ApiGateway::ClientCertificate'; Properties: AWS.ApiGateway.ClientCertificate.Properties; } /** * The AWS::ApiGateway::ClientCertificate resource creates a client certificate that Amazon API Gateway (API Gateway) uses to configure client-side SSL authentication for sending requests to the integration endpoint. * * Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-clientcertificate.html */ function ClientCertificate(props: C.Omit<ClientCertificate, 'Type'>): ClientCertificate; } export declare namespace AWS.ApiGateway.ClientCertificate { interface Properties { /** * String * * A description of the client certificate. * * UpdateType: Mutable * Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-clientcertificate.html#cfn-apigateway-clientcertificate-description */ Description?: C.CFString; } } export declare namespace AWS.ApiGateway { /** * The AWS::ApiGateway::Deployment resource deploys an Amazon API Gateway (API Gateway) RestApi resource to a stage so that clients can call the API over the Internet. The stage acts as an environment. * * Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-deployment.html */ interface Deployment extends C.CommonResourceProps { Type: 'AWS::ApiGateway::Deployment'; Properties: AWS.ApiGateway.Deployment.Properties; } /** * The AWS::ApiGateway::Deployment resource deploys an Amazon API Gateway (API Gateway) RestApi resource to a stage so that clients can call the API over the Internet. The stage acts as an environment. * * Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-deployment.html */ function Deployment(props: C.Omit<Deployment, 'Type'>): Deployment; } export declare namespace AWS.ApiGateway.Deployment { interface Properties { /** * String * * A description of the purpose of the API Gateway deployment. * * UpdateType: Mutable * Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-deployment.html#cfn-apigateway-deployment-description */ Description?: C.CFString; /** * String * * The ID of the RestApi resource to deploy. * * UpdateType: Immutable * Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-deployment.html#cfn-apigateway-deployment-restapiid */ RestApiId: C.CFString; /** * Amazon API Gateway Deployment StageDescription * * Configures the stage that API Gateway creates with this deployment. * * UpdateType: Mutable * Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-deployment.html#cfn-apigateway-deployment-stagedescription */ StageDescription?: AWS.ApiGateway.Deployment.StageDescription; /** * String * * A name for the stage that API Gateway creates with this deployment. Use only alphanumeric characters. * * UpdateType: Mutable * Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-deployment.html#cfn-apigateway-deployment-stagename */ StageName?: C.CFString; } } export declare namespace AWS.ApiGateway.Deployment { interface MethodSetting { /** * Boolean * * Indicates whether the cached responses are encrypted. * * UpdateType: Mutable * Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apigateway-deployment-stagedescription-methodsetting.html#cfn-apigateway-deployment-stagedescription-methodsetting-cachedataencrypted */ CacheDataEncrypted?: C.CFBoolean; /** * Integer * * The time-to-live (TTL) period, in seconds, that specifies how long API Gateway caches responses. * * UpdateType: Mutable * Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apigateway-deployment-stagedescription-methodsetting.html#cfn-apigateway-deployment-stagedescription-methodsetting-cachettlinseconds */ CacheTtlInSeconds?: C.CFInteger; /** * Boolean * * Indicates whether responses are cached and returned for requests. You must enable a cache cluster on the stage to cache responses. For more information, see Enable API Gateway Caching in a Stage to Enhance API Performance in the API Gateway Developer Guide. * * UpdateType: Mutable * Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apigateway-deployment-stagedescription-methodsetting.html#cfn-apigateway-deployment-stagedescription-methodsetting-cachingenabled */ CachingEnabled?: C.CFBoolean; /** * Boolean * * Indicates whether data trace logging is enabled for methods in the stage. API Gateway pushes these logs to Amazon CloudWatch Logs. * * UpdateType: Mutable * Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apigateway-deployment-stagedescription-methodsetting.html#cfn-apigateway-deployment-stagedescription-methodsetting-datatraceenabled */ DataTraceEnabled?: C.CFBoolean; /** * String * * The HTTP method. * * UpdateType: Mutable * Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apigateway-deployment-stagedescription-methodsetting.html#cfn-apigateway-deployment-stagedescription-methodsetting-httpmethod */ HttpMethod?: C.CFString; /** * String * * The logging level for this method. For valid values, see the loggingLevel property of the Stage resource in the Amazon API Gateway API Reference. * * UpdateType: Mutable * Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apigateway-deployment-stagedescription-methodsetting.html#cfn-apigateway-deployment-stagedescription-methodsetting-logginglevel */ LoggingLevel?: C.CFString; /** * Boolean * * Indicates whether Amazon CloudWatch metrics are enabled for methods in the stage. * * UpdateType: Mutable * Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apigateway-deployment-stagedescription-methodsetting.html#cfn-apigateway-deployment-stagedescription-methodsetting-metricsenabled */ MetricsEnabled?: C.CFBoolean; /** * String * * The resource path for this method. Forward slashes (/) are encoded as ~1 and the initial slash must include a forward slash. For example, the path value /resource/subresource must be encoded as /~1resource~1subresource. To specify the root path, use only a slash (/). * * UpdateType: Mutable * Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apigateway-deployment-stagedescription-methodsetting.html#cfn-apigateway-deployment-stagedescription-methodsetting-resourcepath */ ResourcePath?: C.CFString; /** * Integer * * The number of burst requests per second that API Gateway permits across all APIs, stages, and methods in your AWS account. For more information, see Manage API Request Throttling in the API Gateway Developer Guide. * * UpdateType: Mutable * Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apigateway-deployment-stagedescription-methodsetting.html#cfn-apigateway-deployment-stagedescription-methodsetting-throttlingburstlimit */ ThrottlingBurstLimit?: C.CFInteger; /** * Number * * The number of steady-state requests per second that API Gateway permits across all APIs, stages, and methods in your AWS account. For more information, see Manage API Request Throttling in the API Gateway Developer Guide. * * UpdateType: Mutable * Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apigateway-deployment-stagedescription-methodsetting.html#cfn-apigateway-deployment-stagedescription-methodsetting-throttlingratelimit */ ThrottlingRateLimit?: C.CFDouble; } } export declare namespace AWS.ApiGateway.Deployment { interface StageDescription { /** * Boolean * * Indicates whether cache clustering is enabled for the stage. * * UpdateType: Mutable * Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apigateway-deployment-stagedescription.html#cfn-apigateway-deployment-stagedescription-cacheclusterenabled */ CacheClusterEnabled?: C.CFBoolean; /** * String * * The size of the stage's cache cluster. * * UpdateType: Mutable * Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apigateway-deployment-stagedescription.html#cfn-apigateway-deployment-stagedescription-cacheclustersize */ CacheClusterSize?: C.CFString; /** * Boolean * * Indicates whether the cached responses are encrypted. * * UpdateType: Mutable * Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apigateway-deployment-stagedescription.html#cfn-apigateway-deployment-stagedescription-cachedataencrypted */ CacheDataEncrypted?: C.CFBoolean; /** * Integer * * The time-to-live (TTL) period, in seconds, that specifies how long API Gateway caches responses. * * UpdateType: Mutable * Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apigateway-deployment-stagedescription.html#cfn-apigateway-deployment-stagedescription-cachettlinseconds */ CacheTtlInSeconds?: C.CFInteger; /** * Boolean * * Indicates whether responses are cached and returned for requests. You must enable a cache cluster on the stage to cache responses. For more information, see Enable API Gateway Caching in a Stage to Enhance API Performance in the API Gateway Developer Guide. * * UpdateType: Mutable * Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apigateway-deployment-stagedescription.html#cfn-apigateway-deployment-stagedescription-cachingenabled */ CachingEnabled?: C.CFBoolean; /** * String * * The identifier of the client certificate that API Gateway uses to call your integration endpoints in the stage. * * UpdateType: Mutable * Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apigateway-deployment-stagedescription.html#cfn-apigateway-deployment-stagedescription-clientcertificateid */ ClientCertificateId?: C.CFString; /** * Boolean * * Indicates whether data trace logging is enabled for methods in the stage. API Gateway pushes these logs to Amazon CloudWatch Logs. * * UpdateType: Mutable * Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apigateway-deployment-stagedescription.html#cfn-apigateway-deployment-stagedescription-datatraceenabled */ DataTraceEnabled?: C.CFBoolean; /** * String * * A description of the purpose of the stage. * * UpdateType: Mutable * Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apigateway-deployment-stagedescription.html#cfn-apigateway-deployment-stagedescription-description */ Description?: C.CFString; /** * String * * The version identifier of the API documentation snapshot. * * UpdateType: Mutable * Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apigateway-deployment-stagedescription.html#cfn-apigateway-deployment-stagedescription-documentationversion */ DocumentationVersion?: C.CFString; /** * String * * The logging level for this method. For valid values, see the loggingLevel property of the Stage resource in the Amazon API Gateway API Reference. * * UpdateType: Mutable * Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apigateway-deployment-stagedescription.html#cfn-apigateway-deployment-stagedescription-logginglevel */ LoggingLevel?: C.CFString; /** * List of API Gateway Deployment MethodSetting * * Configures settings for all of the stage's methods. * * UpdateType: Mutable * Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apigateway-deployment-stagedescription.html#cfn-apigateway-deployment-stagedescription-methodsettings */ MethodSettings?: C.CFList<AWS.ApiGateway.Deployment.MethodSetting>; /** * Boolean * * Indicates whether Amazon CloudWatch metrics are enabled for methods in the stage. * * UpdateType: Mutable * Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apigateway-deployment-stagedescription.html#cfn-apigateway-deployment-stagedescription-metricsenabled */ MetricsEnabled?: C.CFBoolean; /** * Integer * * The number of burst requests per second that API Gateway permits across all APIs, stages, and methods in your AWS account. For more information, see Manage API Request Throttling in the API Gateway Developer Guide. * * UpdateType: Mutable * Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apigateway-deployment-stagedescription.html#cfn-apigateway-deployment-stagedescription-throttlingburstlimit */ ThrottlingBurstLimit?: C.CFInteger; /** * Number * * The number of steady-state requests per second that API Gateway permits across all APIs, stages, and methods in your AWS account. For more information, see Manage API Request Throttling in the API Gateway Developer Guide. * * UpdateType: Mutable * Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apigateway-deployment-stagedescription.html#cfn-apigateway-deployment-stagedescription-throttlingratelimit */ ThrottlingRateLimit?: C.CFDouble; /** * Mapping of key-value pairs * * A map that defines the stage variables. Variable names must consist of alphanumeric characters, and the values must match the following regular expression: [A-Za-z0-9-._~:/?#&=,]+. * * UpdateType: Mutable * Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apigateway-deployment-stagedescription.html#cfn-apigateway-deployment-stagedescription-variables */ Variables?: C.CFMap<C.CFString>; } } export declare namespace AWS.ApiGateway { /** * The AWS::ApiGateway::DocumentationPart resource creates a documentation part for an Amazon API Gateway API entity. For more information, see Representation of API Documentation in API Gateway in the API Gateway Developer Guide. * * Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-documentationpart.html */ interface DocumentationPart extends C.CommonResourceProps { Type: 'AWS::ApiGateway::DocumentationPart'; Properties: AWS.ApiGateway.DocumentationPart.Properties; } /** * The AWS::ApiGateway::DocumentationPart resource creates a documentation part for an Amazon API Gateway API entity. For more information, see Representation of API Documentation in API Gateway in the API Gateway Developer Guide. * * Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-documentationpart.html */ function DocumentationPart(props: C.Omit<DocumentationPart, 'Type'>): DocumentationPart; } export declare namespace AWS.ApiGateway.DocumentationPart { interface Properties { /** * Type: Amazon API Gateway DocumentationPart Location * * The location of the API entity that the documentation applies to. * * UpdateType: Immutable * Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-documentationpart.html#cfn-apigateway-documentationpart-location */ Location: AWS.ApiGateway.DocumentationPart.Location; /** * String * * The documentation content map of the targeted API entity. * * UpdateType: Mutable * Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-documentationpart.html#cfn-apigateway-documentationpart-properties */ Properties: C.CFString; /** * String * * The identifier of the targeted API entity. * * UpdateType: Immutable * Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-documentationpart.html#cfn-apigateway-documentationpart-restapiid */ RestApiId: C.CFString; } } export declare namespace AWS.ApiGateway.DocumentationPart { interface Location { /** * String * * The HTTP verb of a method. * * UpdateType: Immutable * Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apigateway-documentationpart-location.html#cfn-apigateway-documentationpart-location-method */ Method?: C.CFString; /** * String * * The name of the targeted API entity. * * UpdateType: Immutable * Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-prop