Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Automated SDK generation @ aws-cloudformation-user-guide 19dc52cd3f2007d6d268b65b739ffb5ebf8c1e76 #1899

Merged
merged 3 commits into from
Dec 11, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
The table of contents is too big for display.
Diff view
Diff view
  •  
  •  
  •  
2 changes: 1 addition & 1 deletion .docs.version
Original file line number Diff line number Diff line change
@@ -1 +1 @@
d9a7a3f3043f4f8b764c54129f8d3316d8822ecd
5c197d5a1e30d3254088221de8e3b1f82d37b8dd
9 changes: 3 additions & 6 deletions aws-cloudformation-schema/aws-apigateway-domainnamev2.json
Original file line number Diff line number Diff line change
Expand Up @@ -44,9 +44,6 @@
"Policy" : {
"type" : [ "object", "string" ]
},
"ManagementPolicy" : {
"type" : [ "object", "string" ]
},
"DomainNameId" : {
"type" : "string"
},
Expand Down Expand Up @@ -75,16 +72,16 @@
"readOnlyProperties" : [ "/properties/DomainNameId", "/properties/DomainNameArn" ],
"handlers" : {
"create" : {
"permissions" : [ "apigateway:POST", "apigateway:GET", "apigateway:UpdateDomainNamePolicy", "apigateway:UpdateDomainNameManagementPolicy" ]
"permissions" : [ "apigateway:POST", "apigateway:GET", "apigateway:UpdateDomainNamePolicy" ]
},
"read" : {
"permissions" : [ "apigateway:GET" ]
},
"update" : {
"permissions" : [ "apigateway:GET", "apigateway:PUT", "apigateway:PATCH", "apigateway:UpdateDomainNamePolicy", "apigateway:UpdateDomainNameManagementPolicy" ]
"permissions" : [ "apigateway:GET", "apigateway:PUT", "apigateway:PATCH", "apigateway:UpdateDomainNamePolicy" ]
},
"delete" : {
"permissions" : [ "apigateway:DELETE", "apigateway:GET", "apigateway:UpdateDomainNamePolicy", "apigateway:UpdateDomainNameManagementPolicy" ]
"permissions" : [ "apigateway:DELETE", "apigateway:GET", "apigateway:UpdateDomainNamePolicy" ]
},
"list" : {
"permissions" : [ "apigateway:GET" ]
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -42,28 +42,28 @@
"additionalProperties" : false,
"definitions" : {
"PredictiveScalingMetricDataQuery" : {
"description" : "",
"description" : "The metric data to return. Also defines whether this call is returning data for one metric only, or whether it is performing a math expression on the values of returned metric statistics to create a new time series. A time series is a series of data points, each of which is associated with a timestamp.",
"additionalProperties" : false,
"type" : "object",
"properties" : {
"ReturnData" : {
"description" : "Indicates whether to return the timestamps and raw data values of this metric.",
"description" : "Indicates whether to return the timestamps and raw data values of this metric. \n If you use any math expressions, specify ``true`` for this value for only the final math expression that the metric specification is based on. You must specify ``false`` for ``ReturnData`` for all the other metrics and expressions used in the metric specification.\n If you are only retrieving metrics and not performing any math expressions, do not specify anything for ``ReturnData``. This sets it to its default (``true``).",
"type" : "boolean"
},
"Expression" : {
"description" : "The math expression to perform on the returned data, if this object is performing a math expression.",
"description" : "The math expression to perform on the returned data, if this object is performing a math expression. This expression can use the ``Id`` of the other metrics to refer to those metrics, and can also use the ``Id`` of other expressions to use the result of those expressions. \n Conditional: Within each ``MetricDataQuery`` object, you must specify either ``Expression`` or ``MetricStat``, but not both.",
"type" : "string"
},
"Label" : {
"description" : "A human-readable label for this metric or expression. This is especially useful if this is a math expression, so that you know what the value represents.",
"type" : "string"
},
"MetricStat" : {
"description" : "Information about the metric data to return.",
"description" : "Information about the metric data to return. \n Conditional: Within each ``MetricDataQuery`` object, you must specify either ``Expression`` or ``MetricStat``, but not both.",
"$ref" : "#/definitions/PredictiveScalingMetricStat"
},
"Id" : {
"description" : "A short name that identifies the object's results in the response.",
"description" : "A short name that identifies the object's results in the response. This name must be unique among all ``MetricDataQuery`` objects specified for a single scaling policy. If you are performing math expressions on this set of data, this name represents that data and can serve as a variable in the mathematical expression. The valid characters are letters, numbers, and underscores. The first character must be a lowercase letter.",
"type" : "string"
}
}
Expand All @@ -88,7 +88,7 @@
}
},
"PredictiveScalingMetricDimension" : {
"description" : "",
"description" : "Describes the dimension of a metric.",
"additionalProperties" : false,
"type" : "object",
"properties" : {
Expand Down Expand Up @@ -118,12 +118,13 @@
}
},
"PredictiveScalingCustomizedCapacityMetric" : {
"description" : "",
"description" : "Represents a CloudWatch metric of your choosing for a predictive scaling policy.",
"additionalProperties" : false,
"type" : "object",
"properties" : {
"MetricDataQueries" : {
"uniqueItems" : true,
"description" : "One or more metric data queries to provide data points for a metric specification.",
"insertionOrder" : false,
"type" : "array",
"items" : {
Expand Down Expand Up @@ -161,12 +162,13 @@
}
},
"PredictiveScalingCustomizedScalingMetric" : {
"description" : "",
"description" : "One or more metric data queries to provide data points for a metric specification.",
"additionalProperties" : false,
"type" : "object",
"properties" : {
"MetricDataQueries" : {
"uniqueItems" : true,
"description" : "One or more metric data queries to provide data points for a metric specification.",
"insertionOrder" : false,
"type" : "array",
"items" : {
Expand Down Expand Up @@ -218,14 +220,16 @@
}
},
"PredictiveScalingPredefinedLoadMetric" : {
"description" : "",
"description" : "Describes a load metric for a predictive scaling policy. \n When returned in the output of ``DescribePolicies``, it indicates that a predictive scaling policy uses individually specified load and scaling metrics instead of a metric pair.",
"additionalProperties" : false,
"type" : "object",
"properties" : {
"PredefinedMetricType" : {
"description" : "The metric type.",
"type" : "string"
},
"ResourceLabel" : {
"description" : "A label that uniquely identifies a target group.",
"type" : "string"
}
},
Expand Down Expand Up @@ -264,14 +268,16 @@
"required" : [ "TargetValue" ]
},
"PredictiveScalingPredefinedMetricPair" : {
"description" : "",
"description" : "Represents a metric pair for a predictive scaling policy.",
"additionalProperties" : false,
"type" : "object",
"properties" : {
"PredefinedMetricType" : {
"description" : "Indicates which metrics to use. There are two different types of metrics for each metric type: one is a load metric and one is a scaling metric.",
"type" : "string"
},
"ResourceLabel" : {
"description" : "A label that uniquely identifies a specific target group from which to determine the total and average request count.",
"type" : "string"
}
},
Expand Down Expand Up @@ -330,78 +336,92 @@
"required" : [ "Value", "Name" ]
},
"PredictiveScalingPolicyConfiguration" : {
"description" : "",
"description" : "Represents a predictive scaling policy configuration.",
"additionalProperties" : false,
"type" : "object",
"properties" : {
"MaxCapacityBreachBehavior" : {
"description" : "Defines the behavior that should be applied if the forecast capacity approaches or exceeds the maximum capacity. Defaults to ``HonorMaxCapacity`` if not specified.",
"type" : "string"
},
"MaxCapacityBuffer" : {
"description" : "The size of the capacity buffer to use when the forecast capacity is close to or exceeds the maximum capacity. The value is specified as a percentage relative to the forecast capacity. For example, if the buffer is 10, this means a 10 percent buffer, such that if the forecast capacity is 50, and the maximum capacity is 40, then the effective maximum capacity is 55. \n Required if the ``MaxCapacityBreachBehavior`` property is set to ``IncreaseMaxCapacity``, and cannot be used otherwise.",
"type" : "integer"
},
"Mode" : {
"description" : "The predictive scaling mode. Defaults to ``ForecastOnly`` if not specified.",
"type" : "string"
},
"MetricSpecifications" : {
"uniqueItems" : true,
"description" : "This structure includes the metrics and target utilization to use for predictive scaling. \n This is an array, but we currently only support a single metric specification. That is, you can specify a target value and a single metric pair, or a target value and one scaling metric and one load metric.",
"insertionOrder" : false,
"type" : "array",
"items" : {
"$ref" : "#/definitions/PredictiveScalingMetricSpecification"
}
},
"SchedulingBufferTime" : {
"description" : "The amount of time, in seconds, that the start time can be advanced. \n The value must be less than the forecast interval duration of 3600 seconds (60 minutes). Defaults to 300 seconds if not specified.",
"type" : "integer"
}
},
"required" : [ "MetricSpecifications" ]
},
"PredictiveScalingPredefinedScalingMetric" : {
"description" : "",
"description" : "Describes a scaling metric for a predictive scaling policy. \n When returned in the output of ``DescribePolicies``, it indicates that a predictive scaling policy uses individually specified load and scaling metrics instead of a metric pair.",
"additionalProperties" : false,
"type" : "object",
"properties" : {
"PredefinedMetricType" : {
"description" : "The metric type.",
"type" : "string"
},
"ResourceLabel" : {
"description" : "A label that uniquely identifies a specific target group from which to determine the average request count.",
"type" : "string"
}
},
"required" : [ "PredefinedMetricType" ]
},
"PredictiveScalingMetricSpecification" : {
"description" : "",
"description" : "This structure specifies the metrics and target utilization settings for a predictive scaling policy. \n You must specify either a metric pair, or a load metric and a scaling metric individually. Specifying a metric pair instead of individual metrics provides a simpler way to configure metrics for a scaling policy. You choose the metric pair, and the policy automatically knows the correct sum and average statistics to use for the load metric and the scaling metric.",
"additionalProperties" : false,
"type" : "object",
"properties" : {
"CustomizedLoadMetricSpecification" : {
"description" : "The customized load metric specification.",
"$ref" : "#/definitions/PredictiveScalingCustomizedLoadMetric"
},
"PredefinedLoadMetricSpecification" : {
"description" : "The predefined load metric specification.",
"$ref" : "#/definitions/PredictiveScalingPredefinedLoadMetric"
},
"TargetValue" : {
"description" : "Specifies the target utilization.",
"type" : "number"
},
"PredefinedScalingMetricSpecification" : {
"description" : "The predefined scaling metric specification.",
"$ref" : "#/definitions/PredictiveScalingPredefinedScalingMetric"
},
"CustomizedCapacityMetricSpecification" : {
"description" : "The customized capacity metric specification.",
"$ref" : "#/definitions/PredictiveScalingCustomizedCapacityMetric"
},
"CustomizedScalingMetricSpecification" : {
"description" : "The customized scaling metric specification.",
"$ref" : "#/definitions/PredictiveScalingCustomizedScalingMetric"
},
"PredefinedMetricPairSpecification" : {
"description" : "The predefined metric pair specification that determines the appropriate scaling metric and load metric to use.",
"$ref" : "#/definitions/PredictiveScalingPredefinedMetricPair"
}
},
"required" : [ "TargetValue" ]
},
"PredictiveScalingMetric" : {
"description" : "",
"description" : "Describes the scaling metric.",
"additionalProperties" : false,
"type" : "object",
"properties" : {
Expand All @@ -411,7 +431,7 @@
},
"Dimensions" : {
"uniqueItems" : false,
"description" : "The dimensions for the metric.",
"description" : "Describes the dimensions of the metric.",
"insertionOrder" : false,
"type" : "array",
"items" : {
Expand All @@ -425,12 +445,13 @@
}
},
"PredictiveScalingCustomizedLoadMetric" : {
"description" : "",
"description" : "The customized load metric specification.",
"additionalProperties" : false,
"type" : "object",
"properties" : {
"MetricDataQueries" : {
"uniqueItems" : true,
"description" : "",
"insertionOrder" : false,
"type" : "array",
"items" : {
Expand Down Expand Up @@ -465,20 +486,20 @@
}
},
"PredictiveScalingMetricStat" : {
"description" : "",
"description" : "This structure defines the CloudWatch metric to return, along with the statistic and unit.",
"additionalProperties" : false,
"type" : "object",
"properties" : {
"Stat" : {
"description" : "The statistic to return. It can include any CloudWatch statistic or extended statistic.",
"description" : "The statistic to return. It can include any CloudWatch statistic or extended statistic. For a list of valid values, see the table in [Statistics](https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/cloudwatch_concepts.html#Statistic) in the *Amazon CloudWatch User Guide*. \n The most commonly used metrics for predictive scaling are ``Average`` and ``Sum``.",
"type" : "string"
},
"Metric" : {
"description" : "The CloudWatch metric to return, including the metric name, namespace, and dimensions. ",
"description" : "The CloudWatch metric to return, including the metric name, namespace, and dimensions. To get the exact metric name, namespace, and dimensions, inspect the [Metric](https://docs.aws.amazon.com/AmazonCloudWatch/latest/APIReference/API_Metric.html) object that is returned by a call to [ListMetrics](https://docs.aws.amazon.com/AmazonCloudWatch/latest/APIReference/API_ListMetrics.html).",
"$ref" : "#/definitions/PredictiveScalingMetric"
},
"Unit" : {
"description" : "The unit to use for the returned data points.",
"description" : "The unit to use for the returned data points. For a complete list of the units that CloudWatch supports, see the [MetricDatum](https://docs.aws.amazon.com/AmazonCloudWatch/latest/APIReference/API_MetricDatum.html) data type in the *Amazon CloudWatch API Reference*.",
"type" : "string"
}
}
Expand Down Expand Up @@ -554,7 +575,7 @@
"$ref" : "#/definitions/StepScalingPolicyConfiguration"
},
"PredictiveScalingPolicyConfiguration" : {
"description" : "",
"description" : "The predictive scaling policy configuration.",
"$ref" : "#/definitions/PredictiveScalingPolicyConfiguration"
}
}
Expand Down
2 changes: 1 addition & 1 deletion aws-cloudformation-schema/aws-backup-backupselection.json
Original file line number Diff line number Diff line change
Expand Up @@ -143,7 +143,7 @@
"permissions" : [ "backup:CreateBackupSelection", "iam:GetRole", "iam:PassRole", "iam:CreateServiceLinkedRole" ]
},
"list" : {
"permissions" : [ "backup:ListBackupSelections" ]
"permissions" : [ "backup:ListBackupSelections", "backup:ListBackupPlans" ]
}
}
}
Original file line number Diff line number Diff line change
Expand Up @@ -105,7 +105,7 @@
"timeoutInMinutes" : 5
},
"list" : {
"permissions" : [ "backup:ListRestoreTestingSelections" ],
"permissions" : [ "backup:ListRestoreTestingSelections", "backup:ListRestoreTestingPlans" ],
"timeoutInMinutes" : 5
}
}
Expand Down
5 changes: 5 additions & 0 deletions aws-cloudformation-schema/aws-connect-tasktemplate.json
Original file line number Diff line number Diff line change
Expand Up @@ -193,6 +193,11 @@
"type" : "string",
"pattern" : "^$|arn:aws[-a-z0-9]*:connect:[-a-z0-9]*:[0-9]{12}:instance/[-a-zA-Z0-9]*/contact-flow/[-a-zA-Z0-9]*$"
},
"SelfAssignContactFlowArn" : {
"description" : "The identifier of the contact flow.",
"type" : "string",
"pattern" : "^$|arn:aws[-a-z0-9]*:connect:[-a-z0-9]*:[0-9]{12}:instance/[-a-zA-Z0-9]*/contact-flow/[-a-zA-Z0-9]*$"
},
"Constraints" : {
"description" : "The constraints for the task template",
"type" : "object",
Expand Down
2 changes: 1 addition & 1 deletion aws-cloudformation-schema/aws-dynamodb-table.json
Original file line number Diff line number Diff line change
Expand Up @@ -476,7 +476,7 @@
"$ref" : "#/definitions/ContributorInsightsSpecification"
},
"ImportSourceSpecification" : {
"description" : "Specifies the properties of data being imported from the S3 bucket source to the table.\n If you specify the ``ImportSourceSpecification`` property, and also specify either the ``StreamSpecification``, the ``TableClass`` property, or the ``DeletionProtectionEnabled`` property, the IAM entity creating/updating stack must have ``UpdateTable`` permission.",
"description" : "Specifies the properties of data being imported from the S3 bucket source to the\" table.\n If you specify the ``ImportSourceSpecification`` property, and also specify either the ``StreamSpecification``, the ``TableClass`` property, the ``DeletionProtectionEnabled`` property, or the ``WarmThroughput`` property, the IAM entity creating/updating stack must have ``UpdateTable`` permission.",
"$ref" : "#/definitions/ImportSourceSpecification"
},
"PointInTimeRecoverySpecification" : {
Expand Down
2 changes: 1 addition & 1 deletion aws-cloudformation-schema/aws-ec2-customergateway.json
Original file line number Diff line number Diff line change
Expand Up @@ -83,7 +83,7 @@
}
},
"CertificateArn" : {
"pattern" : "^arn:(aws[a-zA-Z-]*)?:acm:[a-z]{2}((-gov)|(-iso(b?)))?-[a-z]+-\\d{1}:\\d{12}:certificate\\/[a-zA-Z0-9-_]+$",
"pattern" : "^arn:(aws[a-zA-Z-]*)?:acm:[a-z]{2}((-gov)|(-iso([a-z]{1})?))?-[a-z]+-\\d{1}:\\d{12}:certificate\\/[a-zA-Z0-9-_]+$",
"description" : "The Amazon Resource Name (ARN) for the customer gateway certificate.",
"type" : "string"
},
Expand Down
Loading
Loading