diff --git a/.docs.version b/.docs.version index 1fec3807c4..fa14a31928 100644 --- a/.docs.version +++ b/.docs.version @@ -1 +1 @@ -d9a7a3f3043f4f8b764c54129f8d3316d8822ecd +5c197d5a1e30d3254088221de8e3b1f82d37b8dd diff --git a/aws-cloudformation-schema/aws-apigateway-domainnamev2.json b/aws-cloudformation-schema/aws-apigateway-domainnamev2.json index 88cf2404bd..50e9f54f2e 100644 --- a/aws-cloudformation-schema/aws-apigateway-domainnamev2.json +++ b/aws-cloudformation-schema/aws-apigateway-domainnamev2.json @@ -44,9 +44,6 @@ "Policy" : { "type" : [ "object", "string" ] }, - "ManagementPolicy" : { - "type" : [ "object", "string" ] - }, "DomainNameId" : { "type" : "string" }, @@ -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" ] diff --git a/aws-cloudformation-schema/aws-applicationautoscaling-scalingpolicy.json b/aws-cloudformation-schema/aws-applicationautoscaling-scalingpolicy.json index d123542583..49626b3bf0 100644 --- a/aws-cloudformation-schema/aws-applicationautoscaling-scalingpolicy.json +++ b/aws-cloudformation-schema/aws-applicationautoscaling-scalingpolicy.json @@ -42,16 +42,16 @@ "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" : { @@ -59,11 +59,11 @@ "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" } } @@ -88,7 +88,7 @@ } }, "PredictiveScalingMetricDimension" : { - "description" : "", + "description" : "Describes the dimension of a metric.", "additionalProperties" : false, "type" : "object", "properties" : { @@ -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" : { @@ -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" : { @@ -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" } }, @@ -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" } }, @@ -330,21 +336,25 @@ "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" : { @@ -352,56 +362,66 @@ } }, "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" : { @@ -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" : { @@ -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" : { @@ -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" } } @@ -554,7 +575,7 @@ "$ref" : "#/definitions/StepScalingPolicyConfiguration" }, "PredictiveScalingPolicyConfiguration" : { - "description" : "", + "description" : "The predictive scaling policy configuration.", "$ref" : "#/definitions/PredictiveScalingPolicyConfiguration" } } diff --git a/aws-cloudformation-schema/aws-backup-backupselection.json b/aws-cloudformation-schema/aws-backup-backupselection.json index 718ae91e35..615b7a598d 100644 --- a/aws-cloudformation-schema/aws-backup-backupselection.json +++ b/aws-cloudformation-schema/aws-backup-backupselection.json @@ -143,7 +143,7 @@ "permissions" : [ "backup:CreateBackupSelection", "iam:GetRole", "iam:PassRole", "iam:CreateServiceLinkedRole" ] }, "list" : { - "permissions" : [ "backup:ListBackupSelections" ] + "permissions" : [ "backup:ListBackupSelections", "backup:ListBackupPlans" ] } } } \ No newline at end of file diff --git a/aws-cloudformation-schema/aws-backup-restoretestingselection.json b/aws-cloudformation-schema/aws-backup-restoretestingselection.json index 28eff24a80..6d64a732c9 100644 --- a/aws-cloudformation-schema/aws-backup-restoretestingselection.json +++ b/aws-cloudformation-schema/aws-backup-restoretestingselection.json @@ -105,7 +105,7 @@ "timeoutInMinutes" : 5 }, "list" : { - "permissions" : [ "backup:ListRestoreTestingSelections" ], + "permissions" : [ "backup:ListRestoreTestingSelections", "backup:ListRestoreTestingPlans" ], "timeoutInMinutes" : 5 } } diff --git a/aws-cloudformation-schema/aws-connect-tasktemplate.json b/aws-cloudformation-schema/aws-connect-tasktemplate.json index eb202bb782..28a603eb57 100644 --- a/aws-cloudformation-schema/aws-connect-tasktemplate.json +++ b/aws-cloudformation-schema/aws-connect-tasktemplate.json @@ -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", diff --git a/aws-cloudformation-schema/aws-dynamodb-table.json b/aws-cloudformation-schema/aws-dynamodb-table.json index 99febc7060..3ec5025d50 100644 --- a/aws-cloudformation-schema/aws-dynamodb-table.json +++ b/aws-cloudformation-schema/aws-dynamodb-table.json @@ -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" : { diff --git a/aws-cloudformation-schema/aws-ec2-customergateway.json b/aws-cloudformation-schema/aws-ec2-customergateway.json index 57ce94e2b2..e0f21c581a 100644 --- a/aws-cloudformation-schema/aws-ec2-customergateway.json +++ b/aws-cloudformation-schema/aws-ec2-customergateway.json @@ -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" }, diff --git a/aws-cloudformation-schema/aws-ec2-launchtemplate.json b/aws-cloudformation-schema/aws-ec2-launchtemplate.json index 0b3178e5f8..e5a82f7e27 100644 --- a/aws-cloudformation-schema/aws-ec2-launchtemplate.json +++ b/aws-cloudformation-schema/aws-ec2-launchtemplate.json @@ -45,16 +45,12 @@ }, "TagSpecifications" : { "uniqueItems" : false, - "description" : "The tags to apply to resources that are created during instance launch.\n To tag the launch template itself, use [TagSpecifications](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-launchtemplate.html#cfn-ec2-launchtemplate-tagspecifications).", + "description" : "The tags to apply to the resources that are created during instance launch.\n To tag a resource after it has been created, see [CreateTags](https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_CreateTags.html).\n To tag the launch template itself, use [TagSpecifications](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-launchtemplate.html#cfn-ec2-launchtemplate-tagspecifications).", "type" : "array", "items" : { "$ref" : "#/definitions/TagSpecification" } }, - "NetworkPerformanceOptions" : { - "description" : "", - "$ref" : "#/definitions/NetworkPerformanceOptions" - }, "UserData" : { "description" : "The user data to make available to the instance. You must provide base64-encoded text. User data is limited to 16 KB. For more information, see [Run commands on your Amazon EC2 instance at launch](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/user-data.html) in the *Amazon EC2 User Guide*.\n If you are creating the launch template for use with BATCH, the user data must be provided in the [MIME multi-part archive format](https://docs.aws.amazon.com/https://cloudinit.readthedocs.io/en/latest/topics/format.html#mime-multi-part-archive). For more information, see [Amazon EC2 user data in launch templates](https://docs.aws.amazon.com/batch/latest/userguide/launch-templates.html) in the *User Guide*.", "type" : "string" @@ -93,7 +89,7 @@ }, "ElasticInferenceAccelerators" : { "uniqueItems" : false, - "description" : "Amazon Elastic Inference is no longer available.\n An elastic inference accelerator to associate with the instance. Elastic inference accelerators are a resource you can attach to your Amazon EC2 instances to accelerate your Deep Learning (DL) inference workloads.\n You cannot specify accelerators from different generations in the same request.\n Starting April 15, 2023, AWS will not onboard new customers to Amazon Elastic Inference (EI), and will help current customers migrate their workloads to options that offer better price and performance. After April 15, 2023, new customers will not be able to launch instances with Amazon EI accelerators in Amazon SageMaker, Amazon ECS, or Amazon EC2. However, customers who have used Amazon EI at least once during the past 30-day period are considered current customers and will be able to continue using the service.", + "description" : "An elastic inference accelerator to associate with the instance. Elastic inference accelerators are a resource you can attach to your Amazon EC2 instances to accelerate your Deep Learning (DL) inference workloads.\n You cannot specify accelerators from different generations in the same request.\n Starting April 15, 2023, AWS will not onboard new customers to Amazon Elastic Inference (EI), and will help current customers migrate their workloads to options that offer better price and performance. After April 15, 2023, new customers will not be able to launch instances with Amazon EI accelerators in Amazon SageMaker, Amazon ECS, or Amazon EC2. However, customers who have used Amazon EI at least once during the past 30-day period are considered current customers and will be able to continue using the service.", "type" : "array", "items" : { "$ref" : "#/definitions/LaunchTemplateElasticInferenceAccelerator" @@ -180,7 +176,7 @@ "$ref" : "#/definitions/InstanceMarketOptions" }, "InstanceRequirements" : { - "description" : "The attributes for the instance types. When you specify instance attributes, Amazon EC2 will identify instance types with these attributes.\n You must specify ``VCpuCount`` and ``MemoryMiB``. All other attributes are optional. Any unspecified optional attribute is set to its default.\n When you specify multiple attributes, you get instance types that satisfy all of the specified attributes. If you specify multiple values for an attribute, you get instance types that satisfy any of the specified values.\n To limit the list of instance types from which Amazon EC2 can identify matching instance types, you can use one of the following parameters, but not both in the same request:\n + ``AllowedInstanceTypes`` - The instance types to include in the list. All other instance types are ignored, even if they match your specified attributes.\n + ``ExcludedInstanceTypes`` - The instance types to exclude from the list, even if they match your specified attributes.\n \n If you specify ``InstanceRequirements``, you can't specify ``InstanceType``.\n Attribute-based instance type selection is only supported when using Auto Scaling groups, EC2 Fleet, and Spot Fleet to launch instances. If you plan to use the launch template in the [launch instance wizard](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ec2-launch-instance-wizard.html), or with the [RunInstances](https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_RunInstances.html) API or [AWS::EC2::Instance](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-instance.html) AWS CloudFormation resource, you can't specify ``InstanceRequirements``.\n For more information, see [Specify attributes for instance type selection for EC2 Fleet or Spot Fleet](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ec2-fleet-attribute-based-instance-type-selection.html) and [Spot placement score](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/spot-placement-score.html) in the *Amazon EC2 User Guide*.", + "description" : "The attributes for the instance types. When you specify instance attributes, Amazon EC2 will identify instance types with these attributes.\n You must specify ``VCpuCount`` and ``MemoryMiB``. All other attributes are optional. Any unspecified optional attribute is set to its default.\n When you specify multiple attributes, you get instance types that satisfy all of the specified attributes. If you specify multiple values for an attribute, you get instance types that satisfy any of the specified values.\n To limit the list of instance types from which Amazon EC2 can identify matching instance types, you can use one of the following parameters, but not both in the same request:\n + ``AllowedInstanceTypes`` - The instance types to include in the list. All other instance types are ignored, even if they match your specified attributes.\n + ``ExcludedInstanceTypes`` - The instance types to exclude from the list, even if they match your specified attributes.\n \n If you specify ``InstanceRequirements``, you can't specify ``InstanceType``.\n Attribute-based instance type selection is only supported when using Auto Scaling groups, EC2 Fleet, and Spot Fleet to launch instances. If you plan to use the launch template in the [launch instance wizard](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ec2-launch-instance-wizard.html), or with the [RunInstances](https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_RunInstances.html) API or [AWS::EC2::Instance](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-instance.html) AWS CloudFormation resource, you can't specify ``InstanceRequirements``.\n For more information, see [Attribute-based instance type selection for EC2 Fleet](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ec2-fleet-attribute-based-instance-type-selection.html), [Attribute-based instance type selection for Spot Fleet](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/spot-fleet-attribute-based-instance-type-selection.html), and [Spot placement score](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/spot-placement-score.html) in the *Amazon EC2 User Guide*.", "$ref" : "#/definitions/InstanceRequirements" }, "RamDiskId" : { @@ -247,7 +243,6 @@ "type" : "object", "properties" : { "References" : { - "description" : "", "$ref" : "#/definitions/References" } } @@ -391,7 +386,7 @@ "type" : "string" }, "KmsKeyId" : { - "description" : "Identifier (key ID, key alias, key ARN, or alias ARN) of the customer managed KMS key to use for EBS encryption.", + "description" : "The ARN of the symmetric KMSlong (KMS) CMK used for encryption.", "type" : "string" }, "Encrypted" : { @@ -524,7 +519,7 @@ "type" : "object", "properties" : { "InstanceFamily" : { - "description" : "", + "description" : "The instance family to refer. Ensure that you specify the correct family name. For example, C6i and C6g are valid values, but C6 is not.", "type" : "string" } } @@ -658,7 +653,7 @@ "type" : "integer" }, "InterfaceType" : { - "description" : "The type of network interface. To create an Elastic Fabric Adapter (EFA), specify ``efa`` or ``efa``. For more information, see [Elastic Fabric Adapter](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/efa.html) in the *Amazon EC2 User Guide*.\n If you are not creating an EFA, specify ``interface`` or omit this parameter.\n If you specify ``efa-only``, do not assign any IP addresses to the network interface. EFA-only network interfaces do not support IP addresses.\n Valid values: ``interface`` | ``efa`` | ``efa-only``", + "description" : "The type of network interface. To create an Elastic Fabric Adapter (EFA), specify ``efa``. For more information, see [Elastic Fabric Adapter](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/efa.html) in the *Amazon EC2 User Guide*.\n If you are not creating an EFA, specify ``interface`` or omit this parameter.\n Valid values: ``interface`` | ``efa``", "type" : "string" }, "AssociateCarrierIpAddress" : { @@ -737,7 +732,7 @@ } }, "LaunchTemplateTagSpecification" : { - "description" : "Specifies the tags to apply to the launch template during creation.\n To specify the tags for the resources that are created during instance launch, use [AWS::EC2::LaunchTemplate TagSpecification](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-launchtemplate-tagspecification.html).\n ``LaunchTemplateTagSpecification`` is a property of [AWS::EC2::LaunchTemplate](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-launchtemplate.html).", + "description" : "Specifies the tags to apply to the launch template during creation.\n ``LaunchTemplateTagSpecification`` is a property of [AWS::EC2::LaunchTemplate](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-launchtemplate.html).", "additionalProperties" : false, "type" : "object", "properties" : { @@ -756,7 +751,7 @@ } }, "TagSpecification" : { - "description" : "Specifies the tags to apply to resources that are created during instance launch.\n ``TagSpecification`` is a property type of [TagSpecifications](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-launchtemplate-launchtemplatedata.html#cfn-ec2-launchtemplate-launchtemplatedata-tagspecifications). [TagSpecifications](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-launchtemplate-launchtemplatedata.html#cfn-ec2-launchtemplate-launchtemplatedata-tagspecifications) is a property of [AWS::EC2::LaunchTemplate LaunchTemplateData](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-launchtemplate-launchtemplatedata.html).", + "description" : "Specifies the tags to apply to a resource when the resource is created for the launch template.\n ``TagSpecification`` is a property type of [TagSpecifications](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-launchtemplate-launchtemplatedata.html#cfn-ec2-launchtemplate-launchtemplatedata-tagspecifications). [TagSpecifications](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-launchtemplate-launchtemplatedata.html#cfn-ec2-launchtemplate-launchtemplatedata-tagspecifications) is a property of [AWS::EC2::LaunchTemplate LaunchTemplateData](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-launchtemplate-launchtemplatedata.html).", "additionalProperties" : false, "type" : "object", "properties" : { @@ -840,12 +835,11 @@ } }, "BaselinePerformanceFactors" : { - "description" : "The baseline performance to consider, using an instance family as a baseline reference. The instance family establishes the lowest acceptable level of performance. Amazon EC2 uses this baseline to guide instance type selection, but there is no guarantee that the selected instance types will always exceed the baseline for every application.\n Currently, this parameter only supports CPU performance as a baseline performance factor. For example, specifying ``c6i`` would use the CPU performance of the ``c6i`` family as the baseline reference.", + "description" : "", "additionalProperties" : false, "type" : "object", "properties" : { "Cpu" : { - "description" : "The CPU performance to consider, using an instance family as the baseline reference.", "$ref" : "#/definitions/Cpu" } } @@ -881,7 +875,7 @@ } }, "InstanceRequirements" : { - "description" : "The attributes for the instance types. When you specify instance attributes, Amazon EC2 will identify instance types with these attributes.\n You must specify ``VCpuCount`` and ``MemoryMiB``. All other attributes are optional. Any unspecified optional attribute is set to its default.\n When you specify multiple attributes, you get instance types that satisfy all of the specified attributes. If you specify multiple values for an attribute, you get instance types that satisfy any of the specified values.\n To limit the list of instance types from which Amazon EC2 can identify matching instance types, you can use one of the following parameters, but not both in the same request:\n + ``AllowedInstanceTypes`` - The instance types to include in the list. All other instance types are ignored, even if they match your specified attributes.\n + ``ExcludedInstanceTypes`` - The instance types to exclude from the list, even if they match your specified attributes.\n \n If you specify ``InstanceRequirements``, you can't specify ``InstanceType``.\n Attribute-based instance type selection is only supported when using Auto Scaling groups, EC2 Fleet, and Spot Fleet to launch instances. If you plan to use the launch template in the [launch instance wizard](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ec2-launch-instance-wizard.html), or with the [RunInstances](https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_RunInstances.html) API or [AWS::EC2::Instance](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-instance.html) AWS CloudFormation resource, you can't specify ``InstanceRequirements``.\n For more information, see [Specify attributes for instance type selection for EC2 Fleet or Spot Fleet](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ec2-fleet-attribute-based-instance-type-selection.html) and [Spot placement score](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/spot-placement-score.html) in the *Amazon EC2 User Guide*.", + "description" : "The attributes for the instance types. When you specify instance attributes, Amazon EC2 will identify instance types with these attributes.\n You must specify ``VCpuCount`` and ``MemoryMiB``. All other attributes are optional. Any unspecified optional attribute is set to its default.\n When you specify multiple attributes, you get instance types that satisfy all of the specified attributes. If you specify multiple values for an attribute, you get instance types that satisfy any of the specified values.\n To limit the list of instance types from which Amazon EC2 can identify matching instance types, you can use one of the following parameters, but not both in the same request:\n + ``AllowedInstanceTypes`` - The instance types to include in the list. All other instance types are ignored, even if they match your specified attributes.\n + ``ExcludedInstanceTypes`` - The instance types to exclude from the list, even if they match your specified attributes.\n \n If you specify ``InstanceRequirements``, you can't specify ``InstanceType``.\n Attribute-based instance type selection is only supported when using Auto Scaling groups, EC2 Fleet, and Spot Fleet to launch instances. If you plan to use the launch template in the [launch instance wizard](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ec2-launch-instance-wizard.html), or with the [RunInstances](https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_RunInstances.html) API or [AWS::EC2::Instance](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-instance.html) AWS CloudFormation resource, you can't specify ``InstanceRequirements``.\n For more information, see [Attribute-based instance type selection for EC2 Fleet](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ec2-fleet-attribute-based-instance-type-selection.html), [Attribute-based instance type selection for Spot Fleet](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/spot-fleet-attribute-based-instance-type-selection.html), and [Spot placement score](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/spot-placement-score.html) in the *Amazon EC2 User Guide*.", "additionalProperties" : false, "type" : "object", "properties" : { @@ -899,7 +893,7 @@ }, "AcceleratorTypes" : { "uniqueItems" : false, - "description" : "The accelerator types that must be on the instance type.\n + For instance types with GPU accelerators, specify ``gpu``.\n + For instance types with FPGA accelerators, specify ``fpga``.\n \n Default: Any accelerator type", + "description" : "The accelerator types that must be on the instance type.\n + For instance types with GPU accelerators, specify ``gpu``.\n + For instance types with FPGA accelerators, specify ``fpga``.\n + For instance types with inference accelerators, specify ``inference``.\n \n Default: Any accelerator type", "type" : "array", "items" : { "type" : "string" @@ -923,7 +917,7 @@ }, "CpuManufacturers" : { "uniqueItems" : false, - "description" : "The CPU manufacturers to include.\n + For instance types with Intel CPUs, specify ``intel``.\n + For instance types with AMD CPUs, specify ``amd``.\n + For instance types with AWS CPUs, specify ``amazon-web-services``.\n + For instance types with Apple CPUs, specify ``apple``.\n \n Don't confuse the CPU manufacturer with the CPU architecture. Instances will be launched with a compatible CPU architecture based on the Amazon Machine Image (AMI) that you specify in your launch template.\n Default: Any manufacturer", + "description" : "The CPU manufacturers to include.\n + For instance types with Intel CPUs, specify ``intel``.\n + For instance types with AMD CPUs, specify ``amd``.\n + For instance types with AWS CPUs, specify ``amazon-web-services``.\n \n Don't confuse the CPU manufacturer with the CPU architecture. Instances will be launched with a compatible CPU architecture based on the Amazon Machine Image (AMI) that you specify in your launch template.\n Default: Any manufacturer", "type" : "array", "items" : { "type" : "string" @@ -987,7 +981,7 @@ "$ref" : "#/definitions/NetworkBandwidthGbps" }, "BaselinePerformanceFactors" : { - "description" : "The baseline performance to consider, using an instance family as a baseline reference. The instance family establishes the lowest acceptable level of performance. Amazon EC2 uses this baseline to guide instance type selection, but there is no guarantee that the selected instance types will always exceed the baseline for every application. Currently, this parameter only supports CPU performance as a baseline performance factor. For more information, see [Performance protection](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ec2-fleet-attribute-based-instance-type-selection.html#ec2fleet-abis-performance-protection) in the *Amazon EC2 User Guide*.", + "description" : "", "$ref" : "#/definitions/BaselinePerformanceFactors" }, "SpotMaxPricePercentageOverLowestPrice" : { @@ -1072,7 +1066,7 @@ "type" : "object", "properties" : { "CapacityReservationPreference" : { - "description" : "Indicates the instance's Capacity Reservation preferences. Possible preferences include:\n + ``capacity-reservations-only`` - The instance will only run in a Capacity Reservation or Capacity Reservation group. If capacity isn't available, the instance will fail to launch.\n + ``open`` - The instance can run in any ``open`` Capacity Reservation that has matching attributes (instance type, platform, Availability Zone, tenancy).\n + ``none`` - The instance avoids running in a Capacity Reservation even if one is available. The instance runs in On-Demand capacity.", + "description" : "Indicates the instance's Capacity Reservation preferences. Possible preferences include:\n + ``open`` - The instance can run in any ``open`` Capacity Reservation that has matching attributes (instance type, platform, Availability Zone).\n + ``none`` - The instance avoids running in a Capacity Reservation even if one is available. The instance runs in On-Demand capacity.", "type" : "string" }, "CapacityReservationTarget" : { @@ -1143,7 +1137,7 @@ }, "TagSpecifications" : { "uniqueItems" : false, - "description" : "The tags to apply to the launch template on creation. To tag the launch template, the resource type must be ``launch-template``.\n To specify the tags for resources that are created during instance launch, use [TagSpecifications](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-launchtemplate-launchtemplatedata.html#cfn-ec2-launchtemplate-launchtemplatedata-tagspecifications).", + "description" : "The tags to apply to the launch template on creation. To tag the launch template, the resource type must be ``launch-template``.\n To specify the tags for the resources that are created when an instance is launched, you must use [TagSpecifications](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-launchtemplate-launchtemplatedata.html#cfn-ec2-launchtemplate-launchtemplatedata-tagspecifications).", "type" : "array", "items" : { "$ref" : "#/definitions/LaunchTemplateTagSpecification" diff --git a/aws-cloudformation-schema/aws-ec2-networkinterface.json b/aws-cloudformation-schema/aws-ec2-networkinterface.json index e7092a8332..d9158d55cd 100644 --- a/aws-cloudformation-schema/aws-ec2-networkinterface.json +++ b/aws-cloudformation-schema/aws-ec2-networkinterface.json @@ -1,9 +1,112 @@ { - "typeName" : "AWS::EC2::NetworkInterface", + "tagging" : { + "permissions" : [ "ec2:CreateTags", "ec2:DeleteTags" ], + "taggable" : true, + "tagOnCreate" : true, + "tagUpdatable" : true, + "tagProperty" : "/properties/Tags", + "cloudFormationSystemTags" : true + }, "$schema" : "https://raw.githubusercontent.com/aws-cloudformation/cloudformation-resource-schema/master/src/main/resources/schema/provider.definition.schema.v1.json", - "sourceUrl" : "https://github.com/aws-cloudformation/aws-cloudformation-resource-providers-ec2/networkinterface", + "typeName" : "AWS::EC2::NetworkInterface", + "readOnlyProperties" : [ "/properties/Id", "/properties/SecondaryPrivateIpAddresses", "/properties/PrimaryPrivateIpAddress", "/properties/PrimaryIpv6Address", "/properties/VpcId" ], "description" : "The AWS::EC2::NetworkInterface resource creates network interface", + "createOnlyProperties" : [ "/properties/PrivateIpAddress", "/properties/InterfaceType", "/properties/SubnetId" ], + "primaryIdentifier" : [ "/properties/Id" ], + "required" : [ "SubnetId" ], + "conditionalCreateOnlyProperties" : [ "/properties/PrivateIpAddresses", "/properties/EnablePrimaryIpv6", "/properties/ConnectionTrackingSpecification" ], + "sourceUrl" : "https://github.com/aws-cloudformation/aws-cloudformation-resource-providers-ec2/networkinterface", + "handlers" : { + "read" : { + "permissions" : [ "ec2:DescribeNetworkInterfaces" ] + }, + "create" : { + "permissions" : [ "ec2:CreateNetworkInterface", "ec2:DescribeNetworkInterfaces", "ec2:CreateTags", "ec2:ModifyNetworkInterfaceAttribute", "ec2:ModifyPublicIpDnsNameOptions" ] + }, + "update" : { + "permissions" : [ "ec2:DescribeNetworkInterfaces", "ec2:ModifyNetworkInterfaceAttribute", "ec2:UnassignIpv6Addresses", "ec2:AssignIpv6Addresses", "ec2:DeleteTags", "ec2:CreateTags", "ec2:UnassignPrivateIpAddresses", "ec2:AssignPrivateIpAddresses", "ec2:ModifyPublicIpDnsNameOptions" ] + }, + "list" : { + "permissions" : [ "ec2:DescribeNetworkInterfaces" ] + }, + "delete" : { + "permissions" : [ "ec2:DescribeNetworkInterfaces", "ec2:DeleteNetworkInterface" ] + } + }, "additionalProperties" : false, + "definitions" : { + "PrivateIpAddressSpecification" : { + "additionalProperties" : false, + "type" : "object", + "properties" : { + "PrivateIpAddress" : { + "type" : "string" + }, + "Primary" : { + "type" : "boolean" + } + }, + "required" : [ "PrivateIpAddress", "Primary" ] + }, + "Ipv4PrefixSpecification" : { + "additionalProperties" : false, + "type" : "object", + "properties" : { + "Ipv4Prefix" : { + "type" : "string" + } + }, + "required" : [ "Ipv4Prefix" ] + }, + "InstanceIpv6Address" : { + "additionalProperties" : false, + "type" : "object", + "properties" : { + "Ipv6Address" : { + "type" : "string" + } + }, + "required" : [ "Ipv6Address" ] + }, + "Ipv6PrefixSpecification" : { + "additionalProperties" : false, + "type" : "object", + "properties" : { + "Ipv6Prefix" : { + "type" : "string" + } + }, + "required" : [ "Ipv6Prefix" ] + }, + "Tag" : { + "additionalProperties" : false, + "type" : "object", + "properties" : { + "Value" : { + "type" : "string" + }, + "Key" : { + "type" : "string" + } + }, + "required" : [ "Value", "Key" ] + }, + "ConnectionTrackingSpecification" : { + "additionalProperties" : false, + "type" : "object", + "properties" : { + "UdpTimeout" : { + "type" : "integer" + }, + "TcpEstablishedTimeout" : { + "type" : "integer" + }, + "UdpStreamTimeout" : { + "type" : "integer" + } + } + } + }, "properties" : { "Description" : { "description" : "A description for the network interface.", @@ -13,11 +116,15 @@ "description" : "Assigns a single private IP address to the network interface, which is used as the primary private IP address. If you want to specify multiple private IP address, use the PrivateIpAddresses property. ", "type" : "string" }, + "PrimaryIpv6Address" : { + "description" : "The primary IPv6 address", + "type" : "string" + }, "PrivateIpAddresses" : { - "description" : "Assigns a list of private IP addresses to the network interface. You can specify a primary private IP address by setting the value of the Primary property to true in the PrivateIpAddressSpecification property. If you want EC2 to automatically assign private IP addresses, use the SecondaryPrivateIpAddressCount property and do not specify this property.", - "type" : "array", "uniqueItems" : false, + "description" : "Assigns a list of private IP addresses to the network interface. You can specify a primary private IP address by setting the value of the Primary property to true in the PrivateIpAddressSpecification property. If you want EC2 to automatically assign private IP addresses, use the SecondaryPrivateIpAddressCount property and do not specify this property.", "insertionOrder" : false, + "type" : "array", "items" : { "$ref" : "#/definitions/PrivateIpAddressSpecification" } @@ -26,15 +133,19 @@ "description" : "The number of secondary private IPv4 addresses to assign to a network interface. When you specify a number of secondary IPv4 addresses, Amazon EC2 selects these IP addresses within the subnet's IPv4 CIDR range. You can't specify this option and specify more than one private IP address using privateIpAddresses", "type" : "integer" }, + "Ipv6PrefixCount" : { + "description" : "The number of IPv6 prefixes to assign to a network interface. When you specify a number of IPv6 prefixes, Amazon EC2 selects these prefixes from your existing subnet CIDR reservations, if available, or from free spaces in the subnet. By default, these will be /80 prefixes. You can't specify a count of IPv6 prefixes if you've specified one of the following: specific IPv6 prefixes, specific IPv6 addresses, or a count of IPv6 addresses.", + "type" : "integer" + }, "PrimaryPrivateIpAddress" : { "description" : "Returns the primary private IP address of the network interface.", "type" : "string" }, "Ipv4Prefixes" : { - "description" : "Assigns a list of IPv4 prefixes to the network interface. If you want EC2 to automatically assign IPv4 prefixes, use the Ipv4PrefixCount property and do not specify this property. Presently, only /28 prefixes are supported. You can't specify IPv4 prefixes if you've specified one of the following: a count of IPv4 prefixes, specific private IPv4 addresses, or a count of private IPv4 addresses.", - "type" : "array", "uniqueItems" : false, + "description" : "Assigns a list of IPv4 prefixes to the network interface. If you want EC2 to automatically assign IPv4 prefixes, use the Ipv4PrefixCount property and do not specify this property. Presently, only /28 prefixes are supported. You can't specify IPv4 prefixes if you've specified one of the following: a count of IPv4 prefixes, specific private IPv4 addresses, or a count of private IPv4 addresses.", "insertionOrder" : false, + "type" : "array", "items" : { "$ref" : "#/definitions/Ipv4PrefixSpecification" } @@ -43,37 +154,37 @@ "description" : "The number of IPv4 prefixes to assign to a network interface. When you specify a number of IPv4 prefixes, Amazon EC2 selects these prefixes from your existing subnet CIDR reservations, if available, or from free spaces in the subnet. By default, these will be /28 prefixes. You can't specify a count of IPv4 prefixes if you've specified one of the following: specific IPv4 prefixes, specific private IPv4 addresses, or a count of private IPv4 addresses.", "type" : "integer" }, + "EnablePrimaryIpv6" : { + "description" : "If you have instances or ENIs that rely on the IPv6 address not changing, to avoid disrupting traffic to instances or ENIs, you can enable a primary IPv6 address. Enable this option to automatically assign an IPv6 associated with the ENI attached to your instance to be the primary IPv6 address. When you enable an IPv6 address to be a primary IPv6, you cannot disable it. Traffic will be routed to the primary IPv6 address until the instance is terminated or the ENI is detached. If you have multiple IPv6 addresses associated with an ENI and you enable a primary IPv6 address, the first IPv6 address associated with the ENI becomes the primary IPv6 address.", + "type" : "boolean" + }, "GroupSet" : { - "description" : "A list of security group IDs associated with this network interface.", - "type" : "array", "uniqueItems" : false, + "description" : "A list of security group IDs associated with this network interface.", "insertionOrder" : false, + "type" : "array", "items" : { "type" : "string" } }, "Ipv6Addresses" : { - "description" : "One or more specific IPv6 addresses from the IPv6 CIDR block range of your subnet to associate with the network interface. If you're specifying a number of IPv6 addresses, use the Ipv6AddressCount property and don't specify this property.", - "type" : "array", "uniqueItems" : true, + "description" : "One or more specific IPv6 addresses from the IPv6 CIDR block range of your subnet to associate with the network interface. If you're specifying a number of IPv6 addresses, use the Ipv6AddressCount property and don't specify this property.", "insertionOrder" : false, + "type" : "array", "items" : { "$ref" : "#/definitions/InstanceIpv6Address" } }, "Ipv6Prefixes" : { - "description" : "Assigns a list of IPv6 prefixes to the network interface. If you want EC2 to automatically assign IPv6 prefixes, use the Ipv6PrefixCount property and do not specify this property. Presently, only /80 prefixes are supported. You can't specify IPv6 prefixes if you've specified one of the following: a count of IPv6 prefixes, specific IPv6 addresses, or a count of IPv6 addresses.", - "type" : "array", "uniqueItems" : false, + "description" : "Assigns a list of IPv6 prefixes to the network interface. If you want EC2 to automatically assign IPv6 prefixes, use the Ipv6PrefixCount property and do not specify this property. Presently, only /80 prefixes are supported. You can't specify IPv6 prefixes if you've specified one of the following: a count of IPv6 prefixes, specific IPv6 addresses, or a count of IPv6 addresses.", "insertionOrder" : false, + "type" : "array", "items" : { "$ref" : "#/definitions/Ipv6PrefixSpecification" } }, - "Ipv6PrefixCount" : { - "description" : "The number of IPv6 prefixes to assign to a network interface. When you specify a number of IPv6 prefixes, Amazon EC2 selects these prefixes from your existing subnet CIDR reservations, if available, or from free spaces in the subnet. By default, these will be /80 prefixes. You can't specify a count of IPv6 prefixes if you've specified one of the following: specific IPv6 prefixes, specific IPv6 addresses, or a count of IPv6 addresses.", - "type" : "integer" - }, "SubnetId" : { "description" : "The ID of the subnet to associate with the network interface.", "type" : "string" @@ -87,148 +198,37 @@ "type" : "string" }, "SecondaryPrivateIpAddresses" : { - "description" : "Returns the secondary private IP addresses of the network interface.", - "type" : "array", "uniqueItems" : false, + "description" : "Returns the secondary private IP addresses of the network interface.", "insertionOrder" : false, + "type" : "array", "items" : { "type" : "string" } }, + "VpcId" : { + "description" : "The ID of the VPC", + "type" : "string" + }, "Ipv6AddressCount" : { "description" : "The number of IPv6 addresses to assign to a network interface. Amazon EC2 automatically selects the IPv6 addresses from the subnet range. To specify specific IPv6 addresses, use the Ipv6Addresses property and don't specify this property.", "type" : "integer" }, - "EnablePrimaryIpv6" : { - "description" : "If you have instances or ENIs that rely on the IPv6 address not changing, to avoid disrupting traffic to instances or ENIs, you can enable a primary IPv6 address. Enable this option to automatically assign an IPv6 associated with the ENI attached to your instance to be the primary IPv6 address. When you enable an IPv6 address to be a primary IPv6, you cannot disable it. Traffic will be routed to the primary IPv6 address until the instance is terminated or the ENI is detached. If you have multiple IPv6 addresses associated with an ENI and you enable a primary IPv6 address, the first IPv6 address associated with the ENI becomes the primary IPv6 address.", - "type" : "boolean" - }, - "PrimaryIpv6Address" : { - "description" : "The primary IPv6 address", - "type" : "string" - }, - "ConnectionTrackingSpecification" : { - "$ref" : "#/definitions/ConnectionTrackingSpecification" - }, "Id" : { "description" : "Network interface id.", "type" : "string" }, "Tags" : { - "description" : "An arbitrary set of tags (key-value pairs) for this network interface.", - "type" : "array", "uniqueItems" : false, + "description" : "An arbitrary set of tags (key-value pairs) for this network interface.", "insertionOrder" : false, + "type" : "array", "items" : { "$ref" : "#/definitions/Tag" } }, - "VpcId" : { - "description" : "The ID of the VPC", - "type" : "string" - } - }, - "definitions" : { - "PrivateIpAddressSpecification" : { - "type" : "object", - "additionalProperties" : false, - "properties" : { - "PrivateIpAddress" : { - "type" : "string" - }, - "Primary" : { - "type" : "boolean" - } - }, - "required" : [ "PrivateIpAddress", "Primary" ] - }, - "InstanceIpv6Address" : { - "type" : "object", - "additionalProperties" : false, - "properties" : { - "Ipv6Address" : { - "type" : "string" - } - }, - "required" : [ "Ipv6Address" ] - }, - "Ipv4PrefixSpecification" : { - "type" : "object", - "additionalProperties" : false, - "properties" : { - "Ipv4Prefix" : { - "type" : "string" - } - }, - "required" : [ "Ipv4Prefix" ] - }, - "Ipv6PrefixSpecification" : { - "type" : "object", - "additionalProperties" : false, - "properties" : { - "Ipv6Prefix" : { - "type" : "string" - } - }, - "required" : [ "Ipv6Prefix" ] - }, "ConnectionTrackingSpecification" : { - "type" : "object", - "additionalProperties" : false, - "properties" : { - "TcpEstablishedTimeout" : { - "type" : "integer" - }, - "UdpStreamTimeout" : { - "type" : "integer" - }, - "UdpTimeout" : { - "type" : "integer" - } - } - }, - "Tag" : { - "type" : "object", - "additionalProperties" : false, - "properties" : { - "Value" : { - "type" : "string" - }, - "Key" : { - "type" : "string" - } - }, - "required" : [ "Value", "Key" ] - } - }, - "required" : [ "SubnetId" ], - "createOnlyProperties" : [ "/properties/PrivateIpAddress", "/properties/InterfaceType", "/properties/SubnetId" ], - "primaryIdentifier" : [ "/properties/Id" ], - "readOnlyProperties" : [ "/properties/Id", "/properties/SecondaryPrivateIpAddresses", "/properties/PrimaryPrivateIpAddress", "/properties/PrimaryIpv6Address", "/properties/VpcId" ], - "conditionalCreateOnlyProperties" : [ "/properties/PrivateIpAddresses", "/properties/EnablePrimaryIpv6", "/properties/ConnectionTrackingSpecification" ], - "tagging" : { - "taggable" : true, - "tagOnCreate" : true, - "tagUpdatable" : true, - "cloudFormationSystemTags" : true, - "tagProperty" : "/properties/Tags", - "permissions" : [ "ec2:CreateTags", "ec2:DeleteTags" ] - }, - "handlers" : { - "create" : { - "permissions" : [ "ec2:CreateNetworkInterface", "ec2:DescribeNetworkInterfaces", "ec2:CreateTags", "ec2:ModifyNetworkInterfaceAttribute" ] - }, - "delete" : { - "permissions" : [ "ec2:DescribeNetworkInterfaces", "ec2:DeleteNetworkInterface" ] - }, - "list" : { - "permissions" : [ "ec2:DescribeNetworkInterfaces" ] - }, - "read" : { - "permissions" : [ "ec2:DescribeNetworkInterfaces" ] - }, - "update" : { - "permissions" : [ "ec2:DescribeNetworkInterfaces", "ec2:ModifyNetworkInterfaceAttribute", "ec2:UnassignIpv6Addresses", "ec2:AssignIpv6Addresses", "ec2:DeleteTags", "ec2:CreateTags", "ec2:UnassignPrivateIpAddresses", "ec2:AssignPrivateIpAddresses" ] + "$ref" : "#/definitions/ConnectionTrackingSpecification" } } } \ No newline at end of file diff --git a/aws-cloudformation-schema/aws-ecs-taskdefinition.json b/aws-cloudformation-schema/aws-ecs-taskdefinition.json index 6b7180a622..88de9cb4ca 100644 --- a/aws-cloudformation-schema/aws-ecs-taskdefinition.json +++ b/aws-cloudformation-schema/aws-ecs-taskdefinition.json @@ -31,7 +31,7 @@ "typeName" : "AWS::ECS::TaskDefinition", "readOnlyProperties" : [ "/properties/TaskDefinitionArn" ], "description" : "Registers a new task definition from the supplied ``family`` and ``containerDefinitions``. Optionally, you can add data volumes to your containers with the ``volumes`` parameter. For more information about task definition parameters and defaults, see [Amazon ECS Task Definitions](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/task_defintions.html) in the *Amazon Elastic Container Service Developer Guide*.\n You can specify a role for your task with the ``taskRoleArn`` parameter. When you specify a role for a task, its containers can then use the latest versions of the CLI or SDKs to make API requests to the AWS services that are specified in the policy that's associated with the role. For more information, see [IAM Roles for Tasks](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/task-iam-roles.html) in the *Amazon Elastic Container Service Developer Guide*.\n You can specify a Docker networking mode for the containers in your task definition with the ``networkMode`` parameter. If you specify the ``awsvpc`` network mode, the task is allocated an elastic network interface, and you must specify a [NetworkConfiguration](https://docs.aws.amazon.com/AmazonECS/latest/APIReference/API_NetworkConfiguration.html) when you create a service or run a task with the task definition. For more information, see [Task Networking](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/task-networking.html) in the *Amazon Elastic Container Service Developer Guide*.\n In the following example or examples, the Authorization header contents (``AUTHPARAMS``) must be replaced with an AWS Signature Version 4 signature. For more information, see [Signature Version 4 Signing Process](https://docs.aws.amazon.com/general/latest/gr/signature-version-4.html) in the *General Reference*.\n You only need to learn how to sign HTTP requests if you intend to create them manually. When you use the [](https://docs.aws.amazon.com/cli/) or one of the [SDKs](https://docs.aws.amazon.com/tools/) to make requests to AWS, these tools automatically sign the requests for you, with the access key that you specify when you configure the tools. When you use these tools, you don't have to sign requests yourself.", - "createOnlyProperties" : [ "/properties/Family", "/properties/ContainerDefinitions", "/properties/Cpu", "/properties/ExecutionRoleArn", "/properties/InferenceAccelerators", "/properties/Memory", "/properties/NetworkMode", "/properties/PlacementConstraints", "/properties/ProxyConfiguration", "/properties/RequiresCompatibilities", "/properties/RuntimePlatform", "/properties/TaskRoleArn", "/properties/Volumes", "/properties/PidMode", "/properties/IpcMode", "/properties/EphemeralStorage" ], + "createOnlyProperties" : [ "/properties/Family", "/properties/ContainerDefinitions", "/properties/Cpu", "/properties/EnableFaultInjection", "/properties/ExecutionRoleArn", "/properties/InferenceAccelerators", "/properties/Memory", "/properties/NetworkMode", "/properties/PlacementConstraints", "/properties/ProxyConfiguration", "/properties/RequiresCompatibilities", "/properties/RuntimePlatform", "/properties/TaskRoleArn", "/properties/Volumes", "/properties/PidMode", "/properties/IpcMode", "/properties/EphemeralStorage" ], "additionalProperties" : false, "primaryIdentifier" : [ "/properties/TaskDefinitionArn" ], "definitions" : { @@ -292,7 +292,7 @@ }, "VersionConsistency" : { "default" : "enabled", - "description" : "", + "description" : "Specifies whether Amazon ECS will resolve the container image tag provided in the container definition to an image digest. By default, the value is ``enabled``. If you set the value for a container as ``disabled``, Amazon ECS will not resolve the provided container image tag to a digest and will use the original image URI specified in the container definition for deployment. For more information about container image resolution, see [Container image resolution](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/deployment-type-ecs.html#deployment-container-image-stability) in the *Amazon ECS Developer Guide*.", "type" : "string", "enum" : [ "enabled", "disabled" ] }, @@ -1031,6 +1031,10 @@ "description" : "The process namespace to use for the containers in the task. The valid values are ``host`` or ``task``. On Fargate for Linux containers, the only valid value is ``task``. For example, monitoring sidecars might need ``pidMode`` to access information about other containers running in the same task.\n If ``host`` is specified, all containers within the tasks that specified the ``host`` PID mode on the same container instance share the same process namespace with the host Amazon EC2 instance.\n If ``task`` is specified, all containers within the specified task share the same process namespace.\n If no value is specified, the default is a private namespace for each container.\n If the ``host`` PID mode is used, there's a heightened risk of undesired process namespace exposure.\n This parameter is not supported for Windows containers.\n This parameter is only supported for tasks that are hosted on FARGATElong if the tasks are using platform version ``1.4.0`` or later (Linux). This isn't supported for Windows containers on Fargate.", "type" : "string" }, + "EnableFaultInjection" : { + "description" : "", + "type" : "boolean" + }, "ExecutionRoleArn" : { "description" : "The Amazon Resource Name (ARN) of the task execution role that grants the Amazon ECS container agent permission to make AWS API calls on your behalf. For informationabout the required IAM roles for Amazon ECS, see [IAM roles for Amazon ECS](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/security-ecs-iam-role-overview.html) in the *Amazon Elastic Container Service Developer Guide*.", "type" : "string" diff --git a/aws-cloudformation-schema/aws-healthlake-fhirdatastore.json b/aws-cloudformation-schema/aws-healthlake-fhirdatastore.json index ebd88d0c6d..f56b2e18a1 100644 --- a/aws-cloudformation-schema/aws-healthlake-fhirdatastore.json +++ b/aws-cloudformation-schema/aws-healthlake-fhirdatastore.json @@ -73,6 +73,11 @@ } }, "required" : [ "KmsEncryptionConfig" ], + "default" : { + "KmsEncryptionConfig" : { + "CmkType" : "AWS_OWNED_KMS_KEY" + } + }, "additionalProperties" : false }, "KmsEncryptionConfig" : { @@ -121,6 +126,10 @@ } }, "required" : [ "AuthorizationStrategy" ], + "default" : { + "AuthorizationStrategy" : "AWS_AUTH", + "FineGrainedAuthorizationEnabled" : false + }, "additionalProperties" : false }, "Tag" : { diff --git a/aws-cloudformation-schema/aws-imagebuilder-component.json b/aws-cloudformation-schema/aws-imagebuilder-component.json index a2643f3ecb..0778e2a154 100644 --- a/aws-cloudformation-schema/aws-imagebuilder-component.json +++ b/aws-cloudformation-schema/aws-imagebuilder-component.json @@ -89,13 +89,13 @@ "permissions" : [ "iam:CreateServiceLinkedRole", "iam:GetRole", "kms:GenerateDataKey", "kms:GenerateDataKeyPair", "kms:GenerateDataKeyPairWithoutPlaintext", "kms:GenerateDataKeyWithoutPlaintext", "kms:Encrypt", "kms:Decrypt", "s3:GetObject", "s3:HeadBucket", "s3:GetBucketLocation", "imagebuilder:TagResource", "imagebuilder:GetComponent", "imagebuilder:CreateComponent" ] }, "read" : { - "permissions" : [ "imagebuilder:GetComponent" ] + "permissions" : [ "imagebuilder:GetComponent", "kms:Decrypt" ] }, "delete" : { "permissions" : [ "imagebuilder:GetComponent", "imagebuilder:UnTagResource", "imagebuilder:DeleteComponent" ] }, "list" : { - "permissions" : [ "imagebuilder:ListComponents" ], + "permissions" : [ "imagebuilder:ListComponents", "imagebuilder:ListComponentBuildVersions" ], "handlerSchema" : { "properties" : { "Arn" : { diff --git a/aws-cloudformation-schema/aws-imagebuilder-containerrecipe.json b/aws-cloudformation-schema/aws-imagebuilder-containerrecipe.json index ae5769ddc0..04a0f0547a 100644 --- a/aws-cloudformation-schema/aws-imagebuilder-containerrecipe.json +++ b/aws-cloudformation-schema/aws-imagebuilder-containerrecipe.json @@ -241,7 +241,7 @@ "permissions" : [ "iam:GetRole", "iam:CreateServiceLinkedRole", "imagebuilder:GetComponent", "imagebuilder:TagResource", "imagebuilder:GetContainerRecipe", "imagebuilder:CreateContainerRecipe", "imagebuilder:GetImage", "kms:Encrypt", "kms:Decrypt", "kms:ReEncryptFrom", "kms:ReEncryptTo", "kms:GenerateDataKey", "kms:GenerateDataKeyPair", "kms:GenerateDataKeyPairWithoutPlaintext", "kms:GenerateDataKeyWithoutPlaintext", "s3:GetObject", "s3:ListBucket", "ecr:DescribeRepositories", "ec2:DescribeImages" ] }, "read" : { - "permissions" : [ "imagebuilder:GetContainerRecipe" ] + "permissions" : [ "imagebuilder:GetContainerRecipe", "kms:Decrypt" ] }, "delete" : { "permissions" : [ "imagebuilder:UnTagResource", "imagebuilder:GetContainerRecipe", "imagebuilder:DeleteContainerRecipe" ] diff --git a/aws-cloudformation-schema/aws-imagebuilder-image.json b/aws-cloudformation-schema/aws-imagebuilder-image.json index ff6b8454e5..03aa8f91c3 100644 --- a/aws-cloudformation-schema/aws-imagebuilder-image.json +++ b/aws-cloudformation-schema/aws-imagebuilder-image.json @@ -196,7 +196,7 @@ "permissions" : [ "imagebuilder:GetImage", "imagebuilder:DeleteImage", "imagebuilder:UnTagResource", "imagebuilder:CancelImageCreation" ] }, "list" : { - "permissions" : [ "imagebuilder:ListImages" ], + "permissions" : [ "imagebuilder:ListImages", "imagebuilder:ListImageBuildVersions" ], "handlerSchema" : { "properties" : { "Arn" : { diff --git a/aws-cloudformation-schema/aws-imagebuilder-workflow.json b/aws-cloudformation-schema/aws-imagebuilder-workflow.json index 5a8fe5a752..93c8ca3c69 100644 --- a/aws-cloudformation-schema/aws-imagebuilder-workflow.json +++ b/aws-cloudformation-schema/aws-imagebuilder-workflow.json @@ -72,13 +72,13 @@ "permissions" : [ "iam:GetRole", "kms:GenerateDataKey", "kms:GenerateDataKeyPair", "kms:GenerateDataKeyPairWithoutPlaintext", "kms:GenerateDataKeyWithoutPlaintext", "kms:Encrypt", "kms:Decrypt", "s3:GetObject", "s3:HeadBucket", "s3:GetBucketLocation", "imagebuilder:TagResource", "imagebuilder:GetWorkflow", "imagebuilder:CreateWorkflow" ] }, "read" : { - "permissions" : [ "imagebuilder:GetWorkflow" ] + "permissions" : [ "imagebuilder:GetWorkflow", "kms:Decrypt" ] }, "delete" : { "permissions" : [ "imagebuilder:GetWorkflow", "imagebuilder:UnTagResource", "imagebuilder:DeleteWorkflow" ] }, "list" : { - "permissions" : [ "imagebuilder:ListWorkflows" ], + "permissions" : [ "imagebuilder:ListWorkflows", "imagebuilder:ListWorkflowBuildVersions" ], "handlerSchema" : { "properties" : { "Arn" : { diff --git a/aws-cloudformation-schema/aws-iot-command.json b/aws-cloudformation-schema/aws-iot-command.json new file mode 100644 index 0000000000..dd94b59259 --- /dev/null +++ b/aws-cloudformation-schema/aws-iot-command.json @@ -0,0 +1,212 @@ +{ + "typeName" : "AWS::IoT::Command", + "description" : "Represents the resource definition of AWS IoT Command.", + "definitions" : { + "CommandParameterList" : { + "type" : "array", + "items" : { + "$ref" : "#/definitions/CommandParameter" + }, + "minItems" : 1, + "insertionOrder" : false + }, + "CommandParameter" : { + "type" : "object", + "properties" : { + "Name" : { + "$ref" : "#/definitions/CommandParameterName" + }, + "Value" : { + "$ref" : "#/definitions/CommandParameterValue" + }, + "DefaultValue" : { + "$ref" : "#/definitions/CommandParameterValue" + }, + "Description" : { + "$ref" : "#/definitions/CommandParameterDescription" + } + }, + "required" : [ "Name" ], + "additionalProperties" : false + }, + "CommandParameterName" : { + "type" : "string", + "pattern" : "^[.$a-zA-Z0-9_-]+$", + "minLength" : 1, + "maxLength" : 192 + }, + "CommandParameterDescription" : { + "type" : "string", + "maxLength" : 2028 + }, + "CommandParameterValue" : { + "type" : "object", + "properties" : { + "S" : { + "type" : "string", + "minLength" : 1 + }, + "B" : { + "type" : "boolean" + }, + "I" : { + "type" : "integer" + }, + "L" : { + "type" : "string", + "pattern" : "^-?\\d+$", + "maxLength" : 19 + }, + "D" : { + "type" : "number" + }, + "BIN" : { + "type" : "string", + "minLength" : 1 + }, + "UL" : { + "type" : "string", + "pattern" : "^[0-9]*$", + "minLength" : 1, + "maxLength" : 20 + } + }, + "additionalProperties" : false + }, + "MimeType" : { + "type" : "string", + "minLength" : 1 + }, + "CommandPayloadContent" : { + "type" : "string" + }, + "CommandPayload" : { + "type" : "object", + "properties" : { + "Content" : { + "$ref" : "#/definitions/CommandPayloadContent" + }, + "ContentType" : { + "$ref" : "#/definitions/MimeType" + } + }, + "additionalProperties" : false + }, + "Tag" : { + "description" : "A key-value pair to associate with a resource.", + "type" : "object", + "properties" : { + "Key" : { + "type" : "string", + "description" : "The tag's key.", + "minLength" : 1, + "maxLength" : 128 + }, + "Value" : { + "type" : "string", + "description" : "The tag's value.", + "minLength" : 1, + "maxLength" : 256 + } + }, + "required" : [ "Value", "Key" ], + "additionalProperties" : false + } + }, + "properties" : { + "CommandArn" : { + "type" : "string", + "description" : "The Amazon Resource Name (ARN) of the command." + }, + "CommandId" : { + "type" : "string", + "pattern" : "^[a-zA-Z0-9_-]+$", + "minLength" : 1, + "maxLength" : 64, + "description" : "The unique identifier for the command." + }, + "CreatedAt" : { + "type" : "string", + "description" : "The date and time when the command was created." + }, + "Deprecated" : { + "type" : "boolean", + "description" : "A flag indicating whether the command is deprecated." + }, + "Description" : { + "type" : "string", + "maxLength" : 2028, + "description" : "The description of the command." + }, + "DisplayName" : { + "type" : "string", + "description" : "The display name for the command." + }, + "LastUpdatedAt" : { + "type" : "string", + "description" : "The date and time when the command was last updated." + }, + "MandatoryParameters" : { + "$ref" : "#/definitions/CommandParameterList", + "description" : "The list of mandatory parameters for the command." + }, + "Namespace" : { + "type" : "string", + "enum" : [ "AWS-IoT", "AWS-IoT-FleetWise" ], + "description" : "The namespace to which the command belongs." + }, + "RoleArn" : { + "type" : "string", + "minLength" : 20, + "maxLength" : 2028, + "description" : "The customer role associated with the command." + }, + "Payload" : { + "$ref" : "#/definitions/CommandPayload", + "description" : "The payload associated with the command." + }, + "PendingDeletion" : { + "type" : "boolean", + "description" : "A flag indicating whether the command is pending deletion." + }, + "Tags" : { + "type" : "array", + "items" : { + "$ref" : "#/definitions/Tag" + }, + "description" : "The tags to be associated with the command.", + "insertionOrder" : true + } + }, + "required" : [ "CommandId" ], + "createOnlyProperties" : [ "/properties/CommandId" ], + "readOnlyProperties" : [ "/properties/CommandArn" ], + "writeOnlyProperties" : [ "/properties/LastUpdatedAt" ], + "primaryIdentifier" : [ "/properties/CommandId" ], + "handlers" : { + "create" : { + "permissions" : [ "iam:PassRole", "iot:CreateCommand", "iot:TagResource" ] + }, + "read" : { + "permissions" : [ "iot:GetCommand", "iot:ListTagsForResource" ] + }, + "update" : { + "permissions" : [ "iam:PassRole", "iot:UpdateCommand", "iot:GetCommand", "iot:TagResource", "iot:UntagResource", "iot:ListTagsForResource" ] + }, + "delete" : { + "permissions" : [ "iot:GetCommand", "iot:UpdateCommand", "iot:DeleteCommand" ] + }, + "list" : { + "permissions" : [ "iot:ListCommands" ] + } + }, + "additionalProperties" : false, + "tagging" : { + "taggable" : true, + "tagOnCreate" : true, + "tagUpdatable" : true, + "cloudFormationSystemTags" : false, + "tagProperty" : "/properties/Tags", + "permissions" : [ "iot:TagResource", "iot:UntagResource", "iot:ListTagsForResource" ] + } +} \ No newline at end of file diff --git a/aws-cloudformation-schema/aws-iotsitewise-gateway.json b/aws-cloudformation-schema/aws-iotsitewise-gateway.json index 7b6479b075..f238d805d5 100644 --- a/aws-cloudformation-schema/aws-iotsitewise-gateway.json +++ b/aws-cloudformation-schema/aws-iotsitewise-gateway.json @@ -1,50 +1,55 @@ { + "sourceUrl" : "https://github.com/aws-cloudformation/aws-cloudformation-resource-providers-IoTSiteWise.git", + "tagging" : { + "permissions" : [ "iotsitewise:TagResource", "iotsitewise:UntagResource", "iotsitewise:ListTagsForResource" ], + "taggable" : true, + "tagOnCreate" : true, + "tagUpdatable" : true, + "tagProperty" : "/properties/Tags", + "cloudFormationSystemTags" : true + }, + "handlers" : { + "read" : { + "permissions" : [ "iotsitewise:DescribeGateway", "iotsitewise:DescribeGatewayCapabilityConfiguration", "iotsitewise:ListTagsForResource" ] + }, + "create" : { + "permissions" : [ "iotsitewise:CreateGateway", "iotsitewise:DescribeGateway", "iotsitewise:DescribeGatewayCapabilityConfiguration", "iotsitewise:UpdateGatewayCapabilityConfiguration", "iam:PassRole", "iam:GetRole", "greengrass:GetCoreDevice", "iotsitewise:ListTagsForResource", "iotsitewise:TagResource", "iot:DescribeThing" ] + }, + "update" : { + "permissions" : [ "iotsitewise:UpdateGateway", "iotsitewise:UpdateGatewayCapabilityConfiguration", "iotsitewise:TagResource", "iotsitewise:UntagResource", "iotsitewise:DescribeGateway", "iotsitewise:DescribeGatewayCapabilityConfiguration", "iotsitewise:ListTagsForResource" ] + }, + "list" : { + "permissions" : [ "iotsitewise:ListGateways", "iotsitewise:ListTagsForResource" ] + }, + "delete" : { + "permissions" : [ "iotsitewise:DescribeGateway", "iotsitewise:DescribeGatewayCapabilityConfiguration", "iotsitewise:DeleteGateway" ] + } + }, "typeName" : "AWS::IoTSiteWise::Gateway", + "readOnlyProperties" : [ "/properties/GatewayId" ], "description" : "Resource schema for AWS::IoTSiteWise::Gateway", - "sourceUrl" : "https://github.com/aws-cloudformation/aws-cloudformation-resource-providers-IoTSiteWise.git", + "createOnlyProperties" : [ "/properties/GatewayPlatform" ], + "additionalProperties" : false, + "primaryIdentifier" : [ "/properties/GatewayId" ], "definitions" : { - "GatewayPlatform" : { - "description" : "Contains a gateway's platform information.", - "type" : "object", + "GatewayCapabilitySummary" : { + "description" : "Contains a summary of a gateway capability configuration.", "additionalProperties" : false, - "properties" : { - "Greengrass" : { - "description" : "A gateway that runs on AWS IoT Greengrass V1.", - "$ref" : "#/definitions/Greengrass" - }, - "GreengrassV2" : { - "description" : "A gateway that runs on AWS IoT Greengrass V2.", - "$ref" : "#/definitions/GreengrassV2" - }, - "SiemensIE" : { - "description" : "A gateway that runs on Siemens Industrial Edge.", - "$ref" : "#/definitions/SiemensIE" - } - }, - "oneOf" : [ { - "required" : [ "Greengrass" ] - }, { - "required" : [ "GreengrassV2" ] - }, { - "required" : [ "SiemensIE" ] - } ] - }, - "Greengrass" : { - "description" : "Contains the ARN of AWS IoT Greengrass Group V1 that the gateway runs on.", "type" : "object", - "additionalProperties" : false, "properties" : { - "GroupArn" : { - "description" : "The ARN of the Greengrass group.", - "type" : "string" + "CapabilityNamespace" : { + "$ref" : "#/definitions/CapabilityNamespace" + }, + "CapabilityConfiguration" : { + "$ref" : "#/definitions/CapabilityConfiguration" } }, - "required" : [ "GroupArn" ] + "required" : [ "CapabilityNamespace" ] }, "GreengrassV2" : { "description" : "Contains the CoreDeviceThingName of AWS IoT Greengrass Group V2 that the gateway runs on.", - "type" : "object", "additionalProperties" : false, + "type" : "object", "properties" : { "CoreDeviceThingName" : { "description" : "The name of the CoreDevice in GreenGrass V2.", @@ -53,56 +58,90 @@ }, "required" : [ "CoreDeviceThingName" ] }, - "SiemensIE" : { - "description" : "Contains the IotCoreThingName of AWS IoT Thing that the gateway runs on.", - "type" : "object", + "CapabilityNamespace" : { + "description" : "The namespace of the capability configuration.", + "type" : "string" + }, + "Greengrass" : { + "description" : "Contains the ARN of AWS IoT Greengrass Group V1 that the gateway runs on.", "additionalProperties" : false, + "type" : "object", "properties" : { - "IotCoreThingName" : { - "description" : "The name of the IoT Core Thing.", + "GroupArn" : { + "description" : "The ARN of the Greengrass group.", "type" : "string" } }, - "required" : [ "IotCoreThingName" ] + "required" : [ "GroupArn" ] + }, + "CapabilityConfiguration" : { + "description" : "The JSON document that defines the gateway capability's configuration.", + "type" : "string" + }, + "GatewayPlatform" : { + "oneOf" : [ { + "required" : [ "Greengrass" ] + }, { + "required" : [ "GreengrassV2" ] + }, { + "required" : [ "SiemensIE" ] + } ], + "description" : "Contains a gateway's platform information.", + "additionalProperties" : false, + "type" : "object", + "properties" : { + "GreengrassV2" : { + "description" : "A gateway that runs on AWS IoT Greengrass V2.", + "$ref" : "#/definitions/GreengrassV2" + }, + "Greengrass" : { + "description" : "A gateway that runs on AWS IoT Greengrass V1.", + "$ref" : "#/definitions/Greengrass" + }, + "SiemensIE" : { + "description" : "A gateway that runs on Siemens Industrial Edge.", + "$ref" : "#/definitions/SiemensIE" + } + } }, "Tag" : { "description" : "To add or update tag, provide both key and value. To delete tag, provide only tag key to be deleted", - "type" : "object", "additionalProperties" : false, + "type" : "object", "properties" : { - "Key" : { + "Value" : { "type" : "string" }, - "Value" : { + "Key" : { "type" : "string" } }, "required" : [ "Key", "Value" ] }, - "CapabilityNamespace" : { - "description" : "The namespace of the capability configuration.", - "type" : "string" - }, - "CapabilityConfiguration" : { - "description" : "The JSON document that defines the gateway capability's configuration.", - "type" : "string" - }, - "GatewayCapabilitySummary" : { - "description" : "Contains a summary of a gateway capability configuration.", - "type" : "object", + "SiemensIE" : { + "description" : "Contains the IotCoreThingName of AWS IoT Thing that the gateway runs on.", "additionalProperties" : false, + "type" : "object", "properties" : { - "CapabilityNamespace" : { - "$ref" : "#/definitions/CapabilityNamespace" - }, - "CapabilityConfiguration" : { - "$ref" : "#/definitions/CapabilityConfiguration" + "IotCoreThingName" : { + "description" : "The name of the IoT Core Thing.", + "type" : "string" } }, - "required" : [ "CapabilityNamespace" ] + "required" : [ "IotCoreThingName" ] } }, + "required" : [ "GatewayName", "GatewayPlatform" ], "properties" : { + "GatewayCapabilitySummaries" : { + "uniqueItems" : true, + "description" : "A list of gateway capability summaries that each contain a namespace and status.", + "insertionOrder" : true, + "type" : "array", + "items" : { + "$ref" : "#/definitions/GatewayCapabilitySummary" + } + }, "GatewayName" : { "description" : "A unique, friendly name for the gateway.", "type" : "string" @@ -111,57 +150,18 @@ "description" : "The gateway's platform. You can only specify one platform in a gateway.", "$ref" : "#/definitions/GatewayPlatform" }, - "Tags" : { - "description" : "A list of key-value pairs that contain metadata for the gateway.", - "type" : "array", - "uniqueItems" : false, - "insertionOrder" : false, - "items" : { - "$ref" : "#/definitions/Tag" - } - }, "GatewayId" : { "description" : "The ID of the gateway device.", "type" : "string" }, - "GatewayCapabilitySummaries" : { - "description" : "A list of gateway capability summaries that each contain a namespace and status.", + "Tags" : { + "uniqueItems" : false, + "description" : "A list of key-value pairs that contain metadata for the gateway.", + "insertionOrder" : false, "type" : "array", - "uniqueItems" : true, - "insertionOrder" : true, "items" : { - "$ref" : "#/definitions/GatewayCapabilitySummary" + "$ref" : "#/definitions/Tag" } } - }, - "additionalProperties" : false, - "tagging" : { - "taggable" : true, - "tagOnCreate" : true, - "tagUpdatable" : true, - "cloudFormationSystemTags" : true, - "tagProperty" : "/properties/Tags", - "permissions" : [ "iotsitewise:TagResource", "iotsitewise:UntagResource", "iotsitewise:ListTagsForResource" ] - }, - "required" : [ "GatewayName", "GatewayPlatform" ], - "readOnlyProperties" : [ "/properties/GatewayId" ], - "createOnlyProperties" : [ "/properties/GatewayPlatform" ], - "primaryIdentifier" : [ "/properties/GatewayId" ], - "handlers" : { - "create" : { - "permissions" : [ "iotsitewise:CreateGateway", "iotsitewise:DescribeGateway", "iotsitewise:DescribeGatewayCapabilityConfiguration", "iotsitewise:UpdateGatewayCapabilityConfiguration", "iam:PassRole", "iam:GetRole", "greengrass:GetCoreDevice", "iotsitewise:ListTagsForResource", "iotsitewise:TagResource", "iot:DescribeThing" ] - }, - "read" : { - "permissions" : [ "iotsitewise:DescribeGateway", "iotsitewise:DescribeGatewayCapabilityConfiguration", "iotsitewise:ListTagsForResource" ] - }, - "update" : { - "permissions" : [ "iotsitewise:UpdateGateway", "iotsitewise:UpdateGatewayCapabilityConfiguration", "iotsitewise:TagResource", "iotsitewise:UntagResource", "iotsitewise:DescribeGateway", "iotsitewise:DescribeGatewayCapabilityConfiguration", "iotsitewise:ListTagsForResource" ] - }, - "delete" : { - "permissions" : [ "iotsitewise:DescribeGateway", "iotsitewise:DescribeGatewayCapabilityConfiguration", "iotsitewise:DeleteGateway" ] - }, - "list" : { - "permissions" : [ "iotsitewise:ListGateways", "iotsitewise:ListTagsForResource" ] - } } } \ No newline at end of file diff --git a/aws-cloudformation-schema/aws-logs-transformer.json b/aws-cloudformation-schema/aws-logs-transformer.json new file mode 100644 index 0000000000..b47ad3e935 --- /dev/null +++ b/aws-cloudformation-schema/aws-logs-transformer.json @@ -0,0 +1,577 @@ +{ + "typeName" : "AWS::Logs::Transformer", + "description" : "Specifies a transformer on the log group to transform logs into consistent structured and information rich format.", + "sourceUrl" : "https://github.com/aws-cloudformation/aws-cloudformation-resource-providers-logs.git", + "properties" : { + "LogGroupIdentifier" : { + "description" : "Existing log group that you want to associate with this transformer.", + "type" : "string", + "minLength" : 1, + "maxLength" : 2048, + "pattern" : "[\\w#+=/:,.@-]*" + }, + "TransformerConfig" : { + "description" : "List of processors in a transformer", + "type" : "array", + "items" : { + "$ref" : "#/definitions/Processor" + }, + "minItems" : 1, + "maxItems" : 20, + "insertionOrder" : false + } + }, + "required" : [ "LogGroupIdentifier", "TransformerConfig" ], + "additionalProperties" : false, + "definitions" : { + "Processor" : { + "description" : "Individual processor configuration", + "type" : "object", + "properties" : { + "ParseCloudfront" : { + "$ref" : "#/definitions/ParseCloudfront" + }, + "ParseVPC" : { + "$ref" : "#/definitions/ParseVPC" + }, + "ParseWAF" : { + "$ref" : "#/definitions/ParseWAF" + }, + "ParseJSON" : { + "type" : "object", + "properties" : { + "Source" : { + "type" : "string" + }, + "Destination" : { + "$ref" : "#/definitions/NonEmptyAndMaxLengthString" + } + }, + "additionalProperties" : false + }, + "ParseRoute53" : { + "$ref" : "#/definitions/ParseRoute53" + }, + "ParsePostgres" : { + "$ref" : "#/definitions/ParsePostgres" + }, + "ParseKeyValue" : { + "type" : "object", + "properties" : { + "Source" : { + "$ref" : "#/definitions/NonEmptyString" + }, + "Destination" : { + "$ref" : "#/definitions/NonEmptyString" + }, + "FieldDelimiter" : { + "type" : "string" + }, + "KeyValueDelimiter" : { + "type" : "string" + }, + "KeyPrefix" : { + "$ref" : "#/definitions/NonEmptyString" + }, + "NonMatchValue" : { + "$ref" : "#/definitions/NonEmptyString" + }, + "OverwriteIfExists" : { + "type" : "boolean" + } + }, + "additionalProperties" : false + }, + "CopyValue" : { + "type" : "object", + "properties" : { + "Entries" : { + "type" : "array", + "items" : { + "$ref" : "#/definitions/CopyValueEntry" + }, + "minItems" : 1, + "maxItems" : 5, + "insertionOrder" : false + } + }, + "required" : [ "Entries" ], + "additionalProperties" : false + }, + "Csv" : { + "type" : "object", + "properties" : { + "QuoteCharacter" : { + "type" : "string", + "maxLength" : 1 + }, + "Delimiter" : { + "type" : "string", + "maxLength" : 1 + }, + "Source" : { + "type" : "string" + }, + "Columns" : { + "type" : "array", + "items" : { + "$ref" : "#/definitions/Column" + }, + "minItems" : 1, + "maxItems" : 100, + "insertionOrder" : false + } + }, + "additionalProperties" : false + }, + "DateTimeConverter" : { + "type" : "object", + "properties" : { + "Source" : { + "$ref" : "#/definitions/NonEmptyString" + }, + "Target" : { + "$ref" : "#/definitions/NonEmptyAndMaxLengthString" + }, + "TargetFormat" : { + "type" : "string" + }, + "MatchPatterns" : { + "type" : "array", + "items" : { + "$ref" : "#/definitions/MatchPattern" + }, + "minItems" : 1, + "maxItems" : 5, + "uniqueItems" : true, + "insertionOrder" : false + }, + "SourceTimezone" : { + "type" : "string" + }, + "TargetTimezone" : { + "type" : "string" + }, + "Locale" : { + "type" : "string" + } + }, + "required" : [ "Source", "Target", "MatchPatterns" ], + "additionalProperties" : false + }, + "DeleteKeys" : { + "type" : "object", + "properties" : { + "WithKeys" : { + "type" : "array", + "items" : { + "$ref" : "#/definitions/WithKey" + }, + "minItems" : 1, + "maxItems" : 5, + "uniqueItems" : true, + "insertionOrder" : false + } + }, + "required" : [ "WithKeys" ], + "additionalProperties" : false + }, + "Grok" : { + "type" : "object", + "properties" : { + "Source" : { + "$ref" : "#/definitions/NonEmptyString" + }, + "Match" : { + "type" : "string", + "maxLength" : 128 + } + }, + "required" : [ "Match" ], + "additionalProperties" : false + }, + "ListToMap" : { + "type" : "object", + "properties" : { + "Source" : { + "$ref" : "#/definitions/NonEmptyString" + }, + "Key" : { + "$ref" : "#/definitions/NonEmptyString" + }, + "ValueKey" : { + "$ref" : "#/definitions/NonEmptyString" + }, + "Target" : { + "$ref" : "#/definitions/NonEmptyAndMaxLengthString" + }, + "Flatten" : { + "type" : "boolean" + }, + "FlattenedElement" : { + "type" : "string", + "enum" : [ "first", "last" ] + } + }, + "required" : [ "Source", "Key" ], + "additionalProperties" : false + }, + "AddKeys" : { + "type" : "object", + "properties" : { + "Entries" : { + "type" : "array", + "items" : { + "$ref" : "#/definitions/AddKeyEntry" + }, + "minItems" : 1, + "maxItems" : 5, + "uniqueItems" : true, + "insertionOrder" : false + } + }, + "required" : [ "Entries" ], + "additionalProperties" : false + }, + "MoveKeys" : { + "type" : "object", + "properties" : { + "Entries" : { + "type" : "array", + "items" : { + "$ref" : "#/definitions/MoveKeyEntry" + }, + "minItems" : 1, + "maxItems" : 5, + "insertionOrder" : false + } + }, + "required" : [ "Entries" ], + "additionalProperties" : false + }, + "RenameKeys" : { + "type" : "object", + "properties" : { + "Entries" : { + "type" : "array", + "items" : { + "$ref" : "#/definitions/RenameKeyEntry" + }, + "minItems" : 1, + "maxItems" : 5, + "insertionOrder" : false + } + }, + "required" : [ "Entries" ], + "additionalProperties" : false + }, + "LowerCaseString" : { + "type" : "object", + "properties" : { + "WithKeys" : { + "type" : "array", + "items" : { + "$ref" : "#/definitions/WithKey" + }, + "minItems" : 1, + "maxItems" : 10, + "uniqueItems" : true, + "insertionOrder" : false + } + }, + "required" : [ "WithKeys" ], + "additionalProperties" : false + }, + "SplitString" : { + "type" : "object", + "properties" : { + "Entries" : { + "type" : "array", + "items" : { + "$ref" : "#/definitions/SplitStringEntry" + }, + "minItems" : 1, + "maxItems" : 10, + "insertionOrder" : false + } + }, + "required" : [ "Entries" ], + "additionalProperties" : false + }, + "SubstituteString" : { + "type" : "object", + "properties" : { + "Entries" : { + "type" : "array", + "items" : { + "$ref" : "#/definitions/SubstituteStringEntry" + }, + "minItems" : 1, + "maxItems" : 10, + "insertionOrder" : false + } + }, + "required" : [ "Entries" ], + "additionalProperties" : false + }, + "TrimString" : { + "type" : "object", + "properties" : { + "WithKeys" : { + "type" : "array", + "items" : { + "$ref" : "#/definitions/WithKey" + }, + "minItems" : 1, + "maxItems" : 10, + "uniqueItems" : true, + "insertionOrder" : false + } + }, + "required" : [ "WithKeys" ], + "additionalProperties" : false + }, + "UpperCaseString" : { + "type" : "object", + "properties" : { + "WithKeys" : { + "type" : "array", + "items" : { + "$ref" : "#/definitions/WithKey" + }, + "minItems" : 1, + "maxItems" : 10, + "uniqueItems" : true, + "insertionOrder" : false + } + }, + "required" : [ "WithKeys" ], + "additionalProperties" : false + }, + "TypeConverter" : { + "type" : "object", + "properties" : { + "Entries" : { + "type" : "array", + "items" : { + "$ref" : "#/definitions/TypeConverterEntry" + }, + "minItems" : 1, + "maxItems" : 5, + "insertionOrder" : false + } + }, + "required" : [ "Entries" ], + "additionalProperties" : false + } + }, + "additionalProperties" : false, + "minProperties" : 1, + "maxProperties" : 1 + }, + "ParseCloudfront" : { + "type" : "object", + "properties" : { + "Source" : { + "$ref" : "#/definitions/NonEmptyString" + } + }, + "additionalProperties" : false + }, + "ParseVPC" : { + "type" : "object", + "properties" : { + "Source" : { + "$ref" : "#/definitions/NonEmptyString" + } + }, + "additionalProperties" : false + }, + "ParseWAF" : { + "type" : "object", + "properties" : { + "Source" : { + "$ref" : "#/definitions/NonEmptyString" + } + }, + "additionalProperties" : false + }, + "ParseRoute53" : { + "type" : "object", + "properties" : { + "Source" : { + "$ref" : "#/definitions/NonEmptyString" + } + }, + "additionalProperties" : false + }, + "ParsePostgres" : { + "type" : "object", + "properties" : { + "Source" : { + "$ref" : "#/definitions/NonEmptyString" + } + }, + "additionalProperties" : false + }, + "AddKeyEntry" : { + "type" : "object", + "properties" : { + "Key" : { + "$ref" : "#/definitions/NonEmptyAndMaxLengthString" + }, + "Value" : { + "type" : "string", + "minLength" : 1, + "maxLength" : 256 + }, + "OverwriteIfExists" : { + "type" : "boolean" + } + }, + "additionalProperties" : false, + "required" : [ "Key", "Value" ] + }, + "CopyValueEntry" : { + "type" : "object", + "properties" : { + "Source" : { + "$ref" : "#/definitions/NonEmptyString" + }, + "Target" : { + "$ref" : "#/definitions/NonEmptyAndMaxLengthString" + }, + "OverwriteIfExists" : { + "type" : "boolean" + } + }, + "required" : [ "Source", "Target" ], + "additionalProperties" : false + }, + "Column" : { + "$ref" : "#/definitions/NonEmptyAndMaxLengthString" + }, + "WithKey" : { + "type" : "string", + "minLength" : 1, + "maxLength" : 128 + }, + "MatchPattern" : { + "$ref" : "#/definitions/NonEmptyString" + }, + "MoveKeyEntry" : { + "type" : "object", + "properties" : { + "Source" : { + "$ref" : "#/definitions/NonEmptyString" + }, + "Target" : { + "$ref" : "#/definitions/NonEmptyString" + }, + "OverwriteIfExists" : { + "type" : "boolean" + } + }, + "required" : [ "Source", "Target" ], + "additionalProperties" : false + }, + "RenameKeyEntry" : { + "type" : "object", + "properties" : { + "Key" : { + "$ref" : "#/definitions/NonEmptyString" + }, + "RenameTo" : { + "$ref" : "#/definitions/NonEmptyString" + }, + "OverwriteIfExists" : { + "type" : "boolean" + } + }, + "required" : [ "Key", "RenameTo" ], + "additionalProperties" : false + }, + "SplitStringEntry" : { + "type" : "object", + "properties" : { + "Source" : { + "$ref" : "#/definitions/NonEmptyString" + }, + "Delimiter" : { + "type" : "string", + "maxLength" : 1 + } + }, + "required" : [ "Source", "Delimiter" ], + "additionalProperties" : false + }, + "SubstituteStringEntry" : { + "type" : "object", + "properties" : { + "Source" : { + "$ref" : "#/definitions/NonEmptyString" + }, + "From" : { + "$ref" : "#/definitions/NonEmptyAndMaxLengthString" + }, + "To" : { + "$ref" : "#/definitions/NonEmptyAndMaxLengthString" + } + }, + "required" : [ "Source", "From", "To" ], + "additionalProperties" : false + }, + "TypeConverterEntry" : { + "type" : "object", + "properties" : { + "Key" : { + "$ref" : "#/definitions/NonEmptyString" + }, + "Type" : { + "type" : "string", + "enum" : [ "boolean", "integer", "double", "string" ] + } + }, + "required" : [ "Key", "Type" ], + "additionalProperties" : false + }, + "NonEmptyAndMaxLengthString" : { + "type" : "string", + "maxLength" : 128, + "pattern" : "^.*[a-zA-Z0-9]+.*$" + }, + "NonEmptyString" : { + "type" : "string", + "pattern" : "^.*[a-zA-Z0-9]+.*$" + }, + "MaxLengthString" : { + "type" : "string", + "maxLength" : 128 + } + }, + "primaryIdentifier" : [ "/properties/LogGroupIdentifier" ], + "createOnlyProperties" : [ "/properties/LogGroupIdentifier" ], + "handlers" : { + "create" : { + "permissions" : [ "logs:PutTransformer", "logs:GetTransformer" ] + }, + "read" : { + "permissions" : [ "logs:GetTransformer" ] + }, + "update" : { + "permissions" : [ "logs:GetTransformer", "logs:PutTransformer" ] + }, + "delete" : { + "permissions" : [ "logs:DeleteTransformer" ] + }, + "list" : { + "permissions" : [ "logs:DescribeLogGroups", "logs:GetTransformer" ] + } + }, + "tagging" : { + "taggable" : false, + "tagOnCreate" : false, + "tagUpdatable" : false, + "cloudFormationSystemTags" : false + } +} \ No newline at end of file diff --git a/aws-cloudformation-schema/aws-networkmanager-directconnectgatewayattachment.json b/aws-cloudformation-schema/aws-networkmanager-directconnectgatewayattachment.json new file mode 100644 index 0000000000..cdb1999140 --- /dev/null +++ b/aws-cloudformation-schema/aws-networkmanager-directconnectgatewayattachment.json @@ -0,0 +1,184 @@ +{ + "typeName" : "AWS::NetworkManager::DirectConnectGatewayAttachment", + "description" : "AWS::NetworkManager::DirectConnectGatewayAttachment Resource Type", + "sourceUrl" : "https://github.com/aws-cloudformation/aws-cloudformation-resource-providers-networkmanager/aws-networkmanager-directconnectgatewayattachment", + "properties" : { + "CoreNetworkId" : { + "description" : "The ID of a core network for the Direct Connect Gateway attachment.", + "type" : "string" + }, + "CoreNetworkArn" : { + "description" : "The ARN of a core network for the Direct Connect Gateway attachment.", + "type" : "string" + }, + "AttachmentId" : { + "description" : "Id of the attachment.", + "type" : "string" + }, + "OwnerAccountId" : { + "description" : "Owner account of the attachment.", + "type" : "string" + }, + "AttachmentType" : { + "description" : "Attachment type.", + "type" : "string" + }, + "State" : { + "description" : "State of the attachment.", + "type" : "string" + }, + "EdgeLocations" : { + "description" : "The Regions where the edges are located.", + "type" : "array", + "insertionOrder" : false, + "items" : { + "type" : "string" + } + }, + "DirectConnectGatewayArn" : { + "description" : "The ARN of the Direct Connect Gateway.", + "type" : "string" + }, + "ResourceArn" : { + "description" : "The ARN of the Resource.", + "type" : "string" + }, + "AttachmentPolicyRuleNumber" : { + "description" : "The policy rule number associated with the attachment.", + "type" : "integer" + }, + "SegmentName" : { + "description" : "The name of the segment attachment..", + "type" : "string" + }, + "ProposedSegmentChange" : { + "description" : "The attachment to move from one segment to another.", + "$ref" : "#/definitions/ProposedSegmentChange" + }, + "NetworkFunctionGroupName" : { + "description" : "The name of the network function group attachment.", + "type" : "string" + }, + "ProposedNetworkFunctionGroupChange" : { + "description" : "The attachment to move from one network function group to another.", + "$ref" : "#/definitions/ProposedNetworkFunctionGroupChange" + }, + "Tags" : { + "description" : "Tags for the attachment.", + "type" : "array", + "uniqueItems" : true, + "insertionOrder" : false, + "items" : { + "$ref" : "#/definitions/Tag" + } + }, + "CreatedAt" : { + "description" : "Creation time of the attachment.", + "type" : "string" + }, + "UpdatedAt" : { + "description" : "Last update time of the attachment.", + "type" : "string" + } + }, + "definitions" : { + "Tag" : { + "description" : "A key-value pair to associate with a resource.", + "type" : "object", + "properties" : { + "Key" : { + "type" : "string", + "description" : "The key name of the tag. You can specify a value that is 1 to 128 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -." + }, + "Value" : { + "type" : "string", + "description" : "The value for the tag. You can specify a value that is 0 to 256 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -." + } + }, + "required" : [ "Key", "Value" ], + "additionalProperties" : false + }, + "ProposedSegmentChange" : { + "description" : "The attachment to move from one segment to another.", + "type" : "object", + "properties" : { + "Tags" : { + "description" : "The key-value tags that changed for the segment.", + "type" : "array", + "uniqueItems" : true, + "insertionOrder" : false, + "items" : { + "$ref" : "#/definitions/Tag" + } + }, + "AttachmentPolicyRuleNumber" : { + "description" : "The rule number in the policy document that applies to this change.", + "type" : "integer" + }, + "SegmentName" : { + "description" : "The name of the segment to change.", + "type" : "string" + } + }, + "additionalProperties" : false + }, + "ProposedNetworkFunctionGroupChange" : { + "description" : "The attachment to move from one network function group to another.", + "type" : "object", + "properties" : { + "Tags" : { + "description" : "The key-value tags that changed for the network function group.", + "type" : "array", + "uniqueItems" : true, + "insertionOrder" : false, + "items" : { + "$ref" : "#/definitions/Tag" + } + }, + "AttachmentPolicyRuleNumber" : { + "description" : "The rule number in the policy document that applies to this change.", + "type" : "integer" + }, + "NetworkFunctionGroupName" : { + "description" : "The name of the network function group to change.", + "type" : "string" + } + }, + "additionalProperties" : false + } + }, + "tagging" : { + "taggable" : true, + "tagOnCreate" : true, + "tagUpdatable" : true, + "cloudFormationSystemTags" : false, + "tagProperty" : "/properties/Tags", + "permissions" : [ "networkmanager:TagResource", "networkmanager:UntagResource", "networkmanager:ListTagsForResource" ] + }, + "additionalProperties" : false, + "required" : [ "CoreNetworkId", "DirectConnectGatewayArn", "EdgeLocations" ], + "createOnlyProperties" : [ "/properties/CoreNetworkId", "/properties/DirectConnectGatewayArn" ], + "readOnlyProperties" : [ "/properties/CoreNetworkArn", "/properties/CreatedAt", "/properties/UpdatedAt", "/properties/AttachmentType", "/properties/State", "/properties/AttachmentId", "/properties/OwnerAccountId", "/properties/AttachmentPolicyRuleNumber", "/properties/SegmentName", "/properties/NetworkFunctionGroupName", "/properties/ResourceArn" ], + "primaryIdentifier" : [ "/properties/AttachmentId" ], + "additionalIdentifiers" : [ [ "/properties/CoreNetworkId", "/properties/DirectConnectGatewayArn" ] ], + "handlers" : { + "create" : { + "permissions" : [ "networkmanager:CreateDirectConnectGatewayAttachment", "networkmanager:GetDirectConnectGatewayAttachment", "networkmanager:TagResource", "ec2:DescribeRegions", "iam:CreateServiceLinkedRole" ], + "timeoutInMinutes" : 60 + }, + "read" : { + "permissions" : [ "networkmanager:GetDirectConnectGatewayAttachment" ] + }, + "update" : { + "permissions" : [ "networkmanager:UpdateDirectConnectGatewayAttachment", "networkmanager:GetDirectConnectGatewayAttachment", "networkmanager:ListTagsForResource", "networkmanager:TagResource", "networkmanager:UntagResource", "ec2:DescribeRegions" ], + "timeoutInMinutes" : 60 + }, + "delete" : { + "permissions" : [ "networkmanager:DeleteAttachment", "networkmanager:GetDirectConnectGatewayAttachment", "networkmanager:UntagResource", "ec2:DescribeRegions" ], + "timeoutInMinutes" : 60 + }, + "list" : { + "permissions" : [ "networkmanager:ListAttachments" ] + } + } +} \ No newline at end of file diff --git a/aws-cloudformation-schema/aws-networkmanager-transitgatewaypeering.json b/aws-cloudformation-schema/aws-networkmanager-transitgatewaypeering.json index 04c93705af..406bd39858 100644 --- a/aws-cloudformation-schema/aws-networkmanager-transitgatewaypeering.json +++ b/aws-cloudformation-schema/aws-networkmanager-transitgatewaypeering.json @@ -98,7 +98,7 @@ "timeoutInMinutes" : 60 }, "read" : { - "permissions" : [ "networkmanager:GetTransitGatewayPeering", "networkmanager:TagResource" ] + "permissions" : [ "networkmanager:GetTransitGatewayPeering" ] }, "update" : { "permissions" : [ "networkmanager:TagResource", "networkmanager:UntagResource", "networkmanager:ListTagsForResource", "networkmanager:GetTransitGatewayPeering", "ec2:DescribeRegions" ] diff --git a/aws-cloudformation-schema/aws-oam-link.json b/aws-cloudformation-schema/aws-oam-link.json index 9e25bf833a..89791ce659 100644 --- a/aws-cloudformation-schema/aws-oam-link.json +++ b/aws-cloudformation-schema/aws-oam-link.json @@ -92,13 +92,13 @@ "primaryIdentifier" : [ "/properties/Arn" ], "handlers" : { "create" : { - "permissions" : [ "oam:CreateLink", "oam:GetLink", "cloudwatch:Link", "logs:Link", "xray:Link", "applicationinsights:Link", "internetmonitor:Link" ] + "permissions" : [ "oam:CreateLink", "oam:GetLink", "oam:TagResource", "oam:ListTagsForResource", "cloudwatch:Link", "logs:Link", "xray:Link", "applicationinsights:Link", "internetmonitor:Link" ] }, "read" : { - "permissions" : [ "oam:GetLink" ] + "permissions" : [ "oam:GetLink", "oam:ListTagsForResource" ] }, "update" : { - "permissions" : [ "oam:GetLink", "oam:UpdateLink", "cloudwatch:Link", "logs:Link", "xray:Link", "applicationinsights:Link", "internetmonitor:Link", "oam:TagResource", "oam:UntagResource" ] + "permissions" : [ "oam:GetLink", "oam:UpdateLink", "cloudwatch:Link", "logs:Link", "xray:Link", "applicationinsights:Link", "internetmonitor:Link", "oam:TagResource", "oam:UntagResource", "oam:ListTagsForResource" ] }, "delete" : { "permissions" : [ "oam:DeleteLink", "oam:GetLink" ] diff --git a/aws-cloudformation-schema/aws-oam-sink.json b/aws-cloudformation-schema/aws-oam-sink.json index ad8dd78707..3a0ef1228a 100644 --- a/aws-cloudformation-schema/aws-oam-sink.json +++ b/aws-cloudformation-schema/aws-oam-sink.json @@ -48,7 +48,7 @@ "primaryIdentifier" : [ "/properties/Arn" ], "handlers" : { "create" : { - "permissions" : [ "oam:CreateSink", "oam:PutSinkPolicy", "oam:GetSinkPolicy", "oam:GetSink" ] + "permissions" : [ "oam:CreateSink", "oam:PutSinkPolicy", "oam:GetSinkPolicy", "oam:GetSink", "oam:TagResource", "oam:ListTagsForResource" ] }, "delete" : { "permissions" : [ "oam:DeleteSink", "oam:GetSinkPolicy", "oam:GetSink" ] @@ -57,10 +57,10 @@ "permissions" : [ "oam:ListSinks" ] }, "read" : { - "permissions" : [ "oam:GetSinkPolicy", "oam:GetSink" ] + "permissions" : [ "oam:GetSinkPolicy", "oam:GetSink", "oam:ListTagsForResource" ] }, "update" : { - "permissions" : [ "oam:PutSinkPolicy", "oam:GetSinkPolicy", "oam:GetSink", "oam:TagResource", "oam:UntagResource" ] + "permissions" : [ "oam:PutSinkPolicy", "oam:GetSinkPolicy", "oam:GetSink", "oam:TagResource", "oam:UntagResource", "oam:ListTagsForResource" ] } } } \ No newline at end of file diff --git a/aws-cloudformation-schema/aws-organizations-policy.json b/aws-cloudformation-schema/aws-organizations-policy.json index 08a7b220fd..3d9ce54dbe 100644 --- a/aws-cloudformation-schema/aws-organizations-policy.json +++ b/aws-cloudformation-schema/aws-organizations-policy.json @@ -11,9 +11,9 @@ "maxLength" : 128 }, "Type" : { - "description" : "The type of policy to create. You can specify one of the following values: AISERVICES_OPT_OUT_POLICY, BACKUP_POLICY, SERVICE_CONTROL_POLICY, TAG_POLICY, CHATBOT_POLICY, RESOURCE_CONTROL_POLICY", + "description" : "The type of policy to create. You can specify one of the following values: AISERVICES_OPT_OUT_POLICY, BACKUP_POLICY, SERVICE_CONTROL_POLICY, TAG_POLICY, CHATBOT_POLICY, RESOURCE_CONTROL_POLICY,DECLARATIVE_POLICY_EC2", "type" : "string", - "enum" : [ "SERVICE_CONTROL_POLICY", "AISERVICES_OPT_OUT_POLICY", "BACKUP_POLICY", "TAG_POLICY", "CHATBOT_POLICY", "RESOURCE_CONTROL_POLICY" ] + "enum" : [ "SERVICE_CONTROL_POLICY", "AISERVICES_OPT_OUT_POLICY", "BACKUP_POLICY", "TAG_POLICY", "CHATBOT_POLICY", "RESOURCE_CONTROL_POLICY", "DECLARATIVE_POLICY_EC2" ] }, "Content" : { "description" : "The Policy text content. For AWS CloudFormation templates formatted in YAML, you can provide the policy in JSON or YAML format. AWS CloudFormation always converts a YAML policy to JSON format before submitting it.", diff --git a/aws-cloudformation-schema/aws-ram-resourceshare.json b/aws-cloudformation-schema/aws-ram-resourceshare.json index 1573d61329..ccc832c790 100644 --- a/aws-cloudformation-schema/aws-ram-resourceshare.json +++ b/aws-cloudformation-schema/aws-ram-resourceshare.json @@ -1,72 +1,107 @@ { "typeName" : "AWS::RAM::ResourceShare", - "description" : "Resource Type definition for AWS::RAM::ResourceShare", - "additionalProperties" : false, + "description" : "Resource type definition for AWS::RAM::ResourceShare", + "sourceUrl" : "https://github.com/aws-cloudformation/aws-cloudformation-resource-providers-ram", + "definitions" : { + "Tag" : { + "description" : "A key-value pair to associate with a resource.", + "type" : "object", + "properties" : { + "Key" : { + "type" : "string", + "description" : "The key name of the tag. You can specify a value that is 1 to 128 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -." + }, + "Value" : { + "type" : "string", + "description" : "The value for the tag. You can specify a value that is 0 to 256 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -." + } + }, + "required" : [ "Key", "Value" ], + "additionalProperties" : false + } + }, "properties" : { + "AllowExternalPrincipals" : { + "description" : "Specifies whether principals outside your organization in AWS Organizations can be associated with a resource share. A value of `true` lets you share with individual AWS accounts that are not in your organization. A value of `false` only has meaning if your account is a member of an AWS Organization. The default value is `true`.", + "type" : "boolean" + }, + "Arn" : { + "type" : "string" + }, + "Name" : { + "description" : "Specifies the name of the resource share.", + "type" : "string" + }, "PermissionArns" : { + "description" : "Specifies the [Amazon Resource Names (ARNs)](https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html) of the AWS RAM permission to associate with the resource share. If you do not specify an ARN for the permission, AWS RAM automatically attaches the default version of the permission for each resource type. You can associate only one permission with each resource type included in the resource share.", "type" : "array", - "uniqueItems" : false, + "insertionOrder" : false, "items" : { "type" : "string" } }, "Principals" : { + "description" : "Specifies the principals to associate with the resource share. The possible values are:\n\n- An AWS account ID\n\n- An Amazon Resource Name (ARN) of an organization in AWS Organizations\n\n- An ARN of an organizational unit (OU) in AWS Organizations\n\n- An ARN of an IAM role\n\n- An ARN of an IAM user", "type" : "array", - "uniqueItems" : false, + "insertionOrder" : false, "items" : { "type" : "string" } }, - "AllowExternalPrincipals" : { - "type" : "boolean" - }, - "Id" : { - "type" : "string" - }, - "Arn" : { - "type" : "string" - }, "ResourceArns" : { + "description" : "Specifies a list of one or more ARNs of the resources to associate with the resource share.", "type" : "array", - "uniqueItems" : false, + "insertionOrder" : false, "items" : { "type" : "string" } }, "Sources" : { + "description" : "Specifies from which source accounts the service principal has access to the resources in this resource share.", "type" : "array", - "uniqueItems" : false, + "insertionOrder" : false, "items" : { "type" : "string" } }, "Tags" : { + "description" : "Specifies one or more tags to attach to the resource share itself. It doesn't attach the tags to the resources associated with the resource share.", "type" : "array", - "uniqueItems" : false, + "uniqueItems" : true, + "insertionOrder" : false, "items" : { "$ref" : "#/definitions/Tag" } - }, - "Name" : { - "type" : "string" - } - }, - "definitions" : { - "Tag" : { - "type" : "object", - "additionalProperties" : false, - "properties" : { - "Value" : { - "type" : "string" - }, - "Key" : { - "type" : "string" - } - }, - "required" : [ "Value", "Key" ] } }, + "additionalProperties" : false, "required" : [ "Name" ], - "primaryIdentifier" : [ "/properties/Id" ], - "readOnlyProperties" : [ "/properties/Id", "/properties/Arn" ] + "readOnlyProperties" : [ "/properties/Arn" ], + "writeOnlyProperties" : [ "/properties/PermissionArns", "/properties/Principals", "/properties/ResourceArns", "/properties/Sources" ], + "primaryIdentifier" : [ "/properties/Arn" ], + "tagging" : { + "taggable" : true, + "tagOnCreate" : true, + "tagUpdatable" : true, + "cloudFormationSystemTags" : false, + "tagProperty" : "/properties/Tags", + "permissions" : [ "ram:TagResource", "ram:UntagResource" ] + }, + "handlers" : { + "create" : { + "permissions" : [ "ram:CreateResourceShare", "ram:TagResource" ] + }, + "read" : { + "permissions" : [ "ram:GetResourceShares" ] + }, + "update" : { + "permissions" : [ "ram:GetPermission", "ram:GetResourceShares", "ram:GetResourceShareAssociations", "ram:ListResourceSharePermissions", "ram:UpdateResourceShare", "ram:AssociateResourceSharePermission", "ram:AssociateResourceShare", "ram:DisassociateResourceShare", "ram:UntagResource", "ram:TagResource" ] + }, + "delete" : { + "permissions" : [ "ram:DeleteResourceShare", "ram:GetResourceShares" ] + }, + "list" : { + "permissions" : [ "ram:GetResourceShares" ] + } + } } \ No newline at end of file diff --git a/aws-cloudformation-schema/aws-rds-customdbengineversion.json b/aws-cloudformation-schema/aws-rds-customdbengineversion.json index b22d4b2030..ee854e08d1 100644 --- a/aws-cloudformation-schema/aws-rds-customdbengineversion.json +++ b/aws-cloudformation-schema/aws-rds-customdbengineversion.json @@ -1,24 +1,29 @@ { "typeName" : "AWS::RDS::CustomDBEngineVersion", - "description" : "The AWS::RDS::CustomDBEngineVersion resource creates an Amazon RDS custom DB engine version.", + "description" : "Creates a custom DB engine version (CEV).", "sourceUrl" : "https://github.com/aws-cloudformation/aws-cloudformation-rpdk.git", "tagging" : { - "taggable" : true + "taggable" : true, + "tagOnCreate" : true, + "tagUpdatable" : true, + "cloudFormationSystemTags" : true, + "tagProperty" : "/properties/Tags", + "permissions" : [ "rds:AddTagsToResource", "rds:RemoveTagsFromResource" ] }, "definitions" : { "Tag" : { - "description" : "A key-value pair to associate with a resource.", + "description" : "Metadata assigned to an Amazon RDS resource consisting of a key-value pair.\n For more information, see [Tagging Amazon RDS resources](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_Tagging.html) in the *Amazon RDS User Guide* or [Tagging Amazon Aurora and Amazon RDS resources](https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/USER_Tagging.html) in the *Amazon Aurora User Guide*.", "type" : "object", "properties" : { "Key" : { "type" : "string", - "description" : "The key name of the tag. You can specify a value that is 1 to 128 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -.", + "description" : "A key is the required name of the tag. The string value can be from 1 to 128 Unicode characters in length and can't be prefixed with ``aws:`` or ``rds:``. The string can only contain only the set of Unicode letters, digits, white-space, '_', '.', ':', '/', '=', '+', '-', '@' (Java regex: \"^([\\\\p{L}\\\\p{Z}\\\\p{N}_.:/=+\\\\-@]*)$\").", "minLength" : 1, "maxLength" : 128 }, "Value" : { "type" : "string", - "description" : "The value for the tag. You can specify a value that is 0 to 256 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -.", + "description" : "A value is the optional value of the tag. The string value can be from 1 to 256 Unicode characters in length and can't be prefixed with ``aws:`` or ``rds:``. The string can only contain only the set of Unicode letters, digits, white-space, '_', '.', ':', '/', '=', '+', '-', '@' (Java regex: \"^([\\\\p{L}\\\\p{Z}\\\\p{N}_.:/=+\\\\-@]*)$\").", "minLength" : 0, "maxLength" : 256 } @@ -30,13 +35,13 @@ "properties" : { "DatabaseInstallationFilesS3BucketName" : { "type" : "string", - "description" : "The name of an Amazon S3 bucket that contains database installation files for your CEV. For example, a valid bucket name is `my-custom-installation-files`.", + "description" : "The name of an Amazon S3 bucket that contains database installation files for your CEV. For example, a valid bucket name is ``my-custom-installation-files``.", "minLength" : 3, "maxLength" : 63 }, "DatabaseInstallationFilesS3Prefix" : { "type" : "string", - "description" : "The Amazon S3 directory that contains the database installation files for your CEV. For example, a valid bucket name is `123456789012/cev1`. If this setting isn't specified, no prefix is assumed.", + "description" : "The Amazon S3 directory that contains the database installation files for your CEV. For example, a valid bucket name is ``123456789012/cev1``. If this setting isn't specified, no prefix is assumed.", "minLength" : 1, "maxLength" : 255 }, @@ -48,52 +53,52 @@ }, "Engine" : { "type" : "string", - "description" : "The database engine to use for your custom engine version (CEV). The only supported value is `custom-oracle-ee`.", + "description" : "The database engine to use for your custom engine version (CEV).\n Valid values:\n + ``custom-oracle-ee`` \n + ``custom-oracle-ee-cdb``", "minLength" : 1, "maxLength" : 35 }, "EngineVersion" : { "type" : "string", - "description" : "The name of your CEV. The name format is 19.customized_string . For example, a valid name is 19.my_cev1. This setting is required for RDS Custom for Oracle, but optional for Amazon RDS. The combination of Engine and EngineVersion is unique per customer per Region.", + "description" : "The name of your CEV. The name format is ``major version.customized_string``. For example, a valid CEV name is ``19.my_cev1``. This setting is required for RDS Custom for Oracle, but optional for Amazon RDS. The combination of ``Engine`` and ``EngineVersion`` is unique per customer per Region.\n *Constraints:* Minimum length is 1. Maximum length is 60.\n *Pattern:* ``^[a-z0-9_.-]{1,60$``}", "minLength" : 1, "maxLength" : 60 }, "KMSKeyId" : { "type" : "string", - "description" : "The AWS KMS key identifier for an encrypted CEV. A symmetric KMS key is required for RDS Custom, but optional for Amazon RDS.", + "description" : "The AWS KMS key identifier for an encrypted CEV. A symmetric encryption KMS key is required for RDS Custom, but optional for Amazon RDS.\n If you have an existing symmetric encryption KMS key in your account, you can use it with RDS Custom. No further action is necessary. If you don't already have a symmetric encryption KMS key in your account, follow the instructions in [Creating a symmetric encryption KMS key](https://docs.aws.amazon.com/kms/latest/developerguide/create-keys.html#create-symmetric-cmk) in the *Key Management Service Developer Guide*.\n You can choose the same symmetric encryption key when you create a CEV and a DB instance, or choose different keys.", "minLength" : 1, "maxLength" : 2048 }, "Manifest" : { "type" : "string", - "description" : "The CEV manifest, which is a JSON document that describes the installation .zip files stored in Amazon S3. Specify the name/value pairs in a file or a quoted string. RDS Custom applies the patches in the order in which they are listed.", + "description" : "The CEV manifest, which is a JSON document that describes the installation .zip files stored in Amazon S3. Specify the name/value pairs in a file or a quoted string. RDS Custom applies the patches in the order in which they are listed.\n The following JSON fields are valid:\n + MediaImportTemplateVersion Version of the CEV manifest. The date is in the format YYYY-MM-DD. + databaseInstallationFileNames Ordered list of installation files for the CEV. + opatchFileNames Ordered list of OPatch installers used for the Oracle DB engine. + psuRuPatchFileNames The PSU and RU patches for this CEV. + OtherPatchFileNames The patches that are not in the list of PSU and RU patches. Amazon RDS applies these patches after applying the PSU and RU patches. \n For more information, see [Creating the CEV manifest](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/custom-cev.html#custom-cev.preparing.manifest) in the *Amazon RDS User Guide*.", "minLength" : 1, "maxLength" : 51000 }, "DBEngineVersionArn" : { "type" : "string", - "description" : "The ARN of the custom engine version." + "description" : "" }, "SourceCustomDbEngineVersionIdentifier" : { "type" : "string", - "description" : "The identifier of the source custom engine version." + "description" : "The ARN of a CEV to use as a source for creating a new CEV. You can specify a different Amazon Machine Imagine (AMI) by using either ``Source`` or ``UseAwsProvidedLatestImage``. You can't specify a different JSON manifest when you specify ``SourceCustomDbEngineVersionIdentifier``." }, "UseAwsProvidedLatestImage" : { "type" : "boolean", - "description" : "A value that indicates whether AWS provided latest image is applied automatically to the Custom Engine Version. By default, AWS provided latest image is applied automatically. This value is only applied on create." + "description" : "Specifies whether to use the latest service-provided Amazon Machine Image (AMI) for the CEV. If you specify ``UseAwsProvidedLatestImage``, you can't also specify ``ImageId``." }, "ImageId" : { "type" : "string", - "description" : "The identifier of Amazon Machine Image (AMI) used for CEV." + "description" : "A value that indicates the ID of the AMI." }, "Status" : { "type" : "string", - "description" : "The availability status to be assigned to the CEV.", + "description" : "A value that indicates the status of a custom engine version (CEV).", "default" : "available", "enum" : [ "available", "inactive", "inactive-except-restore" ] }, "Tags" : { - "description" : "An array of key-value pairs to apply to this resource.", + "description" : "A list of tags. For more information, see [Tagging Amazon RDS Resources](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_Tagging.html) in the *Amazon RDS User Guide.*", "type" : "array", "uniqueItems" : false, "insertionOrder" : false, @@ -106,7 +111,7 @@ "propertyTransform" : { "/properties/Engine" : "$lowercase(Engine)", "/properties/EngineVersion" : "$lowercase(EngineVersion)", - "/properties/KMSKeyId" : "$join([\"arn:(aws)[-]{0,1}[a-z]{0,2}[-]{0,1}[a-z]{0,3}:kms:[a-z]{2}[-]{1}[a-z]{3,10}[-]{0,1}[a-z]{0,10}[-]{1}[1-3]{1}:[0-9]{12}[:]{1}key\\/\", KMSKeyId])" + "/properties/KMSKeyId" : "$join([\"arn:.+?:kms:.+?:.+?:key\\/\", KMSKeyId])" }, "required" : [ "Engine", "EngineVersion" ], "writeOnlyProperties" : [ "/properties/Manifest", "/properties/SourceCustomDbEngineVersionIdentifier", "/properties/UseAwsProvidedLatestImage" ], diff --git a/aws-cloudformation-schema/aws-redshiftserverless-workgroup.json b/aws-cloudformation-schema/aws-redshiftserverless-workgroup.json index d96fd145a2..e0827d286e 100644 --- a/aws-cloudformation-schema/aws-redshiftserverless-workgroup.json +++ b/aws-cloudformation-schema/aws-redshiftserverless-workgroup.json @@ -56,6 +56,20 @@ }, "additionalProperties" : false }, + "PerformanceTarget" : { + "type" : "object", + "properties" : { + "Status" : { + "$ref" : "#/definitions/PerformanceTargetStatus" + }, + "Level" : { + "type" : "integer", + "minimum" : 1, + "maximum" : 100 + } + }, + "additionalProperties" : false + }, "VpcEndpoint" : { "type" : "object", "properties" : { @@ -144,6 +158,9 @@ }, "CreationDate" : { "type" : "string" + }, + "PricePerformanceTarget" : { + "$ref" : "#/definitions/PerformanceTarget" } }, "additionalProperties" : false @@ -168,6 +185,10 @@ "WorkgroupStatus" : { "type" : "string", "enum" : [ "CREATING", "AVAILABLE", "MODIFYING", "DELETING" ] + }, + "PerformanceTargetStatus" : { + "type" : "string", + "enum" : [ "ENABLED", "DISABLED" ] } }, "properties" : { @@ -243,6 +264,11 @@ "description" : "The custom port to use when connecting to a workgroup. Valid port ranges are 5431-5455 and 8191-8215. The default is 5439.", "type" : "integer" }, + "PricePerformanceTarget" : { + "description" : "A property that represents the price performance target settings for the workgroup.", + "type" : "object", + "$ref" : "#/definitions/PerformanceTarget" + }, "Tags" : { "description" : "The map of the key-value pairs used to tag the workgroup.", "type" : "array", diff --git a/aws-cloudformation-schema/aws-s3-bucket.json b/aws-cloudformation-schema/aws-s3-bucket.json index d5b6c83cdc..092be00afc 100644 --- a/aws-cloudformation-schema/aws-s3-bucket.json +++ b/aws-cloudformation-schema/aws-s3-bucket.json @@ -68,6 +68,10 @@ "uniqueItems" : true, "insertionOrder" : true }, + "MetadataTableConfiguration" : { + "$ref" : "#/definitions/MetadataTableConfiguration", + "description" : "" + }, "NotificationConfiguration" : { "$ref" : "#/definitions/NotificationConfiguration", "description" : "Configuration that defines how Amazon S3 handles bucket notifications." @@ -1404,6 +1408,65 @@ "Arn" : { "description" : "the Amazon Resource Name (ARN) of the specified bucket.", "type" : "string" + }, + "MetadataTableConfiguration" : { + "type" : "object", + "additionalProperties" : false, + "properties" : { + "S3TablesDestination" : { + "$ref" : "#/definitions/S3TablesDestination" + }, + "Status" : { + "type" : "string", + "description" : "Returns the Status value of the GetBucketMetadataTableConfigurationResult response. This value indicates the status of the metadata table. The status values are:
CREATING - The metadata table is in the process of being created in the specified table bucket.
ACTIVE - The metadata table has been created successfully and records are being delivered to the table.
FAILED - Amazon S3 is unable to create the metadata table, or Amazon S3 is unable to deliver records." + }, + "Error" : { + "$ref" : "#/definitions/MetadataTableError", + "description" : "Returns the Error value of the GetBucketMetadataTableConfiguration response." + } + }, + "required" : [ "S3TablesDestination" ], + "description" : "" + }, + "S3TablesDestination" : { + "type" : "object", + "additionalProperties" : false, + "properties" : { + "TableBucketArn" : { + "type" : "string", + "description" : "The Amazon Resource Name (ARN) for the table bucket that's specified as the destination in the metadata table configuration. The destination table bucket must be in the same Region and AWS account as the general purpose bucket." + }, + "TableName" : { + "type" : "string", + "description" : "The name for the metadata table in your metadata table configuration. The specified metadata table name must be unique within the aws_s3_metadata namespace in the destination table bucket." + }, + "TableNamespace" : { + "type" : "string", + "description" : "The table bucket namespace for the metadata table in your metadata table configuration. This value is always aws_s3_metadata." + }, + "TableArn" : { + "type" : "string", + "description" : "The Amazon Resource Name (ARN) for the metadata table in the metadata table configuration. The specified metadata table name must be unique within the aws_s3_metadata namespace in the destination table bucket." + } + }, + "required" : [ "TableBucketArn", "TableName" ], + "description" : "" + }, + "MetadataTableError" : { + "type" : "object", + "additionalProperties" : false, + "properties" : { + "ErrorCode" : { + "type" : "string", + "description" : "If the CreateBucketMetadataTableConfiguration request succeeds, but S3 Metadata was unable to create the table, this structure contains the error code. The possible error codes and error messages are as follows:
AccessDeniedCreatingResources - You don't have sufficient permissions to create the required resources. Make sure that you have s3tables:CreateNamespace, s3tables:CreateTable, s3tables:GetTable and s3tables:PutTablePolicy permissions, and then try again. To create a new metadata table, you must delete the metadata configuration for this bucket, and then create a new metadata configuration.
AccessDeniedWritingToTable - Unable to write to the metadata table because of missing resource permissions. To fix the resource policy, Amazon S3 needs to create a new metadata table. To create a new metadata table, you must delete the metadata configuration for this bucket, and then create a new metadata configuration.
DestinationTableNotFound - The destination table doesn't exist. To create a new metadata table, you must delete the metadata configuration for this bucket, and then create a new metadata configuration.
ServerInternalError - An internal error has occurred. To create a new metadata table, you must delete the metadata configuration for this bucket, and then create a new metadata configuration.
TableAlreadyExists - The table that you specified already exists in the table bucket's namespace. Specify a different table name. To create a new metadata table, you must delete the metadata configuration for this bucket, and then create a new metadata configuration.
TableBucketNotFound - The table bucket that you specified doesn't exist in this AWS Region and account. Create or choose a different table bucket. To create a new metadata table, you must delete the metadata configuration for this bucket, and then create a new metadata configuration." + }, + "ErrorMessage" : { + "type" : "string", + "description" : "If the CreateBucketMetadataTableConfiguration request succeeds, but S3 Metadata was unable to create the table, this structure contains the error code. The possible error codes and error messages are as follows:
AccessDeniedCreatingResources - You don't have sufficient permissions to create the required resources. Make sure that you have s3tables:CreateNamespace, s3tables:CreateTable, s3tables:GetTable and s3tables:PutTablePolicy permissions, and then try again. To create a new metadata table, you must delete the metadata configuration for this bucket, and then create a new metadata configuration.
AccessDeniedWritingToTable - Unable to write to the metadata table because of missing resource permissions. To fix the resource policy, Amazon S3 needs to create a new metadata table. To create a new metadata table, you must delete the metadata configuration for this bucket, and then create a new metadata configuration.
DestinationTableNotFound - The destination table doesn't exist. To create a new metadata table, you must delete the metadata configuration for this bucket, and then create a new metadata configuration.
ServerInternalError - An internal error has occurred. To create a new metadata table, you must delete the metadata configuration for this bucket, and then create a new metadata configuration.
TableAlreadyExists - The table that you specified already exists in the table bucket's namespace. Specify a different table name. To create a new metadata table, you must delete the metadata configuration for this bucket, and then create a new metadata configuration.
TableBucketNotFound - The table bucket that you specified doesn't exist in this AWS Region and account. Create or choose a different table bucket. To create a new metadata table, you must delete the metadata configuration for this bucket, and then create a new metadata configuration." + } + }, + "required" : [ "ErrorCode", "ErrorMessage" ], + "description" : "" } }, "tagging" : { @@ -1424,10 +1487,10 @@ }, "handlers" : { "create" : { - "permissions" : [ "s3:CreateBucket", "s3:PutBucketTagging", "s3:PutAnalyticsConfiguration", "s3:PutEncryptionConfiguration", "s3:PutBucketCORS", "s3:PutInventoryConfiguration", "s3:PutLifecycleConfiguration", "s3:PutMetricsConfiguration", "s3:PutBucketNotification", "s3:PutBucketReplication", "s3:PutBucketWebsite", "s3:PutAccelerateConfiguration", "s3:PutBucketPublicAccessBlock", "s3:PutReplicationConfiguration", "s3:PutObjectAcl", "s3:PutBucketObjectLockConfiguration", "s3:GetBucketAcl", "s3:ListBucket", "iam:PassRole", "s3:DeleteObject", "s3:PutBucketLogging", "s3:PutBucketVersioning", "s3:PutObjectLockConfiguration", "s3:PutBucketOwnershipControls", "s3:PutIntelligentTieringConfiguration" ] + "permissions" : [ "s3:CreateBucket", "s3:PutBucketTagging", "s3:PutAnalyticsConfiguration", "s3:PutEncryptionConfiguration", "s3:PutBucketCORS", "s3:PutInventoryConfiguration", "s3:PutLifecycleConfiguration", "s3:PutMetricsConfiguration", "s3:PutBucketNotification", "s3:PutBucketReplication", "s3:PutBucketWebsite", "s3:PutAccelerateConfiguration", "s3:PutBucketPublicAccessBlock", "s3:PutReplicationConfiguration", "s3:PutObjectAcl", "s3:PutBucketObjectLockConfiguration", "s3:GetBucketAcl", "s3:ListBucket", "iam:PassRole", "s3:DeleteObject", "s3:PutBucketLogging", "s3:PutBucketVersioning", "s3:PutObjectLockConfiguration", "s3:PutBucketOwnershipControls", "s3:PutIntelligentTieringConfiguration", "s3:CreateBucketMetadataTableConfiguration" ] }, "read" : { - "permissions" : [ "s3:GetAccelerateConfiguration", "s3:GetLifecycleConfiguration", "s3:GetBucketPublicAccessBlock", "s3:GetAnalyticsConfiguration", "s3:GetBucketCORS", "s3:GetEncryptionConfiguration", "s3:GetInventoryConfiguration", "s3:GetBucketLogging", "s3:GetMetricsConfiguration", "s3:GetBucketNotification", "s3:GetBucketVersioning", "s3:GetReplicationConfiguration", "S3:GetBucketWebsite", "s3:GetBucketPublicAccessBlock", "s3:GetBucketObjectLockConfiguration", "s3:GetBucketTagging", "s3:GetBucketOwnershipControls", "s3:GetIntelligentTieringConfiguration", "s3:ListBucket" ] + "permissions" : [ "s3:GetAccelerateConfiguration", "s3:GetLifecycleConfiguration", "s3:GetBucketPublicAccessBlock", "s3:GetAnalyticsConfiguration", "s3:GetBucketCORS", "s3:GetEncryptionConfiguration", "s3:GetInventoryConfiguration", "s3:GetBucketLogging", "s3:GetMetricsConfiguration", "s3:GetBucketNotification", "s3:GetBucketVersioning", "s3:GetReplicationConfiguration", "S3:GetBucketWebsite", "s3:GetBucketPublicAccessBlock", "s3:GetBucketObjectLockConfiguration", "s3:GetBucketTagging", "s3:GetBucketOwnershipControls", "s3:GetIntelligentTieringConfiguration", "s3:GetBucketMetadataTableConfiguration", "s3:ListBucket" ] }, "update" : { "permissions" : [ "s3:PutBucketAcl", "s3:PutBucketTagging", "s3:PutAnalyticsConfiguration", "s3:PutEncryptionConfiguration", "s3:PutBucketCORS", "s3:PutInventoryConfiguration", "s3:PutLifecycleConfiguration", "s3:PutMetricsConfiguration", "s3:PutBucketNotification", "s3:PutBucketReplication", "s3:PutBucketWebsite", "s3:PutAccelerateConfiguration", "s3:PutBucketPublicAccessBlock", "s3:PutReplicationConfiguration", "s3:PutBucketOwnershipControls", "s3:PutIntelligentTieringConfiguration", "s3:DeleteBucketWebsite", "s3:PutBucketLogging", "s3:PutBucketVersioning", "s3:PutObjectLockConfiguration", "s3:PutBucketObjectLockConfiguration", "s3:DeleteBucketAnalyticsConfiguration", "s3:DeleteBucketCors", "s3:DeleteBucketMetricsConfiguration", "s3:DeleteBucketEncryption", "s3:DeleteBucketLifecycle", "s3:DeleteBucketReplication", "iam:PassRole", "s3:ListBucket" ] diff --git a/aws-cloudformation-schema/aws-s3express-directorybucket.json b/aws-cloudformation-schema/aws-s3express-directorybucket.json index 9898ad586d..a3e633b46a 100644 --- a/aws-cloudformation-schema/aws-s3express-directorybucket.json +++ b/aws-cloudformation-schema/aws-s3express-directorybucket.json @@ -4,24 +4,24 @@ "additionalProperties" : false, "properties" : { "BucketName" : { - "description" : "Specifies a name for the bucket. The bucket name must contain only lowercase letters, numbers, and hyphens (-). A directory bucket name must be unique in the chosen Availability Zone. The bucket name must also follow the format 'bucket_base_name--az_id--x-s3' (for example, 'DOC-EXAMPLE-BUCKET--usw2-az1--x-s3'). If you don't specify a name, AWS CloudFormation generates a unique physical ID and uses that ID for the bucket name.", + "description" : "Specifies a name for the bucket. The bucket name must contain only lowercase letters, numbers, and hyphens (-). A directory bucket name must be unique in the chosen Availability Zone or Local Zone. The bucket name must also follow the format 'bucket_base_name--zone_id--x-s3'. The zone_id can be the ID of an Availability Zone or a Local Zone. If you don't specify a name, AWS CloudFormation generates a unique physical ID and uses that ID for the bucket name.", "maxLength" : 63, "pattern" : "^[a-z0-9][a-z0-9//.//-]*[a-z0-9]$", "type" : "string" }, "LocationName" : { - "description" : "Specifies the AZ ID of the Availability Zone where the directory bucket will be created. An example AZ ID value is 'use1-az5'.", + "description" : "Specifies the Zone ID of the Availability Zone or Local Zone where the directory bucket will be created. An example Availability Zone ID value is 'use1-az5'.", "type" : "string" }, "AvailabilityZoneName" : { - "description" : "Returns the code for the Availability Zone where the directory bucket was created.", + "description" : "Returns the code for the Availability Zone or Local Zone where the directory bucket was created. An example for the code of an Availability Zone is 'us-east-1f'.", "examples" : [ "us-east-1f" ], "type" : "string" }, "DataRedundancy" : { - "description" : "Specifies the number of Availability Zone that's used for redundancy for the bucket.", + "description" : "Specifies the number of Availability Zone or Local Zone that's used for redundancy for the bucket.", "type" : "string", - "enum" : [ "SingleAvailabilityZone" ] + "enum" : [ "SingleAvailabilityZone", "SingleLocalZone" ] }, "Arn" : { "$ref" : "#/definitions/Arn", diff --git a/aws-cloudformation-schema/aws-s3tables-tablebucket.json b/aws-cloudformation-schema/aws-s3tables-tablebucket.json new file mode 100644 index 0000000000..91d5d8912b --- /dev/null +++ b/aws-cloudformation-schema/aws-s3tables-tablebucket.json @@ -0,0 +1,78 @@ +{ + "typeName" : "AWS::S3Tables::TableBucket", + "description" : "Creates an Amazon S3 Tables table bucket in the same AWS Region where you create the AWS CloudFormation stack.", + "properties" : { + "TableBucketARN" : { + "$ref" : "#/definitions/TableBucketARN" + }, + "TableBucketName" : { + "$ref" : "#/definitions/TableBucketName" + }, + "UnreferencedFileRemoval" : { + "$ref" : "#/definitions/UnreferencedFileRemoval" + } + }, + "definitions" : { + "TableBucketARN" : { + "description" : "The Amazon Resource Name (ARN) of the specified table bucket.", + "type" : "string", + "examples" : [ "arn:aws:s3tables:us-west-2:123456789012:bucket/mytablebucket" ] + }, + "TableBucketName" : { + "description" : "A name for the table bucket.", + "type" : "string", + "minLength" : 3, + "maxLength" : 63 + }, + "UnreferencedFileRemoval" : { + "description" : "Settings governing the Unreferenced File Removal maintenance action. Unreferenced file removal identifies and deletes all objects that are not referenced by any table snapshots.", + "additionalProperties" : false, + "type" : "object", + "properties" : { + "Status" : { + "description" : "Indicates whether the Unreferenced File Removal maintenance action is enabled.", + "type" : "string", + "enum" : [ "Enabled", "Disabled" ] + }, + "UnreferencedDays" : { + "description" : "For any object not referenced by your table and older than the UnreferencedDays property, S3 creates a delete marker and marks the object version as noncurrent.", + "type" : "integer", + "minimum" : 1 + }, + "NoncurrentDays" : { + "description" : "S3 permanently deletes noncurrent objects after the number of days specified by the NoncurrentDays property.", + "type" : "integer", + "minimum" : 1 + } + } + } + }, + "additionalProperties" : false, + "required" : [ "TableBucketName" ], + "createOnlyProperties" : [ "/properties/TableBucketName" ], + "readOnlyProperties" : [ "/properties/TableBucketARN" ], + "primaryIdentifier" : [ "/properties/TableBucketARN" ], + "tagging" : { + "taggable" : false, + "tagOnCreate" : false, + "tagUpdatable" : false, + "cloudFormationSystemTags" : false + }, + "handlers" : { + "create" : { + "permissions" : [ "s3tables:CreateTableBucket", "s3tables:PutTableBucketMaintenanceConfiguration", "s3tables:GetTableBucket", "s3tables:GetTableBucketMaintenanceConfiguration" ] + }, + "read" : { + "permissions" : [ "s3tables:GetTableBucket", "s3tables:GetTableBucketMaintenanceConfiguration" ] + }, + "update" : { + "permissions" : [ "s3tables:PutTableBucketMaintenanceConfiguration", "s3tables:GetTableBucket", "s3tables:GetTableBucketMaintenanceConfiguration" ] + }, + "delete" : { + "permissions" : [ "s3tables:DeleteTableBucket" ] + }, + "list" : { + "permissions" : [ "s3tables:ListTableBuckets" ] + } + } +} \ No newline at end of file diff --git a/aws-cloudformation-schema/aws-s3tables-tablebucketpolicy.json b/aws-cloudformation-schema/aws-s3tables-tablebucketpolicy.json new file mode 100644 index 0000000000..426e203517 --- /dev/null +++ b/aws-cloudformation-schema/aws-s3tables-tablebucketpolicy.json @@ -0,0 +1,50 @@ +{ + "typeName" : "AWS::S3Tables::TableBucketPolicy", + "description" : "Applies an IAM resource policy to a table bucket.", + "properties" : { + "ResourcePolicy" : { + "$ref" : "#/definitions/ResourcePolicy" + }, + "TableBucketARN" : { + "$ref" : "#/definitions/TableBucketARN" + } + }, + "definitions" : { + "ResourcePolicy" : { + "description" : "A policy document containing permissions to add to the specified table bucket. In IAM, you must provide policy documents in JSON format. However, in CloudFormation you can provide the policy in JSON or YAML format because CloudFormation converts YAML to JSON before submitting it to IAM.", + "type" : [ "object", "string" ] + }, + "TableBucketARN" : { + "description" : "The Amazon Resource Name (ARN) of the table bucket to which the policy applies.", + "type" : "string", + "examples" : [ "arn:aws:s3tables:us-west-2:123456789012:bucket/mytablebucket" ] + } + }, + "additionalProperties" : false, + "required" : [ "ResourcePolicy", "TableBucketARN" ], + "createOnlyProperties" : [ "/properties/TableBucketARN" ], + "primaryIdentifier" : [ "/properties/TableBucketARN" ], + "tagging" : { + "taggable" : false, + "tagOnCreate" : false, + "tagUpdatable" : false, + "cloudFormationSystemTags" : false + }, + "handlers" : { + "create" : { + "permissions" : [ "s3tables:GetTableBucket", "s3tables:GetTableBucketPolicy", "s3tables:PutTableBucketPolicy" ] + }, + "read" : { + "permissions" : [ "s3tables:GetTableBucketPolicy" ] + }, + "update" : { + "permissions" : [ "s3tables:GetTableBucketPolicy", "s3tables:PutTableBucketPolicy" ] + }, + "delete" : { + "permissions" : [ "s3tables:GetTableBucketPolicy", "s3tables:DeleteTableBucketPolicy" ] + }, + "list" : { + "permissions" : [ "s3tables:GetTableBucketPolicy", "s3tables:ListTableBuckets" ] + } + } +} \ No newline at end of file diff --git a/meta/.botocore.version b/meta/.botocore.version index a06af74a7a..804a975ceb 100644 --- a/meta/.botocore.version +++ b/meta/.botocore.version @@ -1 +1 @@ -1.35.76 +1.35.78 diff --git a/provider/cmd/pulumi-gen-aws-native/supported-types.txt b/provider/cmd/pulumi-gen-aws-native/supported-types.txt index 742c2ccefe..2c0adbcc64 100644 --- a/provider/cmd/pulumi-gen-aws-native/supported-types.txt +++ b/provider/cmd/pulumi-gen-aws-native/supported-types.txt @@ -575,6 +575,7 @@ AWS::IoT::BillingGroup AWS::IoT::CACertificate AWS::IoT::Certificate AWS::IoT::CertificateProvider +AWS::IoT::Command AWS::IoT::CustomMetric AWS::IoT::Dimension AWS::IoT::DomainConfiguration @@ -842,6 +843,7 @@ AWS::QuickSight::Theme AWS::QuickSight::Topic AWS::QuickSight::VPCConnection AWS::RAM::Permission +AWS::RAM::ResourceShare AWS::RDS::CustomDBEngineVersion AWS::RDS::DBCluster AWS::RDS::DBClusterParameterGroup @@ -935,6 +937,8 @@ AWS::S3Outposts::AccessPoint AWS::S3Outposts::Bucket AWS::S3Outposts::BucketPolicy AWS::S3Outposts::Endpoint +AWS::S3Tables::TableBucket +AWS::S3Tables::TableBucketPolicy AWS::SES::ConfigurationSet AWS::SES::ConfigurationSetEventDestination AWS::SES::ContactList diff --git a/provider/cmd/pulumi-resource-aws-native/metadata.json b/provider/cmd/pulumi-resource-aws-native/metadata.json index f67966683e..405c050368 100644 --- a/provider/cmd/pulumi-resource-aws-native/metadata.json +++ b/provider/cmd/pulumi-resource-aws-native/metadata.json @@ -2262,10 +2262,6 @@ "$ref": "#/types/aws-native:apigateway:DomainNameV2EndpointConfiguration", "description": "The endpoint configuration to indicate the types of endpoints an API (RestApi) or its custom domain name (DomainName) has." }, - "managementPolicy": { - "$ref": "pulumi.json#/Any", - "description": "Search the [CloudFormation User Guide](https://docs.aws.amazon.com/cloudformation/) for `AWS::ApiGateway::DomainNameV2` for more information about the expected schema for this property." - }, "policy": { "$ref": "pulumi.json#/Any", "description": "A stringified JSON policy document that applies to the `execute-api` service for this DomainName regardless of the caller and Method configuration. You can use `Fn::ToJsonString` to enter your `policy` . For more information, see [Fn::ToJsonString](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/intrinsic-function-reference-ToJsonString.html) .\n\nSearch the [CloudFormation User Guide](https://docs.aws.amazon.com/cloudformation/) for `AWS::ApiGateway::DomainNameV2` for more information about the expected schema for this property." @@ -2305,10 +2301,6 @@ "description": "The endpoint configuration to indicate the types of endpoints an API (RestApi) or its custom domain name (DomainName) has.", "replaceOnChanges": true }, - "managementPolicy": { - "$ref": "pulumi.json#/Any", - "description": "Search the [CloudFormation User Guide](https://docs.aws.amazon.com/cloudformation/) for `AWS::ApiGateway::DomainNameV2` for more information about the expected schema for this property." - }, "policy": { "$ref": "pulumi.json#/Any", "description": "A stringified JSON policy document that applies to the `execute-api` service for this DomainName regardless of the caller and Method configuration. You can use `Fn::ToJsonString` to enter your `policy` . For more information, see [Fn::ToJsonString](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/intrinsic-function-reference-ToJsonString.html) .\n\nSearch the [CloudFormation User Guide](https://docs.aws.amazon.com/cloudformation/) for `AWS::ApiGateway::DomainNameV2` for more information about the expected schema for this property." @@ -20085,10 +20077,12 @@ "description": "An array of image files that you want to apply to roles like backgrounds, logos, and icons. Each object must also indicate whether it is for dark mode, light mode, or browser-adaptive mode." }, "clientId": { - "type": "string" + "type": "string", + "description": "The app client that's assigned to the branding style that you want more information about." }, "returnMergedResources": { - "type": "boolean" + "type": "boolean", + "description": "When `true` , returns values for branding options that are unchanged from Amazon Cognito defaults. When `false` or when you omit this parameter, returns only values that you customized in your branding style." }, "settings": { "$ref": "pulumi.json#/Any", @@ -20096,7 +20090,7 @@ }, "useCognitoProvidedValues": { "type": "boolean", - "description": "When true, applies the default branding style options. This option reverts to a \"blank\" style that you can modify later in the branding designer." + "description": "When true, applies the default branding style options. This option reverts to default style options that are managed by Amazon Cognito. You can modify them later in the branding designer.\n\nWhen you specify `true` for this option, you must also omit values for `Settings` and `Assets` in the request." }, "userPoolId": { "type": "string", @@ -20113,6 +20107,7 @@ }, "clientId": { "type": "string", + "description": "The app client that's assigned to the branding style that you want more information about.", "replaceOnChanges": true }, "managedLoginBrandingId": { @@ -20120,7 +20115,8 @@ "description": "The ID of the managed login branding style." }, "returnMergedResources": { - "type": "boolean" + "type": "boolean", + "description": "When `true` , returns values for branding options that are unchanged from Amazon Cognito defaults. When `false` or when you omit this parameter, returns only values that you customized in your branding style." }, "settings": { "$ref": "pulumi.json#/Any", @@ -20128,7 +20124,7 @@ }, "useCognitoProvidedValues": { "type": "boolean", - "description": "When true, applies the default branding style options. This option reverts to a \"blank\" style that you can modify later in the branding designer." + "description": "When true, applies the default branding style options. This option reverts to default style options that are managed by Amazon Cognito. You can modify them later in the branding designer.\n\nWhen you specify `true` for this option, you must also omit values for `Settings` and `Assets` in the request." }, "userPoolId": { "type": "string", @@ -20168,14 +20164,14 @@ "items": { "type": "string" }, - "description": "Attributes supported as an alias for this user pool. Possible values: *phone_number* , *email* , or *preferred_username* ." + "description": "Attributes supported as an alias for this user pool. Possible values: *phone_number* , *email* , or *preferred_username* . For more information about alias attributes, see [Customizing sign-in attributes](https://docs.aws.amazon.com/cognito/latest/developerguide/user-pool-settings-attributes.html#user-pool-settings-aliases) ." }, "autoVerifiedAttributes": { "type": "array", "items": { "type": "string" }, - "description": "The attributes to be auto-verified. Possible values: *email* , *phone_number* ." + "description": "The attributes that you want your user pool to automatically verify. Possible values: *email* , *phone_number* . For more information see [Verifying contact information at sign-up](https://docs.aws.amazon.com/cognito/latest/developerguide/signing-up-users-in-your-app.html#allowing-users-to-sign-up-and-confirm-themselves) ." }, "deletionProtection": { "type": "string", @@ -20183,7 +20179,7 @@ }, "deviceConfiguration": { "$ref": "#/types/aws-native:cognito:UserPoolDeviceConfiguration", - "description": "The device-remembering configuration for a user pool. A null value indicates that you have deactivated device remembering in your user pool.\n\n\u003e When you provide a value for any `DeviceConfiguration` field, you activate the Amazon Cognito device-remembering feature." + "description": "The device-remembering configuration for a user pool. Device remembering or device tracking is a \"Remember me on this device\" option for user pools that perform authentication with the device key of a trusted device in the back end, instead of a user-provided MFA code. For more information about device authentication, see [Working with user devices in your user pool](https://docs.aws.amazon.com/cognito/latest/developerguide/amazon-cognito-user-pools-device-tracking.html) . A null value indicates that you have deactivated device remembering in your user pool.\n\n\u003e When you provide a value for any `DeviceConfiguration` field, you activate the Amazon Cognito device-remembering feature. For more infor" }, "emailAuthenticationMessage": { "type": "string" @@ -20227,7 +20223,7 @@ "items": { "$ref": "#/types/aws-native:cognito:UserPoolSchemaAttribute" }, - "description": "An array of schema attributes for the new user pool. These attributes can be standard or custom attributes." + "description": "An array of attributes for the new user pool. You can add custom attributes and modify the properties of default attributes. The specifications in this parameter set the required attributes in your user pool. For more information, see [Working with user attributes](https://docs.aws.amazon.com/cognito/latest/developerguide/user-pool-settings-attributes.html) ." }, "smsAuthenticationMessage": { "type": "string", @@ -20235,7 +20231,7 @@ }, "smsConfiguration": { "$ref": "#/types/aws-native:cognito:UserPoolSmsConfiguration", - "description": "The SMS configuration with the settings that your Amazon Cognito user pool must use to send an SMS message from your AWS account through Amazon Simple Notification Service. To send SMS messages with Amazon SNS in the AWS Region that you want, the Amazon Cognito user pool uses an AWS Identity and Access Management (IAM) role in your AWS account ." + "description": "The SMS configuration with the settings that your Amazon Cognito user pool must use to send an SMS message from your AWS account through Amazon Simple Notification Service. To send SMS messages with Amazon SNS in the AWS Region that you want, the Amazon Cognito user pool uses an AWS Identity and Access Management (IAM) role in your AWS account . For more information see [SMS message settings](https://docs.aws.amazon.com/cognito/latest/developerguide/user-pool-sms-settings.html) ." }, "smsVerificationMessage": { "type": "string", @@ -20251,7 +20247,7 @@ }, "userPoolName": { "type": "string", - "description": "A string used to name the user pool." + "description": "A friendlhy name for your user pool." }, "userPoolTags": { "type": "object", @@ -20273,17 +20269,19 @@ }, "usernameConfiguration": { "$ref": "#/types/aws-native:cognito:UserPoolUsernameConfiguration", - "description": "Case sensitivity on the username input for the selected sign-in option. When case sensitivity is set to `False` (case insensitive), users can sign in with any combination of capital and lowercase letters. For example, `username` , `USERNAME` , or `UserName` , or for email, `email@example.com` or `EMaiL@eXamplE.Com` . For most use cases, set case sensitivity to `False` (case insensitive) as a best practice. When usernames and email addresses are case insensitive, Amazon Cognito treats any variation in case as the same user, and prevents a case variation from being assigned to the same attribute for a different user.\n\nThis configuration is immutable after you set it. For more information, see [UsernameConfigurationType](https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_UsernameConfigurationType.html) ." + "description": "Sets the case sensitivity option for sign-in usernames. When `CaseSensitive` is `false` (case insensitive), users can sign in with any combination of capital and lowercase letters. For example, `username` , `USERNAME` , or `UserName` , or for email, `email@example.com` or `EMaiL@eXamplE.Com` . For most use cases, set case sensitivity to `false` as a best practice. When usernames and email addresses are case insensitive, Amazon Cognito treats any variation in case as the same user, and prevents a case variation from being assigned to the same attribute for a different user.\n\nWhen `CaseSensitive` is `true` (case sensitive), Amazon Cognito interprets `USERNAME` and `UserName` as distinct users.\n\nThis configuration is immutable after you set it." }, "verificationMessageTemplate": { "$ref": "#/types/aws-native:cognito:UserPoolVerificationMessageTemplate", "description": "The template for the verification message that your user pool delivers to users who set an email address or phone number attribute.\n\nSet the email message type that corresponds to your `DefaultEmailOption` selection. For `CONFIRM_WITH_LINK` , specify an `EmailMessageByLink` and leave `EmailMessage` blank. For `CONFIRM_WITH_CODE` , specify an `EmailMessage` and leave `EmailMessageByLink` blank. When you supply both parameters with either choice, Amazon Cognito returns an error." }, "webAuthnRelyingPartyId": { - "type": "string" + "type": "string", + "description": "Sets or displays the authentication domain, typically your user pool domain, that passkey providers must use as a relying party (RP) in their configuration.\n\nUnder the following conditions, the passkey relying party ID must be the fully-qualified domain name of your custom domain:\n\n- The user pool is configured for passkey authentication.\n- The user pool has a custom domain, whether or not it also has a prefix domain.\n- Your application performs authentication with managed login or the classic hosted UI." }, "webAuthnUserVerification": { - "type": "string" + "type": "string", + "description": "When `required` , users can only register and sign in users with passkeys that are capable of [user verification](https://docs.aws.amazon.com/https://www.w3.org/TR/webauthn-2/#enum-userVerificationRequirement) . When `preferred` , your user pool doesn't require the use of authenticators with user verification but encourages it." } }, "outputs": { @@ -20300,7 +20298,7 @@ "items": { "type": "string" }, - "description": "Attributes supported as an alias for this user pool. Possible values: *phone_number* , *email* , or *preferred_username* ." + "description": "Attributes supported as an alias for this user pool. Possible values: *phone_number* , *email* , or *preferred_username* . For more information about alias attributes, see [Customizing sign-in attributes](https://docs.aws.amazon.com/cognito/latest/developerguide/user-pool-settings-attributes.html#user-pool-settings-aliases) ." }, "arn": { "type": "string", @@ -20311,7 +20309,7 @@ "items": { "type": "string" }, - "description": "The attributes to be auto-verified. Possible values: *email* , *phone_number* ." + "description": "The attributes that you want your user pool to automatically verify. Possible values: *email* , *phone_number* . For more information see [Verifying contact information at sign-up](https://docs.aws.amazon.com/cognito/latest/developerguide/signing-up-users-in-your-app.html#allowing-users-to-sign-up-and-confirm-themselves) ." }, "deletionProtection": { "type": "string", @@ -20319,7 +20317,7 @@ }, "deviceConfiguration": { "$ref": "#/types/aws-native:cognito:UserPoolDeviceConfiguration", - "description": "The device-remembering configuration for a user pool. A null value indicates that you have deactivated device remembering in your user pool.\n\n\u003e When you provide a value for any `DeviceConfiguration` field, you activate the Amazon Cognito device-remembering feature." + "description": "The device-remembering configuration for a user pool. Device remembering or device tracking is a \"Remember me on this device\" option for user pools that perform authentication with the device key of a trusted device in the back end, instead of a user-provided MFA code. For more information about device authentication, see [Working with user devices in your user pool](https://docs.aws.amazon.com/cognito/latest/developerguide/amazon-cognito-user-pools-device-tracking.html) . A null value indicates that you have deactivated device remembering in your user pool.\n\n\u003e When you provide a value for any `DeviceConfiguration` field, you activate the Amazon Cognito device-remembering feature. For more infor" }, "emailAuthenticationMessage": { "type": "string" @@ -20371,7 +20369,7 @@ "items": { "$ref": "#/types/aws-native:cognito:UserPoolSchemaAttribute" }, - "description": "An array of schema attributes for the new user pool. These attributes can be standard or custom attributes." + "description": "An array of attributes for the new user pool. You can add custom attributes and modify the properties of default attributes. The specifications in this parameter set the required attributes in your user pool. For more information, see [Working with user attributes](https://docs.aws.amazon.com/cognito/latest/developerguide/user-pool-settings-attributes.html) ." }, "smsAuthenticationMessage": { "type": "string", @@ -20379,7 +20377,7 @@ }, "smsConfiguration": { "$ref": "#/types/aws-native:cognito:UserPoolSmsConfiguration", - "description": "The SMS configuration with the settings that your Amazon Cognito user pool must use to send an SMS message from your AWS account through Amazon Simple Notification Service. To send SMS messages with Amazon SNS in the AWS Region that you want, the Amazon Cognito user pool uses an AWS Identity and Access Management (IAM) role in your AWS account ." + "description": "The SMS configuration with the settings that your Amazon Cognito user pool must use to send an SMS message from your AWS account through Amazon Simple Notification Service. To send SMS messages with Amazon SNS in the AWS Region that you want, the Amazon Cognito user pool uses an AWS Identity and Access Management (IAM) role in your AWS account . For more information see [SMS message settings](https://docs.aws.amazon.com/cognito/latest/developerguide/user-pool-sms-settings.html) ." }, "smsVerificationMessage": { "type": "string", @@ -20399,7 +20397,7 @@ }, "userPoolName": { "type": "string", - "description": "A string used to name the user pool." + "description": "A friendlhy name for your user pool." }, "userPoolTags": { "type": "object", @@ -20421,17 +20419,19 @@ }, "usernameConfiguration": { "$ref": "#/types/aws-native:cognito:UserPoolUsernameConfiguration", - "description": "Case sensitivity on the username input for the selected sign-in option. When case sensitivity is set to `False` (case insensitive), users can sign in with any combination of capital and lowercase letters. For example, `username` , `USERNAME` , or `UserName` , or for email, `email@example.com` or `EMaiL@eXamplE.Com` . For most use cases, set case sensitivity to `False` (case insensitive) as a best practice. When usernames and email addresses are case insensitive, Amazon Cognito treats any variation in case as the same user, and prevents a case variation from being assigned to the same attribute for a different user.\n\nThis configuration is immutable after you set it. For more information, see [UsernameConfigurationType](https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_UsernameConfigurationType.html) ." + "description": "Sets the case sensitivity option for sign-in usernames. When `CaseSensitive` is `false` (case insensitive), users can sign in with any combination of capital and lowercase letters. For example, `username` , `USERNAME` , or `UserName` , or for email, `email@example.com` or `EMaiL@eXamplE.Com` . For most use cases, set case sensitivity to `false` as a best practice. When usernames and email addresses are case insensitive, Amazon Cognito treats any variation in case as the same user, and prevents a case variation from being assigned to the same attribute for a different user.\n\nWhen `CaseSensitive` is `true` (case sensitive), Amazon Cognito interprets `USERNAME` and `UserName` as distinct users.\n\nThis configuration is immutable after you set it." }, "verificationMessageTemplate": { "$ref": "#/types/aws-native:cognito:UserPoolVerificationMessageTemplate", "description": "The template for the verification message that your user pool delivers to users who set an email address or phone number attribute.\n\nSet the email message type that corresponds to your `DefaultEmailOption` selection. For `CONFIRM_WITH_LINK` , specify an `EmailMessageByLink` and leave `EmailMessage` blank. For `CONFIRM_WITH_CODE` , specify an `EmailMessage` and leave `EmailMessageByLink` blank. When you supply both parameters with either choice, Amazon Cognito returns an error." }, "webAuthnRelyingPartyId": { - "type": "string" + "type": "string", + "description": "Sets or displays the authentication domain, typically your user pool domain, that passkey providers must use as a relying party (RP) in their configuration.\n\nUnder the following conditions, the passkey relying party ID must be the fully-qualified domain name of your custom domain:\n\n- The user pool is configured for passkey authentication.\n- The user pool has a custom domain, whether or not it also has a prefix domain.\n- Your application performs authentication with managed login or the classic hosted UI." }, "webAuthnUserVerification": { - "type": "string" + "type": "string", + "description": "When `required` , users can only register and sign in users with passkeys that are capable of [user verification](https://docs.aws.amazon.com/https://www.w3.org/TR/webauthn-2/#enum-userVerificationRequirement) . When `preferred` , your user pool doesn't require the use of authenticators with user verification but encourages it." } }, "autoNamingSpec": { @@ -20478,11 +20478,11 @@ "items": { "type": "string" }, - "description": "The allowed OAuth scopes. Possible values provided by OAuth are `phone` , `email` , `openid` , and `profile` . Possible values provided by AWS are `aws.cognito.signin.user.admin` . Custom scopes created in Resource Servers are also supported." + "description": "The OAuth 2.0 scopes that you want to permit your app client to authorize. Scopes govern access control to user pool self-service API operations, user data from the `userInfo` endpoint, and third-party APIs. Possible values provided by OAuth are `phone` , `email` , `openid` , and `profile` . Possible values provided by AWS are `aws.cognito.signin.user.admin` . Custom scopes created in Resource Servers are also supported." }, "analyticsConfiguration": { "$ref": "#/types/aws-native:cognito:UserPoolClientAnalyticsConfiguration", - "description": "The user pool analytics configuration for collecting metrics and sending them to your Amazon Pinpoint campaign.\n\n\u003e In AWS Regions where Amazon Pinpoint isn't available, user pools only support sending events to Amazon Pinpoint projects in AWS Region us-east-1. In Regions where Amazon Pinpoint is available, user pools support sending events to Amazon Pinpoint projects within that same Region." + "description": "The user pool analytics configuration for collecting metrics and sending them to your Amazon Pinpoint campaign.\n\nIn AWS Regions where Amazon Pinpoint isn't available, user pools might not have access to analytics or might be configurable with campaigns in the US East (N. Virginia) Region. For more information, see [Using Amazon Pinpoint analytics](https://docs.aws.amazon.com/cognito/latest/developerguide/cognito-user-pools-pinpoint-integration.html) ." }, "authSessionValidity": { "type": "integer", @@ -20493,15 +20493,15 @@ "items": { "type": "string" }, - "description": "A list of allowed redirect (callback) URLs for the IdPs.\n\nA redirect URI must:\n\n- Be an absolute URI.\n- Be registered with the authorization server.\n- Not include a fragment component.\n\nSee [OAuth 2.0 - Redirection Endpoint](https://docs.aws.amazon.com/https://tools.ietf.org/html/rfc6749#section-3.1.2) .\n\nAmazon Cognito requires HTTPS over HTTP except for http://localhost for testing purposes only.\n\nApp callback URLs such as myapp://example are also supported." + "description": "A list of allowed redirect (callback) URLs for the IdPs.\n\nA redirect URI must:\n\n- Be an absolute URI.\n- Be registered with the authorization server. Amazon Cognito doesn't accept authorization requests with `redirect_uri` values that aren't in the list of `CallbackURLs` that you provide in this parameter.\n- Not include a fragment component.\n\nSee [OAuth 2.0 - Redirection Endpoint](https://docs.aws.amazon.com/https://tools.ietf.org/html/rfc6749#section-3.1.2) .\n\nAmazon Cognito requires HTTPS over HTTP except for http://localhost for testing purposes only.\n\nApp callback URLs such as myapp://example are also supported." }, "clientName": { "type": "string", - "description": "The client name for the user pool client you would like to create." + "description": "A friendly name for the app client that you want to create." }, "defaultRedirectUri": { "type": "string", - "description": "The default redirect URI. In app clients with one assigned IdP, replaces `redirect_uri` in authentication requests. Must be in the `CallbackURLs` list.\n\nA redirect URI must:\n\n- Be an absolute URI.\n- Be registered with the authorization server.\n- Not include a fragment component.\n\nFor more information, see [Default redirect URI](https://docs.aws.amazon.com/cognito/latest/developerguide/user-pool-settings-client-apps.html#cognito-user-pools-app-idp-settings-about) .\n\nAmazon Cognito requires HTTPS over HTTP except for http://localhost for testing purposes only.\n\nApp callback URLs such as myapp://example are also supported." + "description": "The default redirect URI. In app clients with one assigned IdP, replaces `redirect_uri` in authentication requests. Must be in the `CallbackURLs` list." }, "enablePropagateAdditionalUserContextData": { "type": "boolean", @@ -20520,7 +20520,7 @@ }, "generateSecret": { "type": "boolean", - "description": "Boolean to specify whether you want to generate a secret for the user pool client being created." + "description": "When `true` , generates a client secret for the app client. Client secrets are used with server-side and machine-to-machine applications. For more information, see [App client types](https://docs.aws.amazon.com/cognito/latest/developerguide/user-pool-settings-client-apps.html#user-pool-settings-client-app-client-types) ." }, "idTokenValidity": { "type": "integer", @@ -20531,7 +20531,7 @@ "items": { "type": "string" }, - "description": "A list of allowed logout URLs for the IdPs." + "description": "A list of allowed logout URLs for managed login authentication. For more information, see [Logout endpoint](https://docs.aws.amazon.com/cognito/latest/developerguide/logout-endpoint.html) ." }, "preventUserExistenceErrors": { "type": "string", @@ -20553,15 +20553,15 @@ "items": { "type": "string" }, - "description": "A list of provider names for the identity providers (IdPs) that are supported on this client. The following are supported: `COGNITO` , `Facebook` , `Google` , `SignInWithApple` , and `LoginWithAmazon` . You can also specify the names that you configured for the SAML and OIDC IdPs in your user pool, for example `MySAMLIdP` or `MyOIDCIdP` .\n\nThis setting applies to providers that you can access with the [hosted UI and OAuth 2.0 authorization server](https://docs.aws.amazon.com/cognito/latest/developerguide/cognito-user-pools-app-integration.html) . The removal of `COGNITO` from this list doesn't prevent authentication operations for local users with the user pools API in an AWS SDK. The only way to prevent API-based authentication is to block access with a [AWS WAF rule](https://docs.aws.amazon.com/cognito/latest/developerguide/user-pool-waf.html) ." + "description": "A list of provider names for the identity providers (IdPs) that are supported on this client. The following are supported: `COGNITO` , `Facebook` , `Google` , `SignInWithApple` , and `LoginWithAmazon` . You can also specify the names that you configured for the SAML and OIDC IdPs in your user pool, for example `MySAMLIdP` or `MyOIDCIdP` .\n\nThis setting applies to providers that you can access with [managed login](https://docs.aws.amazon.com/cognito/latest/developerguide/cognito-user-pools-managed-login.html) . The removal of `COGNITO` from this list doesn't prevent authentication operations for local users with the user pools API in an AWS SDK. The only way to prevent API-based authentication is to block access with a [AWS WAF rule](https://docs.aws.amazon.com/cognito/latest/developerguide/user-pool-waf.html) ." }, "tokenValidityUnits": { "$ref": "#/types/aws-native:cognito:UserPoolClientTokenValidityUnits", - "description": "The units in which the validity times are represented. The default unit for RefreshToken is days, and default for ID and access tokens are hours." + "description": "The units that validity times are represented in. The default unit for refresh tokens is days, and the default for ID and access tokens are hours." }, "userPoolId": { "type": "string", - "description": "The user pool ID for the user pool where you want to create a user pool client." + "description": "The ID of the user pool where you want to create an app client." }, "writeAttributes": { "type": "array", @@ -20592,11 +20592,11 @@ "items": { "type": "string" }, - "description": "The allowed OAuth scopes. Possible values provided by OAuth are `phone` , `email` , `openid` , and `profile` . Possible values provided by AWS are `aws.cognito.signin.user.admin` . Custom scopes created in Resource Servers are also supported." + "description": "The OAuth 2.0 scopes that you want to permit your app client to authorize. Scopes govern access control to user pool self-service API operations, user data from the `userInfo` endpoint, and third-party APIs. Possible values provided by OAuth are `phone` , `email` , `openid` , and `profile` . Possible values provided by AWS are `aws.cognito.signin.user.admin` . Custom scopes created in Resource Servers are also supported." }, "analyticsConfiguration": { "$ref": "#/types/aws-native:cognito:UserPoolClientAnalyticsConfiguration", - "description": "The user pool analytics configuration for collecting metrics and sending them to your Amazon Pinpoint campaign.\n\n\u003e In AWS Regions where Amazon Pinpoint isn't available, user pools only support sending events to Amazon Pinpoint projects in AWS Region us-east-1. In Regions where Amazon Pinpoint is available, user pools support sending events to Amazon Pinpoint projects within that same Region." + "description": "The user pool analytics configuration for collecting metrics and sending them to your Amazon Pinpoint campaign.\n\nIn AWS Regions where Amazon Pinpoint isn't available, user pools might not have access to analytics or might be configurable with campaigns in the US East (N. Virginia) Region. For more information, see [Using Amazon Pinpoint analytics](https://docs.aws.amazon.com/cognito/latest/developerguide/cognito-user-pools-pinpoint-integration.html) ." }, "authSessionValidity": { "type": "integer", @@ -20607,7 +20607,7 @@ "items": { "type": "string" }, - "description": "A list of allowed redirect (callback) URLs for the IdPs.\n\nA redirect URI must:\n\n- Be an absolute URI.\n- Be registered with the authorization server.\n- Not include a fragment component.\n\nSee [OAuth 2.0 - Redirection Endpoint](https://docs.aws.amazon.com/https://tools.ietf.org/html/rfc6749#section-3.1.2) .\n\nAmazon Cognito requires HTTPS over HTTP except for http://localhost for testing purposes only.\n\nApp callback URLs such as myapp://example are also supported." + "description": "A list of allowed redirect (callback) URLs for the IdPs.\n\nA redirect URI must:\n\n- Be an absolute URI.\n- Be registered with the authorization server. Amazon Cognito doesn't accept authorization requests with `redirect_uri` values that aren't in the list of `CallbackURLs` that you provide in this parameter.\n- Not include a fragment component.\n\nSee [OAuth 2.0 - Redirection Endpoint](https://docs.aws.amazon.com/https://tools.ietf.org/html/rfc6749#section-3.1.2) .\n\nAmazon Cognito requires HTTPS over HTTP except for http://localhost for testing purposes only.\n\nApp callback URLs such as myapp://example are also supported." }, "clientId": { "type": "string", @@ -20615,14 +20615,14 @@ }, "clientName": { "type": "string", - "description": "The client name for the user pool client you would like to create." + "description": "A friendly name for the app client that you want to create." }, "clientSecret": { "type": "string" }, "defaultRedirectUri": { "type": "string", - "description": "The default redirect URI. In app clients with one assigned IdP, replaces `redirect_uri` in authentication requests. Must be in the `CallbackURLs` list.\n\nA redirect URI must:\n\n- Be an absolute URI.\n- Be registered with the authorization server.\n- Not include a fragment component.\n\nFor more information, see [Default redirect URI](https://docs.aws.amazon.com/cognito/latest/developerguide/user-pool-settings-client-apps.html#cognito-user-pools-app-idp-settings-about) .\n\nAmazon Cognito requires HTTPS over HTTP except for http://localhost for testing purposes only.\n\nApp callback URLs such as myapp://example are also supported." + "description": "The default redirect URI. In app clients with one assigned IdP, replaces `redirect_uri` in authentication requests. Must be in the `CallbackURLs` list." }, "enablePropagateAdditionalUserContextData": { "type": "boolean", @@ -20641,7 +20641,7 @@ }, "generateSecret": { "type": "boolean", - "description": "Boolean to specify whether you want to generate a secret for the user pool client being created.", + "description": "When `true` , generates a client secret for the app client. Client secrets are used with server-side and machine-to-machine applications. For more information, see [App client types](https://docs.aws.amazon.com/cognito/latest/developerguide/user-pool-settings-client-apps.html#user-pool-settings-client-app-client-types) .", "replaceOnChanges": true }, "idTokenValidity": { @@ -20653,7 +20653,7 @@ "items": { "type": "string" }, - "description": "A list of allowed logout URLs for the IdPs." + "description": "A list of allowed logout URLs for managed login authentication. For more information, see [Logout endpoint](https://docs.aws.amazon.com/cognito/latest/developerguide/logout-endpoint.html) ." }, "name": { "type": "string" @@ -20678,15 +20678,15 @@ "items": { "type": "string" }, - "description": "A list of provider names for the identity providers (IdPs) that are supported on this client. The following are supported: `COGNITO` , `Facebook` , `Google` , `SignInWithApple` , and `LoginWithAmazon` . You can also specify the names that you configured for the SAML and OIDC IdPs in your user pool, for example `MySAMLIdP` or `MyOIDCIdP` .\n\nThis setting applies to providers that you can access with the [hosted UI and OAuth 2.0 authorization server](https://docs.aws.amazon.com/cognito/latest/developerguide/cognito-user-pools-app-integration.html) . The removal of `COGNITO` from this list doesn't prevent authentication operations for local users with the user pools API in an AWS SDK. The only way to prevent API-based authentication is to block access with a [AWS WAF rule](https://docs.aws.amazon.com/cognito/latest/developerguide/user-pool-waf.html) ." + "description": "A list of provider names for the identity providers (IdPs) that are supported on this client. The following are supported: `COGNITO` , `Facebook` , `Google` , `SignInWithApple` , and `LoginWithAmazon` . You can also specify the names that you configured for the SAML and OIDC IdPs in your user pool, for example `MySAMLIdP` or `MyOIDCIdP` .\n\nThis setting applies to providers that you can access with [managed login](https://docs.aws.amazon.com/cognito/latest/developerguide/cognito-user-pools-managed-login.html) . The removal of `COGNITO` from this list doesn't prevent authentication operations for local users with the user pools API in an AWS SDK. The only way to prevent API-based authentication is to block access with a [AWS WAF rule](https://docs.aws.amazon.com/cognito/latest/developerguide/user-pool-waf.html) ." }, "tokenValidityUnits": { "$ref": "#/types/aws-native:cognito:UserPoolClientTokenValidityUnits", - "description": "The units in which the validity times are represented. The default unit for RefreshToken is days, and default for ID and access tokens are hours." + "description": "The units that validity times are represented in. The default unit for refresh tokens is days, and the default for ID and access tokens are hours." }, "userPoolId": { "type": "string", - "description": "The user pool ID for the user pool where you want to create a user pool client.", + "description": "The ID of the user pool where you want to create an app client.", "replaceOnChanges": true }, "writeAttributes": { @@ -20790,11 +20790,11 @@ "inputs": { "description": { "type": "string", - "description": "A string containing the description of the group." + "description": "A description of the group that you're creating." }, "groupName": { "type": "string", - "description": "The name of the group. Must be unique." + "description": "A name for the group. This name must be unique in your user pool." }, "precedence": { "type": "integer", @@ -20802,21 +20802,21 @@ }, "roleArn": { "type": "string", - "description": "The role Amazon Resource Name (ARN) for the group." + "description": "The Amazon Resource Name (ARN) for the IAM role that you want to associate with the group. A group role primarily declares a preferred role for the credentials that you get from an identity pool. Amazon Cognito ID tokens have a `cognito:preferred_role` claim that presents the highest-precedence group that a user belongs to. Both ID and access tokens also contain a `cognito:groups` claim that list all the groups that a user is a member of." }, "userPoolId": { "type": "string", - "description": "The user pool ID for the user pool." + "description": "The ID of the user pool where you want to create a user group." } }, "outputs": { "description": { "type": "string", - "description": "A string containing the description of the group." + "description": "A description of the group that you're creating." }, "groupName": { "type": "string", - "description": "The name of the group. Must be unique.", + "description": "A name for the group. This name must be unique in your user pool.", "replaceOnChanges": true }, "precedence": { @@ -20825,11 +20825,11 @@ }, "roleArn": { "type": "string", - "description": "The role Amazon Resource Name (ARN) for the group." + "description": "The Amazon Resource Name (ARN) for the IAM role that you want to associate with the group. A group role primarily declares a preferred role for the credentials that you get from an identity pool. Amazon Cognito ID tokens have a `cognito:preferred_role` claim that presents the highest-precedence group that a user belongs to. Both ID and access tokens also contain a `cognito:groups` claim that list all the groups that a user is a member of." }, "userPoolId": { "type": "string", - "description": "The user pool ID for the user pool.", + "description": "The ID of the user pool where you want to create a user group.", "replaceOnChanges": true } }, @@ -20856,14 +20856,14 @@ "additionalProperties": { "type": "string" }, - "description": "A mapping of IdP attributes to standard and custom user pool attributes." + "description": "A mapping of IdP attributes to standard and custom user pool attributes. Specify a user pool attribute as the key of the key-value pair, and the IdP attribute claim name as the value." }, "idpIdentifiers": { "type": "array", "items": { "type": "string" }, - "description": "A list of IdP identifiers." + "description": "An array of IdP identifiers, for example `\"IdPIdentifiers\": [ \"MyIdP\", \"MyIdP2\" ]` . Identifiers are friendly names that you can pass in the `idp_identifier` query parameter of requests to the [Authorize endpoint](https://docs.aws.amazon.com/cognito/latest/developerguide/authorization-endpoint.html) to silently redirect to sign-in with the associated IdP. Identifiers in a domain format also enable the use of [email-address matching with SAML providers](https://docs.aws.amazon.com/cognito/latest/developerguide/cognito-user-pools-managing-saml-idp-naming.html) ." }, "providerDetails": { "type": "object", @@ -20874,15 +20874,15 @@ }, "providerName": { "type": "string", - "description": "The IdP name." + "description": "The name that you want to assign to the IdP. You can pass the identity provider name in the `identity_provider` query parameter of requests to the [Authorize endpoint](https://docs.aws.amazon.com/cognito/latest/developerguide/authorization-endpoint.html) to silently redirect to sign-in with the associated IdP." }, "providerType": { "type": "string", - "description": "The IdP type." + "description": "The type of IdP that you want to add. Amazon Cognito supports OIDC, SAML 2.0, Login With Amazon, Sign In With Apple, Google, and Facebook IdPs." }, "userPoolId": { "type": "string", - "description": "The user pool ID." + "description": "The Id of the user pool where you want to create an IdP." } }, "outputs": { @@ -20891,14 +20891,14 @@ "additionalProperties": { "type": "string" }, - "description": "A mapping of IdP attributes to standard and custom user pool attributes." + "description": "A mapping of IdP attributes to standard and custom user pool attributes. Specify a user pool attribute as the key of the key-value pair, and the IdP attribute claim name as the value." }, "idpIdentifiers": { "type": "array", "items": { "type": "string" }, - "description": "A list of IdP identifiers." + "description": "An array of IdP identifiers, for example `\"IdPIdentifiers\": [ \"MyIdP\", \"MyIdP2\" ]` . Identifiers are friendly names that you can pass in the `idp_identifier` query parameter of requests to the [Authorize endpoint](https://docs.aws.amazon.com/cognito/latest/developerguide/authorization-endpoint.html) to silently redirect to sign-in with the associated IdP. Identifiers in a domain format also enable the use of [email-address matching with SAML providers](https://docs.aws.amazon.com/cognito/latest/developerguide/cognito-user-pools-managing-saml-idp-naming.html) ." }, "providerDetails": { "type": "object", @@ -20909,17 +20909,17 @@ }, "providerName": { "type": "string", - "description": "The IdP name.", + "description": "The name that you want to assign to the IdP. You can pass the identity provider name in the `identity_provider` query parameter of requests to the [Authorize endpoint](https://docs.aws.amazon.com/cognito/latest/developerguide/authorization-endpoint.html) to silently redirect to sign-in with the associated IdP.", "replaceOnChanges": true }, "providerType": { "type": "string", - "description": "The IdP type.", + "description": "The type of IdP that you want to add. Amazon Cognito supports OIDC, SAML 2.0, Login With Amazon, Sign In With Apple, Google, and Facebook IdPs.", "replaceOnChanges": true }, "userPoolId": { "type": "string", - "description": "The user pool ID.", + "description": "The Id of the user pool where you want to create an IdP.", "replaceOnChanges": true } }, @@ -20961,7 +20961,7 @@ }, "userPoolId": { "type": "string", - "description": "The user pool ID for the user pool." + "description": "The ID of the user pool where you want to create a resource server." } }, "outputs": { @@ -20983,7 +20983,7 @@ }, "userPoolId": { "type": "string", - "description": "The user pool ID for the user pool.", + "description": "The ID of the user pool where you want to create a resource server.", "replaceOnChanges": true } }, @@ -21080,7 +21080,7 @@ }, "userPoolId": { "type": "string", - "description": "The user pool ID for the user pool." + "description": "The ID of the user pool." } }, "outputs": { @@ -21095,7 +21095,7 @@ }, "userPoolId": { "type": "string", - "description": "The user pool ID for the user pool.", + "description": "The ID of the user pool.", "replaceOnChanges": true } }, @@ -21123,22 +21123,22 @@ "additionalProperties": { "type": "string" }, - "description": "A map of custom key-value pairs that you can provide as input for any custom workflows that this action triggers.\n\nYou create custom workflows by assigning AWS Lambda functions to user pool triggers. When you use the AdminCreateUser API action, Amazon Cognito invokes the function that is assigned to the *pre sign-up* trigger. When Amazon Cognito invokes this function, it passes a JSON payload, which the function receives as input. This payload contains a `clientMetadata` attribute, which provides the data that you assigned to the ClientMetadata parameter in your AdminCreateUser request. In your function code in AWS Lambda , you can process the `clientMetadata` value to enhance your workflow for your specific needs.\n\nFor more information, see [Customizing user pool Workflows with Lambda Triggers](https://docs.aws.amazon.com/cognito/latest/developerguide/cognito-user-identity-pools-working-with-aws-lambda-triggers.html) in the *Amazon Cognito Developer Guide* .\n\n\u003e When you use the ClientMetadata parameter, remember that Amazon Cognito won't do the following:\n\u003e \n\u003e - Store the ClientMetadata value. This data is available only to AWS Lambda triggers that are assigned to a user pool to support custom workflows. If your user pool configuration doesn't include triggers, the ClientMetadata parameter serves no purpose.\n\u003e - Validate the ClientMetadata value.\n\u003e - Encrypt the ClientMetadata value. Don't use Amazon Cognito to provide sensitive information." + "description": "A map of custom key-value pairs that you can provide as input for any custom workflows that this action triggers.\n\nYou create custom workflows by assigning AWS Lambda functions to user pool triggers. When you use the AdminCreateUser API action, Amazon Cognito invokes the function that is assigned to the *pre sign-up* trigger. When Amazon Cognito invokes this function, it passes a JSON payload, which the function receives as input. This payload contains a `ClientMetadata` attribute, which provides the data that you assigned to the ClientMetadata parameter in your AdminCreateUser request. In your function code in AWS Lambda , you can process the `clientMetadata` value to enhance your workflow for your specific needs.\n\nFor more information, see [Customizing user pool Workflows with Lambda Triggers](https://docs.aws.amazon.com/cognito/latest/developerguide/cognito-user-identity-pools-working-with-aws-lambda-triggers.html) in the *Amazon Cognito Developer Guide* .\n\n\u003e When you use the `ClientMetadata` parameter, note that Amazon Cognito won't do the following:\n\u003e \n\u003e - Store the `ClientMetadata` value. This data is available only to AWS Lambda triggers that are assigned to a user pool to support custom workflows. If your user pool configuration doesn't include triggers, the `ClientMetadata` parameter serves no purpose.\n\u003e - Validate the `ClientMetadata` value.\n\u003e - Encrypt the `ClientMetadata` value. Don't send sensitive information in this parameter." }, "desiredDeliveryMediums": { "type": "array", "items": { "type": "string" }, - "description": "Specify `\"EMAIL\"` if email will be used to send the welcome message. Specify `\"SMS\"` if the phone number will be used. The default value is `\"SMS\"` . You can specify more than one value." + "description": "Specify `EMAIL` if email will be used to send the welcome message. Specify `SMS` if the phone number will be used. The default value is `SMS` . You can specify more than one value." }, "forceAliasCreation": { "type": "boolean", - "description": "This parameter is used only if the `phone_number_verified` or `email_verified` attribute is set to `True` . Otherwise, it is ignored.\n\nIf this parameter is set to `True` and the phone number or email address specified in the UserAttributes parameter already exists as an alias with a different user, the API call will migrate the alias from the previous user to the newly created user. The previous user will no longer be able to log in using that alias.\n\nIf this parameter is set to `False` , the API throws an `AliasExistsException` error if the alias already exists. The default value is `False` ." + "description": "This parameter is used only if the `phone_number_verified` or `email_verified` attribute is set to `True` . Otherwise, it is ignored.\n\nIf this parameter is set to `True` and the phone number or email address specified in the `UserAttributes` parameter already exists as an alias with a different user, this request migrates the alias from the previous user to the newly-created user. The previous user will no longer be able to log in using that alias.\n\nIf this parameter is set to `False` , the API throws an `AliasExistsException` error if the alias already exists. The default value is `False` ." }, "messageAction": { "type": "string", - "description": "Set to `RESEND` to resend the invitation message to a user that already exists and reset the expiration limit on the user's account. Set to `SUPPRESS` to suppress sending the message. You can specify only one value." + "description": "Set to `RESEND` to resend the invitation message to a user that already exists, and to reset the temporary-password duration with a new temporary password. Set to `SUPPRESS` to suppress sending the message. You can specify only one value." }, "userAttributes": { "type": "array", @@ -21149,7 +21149,7 @@ }, "userPoolId": { "type": "string", - "description": "The user pool ID for the user pool where the user will be created." + "description": "The ID of the user pool where you want to create a user." }, "username": { "type": "string", @@ -21169,7 +21169,7 @@ "additionalProperties": { "type": "string" }, - "description": "A map of custom key-value pairs that you can provide as input for any custom workflows that this action triggers.\n\nYou create custom workflows by assigning AWS Lambda functions to user pool triggers. When you use the AdminCreateUser API action, Amazon Cognito invokes the function that is assigned to the *pre sign-up* trigger. When Amazon Cognito invokes this function, it passes a JSON payload, which the function receives as input. This payload contains a `clientMetadata` attribute, which provides the data that you assigned to the ClientMetadata parameter in your AdminCreateUser request. In your function code in AWS Lambda , you can process the `clientMetadata` value to enhance your workflow for your specific needs.\n\nFor more information, see [Customizing user pool Workflows with Lambda Triggers](https://docs.aws.amazon.com/cognito/latest/developerguide/cognito-user-identity-pools-working-with-aws-lambda-triggers.html) in the *Amazon Cognito Developer Guide* .\n\n\u003e When you use the ClientMetadata parameter, remember that Amazon Cognito won't do the following:\n\u003e \n\u003e - Store the ClientMetadata value. This data is available only to AWS Lambda triggers that are assigned to a user pool to support custom workflows. If your user pool configuration doesn't include triggers, the ClientMetadata parameter serves no purpose.\n\u003e - Validate the ClientMetadata value.\n\u003e - Encrypt the ClientMetadata value. Don't use Amazon Cognito to provide sensitive information.", + "description": "A map of custom key-value pairs that you can provide as input for any custom workflows that this action triggers.\n\nYou create custom workflows by assigning AWS Lambda functions to user pool triggers. When you use the AdminCreateUser API action, Amazon Cognito invokes the function that is assigned to the *pre sign-up* trigger. When Amazon Cognito invokes this function, it passes a JSON payload, which the function receives as input. This payload contains a `ClientMetadata` attribute, which provides the data that you assigned to the ClientMetadata parameter in your AdminCreateUser request. In your function code in AWS Lambda , you can process the `clientMetadata` value to enhance your workflow for your specific needs.\n\nFor more information, see [Customizing user pool Workflows with Lambda Triggers](https://docs.aws.amazon.com/cognito/latest/developerguide/cognito-user-identity-pools-working-with-aws-lambda-triggers.html) in the *Amazon Cognito Developer Guide* .\n\n\u003e When you use the `ClientMetadata` parameter, note that Amazon Cognito won't do the following:\n\u003e \n\u003e - Store the `ClientMetadata` value. This data is available only to AWS Lambda triggers that are assigned to a user pool to support custom workflows. If your user pool configuration doesn't include triggers, the `ClientMetadata` parameter serves no purpose.\n\u003e - Validate the `ClientMetadata` value.\n\u003e - Encrypt the `ClientMetadata` value. Don't send sensitive information in this parameter.", "replaceOnChanges": true }, "desiredDeliveryMediums": { @@ -21177,17 +21177,17 @@ "items": { "type": "string" }, - "description": "Specify `\"EMAIL\"` if email will be used to send the welcome message. Specify `\"SMS\"` if the phone number will be used. The default value is `\"SMS\"` . You can specify more than one value.", + "description": "Specify `EMAIL` if email will be used to send the welcome message. Specify `SMS` if the phone number will be used. The default value is `SMS` . You can specify more than one value.", "replaceOnChanges": true }, "forceAliasCreation": { "type": "boolean", - "description": "This parameter is used only if the `phone_number_verified` or `email_verified` attribute is set to `True` . Otherwise, it is ignored.\n\nIf this parameter is set to `True` and the phone number or email address specified in the UserAttributes parameter already exists as an alias with a different user, the API call will migrate the alias from the previous user to the newly created user. The previous user will no longer be able to log in using that alias.\n\nIf this parameter is set to `False` , the API throws an `AliasExistsException` error if the alias already exists. The default value is `False` .", + "description": "This parameter is used only if the `phone_number_verified` or `email_verified` attribute is set to `True` . Otherwise, it is ignored.\n\nIf this parameter is set to `True` and the phone number or email address specified in the `UserAttributes` parameter already exists as an alias with a different user, this request migrates the alias from the previous user to the newly-created user. The previous user will no longer be able to log in using that alias.\n\nIf this parameter is set to `False` , the API throws an `AliasExistsException` error if the alias already exists. The default value is `False` .", "replaceOnChanges": true }, "messageAction": { "type": "string", - "description": "Set to `RESEND` to resend the invitation message to a user that already exists and reset the expiration limit on the user's account. Set to `SUPPRESS` to suppress sending the message. You can specify only one value.", + "description": "Set to `RESEND` to resend the invitation message to a user that already exists, and to reset the temporary-password duration with a new temporary password. Set to `SUPPRESS` to suppress sending the message. You can specify only one value.", "replaceOnChanges": true }, "userAttributes": { @@ -21200,7 +21200,7 @@ }, "userPoolId": { "type": "string", - "description": "The user pool ID for the user pool where the user will be created.", + "description": "The ID of the user pool where you want to create a user.", "replaceOnChanges": true }, "username": { @@ -21254,7 +21254,7 @@ }, "userPoolId": { "type": "string", - "description": "The user pool ID for the user pool." + "description": "The ID of the user pool that contains the group that you want to add the user to." }, "username": { "type": "string", @@ -21269,7 +21269,7 @@ }, "userPoolId": { "type": "string", - "description": "The user pool ID for the user pool.", + "description": "The ID of the user pool that contains the group that you want to add the user to.", "replaceOnChanges": true }, "username": { @@ -23760,6 +23760,10 @@ "type": "string", "description": "The name of the task template." }, + "selfAssignContactFlowArn": { + "type": "string", + "description": "The identifier of the contact flow." + }, "status": { "$ref": "#/types/aws-native:connect:TaskTemplateStatus", "description": "The status of the task template." @@ -23815,6 +23819,10 @@ "type": "string", "description": "The name of the task template." }, + "selfAssignContactFlowArn": { + "type": "string", + "description": "The identifier of the contact flow." + }, "status": { "$ref": "#/types/aws-native:connect:TaskTemplateStatus", "description": "The status of the task template." @@ -31410,7 +31418,7 @@ }, "importSourceSpecification": { "$ref": "#/types/aws-native:dynamodb:TableImportSourceSpecification", - "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." }, "keySchema": { "oneOf": [ @@ -31518,7 +31526,7 @@ }, "importSourceSpecification": { "$ref": "#/types/aws-native:dynamodb:TableImportSourceSpecification", - "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.", "replaceOnChanges": true }, "keySchema": { @@ -34242,7 +34250,7 @@ "items": { "$ref": "#/types/aws-native:ec2:LaunchTemplateTagSpecification" }, - "description": "The tags to apply to the launch template on creation. To tag the launch template, the resource type must be ``launch-template``.\n To specify the tags for resources that are created during instance launch, use [TagSpecifications](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-launchtemplate-launchtemplatedata.html#cfn-ec2-launchtemplate-launchtemplatedata-tagspecifications)." + "description": "The tags to apply to the launch template on creation. To tag the launch template, the resource type must be ``launch-template``.\n To specify the tags for the resources that are created when an instance is launched, you must use [TagSpecifications](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-launchtemplate-launchtemplatedata.html#cfn-ec2-launchtemplate-launchtemplatedata-tagspecifications)." }, "versionDescription": { "type": "string", @@ -34276,7 +34284,7 @@ "items": { "$ref": "#/types/aws-native:ec2:LaunchTemplateTagSpecification" }, - "description": "The tags to apply to the launch template on creation. To tag the launch template, the resource type must be ``launch-template``.\n To specify the tags for resources that are created during instance launch, use [TagSpecifications](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-launchtemplate-launchtemplatedata.html#cfn-ec2-launchtemplate-launchtemplatedata-tagspecifications)." + "description": "The tags to apply to the launch template on creation. To tag the launch template, the resource type must be ``launch-template``.\n To specify the tags for the resources that are created when an instance is launched, you must use [TagSpecifications](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-launchtemplate-launchtemplatedata.html#cfn-ec2-launchtemplate-launchtemplatedata-tagspecifications)." }, "versionDescription": { "type": "string", @@ -40413,6 +40421,9 @@ "type": "string", "description": "The number of ``cpu`` units used by the task. If you use the EC2 launch type, this field is optional. Any value can be used. If you use the Fargate launch type, this field is required. You must use one of the following values. The value that you choose determines your range of valid values for the ``memory`` parameter.\n If you use the EC2 launch type, this field is optional. Supported values are between ``128`` CPU units (``0.125`` vCPUs) and ``10240`` CPU units (``10`` vCPUs).\n The CPU units cannot be less than 1 vCPU when you use Windows containers on Fargate.\n + 256 (.25 vCPU) - Available ``memory`` values: 512 (0.5 GB), 1024 (1 GB), 2048 (2 GB)\n + 512 (.5 vCPU) - Available ``memory`` values: 1024 (1 GB), 2048 (2 GB), 3072 (3 GB), 4096 (4 GB)\n + 1024 (1 vCPU) - Available ``memory`` values: 2048 (2 GB), 3072 (3 GB), 4096 (4 GB), 5120 (5 GB), 6144 (6 GB), 7168 (7 GB), 8192 (8 GB)\n + 2048 (2 vCPU) - Available ``memory`` values: 4096 (4 GB) and 16384 (16 GB) in increments of 1024 (1 GB)\n + 4096 (4 vCPU) - Available ``memory`` values: 8192 (8 GB) and 30720 (30 GB) in increments of 1024 (1 GB)\n + 8192 (8 vCPU) - Available ``memory`` values: 16 GB and 60 GB in 4 GB increments\n This option requires Linux platform ``1.4.0`` or later.\n + 16384 (16vCPU) - Available ``memory`` values: 32GB and 120 GB in 8 GB increments\n This option requires Linux platform ``1.4.0`` or later." }, + "enableFaultInjection": { + "type": "boolean" + }, "ephemeralStorage": { "$ref": "#/types/aws-native:ecs:TaskDefinitionEphemeralStorage", "description": "The ephemeral storage settings to use for tasks run with the task definition." @@ -40503,6 +40514,10 @@ "description": "The number of ``cpu`` units used by the task. If you use the EC2 launch type, this field is optional. Any value can be used. If you use the Fargate launch type, this field is required. You must use one of the following values. The value that you choose determines your range of valid values for the ``memory`` parameter.\n If you use the EC2 launch type, this field is optional. Supported values are between ``128`` CPU units (``0.125`` vCPUs) and ``10240`` CPU units (``10`` vCPUs).\n The CPU units cannot be less than 1 vCPU when you use Windows containers on Fargate.\n + 256 (.25 vCPU) - Available ``memory`` values: 512 (0.5 GB), 1024 (1 GB), 2048 (2 GB)\n + 512 (.5 vCPU) - Available ``memory`` values: 1024 (1 GB), 2048 (2 GB), 3072 (3 GB), 4096 (4 GB)\n + 1024 (1 vCPU) - Available ``memory`` values: 2048 (2 GB), 3072 (3 GB), 4096 (4 GB), 5120 (5 GB), 6144 (6 GB), 7168 (7 GB), 8192 (8 GB)\n + 2048 (2 vCPU) - Available ``memory`` values: 4096 (4 GB) and 16384 (16 GB) in increments of 1024 (1 GB)\n + 4096 (4 vCPU) - Available ``memory`` values: 8192 (8 GB) and 30720 (30 GB) in increments of 1024 (1 GB)\n + 8192 (8 vCPU) - Available ``memory`` values: 16 GB and 60 GB in 4 GB increments\n This option requires Linux platform ``1.4.0`` or later.\n + 16384 (16vCPU) - Available ``memory`` values: 32GB and 120 GB in 8 GB increments\n This option requires Linux platform ``1.4.0`` or later.", "replaceOnChanges": true }, + "enableFaultInjection": { + "type": "boolean", + "replaceOnChanges": true + }, "ephemeralStorage": { "$ref": "#/types/aws-native:ecs:TaskDefinitionEphemeralStorage", "description": "The ephemeral storage settings to use for tasks run with the task definition.", @@ -40600,6 +40615,7 @@ "createOnly": [ "containerDefinitions", "cpu", + "enableFaultInjection", "ephemeralStorage", "executionRoleArn", "family", @@ -54354,7 +54370,7 @@ "inputs": { "healthEventsConfig": { "$ref": "#/types/aws-native:internetmonitor:MonitorHealthEventsConfig", - "description": "A complex type with the configuration information that determines the threshold and other conditions for when Internet Monitor creates a health event for an overall performance or availability issue, across an application's geographies.\n\nDefines the percentages, for overall performance scores and availability scores for an application, that are the thresholds for when Amazon CloudWatch Internet Monitor creates a health event. You can override the defaults to set a custom threshold for overall performance or availability scores, or both.\n\nYou can also set thresholds for local health scores,, where Internet Monitor creates a health event when scores cross a threshold for one or more city-networks, in addition to creating an event when an overall score crosses a threshold.\n\nIf you don't set a health event threshold, the default value is 95%.\n\nFor local thresholds, you also set a minimum percentage of overall traffic that is impacted by an issue before Internet Monitor creates an event. In addition, you can disable local thresholds, for performance scores, availability scores, or both.\n\nFor more information, see [Change health event thresholds](https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/CloudWatch-IM-overview.html#IMUpdateThresholdFromOverview) in the Internet Monitor section of the *CloudWatch User Guide* ." + "description": "A complex type with the configuration information that determines the threshold and other conditions for when Internet Monitor creates a health event for an overall performance or availability issue, across an application's geographies.\n\nDefines the percentages, for overall performance scores and availability scores for an application, that are the thresholds for when Internet Monitor creates a health event. You can override the defaults to set a custom threshold for overall performance or availability scores, or both.\n\nYou can also set thresholds for local health scores,, where Internet Monitor creates a health event when scores cross a threshold for one or more city-networks, in addition to creating an event when an overall score crosses a threshold.\n\nIf you don't set a health event threshold, the default value is 95%.\n\nFor local thresholds, you also set a minimum percentage of overall traffic that is impacted by an issue before Internet Monitor creates an event. In addition, you can disable local thresholds, for performance scores, availability scores, or both.\n\nFor more information, see [Change health event thresholds](https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/CloudWatch-IM-overview.html#IMUpdateThresholdFromOverview) in the Internet Monitor section of the *CloudWatch User Guide* ." }, "includeLinkedAccounts": { "type": "boolean", @@ -54420,7 +54436,7 @@ }, "healthEventsConfig": { "$ref": "#/types/aws-native:internetmonitor:MonitorHealthEventsConfig", - "description": "A complex type with the configuration information that determines the threshold and other conditions for when Internet Monitor creates a health event for an overall performance or availability issue, across an application's geographies.\n\nDefines the percentages, for overall performance scores and availability scores for an application, that are the thresholds for when Amazon CloudWatch Internet Monitor creates a health event. You can override the defaults to set a custom threshold for overall performance or availability scores, or both.\n\nYou can also set thresholds for local health scores,, where Internet Monitor creates a health event when scores cross a threshold for one or more city-networks, in addition to creating an event when an overall score crosses a threshold.\n\nIf you don't set a health event threshold, the default value is 95%.\n\nFor local thresholds, you also set a minimum percentage of overall traffic that is impacted by an issue before Internet Monitor creates an event. In addition, you can disable local thresholds, for performance scores, availability scores, or both.\n\nFor more information, see [Change health event thresholds](https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/CloudWatch-IM-overview.html#IMUpdateThresholdFromOverview) in the Internet Monitor section of the *CloudWatch User Guide* ." + "description": "A complex type with the configuration information that determines the threshold and other conditions for when Internet Monitor creates a health event for an overall performance or availability issue, across an application's geographies.\n\nDefines the percentages, for overall performance scores and availability scores for an application, that are the thresholds for when Internet Monitor creates a health event. You can override the defaults to set a custom threshold for overall performance or availability scores, or both.\n\nYou can also set thresholds for local health scores,, where Internet Monitor creates a health event when scores cross a threshold for one or more city-networks, in addition to creating an event when an overall score crosses a threshold.\n\nIf you don't set a health event threshold, the default value is 95%.\n\nFor local thresholds, you also set a minimum percentage of overall traffic that is impacted by an issue before Internet Monitor creates an event. In addition, you can disable local thresholds, for performance scores, availability scores, or both.\n\nFor more information, see [Change health event thresholds](https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/CloudWatch-IM-overview.html#IMUpdateThresholdFromOverview) in the Internet Monitor section of the *CloudWatch User Guide* ." }, "includeLinkedAccounts": { "type": "boolean", @@ -54520,56 +54536,70 @@ "cf": "AWS::Invoicing::InvoiceUnit", "inputs": { "description": { - "type": "string" + "type": "string", + "description": "The assigned description for an invoice unit. This information can't be modified or deleted." }, "invoiceReceiver": { - "type": "string" + "type": "string", + "description": "The account that receives invoices related to the invoice unit." }, "name": { - "type": "string" + "type": "string", + "description": "A unique name that is distinctive within your AWS ." }, "resourceTags": { "type": "array", "items": { "$ref": "#/types/aws-native:index:Tag" - } + }, + "description": "The tag structure that contains a tag key and value." }, "rule": { - "$ref": "#/types/aws-native:invoicing:InvoiceUnitRule" + "$ref": "#/types/aws-native:invoicing:InvoiceUnitRule", + "description": "An `InvoiceUnitRule` object used the categorize invoice units." }, "taxInheritanceDisabled": { - "type": "boolean" + "type": "boolean", + "description": "Whether the invoice unit based tax inheritance is/ should be enabled or disabled." } }, "outputs": { "description": { - "type": "string" + "type": "string", + "description": "The assigned description for an invoice unit. This information can't be modified or deleted." }, "invoiceReceiver": { "type": "string", + "description": "The account that receives invoices related to the invoice unit.", "replaceOnChanges": true }, "invoiceUnitArn": { - "type": "string" + "type": "string", + "description": "The ARN to identify an invoice unit. This information can't be modified or deleted." }, "lastModified": { - "type": "number" + "type": "number", + "description": "The last time the invoice unit was updated. This is important to determine the version of invoice unit configuration used to create the invoices. Any invoice created after this modified time will use this invoice unit configuration." }, "name": { "type": "string", + "description": "A unique name that is distinctive within your AWS .", "replaceOnChanges": true }, "resourceTags": { "type": "array", "items": { "$ref": "#/types/aws-native:index:Tag" - } + }, + "description": "The tag structure that contains a tag key and value." }, "rule": { - "$ref": "#/types/aws-native:invoicing:InvoiceUnitRule" + "$ref": "#/types/aws-native:invoicing:InvoiceUnitRule", + "description": "An `InvoiceUnitRule` object used the categorize invoice units." }, "taxInheritanceDisabled": { - "type": "boolean" + "type": "boolean", + "description": "Whether the invoice unit based tax inheritance is/ should be enabled or disabled." } }, "autoNamingSpec": { @@ -55082,6 +55112,140 @@ "certificateProviderName" ] }, + "aws-native:iot:Command": { + "cf": "AWS::IoT::Command", + "inputs": { + "commandId": { + "type": "string", + "description": "The unique identifier for the command." + }, + "createdAt": { + "type": "string", + "description": "The date and time when the command was created." + }, + "deprecated": { + "type": "boolean", + "description": "A flag indicating whether the command is deprecated." + }, + "description": { + "type": "string", + "description": "The description of the command." + }, + "displayName": { + "type": "string", + "description": "The display name for the command." + }, + "lastUpdatedAt": { + "type": "string", + "description": "The date and time when the command was last updated." + }, + "mandatoryParameters": { + "type": "array", + "items": { + "$ref": "#/types/aws-native:iot:CommandParameter" + }, + "description": "The list of mandatory parameters for the command." + }, + "namespace": { + "$ref": "#/types/aws-native:iot:CommandNamespace", + "description": "The namespace to which the command belongs." + }, + "payload": { + "$ref": "#/types/aws-native:iot:CommandPayload", + "description": "The payload associated with the command." + }, + "pendingDeletion": { + "type": "boolean", + "description": "A flag indicating whether the command is pending deletion." + }, + "roleArn": { + "type": "string", + "description": "The customer role associated with the command." + }, + "tags": { + "type": "array", + "items": { + "$ref": "#/types/aws-native:index:Tag" + }, + "description": "The tags to be associated with the command." + } + }, + "outputs": { + "commandArn": { + "type": "string", + "description": "The Amazon Resource Name (ARN) of the command." + }, + "commandId": { + "type": "string", + "description": "The unique identifier for the command.", + "replaceOnChanges": true + }, + "createdAt": { + "type": "string", + "description": "The date and time when the command was created." + }, + "deprecated": { + "type": "boolean", + "description": "A flag indicating whether the command is deprecated." + }, + "description": { + "type": "string", + "description": "The description of the command." + }, + "displayName": { + "type": "string", + "description": "The display name for the command." + }, + "lastUpdatedAt": { + "type": "string", + "description": "The date and time when the command was last updated." + }, + "mandatoryParameters": { + "type": "array", + "items": { + "$ref": "#/types/aws-native:iot:CommandParameter" + }, + "description": "The list of mandatory parameters for the command." + }, + "namespace": { + "$ref": "#/types/aws-native:iot:CommandNamespace", + "description": "The namespace to which the command belongs." + }, + "payload": { + "$ref": "#/types/aws-native:iot:CommandPayload", + "description": "The payload associated with the command." + }, + "pendingDeletion": { + "type": "boolean", + "description": "A flag indicating whether the command is pending deletion." + }, + "roleArn": { + "type": "string", + "description": "The customer role associated with the command." + }, + "tags": { + "type": "array", + "items": { + "$ref": "#/types/aws-native:index:Tag" + }, + "description": "The tags to be associated with the command." + } + }, + "required": [ + "commandId" + ], + "createOnly": [ + "commandId" + ], + "writeOnly": [ + "lastUpdatedAt" + ], + "tagsProperty": "tags", + "tagsStyle": "keyValueArray", + "primaryIdentifier": [ + "commandId" + ] + }, "aws-native:iot:CustomMetric": { "cf": "AWS::IoT::CustomMetric", "inputs": { @@ -77603,7 +77767,7 @@ }, "type": { "$ref": "#/types/aws-native:organizations:PolicyType", - "description": "The type of policy to create. You can specify one of the following values: AISERVICES_OPT_OUT_POLICY, BACKUP_POLICY, SERVICE_CONTROL_POLICY, TAG_POLICY, CHATBOT_POLICY, RESOURCE_CONTROL_POLICY" + "description": "The type of policy to create. You can specify one of the following values: AISERVICES_OPT_OUT_POLICY, BACKUP_POLICY, SERVICE_CONTROL_POLICY, TAG_POLICY, CHATBOT_POLICY, RESOURCE_CONTROL_POLICY,DECLARATIVE_POLICY_EC2" } }, "outputs": { @@ -77647,7 +77811,7 @@ }, "type": { "$ref": "#/types/aws-native:organizations:PolicyType", - "description": "The type of policy to create. You can specify one of the following values: AISERVICES_OPT_OUT_POLICY, BACKUP_POLICY, SERVICE_CONTROL_POLICY, TAG_POLICY, CHATBOT_POLICY, RESOURCE_CONTROL_POLICY", + "description": "The type of policy to create. You can specify one of the following values: AISERVICES_OPT_OUT_POLICY, BACKUP_POLICY, SERVICE_CONTROL_POLICY, TAG_POLICY, CHATBOT_POLICY, RESOURCE_CONTROL_POLICY,DECLARATIVE_POLICY_EC2", "replaceOnChanges": true } }, @@ -79520,7 +79684,8 @@ "type": "array", "items": { "type": "string" - } + }, + "description": "The OIDC client ID for a Amazon Q Business application." }, "description": { "type": "string", @@ -79591,6 +79756,7 @@ "items": { "type": "string" }, + "description": "The OIDC client ID for a Amazon Q Business application.", "replaceOnChanges": true }, "createdAt": { @@ -82143,6 +82309,117 @@ "arn" ] }, + "aws-native:ram:ResourceShare": { + "cf": "AWS::RAM::ResourceShare", + "inputs": { + "allowExternalPrincipals": { + "type": "boolean", + "description": "Specifies whether principals outside your organization in AWS Organizations can be associated with a resource share. A value of `true` lets you share with individual AWS accounts that are not in your organization. A value of `false` only has meaning if your account is a member of an AWS Organization. The default value is `true`." + }, + "name": { + "type": "string", + "description": "Specifies the name of the resource share." + }, + "permissionArns": { + "type": "array", + "items": { + "type": "string" + }, + "description": "Specifies the [Amazon Resource Names (ARNs)](https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html) of the AWS RAM permission to associate with the resource share. If you do not specify an ARN for the permission, AWS RAM automatically attaches the default version of the permission for each resource type. You can associate only one permission with each resource type included in the resource share." + }, + "principals": { + "type": "array", + "items": { + "type": "string" + }, + "description": "Specifies the principals to associate with the resource share. The possible values are:\n\n- An AWS account ID\n\n- An Amazon Resource Name (ARN) of an organization in AWS Organizations\n\n- An ARN of an organizational unit (OU) in AWS Organizations\n\n- An ARN of an IAM role\n\n- An ARN of an IAM user" + }, + "resourceArns": { + "type": "array", + "items": { + "type": "string" + }, + "description": "Specifies a list of one or more ARNs of the resources to associate with the resource share." + }, + "sources": { + "type": "array", + "items": { + "type": "string" + }, + "description": "Specifies from which source accounts the service principal has access to the resources in this resource share." + }, + "tags": { + "type": "array", + "items": { + "$ref": "#/types/aws-native:index:Tag" + }, + "description": "Specifies one or more tags to attach to the resource share itself. It doesn't attach the tags to the resources associated with the resource share." + } + }, + "outputs": { + "allowExternalPrincipals": { + "type": "boolean", + "description": "Specifies whether principals outside your organization in AWS Organizations can be associated with a resource share. A value of `true` lets you share with individual AWS accounts that are not in your organization. A value of `false` only has meaning if your account is a member of an AWS Organization. The default value is `true`." + }, + "arn": { + "type": "string", + "description": "The Amazon Resource Name (ARN) of the resource share." + }, + "name": { + "type": "string", + "description": "Specifies the name of the resource share." + }, + "permissionArns": { + "type": "array", + "items": { + "type": "string" + }, + "description": "Specifies the [Amazon Resource Names (ARNs)](https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html) of the AWS RAM permission to associate with the resource share. If you do not specify an ARN for the permission, AWS RAM automatically attaches the default version of the permission for each resource type. You can associate only one permission with each resource type included in the resource share." + }, + "principals": { + "type": "array", + "items": { + "type": "string" + }, + "description": "Specifies the principals to associate with the resource share. The possible values are:\n\n- An AWS account ID\n\n- An Amazon Resource Name (ARN) of an organization in AWS Organizations\n\n- An ARN of an organizational unit (OU) in AWS Organizations\n\n- An ARN of an IAM role\n\n- An ARN of an IAM user" + }, + "resourceArns": { + "type": "array", + "items": { + "type": "string" + }, + "description": "Specifies a list of one or more ARNs of the resources to associate with the resource share." + }, + "sources": { + "type": "array", + "items": { + "type": "string" + }, + "description": "Specifies from which source accounts the service principal has access to the resources in this resource share." + }, + "tags": { + "type": "array", + "items": { + "$ref": "#/types/aws-native:index:Tag" + }, + "description": "Specifies one or more tags to attach to the resource share itself. It doesn't attach the tags to the resources associated with the resource share." + } + }, + "autoNamingSpec": { + "sdkName": "name" + }, + "writeOnly": [ + "permissionArns", + "principals", + "resourceArns", + "sources" + ], + "tagsProperty": "tags", + "tagsStyle": "keyValueArray", + "primaryIdentifier": [ + "arn" + ] + }, "aws-native:rbin:Rule": { "cf": "AWS::Rbin::Rule", "inputs": { @@ -82267,11 +82544,11 @@ "inputs": { "databaseInstallationFilesS3BucketName": { "type": "string", - "description": "The name of an Amazon S3 bucket that contains database installation files for your CEV. For example, a valid bucket name is `my-custom-installation-files`." + "description": "The name of an Amazon S3 bucket that contains database installation files for your CEV. For example, a valid bucket name is ``my-custom-installation-files``." }, "databaseInstallationFilesS3Prefix": { "type": "string", - "description": "The Amazon S3 directory that contains the database installation files for your CEV. For example, a valid bucket name is `123456789012/cev1`. If this setting isn't specified, no prefix is assumed." + "description": "The Amazon S3 directory that contains the database installation files for your CEV. For example, a valid bucket name is ``123456789012/cev1``. If this setting isn't specified, no prefix is assumed." }, "description": { "type": "string", @@ -82279,53 +82556,53 @@ }, "engine": { "type": "string", - "description": "The database engine to use for your custom engine version (CEV). The only supported value is `custom-oracle-ee`." + "description": "The database engine to use for your custom engine version (CEV).\n Valid values:\n + ``custom-oracle-ee`` \n + ``custom-oracle-ee-cdb``" }, "engineVersion": { "type": "string", - "description": "The name of your CEV. The name format is 19.customized_string . For example, a valid name is 19.my_cev1. This setting is required for RDS Custom for Oracle, but optional for Amazon RDS. The combination of Engine and EngineVersion is unique per customer per Region." + "description": "The name of your CEV. The name format is ``major version.customized_string``. For example, a valid CEV name is ``19.my_cev1``. This setting is required for RDS Custom for Oracle, but optional for Amazon RDS. The combination of ``Engine`` and ``EngineVersion`` is unique per customer per Region.\n *Constraints:* Minimum length is 1. Maximum length is 60.\n *Pattern:* ``^[a-z0-9_.-]{1,60$``}" }, "imageId": { "type": "string", - "description": "The identifier of Amazon Machine Image (AMI) used for CEV." + "description": "A value that indicates the ID of the AMI." }, "kmsKeyId": { "type": "string", - "description": "The AWS KMS key identifier for an encrypted CEV. A symmetric KMS key is required for RDS Custom, but optional for Amazon RDS." + "description": "The AWS KMS key identifier for an encrypted CEV. A symmetric encryption KMS key is required for RDS Custom, but optional for Amazon RDS.\n If you have an existing symmetric encryption KMS key in your account, you can use it with RDS Custom. No further action is necessary. If you don't already have a symmetric encryption KMS key in your account, follow the instructions in [Creating a symmetric encryption KMS key](https://docs.aws.amazon.com/kms/latest/developerguide/create-keys.html#create-symmetric-cmk) in the *Key Management Service Developer Guide*.\n You can choose the same symmetric encryption key when you create a CEV and a DB instance, or choose different keys." }, "manifest": { "type": "string", - "description": "The CEV manifest, which is a JSON document that describes the installation .zip files stored in Amazon S3. Specify the name/value pairs in a file or a quoted string. RDS Custom applies the patches in the order in which they are listed." + "description": "The CEV manifest, which is a JSON document that describes the installation .zip files stored in Amazon S3. Specify the name/value pairs in a file or a quoted string. RDS Custom applies the patches in the order in which they are listed.\n The following JSON fields are valid:\n + MediaImportTemplateVersion Version of the CEV manifest. The date is in the format YYYY-MM-DD. + databaseInstallationFileNames Ordered list of installation files for the CEV. + opatchFileNames Ordered list of OPatch installers used for the Oracle DB engine. + psuRuPatchFileNames The PSU and RU patches for this CEV. + OtherPatchFileNames The patches that are not in the list of PSU and RU patches. Amazon RDS applies these patches after applying the PSU and RU patches. \n For more information, see [Creating the CEV manifest](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/custom-cev.html#custom-cev.preparing.manifest) in the *Amazon RDS User Guide*." }, "sourceCustomDbEngineVersionIdentifier": { "type": "string", - "description": "The identifier of the source custom engine version." + "description": "The ARN of a CEV to use as a source for creating a new CEV. You can specify a different Amazon Machine Imagine (AMI) by using either ``Source`` or ``UseAwsProvidedLatestImage``. You can't specify a different JSON manifest when you specify ``SourceCustomDbEngineVersionIdentifier``." }, "status": { "$ref": "#/types/aws-native:rds:CustomDbEngineVersionStatus", - "description": "The availability status to be assigned to the CEV." + "description": "A value that indicates the status of a custom engine version (CEV)." }, "tags": { "type": "array", "items": { "$ref": "#/types/aws-native:index:Tag" }, - "description": "An array of key-value pairs to apply to this resource." + "description": "A list of tags. For more information, see [Tagging Amazon RDS Resources](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_Tagging.html) in the *Amazon RDS User Guide.*" }, "useAwsProvidedLatestImage": { "type": "boolean", - "description": "A value that indicates whether AWS provided latest image is applied automatically to the Custom Engine Version. By default, AWS provided latest image is applied automatically. This value is only applied on create." + "description": "Specifies whether to use the latest service-provided Amazon Machine Image (AMI) for the CEV. If you specify ``UseAwsProvidedLatestImage``, you can't also specify ``ImageId``." } }, "outputs": { "databaseInstallationFilesS3BucketName": { "type": "string", - "description": "The name of an Amazon S3 bucket that contains database installation files for your CEV. For example, a valid bucket name is `my-custom-installation-files`.", + "description": "The name of an Amazon S3 bucket that contains database installation files for your CEV. For example, a valid bucket name is ``my-custom-installation-files``.", "replaceOnChanges": true }, "databaseInstallationFilesS3Prefix": { "type": "string", - "description": "The Amazon S3 directory that contains the database installation files for your CEV. For example, a valid bucket name is `123456789012/cev1`. If this setting isn't specified, no prefix is assumed.", + "description": "The Amazon S3 directory that contains the database installation files for your CEV. For example, a valid bucket name is ``123456789012/cev1``. If this setting isn't specified, no prefix is assumed.", "replaceOnChanges": true }, "dbEngineVersionArn": { @@ -82338,48 +82615,48 @@ }, "engine": { "type": "string", - "description": "The database engine to use for your custom engine version (CEV). The only supported value is `custom-oracle-ee`.", + "description": "The database engine to use for your custom engine version (CEV).\n Valid values:\n + ``custom-oracle-ee`` \n + ``custom-oracle-ee-cdb``", "replaceOnChanges": true }, "engineVersion": { "type": "string", - "description": "The name of your CEV. The name format is 19.customized_string . For example, a valid name is 19.my_cev1. This setting is required for RDS Custom for Oracle, but optional for Amazon RDS. The combination of Engine and EngineVersion is unique per customer per Region.", + "description": "The name of your CEV. The name format is ``major version.customized_string``. For example, a valid CEV name is ``19.my_cev1``. This setting is required for RDS Custom for Oracle, but optional for Amazon RDS. The combination of ``Engine`` and ``EngineVersion`` is unique per customer per Region.\n *Constraints:* Minimum length is 1. Maximum length is 60.\n *Pattern:* ``^[a-z0-9_.-]{1,60$``}", "replaceOnChanges": true }, "imageId": { "type": "string", - "description": "The identifier of Amazon Machine Image (AMI) used for CEV.", + "description": "A value that indicates the ID of the AMI.", "replaceOnChanges": true }, "kmsKeyId": { "type": "string", - "description": "The AWS KMS key identifier for an encrypted CEV. A symmetric KMS key is required for RDS Custom, but optional for Amazon RDS.", + "description": "The AWS KMS key identifier for an encrypted CEV. A symmetric encryption KMS key is required for RDS Custom, but optional for Amazon RDS.\n If you have an existing symmetric encryption KMS key in your account, you can use it with RDS Custom. No further action is necessary. If you don't already have a symmetric encryption KMS key in your account, follow the instructions in [Creating a symmetric encryption KMS key](https://docs.aws.amazon.com/kms/latest/developerguide/create-keys.html#create-symmetric-cmk) in the *Key Management Service Developer Guide*.\n You can choose the same symmetric encryption key when you create a CEV and a DB instance, or choose different keys.", "replaceOnChanges": true }, "manifest": { "type": "string", - "description": "The CEV manifest, which is a JSON document that describes the installation .zip files stored in Amazon S3. Specify the name/value pairs in a file or a quoted string. RDS Custom applies the patches in the order in which they are listed.", + "description": "The CEV manifest, which is a JSON document that describes the installation .zip files stored in Amazon S3. Specify the name/value pairs in a file or a quoted string. RDS Custom applies the patches in the order in which they are listed.\n The following JSON fields are valid:\n + MediaImportTemplateVersion Version of the CEV manifest. The date is in the format YYYY-MM-DD. + databaseInstallationFileNames Ordered list of installation files for the CEV. + opatchFileNames Ordered list of OPatch installers used for the Oracle DB engine. + psuRuPatchFileNames The PSU and RU patches for this CEV. + OtherPatchFileNames The patches that are not in the list of PSU and RU patches. Amazon RDS applies these patches after applying the PSU and RU patches. \n For more information, see [Creating the CEV manifest](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/custom-cev.html#custom-cev.preparing.manifest) in the *Amazon RDS User Guide*.", "replaceOnChanges": true }, "sourceCustomDbEngineVersionIdentifier": { "type": "string", - "description": "The identifier of the source custom engine version.", + "description": "The ARN of a CEV to use as a source for creating a new CEV. You can specify a different Amazon Machine Imagine (AMI) by using either ``Source`` or ``UseAwsProvidedLatestImage``. You can't specify a different JSON manifest when you specify ``SourceCustomDbEngineVersionIdentifier``.", "replaceOnChanges": true }, "status": { "$ref": "#/types/aws-native:rds:CustomDbEngineVersionStatus", - "description": "The availability status to be assigned to the CEV." + "description": "A value that indicates the status of a custom engine version (CEV)." }, "tags": { "type": "array", "items": { "$ref": "#/types/aws-native:index:Tag" }, - "description": "An array of key-value pairs to apply to this resource." + "description": "A list of tags. For more information, see [Tagging Amazon RDS Resources](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_Tagging.html) in the *Amazon RDS User Guide.*" }, "useAwsProvidedLatestImage": { "type": "boolean", - "description": "A value that indicates whether AWS provided latest image is applied automatically to the Custom Engine Version. By default, AWS provided latest image is applied automatically. This value is only applied on create.", + "description": "Specifies whether to use the latest service-provided Amazon Machine Image (AMI) for the CEV. If you specify ``UseAwsProvidedLatestImage``, you can't also specify ``ImageId``.", "replaceOnChanges": true } }, @@ -86260,6 +86537,10 @@ "type": "integer", "description": "The custom port to use when connecting to a workgroup. Valid port ranges are 5431-5455 and 8191-8215. The default is 5439." }, + "pricePerformanceTarget": { + "$ref": "#/types/aws-native:redshiftserverless:WorkgroupPerformanceTarget", + "description": "A property that represents the price performance target settings for the workgroup." + }, "publiclyAccessible": { "type": "boolean", "description": "A value that specifies whether the workgroup can be accessible from a public network." @@ -86319,6 +86600,10 @@ "type": "integer", "description": "The custom port to use when connecting to a workgroup. Valid port ranges are 5431-5455 and 8191-8215. The default is 5439." }, + "pricePerformanceTarget": { + "$ref": "#/types/aws-native:redshiftserverless:WorkgroupPerformanceTarget", + "description": "A property that represents the price performance target settings for the workgroup." + }, "publiclyAccessible": { "type": "boolean", "description": "A value that specifies whether the workgroup can be accessible from a public network." @@ -90589,6 +90874,9 @@ "$ref": "#/types/aws-native:s3:BucketLoggingConfiguration", "description": "Settings that define where logs are stored." }, + "metadataTableConfiguration": { + "$ref": "#/types/aws-native:s3:BucketMetadataTableConfiguration" + }, "metricsConfigurations": { "type": "array", "items": { @@ -90699,6 +90987,9 @@ "$ref": "#/types/aws-native:s3:BucketLoggingConfiguration", "description": "Settings that define where logs are stored." }, + "metadataTableConfiguration": { + "$ref": "#/types/aws-native:s3:BucketMetadataTableConfiguration" + }, "metricsConfigurations": { "type": "array", "items": { @@ -91061,11 +91352,11 @@ }, "bucketName": { "type": "string", - "description": "Specifies a name for the bucket. The bucket name must contain only lowercase letters, numbers, and hyphens (-). A directory bucket name must be unique in the chosen Availability Zone. The bucket name must also follow the format 'bucket_base_name--az_id--x-s3' (for example, 'DOC-EXAMPLE-BUCKET--usw2-az1--x-s3'). If you don't specify a name, AWS CloudFormation generates a unique physical ID and uses that ID for the bucket name." + "description": "Specifies a name for the bucket. The bucket name must contain only lowercase letters, numbers, and hyphens (-). A directory bucket name must be unique in the chosen Availability Zone or Local Zone. The bucket name must also follow the format 'bucket_base_name--zone_id--x-s3'. The zone_id can be the ID of an Availability Zone or a Local Zone. If you don't specify a name, AWS CloudFormation generates a unique physical ID and uses that ID for the bucket name." }, "dataRedundancy": { "$ref": "#/types/aws-native:s3express:DirectoryBucketDataRedundancy", - "description": "Specifies the number of Availability Zone that's used for redundancy for the bucket." + "description": "Specifies the number of Availability Zone or Local Zone that's used for redundancy for the bucket." }, "lifecycleConfiguration": { "$ref": "#/types/aws-native:s3express:DirectoryBucketLifecycleConfiguration", @@ -91073,7 +91364,7 @@ }, "locationName": { "type": "string", - "description": "Specifies the AZ ID of the Availability Zone where the directory bucket will be created. An example AZ ID value is 'use1-az5'." + "description": "Specifies the Zone ID of the Availability Zone or Local Zone where the directory bucket will be created. An example Availability Zone ID value is 'use1-az5'." } }, "outputs": { @@ -91083,7 +91374,7 @@ }, "availabilityZoneName": { "type": "string", - "description": "Returns the code for the Availability Zone where the directory bucket was created." + "description": "Returns the code for the Availability Zone or Local Zone where the directory bucket was created. An example for the code of an Availability Zone is 'us-east-1f'." }, "bucketEncryption": { "$ref": "#/types/aws-native:s3express:DirectoryBucketBucketEncryption", @@ -91091,12 +91382,12 @@ }, "bucketName": { "type": "string", - "description": "Specifies a name for the bucket. The bucket name must contain only lowercase letters, numbers, and hyphens (-). A directory bucket name must be unique in the chosen Availability Zone. The bucket name must also follow the format 'bucket_base_name--az_id--x-s3' (for example, 'DOC-EXAMPLE-BUCKET--usw2-az1--x-s3'). If you don't specify a name, AWS CloudFormation generates a unique physical ID and uses that ID for the bucket name.", + "description": "Specifies a name for the bucket. The bucket name must contain only lowercase letters, numbers, and hyphens (-). A directory bucket name must be unique in the chosen Availability Zone or Local Zone. The bucket name must also follow the format 'bucket_base_name--zone_id--x-s3'. The zone_id can be the ID of an Availability Zone or a Local Zone. If you don't specify a name, AWS CloudFormation generates a unique physical ID and uses that ID for the bucket name.", "replaceOnChanges": true }, "dataRedundancy": { "$ref": "#/types/aws-native:s3express:DirectoryBucketDataRedundancy", - "description": "Specifies the number of Availability Zone that's used for redundancy for the bucket.", + "description": "Specifies the number of Availability Zone or Local Zone that's used for redundancy for the bucket.", "replaceOnChanges": true }, "lifecycleConfiguration": { @@ -91105,7 +91396,7 @@ }, "locationName": { "type": "string", - "description": "Specifies the AZ ID of the Availability Zone where the directory bucket will be created. An example AZ ID value is 'use1-az5'.", + "description": "Specifies the Zone ID of the Availability Zone or Local Zone where the directory bucket will be created. An example Availability Zone ID value is 'use1-az5'.", "replaceOnChanges": true } }, @@ -91492,6 +91783,74 @@ "arn" ] }, + "aws-native:s3tables:TableBucket": { + "cf": "AWS::S3Tables::TableBucket", + "inputs": { + "tableBucketName": { + "type": "string" + }, + "unreferencedFileRemoval": { + "$ref": "#/types/aws-native:s3tables:TableBucketUnreferencedFileRemoval" + } + }, + "outputs": { + "tableBucketArn": { + "type": "string" + }, + "tableBucketName": { + "type": "string", + "replaceOnChanges": true + }, + "unreferencedFileRemoval": { + "$ref": "#/types/aws-native:s3tables:TableBucketUnreferencedFileRemoval" + } + }, + "autoNamingSpec": { + "sdkName": "tableBucketName" + }, + "createOnly": [ + "tableBucketName" + ], + "irreversibleNames": { + "tableBucketArn": "TableBucketARN" + }, + "primaryIdentifier": [ + "tableBucketArn" + ] + }, + "aws-native:s3tables:TableBucketPolicy": { + "cf": "AWS::S3Tables::TableBucketPolicy", + "inputs": { + "resourcePolicy": { + "$ref": "#/types/aws-native:s3tables:TableBucketPolicyResourcePolicy" + }, + "tableBucketArn": { + "type": "string" + } + }, + "outputs": { + "resourcePolicy": { + "$ref": "#/types/aws-native:s3tables:TableBucketPolicyResourcePolicy" + }, + "tableBucketArn": { + "type": "string", + "replaceOnChanges": true + } + }, + "required": [ + "resourcePolicy", + "tableBucketArn" + ], + "createOnly": [ + "tableBucketArn" + ], + "irreversibleNames": { + "tableBucketArn": "TableBucketARN" + }, + "primaryIdentifier": [ + "tableBucketArn" + ] + }, "aws-native:sagemaker:App": { "cf": "AWS::SageMaker::App", "inputs": { @@ -112148,7 +112507,7 @@ "items": { "$ref": "#/types/aws-native:applicationautoscaling:ScalingPolicyPredictiveScalingMetricDimension" }, - "description": "The dimensions for the metric." + "description": "Describes the dimensions of the metric." }, "metricName": { "type": "string", @@ -112165,11 +112524,11 @@ "properties": { "expression": { "type": "string", - "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." }, "id": { "type": "string", - "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." }, "label": { "type": "string", @@ -112177,11 +112536,11 @@ }, "metricStat": { "$ref": "#/types/aws-native:applicationautoscaling:ScalingPolicyPredictiveScalingMetricStat", - "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." }, "returnData": { "type": "boolean", - "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``)." } } }, @@ -112236,15 +112595,15 @@ "properties": { "metric": { "$ref": "#/types/aws-native:applicationautoscaling:ScalingPolicyPredictiveScalingMetric", - "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)." }, "stat": { "type": "string", - "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``." }, "unit": { "type": "string", - "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*." } } }, @@ -112253,26 +112612,26 @@ "properties": { "maxCapacityBreachBehavior": { "type": "string", - "description": "Defines the behavior that should be applied if the forecast capacity approaches or exceeds the maximum capacity. Defaults to `HonorMaxCapacity` if not specified." + "description": "Defines the behavior that should be applied if the forecast capacity approaches or exceeds the maximum capacity. Defaults to ``HonorMaxCapacity`` if not specified." }, "maxCapacityBuffer": { "type": "integer", - "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\nRequired if the `MaxCapacityBreachBehavior` property is set to `IncreaseMaxCapacity` , and cannot be used otherwise." + "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." }, "metricSpecifications": { "type": "array", "items": { "$ref": "#/types/aws-native:applicationautoscaling:ScalingPolicyPredictiveScalingMetricSpecification" }, - "description": "This structure includes the metrics and target utilization to use for predictive scaling.\n\nThis 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." + "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." }, "mode": { "type": "string", - "description": "The predictive scaling mode. Defaults to `ForecastOnly` if not specified." + "description": "The predictive scaling mode. Defaults to ``ForecastOnly`` if not specified." }, "schedulingBufferTime": { "type": "integer", - "description": "The amount of time, in seconds, that the start time can be advanced.\n\nThe value must be less than the forecast interval duration of 3600 seconds (60 minutes). Defaults to 300 seconds if not specified." + "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." } } }, @@ -118654,7 +119013,7 @@ "properties": { "bedrockFoundationModelConfiguration": { "$ref": "#/types/aws-native:bedrock:DataSourceBedrockFoundationModelConfiguration", - "description": "Settings for a foundation model used to parse documents for a data source." + "description": "If you specify `BEDROCK_FOUNDATION_MODEL` as the parsing strategy for ingesting your data source, use this object to modify configurations for using a foundation model to parse documents." }, "parsingStrategy": { "$ref": "#/types/aws-native:bedrock:DataSourceParsingStrategy", @@ -118942,7 +119301,7 @@ }, "parsingConfiguration": { "$ref": "#/types/aws-native:bedrock:DataSourceParsingConfiguration", - "description": "A custom parser for data source documents.", + "description": "Configurations for a parser to use for parsing documents in your data source. If you exclude this field, the default parser will be used.", "replaceOnChanges": true } } @@ -120357,7 +120716,7 @@ }, "type": { "$ref": "#/types/aws-native:bedrock:GuardrailPiiEntityType", - "description": "Configure guardrail type when the PII entity is detected.\n\nThe following PIIs are used to block or mask sensitive information:\n\n- *General*\n\n- *ADDRESS*\n\nA physical address, such as \"100 Main Street, Anytown, USA\" or \"Suite #12, Building 123\". An address can include information such as the street, building, location, city, state, country, county, zip code, precinct, and neighborhood.\n- *AGE*\n\nAn individual's age, including the quantity and unit of time. For example, in the phrase \"I am 40 years old,\" Guarrails recognizes \"40 years\" as an age.\n- *NAME*\n\nAn individual's name. This entity type does not include titles, such as Dr., Mr., Mrs., or Miss. guardrails doesn't apply this entity type to names that are part of organizations or addresses. For example, guardrails recognizes the \"John Doe Organization\" as an organization, and it recognizes \"Jane Doe Street\" as an address.\n- *EMAIL*\n\nAn email address, such as *marymajor@email.com* .\n- *PHONE*\n\nA phone number. This entity type also includes fax and pager numbers.\n- *USERNAME*\n\nA user name that identifies an account, such as a login name, screen name, nick name, or handle.\n- *PASSWORD*\n\nAn alphanumeric string that is used as a password, such as \"* *very20special#pass** \".\n- *DRIVER_ID*\n\nThe number assigned to a driver's license, which is an official document permitting an individual to operate one or more motorized vehicles on a public road. A driver's license number consists of alphanumeric characters.\n- *LICENSE_PLATE*\n\nA license plate for a vehicle is issued by the state or country where the vehicle is registered. The format for passenger vehicles is typically five to eight digits, consisting of upper-case letters and numbers. The format varies depending on the location of the issuing state or country.\n- *VEHICLE_IDENTIFICATION_NUMBER*\n\nA Vehicle Identification Number (VIN) uniquely identifies a vehicle. VIN content and format are defined in the *ISO 3779* specification. Each country has specific codes and formats for VINs.\n- *Finance*\n\n- *REDIT_DEBIT_CARD_CVV*\n\nA three-digit card verification code (CVV) that is present on VISA, MasterCard, and Discover credit and debit cards. For American Express credit or debit cards, the CVV is a four-digit numeric code.\n- *CREDIT_DEBIT_CARD_EXPIRY*\n\nThe expiration date for a credit or debit card. This number is usually four digits long and is often formatted as *month/year* or *MM/YY* . Guardrails recognizes expiration dates such as *01/21* , *01/2021* , and *Jan 2021* .\n- *CREDIT_DEBIT_CARD_NUMBER*\n\nThe number for a credit or debit card. These numbers can vary from 13 to 16 digits in length. However, Amazon Comprehend also recognizes credit or debit card numbers when only the last four digits are present.\n- *PIN*\n\nA four-digit personal identification number (PIN) with which you can access your bank account.\n- *INTERNATIONAL_BANK_ACCOUNT_NUMBER*\n\nAn International Bank Account Number has specific formats in each country. For more information, see [www.iban.com/structure](https://docs.aws.amazon.com/https://www.iban.com/structure) .\n- *SWIFT_CODE*\n\nA SWIFT code is a standard format of Bank Identifier Code (BIC) used to specify a particular bank or branch. Banks use these codes for money transfers such as international wire transfers.\n\nSWIFT codes consist of eight or 11 characters. The 11-digit codes refer to specific branches, while eight-digit codes (or 11-digit codes ending in 'XXX') refer to the head or primary office.\n- *IT*\n\n- *IP_ADDRESS*\n\nAn IPv4 address, such as *198.51.100.0* .\n- *MAC_ADDRESS*\n\nA *media access control* (MAC) address is a unique identifier assigned to a network interface controller (NIC).\n- *URL*\n\nA web address, such as *www.example.com* .\n- *AWS_ACCESS_KEY*\n\nA unique identifier that's associated with a secret access key; you use the access key ID and secret access key to sign programmatic AWS requests cryptographically.\n- *AWS_SECRET_KEY*\n\nA unique identifier that's associated with an access key. You use the access key ID and secret access key to sign programmatic AWS requests cryptographically.\n- *USA specific*\n\n- *US_BANK_ACCOUNT_NUMBER*\n\nA US bank account number, which is typically 10 to 12 digits long.\n- *US_BANK_ROUTING_NUMBER*\n\nA US bank account routing number. These are typically nine digits long,\n- *US_INDIVIDUAL_TAX_IDENTIFICATION_NUMBER*\n\nA US Individual Taxpayer Identification Number (ITIN) is a nine-digit number that starts with a \"9\" and contain a \"7\" or \"8\" as the fourth digit. An ITIN can be formatted with a space or a dash after the third and forth digits.\n- *US_PASSPORT_NUMBER*\n\nA US passport number. Passport numbers range from six to nine alphanumeric characters.\n- *US_SOCIAL_SECURITY_NUMBER*\n\nA US Social Security Number (SSN) is a nine-digit number that is issued to US citizens, permanent residents, and temporary working residents.\n- *Canada specific*\n\n- *CA_HEALTH_NUMBER*\n\nA Canadian Health Service Number is a 10-digit unique identifier, required for individuals to access healthcare benefits.\n- *CA_SOCIAL_INSURANCE_NUMBER*\n\nA Canadian Social Insurance Number (SIN) is a nine-digit unique identifier, required for individuals to access government programs and benefits.\n\nThe SIN is formatted as three groups of three digits, such as *123-456-789* . A SIN can be validated through a simple check-digit process called the [Luhn algorithm](https://docs.aws.amazon.com/https://www.wikipedia.org/wiki/Luhn_algorithm) .\n- *UK Specific*\n\n- *UK_NATIONAL_HEALTH_SERVICE_NUMBER*\n\nA UK National Health Service Number is a 10-17 digit number, such as *485 777 3456* . The current system formats the 10-digit number with spaces after the third and sixth digits. The final digit is an error-detecting checksum.\n- *UK_NATIONAL_INSURANCE_NUMBER*\n\nA UK National Insurance Number (NINO) provides individuals with access to National Insurance (social security) benefits. It is also used for some purposes in the UK tax system.\n\nThe number is nine digits long and starts with two letters, followed by six numbers and one letter. A NINO can be formatted with a space or a dash after the two letters and after the second, forth, and sixth digits.\n- *UK_UNIQUE_TAXPAYER_REFERENCE_NUMBER*\n\nA UK Unique Taxpayer Reference (UTR) is a 10-digit number that identifies a taxpayer or a business.\n- *Custom*\n\n- *Regex filter* - You can use a regular expressions to define patterns for a guardrail to recognize and act upon such as serial number, booking ID etc.." + "description": "Configure guardrail type when the PII entity is detected.\n\nThe following PIIs are used to block or mask sensitive information:\n\n- *General*\n\n- *ADDRESS*\n\nA physical address, such as \"100 Main Street, Anytown, USA\" or \"Suite #12, Building 123\". An address can include information such as the street, building, location, city, state, country, county, zip code, precinct, and neighborhood.\n- *AGE*\n\nAn individual's age, including the quantity and unit of time. For example, in the phrase \"I am 40 years old,\" Guardrails recognizes \"40 years\" as an age.\n- *NAME*\n\nAn individual's name. This entity type does not include titles, such as Dr., Mr., Mrs., or Miss. guardrails doesn't apply this entity type to names that are part of organizations or addresses. For example, guardrails recognizes the \"John Doe Organization\" as an organization, and it recognizes \"Jane Doe Street\" as an address.\n- *EMAIL*\n\nAn email address, such as *marymajor@email.com* .\n- *PHONE*\n\nA phone number. This entity type also includes fax and pager numbers.\n- *USERNAME*\n\nA user name that identifies an account, such as a login name, screen name, nick name, or handle.\n- *PASSWORD*\n\nAn alphanumeric string that is used as a password, such as \"* *very20special#pass** \".\n- *DRIVER_ID*\n\nThe number assigned to a driver's license, which is an official document permitting an individual to operate one or more motorized vehicles on a public road. A driver's license number consists of alphanumeric characters.\n- *LICENSE_PLATE*\n\nA license plate for a vehicle is issued by the state or country where the vehicle is registered. The format for passenger vehicles is typically five to eight digits, consisting of upper-case letters and numbers. The format varies depending on the location of the issuing state or country.\n- *VEHICLE_IDENTIFICATION_NUMBER*\n\nA Vehicle Identification Number (VIN) uniquely identifies a vehicle. VIN content and format are defined in the *ISO 3779* specification. Each country has specific codes and formats for VINs.\n- *Finance*\n\n- *CREDIT_DEBIT_CARD_CVV*\n\nA three-digit card verification code (CVV) that is present on VISA, MasterCard, and Discover credit and debit cards. For American Express credit or debit cards, the CVV is a four-digit numeric code.\n- *CREDIT_DEBIT_CARD_EXPIRY*\n\nThe expiration date for a credit or debit card. This number is usually four digits long and is often formatted as *month/year* or *MM/YY* . Guardrails recognizes expiration dates such as *01/21* , *01/2021* , and *Jan 2021* .\n- *CREDIT_DEBIT_CARD_NUMBER*\n\nThe number for a credit or debit card. These numbers can vary from 13 to 16 digits in length. However, Amazon Comprehend also recognizes credit or debit card numbers when only the last four digits are present.\n- *PIN*\n\nA four-digit personal identification number (PIN) with which you can access your bank account.\n- *INTERNATIONAL_BANK_ACCOUNT_NUMBER*\n\nAn International Bank Account Number has specific formats in each country. For more information, see [www.iban.com/structure](https://docs.aws.amazon.com/https://www.iban.com/structure) .\n- *SWIFT_CODE*\n\nA SWIFT code is a standard format of Bank Identifier Code (BIC) used to specify a particular bank or branch. Banks use these codes for money transfers such as international wire transfers.\n\nSWIFT codes consist of eight or 11 characters. The 11-digit codes refer to specific branches, while eight-digit codes (or 11-digit codes ending in 'XXX') refer to the head or primary office.\n- *IT*\n\n- *IP_ADDRESS*\n\nAn IPv4 address, such as *198.51.100.0* .\n- *MAC_ADDRESS*\n\nA *media access control* (MAC) address is a unique identifier assigned to a network interface controller (NIC).\n- *URL*\n\nA web address, such as *www.example.com* .\n- *AWS_ACCESS_KEY*\n\nA unique identifier that's associated with a secret access key; you use the access key ID and secret access key to sign programmatic AWS requests cryptographically.\n- *AWS_SECRET_KEY*\n\nA unique identifier that's associated with an access key. You use the access key ID and secret access key to sign programmatic AWS requests cryptographically.\n- *USA specific*\n\n- *US_BANK_ACCOUNT_NUMBER*\n\nA US bank account number, which is typically 10 to 12 digits long.\n- *US_BANK_ROUTING_NUMBER*\n\nA US bank account routing number. These are typically nine digits long,\n- *US_INDIVIDUAL_TAX_IDENTIFICATION_NUMBER*\n\nA US Individual Taxpayer Identification Number (ITIN) is a nine-digit number that starts with a \"9\" and contain a \"7\" or \"8\" as the fourth digit. An ITIN can be formatted with a space or a dash after the third and forth digits.\n- *US_PASSPORT_NUMBER*\n\nA US passport number. Passport numbers range from six to nine alphanumeric characters.\n- *US_SOCIAL_SECURITY_NUMBER*\n\nA US Social Security Number (SSN) is a nine-digit number that is issued to US citizens, permanent residents, and temporary working residents.\n- *Canada specific*\n\n- *CA_HEALTH_NUMBER*\n\nA Canadian Health Service Number is a 10-digit unique identifier, required for individuals to access healthcare benefits.\n- *CA_SOCIAL_INSURANCE_NUMBER*\n\nA Canadian Social Insurance Number (SIN) is a nine-digit unique identifier, required for individuals to access government programs and benefits.\n\nThe SIN is formatted as three groups of three digits, such as *123-456-789* . A SIN can be validated through a simple check-digit process called the [Luhn algorithm](https://docs.aws.amazon.com/https://www.wikipedia.org/wiki/Luhn_algorithm) .\n- *UK Specific*\n\n- *UK_NATIONAL_HEALTH_SERVICE_NUMBER*\n\nA UK National Health Service Number is a 10-17 digit number, such as *485 777 3456* . The current system formats the 10-digit number with spaces after the third and sixth digits. The final digit is an error-detecting checksum.\n- *UK_NATIONAL_INSURANCE_NUMBER*\n\nA UK National Insurance Number (NINO) provides individuals with access to National Insurance (social security) benefits. It is also used for some purposes in the UK tax system.\n\nThe number is nine digits long and starts with two letters, followed by six numbers and one letter. A NINO can be formatted with a space or a dash after the two letters and after the second, forth, and sixth digits.\n- *UK_UNIQUE_TAXPAYER_REFERENCE_NUMBER*\n\nA UK Unique Taxpayer Reference (UTR) is a 10-digit number that identifies a taxpayer or a business.\n- *Custom*\n\n- *Regex filter* - You can use a regular expressions to define patterns for a guardrail to recognize and act upon such as serial number, booking ID etc.." } } }, @@ -126090,7 +126449,8 @@ "type": "object", "properties": { "advancedSecurityAdditionalFlows": { - "$ref": "#/types/aws-native:cognito:UserPoolAdvancedSecurityAdditionalFlows" + "$ref": "#/types/aws-native:cognito:UserPoolAdvancedSecurityAdditionalFlows", + "description": "Advanced security configuration options for additional authentication types in your user pool, including custom authentication." }, "advancedSecurityMode": { "type": "string", @@ -126119,7 +126479,8 @@ "type": "object", "properties": { "customAuthMode": { - "type": "string" + "type": "string", + "description": "The operating mode of advanced security features in custom authentication with [Custom authentication challenge Lambda triggers](https://docs.aws.amazon.com/cognito/latest/developerguide/user-pool-lambda-challenge.html) ." } } }, @@ -126377,7 +126738,8 @@ "description": "The password policy settings for a user pool, including complexity, history, and length requirements." }, "signInPolicy": { - "$ref": "#/types/aws-native:cognito:UserPoolSignInPolicy" + "$ref": "#/types/aws-native:cognito:UserPoolSignInPolicy", + "description": "The policy for allowed types of authentication in a user pool.\n\nThis data type is a request and response parameter of [CreateUserPool](https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_CreateUserPool.html) and [UpdateUserPool](https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_UpdateUserPool.html) , and a response parameter of [DescribeUserPool](https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_DescribeUserPool.html) ." } } }, @@ -126597,7 +126959,8 @@ "type": "array", "items": { "type": "string" - } + }, + "description": "The sign-in methods that a user pool supports as the first factor. You can permit users to start authentication with a standard username and password, or with other one-time password and hardware factors.\n\nSupports values of `EMAIL_OTP` , `SMS_OTP` , `WEB_AUTHN` and `PASSWORD` ," } } }, @@ -135870,7 +136233,7 @@ "properties": { "capacityReservationPreference": { "type": "string", - "description": "Indicates the instance's Capacity Reservation preferences. Possible preferences include:\n + ``capacity-reservations-only`` - The instance will only run in a Capacity Reservation or Capacity Reservation group. If capacity isn't available, the instance will fail to launch.\n + ``open`` - The instance can run in any ``open`` Capacity Reservation that has matching attributes (instance type, platform, Availability Zone, tenancy).\n + ``none`` - The instance avoids running in a Capacity Reservation even if one is available. The instance runs in On-Demand capacity." + "description": "Indicates the instance's Capacity Reservation preferences. Possible preferences include:\n + ``open`` - The instance can run in any ``open`` Capacity Reservation that has matching attributes (instance type, platform, Availability Zone).\n + ``none`` - The instance avoids running in a Capacity Reservation even if one is available. The instance runs in On-Demand capacity." }, "capacityReservationTarget": { "$ref": "#/types/aws-native:ec2:LaunchTemplateCapacityReservationTarget", @@ -135994,7 +136357,7 @@ "items": { "$ref": "#/types/aws-native:ec2:LaunchTemplateElasticInferenceAccelerator" }, - "description": "Amazon Elastic Inference is no longer available.\n An elastic inference accelerator to associate with the instance. Elastic inference accelerators are a resource you can attach to your Amazon EC2 instances to accelerate your Deep Learning (DL) inference workloads.\n You cannot specify accelerators from different generations in the same request.\n Starting April 15, 2023, AWS will not onboard new customers to Amazon Elastic Inference (EI), and will help current customers migrate their workloads to options that offer better price and performance. After April 15, 2023, new customers will not be able to launch instances with Amazon EI accelerators in Amazon SageMaker, Amazon ECS, or Amazon EC2. However, customers who have used Amazon EI at least once during the past 30-day period are considered current customers and will be able to continue using the service." + "description": "An elastic inference accelerator to associate with the instance. Elastic inference accelerators are a resource you can attach to your Amazon EC2 instances to accelerate your Deep Learning (DL) inference workloads.\n You cannot specify accelerators from different generations in the same request.\n Starting April 15, 2023, AWS will not onboard new customers to Amazon Elastic Inference (EI), and will help current customers migrate their workloads to options that offer better price and performance. After April 15, 2023, new customers will not be able to launch instances with Amazon EI accelerators in Amazon SageMaker, Amazon ECS, or Amazon EC2. However, customers who have used Amazon EI at least once during the past 30-day period are considered current customers and will be able to continue using the service." }, "enclaveOptions": { "$ref": "#/types/aws-native:ec2:LaunchTemplateEnclaveOptions", @@ -136022,7 +136385,7 @@ }, "instanceRequirements": { "$ref": "#/types/aws-native:ec2:LaunchTemplateInstanceRequirements", - "description": "The attributes for the instance types. When you specify instance attributes, Amazon EC2 will identify instance types with these attributes.\n You must specify ``VCpuCount`` and ``MemoryMiB``. All other attributes are optional. Any unspecified optional attribute is set to its default.\n When you specify multiple attributes, you get instance types that satisfy all of the specified attributes. If you specify multiple values for an attribute, you get instance types that satisfy any of the specified values.\n To limit the list of instance types from which Amazon EC2 can identify matching instance types, you can use one of the following parameters, but not both in the same request:\n + ``AllowedInstanceTypes`` - The instance types to include in the list. All other instance types are ignored, even if they match your specified attributes.\n + ``ExcludedInstanceTypes`` - The instance types to exclude from the list, even if they match your specified attributes.\n \n If you specify ``InstanceRequirements``, you can't specify ``InstanceType``.\n Attribute-based instance type selection is only supported when using Auto Scaling groups, EC2 Fleet, and Spot Fleet to launch instances. If you plan to use the launch template in the [launch instance wizard](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ec2-launch-instance-wizard.html), or with the [RunInstances](https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_RunInstances.html) API or [AWS::EC2::Instance](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-instance.html) AWS CloudFormation resource, you can't specify ``InstanceRequirements``.\n For more information, see [Specify attributes for instance type selection for EC2 Fleet or Spot Fleet](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ec2-fleet-attribute-based-instance-type-selection.html) and [Spot placement score](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/spot-placement-score.html) in the *Amazon EC2 User Guide*." + "description": "The attributes for the instance types. When you specify instance attributes, Amazon EC2 will identify instance types with these attributes.\n You must specify ``VCpuCount`` and ``MemoryMiB``. All other attributes are optional. Any unspecified optional attribute is set to its default.\n When you specify multiple attributes, you get instance types that satisfy all of the specified attributes. If you specify multiple values for an attribute, you get instance types that satisfy any of the specified values.\n To limit the list of instance types from which Amazon EC2 can identify matching instance types, you can use one of the following parameters, but not both in the same request:\n + ``AllowedInstanceTypes`` - The instance types to include in the list. All other instance types are ignored, even if they match your specified attributes.\n + ``ExcludedInstanceTypes`` - The instance types to exclude from the list, even if they match your specified attributes.\n \n If you specify ``InstanceRequirements``, you can't specify ``InstanceType``.\n Attribute-based instance type selection is only supported when using Auto Scaling groups, EC2 Fleet, and Spot Fleet to launch instances. If you plan to use the launch template in the [launch instance wizard](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ec2-launch-instance-wizard.html), or with the [RunInstances](https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_RunInstances.html) API or [AWS::EC2::Instance](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-instance.html) AWS CloudFormation resource, you can't specify ``InstanceRequirements``.\n For more information, see [Attribute-based instance type selection for EC2 Fleet](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ec2-fleet-attribute-based-instance-type-selection.html), [Attribute-based instance type selection for Spot Fleet](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/spot-fleet-attribute-based-instance-type-selection.html), and [Spot placement score](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/spot-placement-score.html) in the *Amazon EC2 User Guide*." }, "instanceType": { "type": "string", @@ -136062,9 +136425,6 @@ }, "description": "The network interfaces for the instance." }, - "networkPerformanceOptions": { - "$ref": "pulumi.json#/Any" - }, "placement": { "$ref": "#/types/aws-native:ec2:LaunchTemplatePlacement", "description": "The placement for the instance." @@ -136096,7 +136456,7 @@ "items": { "$ref": "#/types/aws-native:ec2:TagSpecification" }, - "description": "The tags to apply to resources that are created during instance launch.\n To tag the launch template itself, use [TagSpecifications](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-launchtemplate.html#cfn-ec2-launchtemplate-tagspecifications)." + "description": "The tags to apply to the resources that are created during instance launch.\n To tag a resource after it has been created, see [CreateTags](https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_CreateTags.html).\n To tag the launch template itself, use [TagSpecifications](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-launchtemplate.html#cfn-ec2-launchtemplate-tagspecifications)." }, "userData": { "type": "string", @@ -136121,7 +136481,7 @@ }, "kmsKeyId": { "type": "string", - "description": "Identifier (key ID, key alias, key ARN, or alias ARN) of the customer managed KMS key to use for EBS encryption." + "description": "The ARN of the symmetric KMSlong (KMS) CMK used for encryption." }, "snapshotId": { "type": "string", @@ -136259,7 +136619,7 @@ "items": { "type": "string" }, - "description": "The accelerator types that must be on the instance type.\n + For instance types with GPU accelerators, specify ``gpu``.\n + For instance types with FPGA accelerators, specify ``fpga``.\n \n Default: Any accelerator type" + "description": "The accelerator types that must be on the instance type.\n + For instance types with GPU accelerators, specify ``gpu``.\n + For instance types with FPGA accelerators, specify ``fpga``.\n + For instance types with inference accelerators, specify ``inference``.\n \n Default: Any accelerator type" }, "allowedInstanceTypes": { "type": "array", @@ -136278,7 +136638,7 @@ }, "baselinePerformanceFactors": { "$ref": "#/types/aws-native:ec2:LaunchTemplateBaselinePerformanceFactors", - "description": "The baseline performance to consider, using an instance family as a baseline reference. The instance family establishes the lowest acceptable level of performance. Amazon EC2 uses this baseline to guide instance type selection, but there is no guarantee that the selected instance types will always exceed the baseline for every application. Currently, this parameter only supports CPU performance as a baseline performance factor. For more information, see [Performance protection](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ec2-fleet-attribute-based-instance-type-selection.html#ec2fleet-abis-performance-protection) in the *Amazon EC2 User Guide*." + "description": "The baseline performance to consider, using an instance family as a baseline reference. The instance family establishes the lowest acceptable level of performance. Amazon EC2 uses this baseline to guide instance type selection, but there is no guarantee that the selected instance types will always exceed the baseline for every application. Currently, this parameter only supports CPU performance as a baseline performance factor. For more information, see [Performance protection](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ec2-fleet-attribute-based-instance-type-selection.html#ec2fleet-abis-performance-protection) in the *Amazon EC2 User Guide* ." }, "burstablePerformance": { "type": "string", @@ -136289,7 +136649,7 @@ "items": { "type": "string" }, - "description": "The CPU manufacturers to include.\n + For instance types with Intel CPUs, specify ``intel``.\n + For instance types with AMD CPUs, specify ``amd``.\n + For instance types with AWS CPUs, specify ``amazon-web-services``.\n + For instance types with Apple CPUs, specify ``apple``.\n \n Don't confuse the CPU manufacturer with the CPU architecture. Instances will be launched with a compatible CPU architecture based on the Amazon Machine Image (AMI) that you specify in your launch template.\n Default: Any manufacturer" + "description": "The CPU manufacturers to include.\n + For instance types with Intel CPUs, specify ``intel``.\n + For instance types with AMD CPUs, specify ``amd``.\n + For instance types with AWS CPUs, specify ``amazon-web-services``.\n \n Don't confuse the CPU manufacturer with the CPU architecture. Instances will be launched with a compatible CPU architecture based on the Amazon Machine Image (AMI) that you specify in your launch template.\n Default: Any manufacturer" }, "excludedInstanceTypes": { "type": "array", @@ -136519,7 +136879,7 @@ }, "interfaceType": { "type": "string", - "description": "The type of network interface. To create an Elastic Fabric Adapter (EFA), specify ``efa`` or ``efa``. For more information, see [Elastic Fabric Adapter](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/efa.html) in the *Amazon EC2 User Guide*.\n If you are not creating an EFA, specify ``interface`` or omit this parameter.\n If you specify ``efa-only``, do not assign any IP addresses to the network interface. EFA-only network interfaces do not support IP addresses.\n Valid values: ``interface`` | ``efa`` | ``efa-only``" + "description": "The type of network interface. To create an Elastic Fabric Adapter (EFA), specify ``efa``. For more information, see [Elastic Fabric Adapter](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/efa.html) in the *Amazon EC2 User Guide*.\n If you are not creating an EFA, specify ``interface`` or omit this parameter.\n Valid values: ``interface`` | ``efa``" }, "ipv4PrefixCount": { "type": "integer", @@ -136678,7 +137038,8 @@ "type": "object", "properties": { "instanceFamily": { - "type": "string" + "type": "string", + "description": "The instance family to refer. Ensure that you specify the correct family name. For example, C6i and C6g are valid values, but C6 is not." } } }, @@ -138115,7 +138476,7 @@ }, "secondaryPrivateIpAddressCount": { "type": "integer", - "description": "The number of secondary private IPv4 addresses. You can't specify this option and specify more than one private IP address using the private IP addresses option. You cannot specify this option if you're launching more than one instance in a [RunInstances](https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_RunInstances.html) request." + "description": "The number of secondary private IPv4 addresses. You can’t specify this parameter and also specify a secondary private IP address using the `PrivateIpAddress` parameter." }, "subnetId": { "type": "string", @@ -140573,7 +140934,7 @@ }, "versionConsistency": { "$ref": "#/types/aws-native:ecs:TaskDefinitionContainerDefinitionVersionConsistency", - "description": "Specifies whether Amazon ECS will resolve the container image tag provided in the container definition to an image digest. By default, the value is `enabled` . If you set the value for a container as `disabled` , Amazon ECS will not resolve the provided container image tag to a digest and will use the original image URI specified in the container definition for deployment. For more information about container image resolution, see [Container image resolution](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/deployment-type-ecs.html#deployment-container-image-stability) in the *Amazon ECS Developer Guide* ." + "description": "Specifies whether Amazon ECS will resolve the container image tag provided in the container definition to an image digest. By default, the value is ``enabled``. If you set the value for a container as ``disabled``, Amazon ECS will not resolve the provided container image tag to a digest and will use the original image URI specified in the container definition for deployment. For more information about container image resolution, see [Container image resolution](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/deployment-type-ecs.html#deployment-container-image-stability) in the *Amazon ECS Developer Guide*." }, "volumesFrom": { "type": "array", @@ -144065,7 +144426,8 @@ "description": "The authorization parameters for Basic authorization." }, "connectivityParameters": { - "$ref": "#/types/aws-native:events:ConnectionConnectivityParameters" + "$ref": "#/types/aws-native:events:ConnectionConnectivityParameters", + "description": "For private OAuth authentication endpoints. The parameters EventBridge uses to authenticate against the endpoint.\n\nFor more information, see [Authorization methods for connections](https://docs.aws.amazon.com/eventbridge/latest/userguide/eb-target-connection-auth.html) in the **Amazon EventBridge User Guide** ." }, "invocationHttpParameters": { "$ref": "#/types/aws-native:events:ConnectionHttpParameters", @@ -144113,7 +144475,8 @@ "type": "object", "properties": { "resourceParameters": { - "$ref": "#/types/aws-native:events:ConnectionResourceParameters" + "$ref": "#/types/aws-native:events:ConnectionResourceParameters", + "description": "The parameters for EventBridge to use when invoking the resource endpoint." } } }, @@ -144188,10 +144551,12 @@ "type": "object", "properties": { "resourceAssociationArn": { - "type": "string" + "type": "string", + "description": "For connections to private APIs, the Amazon Resource Name (ARN) of the resource association EventBridge created between the connection and the private API's resource configuration.\n\n\u003e The value of this property is set by EventBridge . Any value you specify in your template is ignored." }, "resourceConfigurationArn": { - "type": "string" + "type": "string", + "description": "The Amazon Resource Name (ARN) of the Amazon VPC Lattice resource configuration for the resource endpoint." } } }, @@ -144284,7 +144649,8 @@ "type": "object", "properties": { "resourceParameters": { - "$ref": "#/types/aws-native:events:ConnectionResourceParameters" + "$ref": "#/types/aws-native:events:ConnectionResourceParameters", + "description": "The parameters for EventBridge to use when invoking the resource endpoint." } } }, @@ -151053,7 +151419,8 @@ "type": "array", "items": { "type": "string" - } + }, + "description": "The list of `LINKED_ACCOUNT` IDs where charges are included within the invoice unit." } } }, @@ -151272,6 +151639,80 @@ "aws-native:iot:CertificateStatus": { "type": "string" }, + "aws-native:iot:CommandNamespace": { + "type": "string" + }, + "aws-native:iot:CommandParameter": { + "type": "object", + "properties": { + "defaultValue": { + "$ref": "#/types/aws-native:iot:CommandParameterValue" + }, + "description": { + "type": "string" + }, + "name": { + "type": "string" + }, + "value": { + "$ref": "#/types/aws-native:iot:CommandParameterValue" + } + } + }, + "aws-native:iot:CommandParameterValue": { + "type": "object", + "properties": { + "b": { + "type": "boolean" + }, + "bin": { + "type": "string" + }, + "d": { + "type": "number" + }, + "i": { + "type": "integer" + }, + "l": { + "type": "string" + }, + "s": { + "type": "string" + }, + "ul": { + "type": "string" + } + }, + "irreversibleNames": { + "bin": "BIN", + "ul": "UL" + } + }, + "aws-native:iot:CommandPayload": { + "type": "object", + "properties": { + "content": { + "type": "string" + }, + "contentType": { + "type": "string" + } + } + }, + "aws-native:iot:CommandTag": { + "type": "object", + "properties": { + "key": { + "type": "string", + "description": "The tag's key." + }, + "value": { + "type": "string", + "description": "The tag's value." + } + } + }, "aws-native:iot:CustomMetricMetricType": { "type": "string" }, @@ -209800,6 +210241,19 @@ } } }, + "aws-native:ram:ResourceShareTag": { + "type": "object", + "properties": { + "key": { + "type": "string", + "description": "The key name of the tag. You can specify a value that is 1 to 128 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -." + }, + "value": { + "type": "string", + "description": "The value for the tag. You can specify a value that is 0 to 256 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -." + } + } + }, "aws-native:rbin:RuleResourceTag": { "type": "object", "properties": { @@ -209869,11 +210323,11 @@ "properties": { "key": { "type": "string", - "description": "The key name of the tag. You can specify a value that is 1 to 128 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -." + "description": "A key is the required name of the tag. The string value can be from 1 to 128 Unicode characters in length and can't be prefixed with ``aws:`` or ``rds:``. The string can only contain only the set of Unicode letters, digits, white-space, '_', '.', ':', '/', '=', '+', '-', '@' (Java regex: \"^([\\\\p{L}\\\\p{Z}\\\\p{N}_.:/=+\\\\-@]*)$\")." }, "value": { "type": "string", - "description": "The value for the tag. You can specify a value that is 0 to 256 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -." + "description": "A value is the optional value of the tag. The string value can be from 1 to 256 Unicode characters in length and can't be prefixed with ``aws:`` or ``rds:``. The string can only contain only the set of Unicode letters, digits, white-space, '_', '.', ':', '/', '=', '+', '-', '@' (Java regex: \"^([\\\\p{L}\\\\p{Z}\\\\p{N}_.:/=+\\\\-@]*)$\")." } } }, @@ -210661,6 +211115,9 @@ "type": "string", "description": "The namespace the workgroup is associated with." }, + "pricePerformanceTarget": { + "$ref": "#/types/aws-native:redshiftserverless:WorkgroupPerformanceTarget" + }, "publiclyAccessible": { "type": "boolean", "description": "A value that specifies whether the workgroup can be accessible from a public network." @@ -210751,6 +211208,20 @@ } } }, + "aws-native:redshiftserverless:WorkgroupPerformanceTarget": { + "type": "object", + "properties": { + "level": { + "type": "integer" + }, + "status": { + "$ref": "#/types/aws-native:redshiftserverless:WorkgroupPerformanceTargetStatus" + } + } + }, + "aws-native:redshiftserverless:WorkgroupPerformanceTargetStatus": { + "type": "string" + }, "aws-native:redshiftserverless:WorkgroupStatus": { "type": "string" }, @@ -212880,6 +213351,38 @@ } } }, + "aws-native:s3:BucketMetadataTableConfiguration": { + "type": "object", + "properties": { + "error": { + "$ref": "#/types/aws-native:s3:BucketMetadataTableError", + "description": "Returns the \u003ccode\u003eError\u003c/code\u003e value of the GetBucketMetadataTableConfiguration response." + }, + "s3TablesDestination": { + "$ref": "#/types/aws-native:s3:BucketS3TablesDestination" + }, + "status": { + "type": "string", + "description": "Returns the \u003ccode\u003eStatus\u003c/code\u003e value of the \u003ccode\u003eGetBucketMetadataTableConfigurationResult\u003c/code\u003e response. This value indicates the status of the metadata table. The status values are:\u003cbr/\u003e\u003ccode\u003eCREATING\u003c/code\u003e - The metadata table is in the process of being created in the specified table bucket.\u003cbr/\u003e\u003ccode\u003eACTIVE\u003c/code\u003e - The metadata table has been created successfully and records are being delivered to the table.\u003cbr/\u003e\u003ccode\u003eFAILED\u003c/code\u003e - Amazon S3 is unable to create the metadata table, or Amazon S3 is unable to deliver records." + } + }, + "irreversibleNames": { + "s3TablesDestination": "S3TablesDestination" + } + }, + "aws-native:s3:BucketMetadataTableError": { + "type": "object", + "properties": { + "errorCode": { + "type": "string", + "description": "If the \u003ccode\u003eCreateBucketMetadataTableConfiguration\u003c/code\u003e request succeeds, but S3 Metadata was unable to create the table, this structure contains the error code. The possible error codes and error messages are as follows:\u003cbr/\u003e\u003ccode\u003eAccessDeniedCreatingResources\u003c/code\u003e - You don't have sufficient permissions to create the required resources. Make sure that you have \u003ccode\u003es3tables:CreateNamespace\u003c/code\u003e, \u003ccode\u003es3tables:CreateTable\u003c/code\u003e, \u003ccode\u003es3tables:GetTable\u003c/code\u003e and \u003ccode\u003es3tables:PutTablePolicy\u003c/code\u003e permissions, and then try again. To create a new metadata table, you must delete the metadata configuration for this bucket, and then create a new metadata configuration.\u003cbr/\u003e\u003ccode\u003eAccessDeniedWritingToTable\u003c/code\u003e - Unable to write to the metadata table because of missing resource permissions. To fix the resource policy, Amazon S3 needs to create a new metadata table. To create a new metadata table, you must delete the metadata configuration for this bucket, and then create a new metadata configuration.\u003cbr/\u003e\u003ccode\u003eDestinationTableNotFound\u003c/code\u003e - The destination table doesn't exist. To create a new metadata table, you must delete the metadata configuration for this bucket, and then create a new metadata configuration.\u003cbr/\u003e\u003ccode\u003eServerInternalError\u003c/code\u003e - An internal error has occurred. To create a new metadata table, you must delete the metadata configuration for this bucket, and then create a new metadata configuration.\u003cbr/\u003e\u003ccode\u003eTableAlreadyExists\u003c/code\u003e - The table that you specified already exists in the table bucket's namespace. Specify a different table name. To create a new metadata table, you must delete the metadata configuration for this bucket, and then create a new metadata configuration.\u003cbr/\u003e\u003ccode\u003eTableBucketNotFound\u003c/code\u003e - The table bucket that you specified doesn't exist in this AWS Region and account. Create or choose a different table bucket. To create a new metadata table, you must delete the metadata configuration for this bucket, and then create a new metadata configuration." + }, + "errorMessage": { + "type": "string", + "description": "If the \u003ccode\u003eCreateBucketMetadataTableConfiguration\u003c/code\u003e request succeeds, but S3 Metadata was unable to create the table, this structure contains the error code. The possible error codes and error messages are as follows:\u003cbr/\u003e\u003ccode\u003eAccessDeniedCreatingResources\u003c/code\u003e - You don't have sufficient permissions to create the required resources. Make sure that you have \u003ccode\u003es3tables:CreateNamespace\u003c/code\u003e, \u003ccode\u003es3tables:CreateTable\u003c/code\u003e, \u003ccode\u003es3tables:GetTable\u003c/code\u003e and \u003ccode\u003es3tables:PutTablePolicy\u003c/code\u003e permissions, and then try again. To create a new metadata table, you must delete the metadata configuration for this bucket, and then create a new metadata configuration.\u003cbr/\u003e\u003ccode\u003eAccessDeniedWritingToTable\u003c/code\u003e - Unable to write to the metadata table because of missing resource permissions. To fix the resource policy, Amazon S3 needs to create a new metadata table. To create a new metadata table, you must delete the metadata configuration for this bucket, and then create a new metadata configuration.\u003cbr/\u003e\u003ccode\u003eDestinationTableNotFound\u003c/code\u003e - The destination table doesn't exist. To create a new metadata table, you must delete the metadata configuration for this bucket, and then create a new metadata configuration.\u003cbr/\u003e\u003ccode\u003eServerInternalError\u003c/code\u003e - An internal error has occurred. To create a new metadata table, you must delete the metadata configuration for this bucket, and then create a new metadata configuration.\u003cbr/\u003e\u003ccode\u003eTableAlreadyExists\u003c/code\u003e - The table that you specified already exists in the table bucket's namespace. Specify a different table name. To create a new metadata table, you must delete the metadata configuration for this bucket, and then create a new metadata configuration.\u003cbr/\u003e\u003ccode\u003eTableBucketNotFound\u003c/code\u003e - The table bucket that you specified doesn't exist in this AWS Region and account. Create or choose a different table bucket. To create a new metadata table, you must delete the metadata configuration for this bucket, and then create a new metadata configuration." + } + } + }, "aws-native:s3:BucketMetrics": { "type": "object", "properties": { @@ -213404,6 +213907,27 @@ } } }, + "aws-native:s3:BucketS3TablesDestination": { + "type": "object", + "properties": { + "tableArn": { + "type": "string", + "description": "The Amazon Resource Name (ARN) for the metadata table in the metadata table configuration. The specified metadata table name must be unique within the \u003ccode\u003eaws_s3_metadata\u003c/code\u003e namespace in the destination table bucket." + }, + "tableBucketArn": { + "type": "string", + "description": "The Amazon Resource Name (ARN) for the table bucket that's specified as the destination in the metadata table configuration. The destination table bucket must be in the same Region and AWS account as the general purpose bucket." + }, + "tableName": { + "type": "string", + "description": "The name for the metadata table in your metadata table configuration. The specified metadata table name must be unique within the \u003ccode\u003eaws_s3_metadata\u003c/code\u003e namespace in the destination table bucket." + }, + "tableNamespace": { + "type": "string", + "description": "The table bucket namespace for the metadata table in your metadata table configuration. This value is always \u003ccode\u003eaws_s3_metadata\u003c/code\u003e." + } + } + }, "aws-native:s3:BucketServerSideEncryptionByDefault": { "type": "object", "properties": { @@ -214460,6 +214984,29 @@ "aws-native:s3outposts:EndpointStatus": { "type": "string" }, + "aws-native:s3tables:TableBucketPolicyResourcePolicy": { + "type": "object" + }, + "aws-native:s3tables:TableBucketUnreferencedFileRemoval": { + "type": "object", + "properties": { + "noncurrentDays": { + "type": "integer", + "description": "S3 permanently deletes noncurrent objects after the number of days specified by the NoncurrentDays property." + }, + "status": { + "$ref": "#/types/aws-native:s3tables:TableBucketUnreferencedFileRemovalStatus", + "description": "Indicates whether the Unreferenced File Removal maintenance action is enabled." + }, + "unreferencedDays": { + "type": "integer", + "description": "For any object not referenced by your table and older than the UnreferencedDays property, S3 creates a delete marker and marks the object version as noncurrent." + } + } + }, + "aws-native:s3tables:TableBucketUnreferencedFileRemovalStatus": { + "type": "string" + }, "aws-native:sagemaker:AppImageConfigCodeEditorAppImageConfig": { "type": "object", "properties": { @@ -234593,6 +235140,12 @@ "certificateProviderName" ] }, + "aws-native:iot:getCommand": { + "cf": "AWS::IoT::Command", + "ids": [ + "commandId" + ] + }, "aws-native:iot:getCustomMetric": { "cf": "AWS::IoT::CustomMetric", "ids": [ @@ -236254,6 +236807,12 @@ "arn" ] }, + "aws-native:ram:getResourceShare": { + "cf": "AWS::RAM::ResourceShare", + "ids": [ + "arn" + ] + }, "aws-native:rbin:getRule": { "cf": "AWS::Rbin::Rule", "ids": [ @@ -236808,6 +237367,18 @@ "arn" ] }, + "aws-native:s3tables:getTableBucket": { + "cf": "AWS::S3Tables::TableBucket", + "ids": [ + "tableBucketArn" + ] + }, + "aws-native:s3tables:getTableBucketPolicy": { + "cf": "AWS::S3Tables::TableBucketPolicy", + "ids": [ + "tableBucketArn" + ] + }, "aws-native:sagemaker:getApp": { "cf": "AWS::SageMaker::App", "ids": [ diff --git a/provider/cmd/pulumi-resource-aws-native/schema.json b/provider/cmd/pulumi-resource-aws-native/schema.json index a676275f55..3f76d20c76 100644 --- a/provider/cmd/pulumi-resource-aws-native/schema.json +++ b/provider/cmd/pulumi-resource-aws-native/schema.json @@ -205,6 +205,7 @@ "s3express": "S3Express", "s3objectlambda": "S3ObjectLambda", "s3outposts": "S3Outposts", + "s3tables": "S3Tables", "sagemaker": "SageMaker", "scheduler": "Scheduler", "secretsmanager": "SecretsManager", @@ -7871,6 +7872,7 @@ ] }, "aws-native:applicationautoscaling:ScalingPolicyPredictiveScalingCustomizedCapacityMetric": { + "description": "Represents a CloudWatch metric of your choosing for a predictive scaling policy.", "properties": { "metricDataQueries": { "type": "array", @@ -7886,6 +7888,7 @@ ] }, "aws-native:applicationautoscaling:ScalingPolicyPredictiveScalingCustomizedLoadMetric": { + "description": "The customized load metric specification.", "properties": { "metricDataQueries": { "type": "array", @@ -7900,6 +7903,7 @@ ] }, "aws-native:applicationautoscaling:ScalingPolicyPredictiveScalingCustomizedScalingMetric": { + "description": "One or more metric data queries to provide data points for a metric specification.", "properties": { "metricDataQueries": { "type": "array", @@ -7915,13 +7919,14 @@ ] }, "aws-native:applicationautoscaling:ScalingPolicyPredictiveScalingMetric": { + "description": "Describes the scaling metric.", "properties": { "dimensions": { "type": "array", "items": { "$ref": "#/types/aws-native:applicationautoscaling:ScalingPolicyPredictiveScalingMetricDimension" }, - "description": "The dimensions for the metric." + "description": "Describes the dimensions of the metric." }, "metricName": { "type": "string", @@ -7935,14 +7940,15 @@ "type": "object" }, "aws-native:applicationautoscaling:ScalingPolicyPredictiveScalingMetricDataQuery": { + "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.", "properties": { "expression": { "type": "string", - "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." }, "id": { "type": "string", - "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." }, "label": { "type": "string", @@ -7950,16 +7956,17 @@ }, "metricStat": { "$ref": "#/types/aws-native:applicationautoscaling:ScalingPolicyPredictiveScalingMetricStat", - "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." }, "returnData": { "type": "boolean", - "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": "object" }, "aws-native:applicationautoscaling:ScalingPolicyPredictiveScalingMetricDimension": { + "description": "Describes the dimension of a metric.", "properties": { "name": { "type": "string", @@ -7973,6 +7980,7 @@ "type": "object" }, "aws-native:applicationautoscaling:ScalingPolicyPredictiveScalingMetricSpecification": { + "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.", "properties": { "customizedCapacityMetricSpecification": { "$ref": "#/types/aws-native:applicationautoscaling:ScalingPolicyPredictiveScalingCustomizedCapacityMetric", @@ -8009,46 +8017,48 @@ ] }, "aws-native:applicationautoscaling:ScalingPolicyPredictiveScalingMetricStat": { + "description": "This structure defines the CloudWatch metric to return, along with the statistic and unit.", "properties": { "metric": { "$ref": "#/types/aws-native:applicationautoscaling:ScalingPolicyPredictiveScalingMetric", - "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)." }, "stat": { "type": "string", - "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``." }, "unit": { "type": "string", - "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": "object" }, "aws-native:applicationautoscaling:ScalingPolicyPredictiveScalingPolicyConfiguration": { + "description": "Represents a predictive scaling policy configuration.", "properties": { "maxCapacityBreachBehavior": { "type": "string", - "description": "Defines the behavior that should be applied if the forecast capacity approaches or exceeds the maximum capacity. Defaults to `HonorMaxCapacity` if not specified." + "description": "Defines the behavior that should be applied if the forecast capacity approaches or exceeds the maximum capacity. Defaults to ``HonorMaxCapacity`` if not specified." }, "maxCapacityBuffer": { "type": "integer", - "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\nRequired if the `MaxCapacityBreachBehavior` property is set to `IncreaseMaxCapacity` , and cannot be used otherwise." + "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." }, "metricSpecifications": { "type": "array", "items": { "$ref": "#/types/aws-native:applicationautoscaling:ScalingPolicyPredictiveScalingMetricSpecification" }, - "description": "This structure includes the metrics and target utilization to use for predictive scaling.\n\nThis 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." + "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." }, "mode": { "type": "string", - "description": "The predictive scaling mode. Defaults to `ForecastOnly` if not specified." + "description": "The predictive scaling mode. Defaults to ``ForecastOnly`` if not specified." }, "schedulingBufferTime": { "type": "integer", - "description": "The amount of time, in seconds, that the start time can be advanced.\n\nThe value must be less than the forecast interval duration of 3600 seconds (60 minutes). Defaults to 300 seconds if not specified." + "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": "object", @@ -8057,6 +8067,7 @@ ] }, "aws-native:applicationautoscaling:ScalingPolicyPredictiveScalingPredefinedLoadMetric": { + "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.", "properties": { "predefinedMetricType": { "type": "string", @@ -8073,6 +8084,7 @@ ] }, "aws-native:applicationautoscaling:ScalingPolicyPredictiveScalingPredefinedMetricPair": { + "description": "Represents a metric pair for a predictive scaling policy.", "properties": { "predefinedMetricType": { "type": "string", @@ -8089,6 +8101,7 @@ ] }, "aws-native:applicationautoscaling:ScalingPolicyPredictiveScalingPredefinedScalingMetric": { + "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.", "properties": { "predefinedMetricType": { "type": "string", @@ -18997,7 +19010,7 @@ "properties": { "bedrockFoundationModelConfiguration": { "$ref": "#/types/aws-native:bedrock:DataSourceBedrockFoundationModelConfiguration", - "description": "Settings for a foundation model used to parse documents for a data source." + "description": "If you specify `BEDROCK_FOUNDATION_MODEL` as the parsing strategy for ingesting your data source, use this object to modify configurations for using a foundation model to parse documents." }, "parsingStrategy": { "$ref": "#/types/aws-native:bedrock:DataSourceParsingStrategy", @@ -19431,7 +19444,7 @@ }, "parsingConfiguration": { "$ref": "#/types/aws-native:bedrock:DataSourceParsingConfiguration", - "description": "A custom parser for data source documents.", + "description": "Configurations for a parser to use for parsing documents in your data source. If you exclude this field, the default parser will be used.", "replaceOnChanges": true } }, @@ -21529,7 +21542,7 @@ }, "type": { "$ref": "#/types/aws-native:bedrock:GuardrailPiiEntityType", - "description": "Configure guardrail type when the PII entity is detected.\n\nThe following PIIs are used to block or mask sensitive information:\n\n- *General*\n\n- *ADDRESS*\n\nA physical address, such as \"100 Main Street, Anytown, USA\" or \"Suite #12, Building 123\". An address can include information such as the street, building, location, city, state, country, county, zip code, precinct, and neighborhood.\n- *AGE*\n\nAn individual's age, including the quantity and unit of time. For example, in the phrase \"I am 40 years old,\" Guarrails recognizes \"40 years\" as an age.\n- *NAME*\n\nAn individual's name. This entity type does not include titles, such as Dr., Mr., Mrs., or Miss. guardrails doesn't apply this entity type to names that are part of organizations or addresses. For example, guardrails recognizes the \"John Doe Organization\" as an organization, and it recognizes \"Jane Doe Street\" as an address.\n- *EMAIL*\n\nAn email address, such as *marymajor@email.com* .\n- *PHONE*\n\nA phone number. This entity type also includes fax and pager numbers.\n- *USERNAME*\n\nA user name that identifies an account, such as a login name, screen name, nick name, or handle.\n- *PASSWORD*\n\nAn alphanumeric string that is used as a password, such as \"* *very20special#pass** \".\n- *DRIVER_ID*\n\nThe number assigned to a driver's license, which is an official document permitting an individual to operate one or more motorized vehicles on a public road. A driver's license number consists of alphanumeric characters.\n- *LICENSE_PLATE*\n\nA license plate for a vehicle is issued by the state or country where the vehicle is registered. The format for passenger vehicles is typically five to eight digits, consisting of upper-case letters and numbers. The format varies depending on the location of the issuing state or country.\n- *VEHICLE_IDENTIFICATION_NUMBER*\n\nA Vehicle Identification Number (VIN) uniquely identifies a vehicle. VIN content and format are defined in the *ISO 3779* specification. Each country has specific codes and formats for VINs.\n- *Finance*\n\n- *REDIT_DEBIT_CARD_CVV*\n\nA three-digit card verification code (CVV) that is present on VISA, MasterCard, and Discover credit and debit cards. For American Express credit or debit cards, the CVV is a four-digit numeric code.\n- *CREDIT_DEBIT_CARD_EXPIRY*\n\nThe expiration date for a credit or debit card. This number is usually four digits long and is often formatted as *month/year* or *MM/YY* . Guardrails recognizes expiration dates such as *01/21* , *01/2021* , and *Jan 2021* .\n- *CREDIT_DEBIT_CARD_NUMBER*\n\nThe number for a credit or debit card. These numbers can vary from 13 to 16 digits in length. However, Amazon Comprehend also recognizes credit or debit card numbers when only the last four digits are present.\n- *PIN*\n\nA four-digit personal identification number (PIN) with which you can access your bank account.\n- *INTERNATIONAL_BANK_ACCOUNT_NUMBER*\n\nAn International Bank Account Number has specific formats in each country. For more information, see [www.iban.com/structure](https://docs.aws.amazon.com/https://www.iban.com/structure) .\n- *SWIFT_CODE*\n\nA SWIFT code is a standard format of Bank Identifier Code (BIC) used to specify a particular bank or branch. Banks use these codes for money transfers such as international wire transfers.\n\nSWIFT codes consist of eight or 11 characters. The 11-digit codes refer to specific branches, while eight-digit codes (or 11-digit codes ending in 'XXX') refer to the head or primary office.\n- *IT*\n\n- *IP_ADDRESS*\n\nAn IPv4 address, such as *198.51.100.0* .\n- *MAC_ADDRESS*\n\nA *media access control* (MAC) address is a unique identifier assigned to a network interface controller (NIC).\n- *URL*\n\nA web address, such as *www.example.com* .\n- *AWS_ACCESS_KEY*\n\nA unique identifier that's associated with a secret access key; you use the access key ID and secret access key to sign programmatic AWS requests cryptographically.\n- *AWS_SECRET_KEY*\n\nA unique identifier that's associated with an access key. You use the access key ID and secret access key to sign programmatic AWS requests cryptographically.\n- *USA specific*\n\n- *US_BANK_ACCOUNT_NUMBER*\n\nA US bank account number, which is typically 10 to 12 digits long.\n- *US_BANK_ROUTING_NUMBER*\n\nA US bank account routing number. These are typically nine digits long,\n- *US_INDIVIDUAL_TAX_IDENTIFICATION_NUMBER*\n\nA US Individual Taxpayer Identification Number (ITIN) is a nine-digit number that starts with a \"9\" and contain a \"7\" or \"8\" as the fourth digit. An ITIN can be formatted with a space or a dash after the third and forth digits.\n- *US_PASSPORT_NUMBER*\n\nA US passport number. Passport numbers range from six to nine alphanumeric characters.\n- *US_SOCIAL_SECURITY_NUMBER*\n\nA US Social Security Number (SSN) is a nine-digit number that is issued to US citizens, permanent residents, and temporary working residents.\n- *Canada specific*\n\n- *CA_HEALTH_NUMBER*\n\nA Canadian Health Service Number is a 10-digit unique identifier, required for individuals to access healthcare benefits.\n- *CA_SOCIAL_INSURANCE_NUMBER*\n\nA Canadian Social Insurance Number (SIN) is a nine-digit unique identifier, required for individuals to access government programs and benefits.\n\nThe SIN is formatted as three groups of three digits, such as *123-456-789* . A SIN can be validated through a simple check-digit process called the [Luhn algorithm](https://docs.aws.amazon.com/https://www.wikipedia.org/wiki/Luhn_algorithm) .\n- *UK Specific*\n\n- *UK_NATIONAL_HEALTH_SERVICE_NUMBER*\n\nA UK National Health Service Number is a 10-17 digit number, such as *485 777 3456* . The current system formats the 10-digit number with spaces after the third and sixth digits. The final digit is an error-detecting checksum.\n- *UK_NATIONAL_INSURANCE_NUMBER*\n\nA UK National Insurance Number (NINO) provides individuals with access to National Insurance (social security) benefits. It is also used for some purposes in the UK tax system.\n\nThe number is nine digits long and starts with two letters, followed by six numbers and one letter. A NINO can be formatted with a space or a dash after the two letters and after the second, forth, and sixth digits.\n- *UK_UNIQUE_TAXPAYER_REFERENCE_NUMBER*\n\nA UK Unique Taxpayer Reference (UTR) is a 10-digit number that identifies a taxpayer or a business.\n- *Custom*\n\n- *Regex filter* - You can use a regular expressions to define patterns for a guardrail to recognize and act upon such as serial number, booking ID etc.." + "description": "Configure guardrail type when the PII entity is detected.\n\nThe following PIIs are used to block or mask sensitive information:\n\n- *General*\n\n- *ADDRESS*\n\nA physical address, such as \"100 Main Street, Anytown, USA\" or \"Suite #12, Building 123\". An address can include information such as the street, building, location, city, state, country, county, zip code, precinct, and neighborhood.\n- *AGE*\n\nAn individual's age, including the quantity and unit of time. For example, in the phrase \"I am 40 years old,\" Guardrails recognizes \"40 years\" as an age.\n- *NAME*\n\nAn individual's name. This entity type does not include titles, such as Dr., Mr., Mrs., or Miss. guardrails doesn't apply this entity type to names that are part of organizations or addresses. For example, guardrails recognizes the \"John Doe Organization\" as an organization, and it recognizes \"Jane Doe Street\" as an address.\n- *EMAIL*\n\nAn email address, such as *marymajor@email.com* .\n- *PHONE*\n\nA phone number. This entity type also includes fax and pager numbers.\n- *USERNAME*\n\nA user name that identifies an account, such as a login name, screen name, nick name, or handle.\n- *PASSWORD*\n\nAn alphanumeric string that is used as a password, such as \"* *very20special#pass** \".\n- *DRIVER_ID*\n\nThe number assigned to a driver's license, which is an official document permitting an individual to operate one or more motorized vehicles on a public road. A driver's license number consists of alphanumeric characters.\n- *LICENSE_PLATE*\n\nA license plate for a vehicle is issued by the state or country where the vehicle is registered. The format for passenger vehicles is typically five to eight digits, consisting of upper-case letters and numbers. The format varies depending on the location of the issuing state or country.\n- *VEHICLE_IDENTIFICATION_NUMBER*\n\nA Vehicle Identification Number (VIN) uniquely identifies a vehicle. VIN content and format are defined in the *ISO 3779* specification. Each country has specific codes and formats for VINs.\n- *Finance*\n\n- *CREDIT_DEBIT_CARD_CVV*\n\nA three-digit card verification code (CVV) that is present on VISA, MasterCard, and Discover credit and debit cards. For American Express credit or debit cards, the CVV is a four-digit numeric code.\n- *CREDIT_DEBIT_CARD_EXPIRY*\n\nThe expiration date for a credit or debit card. This number is usually four digits long and is often formatted as *month/year* or *MM/YY* . Guardrails recognizes expiration dates such as *01/21* , *01/2021* , and *Jan 2021* .\n- *CREDIT_DEBIT_CARD_NUMBER*\n\nThe number for a credit or debit card. These numbers can vary from 13 to 16 digits in length. However, Amazon Comprehend also recognizes credit or debit card numbers when only the last four digits are present.\n- *PIN*\n\nA four-digit personal identification number (PIN) with which you can access your bank account.\n- *INTERNATIONAL_BANK_ACCOUNT_NUMBER*\n\nAn International Bank Account Number has specific formats in each country. For more information, see [www.iban.com/structure](https://docs.aws.amazon.com/https://www.iban.com/structure) .\n- *SWIFT_CODE*\n\nA SWIFT code is a standard format of Bank Identifier Code (BIC) used to specify a particular bank or branch. Banks use these codes for money transfers such as international wire transfers.\n\nSWIFT codes consist of eight or 11 characters. The 11-digit codes refer to specific branches, while eight-digit codes (or 11-digit codes ending in 'XXX') refer to the head or primary office.\n- *IT*\n\n- *IP_ADDRESS*\n\nAn IPv4 address, such as *198.51.100.0* .\n- *MAC_ADDRESS*\n\nA *media access control* (MAC) address is a unique identifier assigned to a network interface controller (NIC).\n- *URL*\n\nA web address, such as *www.example.com* .\n- *AWS_ACCESS_KEY*\n\nA unique identifier that's associated with a secret access key; you use the access key ID and secret access key to sign programmatic AWS requests cryptographically.\n- *AWS_SECRET_KEY*\n\nA unique identifier that's associated with an access key. You use the access key ID and secret access key to sign programmatic AWS requests cryptographically.\n- *USA specific*\n\n- *US_BANK_ACCOUNT_NUMBER*\n\nA US bank account number, which is typically 10 to 12 digits long.\n- *US_BANK_ROUTING_NUMBER*\n\nA US bank account routing number. These are typically nine digits long,\n- *US_INDIVIDUAL_TAX_IDENTIFICATION_NUMBER*\n\nA US Individual Taxpayer Identification Number (ITIN) is a nine-digit number that starts with a \"9\" and contain a \"7\" or \"8\" as the fourth digit. An ITIN can be formatted with a space or a dash after the third and forth digits.\n- *US_PASSPORT_NUMBER*\n\nA US passport number. Passport numbers range from six to nine alphanumeric characters.\n- *US_SOCIAL_SECURITY_NUMBER*\n\nA US Social Security Number (SSN) is a nine-digit number that is issued to US citizens, permanent residents, and temporary working residents.\n- *Canada specific*\n\n- *CA_HEALTH_NUMBER*\n\nA Canadian Health Service Number is a 10-digit unique identifier, required for individuals to access healthcare benefits.\n- *CA_SOCIAL_INSURANCE_NUMBER*\n\nA Canadian Social Insurance Number (SIN) is a nine-digit unique identifier, required for individuals to access government programs and benefits.\n\nThe SIN is formatted as three groups of three digits, such as *123-456-789* . A SIN can be validated through a simple check-digit process called the [Luhn algorithm](https://docs.aws.amazon.com/https://www.wikipedia.org/wiki/Luhn_algorithm) .\n- *UK Specific*\n\n- *UK_NATIONAL_HEALTH_SERVICE_NUMBER*\n\nA UK National Health Service Number is a 10-17 digit number, such as *485 777 3456* . The current system formats the 10-digit number with spaces after the third and sixth digits. The final digit is an error-detecting checksum.\n- *UK_NATIONAL_INSURANCE_NUMBER*\n\nA UK National Insurance Number (NINO) provides individuals with access to National Insurance (social security) benefits. It is also used for some purposes in the UK tax system.\n\nThe number is nine digits long and starts with two letters, followed by six numbers and one letter. A NINO can be formatted with a space or a dash after the two letters and after the second, forth, and sixth digits.\n- *UK_UNIQUE_TAXPAYER_REFERENCE_NUMBER*\n\nA UK Unique Taxpayer Reference (UTR) is a 10-digit number that identifies a taxpayer or a business.\n- *Custom*\n\n- *Regex filter* - You can use a regular expressions to define patterns for a guardrail to recognize and act upon such as serial number, booking ID etc.." } }, "type": "object", @@ -30239,7 +30252,8 @@ "aws-native:cognito:UserPoolAddOns": { "properties": { "advancedSecurityAdditionalFlows": { - "$ref": "#/types/aws-native:cognito:UserPoolAdvancedSecurityAdditionalFlows" + "$ref": "#/types/aws-native:cognito:UserPoolAdvancedSecurityAdditionalFlows", + "description": "Advanced security configuration options for additional authentication types in your user pool, including custom authentication." }, "advancedSecurityMode": { "type": "string", @@ -30268,7 +30282,8 @@ "aws-native:cognito:UserPoolAdvancedSecurityAdditionalFlows": { "properties": { "customAuthMode": { - "type": "string" + "type": "string", + "description": "The operating mode of advanced security features in custom authentication with [Custom authentication challenge Lambda triggers](https://docs.aws.amazon.com/cognito/latest/developerguide/user-pool-lambda-challenge.html) ." } }, "type": "object" @@ -30519,7 +30534,8 @@ "description": "The password policy settings for a user pool, including complexity, history, and length requirements." }, "signInPolicy": { - "$ref": "#/types/aws-native:cognito:UserPoolSignInPolicy" + "$ref": "#/types/aws-native:cognito:UserPoolSignInPolicy", + "description": "The policy for allowed types of authentication in a user pool.\n\nThis data type is a request and response parameter of [CreateUserPool](https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_CreateUserPool.html) and [UpdateUserPool](https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_UpdateUserPool.html) , and a response parameter of [DescribeUserPool](https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_DescribeUserPool.html) ." } }, "type": "object" @@ -30758,7 +30774,8 @@ "type": "array", "items": { "type": "string" - } + }, + "description": "The sign-in methods that a user pool supports as the first factor. You can permit users to start authentication with a standard username and password, or with other one-time password and hardware factors.\n\nSupports values of `EMAIL_OTP` , `SMS_OTP` , `WEB_AUTHN` and `PASSWORD` ," } }, "type": "object" @@ -45572,7 +45589,6 @@ "type": "object" }, "aws-native:ec2:LaunchTemplateBaselinePerformanceFactors": { - "description": "The baseline performance to consider, using an instance family as a baseline reference. The instance family establishes the lowest acceptable level of performance. Amazon EC2 uses this baseline to guide instance type selection, but there is no guarantee that the selected instance types will always exceed the baseline for every application.\n Currently, this parameter only supports CPU performance as a baseline performance factor. For example, specifying ``c6i`` would use the CPU performance of the ``c6i`` family as the baseline reference.", "properties": { "cpu": { "$ref": "#/types/aws-native:ec2:LaunchTemplateCpu", @@ -45608,7 +45624,7 @@ "properties": { "capacityReservationPreference": { "type": "string", - "description": "Indicates the instance's Capacity Reservation preferences. Possible preferences include:\n + ``capacity-reservations-only`` - The instance will only run in a Capacity Reservation or Capacity Reservation group. If capacity isn't available, the instance will fail to launch.\n + ``open`` - The instance can run in any ``open`` Capacity Reservation that has matching attributes (instance type, platform, Availability Zone, tenancy).\n + ``none`` - The instance avoids running in a Capacity Reservation even if one is available. The instance runs in On-Demand capacity." + "description": "Indicates the instance's Capacity Reservation preferences. Possible preferences include:\n + ``open`` - The instance can run in any ``open`` Capacity Reservation that has matching attributes (instance type, platform, Availability Zone).\n + ``none`` - The instance avoids running in a Capacity Reservation even if one is available. The instance runs in On-Demand capacity." }, "capacityReservationTarget": { "$ref": "#/types/aws-native:ec2:LaunchTemplateCapacityReservationTarget", @@ -45748,7 +45764,7 @@ "items": { "$ref": "#/types/aws-native:ec2:LaunchTemplateElasticInferenceAccelerator" }, - "description": "Amazon Elastic Inference is no longer available.\n An elastic inference accelerator to associate with the instance. Elastic inference accelerators are a resource you can attach to your Amazon EC2 instances to accelerate your Deep Learning (DL) inference workloads.\n You cannot specify accelerators from different generations in the same request.\n Starting April 15, 2023, AWS will not onboard new customers to Amazon Elastic Inference (EI), and will help current customers migrate their workloads to options that offer better price and performance. After April 15, 2023, new customers will not be able to launch instances with Amazon EI accelerators in Amazon SageMaker, Amazon ECS, or Amazon EC2. However, customers who have used Amazon EI at least once during the past 30-day period are considered current customers and will be able to continue using the service." + "description": "An elastic inference accelerator to associate with the instance. Elastic inference accelerators are a resource you can attach to your Amazon EC2 instances to accelerate your Deep Learning (DL) inference workloads.\n You cannot specify accelerators from different generations in the same request.\n Starting April 15, 2023, AWS will not onboard new customers to Amazon Elastic Inference (EI), and will help current customers migrate their workloads to options that offer better price and performance. After April 15, 2023, new customers will not be able to launch instances with Amazon EI accelerators in Amazon SageMaker, Amazon ECS, or Amazon EC2. However, customers who have used Amazon EI at least once during the past 30-day period are considered current customers and will be able to continue using the service." }, "enclaveOptions": { "$ref": "#/types/aws-native:ec2:LaunchTemplateEnclaveOptions", @@ -45776,7 +45792,7 @@ }, "instanceRequirements": { "$ref": "#/types/aws-native:ec2:LaunchTemplateInstanceRequirements", - "description": "The attributes for the instance types. When you specify instance attributes, Amazon EC2 will identify instance types with these attributes.\n You must specify ``VCpuCount`` and ``MemoryMiB``. All other attributes are optional. Any unspecified optional attribute is set to its default.\n When you specify multiple attributes, you get instance types that satisfy all of the specified attributes. If you specify multiple values for an attribute, you get instance types that satisfy any of the specified values.\n To limit the list of instance types from which Amazon EC2 can identify matching instance types, you can use one of the following parameters, but not both in the same request:\n + ``AllowedInstanceTypes`` - The instance types to include in the list. All other instance types are ignored, even if they match your specified attributes.\n + ``ExcludedInstanceTypes`` - The instance types to exclude from the list, even if they match your specified attributes.\n \n If you specify ``InstanceRequirements``, you can't specify ``InstanceType``.\n Attribute-based instance type selection is only supported when using Auto Scaling groups, EC2 Fleet, and Spot Fleet to launch instances. If you plan to use the launch template in the [launch instance wizard](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ec2-launch-instance-wizard.html), or with the [RunInstances](https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_RunInstances.html) API or [AWS::EC2::Instance](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-instance.html) AWS CloudFormation resource, you can't specify ``InstanceRequirements``.\n For more information, see [Specify attributes for instance type selection for EC2 Fleet or Spot Fleet](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ec2-fleet-attribute-based-instance-type-selection.html) and [Spot placement score](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/spot-placement-score.html) in the *Amazon EC2 User Guide*." + "description": "The attributes for the instance types. When you specify instance attributes, Amazon EC2 will identify instance types with these attributes.\n You must specify ``VCpuCount`` and ``MemoryMiB``. All other attributes are optional. Any unspecified optional attribute is set to its default.\n When you specify multiple attributes, you get instance types that satisfy all of the specified attributes. If you specify multiple values for an attribute, you get instance types that satisfy any of the specified values.\n To limit the list of instance types from which Amazon EC2 can identify matching instance types, you can use one of the following parameters, but not both in the same request:\n + ``AllowedInstanceTypes`` - The instance types to include in the list. All other instance types are ignored, even if they match your specified attributes.\n + ``ExcludedInstanceTypes`` - The instance types to exclude from the list, even if they match your specified attributes.\n \n If you specify ``InstanceRequirements``, you can't specify ``InstanceType``.\n Attribute-based instance type selection is only supported when using Auto Scaling groups, EC2 Fleet, and Spot Fleet to launch instances. If you plan to use the launch template in the [launch instance wizard](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ec2-launch-instance-wizard.html), or with the [RunInstances](https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_RunInstances.html) API or [AWS::EC2::Instance](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-instance.html) AWS CloudFormation resource, you can't specify ``InstanceRequirements``.\n For more information, see [Attribute-based instance type selection for EC2 Fleet](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ec2-fleet-attribute-based-instance-type-selection.html), [Attribute-based instance type selection for Spot Fleet](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/spot-fleet-attribute-based-instance-type-selection.html), and [Spot placement score](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/spot-placement-score.html) in the *Amazon EC2 User Guide*." }, "instanceType": { "type": "string", @@ -45816,9 +45832,6 @@ }, "description": "The network interfaces for the instance." }, - "networkPerformanceOptions": { - "$ref": "pulumi.json#/Any" - }, "placement": { "$ref": "#/types/aws-native:ec2:LaunchTemplatePlacement", "description": "The placement for the instance." @@ -45850,7 +45863,7 @@ "items": { "$ref": "#/types/aws-native:ec2:TagSpecification" }, - "description": "The tags to apply to resources that are created during instance launch.\n To tag the launch template itself, use [TagSpecifications](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-launchtemplate.html#cfn-ec2-launchtemplate-tagspecifications)." + "description": "The tags to apply to the resources that are created during instance launch.\n To tag a resource after it has been created, see [CreateTags](https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_CreateTags.html).\n To tag the launch template itself, use [TagSpecifications](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-launchtemplate.html#cfn-ec2-launchtemplate-tagspecifications)." }, "userData": { "type": "string", @@ -45876,7 +45889,7 @@ }, "kmsKeyId": { "type": "string", - "description": "Identifier (key ID, key alias, key ARN, or alias ARN) of the customer managed KMS key to use for EBS encryption." + "description": "The ARN of the symmetric KMSlong (KMS) CMK used for encryption." }, "snapshotId": { "type": "string", @@ -45994,7 +46007,7 @@ "type": "object" }, "aws-native:ec2:LaunchTemplateInstanceRequirements": { - "description": "The attributes for the instance types. When you specify instance attributes, Amazon EC2 will identify instance types with these attributes.\n You must specify ``VCpuCount`` and ``MemoryMiB``. All other attributes are optional. Any unspecified optional attribute is set to its default.\n When you specify multiple attributes, you get instance types that satisfy all of the specified attributes. If you specify multiple values for an attribute, you get instance types that satisfy any of the specified values.\n To limit the list of instance types from which Amazon EC2 can identify matching instance types, you can use one of the following parameters, but not both in the same request:\n + ``AllowedInstanceTypes`` - The instance types to include in the list. All other instance types are ignored, even if they match your specified attributes.\n + ``ExcludedInstanceTypes`` - The instance types to exclude from the list, even if they match your specified attributes.\n \n If you specify ``InstanceRequirements``, you can't specify ``InstanceType``.\n Attribute-based instance type selection is only supported when using Auto Scaling groups, EC2 Fleet, and Spot Fleet to launch instances. If you plan to use the launch template in the [launch instance wizard](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ec2-launch-instance-wizard.html), or with the [RunInstances](https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_RunInstances.html) API or [AWS::EC2::Instance](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-instance.html) AWS CloudFormation resource, you can't specify ``InstanceRequirements``.\n For more information, see [Specify attributes for instance type selection for EC2 Fleet or Spot Fleet](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ec2-fleet-attribute-based-instance-type-selection.html) and [Spot placement score](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/spot-placement-score.html) in the *Amazon EC2 User Guide*.", + "description": "The attributes for the instance types. When you specify instance attributes, Amazon EC2 will identify instance types with these attributes.\n You must specify ``VCpuCount`` and ``MemoryMiB``. All other attributes are optional. Any unspecified optional attribute is set to its default.\n When you specify multiple attributes, you get instance types that satisfy all of the specified attributes. If you specify multiple values for an attribute, you get instance types that satisfy any of the specified values.\n To limit the list of instance types from which Amazon EC2 can identify matching instance types, you can use one of the following parameters, but not both in the same request:\n + ``AllowedInstanceTypes`` - The instance types to include in the list. All other instance types are ignored, even if they match your specified attributes.\n + ``ExcludedInstanceTypes`` - The instance types to exclude from the list, even if they match your specified attributes.\n \n If you specify ``InstanceRequirements``, you can't specify ``InstanceType``.\n Attribute-based instance type selection is only supported when using Auto Scaling groups, EC2 Fleet, and Spot Fleet to launch instances. If you plan to use the launch template in the [launch instance wizard](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ec2-launch-instance-wizard.html), or with the [RunInstances](https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_RunInstances.html) API or [AWS::EC2::Instance](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-instance.html) AWS CloudFormation resource, you can't specify ``InstanceRequirements``.\n For more information, see [Attribute-based instance type selection for EC2 Fleet](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ec2-fleet-attribute-based-instance-type-selection.html), [Attribute-based instance type selection for Spot Fleet](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/spot-fleet-attribute-based-instance-type-selection.html), and [Spot placement score](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/spot-placement-score.html) in the *Amazon EC2 User Guide*.", "properties": { "acceleratorCount": { "$ref": "#/types/aws-native:ec2:LaunchTemplateAcceleratorCount", @@ -46023,7 +46036,7 @@ "items": { "type": "string" }, - "description": "The accelerator types that must be on the instance type.\n + For instance types with GPU accelerators, specify ``gpu``.\n + For instance types with FPGA accelerators, specify ``fpga``.\n \n Default: Any accelerator type" + "description": "The accelerator types that must be on the instance type.\n + For instance types with GPU accelerators, specify ``gpu``.\n + For instance types with FPGA accelerators, specify ``fpga``.\n + For instance types with inference accelerators, specify ``inference``.\n \n Default: Any accelerator type" }, "allowedInstanceTypes": { "type": "array", @@ -46042,7 +46055,7 @@ }, "baselinePerformanceFactors": { "$ref": "#/types/aws-native:ec2:LaunchTemplateBaselinePerformanceFactors", - "description": "The baseline performance to consider, using an instance family as a baseline reference. The instance family establishes the lowest acceptable level of performance. Amazon EC2 uses this baseline to guide instance type selection, but there is no guarantee that the selected instance types will always exceed the baseline for every application. Currently, this parameter only supports CPU performance as a baseline performance factor. For more information, see [Performance protection](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ec2-fleet-attribute-based-instance-type-selection.html#ec2fleet-abis-performance-protection) in the *Amazon EC2 User Guide*." + "description": "The baseline performance to consider, using an instance family as a baseline reference. The instance family establishes the lowest acceptable level of performance. Amazon EC2 uses this baseline to guide instance type selection, but there is no guarantee that the selected instance types will always exceed the baseline for every application. Currently, this parameter only supports CPU performance as a baseline performance factor. For more information, see [Performance protection](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ec2-fleet-attribute-based-instance-type-selection.html#ec2fleet-abis-performance-protection) in the *Amazon EC2 User Guide* ." }, "burstablePerformance": { "type": "string", @@ -46053,7 +46066,7 @@ "items": { "type": "string" }, - "description": "The CPU manufacturers to include.\n + For instance types with Intel CPUs, specify ``intel``.\n + For instance types with AMD CPUs, specify ``amd``.\n + For instance types with AWS CPUs, specify ``amazon-web-services``.\n + For instance types with Apple CPUs, specify ``apple``.\n \n Don't confuse the CPU manufacturer with the CPU architecture. Instances will be launched with a compatible CPU architecture based on the Amazon Machine Image (AMI) that you specify in your launch template.\n Default: Any manufacturer" + "description": "The CPU manufacturers to include.\n + For instance types with Intel CPUs, specify ``intel``.\n + For instance types with AMD CPUs, specify ``amd``.\n + For instance types with AWS CPUs, specify ``amazon-web-services``.\n \n Don't confuse the CPU manufacturer with the CPU architecture. Instances will be launched with a compatible CPU architecture based on the Amazon Machine Image (AMI) that you specify in your launch template.\n Default: Any manufacturer" }, "excludedInstanceTypes": { "type": "array", @@ -46291,7 +46304,7 @@ }, "interfaceType": { "type": "string", - "description": "The type of network interface. To create an Elastic Fabric Adapter (EFA), specify ``efa`` or ``efa``. For more information, see [Elastic Fabric Adapter](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/efa.html) in the *Amazon EC2 User Guide*.\n If you are not creating an EFA, specify ``interface`` or omit this parameter.\n If you specify ``efa-only``, do not assign any IP addresses to the network interface. EFA-only network interfaces do not support IP addresses.\n Valid values: ``interface`` | ``efa`` | ``efa-only``" + "description": "The type of network interface. To create an Elastic Fabric Adapter (EFA), specify ``efa``. For more information, see [Elastic Fabric Adapter](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/efa.html) in the *Amazon EC2 User Guide*.\n If you are not creating an EFA, specify ``interface`` or omit this parameter.\n Valid values: ``interface`` | ``efa``" }, "ipv4PrefixCount": { "type": "integer", @@ -46451,7 +46464,8 @@ "aws-native:ec2:LaunchTemplateReference": { "properties": { "instanceFamily": { - "type": "string" + "type": "string", + "description": "The instance family to refer. Ensure that you specify the correct family name. For example, C6i and C6g are valid values, but C6 is not." } }, "type": "object" @@ -46501,7 +46515,7 @@ ] }, "aws-native:ec2:LaunchTemplateTagSpecification": { - "description": "Specifies the tags to apply to the launch template during creation.\n To specify the tags for the resources that are created during instance launch, use [AWS::EC2::LaunchTemplate TagSpecification](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-launchtemplate-tagspecification.html).\n ``LaunchTemplateTagSpecification`` is a property of [AWS::EC2::LaunchTemplate](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-launchtemplate.html).", + "description": "Specifies the tags to apply to the launch template during creation.\n ``LaunchTemplateTagSpecification`` is a property of [AWS::EC2::LaunchTemplate](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-launchtemplate.html).", "properties": { "resourceType": { "type": "string", @@ -48125,7 +48139,7 @@ }, "secondaryPrivateIpAddressCount": { "type": "integer", - "description": "The number of secondary private IPv4 addresses. You can't specify this option and specify more than one private IP address using the private IP addresses option. You cannot specify this option if you're launching more than one instance in a [RunInstances](https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_RunInstances.html) request." + "description": "The number of secondary private IPv4 addresses. You can’t specify this parameter and also specify a secondary private IP address using the `PrivateIpAddress` parameter." }, "subnetId": { "type": "string", @@ -49289,7 +49303,7 @@ ] }, "aws-native:ec2:TagSpecification": { - "description": "Specifies the tags to apply to resources that are created during instance launch.\n ``TagSpecification`` is a property type of [TagSpecifications](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-launchtemplate-launchtemplatedata.html#cfn-ec2-launchtemplate-launchtemplatedata-tagspecifications). [TagSpecifications](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-launchtemplate-launchtemplatedata.html#cfn-ec2-launchtemplate-launchtemplatedata-tagspecifications) is a property of [AWS::EC2::LaunchTemplate LaunchTemplateData](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-launchtemplate-launchtemplatedata.html).", + "description": "Specifies the tags to apply to a resource when the resource is created for the launch template.\n ``TagSpecification`` is a property type of [TagSpecifications](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-launchtemplate-launchtemplatedata.html#cfn-ec2-launchtemplate-launchtemplatedata-tagspecifications). [TagSpecifications](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-launchtemplate-launchtemplatedata.html#cfn-ec2-launchtemplate-launchtemplatedata-tagspecifications) is a property of [AWS::EC2::LaunchTemplate LaunchTemplateData](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-launchtemplate-launchtemplatedata.html).", "properties": { "resourceType": { "type": "string", @@ -51665,7 +51679,7 @@ }, "versionConsistency": { "$ref": "#/types/aws-native:ecs:TaskDefinitionContainerDefinitionVersionConsistency", - "description": "Specifies whether Amazon ECS will resolve the container image tag provided in the container definition to an image digest. By default, the value is `enabled` . If you set the value for a container as `disabled` , Amazon ECS will not resolve the provided container image tag to a digest and will use the original image URI specified in the container definition for deployment. For more information about container image resolution, see [Container image resolution](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/deployment-type-ecs.html#deployment-container-image-stability) in the *Amazon ECS Developer Guide* ." + "description": "Specifies whether Amazon ECS will resolve the container image tag provided in the container definition to an image digest. By default, the value is ``enabled``. If you set the value for a container as ``disabled``, Amazon ECS will not resolve the provided container image tag to a digest and will use the original image URI specified in the container definition for deployment. For more information about container image resolution, see [Container image resolution](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/deployment-type-ecs.html#deployment-container-image-stability) in the *Amazon ECS Developer Guide*." }, "volumesFrom": { "type": "array", @@ -51686,7 +51700,7 @@ ] }, "aws-native:ecs:TaskDefinitionContainerDefinitionVersionConsistency": { - "description": "Specifies whether Amazon ECS will resolve the container image tag provided in the container definition to an image digest. By default, the value is `enabled` . If you set the value for a container as `disabled` , Amazon ECS will not resolve the provided container image tag to a digest and will use the original image URI specified in the container definition for deployment. For more information about container image resolution, see [Container image resolution](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/deployment-type-ecs.html#deployment-container-image-stability) in the *Amazon ECS Developer Guide* .", + "description": "Specifies whether Amazon ECS will resolve the container image tag provided in the container definition to an image digest. By default, the value is ``enabled``. If you set the value for a container as ``disabled``, Amazon ECS will not resolve the provided container image tag to a digest and will use the original image URI specified in the container definition for deployment. For more information about container image resolution, see [Container image resolution](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/deployment-type-ecs.html#deployment-container-image-stability) in the *Amazon ECS Developer Guide*.", "type": "string", "enum": [ { @@ -56163,7 +56177,8 @@ "description": "The authorization parameters for Basic authorization." }, "connectivityParameters": { - "$ref": "#/types/aws-native:events:ConnectionConnectivityParameters" + "$ref": "#/types/aws-native:events:ConnectionConnectivityParameters", + "description": "For private OAuth authentication endpoints. The parameters EventBridge uses to authenticate against the endpoint.\n\nFor more information, see [Authorization methods for connections](https://docs.aws.amazon.com/eventbridge/latest/userguide/eb-target-connection-auth.html) in the **Amazon EventBridge User Guide** ." }, "invocationHttpParameters": { "$ref": "#/types/aws-native:events:ConnectionHttpParameters", @@ -56231,7 +56246,8 @@ "aws-native:events:ConnectionConnectivityParameters": { "properties": { "resourceParameters": { - "$ref": "#/types/aws-native:events:ConnectionResourceParameters" + "$ref": "#/types/aws-native:events:ConnectionResourceParameters", + "description": "The parameters for EventBridge to use when invoking the resource endpoint." } }, "type": "object", @@ -56333,10 +56349,12 @@ "aws-native:events:ConnectionResourceParameters": { "properties": { "resourceAssociationArn": { - "type": "string" + "type": "string", + "description": "For connections to private APIs, the Amazon Resource Name (ARN) of the resource association EventBridge created between the connection and the private API's resource configuration.\n\n\u003e The value of this property is set by EventBridge . Any value you specify in your template is ignored." }, "resourceConfigurationArn": { - "type": "string" + "type": "string", + "description": "The Amazon Resource Name (ARN) of the Amazon VPC Lattice resource configuration for the resource endpoint." } }, "type": "object", @@ -56494,7 +56512,8 @@ "description": "The private resource the HTTP request will be sent to.", "properties": { "resourceParameters": { - "$ref": "#/types/aws-native:events:ConnectionResourceParameters" + "$ref": "#/types/aws-native:events:ConnectionResourceParameters", + "description": "The parameters for EventBridge to use when invoking the resource endpoint." } }, "type": "object", @@ -66810,7 +66829,8 @@ "type": "array", "items": { "type": "string" - } + }, + "description": "The list of `LINKED_ACCOUNT` IDs where charges are included within the invoice unit." } }, "type": "object", @@ -67144,6 +67164,95 @@ } ] }, + "aws-native:iot:CommandNamespace": { + "description": "The namespace to which the command belongs.", + "type": "string", + "enum": [ + { + "name": "AwsIoT", + "value": "AWS-IoT" + }, + { + "name": "AwsIoTFleetWise", + "value": "AWS-IoT-FleetWise" + } + ] + }, + "aws-native:iot:CommandParameter": { + "properties": { + "defaultValue": { + "$ref": "#/types/aws-native:iot:CommandParameterValue" + }, + "description": { + "type": "string" + }, + "name": { + "type": "string" + }, + "value": { + "$ref": "#/types/aws-native:iot:CommandParameterValue" + } + }, + "type": "object", + "required": [ + "name" + ] + }, + "aws-native:iot:CommandParameterValue": { + "properties": { + "b": { + "type": "boolean" + }, + "bin": { + "type": "string" + }, + "d": { + "type": "number" + }, + "i": { + "type": "integer" + }, + "l": { + "type": "string" + }, + "s": { + "type": "string" + }, + "ul": { + "type": "string" + } + }, + "type": "object" + }, + "aws-native:iot:CommandPayload": { + "properties": { + "content": { + "type": "string" + }, + "contentType": { + "type": "string" + } + }, + "type": "object" + }, + "aws-native:iot:CommandTag": { + "description": "A key-value pair to associate with a resource.", + "properties": { + "key": { + "type": "string", + "description": "The tag's key." + }, + "value": { + "type": "string", + "description": "The tag's value." + } + }, + "type": "object", + "required": [ + "key", + "value" + ] + }, "aws-native:iot:CustomMetricMetricType": { "description": "The type of the custom metric. Types include string-list, ip-address-list, number-list, and number.", "type": "string", @@ -95863,7 +95972,7 @@ ] }, "aws-native:organizations:PolicyType": { - "description": "The type of policy to create. You can specify one of the following values: AISERVICES_OPT_OUT_POLICY, BACKUP_POLICY, SERVICE_CONTROL_POLICY, TAG_POLICY, CHATBOT_POLICY, RESOURCE_CONTROL_POLICY", + "description": "The type of policy to create. You can specify one of the following values: AISERVICES_OPT_OUT_POLICY, BACKUP_POLICY, SERVICE_CONTROL_POLICY, TAG_POLICY, CHATBOT_POLICY, RESOURCE_CONTROL_POLICY,DECLARATIVE_POLICY_EC2", "type": "string", "enum": [ { @@ -95889,6 +95998,10 @@ { "name": "ResourceControlPolicy", "value": "RESOURCE_CONTROL_POLICY" + }, + { + "name": "DeclarativePolicyEc2", + "value": "DECLARATIVE_POLICY_EC2" } ] }, @@ -145486,6 +145599,24 @@ "value" ] }, + "aws-native:ram:ResourceShareTag": { + "description": "A key-value pair to associate with a resource.", + "properties": { + "key": { + "type": "string", + "description": "The key name of the tag. You can specify a value that is 1 to 128 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -." + }, + "value": { + "type": "string", + "description": "The value for the tag. You can specify a value that is 0 to 256 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -." + } + }, + "type": "object", + "required": [ + "key", + "value" + ] + }, "aws-native:rbin:RuleResourceTag": { "description": "The resource tag of the rule.", "properties": { @@ -145588,7 +145719,7 @@ ] }, "aws-native:rds:CustomDbEngineVersionStatus": { - "description": "The availability status to be assigned to the CEV.", + "description": "A value that indicates the status of a custom engine version (CEV).", "type": "string", "enum": [ { @@ -145606,15 +145737,15 @@ ] }, "aws-native:rds:CustomDbEngineVersionTag": { - "description": "A key-value pair to associate with a resource.", + "description": "Metadata assigned to an Amazon RDS resource consisting of a key-value pair.\n For more information, see [Tagging Amazon RDS resources](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_Tagging.html) in the *Amazon RDS User Guide* or [Tagging Amazon Aurora and Amazon RDS resources](https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/USER_Tagging.html) in the *Amazon Aurora User Guide*.", "properties": { "key": { "type": "string", - "description": "The key name of the tag. You can specify a value that is 1 to 128 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -." + "description": "A key is the required name of the tag. The string value can be from 1 to 128 Unicode characters in length and can't be prefixed with ``aws:`` or ``rds:``. The string can only contain only the set of Unicode letters, digits, white-space, '_', '.', ':', '/', '=', '+', '-', '@' (Java regex: \"^([\\\\p{L}\\\\p{Z}\\\\p{N}_.:/=+\\\\-@]*)$\")." }, "value": { "type": "string", - "description": "The value for the tag. You can specify a value that is 0 to 256 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -." + "description": "A value is the optional value of the tag. The string value can be from 1 to 256 Unicode characters in length and can't be prefixed with ``aws:`` or ``rds:``. The string can only contain only the set of Unicode letters, digits, white-space, '_', '.', ':', '/', '=', '+', '-', '@' (Java regex: \"^([\\\\p{L}\\\\p{Z}\\\\p{N}_.:/=+\\\\-@]*)$\")." } }, "type": "object", @@ -146704,6 +146835,9 @@ "type": "string", "description": "The namespace the workgroup is associated with." }, + "pricePerformanceTarget": { + "$ref": "#/types/aws-native:redshiftserverless:WorkgroupPerformanceTarget" + }, "publiclyAccessible": { "type": "boolean", "description": "A value that specifies whether the workgroup can be accessible from a public network." @@ -146795,6 +146929,30 @@ }, "type": "object" }, + "aws-native:redshiftserverless:WorkgroupPerformanceTarget": { + "properties": { + "level": { + "type": "integer" + }, + "status": { + "$ref": "#/types/aws-native:redshiftserverless:WorkgroupPerformanceTargetStatus" + } + }, + "type": "object" + }, + "aws-native:redshiftserverless:WorkgroupPerformanceTargetStatus": { + "type": "string", + "enum": [ + { + "name": "Enabled", + "value": "ENABLED" + }, + { + "name": "Disabled", + "value": "DISABLED" + } + ] + }, "aws-native:redshiftserverless:WorkgroupStatus": { "type": "string", "enum": [ @@ -150529,6 +150687,42 @@ }, "type": "object" }, + "aws-native:s3:BucketMetadataTableConfiguration": { + "properties": { + "error": { + "$ref": "#/types/aws-native:s3:BucketMetadataTableError", + "description": "Returns the \u003ccode\u003eError\u003c/code\u003e value of the GetBucketMetadataTableConfiguration response." + }, + "s3TablesDestination": { + "$ref": "#/types/aws-native:s3:BucketS3TablesDestination" + }, + "status": { + "type": "string", + "description": "Returns the \u003ccode\u003eStatus\u003c/code\u003e value of the \u003ccode\u003eGetBucketMetadataTableConfigurationResult\u003c/code\u003e response. This value indicates the status of the metadata table. The status values are:\u003cbr/\u003e\u003ccode\u003eCREATING\u003c/code\u003e - The metadata table is in the process of being created in the specified table bucket.\u003cbr/\u003e\u003ccode\u003eACTIVE\u003c/code\u003e - The metadata table has been created successfully and records are being delivered to the table.\u003cbr/\u003e\u003ccode\u003eFAILED\u003c/code\u003e - Amazon S3 is unable to create the metadata table, or Amazon S3 is unable to deliver records." + } + }, + "type": "object", + "required": [ + "s3TablesDestination" + ] + }, + "aws-native:s3:BucketMetadataTableError": { + "properties": { + "errorCode": { + "type": "string", + "description": "If the \u003ccode\u003eCreateBucketMetadataTableConfiguration\u003c/code\u003e request succeeds, but S3 Metadata was unable to create the table, this structure contains the error code. The possible error codes and error messages are as follows:\u003cbr/\u003e\u003ccode\u003eAccessDeniedCreatingResources\u003c/code\u003e - You don't have sufficient permissions to create the required resources. Make sure that you have \u003ccode\u003es3tables:CreateNamespace\u003c/code\u003e, \u003ccode\u003es3tables:CreateTable\u003c/code\u003e, \u003ccode\u003es3tables:GetTable\u003c/code\u003e and \u003ccode\u003es3tables:PutTablePolicy\u003c/code\u003e permissions, and then try again. To create a new metadata table, you must delete the metadata configuration for this bucket, and then create a new metadata configuration.\u003cbr/\u003e\u003ccode\u003eAccessDeniedWritingToTable\u003c/code\u003e - Unable to write to the metadata table because of missing resource permissions. To fix the resource policy, Amazon S3 needs to create a new metadata table. To create a new metadata table, you must delete the metadata configuration for this bucket, and then create a new metadata configuration.\u003cbr/\u003e\u003ccode\u003eDestinationTableNotFound\u003c/code\u003e - The destination table doesn't exist. To create a new metadata table, you must delete the metadata configuration for this bucket, and then create a new metadata configuration.\u003cbr/\u003e\u003ccode\u003eServerInternalError\u003c/code\u003e - An internal error has occurred. To create a new metadata table, you must delete the metadata configuration for this bucket, and then create a new metadata configuration.\u003cbr/\u003e\u003ccode\u003eTableAlreadyExists\u003c/code\u003e - The table that you specified already exists in the table bucket's namespace. Specify a different table name. To create a new metadata table, you must delete the metadata configuration for this bucket, and then create a new metadata configuration.\u003cbr/\u003e\u003ccode\u003eTableBucketNotFound\u003c/code\u003e - The table bucket that you specified doesn't exist in this AWS Region and account. Create or choose a different table bucket. To create a new metadata table, you must delete the metadata configuration for this bucket, and then create a new metadata configuration." + }, + "errorMessage": { + "type": "string", + "description": "If the \u003ccode\u003eCreateBucketMetadataTableConfiguration\u003c/code\u003e request succeeds, but S3 Metadata was unable to create the table, this structure contains the error code. The possible error codes and error messages are as follows:\u003cbr/\u003e\u003ccode\u003eAccessDeniedCreatingResources\u003c/code\u003e - You don't have sufficient permissions to create the required resources. Make sure that you have \u003ccode\u003es3tables:CreateNamespace\u003c/code\u003e, \u003ccode\u003es3tables:CreateTable\u003c/code\u003e, \u003ccode\u003es3tables:GetTable\u003c/code\u003e and \u003ccode\u003es3tables:PutTablePolicy\u003c/code\u003e permissions, and then try again. To create a new metadata table, you must delete the metadata configuration for this bucket, and then create a new metadata configuration.\u003cbr/\u003e\u003ccode\u003eAccessDeniedWritingToTable\u003c/code\u003e - Unable to write to the metadata table because of missing resource permissions. To fix the resource policy, Amazon S3 needs to create a new metadata table. To create a new metadata table, you must delete the metadata configuration for this bucket, and then create a new metadata configuration.\u003cbr/\u003e\u003ccode\u003eDestinationTableNotFound\u003c/code\u003e - The destination table doesn't exist. To create a new metadata table, you must delete the metadata configuration for this bucket, and then create a new metadata configuration.\u003cbr/\u003e\u003ccode\u003eServerInternalError\u003c/code\u003e - An internal error has occurred. To create a new metadata table, you must delete the metadata configuration for this bucket, and then create a new metadata configuration.\u003cbr/\u003e\u003ccode\u003eTableAlreadyExists\u003c/code\u003e - The table that you specified already exists in the table bucket's namespace. Specify a different table name. To create a new metadata table, you must delete the metadata configuration for this bucket, and then create a new metadata configuration.\u003cbr/\u003e\u003ccode\u003eTableBucketNotFound\u003c/code\u003e - The table bucket that you specified doesn't exist in this AWS Region and account. Create or choose a different table bucket. To create a new metadata table, you must delete the metadata configuration for this bucket, and then create a new metadata configuration." + } + }, + "type": "object", + "required": [ + "errorCode", + "errorMessage" + ] + }, "aws-native:s3:BucketMetrics": { "description": "A container specifying replication metrics-related settings enabling replication metrics and events.", "properties": { @@ -151286,6 +151480,31 @@ "rules" ] }, + "aws-native:s3:BucketS3TablesDestination": { + "properties": { + "tableArn": { + "type": "string", + "description": "The Amazon Resource Name (ARN) for the metadata table in the metadata table configuration. The specified metadata table name must be unique within the \u003ccode\u003eaws_s3_metadata\u003c/code\u003e namespace in the destination table bucket." + }, + "tableBucketArn": { + "type": "string", + "description": "The Amazon Resource Name (ARN) for the table bucket that's specified as the destination in the metadata table configuration. The destination table bucket must be in the same Region and AWS account as the general purpose bucket." + }, + "tableName": { + "type": "string", + "description": "The name for the metadata table in your metadata table configuration. The specified metadata table name must be unique within the \u003ccode\u003eaws_s3_metadata\u003c/code\u003e namespace in the destination table bucket." + }, + "tableNamespace": { + "type": "string", + "description": "The table bucket namespace for the metadata table in your metadata table configuration. This value is always \u003ccode\u003eaws_s3_metadata\u003c/code\u003e." + } + }, + "type": "object", + "required": [ + "tableBucketArn", + "tableName" + ] + }, "aws-native:s3:BucketServerSideEncryptionByDefault": { "description": "Describes the default server-side encryption to apply to new objects in the bucket. If a PUT Object request doesn't specify any server-side encryption, this default encryption will be applied. For more information, see [PutBucketEncryption](https://docs.aws.amazon.com/AmazonS3/latest/API/RESTBucketPUTencryption.html).\n + *General purpose buckets* - If you don't specify a customer managed key at configuration, Amazon S3 automatically creates an AWS KMS key (``aws/s3``) in your AWS account the first time that you add an object encrypted with SSE-KMS to a bucket. By default, Amazon S3 uses this KMS key for SSE-KMS. \n + *Directory buckets* - Your SSE-KMS configuration can only support 1 [customer managed key](https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#customer-cmk) per directory bucket for the lifetime of the bucket. The [managed key](https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#aws-managed-cmk) (``aws/s3``) isn't supported. \n + *Directory buckets* - For directory buckets, there are only two supported options for server-side encryption: SSE-S3 and SSE-KMS.", "properties": { @@ -152191,12 +152410,16 @@ ] }, "aws-native:s3express:DirectoryBucketDataRedundancy": { - "description": "Specifies the number of Availability Zone that's used for redundancy for the bucket.", + "description": "Specifies the number of Availability Zone or Local Zone that's used for redundancy for the bucket.", "type": "string", "enum": [ { "name": "SingleAvailabilityZone", "value": "SingleAvailabilityZone" + }, + { + "name": "SingleLocalZone", + "value": "SingleLocalZone" } ] }, @@ -152683,6 +152906,42 @@ } ] }, + "aws-native:s3tables:TableBucketPolicyResourcePolicy": { + "description": "A policy document containing permissions to add to the specified table bucket. In IAM, you must provide policy documents in JSON format. However, in CloudFormation you can provide the policy in JSON or YAML format because CloudFormation converts YAML to JSON before submitting it to IAM.", + "type": "object" + }, + "aws-native:s3tables:TableBucketUnreferencedFileRemoval": { + "description": "Settings governing the Unreferenced File Removal maintenance action. Unreferenced file removal identifies and deletes all objects that are not referenced by any table snapshots.", + "properties": { + "noncurrentDays": { + "type": "integer", + "description": "S3 permanently deletes noncurrent objects after the number of days specified by the NoncurrentDays property." + }, + "status": { + "$ref": "#/types/aws-native:s3tables:TableBucketUnreferencedFileRemovalStatus", + "description": "Indicates whether the Unreferenced File Removal maintenance action is enabled." + }, + "unreferencedDays": { + "type": "integer", + "description": "For any object not referenced by your table and older than the UnreferencedDays property, S3 creates a delete marker and marks the object version as noncurrent." + } + }, + "type": "object" + }, + "aws-native:s3tables:TableBucketUnreferencedFileRemovalStatus": { + "description": "Indicates whether the Unreferenced File Removal maintenance action is enabled.", + "type": "string", + "enum": [ + { + "name": "Enabled", + "value": "Enabled" + }, + { + "name": "Disabled", + "value": "Disabled" + } + ] + }, "aws-native:sagemaker:AppImageConfigCodeEditorAppImageConfig": { "description": "The configuration for the kernels in a SageMaker image running as a CodeEditor app.", "properties": { @@ -180568,10 +180827,6 @@ "description": "The endpoint configuration to indicate the types of endpoints an API (RestApi) or its custom domain name (DomainName) has.", "replaceOnChanges": true }, - "managementPolicy": { - "$ref": "pulumi.json#/Any", - "description": "Search the [CloudFormation User Guide](https://docs.aws.amazon.com/cloudformation/) for `AWS::ApiGateway::DomainNameV2` for more information about the expected schema for this property." - }, "policy": { "$ref": "pulumi.json#/Any", "description": "A stringified JSON policy document that applies to the `execute-api` service for this DomainName regardless of the caller and Method configuration. You can use `Fn::ToJsonString` to enter your `policy` . For more information, see [Fn::ToJsonString](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/intrinsic-function-reference-ToJsonString.html) .\n\nSearch the [CloudFormation User Guide](https://docs.aws.amazon.com/cloudformation/) for `AWS::ApiGateway::DomainNameV2` for more information about the expected schema for this property." @@ -180607,10 +180862,6 @@ "$ref": "#/types/aws-native:apigateway:DomainNameV2EndpointConfiguration", "description": "The endpoint configuration to indicate the types of endpoints an API (RestApi) or its custom domain name (DomainName) has." }, - "managementPolicy": { - "$ref": "pulumi.json#/Any", - "description": "Search the [CloudFormation User Guide](https://docs.aws.amazon.com/cloudformation/) for `AWS::ApiGateway::DomainNameV2` for more information about the expected schema for this property." - }, "policy": { "$ref": "pulumi.json#/Any", "description": "A stringified JSON policy document that applies to the `execute-api` service for this DomainName regardless of the caller and Method configuration. You can use `Fn::ToJsonString` to enter your `policy` . For more information, see [Fn::ToJsonString](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/intrinsic-function-reference-ToJsonString.html) .\n\nSearch the [CloudFormation User Guide](https://docs.aws.amazon.com/cloudformation/) for `AWS::ApiGateway::DomainNameV2` for more information about the expected schema for this property." @@ -197188,6 +197439,7 @@ }, "clientId": { "type": "string", + "description": "The app client that's assigned to the branding style that you want more information about.", "replaceOnChanges": true }, "managedLoginBrandingId": { @@ -197195,7 +197447,8 @@ "description": "The ID of the managed login branding style." }, "returnMergedResources": { - "type": "boolean" + "type": "boolean", + "description": "When `true` , returns values for branding options that are unchanged from Amazon Cognito defaults. When `false` or when you omit this parameter, returns only values that you customized in your branding style." }, "settings": { "$ref": "pulumi.json#/Any", @@ -197203,7 +197456,7 @@ }, "useCognitoProvidedValues": { "type": "boolean", - "description": "When true, applies the default branding style options. This option reverts to a \"blank\" style that you can modify later in the branding designer." + "description": "When true, applies the default branding style options. This option reverts to default style options that are managed by Amazon Cognito. You can modify them later in the branding designer.\n\nWhen you specify `true` for this option, you must also omit values for `Settings` and `Assets` in the request." }, "userPoolId": { "type": "string", @@ -197225,10 +197478,12 @@ "description": "An array of image files that you want to apply to roles like backgrounds, logos, and icons. Each object must also indicate whether it is for dark mode, light mode, or browser-adaptive mode." }, "clientId": { - "type": "string" + "type": "string", + "description": "The app client that's assigned to the branding style that you want more information about." }, "returnMergedResources": { - "type": "boolean" + "type": "boolean", + "description": "When `true` , returns values for branding options that are unchanged from Amazon Cognito defaults. When `false` or when you omit this parameter, returns only values that you customized in your branding style." }, "settings": { "$ref": "pulumi.json#/Any", @@ -197236,7 +197491,7 @@ }, "useCognitoProvidedValues": { "type": "boolean", - "description": "When true, applies the default branding style options. This option reverts to a \"blank\" style that you can modify later in the branding designer." + "description": "When true, applies the default branding style options. This option reverts to default style options that are managed by Amazon Cognito. You can modify them later in the branding designer.\n\nWhen you specify `true` for this option, you must also omit values for `Settings` and `Assets` in the request." }, "userPoolId": { "type": "string", @@ -197263,7 +197518,7 @@ "items": { "type": "string" }, - "description": "Attributes supported as an alias for this user pool. Possible values: *phone_number* , *email* , or *preferred_username* ." + "description": "Attributes supported as an alias for this user pool. Possible values: *phone_number* , *email* , or *preferred_username* . For more information about alias attributes, see [Customizing sign-in attributes](https://docs.aws.amazon.com/cognito/latest/developerguide/user-pool-settings-attributes.html#user-pool-settings-aliases) ." }, "arn": { "type": "string", @@ -197274,7 +197529,7 @@ "items": { "type": "string" }, - "description": "The attributes to be auto-verified. Possible values: *email* , *phone_number* ." + "description": "The attributes that you want your user pool to automatically verify. Possible values: *email* , *phone_number* . For more information see [Verifying contact information at sign-up](https://docs.aws.amazon.com/cognito/latest/developerguide/signing-up-users-in-your-app.html#allowing-users-to-sign-up-and-confirm-themselves) ." }, "deletionProtection": { "type": "string", @@ -197282,7 +197537,7 @@ }, "deviceConfiguration": { "$ref": "#/types/aws-native:cognito:UserPoolDeviceConfiguration", - "description": "The device-remembering configuration for a user pool. A null value indicates that you have deactivated device remembering in your user pool.\n\n\u003e When you provide a value for any `DeviceConfiguration` field, you activate the Amazon Cognito device-remembering feature." + "description": "The device-remembering configuration for a user pool. Device remembering or device tracking is a \"Remember me on this device\" option for user pools that perform authentication with the device key of a trusted device in the back end, instead of a user-provided MFA code. For more information about device authentication, see [Working with user devices in your user pool](https://docs.aws.amazon.com/cognito/latest/developerguide/amazon-cognito-user-pools-device-tracking.html) . A null value indicates that you have deactivated device remembering in your user pool.\n\n\u003e When you provide a value for any `DeviceConfiguration` field, you activate the Amazon Cognito device-remembering feature. For more infor" }, "emailAuthenticationMessage": { "type": "string" @@ -197334,7 +197589,7 @@ "items": { "$ref": "#/types/aws-native:cognito:UserPoolSchemaAttribute" }, - "description": "An array of schema attributes for the new user pool. These attributes can be standard or custom attributes." + "description": "An array of attributes for the new user pool. You can add custom attributes and modify the properties of default attributes. The specifications in this parameter set the required attributes in your user pool. For more information, see [Working with user attributes](https://docs.aws.amazon.com/cognito/latest/developerguide/user-pool-settings-attributes.html) ." }, "smsAuthenticationMessage": { "type": "string", @@ -197342,7 +197597,7 @@ }, "smsConfiguration": { "$ref": "#/types/aws-native:cognito:UserPoolSmsConfiguration", - "description": "The SMS configuration with the settings that your Amazon Cognito user pool must use to send an SMS message from your AWS account through Amazon Simple Notification Service. To send SMS messages with Amazon SNS in the AWS Region that you want, the Amazon Cognito user pool uses an AWS Identity and Access Management (IAM) role in your AWS account ." + "description": "The SMS configuration with the settings that your Amazon Cognito user pool must use to send an SMS message from your AWS account through Amazon Simple Notification Service. To send SMS messages with Amazon SNS in the AWS Region that you want, the Amazon Cognito user pool uses an AWS Identity and Access Management (IAM) role in your AWS account . For more information see [SMS message settings](https://docs.aws.amazon.com/cognito/latest/developerguide/user-pool-sms-settings.html) ." }, "smsVerificationMessage": { "type": "string", @@ -197362,7 +197617,7 @@ }, "userPoolName": { "type": "string", - "description": "A string used to name the user pool." + "description": "A friendlhy name for your user pool." }, "userPoolTags": { "type": "object", @@ -197384,17 +197639,19 @@ }, "usernameConfiguration": { "$ref": "#/types/aws-native:cognito:UserPoolUsernameConfiguration", - "description": "Case sensitivity on the username input for the selected sign-in option. When case sensitivity is set to `False` (case insensitive), users can sign in with any combination of capital and lowercase letters. For example, `username` , `USERNAME` , or `UserName` , or for email, `email@example.com` or `EMaiL@eXamplE.Com` . For most use cases, set case sensitivity to `False` (case insensitive) as a best practice. When usernames and email addresses are case insensitive, Amazon Cognito treats any variation in case as the same user, and prevents a case variation from being assigned to the same attribute for a different user.\n\nThis configuration is immutable after you set it. For more information, see [UsernameConfigurationType](https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_UsernameConfigurationType.html) ." + "description": "Sets the case sensitivity option for sign-in usernames. When `CaseSensitive` is `false` (case insensitive), users can sign in with any combination of capital and lowercase letters. For example, `username` , `USERNAME` , or `UserName` , or for email, `email@example.com` or `EMaiL@eXamplE.Com` . For most use cases, set case sensitivity to `false` as a best practice. When usernames and email addresses are case insensitive, Amazon Cognito treats any variation in case as the same user, and prevents a case variation from being assigned to the same attribute for a different user.\n\nWhen `CaseSensitive` is `true` (case sensitive), Amazon Cognito interprets `USERNAME` and `UserName` as distinct users.\n\nThis configuration is immutable after you set it." }, "verificationMessageTemplate": { "$ref": "#/types/aws-native:cognito:UserPoolVerificationMessageTemplate", "description": "The template for the verification message that your user pool delivers to users who set an email address or phone number attribute.\n\nSet the email message type that corresponds to your `DefaultEmailOption` selection. For `CONFIRM_WITH_LINK` , specify an `EmailMessageByLink` and leave `EmailMessage` blank. For `CONFIRM_WITH_CODE` , specify an `EmailMessage` and leave `EmailMessageByLink` blank. When you supply both parameters with either choice, Amazon Cognito returns an error." }, "webAuthnRelyingPartyId": { - "type": "string" + "type": "string", + "description": "Sets or displays the authentication domain, typically your user pool domain, that passkey providers must use as a relying party (RP) in their configuration.\n\nUnder the following conditions, the passkey relying party ID must be the fully-qualified domain name of your custom domain:\n\n- The user pool is configured for passkey authentication.\n- The user pool has a custom domain, whether or not it also has a prefix domain.\n- Your application performs authentication with managed login or the classic hosted UI." }, "webAuthnUserVerification": { - "type": "string" + "type": "string", + "description": "When `required` , users can only register and sign in users with passkeys that are capable of [user verification](https://docs.aws.amazon.com/https://www.w3.org/TR/webauthn-2/#enum-userVerificationRequirement) . When `preferred` , your user pool doesn't require the use of authenticators with user verification but encourages it." } }, "type": "object", @@ -197418,14 +197675,14 @@ "items": { "type": "string" }, - "description": "Attributes supported as an alias for this user pool. Possible values: *phone_number* , *email* , or *preferred_username* ." + "description": "Attributes supported as an alias for this user pool. Possible values: *phone_number* , *email* , or *preferred_username* . For more information about alias attributes, see [Customizing sign-in attributes](https://docs.aws.amazon.com/cognito/latest/developerguide/user-pool-settings-attributes.html#user-pool-settings-aliases) ." }, "autoVerifiedAttributes": { "type": "array", "items": { "type": "string" }, - "description": "The attributes to be auto-verified. Possible values: *email* , *phone_number* ." + "description": "The attributes that you want your user pool to automatically verify. Possible values: *email* , *phone_number* . For more information see [Verifying contact information at sign-up](https://docs.aws.amazon.com/cognito/latest/developerguide/signing-up-users-in-your-app.html#allowing-users-to-sign-up-and-confirm-themselves) ." }, "deletionProtection": { "type": "string", @@ -197433,7 +197690,7 @@ }, "deviceConfiguration": { "$ref": "#/types/aws-native:cognito:UserPoolDeviceConfiguration", - "description": "The device-remembering configuration for a user pool. A null value indicates that you have deactivated device remembering in your user pool.\n\n\u003e When you provide a value for any `DeviceConfiguration` field, you activate the Amazon Cognito device-remembering feature." + "description": "The device-remembering configuration for a user pool. Device remembering or device tracking is a \"Remember me on this device\" option for user pools that perform authentication with the device key of a trusted device in the back end, instead of a user-provided MFA code. For more information about device authentication, see [Working with user devices in your user pool](https://docs.aws.amazon.com/cognito/latest/developerguide/amazon-cognito-user-pools-device-tracking.html) . A null value indicates that you have deactivated device remembering in your user pool.\n\n\u003e When you provide a value for any `DeviceConfiguration` field, you activate the Amazon Cognito device-remembering feature. For more infor" }, "emailAuthenticationMessage": { "type": "string" @@ -197477,7 +197734,7 @@ "items": { "$ref": "#/types/aws-native:cognito:UserPoolSchemaAttribute" }, - "description": "An array of schema attributes for the new user pool. These attributes can be standard or custom attributes." + "description": "An array of attributes for the new user pool. You can add custom attributes and modify the properties of default attributes. The specifications in this parameter set the required attributes in your user pool. For more information, see [Working with user attributes](https://docs.aws.amazon.com/cognito/latest/developerguide/user-pool-settings-attributes.html) ." }, "smsAuthenticationMessage": { "type": "string", @@ -197485,7 +197742,7 @@ }, "smsConfiguration": { "$ref": "#/types/aws-native:cognito:UserPoolSmsConfiguration", - "description": "The SMS configuration with the settings that your Amazon Cognito user pool must use to send an SMS message from your AWS account through Amazon Simple Notification Service. To send SMS messages with Amazon SNS in the AWS Region that you want, the Amazon Cognito user pool uses an AWS Identity and Access Management (IAM) role in your AWS account ." + "description": "The SMS configuration with the settings that your Amazon Cognito user pool must use to send an SMS message from your AWS account through Amazon Simple Notification Service. To send SMS messages with Amazon SNS in the AWS Region that you want, the Amazon Cognito user pool uses an AWS Identity and Access Management (IAM) role in your AWS account . For more information see [SMS message settings](https://docs.aws.amazon.com/cognito/latest/developerguide/user-pool-sms-settings.html) ." }, "smsVerificationMessage": { "type": "string", @@ -197501,7 +197758,7 @@ }, "userPoolName": { "type": "string", - "description": "A string used to name the user pool." + "description": "A friendlhy name for your user pool." }, "userPoolTags": { "type": "object", @@ -197523,17 +197780,19 @@ }, "usernameConfiguration": { "$ref": "#/types/aws-native:cognito:UserPoolUsernameConfiguration", - "description": "Case sensitivity on the username input for the selected sign-in option. When case sensitivity is set to `False` (case insensitive), users can sign in with any combination of capital and lowercase letters. For example, `username` , `USERNAME` , or `UserName` , or for email, `email@example.com` or `EMaiL@eXamplE.Com` . For most use cases, set case sensitivity to `False` (case insensitive) as a best practice. When usernames and email addresses are case insensitive, Amazon Cognito treats any variation in case as the same user, and prevents a case variation from being assigned to the same attribute for a different user.\n\nThis configuration is immutable after you set it. For more information, see [UsernameConfigurationType](https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_UsernameConfigurationType.html) ." + "description": "Sets the case sensitivity option for sign-in usernames. When `CaseSensitive` is `false` (case insensitive), users can sign in with any combination of capital and lowercase letters. For example, `username` , `USERNAME` , or `UserName` , or for email, `email@example.com` or `EMaiL@eXamplE.Com` . For most use cases, set case sensitivity to `false` as a best practice. When usernames and email addresses are case insensitive, Amazon Cognito treats any variation in case as the same user, and prevents a case variation from being assigned to the same attribute for a different user.\n\nWhen `CaseSensitive` is `true` (case sensitive), Amazon Cognito interprets `USERNAME` and `UserName` as distinct users.\n\nThis configuration is immutable after you set it." }, "verificationMessageTemplate": { "$ref": "#/types/aws-native:cognito:UserPoolVerificationMessageTemplate", "description": "The template for the verification message that your user pool delivers to users who set an email address or phone number attribute.\n\nSet the email message type that corresponds to your `DefaultEmailOption` selection. For `CONFIRM_WITH_LINK` , specify an `EmailMessageByLink` and leave `EmailMessage` blank. For `CONFIRM_WITH_CODE` , specify an `EmailMessage` and leave `EmailMessageByLink` blank. When you supply both parameters with either choice, Amazon Cognito returns an error." }, "webAuthnRelyingPartyId": { - "type": "string" + "type": "string", + "description": "Sets or displays the authentication domain, typically your user pool domain, that passkey providers must use as a relying party (RP) in their configuration.\n\nUnder the following conditions, the passkey relying party ID must be the fully-qualified domain name of your custom domain:\n\n- The user pool is configured for passkey authentication.\n- The user pool has a custom domain, whether or not it also has a prefix domain.\n- Your application performs authentication with managed login or the classic hosted UI." }, "webAuthnUserVerification": { - "type": "string" + "type": "string", + "description": "When `required` , users can only register and sign in users with passkeys that are capable of [user verification](https://docs.aws.amazon.com/https://www.w3.org/TR/webauthn-2/#enum-userVerificationRequirement) . When `preferred` , your user pool doesn't require the use of authenticators with user verification but encourages it." } } }, @@ -197560,11 +197819,11 @@ "items": { "type": "string" }, - "description": "The allowed OAuth scopes. Possible values provided by OAuth are `phone` , `email` , `openid` , and `profile` . Possible values provided by AWS are `aws.cognito.signin.user.admin` . Custom scopes created in Resource Servers are also supported." + "description": "The OAuth 2.0 scopes that you want to permit your app client to authorize. Scopes govern access control to user pool self-service API operations, user data from the `userInfo` endpoint, and third-party APIs. Possible values provided by OAuth are `phone` , `email` , `openid` , and `profile` . Possible values provided by AWS are `aws.cognito.signin.user.admin` . Custom scopes created in Resource Servers are also supported." }, "analyticsConfiguration": { "$ref": "#/types/aws-native:cognito:UserPoolClientAnalyticsConfiguration", - "description": "The user pool analytics configuration for collecting metrics and sending them to your Amazon Pinpoint campaign.\n\n\u003e In AWS Regions where Amazon Pinpoint isn't available, user pools only support sending events to Amazon Pinpoint projects in AWS Region us-east-1. In Regions where Amazon Pinpoint is available, user pools support sending events to Amazon Pinpoint projects within that same Region." + "description": "The user pool analytics configuration for collecting metrics and sending them to your Amazon Pinpoint campaign.\n\nIn AWS Regions where Amazon Pinpoint isn't available, user pools might not have access to analytics or might be configurable with campaigns in the US East (N. Virginia) Region. For more information, see [Using Amazon Pinpoint analytics](https://docs.aws.amazon.com/cognito/latest/developerguide/cognito-user-pools-pinpoint-integration.html) ." }, "authSessionValidity": { "type": "integer", @@ -197575,7 +197834,7 @@ "items": { "type": "string" }, - "description": "A list of allowed redirect (callback) URLs for the IdPs.\n\nA redirect URI must:\n\n- Be an absolute URI.\n- Be registered with the authorization server.\n- Not include a fragment component.\n\nSee [OAuth 2.0 - Redirection Endpoint](https://docs.aws.amazon.com/https://tools.ietf.org/html/rfc6749#section-3.1.2) .\n\nAmazon Cognito requires HTTPS over HTTP except for http://localhost for testing purposes only.\n\nApp callback URLs such as myapp://example are also supported." + "description": "A list of allowed redirect (callback) URLs for the IdPs.\n\nA redirect URI must:\n\n- Be an absolute URI.\n- Be registered with the authorization server. Amazon Cognito doesn't accept authorization requests with `redirect_uri` values that aren't in the list of `CallbackURLs` that you provide in this parameter.\n- Not include a fragment component.\n\nSee [OAuth 2.0 - Redirection Endpoint](https://docs.aws.amazon.com/https://tools.ietf.org/html/rfc6749#section-3.1.2) .\n\nAmazon Cognito requires HTTPS over HTTP except for http://localhost for testing purposes only.\n\nApp callback URLs such as myapp://example are also supported." }, "clientId": { "type": "string", @@ -197583,14 +197842,14 @@ }, "clientName": { "type": "string", - "description": "The client name for the user pool client you would like to create." + "description": "A friendly name for the app client that you want to create." }, "clientSecret": { "type": "string" }, "defaultRedirectUri": { "type": "string", - "description": "The default redirect URI. In app clients with one assigned IdP, replaces `redirect_uri` in authentication requests. Must be in the `CallbackURLs` list.\n\nA redirect URI must:\n\n- Be an absolute URI.\n- Be registered with the authorization server.\n- Not include a fragment component.\n\nFor more information, see [Default redirect URI](https://docs.aws.amazon.com/cognito/latest/developerguide/user-pool-settings-client-apps.html#cognito-user-pools-app-idp-settings-about) .\n\nAmazon Cognito requires HTTPS over HTTP except for http://localhost for testing purposes only.\n\nApp callback URLs such as myapp://example are also supported." + "description": "The default redirect URI. In app clients with one assigned IdP, replaces `redirect_uri` in authentication requests. Must be in the `CallbackURLs` list." }, "enablePropagateAdditionalUserContextData": { "type": "boolean", @@ -197609,7 +197868,7 @@ }, "generateSecret": { "type": "boolean", - "description": "Boolean to specify whether you want to generate a secret for the user pool client being created.", + "description": "When `true` , generates a client secret for the app client. Client secrets are used with server-side and machine-to-machine applications. For more information, see [App client types](https://docs.aws.amazon.com/cognito/latest/developerguide/user-pool-settings-client-apps.html#user-pool-settings-client-app-client-types) .", "replaceOnChanges": true }, "idTokenValidity": { @@ -197621,7 +197880,7 @@ "items": { "type": "string" }, - "description": "A list of allowed logout URLs for the IdPs." + "description": "A list of allowed logout URLs for managed login authentication. For more information, see [Logout endpoint](https://docs.aws.amazon.com/cognito/latest/developerguide/logout-endpoint.html) ." }, "name": { "type": "string" @@ -197646,15 +197905,15 @@ "items": { "type": "string" }, - "description": "A list of provider names for the identity providers (IdPs) that are supported on this client. The following are supported: `COGNITO` , `Facebook` , `Google` , `SignInWithApple` , and `LoginWithAmazon` . You can also specify the names that you configured for the SAML and OIDC IdPs in your user pool, for example `MySAMLIdP` or `MyOIDCIdP` .\n\nThis setting applies to providers that you can access with the [hosted UI and OAuth 2.0 authorization server](https://docs.aws.amazon.com/cognito/latest/developerguide/cognito-user-pools-app-integration.html) . The removal of `COGNITO` from this list doesn't prevent authentication operations for local users with the user pools API in an AWS SDK. The only way to prevent API-based authentication is to block access with a [AWS WAF rule](https://docs.aws.amazon.com/cognito/latest/developerguide/user-pool-waf.html) ." + "description": "A list of provider names for the identity providers (IdPs) that are supported on this client. The following are supported: `COGNITO` , `Facebook` , `Google` , `SignInWithApple` , and `LoginWithAmazon` . You can also specify the names that you configured for the SAML and OIDC IdPs in your user pool, for example `MySAMLIdP` or `MyOIDCIdP` .\n\nThis setting applies to providers that you can access with [managed login](https://docs.aws.amazon.com/cognito/latest/developerguide/cognito-user-pools-managed-login.html) . The removal of `COGNITO` from this list doesn't prevent authentication operations for local users with the user pools API in an AWS SDK. The only way to prevent API-based authentication is to block access with a [AWS WAF rule](https://docs.aws.amazon.com/cognito/latest/developerguide/user-pool-waf.html) ." }, "tokenValidityUnits": { "$ref": "#/types/aws-native:cognito:UserPoolClientTokenValidityUnits", - "description": "The units in which the validity times are represented. The default unit for RefreshToken is days, and default for ID and access tokens are hours." + "description": "The units that validity times are represented in. The default unit for refresh tokens is days, and the default for ID and access tokens are hours." }, "userPoolId": { "type": "string", - "description": "The user pool ID for the user pool where you want to create a user pool client.", + "description": "The ID of the user pool where you want to create an app client.", "replaceOnChanges": true }, "writeAttributes": { @@ -197693,11 +197952,11 @@ "items": { "type": "string" }, - "description": "The allowed OAuth scopes. Possible values provided by OAuth are `phone` , `email` , `openid` , and `profile` . Possible values provided by AWS are `aws.cognito.signin.user.admin` . Custom scopes created in Resource Servers are also supported." + "description": "The OAuth 2.0 scopes that you want to permit your app client to authorize. Scopes govern access control to user pool self-service API operations, user data from the `userInfo` endpoint, and third-party APIs. Possible values provided by OAuth are `phone` , `email` , `openid` , and `profile` . Possible values provided by AWS are `aws.cognito.signin.user.admin` . Custom scopes created in Resource Servers are also supported." }, "analyticsConfiguration": { "$ref": "#/types/aws-native:cognito:UserPoolClientAnalyticsConfiguration", - "description": "The user pool analytics configuration for collecting metrics and sending them to your Amazon Pinpoint campaign.\n\n\u003e In AWS Regions where Amazon Pinpoint isn't available, user pools only support sending events to Amazon Pinpoint projects in AWS Region us-east-1. In Regions where Amazon Pinpoint is available, user pools support sending events to Amazon Pinpoint projects within that same Region." + "description": "The user pool analytics configuration for collecting metrics and sending them to your Amazon Pinpoint campaign.\n\nIn AWS Regions where Amazon Pinpoint isn't available, user pools might not have access to analytics or might be configurable with campaigns in the US East (N. Virginia) Region. For more information, see [Using Amazon Pinpoint analytics](https://docs.aws.amazon.com/cognito/latest/developerguide/cognito-user-pools-pinpoint-integration.html) ." }, "authSessionValidity": { "type": "integer", @@ -197708,15 +197967,15 @@ "items": { "type": "string" }, - "description": "A list of allowed redirect (callback) URLs for the IdPs.\n\nA redirect URI must:\n\n- Be an absolute URI.\n- Be registered with the authorization server.\n- Not include a fragment component.\n\nSee [OAuth 2.0 - Redirection Endpoint](https://docs.aws.amazon.com/https://tools.ietf.org/html/rfc6749#section-3.1.2) .\n\nAmazon Cognito requires HTTPS over HTTP except for http://localhost for testing purposes only.\n\nApp callback URLs such as myapp://example are also supported." + "description": "A list of allowed redirect (callback) URLs for the IdPs.\n\nA redirect URI must:\n\n- Be an absolute URI.\n- Be registered with the authorization server. Amazon Cognito doesn't accept authorization requests with `redirect_uri` values that aren't in the list of `CallbackURLs` that you provide in this parameter.\n- Not include a fragment component.\n\nSee [OAuth 2.0 - Redirection Endpoint](https://docs.aws.amazon.com/https://tools.ietf.org/html/rfc6749#section-3.1.2) .\n\nAmazon Cognito requires HTTPS over HTTP except for http://localhost for testing purposes only.\n\nApp callback URLs such as myapp://example are also supported." }, "clientName": { "type": "string", - "description": "The client name for the user pool client you would like to create." + "description": "A friendly name for the app client that you want to create." }, "defaultRedirectUri": { "type": "string", - "description": "The default redirect URI. In app clients with one assigned IdP, replaces `redirect_uri` in authentication requests. Must be in the `CallbackURLs` list.\n\nA redirect URI must:\n\n- Be an absolute URI.\n- Be registered with the authorization server.\n- Not include a fragment component.\n\nFor more information, see [Default redirect URI](https://docs.aws.amazon.com/cognito/latest/developerguide/user-pool-settings-client-apps.html#cognito-user-pools-app-idp-settings-about) .\n\nAmazon Cognito requires HTTPS over HTTP except for http://localhost for testing purposes only.\n\nApp callback URLs such as myapp://example are also supported." + "description": "The default redirect URI. In app clients with one assigned IdP, replaces `redirect_uri` in authentication requests. Must be in the `CallbackURLs` list." }, "enablePropagateAdditionalUserContextData": { "type": "boolean", @@ -197735,7 +197994,7 @@ }, "generateSecret": { "type": "boolean", - "description": "Boolean to specify whether you want to generate a secret for the user pool client being created." + "description": "When `true` , generates a client secret for the app client. Client secrets are used with server-side and machine-to-machine applications. For more information, see [App client types](https://docs.aws.amazon.com/cognito/latest/developerguide/user-pool-settings-client-apps.html#user-pool-settings-client-app-client-types) ." }, "idTokenValidity": { "type": "integer", @@ -197746,7 +198005,7 @@ "items": { "type": "string" }, - "description": "A list of allowed logout URLs for the IdPs." + "description": "A list of allowed logout URLs for managed login authentication. For more information, see [Logout endpoint](https://docs.aws.amazon.com/cognito/latest/developerguide/logout-endpoint.html) ." }, "preventUserExistenceErrors": { "type": "string", @@ -197768,15 +198027,15 @@ "items": { "type": "string" }, - "description": "A list of provider names for the identity providers (IdPs) that are supported on this client. The following are supported: `COGNITO` , `Facebook` , `Google` , `SignInWithApple` , and `LoginWithAmazon` . You can also specify the names that you configured for the SAML and OIDC IdPs in your user pool, for example `MySAMLIdP` or `MyOIDCIdP` .\n\nThis setting applies to providers that you can access with the [hosted UI and OAuth 2.0 authorization server](https://docs.aws.amazon.com/cognito/latest/developerguide/cognito-user-pools-app-integration.html) . The removal of `COGNITO` from this list doesn't prevent authentication operations for local users with the user pools API in an AWS SDK. The only way to prevent API-based authentication is to block access with a [AWS WAF rule](https://docs.aws.amazon.com/cognito/latest/developerguide/user-pool-waf.html) ." + "description": "A list of provider names for the identity providers (IdPs) that are supported on this client. The following are supported: `COGNITO` , `Facebook` , `Google` , `SignInWithApple` , and `LoginWithAmazon` . You can also specify the names that you configured for the SAML and OIDC IdPs in your user pool, for example `MySAMLIdP` or `MyOIDCIdP` .\n\nThis setting applies to providers that you can access with [managed login](https://docs.aws.amazon.com/cognito/latest/developerguide/cognito-user-pools-managed-login.html) . The removal of `COGNITO` from this list doesn't prevent authentication operations for local users with the user pools API in an AWS SDK. The only way to prevent API-based authentication is to block access with a [AWS WAF rule](https://docs.aws.amazon.com/cognito/latest/developerguide/user-pool-waf.html) ." }, "tokenValidityUnits": { "$ref": "#/types/aws-native:cognito:UserPoolClientTokenValidityUnits", - "description": "The units in which the validity times are represented. The default unit for RefreshToken is days, and default for ID and access tokens are hours." + "description": "The units that validity times are represented in. The default unit for refresh tokens is days, and the default for ID and access tokens are hours." }, "userPoolId": { "type": "string", - "description": "The user pool ID for the user pool where you want to create a user pool client." + "description": "The ID of the user pool where you want to create an app client." }, "writeAttributes": { "type": "array", @@ -197855,11 +198114,11 @@ "properties": { "description": { "type": "string", - "description": "A string containing the description of the group." + "description": "A description of the group that you're creating." }, "groupName": { "type": "string", - "description": "The name of the group. Must be unique.", + "description": "A name for the group. This name must be unique in your user pool.", "replaceOnChanges": true }, "precedence": { @@ -197868,11 +198127,11 @@ }, "roleArn": { "type": "string", - "description": "The role Amazon Resource Name (ARN) for the group." + "description": "The Amazon Resource Name (ARN) for the IAM role that you want to associate with the group. A group role primarily declares a preferred role for the credentials that you get from an identity pool. Amazon Cognito ID tokens have a `cognito:preferred_role` claim that presents the highest-precedence group that a user belongs to. Both ID and access tokens also contain a `cognito:groups` claim that list all the groups that a user is a member of." }, "userPoolId": { "type": "string", - "description": "The user pool ID for the user pool.", + "description": "The ID of the user pool where you want to create a user group.", "replaceOnChanges": true } }, @@ -197883,11 +198142,11 @@ "inputProperties": { "description": { "type": "string", - "description": "A string containing the description of the group." + "description": "A description of the group that you're creating." }, "groupName": { "type": "string", - "description": "The name of the group. Must be unique." + "description": "A name for the group. This name must be unique in your user pool." }, "precedence": { "type": "integer", @@ -197895,11 +198154,11 @@ }, "roleArn": { "type": "string", - "description": "The role Amazon Resource Name (ARN) for the group." + "description": "The Amazon Resource Name (ARN) for the IAM role that you want to associate with the group. A group role primarily declares a preferred role for the credentials that you get from an identity pool. Amazon Cognito ID tokens have a `cognito:preferred_role` claim that presents the highest-precedence group that a user belongs to. Both ID and access tokens also contain a `cognito:groups` claim that list all the groups that a user is a member of." }, "userPoolId": { "type": "string", - "description": "The user pool ID for the user pool." + "description": "The ID of the user pool where you want to create a user group." } }, "requiredInputs": [ @@ -197914,14 +198173,14 @@ "additionalProperties": { "type": "string" }, - "description": "A mapping of IdP attributes to standard and custom user pool attributes." + "description": "A mapping of IdP attributes to standard and custom user pool attributes. Specify a user pool attribute as the key of the key-value pair, and the IdP attribute claim name as the value." }, "idpIdentifiers": { "type": "array", "items": { "type": "string" }, - "description": "A list of IdP identifiers." + "description": "An array of IdP identifiers, for example `\"IdPIdentifiers\": [ \"MyIdP\", \"MyIdP2\" ]` . Identifiers are friendly names that you can pass in the `idp_identifier` query parameter of requests to the [Authorize endpoint](https://docs.aws.amazon.com/cognito/latest/developerguide/authorization-endpoint.html) to silently redirect to sign-in with the associated IdP. Identifiers in a domain format also enable the use of [email-address matching with SAML providers](https://docs.aws.amazon.com/cognito/latest/developerguide/cognito-user-pools-managing-saml-idp-naming.html) ." }, "providerDetails": { "type": "object", @@ -197932,17 +198191,17 @@ }, "providerName": { "type": "string", - "description": "The IdP name.", + "description": "The name that you want to assign to the IdP. You can pass the identity provider name in the `identity_provider` query parameter of requests to the [Authorize endpoint](https://docs.aws.amazon.com/cognito/latest/developerguide/authorization-endpoint.html) to silently redirect to sign-in with the associated IdP.", "replaceOnChanges": true }, "providerType": { "type": "string", - "description": "The IdP type.", + "description": "The type of IdP that you want to add. Amazon Cognito supports OIDC, SAML 2.0, Login With Amazon, Sign In With Apple, Google, and Facebook IdPs.", "replaceOnChanges": true }, "userPoolId": { "type": "string", - "description": "The user pool ID.", + "description": "The Id of the user pool where you want to create an IdP.", "replaceOnChanges": true } }, @@ -197959,14 +198218,14 @@ "additionalProperties": { "type": "string" }, - "description": "A mapping of IdP attributes to standard and custom user pool attributes." + "description": "A mapping of IdP attributes to standard and custom user pool attributes. Specify a user pool attribute as the key of the key-value pair, and the IdP attribute claim name as the value." }, "idpIdentifiers": { "type": "array", "items": { "type": "string" }, - "description": "A list of IdP identifiers." + "description": "An array of IdP identifiers, for example `\"IdPIdentifiers\": [ \"MyIdP\", \"MyIdP2\" ]` . Identifiers are friendly names that you can pass in the `idp_identifier` query parameter of requests to the [Authorize endpoint](https://docs.aws.amazon.com/cognito/latest/developerguide/authorization-endpoint.html) to silently redirect to sign-in with the associated IdP. Identifiers in a domain format also enable the use of [email-address matching with SAML providers](https://docs.aws.amazon.com/cognito/latest/developerguide/cognito-user-pools-managing-saml-idp-naming.html) ." }, "providerDetails": { "type": "object", @@ -197977,15 +198236,15 @@ }, "providerName": { "type": "string", - "description": "The IdP name." + "description": "The name that you want to assign to the IdP. You can pass the identity provider name in the `identity_provider` query parameter of requests to the [Authorize endpoint](https://docs.aws.amazon.com/cognito/latest/developerguide/authorization-endpoint.html) to silently redirect to sign-in with the associated IdP." }, "providerType": { "type": "string", - "description": "The IdP type." + "description": "The type of IdP that you want to add. Amazon Cognito supports OIDC, SAML 2.0, Login With Amazon, Sign In With Apple, Google, and Facebook IdPs." }, "userPoolId": { "type": "string", - "description": "The user pool ID." + "description": "The Id of the user pool where you want to create an IdP." } }, "requiredInputs": [ @@ -198015,7 +198274,7 @@ }, "userPoolId": { "type": "string", - "description": "The user pool ID for the user pool.", + "description": "The ID of the user pool where you want to create a resource server.", "replaceOnChanges": true } }, @@ -198043,7 +198302,7 @@ }, "userPoolId": { "type": "string", - "description": "The user pool ID for the user pool." + "description": "The ID of the user pool where you want to create a resource server." } }, "requiredInputs": [ @@ -198123,7 +198382,7 @@ }, "userPoolId": { "type": "string", - "description": "The user pool ID for the user pool.", + "description": "The ID of the user pool.", "replaceOnChanges": true } }, @@ -198143,7 +198402,7 @@ }, "userPoolId": { "type": "string", - "description": "The user pool ID for the user pool." + "description": "The ID of the user pool." } }, "requiredInputs": [ @@ -198159,7 +198418,7 @@ "additionalProperties": { "type": "string" }, - "description": "A map of custom key-value pairs that you can provide as input for any custom workflows that this action triggers.\n\nYou create custom workflows by assigning AWS Lambda functions to user pool triggers. When you use the AdminCreateUser API action, Amazon Cognito invokes the function that is assigned to the *pre sign-up* trigger. When Amazon Cognito invokes this function, it passes a JSON payload, which the function receives as input. This payload contains a `clientMetadata` attribute, which provides the data that you assigned to the ClientMetadata parameter in your AdminCreateUser request. In your function code in AWS Lambda , you can process the `clientMetadata` value to enhance your workflow for your specific needs.\n\nFor more information, see [Customizing user pool Workflows with Lambda Triggers](https://docs.aws.amazon.com/cognito/latest/developerguide/cognito-user-identity-pools-working-with-aws-lambda-triggers.html) in the *Amazon Cognito Developer Guide* .\n\n\u003e When you use the ClientMetadata parameter, remember that Amazon Cognito won't do the following:\n\u003e \n\u003e - Store the ClientMetadata value. This data is available only to AWS Lambda triggers that are assigned to a user pool to support custom workflows. If your user pool configuration doesn't include triggers, the ClientMetadata parameter serves no purpose.\n\u003e - Validate the ClientMetadata value.\n\u003e - Encrypt the ClientMetadata value. Don't use Amazon Cognito to provide sensitive information.", + "description": "A map of custom key-value pairs that you can provide as input for any custom workflows that this action triggers.\n\nYou create custom workflows by assigning AWS Lambda functions to user pool triggers. When you use the AdminCreateUser API action, Amazon Cognito invokes the function that is assigned to the *pre sign-up* trigger. When Amazon Cognito invokes this function, it passes a JSON payload, which the function receives as input. This payload contains a `ClientMetadata` attribute, which provides the data that you assigned to the ClientMetadata parameter in your AdminCreateUser request. In your function code in AWS Lambda , you can process the `clientMetadata` value to enhance your workflow for your specific needs.\n\nFor more information, see [Customizing user pool Workflows with Lambda Triggers](https://docs.aws.amazon.com/cognito/latest/developerguide/cognito-user-identity-pools-working-with-aws-lambda-triggers.html) in the *Amazon Cognito Developer Guide* .\n\n\u003e When you use the `ClientMetadata` parameter, note that Amazon Cognito won't do the following:\n\u003e \n\u003e - Store the `ClientMetadata` value. This data is available only to AWS Lambda triggers that are assigned to a user pool to support custom workflows. If your user pool configuration doesn't include triggers, the `ClientMetadata` parameter serves no purpose.\n\u003e - Validate the `ClientMetadata` value.\n\u003e - Encrypt the `ClientMetadata` value. Don't send sensitive information in this parameter.", "replaceOnChanges": true }, "desiredDeliveryMediums": { @@ -198167,17 +198426,17 @@ "items": { "type": "string" }, - "description": "Specify `\"EMAIL\"` if email will be used to send the welcome message. Specify `\"SMS\"` if the phone number will be used. The default value is `\"SMS\"` . You can specify more than one value.", + "description": "Specify `EMAIL` if email will be used to send the welcome message. Specify `SMS` if the phone number will be used. The default value is `SMS` . You can specify more than one value.", "replaceOnChanges": true }, "forceAliasCreation": { "type": "boolean", - "description": "This parameter is used only if the `phone_number_verified` or `email_verified` attribute is set to `True` . Otherwise, it is ignored.\n\nIf this parameter is set to `True` and the phone number or email address specified in the UserAttributes parameter already exists as an alias with a different user, the API call will migrate the alias from the previous user to the newly created user. The previous user will no longer be able to log in using that alias.\n\nIf this parameter is set to `False` , the API throws an `AliasExistsException` error if the alias already exists. The default value is `False` .", + "description": "This parameter is used only if the `phone_number_verified` or `email_verified` attribute is set to `True` . Otherwise, it is ignored.\n\nIf this parameter is set to `True` and the phone number or email address specified in the `UserAttributes` parameter already exists as an alias with a different user, this request migrates the alias from the previous user to the newly-created user. The previous user will no longer be able to log in using that alias.\n\nIf this parameter is set to `False` , the API throws an `AliasExistsException` error if the alias already exists. The default value is `False` .", "replaceOnChanges": true }, "messageAction": { "type": "string", - "description": "Set to `RESEND` to resend the invitation message to a user that already exists and reset the expiration limit on the user's account. Set to `SUPPRESS` to suppress sending the message. You can specify only one value.", + "description": "Set to `RESEND` to resend the invitation message to a user that already exists, and to reset the temporary-password duration with a new temporary password. Set to `SUPPRESS` to suppress sending the message. You can specify only one value.", "replaceOnChanges": true }, "userAttributes": { @@ -198190,7 +198449,7 @@ }, "userPoolId": { "type": "string", - "description": "The user pool ID for the user pool where the user will be created.", + "description": "The ID of the user pool where you want to create a user.", "replaceOnChanges": true }, "username": { @@ -198217,22 +198476,22 @@ "additionalProperties": { "type": "string" }, - "description": "A map of custom key-value pairs that you can provide as input for any custom workflows that this action triggers.\n\nYou create custom workflows by assigning AWS Lambda functions to user pool triggers. When you use the AdminCreateUser API action, Amazon Cognito invokes the function that is assigned to the *pre sign-up* trigger. When Amazon Cognito invokes this function, it passes a JSON payload, which the function receives as input. This payload contains a `clientMetadata` attribute, which provides the data that you assigned to the ClientMetadata parameter in your AdminCreateUser request. In your function code in AWS Lambda , you can process the `clientMetadata` value to enhance your workflow for your specific needs.\n\nFor more information, see [Customizing user pool Workflows with Lambda Triggers](https://docs.aws.amazon.com/cognito/latest/developerguide/cognito-user-identity-pools-working-with-aws-lambda-triggers.html) in the *Amazon Cognito Developer Guide* .\n\n\u003e When you use the ClientMetadata parameter, remember that Amazon Cognito won't do the following:\n\u003e \n\u003e - Store the ClientMetadata value. This data is available only to AWS Lambda triggers that are assigned to a user pool to support custom workflows. If your user pool configuration doesn't include triggers, the ClientMetadata parameter serves no purpose.\n\u003e - Validate the ClientMetadata value.\n\u003e - Encrypt the ClientMetadata value. Don't use Amazon Cognito to provide sensitive information." + "description": "A map of custom key-value pairs that you can provide as input for any custom workflows that this action triggers.\n\nYou create custom workflows by assigning AWS Lambda functions to user pool triggers. When you use the AdminCreateUser API action, Amazon Cognito invokes the function that is assigned to the *pre sign-up* trigger. When Amazon Cognito invokes this function, it passes a JSON payload, which the function receives as input. This payload contains a `ClientMetadata` attribute, which provides the data that you assigned to the ClientMetadata parameter in your AdminCreateUser request. In your function code in AWS Lambda , you can process the `clientMetadata` value to enhance your workflow for your specific needs.\n\nFor more information, see [Customizing user pool Workflows with Lambda Triggers](https://docs.aws.amazon.com/cognito/latest/developerguide/cognito-user-identity-pools-working-with-aws-lambda-triggers.html) in the *Amazon Cognito Developer Guide* .\n\n\u003e When you use the `ClientMetadata` parameter, note that Amazon Cognito won't do the following:\n\u003e \n\u003e - Store the `ClientMetadata` value. This data is available only to AWS Lambda triggers that are assigned to a user pool to support custom workflows. If your user pool configuration doesn't include triggers, the `ClientMetadata` parameter serves no purpose.\n\u003e - Validate the `ClientMetadata` value.\n\u003e - Encrypt the `ClientMetadata` value. Don't send sensitive information in this parameter." }, "desiredDeliveryMediums": { "type": "array", "items": { "type": "string" }, - "description": "Specify `\"EMAIL\"` if email will be used to send the welcome message. Specify `\"SMS\"` if the phone number will be used. The default value is `\"SMS\"` . You can specify more than one value." + "description": "Specify `EMAIL` if email will be used to send the welcome message. Specify `SMS` if the phone number will be used. The default value is `SMS` . You can specify more than one value." }, "forceAliasCreation": { "type": "boolean", - "description": "This parameter is used only if the `phone_number_verified` or `email_verified` attribute is set to `True` . Otherwise, it is ignored.\n\nIf this parameter is set to `True` and the phone number or email address specified in the UserAttributes parameter already exists as an alias with a different user, the API call will migrate the alias from the previous user to the newly created user. The previous user will no longer be able to log in using that alias.\n\nIf this parameter is set to `False` , the API throws an `AliasExistsException` error if the alias already exists. The default value is `False` ." + "description": "This parameter is used only if the `phone_number_verified` or `email_verified` attribute is set to `True` . Otherwise, it is ignored.\n\nIf this parameter is set to `True` and the phone number or email address specified in the `UserAttributes` parameter already exists as an alias with a different user, this request migrates the alias from the previous user to the newly-created user. The previous user will no longer be able to log in using that alias.\n\nIf this parameter is set to `False` , the API throws an `AliasExistsException` error if the alias already exists. The default value is `False` ." }, "messageAction": { "type": "string", - "description": "Set to `RESEND` to resend the invitation message to a user that already exists and reset the expiration limit on the user's account. Set to `SUPPRESS` to suppress sending the message. You can specify only one value." + "description": "Set to `RESEND` to resend the invitation message to a user that already exists, and to reset the temporary-password duration with a new temporary password. Set to `SUPPRESS` to suppress sending the message. You can specify only one value." }, "userAttributes": { "type": "array", @@ -198243,7 +198502,7 @@ }, "userPoolId": { "type": "string", - "description": "The user pool ID for the user pool where the user will be created." + "description": "The ID of the user pool where you want to create a user." }, "username": { "type": "string", @@ -198271,7 +198530,7 @@ }, "userPoolId": { "type": "string", - "description": "The user pool ID for the user pool.", + "description": "The ID of the user pool that contains the group that you want to add the user to.", "replaceOnChanges": true }, "username": { @@ -198293,7 +198552,7 @@ }, "userPoolId": { "type": "string", - "description": "The user pool ID for the user pool." + "description": "The ID of the user pool that contains the group that you want to add the user to." }, "username": { "type": "string", @@ -200583,6 +200842,10 @@ "type": "string", "description": "The name of the task template." }, + "selfAssignContactFlowArn": { + "type": "string", + "description": "The identifier of the contact flow." + }, "status": { "$ref": "#/types/aws-native:connect:TaskTemplateStatus", "description": "The status of the task template." @@ -200639,6 +200902,10 @@ "type": "string", "description": "The name of the task template." }, + "selfAssignContactFlowArn": { + "type": "string", + "description": "The identifier of the contact flow." + }, "status": { "$ref": "#/types/aws-native:connect:TaskTemplateStatus", "description": "The status of the task template." @@ -207741,7 +208008,7 @@ }, "importSourceSpecification": { "$ref": "#/types/aws-native:dynamodb:TableImportSourceSpecification", - "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.", "replaceOnChanges": true }, "keySchema": { @@ -207857,7 +208124,7 @@ }, "importSourceSpecification": { "$ref": "#/types/aws-native:dynamodb:TableImportSourceSpecification", - "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." }, "keySchema": { "oneOf": [ @@ -210387,7 +210654,7 @@ "items": { "$ref": "#/types/aws-native:ec2:LaunchTemplateTagSpecification" }, - "description": "The tags to apply to the launch template on creation. To tag the launch template, the resource type must be ``launch-template``.\n To specify the tags for resources that are created during instance launch, use [TagSpecifications](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-launchtemplate-launchtemplatedata.html#cfn-ec2-launchtemplate-launchtemplatedata-tagspecifications)." + "description": "The tags to apply to the launch template on creation. To tag the launch template, the resource type must be ``launch-template``.\n To specify the tags for the resources that are created when an instance is launched, you must use [TagSpecifications](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-launchtemplate-launchtemplatedata.html#cfn-ec2-launchtemplate-launchtemplatedata-tagspecifications)." }, "versionDescription": { "type": "string", @@ -210415,7 +210682,7 @@ "items": { "$ref": "#/types/aws-native:ec2:LaunchTemplateTagSpecification" }, - "description": "The tags to apply to the launch template on creation. To tag the launch template, the resource type must be ``launch-template``.\n To specify the tags for resources that are created during instance launch, use [TagSpecifications](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-launchtemplate-launchtemplatedata.html#cfn-ec2-launchtemplate-launchtemplatedata-tagspecifications)." + "description": "The tags to apply to the launch template on creation. To tag the launch template, the resource type must be ``launch-template``.\n To specify the tags for the resources that are created when an instance is launched, you must use [TagSpecifications](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-launchtemplate-launchtemplatedata.html#cfn-ec2-launchtemplate-launchtemplatedata-tagspecifications)." }, "versionDescription": { "type": "string", @@ -216102,6 +216369,10 @@ "description": "The number of ``cpu`` units used by the task. If you use the EC2 launch type, this field is optional. Any value can be used. If you use the Fargate launch type, this field is required. You must use one of the following values. The value that you choose determines your range of valid values for the ``memory`` parameter.\n If you use the EC2 launch type, this field is optional. Supported values are between ``128`` CPU units (``0.125`` vCPUs) and ``10240`` CPU units (``10`` vCPUs).\n The CPU units cannot be less than 1 vCPU when you use Windows containers on Fargate.\n + 256 (.25 vCPU) - Available ``memory`` values: 512 (0.5 GB), 1024 (1 GB), 2048 (2 GB)\n + 512 (.5 vCPU) - Available ``memory`` values: 1024 (1 GB), 2048 (2 GB), 3072 (3 GB), 4096 (4 GB)\n + 1024 (1 vCPU) - Available ``memory`` values: 2048 (2 GB), 3072 (3 GB), 4096 (4 GB), 5120 (5 GB), 6144 (6 GB), 7168 (7 GB), 8192 (8 GB)\n + 2048 (2 vCPU) - Available ``memory`` values: 4096 (4 GB) and 16384 (16 GB) in increments of 1024 (1 GB)\n + 4096 (4 vCPU) - Available ``memory`` values: 8192 (8 GB) and 30720 (30 GB) in increments of 1024 (1 GB)\n + 8192 (8 vCPU) - Available ``memory`` values: 16 GB and 60 GB in 4 GB increments\n This option requires Linux platform ``1.4.0`` or later.\n + 16384 (16vCPU) - Available ``memory`` values: 32GB and 120 GB in 8 GB increments\n This option requires Linux platform ``1.4.0`` or later.", "replaceOnChanges": true }, + "enableFaultInjection": { + "type": "boolean", + "replaceOnChanges": true + }, "ephemeralStorage": { "$ref": "#/types/aws-native:ecs:TaskDefinitionEphemeralStorage", "description": "The ephemeral storage settings to use for tasks run with the task definition.", @@ -216212,6 +216483,9 @@ "type": "string", "description": "The number of ``cpu`` units used by the task. If you use the EC2 launch type, this field is optional. Any value can be used. If you use the Fargate launch type, this field is required. You must use one of the following values. The value that you choose determines your range of valid values for the ``memory`` parameter.\n If you use the EC2 launch type, this field is optional. Supported values are between ``128`` CPU units (``0.125`` vCPUs) and ``10240`` CPU units (``10`` vCPUs).\n The CPU units cannot be less than 1 vCPU when you use Windows containers on Fargate.\n + 256 (.25 vCPU) - Available ``memory`` values: 512 (0.5 GB), 1024 (1 GB), 2048 (2 GB)\n + 512 (.5 vCPU) - Available ``memory`` values: 1024 (1 GB), 2048 (2 GB), 3072 (3 GB), 4096 (4 GB)\n + 1024 (1 vCPU) - Available ``memory`` values: 2048 (2 GB), 3072 (3 GB), 4096 (4 GB), 5120 (5 GB), 6144 (6 GB), 7168 (7 GB), 8192 (8 GB)\n + 2048 (2 vCPU) - Available ``memory`` values: 4096 (4 GB) and 16384 (16 GB) in increments of 1024 (1 GB)\n + 4096 (4 vCPU) - Available ``memory`` values: 8192 (8 GB) and 30720 (30 GB) in increments of 1024 (1 GB)\n + 8192 (8 vCPU) - Available ``memory`` values: 16 GB and 60 GB in 4 GB increments\n This option requires Linux platform ``1.4.0`` or later.\n + 16384 (16vCPU) - Available ``memory`` values: 32GB and 120 GB in 8 GB increments\n This option requires Linux platform ``1.4.0`` or later." }, + "enableFaultInjection": { + "type": "boolean" + }, "ephemeralStorage": { "$ref": "#/types/aws-native:ecs:TaskDefinitionEphemeralStorage", "description": "The ephemeral storage settings to use for tasks run with the task definition." @@ -228946,7 +229220,7 @@ }, "healthEventsConfig": { "$ref": "#/types/aws-native:internetmonitor:MonitorHealthEventsConfig", - "description": "A complex type with the configuration information that determines the threshold and other conditions for when Internet Monitor creates a health event for an overall performance or availability issue, across an application's geographies.\n\nDefines the percentages, for overall performance scores and availability scores for an application, that are the thresholds for when Amazon CloudWatch Internet Monitor creates a health event. You can override the defaults to set a custom threshold for overall performance or availability scores, or both.\n\nYou can also set thresholds for local health scores,, where Internet Monitor creates a health event when scores cross a threshold for one or more city-networks, in addition to creating an event when an overall score crosses a threshold.\n\nIf you don't set a health event threshold, the default value is 95%.\n\nFor local thresholds, you also set a minimum percentage of overall traffic that is impacted by an issue before Internet Monitor creates an event. In addition, you can disable local thresholds, for performance scores, availability scores, or both.\n\nFor more information, see [Change health event thresholds](https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/CloudWatch-IM-overview.html#IMUpdateThresholdFromOverview) in the Internet Monitor section of the *CloudWatch User Guide* ." + "description": "A complex type with the configuration information that determines the threshold and other conditions for when Internet Monitor creates a health event for an overall performance or availability issue, across an application's geographies.\n\nDefines the percentages, for overall performance scores and availability scores for an application, that are the thresholds for when Internet Monitor creates a health event. You can override the defaults to set a custom threshold for overall performance or availability scores, or both.\n\nYou can also set thresholds for local health scores,, where Internet Monitor creates a health event when scores cross a threshold for one or more city-networks, in addition to creating an event when an overall score crosses a threshold.\n\nIf you don't set a health event threshold, the default value is 95%.\n\nFor local thresholds, you also set a minimum percentage of overall traffic that is impacted by an issue before Internet Monitor creates an event. In addition, you can disable local thresholds, for performance scores, availability scores, or both.\n\nFor more information, see [Change health event thresholds](https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/CloudWatch-IM-overview.html#IMUpdateThresholdFromOverview) in the Internet Monitor section of the *CloudWatch User Guide* ." }, "includeLinkedAccounts": { "type": "boolean", @@ -229034,7 +229308,7 @@ "inputProperties": { "healthEventsConfig": { "$ref": "#/types/aws-native:internetmonitor:MonitorHealthEventsConfig", - "description": "A complex type with the configuration information that determines the threshold and other conditions for when Internet Monitor creates a health event for an overall performance or availability issue, across an application's geographies.\n\nDefines the percentages, for overall performance scores and availability scores for an application, that are the thresholds for when Amazon CloudWatch Internet Monitor creates a health event. You can override the defaults to set a custom threshold for overall performance or availability scores, or both.\n\nYou can also set thresholds for local health scores,, where Internet Monitor creates a health event when scores cross a threshold for one or more city-networks, in addition to creating an event when an overall score crosses a threshold.\n\nIf you don't set a health event threshold, the default value is 95%.\n\nFor local thresholds, you also set a minimum percentage of overall traffic that is impacted by an issue before Internet Monitor creates an event. In addition, you can disable local thresholds, for performance scores, availability scores, or both.\n\nFor more information, see [Change health event thresholds](https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/CloudWatch-IM-overview.html#IMUpdateThresholdFromOverview) in the Internet Monitor section of the *CloudWatch User Guide* ." + "description": "A complex type with the configuration information that determines the threshold and other conditions for when Internet Monitor creates a health event for an overall performance or availability issue, across an application's geographies.\n\nDefines the percentages, for overall performance scores and availability scores for an application, that are the thresholds for when Internet Monitor creates a health event. You can override the defaults to set a custom threshold for overall performance or availability scores, or both.\n\nYou can also set thresholds for local health scores,, where Internet Monitor creates a health event when scores cross a threshold for one or more city-networks, in addition to creating an event when an overall score crosses a threshold.\n\nIf you don't set a health event threshold, the default value is 95%.\n\nFor local thresholds, you also set a minimum percentage of overall traffic that is impacted by an issue before Internet Monitor creates an event. In addition, you can disable local thresholds, for performance scores, availability scores, or both.\n\nFor more information, see [Change health event thresholds](https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/CloudWatch-IM-overview.html#IMUpdateThresholdFromOverview) in the Internet Monitor section of the *CloudWatch User Guide* ." }, "includeLinkedAccounts": { "type": "boolean", @@ -229098,33 +229372,41 @@ "description": "An invoice unit is a set of mutually exclusive accounts that correspond to your business entity. Invoice units allow you to separate AWS account costs and configures your invoice for each business entity.", "properties": { "description": { - "type": "string" + "type": "string", + "description": "The assigned description for an invoice unit. This information can't be modified or deleted." }, "invoiceReceiver": { "type": "string", + "description": "The account that receives invoices related to the invoice unit.", "replaceOnChanges": true }, "invoiceUnitArn": { - "type": "string" + "type": "string", + "description": "The ARN to identify an invoice unit. This information can't be modified or deleted." }, "lastModified": { - "type": "number" + "type": "number", + "description": "The last time the invoice unit was updated. This is important to determine the version of invoice unit configuration used to create the invoices. Any invoice created after this modified time will use this invoice unit configuration." }, "name": { "type": "string", + "description": "A unique name that is distinctive within your AWS .", "replaceOnChanges": true }, "resourceTags": { "type": "array", "items": { "$ref": "#/types/aws-native:index:Tag" - } + }, + "description": "The tag structure that contains a tag key and value." }, "rule": { - "$ref": "#/types/aws-native:invoicing:InvoiceUnitRule" + "$ref": "#/types/aws-native:invoicing:InvoiceUnitRule", + "description": "An `InvoiceUnitRule` object used the categorize invoice units." }, "taxInheritanceDisabled": { - "type": "boolean" + "type": "boolean", + "description": "Whether the invoice unit based tax inheritance is/ should be enabled or disabled." } }, "type": "object", @@ -229137,25 +229419,31 @@ ], "inputProperties": { "description": { - "type": "string" + "type": "string", + "description": "The assigned description for an invoice unit. This information can't be modified or deleted." }, "invoiceReceiver": { - "type": "string" + "type": "string", + "description": "The account that receives invoices related to the invoice unit." }, "name": { - "type": "string" + "type": "string", + "description": "A unique name that is distinctive within your AWS ." }, "resourceTags": { "type": "array", "items": { "$ref": "#/types/aws-native:index:Tag" - } + }, + "description": "The tag structure that contains a tag key and value." }, "rule": { - "$ref": "#/types/aws-native:invoicing:InvoiceUnitRule" + "$ref": "#/types/aws-native:invoicing:InvoiceUnitRule", + "description": "An `InvoiceUnitRule` object used the categorize invoice units." }, "taxInheritanceDisabled": { - "type": "boolean" + "type": "boolean", + "description": "Whether the invoice unit based tax inheritance is/ should be enabled or disabled." } }, "requiredInputs": [ @@ -229595,6 +229883,134 @@ "lambdaFunctionArn" ] }, + "aws-native:iot:Command": { + "description": "Represents the resource definition of AWS IoT Command.", + "properties": { + "commandArn": { + "type": "string", + "description": "The Amazon Resource Name (ARN) of the command." + }, + "commandId": { + "type": "string", + "description": "The unique identifier for the command.", + "replaceOnChanges": true + }, + "createdAt": { + "type": "string", + "description": "The date and time when the command was created." + }, + "deprecated": { + "type": "boolean", + "description": "A flag indicating whether the command is deprecated." + }, + "description": { + "type": "string", + "description": "The description of the command." + }, + "displayName": { + "type": "string", + "description": "The display name for the command." + }, + "lastUpdatedAt": { + "type": "string", + "description": "The date and time when the command was last updated." + }, + "mandatoryParameters": { + "type": "array", + "items": { + "$ref": "#/types/aws-native:iot:CommandParameter" + }, + "description": "The list of mandatory parameters for the command." + }, + "namespace": { + "$ref": "#/types/aws-native:iot:CommandNamespace", + "description": "The namespace to which the command belongs." + }, + "payload": { + "$ref": "#/types/aws-native:iot:CommandPayload", + "description": "The payload associated with the command." + }, + "pendingDeletion": { + "type": "boolean", + "description": "A flag indicating whether the command is pending deletion." + }, + "roleArn": { + "type": "string", + "description": "The customer role associated with the command." + }, + "tags": { + "type": "array", + "items": { + "$ref": "#/types/aws-native:index:Tag" + }, + "description": "The tags to be associated with the command." + } + }, + "type": "object", + "required": [ + "commandArn", + "commandId" + ], + "inputProperties": { + "commandId": { + "type": "string", + "description": "The unique identifier for the command." + }, + "createdAt": { + "type": "string", + "description": "The date and time when the command was created." + }, + "deprecated": { + "type": "boolean", + "description": "A flag indicating whether the command is deprecated." + }, + "description": { + "type": "string", + "description": "The description of the command." + }, + "displayName": { + "type": "string", + "description": "The display name for the command." + }, + "lastUpdatedAt": { + "type": "string", + "description": "The date and time when the command was last updated." + }, + "mandatoryParameters": { + "type": "array", + "items": { + "$ref": "#/types/aws-native:iot:CommandParameter" + }, + "description": "The list of mandatory parameters for the command." + }, + "namespace": { + "$ref": "#/types/aws-native:iot:CommandNamespace", + "description": "The namespace to which the command belongs." + }, + "payload": { + "$ref": "#/types/aws-native:iot:CommandPayload", + "description": "The payload associated with the command." + }, + "pendingDeletion": { + "type": "boolean", + "description": "A flag indicating whether the command is pending deletion." + }, + "roleArn": { + "type": "string", + "description": "The customer role associated with the command." + }, + "tags": { + "type": "array", + "items": { + "$ref": "#/types/aws-native:index:Tag" + }, + "description": "The tags to be associated with the command." + } + }, + "requiredInputs": [ + "commandId" + ] + }, "aws-native:iot:CustomMetric": { "description": "A custom metric published by your devices to Device Defender.\n\n{{% examples %}}\n## Example Usage\n{{% example %}}\n### Example\n```csharp\nusing System.Collections.Generic;\nusing System.Linq;\nusing Pulumi;\nusing AwsNative = Pulumi.AwsNative;\n\nreturn await Deployment.RunAsync(() =\u003e \n{\n var batteryPercentageMetric = new AwsNative.IoT.CustomMetric(\"batteryPercentageMetric\", new()\n {\n MetricName = \"batteryPercentage\",\n DisplayName = \"Remaining battery percentage\",\n MetricType = AwsNative.IoT.CustomMetricMetricType.Number,\n });\n\n});\n\n\n```\n\n```go\npackage main\n\nimport (\n\t\"github.com/pulumi/pulumi-aws-native/sdk/go/aws/iot\"\n\t\"github.com/pulumi/pulumi/sdk/v3/go/pulumi\"\n)\n\nfunc main() {\n\tpulumi.Run(func(ctx *pulumi.Context) error {\n\t\t_, err := iot.NewCustomMetric(ctx, \"batteryPercentageMetric\", \u0026iot.CustomMetricArgs{\n\t\t\tMetricName: pulumi.String(\"batteryPercentage\"),\n\t\t\tDisplayName: pulumi.String(\"Remaining battery percentage\"),\n\t\t\tMetricType: iot.CustomMetricMetricTypeNumber,\n\t\t})\n\t\tif err != nil {\n\t\t\treturn err\n\t\t}\n\t\treturn nil\n\t})\n}\n\n```\n\n```typescript\nimport * as pulumi from \"@pulumi/pulumi\";\nimport * as aws_native from \"@pulumi/aws-native\";\n\nconst batteryPercentageMetric = new aws_native.iot.CustomMetric(\"batteryPercentageMetric\", {\n metricName: \"batteryPercentage\",\n displayName: \"Remaining battery percentage\",\n metricType: aws_native.iot.CustomMetricMetricType.Number,\n});\n\n```\n\n```python\nimport pulumi\nimport pulumi_aws_native as aws_native\n\nbattery_percentage_metric = aws_native.iot.CustomMetric(\"batteryPercentageMetric\",\n metric_name=\"batteryPercentage\",\n display_name=\"Remaining battery percentage\",\n metric_type=aws_native.iot.CustomMetricMetricType.NUMBER)\n\n```\n\n{{% /example %}}\n{{% /examples %}}\n", "properties": { @@ -250453,7 +250869,7 @@ }, "type": { "$ref": "#/types/aws-native:organizations:PolicyType", - "description": "The type of policy to create. You can specify one of the following values: AISERVICES_OPT_OUT_POLICY, BACKUP_POLICY, SERVICE_CONTROL_POLICY, TAG_POLICY, CHATBOT_POLICY, RESOURCE_CONTROL_POLICY", + "description": "The type of policy to create. You can specify one of the following values: AISERVICES_OPT_OUT_POLICY, BACKUP_POLICY, SERVICE_CONTROL_POLICY, TAG_POLICY, CHATBOT_POLICY, RESOURCE_CONTROL_POLICY,DECLARATIVE_POLICY_EC2", "replaceOnChanges": true } }, @@ -250495,7 +250911,7 @@ }, "type": { "$ref": "#/types/aws-native:organizations:PolicyType", - "description": "The type of policy to create. You can specify one of the following values: AISERVICES_OPT_OUT_POLICY, BACKUP_POLICY, SERVICE_CONTROL_POLICY, TAG_POLICY, CHATBOT_POLICY, RESOURCE_CONTROL_POLICY" + "description": "The type of policy to create. You can specify one of the following values: AISERVICES_OPT_OUT_POLICY, BACKUP_POLICY, SERVICE_CONTROL_POLICY, TAG_POLICY, CHATBOT_POLICY, RESOURCE_CONTROL_POLICY,DECLARATIVE_POLICY_EC2" } }, "requiredInputs": [ @@ -252191,6 +252607,7 @@ "items": { "type": "string" }, + "description": "The OIDC client ID for a Amazon Q Business application.", "replaceOnChanges": true }, "createdAt": { @@ -252283,7 +252700,8 @@ "type": "array", "items": { "type": "string" - } + }, + "description": "The OIDC client ID for a Amazon Q Business application." }, "description": { "type": "string", @@ -254673,6 +255091,108 @@ "resourceType" ] }, + "aws-native:ram:ResourceShare": { + "description": "Resource type definition for AWS::RAM::ResourceShare\n\n{{% examples %}}\n## Example Usage\n{{% example %}}\n### Example\n```csharp\nusing System.Collections.Generic;\nusing System.Linq;\nusing Pulumi;\nusing AwsNative = Pulumi.AwsNative;\n\nreturn await Deployment.RunAsync(() =\u003e \n{\n var myresourceshare = new AwsNative.Ram.ResourceShare(\"myresourceshare\", new()\n {\n Name = \"My Resource Share\",\n ResourceArns = new[]\n {\n \"arn:aws:ec2:us-east-1:123456789012:resource-type/12345678-1234-1234-1234-12345678\",\n },\n Principals = new[]\n {\n \"210987654321\",\n },\n Tags = new[]\n {\n new AwsNative.Inputs.TagArgs\n {\n Key = \"Key1\",\n Value = \"Value1\",\n },\n new AwsNative.Inputs.TagArgs\n {\n Key = \"Key2\",\n Value = \"Value2\",\n },\n },\n });\n\n});\n\n\n```\n\n```go\npackage main\n\nimport (\n\tawsnative \"github.com/pulumi/pulumi-aws-native/sdk/go/aws\"\n\t\"github.com/pulumi/pulumi-aws-native/sdk/go/aws/ram\"\n\t\"github.com/pulumi/pulumi/sdk/v3/go/pulumi\"\n)\n\nfunc main() {\n\tpulumi.Run(func(ctx *pulumi.Context) error {\n\t\t_, err := ram.NewResourceShare(ctx, \"myresourceshare\", \u0026ram.ResourceShareArgs{\n\t\t\tName: pulumi.String(\"My Resource Share\"),\n\t\t\tResourceArns: pulumi.StringArray{\n\t\t\t\tpulumi.String(\"arn:aws:ec2:us-east-1:123456789012:resource-type/12345678-1234-1234-1234-12345678\"),\n\t\t\t},\n\t\t\tPrincipals: pulumi.StringArray{\n\t\t\t\tpulumi.String(\"210987654321\"),\n\t\t\t},\n\t\t\tTags: aws.TagArray{\n\t\t\t\t\u0026aws.TagArgs{\n\t\t\t\t\tKey: pulumi.String(\"Key1\"),\n\t\t\t\t\tValue: pulumi.String(\"Value1\"),\n\t\t\t\t},\n\t\t\t\t\u0026aws.TagArgs{\n\t\t\t\t\tKey: pulumi.String(\"Key2\"),\n\t\t\t\t\tValue: pulumi.String(\"Value2\"),\n\t\t\t\t},\n\t\t\t},\n\t\t})\n\t\tif err != nil {\n\t\t\treturn err\n\t\t}\n\t\treturn nil\n\t})\n}\n\n```\n\n```typescript\nimport * as pulumi from \"@pulumi/pulumi\";\nimport * as aws_native from \"@pulumi/aws-native\";\n\nconst myresourceshare = new aws_native.ram.ResourceShare(\"myresourceshare\", {\n name: \"My Resource Share\",\n resourceArns: [\"arn:aws:ec2:us-east-1:123456789012:resource-type/12345678-1234-1234-1234-12345678\"],\n principals: [\"210987654321\"],\n tags: [\n {\n key: \"Key1\",\n value: \"Value1\",\n },\n {\n key: \"Key2\",\n value: \"Value2\",\n },\n ],\n});\n\n```\n\n```python\nimport pulumi\nimport pulumi_aws_native as aws_native\n\nmyresourceshare = aws_native.ram.ResourceShare(\"myresourceshare\",\n name=\"My Resource Share\",\n resource_arns=[\"arn:aws:ec2:us-east-1:123456789012:resource-type/12345678-1234-1234-1234-12345678\"],\n principals=[\"210987654321\"],\n tags=[\n {\n \"key\": \"Key1\",\n \"value\": \"Value1\",\n },\n {\n \"key\": \"Key2\",\n \"value\": \"Value2\",\n },\n ])\n\n```\n\n{{% /example %}}\n{{% example %}}\n### Example\n```csharp\nusing System.Collections.Generic;\nusing System.Linq;\nusing Pulumi;\nusing AwsNative = Pulumi.AwsNative;\n\nreturn await Deployment.RunAsync(() =\u003e \n{\n var myresourceshare = new AwsNative.Ram.ResourceShare(\"myresourceshare\", new()\n {\n Name = \"My Resource Share\",\n ResourceArns = new[]\n {\n \"arn:aws:ec2:us-east-1:123456789012:resource-type/12345678-1234-1234-1234-12345678\",\n },\n Principals = new[]\n {\n \"210987654321\",\n },\n Tags = new[]\n {\n new AwsNative.Inputs.TagArgs\n {\n Key = \"Key1\",\n Value = \"Value1\",\n },\n new AwsNative.Inputs.TagArgs\n {\n Key = \"Key2\",\n Value = \"Value2\",\n },\n },\n });\n\n});\n\n\n```\n\n```go\npackage main\n\nimport (\n\tawsnative \"github.com/pulumi/pulumi-aws-native/sdk/go/aws\"\n\t\"github.com/pulumi/pulumi-aws-native/sdk/go/aws/ram\"\n\t\"github.com/pulumi/pulumi/sdk/v3/go/pulumi\"\n)\n\nfunc main() {\n\tpulumi.Run(func(ctx *pulumi.Context) error {\n\t\t_, err := ram.NewResourceShare(ctx, \"myresourceshare\", \u0026ram.ResourceShareArgs{\n\t\t\tName: pulumi.String(\"My Resource Share\"),\n\t\t\tResourceArns: pulumi.StringArray{\n\t\t\t\tpulumi.String(\"arn:aws:ec2:us-east-1:123456789012:resource-type/12345678-1234-1234-1234-12345678\"),\n\t\t\t},\n\t\t\tPrincipals: pulumi.StringArray{\n\t\t\t\tpulumi.String(\"210987654321\"),\n\t\t\t},\n\t\t\tTags: aws.TagArray{\n\t\t\t\t\u0026aws.TagArgs{\n\t\t\t\t\tKey: pulumi.String(\"Key1\"),\n\t\t\t\t\tValue: pulumi.String(\"Value1\"),\n\t\t\t\t},\n\t\t\t\t\u0026aws.TagArgs{\n\t\t\t\t\tKey: pulumi.String(\"Key2\"),\n\t\t\t\t\tValue: pulumi.String(\"Value2\"),\n\t\t\t\t},\n\t\t\t},\n\t\t})\n\t\tif err != nil {\n\t\t\treturn err\n\t\t}\n\t\treturn nil\n\t})\n}\n\n```\n\n```typescript\nimport * as pulumi from \"@pulumi/pulumi\";\nimport * as aws_native from \"@pulumi/aws-native\";\n\nconst myresourceshare = new aws_native.ram.ResourceShare(\"myresourceshare\", {\n name: \"My Resource Share\",\n resourceArns: [\"arn:aws:ec2:us-east-1:123456789012:resource-type/12345678-1234-1234-1234-12345678\"],\n principals: [\"210987654321\"],\n tags: [\n {\n key: \"Key1\",\n value: \"Value1\",\n },\n {\n key: \"Key2\",\n value: \"Value2\",\n },\n ],\n});\n\n```\n\n```python\nimport pulumi\nimport pulumi_aws_native as aws_native\n\nmyresourceshare = aws_native.ram.ResourceShare(\"myresourceshare\",\n name=\"My Resource Share\",\n resource_arns=[\"arn:aws:ec2:us-east-1:123456789012:resource-type/12345678-1234-1234-1234-12345678\"],\n principals=[\"210987654321\"],\n tags=[\n {\n \"key\": \"Key1\",\n \"value\": \"Value1\",\n },\n {\n \"key\": \"Key2\",\n \"value\": \"Value2\",\n },\n ])\n\n```\n\n{{% /example %}}\n{{% /examples %}}\n", + "properties": { + "allowExternalPrincipals": { + "type": "boolean", + "description": "Specifies whether principals outside your organization in AWS Organizations can be associated with a resource share. A value of `true` lets you share with individual AWS accounts that are not in your organization. A value of `false` only has meaning if your account is a member of an AWS Organization. The default value is `true`." + }, + "arn": { + "type": "string", + "description": "The Amazon Resource Name (ARN) of the resource share." + }, + "name": { + "type": "string", + "description": "Specifies the name of the resource share." + }, + "permissionArns": { + "type": "array", + "items": { + "type": "string" + }, + "description": "Specifies the [Amazon Resource Names (ARNs)](https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html) of the AWS RAM permission to associate with the resource share. If you do not specify an ARN for the permission, AWS RAM automatically attaches the default version of the permission for each resource type. You can associate only one permission with each resource type included in the resource share." + }, + "principals": { + "type": "array", + "items": { + "type": "string" + }, + "description": "Specifies the principals to associate with the resource share. The possible values are:\n\n- An AWS account ID\n\n- An Amazon Resource Name (ARN) of an organization in AWS Organizations\n\n- An ARN of an organizational unit (OU) in AWS Organizations\n\n- An ARN of an IAM role\n\n- An ARN of an IAM user" + }, + "resourceArns": { + "type": "array", + "items": { + "type": "string" + }, + "description": "Specifies a list of one or more ARNs of the resources to associate with the resource share." + }, + "sources": { + "type": "array", + "items": { + "type": "string" + }, + "description": "Specifies from which source accounts the service principal has access to the resources in this resource share." + }, + "tags": { + "type": "array", + "items": { + "$ref": "#/types/aws-native:index:Tag" + }, + "description": "Specifies one or more tags to attach to the resource share itself. It doesn't attach the tags to the resources associated with the resource share." + } + }, + "type": "object", + "required": [ + "arn", + "name" + ], + "inputProperties": { + "allowExternalPrincipals": { + "type": "boolean", + "description": "Specifies whether principals outside your organization in AWS Organizations can be associated with a resource share. A value of `true` lets you share with individual AWS accounts that are not in your organization. A value of `false` only has meaning if your account is a member of an AWS Organization. The default value is `true`." + }, + "name": { + "type": "string", + "description": "Specifies the name of the resource share." + }, + "permissionArns": { + "type": "array", + "items": { + "type": "string" + }, + "description": "Specifies the [Amazon Resource Names (ARNs)](https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html) of the AWS RAM permission to associate with the resource share. If you do not specify an ARN for the permission, AWS RAM automatically attaches the default version of the permission for each resource type. You can associate only one permission with each resource type included in the resource share." + }, + "principals": { + "type": "array", + "items": { + "type": "string" + }, + "description": "Specifies the principals to associate with the resource share. The possible values are:\n\n- An AWS account ID\n\n- An Amazon Resource Name (ARN) of an organization in AWS Organizations\n\n- An ARN of an organizational unit (OU) in AWS Organizations\n\n- An ARN of an IAM role\n\n- An ARN of an IAM user" + }, + "resourceArns": { + "type": "array", + "items": { + "type": "string" + }, + "description": "Specifies a list of one or more ARNs of the resources to associate with the resource share." + }, + "sources": { + "type": "array", + "items": { + "type": "string" + }, + "description": "Specifies from which source accounts the service principal has access to the resources in this resource share." + }, + "tags": { + "type": "array", + "items": { + "$ref": "#/types/aws-native:index:Tag" + }, + "description": "Specifies one or more tags to attach to the resource share itself. It doesn't attach the tags to the resources associated with the resource share." + } + } + }, "aws-native:rbin:Rule": { "description": "Resource Type definition for AWS::Rbin::Rule", "properties": { @@ -254788,16 +255308,16 @@ ] }, "aws-native:rds:CustomDbEngineVersion": { - "description": "The AWS::RDS::CustomDBEngineVersion resource creates an Amazon RDS custom DB engine version.", + "description": "Creates a custom DB engine version (CEV).", "properties": { "databaseInstallationFilesS3BucketName": { "type": "string", - "description": "The name of an Amazon S3 bucket that contains database installation files for your CEV. For example, a valid bucket name is `my-custom-installation-files`.", + "description": "The name of an Amazon S3 bucket that contains database installation files for your CEV. For example, a valid bucket name is ``my-custom-installation-files``.", "replaceOnChanges": true }, "databaseInstallationFilesS3Prefix": { "type": "string", - "description": "The Amazon S3 directory that contains the database installation files for your CEV. For example, a valid bucket name is `123456789012/cev1`. If this setting isn't specified, no prefix is assumed.", + "description": "The Amazon S3 directory that contains the database installation files for your CEV. For example, a valid bucket name is ``123456789012/cev1``. If this setting isn't specified, no prefix is assumed.", "replaceOnChanges": true }, "dbEngineVersionArn": { @@ -254810,48 +255330,48 @@ }, "engine": { "type": "string", - "description": "The database engine to use for your custom engine version (CEV). The only supported value is `custom-oracle-ee`.", + "description": "The database engine to use for your custom engine version (CEV).\n Valid values:\n + ``custom-oracle-ee`` \n + ``custom-oracle-ee-cdb``", "replaceOnChanges": true }, "engineVersion": { "type": "string", - "description": "The name of your CEV. The name format is 19.customized_string . For example, a valid name is 19.my_cev1. This setting is required for RDS Custom for Oracle, but optional for Amazon RDS. The combination of Engine and EngineVersion is unique per customer per Region.", + "description": "The name of your CEV. The name format is ``major version.customized_string``. For example, a valid CEV name is ``19.my_cev1``. This setting is required for RDS Custom for Oracle, but optional for Amazon RDS. The combination of ``Engine`` and ``EngineVersion`` is unique per customer per Region.\n *Constraints:* Minimum length is 1. Maximum length is 60.\n *Pattern:* ``^[a-z0-9_.-]{1,60$``}", "replaceOnChanges": true }, "imageId": { "type": "string", - "description": "The identifier of Amazon Machine Image (AMI) used for CEV.", + "description": "A value that indicates the ID of the AMI.", "replaceOnChanges": true }, "kmsKeyId": { "type": "string", - "description": "The AWS KMS key identifier for an encrypted CEV. A symmetric KMS key is required for RDS Custom, but optional for Amazon RDS.", + "description": "The AWS KMS key identifier for an encrypted CEV. A symmetric encryption KMS key is required for RDS Custom, but optional for Amazon RDS.\n If you have an existing symmetric encryption KMS key in your account, you can use it with RDS Custom. No further action is necessary. If you don't already have a symmetric encryption KMS key in your account, follow the instructions in [Creating a symmetric encryption KMS key](https://docs.aws.amazon.com/kms/latest/developerguide/create-keys.html#create-symmetric-cmk) in the *Key Management Service Developer Guide*.\n You can choose the same symmetric encryption key when you create a CEV and a DB instance, or choose different keys.", "replaceOnChanges": true }, "manifest": { "type": "string", - "description": "The CEV manifest, which is a JSON document that describes the installation .zip files stored in Amazon S3. Specify the name/value pairs in a file or a quoted string. RDS Custom applies the patches in the order in which they are listed.", + "description": "The CEV manifest, which is a JSON document that describes the installation .zip files stored in Amazon S3. Specify the name/value pairs in a file or a quoted string. RDS Custom applies the patches in the order in which they are listed.\n The following JSON fields are valid:\n + MediaImportTemplateVersion Version of the CEV manifest. The date is in the format YYYY-MM-DD. + databaseInstallationFileNames Ordered list of installation files for the CEV. + opatchFileNames Ordered list of OPatch installers used for the Oracle DB engine. + psuRuPatchFileNames The PSU and RU patches for this CEV. + OtherPatchFileNames The patches that are not in the list of PSU and RU patches. Amazon RDS applies these patches after applying the PSU and RU patches. \n For more information, see [Creating the CEV manifest](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/custom-cev.html#custom-cev.preparing.manifest) in the *Amazon RDS User Guide*.", "replaceOnChanges": true }, "sourceCustomDbEngineVersionIdentifier": { "type": "string", - "description": "The identifier of the source custom engine version.", + "description": "The ARN of a CEV to use as a source for creating a new CEV. You can specify a different Amazon Machine Imagine (AMI) by using either ``Source`` or ``UseAwsProvidedLatestImage``. You can't specify a different JSON manifest when you specify ``SourceCustomDbEngineVersionIdentifier``.", "replaceOnChanges": true }, "status": { "$ref": "#/types/aws-native:rds:CustomDbEngineVersionStatus", - "description": "The availability status to be assigned to the CEV." + "description": "A value that indicates the status of a custom engine version (CEV)." }, "tags": { "type": "array", "items": { "$ref": "#/types/aws-native:index:Tag" }, - "description": "An array of key-value pairs to apply to this resource." + "description": "A list of tags. For more information, see [Tagging Amazon RDS Resources](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_Tagging.html) in the *Amazon RDS User Guide.*" }, "useAwsProvidedLatestImage": { "type": "boolean", - "description": "A value that indicates whether AWS provided latest image is applied automatically to the Custom Engine Version. By default, AWS provided latest image is applied automatically. This value is only applied on create.", + "description": "Specifies whether to use the latest service-provided Amazon Machine Image (AMI) for the CEV. If you specify ``UseAwsProvidedLatestImage``, you can't also specify ``ImageId``.", "replaceOnChanges": true } }, @@ -254864,11 +255384,11 @@ "inputProperties": { "databaseInstallationFilesS3BucketName": { "type": "string", - "description": "The name of an Amazon S3 bucket that contains database installation files for your CEV. For example, a valid bucket name is `my-custom-installation-files`." + "description": "The name of an Amazon S3 bucket that contains database installation files for your CEV. For example, a valid bucket name is ``my-custom-installation-files``." }, "databaseInstallationFilesS3Prefix": { "type": "string", - "description": "The Amazon S3 directory that contains the database installation files for your CEV. For example, a valid bucket name is `123456789012/cev1`. If this setting isn't specified, no prefix is assumed." + "description": "The Amazon S3 directory that contains the database installation files for your CEV. For example, a valid bucket name is ``123456789012/cev1``. If this setting isn't specified, no prefix is assumed." }, "description": { "type": "string", @@ -254876,42 +255396,42 @@ }, "engine": { "type": "string", - "description": "The database engine to use for your custom engine version (CEV). The only supported value is `custom-oracle-ee`." + "description": "The database engine to use for your custom engine version (CEV).\n Valid values:\n + ``custom-oracle-ee`` \n + ``custom-oracle-ee-cdb``" }, "engineVersion": { "type": "string", - "description": "The name of your CEV. The name format is 19.customized_string . For example, a valid name is 19.my_cev1. This setting is required for RDS Custom for Oracle, but optional for Amazon RDS. The combination of Engine and EngineVersion is unique per customer per Region." + "description": "The name of your CEV. The name format is ``major version.customized_string``. For example, a valid CEV name is ``19.my_cev1``. This setting is required for RDS Custom for Oracle, but optional for Amazon RDS. The combination of ``Engine`` and ``EngineVersion`` is unique per customer per Region.\n *Constraints:* Minimum length is 1. Maximum length is 60.\n *Pattern:* ``^[a-z0-9_.-]{1,60$``}" }, "imageId": { "type": "string", - "description": "The identifier of Amazon Machine Image (AMI) used for CEV." + "description": "A value that indicates the ID of the AMI." }, "kmsKeyId": { "type": "string", - "description": "The AWS KMS key identifier for an encrypted CEV. A symmetric KMS key is required for RDS Custom, but optional for Amazon RDS." + "description": "The AWS KMS key identifier for an encrypted CEV. A symmetric encryption KMS key is required for RDS Custom, but optional for Amazon RDS.\n If you have an existing symmetric encryption KMS key in your account, you can use it with RDS Custom. No further action is necessary. If you don't already have a symmetric encryption KMS key in your account, follow the instructions in [Creating a symmetric encryption KMS key](https://docs.aws.amazon.com/kms/latest/developerguide/create-keys.html#create-symmetric-cmk) in the *Key Management Service Developer Guide*.\n You can choose the same symmetric encryption key when you create a CEV and a DB instance, or choose different keys." }, "manifest": { "type": "string", - "description": "The CEV manifest, which is a JSON document that describes the installation .zip files stored in Amazon S3. Specify the name/value pairs in a file or a quoted string. RDS Custom applies the patches in the order in which they are listed." + "description": "The CEV manifest, which is a JSON document that describes the installation .zip files stored in Amazon S3. Specify the name/value pairs in a file or a quoted string. RDS Custom applies the patches in the order in which they are listed.\n The following JSON fields are valid:\n + MediaImportTemplateVersion Version of the CEV manifest. The date is in the format YYYY-MM-DD. + databaseInstallationFileNames Ordered list of installation files for the CEV. + opatchFileNames Ordered list of OPatch installers used for the Oracle DB engine. + psuRuPatchFileNames The PSU and RU patches for this CEV. + OtherPatchFileNames The patches that are not in the list of PSU and RU patches. Amazon RDS applies these patches after applying the PSU and RU patches. \n For more information, see [Creating the CEV manifest](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/custom-cev.html#custom-cev.preparing.manifest) in the *Amazon RDS User Guide*." }, "sourceCustomDbEngineVersionIdentifier": { "type": "string", - "description": "The identifier of the source custom engine version." + "description": "The ARN of a CEV to use as a source for creating a new CEV. You can specify a different Amazon Machine Imagine (AMI) by using either ``Source`` or ``UseAwsProvidedLatestImage``. You can't specify a different JSON manifest when you specify ``SourceCustomDbEngineVersionIdentifier``." }, "status": { "$ref": "#/types/aws-native:rds:CustomDbEngineVersionStatus", - "description": "The availability status to be assigned to the CEV." + "description": "A value that indicates the status of a custom engine version (CEV)." }, "tags": { "type": "array", "items": { "$ref": "#/types/aws-native:index:Tag" }, - "description": "An array of key-value pairs to apply to this resource." + "description": "A list of tags. For more information, see [Tagging Amazon RDS Resources](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_Tagging.html) in the *Amazon RDS User Guide.*" }, "useAwsProvidedLatestImage": { "type": "boolean", - "description": "A value that indicates whether AWS provided latest image is applied automatically to the Custom Engine Version. By default, AWS provided latest image is applied automatically. This value is only applied on create." + "description": "Specifies whether to use the latest service-provided Amazon Machine Image (AMI) for the CEV. If you specify ``UseAwsProvidedLatestImage``, you can't also specify ``ImageId``." } }, "requiredInputs": [ @@ -258460,6 +258980,10 @@ "type": "integer", "description": "The custom port to use when connecting to a workgroup. Valid port ranges are 5431-5455 and 8191-8215. The default is 5439." }, + "pricePerformanceTarget": { + "$ref": "#/types/aws-native:redshiftserverless:WorkgroupPerformanceTarget", + "description": "A property that represents the price performance target settings for the workgroup." + }, "publiclyAccessible": { "type": "boolean", "description": "A value that specifies whether the workgroup can be accessible from a public network." @@ -258533,6 +259057,10 @@ "type": "integer", "description": "The custom port to use when connecting to a workgroup. Valid port ranges are 5431-5455 and 8191-8215. The default is 5439." }, + "pricePerformanceTarget": { + "$ref": "#/types/aws-native:redshiftserverless:WorkgroupPerformanceTarget", + "description": "A property that represents the price performance target settings for the workgroup." + }, "publiclyAccessible": { "type": "boolean", "description": "A value that specifies whether the workgroup can be accessible from a public network." @@ -262382,6 +262910,9 @@ "$ref": "#/types/aws-native:s3:BucketLoggingConfiguration", "description": "Settings that define where logs are stored." }, + "metadataTableConfiguration": { + "$ref": "#/types/aws-native:s3:BucketMetadataTableConfiguration" + }, "metricsConfigurations": { "type": "array", "items": { @@ -262495,6 +263026,9 @@ "$ref": "#/types/aws-native:s3:BucketLoggingConfiguration", "description": "Settings that define where logs are stored." }, + "metadataTableConfiguration": { + "$ref": "#/types/aws-native:s3:BucketMetadataTableConfiguration" + }, "metricsConfigurations": { "type": "array", "items": { @@ -262800,7 +263334,7 @@ }, "availabilityZoneName": { "type": "string", - "description": "Returns the code for the Availability Zone where the directory bucket was created." + "description": "Returns the code for the Availability Zone or Local Zone where the directory bucket was created. An example for the code of an Availability Zone is 'us-east-1f'." }, "bucketEncryption": { "$ref": "#/types/aws-native:s3express:DirectoryBucketBucketEncryption", @@ -262808,12 +263342,12 @@ }, "bucketName": { "type": "string", - "description": "Specifies a name for the bucket. The bucket name must contain only lowercase letters, numbers, and hyphens (-). A directory bucket name must be unique in the chosen Availability Zone. The bucket name must also follow the format 'bucket_base_name--az_id--x-s3' (for example, 'DOC-EXAMPLE-BUCKET--usw2-az1--x-s3'). If you don't specify a name, AWS CloudFormation generates a unique physical ID and uses that ID for the bucket name.", + "description": "Specifies a name for the bucket. The bucket name must contain only lowercase letters, numbers, and hyphens (-). A directory bucket name must be unique in the chosen Availability Zone or Local Zone. The bucket name must also follow the format 'bucket_base_name--zone_id--x-s3'. The zone_id can be the ID of an Availability Zone or a Local Zone. If you don't specify a name, AWS CloudFormation generates a unique physical ID and uses that ID for the bucket name.", "replaceOnChanges": true }, "dataRedundancy": { "$ref": "#/types/aws-native:s3express:DirectoryBucketDataRedundancy", - "description": "Specifies the number of Availability Zone that's used for redundancy for the bucket.", + "description": "Specifies the number of Availability Zone or Local Zone that's used for redundancy for the bucket.", "replaceOnChanges": true }, "lifecycleConfiguration": { @@ -262822,7 +263356,7 @@ }, "locationName": { "type": "string", - "description": "Specifies the AZ ID of the Availability Zone where the directory bucket will be created. An example AZ ID value is 'use1-az5'.", + "description": "Specifies the Zone ID of the Availability Zone or Local Zone where the directory bucket will be created. An example Availability Zone ID value is 'use1-az5'.", "replaceOnChanges": true } }, @@ -262840,11 +263374,11 @@ }, "bucketName": { "type": "string", - "description": "Specifies a name for the bucket. The bucket name must contain only lowercase letters, numbers, and hyphens (-). A directory bucket name must be unique in the chosen Availability Zone. The bucket name must also follow the format 'bucket_base_name--az_id--x-s3' (for example, 'DOC-EXAMPLE-BUCKET--usw2-az1--x-s3'). If you don't specify a name, AWS CloudFormation generates a unique physical ID and uses that ID for the bucket name." + "description": "Specifies a name for the bucket. The bucket name must contain only lowercase letters, numbers, and hyphens (-). A directory bucket name must be unique in the chosen Availability Zone or Local Zone. The bucket name must also follow the format 'bucket_base_name--zone_id--x-s3'. The zone_id can be the ID of an Availability Zone or a Local Zone. If you don't specify a name, AWS CloudFormation generates a unique physical ID and uses that ID for the bucket name." }, "dataRedundancy": { "$ref": "#/types/aws-native:s3express:DirectoryBucketDataRedundancy", - "description": "Specifies the number of Availability Zone that's used for redundancy for the bucket." + "description": "Specifies the number of Availability Zone or Local Zone that's used for redundancy for the bucket." }, "lifecycleConfiguration": { "$ref": "#/types/aws-native:s3express:DirectoryBucketLifecycleConfiguration", @@ -262852,7 +263386,7 @@ }, "locationName": { "type": "string", - "description": "Specifies the AZ ID of the Availability Zone where the directory bucket will be created. An example AZ ID value is 'use1-az5'." + "description": "Specifies the Zone ID of the Availability Zone or Local Zone where the directory bucket will be created. An example Availability Zone ID value is 'use1-az5'." } }, "requiredInputs": [ @@ -263201,6 +263735,63 @@ "subnetId" ] }, + "aws-native:s3tables:TableBucket": { + "description": "Creates an Amazon S3 Tables table bucket in the same AWS Region where you create the AWS CloudFormation stack.", + "properties": { + "tableBucketArn": { + "type": "string" + }, + "tableBucketName": { + "type": "string", + "replaceOnChanges": true + }, + "unreferencedFileRemoval": { + "$ref": "#/types/aws-native:s3tables:TableBucketUnreferencedFileRemoval" + } + }, + "type": "object", + "required": [ + "tableBucketArn", + "tableBucketName" + ], + "inputProperties": { + "tableBucketName": { + "type": "string" + }, + "unreferencedFileRemoval": { + "$ref": "#/types/aws-native:s3tables:TableBucketUnreferencedFileRemoval" + } + } + }, + "aws-native:s3tables:TableBucketPolicy": { + "description": "Applies an IAM resource policy to a table bucket.", + "properties": { + "resourcePolicy": { + "$ref": "#/types/aws-native:s3tables:TableBucketPolicyResourcePolicy" + }, + "tableBucketArn": { + "type": "string", + "replaceOnChanges": true + } + }, + "type": "object", + "required": [ + "resourcePolicy", + "tableBucketArn" + ], + "inputProperties": { + "resourcePolicy": { + "$ref": "#/types/aws-native:s3tables:TableBucketPolicyResourcePolicy" + }, + "tableBucketArn": { + "type": "string" + } + }, + "requiredInputs": [ + "resourcePolicy", + "tableBucketArn" + ] + }, "aws-native:sagemaker:App": { "description": "Resource Type definition for AWS::SageMaker::App", "properties": { @@ -278634,10 +279225,6 @@ "type": "string", "description": "The domain name ID." }, - "managementPolicy": { - "$ref": "pulumi.json#/Any", - "description": "Search the [CloudFormation User Guide](https://docs.aws.amazon.com/cloudformation/) for `AWS::ApiGateway::DomainNameV2` for more information about the expected schema for this property." - }, "policy": { "$ref": "pulumi.json#/Any", "description": "A stringified JSON policy document that applies to the `execute-api` service for this DomainName regardless of the caller and Method configuration. You can use `Fn::ToJsonString` to enter your `policy` . For more information, see [Fn::ToJsonString](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/intrinsic-function-reference-ToJsonString.html) .\n\nSearch the [CloudFormation User Guide](https://docs.aws.amazon.com/cloudformation/) for `AWS::ApiGateway::DomainNameV2` for more information about the expected schema for this property." @@ -287479,7 +288066,7 @@ }, "useCognitoProvidedValues": { "type": "boolean", - "description": "When true, applies the default branding style options. This option reverts to a \"blank\" style that you can modify later in the branding designer." + "description": "When true, applies the default branding style options. This option reverts to default style options that are managed by Amazon Cognito. You can modify them later in the branding designer.\n\nWhen you specify `true` for this option, you must also omit values for `Settings` and `Assets` in the request." } } } @@ -287512,7 +288099,7 @@ "items": { "type": "string" }, - "description": "Attributes supported as an alias for this user pool. Possible values: *phone_number* , *email* , or *preferred_username* ." + "description": "Attributes supported as an alias for this user pool. Possible values: *phone_number* , *email* , or *preferred_username* . For more information about alias attributes, see [Customizing sign-in attributes](https://docs.aws.amazon.com/cognito/latest/developerguide/user-pool-settings-attributes.html#user-pool-settings-aliases) ." }, "arn": { "type": "string", @@ -287523,7 +288110,7 @@ "items": { "type": "string" }, - "description": "The attributes to be auto-verified. Possible values: *email* , *phone_number* ." + "description": "The attributes that you want your user pool to automatically verify. Possible values: *email* , *phone_number* . For more information see [Verifying contact information at sign-up](https://docs.aws.amazon.com/cognito/latest/developerguide/signing-up-users-in-your-app.html#allowing-users-to-sign-up-and-confirm-themselves) ." }, "deletionProtection": { "type": "string", @@ -287531,7 +288118,7 @@ }, "deviceConfiguration": { "$ref": "#/types/aws-native:cognito:UserPoolDeviceConfiguration", - "description": "The device-remembering configuration for a user pool. A null value indicates that you have deactivated device remembering in your user pool.\n\n\u003e When you provide a value for any `DeviceConfiguration` field, you activate the Amazon Cognito device-remembering feature." + "description": "The device-remembering configuration for a user pool. Device remembering or device tracking is a \"Remember me on this device\" option for user pools that perform authentication with the device key of a trusted device in the back end, instead of a user-provided MFA code. For more information about device authentication, see [Working with user devices in your user pool](https://docs.aws.amazon.com/cognito/latest/developerguide/amazon-cognito-user-pools-device-tracking.html) . A null value indicates that you have deactivated device remembering in your user pool.\n\n\u003e When you provide a value for any `DeviceConfiguration` field, you activate the Amazon Cognito device-remembering feature. For more infor" }, "emailAuthenticationMessage": { "type": "string" @@ -287576,7 +288163,7 @@ "items": { "$ref": "#/types/aws-native:cognito:UserPoolSchemaAttribute" }, - "description": "An array of schema attributes for the new user pool. These attributes can be standard or custom attributes." + "description": "An array of attributes for the new user pool. You can add custom attributes and modify the properties of default attributes. The specifications in this parameter set the required attributes in your user pool. For more information, see [Working with user attributes](https://docs.aws.amazon.com/cognito/latest/developerguide/user-pool-settings-attributes.html) ." }, "smsAuthenticationMessage": { "type": "string", @@ -287584,7 +288171,7 @@ }, "smsConfiguration": { "$ref": "#/types/aws-native:cognito:UserPoolSmsConfiguration", - "description": "The SMS configuration with the settings that your Amazon Cognito user pool must use to send an SMS message from your AWS account through Amazon Simple Notification Service. To send SMS messages with Amazon SNS in the AWS Region that you want, the Amazon Cognito user pool uses an AWS Identity and Access Management (IAM) role in your AWS account ." + "description": "The SMS configuration with the settings that your Amazon Cognito user pool must use to send an SMS message from your AWS account through Amazon Simple Notification Service. To send SMS messages with Amazon SNS in the AWS Region that you want, the Amazon Cognito user pool uses an AWS Identity and Access Management (IAM) role in your AWS account . For more information see [SMS message settings](https://docs.aws.amazon.com/cognito/latest/developerguide/user-pool-sms-settings.html) ." }, "smsVerificationMessage": { "type": "string", @@ -287604,7 +288191,7 @@ }, "userPoolName": { "type": "string", - "description": "A string used to name the user pool." + "description": "A friendlhy name for your user pool." }, "userPoolTags": { "type": "object", @@ -287626,17 +288213,19 @@ }, "usernameConfiguration": { "$ref": "#/types/aws-native:cognito:UserPoolUsernameConfiguration", - "description": "Case sensitivity on the username input for the selected sign-in option. When case sensitivity is set to `False` (case insensitive), users can sign in with any combination of capital and lowercase letters. For example, `username` , `USERNAME` , or `UserName` , or for email, `email@example.com` or `EMaiL@eXamplE.Com` . For most use cases, set case sensitivity to `False` (case insensitive) as a best practice. When usernames and email addresses are case insensitive, Amazon Cognito treats any variation in case as the same user, and prevents a case variation from being assigned to the same attribute for a different user.\n\nThis configuration is immutable after you set it. For more information, see [UsernameConfigurationType](https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_UsernameConfigurationType.html) ." + "description": "Sets the case sensitivity option for sign-in usernames. When `CaseSensitive` is `false` (case insensitive), users can sign in with any combination of capital and lowercase letters. For example, `username` , `USERNAME` , or `UserName` , or for email, `email@example.com` or `EMaiL@eXamplE.Com` . For most use cases, set case sensitivity to `false` as a best practice. When usernames and email addresses are case insensitive, Amazon Cognito treats any variation in case as the same user, and prevents a case variation from being assigned to the same attribute for a different user.\n\nWhen `CaseSensitive` is `true` (case sensitive), Amazon Cognito interprets `USERNAME` and `UserName` as distinct users.\n\nThis configuration is immutable after you set it." }, "verificationMessageTemplate": { "$ref": "#/types/aws-native:cognito:UserPoolVerificationMessageTemplate", "description": "The template for the verification message that your user pool delivers to users who set an email address or phone number attribute.\n\nSet the email message type that corresponds to your `DefaultEmailOption` selection. For `CONFIRM_WITH_LINK` , specify an `EmailMessageByLink` and leave `EmailMessage` blank. For `CONFIRM_WITH_CODE` , specify an `EmailMessage` and leave `EmailMessageByLink` blank. When you supply both parameters with either choice, Amazon Cognito returns an error." }, "webAuthnRelyingPartyId": { - "type": "string" + "type": "string", + "description": "Sets or displays the authentication domain, typically your user pool domain, that passkey providers must use as a relying party (RP) in their configuration.\n\nUnder the following conditions, the passkey relying party ID must be the fully-qualified domain name of your custom domain:\n\n- The user pool is configured for passkey authentication.\n- The user pool has a custom domain, whether or not it also has a prefix domain.\n- Your application performs authentication with managed login or the classic hosted UI." }, "webAuthnUserVerification": { - "type": "string" + "type": "string", + "description": "When `required` , users can only register and sign in users with passkeys that are capable of [user verification](https://docs.aws.amazon.com/https://www.w3.org/TR/webauthn-2/#enum-userVerificationRequirement) . When `preferred` , your user pool doesn't require the use of authenticators with user verification but encourages it." } } } @@ -287651,7 +288240,7 @@ }, "userPoolId": { "type": "string", - "description": "The user pool ID for the user pool where you want to create a user pool client." + "description": "The ID of the user pool where you want to create an app client." } }, "required": [ @@ -287681,11 +288270,11 @@ "items": { "type": "string" }, - "description": "The allowed OAuth scopes. Possible values provided by OAuth are `phone` , `email` , `openid` , and `profile` . Possible values provided by AWS are `aws.cognito.signin.user.admin` . Custom scopes created in Resource Servers are also supported." + "description": "The OAuth 2.0 scopes that you want to permit your app client to authorize. Scopes govern access control to user pool self-service API operations, user data from the `userInfo` endpoint, and third-party APIs. Possible values provided by OAuth are `phone` , `email` , `openid` , and `profile` . Possible values provided by AWS are `aws.cognito.signin.user.admin` . Custom scopes created in Resource Servers are also supported." }, "analyticsConfiguration": { "$ref": "#/types/aws-native:cognito:UserPoolClientAnalyticsConfiguration", - "description": "The user pool analytics configuration for collecting metrics and sending them to your Amazon Pinpoint campaign.\n\n\u003e In AWS Regions where Amazon Pinpoint isn't available, user pools only support sending events to Amazon Pinpoint projects in AWS Region us-east-1. In Regions where Amazon Pinpoint is available, user pools support sending events to Amazon Pinpoint projects within that same Region." + "description": "The user pool analytics configuration for collecting metrics and sending them to your Amazon Pinpoint campaign.\n\nIn AWS Regions where Amazon Pinpoint isn't available, user pools might not have access to analytics or might be configurable with campaigns in the US East (N. Virginia) Region. For more information, see [Using Amazon Pinpoint analytics](https://docs.aws.amazon.com/cognito/latest/developerguide/cognito-user-pools-pinpoint-integration.html) ." }, "authSessionValidity": { "type": "integer", @@ -287696,7 +288285,7 @@ "items": { "type": "string" }, - "description": "A list of allowed redirect (callback) URLs for the IdPs.\n\nA redirect URI must:\n\n- Be an absolute URI.\n- Be registered with the authorization server.\n- Not include a fragment component.\n\nSee [OAuth 2.0 - Redirection Endpoint](https://docs.aws.amazon.com/https://tools.ietf.org/html/rfc6749#section-3.1.2) .\n\nAmazon Cognito requires HTTPS over HTTP except for http://localhost for testing purposes only.\n\nApp callback URLs such as myapp://example are also supported." + "description": "A list of allowed redirect (callback) URLs for the IdPs.\n\nA redirect URI must:\n\n- Be an absolute URI.\n- Be registered with the authorization server. Amazon Cognito doesn't accept authorization requests with `redirect_uri` values that aren't in the list of `CallbackURLs` that you provide in this parameter.\n- Not include a fragment component.\n\nSee [OAuth 2.0 - Redirection Endpoint](https://docs.aws.amazon.com/https://tools.ietf.org/html/rfc6749#section-3.1.2) .\n\nAmazon Cognito requires HTTPS over HTTP except for http://localhost for testing purposes only.\n\nApp callback URLs such as myapp://example are also supported." }, "clientId": { "type": "string", @@ -287704,14 +288293,14 @@ }, "clientName": { "type": "string", - "description": "The client name for the user pool client you would like to create." + "description": "A friendly name for the app client that you want to create." }, "clientSecret": { "type": "string" }, "defaultRedirectUri": { "type": "string", - "description": "The default redirect URI. In app clients with one assigned IdP, replaces `redirect_uri` in authentication requests. Must be in the `CallbackURLs` list.\n\nA redirect URI must:\n\n- Be an absolute URI.\n- Be registered with the authorization server.\n- Not include a fragment component.\n\nFor more information, see [Default redirect URI](https://docs.aws.amazon.com/cognito/latest/developerguide/user-pool-settings-client-apps.html#cognito-user-pools-app-idp-settings-about) .\n\nAmazon Cognito requires HTTPS over HTTP except for http://localhost for testing purposes only.\n\nApp callback URLs such as myapp://example are also supported." + "description": "The default redirect URI. In app clients with one assigned IdP, replaces `redirect_uri` in authentication requests. Must be in the `CallbackURLs` list." }, "enablePropagateAdditionalUserContextData": { "type": "boolean", @@ -287737,7 +288326,7 @@ "items": { "type": "string" }, - "description": "A list of allowed logout URLs for the IdPs." + "description": "A list of allowed logout URLs for managed login authentication. For more information, see [Logout endpoint](https://docs.aws.amazon.com/cognito/latest/developerguide/logout-endpoint.html) ." }, "name": { "type": "string" @@ -287762,11 +288351,11 @@ "items": { "type": "string" }, - "description": "A list of provider names for the identity providers (IdPs) that are supported on this client. The following are supported: `COGNITO` , `Facebook` , `Google` , `SignInWithApple` , and `LoginWithAmazon` . You can also specify the names that you configured for the SAML and OIDC IdPs in your user pool, for example `MySAMLIdP` or `MyOIDCIdP` .\n\nThis setting applies to providers that you can access with the [hosted UI and OAuth 2.0 authorization server](https://docs.aws.amazon.com/cognito/latest/developerguide/cognito-user-pools-app-integration.html) . The removal of `COGNITO` from this list doesn't prevent authentication operations for local users with the user pools API in an AWS SDK. The only way to prevent API-based authentication is to block access with a [AWS WAF rule](https://docs.aws.amazon.com/cognito/latest/developerguide/user-pool-waf.html) ." + "description": "A list of provider names for the identity providers (IdPs) that are supported on this client. The following are supported: `COGNITO` , `Facebook` , `Google` , `SignInWithApple` , and `LoginWithAmazon` . You can also specify the names that you configured for the SAML and OIDC IdPs in your user pool, for example `MySAMLIdP` or `MyOIDCIdP` .\n\nThis setting applies to providers that you can access with [managed login](https://docs.aws.amazon.com/cognito/latest/developerguide/cognito-user-pools-managed-login.html) . The removal of `COGNITO` from this list doesn't prevent authentication operations for local users with the user pools API in an AWS SDK. The only way to prevent API-based authentication is to block access with a [AWS WAF rule](https://docs.aws.amazon.com/cognito/latest/developerguide/user-pool-waf.html) ." }, "tokenValidityUnits": { "$ref": "#/types/aws-native:cognito:UserPoolClientTokenValidityUnits", - "description": "The units in which the validity times are represented. The default unit for RefreshToken is days, and default for ID and access tokens are hours." + "description": "The units that validity times are represented in. The default unit for refresh tokens is days, and the default for ID and access tokens are hours." }, "writeAttributes": { "type": "array", @@ -287818,11 +288407,11 @@ "properties": { "groupName": { "type": "string", - "description": "The name of the group. Must be unique." + "description": "A name for the group. This name must be unique in your user pool." }, "userPoolId": { "type": "string", - "description": "The user pool ID for the user pool." + "description": "The ID of the user pool where you want to create a user group." } }, "required": [ @@ -287834,7 +288423,7 @@ "properties": { "description": { "type": "string", - "description": "A string containing the description of the group." + "description": "A description of the group that you're creating." }, "precedence": { "type": "integer", @@ -287842,7 +288431,7 @@ }, "roleArn": { "type": "string", - "description": "The role Amazon Resource Name (ARN) for the group." + "description": "The Amazon Resource Name (ARN) for the IAM role that you want to associate with the group. A group role primarily declares a preferred role for the credentials that you get from an identity pool. Amazon Cognito ID tokens have a `cognito:preferred_role` claim that presents the highest-precedence group that a user belongs to. Both ID and access tokens also contain a `cognito:groups` claim that list all the groups that a user is a member of." } } } @@ -287853,11 +288442,11 @@ "properties": { "providerName": { "type": "string", - "description": "The IdP name." + "description": "The name that you want to assign to the IdP. You can pass the identity provider name in the `identity_provider` query parameter of requests to the [Authorize endpoint](https://docs.aws.amazon.com/cognito/latest/developerguide/authorization-endpoint.html) to silently redirect to sign-in with the associated IdP." }, "userPoolId": { "type": "string", - "description": "The user pool ID." + "description": "The Id of the user pool where you want to create an IdP." } }, "required": [ @@ -287872,14 +288461,14 @@ "additionalProperties": { "type": "string" }, - "description": "A mapping of IdP attributes to standard and custom user pool attributes." + "description": "A mapping of IdP attributes to standard and custom user pool attributes. Specify a user pool attribute as the key of the key-value pair, and the IdP attribute claim name as the value." }, "idpIdentifiers": { "type": "array", "items": { "type": "string" }, - "description": "A list of IdP identifiers." + "description": "An array of IdP identifiers, for example `\"IdPIdentifiers\": [ \"MyIdP\", \"MyIdP2\" ]` . Identifiers are friendly names that you can pass in the `idp_identifier` query parameter of requests to the [Authorize endpoint](https://docs.aws.amazon.com/cognito/latest/developerguide/authorization-endpoint.html) to silently redirect to sign-in with the associated IdP. Identifiers in a domain format also enable the use of [email-address matching with SAML providers](https://docs.aws.amazon.com/cognito/latest/developerguide/cognito-user-pools-managing-saml-idp-naming.html) ." }, "providerDetails": { "type": "object", @@ -287901,7 +288490,7 @@ }, "userPoolId": { "type": "string", - "description": "The user pool ID for the user pool." + "description": "The ID of the user pool where you want to create a resource server." } }, "required": [ @@ -287970,7 +288559,7 @@ }, "userPoolId": { "type": "string", - "description": "The user pool ID for the user pool." + "description": "The ID of the user pool." } }, "required": [ @@ -289268,6 +289857,10 @@ "type": "string", "description": "The name of the task template." }, + "selfAssignContactFlowArn": { + "type": "string", + "description": "The identifier of the contact flow." + }, "status": { "$ref": "#/types/aws-native:connect:TaskTemplateStatus", "description": "The status of the task template." @@ -303762,7 +304355,7 @@ }, "healthEventsConfig": { "$ref": "#/types/aws-native:internetmonitor:MonitorHealthEventsConfig", - "description": "A complex type with the configuration information that determines the threshold and other conditions for when Internet Monitor creates a health event for an overall performance or availability issue, across an application's geographies.\n\nDefines the percentages, for overall performance scores and availability scores for an application, that are the thresholds for when Amazon CloudWatch Internet Monitor creates a health event. You can override the defaults to set a custom threshold for overall performance or availability scores, or both.\n\nYou can also set thresholds for local health scores,, where Internet Monitor creates a health event when scores cross a threshold for one or more city-networks, in addition to creating an event when an overall score crosses a threshold.\n\nIf you don't set a health event threshold, the default value is 95%.\n\nFor local thresholds, you also set a minimum percentage of overall traffic that is impacted by an issue before Internet Monitor creates an event. In addition, you can disable local thresholds, for performance scores, availability scores, or both.\n\nFor more information, see [Change health event thresholds](https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/CloudWatch-IM-overview.html#IMUpdateThresholdFromOverview) in the Internet Monitor section of the *CloudWatch User Guide* ." + "description": "A complex type with the configuration information that determines the threshold and other conditions for when Internet Monitor creates a health event for an overall performance or availability issue, across an application's geographies.\n\nDefines the percentages, for overall performance scores and availability scores for an application, that are the thresholds for when Internet Monitor creates a health event. You can override the defaults to set a custom threshold for overall performance or availability scores, or both.\n\nYou can also set thresholds for local health scores,, where Internet Monitor creates a health event when scores cross a threshold for one or more city-networks, in addition to creating an event when an overall score crosses a threshold.\n\nIf you don't set a health event threshold, the default value is 95%.\n\nFor local thresholds, you also set a minimum percentage of overall traffic that is impacted by an issue before Internet Monitor creates an event. In addition, you can disable local thresholds, for performance scores, availability scores, or both.\n\nFor more information, see [Change health event thresholds](https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/CloudWatch-IM-overview.html#IMUpdateThresholdFromOverview) in the Internet Monitor section of the *CloudWatch User Guide* ." }, "internetMeasurementsLogDelivery": { "$ref": "#/types/aws-native:internetmonitor:MonitorInternetMeasurementsLogDelivery", @@ -303818,7 +304411,8 @@ "inputs": { "properties": { "invoiceUnitArn": { - "type": "string" + "type": "string", + "description": "The ARN to identify an invoice unit. This information can't be modified or deleted." } }, "required": [ @@ -303828,25 +304422,31 @@ "outputs": { "properties": { "description": { - "type": "string" + "type": "string", + "description": "The assigned description for an invoice unit. This information can't be modified or deleted." }, "invoiceUnitArn": { - "type": "string" + "type": "string", + "description": "The ARN to identify an invoice unit. This information can't be modified or deleted." }, "lastModified": { - "type": "number" + "type": "number", + "description": "The last time the invoice unit was updated. This is important to determine the version of invoice unit configuration used to create the invoices. Any invoice created after this modified time will use this invoice unit configuration." }, "resourceTags": { "type": "array", "items": { "$ref": "#/types/aws-native:index:Tag" - } + }, + "description": "The tag structure that contains a tag key and value." }, "rule": { - "$ref": "#/types/aws-native:invoicing:InvoiceUnitRule" + "$ref": "#/types/aws-native:invoicing:InvoiceUnitRule", + "description": "An `InvoiceUnitRule` object used the categorize invoice units." }, "taxInheritanceDisabled": { - "type": "boolean" + "type": "boolean", + "description": "Whether the invoice unit based tax inheritance is/ should be enabled or disabled." } } } @@ -304085,6 +304685,74 @@ } } }, + "aws-native:iot:getCommand": { + "description": "Represents the resource definition of AWS IoT Command.", + "inputs": { + "properties": { + "commandId": { + "type": "string", + "description": "The unique identifier for the command." + } + }, + "required": [ + "commandId" + ] + }, + "outputs": { + "properties": { + "commandArn": { + "type": "string", + "description": "The Amazon Resource Name (ARN) of the command." + }, + "createdAt": { + "type": "string", + "description": "The date and time when the command was created." + }, + "deprecated": { + "type": "boolean", + "description": "A flag indicating whether the command is deprecated." + }, + "description": { + "type": "string", + "description": "The description of the command." + }, + "displayName": { + "type": "string", + "description": "The display name for the command." + }, + "mandatoryParameters": { + "type": "array", + "items": { + "$ref": "#/types/aws-native:iot:CommandParameter" + }, + "description": "The list of mandatory parameters for the command." + }, + "namespace": { + "$ref": "#/types/aws-native:iot:CommandNamespace", + "description": "The namespace to which the command belongs." + }, + "payload": { + "$ref": "#/types/aws-native:iot:CommandPayload", + "description": "The payload associated with the command." + }, + "pendingDeletion": { + "type": "boolean", + "description": "A flag indicating whether the command is pending deletion." + }, + "roleArn": { + "type": "string", + "description": "The customer role associated with the command." + }, + "tags": { + "type": "array", + "items": { + "$ref": "#/types/aws-native:index:Tag" + }, + "description": "The tags to be associated with the command." + } + } + } + }, "aws-native:iot:getCustomMetric": { "description": "A custom metric published by your devices to Device Defender.", "inputs": { @@ -317352,6 +318020,43 @@ } } }, + "aws-native:ram:getResourceShare": { + "description": "Resource type definition for AWS::RAM::ResourceShare", + "inputs": { + "properties": { + "arn": { + "type": "string", + "description": "The Amazon Resource Name (ARN) of the resource share." + } + }, + "required": [ + "arn" + ] + }, + "outputs": { + "properties": { + "allowExternalPrincipals": { + "type": "boolean", + "description": "Specifies whether principals outside your organization in AWS Organizations can be associated with a resource share. A value of `true` lets you share with individual AWS accounts that are not in your organization. A value of `false` only has meaning if your account is a member of an AWS Organization. The default value is `true`." + }, + "arn": { + "type": "string", + "description": "The Amazon Resource Name (ARN) of the resource share." + }, + "name": { + "type": "string", + "description": "Specifies the name of the resource share." + }, + "tags": { + "type": "array", + "items": { + "$ref": "#/types/aws-native:index:Tag" + }, + "description": "Specifies one or more tags to attach to the resource share itself. It doesn't attach the tags to the resources associated with the resource share." + } + } + } + }, "aws-native:rbin:getRule": { "description": "Resource Type definition for AWS::Rbin::Rule", "inputs": { @@ -317416,16 +318121,16 @@ } }, "aws-native:rds:getCustomDbEngineVersion": { - "description": "The AWS::RDS::CustomDBEngineVersion resource creates an Amazon RDS custom DB engine version.", + "description": "Creates a custom DB engine version (CEV).", "inputs": { "properties": { "engine": { "type": "string", - "description": "The database engine to use for your custom engine version (CEV). The only supported value is `custom-oracle-ee`." + "description": "The database engine to use for your custom engine version (CEV).\n Valid values:\n + ``custom-oracle-ee`` \n + ``custom-oracle-ee-cdb``" }, "engineVersion": { "type": "string", - "description": "The name of your CEV. The name format is 19.customized_string . For example, a valid name is 19.my_cev1. This setting is required for RDS Custom for Oracle, but optional for Amazon RDS. The combination of Engine and EngineVersion is unique per customer per Region." + "description": "The name of your CEV. The name format is ``major version.customized_string``. For example, a valid CEV name is ``19.my_cev1``. This setting is required for RDS Custom for Oracle, but optional for Amazon RDS. The combination of ``Engine`` and ``EngineVersion`` is unique per customer per Region.\n *Constraints:* Minimum length is 1. Maximum length is 60.\n *Pattern:* ``^[a-z0-9_.-]{1,60$``}" } }, "required": [ @@ -317445,14 +318150,14 @@ }, "status": { "$ref": "#/types/aws-native:rds:CustomDbEngineVersionStatus", - "description": "The availability status to be assigned to the CEV." + "description": "A value that indicates the status of a custom engine version (CEV)." }, "tags": { "type": "array", "items": { "$ref": "#/types/aws-native:index:Tag" }, - "description": "An array of key-value pairs to apply to this resource." + "description": "A list of tags. For more information, see [Tagging Amazon RDS Resources](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_Tagging.html) in the *Amazon RDS User Guide.*" } } } @@ -319027,6 +319732,10 @@ "type": "integer", "description": "The custom port to use when connecting to a workgroup. Valid port ranges are 5431-5455 and 8191-8215. The default is 5439." }, + "pricePerformanceTarget": { + "$ref": "#/types/aws-native:redshiftserverless:WorkgroupPerformanceTarget", + "description": "A property that represents the price performance target settings for the workgroup." + }, "publiclyAccessible": { "type": "boolean", "description": "A value that specifies whether the workgroup can be accessible from a public network." @@ -321298,6 +322007,9 @@ "$ref": "#/types/aws-native:s3:BucketLoggingConfiguration", "description": "Settings that define where logs are stored." }, + "metadataTableConfiguration": { + "$ref": "#/types/aws-native:s3:BucketMetadataTableConfiguration" + }, "metricsConfigurations": { "type": "array", "items": { @@ -321490,7 +322202,7 @@ "properties": { "bucketName": { "type": "string", - "description": "Specifies a name for the bucket. The bucket name must contain only lowercase letters, numbers, and hyphens (-). A directory bucket name must be unique in the chosen Availability Zone. The bucket name must also follow the format 'bucket_base_name--az_id--x-s3' (for example, 'DOC-EXAMPLE-BUCKET--usw2-az1--x-s3'). If you don't specify a name, AWS CloudFormation generates a unique physical ID and uses that ID for the bucket name." + "description": "Specifies a name for the bucket. The bucket name must contain only lowercase letters, numbers, and hyphens (-). A directory bucket name must be unique in the chosen Availability Zone or Local Zone. The bucket name must also follow the format 'bucket_base_name--zone_id--x-s3'. The zone_id can be the ID of an Availability Zone or a Local Zone. If you don't specify a name, AWS CloudFormation generates a unique physical ID and uses that ID for the bucket name." } }, "required": [ @@ -321505,7 +322217,7 @@ }, "availabilityZoneName": { "type": "string", - "description": "Returns the code for the Availability Zone where the directory bucket was created." + "description": "Returns the code for the Availability Zone or Local Zone where the directory bucket was created. An example for the code of an Availability Zone is 'us-east-1f'." }, "bucketEncryption": { "$ref": "#/types/aws-native:s3express:DirectoryBucketBucketEncryption", @@ -321710,6 +322422,49 @@ } } }, + "aws-native:s3tables:getTableBucket": { + "description": "Creates an Amazon S3 Tables table bucket in the same AWS Region where you create the AWS CloudFormation stack.", + "inputs": { + "properties": { + "tableBucketArn": { + "type": "string" + } + }, + "required": [ + "tableBucketArn" + ] + }, + "outputs": { + "properties": { + "tableBucketArn": { + "type": "string" + }, + "unreferencedFileRemoval": { + "$ref": "#/types/aws-native:s3tables:TableBucketUnreferencedFileRemoval" + } + } + } + }, + "aws-native:s3tables:getTableBucketPolicy": { + "description": "Applies an IAM resource policy to a table bucket.", + "inputs": { + "properties": { + "tableBucketArn": { + "type": "string" + } + }, + "required": [ + "tableBucketArn" + ] + }, + "outputs": { + "properties": { + "resourcePolicy": { + "$ref": "#/types/aws-native:s3tables:TableBucketPolicyResourcePolicy" + } + } + } + }, "aws-native:sagemaker:getApp": { "description": "Resource Type definition for AWS::SageMaker::App", "inputs": { diff --git a/reports/missedAutonaming.json b/reports/missedAutonaming.json index 82a5949114..4b1f451587 100644 --- a/reports/missedAutonaming.json +++ b/reports/missedAutonaming.json @@ -336,10 +336,6 @@ "$ref": "#/types/aws-native:apigateway:DomainNameV2EndpointConfiguration", "description": "The endpoint configuration to indicate the types of endpoints an API (RestApi) or its custom domain name (DomainName) has." }, - "managementPolicy": { - "$ref": "pulumi.json#/Any", - "description": "Search the [CloudFormation User Guide](https://docs.aws.amazon.com/cloudformation/) for `AWS::ApiGateway::DomainNameV2` for more information about the expected schema for this property." - }, "policy": { "$ref": "pulumi.json#/Any", "description": "A stringified JSON policy document that applies to the `execute-api` service for this DomainName regardless of the caller and Method configuration. You can use `Fn::ToJsonString` to enter your `policy` . For more information, see [Fn::ToJsonString](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/intrinsic-function-reference-ToJsonString.html) .\n\nSearch the [CloudFormation User Guide](https://docs.aws.amazon.com/cloudformation/) for `AWS::ApiGateway::DomainNameV2` for more information about the expected schema for this property." @@ -2194,10 +2190,12 @@ "description": "An array of image files that you want to apply to roles like backgrounds, logos, and icons. Each object must also indicate whether it is for dark mode, light mode, or browser-adaptive mode." }, "clientId": { - "type": "string" + "type": "string", + "description": "The app client that's assigned to the branding style that you want more information about." }, "returnMergedResources": { - "type": "boolean" + "type": "boolean", + "description": "When `true` , returns values for branding options that are unchanged from Amazon Cognito defaults. When `false` or when you omit this parameter, returns only values that you customized in your branding style." }, "settings": { "$ref": "pulumi.json#/Any", @@ -2205,7 +2203,7 @@ }, "useCognitoProvidedValues": { "type": "boolean", - "description": "When true, applies the default branding style options. This option reverts to a \"blank\" style that you can modify later in the branding designer." + "description": "When true, applies the default branding style options. This option reverts to default style options that are managed by Amazon Cognito. You can modify them later in the branding designer.\n\nWhen you specify `true` for this option, you must also omit values for `Settings` and `Assets` in the request." }, "userPoolId": { "type": "string", @@ -2272,7 +2270,7 @@ }, "userPoolId": { "type": "string", - "description": "The user pool ID for the user pool." + "description": "The ID of the user pool." } } }, @@ -2285,7 +2283,7 @@ }, "userPoolId": { "type": "string", - "description": "The user pool ID for the user pool." + "description": "The ID of the user pool that contains the group that you want to add the user to." }, "username": { "type": "string", @@ -6430,6 +6428,9 @@ "type": "string", "description": "The number of ``cpu`` units used by the task. If you use the EC2 launch type, this field is optional. Any value can be used. If you use the Fargate launch type, this field is required. You must use one of the following values. The value that you choose determines your range of valid values for the ``memory`` parameter.\n If you use the EC2 launch type, this field is optional. Supported values are between ``128`` CPU units (``0.125`` vCPUs) and ``10240`` CPU units (``10`` vCPUs).\n The CPU units cannot be less than 1 vCPU when you use Windows containers on Fargate.\n + 256 (.25 vCPU) - Available ``memory`` values: 512 (0.5 GB), 1024 (1 GB), 2048 (2 GB)\n + 512 (.5 vCPU) - Available ``memory`` values: 1024 (1 GB), 2048 (2 GB), 3072 (3 GB), 4096 (4 GB)\n + 1024 (1 vCPU) - Available ``memory`` values: 2048 (2 GB), 3072 (3 GB), 4096 (4 GB), 5120 (5 GB), 6144 (6 GB), 7168 (7 GB), 8192 (8 GB)\n + 2048 (2 vCPU) - Available ``memory`` values: 4096 (4 GB) and 16384 (16 GB) in increments of 1024 (1 GB)\n + 4096 (4 vCPU) - Available ``memory`` values: 8192 (8 GB) and 30720 (30 GB) in increments of 1024 (1 GB)\n + 8192 (8 vCPU) - Available ``memory`` values: 16 GB and 60 GB in 4 GB increments\n This option requires Linux platform ``1.4.0`` or later.\n + 16384 (16vCPU) - Available ``memory`` values: 32GB and 120 GB in 8 GB increments\n This option requires Linux platform ``1.4.0`` or later." }, + "enableFaultInjection": { + "type": "boolean" + }, "ephemeralStorage": { "$ref": "#/types/aws-native:ecs:TaskDefinitionEphemeralStorage", "description": "The ephemeral storage settings to use for tasks run with the task definition." @@ -7929,6 +7930,65 @@ } } }, + "aws-native:iot:Command": { + "cfTypeName": "AWS::IoT::Command", + "properties": { + "commandId": { + "type": "string", + "description": "The unique identifier for the command." + }, + "createdAt": { + "type": "string", + "description": "The date and time when the command was created." + }, + "deprecated": { + "type": "boolean", + "description": "A flag indicating whether the command is deprecated." + }, + "description": { + "type": "string", + "description": "The description of the command." + }, + "displayName": { + "type": "string", + "description": "The display name for the command." + }, + "lastUpdatedAt": { + "type": "string", + "description": "The date and time when the command was last updated." + }, + "mandatoryParameters": { + "type": "array", + "items": { + "$ref": "#/types/aws-native:iot:CommandParameter" + }, + "description": "The list of mandatory parameters for the command." + }, + "namespace": { + "$ref": "#/types/aws-native:iot:CommandNamespace", + "description": "The namespace to which the command belongs." + }, + "payload": { + "$ref": "#/types/aws-native:iot:CommandPayload", + "description": "The payload associated with the command." + }, + "pendingDeletion": { + "type": "boolean", + "description": "A flag indicating whether the command is pending deletion." + }, + "roleArn": { + "type": "string", + "description": "The customer role associated with the command." + }, + "tags": { + "type": "array", + "items": { + "$ref": "#/types/aws-native:index:Tag" + }, + "description": "The tags to be associated with the command." + } + } + }, "aws-native:iot:JobTemplate": { "cfTypeName": "AWS::IoT::JobTemplate", "properties": { @@ -10215,7 +10275,8 @@ "type": "array", "items": { "type": "string" - } + }, + "description": "The OIDC client ID for a Amazon Q Business application." }, "description": { "type": "string", @@ -10615,11 +10676,11 @@ "properties": { "databaseInstallationFilesS3BucketName": { "type": "string", - "description": "The name of an Amazon S3 bucket that contains database installation files for your CEV. For example, a valid bucket name is `my-custom-installation-files`." + "description": "The name of an Amazon S3 bucket that contains database installation files for your CEV. For example, a valid bucket name is ``my-custom-installation-files``." }, "databaseInstallationFilesS3Prefix": { "type": "string", - "description": "The Amazon S3 directory that contains the database installation files for your CEV. For example, a valid bucket name is `123456789012/cev1`. If this setting isn't specified, no prefix is assumed." + "description": "The Amazon S3 directory that contains the database installation files for your CEV. For example, a valid bucket name is ``123456789012/cev1``. If this setting isn't specified, no prefix is assumed." }, "description": { "type": "string", @@ -10627,42 +10688,42 @@ }, "engine": { "type": "string", - "description": "The database engine to use for your custom engine version (CEV). The only supported value is `custom-oracle-ee`." + "description": "The database engine to use for your custom engine version (CEV).\n Valid values:\n + ``custom-oracle-ee`` \n + ``custom-oracle-ee-cdb``" }, "engineVersion": { "type": "string", - "description": "The name of your CEV. The name format is 19.customized_string . For example, a valid name is 19.my_cev1. This setting is required for RDS Custom for Oracle, but optional for Amazon RDS. The combination of Engine and EngineVersion is unique per customer per Region." + "description": "The name of your CEV. The name format is ``major version.customized_string``. For example, a valid CEV name is ``19.my_cev1``. This setting is required for RDS Custom for Oracle, but optional for Amazon RDS. The combination of ``Engine`` and ``EngineVersion`` is unique per customer per Region.\n *Constraints:* Minimum length is 1. Maximum length is 60.\n *Pattern:* ``^[a-z0-9_.-]{1,60$``}" }, "imageId": { "type": "string", - "description": "The identifier of Amazon Machine Image (AMI) used for CEV." + "description": "A value that indicates the ID of the AMI." }, "kmsKeyId": { "type": "string", - "description": "The AWS KMS key identifier for an encrypted CEV. A symmetric KMS key is required for RDS Custom, but optional for Amazon RDS." + "description": "The AWS KMS key identifier for an encrypted CEV. A symmetric encryption KMS key is required for RDS Custom, but optional for Amazon RDS.\n If you have an existing symmetric encryption KMS key in your account, you can use it with RDS Custom. No further action is necessary. If you don't already have a symmetric encryption KMS key in your account, follow the instructions in [Creating a symmetric encryption KMS key](https://docs.aws.amazon.com/kms/latest/developerguide/create-keys.html#create-symmetric-cmk) in the *Key Management Service Developer Guide*.\n You can choose the same symmetric encryption key when you create a CEV and a DB instance, or choose different keys." }, "manifest": { "type": "string", - "description": "The CEV manifest, which is a JSON document that describes the installation .zip files stored in Amazon S3. Specify the name/value pairs in a file or a quoted string. RDS Custom applies the patches in the order in which they are listed." + "description": "The CEV manifest, which is a JSON document that describes the installation .zip files stored in Amazon S3. Specify the name/value pairs in a file or a quoted string. RDS Custom applies the patches in the order in which they are listed.\n The following JSON fields are valid:\n + MediaImportTemplateVersion Version of the CEV manifest. The date is in the format YYYY-MM-DD. + databaseInstallationFileNames Ordered list of installation files for the CEV. + opatchFileNames Ordered list of OPatch installers used for the Oracle DB engine. + psuRuPatchFileNames The PSU and RU patches for this CEV. + OtherPatchFileNames The patches that are not in the list of PSU and RU patches. Amazon RDS applies these patches after applying the PSU and RU patches. \n For more information, see [Creating the CEV manifest](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/custom-cev.html#custom-cev.preparing.manifest) in the *Amazon RDS User Guide*." }, "sourceCustomDbEngineVersionIdentifier": { "type": "string", - "description": "The identifier of the source custom engine version." + "description": "The ARN of a CEV to use as a source for creating a new CEV. You can specify a different Amazon Machine Imagine (AMI) by using either ``Source`` or ``UseAwsProvidedLatestImage``. You can't specify a different JSON manifest when you specify ``SourceCustomDbEngineVersionIdentifier``." }, "status": { "$ref": "#/types/aws-native:rds:CustomDbEngineVersionStatus", - "description": "The availability status to be assigned to the CEV." + "description": "A value that indicates the status of a custom engine version (CEV)." }, "tags": { "type": "array", "items": { "$ref": "#/types/aws-native:index:Tag" }, - "description": "An array of key-value pairs to apply to this resource." + "description": "A list of tags. For more information, see [Tagging Amazon RDS Resources](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_Tagging.html) in the *Amazon RDS User Guide.*" }, "useAwsProvidedLatestImage": { "type": "boolean", - "description": "A value that indicates whether AWS provided latest image is applied automatically to the Custom Engine Version. By default, AWS provided latest image is applied automatically. This value is only applied on create." + "description": "Specifies whether to use the latest service-provided Amazon Machine Image (AMI) for the CEV. If you specify ``UseAwsProvidedLatestImage``, you can't also specify ``ImageId``." } } }, @@ -12031,6 +12092,17 @@ } } }, + "aws-native:s3tables:TableBucketPolicy": { + "cfTypeName": "AWS::S3Tables::TableBucketPolicy", + "properties": { + "resourcePolicy": { + "$ref": "#/types/aws-native:s3tables:TableBucketPolicyResourcePolicy" + }, + "tableBucketArn": { + "type": "string" + } + } + }, "aws-native:sagemaker:Device": { "cfTypeName": "AWS::SageMaker::Device", "properties": { diff --git a/sdk/dotnet/ApiGateway/DomainNameV2.cs b/sdk/dotnet/ApiGateway/DomainNameV2.cs index be54fdf668..bf5defa62d 100644 --- a/sdk/dotnet/ApiGateway/DomainNameV2.cs +++ b/sdk/dotnet/ApiGateway/DomainNameV2.cs @@ -45,12 +45,6 @@ public partial class DomainNameV2 : global::Pulumi.CustomResource [Output("endpointConfiguration")] public Output EndpointConfiguration { get; private set; } = null!; - /// - /// Search the [CloudFormation User Guide](https://docs.aws.amazon.com/cloudformation/) for `AWS::ApiGateway::DomainNameV2` for more information about the expected schema for this property. - /// - [Output("managementPolicy")] - public Output ManagementPolicy { get; private set; } = null!; - /// /// A stringified JSON policy document that applies to the `execute-api` service for this DomainName regardless of the caller and Method configuration. You can use `Fn::ToJsonString` to enter your `policy` . For more information, see [Fn::ToJsonString](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/intrinsic-function-reference-ToJsonString.html) . /// @@ -140,12 +134,6 @@ public sealed class DomainNameV2Args : global::Pulumi.ResourceArgs [Input("endpointConfiguration")] public Input? EndpointConfiguration { get; set; } - /// - /// Search the [CloudFormation User Guide](https://docs.aws.amazon.com/cloudformation/) for `AWS::ApiGateway::DomainNameV2` for more information about the expected schema for this property. - /// - [Input("managementPolicy")] - public Input? ManagementPolicy { get; set; } - /// /// A stringified JSON policy document that applies to the `execute-api` service for this DomainName regardless of the caller and Method configuration. You can use `Fn::ToJsonString` to enter your `policy` . For more information, see [Fn::ToJsonString](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/intrinsic-function-reference-ToJsonString.html) . /// diff --git a/sdk/dotnet/ApiGateway/GetDomainNameV2.cs b/sdk/dotnet/ApiGateway/GetDomainNameV2.cs index 9168191aa7..ad5103eb85 100644 --- a/sdk/dotnet/ApiGateway/GetDomainNameV2.cs +++ b/sdk/dotnet/ApiGateway/GetDomainNameV2.cs @@ -70,10 +70,6 @@ public sealed class GetDomainNameV2Result /// public readonly string? DomainNameId; /// - /// Search the [CloudFormation User Guide](https://docs.aws.amazon.com/cloudformation/) for `AWS::ApiGateway::DomainNameV2` for more information about the expected schema for this property. - /// - public readonly object? ManagementPolicy; - /// /// A stringified JSON policy document that applies to the `execute-api` service for this DomainName regardless of the caller and Method configuration. You can use `Fn::ToJsonString` to enter your `policy` . For more information, see [Fn::ToJsonString](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/intrinsic-function-reference-ToJsonString.html) . /// /// Search the [CloudFormation User Guide](https://docs.aws.amazon.com/cloudformation/) for `AWS::ApiGateway::DomainNameV2` for more information about the expected schema for this property. @@ -92,8 +88,6 @@ private GetDomainNameV2Result( string? domainNameId, - object? managementPolicy, - object? policy, ImmutableArray tags) @@ -101,7 +95,6 @@ private GetDomainNameV2Result( CertificateArn = certificateArn; DomainNameArn = domainNameArn; DomainNameId = domainNameId; - ManagementPolicy = managementPolicy; Policy = policy; Tags = tags; } diff --git a/sdk/dotnet/ApplicationAutoScaling/Inputs/ScalingPolicyPredictiveScalingCustomizedCapacityMetricArgs.cs b/sdk/dotnet/ApplicationAutoScaling/Inputs/ScalingPolicyPredictiveScalingCustomizedCapacityMetricArgs.cs index a96d78f6c7..d0703202de 100644 --- a/sdk/dotnet/ApplicationAutoScaling/Inputs/ScalingPolicyPredictiveScalingCustomizedCapacityMetricArgs.cs +++ b/sdk/dotnet/ApplicationAutoScaling/Inputs/ScalingPolicyPredictiveScalingCustomizedCapacityMetricArgs.cs @@ -10,6 +10,9 @@ namespace Pulumi.AwsNative.ApplicationAutoScaling.Inputs { + /// + /// Represents a CloudWatch metric of your choosing for a predictive scaling policy. + /// public sealed class ScalingPolicyPredictiveScalingCustomizedCapacityMetricArgs : global::Pulumi.ResourceArgs { [Input("metricDataQueries", required: true)] diff --git a/sdk/dotnet/ApplicationAutoScaling/Inputs/ScalingPolicyPredictiveScalingCustomizedLoadMetricArgs.cs b/sdk/dotnet/ApplicationAutoScaling/Inputs/ScalingPolicyPredictiveScalingCustomizedLoadMetricArgs.cs index 127eeec859..281a3de081 100644 --- a/sdk/dotnet/ApplicationAutoScaling/Inputs/ScalingPolicyPredictiveScalingCustomizedLoadMetricArgs.cs +++ b/sdk/dotnet/ApplicationAutoScaling/Inputs/ScalingPolicyPredictiveScalingCustomizedLoadMetricArgs.cs @@ -10,6 +10,9 @@ namespace Pulumi.AwsNative.ApplicationAutoScaling.Inputs { + /// + /// The customized load metric specification. + /// public sealed class ScalingPolicyPredictiveScalingCustomizedLoadMetricArgs : global::Pulumi.ResourceArgs { [Input("metricDataQueries", required: true)] diff --git a/sdk/dotnet/ApplicationAutoScaling/Inputs/ScalingPolicyPredictiveScalingCustomizedScalingMetricArgs.cs b/sdk/dotnet/ApplicationAutoScaling/Inputs/ScalingPolicyPredictiveScalingCustomizedScalingMetricArgs.cs index 1ad2f2fe92..5f202433bf 100644 --- a/sdk/dotnet/ApplicationAutoScaling/Inputs/ScalingPolicyPredictiveScalingCustomizedScalingMetricArgs.cs +++ b/sdk/dotnet/ApplicationAutoScaling/Inputs/ScalingPolicyPredictiveScalingCustomizedScalingMetricArgs.cs @@ -10,6 +10,9 @@ namespace Pulumi.AwsNative.ApplicationAutoScaling.Inputs { + /// + /// One or more metric data queries to provide data points for a metric specification. + /// public sealed class ScalingPolicyPredictiveScalingCustomizedScalingMetricArgs : global::Pulumi.ResourceArgs { [Input("metricDataQueries", required: true)] diff --git a/sdk/dotnet/ApplicationAutoScaling/Inputs/ScalingPolicyPredictiveScalingMetricArgs.cs b/sdk/dotnet/ApplicationAutoScaling/Inputs/ScalingPolicyPredictiveScalingMetricArgs.cs index e6a48fea44..76784d5a33 100644 --- a/sdk/dotnet/ApplicationAutoScaling/Inputs/ScalingPolicyPredictiveScalingMetricArgs.cs +++ b/sdk/dotnet/ApplicationAutoScaling/Inputs/ScalingPolicyPredictiveScalingMetricArgs.cs @@ -10,13 +10,16 @@ namespace Pulumi.AwsNative.ApplicationAutoScaling.Inputs { + /// + /// Describes the scaling metric. + /// public sealed class ScalingPolicyPredictiveScalingMetricArgs : global::Pulumi.ResourceArgs { [Input("dimensions")] private InputList? _dimensions; /// - /// The dimensions for the metric. + /// Describes the dimensions of the metric. /// public InputList Dimensions { diff --git a/sdk/dotnet/ApplicationAutoScaling/Inputs/ScalingPolicyPredictiveScalingMetricDataQueryArgs.cs b/sdk/dotnet/ApplicationAutoScaling/Inputs/ScalingPolicyPredictiveScalingMetricDataQueryArgs.cs index efaab430a1..274c65b4ae 100644 --- a/sdk/dotnet/ApplicationAutoScaling/Inputs/ScalingPolicyPredictiveScalingMetricDataQueryArgs.cs +++ b/sdk/dotnet/ApplicationAutoScaling/Inputs/ScalingPolicyPredictiveScalingMetricDataQueryArgs.cs @@ -10,16 +10,20 @@ namespace Pulumi.AwsNative.ApplicationAutoScaling.Inputs { + /// + /// 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. + /// public sealed class ScalingPolicyPredictiveScalingMetricDataQueryArgs : global::Pulumi.ResourceArgs { /// - /// The math expression to perform on the returned data, if this object is performing a math expression. + /// 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. + /// Conditional: Within each ``MetricDataQuery`` object, you must specify either ``Expression`` or ``MetricStat``, but not both. /// [Input("expression")] public Input? Expression { get; set; } /// - /// A short name that identifies the object's results in the response. + /// 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. /// [Input("id")] public Input? Id { get; set; } @@ -31,13 +35,16 @@ public sealed class ScalingPolicyPredictiveScalingMetricDataQueryArgs : global:: public Input? Label { get; set; } /// - /// Information about the metric data to return. + /// Information about the metric data to return. + /// Conditional: Within each ``MetricDataQuery`` object, you must specify either ``Expression`` or ``MetricStat``, but not both. /// [Input("metricStat")] public Input? MetricStat { get; set; } /// - /// Indicates whether to return the timestamps and raw data values of this metric. + /// Indicates whether to return the timestamps and raw data values of this metric. + /// 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. + /// 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``). /// [Input("returnData")] public Input? ReturnData { get; set; } diff --git a/sdk/dotnet/ApplicationAutoScaling/Inputs/ScalingPolicyPredictiveScalingMetricDimensionArgs.cs b/sdk/dotnet/ApplicationAutoScaling/Inputs/ScalingPolicyPredictiveScalingMetricDimensionArgs.cs index 90891254e3..e8d42e41c7 100644 --- a/sdk/dotnet/ApplicationAutoScaling/Inputs/ScalingPolicyPredictiveScalingMetricDimensionArgs.cs +++ b/sdk/dotnet/ApplicationAutoScaling/Inputs/ScalingPolicyPredictiveScalingMetricDimensionArgs.cs @@ -10,6 +10,9 @@ namespace Pulumi.AwsNative.ApplicationAutoScaling.Inputs { + /// + /// Describes the dimension of a metric. + /// public sealed class ScalingPolicyPredictiveScalingMetricDimensionArgs : global::Pulumi.ResourceArgs { /// diff --git a/sdk/dotnet/ApplicationAutoScaling/Inputs/ScalingPolicyPredictiveScalingMetricSpecificationArgs.cs b/sdk/dotnet/ApplicationAutoScaling/Inputs/ScalingPolicyPredictiveScalingMetricSpecificationArgs.cs index 7cc77a22f1..6de0cf1c47 100644 --- a/sdk/dotnet/ApplicationAutoScaling/Inputs/ScalingPolicyPredictiveScalingMetricSpecificationArgs.cs +++ b/sdk/dotnet/ApplicationAutoScaling/Inputs/ScalingPolicyPredictiveScalingMetricSpecificationArgs.cs @@ -10,6 +10,10 @@ namespace Pulumi.AwsNative.ApplicationAutoScaling.Inputs { + /// + /// This structure specifies the metrics and target utilization settings for a predictive scaling policy. + /// 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. + /// public sealed class ScalingPolicyPredictiveScalingMetricSpecificationArgs : global::Pulumi.ResourceArgs { /// diff --git a/sdk/dotnet/ApplicationAutoScaling/Inputs/ScalingPolicyPredictiveScalingMetricStatArgs.cs b/sdk/dotnet/ApplicationAutoScaling/Inputs/ScalingPolicyPredictiveScalingMetricStatArgs.cs index cc855ce3dc..acb07791f6 100644 --- a/sdk/dotnet/ApplicationAutoScaling/Inputs/ScalingPolicyPredictiveScalingMetricStatArgs.cs +++ b/sdk/dotnet/ApplicationAutoScaling/Inputs/ScalingPolicyPredictiveScalingMetricStatArgs.cs @@ -10,22 +10,26 @@ namespace Pulumi.AwsNative.ApplicationAutoScaling.Inputs { + /// + /// This structure defines the CloudWatch metric to return, along with the statistic and unit. + /// public sealed class ScalingPolicyPredictiveScalingMetricStatArgs : global::Pulumi.ResourceArgs { /// - /// The CloudWatch metric to return, including the metric name, namespace, and dimensions. + /// 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). /// [Input("metric")] public Input? Metric { get; set; } /// - /// The statistic to return. It can include any CloudWatch statistic or extended statistic. + /// 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*. + /// The most commonly used metrics for predictive scaling are ``Average`` and ``Sum``. /// [Input("stat")] public Input? Stat { get; set; } /// - /// The unit to use for the returned data points. + /// 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*. /// [Input("unit")] public Input? Unit { get; set; } diff --git a/sdk/dotnet/ApplicationAutoScaling/Inputs/ScalingPolicyPredictiveScalingPolicyConfigurationArgs.cs b/sdk/dotnet/ApplicationAutoScaling/Inputs/ScalingPolicyPredictiveScalingPolicyConfigurationArgs.cs index 76cd53c047..5d94ffd616 100644 --- a/sdk/dotnet/ApplicationAutoScaling/Inputs/ScalingPolicyPredictiveScalingPolicyConfigurationArgs.cs +++ b/sdk/dotnet/ApplicationAutoScaling/Inputs/ScalingPolicyPredictiveScalingPolicyConfigurationArgs.cs @@ -10,18 +10,20 @@ namespace Pulumi.AwsNative.ApplicationAutoScaling.Inputs { + /// + /// Represents a predictive scaling policy configuration. + /// public sealed class ScalingPolicyPredictiveScalingPolicyConfigurationArgs : global::Pulumi.ResourceArgs { /// - /// Defines the behavior that should be applied if the forecast capacity approaches or exceeds the maximum capacity. Defaults to `HonorMaxCapacity` if not specified. + /// Defines the behavior that should be applied if the forecast capacity approaches or exceeds the maximum capacity. Defaults to ``HonorMaxCapacity`` if not specified. /// [Input("maxCapacityBreachBehavior")] public Input? MaxCapacityBreachBehavior { get; set; } /// - /// 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. - /// - /// Required if the `MaxCapacityBreachBehavior` property is set to `IncreaseMaxCapacity` , and cannot be used otherwise. + /// 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. + /// Required if the ``MaxCapacityBreachBehavior`` property is set to ``IncreaseMaxCapacity``, and cannot be used otherwise. /// [Input("maxCapacityBuffer")] public Input? MaxCapacityBuffer { get; set; } @@ -30,9 +32,8 @@ public sealed class ScalingPolicyPredictiveScalingPolicyConfigurationArgs : glob private InputList? _metricSpecifications; /// - /// This structure includes the metrics and target utilization to use for predictive scaling. - /// - /// 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. + /// This structure includes the metrics and target utilization to use for predictive scaling. + /// 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. /// public InputList MetricSpecifications { @@ -41,15 +42,14 @@ public InputList M } /// - /// The predictive scaling mode. Defaults to `ForecastOnly` if not specified. + /// The predictive scaling mode. Defaults to ``ForecastOnly`` if not specified. /// [Input("mode")] public Input? Mode { get; set; } /// - /// The amount of time, in seconds, that the start time can be advanced. - /// - /// The value must be less than the forecast interval duration of 3600 seconds (60 minutes). Defaults to 300 seconds if not specified. + /// The amount of time, in seconds, that the start time can be advanced. + /// The value must be less than the forecast interval duration of 3600 seconds (60 minutes). Defaults to 300 seconds if not specified. /// [Input("schedulingBufferTime")] public Input? SchedulingBufferTime { get; set; } diff --git a/sdk/dotnet/ApplicationAutoScaling/Inputs/ScalingPolicyPredictiveScalingPredefinedLoadMetricArgs.cs b/sdk/dotnet/ApplicationAutoScaling/Inputs/ScalingPolicyPredictiveScalingPredefinedLoadMetricArgs.cs index 5b7115fd43..6865b96567 100644 --- a/sdk/dotnet/ApplicationAutoScaling/Inputs/ScalingPolicyPredictiveScalingPredefinedLoadMetricArgs.cs +++ b/sdk/dotnet/ApplicationAutoScaling/Inputs/ScalingPolicyPredictiveScalingPredefinedLoadMetricArgs.cs @@ -10,6 +10,10 @@ namespace Pulumi.AwsNative.ApplicationAutoScaling.Inputs { + /// + /// Describes a load metric for a predictive scaling policy. + /// 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. + /// public sealed class ScalingPolicyPredictiveScalingPredefinedLoadMetricArgs : global::Pulumi.ResourceArgs { /// diff --git a/sdk/dotnet/ApplicationAutoScaling/Inputs/ScalingPolicyPredictiveScalingPredefinedMetricPairArgs.cs b/sdk/dotnet/ApplicationAutoScaling/Inputs/ScalingPolicyPredictiveScalingPredefinedMetricPairArgs.cs index 329d013ba0..714c1bc0eb 100644 --- a/sdk/dotnet/ApplicationAutoScaling/Inputs/ScalingPolicyPredictiveScalingPredefinedMetricPairArgs.cs +++ b/sdk/dotnet/ApplicationAutoScaling/Inputs/ScalingPolicyPredictiveScalingPredefinedMetricPairArgs.cs @@ -10,6 +10,9 @@ namespace Pulumi.AwsNative.ApplicationAutoScaling.Inputs { + /// + /// Represents a metric pair for a predictive scaling policy. + /// public sealed class ScalingPolicyPredictiveScalingPredefinedMetricPairArgs : global::Pulumi.ResourceArgs { /// diff --git a/sdk/dotnet/ApplicationAutoScaling/Inputs/ScalingPolicyPredictiveScalingPredefinedScalingMetricArgs.cs b/sdk/dotnet/ApplicationAutoScaling/Inputs/ScalingPolicyPredictiveScalingPredefinedScalingMetricArgs.cs index d031105ede..0a53f5f9cd 100644 --- a/sdk/dotnet/ApplicationAutoScaling/Inputs/ScalingPolicyPredictiveScalingPredefinedScalingMetricArgs.cs +++ b/sdk/dotnet/ApplicationAutoScaling/Inputs/ScalingPolicyPredictiveScalingPredefinedScalingMetricArgs.cs @@ -10,6 +10,10 @@ namespace Pulumi.AwsNative.ApplicationAutoScaling.Inputs { + /// + /// Describes a scaling metric for a predictive scaling policy. + /// 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. + /// public sealed class ScalingPolicyPredictiveScalingPredefinedScalingMetricArgs : global::Pulumi.ResourceArgs { /// diff --git a/sdk/dotnet/ApplicationAutoScaling/Outputs/ScalingPolicyPredictiveScalingCustomizedCapacityMetric.cs b/sdk/dotnet/ApplicationAutoScaling/Outputs/ScalingPolicyPredictiveScalingCustomizedCapacityMetric.cs index a9b6a813d6..2cc7c3002e 100644 --- a/sdk/dotnet/ApplicationAutoScaling/Outputs/ScalingPolicyPredictiveScalingCustomizedCapacityMetric.cs +++ b/sdk/dotnet/ApplicationAutoScaling/Outputs/ScalingPolicyPredictiveScalingCustomizedCapacityMetric.cs @@ -10,6 +10,9 @@ namespace Pulumi.AwsNative.ApplicationAutoScaling.Outputs { + /// + /// Represents a CloudWatch metric of your choosing for a predictive scaling policy. + /// [OutputType] public sealed class ScalingPolicyPredictiveScalingCustomizedCapacityMetric { diff --git a/sdk/dotnet/ApplicationAutoScaling/Outputs/ScalingPolicyPredictiveScalingCustomizedLoadMetric.cs b/sdk/dotnet/ApplicationAutoScaling/Outputs/ScalingPolicyPredictiveScalingCustomizedLoadMetric.cs index 66ae665d3c..cd2b666688 100644 --- a/sdk/dotnet/ApplicationAutoScaling/Outputs/ScalingPolicyPredictiveScalingCustomizedLoadMetric.cs +++ b/sdk/dotnet/ApplicationAutoScaling/Outputs/ScalingPolicyPredictiveScalingCustomizedLoadMetric.cs @@ -10,6 +10,9 @@ namespace Pulumi.AwsNative.ApplicationAutoScaling.Outputs { + /// + /// The customized load metric specification. + /// [OutputType] public sealed class ScalingPolicyPredictiveScalingCustomizedLoadMetric { diff --git a/sdk/dotnet/ApplicationAutoScaling/Outputs/ScalingPolicyPredictiveScalingCustomizedScalingMetric.cs b/sdk/dotnet/ApplicationAutoScaling/Outputs/ScalingPolicyPredictiveScalingCustomizedScalingMetric.cs index 36815f3467..be67485768 100644 --- a/sdk/dotnet/ApplicationAutoScaling/Outputs/ScalingPolicyPredictiveScalingCustomizedScalingMetric.cs +++ b/sdk/dotnet/ApplicationAutoScaling/Outputs/ScalingPolicyPredictiveScalingCustomizedScalingMetric.cs @@ -10,6 +10,9 @@ namespace Pulumi.AwsNative.ApplicationAutoScaling.Outputs { + /// + /// One or more metric data queries to provide data points for a metric specification. + /// [OutputType] public sealed class ScalingPolicyPredictiveScalingCustomizedScalingMetric { diff --git a/sdk/dotnet/ApplicationAutoScaling/Outputs/ScalingPolicyPredictiveScalingMetric.cs b/sdk/dotnet/ApplicationAutoScaling/Outputs/ScalingPolicyPredictiveScalingMetric.cs index f82d5577e8..16a677d053 100644 --- a/sdk/dotnet/ApplicationAutoScaling/Outputs/ScalingPolicyPredictiveScalingMetric.cs +++ b/sdk/dotnet/ApplicationAutoScaling/Outputs/ScalingPolicyPredictiveScalingMetric.cs @@ -10,11 +10,14 @@ namespace Pulumi.AwsNative.ApplicationAutoScaling.Outputs { + /// + /// Describes the scaling metric. + /// [OutputType] public sealed class ScalingPolicyPredictiveScalingMetric { /// - /// The dimensions for the metric. + /// Describes the dimensions of the metric. /// public readonly ImmutableArray Dimensions; /// diff --git a/sdk/dotnet/ApplicationAutoScaling/Outputs/ScalingPolicyPredictiveScalingMetricDataQuery.cs b/sdk/dotnet/ApplicationAutoScaling/Outputs/ScalingPolicyPredictiveScalingMetricDataQuery.cs index 117ea77d78..6525e593ad 100644 --- a/sdk/dotnet/ApplicationAutoScaling/Outputs/ScalingPolicyPredictiveScalingMetricDataQuery.cs +++ b/sdk/dotnet/ApplicationAutoScaling/Outputs/ScalingPolicyPredictiveScalingMetricDataQuery.cs @@ -10,15 +10,19 @@ namespace Pulumi.AwsNative.ApplicationAutoScaling.Outputs { + /// + /// 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. + /// [OutputType] public sealed class ScalingPolicyPredictiveScalingMetricDataQuery { /// - /// The math expression to perform on the returned data, if this object is performing a math expression. + /// 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. + /// Conditional: Within each ``MetricDataQuery`` object, you must specify either ``Expression`` or ``MetricStat``, but not both. /// public readonly string? Expression; /// - /// A short name that identifies the object's results in the response. + /// 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. /// public readonly string? Id; /// @@ -26,11 +30,14 @@ public sealed class ScalingPolicyPredictiveScalingMetricDataQuery /// public readonly string? Label; /// - /// Information about the metric data to return. + /// Information about the metric data to return. + /// Conditional: Within each ``MetricDataQuery`` object, you must specify either ``Expression`` or ``MetricStat``, but not both. /// public readonly Outputs.ScalingPolicyPredictiveScalingMetricStat? MetricStat; /// - /// Indicates whether to return the timestamps and raw data values of this metric. + /// Indicates whether to return the timestamps and raw data values of this metric. + /// 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. + /// 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``). /// public readonly bool? ReturnData; diff --git a/sdk/dotnet/ApplicationAutoScaling/Outputs/ScalingPolicyPredictiveScalingMetricDimension.cs b/sdk/dotnet/ApplicationAutoScaling/Outputs/ScalingPolicyPredictiveScalingMetricDimension.cs index 448cbac051..37b6867c5e 100644 --- a/sdk/dotnet/ApplicationAutoScaling/Outputs/ScalingPolicyPredictiveScalingMetricDimension.cs +++ b/sdk/dotnet/ApplicationAutoScaling/Outputs/ScalingPolicyPredictiveScalingMetricDimension.cs @@ -10,6 +10,9 @@ namespace Pulumi.AwsNative.ApplicationAutoScaling.Outputs { + /// + /// Describes the dimension of a metric. + /// [OutputType] public sealed class ScalingPolicyPredictiveScalingMetricDimension { diff --git a/sdk/dotnet/ApplicationAutoScaling/Outputs/ScalingPolicyPredictiveScalingMetricSpecification.cs b/sdk/dotnet/ApplicationAutoScaling/Outputs/ScalingPolicyPredictiveScalingMetricSpecification.cs index 6bc4ed767d..8f5cdb0991 100644 --- a/sdk/dotnet/ApplicationAutoScaling/Outputs/ScalingPolicyPredictiveScalingMetricSpecification.cs +++ b/sdk/dotnet/ApplicationAutoScaling/Outputs/ScalingPolicyPredictiveScalingMetricSpecification.cs @@ -10,6 +10,10 @@ namespace Pulumi.AwsNative.ApplicationAutoScaling.Outputs { + /// + /// This structure specifies the metrics and target utilization settings for a predictive scaling policy. + /// 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. + /// [OutputType] public sealed class ScalingPolicyPredictiveScalingMetricSpecification { diff --git a/sdk/dotnet/ApplicationAutoScaling/Outputs/ScalingPolicyPredictiveScalingMetricStat.cs b/sdk/dotnet/ApplicationAutoScaling/Outputs/ScalingPolicyPredictiveScalingMetricStat.cs index 7714b12620..ead12f44ad 100644 --- a/sdk/dotnet/ApplicationAutoScaling/Outputs/ScalingPolicyPredictiveScalingMetricStat.cs +++ b/sdk/dotnet/ApplicationAutoScaling/Outputs/ScalingPolicyPredictiveScalingMetricStat.cs @@ -10,19 +10,23 @@ namespace Pulumi.AwsNative.ApplicationAutoScaling.Outputs { + /// + /// This structure defines the CloudWatch metric to return, along with the statistic and unit. + /// [OutputType] public sealed class ScalingPolicyPredictiveScalingMetricStat { /// - /// The CloudWatch metric to return, including the metric name, namespace, and dimensions. + /// 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). /// public readonly Outputs.ScalingPolicyPredictiveScalingMetric? Metric; /// - /// The statistic to return. It can include any CloudWatch statistic or extended statistic. + /// 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*. + /// The most commonly used metrics for predictive scaling are ``Average`` and ``Sum``. /// public readonly string? Stat; /// - /// The unit to use for the returned data points. + /// 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*. /// public readonly string? Unit; diff --git a/sdk/dotnet/ApplicationAutoScaling/Outputs/ScalingPolicyPredictiveScalingPolicyConfiguration.cs b/sdk/dotnet/ApplicationAutoScaling/Outputs/ScalingPolicyPredictiveScalingPolicyConfiguration.cs index f46dbb6a65..6a2dd716da 100644 --- a/sdk/dotnet/ApplicationAutoScaling/Outputs/ScalingPolicyPredictiveScalingPolicyConfiguration.cs +++ b/sdk/dotnet/ApplicationAutoScaling/Outputs/ScalingPolicyPredictiveScalingPolicyConfiguration.cs @@ -10,33 +10,33 @@ namespace Pulumi.AwsNative.ApplicationAutoScaling.Outputs { + /// + /// Represents a predictive scaling policy configuration. + /// [OutputType] public sealed class ScalingPolicyPredictiveScalingPolicyConfiguration { /// - /// Defines the behavior that should be applied if the forecast capacity approaches or exceeds the maximum capacity. Defaults to `HonorMaxCapacity` if not specified. + /// Defines the behavior that should be applied if the forecast capacity approaches or exceeds the maximum capacity. Defaults to ``HonorMaxCapacity`` if not specified. /// public readonly string? MaxCapacityBreachBehavior; /// - /// 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. - /// - /// Required if the `MaxCapacityBreachBehavior` property is set to `IncreaseMaxCapacity` , and cannot be used otherwise. + /// 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. + /// Required if the ``MaxCapacityBreachBehavior`` property is set to ``IncreaseMaxCapacity``, and cannot be used otherwise. /// public readonly int? MaxCapacityBuffer; /// - /// This structure includes the metrics and target utilization to use for predictive scaling. - /// - /// 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. + /// This structure includes the metrics and target utilization to use for predictive scaling. + /// 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. /// public readonly ImmutableArray MetricSpecifications; /// - /// The predictive scaling mode. Defaults to `ForecastOnly` if not specified. + /// The predictive scaling mode. Defaults to ``ForecastOnly`` if not specified. /// public readonly string? Mode; /// - /// The amount of time, in seconds, that the start time can be advanced. - /// - /// The value must be less than the forecast interval duration of 3600 seconds (60 minutes). Defaults to 300 seconds if not specified. + /// The amount of time, in seconds, that the start time can be advanced. + /// The value must be less than the forecast interval duration of 3600 seconds (60 minutes). Defaults to 300 seconds if not specified. /// public readonly int? SchedulingBufferTime; diff --git a/sdk/dotnet/ApplicationAutoScaling/Outputs/ScalingPolicyPredictiveScalingPredefinedLoadMetric.cs b/sdk/dotnet/ApplicationAutoScaling/Outputs/ScalingPolicyPredictiveScalingPredefinedLoadMetric.cs index c7a98ce436..07794c0d8e 100644 --- a/sdk/dotnet/ApplicationAutoScaling/Outputs/ScalingPolicyPredictiveScalingPredefinedLoadMetric.cs +++ b/sdk/dotnet/ApplicationAutoScaling/Outputs/ScalingPolicyPredictiveScalingPredefinedLoadMetric.cs @@ -10,6 +10,10 @@ namespace Pulumi.AwsNative.ApplicationAutoScaling.Outputs { + /// + /// Describes a load metric for a predictive scaling policy. + /// 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. + /// [OutputType] public sealed class ScalingPolicyPredictiveScalingPredefinedLoadMetric { diff --git a/sdk/dotnet/ApplicationAutoScaling/Outputs/ScalingPolicyPredictiveScalingPredefinedMetricPair.cs b/sdk/dotnet/ApplicationAutoScaling/Outputs/ScalingPolicyPredictiveScalingPredefinedMetricPair.cs index b1901dec81..8973aca6cb 100644 --- a/sdk/dotnet/ApplicationAutoScaling/Outputs/ScalingPolicyPredictiveScalingPredefinedMetricPair.cs +++ b/sdk/dotnet/ApplicationAutoScaling/Outputs/ScalingPolicyPredictiveScalingPredefinedMetricPair.cs @@ -10,6 +10,9 @@ namespace Pulumi.AwsNative.ApplicationAutoScaling.Outputs { + /// + /// Represents a metric pair for a predictive scaling policy. + /// [OutputType] public sealed class ScalingPolicyPredictiveScalingPredefinedMetricPair { diff --git a/sdk/dotnet/ApplicationAutoScaling/Outputs/ScalingPolicyPredictiveScalingPredefinedScalingMetric.cs b/sdk/dotnet/ApplicationAutoScaling/Outputs/ScalingPolicyPredictiveScalingPredefinedScalingMetric.cs index bf0a8c89ab..a7d0fae6c8 100644 --- a/sdk/dotnet/ApplicationAutoScaling/Outputs/ScalingPolicyPredictiveScalingPredefinedScalingMetric.cs +++ b/sdk/dotnet/ApplicationAutoScaling/Outputs/ScalingPolicyPredictiveScalingPredefinedScalingMetric.cs @@ -10,6 +10,10 @@ namespace Pulumi.AwsNative.ApplicationAutoScaling.Outputs { + /// + /// Describes a scaling metric for a predictive scaling policy. + /// 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. + /// [OutputType] public sealed class ScalingPolicyPredictiveScalingPredefinedScalingMetric { diff --git a/sdk/dotnet/Bedrock/Inputs/DataSourceParsingConfigurationArgs.cs b/sdk/dotnet/Bedrock/Inputs/DataSourceParsingConfigurationArgs.cs index 13ce32065c..eaa6277f68 100644 --- a/sdk/dotnet/Bedrock/Inputs/DataSourceParsingConfigurationArgs.cs +++ b/sdk/dotnet/Bedrock/Inputs/DataSourceParsingConfigurationArgs.cs @@ -16,7 +16,7 @@ namespace Pulumi.AwsNative.Bedrock.Inputs public sealed class DataSourceParsingConfigurationArgs : global::Pulumi.ResourceArgs { /// - /// Settings for a foundation model used to parse documents for a data source. + /// If you specify `BEDROCK_FOUNDATION_MODEL` as the parsing strategy for ingesting your data source, use this object to modify configurations for using a foundation model to parse documents. /// [Input("bedrockFoundationModelConfiguration")] public Input? BedrockFoundationModelConfiguration { get; set; } diff --git a/sdk/dotnet/Bedrock/Inputs/DataSourceVectorIngestionConfigurationArgs.cs b/sdk/dotnet/Bedrock/Inputs/DataSourceVectorIngestionConfigurationArgs.cs index 1fef5ab5eb..eed2e173c9 100644 --- a/sdk/dotnet/Bedrock/Inputs/DataSourceVectorIngestionConfigurationArgs.cs +++ b/sdk/dotnet/Bedrock/Inputs/DataSourceVectorIngestionConfigurationArgs.cs @@ -28,7 +28,7 @@ public sealed class DataSourceVectorIngestionConfigurationArgs : global::Pulumi. public Input? CustomTransformationConfiguration { get; set; } /// - /// A custom parser for data source documents. + /// Configurations for a parser to use for parsing documents in your data source. If you exclude this field, the default parser will be used. /// [Input("parsingConfiguration")] public Input? ParsingConfiguration { get; set; } diff --git a/sdk/dotnet/Bedrock/Inputs/GuardrailPiiEntityConfigArgs.cs b/sdk/dotnet/Bedrock/Inputs/GuardrailPiiEntityConfigArgs.cs index 0da6c32d02..8f95a235cf 100644 --- a/sdk/dotnet/Bedrock/Inputs/GuardrailPiiEntityConfigArgs.cs +++ b/sdk/dotnet/Bedrock/Inputs/GuardrailPiiEntityConfigArgs.cs @@ -33,7 +33,7 @@ public sealed class GuardrailPiiEntityConfigArgs : global::Pulumi.ResourceArgs /// A physical address, such as "100 Main Street, Anytown, USA" or "Suite #12, Building 123". An address can include information such as the street, building, location, city, state, country, county, zip code, precinct, and neighborhood. /// - *AGE* /// - /// An individual's age, including the quantity and unit of time. For example, in the phrase "I am 40 years old," Guarrails recognizes "40 years" as an age. + /// An individual's age, including the quantity and unit of time. For example, in the phrase "I am 40 years old," Guardrails recognizes "40 years" as an age. /// - *NAME* /// /// An individual's name. This entity type does not include titles, such as Dr., Mr., Mrs., or Miss. guardrails doesn't apply this entity type to names that are part of organizations or addresses. For example, guardrails recognizes the "John Doe Organization" as an organization, and it recognizes "Jane Doe Street" as an address. @@ -60,7 +60,7 @@ public sealed class GuardrailPiiEntityConfigArgs : global::Pulumi.ResourceArgs /// A Vehicle Identification Number (VIN) uniquely identifies a vehicle. VIN content and format are defined in the *ISO 3779* specification. Each country has specific codes and formats for VINs. /// - *Finance* /// - /// - *REDIT_DEBIT_CARD_CVV* + /// - *CREDIT_DEBIT_CARD_CVV* /// /// A three-digit card verification code (CVV) that is present on VISA, MasterCard, and Discover credit and debit cards. For American Express credit or debit cards, the CVV is a four-digit numeric code. /// - *CREDIT_DEBIT_CARD_EXPIRY* diff --git a/sdk/dotnet/Bedrock/Outputs/DataSourceParsingConfiguration.cs b/sdk/dotnet/Bedrock/Outputs/DataSourceParsingConfiguration.cs index d72d22fb80..b113768786 100644 --- a/sdk/dotnet/Bedrock/Outputs/DataSourceParsingConfiguration.cs +++ b/sdk/dotnet/Bedrock/Outputs/DataSourceParsingConfiguration.cs @@ -17,7 +17,7 @@ namespace Pulumi.AwsNative.Bedrock.Outputs public sealed class DataSourceParsingConfiguration { /// - /// Settings for a foundation model used to parse documents for a data source. + /// If you specify `BEDROCK_FOUNDATION_MODEL` as the parsing strategy for ingesting your data source, use this object to modify configurations for using a foundation model to parse documents. /// public readonly Outputs.DataSourceBedrockFoundationModelConfiguration? BedrockFoundationModelConfiguration; /// diff --git a/sdk/dotnet/Bedrock/Outputs/DataSourceVectorIngestionConfiguration.cs b/sdk/dotnet/Bedrock/Outputs/DataSourceVectorIngestionConfiguration.cs index e551a152a3..90141375d1 100644 --- a/sdk/dotnet/Bedrock/Outputs/DataSourceVectorIngestionConfiguration.cs +++ b/sdk/dotnet/Bedrock/Outputs/DataSourceVectorIngestionConfiguration.cs @@ -25,7 +25,7 @@ public sealed class DataSourceVectorIngestionConfiguration /// public readonly Outputs.DataSourceCustomTransformationConfiguration? CustomTransformationConfiguration; /// - /// A custom parser for data source documents. + /// Configurations for a parser to use for parsing documents in your data source. If you exclude this field, the default parser will be used. /// public readonly Outputs.DataSourceParsingConfiguration? ParsingConfiguration; diff --git a/sdk/dotnet/Bedrock/Outputs/GuardrailPiiEntityConfig.cs b/sdk/dotnet/Bedrock/Outputs/GuardrailPiiEntityConfig.cs index bbd4ac3840..7174091002 100644 --- a/sdk/dotnet/Bedrock/Outputs/GuardrailPiiEntityConfig.cs +++ b/sdk/dotnet/Bedrock/Outputs/GuardrailPiiEntityConfig.cs @@ -32,7 +32,7 @@ public sealed class GuardrailPiiEntityConfig /// A physical address, such as "100 Main Street, Anytown, USA" or "Suite #12, Building 123". An address can include information such as the street, building, location, city, state, country, county, zip code, precinct, and neighborhood. /// - *AGE* /// - /// An individual's age, including the quantity and unit of time. For example, in the phrase "I am 40 years old," Guarrails recognizes "40 years" as an age. + /// An individual's age, including the quantity and unit of time. For example, in the phrase "I am 40 years old," Guardrails recognizes "40 years" as an age. /// - *NAME* /// /// An individual's name. This entity type does not include titles, such as Dr., Mr., Mrs., or Miss. guardrails doesn't apply this entity type to names that are part of organizations or addresses. For example, guardrails recognizes the "John Doe Organization" as an organization, and it recognizes "Jane Doe Street" as an address. @@ -59,7 +59,7 @@ public sealed class GuardrailPiiEntityConfig /// A Vehicle Identification Number (VIN) uniquely identifies a vehicle. VIN content and format are defined in the *ISO 3779* specification. Each country has specific codes and formats for VINs. /// - *Finance* /// - /// - *REDIT_DEBIT_CARD_CVV* + /// - *CREDIT_DEBIT_CARD_CVV* /// /// A three-digit card verification code (CVV) that is present on VISA, MasterCard, and Discover credit and debit cards. For American Express credit or debit cards, the CVV is a four-digit numeric code. /// - *CREDIT_DEBIT_CARD_EXPIRY* diff --git a/sdk/dotnet/Cognito/GetManagedLoginBranding.cs b/sdk/dotnet/Cognito/GetManagedLoginBranding.cs index de47670389..de61a2892c 100644 --- a/sdk/dotnet/Cognito/GetManagedLoginBranding.cs +++ b/sdk/dotnet/Cognito/GetManagedLoginBranding.cs @@ -84,7 +84,9 @@ public sealed class GetManagedLoginBrandingResult /// public readonly object? Settings; /// - /// When true, applies the default branding style options. This option reverts to a "blank" style that you can modify later in the branding designer. + /// When true, applies the default branding style options. This option reverts to default style options that are managed by Amazon Cognito. You can modify them later in the branding designer. + /// + /// When you specify `true` for this option, you must also omit values for `Settings` and `Assets` in the request. /// public readonly bool? UseCognitoProvidedValues; diff --git a/sdk/dotnet/Cognito/GetUserPool.cs b/sdk/dotnet/Cognito/GetUserPool.cs index c54aa73857..0a2bffa325 100644 --- a/sdk/dotnet/Cognito/GetUserPool.cs +++ b/sdk/dotnet/Cognito/GetUserPool.cs @@ -68,7 +68,7 @@ public sealed class GetUserPoolResult /// public readonly Outputs.UserPoolAdminCreateUserConfig? AdminCreateUserConfig; /// - /// Attributes supported as an alias for this user pool. Possible values: *phone_number* , *email* , or *preferred_username* . + /// Attributes supported as an alias for this user pool. Possible values: *phone_number* , *email* , or *preferred_username* . For more information about alias attributes, see [Customizing sign-in attributes](https://docs.aws.amazon.com/cognito/latest/developerguide/user-pool-settings-attributes.html#user-pool-settings-aliases) . /// public readonly ImmutableArray AliasAttributes; /// @@ -76,7 +76,7 @@ public sealed class GetUserPoolResult /// public readonly string? Arn; /// - /// The attributes to be auto-verified. Possible values: *email* , *phone_number* . + /// The attributes that you want your user pool to automatically verify. Possible values: *email* , *phone_number* . For more information see [Verifying contact information at sign-up](https://docs.aws.amazon.com/cognito/latest/developerguide/signing-up-users-in-your-app.html#allowing-users-to-sign-up-and-confirm-themselves) . /// public readonly ImmutableArray AutoVerifiedAttributes; /// @@ -88,9 +88,9 @@ public sealed class GetUserPoolResult /// public readonly string? DeletionProtection; /// - /// The device-remembering configuration for a user pool. A null value indicates that you have deactivated device remembering in your user pool. + /// The device-remembering configuration for a user pool. Device remembering or device tracking is a "Remember me on this device" option for user pools that perform authentication with the device key of a trusted device in the back end, instead of a user-provided MFA code. For more information about device authentication, see [Working with user devices in your user pool](https://docs.aws.amazon.com/cognito/latest/developerguide/amazon-cognito-user-pools-device-tracking.html) . A null value indicates that you have deactivated device remembering in your user pool. /// - /// > When you provide a value for any `DeviceConfiguration` field, you activate the Amazon Cognito device-remembering feature. + /// > When you provide a value for any `DeviceConfiguration` field, you activate the Amazon Cognito device-remembering feature. For more infor /// public readonly Outputs.UserPoolDeviceConfiguration? DeviceConfiguration; public readonly string? EmailAuthenticationMessage; @@ -134,7 +134,7 @@ public sealed class GetUserPoolResult /// public readonly string? ProviderUrl; /// - /// An array of schema attributes for the new user pool. These attributes can be standard or custom attributes. + /// An array of attributes for the new user pool. You can add custom attributes and modify the properties of default attributes. The specifications in this parameter set the required attributes in your user pool. For more information, see [Working with user attributes](https://docs.aws.amazon.com/cognito/latest/developerguide/user-pool-settings-attributes.html) . /// public readonly ImmutableArray Schema; /// @@ -142,7 +142,7 @@ public sealed class GetUserPoolResult /// public readonly string? SmsAuthenticationMessage; /// - /// The SMS configuration with the settings that your Amazon Cognito user pool must use to send an SMS message from your AWS account through Amazon Simple Notification Service. To send SMS messages with Amazon SNS in the AWS Region that you want, the Amazon Cognito user pool uses an AWS Identity and Access Management (IAM) role in your AWS account . + /// The SMS configuration with the settings that your Amazon Cognito user pool must use to send an SMS message from your AWS account through Amazon Simple Notification Service. To send SMS messages with Amazon SNS in the AWS Region that you want, the Amazon Cognito user pool uses an AWS Identity and Access Management (IAM) role in your AWS account . For more information see [SMS message settings](https://docs.aws.amazon.com/cognito/latest/developerguide/user-pool-sms-settings.html) . /// public readonly Outputs.UserPoolSmsConfiguration? SmsConfiguration; /// @@ -166,7 +166,7 @@ public sealed class GetUserPoolResult /// public readonly string? UserPoolId; /// - /// A string used to name the user pool. + /// A friendlhy name for your user pool. /// public readonly string? UserPoolName; /// @@ -182,9 +182,11 @@ public sealed class GetUserPoolResult /// public readonly ImmutableArray UsernameAttributes; /// - /// Case sensitivity on the username input for the selected sign-in option. When case sensitivity is set to `False` (case insensitive), users can sign in with any combination of capital and lowercase letters. For example, `username` , `USERNAME` , or `UserName` , or for email, `email@example.com` or `EMaiL@eXamplE.Com` . For most use cases, set case sensitivity to `False` (case insensitive) as a best practice. When usernames and email addresses are case insensitive, Amazon Cognito treats any variation in case as the same user, and prevents a case variation from being assigned to the same attribute for a different user. + /// Sets the case sensitivity option for sign-in usernames. When `CaseSensitive` is `false` (case insensitive), users can sign in with any combination of capital and lowercase letters. For example, `username` , `USERNAME` , or `UserName` , or for email, `email@example.com` or `EMaiL@eXamplE.Com` . For most use cases, set case sensitivity to `false` as a best practice. When usernames and email addresses are case insensitive, Amazon Cognito treats any variation in case as the same user, and prevents a case variation from being assigned to the same attribute for a different user. /// - /// This configuration is immutable after you set it. For more information, see [UsernameConfigurationType](https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_UsernameConfigurationType.html) . + /// When `CaseSensitive` is `true` (case sensitive), Amazon Cognito interprets `USERNAME` and `UserName` as distinct users. + /// + /// This configuration is immutable after you set it. /// public readonly Outputs.UserPoolUsernameConfiguration? UsernameConfiguration; /// @@ -193,7 +195,19 @@ public sealed class GetUserPoolResult /// Set the email message type that corresponds to your `DefaultEmailOption` selection. For `CONFIRM_WITH_LINK` , specify an `EmailMessageByLink` and leave `EmailMessage` blank. For `CONFIRM_WITH_CODE` , specify an `EmailMessage` and leave `EmailMessageByLink` blank. When you supply both parameters with either choice, Amazon Cognito returns an error. /// public readonly Outputs.UserPoolVerificationMessageTemplate? VerificationMessageTemplate; + /// + /// Sets or displays the authentication domain, typically your user pool domain, that passkey providers must use as a relying party (RP) in their configuration. + /// + /// Under the following conditions, the passkey relying party ID must be the fully-qualified domain name of your custom domain: + /// + /// - The user pool is configured for passkey authentication. + /// - The user pool has a custom domain, whether or not it also has a prefix domain. + /// - Your application performs authentication with managed login or the classic hosted UI. + /// public readonly string? WebAuthnRelyingPartyId; + /// + /// When `required` , users can only register and sign in users with passkeys that are capable of [user verification](https://docs.aws.amazon.com/https://www.w3.org/TR/webauthn-2/#enum-userVerificationRequirement) . When `preferred` , your user pool doesn't require the use of authenticators with user verification but encourages it. + /// public readonly string? WebAuthnUserVerification; [OutputConstructor] diff --git a/sdk/dotnet/Cognito/GetUserPoolClient.cs b/sdk/dotnet/Cognito/GetUserPoolClient.cs index 4431583648..5d8ca668d4 100644 --- a/sdk/dotnet/Cognito/GetUserPoolClient.cs +++ b/sdk/dotnet/Cognito/GetUserPoolClient.cs @@ -34,7 +34,7 @@ public sealed class GetUserPoolClientArgs : global::Pulumi.InvokeArgs public string ClientId { get; set; } = null!; /// - /// The user pool ID for the user pool where you want to create a user pool client. + /// The ID of the user pool where you want to create an app client. /// [Input("userPoolId", required: true)] public string UserPoolId { get; set; } = null!; @@ -54,7 +54,7 @@ public sealed class GetUserPoolClientInvokeArgs : global::Pulumi.InvokeArgs public Input ClientId { get; set; } = null!; /// - /// The user pool ID for the user pool where you want to create a user pool client. + /// The ID of the user pool where you want to create an app client. /// [Input("userPoolId", required: true)] public Input UserPoolId { get; set; } = null!; @@ -103,13 +103,13 @@ public sealed class GetUserPoolClientResult /// public readonly bool? AllowedOAuthFlowsUserPoolClient; /// - /// The allowed OAuth scopes. Possible values provided by OAuth are `phone` , `email` , `openid` , and `profile` . Possible values provided by AWS are `aws.cognito.signin.user.admin` . Custom scopes created in Resource Servers are also supported. + /// The OAuth 2.0 scopes that you want to permit your app client to authorize. Scopes govern access control to user pool self-service API operations, user data from the `userInfo` endpoint, and third-party APIs. Possible values provided by OAuth are `phone` , `email` , `openid` , and `profile` . Possible values provided by AWS are `aws.cognito.signin.user.admin` . Custom scopes created in Resource Servers are also supported. /// public readonly ImmutableArray AllowedOAuthScopes; /// /// The user pool analytics configuration for collecting metrics and sending them to your Amazon Pinpoint campaign. /// - /// > In AWS Regions where Amazon Pinpoint isn't available, user pools only support sending events to Amazon Pinpoint projects in AWS Region us-east-1. In Regions where Amazon Pinpoint is available, user pools support sending events to Amazon Pinpoint projects within that same Region. + /// In AWS Regions where Amazon Pinpoint isn't available, user pools might not have access to analytics or might be configurable with campaigns in the US East (N. Virginia) Region. For more information, see [Using Amazon Pinpoint analytics](https://docs.aws.amazon.com/cognito/latest/developerguide/cognito-user-pools-pinpoint-integration.html) . /// public readonly Outputs.UserPoolClientAnalyticsConfiguration? AnalyticsConfiguration; /// @@ -122,7 +122,7 @@ public sealed class GetUserPoolClientResult /// A redirect URI must: /// /// - Be an absolute URI. - /// - Be registered with the authorization server. + /// - Be registered with the authorization server. Amazon Cognito doesn't accept authorization requests with `redirect_uri` values that aren't in the list of `CallbackURLs` that you provide in this parameter. /// - Not include a fragment component. /// /// See [OAuth 2.0 - Redirection Endpoint](https://docs.aws.amazon.com/https://tools.ietf.org/html/rfc6749#section-3.1.2) . @@ -137,24 +137,12 @@ public sealed class GetUserPoolClientResult /// public readonly string? ClientId; /// - /// The client name for the user pool client you would like to create. + /// A friendly name for the app client that you want to create. /// public readonly string? ClientName; public readonly string? ClientSecret; /// /// The default redirect URI. In app clients with one assigned IdP, replaces `redirect_uri` in authentication requests. Must be in the `CallbackURLs` list. - /// - /// A redirect URI must: - /// - /// - Be an absolute URI. - /// - Be registered with the authorization server. - /// - Not include a fragment component. - /// - /// For more information, see [Default redirect URI](https://docs.aws.amazon.com/cognito/latest/developerguide/user-pool-settings-client-apps.html#cognito-user-pools-app-idp-settings-about) . - /// - /// Amazon Cognito requires HTTPS over HTTP except for http://localhost for testing purposes only. - /// - /// App callback URLs such as myapp://example are also supported. /// public readonly string? DefaultRedirectUri; /// @@ -197,7 +185,7 @@ public sealed class GetUserPoolClientResult /// public readonly int? IdTokenValidity; /// - /// A list of allowed logout URLs for the IdPs. + /// A list of allowed logout URLs for managed login authentication. For more information, see [Logout endpoint](https://docs.aws.amazon.com/cognito/latest/developerguide/logout-endpoint.html) . /// public readonly ImmutableArray LogoutUrls; public readonly string? Name; @@ -233,11 +221,11 @@ public sealed class GetUserPoolClientResult /// /// A list of provider names for the identity providers (IdPs) that are supported on this client. The following are supported: `COGNITO` , `Facebook` , `Google` , `SignInWithApple` , and `LoginWithAmazon` . You can also specify the names that you configured for the SAML and OIDC IdPs in your user pool, for example `MySAMLIdP` or `MyOIDCIdP` . /// - /// This setting applies to providers that you can access with the [hosted UI and OAuth 2.0 authorization server](https://docs.aws.amazon.com/cognito/latest/developerguide/cognito-user-pools-app-integration.html) . The removal of `COGNITO` from this list doesn't prevent authentication operations for local users with the user pools API in an AWS SDK. The only way to prevent API-based authentication is to block access with a [AWS WAF rule](https://docs.aws.amazon.com/cognito/latest/developerguide/user-pool-waf.html) . + /// This setting applies to providers that you can access with [managed login](https://docs.aws.amazon.com/cognito/latest/developerguide/cognito-user-pools-managed-login.html) . The removal of `COGNITO` from this list doesn't prevent authentication operations for local users with the user pools API in an AWS SDK. The only way to prevent API-based authentication is to block access with a [AWS WAF rule](https://docs.aws.amazon.com/cognito/latest/developerguide/user-pool-waf.html) . /// public readonly ImmutableArray SupportedIdentityProviders; /// - /// The units in which the validity times are represented. The default unit for RefreshToken is days, and default for ID and access tokens are hours. + /// The units that validity times are represented in. The default unit for refresh tokens is days, and the default for ID and access tokens are hours. /// public readonly Outputs.UserPoolClientTokenValidityUnits? TokenValidityUnits; /// diff --git a/sdk/dotnet/Cognito/GetUserPoolGroup.cs b/sdk/dotnet/Cognito/GetUserPoolGroup.cs index 8b0f11977a..55c401c1e5 100644 --- a/sdk/dotnet/Cognito/GetUserPoolGroup.cs +++ b/sdk/dotnet/Cognito/GetUserPoolGroup.cs @@ -28,13 +28,13 @@ public static Output Invoke(GetUserPoolGroupInvokeArgs a public sealed class GetUserPoolGroupArgs : global::Pulumi.InvokeArgs { /// - /// The name of the group. Must be unique. + /// A name for the group. This name must be unique in your user pool. /// [Input("groupName", required: true)] public string GroupName { get; set; } = null!; /// - /// The user pool ID for the user pool. + /// The ID of the user pool where you want to create a user group. /// [Input("userPoolId", required: true)] public string UserPoolId { get; set; } = null!; @@ -48,13 +48,13 @@ public GetUserPoolGroupArgs() public sealed class GetUserPoolGroupInvokeArgs : global::Pulumi.InvokeArgs { /// - /// The name of the group. Must be unique. + /// A name for the group. This name must be unique in your user pool. /// [Input("groupName", required: true)] public Input GroupName { get; set; } = null!; /// - /// The user pool ID for the user pool. + /// The ID of the user pool where you want to create a user group. /// [Input("userPoolId", required: true)] public Input UserPoolId { get; set; } = null!; @@ -70,7 +70,7 @@ public GetUserPoolGroupInvokeArgs() public sealed class GetUserPoolGroupResult { /// - /// A string containing the description of the group. + /// A description of the group that you're creating. /// public readonly string? Description; /// @@ -82,7 +82,7 @@ public sealed class GetUserPoolGroupResult /// public readonly int? Precedence; /// - /// The role Amazon Resource Name (ARN) for the group. + /// The Amazon Resource Name (ARN) for the IAM role that you want to associate with the group. A group role primarily declares a preferred role for the credentials that you get from an identity pool. Amazon Cognito ID tokens have a `cognito:preferred_role` claim that presents the highest-precedence group that a user belongs to. Both ID and access tokens also contain a `cognito:groups` claim that list all the groups that a user is a member of. /// public readonly string? RoleArn; diff --git a/sdk/dotnet/Cognito/GetUserPoolIdentityProvider.cs b/sdk/dotnet/Cognito/GetUserPoolIdentityProvider.cs index eb3d25f951..bafcb294fd 100644 --- a/sdk/dotnet/Cognito/GetUserPoolIdentityProvider.cs +++ b/sdk/dotnet/Cognito/GetUserPoolIdentityProvider.cs @@ -28,13 +28,13 @@ public static Output Invoke(GetUserPoolIdenti public sealed class GetUserPoolIdentityProviderArgs : global::Pulumi.InvokeArgs { /// - /// The IdP name. + /// The name that you want to assign to the IdP. You can pass the identity provider name in the `identity_provider` query parameter of requests to the [Authorize endpoint](https://docs.aws.amazon.com/cognito/latest/developerguide/authorization-endpoint.html) to silently redirect to sign-in with the associated IdP. /// [Input("providerName", required: true)] public string ProviderName { get; set; } = null!; /// - /// The user pool ID. + /// The Id of the user pool where you want to create an IdP. /// [Input("userPoolId", required: true)] public string UserPoolId { get; set; } = null!; @@ -48,13 +48,13 @@ public GetUserPoolIdentityProviderArgs() public sealed class GetUserPoolIdentityProviderInvokeArgs : global::Pulumi.InvokeArgs { /// - /// The IdP name. + /// The name that you want to assign to the IdP. You can pass the identity provider name in the `identity_provider` query parameter of requests to the [Authorize endpoint](https://docs.aws.amazon.com/cognito/latest/developerguide/authorization-endpoint.html) to silently redirect to sign-in with the associated IdP. /// [Input("providerName", required: true)] public Input ProviderName { get; set; } = null!; /// - /// The user pool ID. + /// The Id of the user pool where you want to create an IdP. /// [Input("userPoolId", required: true)] public Input UserPoolId { get; set; } = null!; @@ -70,11 +70,11 @@ public GetUserPoolIdentityProviderInvokeArgs() public sealed class GetUserPoolIdentityProviderResult { /// - /// A mapping of IdP attributes to standard and custom user pool attributes. + /// A mapping of IdP attributes to standard and custom user pool attributes. Specify a user pool attribute as the key of the key-value pair, and the IdP attribute claim name as the value. /// public readonly ImmutableDictionary? AttributeMapping; /// - /// A list of IdP identifiers. + /// An array of IdP identifiers, for example `"IdPIdentifiers": [ "MyIdP", "MyIdP2" ]` . Identifiers are friendly names that you can pass in the `idp_identifier` query parameter of requests to the [Authorize endpoint](https://docs.aws.amazon.com/cognito/latest/developerguide/authorization-endpoint.html) to silently redirect to sign-in with the associated IdP. Identifiers in a domain format also enable the use of [email-address matching with SAML providers](https://docs.aws.amazon.com/cognito/latest/developerguide/cognito-user-pools-managing-saml-idp-naming.html) . /// public readonly ImmutableArray IdpIdentifiers; /// diff --git a/sdk/dotnet/Cognito/GetUserPoolResourceServer.cs b/sdk/dotnet/Cognito/GetUserPoolResourceServer.cs index a152ad0ff3..adbdfa5c5d 100644 --- a/sdk/dotnet/Cognito/GetUserPoolResourceServer.cs +++ b/sdk/dotnet/Cognito/GetUserPoolResourceServer.cs @@ -36,7 +36,7 @@ public sealed class GetUserPoolResourceServerArgs : global::Pulumi.InvokeArgs public string Identifier { get; set; } = null!; /// - /// The user pool ID for the user pool. + /// The ID of the user pool where you want to create a resource server. /// [Input("userPoolId", required: true)] public string UserPoolId { get; set; } = null!; @@ -58,7 +58,7 @@ public sealed class GetUserPoolResourceServerInvokeArgs : global::Pulumi.InvokeA public Input Identifier { get; set; } = null!; /// - /// The user pool ID for the user pool. + /// The ID of the user pool where you want to create a resource server. /// [Input("userPoolId", required: true)] public Input UserPoolId { get; set; } = null!; diff --git a/sdk/dotnet/Cognito/GetUserPoolUiCustomizationAttachment.cs b/sdk/dotnet/Cognito/GetUserPoolUiCustomizationAttachment.cs index 9afeabf126..289c38097a 100644 --- a/sdk/dotnet/Cognito/GetUserPoolUiCustomizationAttachment.cs +++ b/sdk/dotnet/Cognito/GetUserPoolUiCustomizationAttachment.cs @@ -34,7 +34,7 @@ public sealed class GetUserPoolUiCustomizationAttachmentArgs : global::Pulumi.In public string ClientId { get; set; } = null!; /// - /// The user pool ID for the user pool. + /// The ID of the user pool. /// [Input("userPoolId", required: true)] public string UserPoolId { get; set; } = null!; @@ -54,7 +54,7 @@ public sealed class GetUserPoolUiCustomizationAttachmentInvokeArgs : global::Pul public Input ClientId { get; set; } = null!; /// - /// The user pool ID for the user pool. + /// The ID of the user pool. /// [Input("userPoolId", required: true)] public Input UserPoolId { get; set; } = null!; diff --git a/sdk/dotnet/Cognito/Inputs/UserPoolAddOnsArgs.cs b/sdk/dotnet/Cognito/Inputs/UserPoolAddOnsArgs.cs index f3529fdc92..9c7dc63fb8 100644 --- a/sdk/dotnet/Cognito/Inputs/UserPoolAddOnsArgs.cs +++ b/sdk/dotnet/Cognito/Inputs/UserPoolAddOnsArgs.cs @@ -12,6 +12,9 @@ namespace Pulumi.AwsNative.Cognito.Inputs public sealed class UserPoolAddOnsArgs : global::Pulumi.ResourceArgs { + /// + /// Advanced security configuration options for additional authentication types in your user pool, including custom authentication. + /// [Input("advancedSecurityAdditionalFlows")] public Input? AdvancedSecurityAdditionalFlows { get; set; } diff --git a/sdk/dotnet/Cognito/Inputs/UserPoolAdvancedSecurityAdditionalFlowsArgs.cs b/sdk/dotnet/Cognito/Inputs/UserPoolAdvancedSecurityAdditionalFlowsArgs.cs index 371ebccacc..1d81b2d464 100644 --- a/sdk/dotnet/Cognito/Inputs/UserPoolAdvancedSecurityAdditionalFlowsArgs.cs +++ b/sdk/dotnet/Cognito/Inputs/UserPoolAdvancedSecurityAdditionalFlowsArgs.cs @@ -12,6 +12,9 @@ namespace Pulumi.AwsNative.Cognito.Inputs public sealed class UserPoolAdvancedSecurityAdditionalFlowsArgs : global::Pulumi.ResourceArgs { + /// + /// The operating mode of advanced security features in custom authentication with [Custom authentication challenge Lambda triggers](https://docs.aws.amazon.com/cognito/latest/developerguide/user-pool-lambda-challenge.html) . + /// [Input("customAuthMode")] public Input? CustomAuthMode { get; set; } diff --git a/sdk/dotnet/Cognito/Inputs/UserPoolPoliciesArgs.cs b/sdk/dotnet/Cognito/Inputs/UserPoolPoliciesArgs.cs index 23b5c9bca0..425bfffdd0 100644 --- a/sdk/dotnet/Cognito/Inputs/UserPoolPoliciesArgs.cs +++ b/sdk/dotnet/Cognito/Inputs/UserPoolPoliciesArgs.cs @@ -18,6 +18,11 @@ public sealed class UserPoolPoliciesArgs : global::Pulumi.ResourceArgs [Input("passwordPolicy")] public Input? PasswordPolicy { get; set; } + /// + /// The policy for allowed types of authentication in a user pool. + /// + /// This data type is a request and response parameter of [CreateUserPool](https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_CreateUserPool.html) and [UpdateUserPool](https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_UpdateUserPool.html) , and a response parameter of [DescribeUserPool](https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_DescribeUserPool.html) . + /// [Input("signInPolicy")] public Input? SignInPolicy { get; set; } diff --git a/sdk/dotnet/Cognito/Inputs/UserPoolSignInPolicyArgs.cs b/sdk/dotnet/Cognito/Inputs/UserPoolSignInPolicyArgs.cs index e93d2f880a..e87ae53aa2 100644 --- a/sdk/dotnet/Cognito/Inputs/UserPoolSignInPolicyArgs.cs +++ b/sdk/dotnet/Cognito/Inputs/UserPoolSignInPolicyArgs.cs @@ -14,6 +14,12 @@ public sealed class UserPoolSignInPolicyArgs : global::Pulumi.ResourceArgs { [Input("allowedFirstAuthFactors")] private InputList? _allowedFirstAuthFactors; + + /// + /// The sign-in methods that a user pool supports as the first factor. You can permit users to start authentication with a standard username and password, or with other one-time password and hardware factors. + /// + /// Supports values of `EMAIL_OTP` , `SMS_OTP` , `WEB_AUTHN` and `PASSWORD` , + /// public InputList AllowedFirstAuthFactors { get => _allowedFirstAuthFactors ?? (_allowedFirstAuthFactors = new InputList()); diff --git a/sdk/dotnet/Cognito/ManagedLoginBranding.cs b/sdk/dotnet/Cognito/ManagedLoginBranding.cs index 5510801672..2e2f8a5d8e 100644 --- a/sdk/dotnet/Cognito/ManagedLoginBranding.cs +++ b/sdk/dotnet/Cognito/ManagedLoginBranding.cs @@ -21,6 +21,9 @@ public partial class ManagedLoginBranding : global::Pulumi.CustomResource [Output("assets")] public Output> Assets { get; private set; } = null!; + /// + /// The app client that's assigned to the branding style that you want more information about. + /// [Output("clientId")] public Output ClientId { get; private set; } = null!; @@ -30,6 +33,9 @@ public partial class ManagedLoginBranding : global::Pulumi.CustomResource [Output("managedLoginBrandingId")] public Output ManagedLoginBrandingId { get; private set; } = null!; + /// + /// When `true` , returns values for branding options that are unchanged from Amazon Cognito defaults. When `false` or when you omit this parameter, returns only values that you customized in your branding style. + /// [Output("returnMergedResources")] public Output ReturnMergedResources { get; private set; } = null!; @@ -42,7 +48,9 @@ public partial class ManagedLoginBranding : global::Pulumi.CustomResource public Output Settings { get; private set; } = null!; /// - /// When true, applies the default branding style options. This option reverts to a "blank" style that you can modify later in the branding designer. + /// When true, applies the default branding style options. This option reverts to default style options that are managed by Amazon Cognito. You can modify them later in the branding designer. + /// + /// When you specify `true` for this option, you must also omit values for `Settings` and `Assets` in the request. /// [Output("useCognitoProvidedValues")] public Output UseCognitoProvidedValues { get; private set; } = null!; @@ -115,9 +123,15 @@ public InputList Assets set => _assets = value; } + /// + /// The app client that's assigned to the branding style that you want more information about. + /// [Input("clientId")] public Input? ClientId { get; set; } + /// + /// When `true` , returns values for branding options that are unchanged from Amazon Cognito defaults. When `false` or when you omit this parameter, returns only values that you customized in your branding style. + /// [Input("returnMergedResources")] public Input? ReturnMergedResources { get; set; } @@ -130,7 +144,9 @@ public InputList Assets public Input? Settings { get; set; } /// - /// When true, applies the default branding style options. This option reverts to a "blank" style that you can modify later in the branding designer. + /// When true, applies the default branding style options. This option reverts to default style options that are managed by Amazon Cognito. You can modify them later in the branding designer. + /// + /// When you specify `true` for this option, you must also omit values for `Settings` and `Assets` in the request. /// [Input("useCognitoProvidedValues")] public Input? UseCognitoProvidedValues { get; set; } diff --git a/sdk/dotnet/Cognito/Outputs/UserPoolAddOns.cs b/sdk/dotnet/Cognito/Outputs/UserPoolAddOns.cs index a674575bbf..e020e483d0 100644 --- a/sdk/dotnet/Cognito/Outputs/UserPoolAddOns.cs +++ b/sdk/dotnet/Cognito/Outputs/UserPoolAddOns.cs @@ -13,6 +13,9 @@ namespace Pulumi.AwsNative.Cognito.Outputs [OutputType] public sealed class UserPoolAddOns { + /// + /// Advanced security configuration options for additional authentication types in your user pool, including custom authentication. + /// public readonly Outputs.UserPoolAdvancedSecurityAdditionalFlows? AdvancedSecurityAdditionalFlows; /// /// The operating mode of advanced security features for standard authentication types in your user pool, including username-password and secure remote password (SRP) authentication. diff --git a/sdk/dotnet/Cognito/Outputs/UserPoolAdvancedSecurityAdditionalFlows.cs b/sdk/dotnet/Cognito/Outputs/UserPoolAdvancedSecurityAdditionalFlows.cs index 82c93d2ea4..bf801318c8 100644 --- a/sdk/dotnet/Cognito/Outputs/UserPoolAdvancedSecurityAdditionalFlows.cs +++ b/sdk/dotnet/Cognito/Outputs/UserPoolAdvancedSecurityAdditionalFlows.cs @@ -13,6 +13,9 @@ namespace Pulumi.AwsNative.Cognito.Outputs [OutputType] public sealed class UserPoolAdvancedSecurityAdditionalFlows { + /// + /// The operating mode of advanced security features in custom authentication with [Custom authentication challenge Lambda triggers](https://docs.aws.amazon.com/cognito/latest/developerguide/user-pool-lambda-challenge.html) . + /// public readonly string? CustomAuthMode; [OutputConstructor] diff --git a/sdk/dotnet/Cognito/Outputs/UserPoolPolicies.cs b/sdk/dotnet/Cognito/Outputs/UserPoolPolicies.cs index 7eace3c724..15e2f34426 100644 --- a/sdk/dotnet/Cognito/Outputs/UserPoolPolicies.cs +++ b/sdk/dotnet/Cognito/Outputs/UserPoolPolicies.cs @@ -17,6 +17,11 @@ public sealed class UserPoolPolicies /// The password policy settings for a user pool, including complexity, history, and length requirements. /// public readonly Outputs.UserPoolPasswordPolicy? PasswordPolicy; + /// + /// The policy for allowed types of authentication in a user pool. + /// + /// This data type is a request and response parameter of [CreateUserPool](https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_CreateUserPool.html) and [UpdateUserPool](https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_UpdateUserPool.html) , and a response parameter of [DescribeUserPool](https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_DescribeUserPool.html) . + /// public readonly Outputs.UserPoolSignInPolicy? SignInPolicy; [OutputConstructor] diff --git a/sdk/dotnet/Cognito/Outputs/UserPoolSignInPolicy.cs b/sdk/dotnet/Cognito/Outputs/UserPoolSignInPolicy.cs index 154b3f0eda..2f67dcf2cc 100644 --- a/sdk/dotnet/Cognito/Outputs/UserPoolSignInPolicy.cs +++ b/sdk/dotnet/Cognito/Outputs/UserPoolSignInPolicy.cs @@ -13,6 +13,11 @@ namespace Pulumi.AwsNative.Cognito.Outputs [OutputType] public sealed class UserPoolSignInPolicy { + /// + /// The sign-in methods that a user pool supports as the first factor. You can permit users to start authentication with a standard username and password, or with other one-time password and hardware factors. + /// + /// Supports values of `EMAIL_OTP` , `SMS_OTP` , `WEB_AUTHN` and `PASSWORD` , + /// public readonly ImmutableArray AllowedFirstAuthFactors; [OutputConstructor] diff --git a/sdk/dotnet/Cognito/UserPool.cs b/sdk/dotnet/Cognito/UserPool.cs index 75853a5f96..9ce3c3b4f2 100644 --- a/sdk/dotnet/Cognito/UserPool.cs +++ b/sdk/dotnet/Cognito/UserPool.cs @@ -30,7 +30,7 @@ public partial class UserPool : global::Pulumi.CustomResource public Output AdminCreateUserConfig { get; private set; } = null!; /// - /// Attributes supported as an alias for this user pool. Possible values: *phone_number* , *email* , or *preferred_username* . + /// Attributes supported as an alias for this user pool. Possible values: *phone_number* , *email* , or *preferred_username* . For more information about alias attributes, see [Customizing sign-in attributes](https://docs.aws.amazon.com/cognito/latest/developerguide/user-pool-settings-attributes.html#user-pool-settings-aliases) . /// [Output("aliasAttributes")] public Output> AliasAttributes { get; private set; } = null!; @@ -42,7 +42,7 @@ public partial class UserPool : global::Pulumi.CustomResource public Output Arn { get; private set; } = null!; /// - /// The attributes to be auto-verified. Possible values: *email* , *phone_number* . + /// The attributes that you want your user pool to automatically verify. Possible values: *email* , *phone_number* . For more information see [Verifying contact information at sign-up](https://docs.aws.amazon.com/cognito/latest/developerguide/signing-up-users-in-your-app.html#allowing-users-to-sign-up-and-confirm-themselves) . /// [Output("autoVerifiedAttributes")] public Output> AutoVerifiedAttributes { get; private set; } = null!; @@ -58,9 +58,9 @@ public partial class UserPool : global::Pulumi.CustomResource public Output DeletionProtection { get; private set; } = null!; /// - /// The device-remembering configuration for a user pool. A null value indicates that you have deactivated device remembering in your user pool. + /// The device-remembering configuration for a user pool. Device remembering or device tracking is a "Remember me on this device" option for user pools that perform authentication with the device key of a trusted device in the back end, instead of a user-provided MFA code. For more information about device authentication, see [Working with user devices in your user pool](https://docs.aws.amazon.com/cognito/latest/developerguide/amazon-cognito-user-pools-device-tracking.html) . A null value indicates that you have deactivated device remembering in your user pool. /// - /// > When you provide a value for any `DeviceConfiguration` field, you activate the Amazon Cognito device-remembering feature. + /// > When you provide a value for any `DeviceConfiguration` field, you activate the Amazon Cognito device-remembering feature. For more infor /// [Output("deviceConfiguration")] public Output DeviceConfiguration { get; private set; } = null!; @@ -138,7 +138,7 @@ public partial class UserPool : global::Pulumi.CustomResource public Output ProviderUrl { get; private set; } = null!; /// - /// An array of schema attributes for the new user pool. These attributes can be standard or custom attributes. + /// An array of attributes for the new user pool. You can add custom attributes and modify the properties of default attributes. The specifications in this parameter set the required attributes in your user pool. For more information, see [Working with user attributes](https://docs.aws.amazon.com/cognito/latest/developerguide/user-pool-settings-attributes.html) . /// [Output("schema")] public Output> Schema { get; private set; } = null!; @@ -150,7 +150,7 @@ public partial class UserPool : global::Pulumi.CustomResource public Output SmsAuthenticationMessage { get; private set; } = null!; /// - /// The SMS configuration with the settings that your Amazon Cognito user pool must use to send an SMS message from your AWS account through Amazon Simple Notification Service. To send SMS messages with Amazon SNS in the AWS Region that you want, the Amazon Cognito user pool uses an AWS Identity and Access Management (IAM) role in your AWS account . + /// The SMS configuration with the settings that your Amazon Cognito user pool must use to send an SMS message from your AWS account through Amazon Simple Notification Service. To send SMS messages with Amazon SNS in the AWS Region that you want, the Amazon Cognito user pool uses an AWS Identity and Access Management (IAM) role in your AWS account . For more information see [SMS message settings](https://docs.aws.amazon.com/cognito/latest/developerguide/user-pool-sms-settings.html) . /// [Output("smsConfiguration")] public Output SmsConfiguration { get; private set; } = null!; @@ -184,7 +184,7 @@ public partial class UserPool : global::Pulumi.CustomResource public Output UserPoolId { get; private set; } = null!; /// - /// A string used to name the user pool. + /// A friendlhy name for your user pool. /// [Output("userPoolName")] public Output UserPoolName { get; private set; } = null!; @@ -208,9 +208,11 @@ public partial class UserPool : global::Pulumi.CustomResource public Output> UsernameAttributes { get; private set; } = null!; /// - /// Case sensitivity on the username input for the selected sign-in option. When case sensitivity is set to `False` (case insensitive), users can sign in with any combination of capital and lowercase letters. For example, `username` , `USERNAME` , or `UserName` , or for email, `email@example.com` or `EMaiL@eXamplE.Com` . For most use cases, set case sensitivity to `False` (case insensitive) as a best practice. When usernames and email addresses are case insensitive, Amazon Cognito treats any variation in case as the same user, and prevents a case variation from being assigned to the same attribute for a different user. + /// Sets the case sensitivity option for sign-in usernames. When `CaseSensitive` is `false` (case insensitive), users can sign in with any combination of capital and lowercase letters. For example, `username` , `USERNAME` , or `UserName` , or for email, `email@example.com` or `EMaiL@eXamplE.Com` . For most use cases, set case sensitivity to `false` as a best practice. When usernames and email addresses are case insensitive, Amazon Cognito treats any variation in case as the same user, and prevents a case variation from being assigned to the same attribute for a different user. /// - /// This configuration is immutable after you set it. For more information, see [UsernameConfigurationType](https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_UsernameConfigurationType.html) . + /// When `CaseSensitive` is `true` (case sensitive), Amazon Cognito interprets `USERNAME` and `UserName` as distinct users. + /// + /// This configuration is immutable after you set it. /// [Output("usernameConfiguration")] public Output UsernameConfiguration { get; private set; } = null!; @@ -223,9 +225,21 @@ public partial class UserPool : global::Pulumi.CustomResource [Output("verificationMessageTemplate")] public Output VerificationMessageTemplate { get; private set; } = null!; + /// + /// Sets or displays the authentication domain, typically your user pool domain, that passkey providers must use as a relying party (RP) in their configuration. + /// + /// Under the following conditions, the passkey relying party ID must be the fully-qualified domain name of your custom domain: + /// + /// - The user pool is configured for passkey authentication. + /// - The user pool has a custom domain, whether or not it also has a prefix domain. + /// - Your application performs authentication with managed login or the classic hosted UI. + /// [Output("webAuthnRelyingPartyId")] public Output WebAuthnRelyingPartyId { get; private set; } = null!; + /// + /// When `required` , users can only register and sign in users with passkeys that are capable of [user verification](https://docs.aws.amazon.com/https://www.w3.org/TR/webauthn-2/#enum-userVerificationRequirement) . When `preferred` , your user pool doesn't require the use of authenticators with user verification but encourages it. + /// [Output("webAuthnUserVerification")] public Output WebAuthnUserVerification { get; private set; } = null!; @@ -292,7 +306,7 @@ public sealed class UserPoolArgs : global::Pulumi.ResourceArgs private InputList? _aliasAttributes; /// - /// Attributes supported as an alias for this user pool. Possible values: *phone_number* , *email* , or *preferred_username* . + /// Attributes supported as an alias for this user pool. Possible values: *phone_number* , *email* , or *preferred_username* . For more information about alias attributes, see [Customizing sign-in attributes](https://docs.aws.amazon.com/cognito/latest/developerguide/user-pool-settings-attributes.html#user-pool-settings-aliases) . /// public InputList AliasAttributes { @@ -304,7 +318,7 @@ public InputList AliasAttributes private InputList? _autoVerifiedAttributes; /// - /// The attributes to be auto-verified. Possible values: *email* , *phone_number* . + /// The attributes that you want your user pool to automatically verify. Possible values: *email* , *phone_number* . For more information see [Verifying contact information at sign-up](https://docs.aws.amazon.com/cognito/latest/developerguide/signing-up-users-in-your-app.html#allowing-users-to-sign-up-and-confirm-themselves) . /// public InputList AutoVerifiedAttributes { @@ -323,9 +337,9 @@ public InputList AutoVerifiedAttributes public Input? DeletionProtection { get; set; } /// - /// The device-remembering configuration for a user pool. A null value indicates that you have deactivated device remembering in your user pool. + /// The device-remembering configuration for a user pool. Device remembering or device tracking is a "Remember me on this device" option for user pools that perform authentication with the device key of a trusted device in the back end, instead of a user-provided MFA code. For more information about device authentication, see [Working with user devices in your user pool](https://docs.aws.amazon.com/cognito/latest/developerguide/amazon-cognito-user-pools-device-tracking.html) . A null value indicates that you have deactivated device remembering in your user pool. /// - /// > When you provide a value for any `DeviceConfiguration` field, you activate the Amazon Cognito device-remembering feature. + /// > When you provide a value for any `DeviceConfiguration` field, you activate the Amazon Cognito device-remembering feature. For more infor /// [Input("deviceConfiguration")] public Input? DeviceConfiguration { get; set; } @@ -400,7 +414,7 @@ public InputList EnabledMfas private InputList? _schema; /// - /// An array of schema attributes for the new user pool. These attributes can be standard or custom attributes. + /// An array of attributes for the new user pool. You can add custom attributes and modify the properties of default attributes. The specifications in this parameter set the required attributes in your user pool. For more information, see [Working with user attributes](https://docs.aws.amazon.com/cognito/latest/developerguide/user-pool-settings-attributes.html) . /// public InputList Schema { @@ -415,7 +429,7 @@ public InputList Schema public Input? SmsAuthenticationMessage { get; set; } /// - /// The SMS configuration with the settings that your Amazon Cognito user pool must use to send an SMS message from your AWS account through Amazon Simple Notification Service. To send SMS messages with Amazon SNS in the AWS Region that you want, the Amazon Cognito user pool uses an AWS Identity and Access Management (IAM) role in your AWS account . + /// The SMS configuration with the settings that your Amazon Cognito user pool must use to send an SMS message from your AWS account through Amazon Simple Notification Service. To send SMS messages with Amazon SNS in the AWS Region that you want, the Amazon Cognito user pool uses an AWS Identity and Access Management (IAM) role in your AWS account . For more information see [SMS message settings](https://docs.aws.amazon.com/cognito/latest/developerguide/user-pool-sms-settings.html) . /// [Input("smsConfiguration")] public Input? SmsConfiguration { get; set; } @@ -443,7 +457,7 @@ public InputList Schema public Input? UserPoolAddOns { get; set; } /// - /// A string used to name the user pool. + /// A friendlhy name for your user pool. /// [Input("userPoolName")] public Input? UserPoolName { get; set; } @@ -479,9 +493,11 @@ public InputList UsernameAttributes } /// - /// Case sensitivity on the username input for the selected sign-in option. When case sensitivity is set to `False` (case insensitive), users can sign in with any combination of capital and lowercase letters. For example, `username` , `USERNAME` , or `UserName` , or for email, `email@example.com` or `EMaiL@eXamplE.Com` . For most use cases, set case sensitivity to `False` (case insensitive) as a best practice. When usernames and email addresses are case insensitive, Amazon Cognito treats any variation in case as the same user, and prevents a case variation from being assigned to the same attribute for a different user. + /// Sets the case sensitivity option for sign-in usernames. When `CaseSensitive` is `false` (case insensitive), users can sign in with any combination of capital and lowercase letters. For example, `username` , `USERNAME` , or `UserName` , or for email, `email@example.com` or `EMaiL@eXamplE.Com` . For most use cases, set case sensitivity to `false` as a best practice. When usernames and email addresses are case insensitive, Amazon Cognito treats any variation in case as the same user, and prevents a case variation from being assigned to the same attribute for a different user. /// - /// This configuration is immutable after you set it. For more information, see [UsernameConfigurationType](https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_UsernameConfigurationType.html) . + /// When `CaseSensitive` is `true` (case sensitive), Amazon Cognito interprets `USERNAME` and `UserName` as distinct users. + /// + /// This configuration is immutable after you set it. /// [Input("usernameConfiguration")] public Input? UsernameConfiguration { get; set; } @@ -494,9 +510,21 @@ public InputList UsernameAttributes [Input("verificationMessageTemplate")] public Input? VerificationMessageTemplate { get; set; } + /// + /// Sets or displays the authentication domain, typically your user pool domain, that passkey providers must use as a relying party (RP) in their configuration. + /// + /// Under the following conditions, the passkey relying party ID must be the fully-qualified domain name of your custom domain: + /// + /// - The user pool is configured for passkey authentication. + /// - The user pool has a custom domain, whether or not it also has a prefix domain. + /// - Your application performs authentication with managed login or the classic hosted UI. + /// [Input("webAuthnRelyingPartyId")] public Input? WebAuthnRelyingPartyId { get; set; } + /// + /// When `required` , users can only register and sign in users with passkeys that are capable of [user verification](https://docs.aws.amazon.com/https://www.w3.org/TR/webauthn-2/#enum-userVerificationRequirement) . When `preferred` , your user pool doesn't require the use of authenticators with user verification but encourages it. + /// [Input("webAuthnUserVerification")] public Input? WebAuthnUserVerification { get; set; } diff --git a/sdk/dotnet/Cognito/UserPoolClient.cs b/sdk/dotnet/Cognito/UserPoolClient.cs index 3bcbff9929..d323db7513 100644 --- a/sdk/dotnet/Cognito/UserPoolClient.cs +++ b/sdk/dotnet/Cognito/UserPoolClient.cs @@ -55,7 +55,7 @@ public partial class UserPoolClient : global::Pulumi.CustomResource public Output AllowedOAuthFlowsUserPoolClient { get; private set; } = null!; /// - /// The allowed OAuth scopes. Possible values provided by OAuth are `phone` , `email` , `openid` , and `profile` . Possible values provided by AWS are `aws.cognito.signin.user.admin` . Custom scopes created in Resource Servers are also supported. + /// The OAuth 2.0 scopes that you want to permit your app client to authorize. Scopes govern access control to user pool self-service API operations, user data from the `userInfo` endpoint, and third-party APIs. Possible values provided by OAuth are `phone` , `email` , `openid` , and `profile` . Possible values provided by AWS are `aws.cognito.signin.user.admin` . Custom scopes created in Resource Servers are also supported. /// [Output("allowedOAuthScopes")] public Output> AllowedOAuthScopes { get; private set; } = null!; @@ -63,7 +63,7 @@ public partial class UserPoolClient : global::Pulumi.CustomResource /// /// The user pool analytics configuration for collecting metrics and sending them to your Amazon Pinpoint campaign. /// - /// > In AWS Regions where Amazon Pinpoint isn't available, user pools only support sending events to Amazon Pinpoint projects in AWS Region us-east-1. In Regions where Amazon Pinpoint is available, user pools support sending events to Amazon Pinpoint projects within that same Region. + /// In AWS Regions where Amazon Pinpoint isn't available, user pools might not have access to analytics or might be configurable with campaigns in the US East (N. Virginia) Region. For more information, see [Using Amazon Pinpoint analytics](https://docs.aws.amazon.com/cognito/latest/developerguide/cognito-user-pools-pinpoint-integration.html) . /// [Output("analyticsConfiguration")] public Output AnalyticsConfiguration { get; private set; } = null!; @@ -80,7 +80,7 @@ public partial class UserPoolClient : global::Pulumi.CustomResource /// A redirect URI must: /// /// - Be an absolute URI. - /// - Be registered with the authorization server. + /// - Be registered with the authorization server. Amazon Cognito doesn't accept authorization requests with `redirect_uri` values that aren't in the list of `CallbackURLs` that you provide in this parameter. /// - Not include a fragment component. /// /// See [OAuth 2.0 - Redirection Endpoint](https://docs.aws.amazon.com/https://tools.ietf.org/html/rfc6749#section-3.1.2) . @@ -99,7 +99,7 @@ public partial class UserPoolClient : global::Pulumi.CustomResource public Output ClientId { get; private set; } = null!; /// - /// The client name for the user pool client you would like to create. + /// A friendly name for the app client that you want to create. /// [Output("clientName")] public Output ClientName { get; private set; } = null!; @@ -109,18 +109,6 @@ public partial class UserPoolClient : global::Pulumi.CustomResource /// /// The default redirect URI. In app clients with one assigned IdP, replaces `redirect_uri` in authentication requests. Must be in the `CallbackURLs` list. - /// - /// A redirect URI must: - /// - /// - Be an absolute URI. - /// - Be registered with the authorization server. - /// - Not include a fragment component. - /// - /// For more information, see [Default redirect URI](https://docs.aws.amazon.com/cognito/latest/developerguide/user-pool-settings-client-apps.html#cognito-user-pools-app-idp-settings-about) . - /// - /// Amazon Cognito requires HTTPS over HTTP except for http://localhost for testing purposes only. - /// - /// App callback URLs such as myapp://example are also supported. /// [Output("defaultRedirectUri")] public Output DefaultRedirectUri { get; private set; } = null!; @@ -160,7 +148,7 @@ public partial class UserPoolClient : global::Pulumi.CustomResource public Output> ExplicitAuthFlows { get; private set; } = null!; /// - /// Boolean to specify whether you want to generate a secret for the user pool client being created. + /// When `true` , generates a client secret for the app client. Client secrets are used with server-side and machine-to-machine applications. For more information, see [App client types](https://docs.aws.amazon.com/cognito/latest/developerguide/user-pool-settings-client-apps.html#user-pool-settings-client-app-client-types) . /// [Output("generateSecret")] public Output GenerateSecret { get; private set; } = null!; @@ -179,7 +167,7 @@ public partial class UserPoolClient : global::Pulumi.CustomResource public Output IdTokenValidity { get; private set; } = null!; /// - /// A list of allowed logout URLs for the IdPs. + /// A list of allowed logout URLs for managed login authentication. For more information, see [Logout endpoint](https://docs.aws.amazon.com/cognito/latest/developerguide/logout-endpoint.html) . /// [Output("logoutUrls")] public Output> LogoutUrls { get; private set; } = null!; @@ -225,19 +213,19 @@ public partial class UserPoolClient : global::Pulumi.CustomResource /// /// A list of provider names for the identity providers (IdPs) that are supported on this client. The following are supported: `COGNITO` , `Facebook` , `Google` , `SignInWithApple` , and `LoginWithAmazon` . You can also specify the names that you configured for the SAML and OIDC IdPs in your user pool, for example `MySAMLIdP` or `MyOIDCIdP` . /// - /// This setting applies to providers that you can access with the [hosted UI and OAuth 2.0 authorization server](https://docs.aws.amazon.com/cognito/latest/developerguide/cognito-user-pools-app-integration.html) . The removal of `COGNITO` from this list doesn't prevent authentication operations for local users with the user pools API in an AWS SDK. The only way to prevent API-based authentication is to block access with a [AWS WAF rule](https://docs.aws.amazon.com/cognito/latest/developerguide/user-pool-waf.html) . + /// This setting applies to providers that you can access with [managed login](https://docs.aws.amazon.com/cognito/latest/developerguide/cognito-user-pools-managed-login.html) . The removal of `COGNITO` from this list doesn't prevent authentication operations for local users with the user pools API in an AWS SDK. The only way to prevent API-based authentication is to block access with a [AWS WAF rule](https://docs.aws.amazon.com/cognito/latest/developerguide/user-pool-waf.html) . /// [Output("supportedIdentityProviders")] public Output> SupportedIdentityProviders { get; private set; } = null!; /// - /// The units in which the validity times are represented. The default unit for RefreshToken is days, and default for ID and access tokens are hours. + /// The units that validity times are represented in. The default unit for refresh tokens is days, and the default for ID and access tokens are hours. /// [Output("tokenValidityUnits")] public Output TokenValidityUnits { get; private set; } = null!; /// - /// The user pool ID for the user pool where you want to create a user pool client. + /// The ID of the user pool where you want to create an app client. /// [Output("userPoolId")] public Output UserPoolId { get; private set; } = null!; @@ -351,7 +339,7 @@ public InputList AllowedOAuthFlows private InputList? _allowedOAuthScopes; /// - /// The allowed OAuth scopes. Possible values provided by OAuth are `phone` , `email` , `openid` , and `profile` . Possible values provided by AWS are `aws.cognito.signin.user.admin` . Custom scopes created in Resource Servers are also supported. + /// The OAuth 2.0 scopes that you want to permit your app client to authorize. Scopes govern access control to user pool self-service API operations, user data from the `userInfo` endpoint, and third-party APIs. Possible values provided by OAuth are `phone` , `email` , `openid` , and `profile` . Possible values provided by AWS are `aws.cognito.signin.user.admin` . Custom scopes created in Resource Servers are also supported. /// public InputList AllowedOAuthScopes { @@ -362,7 +350,7 @@ public InputList AllowedOAuthScopes /// /// The user pool analytics configuration for collecting metrics and sending them to your Amazon Pinpoint campaign. /// - /// > In AWS Regions where Amazon Pinpoint isn't available, user pools only support sending events to Amazon Pinpoint projects in AWS Region us-east-1. In Regions where Amazon Pinpoint is available, user pools support sending events to Amazon Pinpoint projects within that same Region. + /// In AWS Regions where Amazon Pinpoint isn't available, user pools might not have access to analytics or might be configurable with campaigns in the US East (N. Virginia) Region. For more information, see [Using Amazon Pinpoint analytics](https://docs.aws.amazon.com/cognito/latest/developerguide/cognito-user-pools-pinpoint-integration.html) . /// [Input("analyticsConfiguration")] public Input? AnalyticsConfiguration { get; set; } @@ -382,7 +370,7 @@ public InputList AllowedOAuthScopes /// A redirect URI must: /// /// - Be an absolute URI. - /// - Be registered with the authorization server. + /// - Be registered with the authorization server. Amazon Cognito doesn't accept authorization requests with `redirect_uri` values that aren't in the list of `CallbackURLs` that you provide in this parameter. /// - Not include a fragment component. /// /// See [OAuth 2.0 - Redirection Endpoint](https://docs.aws.amazon.com/https://tools.ietf.org/html/rfc6749#section-3.1.2) . @@ -398,25 +386,13 @@ public InputList CallbackUrls } /// - /// The client name for the user pool client you would like to create. + /// A friendly name for the app client that you want to create. /// [Input("clientName")] public Input? ClientName { get; set; } /// /// The default redirect URI. In app clients with one assigned IdP, replaces `redirect_uri` in authentication requests. Must be in the `CallbackURLs` list. - /// - /// A redirect URI must: - /// - /// - Be an absolute URI. - /// - Be registered with the authorization server. - /// - Not include a fragment component. - /// - /// For more information, see [Default redirect URI](https://docs.aws.amazon.com/cognito/latest/developerguide/user-pool-settings-client-apps.html#cognito-user-pools-app-idp-settings-about) . - /// - /// Amazon Cognito requires HTTPS over HTTP except for http://localhost for testing purposes only. - /// - /// App callback URLs such as myapp://example are also supported. /// [Input("defaultRedirectUri")] public Input? DefaultRedirectUri { get; set; } @@ -462,7 +438,7 @@ public InputList ExplicitAuthFlows } /// - /// Boolean to specify whether you want to generate a secret for the user pool client being created. + /// When `true` , generates a client secret for the app client. Client secrets are used with server-side and machine-to-machine applications. For more information, see [App client types](https://docs.aws.amazon.com/cognito/latest/developerguide/user-pool-settings-client-apps.html#user-pool-settings-client-app-client-types) . /// [Input("generateSecret")] public Input? GenerateSecret { get; set; } @@ -484,7 +460,7 @@ public InputList ExplicitAuthFlows private InputList? _logoutUrls; /// - /// A list of allowed logout URLs for the IdPs. + /// A list of allowed logout URLs for managed login authentication. For more information, see [Logout endpoint](https://docs.aws.amazon.com/cognito/latest/developerguide/logout-endpoint.html) . /// public InputList LogoutUrls { @@ -539,7 +515,7 @@ public InputList ReadAttributes /// /// A list of provider names for the identity providers (IdPs) that are supported on this client. The following are supported: `COGNITO` , `Facebook` , `Google` , `SignInWithApple` , and `LoginWithAmazon` . You can also specify the names that you configured for the SAML and OIDC IdPs in your user pool, for example `MySAMLIdP` or `MyOIDCIdP` . /// - /// This setting applies to providers that you can access with the [hosted UI and OAuth 2.0 authorization server](https://docs.aws.amazon.com/cognito/latest/developerguide/cognito-user-pools-app-integration.html) . The removal of `COGNITO` from this list doesn't prevent authentication operations for local users with the user pools API in an AWS SDK. The only way to prevent API-based authentication is to block access with a [AWS WAF rule](https://docs.aws.amazon.com/cognito/latest/developerguide/user-pool-waf.html) . + /// This setting applies to providers that you can access with [managed login](https://docs.aws.amazon.com/cognito/latest/developerguide/cognito-user-pools-managed-login.html) . The removal of `COGNITO` from this list doesn't prevent authentication operations for local users with the user pools API in an AWS SDK. The only way to prevent API-based authentication is to block access with a [AWS WAF rule](https://docs.aws.amazon.com/cognito/latest/developerguide/user-pool-waf.html) . /// public InputList SupportedIdentityProviders { @@ -548,13 +524,13 @@ public InputList SupportedIdentityProviders } /// - /// The units in which the validity times are represented. The default unit for RefreshToken is days, and default for ID and access tokens are hours. + /// The units that validity times are represented in. The default unit for refresh tokens is days, and the default for ID and access tokens are hours. /// [Input("tokenValidityUnits")] public Input? TokenValidityUnits { get; set; } /// - /// The user pool ID for the user pool where you want to create a user pool client. + /// The ID of the user pool where you want to create an app client. /// [Input("userPoolId", required: true)] public Input UserPoolId { get; set; } = null!; diff --git a/sdk/dotnet/Cognito/UserPoolGroup.cs b/sdk/dotnet/Cognito/UserPoolGroup.cs index 45a2cf8c92..eeb70332ee 100644 --- a/sdk/dotnet/Cognito/UserPoolGroup.cs +++ b/sdk/dotnet/Cognito/UserPoolGroup.cs @@ -16,13 +16,13 @@ namespace Pulumi.AwsNative.Cognito public partial class UserPoolGroup : global::Pulumi.CustomResource { /// - /// A string containing the description of the group. + /// A description of the group that you're creating. /// [Output("description")] public Output Description { get; private set; } = null!; /// - /// The name of the group. Must be unique. + /// A name for the group. This name must be unique in your user pool. /// [Output("groupName")] public Output GroupName { get; private set; } = null!; @@ -38,13 +38,13 @@ public partial class UserPoolGroup : global::Pulumi.CustomResource public Output Precedence { get; private set; } = null!; /// - /// The role Amazon Resource Name (ARN) for the group. + /// The Amazon Resource Name (ARN) for the IAM role that you want to associate with the group. A group role primarily declares a preferred role for the credentials that you get from an identity pool. Amazon Cognito ID tokens have a `cognito:preferred_role` claim that presents the highest-precedence group that a user belongs to. Both ID and access tokens also contain a `cognito:groups` claim that list all the groups that a user is a member of. /// [Output("roleArn")] public Output RoleArn { get; private set; } = null!; /// - /// The user pool ID for the user pool. + /// The ID of the user pool where you want to create a user group. /// [Output("userPoolId")] public Output UserPoolId { get; private set; } = null!; @@ -100,13 +100,13 @@ public static UserPoolGroup Get(string name, Input id, CustomResourceOpt public sealed class UserPoolGroupArgs : global::Pulumi.ResourceArgs { /// - /// A string containing the description of the group. + /// A description of the group that you're creating. /// [Input("description")] public Input? Description { get; set; } /// - /// The name of the group. Must be unique. + /// A name for the group. This name must be unique in your user pool. /// [Input("groupName")] public Input? GroupName { get; set; } @@ -122,13 +122,13 @@ public sealed class UserPoolGroupArgs : global::Pulumi.ResourceArgs public Input? Precedence { get; set; } /// - /// The role Amazon Resource Name (ARN) for the group. + /// The Amazon Resource Name (ARN) for the IAM role that you want to associate with the group. A group role primarily declares a preferred role for the credentials that you get from an identity pool. Amazon Cognito ID tokens have a `cognito:preferred_role` claim that presents the highest-precedence group that a user belongs to. Both ID and access tokens also contain a `cognito:groups` claim that list all the groups that a user is a member of. /// [Input("roleArn")] public Input? RoleArn { get; set; } /// - /// The user pool ID for the user pool. + /// The ID of the user pool where you want to create a user group. /// [Input("userPoolId", required: true)] public Input UserPoolId { get; set; } = null!; diff --git a/sdk/dotnet/Cognito/UserPoolIdentityProvider.cs b/sdk/dotnet/Cognito/UserPoolIdentityProvider.cs index 56862a9b6a..86c90c9247 100644 --- a/sdk/dotnet/Cognito/UserPoolIdentityProvider.cs +++ b/sdk/dotnet/Cognito/UserPoolIdentityProvider.cs @@ -16,13 +16,13 @@ namespace Pulumi.AwsNative.Cognito public partial class UserPoolIdentityProvider : global::Pulumi.CustomResource { /// - /// A mapping of IdP attributes to standard and custom user pool attributes. + /// A mapping of IdP attributes to standard and custom user pool attributes. Specify a user pool attribute as the key of the key-value pair, and the IdP attribute claim name as the value. /// [Output("attributeMapping")] public Output?> AttributeMapping { get; private set; } = null!; /// - /// A list of IdP identifiers. + /// An array of IdP identifiers, for example `"IdPIdentifiers": [ "MyIdP", "MyIdP2" ]` . Identifiers are friendly names that you can pass in the `idp_identifier` query parameter of requests to the [Authorize endpoint](https://docs.aws.amazon.com/cognito/latest/developerguide/authorization-endpoint.html) to silently redirect to sign-in with the associated IdP. Identifiers in a domain format also enable the use of [email-address matching with SAML providers](https://docs.aws.amazon.com/cognito/latest/developerguide/cognito-user-pools-managing-saml-idp-naming.html) . /// [Output("idpIdentifiers")] public Output> IdpIdentifiers { get; private set; } = null!; @@ -62,19 +62,19 @@ public partial class UserPoolIdentityProvider : global::Pulumi.CustomResource public Output> ProviderDetails { get; private set; } = null!; /// - /// The IdP name. + /// The name that you want to assign to the IdP. You can pass the identity provider name in the `identity_provider` query parameter of requests to the [Authorize endpoint](https://docs.aws.amazon.com/cognito/latest/developerguide/authorization-endpoint.html) to silently redirect to sign-in with the associated IdP. /// [Output("providerName")] public Output ProviderName { get; private set; } = null!; /// - /// The IdP type. + /// The type of IdP that you want to add. Amazon Cognito supports OIDC, SAML 2.0, Login With Amazon, Sign In With Apple, Google, and Facebook IdPs. /// [Output("providerType")] public Output ProviderType { get; private set; } = null!; /// - /// The user pool ID. + /// The Id of the user pool where you want to create an IdP. /// [Output("userPoolId")] public Output UserPoolId { get; private set; } = null!; @@ -134,7 +134,7 @@ public sealed class UserPoolIdentityProviderArgs : global::Pulumi.ResourceArgs private InputMap? _attributeMapping; /// - /// A mapping of IdP attributes to standard and custom user pool attributes. + /// A mapping of IdP attributes to standard and custom user pool attributes. Specify a user pool attribute as the key of the key-value pair, and the IdP attribute claim name as the value. /// public InputMap AttributeMapping { @@ -146,7 +146,7 @@ public InputMap AttributeMapping private InputList? _idpIdentifiers; /// - /// A list of IdP identifiers. + /// An array of IdP identifiers, for example `"IdPIdentifiers": [ "MyIdP", "MyIdP2" ]` . Identifiers are friendly names that you can pass in the `idp_identifier` query parameter of requests to the [Authorize endpoint](https://docs.aws.amazon.com/cognito/latest/developerguide/authorization-endpoint.html) to silently redirect to sign-in with the associated IdP. Identifiers in a domain format also enable the use of [email-address matching with SAML providers](https://docs.aws.amazon.com/cognito/latest/developerguide/cognito-user-pools-managing-saml-idp-naming.html) . /// public InputList IdpIdentifiers { @@ -195,19 +195,19 @@ public InputMap ProviderDetails } /// - /// The IdP name. + /// The name that you want to assign to the IdP. You can pass the identity provider name in the `identity_provider` query parameter of requests to the [Authorize endpoint](https://docs.aws.amazon.com/cognito/latest/developerguide/authorization-endpoint.html) to silently redirect to sign-in with the associated IdP. /// [Input("providerName")] public Input? ProviderName { get; set; } /// - /// The IdP type. + /// The type of IdP that you want to add. Amazon Cognito supports OIDC, SAML 2.0, Login With Amazon, Sign In With Apple, Google, and Facebook IdPs. /// [Input("providerType", required: true)] public Input ProviderType { get; set; } = null!; /// - /// The user pool ID. + /// The Id of the user pool where you want to create an IdP. /// [Input("userPoolId", required: true)] public Input UserPoolId { get; set; } = null!; diff --git a/sdk/dotnet/Cognito/UserPoolResourceServer.cs b/sdk/dotnet/Cognito/UserPoolResourceServer.cs index 3ecb7d0088..8f30ad318e 100644 --- a/sdk/dotnet/Cognito/UserPoolResourceServer.cs +++ b/sdk/dotnet/Cognito/UserPoolResourceServer.cs @@ -36,7 +36,7 @@ public partial class UserPoolResourceServer : global::Pulumi.CustomResource public Output> Scopes { get; private set; } = null!; /// - /// The user pool ID for the user pool. + /// The ID of the user pool where you want to create a resource server. /// [Output("userPoolId")] public Output UserPoolId { get; private set; } = null!; @@ -118,7 +118,7 @@ public InputList Scope } /// - /// The user pool ID for the user pool. + /// The ID of the user pool where you want to create a resource server. /// [Input("userPoolId", required: true)] public Input UserPoolId { get; set; } = null!; diff --git a/sdk/dotnet/Cognito/UserPoolUiCustomizationAttachment.cs b/sdk/dotnet/Cognito/UserPoolUiCustomizationAttachment.cs index 4e0d721241..b649463477 100644 --- a/sdk/dotnet/Cognito/UserPoolUiCustomizationAttachment.cs +++ b/sdk/dotnet/Cognito/UserPoolUiCustomizationAttachment.cs @@ -28,7 +28,7 @@ public partial class UserPoolUiCustomizationAttachment : global::Pulumi.CustomRe public Output Css { get; private set; } = null!; /// - /// The user pool ID for the user pool. + /// The ID of the user pool. /// [Output("userPoolId")] public Output UserPoolId { get; private set; } = null!; @@ -96,7 +96,7 @@ public sealed class UserPoolUiCustomizationAttachmentArgs : global::Pulumi.Resou public Input? Css { get; set; } /// - /// The user pool ID for the user pool. + /// The ID of the user pool. /// [Input("userPoolId", required: true)] public Input UserPoolId { get; set; } = null!; diff --git a/sdk/dotnet/Cognito/UserPoolUser.cs b/sdk/dotnet/Cognito/UserPoolUser.cs index c88fece419..7ef6ecf3c6 100644 --- a/sdk/dotnet/Cognito/UserPoolUser.cs +++ b/sdk/dotnet/Cognito/UserPoolUser.cs @@ -18,21 +18,21 @@ public partial class UserPoolUser : global::Pulumi.CustomResource /// /// A map of custom key-value pairs that you can provide as input for any custom workflows that this action triggers. /// - /// You create custom workflows by assigning AWS Lambda functions to user pool triggers. When you use the AdminCreateUser API action, Amazon Cognito invokes the function that is assigned to the *pre sign-up* trigger. When Amazon Cognito invokes this function, it passes a JSON payload, which the function receives as input. This payload contains a `clientMetadata` attribute, which provides the data that you assigned to the ClientMetadata parameter in your AdminCreateUser request. In your function code in AWS Lambda , you can process the `clientMetadata` value to enhance your workflow for your specific needs. + /// You create custom workflows by assigning AWS Lambda functions to user pool triggers. When you use the AdminCreateUser API action, Amazon Cognito invokes the function that is assigned to the *pre sign-up* trigger. When Amazon Cognito invokes this function, it passes a JSON payload, which the function receives as input. This payload contains a `ClientMetadata` attribute, which provides the data that you assigned to the ClientMetadata parameter in your AdminCreateUser request. In your function code in AWS Lambda , you can process the `clientMetadata` value to enhance your workflow for your specific needs. /// /// For more information, see [Customizing user pool Workflows with Lambda Triggers](https://docs.aws.amazon.com/cognito/latest/developerguide/cognito-user-identity-pools-working-with-aws-lambda-triggers.html) in the *Amazon Cognito Developer Guide* . /// - /// > When you use the ClientMetadata parameter, remember that Amazon Cognito won't do the following: + /// > When you use the `ClientMetadata` parameter, note that Amazon Cognito won't do the following: /// > - /// > - Store the ClientMetadata value. This data is available only to AWS Lambda triggers that are assigned to a user pool to support custom workflows. If your user pool configuration doesn't include triggers, the ClientMetadata parameter serves no purpose. - /// > - Validate the ClientMetadata value. - /// > - Encrypt the ClientMetadata value. Don't use Amazon Cognito to provide sensitive information. + /// > - Store the `ClientMetadata` value. This data is available only to AWS Lambda triggers that are assigned to a user pool to support custom workflows. If your user pool configuration doesn't include triggers, the `ClientMetadata` parameter serves no purpose. + /// > - Validate the `ClientMetadata` value. + /// > - Encrypt the `ClientMetadata` value. Don't send sensitive information in this parameter. /// [Output("clientMetadata")] public Output?> ClientMetadata { get; private set; } = null!; /// - /// Specify `"EMAIL"` if email will be used to send the welcome message. Specify `"SMS"` if the phone number will be used. The default value is `"SMS"` . You can specify more than one value. + /// Specify `EMAIL` if email will be used to send the welcome message. Specify `SMS` if the phone number will be used. The default value is `SMS` . You can specify more than one value. /// [Output("desiredDeliveryMediums")] public Output> DesiredDeliveryMediums { get; private set; } = null!; @@ -40,7 +40,7 @@ public partial class UserPoolUser : global::Pulumi.CustomResource /// /// This parameter is used only if the `phone_number_verified` or `email_verified` attribute is set to `True` . Otherwise, it is ignored. /// - /// If this parameter is set to `True` and the phone number or email address specified in the UserAttributes parameter already exists as an alias with a different user, the API call will migrate the alias from the previous user to the newly created user. The previous user will no longer be able to log in using that alias. + /// If this parameter is set to `True` and the phone number or email address specified in the `UserAttributes` parameter already exists as an alias with a different user, this request migrates the alias from the previous user to the newly-created user. The previous user will no longer be able to log in using that alias. /// /// If this parameter is set to `False` , the API throws an `AliasExistsException` error if the alias already exists. The default value is `False` . /// @@ -48,7 +48,7 @@ public partial class UserPoolUser : global::Pulumi.CustomResource public Output ForceAliasCreation { get; private set; } = null!; /// - /// Set to `RESEND` to resend the invitation message to a user that already exists and reset the expiration limit on the user's account. Set to `SUPPRESS` to suppress sending the message. You can specify only one value. + /// Set to `RESEND` to resend the invitation message to a user that already exists, and to reset the temporary-password duration with a new temporary password. Set to `SUPPRESS` to suppress sending the message. You can specify only one value. /// [Output("messageAction")] public Output MessageAction { get; private set; } = null!; @@ -71,7 +71,7 @@ public partial class UserPoolUser : global::Pulumi.CustomResource public Output> UserAttributes { get; private set; } = null!; /// - /// The user pool ID for the user pool where the user will be created. + /// The ID of the user pool where you want to create a user. /// [Output("userPoolId")] public Output UserPoolId { get; private set; } = null!; @@ -158,15 +158,15 @@ public sealed class UserPoolUserArgs : global::Pulumi.ResourceArgs /// /// A map of custom key-value pairs that you can provide as input for any custom workflows that this action triggers. /// - /// You create custom workflows by assigning AWS Lambda functions to user pool triggers. When you use the AdminCreateUser API action, Amazon Cognito invokes the function that is assigned to the *pre sign-up* trigger. When Amazon Cognito invokes this function, it passes a JSON payload, which the function receives as input. This payload contains a `clientMetadata` attribute, which provides the data that you assigned to the ClientMetadata parameter in your AdminCreateUser request. In your function code in AWS Lambda , you can process the `clientMetadata` value to enhance your workflow for your specific needs. + /// You create custom workflows by assigning AWS Lambda functions to user pool triggers. When you use the AdminCreateUser API action, Amazon Cognito invokes the function that is assigned to the *pre sign-up* trigger. When Amazon Cognito invokes this function, it passes a JSON payload, which the function receives as input. This payload contains a `ClientMetadata` attribute, which provides the data that you assigned to the ClientMetadata parameter in your AdminCreateUser request. In your function code in AWS Lambda , you can process the `clientMetadata` value to enhance your workflow for your specific needs. /// /// For more information, see [Customizing user pool Workflows with Lambda Triggers](https://docs.aws.amazon.com/cognito/latest/developerguide/cognito-user-identity-pools-working-with-aws-lambda-triggers.html) in the *Amazon Cognito Developer Guide* . /// - /// > When you use the ClientMetadata parameter, remember that Amazon Cognito won't do the following: + /// > When you use the `ClientMetadata` parameter, note that Amazon Cognito won't do the following: /// > - /// > - Store the ClientMetadata value. This data is available only to AWS Lambda triggers that are assigned to a user pool to support custom workflows. If your user pool configuration doesn't include triggers, the ClientMetadata parameter serves no purpose. - /// > - Validate the ClientMetadata value. - /// > - Encrypt the ClientMetadata value. Don't use Amazon Cognito to provide sensitive information. + /// > - Store the `ClientMetadata` value. This data is available only to AWS Lambda triggers that are assigned to a user pool to support custom workflows. If your user pool configuration doesn't include triggers, the `ClientMetadata` parameter serves no purpose. + /// > - Validate the `ClientMetadata` value. + /// > - Encrypt the `ClientMetadata` value. Don't send sensitive information in this parameter. /// public InputMap ClientMetadata { @@ -178,7 +178,7 @@ public InputMap ClientMetadata private InputList? _desiredDeliveryMediums; /// - /// Specify `"EMAIL"` if email will be used to send the welcome message. Specify `"SMS"` if the phone number will be used. The default value is `"SMS"` . You can specify more than one value. + /// Specify `EMAIL` if email will be used to send the welcome message. Specify `SMS` if the phone number will be used. The default value is `SMS` . You can specify more than one value. /// public InputList DesiredDeliveryMediums { @@ -189,7 +189,7 @@ public InputList DesiredDeliveryMediums /// /// This parameter is used only if the `phone_number_verified` or `email_verified` attribute is set to `True` . Otherwise, it is ignored. /// - /// If this parameter is set to `True` and the phone number or email address specified in the UserAttributes parameter already exists as an alias with a different user, the API call will migrate the alias from the previous user to the newly created user. The previous user will no longer be able to log in using that alias. + /// If this parameter is set to `True` and the phone number or email address specified in the `UserAttributes` parameter already exists as an alias with a different user, this request migrates the alias from the previous user to the newly-created user. The previous user will no longer be able to log in using that alias. /// /// If this parameter is set to `False` , the API throws an `AliasExistsException` error if the alias already exists. The default value is `False` . /// @@ -197,7 +197,7 @@ public InputList DesiredDeliveryMediums public Input? ForceAliasCreation { get; set; } /// - /// Set to `RESEND` to resend the invitation message to a user that already exists and reset the expiration limit on the user's account. Set to `SUPPRESS` to suppress sending the message. You can specify only one value. + /// Set to `RESEND` to resend the invitation message to a user that already exists, and to reset the temporary-password duration with a new temporary password. Set to `SUPPRESS` to suppress sending the message. You can specify only one value. /// [Input("messageAction")] public Input? MessageAction { get; set; } @@ -226,7 +226,7 @@ public InputList UserAttributes } /// - /// The user pool ID for the user pool where the user will be created. + /// The ID of the user pool where you want to create a user. /// [Input("userPoolId", required: true)] public Input UserPoolId { get; set; } = null!; diff --git a/sdk/dotnet/Cognito/UserPoolUserToGroupAttachment.cs b/sdk/dotnet/Cognito/UserPoolUserToGroupAttachment.cs index 8aad542948..4112a2e2b9 100644 --- a/sdk/dotnet/Cognito/UserPoolUserToGroupAttachment.cs +++ b/sdk/dotnet/Cognito/UserPoolUserToGroupAttachment.cs @@ -22,7 +22,7 @@ public partial class UserPoolUserToGroupAttachment : global::Pulumi.CustomResour public Output GroupName { get; private set; } = null!; /// - /// The user pool ID for the user pool. + /// The ID of the user pool that contains the group that you want to add the user to. /// [Output("userPoolId")] public Output UserPoolId { get; private set; } = null!; @@ -91,7 +91,7 @@ public sealed class UserPoolUserToGroupAttachmentArgs : global::Pulumi.ResourceA public Input GroupName { get; set; } = null!; /// - /// The user pool ID for the user pool. + /// The ID of the user pool that contains the group that you want to add the user to. /// [Input("userPoolId", required: true)] public Input UserPoolId { get; set; } = null!; diff --git a/sdk/dotnet/Connect/GetTaskTemplate.cs b/sdk/dotnet/Connect/GetTaskTemplate.cs index 32142284ef..7811319099 100644 --- a/sdk/dotnet/Connect/GetTaskTemplate.cs +++ b/sdk/dotnet/Connect/GetTaskTemplate.cs @@ -94,6 +94,10 @@ public sealed class GetTaskTemplateResult /// public readonly string? Name; /// + /// The identifier of the contact flow. + /// + public readonly string? SelfAssignContactFlowArn; + /// /// The status of the task template. /// public readonly Pulumi.AwsNative.Connect.TaskTemplateStatus? Status; @@ -122,6 +126,8 @@ private GetTaskTemplateResult( string? name, + string? selfAssignContactFlowArn, + Pulumi.AwsNative.Connect.TaskTemplateStatus? status, ImmutableArray tags) @@ -135,6 +141,7 @@ private GetTaskTemplateResult( Fields = fields; InstanceArn = instanceArn; Name = name; + SelfAssignContactFlowArn = selfAssignContactFlowArn; Status = status; Tags = tags; } diff --git a/sdk/dotnet/Connect/TaskTemplate.cs b/sdk/dotnet/Connect/TaskTemplate.cs index b839e7202d..87e4f1f999 100644 --- a/sdk/dotnet/Connect/TaskTemplate.cs +++ b/sdk/dotnet/Connect/TaskTemplate.cs @@ -69,6 +69,12 @@ public partial class TaskTemplate : global::Pulumi.CustomResource [Output("name")] public Output Name { get; private set; } = null!; + /// + /// The identifier of the contact flow. + /// + [Output("selfAssignContactFlowArn")] + public Output SelfAssignContactFlowArn { get; private set; } = null!; + /// /// The status of the task template. /// @@ -186,6 +192,12 @@ public InputList Fields [Input("name")] public Input? Name { get; set; } + /// + /// The identifier of the contact flow. + /// + [Input("selfAssignContactFlowArn")] + public Input? SelfAssignContactFlowArn { get; set; } + /// /// The status of the task template. /// diff --git a/sdk/dotnet/DynamoDb/Table.cs b/sdk/dotnet/DynamoDb/Table.cs index 1cc9821822..d0647d32b6 100644 --- a/sdk/dotnet/DynamoDb/Table.cs +++ b/sdk/dotnet/DynamoDb/Table.cs @@ -376,8 +376,8 @@ public partial class Table : global::Pulumi.CustomResource public Output> GlobalSecondaryIndexes { get; private set; } = null!; /// - /// Specifies the properties of data being imported from the S3 bucket source to the table. - /// 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. + /// Specifies the properties of data being imported from the S3 bucket source to the" table. + /// 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. /// [Output("importSourceSpecification")] public Output ImportSourceSpecification { get; private set; } = null!; @@ -584,8 +584,8 @@ public InputList GlobalSecondaryIndexes } /// - /// Specifies the properties of data being imported from the S3 bucket source to the table. - /// 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. + /// Specifies the properties of data being imported from the S3 bucket source to the" table. + /// 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. /// [Input("importSourceSpecification")] public Input? ImportSourceSpecification { get; set; } diff --git a/sdk/dotnet/Ec2/Inputs/LaunchTemplateBaselinePerformanceFactorsArgs.cs b/sdk/dotnet/Ec2/Inputs/LaunchTemplateBaselinePerformanceFactorsArgs.cs index bbaa97b5b1..349e0ac36d 100644 --- a/sdk/dotnet/Ec2/Inputs/LaunchTemplateBaselinePerformanceFactorsArgs.cs +++ b/sdk/dotnet/Ec2/Inputs/LaunchTemplateBaselinePerformanceFactorsArgs.cs @@ -10,10 +10,6 @@ namespace Pulumi.AwsNative.Ec2.Inputs { - /// - /// The baseline performance to consider, using an instance family as a baseline reference. The instance family establishes the lowest acceptable level of performance. Amazon EC2 uses this baseline to guide instance type selection, but there is no guarantee that the selected instance types will always exceed the baseline for every application. - /// Currently, this parameter only supports CPU performance as a baseline performance factor. For example, specifying ``c6i`` would use the CPU performance of the ``c6i`` family as the baseline reference. - /// public sealed class LaunchTemplateBaselinePerformanceFactorsArgs : global::Pulumi.ResourceArgs { /// diff --git a/sdk/dotnet/Ec2/Inputs/LaunchTemplateCapacityReservationSpecificationArgs.cs b/sdk/dotnet/Ec2/Inputs/LaunchTemplateCapacityReservationSpecificationArgs.cs index 9fc6816d0f..123f5bcaf9 100644 --- a/sdk/dotnet/Ec2/Inputs/LaunchTemplateCapacityReservationSpecificationArgs.cs +++ b/sdk/dotnet/Ec2/Inputs/LaunchTemplateCapacityReservationSpecificationArgs.cs @@ -18,8 +18,7 @@ public sealed class LaunchTemplateCapacityReservationSpecificationArgs : global: { /// /// Indicates the instance's Capacity Reservation preferences. Possible preferences include: - /// + ``capacity-reservations-only`` - The instance will only run in a Capacity Reservation or Capacity Reservation group. If capacity isn't available, the instance will fail to launch. - /// + ``open`` - The instance can run in any ``open`` Capacity Reservation that has matching attributes (instance type, platform, Availability Zone, tenancy). + /// + ``open`` - The instance can run in any ``open`` Capacity Reservation that has matching attributes (instance type, platform, Availability Zone). /// + ``none`` - The instance avoids running in a Capacity Reservation even if one is available. The instance runs in On-Demand capacity. /// [Input("capacityReservationPreference")] diff --git a/sdk/dotnet/Ec2/Inputs/LaunchTemplateDataArgs.cs b/sdk/dotnet/Ec2/Inputs/LaunchTemplateDataArgs.cs index 8647362ad4..723e3d65e3 100644 --- a/sdk/dotnet/Ec2/Inputs/LaunchTemplateDataArgs.cs +++ b/sdk/dotnet/Ec2/Inputs/LaunchTemplateDataArgs.cs @@ -81,8 +81,7 @@ public InputList ElasticGpuSpe private InputList? _elasticInferenceAccelerators; /// - /// Amazon Elastic Inference is no longer available. - /// An elastic inference accelerator to associate with the instance. Elastic inference accelerators are a resource you can attach to your Amazon EC2 instances to accelerate your Deep Learning (DL) inference workloads. + /// An elastic inference accelerator to associate with the instance. Elastic inference accelerators are a resource you can attach to your Amazon EC2 instances to accelerate your Deep Learning (DL) inference workloads. /// You cannot specify accelerators from different generations in the same request. /// Starting April 15, 2023, AWS will not onboard new customers to Amazon Elastic Inference (EI), and will help current customers migrate their workloads to options that offer better price and performance. After April 15, 2023, new customers will not be able to launch instances with Amazon EI accelerators in Amazon SageMaker, Amazon ECS, or Amazon EC2. However, customers who have used Amazon EI at least once during the past 30-day period are considered current customers and will be able to continue using the service. /// @@ -147,7 +146,7 @@ public InputList ElasticIn /// /// If you specify ``InstanceRequirements``, you can't specify ``InstanceType``. /// Attribute-based instance type selection is only supported when using Auto Scaling groups, EC2 Fleet, and Spot Fleet to launch instances. If you plan to use the launch template in the [launch instance wizard](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ec2-launch-instance-wizard.html), or with the [RunInstances](https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_RunInstances.html) API or [AWS::EC2::Instance](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-instance.html) AWS CloudFormation resource, you can't specify ``InstanceRequirements``. - /// For more information, see [Specify attributes for instance type selection for EC2 Fleet or Spot Fleet](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ec2-fleet-attribute-based-instance-type-selection.html) and [Spot placement score](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/spot-placement-score.html) in the *Amazon EC2 User Guide*. + /// For more information, see [Attribute-based instance type selection for EC2 Fleet](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ec2-fleet-attribute-based-instance-type-selection.html), [Attribute-based instance type selection for Spot Fleet](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/spot-fleet-attribute-based-instance-type-selection.html), and [Spot placement score](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/spot-placement-score.html) in the *Amazon EC2 User Guide*. /// [Input("instanceRequirements")] public Input? InstanceRequirements { get; set; } @@ -215,9 +214,6 @@ public InputList NetworkInterfaces set => _networkInterfaces = value; } - [Input("networkPerformanceOptions")] - public Input? NetworkPerformanceOptions { get; set; } - /// /// The placement for the instance. /// @@ -267,7 +263,8 @@ public InputList SecurityGroups private InputList? _tagSpecifications; /// - /// The tags to apply to resources that are created during instance launch. + /// The tags to apply to the resources that are created during instance launch. + /// To tag a resource after it has been created, see [CreateTags](https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_CreateTags.html). /// To tag the launch template itself, use [TagSpecifications](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-launchtemplate.html#cfn-ec2-launchtemplate-tagspecifications). /// public InputList TagSpecifications diff --git a/sdk/dotnet/Ec2/Inputs/LaunchTemplateEbsArgs.cs b/sdk/dotnet/Ec2/Inputs/LaunchTemplateEbsArgs.cs index 81e0ef7f9a..0c2790b37d 100644 --- a/sdk/dotnet/Ec2/Inputs/LaunchTemplateEbsArgs.cs +++ b/sdk/dotnet/Ec2/Inputs/LaunchTemplateEbsArgs.cs @@ -42,7 +42,7 @@ public sealed class LaunchTemplateEbsArgs : global::Pulumi.ResourceArgs public Input? Iops { get; set; } /// - /// Identifier (key ID, key alias, key ARN, or alias ARN) of the customer managed KMS key to use for EBS encryption. + /// The ARN of the symmetric KMSlong (KMS) CMK used for encryption. /// [Input("kmsKeyId")] public Input? KmsKeyId { get; set; } diff --git a/sdk/dotnet/Ec2/Inputs/LaunchTemplateInstanceRequirementsArgs.cs b/sdk/dotnet/Ec2/Inputs/LaunchTemplateInstanceRequirementsArgs.cs index 0668560606..78ef563352 100644 --- a/sdk/dotnet/Ec2/Inputs/LaunchTemplateInstanceRequirementsArgs.cs +++ b/sdk/dotnet/Ec2/Inputs/LaunchTemplateInstanceRequirementsArgs.cs @@ -20,7 +20,7 @@ namespace Pulumi.AwsNative.Ec2.Inputs /// /// If you specify ``InstanceRequirements``, you can't specify ``InstanceType``. /// Attribute-based instance type selection is only supported when using Auto Scaling groups, EC2 Fleet, and Spot Fleet to launch instances. If you plan to use the launch template in the [launch instance wizard](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ec2-launch-instance-wizard.html), or with the [RunInstances](https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_RunInstances.html) API or [AWS::EC2::Instance](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-instance.html) AWS CloudFormation resource, you can't specify ``InstanceRequirements``. - /// For more information, see [Specify attributes for instance type selection for EC2 Fleet or Spot Fleet](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ec2-fleet-attribute-based-instance-type-selection.html) and [Spot placement score](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/spot-placement-score.html) in the *Amazon EC2 User Guide*. + /// For more information, see [Attribute-based instance type selection for EC2 Fleet](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ec2-fleet-attribute-based-instance-type-selection.html), [Attribute-based instance type selection for Spot Fleet](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/spot-fleet-attribute-based-instance-type-selection.html), and [Spot placement score](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/spot-placement-score.html) in the *Amazon EC2 User Guide*. /// public sealed class LaunchTemplateInstanceRequirementsArgs : global::Pulumi.ResourceArgs { @@ -91,6 +91,7 @@ public InputList AcceleratorNames /// The accelerator types that must be on the instance type. /// + For instance types with GPU accelerators, specify ``gpu``. /// + For instance types with FPGA accelerators, specify ``fpga``. + /// + For instance types with inference accelerators, specify ``inference``. /// /// Default: Any accelerator type /// @@ -135,7 +136,7 @@ public InputList AllowedInstanceTypes public Input? BaselineEbsBandwidthMbps { get; set; } /// - /// The baseline performance to consider, using an instance family as a baseline reference. The instance family establishes the lowest acceptable level of performance. Amazon EC2 uses this baseline to guide instance type selection, but there is no guarantee that the selected instance types will always exceed the baseline for every application. Currently, this parameter only supports CPU performance as a baseline performance factor. For more information, see [Performance protection](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ec2-fleet-attribute-based-instance-type-selection.html#ec2fleet-abis-performance-protection) in the *Amazon EC2 User Guide*. + /// The baseline performance to consider, using an instance family as a baseline reference. The instance family establishes the lowest acceptable level of performance. Amazon EC2 uses this baseline to guide instance type selection, but there is no guarantee that the selected instance types will always exceed the baseline for every application. Currently, this parameter only supports CPU performance as a baseline performance factor. For more information, see [Performance protection](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ec2-fleet-attribute-based-instance-type-selection.html#ec2fleet-abis-performance-protection) in the *Amazon EC2 User Guide* . /// [Input("baselinePerformanceFactors")] public Input? BaselinePerformanceFactors { get; set; } @@ -159,7 +160,6 @@ public InputList AllowedInstanceTypes /// + For instance types with Intel CPUs, specify ``intel``. /// + For instance types with AMD CPUs, specify ``amd``. /// + For instance types with AWS CPUs, specify ``amazon-web-services``. - /// + For instance types with Apple CPUs, specify ``apple``. /// /// Don't confuse the CPU manufacturer with the CPU architecture. Instances will be launched with a compatible CPU architecture based on the Amazon Machine Image (AMI) that you specify in your launch template. /// Default: Any manufacturer diff --git a/sdk/dotnet/Ec2/Inputs/LaunchTemplateNetworkInterfaceArgs.cs b/sdk/dotnet/Ec2/Inputs/LaunchTemplateNetworkInterfaceArgs.cs index 595cb6881f..c7b209eca7 100644 --- a/sdk/dotnet/Ec2/Inputs/LaunchTemplateNetworkInterfaceArgs.cs +++ b/sdk/dotnet/Ec2/Inputs/LaunchTemplateNetworkInterfaceArgs.cs @@ -73,10 +73,9 @@ public InputList Groups } /// - /// The type of network interface. To create an Elastic Fabric Adapter (EFA), specify ``efa`` or ``efa``. For more information, see [Elastic Fabric Adapter](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/efa.html) in the *Amazon EC2 User Guide*. + /// The type of network interface. To create an Elastic Fabric Adapter (EFA), specify ``efa``. For more information, see [Elastic Fabric Adapter](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/efa.html) in the *Amazon EC2 User Guide*. /// If you are not creating an EFA, specify ``interface`` or omit this parameter. - /// If you specify ``efa-only``, do not assign any IP addresses to the network interface. EFA-only network interfaces do not support IP addresses. - /// Valid values: ``interface`` | ``efa`` | ``efa-only`` + /// Valid values: ``interface`` | ``efa`` /// [Input("interfaceType")] public Input? InterfaceType { get; set; } diff --git a/sdk/dotnet/Ec2/Inputs/LaunchTemplateReferenceArgs.cs b/sdk/dotnet/Ec2/Inputs/LaunchTemplateReferenceArgs.cs index 735df11021..0f34b579a6 100644 --- a/sdk/dotnet/Ec2/Inputs/LaunchTemplateReferenceArgs.cs +++ b/sdk/dotnet/Ec2/Inputs/LaunchTemplateReferenceArgs.cs @@ -12,6 +12,9 @@ namespace Pulumi.AwsNative.Ec2.Inputs public sealed class LaunchTemplateReferenceArgs : global::Pulumi.ResourceArgs { + /// + /// The instance family to refer. Ensure that you specify the correct family name. For example, C6i and C6g are valid values, but C6 is not. + /// [Input("instanceFamily")] public Input? InstanceFamily { get; set; } diff --git a/sdk/dotnet/Ec2/Inputs/LaunchTemplateTagSpecificationArgs.cs b/sdk/dotnet/Ec2/Inputs/LaunchTemplateTagSpecificationArgs.cs index f7aca51ace..bf88a7d1eb 100644 --- a/sdk/dotnet/Ec2/Inputs/LaunchTemplateTagSpecificationArgs.cs +++ b/sdk/dotnet/Ec2/Inputs/LaunchTemplateTagSpecificationArgs.cs @@ -12,7 +12,6 @@ namespace Pulumi.AwsNative.Ec2.Inputs /// /// Specifies the tags to apply to the launch template during creation. - /// To specify the tags for the resources that are created during instance launch, use [AWS::EC2::LaunchTemplate TagSpecification](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-launchtemplate-tagspecification.html). /// ``LaunchTemplateTagSpecification`` is a property of [AWS::EC2::LaunchTemplate](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-launchtemplate.html). /// public sealed class LaunchTemplateTagSpecificationArgs : global::Pulumi.ResourceArgs diff --git a/sdk/dotnet/Ec2/Inputs/SpotFleetInstanceNetworkInterfaceSpecificationArgs.cs b/sdk/dotnet/Ec2/Inputs/SpotFleetInstanceNetworkInterfaceSpecificationArgs.cs index a67022e6de..48bdf33742 100644 --- a/sdk/dotnet/Ec2/Inputs/SpotFleetInstanceNetworkInterfaceSpecificationArgs.cs +++ b/sdk/dotnet/Ec2/Inputs/SpotFleetInstanceNetworkInterfaceSpecificationArgs.cs @@ -91,7 +91,7 @@ public InputList PrivateIpAdd } /// - /// The number of secondary private IPv4 addresses. You can't specify this option and specify more than one private IP address using the private IP addresses option. You cannot specify this option if you're launching more than one instance in a [RunInstances](https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_RunInstances.html) request. + /// The number of secondary private IPv4 addresses. You can’t specify this parameter and also specify a secondary private IP address using the `PrivateIpAddress` parameter. /// [Input("secondaryPrivateIpAddressCount")] public Input? SecondaryPrivateIpAddressCount { get; set; } diff --git a/sdk/dotnet/Ec2/Inputs/TagSpecificationArgs.cs b/sdk/dotnet/Ec2/Inputs/TagSpecificationArgs.cs index d8f23f92e6..de30167450 100644 --- a/sdk/dotnet/Ec2/Inputs/TagSpecificationArgs.cs +++ b/sdk/dotnet/Ec2/Inputs/TagSpecificationArgs.cs @@ -11,7 +11,7 @@ namespace Pulumi.AwsNative.Ec2.Inputs { /// - /// Specifies the tags to apply to resources that are created during instance launch. + /// Specifies the tags to apply to a resource when the resource is created for the launch template. /// ``TagSpecification`` is a property type of [TagSpecifications](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-launchtemplate-launchtemplatedata.html#cfn-ec2-launchtemplate-launchtemplatedata-tagspecifications). [TagSpecifications](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-launchtemplate-launchtemplatedata.html#cfn-ec2-launchtemplate-launchtemplatedata-tagspecifications) is a property of [AWS::EC2::LaunchTemplate LaunchTemplateData](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-launchtemplate-launchtemplatedata.html). /// public sealed class TagSpecificationArgs : global::Pulumi.ResourceArgs diff --git a/sdk/dotnet/Ec2/LaunchTemplate.cs b/sdk/dotnet/Ec2/LaunchTemplate.cs index 912b957f67..127684e336 100644 --- a/sdk/dotnet/Ec2/LaunchTemplate.cs +++ b/sdk/dotnet/Ec2/LaunchTemplate.cs @@ -55,7 +55,7 @@ public partial class LaunchTemplate : global::Pulumi.CustomResource /// /// The tags to apply to the launch template on creation. To tag the launch template, the resource type must be ``launch-template``. - /// To specify the tags for resources that are created during instance launch, use [TagSpecifications](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-launchtemplate-launchtemplatedata.html#cfn-ec2-launchtemplate-launchtemplatedata-tagspecifications). + /// To specify the tags for the resources that are created when an instance is launched, you must use [TagSpecifications](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-launchtemplate-launchtemplatedata.html#cfn-ec2-launchtemplate-launchtemplatedata-tagspecifications). /// [Output("tagSpecifications")] public Output> TagSpecifications { get; private set; } = null!; @@ -132,7 +132,7 @@ public sealed class LaunchTemplateArgs : global::Pulumi.ResourceArgs /// /// The tags to apply to the launch template on creation. To tag the launch template, the resource type must be ``launch-template``. - /// To specify the tags for resources that are created during instance launch, use [TagSpecifications](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-launchtemplate-launchtemplatedata.html#cfn-ec2-launchtemplate-launchtemplatedata-tagspecifications). + /// To specify the tags for the resources that are created when an instance is launched, you must use [TagSpecifications](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-launchtemplate-launchtemplatedata.html#cfn-ec2-launchtemplate-launchtemplatedata-tagspecifications). /// public InputList TagSpecifications { diff --git a/sdk/dotnet/Ec2/Outputs/LaunchTemplateBaselinePerformanceFactors.cs b/sdk/dotnet/Ec2/Outputs/LaunchTemplateBaselinePerformanceFactors.cs index a848e87d0a..885d937c2b 100644 --- a/sdk/dotnet/Ec2/Outputs/LaunchTemplateBaselinePerformanceFactors.cs +++ b/sdk/dotnet/Ec2/Outputs/LaunchTemplateBaselinePerformanceFactors.cs @@ -10,10 +10,6 @@ namespace Pulumi.AwsNative.Ec2.Outputs { - /// - /// The baseline performance to consider, using an instance family as a baseline reference. The instance family establishes the lowest acceptable level of performance. Amazon EC2 uses this baseline to guide instance type selection, but there is no guarantee that the selected instance types will always exceed the baseline for every application. - /// Currently, this parameter only supports CPU performance as a baseline performance factor. For example, specifying ``c6i`` would use the CPU performance of the ``c6i`` family as the baseline reference. - /// [OutputType] public sealed class LaunchTemplateBaselinePerformanceFactors { diff --git a/sdk/dotnet/Ec2/Outputs/LaunchTemplateCapacityReservationSpecification.cs b/sdk/dotnet/Ec2/Outputs/LaunchTemplateCapacityReservationSpecification.cs index 54d23c84eb..26be4377ae 100644 --- a/sdk/dotnet/Ec2/Outputs/LaunchTemplateCapacityReservationSpecification.cs +++ b/sdk/dotnet/Ec2/Outputs/LaunchTemplateCapacityReservationSpecification.cs @@ -19,8 +19,7 @@ public sealed class LaunchTemplateCapacityReservationSpecification { /// /// Indicates the instance's Capacity Reservation preferences. Possible preferences include: - /// + ``capacity-reservations-only`` - The instance will only run in a Capacity Reservation or Capacity Reservation group. If capacity isn't available, the instance will fail to launch. - /// + ``open`` - The instance can run in any ``open`` Capacity Reservation that has matching attributes (instance type, platform, Availability Zone, tenancy). + /// + ``open`` - The instance can run in any ``open`` Capacity Reservation that has matching attributes (instance type, platform, Availability Zone). /// + ``none`` - The instance avoids running in a Capacity Reservation even if one is available. The instance runs in On-Demand capacity. /// public readonly string? CapacityReservationPreference; diff --git a/sdk/dotnet/Ec2/Outputs/LaunchTemplateData.cs b/sdk/dotnet/Ec2/Outputs/LaunchTemplateData.cs index 55a8304aad..04fae631d0 100644 --- a/sdk/dotnet/Ec2/Outputs/LaunchTemplateData.cs +++ b/sdk/dotnet/Ec2/Outputs/LaunchTemplateData.cs @@ -51,8 +51,7 @@ public sealed class LaunchTemplateData /// public readonly ImmutableArray ElasticGpuSpecifications; /// - /// Amazon Elastic Inference is no longer available. - /// An elastic inference accelerator to associate with the instance. Elastic inference accelerators are a resource you can attach to your Amazon EC2 instances to accelerate your Deep Learning (DL) inference workloads. + /// An elastic inference accelerator to associate with the instance. Elastic inference accelerators are a resource you can attach to your Amazon EC2 instances to accelerate your Deep Learning (DL) inference workloads. /// You cannot specify accelerators from different generations in the same request. /// Starting April 15, 2023, AWS will not onboard new customers to Amazon Elastic Inference (EI), and will help current customers migrate their workloads to options that offer better price and performance. After April 15, 2023, new customers will not be able to launch instances with Amazon EI accelerators in Amazon SageMaker, Amazon ECS, or Amazon EC2. However, customers who have used Amazon EI at least once during the past 30-day period are considered current customers and will be able to continue using the service. /// @@ -100,7 +99,7 @@ public sealed class LaunchTemplateData /// /// If you specify ``InstanceRequirements``, you can't specify ``InstanceType``. /// Attribute-based instance type selection is only supported when using Auto Scaling groups, EC2 Fleet, and Spot Fleet to launch instances. If you plan to use the launch template in the [launch instance wizard](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ec2-launch-instance-wizard.html), or with the [RunInstances](https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_RunInstances.html) API or [AWS::EC2::Instance](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-instance.html) AWS CloudFormation resource, you can't specify ``InstanceRequirements``. - /// For more information, see [Specify attributes for instance type selection for EC2 Fleet or Spot Fleet](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ec2-fleet-attribute-based-instance-type-selection.html) and [Spot placement score](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/spot-placement-score.html) in the *Amazon EC2 User Guide*. + /// For more information, see [Attribute-based instance type selection for EC2 Fleet](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ec2-fleet-attribute-based-instance-type-selection.html), [Attribute-based instance type selection for Spot Fleet](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/spot-fleet-attribute-based-instance-type-selection.html), and [Spot placement score](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/spot-placement-score.html) in the *Amazon EC2 User Guide*. /// public readonly Outputs.LaunchTemplateInstanceRequirements? InstanceRequirements; /// @@ -138,7 +137,6 @@ public sealed class LaunchTemplateData /// The network interfaces for the instance. /// public readonly ImmutableArray NetworkInterfaces; - public readonly object? NetworkPerformanceOptions; /// /// The placement for the instance. /// @@ -163,7 +161,8 @@ public sealed class LaunchTemplateData /// public readonly ImmutableArray SecurityGroups; /// - /// The tags to apply to resources that are created during instance launch. + /// The tags to apply to the resources that are created during instance launch. + /// To tag a resource after it has been created, see [CreateTags](https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_CreateTags.html). /// To tag the launch template itself, use [TagSpecifications](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-launchtemplate.html#cfn-ec2-launchtemplate-tagspecifications). /// public readonly ImmutableArray TagSpecifications; @@ -223,8 +222,6 @@ private LaunchTemplateData( ImmutableArray networkInterfaces, - object? networkPerformanceOptions, - Outputs.LaunchTemplatePlacement? placement, Outputs.LaunchTemplatePrivateDnsNameOptions? privateDnsNameOptions, @@ -263,7 +260,6 @@ private LaunchTemplateData( MetadataOptions = metadataOptions; Monitoring = monitoring; NetworkInterfaces = networkInterfaces; - NetworkPerformanceOptions = networkPerformanceOptions; Placement = placement; PrivateDnsNameOptions = privateDnsNameOptions; RamDiskId = ramDiskId; diff --git a/sdk/dotnet/Ec2/Outputs/LaunchTemplateEbs.cs b/sdk/dotnet/Ec2/Outputs/LaunchTemplateEbs.cs index b19589e051..cbb5c074c7 100644 --- a/sdk/dotnet/Ec2/Outputs/LaunchTemplateEbs.cs +++ b/sdk/dotnet/Ec2/Outputs/LaunchTemplateEbs.cs @@ -37,7 +37,7 @@ public sealed class LaunchTemplateEbs /// public readonly int? Iops; /// - /// Identifier (key ID, key alias, key ARN, or alias ARN) of the customer managed KMS key to use for EBS encryption. + /// The ARN of the symmetric KMSlong (KMS) CMK used for encryption. /// public readonly string? KmsKeyId; /// diff --git a/sdk/dotnet/Ec2/Outputs/LaunchTemplateInstanceRequirements.cs b/sdk/dotnet/Ec2/Outputs/LaunchTemplateInstanceRequirements.cs index befa41313f..73e24602a7 100644 --- a/sdk/dotnet/Ec2/Outputs/LaunchTemplateInstanceRequirements.cs +++ b/sdk/dotnet/Ec2/Outputs/LaunchTemplateInstanceRequirements.cs @@ -20,7 +20,7 @@ namespace Pulumi.AwsNative.Ec2.Outputs /// /// If you specify ``InstanceRequirements``, you can't specify ``InstanceType``. /// Attribute-based instance type selection is only supported when using Auto Scaling groups, EC2 Fleet, and Spot Fleet to launch instances. If you plan to use the launch template in the [launch instance wizard](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ec2-launch-instance-wizard.html), or with the [RunInstances](https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_RunInstances.html) API or [AWS::EC2::Instance](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-instance.html) AWS CloudFormation resource, you can't specify ``InstanceRequirements``. - /// For more information, see [Specify attributes for instance type selection for EC2 Fleet or Spot Fleet](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ec2-fleet-attribute-based-instance-type-selection.html) and [Spot placement score](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/spot-placement-score.html) in the *Amazon EC2 User Guide*. + /// For more information, see [Attribute-based instance type selection for EC2 Fleet](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ec2-fleet-attribute-based-instance-type-selection.html), [Attribute-based instance type selection for Spot Fleet](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/spot-fleet-attribute-based-instance-type-selection.html), and [Spot placement score](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/spot-placement-score.html) in the *Amazon EC2 User Guide*. /// [OutputType] public sealed class LaunchTemplateInstanceRequirements @@ -69,6 +69,7 @@ public sealed class LaunchTemplateInstanceRequirements /// The accelerator types that must be on the instance type. /// + For instance types with GPU accelerators, specify ``gpu``. /// + For instance types with FPGA accelerators, specify ``fpga``. + /// + For instance types with inference accelerators, specify ``inference``. /// /// Default: Any accelerator type /// @@ -96,7 +97,7 @@ public sealed class LaunchTemplateInstanceRequirements /// public readonly Outputs.LaunchTemplateBaselineEbsBandwidthMbps? BaselineEbsBandwidthMbps; /// - /// The baseline performance to consider, using an instance family as a baseline reference. The instance family establishes the lowest acceptable level of performance. Amazon EC2 uses this baseline to guide instance type selection, but there is no guarantee that the selected instance types will always exceed the baseline for every application. Currently, this parameter only supports CPU performance as a baseline performance factor. For more information, see [Performance protection](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ec2-fleet-attribute-based-instance-type-selection.html#ec2fleet-abis-performance-protection) in the *Amazon EC2 User Guide*. + /// The baseline performance to consider, using an instance family as a baseline reference. The instance family establishes the lowest acceptable level of performance. Amazon EC2 uses this baseline to guide instance type selection, but there is no guarantee that the selected instance types will always exceed the baseline for every application. Currently, this parameter only supports CPU performance as a baseline performance factor. For more information, see [Performance protection](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ec2-fleet-attribute-based-instance-type-selection.html#ec2fleet-abis-performance-protection) in the *Amazon EC2 User Guide* . /// public readonly Outputs.LaunchTemplateBaselinePerformanceFactors? BaselinePerformanceFactors; /// @@ -113,7 +114,6 @@ public sealed class LaunchTemplateInstanceRequirements /// + For instance types with Intel CPUs, specify ``intel``. /// + For instance types with AMD CPUs, specify ``amd``. /// + For instance types with AWS CPUs, specify ``amazon-web-services``. - /// + For instance types with Apple CPUs, specify ``apple``. /// /// Don't confuse the CPU manufacturer with the CPU architecture. Instances will be launched with a compatible CPU architecture based on the Amazon Machine Image (AMI) that you specify in your launch template. /// Default: Any manufacturer diff --git a/sdk/dotnet/Ec2/Outputs/LaunchTemplateNetworkInterface.cs b/sdk/dotnet/Ec2/Outputs/LaunchTemplateNetworkInterface.cs index a47f0467e5..114940fd31 100644 --- a/sdk/dotnet/Ec2/Outputs/LaunchTemplateNetworkInterface.cs +++ b/sdk/dotnet/Ec2/Outputs/LaunchTemplateNetworkInterface.cs @@ -52,10 +52,9 @@ public sealed class LaunchTemplateNetworkInterface /// public readonly ImmutableArray Groups; /// - /// The type of network interface. To create an Elastic Fabric Adapter (EFA), specify ``efa`` or ``efa``. For more information, see [Elastic Fabric Adapter](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/efa.html) in the *Amazon EC2 User Guide*. + /// The type of network interface. To create an Elastic Fabric Adapter (EFA), specify ``efa``. For more information, see [Elastic Fabric Adapter](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/efa.html) in the *Amazon EC2 User Guide*. /// If you are not creating an EFA, specify ``interface`` or omit this parameter. - /// If you specify ``efa-only``, do not assign any IP addresses to the network interface. EFA-only network interfaces do not support IP addresses. - /// Valid values: ``interface`` | ``efa`` | ``efa-only`` + /// Valid values: ``interface`` | ``efa`` /// public readonly string? InterfaceType; /// diff --git a/sdk/dotnet/Ec2/Outputs/LaunchTemplateReference.cs b/sdk/dotnet/Ec2/Outputs/LaunchTemplateReference.cs index 20f7aeff5a..057becbcb8 100644 --- a/sdk/dotnet/Ec2/Outputs/LaunchTemplateReference.cs +++ b/sdk/dotnet/Ec2/Outputs/LaunchTemplateReference.cs @@ -13,6 +13,9 @@ namespace Pulumi.AwsNative.Ec2.Outputs [OutputType] public sealed class LaunchTemplateReference { + /// + /// The instance family to refer. Ensure that you specify the correct family name. For example, C6i and C6g are valid values, but C6 is not. + /// public readonly string? InstanceFamily; [OutputConstructor] diff --git a/sdk/dotnet/Ec2/Outputs/LaunchTemplateTagSpecification.cs b/sdk/dotnet/Ec2/Outputs/LaunchTemplateTagSpecification.cs index c1244679d8..ae0d3f4adf 100644 --- a/sdk/dotnet/Ec2/Outputs/LaunchTemplateTagSpecification.cs +++ b/sdk/dotnet/Ec2/Outputs/LaunchTemplateTagSpecification.cs @@ -12,7 +12,6 @@ namespace Pulumi.AwsNative.Ec2.Outputs /// /// Specifies the tags to apply to the launch template during creation. - /// To specify the tags for the resources that are created during instance launch, use [AWS::EC2::LaunchTemplate TagSpecification](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-launchtemplate-tagspecification.html). /// ``LaunchTemplateTagSpecification`` is a property of [AWS::EC2::LaunchTemplate](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-launchtemplate.html). /// [OutputType] diff --git a/sdk/dotnet/Ec2/Outputs/SpotFleetInstanceNetworkInterfaceSpecification.cs b/sdk/dotnet/Ec2/Outputs/SpotFleetInstanceNetworkInterfaceSpecification.cs index 777e43a3be..4faeca5946 100644 --- a/sdk/dotnet/Ec2/Outputs/SpotFleetInstanceNetworkInterfaceSpecification.cs +++ b/sdk/dotnet/Ec2/Outputs/SpotFleetInstanceNetworkInterfaceSpecification.cs @@ -56,7 +56,7 @@ public sealed class SpotFleetInstanceNetworkInterfaceSpecification /// public readonly ImmutableArray PrivateIpAddresses; /// - /// The number of secondary private IPv4 addresses. You can't specify this option and specify more than one private IP address using the private IP addresses option. You cannot specify this option if you're launching more than one instance in a [RunInstances](https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_RunInstances.html) request. + /// The number of secondary private IPv4 addresses. You can’t specify this parameter and also specify a secondary private IP address using the `PrivateIpAddress` parameter. /// public readonly int? SecondaryPrivateIpAddressCount; /// diff --git a/sdk/dotnet/Ec2/Outputs/TagSpecification.cs b/sdk/dotnet/Ec2/Outputs/TagSpecification.cs index 88f2d76c36..2539fb61d0 100644 --- a/sdk/dotnet/Ec2/Outputs/TagSpecification.cs +++ b/sdk/dotnet/Ec2/Outputs/TagSpecification.cs @@ -11,7 +11,7 @@ namespace Pulumi.AwsNative.Ec2.Outputs { /// - /// Specifies the tags to apply to resources that are created during instance launch. + /// Specifies the tags to apply to a resource when the resource is created for the launch template. /// ``TagSpecification`` is a property type of [TagSpecifications](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-launchtemplate-launchtemplatedata.html#cfn-ec2-launchtemplate-launchtemplatedata-tagspecifications). [TagSpecifications](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-launchtemplate-launchtemplatedata.html#cfn-ec2-launchtemplate-launchtemplatedata-tagspecifications) is a property of [AWS::EC2::LaunchTemplate LaunchTemplateData](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-launchtemplate-launchtemplatedata.html). /// [OutputType] diff --git a/sdk/dotnet/Ecs/Enums.cs b/sdk/dotnet/Ecs/Enums.cs index 01cfc6c062..20c582a1a2 100644 --- a/sdk/dotnet/Ecs/Enums.cs +++ b/sdk/dotnet/Ecs/Enums.cs @@ -494,7 +494,7 @@ private TaskDefinitionAuthorizationConfigIam(string value) } /// - /// Specifies whether Amazon ECS will resolve the container image tag provided in the container definition to an image digest. By default, the value is `enabled` . If you set the value for a container as `disabled` , Amazon ECS will not resolve the provided container image tag to a digest and will use the original image URI specified in the container definition for deployment. For more information about container image resolution, see [Container image resolution](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/deployment-type-ecs.html#deployment-container-image-stability) in the *Amazon ECS Developer Guide* . + /// Specifies whether Amazon ECS will resolve the container image tag provided in the container definition to an image digest. By default, the value is ``enabled``. If you set the value for a container as ``disabled``, Amazon ECS will not resolve the provided container image tag to a digest and will use the original image URI specified in the container definition for deployment. For more information about container image resolution, see [Container image resolution](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/deployment-type-ecs.html#deployment-container-image-stability) in the *Amazon ECS Developer Guide*. /// [EnumType] public readonly struct TaskDefinitionContainerDefinitionVersionConsistency : IEquatable diff --git a/sdk/dotnet/Ecs/Inputs/TaskDefinitionContainerDefinitionArgs.cs b/sdk/dotnet/Ecs/Inputs/TaskDefinitionContainerDefinitionArgs.cs index 7e706273d5..b11f5fa69d 100644 --- a/sdk/dotnet/Ecs/Inputs/TaskDefinitionContainerDefinitionArgs.cs +++ b/sdk/dotnet/Ecs/Inputs/TaskDefinitionContainerDefinitionArgs.cs @@ -445,7 +445,7 @@ public InputList Ulimits public Input? User { get; set; } /// - /// Specifies whether Amazon ECS will resolve the container image tag provided in the container definition to an image digest. By default, the value is `enabled` . If you set the value for a container as `disabled` , Amazon ECS will not resolve the provided container image tag to a digest and will use the original image URI specified in the container definition for deployment. For more information about container image resolution, see [Container image resolution](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/deployment-type-ecs.html#deployment-container-image-stability) in the *Amazon ECS Developer Guide* . + /// Specifies whether Amazon ECS will resolve the container image tag provided in the container definition to an image digest. By default, the value is ``enabled``. If you set the value for a container as ``disabled``, Amazon ECS will not resolve the provided container image tag to a digest and will use the original image URI specified in the container definition for deployment. For more information about container image resolution, see [Container image resolution](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/deployment-type-ecs.html#deployment-container-image-stability) in the *Amazon ECS Developer Guide*. /// [Input("versionConsistency")] public Input? VersionConsistency { get; set; } diff --git a/sdk/dotnet/Ecs/Outputs/TaskDefinitionContainerDefinition.cs b/sdk/dotnet/Ecs/Outputs/TaskDefinitionContainerDefinition.cs index f1495dadaa..17608198c1 100644 --- a/sdk/dotnet/Ecs/Outputs/TaskDefinitionContainerDefinition.cs +++ b/sdk/dotnet/Ecs/Outputs/TaskDefinitionContainerDefinition.cs @@ -260,7 +260,7 @@ public sealed class TaskDefinitionContainerDefinition /// public readonly string? User; /// - /// Specifies whether Amazon ECS will resolve the container image tag provided in the container definition to an image digest. By default, the value is `enabled` . If you set the value for a container as `disabled` , Amazon ECS will not resolve the provided container image tag to a digest and will use the original image URI specified in the container definition for deployment. For more information about container image resolution, see [Container image resolution](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/deployment-type-ecs.html#deployment-container-image-stability) in the *Amazon ECS Developer Guide* . + /// Specifies whether Amazon ECS will resolve the container image tag provided in the container definition to an image digest. By default, the value is ``enabled``. If you set the value for a container as ``disabled``, Amazon ECS will not resolve the provided container image tag to a digest and will use the original image URI specified in the container definition for deployment. For more information about container image resolution, see [Container image resolution](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/deployment-type-ecs.html#deployment-container-image-stability) in the *Amazon ECS Developer Guide*. /// public readonly Pulumi.AwsNative.Ecs.TaskDefinitionContainerDefinitionVersionConsistency? VersionConsistency; /// diff --git a/sdk/dotnet/Ecs/TaskDefinition.cs b/sdk/dotnet/Ecs/TaskDefinition.cs index efdb36ee56..159d342e22 100644 --- a/sdk/dotnet/Ecs/TaskDefinition.cs +++ b/sdk/dotnet/Ecs/TaskDefinition.cs @@ -332,6 +332,9 @@ public partial class TaskDefinition : global::Pulumi.CustomResource [Output("cpu")] public Output Cpu { get; private set; } = null!; + [Output("enableFaultInjection")] + public Output EnableFaultInjection { get; private set; } = null!; + /// /// The ephemeral storage settings to use for tasks run with the task definition. /// @@ -498,6 +501,7 @@ private static CustomResourceOptions MakeResourceOptions(CustomResourceOptions? { "containerDefinitions[*]", "cpu", + "enableFaultInjection", "ephemeralStorage", "executionRoleArn", "family", @@ -564,6 +568,9 @@ public InputList ContainerDefiniti [Input("cpu")] public Input? Cpu { get; set; } + [Input("enableFaultInjection")] + public Input? EnableFaultInjection { get; set; } + /// /// The ephemeral storage settings to use for tasks run with the task definition. /// diff --git a/sdk/dotnet/Events/Inputs/ConnectionAuthParametersArgs.cs b/sdk/dotnet/Events/Inputs/ConnectionAuthParametersArgs.cs index 78dc86110d..5ff64779be 100644 --- a/sdk/dotnet/Events/Inputs/ConnectionAuthParametersArgs.cs +++ b/sdk/dotnet/Events/Inputs/ConnectionAuthParametersArgs.cs @@ -24,6 +24,11 @@ public sealed class ConnectionAuthParametersArgs : global::Pulumi.ResourceArgs [Input("basicAuthParameters")] public Input? BasicAuthParameters { get; set; } + /// + /// For private OAuth authentication endpoints. The parameters EventBridge uses to authenticate against the endpoint. + /// + /// For more information, see [Authorization methods for connections](https://docs.aws.amazon.com/eventbridge/latest/userguide/eb-target-connection-auth.html) in the **Amazon EventBridge User Guide** . + /// [Input("connectivityParameters")] public Input? ConnectivityParameters { get; set; } diff --git a/sdk/dotnet/Events/Inputs/ConnectionConnectivityParametersArgs.cs b/sdk/dotnet/Events/Inputs/ConnectionConnectivityParametersArgs.cs index 52e57eb71e..8890a2e524 100644 --- a/sdk/dotnet/Events/Inputs/ConnectionConnectivityParametersArgs.cs +++ b/sdk/dotnet/Events/Inputs/ConnectionConnectivityParametersArgs.cs @@ -12,6 +12,9 @@ namespace Pulumi.AwsNative.Events.Inputs public sealed class ConnectionConnectivityParametersArgs : global::Pulumi.ResourceArgs { + /// + /// The parameters for EventBridge to use when invoking the resource endpoint. + /// [Input("resourceParameters", required: true)] public Input ResourceParameters { get; set; } = null!; diff --git a/sdk/dotnet/Events/Inputs/ConnectionResourceParametersArgs.cs b/sdk/dotnet/Events/Inputs/ConnectionResourceParametersArgs.cs index c601580df7..def3384f1e 100644 --- a/sdk/dotnet/Events/Inputs/ConnectionResourceParametersArgs.cs +++ b/sdk/dotnet/Events/Inputs/ConnectionResourceParametersArgs.cs @@ -12,9 +12,17 @@ namespace Pulumi.AwsNative.Events.Inputs public sealed class ConnectionResourceParametersArgs : global::Pulumi.ResourceArgs { + /// + /// For connections to private APIs, the Amazon Resource Name (ARN) of the resource association EventBridge created between the connection and the private API's resource configuration. + /// + /// > The value of this property is set by EventBridge . Any value you specify in your template is ignored. + /// [Input("resourceAssociationArn")] public Input? ResourceAssociationArn { get; set; } + /// + /// The Amazon Resource Name (ARN) of the Amazon VPC Lattice resource configuration for the resource endpoint. + /// [Input("resourceConfigurationArn", required: true)] public Input ResourceConfigurationArn { get; set; } = null!; diff --git a/sdk/dotnet/Events/Inputs/InvocationConnectivityParametersPropertiesArgs.cs b/sdk/dotnet/Events/Inputs/InvocationConnectivityParametersPropertiesArgs.cs index 9bdff81f32..0006602f5b 100644 --- a/sdk/dotnet/Events/Inputs/InvocationConnectivityParametersPropertiesArgs.cs +++ b/sdk/dotnet/Events/Inputs/InvocationConnectivityParametersPropertiesArgs.cs @@ -15,6 +15,9 @@ namespace Pulumi.AwsNative.Events.Inputs /// public sealed class InvocationConnectivityParametersPropertiesArgs : global::Pulumi.ResourceArgs { + /// + /// The parameters for EventBridge to use when invoking the resource endpoint. + /// [Input("resourceParameters", required: true)] public Input ResourceParameters { get; set; } = null!; diff --git a/sdk/dotnet/Events/Outputs/ConnectionAuthParameters.cs b/sdk/dotnet/Events/Outputs/ConnectionAuthParameters.cs index f754600082..9e50ee8b0c 100644 --- a/sdk/dotnet/Events/Outputs/ConnectionAuthParameters.cs +++ b/sdk/dotnet/Events/Outputs/ConnectionAuthParameters.cs @@ -21,6 +21,11 @@ public sealed class ConnectionAuthParameters /// The authorization parameters for Basic authorization. /// public readonly Outputs.ConnectionBasicAuthParameters? BasicAuthParameters; + /// + /// For private OAuth authentication endpoints. The parameters EventBridge uses to authenticate against the endpoint. + /// + /// For more information, see [Authorization methods for connections](https://docs.aws.amazon.com/eventbridge/latest/userguide/eb-target-connection-auth.html) in the **Amazon EventBridge User Guide** . + /// public readonly Outputs.ConnectionConnectivityParameters? ConnectivityParameters; /// /// Additional parameters for the connection that are passed through with every invocation to the HTTP endpoint. diff --git a/sdk/dotnet/Events/Outputs/ConnectionConnectivityParameters.cs b/sdk/dotnet/Events/Outputs/ConnectionConnectivityParameters.cs index 945dcccaba..7cb50e14bf 100644 --- a/sdk/dotnet/Events/Outputs/ConnectionConnectivityParameters.cs +++ b/sdk/dotnet/Events/Outputs/ConnectionConnectivityParameters.cs @@ -13,6 +13,9 @@ namespace Pulumi.AwsNative.Events.Outputs [OutputType] public sealed class ConnectionConnectivityParameters { + /// + /// The parameters for EventBridge to use when invoking the resource endpoint. + /// public readonly Outputs.ConnectionResourceParameters ResourceParameters; [OutputConstructor] diff --git a/sdk/dotnet/Events/Outputs/ConnectionResourceParameters.cs b/sdk/dotnet/Events/Outputs/ConnectionResourceParameters.cs index bf5b4565e3..cad411da54 100644 --- a/sdk/dotnet/Events/Outputs/ConnectionResourceParameters.cs +++ b/sdk/dotnet/Events/Outputs/ConnectionResourceParameters.cs @@ -13,7 +13,15 @@ namespace Pulumi.AwsNative.Events.Outputs [OutputType] public sealed class ConnectionResourceParameters { + /// + /// For connections to private APIs, the Amazon Resource Name (ARN) of the resource association EventBridge created between the connection and the private API's resource configuration. + /// + /// > The value of this property is set by EventBridge . Any value you specify in your template is ignored. + /// public readonly string? ResourceAssociationArn; + /// + /// The Amazon Resource Name (ARN) of the Amazon VPC Lattice resource configuration for the resource endpoint. + /// public readonly string ResourceConfigurationArn; [OutputConstructor] diff --git a/sdk/dotnet/Events/Outputs/InvocationConnectivityParametersProperties.cs b/sdk/dotnet/Events/Outputs/InvocationConnectivityParametersProperties.cs index b9a453535f..99cd42b064 100644 --- a/sdk/dotnet/Events/Outputs/InvocationConnectivityParametersProperties.cs +++ b/sdk/dotnet/Events/Outputs/InvocationConnectivityParametersProperties.cs @@ -16,6 +16,9 @@ namespace Pulumi.AwsNative.Events.Outputs [OutputType] public sealed class InvocationConnectivityParametersProperties { + /// + /// The parameters for EventBridge to use when invoking the resource endpoint. + /// public readonly Outputs.ConnectionResourceParameters ResourceParameters; [OutputConstructor] diff --git a/sdk/dotnet/InternetMonitor/GetMonitor.cs b/sdk/dotnet/InternetMonitor/GetMonitor.cs index 671ae18b02..40e480954a 100644 --- a/sdk/dotnet/InternetMonitor/GetMonitor.cs +++ b/sdk/dotnet/InternetMonitor/GetMonitor.cs @@ -64,7 +64,7 @@ public sealed class GetMonitorResult /// /// A complex type with the configuration information that determines the threshold and other conditions for when Internet Monitor creates a health event for an overall performance or availability issue, across an application's geographies. /// - /// Defines the percentages, for overall performance scores and availability scores for an application, that are the thresholds for when Amazon CloudWatch Internet Monitor creates a health event. You can override the defaults to set a custom threshold for overall performance or availability scores, or both. + /// Defines the percentages, for overall performance scores and availability scores for an application, that are the thresholds for when Internet Monitor creates a health event. You can override the defaults to set a custom threshold for overall performance or availability scores, or both. /// /// You can also set thresholds for local health scores,, where Internet Monitor creates a health event when scores cross a threshold for one or more city-networks, in addition to creating an event when an overall score crosses a threshold. /// diff --git a/sdk/dotnet/InternetMonitor/Monitor.cs b/sdk/dotnet/InternetMonitor/Monitor.cs index 497ca3fcec..c67953fab5 100644 --- a/sdk/dotnet/InternetMonitor/Monitor.cs +++ b/sdk/dotnet/InternetMonitor/Monitor.cs @@ -24,7 +24,7 @@ public partial class Monitor : global::Pulumi.CustomResource /// /// A complex type with the configuration information that determines the threshold and other conditions for when Internet Monitor creates a health event for an overall performance or availability issue, across an application's geographies. /// - /// Defines the percentages, for overall performance scores and availability scores for an application, that are the thresholds for when Amazon CloudWatch Internet Monitor creates a health event. You can override the defaults to set a custom threshold for overall performance or availability scores, or both. + /// Defines the percentages, for overall performance scores and availability scores for an application, that are the thresholds for when Internet Monitor creates a health event. You can override the defaults to set a custom threshold for overall performance or availability scores, or both. /// /// You can also set thresholds for local health scores,, where Internet Monitor creates a health event when scores cross a threshold for one or more city-networks, in addition to creating an event when an overall score crosses a threshold. /// @@ -191,7 +191,7 @@ public sealed class MonitorArgs : global::Pulumi.ResourceArgs /// /// A complex type with the configuration information that determines the threshold and other conditions for when Internet Monitor creates a health event for an overall performance or availability issue, across an application's geographies. /// - /// Defines the percentages, for overall performance scores and availability scores for an application, that are the thresholds for when Amazon CloudWatch Internet Monitor creates a health event. You can override the defaults to set a custom threshold for overall performance or availability scores, or both. + /// Defines the percentages, for overall performance scores and availability scores for an application, that are the thresholds for when Internet Monitor creates a health event. You can override the defaults to set a custom threshold for overall performance or availability scores, or both. /// /// You can also set thresholds for local health scores,, where Internet Monitor creates a health event when scores cross a threshold for one or more city-networks, in addition to creating an event when an overall score crosses a threshold. /// diff --git a/sdk/dotnet/Invoicing/GetInvoiceUnit.cs b/sdk/dotnet/Invoicing/GetInvoiceUnit.cs index 49f50ac730..75ccb4345e 100644 --- a/sdk/dotnet/Invoicing/GetInvoiceUnit.cs +++ b/sdk/dotnet/Invoicing/GetInvoiceUnit.cs @@ -27,6 +27,9 @@ public static Output Invoke(GetInvoiceUnitInvokeArgs args, public sealed class GetInvoiceUnitArgs : global::Pulumi.InvokeArgs { + /// + /// The ARN to identify an invoice unit. This information can't be modified or deleted. + /// [Input("invoiceUnitArn", required: true)] public string InvoiceUnitArn { get; set; } = null!; @@ -38,6 +41,9 @@ public GetInvoiceUnitArgs() public sealed class GetInvoiceUnitInvokeArgs : global::Pulumi.InvokeArgs { + /// + /// The ARN to identify an invoice unit. This information can't be modified or deleted. + /// [Input("invoiceUnitArn", required: true)] public Input InvoiceUnitArn { get; set; } = null!; @@ -51,11 +57,29 @@ public GetInvoiceUnitInvokeArgs() [OutputType] public sealed class GetInvoiceUnitResult { + /// + /// The assigned description for an invoice unit. This information can't be modified or deleted. + /// public readonly string? Description; + /// + /// The ARN to identify an invoice unit. This information can't be modified or deleted. + /// public readonly string? InvoiceUnitArn; + /// + /// The last time the invoice unit was updated. This is important to determine the version of invoice unit configuration used to create the invoices. Any invoice created after this modified time will use this invoice unit configuration. + /// public readonly double? LastModified; + /// + /// The tag structure that contains a tag key and value. + /// public readonly ImmutableArray ResourceTags; + /// + /// An `InvoiceUnitRule` object used the categorize invoice units. + /// public readonly Outputs.InvoiceUnitRule? Rule; + /// + /// Whether the invoice unit based tax inheritance is/ should be enabled or disabled. + /// public readonly bool? TaxInheritanceDisabled; [OutputConstructor] diff --git a/sdk/dotnet/Invoicing/Inputs/InvoiceUnitRuleArgs.cs b/sdk/dotnet/Invoicing/Inputs/InvoiceUnitRuleArgs.cs index 0f74340f83..d05c86d4c1 100644 --- a/sdk/dotnet/Invoicing/Inputs/InvoiceUnitRuleArgs.cs +++ b/sdk/dotnet/Invoicing/Inputs/InvoiceUnitRuleArgs.cs @@ -14,6 +14,10 @@ public sealed class InvoiceUnitRuleArgs : global::Pulumi.ResourceArgs { [Input("linkedAccounts", required: true)] private InputList? _linkedAccounts; + + /// + /// The list of `LINKED_ACCOUNT` IDs where charges are included within the invoice unit. + /// public InputList LinkedAccounts { get => _linkedAccounts ?? (_linkedAccounts = new InputList()); diff --git a/sdk/dotnet/Invoicing/InvoiceUnit.cs b/sdk/dotnet/Invoicing/InvoiceUnit.cs index c1ed81436f..ad422db5f6 100644 --- a/sdk/dotnet/Invoicing/InvoiceUnit.cs +++ b/sdk/dotnet/Invoicing/InvoiceUnit.cs @@ -15,27 +15,51 @@ namespace Pulumi.AwsNative.Invoicing [AwsNativeResourceType("aws-native:invoicing:InvoiceUnit")] public partial class InvoiceUnit : global::Pulumi.CustomResource { + /// + /// The assigned description for an invoice unit. This information can't be modified or deleted. + /// [Output("description")] public Output Description { get; private set; } = null!; + /// + /// The account that receives invoices related to the invoice unit. + /// [Output("invoiceReceiver")] public Output InvoiceReceiver { get; private set; } = null!; + /// + /// The ARN to identify an invoice unit. This information can't be modified or deleted. + /// [Output("invoiceUnitArn")] public Output InvoiceUnitArn { get; private set; } = null!; + /// + /// The last time the invoice unit was updated. This is important to determine the version of invoice unit configuration used to create the invoices. Any invoice created after this modified time will use this invoice unit configuration. + /// [Output("lastModified")] public Output LastModified { get; private set; } = null!; + /// + /// A unique name that is distinctive within your AWS . + /// [Output("name")] public Output Name { get; private set; } = null!; + /// + /// The tag structure that contains a tag key and value. + /// [Output("resourceTags")] public Output> ResourceTags { get; private set; } = null!; + /// + /// An `InvoiceUnitRule` object used the categorize invoice units. + /// [Output("rule")] public Output Rule { get; private set; } = null!; + /// + /// Whether the invoice unit based tax inheritance is/ should be enabled or disabled. + /// [Output("taxInheritanceDisabled")] public Output TaxInheritanceDisabled { get; private set; } = null!; @@ -89,26 +113,45 @@ public static InvoiceUnit Get(string name, Input id, CustomResourceOptio public sealed class InvoiceUnitArgs : global::Pulumi.ResourceArgs { + /// + /// The assigned description for an invoice unit. This information can't be modified or deleted. + /// [Input("description")] public Input? Description { get; set; } + /// + /// The account that receives invoices related to the invoice unit. + /// [Input("invoiceReceiver", required: true)] public Input InvoiceReceiver { get; set; } = null!; + /// + /// A unique name that is distinctive within your AWS . + /// [Input("name")] public Input? Name { get; set; } [Input("resourceTags")] private InputList? _resourceTags; + + /// + /// The tag structure that contains a tag key and value. + /// public InputList ResourceTags { get => _resourceTags ?? (_resourceTags = new InputList()); set => _resourceTags = value; } + /// + /// An `InvoiceUnitRule` object used the categorize invoice units. + /// [Input("rule", required: true)] public Input Rule { get; set; } = null!; + /// + /// Whether the invoice unit based tax inheritance is/ should be enabled or disabled. + /// [Input("taxInheritanceDisabled")] public Input? TaxInheritanceDisabled { get; set; } diff --git a/sdk/dotnet/Invoicing/Outputs/InvoiceUnitRule.cs b/sdk/dotnet/Invoicing/Outputs/InvoiceUnitRule.cs index a845fa942b..c90f8b4db1 100644 --- a/sdk/dotnet/Invoicing/Outputs/InvoiceUnitRule.cs +++ b/sdk/dotnet/Invoicing/Outputs/InvoiceUnitRule.cs @@ -13,6 +13,9 @@ namespace Pulumi.AwsNative.Invoicing.Outputs [OutputType] public sealed class InvoiceUnitRule { + /// + /// The list of `LINKED_ACCOUNT` IDs where charges are included within the invoice unit. + /// public readonly ImmutableArray LinkedAccounts; [OutputConstructor] diff --git a/sdk/dotnet/IoT/Command.cs b/sdk/dotnet/IoT/Command.cs new file mode 100644 index 0000000000..034ae6e9c9 --- /dev/null +++ b/sdk/dotnet/IoT/Command.cs @@ -0,0 +1,234 @@ +// *** WARNING: this file was generated by pulumi. *** +// *** Do not edit by hand unless you're certain you know what you are doing! *** + +using System; +using System.Collections.Generic; +using System.Collections.Immutable; +using System.Threading.Tasks; +using Pulumi.Serialization; + +namespace Pulumi.AwsNative.IoT +{ + /// + /// Represents the resource definition of AWS IoT Command. + /// + [AwsNativeResourceType("aws-native:iot:Command")] + public partial class Command : global::Pulumi.CustomResource + { + /// + /// The Amazon Resource Name (ARN) of the command. + /// + [Output("commandArn")] + public Output CommandArn { get; private set; } = null!; + + /// + /// The unique identifier for the command. + /// + [Output("commandId")] + public Output CommandId { get; private set; } = null!; + + /// + /// The date and time when the command was created. + /// + [Output("createdAt")] + public Output CreatedAt { get; private set; } = null!; + + /// + /// A flag indicating whether the command is deprecated. + /// + [Output("deprecated")] + public Output Deprecated { get; private set; } = null!; + + /// + /// The description of the command. + /// + [Output("description")] + public Output Description { get; private set; } = null!; + + /// + /// The display name for the command. + /// + [Output("displayName")] + public Output DisplayName { get; private set; } = null!; + + /// + /// The date and time when the command was last updated. + /// + [Output("lastUpdatedAt")] + public Output LastUpdatedAt { get; private set; } = null!; + + /// + /// The list of mandatory parameters for the command. + /// + [Output("mandatoryParameters")] + public Output> MandatoryParameters { get; private set; } = null!; + + /// + /// The namespace to which the command belongs. + /// + [Output("namespace")] + public Output Namespace { get; private set; } = null!; + + /// + /// The payload associated with the command. + /// + [Output("payload")] + public Output Payload { get; private set; } = null!; + + /// + /// A flag indicating whether the command is pending deletion. + /// + [Output("pendingDeletion")] + public Output PendingDeletion { get; private set; } = null!; + + /// + /// The customer role associated with the command. + /// + [Output("roleArn")] + public Output RoleArn { get; private set; } = null!; + + /// + /// The tags to be associated with the command. + /// + [Output("tags")] + public Output> Tags { get; private set; } = null!; + + + /// + /// Create a Command resource with the given unique name, arguments, and options. + /// + /// + /// The unique name of the resource + /// The arguments used to populate this resource's properties + /// A bag of options that control this resource's behavior + public Command(string name, CommandArgs args, CustomResourceOptions? options = null) + : base("aws-native:iot:Command", name, args ?? new CommandArgs(), MakeResourceOptions(options, "")) + { + } + + private Command(string name, Input id, CustomResourceOptions? options = null) + : base("aws-native:iot:Command", name, null, MakeResourceOptions(options, id)) + { + } + + private static CustomResourceOptions MakeResourceOptions(CustomResourceOptions? options, Input? id) + { + var defaultOptions = new CustomResourceOptions + { + Version = Utilities.Version, + ReplaceOnChanges = + { + "commandId", + }, + }; + var merged = CustomResourceOptions.Merge(defaultOptions, options); + // Override the ID if one was specified for consistency with other language SDKs. + merged.Id = id ?? merged.Id; + return merged; + } + /// + /// Get an existing Command resource's state with the given name, ID, and optional extra + /// properties used to qualify the lookup. + /// + /// + /// The unique name of the resulting resource. + /// The unique provider ID of the resource to lookup. + /// A bag of options that control this resource's behavior + public static Command Get(string name, Input id, CustomResourceOptions? options = null) + { + return new Command(name, id, options); + } + } + + public sealed class CommandArgs : global::Pulumi.ResourceArgs + { + /// + /// The unique identifier for the command. + /// + [Input("commandId", required: true)] + public Input CommandId { get; set; } = null!; + + /// + /// The date and time when the command was created. + /// + [Input("createdAt")] + public Input? CreatedAt { get; set; } + + /// + /// A flag indicating whether the command is deprecated. + /// + [Input("deprecated")] + public Input? Deprecated { get; set; } + + /// + /// The description of the command. + /// + [Input("description")] + public Input? Description { get; set; } + + /// + /// The display name for the command. + /// + [Input("displayName")] + public Input? DisplayName { get; set; } + + /// + /// The date and time when the command was last updated. + /// + [Input("lastUpdatedAt")] + public Input? LastUpdatedAt { get; set; } + + [Input("mandatoryParameters")] + private InputList? _mandatoryParameters; + + /// + /// The list of mandatory parameters for the command. + /// + public InputList MandatoryParameters + { + get => _mandatoryParameters ?? (_mandatoryParameters = new InputList()); + set => _mandatoryParameters = value; + } + + /// + /// The namespace to which the command belongs. + /// + [Input("namespace")] + public Input? Namespace { get; set; } + + /// + /// The payload associated with the command. + /// + [Input("payload")] + public Input? Payload { get; set; } + + /// + /// A flag indicating whether the command is pending deletion. + /// + [Input("pendingDeletion")] + public Input? PendingDeletion { get; set; } + + /// + /// The customer role associated with the command. + /// + [Input("roleArn")] + public Input? RoleArn { get; set; } + + [Input("tags")] + private InputList? _tags; + + /// + /// The tags to be associated with the command. + /// + public InputList Tags + { + get => _tags ?? (_tags = new InputList()); + set => _tags = value; + } + + public CommandArgs() + { + } + public static new CommandArgs Empty => new CommandArgs(); + } +} diff --git a/sdk/dotnet/IoT/Enums.cs b/sdk/dotnet/IoT/Enums.cs index e1a8b23569..fb378b6608 100644 --- a/sdk/dotnet/IoT/Enums.cs +++ b/sdk/dotnet/IoT/Enums.cs @@ -239,6 +239,37 @@ private CertificateStatus(string value) public override string ToString() => _value; } + /// + /// The namespace to which the command belongs. + /// + [EnumType] + public readonly struct CommandNamespace : IEquatable + { + private readonly string _value; + + private CommandNamespace(string value) + { + _value = value ?? throw new ArgumentNullException(nameof(value)); + } + + public static CommandNamespace AwsIoT { get; } = new CommandNamespace("AWS-IoT"); + public static CommandNamespace AwsIoTFleetWise { get; } = new CommandNamespace("AWS-IoT-FleetWise"); + + public static bool operator ==(CommandNamespace left, CommandNamespace right) => left.Equals(right); + public static bool operator !=(CommandNamespace left, CommandNamespace right) => !left.Equals(right); + + public static explicit operator string(CommandNamespace value) => value._value; + + [EditorBrowsable(EditorBrowsableState.Never)] + public override bool Equals(object? obj) => obj is CommandNamespace other && Equals(other); + public bool Equals(CommandNamespace other) => string.Equals(_value, other._value, StringComparison.Ordinal); + + [EditorBrowsable(EditorBrowsableState.Never)] + public override int GetHashCode() => _value?.GetHashCode() ?? 0; + + public override string ToString() => _value; + } + /// /// The type of the custom metric. Types include string-list, ip-address-list, number-list, and number. /// diff --git a/sdk/dotnet/IoT/GetCommand.cs b/sdk/dotnet/IoT/GetCommand.cs new file mode 100644 index 0000000000..235aa1f9cb --- /dev/null +++ b/sdk/dotnet/IoT/GetCommand.cs @@ -0,0 +1,142 @@ +// *** WARNING: this file was generated by pulumi. *** +// *** Do not edit by hand unless you're certain you know what you are doing! *** + +using System; +using System.Collections.Generic; +using System.Collections.Immutable; +using System.Threading.Tasks; +using Pulumi.Serialization; + +namespace Pulumi.AwsNative.IoT +{ + public static class GetCommand + { + /// + /// Represents the resource definition of AWS IoT Command. + /// + public static Task InvokeAsync(GetCommandArgs args, InvokeOptions? options = null) + => global::Pulumi.Deployment.Instance.InvokeAsync("aws-native:iot:getCommand", args ?? new GetCommandArgs(), options.WithDefaults()); + + /// + /// Represents the resource definition of AWS IoT Command. + /// + public static Output Invoke(GetCommandInvokeArgs args, InvokeOptions? options = null) + => global::Pulumi.Deployment.Instance.Invoke("aws-native:iot:getCommand", args ?? new GetCommandInvokeArgs(), options.WithDefaults()); + } + + + public sealed class GetCommandArgs : global::Pulumi.InvokeArgs + { + /// + /// The unique identifier for the command. + /// + [Input("commandId", required: true)] + public string CommandId { get; set; } = null!; + + public GetCommandArgs() + { + } + public static new GetCommandArgs Empty => new GetCommandArgs(); + } + + public sealed class GetCommandInvokeArgs : global::Pulumi.InvokeArgs + { + /// + /// The unique identifier for the command. + /// + [Input("commandId", required: true)] + public Input CommandId { get; set; } = null!; + + public GetCommandInvokeArgs() + { + } + public static new GetCommandInvokeArgs Empty => new GetCommandInvokeArgs(); + } + + + [OutputType] + public sealed class GetCommandResult + { + /// + /// The Amazon Resource Name (ARN) of the command. + /// + public readonly string? CommandArn; + /// + /// The date and time when the command was created. + /// + public readonly string? CreatedAt; + /// + /// A flag indicating whether the command is deprecated. + /// + public readonly bool? Deprecated; + /// + /// The description of the command. + /// + public readonly string? Description; + /// + /// The display name for the command. + /// + public readonly string? DisplayName; + /// + /// The list of mandatory parameters for the command. + /// + public readonly ImmutableArray MandatoryParameters; + /// + /// The namespace to which the command belongs. + /// + public readonly Pulumi.AwsNative.IoT.CommandNamespace? Namespace; + /// + /// The payload associated with the command. + /// + public readonly Outputs.CommandPayload? Payload; + /// + /// A flag indicating whether the command is pending deletion. + /// + public readonly bool? PendingDeletion; + /// + /// The customer role associated with the command. + /// + public readonly string? RoleArn; + /// + /// The tags to be associated with the command. + /// + public readonly ImmutableArray Tags; + + [OutputConstructor] + private GetCommandResult( + string? commandArn, + + string? createdAt, + + bool? deprecated, + + string? description, + + string? displayName, + + ImmutableArray mandatoryParameters, + + Pulumi.AwsNative.IoT.CommandNamespace? @namespace, + + Outputs.CommandPayload? payload, + + bool? pendingDeletion, + + string? roleArn, + + ImmutableArray tags) + { + CommandArn = commandArn; + CreatedAt = createdAt; + Deprecated = deprecated; + Description = description; + DisplayName = displayName; + MandatoryParameters = mandatoryParameters; + Namespace = @namespace; + Payload = payload; + PendingDeletion = pendingDeletion; + RoleArn = roleArn; + Tags = tags; + } + } +} diff --git a/sdk/dotnet/IoT/Inputs/CommandParameterArgs.cs b/sdk/dotnet/IoT/Inputs/CommandParameterArgs.cs new file mode 100644 index 0000000000..7937109f81 --- /dev/null +++ b/sdk/dotnet/IoT/Inputs/CommandParameterArgs.cs @@ -0,0 +1,32 @@ +// *** WARNING: this file was generated by pulumi. *** +// *** Do not edit by hand unless you're certain you know what you are doing! *** + +using System; +using System.Collections.Generic; +using System.Collections.Immutable; +using System.Threading.Tasks; +using Pulumi.Serialization; + +namespace Pulumi.AwsNative.IoT.Inputs +{ + + public sealed class CommandParameterArgs : global::Pulumi.ResourceArgs + { + [Input("defaultValue")] + public Input? DefaultValue { get; set; } + + [Input("description")] + public Input? Description { get; set; } + + [Input("name", required: true)] + public Input Name { get; set; } = null!; + + [Input("value")] + public Input? Value { get; set; } + + public CommandParameterArgs() + { + } + public static new CommandParameterArgs Empty => new CommandParameterArgs(); + } +} diff --git a/sdk/dotnet/IoT/Inputs/CommandParameterValueArgs.cs b/sdk/dotnet/IoT/Inputs/CommandParameterValueArgs.cs new file mode 100644 index 0000000000..fc621b90c7 --- /dev/null +++ b/sdk/dotnet/IoT/Inputs/CommandParameterValueArgs.cs @@ -0,0 +1,41 @@ +// *** WARNING: this file was generated by pulumi. *** +// *** Do not edit by hand unless you're certain you know what you are doing! *** + +using System; +using System.Collections.Generic; +using System.Collections.Immutable; +using System.Threading.Tasks; +using Pulumi.Serialization; + +namespace Pulumi.AwsNative.IoT.Inputs +{ + + public sealed class CommandParameterValueArgs : global::Pulumi.ResourceArgs + { + [Input("b")] + public Input? B { get; set; } + + [Input("bin")] + public Input? Bin { get; set; } + + [Input("d")] + public Input? D { get; set; } + + [Input("i")] + public Input? I { get; set; } + + [Input("l")] + public Input? L { get; set; } + + [Input("s")] + public Input? S { get; set; } + + [Input("ul")] + public Input? Ul { get; set; } + + public CommandParameterValueArgs() + { + } + public static new CommandParameterValueArgs Empty => new CommandParameterValueArgs(); + } +} diff --git a/sdk/dotnet/IoT/Inputs/CommandPayloadArgs.cs b/sdk/dotnet/IoT/Inputs/CommandPayloadArgs.cs new file mode 100644 index 0000000000..a39b3d65d0 --- /dev/null +++ b/sdk/dotnet/IoT/Inputs/CommandPayloadArgs.cs @@ -0,0 +1,26 @@ +// *** WARNING: this file was generated by pulumi. *** +// *** Do not edit by hand unless you're certain you know what you are doing! *** + +using System; +using System.Collections.Generic; +using System.Collections.Immutable; +using System.Threading.Tasks; +using Pulumi.Serialization; + +namespace Pulumi.AwsNative.IoT.Inputs +{ + + public sealed class CommandPayloadArgs : global::Pulumi.ResourceArgs + { + [Input("content")] + public Input? Content { get; set; } + + [Input("contentType")] + public Input? ContentType { get; set; } + + public CommandPayloadArgs() + { + } + public static new CommandPayloadArgs Empty => new CommandPayloadArgs(); + } +} diff --git a/sdk/dotnet/IoT/Outputs/CommandParameter.cs b/sdk/dotnet/IoT/Outputs/CommandParameter.cs new file mode 100644 index 0000000000..f82e241fd0 --- /dev/null +++ b/sdk/dotnet/IoT/Outputs/CommandParameter.cs @@ -0,0 +1,37 @@ +// *** WARNING: this file was generated by pulumi. *** +// *** Do not edit by hand unless you're certain you know what you are doing! *** + +using System; +using System.Collections.Generic; +using System.Collections.Immutable; +using System.Threading.Tasks; +using Pulumi.Serialization; + +namespace Pulumi.AwsNative.IoT.Outputs +{ + + [OutputType] + public sealed class CommandParameter + { + public readonly Outputs.CommandParameterValue? DefaultValue; + public readonly string? Description; + public readonly string Name; + public readonly Outputs.CommandParameterValue? Value; + + [OutputConstructor] + private CommandParameter( + Outputs.CommandParameterValue? defaultValue, + + string? description, + + string name, + + Outputs.CommandParameterValue? value) + { + DefaultValue = defaultValue; + Description = description; + Name = name; + Value = value; + } + } +} diff --git a/sdk/dotnet/IoT/Outputs/CommandParameterValue.cs b/sdk/dotnet/IoT/Outputs/CommandParameterValue.cs new file mode 100644 index 0000000000..8bc9811c34 --- /dev/null +++ b/sdk/dotnet/IoT/Outputs/CommandParameterValue.cs @@ -0,0 +1,49 @@ +// *** WARNING: this file was generated by pulumi. *** +// *** Do not edit by hand unless you're certain you know what you are doing! *** + +using System; +using System.Collections.Generic; +using System.Collections.Immutable; +using System.Threading.Tasks; +using Pulumi.Serialization; + +namespace Pulumi.AwsNative.IoT.Outputs +{ + + [OutputType] + public sealed class CommandParameterValue + { + public readonly bool? B; + public readonly string? Bin; + public readonly double? D; + public readonly int? I; + public readonly string? L; + public readonly string? S; + public readonly string? Ul; + + [OutputConstructor] + private CommandParameterValue( + bool? b, + + string? bin, + + double? d, + + int? i, + + string? l, + + string? s, + + string? ul) + { + B = b; + Bin = bin; + D = d; + I = i; + L = l; + S = s; + Ul = ul; + } + } +} diff --git a/sdk/dotnet/IoT/Outputs/CommandPayload.cs b/sdk/dotnet/IoT/Outputs/CommandPayload.cs new file mode 100644 index 0000000000..8b1584a365 --- /dev/null +++ b/sdk/dotnet/IoT/Outputs/CommandPayload.cs @@ -0,0 +1,29 @@ +// *** WARNING: this file was generated by pulumi. *** +// *** Do not edit by hand unless you're certain you know what you are doing! *** + +using System; +using System.Collections.Generic; +using System.Collections.Immutable; +using System.Threading.Tasks; +using Pulumi.Serialization; + +namespace Pulumi.AwsNative.IoT.Outputs +{ + + [OutputType] + public sealed class CommandPayload + { + public readonly string? Content; + public readonly string? ContentType; + + [OutputConstructor] + private CommandPayload( + string? content, + + string? contentType) + { + Content = content; + ContentType = contentType; + } + } +} diff --git a/sdk/dotnet/Organizations/Enums.cs b/sdk/dotnet/Organizations/Enums.cs index 01ae4ba639..34080022ac 100644 --- a/sdk/dotnet/Organizations/Enums.cs +++ b/sdk/dotnet/Organizations/Enums.cs @@ -102,7 +102,7 @@ private OrganizationFeatureSet(string value) } /// - /// The type of policy to create. You can specify one of the following values: AISERVICES_OPT_OUT_POLICY, BACKUP_POLICY, SERVICE_CONTROL_POLICY, TAG_POLICY, CHATBOT_POLICY, RESOURCE_CONTROL_POLICY + /// The type of policy to create. You can specify one of the following values: AISERVICES_OPT_OUT_POLICY, BACKUP_POLICY, SERVICE_CONTROL_POLICY, TAG_POLICY, CHATBOT_POLICY, RESOURCE_CONTROL_POLICY,DECLARATIVE_POLICY_EC2 /// [EnumType] public readonly struct PolicyType : IEquatable @@ -120,6 +120,7 @@ private PolicyType(string value) public static PolicyType TagPolicy { get; } = new PolicyType("TAG_POLICY"); public static PolicyType ChatbotPolicy { get; } = new PolicyType("CHATBOT_POLICY"); public static PolicyType ResourceControlPolicy { get; } = new PolicyType("RESOURCE_CONTROL_POLICY"); + public static PolicyType DeclarativePolicyEc2 { get; } = new PolicyType("DECLARATIVE_POLICY_EC2"); public static bool operator ==(PolicyType left, PolicyType right) => left.Equals(right); public static bool operator !=(PolicyType left, PolicyType right) => !left.Equals(right); diff --git a/sdk/dotnet/Organizations/Policy.cs b/sdk/dotnet/Organizations/Policy.cs index 4786d325f9..ab1007485d 100644 --- a/sdk/dotnet/Organizations/Policy.cs +++ b/sdk/dotnet/Organizations/Policy.cs @@ -66,7 +66,7 @@ public partial class Policy : global::Pulumi.CustomResource public Output> TargetIds { get; private set; } = null!; /// - /// The type of policy to create. You can specify one of the following values: AISERVICES_OPT_OUT_POLICY, BACKUP_POLICY, SERVICE_CONTROL_POLICY, TAG_POLICY, CHATBOT_POLICY, RESOURCE_CONTROL_POLICY + /// The type of policy to create. You can specify one of the following values: AISERVICES_OPT_OUT_POLICY, BACKUP_POLICY, SERVICE_CONTROL_POLICY, TAG_POLICY, CHATBOT_POLICY, RESOURCE_CONTROL_POLICY,DECLARATIVE_POLICY_EC2 /// [Output("type")] public Output Type { get; private set; } = null!; @@ -165,7 +165,7 @@ public InputList TargetIds } /// - /// The type of policy to create. You can specify one of the following values: AISERVICES_OPT_OUT_POLICY, BACKUP_POLICY, SERVICE_CONTROL_POLICY, TAG_POLICY, CHATBOT_POLICY, RESOURCE_CONTROL_POLICY + /// The type of policy to create. You can specify one of the following values: AISERVICES_OPT_OUT_POLICY, BACKUP_POLICY, SERVICE_CONTROL_POLICY, TAG_POLICY, CHATBOT_POLICY, RESOURCE_CONTROL_POLICY,DECLARATIVE_POLICY_EC2 /// [Input("type", required: true)] public Input Type { get; set; } = null!; diff --git a/sdk/dotnet/QBusiness/Application.cs b/sdk/dotnet/QBusiness/Application.cs index 5b465fe5c3..19bfecd3ad 100644 --- a/sdk/dotnet/QBusiness/Application.cs +++ b/sdk/dotnet/QBusiness/Application.cs @@ -39,6 +39,9 @@ public partial class Application : global::Pulumi.CustomResource [Output("autoSubscriptionConfiguration")] public Output AutoSubscriptionConfiguration { get; private set; } = null!; + /// + /// The OIDC client ID for a Amazon Q Business application. + /// [Output("clientIdsForOidc")] public Output> ClientIdsForOidc { get; private set; } = null!; @@ -198,6 +201,10 @@ public sealed class ApplicationArgs : global::Pulumi.ResourceArgs [Input("clientIdsForOidc")] private InputList? _clientIdsForOidc; + + /// + /// The OIDC client ID for a Amazon Q Business application. + /// public InputList ClientIdsForOidc { get => _clientIdsForOidc ?? (_clientIdsForOidc = new InputList()); diff --git a/sdk/dotnet/Ram/GetResourceShare.cs b/sdk/dotnet/Ram/GetResourceShare.cs new file mode 100644 index 0000000000..3f1a060413 --- /dev/null +++ b/sdk/dotnet/Ram/GetResourceShare.cs @@ -0,0 +1,93 @@ +// *** WARNING: this file was generated by pulumi. *** +// *** Do not edit by hand unless you're certain you know what you are doing! *** + +using System; +using System.Collections.Generic; +using System.Collections.Immutable; +using System.Threading.Tasks; +using Pulumi.Serialization; + +namespace Pulumi.AwsNative.Ram +{ + public static class GetResourceShare + { + /// + /// Resource type definition for AWS::RAM::ResourceShare + /// + public static Task InvokeAsync(GetResourceShareArgs args, InvokeOptions? options = null) + => global::Pulumi.Deployment.Instance.InvokeAsync("aws-native:ram:getResourceShare", args ?? new GetResourceShareArgs(), options.WithDefaults()); + + /// + /// Resource type definition for AWS::RAM::ResourceShare + /// + public static Output Invoke(GetResourceShareInvokeArgs args, InvokeOptions? options = null) + => global::Pulumi.Deployment.Instance.Invoke("aws-native:ram:getResourceShare", args ?? new GetResourceShareInvokeArgs(), options.WithDefaults()); + } + + + public sealed class GetResourceShareArgs : global::Pulumi.InvokeArgs + { + /// + /// The Amazon Resource Name (ARN) of the resource share. + /// + [Input("arn", required: true)] + public string Arn { get; set; } = null!; + + public GetResourceShareArgs() + { + } + public static new GetResourceShareArgs Empty => new GetResourceShareArgs(); + } + + public sealed class GetResourceShareInvokeArgs : global::Pulumi.InvokeArgs + { + /// + /// The Amazon Resource Name (ARN) of the resource share. + /// + [Input("arn", required: true)] + public Input Arn { get; set; } = null!; + + public GetResourceShareInvokeArgs() + { + } + public static new GetResourceShareInvokeArgs Empty => new GetResourceShareInvokeArgs(); + } + + + [OutputType] + public sealed class GetResourceShareResult + { + /// + /// Specifies whether principals outside your organization in AWS Organizations can be associated with a resource share. A value of `true` lets you share with individual AWS accounts that are not in your organization. A value of `false` only has meaning if your account is a member of an AWS Organization. The default value is `true`. + /// + public readonly bool? AllowExternalPrincipals; + /// + /// The Amazon Resource Name (ARN) of the resource share. + /// + public readonly string? Arn; + /// + /// Specifies the name of the resource share. + /// + public readonly string? Name; + /// + /// Specifies one or more tags to attach to the resource share itself. It doesn't attach the tags to the resources associated with the resource share. + /// + public readonly ImmutableArray Tags; + + [OutputConstructor] + private GetResourceShareResult( + bool? allowExternalPrincipals, + + string? arn, + + string? name, + + ImmutableArray tags) + { + AllowExternalPrincipals = allowExternalPrincipals; + Arn = arn; + Name = name; + Tags = tags; + } + } +} diff --git a/sdk/dotnet/Ram/ResourceShare.cs b/sdk/dotnet/Ram/ResourceShare.cs new file mode 100644 index 0000000000..f6edb5b972 --- /dev/null +++ b/sdk/dotnet/Ram/ResourceShare.cs @@ -0,0 +1,288 @@ +// *** WARNING: this file was generated by pulumi. *** +// *** Do not edit by hand unless you're certain you know what you are doing! *** + +using System; +using System.Collections.Generic; +using System.Collections.Immutable; +using System.Threading.Tasks; +using Pulumi.Serialization; + +namespace Pulumi.AwsNative.Ram +{ + /// + /// Resource type definition for AWS::RAM::ResourceShare + /// + /// ## Example Usage + /// ### Example + /// ```csharp + /// using System.Collections.Generic; + /// using System.Linq; + /// using Pulumi; + /// using AwsNative = Pulumi.AwsNative; + /// + /// return await Deployment.RunAsync(() => + /// { + /// var myresourceshare = new AwsNative.Ram.ResourceShare("myresourceshare", new() + /// { + /// Name = "My Resource Share", + /// ResourceArns = new[] + /// { + /// "arn:aws:ec2:us-east-1:123456789012:resource-type/12345678-1234-1234-1234-12345678", + /// }, + /// Principals = new[] + /// { + /// "210987654321", + /// }, + /// Tags = new[] + /// { + /// new AwsNative.Inputs.TagArgs + /// { + /// Key = "Key1", + /// Value = "Value1", + /// }, + /// new AwsNative.Inputs.TagArgs + /// { + /// Key = "Key2", + /// Value = "Value2", + /// }, + /// }, + /// }); + /// + /// }); + /// + /// + /// ``` + /// ### Example + /// ```csharp + /// using System.Collections.Generic; + /// using System.Linq; + /// using Pulumi; + /// using AwsNative = Pulumi.AwsNative; + /// + /// return await Deployment.RunAsync(() => + /// { + /// var myresourceshare = new AwsNative.Ram.ResourceShare("myresourceshare", new() + /// { + /// Name = "My Resource Share", + /// ResourceArns = new[] + /// { + /// "arn:aws:ec2:us-east-1:123456789012:resource-type/12345678-1234-1234-1234-12345678", + /// }, + /// Principals = new[] + /// { + /// "210987654321", + /// }, + /// Tags = new[] + /// { + /// new AwsNative.Inputs.TagArgs + /// { + /// Key = "Key1", + /// Value = "Value1", + /// }, + /// new AwsNative.Inputs.TagArgs + /// { + /// Key = "Key2", + /// Value = "Value2", + /// }, + /// }, + /// }); + /// + /// }); + /// + /// + /// ``` + /// + [AwsNativeResourceType("aws-native:ram:ResourceShare")] + public partial class ResourceShare : global::Pulumi.CustomResource + { + /// + /// Specifies whether principals outside your organization in AWS Organizations can be associated with a resource share. A value of `true` lets you share with individual AWS accounts that are not in your organization. A value of `false` only has meaning if your account is a member of an AWS Organization. The default value is `true`. + /// + [Output("allowExternalPrincipals")] + public Output AllowExternalPrincipals { get; private set; } = null!; + + /// + /// The Amazon Resource Name (ARN) of the resource share. + /// + [Output("arn")] + public Output Arn { get; private set; } = null!; + + /// + /// Specifies the name of the resource share. + /// + [Output("name")] + public Output Name { get; private set; } = null!; + + /// + /// Specifies the [Amazon Resource Names (ARNs)](https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html) of the AWS RAM permission to associate with the resource share. If you do not specify an ARN for the permission, AWS RAM automatically attaches the default version of the permission for each resource type. You can associate only one permission with each resource type included in the resource share. + /// + [Output("permissionArns")] + public Output> PermissionArns { get; private set; } = null!; + + /// + /// Specifies the principals to associate with the resource share. The possible values are: + /// + /// - An AWS account ID + /// + /// - An Amazon Resource Name (ARN) of an organization in AWS Organizations + /// + /// - An ARN of an organizational unit (OU) in AWS Organizations + /// + /// - An ARN of an IAM role + /// + /// - An ARN of an IAM user + /// + [Output("principals")] + public Output> Principals { get; private set; } = null!; + + /// + /// Specifies a list of one or more ARNs of the resources to associate with the resource share. + /// + [Output("resourceArns")] + public Output> ResourceArns { get; private set; } = null!; + + /// + /// Specifies from which source accounts the service principal has access to the resources in this resource share. + /// + [Output("sources")] + public Output> Sources { get; private set; } = null!; + + /// + /// Specifies one or more tags to attach to the resource share itself. It doesn't attach the tags to the resources associated with the resource share. + /// + [Output("tags")] + public Output> Tags { get; private set; } = null!; + + + /// + /// Create a ResourceShare resource with the given unique name, arguments, and options. + /// + /// + /// The unique name of the resource + /// The arguments used to populate this resource's properties + /// A bag of options that control this resource's behavior + public ResourceShare(string name, ResourceShareArgs? args = null, CustomResourceOptions? options = null) + : base("aws-native:ram:ResourceShare", name, args ?? new ResourceShareArgs(), MakeResourceOptions(options, "")) + { + } + + private ResourceShare(string name, Input id, CustomResourceOptions? options = null) + : base("aws-native:ram:ResourceShare", name, null, MakeResourceOptions(options, id)) + { + } + + private static CustomResourceOptions MakeResourceOptions(CustomResourceOptions? options, Input? id) + { + var defaultOptions = new CustomResourceOptions + { + Version = Utilities.Version, + }; + var merged = CustomResourceOptions.Merge(defaultOptions, options); + // Override the ID if one was specified for consistency with other language SDKs. + merged.Id = id ?? merged.Id; + return merged; + } + /// + /// Get an existing ResourceShare resource's state with the given name, ID, and optional extra + /// properties used to qualify the lookup. + /// + /// + /// The unique name of the resulting resource. + /// The unique provider ID of the resource to lookup. + /// A bag of options that control this resource's behavior + public static ResourceShare Get(string name, Input id, CustomResourceOptions? options = null) + { + return new ResourceShare(name, id, options); + } + } + + public sealed class ResourceShareArgs : global::Pulumi.ResourceArgs + { + /// + /// Specifies whether principals outside your organization in AWS Organizations can be associated with a resource share. A value of `true` lets you share with individual AWS accounts that are not in your organization. A value of `false` only has meaning if your account is a member of an AWS Organization. The default value is `true`. + /// + [Input("allowExternalPrincipals")] + public Input? AllowExternalPrincipals { get; set; } + + /// + /// Specifies the name of the resource share. + /// + [Input("name")] + public Input? Name { get; set; } + + [Input("permissionArns")] + private InputList? _permissionArns; + + /// + /// Specifies the [Amazon Resource Names (ARNs)](https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html) of the AWS RAM permission to associate with the resource share. If you do not specify an ARN for the permission, AWS RAM automatically attaches the default version of the permission for each resource type. You can associate only one permission with each resource type included in the resource share. + /// + public InputList PermissionArns + { + get => _permissionArns ?? (_permissionArns = new InputList()); + set => _permissionArns = value; + } + + [Input("principals")] + private InputList? _principals; + + /// + /// Specifies the principals to associate with the resource share. The possible values are: + /// + /// - An AWS account ID + /// + /// - An Amazon Resource Name (ARN) of an organization in AWS Organizations + /// + /// - An ARN of an organizational unit (OU) in AWS Organizations + /// + /// - An ARN of an IAM role + /// + /// - An ARN of an IAM user + /// + public InputList Principals + { + get => _principals ?? (_principals = new InputList()); + set => _principals = value; + } + + [Input("resourceArns")] + private InputList? _resourceArns; + + /// + /// Specifies a list of one or more ARNs of the resources to associate with the resource share. + /// + public InputList ResourceArns + { + get => _resourceArns ?? (_resourceArns = new InputList()); + set => _resourceArns = value; + } + + [Input("sources")] + private InputList? _sources; + + /// + /// Specifies from which source accounts the service principal has access to the resources in this resource share. + /// + public InputList Sources + { + get => _sources ?? (_sources = new InputList()); + set => _sources = value; + } + + [Input("tags")] + private InputList? _tags; + + /// + /// Specifies one or more tags to attach to the resource share itself. It doesn't attach the tags to the resources associated with the resource share. + /// + public InputList Tags + { + get => _tags ?? (_tags = new InputList()); + set => _tags = value; + } + + public ResourceShareArgs() + { + } + public static new ResourceShareArgs Empty => new ResourceShareArgs(); + } +} diff --git a/sdk/dotnet/Rds/CustomDbEngineVersion.cs b/sdk/dotnet/Rds/CustomDbEngineVersion.cs index 89079ef123..09712f3e70 100644 --- a/sdk/dotnet/Rds/CustomDbEngineVersion.cs +++ b/sdk/dotnet/Rds/CustomDbEngineVersion.cs @@ -10,19 +10,19 @@ namespace Pulumi.AwsNative.Rds { /// - /// The AWS::RDS::CustomDBEngineVersion resource creates an Amazon RDS custom DB engine version. + /// Creates a custom DB engine version (CEV). /// [AwsNativeResourceType("aws-native:rds:CustomDbEngineVersion")] public partial class CustomDbEngineVersion : global::Pulumi.CustomResource { /// - /// The name of an Amazon S3 bucket that contains database installation files for your CEV. For example, a valid bucket name is `my-custom-installation-files`. + /// The name of an Amazon S3 bucket that contains database installation files for your CEV. For example, a valid bucket name is ``my-custom-installation-files``. /// [Output("databaseInstallationFilesS3BucketName")] public Output DatabaseInstallationFilesS3BucketName { get; private set; } = null!; /// - /// The Amazon S3 directory that contains the database installation files for your CEV. For example, a valid bucket name is `123456789012/cev1`. If this setting isn't specified, no prefix is assumed. + /// The Amazon S3 directory that contains the database installation files for your CEV. For example, a valid bucket name is ``123456789012/cev1``. If this setting isn't specified, no prefix is assumed. /// [Output("databaseInstallationFilesS3Prefix")] public Output DatabaseInstallationFilesS3Prefix { get; private set; } = null!; @@ -40,55 +40,65 @@ public partial class CustomDbEngineVersion : global::Pulumi.CustomResource public Output Description { get; private set; } = null!; /// - /// The database engine to use for your custom engine version (CEV). The only supported value is `custom-oracle-ee`. + /// The database engine to use for your custom engine version (CEV). + /// Valid values: + /// + ``custom-oracle-ee`` + /// + ``custom-oracle-ee-cdb`` /// [Output("engine")] public Output Engine { get; private set; } = null!; /// - /// The name of your CEV. The name format is 19.customized_string . For example, a valid name is 19.my_cev1. This setting is required for RDS Custom for Oracle, but optional for Amazon RDS. The combination of Engine and EngineVersion is unique per customer per Region. + /// The name of your CEV. The name format is ``major version.customized_string``. For example, a valid CEV name is ``19.my_cev1``. This setting is required for RDS Custom for Oracle, but optional for Amazon RDS. The combination of ``Engine`` and ``EngineVersion`` is unique per customer per Region. + /// *Constraints:* Minimum length is 1. Maximum length is 60. + /// *Pattern:* ``^[a-z0-9_.-]{1,60$``} /// [Output("engineVersion")] public Output EngineVersion { get; private set; } = null!; /// - /// The identifier of Amazon Machine Image (AMI) used for CEV. + /// A value that indicates the ID of the AMI. /// [Output("imageId")] public Output ImageId { get; private set; } = null!; /// - /// The AWS KMS key identifier for an encrypted CEV. A symmetric KMS key is required for RDS Custom, but optional for Amazon RDS. + /// The AWS KMS key identifier for an encrypted CEV. A symmetric encryption KMS key is required for RDS Custom, but optional for Amazon RDS. + /// If you have an existing symmetric encryption KMS key in your account, you can use it with RDS Custom. No further action is necessary. If you don't already have a symmetric encryption KMS key in your account, follow the instructions in [Creating a symmetric encryption KMS key](https://docs.aws.amazon.com/kms/latest/developerguide/create-keys.html#create-symmetric-cmk) in the *Key Management Service Developer Guide*. + /// You can choose the same symmetric encryption key when you create a CEV and a DB instance, or choose different keys. /// [Output("kmsKeyId")] public Output KmsKeyId { get; private set; } = null!; /// /// The CEV manifest, which is a JSON document that describes the installation .zip files stored in Amazon S3. Specify the name/value pairs in a file or a quoted string. RDS Custom applies the patches in the order in which they are listed. + /// The following JSON fields are valid: + /// + MediaImportTemplateVersion Version of the CEV manifest. The date is in the format YYYY-MM-DD. + databaseInstallationFileNames Ordered list of installation files for the CEV. + opatchFileNames Ordered list of OPatch installers used for the Oracle DB engine. + psuRuPatchFileNames The PSU and RU patches for this CEV. + OtherPatchFileNames The patches that are not in the list of PSU and RU patches. Amazon RDS applies these patches after applying the PSU and RU patches. + /// For more information, see [Creating the CEV manifest](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/custom-cev.html#custom-cev.preparing.manifest) in the *Amazon RDS User Guide*. /// [Output("manifest")] public Output Manifest { get; private set; } = null!; /// - /// The identifier of the source custom engine version. + /// The ARN of a CEV to use as a source for creating a new CEV. You can specify a different Amazon Machine Imagine (AMI) by using either ``Source`` or ``UseAwsProvidedLatestImage``. You can't specify a different JSON manifest when you specify ``SourceCustomDbEngineVersionIdentifier``. /// [Output("sourceCustomDbEngineVersionIdentifier")] public Output SourceCustomDbEngineVersionIdentifier { get; private set; } = null!; /// - /// The availability status to be assigned to the CEV. + /// A value that indicates the status of a custom engine version (CEV). /// [Output("status")] public Output Status { get; private set; } = null!; /// - /// An array of key-value pairs to apply to this resource. + /// A list of tags. For more information, see [Tagging Amazon RDS Resources](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_Tagging.html) in the *Amazon RDS User Guide.* /// [Output("tags")] public Output> Tags { get; private set; } = null!; /// - /// A value that indicates whether AWS provided latest image is applied automatically to the Custom Engine Version. By default, AWS provided latest image is applied automatically. This value is only applied on create. + /// Specifies whether to use the latest service-provided Amazon Machine Image (AMI) for the CEV. If you specify ``UseAwsProvidedLatestImage``, you can't also specify ``ImageId``. /// [Output("useAwsProvidedLatestImage")] public Output UseAwsProvidedLatestImage { get; private set; } = null!; @@ -151,13 +161,13 @@ public static CustomDbEngineVersion Get(string name, Input id, CustomRes public sealed class CustomDbEngineVersionArgs : global::Pulumi.ResourceArgs { /// - /// The name of an Amazon S3 bucket that contains database installation files for your CEV. For example, a valid bucket name is `my-custom-installation-files`. + /// The name of an Amazon S3 bucket that contains database installation files for your CEV. For example, a valid bucket name is ``my-custom-installation-files``. /// [Input("databaseInstallationFilesS3BucketName")] public Input? DatabaseInstallationFilesS3BucketName { get; set; } /// - /// The Amazon S3 directory that contains the database installation files for your CEV. For example, a valid bucket name is `123456789012/cev1`. If this setting isn't specified, no prefix is assumed. + /// The Amazon S3 directory that contains the database installation files for your CEV. For example, a valid bucket name is ``123456789012/cev1``. If this setting isn't specified, no prefix is assumed. /// [Input("databaseInstallationFilesS3Prefix")] public Input? DatabaseInstallationFilesS3Prefix { get; set; } @@ -169,43 +179,53 @@ public sealed class CustomDbEngineVersionArgs : global::Pulumi.ResourceArgs public Input? Description { get; set; } /// - /// The database engine to use for your custom engine version (CEV). The only supported value is `custom-oracle-ee`. + /// The database engine to use for your custom engine version (CEV). + /// Valid values: + /// + ``custom-oracle-ee`` + /// + ``custom-oracle-ee-cdb`` /// [Input("engine", required: true)] public Input Engine { get; set; } = null!; /// - /// The name of your CEV. The name format is 19.customized_string . For example, a valid name is 19.my_cev1. This setting is required for RDS Custom for Oracle, but optional for Amazon RDS. The combination of Engine and EngineVersion is unique per customer per Region. + /// The name of your CEV. The name format is ``major version.customized_string``. For example, a valid CEV name is ``19.my_cev1``. This setting is required for RDS Custom for Oracle, but optional for Amazon RDS. The combination of ``Engine`` and ``EngineVersion`` is unique per customer per Region. + /// *Constraints:* Minimum length is 1. Maximum length is 60. + /// *Pattern:* ``^[a-z0-9_.-]{1,60$``} /// [Input("engineVersion", required: true)] public Input EngineVersion { get; set; } = null!; /// - /// The identifier of Amazon Machine Image (AMI) used for CEV. + /// A value that indicates the ID of the AMI. /// [Input("imageId")] public Input? ImageId { get; set; } /// - /// The AWS KMS key identifier for an encrypted CEV. A symmetric KMS key is required for RDS Custom, but optional for Amazon RDS. + /// The AWS KMS key identifier for an encrypted CEV. A symmetric encryption KMS key is required for RDS Custom, but optional for Amazon RDS. + /// If you have an existing symmetric encryption KMS key in your account, you can use it with RDS Custom. No further action is necessary. If you don't already have a symmetric encryption KMS key in your account, follow the instructions in [Creating a symmetric encryption KMS key](https://docs.aws.amazon.com/kms/latest/developerguide/create-keys.html#create-symmetric-cmk) in the *Key Management Service Developer Guide*. + /// You can choose the same symmetric encryption key when you create a CEV and a DB instance, or choose different keys. /// [Input("kmsKeyId")] public Input? KmsKeyId { get; set; } /// /// The CEV manifest, which is a JSON document that describes the installation .zip files stored in Amazon S3. Specify the name/value pairs in a file or a quoted string. RDS Custom applies the patches in the order in which they are listed. + /// The following JSON fields are valid: + /// + MediaImportTemplateVersion Version of the CEV manifest. The date is in the format YYYY-MM-DD. + databaseInstallationFileNames Ordered list of installation files for the CEV. + opatchFileNames Ordered list of OPatch installers used for the Oracle DB engine. + psuRuPatchFileNames The PSU and RU patches for this CEV. + OtherPatchFileNames The patches that are not in the list of PSU and RU patches. Amazon RDS applies these patches after applying the PSU and RU patches. + /// For more information, see [Creating the CEV manifest](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/custom-cev.html#custom-cev.preparing.manifest) in the *Amazon RDS User Guide*. /// [Input("manifest")] public Input? Manifest { get; set; } /// - /// The identifier of the source custom engine version. + /// The ARN of a CEV to use as a source for creating a new CEV. You can specify a different Amazon Machine Imagine (AMI) by using either ``Source`` or ``UseAwsProvidedLatestImage``. You can't specify a different JSON manifest when you specify ``SourceCustomDbEngineVersionIdentifier``. /// [Input("sourceCustomDbEngineVersionIdentifier")] public Input? SourceCustomDbEngineVersionIdentifier { get; set; } /// - /// The availability status to be assigned to the CEV. + /// A value that indicates the status of a custom engine version (CEV). /// [Input("status")] public Input? Status { get; set; } @@ -214,7 +234,7 @@ public sealed class CustomDbEngineVersionArgs : global::Pulumi.ResourceArgs private InputList? _tags; /// - /// An array of key-value pairs to apply to this resource. + /// A list of tags. For more information, see [Tagging Amazon RDS Resources](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_Tagging.html) in the *Amazon RDS User Guide.* /// public InputList Tags { @@ -223,7 +243,7 @@ public InputList Tags } /// - /// A value that indicates whether AWS provided latest image is applied automatically to the Custom Engine Version. By default, AWS provided latest image is applied automatically. This value is only applied on create. + /// Specifies whether to use the latest service-provided Amazon Machine Image (AMI) for the CEV. If you specify ``UseAwsProvidedLatestImage``, you can't also specify ``ImageId``. /// [Input("useAwsProvidedLatestImage")] public Input? UseAwsProvidedLatestImage { get; set; } diff --git a/sdk/dotnet/Rds/Enums.cs b/sdk/dotnet/Rds/Enums.cs index 1ffe793954..69a26c5c50 100644 --- a/sdk/dotnet/Rds/Enums.cs +++ b/sdk/dotnet/Rds/Enums.cs @@ -8,7 +8,7 @@ namespace Pulumi.AwsNative.Rds { /// - /// The availability status to be assigned to the CEV. + /// A value that indicates the status of a custom engine version (CEV). /// [EnumType] public readonly struct CustomDbEngineVersionStatus : IEquatable diff --git a/sdk/dotnet/Rds/GetCustomDbEngineVersion.cs b/sdk/dotnet/Rds/GetCustomDbEngineVersion.cs index b424e95b5b..ca471db498 100644 --- a/sdk/dotnet/Rds/GetCustomDbEngineVersion.cs +++ b/sdk/dotnet/Rds/GetCustomDbEngineVersion.cs @@ -12,13 +12,13 @@ namespace Pulumi.AwsNative.Rds public static class GetCustomDbEngineVersion { /// - /// The AWS::RDS::CustomDBEngineVersion resource creates an Amazon RDS custom DB engine version. + /// Creates a custom DB engine version (CEV). /// public static Task InvokeAsync(GetCustomDbEngineVersionArgs args, InvokeOptions? options = null) => global::Pulumi.Deployment.Instance.InvokeAsync("aws-native:rds:getCustomDbEngineVersion", args ?? new GetCustomDbEngineVersionArgs(), options.WithDefaults()); /// - /// The AWS::RDS::CustomDBEngineVersion resource creates an Amazon RDS custom DB engine version. + /// Creates a custom DB engine version (CEV). /// public static Output Invoke(GetCustomDbEngineVersionInvokeArgs args, InvokeOptions? options = null) => global::Pulumi.Deployment.Instance.Invoke("aws-native:rds:getCustomDbEngineVersion", args ?? new GetCustomDbEngineVersionInvokeArgs(), options.WithDefaults()); @@ -28,13 +28,18 @@ public static Output Invoke(GetCustomDbEngineVer public sealed class GetCustomDbEngineVersionArgs : global::Pulumi.InvokeArgs { /// - /// The database engine to use for your custom engine version (CEV). The only supported value is `custom-oracle-ee`. + /// The database engine to use for your custom engine version (CEV). + /// Valid values: + /// + ``custom-oracle-ee`` + /// + ``custom-oracle-ee-cdb`` /// [Input("engine", required: true)] public string Engine { get; set; } = null!; /// - /// The name of your CEV. The name format is 19.customized_string . For example, a valid name is 19.my_cev1. This setting is required for RDS Custom for Oracle, but optional for Amazon RDS. The combination of Engine and EngineVersion is unique per customer per Region. + /// The name of your CEV. The name format is ``major version.customized_string``. For example, a valid CEV name is ``19.my_cev1``. This setting is required for RDS Custom for Oracle, but optional for Amazon RDS. The combination of ``Engine`` and ``EngineVersion`` is unique per customer per Region. + /// *Constraints:* Minimum length is 1. Maximum length is 60. + /// *Pattern:* ``^[a-z0-9_.-]{1,60$``} /// [Input("engineVersion", required: true)] public string EngineVersion { get; set; } = null!; @@ -48,13 +53,18 @@ public GetCustomDbEngineVersionArgs() public sealed class GetCustomDbEngineVersionInvokeArgs : global::Pulumi.InvokeArgs { /// - /// The database engine to use for your custom engine version (CEV). The only supported value is `custom-oracle-ee`. + /// The database engine to use for your custom engine version (CEV). + /// Valid values: + /// + ``custom-oracle-ee`` + /// + ``custom-oracle-ee-cdb`` /// [Input("engine", required: true)] public Input Engine { get; set; } = null!; /// - /// The name of your CEV. The name format is 19.customized_string . For example, a valid name is 19.my_cev1. This setting is required for RDS Custom for Oracle, but optional for Amazon RDS. The combination of Engine and EngineVersion is unique per customer per Region. + /// The name of your CEV. The name format is ``major version.customized_string``. For example, a valid CEV name is ``19.my_cev1``. This setting is required for RDS Custom for Oracle, but optional for Amazon RDS. The combination of ``Engine`` and ``EngineVersion`` is unique per customer per Region. + /// *Constraints:* Minimum length is 1. Maximum length is 60. + /// *Pattern:* ``^[a-z0-9_.-]{1,60$``} /// [Input("engineVersion", required: true)] public Input EngineVersion { get; set; } = null!; @@ -78,11 +88,11 @@ public sealed class GetCustomDbEngineVersionResult /// public readonly string? Description; /// - /// The availability status to be assigned to the CEV. + /// A value that indicates the status of a custom engine version (CEV). /// public readonly Pulumi.AwsNative.Rds.CustomDbEngineVersionStatus? Status; /// - /// An array of key-value pairs to apply to this resource. + /// A list of tags. For more information, see [Tagging Amazon RDS Resources](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_Tagging.html) in the *Amazon RDS User Guide.* /// public readonly ImmutableArray Tags; diff --git a/sdk/dotnet/RedshiftServerless/Enums.cs b/sdk/dotnet/RedshiftServerless/Enums.cs index df2ef6a427..5e16c28d77 100644 --- a/sdk/dotnet/RedshiftServerless/Enums.cs +++ b/sdk/dotnet/RedshiftServerless/Enums.cs @@ -65,6 +65,34 @@ private NamespaceStatus(string value) public override string ToString() => _value; } + [EnumType] + public readonly struct WorkgroupPerformanceTargetStatus : IEquatable + { + private readonly string _value; + + private WorkgroupPerformanceTargetStatus(string value) + { + _value = value ?? throw new ArgumentNullException(nameof(value)); + } + + public static WorkgroupPerformanceTargetStatus Enabled { get; } = new WorkgroupPerformanceTargetStatus("ENABLED"); + public static WorkgroupPerformanceTargetStatus Disabled { get; } = new WorkgroupPerformanceTargetStatus("DISABLED"); + + public static bool operator ==(WorkgroupPerformanceTargetStatus left, WorkgroupPerformanceTargetStatus right) => left.Equals(right); + public static bool operator !=(WorkgroupPerformanceTargetStatus left, WorkgroupPerformanceTargetStatus right) => !left.Equals(right); + + public static explicit operator string(WorkgroupPerformanceTargetStatus value) => value._value; + + [EditorBrowsable(EditorBrowsableState.Never)] + public override bool Equals(object? obj) => obj is WorkgroupPerformanceTargetStatus other && Equals(other); + public bool Equals(WorkgroupPerformanceTargetStatus other) => string.Equals(_value, other._value, StringComparison.Ordinal); + + [EditorBrowsable(EditorBrowsableState.Never)] + public override int GetHashCode() => _value?.GetHashCode() ?? 0; + + public override string ToString() => _value; + } + [EnumType] public readonly struct WorkgroupStatus : IEquatable { diff --git a/sdk/dotnet/RedshiftServerless/GetWorkgroup.cs b/sdk/dotnet/RedshiftServerless/GetWorkgroup.cs index d7bfeae5bb..cfdfccc0d5 100644 --- a/sdk/dotnet/RedshiftServerless/GetWorkgroup.cs +++ b/sdk/dotnet/RedshiftServerless/GetWorkgroup.cs @@ -66,6 +66,10 @@ public sealed class GetWorkgroupResult /// public readonly int? Port; /// + /// A property that represents the price performance target settings for the workgroup. + /// + public readonly Outputs.WorkgroupPerformanceTarget? PricePerformanceTarget; + /// /// A value that specifies whether the workgroup can be accessible from a public network. /// public readonly bool? PubliclyAccessible; @@ -84,6 +88,8 @@ private GetWorkgroupResult( int? port, + Outputs.WorkgroupPerformanceTarget? pricePerformanceTarget, + bool? publiclyAccessible, ImmutableArray tags, @@ -92,6 +98,7 @@ private GetWorkgroupResult( { EnhancedVpcRouting = enhancedVpcRouting; Port = port; + PricePerformanceTarget = pricePerformanceTarget; PubliclyAccessible = publiclyAccessible; Tags = tags; WorkgroupValue = workgroup; diff --git a/sdk/dotnet/RedshiftServerless/Inputs/WorkgroupPerformanceTargetArgs.cs b/sdk/dotnet/RedshiftServerless/Inputs/WorkgroupPerformanceTargetArgs.cs new file mode 100644 index 0000000000..c5fb15ebad --- /dev/null +++ b/sdk/dotnet/RedshiftServerless/Inputs/WorkgroupPerformanceTargetArgs.cs @@ -0,0 +1,26 @@ +// *** WARNING: this file was generated by pulumi. *** +// *** Do not edit by hand unless you're certain you know what you are doing! *** + +using System; +using System.Collections.Generic; +using System.Collections.Immutable; +using System.Threading.Tasks; +using Pulumi.Serialization; + +namespace Pulumi.AwsNative.RedshiftServerless.Inputs +{ + + public sealed class WorkgroupPerformanceTargetArgs : global::Pulumi.ResourceArgs + { + [Input("level")] + public Input? Level { get; set; } + + [Input("status")] + public Input? Status { get; set; } + + public WorkgroupPerformanceTargetArgs() + { + } + public static new WorkgroupPerformanceTargetArgs Empty => new WorkgroupPerformanceTargetArgs(); + } +} diff --git a/sdk/dotnet/RedshiftServerless/Outputs/Workgroup.cs b/sdk/dotnet/RedshiftServerless/Outputs/Workgroup.cs index d9cf9d6094..6a184ebe57 100644 --- a/sdk/dotnet/RedshiftServerless/Outputs/Workgroup.cs +++ b/sdk/dotnet/RedshiftServerless/Outputs/Workgroup.cs @@ -41,6 +41,7 @@ public sealed class Workgroup /// The namespace the workgroup is associated with. /// public readonly string? NamespaceName; + public readonly Outputs.WorkgroupPerformanceTarget? PricePerformanceTarget; /// /// A value that specifies whether the workgroup can be accessible from a public network. /// @@ -86,6 +87,8 @@ private Workgroup( string? namespaceName, + Outputs.WorkgroupPerformanceTarget? pricePerformanceTarget, + bool? publiclyAccessible, ImmutableArray securityGroupIds, @@ -107,6 +110,7 @@ private Workgroup( EnhancedVpcRouting = enhancedVpcRouting; MaxCapacity = maxCapacity; NamespaceName = namespaceName; + PricePerformanceTarget = pricePerformanceTarget; PubliclyAccessible = publiclyAccessible; SecurityGroupIds = securityGroupIds; Status = status; diff --git a/sdk/dotnet/RedshiftServerless/Outputs/WorkgroupPerformanceTarget.cs b/sdk/dotnet/RedshiftServerless/Outputs/WorkgroupPerformanceTarget.cs new file mode 100644 index 0000000000..1fbcc6340c --- /dev/null +++ b/sdk/dotnet/RedshiftServerless/Outputs/WorkgroupPerformanceTarget.cs @@ -0,0 +1,29 @@ +// *** WARNING: this file was generated by pulumi. *** +// *** Do not edit by hand unless you're certain you know what you are doing! *** + +using System; +using System.Collections.Generic; +using System.Collections.Immutable; +using System.Threading.Tasks; +using Pulumi.Serialization; + +namespace Pulumi.AwsNative.RedshiftServerless.Outputs +{ + + [OutputType] + public sealed class WorkgroupPerformanceTarget + { + public readonly int? Level; + public readonly Pulumi.AwsNative.RedshiftServerless.WorkgroupPerformanceTargetStatus? Status; + + [OutputConstructor] + private WorkgroupPerformanceTarget( + int? level, + + Pulumi.AwsNative.RedshiftServerless.WorkgroupPerformanceTargetStatus? status) + { + Level = level; + Status = status; + } + } +} diff --git a/sdk/dotnet/RedshiftServerless/Workgroup.cs b/sdk/dotnet/RedshiftServerless/Workgroup.cs index a08a8b738e..4017326335 100644 --- a/sdk/dotnet/RedshiftServerless/Workgroup.cs +++ b/sdk/dotnet/RedshiftServerless/Workgroup.cs @@ -51,6 +51,12 @@ public partial class Workgroup : global::Pulumi.CustomResource [Output("port")] public Output Port { get; private set; } = null!; + /// + /// A property that represents the price performance target settings for the workgroup. + /// + [Output("pricePerformanceTarget")] + public Output PricePerformanceTarget { get; private set; } = null!; + /// /// A value that specifies whether the workgroup can be accessible from a public network. /// @@ -179,6 +185,12 @@ public InputList ConfigParameters [Input("port")] public Input? Port { get; set; } + /// + /// A property that represents the price performance target settings for the workgroup. + /// + [Input("pricePerformanceTarget")] + public Input? PricePerformanceTarget { get; set; } + /// /// A value that specifies whether the workgroup can be accessible from a public network. /// diff --git a/sdk/dotnet/S3/Bucket.cs b/sdk/dotnet/S3/Bucket.cs index 606224dcac..1cbbfea36b 100644 --- a/sdk/dotnet/S3/Bucket.cs +++ b/sdk/dotnet/S3/Bucket.cs @@ -948,6 +948,9 @@ public partial class Bucket : global::Pulumi.CustomResource [Output("loggingConfiguration")] public Output LoggingConfiguration { get; private set; } = null!; + [Output("metadataTableConfiguration")] + public Output MetadataTableConfiguration { get; private set; } = null!; + /// /// Specifies a metrics configuration for the CloudWatch request metrics (specified by the metrics configuration ID) from an Amazon S3 bucket. If you're updating an existing metrics configuration, note that this is a full replacement of the existing metrics configuration. If you don't include the elements you want to keep, they are erased. For more information, see [PutBucketMetricsConfiguration](https://docs.aws.amazon.com/AmazonS3/latest/API/RESTBucketPUTMetricConfiguration.html). /// @@ -1163,6 +1166,9 @@ public InputList InventoryConfiguration [Input("loggingConfiguration")] public Input? LoggingConfiguration { get; set; } + [Input("metadataTableConfiguration")] + public Input? MetadataTableConfiguration { get; set; } + [Input("metricsConfigurations")] private InputList? _metricsConfigurations; diff --git a/sdk/dotnet/S3/GetBucket.cs b/sdk/dotnet/S3/GetBucket.cs index 2d31f18ac3..23e50d13d2 100644 --- a/sdk/dotnet/S3/GetBucket.cs +++ b/sdk/dotnet/S3/GetBucket.cs @@ -115,6 +115,7 @@ public sealed class GetBucketResult /// Settings that define where logs are stored. /// public readonly Outputs.BucketLoggingConfiguration? LoggingConfiguration; + public readonly Outputs.BucketMetadataTableConfiguration? MetadataTableConfiguration; /// /// Specifies a metrics configuration for the CloudWatch request metrics (specified by the metrics configuration ID) from an Amazon S3 bucket. If you're updating an existing metrics configuration, note that this is a full replacement of the existing metrics configuration. If you don't include the elements you want to keep, they are erased. For more information, see [PutBucketMetricsConfiguration](https://docs.aws.amazon.com/AmazonS3/latest/API/RESTBucketPUTMetricConfiguration.html). /// @@ -200,6 +201,8 @@ private GetBucketResult( Outputs.BucketLoggingConfiguration? loggingConfiguration, + Outputs.BucketMetadataTableConfiguration? metadataTableConfiguration, + ImmutableArray metricsConfigurations, Outputs.BucketNotificationConfiguration? notificationConfiguration, @@ -235,6 +238,7 @@ private GetBucketResult( InventoryConfigurations = inventoryConfigurations; LifecycleConfiguration = lifecycleConfiguration; LoggingConfiguration = loggingConfiguration; + MetadataTableConfiguration = metadataTableConfiguration; MetricsConfigurations = metricsConfigurations; NotificationConfiguration = notificationConfiguration; ObjectLockConfiguration = objectLockConfiguration; diff --git a/sdk/dotnet/S3/Inputs/BucketMetadataTableConfigurationArgs.cs b/sdk/dotnet/S3/Inputs/BucketMetadataTableConfigurationArgs.cs new file mode 100644 index 0000000000..352d2f8186 --- /dev/null +++ b/sdk/dotnet/S3/Inputs/BucketMetadataTableConfigurationArgs.cs @@ -0,0 +1,35 @@ +// *** WARNING: this file was generated by pulumi. *** +// *** Do not edit by hand unless you're certain you know what you are doing! *** + +using System; +using System.Collections.Generic; +using System.Collections.Immutable; +using System.Threading.Tasks; +using Pulumi.Serialization; + +namespace Pulumi.AwsNative.S3.Inputs +{ + + public sealed class BucketMetadataTableConfigurationArgs : global::Pulumi.ResourceArgs + { + /// + /// Returns the <code>Error</code> value of the GetBucketMetadataTableConfiguration response. + /// + [Input("error")] + public Input? Error { get; set; } + + [Input("s3TablesDestination", required: true)] + public Input S3TablesDestination { get; set; } = null!; + + /// + /// Returns the <code>Status</code> value of the <code>GetBucketMetadataTableConfigurationResult</code> response. This value indicates the status of the metadata table. The status values are:<br/><code>CREATING</code> - The metadata table is in the process of being created in the specified table bucket.<br/><code>ACTIVE</code> - The metadata table has been created successfully and records are being delivered to the table.<br/><code>FAILED</code> - Amazon S3 is unable to create the metadata table, or Amazon S3 is unable to deliver records. + /// + [Input("status")] + public Input? Status { get; set; } + + public BucketMetadataTableConfigurationArgs() + { + } + public static new BucketMetadataTableConfigurationArgs Empty => new BucketMetadataTableConfigurationArgs(); + } +} diff --git a/sdk/dotnet/S3/Inputs/BucketMetadataTableErrorArgs.cs b/sdk/dotnet/S3/Inputs/BucketMetadataTableErrorArgs.cs new file mode 100644 index 0000000000..ccd338c169 --- /dev/null +++ b/sdk/dotnet/S3/Inputs/BucketMetadataTableErrorArgs.cs @@ -0,0 +1,32 @@ +// *** WARNING: this file was generated by pulumi. *** +// *** Do not edit by hand unless you're certain you know what you are doing! *** + +using System; +using System.Collections.Generic; +using System.Collections.Immutable; +using System.Threading.Tasks; +using Pulumi.Serialization; + +namespace Pulumi.AwsNative.S3.Inputs +{ + + public sealed class BucketMetadataTableErrorArgs : global::Pulumi.ResourceArgs + { + /// + /// If the <code>CreateBucketMetadataTableConfiguration</code> request succeeds, but S3 Metadata was unable to create the table, this structure contains the error code. The possible error codes and error messages are as follows:<br/><code>AccessDeniedCreatingResources</code> - You don't have sufficient permissions to create the required resources. Make sure that you have <code>s3tables:CreateNamespace</code>, <code>s3tables:CreateTable</code>, <code>s3tables:GetTable</code> and <code>s3tables:PutTablePolicy</code> permissions, and then try again. To create a new metadata table, you must delete the metadata configuration for this bucket, and then create a new metadata configuration.<br/><code>AccessDeniedWritingToTable</code> - Unable to write to the metadata table because of missing resource permissions. To fix the resource policy, Amazon S3 needs to create a new metadata table. To create a new metadata table, you must delete the metadata configuration for this bucket, and then create a new metadata configuration.<br/><code>DestinationTableNotFound</code> - The destination table doesn't exist. To create a new metadata table, you must delete the metadata configuration for this bucket, and then create a new metadata configuration.<br/><code>ServerInternalError</code> - An internal error has occurred. To create a new metadata table, you must delete the metadata configuration for this bucket, and then create a new metadata configuration.<br/><code>TableAlreadyExists</code> - The table that you specified already exists in the table bucket's namespace. Specify a different table name. To create a new metadata table, you must delete the metadata configuration for this bucket, and then create a new metadata configuration.<br/><code>TableBucketNotFound</code> - The table bucket that you specified doesn't exist in this AWS Region and account. Create or choose a different table bucket. To create a new metadata table, you must delete the metadata configuration for this bucket, and then create a new metadata configuration. + /// + [Input("errorCode", required: true)] + public Input ErrorCode { get; set; } = null!; + + /// + /// If the <code>CreateBucketMetadataTableConfiguration</code> request succeeds, but S3 Metadata was unable to create the table, this structure contains the error code. The possible error codes and error messages are as follows:<br/><code>AccessDeniedCreatingResources</code> - You don't have sufficient permissions to create the required resources. Make sure that you have <code>s3tables:CreateNamespace</code>, <code>s3tables:CreateTable</code>, <code>s3tables:GetTable</code> and <code>s3tables:PutTablePolicy</code> permissions, and then try again. To create a new metadata table, you must delete the metadata configuration for this bucket, and then create a new metadata configuration.<br/><code>AccessDeniedWritingToTable</code> - Unable to write to the metadata table because of missing resource permissions. To fix the resource policy, Amazon S3 needs to create a new metadata table. To create a new metadata table, you must delete the metadata configuration for this bucket, and then create a new metadata configuration.<br/><code>DestinationTableNotFound</code> - The destination table doesn't exist. To create a new metadata table, you must delete the metadata configuration for this bucket, and then create a new metadata configuration.<br/><code>ServerInternalError</code> - An internal error has occurred. To create a new metadata table, you must delete the metadata configuration for this bucket, and then create a new metadata configuration.<br/><code>TableAlreadyExists</code> - The table that you specified already exists in the table bucket's namespace. Specify a different table name. To create a new metadata table, you must delete the metadata configuration for this bucket, and then create a new metadata configuration.<br/><code>TableBucketNotFound</code> - The table bucket that you specified doesn't exist in this AWS Region and account. Create or choose a different table bucket. To create a new metadata table, you must delete the metadata configuration for this bucket, and then create a new metadata configuration. + /// + [Input("errorMessage", required: true)] + public Input ErrorMessage { get; set; } = null!; + + public BucketMetadataTableErrorArgs() + { + } + public static new BucketMetadataTableErrorArgs Empty => new BucketMetadataTableErrorArgs(); + } +} diff --git a/sdk/dotnet/S3/Inputs/BucketS3TablesDestinationArgs.cs b/sdk/dotnet/S3/Inputs/BucketS3TablesDestinationArgs.cs new file mode 100644 index 0000000000..a40c005204 --- /dev/null +++ b/sdk/dotnet/S3/Inputs/BucketS3TablesDestinationArgs.cs @@ -0,0 +1,44 @@ +// *** WARNING: this file was generated by pulumi. *** +// *** Do not edit by hand unless you're certain you know what you are doing! *** + +using System; +using System.Collections.Generic; +using System.Collections.Immutable; +using System.Threading.Tasks; +using Pulumi.Serialization; + +namespace Pulumi.AwsNative.S3.Inputs +{ + + public sealed class BucketS3TablesDestinationArgs : global::Pulumi.ResourceArgs + { + /// + /// The Amazon Resource Name (ARN) for the metadata table in the metadata table configuration. The specified metadata table name must be unique within the <code>aws_s3_metadata</code> namespace in the destination table bucket. + /// + [Input("tableArn")] + public Input? TableArn { get; set; } + + /// + /// The Amazon Resource Name (ARN) for the table bucket that's specified as the destination in the metadata table configuration. The destination table bucket must be in the same Region and AWS account as the general purpose bucket. + /// + [Input("tableBucketArn", required: true)] + public Input TableBucketArn { get; set; } = null!; + + /// + /// The name for the metadata table in your metadata table configuration. The specified metadata table name must be unique within the <code>aws_s3_metadata</code> namespace in the destination table bucket. + /// + [Input("tableName", required: true)] + public Input TableName { get; set; } = null!; + + /// + /// The table bucket namespace for the metadata table in your metadata table configuration. This value is always <code>aws_s3_metadata</code>. + /// + [Input("tableNamespace")] + public Input? TableNamespace { get; set; } + + public BucketS3TablesDestinationArgs() + { + } + public static new BucketS3TablesDestinationArgs Empty => new BucketS3TablesDestinationArgs(); + } +} diff --git a/sdk/dotnet/S3/Outputs/BucketMetadataTableConfiguration.cs b/sdk/dotnet/S3/Outputs/BucketMetadataTableConfiguration.cs new file mode 100644 index 0000000000..933aadd41b --- /dev/null +++ b/sdk/dotnet/S3/Outputs/BucketMetadataTableConfiguration.cs @@ -0,0 +1,39 @@ +// *** WARNING: this file was generated by pulumi. *** +// *** Do not edit by hand unless you're certain you know what you are doing! *** + +using System; +using System.Collections.Generic; +using System.Collections.Immutable; +using System.Threading.Tasks; +using Pulumi.Serialization; + +namespace Pulumi.AwsNative.S3.Outputs +{ + + [OutputType] + public sealed class BucketMetadataTableConfiguration + { + /// + /// Returns the <code>Error</code> value of the GetBucketMetadataTableConfiguration response. + /// + public readonly Outputs.BucketMetadataTableError? Error; + public readonly Outputs.BucketS3TablesDestination S3TablesDestination; + /// + /// Returns the <code>Status</code> value of the <code>GetBucketMetadataTableConfigurationResult</code> response. This value indicates the status of the metadata table. The status values are:<br/><code>CREATING</code> - The metadata table is in the process of being created in the specified table bucket.<br/><code>ACTIVE</code> - The metadata table has been created successfully and records are being delivered to the table.<br/><code>FAILED</code> - Amazon S3 is unable to create the metadata table, or Amazon S3 is unable to deliver records. + /// + public readonly string? Status; + + [OutputConstructor] + private BucketMetadataTableConfiguration( + Outputs.BucketMetadataTableError? error, + + Outputs.BucketS3TablesDestination s3TablesDestination, + + string? status) + { + Error = error; + S3TablesDestination = s3TablesDestination; + Status = status; + } + } +} diff --git a/sdk/dotnet/S3/Outputs/BucketMetadataTableError.cs b/sdk/dotnet/S3/Outputs/BucketMetadataTableError.cs new file mode 100644 index 0000000000..061afdc2f1 --- /dev/null +++ b/sdk/dotnet/S3/Outputs/BucketMetadataTableError.cs @@ -0,0 +1,35 @@ +// *** WARNING: this file was generated by pulumi. *** +// *** Do not edit by hand unless you're certain you know what you are doing! *** + +using System; +using System.Collections.Generic; +using System.Collections.Immutable; +using System.Threading.Tasks; +using Pulumi.Serialization; + +namespace Pulumi.AwsNative.S3.Outputs +{ + + [OutputType] + public sealed class BucketMetadataTableError + { + /// + /// If the <code>CreateBucketMetadataTableConfiguration</code> request succeeds, but S3 Metadata was unable to create the table, this structure contains the error code. The possible error codes and error messages are as follows:<br/><code>AccessDeniedCreatingResources</code> - You don't have sufficient permissions to create the required resources. Make sure that you have <code>s3tables:CreateNamespace</code>, <code>s3tables:CreateTable</code>, <code>s3tables:GetTable</code> and <code>s3tables:PutTablePolicy</code> permissions, and then try again. To create a new metadata table, you must delete the metadata configuration for this bucket, and then create a new metadata configuration.<br/><code>AccessDeniedWritingToTable</code> - Unable to write to the metadata table because of missing resource permissions. To fix the resource policy, Amazon S3 needs to create a new metadata table. To create a new metadata table, you must delete the metadata configuration for this bucket, and then create a new metadata configuration.<br/><code>DestinationTableNotFound</code> - The destination table doesn't exist. To create a new metadata table, you must delete the metadata configuration for this bucket, and then create a new metadata configuration.<br/><code>ServerInternalError</code> - An internal error has occurred. To create a new metadata table, you must delete the metadata configuration for this bucket, and then create a new metadata configuration.<br/><code>TableAlreadyExists</code> - The table that you specified already exists in the table bucket's namespace. Specify a different table name. To create a new metadata table, you must delete the metadata configuration for this bucket, and then create a new metadata configuration.<br/><code>TableBucketNotFound</code> - The table bucket that you specified doesn't exist in this AWS Region and account. Create or choose a different table bucket. To create a new metadata table, you must delete the metadata configuration for this bucket, and then create a new metadata configuration. + /// + public readonly string ErrorCode; + /// + /// If the <code>CreateBucketMetadataTableConfiguration</code> request succeeds, but S3 Metadata was unable to create the table, this structure contains the error code. The possible error codes and error messages are as follows:<br/><code>AccessDeniedCreatingResources</code> - You don't have sufficient permissions to create the required resources. Make sure that you have <code>s3tables:CreateNamespace</code>, <code>s3tables:CreateTable</code>, <code>s3tables:GetTable</code> and <code>s3tables:PutTablePolicy</code> permissions, and then try again. To create a new metadata table, you must delete the metadata configuration for this bucket, and then create a new metadata configuration.<br/><code>AccessDeniedWritingToTable</code> - Unable to write to the metadata table because of missing resource permissions. To fix the resource policy, Amazon S3 needs to create a new metadata table. To create a new metadata table, you must delete the metadata configuration for this bucket, and then create a new metadata configuration.<br/><code>DestinationTableNotFound</code> - The destination table doesn't exist. To create a new metadata table, you must delete the metadata configuration for this bucket, and then create a new metadata configuration.<br/><code>ServerInternalError</code> - An internal error has occurred. To create a new metadata table, you must delete the metadata configuration for this bucket, and then create a new metadata configuration.<br/><code>TableAlreadyExists</code> - The table that you specified already exists in the table bucket's namespace. Specify a different table name. To create a new metadata table, you must delete the metadata configuration for this bucket, and then create a new metadata configuration.<br/><code>TableBucketNotFound</code> - The table bucket that you specified doesn't exist in this AWS Region and account. Create or choose a different table bucket. To create a new metadata table, you must delete the metadata configuration for this bucket, and then create a new metadata configuration. + /// + public readonly string ErrorMessage; + + [OutputConstructor] + private BucketMetadataTableError( + string errorCode, + + string errorMessage) + { + ErrorCode = errorCode; + ErrorMessage = errorMessage; + } + } +} diff --git a/sdk/dotnet/S3/Outputs/BucketS3TablesDestination.cs b/sdk/dotnet/S3/Outputs/BucketS3TablesDestination.cs new file mode 100644 index 0000000000..afe8a95ce7 --- /dev/null +++ b/sdk/dotnet/S3/Outputs/BucketS3TablesDestination.cs @@ -0,0 +1,49 @@ +// *** WARNING: this file was generated by pulumi. *** +// *** Do not edit by hand unless you're certain you know what you are doing! *** + +using System; +using System.Collections.Generic; +using System.Collections.Immutable; +using System.Threading.Tasks; +using Pulumi.Serialization; + +namespace Pulumi.AwsNative.S3.Outputs +{ + + [OutputType] + public sealed class BucketS3TablesDestination + { + /// + /// The Amazon Resource Name (ARN) for the metadata table in the metadata table configuration. The specified metadata table name must be unique within the <code>aws_s3_metadata</code> namespace in the destination table bucket. + /// + public readonly string? TableArn; + /// + /// The Amazon Resource Name (ARN) for the table bucket that's specified as the destination in the metadata table configuration. The destination table bucket must be in the same Region and AWS account as the general purpose bucket. + /// + public readonly string TableBucketArn; + /// + /// The name for the metadata table in your metadata table configuration. The specified metadata table name must be unique within the <code>aws_s3_metadata</code> namespace in the destination table bucket. + /// + public readonly string TableName; + /// + /// The table bucket namespace for the metadata table in your metadata table configuration. This value is always <code>aws_s3_metadata</code>. + /// + public readonly string? TableNamespace; + + [OutputConstructor] + private BucketS3TablesDestination( + string? tableArn, + + string tableBucketArn, + + string tableName, + + string? tableNamespace) + { + TableArn = tableArn; + TableBucketArn = tableBucketArn; + TableName = tableName; + TableNamespace = tableNamespace; + } + } +} diff --git a/sdk/dotnet/S3Express/DirectoryBucket.cs b/sdk/dotnet/S3Express/DirectoryBucket.cs index 334afa7971..eb3a527acf 100644 --- a/sdk/dotnet/S3Express/DirectoryBucket.cs +++ b/sdk/dotnet/S3Express/DirectoryBucket.cs @@ -22,7 +22,7 @@ public partial class DirectoryBucket : global::Pulumi.CustomResource public Output Arn { get; private set; } = null!; /// - /// Returns the code for the Availability Zone where the directory bucket was created. + /// Returns the code for the Availability Zone or Local Zone where the directory bucket was created. An example for the code of an Availability Zone is 'us-east-1f'. /// [Output("availabilityZoneName")] public Output AvailabilityZoneName { get; private set; } = null!; @@ -34,13 +34,13 @@ public partial class DirectoryBucket : global::Pulumi.CustomResource public Output BucketEncryption { get; private set; } = null!; /// - /// Specifies a name for the bucket. The bucket name must contain only lowercase letters, numbers, and hyphens (-). A directory bucket name must be unique in the chosen Availability Zone. The bucket name must also follow the format 'bucket_base_name--az_id--x-s3' (for example, 'DOC-EXAMPLE-BUCKET--usw2-az1--x-s3'). If you don't specify a name, AWS CloudFormation generates a unique physical ID and uses that ID for the bucket name. + /// Specifies a name for the bucket. The bucket name must contain only lowercase letters, numbers, and hyphens (-). A directory bucket name must be unique in the chosen Availability Zone or Local Zone. The bucket name must also follow the format 'bucket_base_name--zone_id--x-s3'. The zone_id can be the ID of an Availability Zone or a Local Zone. If you don't specify a name, AWS CloudFormation generates a unique physical ID and uses that ID for the bucket name. /// [Output("bucketName")] public Output BucketName { get; private set; } = null!; /// - /// Specifies the number of Availability Zone that's used for redundancy for the bucket. + /// Specifies the number of Availability Zone or Local Zone that's used for redundancy for the bucket. /// [Output("dataRedundancy")] public Output DataRedundancy { get; private set; } = null!; @@ -52,7 +52,7 @@ public partial class DirectoryBucket : global::Pulumi.CustomResource public Output LifecycleConfiguration { get; private set; } = null!; /// - /// Specifies the AZ ID of the Availability Zone where the directory bucket will be created. An example AZ ID value is 'use1-az5'. + /// Specifies the Zone ID of the Availability Zone or Local Zone where the directory bucket will be created. An example Availability Zone ID value is 'use1-az5'. /// [Output("locationName")] public Output LocationName { get; private set; } = null!; @@ -115,13 +115,13 @@ public sealed class DirectoryBucketArgs : global::Pulumi.ResourceArgs public Input? BucketEncryption { get; set; } /// - /// Specifies a name for the bucket. The bucket name must contain only lowercase letters, numbers, and hyphens (-). A directory bucket name must be unique in the chosen Availability Zone. The bucket name must also follow the format 'bucket_base_name--az_id--x-s3' (for example, 'DOC-EXAMPLE-BUCKET--usw2-az1--x-s3'). If you don't specify a name, AWS CloudFormation generates a unique physical ID and uses that ID for the bucket name. + /// Specifies a name for the bucket. The bucket name must contain only lowercase letters, numbers, and hyphens (-). A directory bucket name must be unique in the chosen Availability Zone or Local Zone. The bucket name must also follow the format 'bucket_base_name--zone_id--x-s3'. The zone_id can be the ID of an Availability Zone or a Local Zone. If you don't specify a name, AWS CloudFormation generates a unique physical ID and uses that ID for the bucket name. /// [Input("bucketName")] public Input? BucketName { get; set; } /// - /// Specifies the number of Availability Zone that's used for redundancy for the bucket. + /// Specifies the number of Availability Zone or Local Zone that's used for redundancy for the bucket. /// [Input("dataRedundancy", required: true)] public Input DataRedundancy { get; set; } = null!; @@ -133,7 +133,7 @@ public sealed class DirectoryBucketArgs : global::Pulumi.ResourceArgs public Input? LifecycleConfiguration { get; set; } /// - /// Specifies the AZ ID of the Availability Zone where the directory bucket will be created. An example AZ ID value is 'use1-az5'. + /// Specifies the Zone ID of the Availability Zone or Local Zone where the directory bucket will be created. An example Availability Zone ID value is 'use1-az5'. /// [Input("locationName", required: true)] public Input LocationName { get; set; } = null!; diff --git a/sdk/dotnet/S3Express/Enums.cs b/sdk/dotnet/S3Express/Enums.cs index 37ec5b0b90..480f3fedfe 100644 --- a/sdk/dotnet/S3Express/Enums.cs +++ b/sdk/dotnet/S3Express/Enums.cs @@ -8,7 +8,7 @@ namespace Pulumi.AwsNative.S3Express { /// - /// Specifies the number of Availability Zone that's used for redundancy for the bucket. + /// Specifies the number of Availability Zone or Local Zone that's used for redundancy for the bucket. /// [EnumType] public readonly struct DirectoryBucketDataRedundancy : IEquatable @@ -21,6 +21,7 @@ private DirectoryBucketDataRedundancy(string value) } public static DirectoryBucketDataRedundancy SingleAvailabilityZone { get; } = new DirectoryBucketDataRedundancy("SingleAvailabilityZone"); + public static DirectoryBucketDataRedundancy SingleLocalZone { get; } = new DirectoryBucketDataRedundancy("SingleLocalZone"); public static bool operator ==(DirectoryBucketDataRedundancy left, DirectoryBucketDataRedundancy right) => left.Equals(right); public static bool operator !=(DirectoryBucketDataRedundancy left, DirectoryBucketDataRedundancy right) => !left.Equals(right); diff --git a/sdk/dotnet/S3Express/GetDirectoryBucket.cs b/sdk/dotnet/S3Express/GetDirectoryBucket.cs index 8b5e64ae6c..923a274c6b 100644 --- a/sdk/dotnet/S3Express/GetDirectoryBucket.cs +++ b/sdk/dotnet/S3Express/GetDirectoryBucket.cs @@ -28,7 +28,7 @@ public static Output Invoke(GetDirectoryBucketInvokeAr public sealed class GetDirectoryBucketArgs : global::Pulumi.InvokeArgs { /// - /// Specifies a name for the bucket. The bucket name must contain only lowercase letters, numbers, and hyphens (-). A directory bucket name must be unique in the chosen Availability Zone. The bucket name must also follow the format 'bucket_base_name--az_id--x-s3' (for example, 'DOC-EXAMPLE-BUCKET--usw2-az1--x-s3'). If you don't specify a name, AWS CloudFormation generates a unique physical ID and uses that ID for the bucket name. + /// Specifies a name for the bucket. The bucket name must contain only lowercase letters, numbers, and hyphens (-). A directory bucket name must be unique in the chosen Availability Zone or Local Zone. The bucket name must also follow the format 'bucket_base_name--zone_id--x-s3'. The zone_id can be the ID of an Availability Zone or a Local Zone. If you don't specify a name, AWS CloudFormation generates a unique physical ID and uses that ID for the bucket name. /// [Input("bucketName", required: true)] public string BucketName { get; set; } = null!; @@ -42,7 +42,7 @@ public GetDirectoryBucketArgs() public sealed class GetDirectoryBucketInvokeArgs : global::Pulumi.InvokeArgs { /// - /// Specifies a name for the bucket. The bucket name must contain only lowercase letters, numbers, and hyphens (-). A directory bucket name must be unique in the chosen Availability Zone. The bucket name must also follow the format 'bucket_base_name--az_id--x-s3' (for example, 'DOC-EXAMPLE-BUCKET--usw2-az1--x-s3'). If you don't specify a name, AWS CloudFormation generates a unique physical ID and uses that ID for the bucket name. + /// Specifies a name for the bucket. The bucket name must contain only lowercase letters, numbers, and hyphens (-). A directory bucket name must be unique in the chosen Availability Zone or Local Zone. The bucket name must also follow the format 'bucket_base_name--zone_id--x-s3'. The zone_id can be the ID of an Availability Zone or a Local Zone. If you don't specify a name, AWS CloudFormation generates a unique physical ID and uses that ID for the bucket name. /// [Input("bucketName", required: true)] public Input BucketName { get; set; } = null!; @@ -62,7 +62,7 @@ public sealed class GetDirectoryBucketResult /// public readonly string? Arn; /// - /// Returns the code for the Availability Zone where the directory bucket was created. + /// Returns the code for the Availability Zone or Local Zone where the directory bucket was created. An example for the code of an Availability Zone is 'us-east-1f'. /// public readonly string? AvailabilityZoneName; /// diff --git a/sdk/dotnet/S3Tables/Enums.cs b/sdk/dotnet/S3Tables/Enums.cs new file mode 100644 index 0000000000..9ba37c8c08 --- /dev/null +++ b/sdk/dotnet/S3Tables/Enums.cs @@ -0,0 +1,40 @@ +// *** WARNING: this file was generated by pulumi. *** +// *** Do not edit by hand unless you're certain you know what you are doing! *** + +using System; +using System.ComponentModel; +using Pulumi; + +namespace Pulumi.AwsNative.S3Tables +{ + /// + /// Indicates whether the Unreferenced File Removal maintenance action is enabled. + /// + [EnumType] + public readonly struct TableBucketUnreferencedFileRemovalStatus : IEquatable + { + private readonly string _value; + + private TableBucketUnreferencedFileRemovalStatus(string value) + { + _value = value ?? throw new ArgumentNullException(nameof(value)); + } + + public static TableBucketUnreferencedFileRemovalStatus Enabled { get; } = new TableBucketUnreferencedFileRemovalStatus("Enabled"); + public static TableBucketUnreferencedFileRemovalStatus Disabled { get; } = new TableBucketUnreferencedFileRemovalStatus("Disabled"); + + public static bool operator ==(TableBucketUnreferencedFileRemovalStatus left, TableBucketUnreferencedFileRemovalStatus right) => left.Equals(right); + public static bool operator !=(TableBucketUnreferencedFileRemovalStatus left, TableBucketUnreferencedFileRemovalStatus right) => !left.Equals(right); + + public static explicit operator string(TableBucketUnreferencedFileRemovalStatus value) => value._value; + + [EditorBrowsable(EditorBrowsableState.Never)] + public override bool Equals(object? obj) => obj is TableBucketUnreferencedFileRemovalStatus other && Equals(other); + public bool Equals(TableBucketUnreferencedFileRemovalStatus other) => string.Equals(_value, other._value, StringComparison.Ordinal); + + [EditorBrowsable(EditorBrowsableState.Never)] + public override int GetHashCode() => _value?.GetHashCode() ?? 0; + + public override string ToString() => _value; + } +} diff --git a/sdk/dotnet/S3Tables/GetTableBucket.cs b/sdk/dotnet/S3Tables/GetTableBucket.cs new file mode 100644 index 0000000000..bcc68b7b66 --- /dev/null +++ b/sdk/dotnet/S3Tables/GetTableBucket.cs @@ -0,0 +1,67 @@ +// *** WARNING: this file was generated by pulumi. *** +// *** Do not edit by hand unless you're certain you know what you are doing! *** + +using System; +using System.Collections.Generic; +using System.Collections.Immutable; +using System.Threading.Tasks; +using Pulumi.Serialization; + +namespace Pulumi.AwsNative.S3Tables +{ + public static class GetTableBucket + { + /// + /// Creates an Amazon S3 Tables table bucket in the same AWS Region where you create the AWS CloudFormation stack. + /// + public static Task InvokeAsync(GetTableBucketArgs args, InvokeOptions? options = null) + => global::Pulumi.Deployment.Instance.InvokeAsync("aws-native:s3tables:getTableBucket", args ?? new GetTableBucketArgs(), options.WithDefaults()); + + /// + /// Creates an Amazon S3 Tables table bucket in the same AWS Region where you create the AWS CloudFormation stack. + /// + public static Output Invoke(GetTableBucketInvokeArgs args, InvokeOptions? options = null) + => global::Pulumi.Deployment.Instance.Invoke("aws-native:s3tables:getTableBucket", args ?? new GetTableBucketInvokeArgs(), options.WithDefaults()); + } + + + public sealed class GetTableBucketArgs : global::Pulumi.InvokeArgs + { + [Input("tableBucketArn", required: true)] + public string TableBucketArn { get; set; } = null!; + + public GetTableBucketArgs() + { + } + public static new GetTableBucketArgs Empty => new GetTableBucketArgs(); + } + + public sealed class GetTableBucketInvokeArgs : global::Pulumi.InvokeArgs + { + [Input("tableBucketArn", required: true)] + public Input TableBucketArn { get; set; } = null!; + + public GetTableBucketInvokeArgs() + { + } + public static new GetTableBucketInvokeArgs Empty => new GetTableBucketInvokeArgs(); + } + + + [OutputType] + public sealed class GetTableBucketResult + { + public readonly string? TableBucketArn; + public readonly Outputs.TableBucketUnreferencedFileRemoval? UnreferencedFileRemoval; + + [OutputConstructor] + private GetTableBucketResult( + string? tableBucketArn, + + Outputs.TableBucketUnreferencedFileRemoval? unreferencedFileRemoval) + { + TableBucketArn = tableBucketArn; + UnreferencedFileRemoval = unreferencedFileRemoval; + } + } +} diff --git a/sdk/dotnet/S3Tables/GetTableBucketPolicy.cs b/sdk/dotnet/S3Tables/GetTableBucketPolicy.cs new file mode 100644 index 0000000000..fda2cbaa54 --- /dev/null +++ b/sdk/dotnet/S3Tables/GetTableBucketPolicy.cs @@ -0,0 +1,62 @@ +// *** WARNING: this file was generated by pulumi. *** +// *** Do not edit by hand unless you're certain you know what you are doing! *** + +using System; +using System.Collections.Generic; +using System.Collections.Immutable; +using System.Threading.Tasks; +using Pulumi.Serialization; + +namespace Pulumi.AwsNative.S3Tables +{ + public static class GetTableBucketPolicy + { + /// + /// Applies an IAM resource policy to a table bucket. + /// + public static Task InvokeAsync(GetTableBucketPolicyArgs args, InvokeOptions? options = null) + => global::Pulumi.Deployment.Instance.InvokeAsync("aws-native:s3tables:getTableBucketPolicy", args ?? new GetTableBucketPolicyArgs(), options.WithDefaults()); + + /// + /// Applies an IAM resource policy to a table bucket. + /// + public static Output Invoke(GetTableBucketPolicyInvokeArgs args, InvokeOptions? options = null) + => global::Pulumi.Deployment.Instance.Invoke("aws-native:s3tables:getTableBucketPolicy", args ?? new GetTableBucketPolicyInvokeArgs(), options.WithDefaults()); + } + + + public sealed class GetTableBucketPolicyArgs : global::Pulumi.InvokeArgs + { + [Input("tableBucketArn", required: true)] + public string TableBucketArn { get; set; } = null!; + + public GetTableBucketPolicyArgs() + { + } + public static new GetTableBucketPolicyArgs Empty => new GetTableBucketPolicyArgs(); + } + + public sealed class GetTableBucketPolicyInvokeArgs : global::Pulumi.InvokeArgs + { + [Input("tableBucketArn", required: true)] + public Input TableBucketArn { get; set; } = null!; + + public GetTableBucketPolicyInvokeArgs() + { + } + public static new GetTableBucketPolicyInvokeArgs Empty => new GetTableBucketPolicyInvokeArgs(); + } + + + [OutputType] + public sealed class GetTableBucketPolicyResult + { + public readonly Outputs.TableBucketPolicyResourcePolicy? ResourcePolicy; + + [OutputConstructor] + private GetTableBucketPolicyResult(Outputs.TableBucketPolicyResourcePolicy? resourcePolicy) + { + ResourcePolicy = resourcePolicy; + } + } +} diff --git a/sdk/dotnet/S3Tables/Inputs/TableBucketPolicyResourcePolicyArgs.cs b/sdk/dotnet/S3Tables/Inputs/TableBucketPolicyResourcePolicyArgs.cs new file mode 100644 index 0000000000..3f98c23e35 --- /dev/null +++ b/sdk/dotnet/S3Tables/Inputs/TableBucketPolicyResourcePolicyArgs.cs @@ -0,0 +1,23 @@ +// *** WARNING: this file was generated by pulumi. *** +// *** Do not edit by hand unless you're certain you know what you are doing! *** + +using System; +using System.Collections.Generic; +using System.Collections.Immutable; +using System.Threading.Tasks; +using Pulumi.Serialization; + +namespace Pulumi.AwsNative.S3Tables.Inputs +{ + + /// + /// A policy document containing permissions to add to the specified table bucket. In IAM, you must provide policy documents in JSON format. However, in CloudFormation you can provide the policy in JSON or YAML format because CloudFormation converts YAML to JSON before submitting it to IAM. + /// + public sealed class TableBucketPolicyResourcePolicyArgs : global::Pulumi.ResourceArgs + { + public TableBucketPolicyResourcePolicyArgs() + { + } + public static new TableBucketPolicyResourcePolicyArgs Empty => new TableBucketPolicyResourcePolicyArgs(); + } +} diff --git a/sdk/dotnet/S3Tables/Inputs/TableBucketUnreferencedFileRemovalArgs.cs b/sdk/dotnet/S3Tables/Inputs/TableBucketUnreferencedFileRemovalArgs.cs new file mode 100644 index 0000000000..b6a32b061d --- /dev/null +++ b/sdk/dotnet/S3Tables/Inputs/TableBucketUnreferencedFileRemovalArgs.cs @@ -0,0 +1,41 @@ +// *** WARNING: this file was generated by pulumi. *** +// *** Do not edit by hand unless you're certain you know what you are doing! *** + +using System; +using System.Collections.Generic; +using System.Collections.Immutable; +using System.Threading.Tasks; +using Pulumi.Serialization; + +namespace Pulumi.AwsNative.S3Tables.Inputs +{ + + /// + /// Settings governing the Unreferenced File Removal maintenance action. Unreferenced file removal identifies and deletes all objects that are not referenced by any table snapshots. + /// + public sealed class TableBucketUnreferencedFileRemovalArgs : global::Pulumi.ResourceArgs + { + /// + /// S3 permanently deletes noncurrent objects after the number of days specified by the NoncurrentDays property. + /// + [Input("noncurrentDays")] + public Input? NoncurrentDays { get; set; } + + /// + /// Indicates whether the Unreferenced File Removal maintenance action is enabled. + /// + [Input("status")] + public Input? Status { get; set; } + + /// + /// For any object not referenced by your table and older than the UnreferencedDays property, S3 creates a delete marker and marks the object version as noncurrent. + /// + [Input("unreferencedDays")] + public Input? UnreferencedDays { get; set; } + + public TableBucketUnreferencedFileRemovalArgs() + { + } + public static new TableBucketUnreferencedFileRemovalArgs Empty => new TableBucketUnreferencedFileRemovalArgs(); + } +} diff --git a/sdk/dotnet/S3Tables/Outputs/TableBucketPolicyResourcePolicy.cs b/sdk/dotnet/S3Tables/Outputs/TableBucketPolicyResourcePolicy.cs new file mode 100644 index 0000000000..6fee345788 --- /dev/null +++ b/sdk/dotnet/S3Tables/Outputs/TableBucketPolicyResourcePolicy.cs @@ -0,0 +1,24 @@ +// *** WARNING: this file was generated by pulumi. *** +// *** Do not edit by hand unless you're certain you know what you are doing! *** + +using System; +using System.Collections.Generic; +using System.Collections.Immutable; +using System.Threading.Tasks; +using Pulumi.Serialization; + +namespace Pulumi.AwsNative.S3Tables.Outputs +{ + + /// + /// A policy document containing permissions to add to the specified table bucket. In IAM, you must provide policy documents in JSON format. However, in CloudFormation you can provide the policy in JSON or YAML format because CloudFormation converts YAML to JSON before submitting it to IAM. + /// + [OutputType] + public sealed class TableBucketPolicyResourcePolicy + { + [OutputConstructor] + private TableBucketPolicyResourcePolicy() + { + } + } +} diff --git a/sdk/dotnet/S3Tables/Outputs/TableBucketUnreferencedFileRemoval.cs b/sdk/dotnet/S3Tables/Outputs/TableBucketUnreferencedFileRemoval.cs new file mode 100644 index 0000000000..d668afb643 --- /dev/null +++ b/sdk/dotnet/S3Tables/Outputs/TableBucketUnreferencedFileRemoval.cs @@ -0,0 +1,45 @@ +// *** WARNING: this file was generated by pulumi. *** +// *** Do not edit by hand unless you're certain you know what you are doing! *** + +using System; +using System.Collections.Generic; +using System.Collections.Immutable; +using System.Threading.Tasks; +using Pulumi.Serialization; + +namespace Pulumi.AwsNative.S3Tables.Outputs +{ + + /// + /// Settings governing the Unreferenced File Removal maintenance action. Unreferenced file removal identifies and deletes all objects that are not referenced by any table snapshots. + /// + [OutputType] + public sealed class TableBucketUnreferencedFileRemoval + { + /// + /// S3 permanently deletes noncurrent objects after the number of days specified by the NoncurrentDays property. + /// + public readonly int? NoncurrentDays; + /// + /// Indicates whether the Unreferenced File Removal maintenance action is enabled. + /// + public readonly Pulumi.AwsNative.S3Tables.TableBucketUnreferencedFileRemovalStatus? Status; + /// + /// For any object not referenced by your table and older than the UnreferencedDays property, S3 creates a delete marker and marks the object version as noncurrent. + /// + public readonly int? UnreferencedDays; + + [OutputConstructor] + private TableBucketUnreferencedFileRemoval( + int? noncurrentDays, + + Pulumi.AwsNative.S3Tables.TableBucketUnreferencedFileRemovalStatus? status, + + int? unreferencedDays) + { + NoncurrentDays = noncurrentDays; + Status = status; + UnreferencedDays = unreferencedDays; + } + } +} diff --git a/sdk/dotnet/S3Tables/README.md b/sdk/dotnet/S3Tables/README.md new file mode 100644 index 0000000000..77b2f47ec2 --- /dev/null +++ b/sdk/dotnet/S3Tables/README.md @@ -0,0 +1 @@ +A native Pulumi package for creating and managing Amazon Web Services (AWS) resources. diff --git a/sdk/dotnet/S3Tables/TableBucket.cs b/sdk/dotnet/S3Tables/TableBucket.cs new file mode 100644 index 0000000000..3595b4525e --- /dev/null +++ b/sdk/dotnet/S3Tables/TableBucket.cs @@ -0,0 +1,87 @@ +// *** WARNING: this file was generated by pulumi. *** +// *** Do not edit by hand unless you're certain you know what you are doing! *** + +using System; +using System.Collections.Generic; +using System.Collections.Immutable; +using System.Threading.Tasks; +using Pulumi.Serialization; + +namespace Pulumi.AwsNative.S3Tables +{ + /// + /// Creates an Amazon S3 Tables table bucket in the same AWS Region where you create the AWS CloudFormation stack. + /// + [AwsNativeResourceType("aws-native:s3tables:TableBucket")] + public partial class TableBucket : global::Pulumi.CustomResource + { + [Output("tableBucketArn")] + public Output TableBucketArn { get; private set; } = null!; + + [Output("tableBucketName")] + public Output TableBucketName { get; private set; } = null!; + + [Output("unreferencedFileRemoval")] + public Output UnreferencedFileRemoval { get; private set; } = null!; + + + /// + /// Create a TableBucket resource with the given unique name, arguments, and options. + /// + /// + /// The unique name of the resource + /// The arguments used to populate this resource's properties + /// A bag of options that control this resource's behavior + public TableBucket(string name, TableBucketArgs? args = null, CustomResourceOptions? options = null) + : base("aws-native:s3tables:TableBucket", name, args ?? new TableBucketArgs(), MakeResourceOptions(options, "")) + { + } + + private TableBucket(string name, Input id, CustomResourceOptions? options = null) + : base("aws-native:s3tables:TableBucket", name, null, MakeResourceOptions(options, id)) + { + } + + private static CustomResourceOptions MakeResourceOptions(CustomResourceOptions? options, Input? id) + { + var defaultOptions = new CustomResourceOptions + { + Version = Utilities.Version, + ReplaceOnChanges = + { + "tableBucketName", + }, + }; + var merged = CustomResourceOptions.Merge(defaultOptions, options); + // Override the ID if one was specified for consistency with other language SDKs. + merged.Id = id ?? merged.Id; + return merged; + } + /// + /// Get an existing TableBucket resource's state with the given name, ID, and optional extra + /// properties used to qualify the lookup. + /// + /// + /// The unique name of the resulting resource. + /// The unique provider ID of the resource to lookup. + /// A bag of options that control this resource's behavior + public static TableBucket Get(string name, Input id, CustomResourceOptions? options = null) + { + return new TableBucket(name, id, options); + } + } + + public sealed class TableBucketArgs : global::Pulumi.ResourceArgs + { + [Input("tableBucketName")] + public Input? TableBucketName { get; set; } + + [Input("unreferencedFileRemoval")] + public Input? UnreferencedFileRemoval { get; set; } + + public TableBucketArgs() + { + } + public static new TableBucketArgs Empty => new TableBucketArgs(); + } +} diff --git a/sdk/dotnet/S3Tables/TableBucketPolicy.cs b/sdk/dotnet/S3Tables/TableBucketPolicy.cs new file mode 100644 index 0000000000..5fea7bad89 --- /dev/null +++ b/sdk/dotnet/S3Tables/TableBucketPolicy.cs @@ -0,0 +1,84 @@ +// *** WARNING: this file was generated by pulumi. *** +// *** Do not edit by hand unless you're certain you know what you are doing! *** + +using System; +using System.Collections.Generic; +using System.Collections.Immutable; +using System.Threading.Tasks; +using Pulumi.Serialization; + +namespace Pulumi.AwsNative.S3Tables +{ + /// + /// Applies an IAM resource policy to a table bucket. + /// + [AwsNativeResourceType("aws-native:s3tables:TableBucketPolicy")] + public partial class TableBucketPolicy : global::Pulumi.CustomResource + { + [Output("resourcePolicy")] + public Output ResourcePolicy { get; private set; } = null!; + + [Output("tableBucketArn")] + public Output TableBucketArn { get; private set; } = null!; + + + /// + /// Create a TableBucketPolicy resource with the given unique name, arguments, and options. + /// + /// + /// The unique name of the resource + /// The arguments used to populate this resource's properties + /// A bag of options that control this resource's behavior + public TableBucketPolicy(string name, TableBucketPolicyArgs args, CustomResourceOptions? options = null) + : base("aws-native:s3tables:TableBucketPolicy", name, args ?? new TableBucketPolicyArgs(), MakeResourceOptions(options, "")) + { + } + + private TableBucketPolicy(string name, Input id, CustomResourceOptions? options = null) + : base("aws-native:s3tables:TableBucketPolicy", name, null, MakeResourceOptions(options, id)) + { + } + + private static CustomResourceOptions MakeResourceOptions(CustomResourceOptions? options, Input? id) + { + var defaultOptions = new CustomResourceOptions + { + Version = Utilities.Version, + ReplaceOnChanges = + { + "tableBucketArn", + }, + }; + var merged = CustomResourceOptions.Merge(defaultOptions, options); + // Override the ID if one was specified for consistency with other language SDKs. + merged.Id = id ?? merged.Id; + return merged; + } + /// + /// Get an existing TableBucketPolicy resource's state with the given name, ID, and optional extra + /// properties used to qualify the lookup. + /// + /// + /// The unique name of the resulting resource. + /// The unique provider ID of the resource to lookup. + /// A bag of options that control this resource's behavior + public static TableBucketPolicy Get(string name, Input id, CustomResourceOptions? options = null) + { + return new TableBucketPolicy(name, id, options); + } + } + + public sealed class TableBucketPolicyArgs : global::Pulumi.ResourceArgs + { + [Input("resourcePolicy", required: true)] + public Input ResourcePolicy { get; set; } = null!; + + [Input("tableBucketArn", required: true)] + public Input TableBucketArn { get; set; } = null!; + + public TableBucketPolicyArgs() + { + } + public static new TableBucketPolicyArgs Empty => new TableBucketPolicyArgs(); + } +} diff --git a/sdk/go/aws/apigateway/domainNameV2.go b/sdk/go/aws/apigateway/domainNameV2.go index 2e193b3809..01c3284357 100644 --- a/sdk/go/aws/apigateway/domainNameV2.go +++ b/sdk/go/aws/apigateway/domainNameV2.go @@ -26,8 +26,6 @@ type DomainNameV2 struct { DomainNameId pulumi.StringOutput `pulumi:"domainNameId"` // The endpoint configuration to indicate the types of endpoints an API (RestApi) or its custom domain name (DomainName) has. EndpointConfiguration DomainNameV2EndpointConfigurationPtrOutput `pulumi:"endpointConfiguration"` - // Search the [CloudFormation User Guide](https://docs.aws.amazon.com/cloudformation/) for `AWS::ApiGateway::DomainNameV2` for more information about the expected schema for this property. - ManagementPolicy pulumi.AnyOutput `pulumi:"managementPolicy"` // A stringified JSON policy document that applies to the `execute-api` service for this DomainName regardless of the caller and Method configuration. You can use `Fn::ToJsonString` to enter your `policy` . For more information, see [Fn::ToJsonString](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/intrinsic-function-reference-ToJsonString.html) . // // Search the [CloudFormation User Guide](https://docs.aws.amazon.com/cloudformation/) for `AWS::ApiGateway::DomainNameV2` for more information about the expected schema for this property. @@ -90,8 +88,6 @@ type domainNameV2Args struct { DomainName *string `pulumi:"domainName"` // The endpoint configuration to indicate the types of endpoints an API (RestApi) or its custom domain name (DomainName) has. EndpointConfiguration *DomainNameV2EndpointConfiguration `pulumi:"endpointConfiguration"` - // Search the [CloudFormation User Guide](https://docs.aws.amazon.com/cloudformation/) for `AWS::ApiGateway::DomainNameV2` for more information about the expected schema for this property. - ManagementPolicy interface{} `pulumi:"managementPolicy"` // A stringified JSON policy document that applies to the `execute-api` service for this DomainName regardless of the caller and Method configuration. You can use `Fn::ToJsonString` to enter your `policy` . For more information, see [Fn::ToJsonString](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/intrinsic-function-reference-ToJsonString.html) . // // Search the [CloudFormation User Guide](https://docs.aws.amazon.com/cloudformation/) for `AWS::ApiGateway::DomainNameV2` for more information about the expected schema for this property. @@ -110,8 +106,6 @@ type DomainNameV2Args struct { DomainName pulumi.StringPtrInput // The endpoint configuration to indicate the types of endpoints an API (RestApi) or its custom domain name (DomainName) has. EndpointConfiguration DomainNameV2EndpointConfigurationPtrInput - // Search the [CloudFormation User Guide](https://docs.aws.amazon.com/cloudformation/) for `AWS::ApiGateway::DomainNameV2` for more information about the expected schema for this property. - ManagementPolicy pulumi.Input // A stringified JSON policy document that applies to the `execute-api` service for this DomainName regardless of the caller and Method configuration. You can use `Fn::ToJsonString` to enter your `policy` . For more information, see [Fn::ToJsonString](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/intrinsic-function-reference-ToJsonString.html) . // // Search the [CloudFormation User Guide](https://docs.aws.amazon.com/cloudformation/) for `AWS::ApiGateway::DomainNameV2` for more information about the expected schema for this property. @@ -184,11 +178,6 @@ func (o DomainNameV2Output) EndpointConfiguration() DomainNameV2EndpointConfigur return o.ApplyT(func(v *DomainNameV2) DomainNameV2EndpointConfigurationPtrOutput { return v.EndpointConfiguration }).(DomainNameV2EndpointConfigurationPtrOutput) } -// Search the [CloudFormation User Guide](https://docs.aws.amazon.com/cloudformation/) for `AWS::ApiGateway::DomainNameV2` for more information about the expected schema for this property. -func (o DomainNameV2Output) ManagementPolicy() pulumi.AnyOutput { - return o.ApplyT(func(v *DomainNameV2) pulumi.AnyOutput { return v.ManagementPolicy }).(pulumi.AnyOutput) -} - // A stringified JSON policy document that applies to the `execute-api` service for this DomainName regardless of the caller and Method configuration. You can use `Fn::ToJsonString` to enter your `policy` . For more information, see [Fn::ToJsonString](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/intrinsic-function-reference-ToJsonString.html) . // // Search the [CloudFormation User Guide](https://docs.aws.amazon.com/cloudformation/) for `AWS::ApiGateway::DomainNameV2` for more information about the expected schema for this property. diff --git a/sdk/go/aws/apigateway/getDomainNameV2.go b/sdk/go/aws/apigateway/getDomainNameV2.go index 5e6d3103da..7c23f14830 100644 --- a/sdk/go/aws/apigateway/getDomainNameV2.go +++ b/sdk/go/aws/apigateway/getDomainNameV2.go @@ -35,8 +35,6 @@ type LookupDomainNameV2Result struct { DomainNameArn *string `pulumi:"domainNameArn"` // The domain name ID. DomainNameId *string `pulumi:"domainNameId"` - // Search the [CloudFormation User Guide](https://docs.aws.amazon.com/cloudformation/) for `AWS::ApiGateway::DomainNameV2` for more information about the expected schema for this property. - ManagementPolicy interface{} `pulumi:"managementPolicy"` // A stringified JSON policy document that applies to the `execute-api` service for this DomainName regardless of the caller and Method configuration. You can use `Fn::ToJsonString` to enter your `policy` . For more information, see [Fn::ToJsonString](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/intrinsic-function-reference-ToJsonString.html) . // // Search the [CloudFormation User Guide](https://docs.aws.amazon.com/cloudformation/) for `AWS::ApiGateway::DomainNameV2` for more information about the expected schema for this property. @@ -102,11 +100,6 @@ func (o LookupDomainNameV2ResultOutput) DomainNameId() pulumi.StringPtrOutput { return o.ApplyT(func(v LookupDomainNameV2Result) *string { return v.DomainNameId }).(pulumi.StringPtrOutput) } -// Search the [CloudFormation User Guide](https://docs.aws.amazon.com/cloudformation/) for `AWS::ApiGateway::DomainNameV2` for more information about the expected schema for this property. -func (o LookupDomainNameV2ResultOutput) ManagementPolicy() pulumi.AnyOutput { - return o.ApplyT(func(v LookupDomainNameV2Result) interface{} { return v.ManagementPolicy }).(pulumi.AnyOutput) -} - // A stringified JSON policy document that applies to the `execute-api` service for this DomainName regardless of the caller and Method configuration. You can use `Fn::ToJsonString` to enter your `policy` . For more information, see [Fn::ToJsonString](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/intrinsic-function-reference-ToJsonString.html) . // // Search the [CloudFormation User Guide](https://docs.aws.amazon.com/cloudformation/) for `AWS::ApiGateway::DomainNameV2` for more information about the expected schema for this property. diff --git a/sdk/go/aws/applicationautoscaling/pulumiTypes.go b/sdk/go/aws/applicationautoscaling/pulumiTypes.go index 4acaabbcae..79160c8309 100644 --- a/sdk/go/aws/applicationautoscaling/pulumiTypes.go +++ b/sdk/go/aws/applicationautoscaling/pulumiTypes.go @@ -1108,6 +1108,7 @@ func (o ScalingPolicyPredefinedMetricSpecificationPtrOutput) ResourceLabel() pul }).(pulumi.StringPtrOutput) } +// Represents a CloudWatch metric of your choosing for a predictive scaling policy. type ScalingPolicyPredictiveScalingCustomizedCapacityMetric struct { // One or more metric data queries to provide data points for a metric specification. MetricDataQueries []ScalingPolicyPredictiveScalingMetricDataQuery `pulumi:"metricDataQueries"` @@ -1124,6 +1125,7 @@ type ScalingPolicyPredictiveScalingCustomizedCapacityMetricInput interface { ToScalingPolicyPredictiveScalingCustomizedCapacityMetricOutputWithContext(context.Context) ScalingPolicyPredictiveScalingCustomizedCapacityMetricOutput } +// Represents a CloudWatch metric of your choosing for a predictive scaling policy. type ScalingPolicyPredictiveScalingCustomizedCapacityMetricArgs struct { // One or more metric data queries to provide data points for a metric specification. MetricDataQueries ScalingPolicyPredictiveScalingMetricDataQueryArrayInput `pulumi:"metricDataQueries"` @@ -1182,6 +1184,7 @@ func (i *scalingPolicyPredictiveScalingCustomizedCapacityMetricPtrType) ToScalin return pulumi.ToOutputWithContext(ctx, i).(ScalingPolicyPredictiveScalingCustomizedCapacityMetricPtrOutput) } +// Represents a CloudWatch metric of your choosing for a predictive scaling policy. type ScalingPolicyPredictiveScalingCustomizedCapacityMetricOutput struct{ *pulumi.OutputState } func (ScalingPolicyPredictiveScalingCustomizedCapacityMetricOutput) ElementType() reflect.Type { @@ -1247,6 +1250,7 @@ func (o ScalingPolicyPredictiveScalingCustomizedCapacityMetricPtrOutput) MetricD }).(ScalingPolicyPredictiveScalingMetricDataQueryArrayOutput) } +// The customized load metric specification. type ScalingPolicyPredictiveScalingCustomizedLoadMetric struct { MetricDataQueries []ScalingPolicyPredictiveScalingMetricDataQuery `pulumi:"metricDataQueries"` } @@ -1262,6 +1266,7 @@ type ScalingPolicyPredictiveScalingCustomizedLoadMetricInput interface { ToScalingPolicyPredictiveScalingCustomizedLoadMetricOutputWithContext(context.Context) ScalingPolicyPredictiveScalingCustomizedLoadMetricOutput } +// The customized load metric specification. type ScalingPolicyPredictiveScalingCustomizedLoadMetricArgs struct { MetricDataQueries ScalingPolicyPredictiveScalingMetricDataQueryArrayInput `pulumi:"metricDataQueries"` } @@ -1319,6 +1324,7 @@ func (i *scalingPolicyPredictiveScalingCustomizedLoadMetricPtrType) ToScalingPol return pulumi.ToOutputWithContext(ctx, i).(ScalingPolicyPredictiveScalingCustomizedLoadMetricPtrOutput) } +// The customized load metric specification. type ScalingPolicyPredictiveScalingCustomizedLoadMetricOutput struct{ *pulumi.OutputState } func (ScalingPolicyPredictiveScalingCustomizedLoadMetricOutput) ElementType() reflect.Type { @@ -1382,6 +1388,7 @@ func (o ScalingPolicyPredictiveScalingCustomizedLoadMetricPtrOutput) MetricDataQ }).(ScalingPolicyPredictiveScalingMetricDataQueryArrayOutput) } +// One or more metric data queries to provide data points for a metric specification. type ScalingPolicyPredictiveScalingCustomizedScalingMetric struct { // One or more metric data queries to provide data points for a metric specification. MetricDataQueries []ScalingPolicyPredictiveScalingMetricDataQuery `pulumi:"metricDataQueries"` @@ -1398,6 +1405,7 @@ type ScalingPolicyPredictiveScalingCustomizedScalingMetricInput interface { ToScalingPolicyPredictiveScalingCustomizedScalingMetricOutputWithContext(context.Context) ScalingPolicyPredictiveScalingCustomizedScalingMetricOutput } +// One or more metric data queries to provide data points for a metric specification. type ScalingPolicyPredictiveScalingCustomizedScalingMetricArgs struct { // One or more metric data queries to provide data points for a metric specification. MetricDataQueries ScalingPolicyPredictiveScalingMetricDataQueryArrayInput `pulumi:"metricDataQueries"` @@ -1456,6 +1464,7 @@ func (i *scalingPolicyPredictiveScalingCustomizedScalingMetricPtrType) ToScaling return pulumi.ToOutputWithContext(ctx, i).(ScalingPolicyPredictiveScalingCustomizedScalingMetricPtrOutput) } +// One or more metric data queries to provide data points for a metric specification. type ScalingPolicyPredictiveScalingCustomizedScalingMetricOutput struct{ *pulumi.OutputState } func (ScalingPolicyPredictiveScalingCustomizedScalingMetricOutput) ElementType() reflect.Type { @@ -1521,8 +1530,9 @@ func (o ScalingPolicyPredictiveScalingCustomizedScalingMetricPtrOutput) MetricDa }).(ScalingPolicyPredictiveScalingMetricDataQueryArrayOutput) } +// Describes the scaling metric. type ScalingPolicyPredictiveScalingMetric struct { - // The dimensions for the metric. + // Describes the dimensions of the metric. Dimensions []ScalingPolicyPredictiveScalingMetricDimension `pulumi:"dimensions"` // The name of the metric. MetricName *string `pulumi:"metricName"` @@ -1541,8 +1551,9 @@ type ScalingPolicyPredictiveScalingMetricInput interface { ToScalingPolicyPredictiveScalingMetricOutputWithContext(context.Context) ScalingPolicyPredictiveScalingMetricOutput } +// Describes the scaling metric. type ScalingPolicyPredictiveScalingMetricArgs struct { - // The dimensions for the metric. + // Describes the dimensions of the metric. Dimensions ScalingPolicyPredictiveScalingMetricDimensionArrayInput `pulumi:"dimensions"` // The name of the metric. MetricName pulumi.StringPtrInput `pulumi:"metricName"` @@ -1603,6 +1614,7 @@ func (i *scalingPolicyPredictiveScalingMetricPtrType) ToScalingPolicyPredictiveS return pulumi.ToOutputWithContext(ctx, i).(ScalingPolicyPredictiveScalingMetricPtrOutput) } +// Describes the scaling metric. type ScalingPolicyPredictiveScalingMetricOutput struct{ *pulumi.OutputState } func (ScalingPolicyPredictiveScalingMetricOutput) ElementType() reflect.Type { @@ -1627,7 +1639,7 @@ func (o ScalingPolicyPredictiveScalingMetricOutput) ToScalingPolicyPredictiveSca }).(ScalingPolicyPredictiveScalingMetricPtrOutput) } -// The dimensions for the metric. +// Describes the dimensions of the metric. func (o ScalingPolicyPredictiveScalingMetricOutput) Dimensions() ScalingPolicyPredictiveScalingMetricDimensionArrayOutput { return o.ApplyT(func(v ScalingPolicyPredictiveScalingMetric) []ScalingPolicyPredictiveScalingMetricDimension { return v.Dimensions @@ -1668,7 +1680,7 @@ func (o ScalingPolicyPredictiveScalingMetricPtrOutput) Elem() ScalingPolicyPredi }).(ScalingPolicyPredictiveScalingMetricOutput) } -// The dimensions for the metric. +// Describes the dimensions of the metric. func (o ScalingPolicyPredictiveScalingMetricPtrOutput) Dimensions() ScalingPolicyPredictiveScalingMetricDimensionArrayOutput { return o.ApplyT(func(v *ScalingPolicyPredictiveScalingMetric) []ScalingPolicyPredictiveScalingMetricDimension { if v == nil { @@ -1698,16 +1710,21 @@ func (o ScalingPolicyPredictiveScalingMetricPtrOutput) Namespace() pulumi.String }).(pulumi.StringPtrOutput) } +// 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. type ScalingPolicyPredictiveScalingMetricDataQuery struct { - // The math expression to perform on the returned data, if this object is performing a math expression. + // 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. + // Conditional: Within each ``MetricDataQuery`` object, you must specify either ``Expression`` or ``MetricStat``, but not both. Expression *string `pulumi:"expression"` - // A short name that identifies the object's results in the response. + // 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. Id *string `pulumi:"id"` // 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. Label *string `pulumi:"label"` // Information about the metric data to return. + // Conditional: Within each ``MetricDataQuery`` object, you must specify either ``Expression`` or ``MetricStat``, but not both. MetricStat *ScalingPolicyPredictiveScalingMetricStat `pulumi:"metricStat"` // Indicates whether to return the timestamps and raw data values of this metric. + // 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. + // 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``). ReturnData *bool `pulumi:"returnData"` } @@ -1722,16 +1739,21 @@ type ScalingPolicyPredictiveScalingMetricDataQueryInput interface { ToScalingPolicyPredictiveScalingMetricDataQueryOutputWithContext(context.Context) ScalingPolicyPredictiveScalingMetricDataQueryOutput } +// 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. type ScalingPolicyPredictiveScalingMetricDataQueryArgs struct { - // The math expression to perform on the returned data, if this object is performing a math expression. + // 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. + // Conditional: Within each ``MetricDataQuery`` object, you must specify either ``Expression`` or ``MetricStat``, but not both. Expression pulumi.StringPtrInput `pulumi:"expression"` - // A short name that identifies the object's results in the response. + // 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. Id pulumi.StringPtrInput `pulumi:"id"` // 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. Label pulumi.StringPtrInput `pulumi:"label"` // Information about the metric data to return. + // Conditional: Within each ``MetricDataQuery`` object, you must specify either ``Expression`` or ``MetricStat``, but not both. MetricStat ScalingPolicyPredictiveScalingMetricStatPtrInput `pulumi:"metricStat"` // Indicates whether to return the timestamps and raw data values of this metric. + // 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. + // 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``). ReturnData pulumi.BoolPtrInput `pulumi:"returnData"` } @@ -1772,6 +1794,7 @@ func (i ScalingPolicyPredictiveScalingMetricDataQueryArray) ToScalingPolicyPredi return pulumi.ToOutputWithContext(ctx, i).(ScalingPolicyPredictiveScalingMetricDataQueryArrayOutput) } +// 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. type ScalingPolicyPredictiveScalingMetricDataQueryOutput struct{ *pulumi.OutputState } func (ScalingPolicyPredictiveScalingMetricDataQueryOutput) ElementType() reflect.Type { @@ -1786,12 +1809,14 @@ func (o ScalingPolicyPredictiveScalingMetricDataQueryOutput) ToScalingPolicyPred return o } -// The math expression to perform on the returned data, if this object is performing a math expression. +// 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. +// +// Conditional: Within each ``MetricDataQuery`` object, you must specify either ``Expression`` or ``MetricStat``, but not both. func (o ScalingPolicyPredictiveScalingMetricDataQueryOutput) Expression() pulumi.StringPtrOutput { return o.ApplyT(func(v ScalingPolicyPredictiveScalingMetricDataQuery) *string { return v.Expression }).(pulumi.StringPtrOutput) } -// A short name that identifies the object's results in the response. +// 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. func (o ScalingPolicyPredictiveScalingMetricDataQueryOutput) Id() pulumi.StringPtrOutput { return o.ApplyT(func(v ScalingPolicyPredictiveScalingMetricDataQuery) *string { return v.Id }).(pulumi.StringPtrOutput) } @@ -1802,6 +1827,8 @@ func (o ScalingPolicyPredictiveScalingMetricDataQueryOutput) Label() pulumi.Stri } // Information about the metric data to return. +// +// Conditional: Within each ``MetricDataQuery`` object, you must specify either ``Expression`` or ``MetricStat``, but not both. func (o ScalingPolicyPredictiveScalingMetricDataQueryOutput) MetricStat() ScalingPolicyPredictiveScalingMetricStatPtrOutput { return o.ApplyT(func(v ScalingPolicyPredictiveScalingMetricDataQuery) *ScalingPolicyPredictiveScalingMetricStat { return v.MetricStat @@ -1809,6 +1836,9 @@ func (o ScalingPolicyPredictiveScalingMetricDataQueryOutput) MetricStat() Scalin } // Indicates whether to return the timestamps and raw data values of this metric. +// +// 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. +// 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``). func (o ScalingPolicyPredictiveScalingMetricDataQueryOutput) ReturnData() pulumi.BoolPtrOutput { return o.ApplyT(func(v ScalingPolicyPredictiveScalingMetricDataQuery) *bool { return v.ReturnData }).(pulumi.BoolPtrOutput) } @@ -1833,6 +1863,7 @@ func (o ScalingPolicyPredictiveScalingMetricDataQueryArrayOutput) Index(i pulumi }).(ScalingPolicyPredictiveScalingMetricDataQueryOutput) } +// Describes the dimension of a metric. type ScalingPolicyPredictiveScalingMetricDimension struct { // The name of the dimension. Name *string `pulumi:"name"` @@ -1851,6 +1882,7 @@ type ScalingPolicyPredictiveScalingMetricDimensionInput interface { ToScalingPolicyPredictiveScalingMetricDimensionOutputWithContext(context.Context) ScalingPolicyPredictiveScalingMetricDimensionOutput } +// Describes the dimension of a metric. type ScalingPolicyPredictiveScalingMetricDimensionArgs struct { // The name of the dimension. Name pulumi.StringPtrInput `pulumi:"name"` @@ -1895,6 +1927,7 @@ func (i ScalingPolicyPredictiveScalingMetricDimensionArray) ToScalingPolicyPredi return pulumi.ToOutputWithContext(ctx, i).(ScalingPolicyPredictiveScalingMetricDimensionArrayOutput) } +// Describes the dimension of a metric. type ScalingPolicyPredictiveScalingMetricDimensionOutput struct{ *pulumi.OutputState } func (ScalingPolicyPredictiveScalingMetricDimensionOutput) ElementType() reflect.Type { @@ -1939,6 +1972,9 @@ func (o ScalingPolicyPredictiveScalingMetricDimensionArrayOutput) Index(i pulumi }).(ScalingPolicyPredictiveScalingMetricDimensionOutput) } +// This structure specifies the metrics and target utilization settings for a predictive scaling policy. +// +// 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. type ScalingPolicyPredictiveScalingMetricSpecification struct { // The customized capacity metric specification. CustomizedCapacityMetricSpecification *ScalingPolicyPredictiveScalingCustomizedCapacityMetric `pulumi:"customizedCapacityMetricSpecification"` @@ -1967,6 +2003,9 @@ type ScalingPolicyPredictiveScalingMetricSpecificationInput interface { ToScalingPolicyPredictiveScalingMetricSpecificationOutputWithContext(context.Context) ScalingPolicyPredictiveScalingMetricSpecificationOutput } +// This structure specifies the metrics and target utilization settings for a predictive scaling policy. +// +// 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. type ScalingPolicyPredictiveScalingMetricSpecificationArgs struct { // The customized capacity metric specification. CustomizedCapacityMetricSpecification ScalingPolicyPredictiveScalingCustomizedCapacityMetricPtrInput `pulumi:"customizedCapacityMetricSpecification"` @@ -2021,6 +2060,9 @@ func (i ScalingPolicyPredictiveScalingMetricSpecificationArray) ToScalingPolicyP return pulumi.ToOutputWithContext(ctx, i).(ScalingPolicyPredictiveScalingMetricSpecificationArrayOutput) } +// This structure specifies the metrics and target utilization settings for a predictive scaling policy. +// +// 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. type ScalingPolicyPredictiveScalingMetricSpecificationOutput struct{ *pulumi.OutputState } func (ScalingPolicyPredictiveScalingMetricSpecificationOutput) ElementType() reflect.Type { @@ -2102,12 +2144,14 @@ func (o ScalingPolicyPredictiveScalingMetricSpecificationArrayOutput) Index(i pu }).(ScalingPolicyPredictiveScalingMetricSpecificationOutput) } +// This structure defines the CloudWatch metric to return, along with the statistic and unit. type ScalingPolicyPredictiveScalingMetricStat struct { - // The CloudWatch metric to return, including the metric name, namespace, and dimensions. + // 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). Metric *ScalingPolicyPredictiveScalingMetric `pulumi:"metric"` - // The statistic to return. It can include any CloudWatch statistic or extended statistic. + // 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*. + // The most commonly used metrics for predictive scaling are ``Average`` and ``Sum``. Stat *string `pulumi:"stat"` - // The unit to use for the returned data points. + // 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*. Unit *string `pulumi:"unit"` } @@ -2122,12 +2166,14 @@ type ScalingPolicyPredictiveScalingMetricStatInput interface { ToScalingPolicyPredictiveScalingMetricStatOutputWithContext(context.Context) ScalingPolicyPredictiveScalingMetricStatOutput } +// This structure defines the CloudWatch metric to return, along with the statistic and unit. type ScalingPolicyPredictiveScalingMetricStatArgs struct { - // The CloudWatch metric to return, including the metric name, namespace, and dimensions. + // 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). Metric ScalingPolicyPredictiveScalingMetricPtrInput `pulumi:"metric"` - // The statistic to return. It can include any CloudWatch statistic or extended statistic. + // 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*. + // The most commonly used metrics for predictive scaling are ``Average`` and ``Sum``. Stat pulumi.StringPtrInput `pulumi:"stat"` - // The unit to use for the returned data points. + // 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*. Unit pulumi.StringPtrInput `pulumi:"unit"` } @@ -2184,6 +2230,7 @@ func (i *scalingPolicyPredictiveScalingMetricStatPtrType) ToScalingPolicyPredict return pulumi.ToOutputWithContext(ctx, i).(ScalingPolicyPredictiveScalingMetricStatPtrOutput) } +// This structure defines the CloudWatch metric to return, along with the statistic and unit. type ScalingPolicyPredictiveScalingMetricStatOutput struct{ *pulumi.OutputState } func (ScalingPolicyPredictiveScalingMetricStatOutput) ElementType() reflect.Type { @@ -2208,19 +2255,21 @@ func (o ScalingPolicyPredictiveScalingMetricStatOutput) ToScalingPolicyPredictiv }).(ScalingPolicyPredictiveScalingMetricStatPtrOutput) } -// The CloudWatch metric to return, including the metric name, namespace, and dimensions. +// 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). func (o ScalingPolicyPredictiveScalingMetricStatOutput) Metric() ScalingPolicyPredictiveScalingMetricPtrOutput { return o.ApplyT(func(v ScalingPolicyPredictiveScalingMetricStat) *ScalingPolicyPredictiveScalingMetric { return v.Metric }).(ScalingPolicyPredictiveScalingMetricPtrOutput) } -// The statistic to return. It can include any CloudWatch statistic or extended statistic. +// 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*. +// +// The most commonly used metrics for predictive scaling are ``Average`` and ``Sum``. func (o ScalingPolicyPredictiveScalingMetricStatOutput) Stat() pulumi.StringPtrOutput { return o.ApplyT(func(v ScalingPolicyPredictiveScalingMetricStat) *string { return v.Stat }).(pulumi.StringPtrOutput) } -// The unit to use for the returned data points. +// 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*. func (o ScalingPolicyPredictiveScalingMetricStatOutput) Unit() pulumi.StringPtrOutput { return o.ApplyT(func(v ScalingPolicyPredictiveScalingMetricStat) *string { return v.Unit }).(pulumi.StringPtrOutput) } @@ -2249,7 +2298,7 @@ func (o ScalingPolicyPredictiveScalingMetricStatPtrOutput) Elem() ScalingPolicyP }).(ScalingPolicyPredictiveScalingMetricStatOutput) } -// The CloudWatch metric to return, including the metric name, namespace, and dimensions. +// 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). func (o ScalingPolicyPredictiveScalingMetricStatPtrOutput) Metric() ScalingPolicyPredictiveScalingMetricPtrOutput { return o.ApplyT(func(v *ScalingPolicyPredictiveScalingMetricStat) *ScalingPolicyPredictiveScalingMetric { if v == nil { @@ -2259,7 +2308,9 @@ func (o ScalingPolicyPredictiveScalingMetricStatPtrOutput) Metric() ScalingPolic }).(ScalingPolicyPredictiveScalingMetricPtrOutput) } -// The statistic to return. It can include any CloudWatch statistic or extended statistic. +// 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*. +// +// The most commonly used metrics for predictive scaling are ``Average`` and ``Sum``. func (o ScalingPolicyPredictiveScalingMetricStatPtrOutput) Stat() pulumi.StringPtrOutput { return o.ApplyT(func(v *ScalingPolicyPredictiveScalingMetricStat) *string { if v == nil { @@ -2269,7 +2320,7 @@ func (o ScalingPolicyPredictiveScalingMetricStatPtrOutput) Stat() pulumi.StringP }).(pulumi.StringPtrOutput) } -// The unit to use for the returned data points. +// 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*. func (o ScalingPolicyPredictiveScalingMetricStatPtrOutput) Unit() pulumi.StringPtrOutput { return o.ApplyT(func(v *ScalingPolicyPredictiveScalingMetricStat) *string { if v == nil { @@ -2279,22 +2330,20 @@ func (o ScalingPolicyPredictiveScalingMetricStatPtrOutput) Unit() pulumi.StringP }).(pulumi.StringPtrOutput) } +// Represents a predictive scaling policy configuration. type ScalingPolicyPredictiveScalingPolicyConfiguration struct { - // Defines the behavior that should be applied if the forecast capacity approaches or exceeds the maximum capacity. Defaults to `HonorMaxCapacity` if not specified. + // Defines the behavior that should be applied if the forecast capacity approaches or exceeds the maximum capacity. Defaults to ``HonorMaxCapacity`` if not specified. MaxCapacityBreachBehavior *string `pulumi:"maxCapacityBreachBehavior"` // 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. - // - // Required if the `MaxCapacityBreachBehavior` property is set to `IncreaseMaxCapacity` , and cannot be used otherwise. + // Required if the ``MaxCapacityBreachBehavior`` property is set to ``IncreaseMaxCapacity``, and cannot be used otherwise. MaxCapacityBuffer *int `pulumi:"maxCapacityBuffer"` // This structure includes the metrics and target utilization to use for predictive scaling. - // - // 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. + // 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. MetricSpecifications []ScalingPolicyPredictiveScalingMetricSpecification `pulumi:"metricSpecifications"` - // The predictive scaling mode. Defaults to `ForecastOnly` if not specified. + // The predictive scaling mode. Defaults to ``ForecastOnly`` if not specified. Mode *string `pulumi:"mode"` // The amount of time, in seconds, that the start time can be advanced. - // - // The value must be less than the forecast interval duration of 3600 seconds (60 minutes). Defaults to 300 seconds if not specified. + // The value must be less than the forecast interval duration of 3600 seconds (60 minutes). Defaults to 300 seconds if not specified. SchedulingBufferTime *int `pulumi:"schedulingBufferTime"` } @@ -2309,22 +2358,20 @@ type ScalingPolicyPredictiveScalingPolicyConfigurationInput interface { ToScalingPolicyPredictiveScalingPolicyConfigurationOutputWithContext(context.Context) ScalingPolicyPredictiveScalingPolicyConfigurationOutput } +// Represents a predictive scaling policy configuration. type ScalingPolicyPredictiveScalingPolicyConfigurationArgs struct { - // Defines the behavior that should be applied if the forecast capacity approaches or exceeds the maximum capacity. Defaults to `HonorMaxCapacity` if not specified. + // Defines the behavior that should be applied if the forecast capacity approaches or exceeds the maximum capacity. Defaults to ``HonorMaxCapacity`` if not specified. MaxCapacityBreachBehavior pulumi.StringPtrInput `pulumi:"maxCapacityBreachBehavior"` // 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. - // - // Required if the `MaxCapacityBreachBehavior` property is set to `IncreaseMaxCapacity` , and cannot be used otherwise. + // Required if the ``MaxCapacityBreachBehavior`` property is set to ``IncreaseMaxCapacity``, and cannot be used otherwise. MaxCapacityBuffer pulumi.IntPtrInput `pulumi:"maxCapacityBuffer"` // This structure includes the metrics and target utilization to use for predictive scaling. - // - // 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. + // 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. MetricSpecifications ScalingPolicyPredictiveScalingMetricSpecificationArrayInput `pulumi:"metricSpecifications"` - // The predictive scaling mode. Defaults to `ForecastOnly` if not specified. + // The predictive scaling mode. Defaults to ``ForecastOnly`` if not specified. Mode pulumi.StringPtrInput `pulumi:"mode"` // The amount of time, in seconds, that the start time can be advanced. - // - // The value must be less than the forecast interval duration of 3600 seconds (60 minutes). Defaults to 300 seconds if not specified. + // The value must be less than the forecast interval duration of 3600 seconds (60 minutes). Defaults to 300 seconds if not specified. SchedulingBufferTime pulumi.IntPtrInput `pulumi:"schedulingBufferTime"` } @@ -2381,6 +2428,7 @@ func (i *scalingPolicyPredictiveScalingPolicyConfigurationPtrType) ToScalingPoli return pulumi.ToOutputWithContext(ctx, i).(ScalingPolicyPredictiveScalingPolicyConfigurationPtrOutput) } +// Represents a predictive scaling policy configuration. type ScalingPolicyPredictiveScalingPolicyConfigurationOutput struct{ *pulumi.OutputState } func (ScalingPolicyPredictiveScalingPolicyConfigurationOutput) ElementType() reflect.Type { @@ -2405,35 +2453,35 @@ func (o ScalingPolicyPredictiveScalingPolicyConfigurationOutput) ToScalingPolicy }).(ScalingPolicyPredictiveScalingPolicyConfigurationPtrOutput) } -// Defines the behavior that should be applied if the forecast capacity approaches or exceeds the maximum capacity. Defaults to `HonorMaxCapacity` if not specified. +// Defines the behavior that should be applied if the forecast capacity approaches or exceeds the maximum capacity. Defaults to “HonorMaxCapacity“ if not specified. func (o ScalingPolicyPredictiveScalingPolicyConfigurationOutput) MaxCapacityBreachBehavior() pulumi.StringPtrOutput { return o.ApplyT(func(v ScalingPolicyPredictiveScalingPolicyConfiguration) *string { return v.MaxCapacityBreachBehavior }).(pulumi.StringPtrOutput) } // 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. // -// Required if the `MaxCapacityBreachBehavior` property is set to `IncreaseMaxCapacity` , and cannot be used otherwise. +// Required if the ``MaxCapacityBreachBehavior`` property is set to ``IncreaseMaxCapacity``, and cannot be used otherwise. func (o ScalingPolicyPredictiveScalingPolicyConfigurationOutput) MaxCapacityBuffer() pulumi.IntPtrOutput { return o.ApplyT(func(v ScalingPolicyPredictiveScalingPolicyConfiguration) *int { return v.MaxCapacityBuffer }).(pulumi.IntPtrOutput) } // This structure includes the metrics and target utilization to use for predictive scaling. // -// 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. +// 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. func (o ScalingPolicyPredictiveScalingPolicyConfigurationOutput) MetricSpecifications() ScalingPolicyPredictiveScalingMetricSpecificationArrayOutput { return o.ApplyT(func(v ScalingPolicyPredictiveScalingPolicyConfiguration) []ScalingPolicyPredictiveScalingMetricSpecification { return v.MetricSpecifications }).(ScalingPolicyPredictiveScalingMetricSpecificationArrayOutput) } -// The predictive scaling mode. Defaults to `ForecastOnly` if not specified. +// The predictive scaling mode. Defaults to “ForecastOnly“ if not specified. func (o ScalingPolicyPredictiveScalingPolicyConfigurationOutput) Mode() pulumi.StringPtrOutput { return o.ApplyT(func(v ScalingPolicyPredictiveScalingPolicyConfiguration) *string { return v.Mode }).(pulumi.StringPtrOutput) } // The amount of time, in seconds, that the start time can be advanced. // -// The value must be less than the forecast interval duration of 3600 seconds (60 minutes). Defaults to 300 seconds if not specified. +// The value must be less than the forecast interval duration of 3600 seconds (60 minutes). Defaults to 300 seconds if not specified. func (o ScalingPolicyPredictiveScalingPolicyConfigurationOutput) SchedulingBufferTime() pulumi.IntPtrOutput { return o.ApplyT(func(v ScalingPolicyPredictiveScalingPolicyConfiguration) *int { return v.SchedulingBufferTime }).(pulumi.IntPtrOutput) } @@ -2462,7 +2510,7 @@ func (o ScalingPolicyPredictiveScalingPolicyConfigurationPtrOutput) Elem() Scali }).(ScalingPolicyPredictiveScalingPolicyConfigurationOutput) } -// Defines the behavior that should be applied if the forecast capacity approaches or exceeds the maximum capacity. Defaults to `HonorMaxCapacity` if not specified. +// Defines the behavior that should be applied if the forecast capacity approaches or exceeds the maximum capacity. Defaults to “HonorMaxCapacity“ if not specified. func (o ScalingPolicyPredictiveScalingPolicyConfigurationPtrOutput) MaxCapacityBreachBehavior() pulumi.StringPtrOutput { return o.ApplyT(func(v *ScalingPolicyPredictiveScalingPolicyConfiguration) *string { if v == nil { @@ -2474,7 +2522,7 @@ func (o ScalingPolicyPredictiveScalingPolicyConfigurationPtrOutput) MaxCapacityB // 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. // -// Required if the `MaxCapacityBreachBehavior` property is set to `IncreaseMaxCapacity` , and cannot be used otherwise. +// Required if the ``MaxCapacityBreachBehavior`` property is set to ``IncreaseMaxCapacity``, and cannot be used otherwise. func (o ScalingPolicyPredictiveScalingPolicyConfigurationPtrOutput) MaxCapacityBuffer() pulumi.IntPtrOutput { return o.ApplyT(func(v *ScalingPolicyPredictiveScalingPolicyConfiguration) *int { if v == nil { @@ -2486,7 +2534,7 @@ func (o ScalingPolicyPredictiveScalingPolicyConfigurationPtrOutput) MaxCapacityB // This structure includes the metrics and target utilization to use for predictive scaling. // -// 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. +// 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. func (o ScalingPolicyPredictiveScalingPolicyConfigurationPtrOutput) MetricSpecifications() ScalingPolicyPredictiveScalingMetricSpecificationArrayOutput { return o.ApplyT(func(v *ScalingPolicyPredictiveScalingPolicyConfiguration) []ScalingPolicyPredictiveScalingMetricSpecification { if v == nil { @@ -2496,7 +2544,7 @@ func (o ScalingPolicyPredictiveScalingPolicyConfigurationPtrOutput) MetricSpecif }).(ScalingPolicyPredictiveScalingMetricSpecificationArrayOutput) } -// The predictive scaling mode. Defaults to `ForecastOnly` if not specified. +// The predictive scaling mode. Defaults to “ForecastOnly“ if not specified. func (o ScalingPolicyPredictiveScalingPolicyConfigurationPtrOutput) Mode() pulumi.StringPtrOutput { return o.ApplyT(func(v *ScalingPolicyPredictiveScalingPolicyConfiguration) *string { if v == nil { @@ -2508,7 +2556,7 @@ func (o ScalingPolicyPredictiveScalingPolicyConfigurationPtrOutput) Mode() pulum // The amount of time, in seconds, that the start time can be advanced. // -// The value must be less than the forecast interval duration of 3600 seconds (60 minutes). Defaults to 300 seconds if not specified. +// The value must be less than the forecast interval duration of 3600 seconds (60 minutes). Defaults to 300 seconds if not specified. func (o ScalingPolicyPredictiveScalingPolicyConfigurationPtrOutput) SchedulingBufferTime() pulumi.IntPtrOutput { return o.ApplyT(func(v *ScalingPolicyPredictiveScalingPolicyConfiguration) *int { if v == nil { @@ -2518,6 +2566,9 @@ func (o ScalingPolicyPredictiveScalingPolicyConfigurationPtrOutput) SchedulingBu }).(pulumi.IntPtrOutput) } +// Describes a load metric for a predictive scaling policy. +// +// 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. type ScalingPolicyPredictiveScalingPredefinedLoadMetric struct { // The metric type. PredefinedMetricType string `pulumi:"predefinedMetricType"` @@ -2536,6 +2587,9 @@ type ScalingPolicyPredictiveScalingPredefinedLoadMetricInput interface { ToScalingPolicyPredictiveScalingPredefinedLoadMetricOutputWithContext(context.Context) ScalingPolicyPredictiveScalingPredefinedLoadMetricOutput } +// Describes a load metric for a predictive scaling policy. +// +// 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. type ScalingPolicyPredictiveScalingPredefinedLoadMetricArgs struct { // The metric type. PredefinedMetricType pulumi.StringInput `pulumi:"predefinedMetricType"` @@ -2596,6 +2650,9 @@ func (i *scalingPolicyPredictiveScalingPredefinedLoadMetricPtrType) ToScalingPol return pulumi.ToOutputWithContext(ctx, i).(ScalingPolicyPredictiveScalingPredefinedLoadMetricPtrOutput) } +// Describes a load metric for a predictive scaling policy. +// +// 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. type ScalingPolicyPredictiveScalingPredefinedLoadMetricOutput struct{ *pulumi.OutputState } func (ScalingPolicyPredictiveScalingPredefinedLoadMetricOutput) ElementType() reflect.Type { @@ -2674,6 +2731,7 @@ func (o ScalingPolicyPredictiveScalingPredefinedLoadMetricPtrOutput) ResourceLab }).(pulumi.StringPtrOutput) } +// Represents a metric pair for a predictive scaling policy. type ScalingPolicyPredictiveScalingPredefinedMetricPair struct { // 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. PredefinedMetricType string `pulumi:"predefinedMetricType"` @@ -2692,6 +2750,7 @@ type ScalingPolicyPredictiveScalingPredefinedMetricPairInput interface { ToScalingPolicyPredictiveScalingPredefinedMetricPairOutputWithContext(context.Context) ScalingPolicyPredictiveScalingPredefinedMetricPairOutput } +// Represents a metric pair for a predictive scaling policy. type ScalingPolicyPredictiveScalingPredefinedMetricPairArgs struct { // 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. PredefinedMetricType pulumi.StringInput `pulumi:"predefinedMetricType"` @@ -2752,6 +2811,7 @@ func (i *scalingPolicyPredictiveScalingPredefinedMetricPairPtrType) ToScalingPol return pulumi.ToOutputWithContext(ctx, i).(ScalingPolicyPredictiveScalingPredefinedMetricPairPtrOutput) } +// Represents a metric pair for a predictive scaling policy. type ScalingPolicyPredictiveScalingPredefinedMetricPairOutput struct{ *pulumi.OutputState } func (ScalingPolicyPredictiveScalingPredefinedMetricPairOutput) ElementType() reflect.Type { @@ -2830,6 +2890,9 @@ func (o ScalingPolicyPredictiveScalingPredefinedMetricPairPtrOutput) ResourceLab }).(pulumi.StringPtrOutput) } +// Describes a scaling metric for a predictive scaling policy. +// +// 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. type ScalingPolicyPredictiveScalingPredefinedScalingMetric struct { // The metric type. PredefinedMetricType string `pulumi:"predefinedMetricType"` @@ -2848,6 +2911,9 @@ type ScalingPolicyPredictiveScalingPredefinedScalingMetricInput interface { ToScalingPolicyPredictiveScalingPredefinedScalingMetricOutputWithContext(context.Context) ScalingPolicyPredictiveScalingPredefinedScalingMetricOutput } +// Describes a scaling metric for a predictive scaling policy. +// +// 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. type ScalingPolicyPredictiveScalingPredefinedScalingMetricArgs struct { // The metric type. PredefinedMetricType pulumi.StringInput `pulumi:"predefinedMetricType"` @@ -2908,6 +2974,9 @@ func (i *scalingPolicyPredictiveScalingPredefinedScalingMetricPtrType) ToScaling return pulumi.ToOutputWithContext(ctx, i).(ScalingPolicyPredictiveScalingPredefinedScalingMetricPtrOutput) } +// Describes a scaling metric for a predictive scaling policy. +// +// 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. type ScalingPolicyPredictiveScalingPredefinedScalingMetricOutput struct{ *pulumi.OutputState } func (ScalingPolicyPredictiveScalingPredefinedScalingMetricOutput) ElementType() reflect.Type { diff --git a/sdk/go/aws/bedrock/pulumiTypes.go b/sdk/go/aws/bedrock/pulumiTypes.go index 8f84856947..c9b1bdea54 100644 --- a/sdk/go/aws/bedrock/pulumiTypes.go +++ b/sdk/go/aws/bedrock/pulumiTypes.go @@ -4442,7 +4442,7 @@ func (o DataSourceIntermediateStoragePtrOutput) S3Location() DataSourceS3Locatio // Settings for parsing document contents type DataSourceParsingConfiguration struct { - // Settings for a foundation model used to parse documents for a data source. + // If you specify `BEDROCK_FOUNDATION_MODEL` as the parsing strategy for ingesting your data source, use this object to modify configurations for using a foundation model to parse documents. BedrockFoundationModelConfiguration *DataSourceBedrockFoundationModelConfiguration `pulumi:"bedrockFoundationModelConfiguration"` // The parsing strategy for the data source. ParsingStrategy DataSourceParsingStrategy `pulumi:"parsingStrategy"` @@ -4461,7 +4461,7 @@ type DataSourceParsingConfigurationInput interface { // Settings for parsing document contents type DataSourceParsingConfigurationArgs struct { - // Settings for a foundation model used to parse documents for a data source. + // If you specify `BEDROCK_FOUNDATION_MODEL` as the parsing strategy for ingesting your data source, use this object to modify configurations for using a foundation model to parse documents. BedrockFoundationModelConfiguration DataSourceBedrockFoundationModelConfigurationPtrInput `pulumi:"bedrockFoundationModelConfiguration"` // The parsing strategy for the data source. ParsingStrategy DataSourceParsingStrategyInput `pulumi:"parsingStrategy"` @@ -4545,7 +4545,7 @@ func (o DataSourceParsingConfigurationOutput) ToDataSourceParsingConfigurationPt }).(DataSourceParsingConfigurationPtrOutput) } -// Settings for a foundation model used to parse documents for a data source. +// If you specify `BEDROCK_FOUNDATION_MODEL` as the parsing strategy for ingesting your data source, use this object to modify configurations for using a foundation model to parse documents. func (o DataSourceParsingConfigurationOutput) BedrockFoundationModelConfiguration() DataSourceBedrockFoundationModelConfigurationPtrOutput { return o.ApplyT(func(v DataSourceParsingConfiguration) *DataSourceBedrockFoundationModelConfiguration { return v.BedrockFoundationModelConfiguration @@ -4581,7 +4581,7 @@ func (o DataSourceParsingConfigurationPtrOutput) Elem() DataSourceParsingConfigu }).(DataSourceParsingConfigurationOutput) } -// Settings for a foundation model used to parse documents for a data source. +// If you specify `BEDROCK_FOUNDATION_MODEL` as the parsing strategy for ingesting your data source, use this object to modify configurations for using a foundation model to parse documents. func (o DataSourceParsingConfigurationPtrOutput) BedrockFoundationModelConfiguration() DataSourceBedrockFoundationModelConfigurationPtrOutput { return o.ApplyT(func(v *DataSourceParsingConfiguration) *DataSourceBedrockFoundationModelConfiguration { if v == nil { @@ -7125,7 +7125,7 @@ type DataSourceVectorIngestionConfiguration struct { ChunkingConfiguration *DataSourceChunkingConfiguration `pulumi:"chunkingConfiguration"` // A custom document transformer for parsed data source documents. CustomTransformationConfiguration *DataSourceCustomTransformationConfiguration `pulumi:"customTransformationConfiguration"` - // A custom parser for data source documents. + // Configurations for a parser to use for parsing documents in your data source. If you exclude this field, the default parser will be used. ParsingConfiguration *DataSourceParsingConfiguration `pulumi:"parsingConfiguration"` } @@ -7146,7 +7146,7 @@ type DataSourceVectorIngestionConfigurationArgs struct { ChunkingConfiguration DataSourceChunkingConfigurationPtrInput `pulumi:"chunkingConfiguration"` // A custom document transformer for parsed data source documents. CustomTransformationConfiguration DataSourceCustomTransformationConfigurationPtrInput `pulumi:"customTransformationConfiguration"` - // A custom parser for data source documents. + // Configurations for a parser to use for parsing documents in your data source. If you exclude this field, the default parser will be used. ParsingConfiguration DataSourceParsingConfigurationPtrInput `pulumi:"parsingConfiguration"` } @@ -7242,7 +7242,7 @@ func (o DataSourceVectorIngestionConfigurationOutput) CustomTransformationConfig }).(DataSourceCustomTransformationConfigurationPtrOutput) } -// A custom parser for data source documents. +// Configurations for a parser to use for parsing documents in your data source. If you exclude this field, the default parser will be used. func (o DataSourceVectorIngestionConfigurationOutput) ParsingConfiguration() DataSourceParsingConfigurationPtrOutput { return o.ApplyT(func(v DataSourceVectorIngestionConfiguration) *DataSourceParsingConfiguration { return v.ParsingConfiguration @@ -7293,7 +7293,7 @@ func (o DataSourceVectorIngestionConfigurationPtrOutput) CustomTransformationCon }).(DataSourceCustomTransformationConfigurationPtrOutput) } -// A custom parser for data source documents. +// Configurations for a parser to use for parsing documents in your data source. If you exclude this field, the default parser will be used. func (o DataSourceVectorIngestionConfigurationPtrOutput) ParsingConfiguration() DataSourceParsingConfigurationPtrOutput { return o.ApplyT(func(v *DataSourceVectorIngestionConfiguration) *DataSourceParsingConfiguration { if v == nil { @@ -18651,7 +18651,7 @@ type GuardrailPiiEntityConfig struct { // A physical address, such as "100 Main Street, Anytown, USA" or "Suite #12, Building 123". An address can include information such as the street, building, location, city, state, country, county, zip code, precinct, and neighborhood. // - *AGE* // - // An individual's age, including the quantity and unit of time. For example, in the phrase "I am 40 years old," Guarrails recognizes "40 years" as an age. + // An individual's age, including the quantity and unit of time. For example, in the phrase "I am 40 years old," Guardrails recognizes "40 years" as an age. // - *NAME* // // An individual's name. This entity type does not include titles, such as Dr., Mr., Mrs., or Miss. guardrails doesn't apply this entity type to names that are part of organizations or addresses. For example, guardrails recognizes the "John Doe Organization" as an organization, and it recognizes "Jane Doe Street" as an address. @@ -18678,7 +18678,7 @@ type GuardrailPiiEntityConfig struct { // A Vehicle Identification Number (VIN) uniquely identifies a vehicle. VIN content and format are defined in the *ISO 3779* specification. Each country has specific codes and formats for VINs. // - *Finance* // - // - *REDIT_DEBIT_CARD_CVV* + // - *CREDIT_DEBIT_CARD_CVV* // // A three-digit card verification code (CVV) that is present on VISA, MasterCard, and Discover credit and debit cards. For American Express credit or debit cards, the CVV is a four-digit numeric code. // - *CREDIT_DEBIT_CARD_EXPIRY* @@ -18787,7 +18787,7 @@ type GuardrailPiiEntityConfigArgs struct { // A physical address, such as "100 Main Street, Anytown, USA" or "Suite #12, Building 123". An address can include information such as the street, building, location, city, state, country, county, zip code, precinct, and neighborhood. // - *AGE* // - // An individual's age, including the quantity and unit of time. For example, in the phrase "I am 40 years old," Guarrails recognizes "40 years" as an age. + // An individual's age, including the quantity and unit of time. For example, in the phrase "I am 40 years old," Guardrails recognizes "40 years" as an age. // - *NAME* // // An individual's name. This entity type does not include titles, such as Dr., Mr., Mrs., or Miss. guardrails doesn't apply this entity type to names that are part of organizations or addresses. For example, guardrails recognizes the "John Doe Organization" as an organization, and it recognizes "Jane Doe Street" as an address. @@ -18814,7 +18814,7 @@ type GuardrailPiiEntityConfigArgs struct { // A Vehicle Identification Number (VIN) uniquely identifies a vehicle. VIN content and format are defined in the *ISO 3779* specification. Each country has specific codes and formats for VINs. // - *Finance* // - // - *REDIT_DEBIT_CARD_CVV* + // - *CREDIT_DEBIT_CARD_CVV* // // A three-digit card verification code (CVV) that is present on VISA, MasterCard, and Discover credit and debit cards. For American Express credit or debit cards, the CVV is a four-digit numeric code. // - *CREDIT_DEBIT_CARD_EXPIRY* @@ -18965,7 +18965,7 @@ func (o GuardrailPiiEntityConfigOutput) Action() GuardrailSensitiveInformationAc // A physical address, such as "100 Main Street, Anytown, USA" or "Suite #12, Building 123". An address can include information such as the street, building, location, city, state, country, county, zip code, precinct, and neighborhood. // - *AGE* // -// An individual's age, including the quantity and unit of time. For example, in the phrase "I am 40 years old," Guarrails recognizes "40 years" as an age. +// An individual's age, including the quantity and unit of time. For example, in the phrase "I am 40 years old," Guardrails recognizes "40 years" as an age. // - *NAME* // // An individual's name. This entity type does not include titles, such as Dr., Mr., Mrs., or Miss. guardrails doesn't apply this entity type to names that are part of organizations or addresses. For example, guardrails recognizes the "John Doe Organization" as an organization, and it recognizes "Jane Doe Street" as an address. @@ -18992,7 +18992,7 @@ func (o GuardrailPiiEntityConfigOutput) Action() GuardrailSensitiveInformationAc // A Vehicle Identification Number (VIN) uniquely identifies a vehicle. VIN content and format are defined in the *ISO 3779* specification. Each country has specific codes and formats for VINs. // - *Finance* // -// - *REDIT_DEBIT_CARD_CVV* +// - *CREDIT_DEBIT_CARD_CVV* // // A three-digit card verification code (CVV) that is present on VISA, MasterCard, and Discover credit and debit cards. For American Express credit or debit cards, the CVV is a four-digit numeric code. // - *CREDIT_DEBIT_CARD_EXPIRY* diff --git a/sdk/go/aws/cognito/getManagedLoginBranding.go b/sdk/go/aws/cognito/getManagedLoginBranding.go index 0ce8945f27..7d216a0123 100644 --- a/sdk/go/aws/cognito/getManagedLoginBranding.go +++ b/sdk/go/aws/cognito/getManagedLoginBranding.go @@ -38,7 +38,9 @@ type LookupManagedLoginBrandingResult struct { // // Search the [CloudFormation User Guide](https://docs.aws.amazon.com/cloudformation/) for `AWS::Cognito::ManagedLoginBranding` for more information about the expected schema for this property. Settings interface{} `pulumi:"settings"` - // When true, applies the default branding style options. This option reverts to a "blank" style that you can modify later in the branding designer. + // When true, applies the default branding style options. This option reverts to default style options that are managed by Amazon Cognito. You can modify them later in the branding designer. + // + // When you specify `true` for this option, you must also omit values for `Settings` and `Assets` in the request. UseCognitoProvidedValues *bool `pulumi:"useCognitoProvidedValues"` } @@ -103,7 +105,9 @@ func (o LookupManagedLoginBrandingResultOutput) Settings() pulumi.AnyOutput { return o.ApplyT(func(v LookupManagedLoginBrandingResult) interface{} { return v.Settings }).(pulumi.AnyOutput) } -// When true, applies the default branding style options. This option reverts to a "blank" style that you can modify later in the branding designer. +// When true, applies the default branding style options. This option reverts to default style options that are managed by Amazon Cognito. You can modify them later in the branding designer. +// +// When you specify `true` for this option, you must also omit values for `Settings` and `Assets` in the request. func (o LookupManagedLoginBrandingResultOutput) UseCognitoProvidedValues() pulumi.BoolPtrOutput { return o.ApplyT(func(v LookupManagedLoginBrandingResult) *bool { return v.UseCognitoProvidedValues }).(pulumi.BoolPtrOutput) } diff --git a/sdk/go/aws/cognito/getUserPool.go b/sdk/go/aws/cognito/getUserPool.go index e614d42530..ccd4bbff8d 100644 --- a/sdk/go/aws/cognito/getUserPool.go +++ b/sdk/go/aws/cognito/getUserPool.go @@ -34,11 +34,11 @@ type LookupUserPoolResult struct { // // This data type is a request and response parameter of [CreateUserPool](https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_CreateUserPool.html) and [UpdateUserPool](https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_UpdateUserPool.html) , and a response parameter of [DescribeUserPool](https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_DescribeUserPool.html) . AdminCreateUserConfig *UserPoolAdminCreateUserConfig `pulumi:"adminCreateUserConfig"` - // Attributes supported as an alias for this user pool. Possible values: *phone_number* , *email* , or *preferred_username* . + // Attributes supported as an alias for this user pool. Possible values: *phone_number* , *email* , or *preferred_username* . For more information about alias attributes, see [Customizing sign-in attributes](https://docs.aws.amazon.com/cognito/latest/developerguide/user-pool-settings-attributes.html#user-pool-settings-aliases) . AliasAttributes []string `pulumi:"aliasAttributes"` // The Amazon Resource Name (ARN) of the user pool, such as `arn:aws:cognito-idp:us-east-1:123412341234:userpool/us-east-1_123412341` . Arn *string `pulumi:"arn"` - // The attributes to be auto-verified. Possible values: *email* , *phone_number* . + // The attributes that you want your user pool to automatically verify. Possible values: *email* , *phone_number* . For more information see [Verifying contact information at sign-up](https://docs.aws.amazon.com/cognito/latest/developerguide/signing-up-users-in-your-app.html#allowing-users-to-sign-up-and-confirm-themselves) . AutoVerifiedAttributes []string `pulumi:"autoVerifiedAttributes"` // When active, `DeletionProtection` prevents accidental deletion of your user // pool. Before you can delete a user pool that you have protected against deletion, you @@ -46,9 +46,9 @@ type LookupUserPoolResult struct { // // When you try to delete a protected user pool in a `DeleteUserPool` API request, Amazon Cognito returns an `InvalidParameterException` error. To delete a protected user pool, send a new `DeleteUserPool` request after you deactivate deletion protection in an `UpdateUserPool` API request. DeletionProtection *string `pulumi:"deletionProtection"` - // The device-remembering configuration for a user pool. A null value indicates that you have deactivated device remembering in your user pool. + // The device-remembering configuration for a user pool. Device remembering or device tracking is a "Remember me on this device" option for user pools that perform authentication with the device key of a trusted device in the back end, instead of a user-provided MFA code. For more information about device authentication, see [Working with user devices in your user pool](https://docs.aws.amazon.com/cognito/latest/developerguide/amazon-cognito-user-pools-device-tracking.html) . A null value indicates that you have deactivated device remembering in your user pool. // - // > When you provide a value for any `DeviceConfiguration` field, you activate the Amazon Cognito device-remembering feature. + // > When you provide a value for any `DeviceConfiguration` field, you activate the Amazon Cognito device-remembering feature. For more infor DeviceConfiguration *UserPoolDeviceConfiguration `pulumi:"deviceConfiguration"` EmailAuthenticationMessage *string `pulumi:"emailAuthenticationMessage"` EmailAuthenticationSubject *string `pulumi:"emailAuthenticationSubject"` @@ -74,11 +74,11 @@ type LookupUserPoolResult struct { ProviderName *string `pulumi:"providerName"` // The URL of the provider of the Amazon Cognito user pool, specified as a `String` . ProviderUrl *string `pulumi:"providerUrl"` - // An array of schema attributes for the new user pool. These attributes can be standard or custom attributes. + // An array of attributes for the new user pool. You can add custom attributes and modify the properties of default attributes. The specifications in this parameter set the required attributes in your user pool. For more information, see [Working with user attributes](https://docs.aws.amazon.com/cognito/latest/developerguide/user-pool-settings-attributes.html) . Schema []UserPoolSchemaAttribute `pulumi:"schema"` // The contents of the SMS authentication message. SmsAuthenticationMessage *string `pulumi:"smsAuthenticationMessage"` - // The SMS configuration with the settings that your Amazon Cognito user pool must use to send an SMS message from your AWS account through Amazon Simple Notification Service. To send SMS messages with Amazon SNS in the AWS Region that you want, the Amazon Cognito user pool uses an AWS Identity and Access Management (IAM) role in your AWS account . + // The SMS configuration with the settings that your Amazon Cognito user pool must use to send an SMS message from your AWS account through Amazon Simple Notification Service. To send SMS messages with Amazon SNS in the AWS Region that you want, the Amazon Cognito user pool uses an AWS Identity and Access Management (IAM) role in your AWS account . For more information see [SMS message settings](https://docs.aws.amazon.com/cognito/latest/developerguide/user-pool-sms-settings.html) . SmsConfiguration *UserPoolSmsConfiguration `pulumi:"smsConfiguration"` // This parameter is no longer used. See [VerificationMessageTemplateType](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cognito-userpool-verificationmessagetemplate.html) . SmsVerificationMessage *string `pulumi:"smsVerificationMessage"` @@ -92,7 +92,7 @@ type LookupUserPoolResult struct { UserPoolAddOns *UserPoolAddOns `pulumi:"userPoolAddOns"` // The ID of the user pool. UserPoolId *string `pulumi:"userPoolId"` - // A string used to name the user pool. + // A friendlhy name for your user pool. UserPoolName *string `pulumi:"userPoolName"` // The tag keys and values to assign to the user pool. A tag is a label that you can use to categorize and manage user pools in different ways, such as by purpose, owner, environment, or other criteria. UserPoolTags map[string]string `pulumi:"userPoolTags"` @@ -100,16 +100,26 @@ type LookupUserPoolResult struct { UserPoolTier *UserPoolTier `pulumi:"userPoolTier"` // Specifies whether a user can use an email address or phone number as a username when they sign up. UsernameAttributes []string `pulumi:"usernameAttributes"` - // Case sensitivity on the username input for the selected sign-in option. When case sensitivity is set to `False` (case insensitive), users can sign in with any combination of capital and lowercase letters. For example, `username` , `USERNAME` , or `UserName` , or for email, `email@example.com` or `EMaiL@eXamplE.Com` . For most use cases, set case sensitivity to `False` (case insensitive) as a best practice. When usernames and email addresses are case insensitive, Amazon Cognito treats any variation in case as the same user, and prevents a case variation from being assigned to the same attribute for a different user. + // Sets the case sensitivity option for sign-in usernames. When `CaseSensitive` is `false` (case insensitive), users can sign in with any combination of capital and lowercase letters. For example, `username` , `USERNAME` , or `UserName` , or for email, `email@example.com` or `EMaiL@eXamplE.Com` . For most use cases, set case sensitivity to `false` as a best practice. When usernames and email addresses are case insensitive, Amazon Cognito treats any variation in case as the same user, and prevents a case variation from being assigned to the same attribute for a different user. // - // This configuration is immutable after you set it. For more information, see [UsernameConfigurationType](https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_UsernameConfigurationType.html) . + // When `CaseSensitive` is `true` (case sensitive), Amazon Cognito interprets `USERNAME` and `UserName` as distinct users. + // + // This configuration is immutable after you set it. UsernameConfiguration *UserPoolUsernameConfiguration `pulumi:"usernameConfiguration"` // The template for the verification message that your user pool delivers to users who set an email address or phone number attribute. // // Set the email message type that corresponds to your `DefaultEmailOption` selection. For `CONFIRM_WITH_LINK` , specify an `EmailMessageByLink` and leave `EmailMessage` blank. For `CONFIRM_WITH_CODE` , specify an `EmailMessage` and leave `EmailMessageByLink` blank. When you supply both parameters with either choice, Amazon Cognito returns an error. VerificationMessageTemplate *UserPoolVerificationMessageTemplate `pulumi:"verificationMessageTemplate"` - WebAuthnRelyingPartyId *string `pulumi:"webAuthnRelyingPartyId"` - WebAuthnUserVerification *string `pulumi:"webAuthnUserVerification"` + // Sets or displays the authentication domain, typically your user pool domain, that passkey providers must use as a relying party (RP) in their configuration. + // + // Under the following conditions, the passkey relying party ID must be the fully-qualified domain name of your custom domain: + // + // - The user pool is configured for passkey authentication. + // - The user pool has a custom domain, whether or not it also has a prefix domain. + // - Your application performs authentication with managed login or the classic hosted UI. + WebAuthnRelyingPartyId *string `pulumi:"webAuthnRelyingPartyId"` + // When `required` , users can only register and sign in users with passkeys that are capable of [user verification](https://docs.aws.amazon.com/https://www.w3.org/TR/webauthn-2/#enum-userVerificationRequirement) . When `preferred` , your user pool doesn't require the use of authenticators with user verification but encourages it. + WebAuthnUserVerification *string `pulumi:"webAuthnUserVerification"` } func LookupUserPoolOutput(ctx *pulumi.Context, args LookupUserPoolOutputArgs, opts ...pulumi.InvokeOption) LookupUserPoolResultOutput { @@ -166,7 +176,7 @@ func (o LookupUserPoolResultOutput) AdminCreateUserConfig() UserPoolAdminCreateU return o.ApplyT(func(v LookupUserPoolResult) *UserPoolAdminCreateUserConfig { return v.AdminCreateUserConfig }).(UserPoolAdminCreateUserConfigPtrOutput) } -// Attributes supported as an alias for this user pool. Possible values: *phone_number* , *email* , or *preferred_username* . +// Attributes supported as an alias for this user pool. Possible values: *phone_number* , *email* , or *preferred_username* . For more information about alias attributes, see [Customizing sign-in attributes](https://docs.aws.amazon.com/cognito/latest/developerguide/user-pool-settings-attributes.html#user-pool-settings-aliases) . func (o LookupUserPoolResultOutput) AliasAttributes() pulumi.StringArrayOutput { return o.ApplyT(func(v LookupUserPoolResult) []string { return v.AliasAttributes }).(pulumi.StringArrayOutput) } @@ -176,7 +186,7 @@ func (o LookupUserPoolResultOutput) Arn() pulumi.StringPtrOutput { return o.ApplyT(func(v LookupUserPoolResult) *string { return v.Arn }).(pulumi.StringPtrOutput) } -// The attributes to be auto-verified. Possible values: *email* , *phone_number* . +// The attributes that you want your user pool to automatically verify. Possible values: *email* , *phone_number* . For more information see [Verifying contact information at sign-up](https://docs.aws.amazon.com/cognito/latest/developerguide/signing-up-users-in-your-app.html#allowing-users-to-sign-up-and-confirm-themselves) . func (o LookupUserPoolResultOutput) AutoVerifiedAttributes() pulumi.StringArrayOutput { return o.ApplyT(func(v LookupUserPoolResult) []string { return v.AutoVerifiedAttributes }).(pulumi.StringArrayOutput) } @@ -190,9 +200,9 @@ func (o LookupUserPoolResultOutput) DeletionProtection() pulumi.StringPtrOutput return o.ApplyT(func(v LookupUserPoolResult) *string { return v.DeletionProtection }).(pulumi.StringPtrOutput) } -// The device-remembering configuration for a user pool. A null value indicates that you have deactivated device remembering in your user pool. +// The device-remembering configuration for a user pool. Device remembering or device tracking is a "Remember me on this device" option for user pools that perform authentication with the device key of a trusted device in the back end, instead of a user-provided MFA code. For more information about device authentication, see [Working with user devices in your user pool](https://docs.aws.amazon.com/cognito/latest/developerguide/amazon-cognito-user-pools-device-tracking.html) . A null value indicates that you have deactivated device remembering in your user pool. // -// > When you provide a value for any `DeviceConfiguration` field, you activate the Amazon Cognito device-remembering feature. +// > When you provide a value for any `DeviceConfiguration` field, you activate the Amazon Cognito device-remembering feature. For more infor func (o LookupUserPoolResultOutput) DeviceConfiguration() UserPoolDeviceConfigurationPtrOutput { return o.ApplyT(func(v LookupUserPoolResult) *UserPoolDeviceConfiguration { return v.DeviceConfiguration }).(UserPoolDeviceConfigurationPtrOutput) } @@ -251,7 +261,7 @@ func (o LookupUserPoolResultOutput) ProviderUrl() pulumi.StringPtrOutput { return o.ApplyT(func(v LookupUserPoolResult) *string { return v.ProviderUrl }).(pulumi.StringPtrOutput) } -// An array of schema attributes for the new user pool. These attributes can be standard or custom attributes. +// An array of attributes for the new user pool. You can add custom attributes and modify the properties of default attributes. The specifications in this parameter set the required attributes in your user pool. For more information, see [Working with user attributes](https://docs.aws.amazon.com/cognito/latest/developerguide/user-pool-settings-attributes.html) . func (o LookupUserPoolResultOutput) Schema() UserPoolSchemaAttributeArrayOutput { return o.ApplyT(func(v LookupUserPoolResult) []UserPoolSchemaAttribute { return v.Schema }).(UserPoolSchemaAttributeArrayOutput) } @@ -261,7 +271,7 @@ func (o LookupUserPoolResultOutput) SmsAuthenticationMessage() pulumi.StringPtrO return o.ApplyT(func(v LookupUserPoolResult) *string { return v.SmsAuthenticationMessage }).(pulumi.StringPtrOutput) } -// The SMS configuration with the settings that your Amazon Cognito user pool must use to send an SMS message from your AWS account through Amazon Simple Notification Service. To send SMS messages with Amazon SNS in the AWS Region that you want, the Amazon Cognito user pool uses an AWS Identity and Access Management (IAM) role in your AWS account . +// The SMS configuration with the settings that your Amazon Cognito user pool must use to send an SMS message from your AWS account through Amazon Simple Notification Service. To send SMS messages with Amazon SNS in the AWS Region that you want, the Amazon Cognito user pool uses an AWS Identity and Access Management (IAM) role in your AWS account . For more information see [SMS message settings](https://docs.aws.amazon.com/cognito/latest/developerguide/user-pool-sms-settings.html) . func (o LookupUserPoolResultOutput) SmsConfiguration() UserPoolSmsConfigurationPtrOutput { return o.ApplyT(func(v LookupUserPoolResult) *UserPoolSmsConfiguration { return v.SmsConfiguration }).(UserPoolSmsConfigurationPtrOutput) } @@ -292,7 +302,7 @@ func (o LookupUserPoolResultOutput) UserPoolId() pulumi.StringPtrOutput { return o.ApplyT(func(v LookupUserPoolResult) *string { return v.UserPoolId }).(pulumi.StringPtrOutput) } -// A string used to name the user pool. +// A friendlhy name for your user pool. func (o LookupUserPoolResultOutput) UserPoolName() pulumi.StringPtrOutput { return o.ApplyT(func(v LookupUserPoolResult) *string { return v.UserPoolName }).(pulumi.StringPtrOutput) } @@ -312,9 +322,11 @@ func (o LookupUserPoolResultOutput) UsernameAttributes() pulumi.StringArrayOutpu return o.ApplyT(func(v LookupUserPoolResult) []string { return v.UsernameAttributes }).(pulumi.StringArrayOutput) } -// Case sensitivity on the username input for the selected sign-in option. When case sensitivity is set to `False` (case insensitive), users can sign in with any combination of capital and lowercase letters. For example, `username` , `USERNAME` , or `UserName` , or for email, `email@example.com` or `EMaiL@eXamplE.Com` . For most use cases, set case sensitivity to `False` (case insensitive) as a best practice. When usernames and email addresses are case insensitive, Amazon Cognito treats any variation in case as the same user, and prevents a case variation from being assigned to the same attribute for a different user. +// Sets the case sensitivity option for sign-in usernames. When `CaseSensitive` is `false` (case insensitive), users can sign in with any combination of capital and lowercase letters. For example, `username` , `USERNAME` , or `UserName` , or for email, `email@example.com` or `EMaiL@eXamplE.Com` . For most use cases, set case sensitivity to `false` as a best practice. When usernames and email addresses are case insensitive, Amazon Cognito treats any variation in case as the same user, and prevents a case variation from being assigned to the same attribute for a different user. // -// This configuration is immutable after you set it. For more information, see [UsernameConfigurationType](https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_UsernameConfigurationType.html) . +// When `CaseSensitive` is `true` (case sensitive), Amazon Cognito interprets `USERNAME` and `UserName` as distinct users. +// +// This configuration is immutable after you set it. func (o LookupUserPoolResultOutput) UsernameConfiguration() UserPoolUsernameConfigurationPtrOutput { return o.ApplyT(func(v LookupUserPoolResult) *UserPoolUsernameConfiguration { return v.UsernameConfiguration }).(UserPoolUsernameConfigurationPtrOutput) } @@ -328,10 +340,18 @@ func (o LookupUserPoolResultOutput) VerificationMessageTemplate() UserPoolVerifi }).(UserPoolVerificationMessageTemplatePtrOutput) } +// Sets or displays the authentication domain, typically your user pool domain, that passkey providers must use as a relying party (RP) in their configuration. +// +// Under the following conditions, the passkey relying party ID must be the fully-qualified domain name of your custom domain: +// +// - The user pool is configured for passkey authentication. +// - The user pool has a custom domain, whether or not it also has a prefix domain. +// - Your application performs authentication with managed login or the classic hosted UI. func (o LookupUserPoolResultOutput) WebAuthnRelyingPartyId() pulumi.StringPtrOutput { return o.ApplyT(func(v LookupUserPoolResult) *string { return v.WebAuthnRelyingPartyId }).(pulumi.StringPtrOutput) } +// When `required` , users can only register and sign in users with passkeys that are capable of [user verification](https://docs.aws.amazon.com/https://www.w3.org/TR/webauthn-2/#enum-userVerificationRequirement) . When `preferred` , your user pool doesn't require the use of authenticators with user verification but encourages it. func (o LookupUserPoolResultOutput) WebAuthnUserVerification() pulumi.StringPtrOutput { return o.ApplyT(func(v LookupUserPoolResult) *string { return v.WebAuthnUserVerification }).(pulumi.StringPtrOutput) } diff --git a/sdk/go/aws/cognito/getUserPoolClient.go b/sdk/go/aws/cognito/getUserPoolClient.go index f883fd7baf..b06368c730 100644 --- a/sdk/go/aws/cognito/getUserPoolClient.go +++ b/sdk/go/aws/cognito/getUserPoolClient.go @@ -25,7 +25,7 @@ func LookupUserPoolClient(ctx *pulumi.Context, args *LookupUserPoolClientArgs, o type LookupUserPoolClientArgs struct { // The ID of the app client, for example `1example23456789` . ClientId string `pulumi:"clientId"` - // The user pool ID for the user pool where you want to create a user pool client. + // The ID of the user pool where you want to create an app client. UserPoolId string `pulumi:"userPoolId"` } @@ -57,11 +57,11 @@ type LookupUserPoolClientResult struct { // // To use OAuth 2.0 features, configure one of these features in the Amazon Cognito console or set `AllowedOAuthFlowsUserPoolClient` to `true` in a `CreateUserPoolClient` or `UpdateUserPoolClient` API request. If you don't set a value for `AllowedOAuthFlowsUserPoolClient` in a request with the AWS CLI or SDKs, it defaults to `false` . AllowedOAuthFlowsUserPoolClient *bool `pulumi:"allowedOAuthFlowsUserPoolClient"` - // The allowed OAuth scopes. Possible values provided by OAuth are `phone` , `email` , `openid` , and `profile` . Possible values provided by AWS are `aws.cognito.signin.user.admin` . Custom scopes created in Resource Servers are also supported. + // The OAuth 2.0 scopes that you want to permit your app client to authorize. Scopes govern access control to user pool self-service API operations, user data from the `userInfo` endpoint, and third-party APIs. Possible values provided by OAuth are `phone` , `email` , `openid` , and `profile` . Possible values provided by AWS are `aws.cognito.signin.user.admin` . Custom scopes created in Resource Servers are also supported. AllowedOAuthScopes []string `pulumi:"allowedOAuthScopes"` // The user pool analytics configuration for collecting metrics and sending them to your Amazon Pinpoint campaign. // - // > In AWS Regions where Amazon Pinpoint isn't available, user pools only support sending events to Amazon Pinpoint projects in AWS Region us-east-1. In Regions where Amazon Pinpoint is available, user pools support sending events to Amazon Pinpoint projects within that same Region. + // In AWS Regions where Amazon Pinpoint isn't available, user pools might not have access to analytics or might be configurable with campaigns in the US East (N. Virginia) Region. For more information, see [Using Amazon Pinpoint analytics](https://docs.aws.amazon.com/cognito/latest/developerguide/cognito-user-pools-pinpoint-integration.html) . AnalyticsConfiguration *UserPoolClientAnalyticsConfiguration `pulumi:"analyticsConfiguration"` // Amazon Cognito creates a session token for each API request in an authentication flow. `AuthSessionValidity` is the duration, in minutes, of that session token. Your user pool native user must respond to each authentication challenge before the session expires. AuthSessionValidity *int `pulumi:"authSessionValidity"` @@ -70,7 +70,7 @@ type LookupUserPoolClientResult struct { // A redirect URI must: // // - Be an absolute URI. - // - Be registered with the authorization server. + // - Be registered with the authorization server. Amazon Cognito doesn't accept authorization requests with `redirect_uri` values that aren't in the list of `CallbackURLs` that you provide in this parameter. // - Not include a fragment component. // // See [OAuth 2.0 - Redirection Endpoint](https://docs.aws.amazon.com/https://tools.ietf.org/html/rfc6749#section-3.1.2) . @@ -81,22 +81,10 @@ type LookupUserPoolClientResult struct { CallbackUrls []string `pulumi:"callbackUrls"` // The ID of the app client, for example `1example23456789` . ClientId *string `pulumi:"clientId"` - // The client name for the user pool client you would like to create. + // A friendly name for the app client that you want to create. ClientName *string `pulumi:"clientName"` ClientSecret *string `pulumi:"clientSecret"` // The default redirect URI. In app clients with one assigned IdP, replaces `redirect_uri` in authentication requests. Must be in the `CallbackURLs` list. - // - // A redirect URI must: - // - // - Be an absolute URI. - // - Be registered with the authorization server. - // - Not include a fragment component. - // - // For more information, see [Default redirect URI](https://docs.aws.amazon.com/cognito/latest/developerguide/user-pool-settings-client-apps.html#cognito-user-pools-app-idp-settings-about) . - // - // Amazon Cognito requires HTTPS over HTTP except for http://localhost for testing purposes only. - // - // App callback URLs such as myapp://example are also supported. DefaultRedirectUri *string `pulumi:"defaultRedirectUri"` // Activates the propagation of additional user context data. For more information about propagation of user context data, see [Adding advanced security to a user pool](https://docs.aws.amazon.com/cognito/latest/developerguide/cognito-user-pool-settings-threat-protection.html) . If you don’t include this parameter, you can't send device fingerprint information, including source IP address, to Amazon Cognito advanced security. You can only activate `EnablePropagateAdditionalUserContextData` in an app client that has a client secret. EnablePropagateAdditionalUserContextData *bool `pulumi:"enablePropagateAdditionalUserContextData"` @@ -129,7 +117,7 @@ type LookupUserPoolClientResult struct { // If you don't specify otherwise in the configuration of your app client, your ID // tokens are valid for one hour. IdTokenValidity *int `pulumi:"idTokenValidity"` - // A list of allowed logout URLs for the IdPs. + // A list of allowed logout URLs for managed login authentication. For more information, see [Logout endpoint](https://docs.aws.amazon.com/cognito/latest/developerguide/logout-endpoint.html) . LogoutUrls []string `pulumi:"logoutUrls"` Name *string `pulumi:"name"` // Errors and responses that you want Amazon Cognito APIs to return during authentication, account confirmation, and password recovery when the user doesn't exist in the user pool. When set to `ENABLED` and the user doesn't exist, authentication returns an error indicating either the username or password was incorrect. Account confirmation and password recovery return a response indicating a code was sent to a simulated destination. When set to `LEGACY` , those APIs return a `UserNotFoundException` exception if the user doesn't exist in the user pool. @@ -157,9 +145,9 @@ type LookupUserPoolClientResult struct { RefreshTokenValidity *int `pulumi:"refreshTokenValidity"` // A list of provider names for the identity providers (IdPs) that are supported on this client. The following are supported: `COGNITO` , `Facebook` , `Google` , `SignInWithApple` , and `LoginWithAmazon` . You can also specify the names that you configured for the SAML and OIDC IdPs in your user pool, for example `MySAMLIdP` or `MyOIDCIdP` . // - // This setting applies to providers that you can access with the [hosted UI and OAuth 2.0 authorization server](https://docs.aws.amazon.com/cognito/latest/developerguide/cognito-user-pools-app-integration.html) . The removal of `COGNITO` from this list doesn't prevent authentication operations for local users with the user pools API in an AWS SDK. The only way to prevent API-based authentication is to block access with a [AWS WAF rule](https://docs.aws.amazon.com/cognito/latest/developerguide/user-pool-waf.html) . + // This setting applies to providers that you can access with [managed login](https://docs.aws.amazon.com/cognito/latest/developerguide/cognito-user-pools-managed-login.html) . The removal of `COGNITO` from this list doesn't prevent authentication operations for local users with the user pools API in an AWS SDK. The only way to prevent API-based authentication is to block access with a [AWS WAF rule](https://docs.aws.amazon.com/cognito/latest/developerguide/user-pool-waf.html) . SupportedIdentityProviders []string `pulumi:"supportedIdentityProviders"` - // The units in which the validity times are represented. The default unit for RefreshToken is days, and default for ID and access tokens are hours. + // The units that validity times are represented in. The default unit for refresh tokens is days, and the default for ID and access tokens are hours. TokenValidityUnits *UserPoolClientTokenValidityUnits `pulumi:"tokenValidityUnits"` // The list of user attributes that you want your app client to have write access to. After your user authenticates in your app, their access token authorizes them to set or modify their own attribute value for any attribute in this list. An example of this kind of activity is when you present your user with a form to update their profile information and they change their last name. Your app then makes an [UpdateUserAttributes](https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_UpdateUserAttributes.html) API request and sets `family_name` to the new value. // @@ -191,7 +179,7 @@ func LookupUserPoolClientOutput(ctx *pulumi.Context, args LookupUserPoolClientOu type LookupUserPoolClientOutputArgs struct { // The ID of the app client, for example `1example23456789` . ClientId pulumi.StringInput `pulumi:"clientId"` - // The user pool ID for the user pool where you want to create a user pool client. + // The ID of the user pool where you want to create an app client. UserPoolId pulumi.StringInput `pulumi:"userPoolId"` } @@ -249,14 +237,14 @@ func (o LookupUserPoolClientResultOutput) AllowedOAuthFlowsUserPoolClient() pulu return o.ApplyT(func(v LookupUserPoolClientResult) *bool { return v.AllowedOAuthFlowsUserPoolClient }).(pulumi.BoolPtrOutput) } -// The allowed OAuth scopes. Possible values provided by OAuth are `phone` , `email` , `openid` , and `profile` . Possible values provided by AWS are `aws.cognito.signin.user.admin` . Custom scopes created in Resource Servers are also supported. +// The OAuth 2.0 scopes that you want to permit your app client to authorize. Scopes govern access control to user pool self-service API operations, user data from the `userInfo` endpoint, and third-party APIs. Possible values provided by OAuth are `phone` , `email` , `openid` , and `profile` . Possible values provided by AWS are `aws.cognito.signin.user.admin` . Custom scopes created in Resource Servers are also supported. func (o LookupUserPoolClientResultOutput) AllowedOAuthScopes() pulumi.StringArrayOutput { return o.ApplyT(func(v LookupUserPoolClientResult) []string { return v.AllowedOAuthScopes }).(pulumi.StringArrayOutput) } // The user pool analytics configuration for collecting metrics and sending them to your Amazon Pinpoint campaign. // -// > In AWS Regions where Amazon Pinpoint isn't available, user pools only support sending events to Amazon Pinpoint projects in AWS Region us-east-1. In Regions where Amazon Pinpoint is available, user pools support sending events to Amazon Pinpoint projects within that same Region. +// In AWS Regions where Amazon Pinpoint isn't available, user pools might not have access to analytics or might be configurable with campaigns in the US East (N. Virginia) Region. For more information, see [Using Amazon Pinpoint analytics](https://docs.aws.amazon.com/cognito/latest/developerguide/cognito-user-pools-pinpoint-integration.html) . func (o LookupUserPoolClientResultOutput) AnalyticsConfiguration() UserPoolClientAnalyticsConfigurationPtrOutput { return o.ApplyT(func(v LookupUserPoolClientResult) *UserPoolClientAnalyticsConfiguration { return v.AnalyticsConfiguration @@ -273,7 +261,7 @@ func (o LookupUserPoolClientResultOutput) AuthSessionValidity() pulumi.IntPtrOut // A redirect URI must: // // - Be an absolute URI. -// - Be registered with the authorization server. +// - Be registered with the authorization server. Amazon Cognito doesn't accept authorization requests with `redirect_uri` values that aren't in the list of `CallbackURLs` that you provide in this parameter. // - Not include a fragment component. // // See [OAuth 2.0 - Redirection Endpoint](https://docs.aws.amazon.com/https://tools.ietf.org/html/rfc6749#section-3.1.2) . @@ -290,7 +278,7 @@ func (o LookupUserPoolClientResultOutput) ClientId() pulumi.StringPtrOutput { return o.ApplyT(func(v LookupUserPoolClientResult) *string { return v.ClientId }).(pulumi.StringPtrOutput) } -// The client name for the user pool client you would like to create. +// A friendly name for the app client that you want to create. func (o LookupUserPoolClientResultOutput) ClientName() pulumi.StringPtrOutput { return o.ApplyT(func(v LookupUserPoolClientResult) *string { return v.ClientName }).(pulumi.StringPtrOutput) } @@ -300,18 +288,6 @@ func (o LookupUserPoolClientResultOutput) ClientSecret() pulumi.StringPtrOutput } // The default redirect URI. In app clients with one assigned IdP, replaces `redirect_uri` in authentication requests. Must be in the `CallbackURLs` list. -// -// A redirect URI must: -// -// - Be an absolute URI. -// - Be registered with the authorization server. -// - Not include a fragment component. -// -// For more information, see [Default redirect URI](https://docs.aws.amazon.com/cognito/latest/developerguide/user-pool-settings-client-apps.html#cognito-user-pools-app-idp-settings-about) . -// -// Amazon Cognito requires HTTPS over HTTP except for http://localhost for testing purposes only. -// -// App callback URLs such as myapp://example are also supported. func (o LookupUserPoolClientResultOutput) DefaultRedirectUri() pulumi.StringPtrOutput { return o.ApplyT(func(v LookupUserPoolClientResult) *string { return v.DefaultRedirectUri }).(pulumi.StringPtrOutput) } @@ -359,7 +335,7 @@ func (o LookupUserPoolClientResultOutput) IdTokenValidity() pulumi.IntPtrOutput return o.ApplyT(func(v LookupUserPoolClientResult) *int { return v.IdTokenValidity }).(pulumi.IntPtrOutput) } -// A list of allowed logout URLs for the IdPs. +// A list of allowed logout URLs for managed login authentication. For more information, see [Logout endpoint](https://docs.aws.amazon.com/cognito/latest/developerguide/logout-endpoint.html) . func (o LookupUserPoolClientResultOutput) LogoutUrls() pulumi.StringArrayOutput { return o.ApplyT(func(v LookupUserPoolClientResult) []string { return v.LogoutUrls }).(pulumi.StringArrayOutput) } @@ -402,12 +378,12 @@ func (o LookupUserPoolClientResultOutput) RefreshTokenValidity() pulumi.IntPtrOu // A list of provider names for the identity providers (IdPs) that are supported on this client. The following are supported: `COGNITO` , `Facebook` , `Google` , `SignInWithApple` , and `LoginWithAmazon` . You can also specify the names that you configured for the SAML and OIDC IdPs in your user pool, for example `MySAMLIdP` or `MyOIDCIdP` . // -// This setting applies to providers that you can access with the [hosted UI and OAuth 2.0 authorization server](https://docs.aws.amazon.com/cognito/latest/developerguide/cognito-user-pools-app-integration.html) . The removal of `COGNITO` from this list doesn't prevent authentication operations for local users with the user pools API in an AWS SDK. The only way to prevent API-based authentication is to block access with a [AWS WAF rule](https://docs.aws.amazon.com/cognito/latest/developerguide/user-pool-waf.html) . +// This setting applies to providers that you can access with [managed login](https://docs.aws.amazon.com/cognito/latest/developerguide/cognito-user-pools-managed-login.html) . The removal of `COGNITO` from this list doesn't prevent authentication operations for local users with the user pools API in an AWS SDK. The only way to prevent API-based authentication is to block access with a [AWS WAF rule](https://docs.aws.amazon.com/cognito/latest/developerguide/user-pool-waf.html) . func (o LookupUserPoolClientResultOutput) SupportedIdentityProviders() pulumi.StringArrayOutput { return o.ApplyT(func(v LookupUserPoolClientResult) []string { return v.SupportedIdentityProviders }).(pulumi.StringArrayOutput) } -// The units in which the validity times are represented. The default unit for RefreshToken is days, and default for ID and access tokens are hours. +// The units that validity times are represented in. The default unit for refresh tokens is days, and the default for ID and access tokens are hours. func (o LookupUserPoolClientResultOutput) TokenValidityUnits() UserPoolClientTokenValidityUnitsPtrOutput { return o.ApplyT(func(v LookupUserPoolClientResult) *UserPoolClientTokenValidityUnits { return v.TokenValidityUnits }).(UserPoolClientTokenValidityUnitsPtrOutput) } diff --git a/sdk/go/aws/cognito/getUserPoolGroup.go b/sdk/go/aws/cognito/getUserPoolGroup.go index fd74bd2093..643f309b87 100644 --- a/sdk/go/aws/cognito/getUserPoolGroup.go +++ b/sdk/go/aws/cognito/getUserPoolGroup.go @@ -23,14 +23,14 @@ func LookupUserPoolGroup(ctx *pulumi.Context, args *LookupUserPoolGroupArgs, opt } type LookupUserPoolGroupArgs struct { - // The name of the group. Must be unique. + // A name for the group. This name must be unique in your user pool. GroupName string `pulumi:"groupName"` - // The user pool ID for the user pool. + // The ID of the user pool where you want to create a user group. UserPoolId string `pulumi:"userPoolId"` } type LookupUserPoolGroupResult struct { - // A string containing the description of the group. + // A description of the group that you're creating. Description *string `pulumi:"description"` // A non-negative integer value that specifies the precedence of this group relative to the other groups that a user can belong to in the user pool. Zero is the highest precedence value. Groups with lower `Precedence` values take precedence over groups with higher or null `Precedence` values. If a user belongs to two or more groups, it is the group with the lowest precedence value whose role ARN is given in the user's tokens for the `cognito:roles` and `cognito:preferred_role` claims. // @@ -38,7 +38,7 @@ type LookupUserPoolGroupResult struct { // // The default `Precedence` value is null. The maximum `Precedence` value is `2^31-1` . Precedence *int `pulumi:"precedence"` - // The role Amazon Resource Name (ARN) for the group. + // The Amazon Resource Name (ARN) for the IAM role that you want to associate with the group. A group role primarily declares a preferred role for the credentials that you get from an identity pool. Amazon Cognito ID tokens have a `cognito:preferred_role` claim that presents the highest-precedence group that a user belongs to. Both ID and access tokens also contain a `cognito:groups` claim that list all the groups that a user is a member of. RoleArn *string `pulumi:"roleArn"` } @@ -62,9 +62,9 @@ func LookupUserPoolGroupOutput(ctx *pulumi.Context, args LookupUserPoolGroupOutp } type LookupUserPoolGroupOutputArgs struct { - // The name of the group. Must be unique. + // A name for the group. This name must be unique in your user pool. GroupName pulumi.StringInput `pulumi:"groupName"` - // The user pool ID for the user pool. + // The ID of the user pool where you want to create a user group. UserPoolId pulumi.StringInput `pulumi:"userPoolId"` } @@ -86,7 +86,7 @@ func (o LookupUserPoolGroupResultOutput) ToLookupUserPoolGroupResultOutputWithCo return o } -// A string containing the description of the group. +// A description of the group that you're creating. func (o LookupUserPoolGroupResultOutput) Description() pulumi.StringPtrOutput { return o.ApplyT(func(v LookupUserPoolGroupResult) *string { return v.Description }).(pulumi.StringPtrOutput) } @@ -100,7 +100,7 @@ func (o LookupUserPoolGroupResultOutput) Precedence() pulumi.IntPtrOutput { return o.ApplyT(func(v LookupUserPoolGroupResult) *int { return v.Precedence }).(pulumi.IntPtrOutput) } -// The role Amazon Resource Name (ARN) for the group. +// The Amazon Resource Name (ARN) for the IAM role that you want to associate with the group. A group role primarily declares a preferred role for the credentials that you get from an identity pool. Amazon Cognito ID tokens have a `cognito:preferred_role` claim that presents the highest-precedence group that a user belongs to. Both ID and access tokens also contain a `cognito:groups` claim that list all the groups that a user is a member of. func (o LookupUserPoolGroupResultOutput) RoleArn() pulumi.StringPtrOutput { return o.ApplyT(func(v LookupUserPoolGroupResult) *string { return v.RoleArn }).(pulumi.StringPtrOutput) } diff --git a/sdk/go/aws/cognito/getUserPoolIdentityProvider.go b/sdk/go/aws/cognito/getUserPoolIdentityProvider.go index 1bf1f5b2a4..74e7b534fa 100644 --- a/sdk/go/aws/cognito/getUserPoolIdentityProvider.go +++ b/sdk/go/aws/cognito/getUserPoolIdentityProvider.go @@ -23,16 +23,16 @@ func LookupUserPoolIdentityProvider(ctx *pulumi.Context, args *LookupUserPoolIde } type LookupUserPoolIdentityProviderArgs struct { - // The IdP name. + // The name that you want to assign to the IdP. You can pass the identity provider name in the `identity_provider` query parameter of requests to the [Authorize endpoint](https://docs.aws.amazon.com/cognito/latest/developerguide/authorization-endpoint.html) to silently redirect to sign-in with the associated IdP. ProviderName string `pulumi:"providerName"` - // The user pool ID. + // The Id of the user pool where you want to create an IdP. UserPoolId string `pulumi:"userPoolId"` } type LookupUserPoolIdentityProviderResult struct { - // A mapping of IdP attributes to standard and custom user pool attributes. + // A mapping of IdP attributes to standard and custom user pool attributes. Specify a user pool attribute as the key of the key-value pair, and the IdP attribute claim name as the value. AttributeMapping map[string]string `pulumi:"attributeMapping"` - // A list of IdP identifiers. + // An array of IdP identifiers, for example `"IdPIdentifiers": [ "MyIdP", "MyIdP2" ]` . Identifiers are friendly names that you can pass in the `idp_identifier` query parameter of requests to the [Authorize endpoint](https://docs.aws.amazon.com/cognito/latest/developerguide/authorization-endpoint.html) to silently redirect to sign-in with the associated IdP. Identifiers in a domain format also enable the use of [email-address matching with SAML providers](https://docs.aws.amazon.com/cognito/latest/developerguide/cognito-user-pools-managing-saml-idp-naming.html) . IdpIdentifiers []string `pulumi:"idpIdentifiers"` // The scopes, URLs, and identifiers for your external identity provider. The following // examples describe the provider detail keys for each IdP type. These values and their @@ -86,9 +86,9 @@ func LookupUserPoolIdentityProviderOutput(ctx *pulumi.Context, args LookupUserPo } type LookupUserPoolIdentityProviderOutputArgs struct { - // The IdP name. + // The name that you want to assign to the IdP. You can pass the identity provider name in the `identity_provider` query parameter of requests to the [Authorize endpoint](https://docs.aws.amazon.com/cognito/latest/developerguide/authorization-endpoint.html) to silently redirect to sign-in with the associated IdP. ProviderName pulumi.StringInput `pulumi:"providerName"` - // The user pool ID. + // The Id of the user pool where you want to create an IdP. UserPoolId pulumi.StringInput `pulumi:"userPoolId"` } @@ -110,12 +110,12 @@ func (o LookupUserPoolIdentityProviderResultOutput) ToLookupUserPoolIdentityProv return o } -// A mapping of IdP attributes to standard and custom user pool attributes. +// A mapping of IdP attributes to standard and custom user pool attributes. Specify a user pool attribute as the key of the key-value pair, and the IdP attribute claim name as the value. func (o LookupUserPoolIdentityProviderResultOutput) AttributeMapping() pulumi.StringMapOutput { return o.ApplyT(func(v LookupUserPoolIdentityProviderResult) map[string]string { return v.AttributeMapping }).(pulumi.StringMapOutput) } -// A list of IdP identifiers. +// An array of IdP identifiers, for example `"IdPIdentifiers": [ "MyIdP", "MyIdP2" ]` . Identifiers are friendly names that you can pass in the `idp_identifier` query parameter of requests to the [Authorize endpoint](https://docs.aws.amazon.com/cognito/latest/developerguide/authorization-endpoint.html) to silently redirect to sign-in with the associated IdP. Identifiers in a domain format also enable the use of [email-address matching with SAML providers](https://docs.aws.amazon.com/cognito/latest/developerguide/cognito-user-pools-managing-saml-idp-naming.html) . func (o LookupUserPoolIdentityProviderResultOutput) IdpIdentifiers() pulumi.StringArrayOutput { return o.ApplyT(func(v LookupUserPoolIdentityProviderResult) []string { return v.IdpIdentifiers }).(pulumi.StringArrayOutput) } diff --git a/sdk/go/aws/cognito/getUserPoolResourceServer.go b/sdk/go/aws/cognito/getUserPoolResourceServer.go index 625d596ce0..739315b53d 100644 --- a/sdk/go/aws/cognito/getUserPoolResourceServer.go +++ b/sdk/go/aws/cognito/getUserPoolResourceServer.go @@ -27,7 +27,7 @@ type LookupUserPoolResourceServerArgs struct { // // Amazon Cognito represents scopes in the access token in the format `$resource-server-identifier/$scope` . Longer scope-identifier strings increase the size of your access tokens. Identifier string `pulumi:"identifier"` - // The user pool ID for the user pool. + // The ID of the user pool where you want to create a resource server. UserPoolId string `pulumi:"userPoolId"` } @@ -62,7 +62,7 @@ type LookupUserPoolResourceServerOutputArgs struct { // // Amazon Cognito represents scopes in the access token in the format `$resource-server-identifier/$scope` . Longer scope-identifier strings increase the size of your access tokens. Identifier pulumi.StringInput `pulumi:"identifier"` - // The user pool ID for the user pool. + // The ID of the user pool where you want to create a resource server. UserPoolId pulumi.StringInput `pulumi:"userPoolId"` } diff --git a/sdk/go/aws/cognito/getUserPoolUiCustomizationAttachment.go b/sdk/go/aws/cognito/getUserPoolUiCustomizationAttachment.go index ce1f906e42..5f87292695 100644 --- a/sdk/go/aws/cognito/getUserPoolUiCustomizationAttachment.go +++ b/sdk/go/aws/cognito/getUserPoolUiCustomizationAttachment.go @@ -25,7 +25,7 @@ func LookupUserPoolUiCustomizationAttachment(ctx *pulumi.Context, args *LookupUs type LookupUserPoolUiCustomizationAttachmentArgs struct { // The app client ID for your UI customization. When this value isn't present, the customization applies to all user pool app clients that don't have client-level settings.. ClientId string `pulumi:"clientId"` - // The user pool ID for the user pool. + // The ID of the user pool. UserPoolId string `pulumi:"userPoolId"` } @@ -56,7 +56,7 @@ func LookupUserPoolUiCustomizationAttachmentOutput(ctx *pulumi.Context, args Loo type LookupUserPoolUiCustomizationAttachmentOutputArgs struct { // The app client ID for your UI customization. When this value isn't present, the customization applies to all user pool app clients that don't have client-level settings.. ClientId pulumi.StringInput `pulumi:"clientId"` - // The user pool ID for the user pool. + // The ID of the user pool. UserPoolId pulumi.StringInput `pulumi:"userPoolId"` } diff --git a/sdk/go/aws/cognito/managedLoginBranding.go b/sdk/go/aws/cognito/managedLoginBranding.go index 4f6e3ea273..d72204de09 100644 --- a/sdk/go/aws/cognito/managedLoginBranding.go +++ b/sdk/go/aws/cognito/managedLoginBranding.go @@ -17,16 +17,20 @@ type ManagedLoginBranding struct { pulumi.CustomResourceState // An array of image files that you want to apply to roles like backgrounds, logos, and icons. Each object must also indicate whether it is for dark mode, light mode, or browser-adaptive mode. - Assets ManagedLoginBrandingAssetTypeArrayOutput `pulumi:"assets"` - ClientId pulumi.StringPtrOutput `pulumi:"clientId"` + Assets ManagedLoginBrandingAssetTypeArrayOutput `pulumi:"assets"` + // The app client that's assigned to the branding style that you want more information about. + ClientId pulumi.StringPtrOutput `pulumi:"clientId"` // The ID of the managed login branding style. - ManagedLoginBrandingId pulumi.StringOutput `pulumi:"managedLoginBrandingId"` - ReturnMergedResources pulumi.BoolPtrOutput `pulumi:"returnMergedResources"` + ManagedLoginBrandingId pulumi.StringOutput `pulumi:"managedLoginBrandingId"` + // When `true` , returns values for branding options that are unchanged from Amazon Cognito defaults. When `false` or when you omit this parameter, returns only values that you customized in your branding style. + ReturnMergedResources pulumi.BoolPtrOutput `pulumi:"returnMergedResources"` // A JSON file, encoded as a `Document` type, with the the settings that you want to apply to your style. // // Search the [CloudFormation User Guide](https://docs.aws.amazon.com/cloudformation/) for `AWS::Cognito::ManagedLoginBranding` for more information about the expected schema for this property. Settings pulumi.AnyOutput `pulumi:"settings"` - // When true, applies the default branding style options. This option reverts to a "blank" style that you can modify later in the branding designer. + // When true, applies the default branding style options. This option reverts to default style options that are managed by Amazon Cognito. You can modify them later in the branding designer. + // + // When you specify `true` for this option, you must also omit values for `Settings` and `Assets` in the request. UseCognitoProvidedValues pulumi.BoolPtrOutput `pulumi:"useCognitoProvidedValues"` // The user pool where the branding style is assigned. UserPoolId pulumi.StringOutput `pulumi:"userPoolId"` @@ -81,14 +85,18 @@ func (ManagedLoginBrandingState) ElementType() reflect.Type { type managedLoginBrandingArgs struct { // An array of image files that you want to apply to roles like backgrounds, logos, and icons. Each object must also indicate whether it is for dark mode, light mode, or browser-adaptive mode. - Assets []ManagedLoginBrandingAssetType `pulumi:"assets"` - ClientId *string `pulumi:"clientId"` - ReturnMergedResources *bool `pulumi:"returnMergedResources"` + Assets []ManagedLoginBrandingAssetType `pulumi:"assets"` + // The app client that's assigned to the branding style that you want more information about. + ClientId *string `pulumi:"clientId"` + // When `true` , returns values for branding options that are unchanged from Amazon Cognito defaults. When `false` or when you omit this parameter, returns only values that you customized in your branding style. + ReturnMergedResources *bool `pulumi:"returnMergedResources"` // A JSON file, encoded as a `Document` type, with the the settings that you want to apply to your style. // // Search the [CloudFormation User Guide](https://docs.aws.amazon.com/cloudformation/) for `AWS::Cognito::ManagedLoginBranding` for more information about the expected schema for this property. Settings interface{} `pulumi:"settings"` - // When true, applies the default branding style options. This option reverts to a "blank" style that you can modify later in the branding designer. + // When true, applies the default branding style options. This option reverts to default style options that are managed by Amazon Cognito. You can modify them later in the branding designer. + // + // When you specify `true` for this option, you must also omit values for `Settings` and `Assets` in the request. UseCognitoProvidedValues *bool `pulumi:"useCognitoProvidedValues"` // The user pool where the branding style is assigned. UserPoolId string `pulumi:"userPoolId"` @@ -97,14 +105,18 @@ type managedLoginBrandingArgs struct { // The set of arguments for constructing a ManagedLoginBranding resource. type ManagedLoginBrandingArgs struct { // An array of image files that you want to apply to roles like backgrounds, logos, and icons. Each object must also indicate whether it is for dark mode, light mode, or browser-adaptive mode. - Assets ManagedLoginBrandingAssetTypeArrayInput - ClientId pulumi.StringPtrInput + Assets ManagedLoginBrandingAssetTypeArrayInput + // The app client that's assigned to the branding style that you want more information about. + ClientId pulumi.StringPtrInput + // When `true` , returns values for branding options that are unchanged from Amazon Cognito defaults. When `false` or when you omit this parameter, returns only values that you customized in your branding style. ReturnMergedResources pulumi.BoolPtrInput // A JSON file, encoded as a `Document` type, with the the settings that you want to apply to your style. // // Search the [CloudFormation User Guide](https://docs.aws.amazon.com/cloudformation/) for `AWS::Cognito::ManagedLoginBranding` for more information about the expected schema for this property. Settings pulumi.Input - // When true, applies the default branding style options. This option reverts to a "blank" style that you can modify later in the branding designer. + // When true, applies the default branding style options. This option reverts to default style options that are managed by Amazon Cognito. You can modify them later in the branding designer. + // + // When you specify `true` for this option, you must also omit values for `Settings` and `Assets` in the request. UseCognitoProvidedValues pulumi.BoolPtrInput // The user pool where the branding style is assigned. UserPoolId pulumi.StringInput @@ -152,6 +164,7 @@ func (o ManagedLoginBrandingOutput) Assets() ManagedLoginBrandingAssetTypeArrayO return o.ApplyT(func(v *ManagedLoginBranding) ManagedLoginBrandingAssetTypeArrayOutput { return v.Assets }).(ManagedLoginBrandingAssetTypeArrayOutput) } +// The app client that's assigned to the branding style that you want more information about. func (o ManagedLoginBrandingOutput) ClientId() pulumi.StringPtrOutput { return o.ApplyT(func(v *ManagedLoginBranding) pulumi.StringPtrOutput { return v.ClientId }).(pulumi.StringPtrOutput) } @@ -161,6 +174,7 @@ func (o ManagedLoginBrandingOutput) ManagedLoginBrandingId() pulumi.StringOutput return o.ApplyT(func(v *ManagedLoginBranding) pulumi.StringOutput { return v.ManagedLoginBrandingId }).(pulumi.StringOutput) } +// When `true` , returns values for branding options that are unchanged from Amazon Cognito defaults. When `false` or when you omit this parameter, returns only values that you customized in your branding style. func (o ManagedLoginBrandingOutput) ReturnMergedResources() pulumi.BoolPtrOutput { return o.ApplyT(func(v *ManagedLoginBranding) pulumi.BoolPtrOutput { return v.ReturnMergedResources }).(pulumi.BoolPtrOutput) } @@ -172,7 +186,9 @@ func (o ManagedLoginBrandingOutput) Settings() pulumi.AnyOutput { return o.ApplyT(func(v *ManagedLoginBranding) pulumi.AnyOutput { return v.Settings }).(pulumi.AnyOutput) } -// When true, applies the default branding style options. This option reverts to a "blank" style that you can modify later in the branding designer. +// When true, applies the default branding style options. This option reverts to default style options that are managed by Amazon Cognito. You can modify them later in the branding designer. +// +// When you specify `true` for this option, you must also omit values for `Settings` and `Assets` in the request. func (o ManagedLoginBrandingOutput) UseCognitoProvidedValues() pulumi.BoolPtrOutput { return o.ApplyT(func(v *ManagedLoginBranding) pulumi.BoolPtrOutput { return v.UseCognitoProvidedValues }).(pulumi.BoolPtrOutput) } diff --git a/sdk/go/aws/cognito/pulumiTypes.go b/sdk/go/aws/cognito/pulumiTypes.go index 1e1eb9ed25..df6464e4c0 100644 --- a/sdk/go/aws/cognito/pulumiTypes.go +++ b/sdk/go/aws/cognito/pulumiTypes.go @@ -1619,6 +1619,7 @@ func (o UserPoolAccountRecoverySettingPtrOutput) RecoveryMechanisms() UserPoolRe } type UserPoolAddOns struct { + // Advanced security configuration options for additional authentication types in your user pool, including custom authentication. AdvancedSecurityAdditionalFlows *UserPoolAdvancedSecurityAdditionalFlows `pulumi:"advancedSecurityAdditionalFlows"` // The operating mode of advanced security features for standard authentication types in your user pool, including username-password and secure remote password (SRP) authentication. AdvancedSecurityMode *string `pulumi:"advancedSecurityMode"` @@ -1636,6 +1637,7 @@ type UserPoolAddOnsInput interface { } type UserPoolAddOnsArgs struct { + // Advanced security configuration options for additional authentication types in your user pool, including custom authentication. AdvancedSecurityAdditionalFlows UserPoolAdvancedSecurityAdditionalFlowsPtrInput `pulumi:"advancedSecurityAdditionalFlows"` // The operating mode of advanced security features for standard authentication types in your user pool, including username-password and secure remote password (SRP) authentication. AdvancedSecurityMode pulumi.StringPtrInput `pulumi:"advancedSecurityMode"` @@ -1718,6 +1720,7 @@ func (o UserPoolAddOnsOutput) ToUserPoolAddOnsPtrOutputWithContext(ctx context.C }).(UserPoolAddOnsPtrOutput) } +// Advanced security configuration options for additional authentication types in your user pool, including custom authentication. func (o UserPoolAddOnsOutput) AdvancedSecurityAdditionalFlows() UserPoolAdvancedSecurityAdditionalFlowsPtrOutput { return o.ApplyT(func(v UserPoolAddOns) *UserPoolAdvancedSecurityAdditionalFlows { return v.AdvancedSecurityAdditionalFlows @@ -1753,6 +1756,7 @@ func (o UserPoolAddOnsPtrOutput) Elem() UserPoolAddOnsOutput { }).(UserPoolAddOnsOutput) } +// Advanced security configuration options for additional authentication types in your user pool, including custom authentication. func (o UserPoolAddOnsPtrOutput) AdvancedSecurityAdditionalFlows() UserPoolAdvancedSecurityAdditionalFlowsPtrOutput { return o.ApplyT(func(v *UserPoolAddOns) *UserPoolAdvancedSecurityAdditionalFlows { if v == nil { @@ -1972,6 +1976,7 @@ func (o UserPoolAdminCreateUserConfigPtrOutput) UnusedAccountValidityDays() pulu } type UserPoolAdvancedSecurityAdditionalFlows struct { + // The operating mode of advanced security features in custom authentication with [Custom authentication challenge Lambda triggers](https://docs.aws.amazon.com/cognito/latest/developerguide/user-pool-lambda-challenge.html) . CustomAuthMode *string `pulumi:"customAuthMode"` } @@ -1987,6 +1992,7 @@ type UserPoolAdvancedSecurityAdditionalFlowsInput interface { } type UserPoolAdvancedSecurityAdditionalFlowsArgs struct { + // The operating mode of advanced security features in custom authentication with [Custom authentication challenge Lambda triggers](https://docs.aws.amazon.com/cognito/latest/developerguide/user-pool-lambda-challenge.html) . CustomAuthMode pulumi.StringPtrInput `pulumi:"customAuthMode"` } @@ -2067,6 +2073,7 @@ func (o UserPoolAdvancedSecurityAdditionalFlowsOutput) ToUserPoolAdvancedSecurit }).(UserPoolAdvancedSecurityAdditionalFlowsPtrOutput) } +// The operating mode of advanced security features in custom authentication with [Custom authentication challenge Lambda triggers](https://docs.aws.amazon.com/cognito/latest/developerguide/user-pool-lambda-challenge.html) . func (o UserPoolAdvancedSecurityAdditionalFlowsOutput) CustomAuthMode() pulumi.StringPtrOutput { return o.ApplyT(func(v UserPoolAdvancedSecurityAdditionalFlows) *string { return v.CustomAuthMode }).(pulumi.StringPtrOutput) } @@ -2095,6 +2102,7 @@ func (o UserPoolAdvancedSecurityAdditionalFlowsPtrOutput) Elem() UserPoolAdvance }).(UserPoolAdvancedSecurityAdditionalFlowsOutput) } +// The operating mode of advanced security features in custom authentication with [Custom authentication challenge Lambda triggers](https://docs.aws.amazon.com/cognito/latest/developerguide/user-pool-lambda-challenge.html) . func (o UserPoolAdvancedSecurityAdditionalFlowsPtrOutput) CustomAuthMode() pulumi.StringPtrOutput { return o.ApplyT(func(v *UserPoolAdvancedSecurityAdditionalFlows) *string { if v == nil { @@ -4411,7 +4419,10 @@ func (o UserPoolPasswordPolicyPtrOutput) TemporaryPasswordValidityDays() pulumi. type UserPoolPolicies struct { // The password policy settings for a user pool, including complexity, history, and length requirements. PasswordPolicy *UserPoolPasswordPolicy `pulumi:"passwordPolicy"` - SignInPolicy *UserPoolSignInPolicy `pulumi:"signInPolicy"` + // The policy for allowed types of authentication in a user pool. + // + // This data type is a request and response parameter of [CreateUserPool](https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_CreateUserPool.html) and [UpdateUserPool](https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_UpdateUserPool.html) , and a response parameter of [DescribeUserPool](https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_DescribeUserPool.html) . + SignInPolicy *UserPoolSignInPolicy `pulumi:"signInPolicy"` } // UserPoolPoliciesInput is an input type that accepts UserPoolPoliciesArgs and UserPoolPoliciesOutput values. @@ -4428,7 +4439,10 @@ type UserPoolPoliciesInput interface { type UserPoolPoliciesArgs struct { // The password policy settings for a user pool, including complexity, history, and length requirements. PasswordPolicy UserPoolPasswordPolicyPtrInput `pulumi:"passwordPolicy"` - SignInPolicy UserPoolSignInPolicyPtrInput `pulumi:"signInPolicy"` + // The policy for allowed types of authentication in a user pool. + // + // This data type is a request and response parameter of [CreateUserPool](https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_CreateUserPool.html) and [UpdateUserPool](https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_UpdateUserPool.html) , and a response parameter of [DescribeUserPool](https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_DescribeUserPool.html) . + SignInPolicy UserPoolSignInPolicyPtrInput `pulumi:"signInPolicy"` } func (UserPoolPoliciesArgs) ElementType() reflect.Type { @@ -4513,6 +4527,9 @@ func (o UserPoolPoliciesOutput) PasswordPolicy() UserPoolPasswordPolicyPtrOutput return o.ApplyT(func(v UserPoolPolicies) *UserPoolPasswordPolicy { return v.PasswordPolicy }).(UserPoolPasswordPolicyPtrOutput) } +// The policy for allowed types of authentication in a user pool. +// +// This data type is a request and response parameter of [CreateUserPool](https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_CreateUserPool.html) and [UpdateUserPool](https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_UpdateUserPool.html) , and a response parameter of [DescribeUserPool](https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_DescribeUserPool.html) . func (o UserPoolPoliciesOutput) SignInPolicy() UserPoolSignInPolicyPtrOutput { return o.ApplyT(func(v UserPoolPolicies) *UserPoolSignInPolicy { return v.SignInPolicy }).(UserPoolSignInPolicyPtrOutput) } @@ -4551,6 +4568,9 @@ func (o UserPoolPoliciesPtrOutput) PasswordPolicy() UserPoolPasswordPolicyPtrOut }).(UserPoolPasswordPolicyPtrOutput) } +// The policy for allowed types of authentication in a user pool. +// +// This data type is a request and response parameter of [CreateUserPool](https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_CreateUserPool.html) and [UpdateUserPool](https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_UpdateUserPool.html) , and a response parameter of [DescribeUserPool](https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_DescribeUserPool.html) . func (o UserPoolPoliciesPtrOutput) SignInPolicy() UserPoolSignInPolicyPtrOutput { return o.ApplyT(func(v *UserPoolPolicies) *UserPoolSignInPolicy { if v == nil { @@ -6493,6 +6513,9 @@ func (o UserPoolSchemaAttributeArrayOutput) Index(i pulumi.IntInput) UserPoolSch } type UserPoolSignInPolicy struct { + // The sign-in methods that a user pool supports as the first factor. You can permit users to start authentication with a standard username and password, or with other one-time password and hardware factors. + // + // Supports values of `EMAIL_OTP` , `SMS_OTP` , `WEB_AUTHN` and `PASSWORD` , AllowedFirstAuthFactors []string `pulumi:"allowedFirstAuthFactors"` } @@ -6508,6 +6531,9 @@ type UserPoolSignInPolicyInput interface { } type UserPoolSignInPolicyArgs struct { + // The sign-in methods that a user pool supports as the first factor. You can permit users to start authentication with a standard username and password, or with other one-time password and hardware factors. + // + // Supports values of `EMAIL_OTP` , `SMS_OTP` , `WEB_AUTHN` and `PASSWORD` , AllowedFirstAuthFactors pulumi.StringArrayInput `pulumi:"allowedFirstAuthFactors"` } @@ -6588,6 +6614,9 @@ func (o UserPoolSignInPolicyOutput) ToUserPoolSignInPolicyPtrOutputWithContext(c }).(UserPoolSignInPolicyPtrOutput) } +// The sign-in methods that a user pool supports as the first factor. You can permit users to start authentication with a standard username and password, or with other one-time password and hardware factors. +// +// Supports values of `EMAIL_OTP` , `SMS_OTP` , `WEB_AUTHN` and `PASSWORD` , func (o UserPoolSignInPolicyOutput) AllowedFirstAuthFactors() pulumi.StringArrayOutput { return o.ApplyT(func(v UserPoolSignInPolicy) []string { return v.AllowedFirstAuthFactors }).(pulumi.StringArrayOutput) } @@ -6616,6 +6645,9 @@ func (o UserPoolSignInPolicyPtrOutput) Elem() UserPoolSignInPolicyOutput { }).(UserPoolSignInPolicyOutput) } +// The sign-in methods that a user pool supports as the first factor. You can permit users to start authentication with a standard username and password, or with other one-time password and hardware factors. +// +// Supports values of `EMAIL_OTP` , `SMS_OTP` , `WEB_AUTHN` and `PASSWORD` , func (o UserPoolSignInPolicyPtrOutput) AllowedFirstAuthFactors() pulumi.StringArrayOutput { return o.ApplyT(func(v *UserPoolSignInPolicy) []string { if v == nil { diff --git a/sdk/go/aws/cognito/userPool.go b/sdk/go/aws/cognito/userPool.go index 193d43f909..b45f0d5934 100644 --- a/sdk/go/aws/cognito/userPool.go +++ b/sdk/go/aws/cognito/userPool.go @@ -21,11 +21,11 @@ type UserPool struct { // // This data type is a request and response parameter of [CreateUserPool](https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_CreateUserPool.html) and [UpdateUserPool](https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_UpdateUserPool.html) , and a response parameter of [DescribeUserPool](https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_DescribeUserPool.html) . AdminCreateUserConfig UserPoolAdminCreateUserConfigPtrOutput `pulumi:"adminCreateUserConfig"` - // Attributes supported as an alias for this user pool. Possible values: *phone_number* , *email* , or *preferred_username* . + // Attributes supported as an alias for this user pool. Possible values: *phone_number* , *email* , or *preferred_username* . For more information about alias attributes, see [Customizing sign-in attributes](https://docs.aws.amazon.com/cognito/latest/developerguide/user-pool-settings-attributes.html#user-pool-settings-aliases) . AliasAttributes pulumi.StringArrayOutput `pulumi:"aliasAttributes"` // The Amazon Resource Name (ARN) of the user pool, such as `arn:aws:cognito-idp:us-east-1:123412341234:userpool/us-east-1_123412341` . Arn pulumi.StringOutput `pulumi:"arn"` - // The attributes to be auto-verified. Possible values: *email* , *phone_number* . + // The attributes that you want your user pool to automatically verify. Possible values: *email* , *phone_number* . For more information see [Verifying contact information at sign-up](https://docs.aws.amazon.com/cognito/latest/developerguide/signing-up-users-in-your-app.html#allowing-users-to-sign-up-and-confirm-themselves) . AutoVerifiedAttributes pulumi.StringArrayOutput `pulumi:"autoVerifiedAttributes"` // When active, `DeletionProtection` prevents accidental deletion of your user // pool. Before you can delete a user pool that you have protected against deletion, you @@ -33,9 +33,9 @@ type UserPool struct { // // When you try to delete a protected user pool in a `DeleteUserPool` API request, Amazon Cognito returns an `InvalidParameterException` error. To delete a protected user pool, send a new `DeleteUserPool` request after you deactivate deletion protection in an `UpdateUserPool` API request. DeletionProtection pulumi.StringPtrOutput `pulumi:"deletionProtection"` - // The device-remembering configuration for a user pool. A null value indicates that you have deactivated device remembering in your user pool. + // The device-remembering configuration for a user pool. Device remembering or device tracking is a "Remember me on this device" option for user pools that perform authentication with the device key of a trusted device in the back end, instead of a user-provided MFA code. For more information about device authentication, see [Working with user devices in your user pool](https://docs.aws.amazon.com/cognito/latest/developerguide/amazon-cognito-user-pools-device-tracking.html) . A null value indicates that you have deactivated device remembering in your user pool. // - // > When you provide a value for any `DeviceConfiguration` field, you activate the Amazon Cognito device-remembering feature. + // > When you provide a value for any `DeviceConfiguration` field, you activate the Amazon Cognito device-remembering feature. For more infor DeviceConfiguration UserPoolDeviceConfigurationPtrOutput `pulumi:"deviceConfiguration"` EmailAuthenticationMessage pulumi.StringPtrOutput `pulumi:"emailAuthenticationMessage"` EmailAuthenticationSubject pulumi.StringPtrOutput `pulumi:"emailAuthenticationSubject"` @@ -69,11 +69,11 @@ type UserPool struct { ProviderName pulumi.StringOutput `pulumi:"providerName"` // The URL of the provider of the Amazon Cognito user pool, specified as a `String` . ProviderUrl pulumi.StringOutput `pulumi:"providerUrl"` - // An array of schema attributes for the new user pool. These attributes can be standard or custom attributes. + // An array of attributes for the new user pool. You can add custom attributes and modify the properties of default attributes. The specifications in this parameter set the required attributes in your user pool. For more information, see [Working with user attributes](https://docs.aws.amazon.com/cognito/latest/developerguide/user-pool-settings-attributes.html) . Schema UserPoolSchemaAttributeArrayOutput `pulumi:"schema"` // The contents of the SMS authentication message. SmsAuthenticationMessage pulumi.StringPtrOutput `pulumi:"smsAuthenticationMessage"` - // The SMS configuration with the settings that your Amazon Cognito user pool must use to send an SMS message from your AWS account through Amazon Simple Notification Service. To send SMS messages with Amazon SNS in the AWS Region that you want, the Amazon Cognito user pool uses an AWS Identity and Access Management (IAM) role in your AWS account . + // The SMS configuration with the settings that your Amazon Cognito user pool must use to send an SMS message from your AWS account through Amazon Simple Notification Service. To send SMS messages with Amazon SNS in the AWS Region that you want, the Amazon Cognito user pool uses an AWS Identity and Access Management (IAM) role in your AWS account . For more information see [SMS message settings](https://docs.aws.amazon.com/cognito/latest/developerguide/user-pool-sms-settings.html) . SmsConfiguration UserPoolSmsConfigurationPtrOutput `pulumi:"smsConfiguration"` // This parameter is no longer used. See [VerificationMessageTemplateType](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cognito-userpool-verificationmessagetemplate.html) . SmsVerificationMessage pulumi.StringPtrOutput `pulumi:"smsVerificationMessage"` @@ -87,7 +87,7 @@ type UserPool struct { UserPoolAddOns UserPoolAddOnsPtrOutput `pulumi:"userPoolAddOns"` // The ID of the user pool. UserPoolId pulumi.StringOutput `pulumi:"userPoolId"` - // A string used to name the user pool. + // A friendlhy name for your user pool. UserPoolName pulumi.StringPtrOutput `pulumi:"userPoolName"` // The tag keys and values to assign to the user pool. A tag is a label that you can use to categorize and manage user pools in different ways, such as by purpose, owner, environment, or other criteria. UserPoolTags pulumi.StringMapOutput `pulumi:"userPoolTags"` @@ -95,16 +95,26 @@ type UserPool struct { UserPoolTier UserPoolTierPtrOutput `pulumi:"userPoolTier"` // Specifies whether a user can use an email address or phone number as a username when they sign up. UsernameAttributes pulumi.StringArrayOutput `pulumi:"usernameAttributes"` - // Case sensitivity on the username input for the selected sign-in option. When case sensitivity is set to `False` (case insensitive), users can sign in with any combination of capital and lowercase letters. For example, `username` , `USERNAME` , or `UserName` , or for email, `email@example.com` or `EMaiL@eXamplE.Com` . For most use cases, set case sensitivity to `False` (case insensitive) as a best practice. When usernames and email addresses are case insensitive, Amazon Cognito treats any variation in case as the same user, and prevents a case variation from being assigned to the same attribute for a different user. + // Sets the case sensitivity option for sign-in usernames. When `CaseSensitive` is `false` (case insensitive), users can sign in with any combination of capital and lowercase letters. For example, `username` , `USERNAME` , or `UserName` , or for email, `email@example.com` or `EMaiL@eXamplE.Com` . For most use cases, set case sensitivity to `false` as a best practice. When usernames and email addresses are case insensitive, Amazon Cognito treats any variation in case as the same user, and prevents a case variation from being assigned to the same attribute for a different user. // - // This configuration is immutable after you set it. For more information, see [UsernameConfigurationType](https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_UsernameConfigurationType.html) . + // When `CaseSensitive` is `true` (case sensitive), Amazon Cognito interprets `USERNAME` and `UserName` as distinct users. + // + // This configuration is immutable after you set it. UsernameConfiguration UserPoolUsernameConfigurationPtrOutput `pulumi:"usernameConfiguration"` // The template for the verification message that your user pool delivers to users who set an email address or phone number attribute. // // Set the email message type that corresponds to your `DefaultEmailOption` selection. For `CONFIRM_WITH_LINK` , specify an `EmailMessageByLink` and leave `EmailMessage` blank. For `CONFIRM_WITH_CODE` , specify an `EmailMessage` and leave `EmailMessageByLink` blank. When you supply both parameters with either choice, Amazon Cognito returns an error. VerificationMessageTemplate UserPoolVerificationMessageTemplatePtrOutput `pulumi:"verificationMessageTemplate"` - WebAuthnRelyingPartyId pulumi.StringPtrOutput `pulumi:"webAuthnRelyingPartyId"` - WebAuthnUserVerification pulumi.StringPtrOutput `pulumi:"webAuthnUserVerification"` + // Sets or displays the authentication domain, typically your user pool domain, that passkey providers must use as a relying party (RP) in their configuration. + // + // Under the following conditions, the passkey relying party ID must be the fully-qualified domain name of your custom domain: + // + // - The user pool is configured for passkey authentication. + // - The user pool has a custom domain, whether or not it also has a prefix domain. + // - Your application performs authentication with managed login or the classic hosted UI. + WebAuthnRelyingPartyId pulumi.StringPtrOutput `pulumi:"webAuthnRelyingPartyId"` + // When `required` , users can only register and sign in users with passkeys that are capable of [user verification](https://docs.aws.amazon.com/https://www.w3.org/TR/webauthn-2/#enum-userVerificationRequirement) . When `preferred` , your user pool doesn't require the use of authenticators with user verification but encourages it. + WebAuthnUserVerification pulumi.StringPtrOutput `pulumi:"webAuthnUserVerification"` } // NewUserPool registers a new resource with the given unique name, arguments, and options. @@ -153,9 +163,9 @@ type userPoolArgs struct { // // This data type is a request and response parameter of [CreateUserPool](https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_CreateUserPool.html) and [UpdateUserPool](https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_UpdateUserPool.html) , and a response parameter of [DescribeUserPool](https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_DescribeUserPool.html) . AdminCreateUserConfig *UserPoolAdminCreateUserConfig `pulumi:"adminCreateUserConfig"` - // Attributes supported as an alias for this user pool. Possible values: *phone_number* , *email* , or *preferred_username* . + // Attributes supported as an alias for this user pool. Possible values: *phone_number* , *email* , or *preferred_username* . For more information about alias attributes, see [Customizing sign-in attributes](https://docs.aws.amazon.com/cognito/latest/developerguide/user-pool-settings-attributes.html#user-pool-settings-aliases) . AliasAttributes []string `pulumi:"aliasAttributes"` - // The attributes to be auto-verified. Possible values: *email* , *phone_number* . + // The attributes that you want your user pool to automatically verify. Possible values: *email* , *phone_number* . For more information see [Verifying contact information at sign-up](https://docs.aws.amazon.com/cognito/latest/developerguide/signing-up-users-in-your-app.html#allowing-users-to-sign-up-and-confirm-themselves) . AutoVerifiedAttributes []string `pulumi:"autoVerifiedAttributes"` // When active, `DeletionProtection` prevents accidental deletion of your user // pool. Before you can delete a user pool that you have protected against deletion, you @@ -163,9 +173,9 @@ type userPoolArgs struct { // // When you try to delete a protected user pool in a `DeleteUserPool` API request, Amazon Cognito returns an `InvalidParameterException` error. To delete a protected user pool, send a new `DeleteUserPool` request after you deactivate deletion protection in an `UpdateUserPool` API request. DeletionProtection *string `pulumi:"deletionProtection"` - // The device-remembering configuration for a user pool. A null value indicates that you have deactivated device remembering in your user pool. + // The device-remembering configuration for a user pool. Device remembering or device tracking is a "Remember me on this device" option for user pools that perform authentication with the device key of a trusted device in the back end, instead of a user-provided MFA code. For more information about device authentication, see [Working with user devices in your user pool](https://docs.aws.amazon.com/cognito/latest/developerguide/amazon-cognito-user-pools-device-tracking.html) . A null value indicates that you have deactivated device remembering in your user pool. // - // > When you provide a value for any `DeviceConfiguration` field, you activate the Amazon Cognito device-remembering feature. + // > When you provide a value for any `DeviceConfiguration` field, you activate the Amazon Cognito device-remembering feature. For more infor DeviceConfiguration *UserPoolDeviceConfiguration `pulumi:"deviceConfiguration"` EmailAuthenticationMessage *string `pulumi:"emailAuthenticationMessage"` EmailAuthenticationSubject *string `pulumi:"emailAuthenticationSubject"` @@ -195,11 +205,11 @@ type userPoolArgs struct { // // This data type is a request and response parameter of [CreateUserPool](https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_CreateUserPool.html) and [UpdateUserPool](https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_UpdateUserPool.html) , and a response parameter of [DescribeUserPool](https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_DescribeUserPool.html) . Policies *UserPoolPolicies `pulumi:"policies"` - // An array of schema attributes for the new user pool. These attributes can be standard or custom attributes. + // An array of attributes for the new user pool. You can add custom attributes and modify the properties of default attributes. The specifications in this parameter set the required attributes in your user pool. For more information, see [Working with user attributes](https://docs.aws.amazon.com/cognito/latest/developerguide/user-pool-settings-attributes.html) . Schema []UserPoolSchemaAttribute `pulumi:"schema"` // The contents of the SMS authentication message. SmsAuthenticationMessage *string `pulumi:"smsAuthenticationMessage"` - // The SMS configuration with the settings that your Amazon Cognito user pool must use to send an SMS message from your AWS account through Amazon Simple Notification Service. To send SMS messages with Amazon SNS in the AWS Region that you want, the Amazon Cognito user pool uses an AWS Identity and Access Management (IAM) role in your AWS account . + // The SMS configuration with the settings that your Amazon Cognito user pool must use to send an SMS message from your AWS account through Amazon Simple Notification Service. To send SMS messages with Amazon SNS in the AWS Region that you want, the Amazon Cognito user pool uses an AWS Identity and Access Management (IAM) role in your AWS account . For more information see [SMS message settings](https://docs.aws.amazon.com/cognito/latest/developerguide/user-pool-sms-settings.html) . SmsConfiguration *UserPoolSmsConfiguration `pulumi:"smsConfiguration"` // This parameter is no longer used. See [VerificationMessageTemplateType](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cognito-userpool-verificationmessagetemplate.html) . SmsVerificationMessage *string `pulumi:"smsVerificationMessage"` @@ -211,7 +221,7 @@ type userPoolArgs struct { // // For more information, see [Adding advanced security to a user pool](https://docs.aws.amazon.com/cognito/latest/developerguide/cognito-user-pool-settings-advanced-security.html) . UserPoolAddOns *UserPoolAddOns `pulumi:"userPoolAddOns"` - // A string used to name the user pool. + // A friendlhy name for your user pool. UserPoolName *string `pulumi:"userPoolName"` // The tag keys and values to assign to the user pool. A tag is a label that you can use to categorize and manage user pools in different ways, such as by purpose, owner, environment, or other criteria. UserPoolTags map[string]string `pulumi:"userPoolTags"` @@ -219,16 +229,26 @@ type userPoolArgs struct { UserPoolTier *UserPoolTier `pulumi:"userPoolTier"` // Specifies whether a user can use an email address or phone number as a username when they sign up. UsernameAttributes []string `pulumi:"usernameAttributes"` - // Case sensitivity on the username input for the selected sign-in option. When case sensitivity is set to `False` (case insensitive), users can sign in with any combination of capital and lowercase letters. For example, `username` , `USERNAME` , or `UserName` , or for email, `email@example.com` or `EMaiL@eXamplE.Com` . For most use cases, set case sensitivity to `False` (case insensitive) as a best practice. When usernames and email addresses are case insensitive, Amazon Cognito treats any variation in case as the same user, and prevents a case variation from being assigned to the same attribute for a different user. + // Sets the case sensitivity option for sign-in usernames. When `CaseSensitive` is `false` (case insensitive), users can sign in with any combination of capital and lowercase letters. For example, `username` , `USERNAME` , or `UserName` , or for email, `email@example.com` or `EMaiL@eXamplE.Com` . For most use cases, set case sensitivity to `false` as a best practice. When usernames and email addresses are case insensitive, Amazon Cognito treats any variation in case as the same user, and prevents a case variation from being assigned to the same attribute for a different user. // - // This configuration is immutable after you set it. For more information, see [UsernameConfigurationType](https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_UsernameConfigurationType.html) . + // When `CaseSensitive` is `true` (case sensitive), Amazon Cognito interprets `USERNAME` and `UserName` as distinct users. + // + // This configuration is immutable after you set it. UsernameConfiguration *UserPoolUsernameConfiguration `pulumi:"usernameConfiguration"` // The template for the verification message that your user pool delivers to users who set an email address or phone number attribute. // // Set the email message type that corresponds to your `DefaultEmailOption` selection. For `CONFIRM_WITH_LINK` , specify an `EmailMessageByLink` and leave `EmailMessage` blank. For `CONFIRM_WITH_CODE` , specify an `EmailMessage` and leave `EmailMessageByLink` blank. When you supply both parameters with either choice, Amazon Cognito returns an error. VerificationMessageTemplate *UserPoolVerificationMessageTemplate `pulumi:"verificationMessageTemplate"` - WebAuthnRelyingPartyId *string `pulumi:"webAuthnRelyingPartyId"` - WebAuthnUserVerification *string `pulumi:"webAuthnUserVerification"` + // Sets or displays the authentication domain, typically your user pool domain, that passkey providers must use as a relying party (RP) in their configuration. + // + // Under the following conditions, the passkey relying party ID must be the fully-qualified domain name of your custom domain: + // + // - The user pool is configured for passkey authentication. + // - The user pool has a custom domain, whether or not it also has a prefix domain. + // - Your application performs authentication with managed login or the classic hosted UI. + WebAuthnRelyingPartyId *string `pulumi:"webAuthnRelyingPartyId"` + // When `required` , users can only register and sign in users with passkeys that are capable of [user verification](https://docs.aws.amazon.com/https://www.w3.org/TR/webauthn-2/#enum-userVerificationRequirement) . When `preferred` , your user pool doesn't require the use of authenticators with user verification but encourages it. + WebAuthnUserVerification *string `pulumi:"webAuthnUserVerification"` } // The set of arguments for constructing a UserPool resource. @@ -239,9 +259,9 @@ type UserPoolArgs struct { // // This data type is a request and response parameter of [CreateUserPool](https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_CreateUserPool.html) and [UpdateUserPool](https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_UpdateUserPool.html) , and a response parameter of [DescribeUserPool](https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_DescribeUserPool.html) . AdminCreateUserConfig UserPoolAdminCreateUserConfigPtrInput - // Attributes supported as an alias for this user pool. Possible values: *phone_number* , *email* , or *preferred_username* . + // Attributes supported as an alias for this user pool. Possible values: *phone_number* , *email* , or *preferred_username* . For more information about alias attributes, see [Customizing sign-in attributes](https://docs.aws.amazon.com/cognito/latest/developerguide/user-pool-settings-attributes.html#user-pool-settings-aliases) . AliasAttributes pulumi.StringArrayInput - // The attributes to be auto-verified. Possible values: *email* , *phone_number* . + // The attributes that you want your user pool to automatically verify. Possible values: *email* , *phone_number* . For more information see [Verifying contact information at sign-up](https://docs.aws.amazon.com/cognito/latest/developerguide/signing-up-users-in-your-app.html#allowing-users-to-sign-up-and-confirm-themselves) . AutoVerifiedAttributes pulumi.StringArrayInput // When active, `DeletionProtection` prevents accidental deletion of your user // pool. Before you can delete a user pool that you have protected against deletion, you @@ -249,9 +269,9 @@ type UserPoolArgs struct { // // When you try to delete a protected user pool in a `DeleteUserPool` API request, Amazon Cognito returns an `InvalidParameterException` error. To delete a protected user pool, send a new `DeleteUserPool` request after you deactivate deletion protection in an `UpdateUserPool` API request. DeletionProtection pulumi.StringPtrInput - // The device-remembering configuration for a user pool. A null value indicates that you have deactivated device remembering in your user pool. + // The device-remembering configuration for a user pool. Device remembering or device tracking is a "Remember me on this device" option for user pools that perform authentication with the device key of a trusted device in the back end, instead of a user-provided MFA code. For more information about device authentication, see [Working with user devices in your user pool](https://docs.aws.amazon.com/cognito/latest/developerguide/amazon-cognito-user-pools-device-tracking.html) . A null value indicates that you have deactivated device remembering in your user pool. // - // > When you provide a value for any `DeviceConfiguration` field, you activate the Amazon Cognito device-remembering feature. + // > When you provide a value for any `DeviceConfiguration` field, you activate the Amazon Cognito device-remembering feature. For more infor DeviceConfiguration UserPoolDeviceConfigurationPtrInput EmailAuthenticationMessage pulumi.StringPtrInput EmailAuthenticationSubject pulumi.StringPtrInput @@ -281,11 +301,11 @@ type UserPoolArgs struct { // // This data type is a request and response parameter of [CreateUserPool](https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_CreateUserPool.html) and [UpdateUserPool](https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_UpdateUserPool.html) , and a response parameter of [DescribeUserPool](https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_DescribeUserPool.html) . Policies UserPoolPoliciesPtrInput - // An array of schema attributes for the new user pool. These attributes can be standard or custom attributes. + // An array of attributes for the new user pool. You can add custom attributes and modify the properties of default attributes. The specifications in this parameter set the required attributes in your user pool. For more information, see [Working with user attributes](https://docs.aws.amazon.com/cognito/latest/developerguide/user-pool-settings-attributes.html) . Schema UserPoolSchemaAttributeArrayInput // The contents of the SMS authentication message. SmsAuthenticationMessage pulumi.StringPtrInput - // The SMS configuration with the settings that your Amazon Cognito user pool must use to send an SMS message from your AWS account through Amazon Simple Notification Service. To send SMS messages with Amazon SNS in the AWS Region that you want, the Amazon Cognito user pool uses an AWS Identity and Access Management (IAM) role in your AWS account . + // The SMS configuration with the settings that your Amazon Cognito user pool must use to send an SMS message from your AWS account through Amazon Simple Notification Service. To send SMS messages with Amazon SNS in the AWS Region that you want, the Amazon Cognito user pool uses an AWS Identity and Access Management (IAM) role in your AWS account . For more information see [SMS message settings](https://docs.aws.amazon.com/cognito/latest/developerguide/user-pool-sms-settings.html) . SmsConfiguration UserPoolSmsConfigurationPtrInput // This parameter is no longer used. See [VerificationMessageTemplateType](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cognito-userpool-verificationmessagetemplate.html) . SmsVerificationMessage pulumi.StringPtrInput @@ -297,7 +317,7 @@ type UserPoolArgs struct { // // For more information, see [Adding advanced security to a user pool](https://docs.aws.amazon.com/cognito/latest/developerguide/cognito-user-pool-settings-advanced-security.html) . UserPoolAddOns UserPoolAddOnsPtrInput - // A string used to name the user pool. + // A friendlhy name for your user pool. UserPoolName pulumi.StringPtrInput // The tag keys and values to assign to the user pool. A tag is a label that you can use to categorize and manage user pools in different ways, such as by purpose, owner, environment, or other criteria. UserPoolTags pulumi.StringMapInput @@ -305,16 +325,26 @@ type UserPoolArgs struct { UserPoolTier UserPoolTierPtrInput // Specifies whether a user can use an email address or phone number as a username when they sign up. UsernameAttributes pulumi.StringArrayInput - // Case sensitivity on the username input for the selected sign-in option. When case sensitivity is set to `False` (case insensitive), users can sign in with any combination of capital and lowercase letters. For example, `username` , `USERNAME` , or `UserName` , or for email, `email@example.com` or `EMaiL@eXamplE.Com` . For most use cases, set case sensitivity to `False` (case insensitive) as a best practice. When usernames and email addresses are case insensitive, Amazon Cognito treats any variation in case as the same user, and prevents a case variation from being assigned to the same attribute for a different user. + // Sets the case sensitivity option for sign-in usernames. When `CaseSensitive` is `false` (case insensitive), users can sign in with any combination of capital and lowercase letters. For example, `username` , `USERNAME` , or `UserName` , or for email, `email@example.com` or `EMaiL@eXamplE.Com` . For most use cases, set case sensitivity to `false` as a best practice. When usernames and email addresses are case insensitive, Amazon Cognito treats any variation in case as the same user, and prevents a case variation from being assigned to the same attribute for a different user. // - // This configuration is immutable after you set it. For more information, see [UsernameConfigurationType](https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_UsernameConfigurationType.html) . + // When `CaseSensitive` is `true` (case sensitive), Amazon Cognito interprets `USERNAME` and `UserName` as distinct users. + // + // This configuration is immutable after you set it. UsernameConfiguration UserPoolUsernameConfigurationPtrInput // The template for the verification message that your user pool delivers to users who set an email address or phone number attribute. // // Set the email message type that corresponds to your `DefaultEmailOption` selection. For `CONFIRM_WITH_LINK` , specify an `EmailMessageByLink` and leave `EmailMessage` blank. For `CONFIRM_WITH_CODE` , specify an `EmailMessage` and leave `EmailMessageByLink` blank. When you supply both parameters with either choice, Amazon Cognito returns an error. VerificationMessageTemplate UserPoolVerificationMessageTemplatePtrInput - WebAuthnRelyingPartyId pulumi.StringPtrInput - WebAuthnUserVerification pulumi.StringPtrInput + // Sets or displays the authentication domain, typically your user pool domain, that passkey providers must use as a relying party (RP) in their configuration. + // + // Under the following conditions, the passkey relying party ID must be the fully-qualified domain name of your custom domain: + // + // - The user pool is configured for passkey authentication. + // - The user pool has a custom domain, whether or not it also has a prefix domain. + // - Your application performs authentication with managed login or the classic hosted UI. + WebAuthnRelyingPartyId pulumi.StringPtrInput + // When `required` , users can only register and sign in users with passkeys that are capable of [user verification](https://docs.aws.amazon.com/https://www.w3.org/TR/webauthn-2/#enum-userVerificationRequirement) . When `preferred` , your user pool doesn't require the use of authenticators with user verification but encourages it. + WebAuthnUserVerification pulumi.StringPtrInput } func (UserPoolArgs) ElementType() reflect.Type { @@ -366,7 +396,7 @@ func (o UserPoolOutput) AdminCreateUserConfig() UserPoolAdminCreateUserConfigPtr return o.ApplyT(func(v *UserPool) UserPoolAdminCreateUserConfigPtrOutput { return v.AdminCreateUserConfig }).(UserPoolAdminCreateUserConfigPtrOutput) } -// Attributes supported as an alias for this user pool. Possible values: *phone_number* , *email* , or *preferred_username* . +// Attributes supported as an alias for this user pool. Possible values: *phone_number* , *email* , or *preferred_username* . For more information about alias attributes, see [Customizing sign-in attributes](https://docs.aws.amazon.com/cognito/latest/developerguide/user-pool-settings-attributes.html#user-pool-settings-aliases) . func (o UserPoolOutput) AliasAttributes() pulumi.StringArrayOutput { return o.ApplyT(func(v *UserPool) pulumi.StringArrayOutput { return v.AliasAttributes }).(pulumi.StringArrayOutput) } @@ -376,7 +406,7 @@ func (o UserPoolOutput) Arn() pulumi.StringOutput { return o.ApplyT(func(v *UserPool) pulumi.StringOutput { return v.Arn }).(pulumi.StringOutput) } -// The attributes to be auto-verified. Possible values: *email* , *phone_number* . +// The attributes that you want your user pool to automatically verify. Possible values: *email* , *phone_number* . For more information see [Verifying contact information at sign-up](https://docs.aws.amazon.com/cognito/latest/developerguide/signing-up-users-in-your-app.html#allowing-users-to-sign-up-and-confirm-themselves) . func (o UserPoolOutput) AutoVerifiedAttributes() pulumi.StringArrayOutput { return o.ApplyT(func(v *UserPool) pulumi.StringArrayOutput { return v.AutoVerifiedAttributes }).(pulumi.StringArrayOutput) } @@ -390,9 +420,9 @@ func (o UserPoolOutput) DeletionProtection() pulumi.StringPtrOutput { return o.ApplyT(func(v *UserPool) pulumi.StringPtrOutput { return v.DeletionProtection }).(pulumi.StringPtrOutput) } -// The device-remembering configuration for a user pool. A null value indicates that you have deactivated device remembering in your user pool. +// The device-remembering configuration for a user pool. Device remembering or device tracking is a "Remember me on this device" option for user pools that perform authentication with the device key of a trusted device in the back end, instead of a user-provided MFA code. For more information about device authentication, see [Working with user devices in your user pool](https://docs.aws.amazon.com/cognito/latest/developerguide/amazon-cognito-user-pools-device-tracking.html) . A null value indicates that you have deactivated device remembering in your user pool. // -// > When you provide a value for any `DeviceConfiguration` field, you activate the Amazon Cognito device-remembering feature. +// > When you provide a value for any `DeviceConfiguration` field, you activate the Amazon Cognito device-remembering feature. For more infor func (o UserPoolOutput) DeviceConfiguration() UserPoolDeviceConfigurationPtrOutput { return o.ApplyT(func(v *UserPool) UserPoolDeviceConfigurationPtrOutput { return v.DeviceConfiguration }).(UserPoolDeviceConfigurationPtrOutput) } @@ -462,7 +492,7 @@ func (o UserPoolOutput) ProviderUrl() pulumi.StringOutput { return o.ApplyT(func(v *UserPool) pulumi.StringOutput { return v.ProviderUrl }).(pulumi.StringOutput) } -// An array of schema attributes for the new user pool. These attributes can be standard or custom attributes. +// An array of attributes for the new user pool. You can add custom attributes and modify the properties of default attributes. The specifications in this parameter set the required attributes in your user pool. For more information, see [Working with user attributes](https://docs.aws.amazon.com/cognito/latest/developerguide/user-pool-settings-attributes.html) . func (o UserPoolOutput) Schema() UserPoolSchemaAttributeArrayOutput { return o.ApplyT(func(v *UserPool) UserPoolSchemaAttributeArrayOutput { return v.Schema }).(UserPoolSchemaAttributeArrayOutput) } @@ -472,7 +502,7 @@ func (o UserPoolOutput) SmsAuthenticationMessage() pulumi.StringPtrOutput { return o.ApplyT(func(v *UserPool) pulumi.StringPtrOutput { return v.SmsAuthenticationMessage }).(pulumi.StringPtrOutput) } -// The SMS configuration with the settings that your Amazon Cognito user pool must use to send an SMS message from your AWS account through Amazon Simple Notification Service. To send SMS messages with Amazon SNS in the AWS Region that you want, the Amazon Cognito user pool uses an AWS Identity and Access Management (IAM) role in your AWS account . +// The SMS configuration with the settings that your Amazon Cognito user pool must use to send an SMS message from your AWS account through Amazon Simple Notification Service. To send SMS messages with Amazon SNS in the AWS Region that you want, the Amazon Cognito user pool uses an AWS Identity and Access Management (IAM) role in your AWS account . For more information see [SMS message settings](https://docs.aws.amazon.com/cognito/latest/developerguide/user-pool-sms-settings.html) . func (o UserPoolOutput) SmsConfiguration() UserPoolSmsConfigurationPtrOutput { return o.ApplyT(func(v *UserPool) UserPoolSmsConfigurationPtrOutput { return v.SmsConfiguration }).(UserPoolSmsConfigurationPtrOutput) } @@ -501,7 +531,7 @@ func (o UserPoolOutput) UserPoolId() pulumi.StringOutput { return o.ApplyT(func(v *UserPool) pulumi.StringOutput { return v.UserPoolId }).(pulumi.StringOutput) } -// A string used to name the user pool. +// A friendlhy name for your user pool. func (o UserPoolOutput) UserPoolName() pulumi.StringPtrOutput { return o.ApplyT(func(v *UserPool) pulumi.StringPtrOutput { return v.UserPoolName }).(pulumi.StringPtrOutput) } @@ -521,9 +551,11 @@ func (o UserPoolOutput) UsernameAttributes() pulumi.StringArrayOutput { return o.ApplyT(func(v *UserPool) pulumi.StringArrayOutput { return v.UsernameAttributes }).(pulumi.StringArrayOutput) } -// Case sensitivity on the username input for the selected sign-in option. When case sensitivity is set to `False` (case insensitive), users can sign in with any combination of capital and lowercase letters. For example, `username` , `USERNAME` , or `UserName` , or for email, `email@example.com` or `EMaiL@eXamplE.Com` . For most use cases, set case sensitivity to `False` (case insensitive) as a best practice. When usernames and email addresses are case insensitive, Amazon Cognito treats any variation in case as the same user, and prevents a case variation from being assigned to the same attribute for a different user. +// Sets the case sensitivity option for sign-in usernames. When `CaseSensitive` is `false` (case insensitive), users can sign in with any combination of capital and lowercase letters. For example, `username` , `USERNAME` , or `UserName` , or for email, `email@example.com` or `EMaiL@eXamplE.Com` . For most use cases, set case sensitivity to `false` as a best practice. When usernames and email addresses are case insensitive, Amazon Cognito treats any variation in case as the same user, and prevents a case variation from being assigned to the same attribute for a different user. // -// This configuration is immutable after you set it. For more information, see [UsernameConfigurationType](https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_UsernameConfigurationType.html) . +// When `CaseSensitive` is `true` (case sensitive), Amazon Cognito interprets `USERNAME` and `UserName` as distinct users. +// +// This configuration is immutable after you set it. func (o UserPoolOutput) UsernameConfiguration() UserPoolUsernameConfigurationPtrOutput { return o.ApplyT(func(v *UserPool) UserPoolUsernameConfigurationPtrOutput { return v.UsernameConfiguration }).(UserPoolUsernameConfigurationPtrOutput) } @@ -535,10 +567,18 @@ func (o UserPoolOutput) VerificationMessageTemplate() UserPoolVerificationMessag return o.ApplyT(func(v *UserPool) UserPoolVerificationMessageTemplatePtrOutput { return v.VerificationMessageTemplate }).(UserPoolVerificationMessageTemplatePtrOutput) } +// Sets or displays the authentication domain, typically your user pool domain, that passkey providers must use as a relying party (RP) in their configuration. +// +// Under the following conditions, the passkey relying party ID must be the fully-qualified domain name of your custom domain: +// +// - The user pool is configured for passkey authentication. +// - The user pool has a custom domain, whether or not it also has a prefix domain. +// - Your application performs authentication with managed login or the classic hosted UI. func (o UserPoolOutput) WebAuthnRelyingPartyId() pulumi.StringPtrOutput { return o.ApplyT(func(v *UserPool) pulumi.StringPtrOutput { return v.WebAuthnRelyingPartyId }).(pulumi.StringPtrOutput) } +// When `required` , users can only register and sign in users with passkeys that are capable of [user verification](https://docs.aws.amazon.com/https://www.w3.org/TR/webauthn-2/#enum-userVerificationRequirement) . When `preferred` , your user pool doesn't require the use of authenticators with user verification but encourages it. func (o UserPoolOutput) WebAuthnUserVerification() pulumi.StringPtrOutput { return o.ApplyT(func(v *UserPool) pulumi.StringPtrOutput { return v.WebAuthnUserVerification }).(pulumi.StringPtrOutput) } diff --git a/sdk/go/aws/cognito/userPoolClient.go b/sdk/go/aws/cognito/userPoolClient.go index d6d088c08e..39ca4f34ee 100644 --- a/sdk/go/aws/cognito/userPoolClient.go +++ b/sdk/go/aws/cognito/userPoolClient.go @@ -43,11 +43,11 @@ type UserPoolClient struct { // // To use OAuth 2.0 features, configure one of these features in the Amazon Cognito console or set `AllowedOAuthFlowsUserPoolClient` to `true` in a `CreateUserPoolClient` or `UpdateUserPoolClient` API request. If you don't set a value for `AllowedOAuthFlowsUserPoolClient` in a request with the AWS CLI or SDKs, it defaults to `false` . AllowedOAuthFlowsUserPoolClient pulumi.BoolPtrOutput `pulumi:"allowedOAuthFlowsUserPoolClient"` - // The allowed OAuth scopes. Possible values provided by OAuth are `phone` , `email` , `openid` , and `profile` . Possible values provided by AWS are `aws.cognito.signin.user.admin` . Custom scopes created in Resource Servers are also supported. + // The OAuth 2.0 scopes that you want to permit your app client to authorize. Scopes govern access control to user pool self-service API operations, user data from the `userInfo` endpoint, and third-party APIs. Possible values provided by OAuth are `phone` , `email` , `openid` , and `profile` . Possible values provided by AWS are `aws.cognito.signin.user.admin` . Custom scopes created in Resource Servers are also supported. AllowedOAuthScopes pulumi.StringArrayOutput `pulumi:"allowedOAuthScopes"` // The user pool analytics configuration for collecting metrics and sending them to your Amazon Pinpoint campaign. // - // > In AWS Regions where Amazon Pinpoint isn't available, user pools only support sending events to Amazon Pinpoint projects in AWS Region us-east-1. In Regions where Amazon Pinpoint is available, user pools support sending events to Amazon Pinpoint projects within that same Region. + // In AWS Regions where Amazon Pinpoint isn't available, user pools might not have access to analytics or might be configurable with campaigns in the US East (N. Virginia) Region. For more information, see [Using Amazon Pinpoint analytics](https://docs.aws.amazon.com/cognito/latest/developerguide/cognito-user-pools-pinpoint-integration.html) . AnalyticsConfiguration UserPoolClientAnalyticsConfigurationPtrOutput `pulumi:"analyticsConfiguration"` // Amazon Cognito creates a session token for each API request in an authentication flow. `AuthSessionValidity` is the duration, in minutes, of that session token. Your user pool native user must respond to each authentication challenge before the session expires. AuthSessionValidity pulumi.IntPtrOutput `pulumi:"authSessionValidity"` @@ -56,7 +56,7 @@ type UserPoolClient struct { // A redirect URI must: // // - Be an absolute URI. - // - Be registered with the authorization server. + // - Be registered with the authorization server. Amazon Cognito doesn't accept authorization requests with `redirect_uri` values that aren't in the list of `CallbackURLs` that you provide in this parameter. // - Not include a fragment component. // // See [OAuth 2.0 - Redirection Endpoint](https://docs.aws.amazon.com/https://tools.ietf.org/html/rfc6749#section-3.1.2) . @@ -67,22 +67,10 @@ type UserPoolClient struct { CallbackUrls pulumi.StringArrayOutput `pulumi:"callbackUrls"` // The ID of the app client, for example `1example23456789` . ClientId pulumi.StringOutput `pulumi:"clientId"` - // The client name for the user pool client you would like to create. + // A friendly name for the app client that you want to create. ClientName pulumi.StringPtrOutput `pulumi:"clientName"` ClientSecret pulumi.StringOutput `pulumi:"clientSecret"` // The default redirect URI. In app clients with one assigned IdP, replaces `redirect_uri` in authentication requests. Must be in the `CallbackURLs` list. - // - // A redirect URI must: - // - // - Be an absolute URI. - // - Be registered with the authorization server. - // - Not include a fragment component. - // - // For more information, see [Default redirect URI](https://docs.aws.amazon.com/cognito/latest/developerguide/user-pool-settings-client-apps.html#cognito-user-pools-app-idp-settings-about) . - // - // Amazon Cognito requires HTTPS over HTTP except for http://localhost for testing purposes only. - // - // App callback URLs such as myapp://example are also supported. DefaultRedirectUri pulumi.StringPtrOutput `pulumi:"defaultRedirectUri"` // Activates the propagation of additional user context data. For more information about propagation of user context data, see [Adding advanced security to a user pool](https://docs.aws.amazon.com/cognito/latest/developerguide/cognito-user-pool-settings-threat-protection.html) . If you don’t include this parameter, you can't send device fingerprint information, including source IP address, to Amazon Cognito advanced security. You can only activate `EnablePropagateAdditionalUserContextData` in an app client that has a client secret. EnablePropagateAdditionalUserContextData pulumi.BoolPtrOutput `pulumi:"enablePropagateAdditionalUserContextData"` @@ -106,7 +94,7 @@ type UserPoolClient struct { // In some environments, you will see the values `ADMIN_NO_SRP_AUTH` , `CUSTOM_AUTH_FLOW_ONLY` , or `USER_PASSWORD_AUTH` . You can't assign these legacy `ExplicitAuthFlows` values to user pool clients at the same time as values that begin with `ALLOW_` , // like `ALLOW_USER_SRP_AUTH` . ExplicitAuthFlows pulumi.StringArrayOutput `pulumi:"explicitAuthFlows"` - // Boolean to specify whether you want to generate a secret for the user pool client being created. + // When `true` , generates a client secret for the app client. Client secrets are used with server-side and machine-to-machine applications. For more information, see [App client types](https://docs.aws.amazon.com/cognito/latest/developerguide/user-pool-settings-client-apps.html#user-pool-settings-client-app-client-types) . GenerateSecret pulumi.BoolPtrOutput `pulumi:"generateSecret"` // The ID token time limit. After this limit expires, your user can't use their ID token. To specify the time unit for `IdTokenValidity` as `seconds` , `minutes` , `hours` , or `days` , set a `TokenValidityUnits` value in your API request. // @@ -117,7 +105,7 @@ type UserPoolClient struct { // If you don't specify otherwise in the configuration of your app client, your ID // tokens are valid for one hour. IdTokenValidity pulumi.IntPtrOutput `pulumi:"idTokenValidity"` - // A list of allowed logout URLs for the IdPs. + // A list of allowed logout URLs for managed login authentication. For more information, see [Logout endpoint](https://docs.aws.amazon.com/cognito/latest/developerguide/logout-endpoint.html) . LogoutUrls pulumi.StringArrayOutput `pulumi:"logoutUrls"` Name pulumi.StringOutput `pulumi:"name"` // Errors and responses that you want Amazon Cognito APIs to return during authentication, account confirmation, and password recovery when the user doesn't exist in the user pool. When set to `ENABLED` and the user doesn't exist, authentication returns an error indicating either the username or password was incorrect. Account confirmation and password recovery return a response indicating a code was sent to a simulated destination. When set to `LEGACY` , those APIs return a `UserNotFoundException` exception if the user doesn't exist in the user pool. @@ -145,11 +133,11 @@ type UserPoolClient struct { RefreshTokenValidity pulumi.IntPtrOutput `pulumi:"refreshTokenValidity"` // A list of provider names for the identity providers (IdPs) that are supported on this client. The following are supported: `COGNITO` , `Facebook` , `Google` , `SignInWithApple` , and `LoginWithAmazon` . You can also specify the names that you configured for the SAML and OIDC IdPs in your user pool, for example `MySAMLIdP` or `MyOIDCIdP` . // - // This setting applies to providers that you can access with the [hosted UI and OAuth 2.0 authorization server](https://docs.aws.amazon.com/cognito/latest/developerguide/cognito-user-pools-app-integration.html) . The removal of `COGNITO` from this list doesn't prevent authentication operations for local users with the user pools API in an AWS SDK. The only way to prevent API-based authentication is to block access with a [AWS WAF rule](https://docs.aws.amazon.com/cognito/latest/developerguide/user-pool-waf.html) . + // This setting applies to providers that you can access with [managed login](https://docs.aws.amazon.com/cognito/latest/developerguide/cognito-user-pools-managed-login.html) . The removal of `COGNITO` from this list doesn't prevent authentication operations for local users with the user pools API in an AWS SDK. The only way to prevent API-based authentication is to block access with a [AWS WAF rule](https://docs.aws.amazon.com/cognito/latest/developerguide/user-pool-waf.html) . SupportedIdentityProviders pulumi.StringArrayOutput `pulumi:"supportedIdentityProviders"` - // The units in which the validity times are represented. The default unit for RefreshToken is days, and default for ID and access tokens are hours. + // The units that validity times are represented in. The default unit for refresh tokens is days, and the default for ID and access tokens are hours. TokenValidityUnits UserPoolClientTokenValidityUnitsPtrOutput `pulumi:"tokenValidityUnits"` - // The user pool ID for the user pool where you want to create a user pool client. + // The ID of the user pool where you want to create an app client. UserPoolId pulumi.StringOutput `pulumi:"userPoolId"` // The list of user attributes that you want your app client to have write access to. After your user authenticates in your app, their access token authorizes them to set or modify their own attribute value for any attribute in this list. An example of this kind of activity is when you present your user with a form to update their profile information and they change their last name. Your app then makes an [UpdateUserAttributes](https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_UpdateUserAttributes.html) API request and sets `family_name` to the new value. // @@ -234,11 +222,11 @@ type userPoolClientArgs struct { // // To use OAuth 2.0 features, configure one of these features in the Amazon Cognito console or set `AllowedOAuthFlowsUserPoolClient` to `true` in a `CreateUserPoolClient` or `UpdateUserPoolClient` API request. If you don't set a value for `AllowedOAuthFlowsUserPoolClient` in a request with the AWS CLI or SDKs, it defaults to `false` . AllowedOAuthFlowsUserPoolClient *bool `pulumi:"allowedOAuthFlowsUserPoolClient"` - // The allowed OAuth scopes. Possible values provided by OAuth are `phone` , `email` , `openid` , and `profile` . Possible values provided by AWS are `aws.cognito.signin.user.admin` . Custom scopes created in Resource Servers are also supported. + // The OAuth 2.0 scopes that you want to permit your app client to authorize. Scopes govern access control to user pool self-service API operations, user data from the `userInfo` endpoint, and third-party APIs. Possible values provided by OAuth are `phone` , `email` , `openid` , and `profile` . Possible values provided by AWS are `aws.cognito.signin.user.admin` . Custom scopes created in Resource Servers are also supported. AllowedOAuthScopes []string `pulumi:"allowedOAuthScopes"` // The user pool analytics configuration for collecting metrics and sending them to your Amazon Pinpoint campaign. // - // > In AWS Regions where Amazon Pinpoint isn't available, user pools only support sending events to Amazon Pinpoint projects in AWS Region us-east-1. In Regions where Amazon Pinpoint is available, user pools support sending events to Amazon Pinpoint projects within that same Region. + // In AWS Regions where Amazon Pinpoint isn't available, user pools might not have access to analytics or might be configurable with campaigns in the US East (N. Virginia) Region. For more information, see [Using Amazon Pinpoint analytics](https://docs.aws.amazon.com/cognito/latest/developerguide/cognito-user-pools-pinpoint-integration.html) . AnalyticsConfiguration *UserPoolClientAnalyticsConfiguration `pulumi:"analyticsConfiguration"` // Amazon Cognito creates a session token for each API request in an authentication flow. `AuthSessionValidity` is the duration, in minutes, of that session token. Your user pool native user must respond to each authentication challenge before the session expires. AuthSessionValidity *int `pulumi:"authSessionValidity"` @@ -247,7 +235,7 @@ type userPoolClientArgs struct { // A redirect URI must: // // - Be an absolute URI. - // - Be registered with the authorization server. + // - Be registered with the authorization server. Amazon Cognito doesn't accept authorization requests with `redirect_uri` values that aren't in the list of `CallbackURLs` that you provide in this parameter. // - Not include a fragment component. // // See [OAuth 2.0 - Redirection Endpoint](https://docs.aws.amazon.com/https://tools.ietf.org/html/rfc6749#section-3.1.2) . @@ -256,21 +244,9 @@ type userPoolClientArgs struct { // // App callback URLs such as myapp://example are also supported. CallbackUrls []string `pulumi:"callbackUrls"` - // The client name for the user pool client you would like to create. + // A friendly name for the app client that you want to create. ClientName *string `pulumi:"clientName"` // The default redirect URI. In app clients with one assigned IdP, replaces `redirect_uri` in authentication requests. Must be in the `CallbackURLs` list. - // - // A redirect URI must: - // - // - Be an absolute URI. - // - Be registered with the authorization server. - // - Not include a fragment component. - // - // For more information, see [Default redirect URI](https://docs.aws.amazon.com/cognito/latest/developerguide/user-pool-settings-client-apps.html#cognito-user-pools-app-idp-settings-about) . - // - // Amazon Cognito requires HTTPS over HTTP except for http://localhost for testing purposes only. - // - // App callback URLs such as myapp://example are also supported. DefaultRedirectUri *string `pulumi:"defaultRedirectUri"` // Activates the propagation of additional user context data. For more information about propagation of user context data, see [Adding advanced security to a user pool](https://docs.aws.amazon.com/cognito/latest/developerguide/cognito-user-pool-settings-threat-protection.html) . If you don’t include this parameter, you can't send device fingerprint information, including source IP address, to Amazon Cognito advanced security. You can only activate `EnablePropagateAdditionalUserContextData` in an app client that has a client secret. EnablePropagateAdditionalUserContextData *bool `pulumi:"enablePropagateAdditionalUserContextData"` @@ -294,7 +270,7 @@ type userPoolClientArgs struct { // In some environments, you will see the values `ADMIN_NO_SRP_AUTH` , `CUSTOM_AUTH_FLOW_ONLY` , or `USER_PASSWORD_AUTH` . You can't assign these legacy `ExplicitAuthFlows` values to user pool clients at the same time as values that begin with `ALLOW_` , // like `ALLOW_USER_SRP_AUTH` . ExplicitAuthFlows []string `pulumi:"explicitAuthFlows"` - // Boolean to specify whether you want to generate a secret for the user pool client being created. + // When `true` , generates a client secret for the app client. Client secrets are used with server-side and machine-to-machine applications. For more information, see [App client types](https://docs.aws.amazon.com/cognito/latest/developerguide/user-pool-settings-client-apps.html#user-pool-settings-client-app-client-types) . GenerateSecret *bool `pulumi:"generateSecret"` // The ID token time limit. After this limit expires, your user can't use their ID token. To specify the time unit for `IdTokenValidity` as `seconds` , `minutes` , `hours` , or `days` , set a `TokenValidityUnits` value in your API request. // @@ -305,7 +281,7 @@ type userPoolClientArgs struct { // If you don't specify otherwise in the configuration of your app client, your ID // tokens are valid for one hour. IdTokenValidity *int `pulumi:"idTokenValidity"` - // A list of allowed logout URLs for the IdPs. + // A list of allowed logout URLs for managed login authentication. For more information, see [Logout endpoint](https://docs.aws.amazon.com/cognito/latest/developerguide/logout-endpoint.html) . LogoutUrls []string `pulumi:"logoutUrls"` // Errors and responses that you want Amazon Cognito APIs to return during authentication, account confirmation, and password recovery when the user doesn't exist in the user pool. When set to `ENABLED` and the user doesn't exist, authentication returns an error indicating either the username or password was incorrect. Account confirmation and password recovery return a response indicating a code was sent to a simulated destination. When set to `LEGACY` , those APIs return a `UserNotFoundException` exception if the user doesn't exist in the user pool. // @@ -332,11 +308,11 @@ type userPoolClientArgs struct { RefreshTokenValidity *int `pulumi:"refreshTokenValidity"` // A list of provider names for the identity providers (IdPs) that are supported on this client. The following are supported: `COGNITO` , `Facebook` , `Google` , `SignInWithApple` , and `LoginWithAmazon` . You can also specify the names that you configured for the SAML and OIDC IdPs in your user pool, for example `MySAMLIdP` or `MyOIDCIdP` . // - // This setting applies to providers that you can access with the [hosted UI and OAuth 2.0 authorization server](https://docs.aws.amazon.com/cognito/latest/developerguide/cognito-user-pools-app-integration.html) . The removal of `COGNITO` from this list doesn't prevent authentication operations for local users with the user pools API in an AWS SDK. The only way to prevent API-based authentication is to block access with a [AWS WAF rule](https://docs.aws.amazon.com/cognito/latest/developerguide/user-pool-waf.html) . + // This setting applies to providers that you can access with [managed login](https://docs.aws.amazon.com/cognito/latest/developerguide/cognito-user-pools-managed-login.html) . The removal of `COGNITO` from this list doesn't prevent authentication operations for local users with the user pools API in an AWS SDK. The only way to prevent API-based authentication is to block access with a [AWS WAF rule](https://docs.aws.amazon.com/cognito/latest/developerguide/user-pool-waf.html) . SupportedIdentityProviders []string `pulumi:"supportedIdentityProviders"` - // The units in which the validity times are represented. The default unit for RefreshToken is days, and default for ID and access tokens are hours. + // The units that validity times are represented in. The default unit for refresh tokens is days, and the default for ID and access tokens are hours. TokenValidityUnits *UserPoolClientTokenValidityUnits `pulumi:"tokenValidityUnits"` - // The user pool ID for the user pool where you want to create a user pool client. + // The ID of the user pool where you want to create an app client. UserPoolId string `pulumi:"userPoolId"` // The list of user attributes that you want your app client to have write access to. After your user authenticates in your app, their access token authorizes them to set or modify their own attribute value for any attribute in this list. An example of this kind of activity is when you present your user with a form to update their profile information and they change their last name. Your app then makes an [UpdateUserAttributes](https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_UpdateUserAttributes.html) API request and sets `family_name` to the new value. // @@ -375,11 +351,11 @@ type UserPoolClientArgs struct { // // To use OAuth 2.0 features, configure one of these features in the Amazon Cognito console or set `AllowedOAuthFlowsUserPoolClient` to `true` in a `CreateUserPoolClient` or `UpdateUserPoolClient` API request. If you don't set a value for `AllowedOAuthFlowsUserPoolClient` in a request with the AWS CLI or SDKs, it defaults to `false` . AllowedOAuthFlowsUserPoolClient pulumi.BoolPtrInput - // The allowed OAuth scopes. Possible values provided by OAuth are `phone` , `email` , `openid` , and `profile` . Possible values provided by AWS are `aws.cognito.signin.user.admin` . Custom scopes created in Resource Servers are also supported. + // The OAuth 2.0 scopes that you want to permit your app client to authorize. Scopes govern access control to user pool self-service API operations, user data from the `userInfo` endpoint, and third-party APIs. Possible values provided by OAuth are `phone` , `email` , `openid` , and `profile` . Possible values provided by AWS are `aws.cognito.signin.user.admin` . Custom scopes created in Resource Servers are also supported. AllowedOAuthScopes pulumi.StringArrayInput // The user pool analytics configuration for collecting metrics and sending them to your Amazon Pinpoint campaign. // - // > In AWS Regions where Amazon Pinpoint isn't available, user pools only support sending events to Amazon Pinpoint projects in AWS Region us-east-1. In Regions where Amazon Pinpoint is available, user pools support sending events to Amazon Pinpoint projects within that same Region. + // In AWS Regions where Amazon Pinpoint isn't available, user pools might not have access to analytics or might be configurable with campaigns in the US East (N. Virginia) Region. For more information, see [Using Amazon Pinpoint analytics](https://docs.aws.amazon.com/cognito/latest/developerguide/cognito-user-pools-pinpoint-integration.html) . AnalyticsConfiguration UserPoolClientAnalyticsConfigurationPtrInput // Amazon Cognito creates a session token for each API request in an authentication flow. `AuthSessionValidity` is the duration, in minutes, of that session token. Your user pool native user must respond to each authentication challenge before the session expires. AuthSessionValidity pulumi.IntPtrInput @@ -388,7 +364,7 @@ type UserPoolClientArgs struct { // A redirect URI must: // // - Be an absolute URI. - // - Be registered with the authorization server. + // - Be registered with the authorization server. Amazon Cognito doesn't accept authorization requests with `redirect_uri` values that aren't in the list of `CallbackURLs` that you provide in this parameter. // - Not include a fragment component. // // See [OAuth 2.0 - Redirection Endpoint](https://docs.aws.amazon.com/https://tools.ietf.org/html/rfc6749#section-3.1.2) . @@ -397,21 +373,9 @@ type UserPoolClientArgs struct { // // App callback URLs such as myapp://example are also supported. CallbackUrls pulumi.StringArrayInput - // The client name for the user pool client you would like to create. + // A friendly name for the app client that you want to create. ClientName pulumi.StringPtrInput // The default redirect URI. In app clients with one assigned IdP, replaces `redirect_uri` in authentication requests. Must be in the `CallbackURLs` list. - // - // A redirect URI must: - // - // - Be an absolute URI. - // - Be registered with the authorization server. - // - Not include a fragment component. - // - // For more information, see [Default redirect URI](https://docs.aws.amazon.com/cognito/latest/developerguide/user-pool-settings-client-apps.html#cognito-user-pools-app-idp-settings-about) . - // - // Amazon Cognito requires HTTPS over HTTP except for http://localhost for testing purposes only. - // - // App callback URLs such as myapp://example are also supported. DefaultRedirectUri pulumi.StringPtrInput // Activates the propagation of additional user context data. For more information about propagation of user context data, see [Adding advanced security to a user pool](https://docs.aws.amazon.com/cognito/latest/developerguide/cognito-user-pool-settings-threat-protection.html) . If you don’t include this parameter, you can't send device fingerprint information, including source IP address, to Amazon Cognito advanced security. You can only activate `EnablePropagateAdditionalUserContextData` in an app client that has a client secret. EnablePropagateAdditionalUserContextData pulumi.BoolPtrInput @@ -435,7 +399,7 @@ type UserPoolClientArgs struct { // In some environments, you will see the values `ADMIN_NO_SRP_AUTH` , `CUSTOM_AUTH_FLOW_ONLY` , or `USER_PASSWORD_AUTH` . You can't assign these legacy `ExplicitAuthFlows` values to user pool clients at the same time as values that begin with `ALLOW_` , // like `ALLOW_USER_SRP_AUTH` . ExplicitAuthFlows pulumi.StringArrayInput - // Boolean to specify whether you want to generate a secret for the user pool client being created. + // When `true` , generates a client secret for the app client. Client secrets are used with server-side and machine-to-machine applications. For more information, see [App client types](https://docs.aws.amazon.com/cognito/latest/developerguide/user-pool-settings-client-apps.html#user-pool-settings-client-app-client-types) . GenerateSecret pulumi.BoolPtrInput // The ID token time limit. After this limit expires, your user can't use their ID token. To specify the time unit for `IdTokenValidity` as `seconds` , `minutes` , `hours` , or `days` , set a `TokenValidityUnits` value in your API request. // @@ -446,7 +410,7 @@ type UserPoolClientArgs struct { // If you don't specify otherwise in the configuration of your app client, your ID // tokens are valid for one hour. IdTokenValidity pulumi.IntPtrInput - // A list of allowed logout URLs for the IdPs. + // A list of allowed logout URLs for managed login authentication. For more information, see [Logout endpoint](https://docs.aws.amazon.com/cognito/latest/developerguide/logout-endpoint.html) . LogoutUrls pulumi.StringArrayInput // Errors and responses that you want Amazon Cognito APIs to return during authentication, account confirmation, and password recovery when the user doesn't exist in the user pool. When set to `ENABLED` and the user doesn't exist, authentication returns an error indicating either the username or password was incorrect. Account confirmation and password recovery return a response indicating a code was sent to a simulated destination. When set to `LEGACY` , those APIs return a `UserNotFoundException` exception if the user doesn't exist in the user pool. // @@ -473,11 +437,11 @@ type UserPoolClientArgs struct { RefreshTokenValidity pulumi.IntPtrInput // A list of provider names for the identity providers (IdPs) that are supported on this client. The following are supported: `COGNITO` , `Facebook` , `Google` , `SignInWithApple` , and `LoginWithAmazon` . You can also specify the names that you configured for the SAML and OIDC IdPs in your user pool, for example `MySAMLIdP` or `MyOIDCIdP` . // - // This setting applies to providers that you can access with the [hosted UI and OAuth 2.0 authorization server](https://docs.aws.amazon.com/cognito/latest/developerguide/cognito-user-pools-app-integration.html) . The removal of `COGNITO` from this list doesn't prevent authentication operations for local users with the user pools API in an AWS SDK. The only way to prevent API-based authentication is to block access with a [AWS WAF rule](https://docs.aws.amazon.com/cognito/latest/developerguide/user-pool-waf.html) . + // This setting applies to providers that you can access with [managed login](https://docs.aws.amazon.com/cognito/latest/developerguide/cognito-user-pools-managed-login.html) . The removal of `COGNITO` from this list doesn't prevent authentication operations for local users with the user pools API in an AWS SDK. The only way to prevent API-based authentication is to block access with a [AWS WAF rule](https://docs.aws.amazon.com/cognito/latest/developerguide/user-pool-waf.html) . SupportedIdentityProviders pulumi.StringArrayInput - // The units in which the validity times are represented. The default unit for RefreshToken is days, and default for ID and access tokens are hours. + // The units that validity times are represented in. The default unit for refresh tokens is days, and the default for ID and access tokens are hours. TokenValidityUnits UserPoolClientTokenValidityUnitsPtrInput - // The user pool ID for the user pool where you want to create a user pool client. + // The ID of the user pool where you want to create an app client. UserPoolId pulumi.StringInput // The list of user attributes that you want your app client to have write access to. After your user authenticates in your app, their access token authorizes them to set or modify their own attribute value for any attribute in this list. An example of this kind of activity is when you present your user with a form to update their profile information and they change their last name. Your app then makes an [UpdateUserAttributes](https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_UpdateUserAttributes.html) API request and sets `family_name` to the new value. // @@ -560,14 +524,14 @@ func (o UserPoolClientOutput) AllowedOAuthFlowsUserPoolClient() pulumi.BoolPtrOu return o.ApplyT(func(v *UserPoolClient) pulumi.BoolPtrOutput { return v.AllowedOAuthFlowsUserPoolClient }).(pulumi.BoolPtrOutput) } -// The allowed OAuth scopes. Possible values provided by OAuth are `phone` , `email` , `openid` , and `profile` . Possible values provided by AWS are `aws.cognito.signin.user.admin` . Custom scopes created in Resource Servers are also supported. +// The OAuth 2.0 scopes that you want to permit your app client to authorize. Scopes govern access control to user pool self-service API operations, user data from the `userInfo` endpoint, and third-party APIs. Possible values provided by OAuth are `phone` , `email` , `openid` , and `profile` . Possible values provided by AWS are `aws.cognito.signin.user.admin` . Custom scopes created in Resource Servers are also supported. func (o UserPoolClientOutput) AllowedOAuthScopes() pulumi.StringArrayOutput { return o.ApplyT(func(v *UserPoolClient) pulumi.StringArrayOutput { return v.AllowedOAuthScopes }).(pulumi.StringArrayOutput) } // The user pool analytics configuration for collecting metrics and sending them to your Amazon Pinpoint campaign. // -// > In AWS Regions where Amazon Pinpoint isn't available, user pools only support sending events to Amazon Pinpoint projects in AWS Region us-east-1. In Regions where Amazon Pinpoint is available, user pools support sending events to Amazon Pinpoint projects within that same Region. +// In AWS Regions where Amazon Pinpoint isn't available, user pools might not have access to analytics or might be configurable with campaigns in the US East (N. Virginia) Region. For more information, see [Using Amazon Pinpoint analytics](https://docs.aws.amazon.com/cognito/latest/developerguide/cognito-user-pools-pinpoint-integration.html) . func (o UserPoolClientOutput) AnalyticsConfiguration() UserPoolClientAnalyticsConfigurationPtrOutput { return o.ApplyT(func(v *UserPoolClient) UserPoolClientAnalyticsConfigurationPtrOutput { return v.AnalyticsConfiguration }).(UserPoolClientAnalyticsConfigurationPtrOutput) } @@ -582,7 +546,7 @@ func (o UserPoolClientOutput) AuthSessionValidity() pulumi.IntPtrOutput { // A redirect URI must: // // - Be an absolute URI. -// - Be registered with the authorization server. +// - Be registered with the authorization server. Amazon Cognito doesn't accept authorization requests with `redirect_uri` values that aren't in the list of `CallbackURLs` that you provide in this parameter. // - Not include a fragment component. // // See [OAuth 2.0 - Redirection Endpoint](https://docs.aws.amazon.com/https://tools.ietf.org/html/rfc6749#section-3.1.2) . @@ -599,7 +563,7 @@ func (o UserPoolClientOutput) ClientId() pulumi.StringOutput { return o.ApplyT(func(v *UserPoolClient) pulumi.StringOutput { return v.ClientId }).(pulumi.StringOutput) } -// The client name for the user pool client you would like to create. +// A friendly name for the app client that you want to create. func (o UserPoolClientOutput) ClientName() pulumi.StringPtrOutput { return o.ApplyT(func(v *UserPoolClient) pulumi.StringPtrOutput { return v.ClientName }).(pulumi.StringPtrOutput) } @@ -609,18 +573,6 @@ func (o UserPoolClientOutput) ClientSecret() pulumi.StringOutput { } // The default redirect URI. In app clients with one assigned IdP, replaces `redirect_uri` in authentication requests. Must be in the `CallbackURLs` list. -// -// A redirect URI must: -// -// - Be an absolute URI. -// - Be registered with the authorization server. -// - Not include a fragment component. -// -// For more information, see [Default redirect URI](https://docs.aws.amazon.com/cognito/latest/developerguide/user-pool-settings-client-apps.html#cognito-user-pools-app-idp-settings-about) . -// -// Amazon Cognito requires HTTPS over HTTP except for http://localhost for testing purposes only. -// -// App callback URLs such as myapp://example are also supported. func (o UserPoolClientOutput) DefaultRedirectUri() pulumi.StringPtrOutput { return o.ApplyT(func(v *UserPoolClient) pulumi.StringPtrOutput { return v.DefaultRedirectUri }).(pulumi.StringPtrOutput) } @@ -656,7 +608,7 @@ func (o UserPoolClientOutput) ExplicitAuthFlows() pulumi.StringArrayOutput { return o.ApplyT(func(v *UserPoolClient) pulumi.StringArrayOutput { return v.ExplicitAuthFlows }).(pulumi.StringArrayOutput) } -// Boolean to specify whether you want to generate a secret for the user pool client being created. +// When `true` , generates a client secret for the app client. Client secrets are used with server-side and machine-to-machine applications. For more information, see [App client types](https://docs.aws.amazon.com/cognito/latest/developerguide/user-pool-settings-client-apps.html#user-pool-settings-client-app-client-types) . func (o UserPoolClientOutput) GenerateSecret() pulumi.BoolPtrOutput { return o.ApplyT(func(v *UserPoolClient) pulumi.BoolPtrOutput { return v.GenerateSecret }).(pulumi.BoolPtrOutput) } @@ -673,7 +625,7 @@ func (o UserPoolClientOutput) IdTokenValidity() pulumi.IntPtrOutput { return o.ApplyT(func(v *UserPoolClient) pulumi.IntPtrOutput { return v.IdTokenValidity }).(pulumi.IntPtrOutput) } -// A list of allowed logout URLs for the IdPs. +// A list of allowed logout URLs for managed login authentication. For more information, see [Logout endpoint](https://docs.aws.amazon.com/cognito/latest/developerguide/logout-endpoint.html) . func (o UserPoolClientOutput) LogoutUrls() pulumi.StringArrayOutput { return o.ApplyT(func(v *UserPoolClient) pulumi.StringArrayOutput { return v.LogoutUrls }).(pulumi.StringArrayOutput) } @@ -716,17 +668,17 @@ func (o UserPoolClientOutput) RefreshTokenValidity() pulumi.IntPtrOutput { // A list of provider names for the identity providers (IdPs) that are supported on this client. The following are supported: `COGNITO` , `Facebook` , `Google` , `SignInWithApple` , and `LoginWithAmazon` . You can also specify the names that you configured for the SAML and OIDC IdPs in your user pool, for example `MySAMLIdP` or `MyOIDCIdP` . // -// This setting applies to providers that you can access with the [hosted UI and OAuth 2.0 authorization server](https://docs.aws.amazon.com/cognito/latest/developerguide/cognito-user-pools-app-integration.html) . The removal of `COGNITO` from this list doesn't prevent authentication operations for local users with the user pools API in an AWS SDK. The only way to prevent API-based authentication is to block access with a [AWS WAF rule](https://docs.aws.amazon.com/cognito/latest/developerguide/user-pool-waf.html) . +// This setting applies to providers that you can access with [managed login](https://docs.aws.amazon.com/cognito/latest/developerguide/cognito-user-pools-managed-login.html) . The removal of `COGNITO` from this list doesn't prevent authentication operations for local users with the user pools API in an AWS SDK. The only way to prevent API-based authentication is to block access with a [AWS WAF rule](https://docs.aws.amazon.com/cognito/latest/developerguide/user-pool-waf.html) . func (o UserPoolClientOutput) SupportedIdentityProviders() pulumi.StringArrayOutput { return o.ApplyT(func(v *UserPoolClient) pulumi.StringArrayOutput { return v.SupportedIdentityProviders }).(pulumi.StringArrayOutput) } -// The units in which the validity times are represented. The default unit for RefreshToken is days, and default for ID and access tokens are hours. +// The units that validity times are represented in. The default unit for refresh tokens is days, and the default for ID and access tokens are hours. func (o UserPoolClientOutput) TokenValidityUnits() UserPoolClientTokenValidityUnitsPtrOutput { return o.ApplyT(func(v *UserPoolClient) UserPoolClientTokenValidityUnitsPtrOutput { return v.TokenValidityUnits }).(UserPoolClientTokenValidityUnitsPtrOutput) } -// The user pool ID for the user pool where you want to create a user pool client. +// The ID of the user pool where you want to create an app client. func (o UserPoolClientOutput) UserPoolId() pulumi.StringOutput { return o.ApplyT(func(v *UserPoolClient) pulumi.StringOutput { return v.UserPoolId }).(pulumi.StringOutput) } diff --git a/sdk/go/aws/cognito/userPoolGroup.go b/sdk/go/aws/cognito/userPoolGroup.go index 5553f04747..3a92762133 100644 --- a/sdk/go/aws/cognito/userPoolGroup.go +++ b/sdk/go/aws/cognito/userPoolGroup.go @@ -16,9 +16,9 @@ import ( type UserPoolGroup struct { pulumi.CustomResourceState - // A string containing the description of the group. + // A description of the group that you're creating. Description pulumi.StringPtrOutput `pulumi:"description"` - // The name of the group. Must be unique. + // A name for the group. This name must be unique in your user pool. GroupName pulumi.StringPtrOutput `pulumi:"groupName"` // A non-negative integer value that specifies the precedence of this group relative to the other groups that a user can belong to in the user pool. Zero is the highest precedence value. Groups with lower `Precedence` values take precedence over groups with higher or null `Precedence` values. If a user belongs to two or more groups, it is the group with the lowest precedence value whose role ARN is given in the user's tokens for the `cognito:roles` and `cognito:preferred_role` claims. // @@ -26,9 +26,9 @@ type UserPoolGroup struct { // // The default `Precedence` value is null. The maximum `Precedence` value is `2^31-1` . Precedence pulumi.IntPtrOutput `pulumi:"precedence"` - // The role Amazon Resource Name (ARN) for the group. + // The Amazon Resource Name (ARN) for the IAM role that you want to associate with the group. A group role primarily declares a preferred role for the credentials that you get from an identity pool. Amazon Cognito ID tokens have a `cognito:preferred_role` claim that presents the highest-precedence group that a user belongs to. Both ID and access tokens also contain a `cognito:groups` claim that list all the groups that a user is a member of. RoleArn pulumi.StringPtrOutput `pulumi:"roleArn"` - // The user pool ID for the user pool. + // The ID of the user pool where you want to create a user group. UserPoolId pulumi.StringOutput `pulumi:"userPoolId"` } @@ -80,9 +80,9 @@ func (UserPoolGroupState) ElementType() reflect.Type { } type userPoolGroupArgs struct { - // A string containing the description of the group. + // A description of the group that you're creating. Description *string `pulumi:"description"` - // The name of the group. Must be unique. + // A name for the group. This name must be unique in your user pool. GroupName *string `pulumi:"groupName"` // A non-negative integer value that specifies the precedence of this group relative to the other groups that a user can belong to in the user pool. Zero is the highest precedence value. Groups with lower `Precedence` values take precedence over groups with higher or null `Precedence` values. If a user belongs to two or more groups, it is the group with the lowest precedence value whose role ARN is given in the user's tokens for the `cognito:roles` and `cognito:preferred_role` claims. // @@ -90,17 +90,17 @@ type userPoolGroupArgs struct { // // The default `Precedence` value is null. The maximum `Precedence` value is `2^31-1` . Precedence *int `pulumi:"precedence"` - // The role Amazon Resource Name (ARN) for the group. + // The Amazon Resource Name (ARN) for the IAM role that you want to associate with the group. A group role primarily declares a preferred role for the credentials that you get from an identity pool. Amazon Cognito ID tokens have a `cognito:preferred_role` claim that presents the highest-precedence group that a user belongs to. Both ID and access tokens also contain a `cognito:groups` claim that list all the groups that a user is a member of. RoleArn *string `pulumi:"roleArn"` - // The user pool ID for the user pool. + // The ID of the user pool where you want to create a user group. UserPoolId string `pulumi:"userPoolId"` } // The set of arguments for constructing a UserPoolGroup resource. type UserPoolGroupArgs struct { - // A string containing the description of the group. + // A description of the group that you're creating. Description pulumi.StringPtrInput - // The name of the group. Must be unique. + // A name for the group. This name must be unique in your user pool. GroupName pulumi.StringPtrInput // A non-negative integer value that specifies the precedence of this group relative to the other groups that a user can belong to in the user pool. Zero is the highest precedence value. Groups with lower `Precedence` values take precedence over groups with higher or null `Precedence` values. If a user belongs to two or more groups, it is the group with the lowest precedence value whose role ARN is given in the user's tokens for the `cognito:roles` and `cognito:preferred_role` claims. // @@ -108,9 +108,9 @@ type UserPoolGroupArgs struct { // // The default `Precedence` value is null. The maximum `Precedence` value is `2^31-1` . Precedence pulumi.IntPtrInput - // The role Amazon Resource Name (ARN) for the group. + // The Amazon Resource Name (ARN) for the IAM role that you want to associate with the group. A group role primarily declares a preferred role for the credentials that you get from an identity pool. Amazon Cognito ID tokens have a `cognito:preferred_role` claim that presents the highest-precedence group that a user belongs to. Both ID and access tokens also contain a `cognito:groups` claim that list all the groups that a user is a member of. RoleArn pulumi.StringPtrInput - // The user pool ID for the user pool. + // The ID of the user pool where you want to create a user group. UserPoolId pulumi.StringInput } @@ -151,12 +151,12 @@ func (o UserPoolGroupOutput) ToUserPoolGroupOutputWithContext(ctx context.Contex return o } -// A string containing the description of the group. +// A description of the group that you're creating. func (o UserPoolGroupOutput) Description() pulumi.StringPtrOutput { return o.ApplyT(func(v *UserPoolGroup) pulumi.StringPtrOutput { return v.Description }).(pulumi.StringPtrOutput) } -// The name of the group. Must be unique. +// A name for the group. This name must be unique in your user pool. func (o UserPoolGroupOutput) GroupName() pulumi.StringPtrOutput { return o.ApplyT(func(v *UserPoolGroup) pulumi.StringPtrOutput { return v.GroupName }).(pulumi.StringPtrOutput) } @@ -170,12 +170,12 @@ func (o UserPoolGroupOutput) Precedence() pulumi.IntPtrOutput { return o.ApplyT(func(v *UserPoolGroup) pulumi.IntPtrOutput { return v.Precedence }).(pulumi.IntPtrOutput) } -// The role Amazon Resource Name (ARN) for the group. +// The Amazon Resource Name (ARN) for the IAM role that you want to associate with the group. A group role primarily declares a preferred role for the credentials that you get from an identity pool. Amazon Cognito ID tokens have a `cognito:preferred_role` claim that presents the highest-precedence group that a user belongs to. Both ID and access tokens also contain a `cognito:groups` claim that list all the groups that a user is a member of. func (o UserPoolGroupOutput) RoleArn() pulumi.StringPtrOutput { return o.ApplyT(func(v *UserPoolGroup) pulumi.StringPtrOutput { return v.RoleArn }).(pulumi.StringPtrOutput) } -// The user pool ID for the user pool. +// The ID of the user pool where you want to create a user group. func (o UserPoolGroupOutput) UserPoolId() pulumi.StringOutput { return o.ApplyT(func(v *UserPoolGroup) pulumi.StringOutput { return v.UserPoolId }).(pulumi.StringOutput) } diff --git a/sdk/go/aws/cognito/userPoolIdentityProvider.go b/sdk/go/aws/cognito/userPoolIdentityProvider.go index 616d22f13f..6900d6c6f0 100644 --- a/sdk/go/aws/cognito/userPoolIdentityProvider.go +++ b/sdk/go/aws/cognito/userPoolIdentityProvider.go @@ -16,9 +16,9 @@ import ( type UserPoolIdentityProvider struct { pulumi.CustomResourceState - // A mapping of IdP attributes to standard and custom user pool attributes. + // A mapping of IdP attributes to standard and custom user pool attributes. Specify a user pool attribute as the key of the key-value pair, and the IdP attribute claim name as the value. AttributeMapping pulumi.StringMapOutput `pulumi:"attributeMapping"` - // A list of IdP identifiers. + // An array of IdP identifiers, for example `"IdPIdentifiers": [ "MyIdP", "MyIdP2" ]` . Identifiers are friendly names that you can pass in the `idp_identifier` query parameter of requests to the [Authorize endpoint](https://docs.aws.amazon.com/cognito/latest/developerguide/authorization-endpoint.html) to silently redirect to sign-in with the associated IdP. Identifiers in a domain format also enable the use of [email-address matching with SAML providers](https://docs.aws.amazon.com/cognito/latest/developerguide/cognito-user-pools-managing-saml-idp-naming.html) . IdpIdentifiers pulumi.StringArrayOutput `pulumi:"idpIdentifiers"` // The scopes, URLs, and identifiers for your external identity provider. The following // examples describe the provider detail keys for each IdP type. These values and their @@ -50,11 +50,11 @@ type UserPoolIdentityProvider struct { // // Describe response: `"ProviderDetails": { "api_version": "v17.0", "attributes_url": "https://graph.facebook.com/v17.0/me?fields=", "attributes_url_add_attributes": "true", "authorize_scopes": "public_profile, email", "authorize_url": "https://www.facebook.com/v17.0/dialog/oauth", "client_id": "1example23456789", "client_secret": "provider-app-client-secret", "token_request_method": "GET", "token_url": "https://graph.facebook.com/v17.0/oauth/access_token" }` ProviderDetails pulumi.StringMapOutput `pulumi:"providerDetails"` - // The IdP name. + // The name that you want to assign to the IdP. You can pass the identity provider name in the `identity_provider` query parameter of requests to the [Authorize endpoint](https://docs.aws.amazon.com/cognito/latest/developerguide/authorization-endpoint.html) to silently redirect to sign-in with the associated IdP. ProviderName pulumi.StringOutput `pulumi:"providerName"` - // The IdP type. + // The type of IdP that you want to add. Amazon Cognito supports OIDC, SAML 2.0, Login With Amazon, Sign In With Apple, Google, and Facebook IdPs. ProviderType pulumi.StringOutput `pulumi:"providerType"` - // The user pool ID. + // The Id of the user pool where you want to create an IdP. UserPoolId pulumi.StringOutput `pulumi:"userPoolId"` } @@ -113,9 +113,9 @@ func (UserPoolIdentityProviderState) ElementType() reflect.Type { } type userPoolIdentityProviderArgs struct { - // A mapping of IdP attributes to standard and custom user pool attributes. + // A mapping of IdP attributes to standard and custom user pool attributes. Specify a user pool attribute as the key of the key-value pair, and the IdP attribute claim name as the value. AttributeMapping map[string]string `pulumi:"attributeMapping"` - // A list of IdP identifiers. + // An array of IdP identifiers, for example `"IdPIdentifiers": [ "MyIdP", "MyIdP2" ]` . Identifiers are friendly names that you can pass in the `idp_identifier` query parameter of requests to the [Authorize endpoint](https://docs.aws.amazon.com/cognito/latest/developerguide/authorization-endpoint.html) to silently redirect to sign-in with the associated IdP. Identifiers in a domain format also enable the use of [email-address matching with SAML providers](https://docs.aws.amazon.com/cognito/latest/developerguide/cognito-user-pools-managing-saml-idp-naming.html) . IdpIdentifiers []string `pulumi:"idpIdentifiers"` // The scopes, URLs, and identifiers for your external identity provider. The following // examples describe the provider detail keys for each IdP type. These values and their @@ -147,19 +147,19 @@ type userPoolIdentityProviderArgs struct { // // Describe response: `"ProviderDetails": { "api_version": "v17.0", "attributes_url": "https://graph.facebook.com/v17.0/me?fields=", "attributes_url_add_attributes": "true", "authorize_scopes": "public_profile, email", "authorize_url": "https://www.facebook.com/v17.0/dialog/oauth", "client_id": "1example23456789", "client_secret": "provider-app-client-secret", "token_request_method": "GET", "token_url": "https://graph.facebook.com/v17.0/oauth/access_token" }` ProviderDetails map[string]string `pulumi:"providerDetails"` - // The IdP name. + // The name that you want to assign to the IdP. You can pass the identity provider name in the `identity_provider` query parameter of requests to the [Authorize endpoint](https://docs.aws.amazon.com/cognito/latest/developerguide/authorization-endpoint.html) to silently redirect to sign-in with the associated IdP. ProviderName *string `pulumi:"providerName"` - // The IdP type. + // The type of IdP that you want to add. Amazon Cognito supports OIDC, SAML 2.0, Login With Amazon, Sign In With Apple, Google, and Facebook IdPs. ProviderType string `pulumi:"providerType"` - // The user pool ID. + // The Id of the user pool where you want to create an IdP. UserPoolId string `pulumi:"userPoolId"` } // The set of arguments for constructing a UserPoolIdentityProvider resource. type UserPoolIdentityProviderArgs struct { - // A mapping of IdP attributes to standard and custom user pool attributes. + // A mapping of IdP attributes to standard and custom user pool attributes. Specify a user pool attribute as the key of the key-value pair, and the IdP attribute claim name as the value. AttributeMapping pulumi.StringMapInput - // A list of IdP identifiers. + // An array of IdP identifiers, for example `"IdPIdentifiers": [ "MyIdP", "MyIdP2" ]` . Identifiers are friendly names that you can pass in the `idp_identifier` query parameter of requests to the [Authorize endpoint](https://docs.aws.amazon.com/cognito/latest/developerguide/authorization-endpoint.html) to silently redirect to sign-in with the associated IdP. Identifiers in a domain format also enable the use of [email-address matching with SAML providers](https://docs.aws.amazon.com/cognito/latest/developerguide/cognito-user-pools-managing-saml-idp-naming.html) . IdpIdentifiers pulumi.StringArrayInput // The scopes, URLs, and identifiers for your external identity provider. The following // examples describe the provider detail keys for each IdP type. These values and their @@ -191,11 +191,11 @@ type UserPoolIdentityProviderArgs struct { // // Describe response: `"ProviderDetails": { "api_version": "v17.0", "attributes_url": "https://graph.facebook.com/v17.0/me?fields=", "attributes_url_add_attributes": "true", "authorize_scopes": "public_profile, email", "authorize_url": "https://www.facebook.com/v17.0/dialog/oauth", "client_id": "1example23456789", "client_secret": "provider-app-client-secret", "token_request_method": "GET", "token_url": "https://graph.facebook.com/v17.0/oauth/access_token" }` ProviderDetails pulumi.StringMapInput - // The IdP name. + // The name that you want to assign to the IdP. You can pass the identity provider name in the `identity_provider` query parameter of requests to the [Authorize endpoint](https://docs.aws.amazon.com/cognito/latest/developerguide/authorization-endpoint.html) to silently redirect to sign-in with the associated IdP. ProviderName pulumi.StringPtrInput - // The IdP type. + // The type of IdP that you want to add. Amazon Cognito supports OIDC, SAML 2.0, Login With Amazon, Sign In With Apple, Google, and Facebook IdPs. ProviderType pulumi.StringInput - // The user pool ID. + // The Id of the user pool where you want to create an IdP. UserPoolId pulumi.StringInput } @@ -236,12 +236,12 @@ func (o UserPoolIdentityProviderOutput) ToUserPoolIdentityProviderOutputWithCont return o } -// A mapping of IdP attributes to standard and custom user pool attributes. +// A mapping of IdP attributes to standard and custom user pool attributes. Specify a user pool attribute as the key of the key-value pair, and the IdP attribute claim name as the value. func (o UserPoolIdentityProviderOutput) AttributeMapping() pulumi.StringMapOutput { return o.ApplyT(func(v *UserPoolIdentityProvider) pulumi.StringMapOutput { return v.AttributeMapping }).(pulumi.StringMapOutput) } -// A list of IdP identifiers. +// An array of IdP identifiers, for example `"IdPIdentifiers": [ "MyIdP", "MyIdP2" ]` . Identifiers are friendly names that you can pass in the `idp_identifier` query parameter of requests to the [Authorize endpoint](https://docs.aws.amazon.com/cognito/latest/developerguide/authorization-endpoint.html) to silently redirect to sign-in with the associated IdP. Identifiers in a domain format also enable the use of [email-address matching with SAML providers](https://docs.aws.amazon.com/cognito/latest/developerguide/cognito-user-pools-managing-saml-idp-naming.html) . func (o UserPoolIdentityProviderOutput) IdpIdentifiers() pulumi.StringArrayOutput { return o.ApplyT(func(v *UserPoolIdentityProvider) pulumi.StringArrayOutput { return v.IdpIdentifiers }).(pulumi.StringArrayOutput) } @@ -279,17 +279,17 @@ func (o UserPoolIdentityProviderOutput) ProviderDetails() pulumi.StringMapOutput return o.ApplyT(func(v *UserPoolIdentityProvider) pulumi.StringMapOutput { return v.ProviderDetails }).(pulumi.StringMapOutput) } -// The IdP name. +// The name that you want to assign to the IdP. You can pass the identity provider name in the `identity_provider` query parameter of requests to the [Authorize endpoint](https://docs.aws.amazon.com/cognito/latest/developerguide/authorization-endpoint.html) to silently redirect to sign-in with the associated IdP. func (o UserPoolIdentityProviderOutput) ProviderName() pulumi.StringOutput { return o.ApplyT(func(v *UserPoolIdentityProvider) pulumi.StringOutput { return v.ProviderName }).(pulumi.StringOutput) } -// The IdP type. +// The type of IdP that you want to add. Amazon Cognito supports OIDC, SAML 2.0, Login With Amazon, Sign In With Apple, Google, and Facebook IdPs. func (o UserPoolIdentityProviderOutput) ProviderType() pulumi.StringOutput { return o.ApplyT(func(v *UserPoolIdentityProvider) pulumi.StringOutput { return v.ProviderType }).(pulumi.StringOutput) } -// The user pool ID. +// The Id of the user pool where you want to create an IdP. func (o UserPoolIdentityProviderOutput) UserPoolId() pulumi.StringOutput { return o.ApplyT(func(v *UserPoolIdentityProvider) pulumi.StringOutput { return v.UserPoolId }).(pulumi.StringOutput) } diff --git a/sdk/go/aws/cognito/userPoolResourceServer.go b/sdk/go/aws/cognito/userPoolResourceServer.go index 657b899f81..4452d56ed8 100644 --- a/sdk/go/aws/cognito/userPoolResourceServer.go +++ b/sdk/go/aws/cognito/userPoolResourceServer.go @@ -24,7 +24,7 @@ type UserPoolResourceServer struct { Name pulumi.StringOutput `pulumi:"name"` // A list of scopes. Each scope is a map with keys `ScopeName` and `ScopeDescription` . Scopes UserPoolResourceServerResourceServerScopeTypeArrayOutput `pulumi:"scopes"` - // The user pool ID for the user pool. + // The ID of the user pool where you want to create a resource server. UserPoolId pulumi.StringOutput `pulumi:"userPoolId"` } @@ -87,7 +87,7 @@ type userPoolResourceServerArgs struct { Name *string `pulumi:"name"` // A list of scopes. Each scope is a map with keys `ScopeName` and `ScopeDescription` . Scopes []UserPoolResourceServerResourceServerScopeType `pulumi:"scopes"` - // The user pool ID for the user pool. + // The ID of the user pool where you want to create a resource server. UserPoolId string `pulumi:"userPoolId"` } @@ -101,7 +101,7 @@ type UserPoolResourceServerArgs struct { Name pulumi.StringPtrInput // A list of scopes. Each scope is a map with keys `ScopeName` and `ScopeDescription` . Scopes UserPoolResourceServerResourceServerScopeTypeArrayInput - // The user pool ID for the user pool. + // The ID of the user pool where you want to create a resource server. UserPoolId pulumi.StringInput } @@ -161,7 +161,7 @@ func (o UserPoolResourceServerOutput) Scopes() UserPoolResourceServerResourceSer }).(UserPoolResourceServerResourceServerScopeTypeArrayOutput) } -// The user pool ID for the user pool. +// The ID of the user pool where you want to create a resource server. func (o UserPoolResourceServerOutput) UserPoolId() pulumi.StringOutput { return o.ApplyT(func(v *UserPoolResourceServer) pulumi.StringOutput { return v.UserPoolId }).(pulumi.StringOutput) } diff --git a/sdk/go/aws/cognito/userPoolUiCustomizationAttachment.go b/sdk/go/aws/cognito/userPoolUiCustomizationAttachment.go index 5ac37084f8..2e4fd1cbca 100644 --- a/sdk/go/aws/cognito/userPoolUiCustomizationAttachment.go +++ b/sdk/go/aws/cognito/userPoolUiCustomizationAttachment.go @@ -20,7 +20,7 @@ type UserPoolUiCustomizationAttachment struct { ClientId pulumi.StringOutput `pulumi:"clientId"` // The CSS values in the UI customization. Css pulumi.StringPtrOutput `pulumi:"css"` - // The user pool ID for the user pool. + // The ID of the user pool. UserPoolId pulumi.StringOutput `pulumi:"userPoolId"` } @@ -79,7 +79,7 @@ type userPoolUiCustomizationAttachmentArgs struct { ClientId string `pulumi:"clientId"` // The CSS values in the UI customization. Css *string `pulumi:"css"` - // The user pool ID for the user pool. + // The ID of the user pool. UserPoolId string `pulumi:"userPoolId"` } @@ -89,7 +89,7 @@ type UserPoolUiCustomizationAttachmentArgs struct { ClientId pulumi.StringInput // The CSS values in the UI customization. Css pulumi.StringPtrInput - // The user pool ID for the user pool. + // The ID of the user pool. UserPoolId pulumi.StringInput } @@ -140,7 +140,7 @@ func (o UserPoolUiCustomizationAttachmentOutput) Css() pulumi.StringPtrOutput { return o.ApplyT(func(v *UserPoolUiCustomizationAttachment) pulumi.StringPtrOutput { return v.Css }).(pulumi.StringPtrOutput) } -// The user pool ID for the user pool. +// The ID of the user pool. func (o UserPoolUiCustomizationAttachmentOutput) UserPoolId() pulumi.StringOutput { return o.ApplyT(func(v *UserPoolUiCustomizationAttachment) pulumi.StringOutput { return v.UserPoolId }).(pulumi.StringOutput) } diff --git a/sdk/go/aws/cognito/userPoolUser.go b/sdk/go/aws/cognito/userPoolUser.go index d23efefed6..bea179e395 100644 --- a/sdk/go/aws/cognito/userPoolUser.go +++ b/sdk/go/aws/cognito/userPoolUser.go @@ -18,24 +18,24 @@ type UserPoolUser struct { // A map of custom key-value pairs that you can provide as input for any custom workflows that this action triggers. // - // You create custom workflows by assigning AWS Lambda functions to user pool triggers. When you use the AdminCreateUser API action, Amazon Cognito invokes the function that is assigned to the *pre sign-up* trigger. When Amazon Cognito invokes this function, it passes a JSON payload, which the function receives as input. This payload contains a `clientMetadata` attribute, which provides the data that you assigned to the ClientMetadata parameter in your AdminCreateUser request. In your function code in AWS Lambda , you can process the `clientMetadata` value to enhance your workflow for your specific needs. + // You create custom workflows by assigning AWS Lambda functions to user pool triggers. When you use the AdminCreateUser API action, Amazon Cognito invokes the function that is assigned to the *pre sign-up* trigger. When Amazon Cognito invokes this function, it passes a JSON payload, which the function receives as input. This payload contains a `ClientMetadata` attribute, which provides the data that you assigned to the ClientMetadata parameter in your AdminCreateUser request. In your function code in AWS Lambda , you can process the `clientMetadata` value to enhance your workflow for your specific needs. // // For more information, see [Customizing user pool Workflows with Lambda Triggers](https://docs.aws.amazon.com/cognito/latest/developerguide/cognito-user-identity-pools-working-with-aws-lambda-triggers.html) in the *Amazon Cognito Developer Guide* . // - // > When you use the ClientMetadata parameter, remember that Amazon Cognito won't do the following: - // > - Store the ClientMetadata value. This data is available only to AWS Lambda triggers that are assigned to a user pool to support custom workflows. If your user pool configuration doesn't include triggers, the ClientMetadata parameter serves no purpose. - // > - Validate the ClientMetadata value. - // > - Encrypt the ClientMetadata value. Don't use Amazon Cognito to provide sensitive information. + // > When you use the `ClientMetadata` parameter, note that Amazon Cognito won't do the following: + // > - Store the `ClientMetadata` value. This data is available only to AWS Lambda triggers that are assigned to a user pool to support custom workflows. If your user pool configuration doesn't include triggers, the `ClientMetadata` parameter serves no purpose. + // > - Validate the `ClientMetadata` value. + // > - Encrypt the `ClientMetadata` value. Don't send sensitive information in this parameter. ClientMetadata pulumi.StringMapOutput `pulumi:"clientMetadata"` - // Specify `"EMAIL"` if email will be used to send the welcome message. Specify `"SMS"` if the phone number will be used. The default value is `"SMS"` . You can specify more than one value. + // Specify `EMAIL` if email will be used to send the welcome message. Specify `SMS` if the phone number will be used. The default value is `SMS` . You can specify more than one value. DesiredDeliveryMediums pulumi.StringArrayOutput `pulumi:"desiredDeliveryMediums"` // This parameter is used only if the `phone_number_verified` or `email_verified` attribute is set to `True` . Otherwise, it is ignored. // - // If this parameter is set to `True` and the phone number or email address specified in the UserAttributes parameter already exists as an alias with a different user, the API call will migrate the alias from the previous user to the newly created user. The previous user will no longer be able to log in using that alias. + // If this parameter is set to `True` and the phone number or email address specified in the `UserAttributes` parameter already exists as an alias with a different user, this request migrates the alias from the previous user to the newly-created user. The previous user will no longer be able to log in using that alias. // // If this parameter is set to `False` , the API throws an `AliasExistsException` error if the alias already exists. The default value is `False` . ForceAliasCreation pulumi.BoolPtrOutput `pulumi:"forceAliasCreation"` - // Set to `RESEND` to resend the invitation message to a user that already exists and reset the expiration limit on the user's account. Set to `SUPPRESS` to suppress sending the message. You can specify only one value. + // Set to `RESEND` to resend the invitation message to a user that already exists, and to reset the temporary-password duration with a new temporary password. Set to `SUPPRESS` to suppress sending the message. You can specify only one value. MessageAction pulumi.StringPtrOutput `pulumi:"messageAction"` // An array of name-value pairs that contain user attributes and attribute values to be set for the user to be created. You can create a user without specifying any attributes other than `Username` . However, any attributes that you specify as required (when creating a user pool or in the *Attributes* tab of the console) either you should supply (in your call to `AdminCreateUser` ) or the user should supply (when they sign up in response to your welcome message). // @@ -50,7 +50,7 @@ type UserPoolUser struct { // - *email* : The email address of the user to whom the message that contains the code and username will be sent. Required if the `email_verified` attribute is set to `True` , or if `"EMAIL"` is specified in the `DesiredDeliveryMediums` parameter. // - *phone_number* : The phone number of the user to whom the message that contains the code and username will be sent. Required if the `phone_number_verified` attribute is set to `True` , or if `"SMS"` is specified in the `DesiredDeliveryMediums` parameter. UserAttributes UserPoolUserAttributeTypeArrayOutput `pulumi:"userAttributes"` - // The user pool ID for the user pool where the user will be created. + // The ID of the user pool where you want to create a user. UserPoolId pulumi.StringOutput `pulumi:"userPoolId"` // The value that you want to set as the username sign-in attribute. The following conditions apply to the username parameter. // @@ -122,24 +122,24 @@ func (UserPoolUserState) ElementType() reflect.Type { type userPoolUserArgs struct { // A map of custom key-value pairs that you can provide as input for any custom workflows that this action triggers. // - // You create custom workflows by assigning AWS Lambda functions to user pool triggers. When you use the AdminCreateUser API action, Amazon Cognito invokes the function that is assigned to the *pre sign-up* trigger. When Amazon Cognito invokes this function, it passes a JSON payload, which the function receives as input. This payload contains a `clientMetadata` attribute, which provides the data that you assigned to the ClientMetadata parameter in your AdminCreateUser request. In your function code in AWS Lambda , you can process the `clientMetadata` value to enhance your workflow for your specific needs. + // You create custom workflows by assigning AWS Lambda functions to user pool triggers. When you use the AdminCreateUser API action, Amazon Cognito invokes the function that is assigned to the *pre sign-up* trigger. When Amazon Cognito invokes this function, it passes a JSON payload, which the function receives as input. This payload contains a `ClientMetadata` attribute, which provides the data that you assigned to the ClientMetadata parameter in your AdminCreateUser request. In your function code in AWS Lambda , you can process the `clientMetadata` value to enhance your workflow for your specific needs. // // For more information, see [Customizing user pool Workflows with Lambda Triggers](https://docs.aws.amazon.com/cognito/latest/developerguide/cognito-user-identity-pools-working-with-aws-lambda-triggers.html) in the *Amazon Cognito Developer Guide* . // - // > When you use the ClientMetadata parameter, remember that Amazon Cognito won't do the following: - // > - Store the ClientMetadata value. This data is available only to AWS Lambda triggers that are assigned to a user pool to support custom workflows. If your user pool configuration doesn't include triggers, the ClientMetadata parameter serves no purpose. - // > - Validate the ClientMetadata value. - // > - Encrypt the ClientMetadata value. Don't use Amazon Cognito to provide sensitive information. + // > When you use the `ClientMetadata` parameter, note that Amazon Cognito won't do the following: + // > - Store the `ClientMetadata` value. This data is available only to AWS Lambda triggers that are assigned to a user pool to support custom workflows. If your user pool configuration doesn't include triggers, the `ClientMetadata` parameter serves no purpose. + // > - Validate the `ClientMetadata` value. + // > - Encrypt the `ClientMetadata` value. Don't send sensitive information in this parameter. ClientMetadata map[string]string `pulumi:"clientMetadata"` - // Specify `"EMAIL"` if email will be used to send the welcome message. Specify `"SMS"` if the phone number will be used. The default value is `"SMS"` . You can specify more than one value. + // Specify `EMAIL` if email will be used to send the welcome message. Specify `SMS` if the phone number will be used. The default value is `SMS` . You can specify more than one value. DesiredDeliveryMediums []string `pulumi:"desiredDeliveryMediums"` // This parameter is used only if the `phone_number_verified` or `email_verified` attribute is set to `True` . Otherwise, it is ignored. // - // If this parameter is set to `True` and the phone number or email address specified in the UserAttributes parameter already exists as an alias with a different user, the API call will migrate the alias from the previous user to the newly created user. The previous user will no longer be able to log in using that alias. + // If this parameter is set to `True` and the phone number or email address specified in the `UserAttributes` parameter already exists as an alias with a different user, this request migrates the alias from the previous user to the newly-created user. The previous user will no longer be able to log in using that alias. // // If this parameter is set to `False` , the API throws an `AliasExistsException` error if the alias already exists. The default value is `False` . ForceAliasCreation *bool `pulumi:"forceAliasCreation"` - // Set to `RESEND` to resend the invitation message to a user that already exists and reset the expiration limit on the user's account. Set to `SUPPRESS` to suppress sending the message. You can specify only one value. + // Set to `RESEND` to resend the invitation message to a user that already exists, and to reset the temporary-password duration with a new temporary password. Set to `SUPPRESS` to suppress sending the message. You can specify only one value. MessageAction *string `pulumi:"messageAction"` // An array of name-value pairs that contain user attributes and attribute values to be set for the user to be created. You can create a user without specifying any attributes other than `Username` . However, any attributes that you specify as required (when creating a user pool or in the *Attributes* tab of the console) either you should supply (in your call to `AdminCreateUser` ) or the user should supply (when they sign up in response to your welcome message). // @@ -154,7 +154,7 @@ type userPoolUserArgs struct { // - *email* : The email address of the user to whom the message that contains the code and username will be sent. Required if the `email_verified` attribute is set to `True` , or if `"EMAIL"` is specified in the `DesiredDeliveryMediums` parameter. // - *phone_number* : The phone number of the user to whom the message that contains the code and username will be sent. Required if the `phone_number_verified` attribute is set to `True` , or if `"SMS"` is specified in the `DesiredDeliveryMediums` parameter. UserAttributes []UserPoolUserAttributeType `pulumi:"userAttributes"` - // The user pool ID for the user pool where the user will be created. + // The ID of the user pool where you want to create a user. UserPoolId string `pulumi:"userPoolId"` // The value that you want to set as the username sign-in attribute. The following conditions apply to the username parameter. // @@ -174,24 +174,24 @@ type userPoolUserArgs struct { type UserPoolUserArgs struct { // A map of custom key-value pairs that you can provide as input for any custom workflows that this action triggers. // - // You create custom workflows by assigning AWS Lambda functions to user pool triggers. When you use the AdminCreateUser API action, Amazon Cognito invokes the function that is assigned to the *pre sign-up* trigger. When Amazon Cognito invokes this function, it passes a JSON payload, which the function receives as input. This payload contains a `clientMetadata` attribute, which provides the data that you assigned to the ClientMetadata parameter in your AdminCreateUser request. In your function code in AWS Lambda , you can process the `clientMetadata` value to enhance your workflow for your specific needs. + // You create custom workflows by assigning AWS Lambda functions to user pool triggers. When you use the AdminCreateUser API action, Amazon Cognito invokes the function that is assigned to the *pre sign-up* trigger. When Amazon Cognito invokes this function, it passes a JSON payload, which the function receives as input. This payload contains a `ClientMetadata` attribute, which provides the data that you assigned to the ClientMetadata parameter in your AdminCreateUser request. In your function code in AWS Lambda , you can process the `clientMetadata` value to enhance your workflow for your specific needs. // // For more information, see [Customizing user pool Workflows with Lambda Triggers](https://docs.aws.amazon.com/cognito/latest/developerguide/cognito-user-identity-pools-working-with-aws-lambda-triggers.html) in the *Amazon Cognito Developer Guide* . // - // > When you use the ClientMetadata parameter, remember that Amazon Cognito won't do the following: - // > - Store the ClientMetadata value. This data is available only to AWS Lambda triggers that are assigned to a user pool to support custom workflows. If your user pool configuration doesn't include triggers, the ClientMetadata parameter serves no purpose. - // > - Validate the ClientMetadata value. - // > - Encrypt the ClientMetadata value. Don't use Amazon Cognito to provide sensitive information. + // > When you use the `ClientMetadata` parameter, note that Amazon Cognito won't do the following: + // > - Store the `ClientMetadata` value. This data is available only to AWS Lambda triggers that are assigned to a user pool to support custom workflows. If your user pool configuration doesn't include triggers, the `ClientMetadata` parameter serves no purpose. + // > - Validate the `ClientMetadata` value. + // > - Encrypt the `ClientMetadata` value. Don't send sensitive information in this parameter. ClientMetadata pulumi.StringMapInput - // Specify `"EMAIL"` if email will be used to send the welcome message. Specify `"SMS"` if the phone number will be used. The default value is `"SMS"` . You can specify more than one value. + // Specify `EMAIL` if email will be used to send the welcome message. Specify `SMS` if the phone number will be used. The default value is `SMS` . You can specify more than one value. DesiredDeliveryMediums pulumi.StringArrayInput // This parameter is used only if the `phone_number_verified` or `email_verified` attribute is set to `True` . Otherwise, it is ignored. // - // If this parameter is set to `True` and the phone number or email address specified in the UserAttributes parameter already exists as an alias with a different user, the API call will migrate the alias from the previous user to the newly created user. The previous user will no longer be able to log in using that alias. + // If this parameter is set to `True` and the phone number or email address specified in the `UserAttributes` parameter already exists as an alias with a different user, this request migrates the alias from the previous user to the newly-created user. The previous user will no longer be able to log in using that alias. // // If this parameter is set to `False` , the API throws an `AliasExistsException` error if the alias already exists. The default value is `False` . ForceAliasCreation pulumi.BoolPtrInput - // Set to `RESEND` to resend the invitation message to a user that already exists and reset the expiration limit on the user's account. Set to `SUPPRESS` to suppress sending the message. You can specify only one value. + // Set to `RESEND` to resend the invitation message to a user that already exists, and to reset the temporary-password duration with a new temporary password. Set to `SUPPRESS` to suppress sending the message. You can specify only one value. MessageAction pulumi.StringPtrInput // An array of name-value pairs that contain user attributes and attribute values to be set for the user to be created. You can create a user without specifying any attributes other than `Username` . However, any attributes that you specify as required (when creating a user pool or in the *Attributes* tab of the console) either you should supply (in your call to `AdminCreateUser` ) or the user should supply (when they sign up in response to your welcome message). // @@ -206,7 +206,7 @@ type UserPoolUserArgs struct { // - *email* : The email address of the user to whom the message that contains the code and username will be sent. Required if the `email_verified` attribute is set to `True` , or if `"EMAIL"` is specified in the `DesiredDeliveryMediums` parameter. // - *phone_number* : The phone number of the user to whom the message that contains the code and username will be sent. Required if the `phone_number_verified` attribute is set to `True` , or if `"SMS"` is specified in the `DesiredDeliveryMediums` parameter. UserAttributes UserPoolUserAttributeTypeArrayInput - // The user pool ID for the user pool where the user will be created. + // The ID of the user pool where you want to create a user. UserPoolId pulumi.StringInput // The value that you want to set as the username sign-in attribute. The following conditions apply to the username parameter. // @@ -261,33 +261,33 @@ func (o UserPoolUserOutput) ToUserPoolUserOutputWithContext(ctx context.Context) // A map of custom key-value pairs that you can provide as input for any custom workflows that this action triggers. // -// You create custom workflows by assigning AWS Lambda functions to user pool triggers. When you use the AdminCreateUser API action, Amazon Cognito invokes the function that is assigned to the *pre sign-up* trigger. When Amazon Cognito invokes this function, it passes a JSON payload, which the function receives as input. This payload contains a `clientMetadata` attribute, which provides the data that you assigned to the ClientMetadata parameter in your AdminCreateUser request. In your function code in AWS Lambda , you can process the `clientMetadata` value to enhance your workflow for your specific needs. +// You create custom workflows by assigning AWS Lambda functions to user pool triggers. When you use the AdminCreateUser API action, Amazon Cognito invokes the function that is assigned to the *pre sign-up* trigger. When Amazon Cognito invokes this function, it passes a JSON payload, which the function receives as input. This payload contains a `ClientMetadata` attribute, which provides the data that you assigned to the ClientMetadata parameter in your AdminCreateUser request. In your function code in AWS Lambda , you can process the `clientMetadata` value to enhance your workflow for your specific needs. // // For more information, see [Customizing user pool Workflows with Lambda Triggers](https://docs.aws.amazon.com/cognito/latest/developerguide/cognito-user-identity-pools-working-with-aws-lambda-triggers.html) in the *Amazon Cognito Developer Guide* . // -// > When you use the ClientMetadata parameter, remember that Amazon Cognito won't do the following: -// > - Store the ClientMetadata value. This data is available only to AWS Lambda triggers that are assigned to a user pool to support custom workflows. If your user pool configuration doesn't include triggers, the ClientMetadata parameter serves no purpose. -// > - Validate the ClientMetadata value. -// > - Encrypt the ClientMetadata value. Don't use Amazon Cognito to provide sensitive information. +// > When you use the `ClientMetadata` parameter, note that Amazon Cognito won't do the following: +// > - Store the `ClientMetadata` value. This data is available only to AWS Lambda triggers that are assigned to a user pool to support custom workflows. If your user pool configuration doesn't include triggers, the `ClientMetadata` parameter serves no purpose. +// > - Validate the `ClientMetadata` value. +// > - Encrypt the `ClientMetadata` value. Don't send sensitive information in this parameter. func (o UserPoolUserOutput) ClientMetadata() pulumi.StringMapOutput { return o.ApplyT(func(v *UserPoolUser) pulumi.StringMapOutput { return v.ClientMetadata }).(pulumi.StringMapOutput) } -// Specify `"EMAIL"` if email will be used to send the welcome message. Specify `"SMS"` if the phone number will be used. The default value is `"SMS"` . You can specify more than one value. +// Specify `EMAIL` if email will be used to send the welcome message. Specify `SMS` if the phone number will be used. The default value is `SMS` . You can specify more than one value. func (o UserPoolUserOutput) DesiredDeliveryMediums() pulumi.StringArrayOutput { return o.ApplyT(func(v *UserPoolUser) pulumi.StringArrayOutput { return v.DesiredDeliveryMediums }).(pulumi.StringArrayOutput) } // This parameter is used only if the `phone_number_verified` or `email_verified` attribute is set to `True` . Otherwise, it is ignored. // -// If this parameter is set to `True` and the phone number or email address specified in the UserAttributes parameter already exists as an alias with a different user, the API call will migrate the alias from the previous user to the newly created user. The previous user will no longer be able to log in using that alias. +// If this parameter is set to `True` and the phone number or email address specified in the `UserAttributes` parameter already exists as an alias with a different user, this request migrates the alias from the previous user to the newly-created user. The previous user will no longer be able to log in using that alias. // // If this parameter is set to `False` , the API throws an `AliasExistsException` error if the alias already exists. The default value is `False` . func (o UserPoolUserOutput) ForceAliasCreation() pulumi.BoolPtrOutput { return o.ApplyT(func(v *UserPoolUser) pulumi.BoolPtrOutput { return v.ForceAliasCreation }).(pulumi.BoolPtrOutput) } -// Set to `RESEND` to resend the invitation message to a user that already exists and reset the expiration limit on the user's account. Set to `SUPPRESS` to suppress sending the message. You can specify only one value. +// Set to `RESEND` to resend the invitation message to a user that already exists, and to reset the temporary-password duration with a new temporary password. Set to `SUPPRESS` to suppress sending the message. You can specify only one value. func (o UserPoolUserOutput) MessageAction() pulumi.StringPtrOutput { return o.ApplyT(func(v *UserPoolUser) pulumi.StringPtrOutput { return v.MessageAction }).(pulumi.StringPtrOutput) } @@ -308,7 +308,7 @@ func (o UserPoolUserOutput) UserAttributes() UserPoolUserAttributeTypeArrayOutpu return o.ApplyT(func(v *UserPoolUser) UserPoolUserAttributeTypeArrayOutput { return v.UserAttributes }).(UserPoolUserAttributeTypeArrayOutput) } -// The user pool ID for the user pool where the user will be created. +// The ID of the user pool where you want to create a user. func (o UserPoolUserOutput) UserPoolId() pulumi.StringOutput { return o.ApplyT(func(v *UserPoolUser) pulumi.StringOutput { return v.UserPoolId }).(pulumi.StringOutput) } diff --git a/sdk/go/aws/cognito/userPoolUserToGroupAttachment.go b/sdk/go/aws/cognito/userPoolUserToGroupAttachment.go index ac977ce734..ea5432d36f 100644 --- a/sdk/go/aws/cognito/userPoolUserToGroupAttachment.go +++ b/sdk/go/aws/cognito/userPoolUserToGroupAttachment.go @@ -18,7 +18,7 @@ type UserPoolUserToGroupAttachment struct { // The name of the group that you want to add your user to. GroupName pulumi.StringOutput `pulumi:"groupName"` - // The user pool ID for the user pool. + // The ID of the user pool that contains the group that you want to add the user to. UserPoolId pulumi.StringOutput `pulumi:"userPoolId"` // The user's username. Username pulumi.StringOutput `pulumi:"username"` @@ -81,7 +81,7 @@ func (UserPoolUserToGroupAttachmentState) ElementType() reflect.Type { type userPoolUserToGroupAttachmentArgs struct { // The name of the group that you want to add your user to. GroupName string `pulumi:"groupName"` - // The user pool ID for the user pool. + // The ID of the user pool that contains the group that you want to add the user to. UserPoolId string `pulumi:"userPoolId"` // The user's username. Username string `pulumi:"username"` @@ -91,7 +91,7 @@ type userPoolUserToGroupAttachmentArgs struct { type UserPoolUserToGroupAttachmentArgs struct { // The name of the group that you want to add your user to. GroupName pulumi.StringInput - // The user pool ID for the user pool. + // The ID of the user pool that contains the group that you want to add the user to. UserPoolId pulumi.StringInput // The user's username. Username pulumi.StringInput @@ -139,7 +139,7 @@ func (o UserPoolUserToGroupAttachmentOutput) GroupName() pulumi.StringOutput { return o.ApplyT(func(v *UserPoolUserToGroupAttachment) pulumi.StringOutput { return v.GroupName }).(pulumi.StringOutput) } -// The user pool ID for the user pool. +// The ID of the user pool that contains the group that you want to add the user to. func (o UserPoolUserToGroupAttachmentOutput) UserPoolId() pulumi.StringOutput { return o.ApplyT(func(v *UserPoolUserToGroupAttachment) pulumi.StringOutput { return v.UserPoolId }).(pulumi.StringOutput) } diff --git a/sdk/go/aws/connect/getTaskTemplate.go b/sdk/go/aws/connect/getTaskTemplate.go index 56c01b8eda..ccf5b26653 100644 --- a/sdk/go/aws/connect/getTaskTemplate.go +++ b/sdk/go/aws/connect/getTaskTemplate.go @@ -47,6 +47,8 @@ type LookupTaskTemplateResult struct { InstanceArn *string `pulumi:"instanceArn"` // The name of the task template. Name *string `pulumi:"name"` + // The identifier of the contact flow. + SelfAssignContactFlowArn *string `pulumi:"selfAssignContactFlowArn"` // The status of the task template. Status *TaskTemplateStatus `pulumi:"status"` // One or more tags. @@ -140,6 +142,11 @@ func (o LookupTaskTemplateResultOutput) Name() pulumi.StringPtrOutput { return o.ApplyT(func(v LookupTaskTemplateResult) *string { return v.Name }).(pulumi.StringPtrOutput) } +// The identifier of the contact flow. +func (o LookupTaskTemplateResultOutput) SelfAssignContactFlowArn() pulumi.StringPtrOutput { + return o.ApplyT(func(v LookupTaskTemplateResult) *string { return v.SelfAssignContactFlowArn }).(pulumi.StringPtrOutput) +} + // The status of the task template. func (o LookupTaskTemplateResultOutput) Status() TaskTemplateStatusPtrOutput { return o.ApplyT(func(v LookupTaskTemplateResult) *TaskTemplateStatus { return v.Status }).(TaskTemplateStatusPtrOutput) diff --git a/sdk/go/aws/connect/taskTemplate.go b/sdk/go/aws/connect/taskTemplate.go index ca8316beb9..dad64333e6 100644 --- a/sdk/go/aws/connect/taskTemplate.go +++ b/sdk/go/aws/connect/taskTemplate.go @@ -35,6 +35,8 @@ type TaskTemplate struct { InstanceArn pulumi.StringOutput `pulumi:"instanceArn"` // The name of the task template. Name pulumi.StringPtrOutput `pulumi:"name"` + // The identifier of the contact flow. + SelfAssignContactFlowArn pulumi.StringPtrOutput `pulumi:"selfAssignContactFlowArn"` // The status of the task template. Status TaskTemplateStatusPtrOutput `pulumi:"status"` // One or more tags. @@ -100,6 +102,8 @@ type taskTemplateArgs struct { InstanceArn string `pulumi:"instanceArn"` // The name of the task template. Name *string `pulumi:"name"` + // The identifier of the contact flow. + SelfAssignContactFlowArn *string `pulumi:"selfAssignContactFlowArn"` // The status of the task template. Status *TaskTemplateStatus `pulumi:"status"` // One or more tags. @@ -124,6 +128,8 @@ type TaskTemplateArgs struct { InstanceArn pulumi.StringInput // The name of the task template. Name pulumi.StringPtrInput + // The identifier of the contact flow. + SelfAssignContactFlowArn pulumi.StringPtrInput // The status of the task template. Status TaskTemplateStatusPtrInput // One or more tags. @@ -212,6 +218,11 @@ func (o TaskTemplateOutput) Name() pulumi.StringPtrOutput { return o.ApplyT(func(v *TaskTemplate) pulumi.StringPtrOutput { return v.Name }).(pulumi.StringPtrOutput) } +// The identifier of the contact flow. +func (o TaskTemplateOutput) SelfAssignContactFlowArn() pulumi.StringPtrOutput { + return o.ApplyT(func(v *TaskTemplate) pulumi.StringPtrOutput { return v.SelfAssignContactFlowArn }).(pulumi.StringPtrOutput) +} + // The status of the task template. func (o TaskTemplateOutput) Status() TaskTemplateStatusPtrOutput { return o.ApplyT(func(v *TaskTemplate) TaskTemplateStatusPtrOutput { return v.Status }).(TaskTemplateStatusPtrOutput) diff --git a/sdk/go/aws/dynamodb/table.go b/sdk/go/aws/dynamodb/table.go index 2b002b7adf..1a059a0372 100644 --- a/sdk/go/aws/dynamodb/table.go +++ b/sdk/go/aws/dynamodb/table.go @@ -306,8 +306,8 @@ type Table struct { // + If you update either the contributor insights specification or the provisioned throughput values of global secondary indexes, you can update the table without interruption. // + You can delete or add one global secondary index without interruption. If you do both in the same update (for example, by changing the index's logical ID), the update fails. GlobalSecondaryIndexes TableGlobalSecondaryIndexArrayOutput `pulumi:"globalSecondaryIndexes"` - // Specifies the properties of data being imported from the S3 bucket source to the table. - // 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. + // Specifies the properties of data being imported from the S3 bucket source to the" table. + // 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. ImportSourceSpecification TableImportSourceSpecificationPtrOutput `pulumi:"importSourceSpecification"` // Specifies the attributes that make up the primary key for the table. The attributes in the ``KeySchema`` property must also be defined in the ``AttributeDefinitions`` property. KeySchema pulumi.AnyOutput `pulumi:"keySchema"` @@ -418,8 +418,8 @@ type tableArgs struct { // + If you update either the contributor insights specification or the provisioned throughput values of global secondary indexes, you can update the table without interruption. // + You can delete or add one global secondary index without interruption. If you do both in the same update (for example, by changing the index's logical ID), the update fails. GlobalSecondaryIndexes []TableGlobalSecondaryIndex `pulumi:"globalSecondaryIndexes"` - // Specifies the properties of data being imported from the S3 bucket source to the table. - // 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. + // Specifies the properties of data being imported from the S3 bucket source to the" table. + // 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. ImportSourceSpecification *TableImportSourceSpecification `pulumi:"importSourceSpecification"` // Specifies the attributes that make up the primary key for the table. The attributes in the ``KeySchema`` property must also be defined in the ``AttributeDefinitions`` property. KeySchema interface{} `pulumi:"keySchema"` @@ -480,8 +480,8 @@ type TableArgs struct { // + If you update either the contributor insights specification or the provisioned throughput values of global secondary indexes, you can update the table without interruption. // + You can delete or add one global secondary index without interruption. If you do both in the same update (for example, by changing the index's logical ID), the update fails. GlobalSecondaryIndexes TableGlobalSecondaryIndexArrayInput - // Specifies the properties of data being imported from the S3 bucket source to the table. - // 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. + // Specifies the properties of data being imported from the S3 bucket source to the" table. + // 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. ImportSourceSpecification TableImportSourceSpecificationPtrInput // Specifies the attributes that make up the primary key for the table. The attributes in the ``KeySchema`` property must also be defined in the ``AttributeDefinitions`` property. KeySchema pulumi.Input @@ -602,9 +602,9 @@ func (o TableOutput) GlobalSecondaryIndexes() TableGlobalSecondaryIndexArrayOutp return o.ApplyT(func(v *Table) TableGlobalSecondaryIndexArrayOutput { return v.GlobalSecondaryIndexes }).(TableGlobalSecondaryIndexArrayOutput) } -// Specifies the properties of data being imported from the S3 bucket source to the table. +// Specifies the properties of data being imported from the S3 bucket source to the" table. // -// 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. +// 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. func (o TableOutput) ImportSourceSpecification() TableImportSourceSpecificationPtrOutput { return o.ApplyT(func(v *Table) TableImportSourceSpecificationPtrOutput { return v.ImportSourceSpecification }).(TableImportSourceSpecificationPtrOutput) } diff --git a/sdk/go/aws/ec2/launchTemplate.go b/sdk/go/aws/ec2/launchTemplate.go index 0156de971b..c539695716 100644 --- a/sdk/go/aws/ec2/launchTemplate.go +++ b/sdk/go/aws/ec2/launchTemplate.go @@ -36,7 +36,7 @@ type LaunchTemplate struct { // A name for the launch template. LaunchTemplateName pulumi.StringPtrOutput `pulumi:"launchTemplateName"` // The tags to apply to the launch template on creation. To tag the launch template, the resource type must be ``launch-template``. - // To specify the tags for resources that are created during instance launch, use [TagSpecifications](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-launchtemplate-launchtemplatedata.html#cfn-ec2-launchtemplate-launchtemplatedata-tagspecifications). + // To specify the tags for the resources that are created when an instance is launched, you must use [TagSpecifications](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-launchtemplate-launchtemplatedata.html#cfn-ec2-launchtemplate-launchtemplatedata-tagspecifications). TagSpecifications LaunchTemplateTagSpecificationArrayOutput `pulumi:"tagSpecifications"` // A description for the first version of the launch template. VersionDescription pulumi.StringPtrOutput `pulumi:"versionDescription"` @@ -94,7 +94,7 @@ type launchTemplateArgs struct { // A name for the launch template. LaunchTemplateName *string `pulumi:"launchTemplateName"` // The tags to apply to the launch template on creation. To tag the launch template, the resource type must be ``launch-template``. - // To specify the tags for resources that are created during instance launch, use [TagSpecifications](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-launchtemplate-launchtemplatedata.html#cfn-ec2-launchtemplate-launchtemplatedata-tagspecifications). + // To specify the tags for the resources that are created when an instance is launched, you must use [TagSpecifications](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-launchtemplate-launchtemplatedata.html#cfn-ec2-launchtemplate-launchtemplatedata-tagspecifications). TagSpecifications []LaunchTemplateTagSpecification `pulumi:"tagSpecifications"` // A description for the first version of the launch template. VersionDescription *string `pulumi:"versionDescription"` @@ -107,7 +107,7 @@ type LaunchTemplateArgs struct { // A name for the launch template. LaunchTemplateName pulumi.StringPtrInput // The tags to apply to the launch template on creation. To tag the launch template, the resource type must be ``launch-template``. - // To specify the tags for resources that are created during instance launch, use [TagSpecifications](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-launchtemplate-launchtemplatedata.html#cfn-ec2-launchtemplate-launchtemplatedata-tagspecifications). + // To specify the tags for the resources that are created when an instance is launched, you must use [TagSpecifications](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-launchtemplate-launchtemplatedata.html#cfn-ec2-launchtemplate-launchtemplatedata-tagspecifications). TagSpecifications LaunchTemplateTagSpecificationArrayInput // A description for the first version of the launch template. VersionDescription pulumi.StringPtrInput @@ -179,7 +179,7 @@ func (o LaunchTemplateOutput) LaunchTemplateName() pulumi.StringPtrOutput { // The tags to apply to the launch template on creation. To tag the launch template, the resource type must be “launch-template“. // -// To specify the tags for resources that are created during instance launch, use [TagSpecifications](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-launchtemplate-launchtemplatedata.html#cfn-ec2-launchtemplate-launchtemplatedata-tagspecifications). +// To specify the tags for the resources that are created when an instance is launched, you must use [TagSpecifications](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-launchtemplate-launchtemplatedata.html#cfn-ec2-launchtemplate-launchtemplatedata-tagspecifications). func (o LaunchTemplateOutput) TagSpecifications() LaunchTemplateTagSpecificationArrayOutput { return o.ApplyT(func(v *LaunchTemplate) LaunchTemplateTagSpecificationArrayOutput { return v.TagSpecifications }).(LaunchTemplateTagSpecificationArrayOutput) } diff --git a/sdk/go/aws/ec2/pulumiTypes.go b/sdk/go/aws/ec2/pulumiTypes.go index f1908716a6..0179c1ac13 100644 --- a/sdk/go/aws/ec2/pulumiTypes.go +++ b/sdk/go/aws/ec2/pulumiTypes.go @@ -9351,9 +9351,6 @@ func (o LaunchTemplateBaselineEbsBandwidthMbpsPtrOutput) Min() pulumi.IntPtrOutp }).(pulumi.IntPtrOutput) } -// The baseline performance to consider, using an instance family as a baseline reference. The instance family establishes the lowest acceptable level of performance. Amazon EC2 uses this baseline to guide instance type selection, but there is no guarantee that the selected instance types will always exceed the baseline for every application. -// -// Currently, this parameter only supports CPU performance as a baseline performance factor. For example, specifying ``c6i`` would use the CPU performance of the ``c6i`` family as the baseline reference. type LaunchTemplateBaselinePerformanceFactors struct { // The CPU performance to consider, using an instance family as the baseline reference. Cpu *LaunchTemplateCpu `pulumi:"cpu"` @@ -9370,9 +9367,6 @@ type LaunchTemplateBaselinePerformanceFactorsInput interface { ToLaunchTemplateBaselinePerformanceFactorsOutputWithContext(context.Context) LaunchTemplateBaselinePerformanceFactorsOutput } -// The baseline performance to consider, using an instance family as a baseline reference. The instance family establishes the lowest acceptable level of performance. Amazon EC2 uses this baseline to guide instance type selection, but there is no guarantee that the selected instance types will always exceed the baseline for every application. -// -// Currently, this parameter only supports CPU performance as a baseline performance factor. For example, specifying ``c6i`` would use the CPU performance of the ``c6i`` family as the baseline reference. type LaunchTemplateBaselinePerformanceFactorsArgs struct { // The CPU performance to consider, using an instance family as the baseline reference. Cpu LaunchTemplateCpuPtrInput `pulumi:"cpu"` @@ -9431,9 +9425,6 @@ func (i *launchTemplateBaselinePerformanceFactorsPtrType) ToLaunchTemplateBaseli return pulumi.ToOutputWithContext(ctx, i).(LaunchTemplateBaselinePerformanceFactorsPtrOutput) } -// The baseline performance to consider, using an instance family as a baseline reference. The instance family establishes the lowest acceptable level of performance. Amazon EC2 uses this baseline to guide instance type selection, but there is no guarantee that the selected instance types will always exceed the baseline for every application. -// -// Currently, this parameter only supports CPU performance as a baseline performance factor. For example, specifying ``c6i`` would use the CPU performance of the ``c6i`` family as the baseline reference. type LaunchTemplateBaselinePerformanceFactorsOutput struct{ *pulumi.OutputState } func (LaunchTemplateBaselinePerformanceFactorsOutput) ElementType() reflect.Type { @@ -9635,8 +9626,7 @@ func (o LaunchTemplateBlockDeviceMappingArrayOutput) Index(i pulumi.IntInput) La // ``CapacityReservationSpecification`` is a property of [AWS::EC2::LaunchTemplate LaunchTemplateData](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-launchtemplate-launchtemplatedata.html). type LaunchTemplateCapacityReservationSpecification struct { // Indicates the instance's Capacity Reservation preferences. Possible preferences include: - // + ``capacity-reservations-only`` - The instance will only run in a Capacity Reservation or Capacity Reservation group. If capacity isn't available, the instance will fail to launch. - // + ``open`` - The instance can run in any ``open`` Capacity Reservation that has matching attributes (instance type, platform, Availability Zone, tenancy). + // + ``open`` - The instance can run in any ``open`` Capacity Reservation that has matching attributes (instance type, platform, Availability Zone). // + ``none`` - The instance avoids running in a Capacity Reservation even if one is available. The instance runs in On-Demand capacity. CapacityReservationPreference *string `pulumi:"capacityReservationPreference"` // Information about the target Capacity Reservation or Capacity Reservation group. @@ -9659,8 +9649,7 @@ type LaunchTemplateCapacityReservationSpecificationInput interface { // ``CapacityReservationSpecification`` is a property of [AWS::EC2::LaunchTemplate LaunchTemplateData](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-launchtemplate-launchtemplatedata.html). type LaunchTemplateCapacityReservationSpecificationArgs struct { // Indicates the instance's Capacity Reservation preferences. Possible preferences include: - // + ``capacity-reservations-only`` - The instance will only run in a Capacity Reservation or Capacity Reservation group. If capacity isn't available, the instance will fail to launch. - // + ``open`` - The instance can run in any ``open`` Capacity Reservation that has matching attributes (instance type, platform, Availability Zone, tenancy). + // + ``open`` - The instance can run in any ``open`` Capacity Reservation that has matching attributes (instance type, platform, Availability Zone). // + ``none`` - The instance avoids running in a Capacity Reservation even if one is available. The instance runs in On-Demand capacity. CapacityReservationPreference pulumi.StringPtrInput `pulumi:"capacityReservationPreference"` // Information about the target Capacity Reservation or Capacity Reservation group. @@ -9748,8 +9737,7 @@ func (o LaunchTemplateCapacityReservationSpecificationOutput) ToLaunchTemplateCa } // Indicates the instance's Capacity Reservation preferences. Possible preferences include: -// - “capacity-reservations-only“ - The instance will only run in a Capacity Reservation or Capacity Reservation group. If capacity isn't available, the instance will fail to launch. -// - “open“ - The instance can run in any “open“ Capacity Reservation that has matching attributes (instance type, platform, Availability Zone, tenancy). +// - “open“ - The instance can run in any “open“ Capacity Reservation that has matching attributes (instance type, platform, Availability Zone). // - “none“ - The instance avoids running in a Capacity Reservation even if one is available. The instance runs in On-Demand capacity. func (o LaunchTemplateCapacityReservationSpecificationOutput) CapacityReservationPreference() pulumi.StringPtrOutput { return o.ApplyT(func(v LaunchTemplateCapacityReservationSpecification) *string { return v.CapacityReservationPreference }).(pulumi.StringPtrOutput) @@ -9787,8 +9775,7 @@ func (o LaunchTemplateCapacityReservationSpecificationPtrOutput) Elem() LaunchTe } // Indicates the instance's Capacity Reservation preferences. Possible preferences include: -// - “capacity-reservations-only“ - The instance will only run in a Capacity Reservation or Capacity Reservation group. If capacity isn't available, the instance will fail to launch. -// - “open“ - The instance can run in any “open“ Capacity Reservation that has matching attributes (instance type, platform, Availability Zone, tenancy). +// - “open“ - The instance can run in any “open“ Capacity Reservation that has matching attributes (instance type, platform, Availability Zone). // - “none“ - The instance avoids running in a Capacity Reservation even if one is available. The instance runs in On-Demand capacity. func (o LaunchTemplateCapacityReservationSpecificationPtrOutput) CapacityReservationPreference() pulumi.StringPtrOutput { return o.ApplyT(func(v *LaunchTemplateCapacityReservationSpecification) *string { @@ -10642,8 +10629,7 @@ type LaunchTemplateData struct { // Deprecated. // Amazon Elastic Graphics reached end of life on January 8, 2024. For workloads that require graphics acceleration, we recommend that you use Amazon EC2 G4ad, G4dn, or G5 instances. ElasticGpuSpecifications []LaunchTemplateElasticGpuSpecification `pulumi:"elasticGpuSpecifications"` - // Amazon Elastic Inference is no longer available. - // An elastic inference accelerator to associate with the instance. Elastic inference accelerators are a resource you can attach to your Amazon EC2 instances to accelerate your Deep Learning (DL) inference workloads. + // An elastic inference accelerator to associate with the instance. Elastic inference accelerators are a resource you can attach to your Amazon EC2 instances to accelerate your Deep Learning (DL) inference workloads. // You cannot specify accelerators from different generations in the same request. // Starting April 15, 2023, AWS will not onboard new customers to Amazon Elastic Inference (EI), and will help current customers migrate their workloads to options that offer better price and performance. After April 15, 2023, new customers will not be able to launch instances with Amazon EI accelerators in Amazon SageMaker, Amazon ECS, or Amazon EC2. However, customers who have used Amazon EI at least once during the past 30-day period are considered current customers and will be able to continue using the service. ElasticInferenceAccelerators []LaunchTemplateElasticInferenceAccelerator `pulumi:"elasticInferenceAccelerators"` @@ -10677,7 +10663,7 @@ type LaunchTemplateData struct { // // If you specify ``InstanceRequirements``, you can't specify ``InstanceType``. // Attribute-based instance type selection is only supported when using Auto Scaling groups, EC2 Fleet, and Spot Fleet to launch instances. If you plan to use the launch template in the [launch instance wizard](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ec2-launch-instance-wizard.html), or with the [RunInstances](https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_RunInstances.html) API or [AWS::EC2::Instance](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-instance.html) AWS CloudFormation resource, you can't specify ``InstanceRequirements``. - // For more information, see [Specify attributes for instance type selection for EC2 Fleet or Spot Fleet](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ec2-fleet-attribute-based-instance-type-selection.html) and [Spot placement score](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/spot-placement-score.html) in the *Amazon EC2 User Guide*. + // For more information, see [Attribute-based instance type selection for EC2 Fleet](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ec2-fleet-attribute-based-instance-type-selection.html), [Attribute-based instance type selection for Spot Fleet](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/spot-fleet-attribute-based-instance-type-selection.html), and [Spot placement score](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/spot-placement-score.html) in the *Amazon EC2 User Guide*. InstanceRequirements *LaunchTemplateInstanceRequirements `pulumi:"instanceRequirements"` // The instance type. For more information, see [Amazon EC2 instance types](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/instance-types.html) in the *Amazon EC2 User Guide*. // If you specify ``InstanceType``, you can't specify ``InstanceRequirements``. @@ -10697,8 +10683,7 @@ type LaunchTemplateData struct { // The monitoring for the instance. Monitoring *LaunchTemplateMonitoring `pulumi:"monitoring"` // The network interfaces for the instance. - NetworkInterfaces []LaunchTemplateNetworkInterface `pulumi:"networkInterfaces"` - NetworkPerformanceOptions interface{} `pulumi:"networkPerformanceOptions"` + NetworkInterfaces []LaunchTemplateNetworkInterface `pulumi:"networkInterfaces"` // The placement for the instance. Placement *LaunchTemplatePlacement `pulumi:"placement"` // The hostname type for EC2 instances launched into this subnet and how DNS A and AAAA record queries should be handled. For more information, see [Amazon EC2 instance hostname types](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ec2-instance-naming.html) in the *User Guide*. @@ -10712,7 +10697,8 @@ type LaunchTemplateData struct { // The names of the security groups. For a nondefault VPC, you must use security group IDs instead. // If you specify a network interface, you must specify any security groups as part of the network interface instead of using this parameter. SecurityGroups []string `pulumi:"securityGroups"` - // The tags to apply to resources that are created during instance launch. + // The tags to apply to the resources that are created during instance launch. + // To tag a resource after it has been created, see [CreateTags](https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_CreateTags.html). // To tag the launch template itself, use [TagSpecifications](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-launchtemplate.html#cfn-ec2-launchtemplate-tagspecifications). TagSpecifications []TagSpecification `pulumi:"tagSpecifications"` // The user data to make available to the instance. You must provide base64-encoded text. User data is limited to 16 KB. For more information, see [Run commands on your Amazon EC2 instance at launch](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/user-data.html) in the *Amazon EC2 User Guide*. @@ -10752,8 +10738,7 @@ type LaunchTemplateDataArgs struct { // Deprecated. // Amazon Elastic Graphics reached end of life on January 8, 2024. For workloads that require graphics acceleration, we recommend that you use Amazon EC2 G4ad, G4dn, or G5 instances. ElasticGpuSpecifications LaunchTemplateElasticGpuSpecificationArrayInput `pulumi:"elasticGpuSpecifications"` - // Amazon Elastic Inference is no longer available. - // An elastic inference accelerator to associate with the instance. Elastic inference accelerators are a resource you can attach to your Amazon EC2 instances to accelerate your Deep Learning (DL) inference workloads. + // An elastic inference accelerator to associate with the instance. Elastic inference accelerators are a resource you can attach to your Amazon EC2 instances to accelerate your Deep Learning (DL) inference workloads. // You cannot specify accelerators from different generations in the same request. // Starting April 15, 2023, AWS will not onboard new customers to Amazon Elastic Inference (EI), and will help current customers migrate their workloads to options that offer better price and performance. After April 15, 2023, new customers will not be able to launch instances with Amazon EI accelerators in Amazon SageMaker, Amazon ECS, or Amazon EC2. However, customers who have used Amazon EI at least once during the past 30-day period are considered current customers and will be able to continue using the service. ElasticInferenceAccelerators LaunchTemplateElasticInferenceAcceleratorArrayInput `pulumi:"elasticInferenceAccelerators"` @@ -10787,7 +10772,7 @@ type LaunchTemplateDataArgs struct { // // If you specify ``InstanceRequirements``, you can't specify ``InstanceType``. // Attribute-based instance type selection is only supported when using Auto Scaling groups, EC2 Fleet, and Spot Fleet to launch instances. If you plan to use the launch template in the [launch instance wizard](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ec2-launch-instance-wizard.html), or with the [RunInstances](https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_RunInstances.html) API or [AWS::EC2::Instance](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-instance.html) AWS CloudFormation resource, you can't specify ``InstanceRequirements``. - // For more information, see [Specify attributes for instance type selection for EC2 Fleet or Spot Fleet](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ec2-fleet-attribute-based-instance-type-selection.html) and [Spot placement score](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/spot-placement-score.html) in the *Amazon EC2 User Guide*. + // For more information, see [Attribute-based instance type selection for EC2 Fleet](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ec2-fleet-attribute-based-instance-type-selection.html), [Attribute-based instance type selection for Spot Fleet](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/spot-fleet-attribute-based-instance-type-selection.html), and [Spot placement score](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/spot-placement-score.html) in the *Amazon EC2 User Guide*. InstanceRequirements LaunchTemplateInstanceRequirementsPtrInput `pulumi:"instanceRequirements"` // The instance type. For more information, see [Amazon EC2 instance types](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/instance-types.html) in the *Amazon EC2 User Guide*. // If you specify ``InstanceType``, you can't specify ``InstanceRequirements``. @@ -10807,8 +10792,7 @@ type LaunchTemplateDataArgs struct { // The monitoring for the instance. Monitoring LaunchTemplateMonitoringPtrInput `pulumi:"monitoring"` // The network interfaces for the instance. - NetworkInterfaces LaunchTemplateNetworkInterfaceArrayInput `pulumi:"networkInterfaces"` - NetworkPerformanceOptions pulumi.Input `pulumi:"networkPerformanceOptions"` + NetworkInterfaces LaunchTemplateNetworkInterfaceArrayInput `pulumi:"networkInterfaces"` // The placement for the instance. Placement LaunchTemplatePlacementPtrInput `pulumi:"placement"` // The hostname type for EC2 instances launched into this subnet and how DNS A and AAAA record queries should be handled. For more information, see [Amazon EC2 instance hostname types](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ec2-instance-naming.html) in the *User Guide*. @@ -10822,7 +10806,8 @@ type LaunchTemplateDataArgs struct { // The names of the security groups. For a nondefault VPC, you must use security group IDs instead. // If you specify a network interface, you must specify any security groups as part of the network interface instead of using this parameter. SecurityGroups pulumi.StringArrayInput `pulumi:"securityGroups"` - // The tags to apply to resources that are created during instance launch. + // The tags to apply to the resources that are created during instance launch. + // To tag a resource after it has been created, see [CreateTags](https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_CreateTags.html). // To tag the launch template itself, use [TagSpecifications](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-launchtemplate.html#cfn-ec2-launchtemplate-tagspecifications). TagSpecifications TagSpecificationArrayInput `pulumi:"tagSpecifications"` // The user data to make available to the instance. You must provide base64-encoded text. User data is limited to 16 KB. For more information, see [Run commands on your Amazon EC2 instance at launch](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/user-data.html) in the *Amazon EC2 User Guide*. @@ -10903,9 +10888,8 @@ func (o LaunchTemplateDataOutput) ElasticGpuSpecifications() LaunchTemplateElast return o.ApplyT(func(v LaunchTemplateData) []LaunchTemplateElasticGpuSpecification { return v.ElasticGpuSpecifications }).(LaunchTemplateElasticGpuSpecificationArrayOutput) } -// Amazon Elastic Inference is no longer available. +// An elastic inference accelerator to associate with the instance. Elastic inference accelerators are a resource you can attach to your Amazon EC2 instances to accelerate your Deep Learning (DL) inference workloads. // -// An elastic inference accelerator to associate with the instance. Elastic inference accelerators are a resource you can attach to your Amazon EC2 instances to accelerate your Deep Learning (DL) inference workloads. // You cannot specify accelerators from different generations in the same request. // Starting April 15, 2023, AWS will not onboard new customers to Amazon Elastic Inference (EI), and will help current customers migrate their workloads to options that offer better price and performance. After April 15, 2023, new customers will not be able to launch instances with Amazon EI accelerators in Amazon SageMaker, Amazon ECS, or Amazon EC2. However, customers who have used Amazon EI at least once during the past 30-day period are considered current customers and will be able to continue using the service. func (o LaunchTemplateDataOutput) ElasticInferenceAccelerators() LaunchTemplateElasticInferenceAcceleratorArrayOutput { @@ -10966,7 +10950,7 @@ func (o LaunchTemplateDataOutput) InstanceMarketOptions() LaunchTemplateInstance // // If you specify ``InstanceRequirements``, you can't specify ``InstanceType``. // Attribute-based instance type selection is only supported when using Auto Scaling groups, EC2 Fleet, and Spot Fleet to launch instances. If you plan to use the launch template in the [launch instance wizard](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ec2-launch-instance-wizard.html), or with the [RunInstances](https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_RunInstances.html) API or [AWS::EC2::Instance](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-instance.html) AWS CloudFormation resource, you can't specify ``InstanceRequirements``. -// For more information, see [Specify attributes for instance type selection for EC2 Fleet or Spot Fleet](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ec2-fleet-attribute-based-instance-type-selection.html) and [Spot placement score](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/spot-placement-score.html) in the *Amazon EC2 User Guide*. +// For more information, see [Attribute-based instance type selection for EC2 Fleet](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ec2-fleet-attribute-based-instance-type-selection.html), [Attribute-based instance type selection for Spot Fleet](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/spot-fleet-attribute-based-instance-type-selection.html), and [Spot placement score](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/spot-placement-score.html) in the *Amazon EC2 User Guide*. func (o LaunchTemplateDataOutput) InstanceRequirements() LaunchTemplateInstanceRequirementsPtrOutput { return o.ApplyT(func(v LaunchTemplateData) *LaunchTemplateInstanceRequirements { return v.InstanceRequirements }).(LaunchTemplateInstanceRequirementsPtrOutput) } @@ -11017,10 +11001,6 @@ func (o LaunchTemplateDataOutput) NetworkInterfaces() LaunchTemplateNetworkInter return o.ApplyT(func(v LaunchTemplateData) []LaunchTemplateNetworkInterface { return v.NetworkInterfaces }).(LaunchTemplateNetworkInterfaceArrayOutput) } -func (o LaunchTemplateDataOutput) NetworkPerformanceOptions() pulumi.AnyOutput { - return o.ApplyT(func(v LaunchTemplateData) interface{} { return v.NetworkPerformanceOptions }).(pulumi.AnyOutput) -} - // The placement for the instance. func (o LaunchTemplateDataOutput) Placement() LaunchTemplatePlacementPtrOutput { return o.ApplyT(func(v LaunchTemplateData) *LaunchTemplatePlacement { return v.Placement }).(LaunchTemplatePlacementPtrOutput) @@ -11052,8 +11032,9 @@ func (o LaunchTemplateDataOutput) SecurityGroups() pulumi.StringArrayOutput { return o.ApplyT(func(v LaunchTemplateData) []string { return v.SecurityGroups }).(pulumi.StringArrayOutput) } -// The tags to apply to resources that are created during instance launch. +// The tags to apply to the resources that are created during instance launch. // +// To tag a resource after it has been created, see [CreateTags](https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_CreateTags.html). // To tag the launch template itself, use [TagSpecifications](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-launchtemplate.html#cfn-ec2-launchtemplate-tagspecifications). func (o LaunchTemplateDataOutput) TagSpecifications() TagSpecificationArrayOutput { return o.ApplyT(func(v LaunchTemplateData) []TagSpecification { return v.TagSpecifications }).(TagSpecificationArrayOutput) @@ -11083,7 +11064,7 @@ type LaunchTemplateEbs struct { // For ``io2`` volumes, you can achieve up to 256,000 IOPS on [instances built on the Nitro System](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/instance-types.html#ec2-nitro-instances). On other instances, you can achieve performance up to 32,000 IOPS. // This parameter is supported for ``io1``, ``io2``, and ``gp3`` volumes only. Iops *int `pulumi:"iops"` - // Identifier (key ID, key alias, key ARN, or alias ARN) of the customer managed KMS key to use for EBS encryption. + // The ARN of the symmetric KMSlong (KMS) CMK used for encryption. KmsKeyId *string `pulumi:"kmsKeyId"` // The ID of the snapshot. SnapshotId *string `pulumi:"snapshotId"` @@ -11129,7 +11110,7 @@ type LaunchTemplateEbsArgs struct { // For ``io2`` volumes, you can achieve up to 256,000 IOPS on [instances built on the Nitro System](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/instance-types.html#ec2-nitro-instances). On other instances, you can achieve performance up to 32,000 IOPS. // This parameter is supported for ``io1``, ``io2``, and ``gp3`` volumes only. Iops pulumi.IntPtrInput `pulumi:"iops"` - // Identifier (key ID, key alias, key ARN, or alias ARN) of the customer managed KMS key to use for EBS encryption. + // The ARN of the symmetric KMSlong (KMS) CMK used for encryption. KmsKeyId pulumi.StringPtrInput `pulumi:"kmsKeyId"` // The ID of the snapshot. SnapshotId pulumi.StringPtrInput `pulumi:"snapshotId"` @@ -11250,7 +11231,7 @@ func (o LaunchTemplateEbsOutput) Iops() pulumi.IntPtrOutput { return o.ApplyT(func(v LaunchTemplateEbs) *int { return v.Iops }).(pulumi.IntPtrOutput) } -// Identifier (key ID, key alias, key ARN, or alias ARN) of the customer managed KMS key to use for EBS encryption. +// The ARN of the symmetric KMSlong (KMS) CMK used for encryption. func (o LaunchTemplateEbsOutput) KmsKeyId() pulumi.StringPtrOutput { return o.ApplyT(func(v LaunchTemplateEbs) *string { return v.KmsKeyId }).(pulumi.StringPtrOutput) } @@ -11344,7 +11325,7 @@ func (o LaunchTemplateEbsPtrOutput) Iops() pulumi.IntPtrOutput { }).(pulumi.IntPtrOutput) } -// Identifier (key ID, key alias, key ARN, or alias ARN) of the customer managed KMS key to use for EBS encryption. +// The ARN of the symmetric KMSlong (KMS) CMK used for encryption. func (o LaunchTemplateEbsPtrOutput) KmsKeyId() pulumi.StringPtrOutput { return o.ApplyT(func(v *LaunchTemplateEbs) *string { if v == nil { @@ -12571,7 +12552,7 @@ func (o LaunchTemplateInstanceMarketOptionsPtrOutput) SpotOptions() LaunchTempla // // If you specify ``InstanceRequirements``, you can't specify ``InstanceType``. // Attribute-based instance type selection is only supported when using Auto Scaling groups, EC2 Fleet, and Spot Fleet to launch instances. If you plan to use the launch template in the [launch instance wizard](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ec2-launch-instance-wizard.html), or with the [RunInstances](https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_RunInstances.html) API or [AWS::EC2::Instance](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-instance.html) AWS CloudFormation resource, you can't specify ``InstanceRequirements``. -// For more information, see [Specify attributes for instance type selection for EC2 Fleet or Spot Fleet](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ec2-fleet-attribute-based-instance-type-selection.html) and [Spot placement score](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/spot-placement-score.html) in the *Amazon EC2 User Guide*. +// For more information, see [Attribute-based instance type selection for EC2 Fleet](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ec2-fleet-attribute-based-instance-type-selection.html), [Attribute-based instance type selection for Spot Fleet](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/spot-fleet-attribute-based-instance-type-selection.html), and [Spot placement score](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/spot-placement-score.html) in the *Amazon EC2 User Guide*. type LaunchTemplateInstanceRequirements struct { // The minimum and maximum number of accelerators (GPUs, FPGAs, or AWS Inferentia chips) on an instance. // To exclude accelerator-enabled instance types, set ``Max`` to ``0``. @@ -12608,6 +12589,7 @@ type LaunchTemplateInstanceRequirements struct { // The accelerator types that must be on the instance type. // + For instance types with GPU accelerators, specify ``gpu``. // + For instance types with FPGA accelerators, specify ``fpga``. + // + For instance types with inference accelerators, specify ``inference``. // // Default: Any accelerator type AcceleratorTypes []string `pulumi:"acceleratorTypes"` @@ -12627,7 +12609,7 @@ type LaunchTemplateInstanceRequirements struct { // The minimum and maximum baseline bandwidth to Amazon EBS, in Mbps. For more information, see [Amazon EBS–optimized instances](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ebs-optimized.html) in the *Amazon EC2 User Guide*. // Default: No minimum or maximum limits BaselineEbsBandwidthMbps *LaunchTemplateBaselineEbsBandwidthMbps `pulumi:"baselineEbsBandwidthMbps"` - // The baseline performance to consider, using an instance family as a baseline reference. The instance family establishes the lowest acceptable level of performance. Amazon EC2 uses this baseline to guide instance type selection, but there is no guarantee that the selected instance types will always exceed the baseline for every application. Currently, this parameter only supports CPU performance as a baseline performance factor. For more information, see [Performance protection](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ec2-fleet-attribute-based-instance-type-selection.html#ec2fleet-abis-performance-protection) in the *Amazon EC2 User Guide*. + // The baseline performance to consider, using an instance family as a baseline reference. The instance family establishes the lowest acceptable level of performance. Amazon EC2 uses this baseline to guide instance type selection, but there is no guarantee that the selected instance types will always exceed the baseline for every application. Currently, this parameter only supports CPU performance as a baseline performance factor. For more information, see [Performance protection](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ec2-fleet-attribute-based-instance-type-selection.html#ec2fleet-abis-performance-protection) in the *Amazon EC2 User Guide* . BaselinePerformanceFactors *LaunchTemplateBaselinePerformanceFactors `pulumi:"baselinePerformanceFactors"` // Indicates whether burstable performance T instance types are included, excluded, or required. For more information, see [Burstable performance instances](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/burstable-performance-instances.html). // + To include burstable performance instance types, specify ``included``. @@ -12640,7 +12622,6 @@ type LaunchTemplateInstanceRequirements struct { // + For instance types with Intel CPUs, specify ``intel``. // + For instance types with AMD CPUs, specify ``amd``. // + For instance types with AWS CPUs, specify ``amazon-web-services``. - // + For instance types with Apple CPUs, specify ``apple``. // // Don't confuse the CPU manufacturer with the CPU architecture. Instances will be launched with a compatible CPU architecture based on the Amazon Machine Image (AMI) that you specify in your launch template. // Default: Any manufacturer @@ -12731,7 +12712,7 @@ type LaunchTemplateInstanceRequirementsInput interface { // // If you specify ``InstanceRequirements``, you can't specify ``InstanceType``. // Attribute-based instance type selection is only supported when using Auto Scaling groups, EC2 Fleet, and Spot Fleet to launch instances. If you plan to use the launch template in the [launch instance wizard](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ec2-launch-instance-wizard.html), or with the [RunInstances](https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_RunInstances.html) API or [AWS::EC2::Instance](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-instance.html) AWS CloudFormation resource, you can't specify ``InstanceRequirements``. -// For more information, see [Specify attributes for instance type selection for EC2 Fleet or Spot Fleet](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ec2-fleet-attribute-based-instance-type-selection.html) and [Spot placement score](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/spot-placement-score.html) in the *Amazon EC2 User Guide*. +// For more information, see [Attribute-based instance type selection for EC2 Fleet](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ec2-fleet-attribute-based-instance-type-selection.html), [Attribute-based instance type selection for Spot Fleet](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/spot-fleet-attribute-based-instance-type-selection.html), and [Spot placement score](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/spot-placement-score.html) in the *Amazon EC2 User Guide*. type LaunchTemplateInstanceRequirementsArgs struct { // The minimum and maximum number of accelerators (GPUs, FPGAs, or AWS Inferentia chips) on an instance. // To exclude accelerator-enabled instance types, set ``Max`` to ``0``. @@ -12768,6 +12749,7 @@ type LaunchTemplateInstanceRequirementsArgs struct { // The accelerator types that must be on the instance type. // + For instance types with GPU accelerators, specify ``gpu``. // + For instance types with FPGA accelerators, specify ``fpga``. + // + For instance types with inference accelerators, specify ``inference``. // // Default: Any accelerator type AcceleratorTypes pulumi.StringArrayInput `pulumi:"acceleratorTypes"` @@ -12787,7 +12769,7 @@ type LaunchTemplateInstanceRequirementsArgs struct { // The minimum and maximum baseline bandwidth to Amazon EBS, in Mbps. For more information, see [Amazon EBS–optimized instances](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ebs-optimized.html) in the *Amazon EC2 User Guide*. // Default: No minimum or maximum limits BaselineEbsBandwidthMbps LaunchTemplateBaselineEbsBandwidthMbpsPtrInput `pulumi:"baselineEbsBandwidthMbps"` - // The baseline performance to consider, using an instance family as a baseline reference. The instance family establishes the lowest acceptable level of performance. Amazon EC2 uses this baseline to guide instance type selection, but there is no guarantee that the selected instance types will always exceed the baseline for every application. Currently, this parameter only supports CPU performance as a baseline performance factor. For more information, see [Performance protection](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ec2-fleet-attribute-based-instance-type-selection.html#ec2fleet-abis-performance-protection) in the *Amazon EC2 User Guide*. + // The baseline performance to consider, using an instance family as a baseline reference. The instance family establishes the lowest acceptable level of performance. Amazon EC2 uses this baseline to guide instance type selection, but there is no guarantee that the selected instance types will always exceed the baseline for every application. Currently, this parameter only supports CPU performance as a baseline performance factor. For more information, see [Performance protection](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ec2-fleet-attribute-based-instance-type-selection.html#ec2fleet-abis-performance-protection) in the *Amazon EC2 User Guide* . BaselinePerformanceFactors LaunchTemplateBaselinePerformanceFactorsPtrInput `pulumi:"baselinePerformanceFactors"` // Indicates whether burstable performance T instance types are included, excluded, or required. For more information, see [Burstable performance instances](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/burstable-performance-instances.html). // + To include burstable performance instance types, specify ``included``. @@ -12800,7 +12782,6 @@ type LaunchTemplateInstanceRequirementsArgs struct { // + For instance types with Intel CPUs, specify ``intel``. // + For instance types with AMD CPUs, specify ``amd``. // + For instance types with AWS CPUs, specify ``amazon-web-services``. - // + For instance types with Apple CPUs, specify ``apple``. // // Don't confuse the CPU manufacturer with the CPU architecture. Instances will be launched with a compatible CPU architecture based on the Amazon Machine Image (AMI) that you specify in your launch template. // Default: Any manufacturer @@ -12933,7 +12914,7 @@ func (i *launchTemplateInstanceRequirementsPtrType) ToLaunchTemplateInstanceRequ // // If you specify ``InstanceRequirements``, you can't specify ``InstanceType``. // Attribute-based instance type selection is only supported when using Auto Scaling groups, EC2 Fleet, and Spot Fleet to launch instances. If you plan to use the launch template in the [launch instance wizard](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ec2-launch-instance-wizard.html), or with the [RunInstances](https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_RunInstances.html) API or [AWS::EC2::Instance](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-instance.html) AWS CloudFormation resource, you can't specify ``InstanceRequirements``. -// For more information, see [Specify attributes for instance type selection for EC2 Fleet or Spot Fleet](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ec2-fleet-attribute-based-instance-type-selection.html) and [Spot placement score](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/spot-placement-score.html) in the *Amazon EC2 User Guide*. +// For more information, see [Attribute-based instance type selection for EC2 Fleet](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ec2-fleet-attribute-based-instance-type-selection.html), [Attribute-based instance type selection for Spot Fleet](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/spot-fleet-attribute-based-instance-type-selection.html), and [Spot placement score](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/spot-placement-score.html) in the *Amazon EC2 User Guide*. type LaunchTemplateInstanceRequirementsOutput struct{ *pulumi.OutputState } func (LaunchTemplateInstanceRequirementsOutput) ElementType() reflect.Type { @@ -13029,6 +13010,8 @@ func (o LaunchTemplateInstanceRequirementsOutput) AcceleratorTotalMemoryMiB() La // // - For instance types with FPGA accelerators, specify “fpga“. // +// - For instance types with inference accelerators, specify “inference“. +// // Default: Any accelerator type func (o LaunchTemplateInstanceRequirementsOutput) AcceleratorTypes() pulumi.StringArrayOutput { return o.ApplyT(func(v LaunchTemplateInstanceRequirements) []string { return v.AcceleratorTypes }).(pulumi.StringArrayOutput) @@ -13066,7 +13049,7 @@ func (o LaunchTemplateInstanceRequirementsOutput) BaselineEbsBandwidthMbps() Lau }).(LaunchTemplateBaselineEbsBandwidthMbpsPtrOutput) } -// The baseline performance to consider, using an instance family as a baseline reference. The instance family establishes the lowest acceptable level of performance. Amazon EC2 uses this baseline to guide instance type selection, but there is no guarantee that the selected instance types will always exceed the baseline for every application. Currently, this parameter only supports CPU performance as a baseline performance factor. For more information, see [Performance protection](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ec2-fleet-attribute-based-instance-type-selection.html#ec2fleet-abis-performance-protection) in the *Amazon EC2 User Guide*. +// The baseline performance to consider, using an instance family as a baseline reference. The instance family establishes the lowest acceptable level of performance. Amazon EC2 uses this baseline to guide instance type selection, but there is no guarantee that the selected instance types will always exceed the baseline for every application. Currently, this parameter only supports CPU performance as a baseline performance factor. For more information, see [Performance protection](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ec2-fleet-attribute-based-instance-type-selection.html#ec2fleet-abis-performance-protection) in the *Amazon EC2 User Guide* . func (o LaunchTemplateInstanceRequirementsOutput) BaselinePerformanceFactors() LaunchTemplateBaselinePerformanceFactorsPtrOutput { return o.ApplyT(func(v LaunchTemplateInstanceRequirements) *LaunchTemplateBaselinePerformanceFactors { return v.BaselinePerformanceFactors @@ -13094,8 +13077,6 @@ func (o LaunchTemplateInstanceRequirementsOutput) BurstablePerformance() pulumi. // // - For instance types with AWS CPUs, specify “amazon-web-services“. // -// - For instance types with Apple CPUs, specify “apple“. -// // Don't confuse the CPU manufacturer with the CPU architecture. Instances will be launched with a compatible CPU architecture based on the Amazon Machine Image (AMI) that you specify in your launch template. // Default: Any manufacturer func (o LaunchTemplateInstanceRequirementsOutput) CpuManufacturers() pulumi.StringArrayOutput { @@ -13343,6 +13324,8 @@ func (o LaunchTemplateInstanceRequirementsPtrOutput) AcceleratorTotalMemoryMiB() // // - For instance types with FPGA accelerators, specify “fpga“. // +// - For instance types with inference accelerators, specify “inference“. +// // Default: Any accelerator type func (o LaunchTemplateInstanceRequirementsPtrOutput) AcceleratorTypes() pulumi.StringArrayOutput { return o.ApplyT(func(v *LaunchTemplateInstanceRequirements) []string { @@ -13398,7 +13381,7 @@ func (o LaunchTemplateInstanceRequirementsPtrOutput) BaselineEbsBandwidthMbps() }).(LaunchTemplateBaselineEbsBandwidthMbpsPtrOutput) } -// The baseline performance to consider, using an instance family as a baseline reference. The instance family establishes the lowest acceptable level of performance. Amazon EC2 uses this baseline to guide instance type selection, but there is no guarantee that the selected instance types will always exceed the baseline for every application. Currently, this parameter only supports CPU performance as a baseline performance factor. For more information, see [Performance protection](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ec2-fleet-attribute-based-instance-type-selection.html#ec2fleet-abis-performance-protection) in the *Amazon EC2 User Guide*. +// The baseline performance to consider, using an instance family as a baseline reference. The instance family establishes the lowest acceptable level of performance. Amazon EC2 uses this baseline to guide instance type selection, but there is no guarantee that the selected instance types will always exceed the baseline for every application. Currently, this parameter only supports CPU performance as a baseline performance factor. For more information, see [Performance protection](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ec2-fleet-attribute-based-instance-type-selection.html#ec2fleet-abis-performance-protection) in the *Amazon EC2 User Guide* . func (o LaunchTemplateInstanceRequirementsPtrOutput) BaselinePerformanceFactors() LaunchTemplateBaselinePerformanceFactorsPtrOutput { return o.ApplyT(func(v *LaunchTemplateInstanceRequirements) *LaunchTemplateBaselinePerformanceFactors { if v == nil { @@ -13434,8 +13417,6 @@ func (o LaunchTemplateInstanceRequirementsPtrOutput) BurstablePerformance() pulu // // - For instance types with AWS CPUs, specify “amazon-web-services“. // -// - For instance types with Apple CPUs, specify “apple“. -// // Don't confuse the CPU manufacturer with the CPU architecture. Instances will be launched with a compatible CPU architecture based on the Amazon Machine Image (AMI) that you specify in your launch template. // Default: Any manufacturer func (o LaunchTemplateInstanceRequirementsPtrOutput) CpuManufacturers() pulumi.StringArrayOutput { @@ -15122,10 +15103,9 @@ type LaunchTemplateNetworkInterface struct { EnaSrdSpecification *LaunchTemplateEnaSrdSpecification `pulumi:"enaSrdSpecification"` // The IDs of one or more security groups. Groups []string `pulumi:"groups"` - // The type of network interface. To create an Elastic Fabric Adapter (EFA), specify ``efa`` or ``efa``. For more information, see [Elastic Fabric Adapter](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/efa.html) in the *Amazon EC2 User Guide*. + // The type of network interface. To create an Elastic Fabric Adapter (EFA), specify ``efa``. For more information, see [Elastic Fabric Adapter](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/efa.html) in the *Amazon EC2 User Guide*. // If you are not creating an EFA, specify ``interface`` or omit this parameter. - // If you specify ``efa-only``, do not assign any IP addresses to the network interface. EFA-only network interfaces do not support IP addresses. - // Valid values: ``interface`` | ``efa`` | ``efa-only`` + // Valid values: ``interface`` | ``efa`` InterfaceType *string `pulumi:"interfaceType"` // The number of IPv4 prefixes to be automatically assigned to the network interface. You cannot use this option if you use the ``Ipv4Prefix`` option. Ipv4PrefixCount *int `pulumi:"ipv4PrefixCount"` @@ -15188,10 +15168,9 @@ type LaunchTemplateNetworkInterfaceArgs struct { EnaSrdSpecification LaunchTemplateEnaSrdSpecificationPtrInput `pulumi:"enaSrdSpecification"` // The IDs of one or more security groups. Groups pulumi.StringArrayInput `pulumi:"groups"` - // The type of network interface. To create an Elastic Fabric Adapter (EFA), specify ``efa`` or ``efa``. For more information, see [Elastic Fabric Adapter](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/efa.html) in the *Amazon EC2 User Guide*. + // The type of network interface. To create an Elastic Fabric Adapter (EFA), specify ``efa``. For more information, see [Elastic Fabric Adapter](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/efa.html) in the *Amazon EC2 User Guide*. // If you are not creating an EFA, specify ``interface`` or omit this parameter. - // If you specify ``efa-only``, do not assign any IP addresses to the network interface. EFA-only network interfaces do not support IP addresses. - // Valid values: ``interface`` | ``efa`` | ``efa-only`` + // Valid values: ``interface`` | ``efa`` InterfaceType pulumi.StringPtrInput `pulumi:"interfaceType"` // The number of IPv4 prefixes to be automatically assigned to the network interface. You cannot use this option if you use the ``Ipv4Prefix`` option. Ipv4PrefixCount pulumi.IntPtrInput `pulumi:"ipv4PrefixCount"` @@ -15323,11 +15302,10 @@ func (o LaunchTemplateNetworkInterfaceOutput) Groups() pulumi.StringArrayOutput return o.ApplyT(func(v LaunchTemplateNetworkInterface) []string { return v.Groups }).(pulumi.StringArrayOutput) } -// The type of network interface. To create an Elastic Fabric Adapter (EFA), specify “efa“ or “efa“. For more information, see [Elastic Fabric Adapter](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/efa.html) in the *Amazon EC2 User Guide*. +// The type of network interface. To create an Elastic Fabric Adapter (EFA), specify “efa“. For more information, see [Elastic Fabric Adapter](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/efa.html) in the *Amazon EC2 User Guide*. // // If you are not creating an EFA, specify ``interface`` or omit this parameter. -// If you specify ``efa-only``, do not assign any IP addresses to the network interface. EFA-only network interfaces do not support IP addresses. -// Valid values: ``interface`` | ``efa`` | ``efa-only`` +// Valid values: ``interface`` | ``efa`` func (o LaunchTemplateNetworkInterfaceOutput) InterfaceType() pulumi.StringPtrOutput { return o.ApplyT(func(v LaunchTemplateNetworkInterface) *string { return v.InterfaceType }).(pulumi.StringPtrOutput) } @@ -16168,6 +16146,7 @@ func (o LaunchTemplatePrivateIpAddArrayOutput) Index(i pulumi.IntInput) LaunchTe } type LaunchTemplateReference struct { + // The instance family to refer. Ensure that you specify the correct family name. For example, C6i and C6g are valid values, but C6 is not. InstanceFamily *string `pulumi:"instanceFamily"` } @@ -16183,6 +16162,7 @@ type LaunchTemplateReferenceInput interface { } type LaunchTemplateReferenceArgs struct { + // The instance family to refer. Ensure that you specify the correct family name. For example, C6i and C6g are valid values, but C6 is not. InstanceFamily pulumi.StringPtrInput `pulumi:"instanceFamily"` } @@ -16237,6 +16217,7 @@ func (o LaunchTemplateReferenceOutput) ToLaunchTemplateReferenceOutputWithContex return o } +// The instance family to refer. Ensure that you specify the correct family name. For example, C6i and C6g are valid values, but C6 is not. func (o LaunchTemplateReferenceOutput) InstanceFamily() pulumi.StringPtrOutput { return o.ApplyT(func(v LaunchTemplateReference) *string { return v.InstanceFamily }).(pulumi.StringPtrOutput) } @@ -16626,8 +16607,7 @@ func (o LaunchTemplateTagArrayOutput) Index(i pulumi.IntInput) LaunchTemplateTag // Specifies the tags to apply to the launch template during creation. // -// To specify the tags for the resources that are created during instance launch, use [AWS::EC2::LaunchTemplate TagSpecification](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-launchtemplate-tagspecification.html). -// ``LaunchTemplateTagSpecification`` is a property of [AWS::EC2::LaunchTemplate](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-launchtemplate.html). +// ``LaunchTemplateTagSpecification`` is a property of [AWS::EC2::LaunchTemplate](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-launchtemplate.html). type LaunchTemplateTagSpecification struct { // The type of resource. To tag a launch template, ``ResourceType`` must be ``launch-template``. ResourceType *string `pulumi:"resourceType"` @@ -16648,8 +16628,7 @@ type LaunchTemplateTagSpecificationInput interface { // Specifies the tags to apply to the launch template during creation. // -// To specify the tags for the resources that are created during instance launch, use [AWS::EC2::LaunchTemplate TagSpecification](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-launchtemplate-tagspecification.html). -// ``LaunchTemplateTagSpecification`` is a property of [AWS::EC2::LaunchTemplate](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-launchtemplate.html). +// ``LaunchTemplateTagSpecification`` is a property of [AWS::EC2::LaunchTemplate](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-launchtemplate.html). type LaunchTemplateTagSpecificationArgs struct { // The type of resource. To tag a launch template, ``ResourceType`` must be ``launch-template``. ResourceType pulumi.StringPtrInput `pulumi:"resourceType"` @@ -16696,8 +16675,7 @@ func (i LaunchTemplateTagSpecificationArray) ToLaunchTemplateTagSpecificationArr // Specifies the tags to apply to the launch template during creation. // -// To specify the tags for the resources that are created during instance launch, use [AWS::EC2::LaunchTemplate TagSpecification](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-launchtemplate-tagspecification.html). -// ``LaunchTemplateTagSpecification`` is a property of [AWS::EC2::LaunchTemplate](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-launchtemplate.html). +// ``LaunchTemplateTagSpecification`` is a property of [AWS::EC2::LaunchTemplate](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-launchtemplate.html). type LaunchTemplateTagSpecificationOutput struct{ *pulumi.OutputState } func (LaunchTemplateTagSpecificationOutput) ElementType() reflect.Type { @@ -23818,7 +23796,7 @@ type SpotFleetInstanceNetworkInterfaceSpecification struct { NetworkInterfaceId *string `pulumi:"networkInterfaceId"` // The private IPv4 addresses to assign to the network interface. Only one private IPv4 address can be designated as primary. You cannot specify this option if you're launching more than one instance in a [RunInstances](https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_RunInstances.html) request. PrivateIpAddresses []SpotFleetPrivateIpAddressSpecification `pulumi:"privateIpAddresses"` - // The number of secondary private IPv4 addresses. You can't specify this option and specify more than one private IP address using the private IP addresses option. You cannot specify this option if you're launching more than one instance in a [RunInstances](https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_RunInstances.html) request. + // The number of secondary private IPv4 addresses. You can’t specify this parameter and also specify a secondary private IP address using the `PrivateIpAddress` parameter. SecondaryPrivateIpAddressCount *int `pulumi:"secondaryPrivateIpAddressCount"` // The ID of the subnet associated with the network interface. SubnetId *string `pulumi:"subnetId"` @@ -23860,7 +23838,7 @@ type SpotFleetInstanceNetworkInterfaceSpecificationArgs struct { NetworkInterfaceId pulumi.StringPtrInput `pulumi:"networkInterfaceId"` // The private IPv4 addresses to assign to the network interface. Only one private IPv4 address can be designated as primary. You cannot specify this option if you're launching more than one instance in a [RunInstances](https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_RunInstances.html) request. PrivateIpAddresses SpotFleetPrivateIpAddressSpecificationArrayInput `pulumi:"privateIpAddresses"` - // The number of secondary private IPv4 addresses. You can't specify this option and specify more than one private IP address using the private IP addresses option. You cannot specify this option if you're launching more than one instance in a [RunInstances](https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_RunInstances.html) request. + // The number of secondary private IPv4 addresses. You can’t specify this parameter and also specify a secondary private IP address using the `PrivateIpAddress` parameter. SecondaryPrivateIpAddressCount pulumi.IntPtrInput `pulumi:"secondaryPrivateIpAddressCount"` // The ID of the subnet associated with the network interface. SubnetId pulumi.StringPtrInput `pulumi:"subnetId"` @@ -23972,7 +23950,7 @@ func (o SpotFleetInstanceNetworkInterfaceSpecificationOutput) PrivateIpAddresses }).(SpotFleetPrivateIpAddressSpecificationArrayOutput) } -// The number of secondary private IPv4 addresses. You can't specify this option and specify more than one private IP address using the private IP addresses option. You cannot specify this option if you're launching more than one instance in a [RunInstances](https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_RunInstances.html) request. +// The number of secondary private IPv4 addresses. You can’t specify this parameter and also specify a secondary private IP address using the `PrivateIpAddress` parameter. func (o SpotFleetInstanceNetworkInterfaceSpecificationOutput) SecondaryPrivateIpAddressCount() pulumi.IntPtrOutput { return o.ApplyT(func(v SpotFleetInstanceNetworkInterfaceSpecification) *int { return v.SecondaryPrivateIpAddressCount }).(pulumi.IntPtrOutput) } @@ -28805,7 +28783,7 @@ type SubnetTag struct { Value string `pulumi:"value"` } -// Specifies the tags to apply to resources that are created during instance launch. +// Specifies the tags to apply to a resource when the resource is created for the launch template. // // ``TagSpecification`` is a property type of [TagSpecifications](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-launchtemplate-launchtemplatedata.html#cfn-ec2-launchtemplate-launchtemplatedata-tagspecifications). [TagSpecifications](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-launchtemplate-launchtemplatedata.html#cfn-ec2-launchtemplate-launchtemplatedata-tagspecifications) is a property of [AWS::EC2::LaunchTemplate LaunchTemplateData](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-launchtemplate-launchtemplatedata.html). type TagSpecification struct { @@ -28827,7 +28805,7 @@ type TagSpecificationInput interface { ToTagSpecificationOutputWithContext(context.Context) TagSpecificationOutput } -// Specifies the tags to apply to resources that are created during instance launch. +// Specifies the tags to apply to a resource when the resource is created for the launch template. // // ``TagSpecification`` is a property type of [TagSpecifications](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-launchtemplate-launchtemplatedata.html#cfn-ec2-launchtemplate-launchtemplatedata-tagspecifications). [TagSpecifications](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-launchtemplate-launchtemplatedata.html#cfn-ec2-launchtemplate-launchtemplatedata-tagspecifications) is a property of [AWS::EC2::LaunchTemplate LaunchTemplateData](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-launchtemplate-launchtemplatedata.html). type TagSpecificationArgs struct { @@ -28875,7 +28853,7 @@ func (i TagSpecificationArray) ToTagSpecificationArrayOutputWithContext(ctx cont return pulumi.ToOutputWithContext(ctx, i).(TagSpecificationArrayOutput) } -// Specifies the tags to apply to resources that are created during instance launch. +// Specifies the tags to apply to a resource when the resource is created for the launch template. // // ``TagSpecification`` is a property type of [TagSpecifications](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-launchtemplate-launchtemplatedata.html#cfn-ec2-launchtemplate-launchtemplatedata-tagspecifications). [TagSpecifications](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-launchtemplate-launchtemplatedata.html#cfn-ec2-launchtemplate-launchtemplatedata-tagspecifications) is a property of [AWS::EC2::LaunchTemplate LaunchTemplateData](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-launchtemplate-launchtemplatedata.html). type TagSpecificationOutput struct{ *pulumi.OutputState } diff --git a/sdk/go/aws/ecs/pulumiEnums.go b/sdk/go/aws/ecs/pulumiEnums.go index 8986b1f9c0..cd02344845 100644 --- a/sdk/go/aws/ecs/pulumiEnums.go +++ b/sdk/go/aws/ecs/pulumiEnums.go @@ -2368,7 +2368,7 @@ func (in *taskDefinitionAuthorizationConfigIamPtr) ToTaskDefinitionAuthorization return pulumi.ToOutputWithContext(ctx, in).(TaskDefinitionAuthorizationConfigIamPtrOutput) } -// Specifies whether Amazon ECS will resolve the container image tag provided in the container definition to an image digest. By default, the value is `enabled` . If you set the value for a container as `disabled` , Amazon ECS will not resolve the provided container image tag to a digest and will use the original image URI specified in the container definition for deployment. For more information about container image resolution, see [Container image resolution](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/deployment-type-ecs.html#deployment-container-image-stability) in the *Amazon ECS Developer Guide* . +// Specifies whether Amazon ECS will resolve the container image tag provided in the container definition to an image digest. By default, the value is “enabled“. If you set the value for a container as “disabled“, Amazon ECS will not resolve the provided container image tag to a digest and will use the original image URI specified in the container definition for deployment. For more information about container image resolution, see [Container image resolution](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/deployment-type-ecs.html#deployment-container-image-stability) in the *Amazon ECS Developer Guide*. type TaskDefinitionContainerDefinitionVersionConsistency string const ( diff --git a/sdk/go/aws/ecs/pulumiTypes.go b/sdk/go/aws/ecs/pulumiTypes.go index 013c31cc6e..789d5a804a 100644 --- a/sdk/go/aws/ecs/pulumiTypes.go +++ b/sdk/go/aws/ecs/pulumiTypes.go @@ -6182,7 +6182,7 @@ type TaskDefinitionContainerDefinition struct { // // This parameter is not supported for Windows containers. User *string `pulumi:"user"` - // Specifies whether Amazon ECS will resolve the container image tag provided in the container definition to an image digest. By default, the value is `enabled` . If you set the value for a container as `disabled` , Amazon ECS will not resolve the provided container image tag to a digest and will use the original image URI specified in the container definition for deployment. For more information about container image resolution, see [Container image resolution](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/deployment-type-ecs.html#deployment-container-image-stability) in the *Amazon ECS Developer Guide* . + // Specifies whether Amazon ECS will resolve the container image tag provided in the container definition to an image digest. By default, the value is ``enabled``. If you set the value for a container as ``disabled``, Amazon ECS will not resolve the provided container image tag to a digest and will use the original image URI specified in the container definition for deployment. For more information about container image resolution, see [Container image resolution](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/deployment-type-ecs.html#deployment-container-image-stability) in the *Amazon ECS Developer Guide*. VersionConsistency *TaskDefinitionContainerDefinitionVersionConsistency `pulumi:"versionConsistency"` // Data volumes to mount from another container. This parameter maps to ``VolumesFrom`` in the docker container create command and the ``--volumes-from`` option to docker run. VolumesFrom []TaskDefinitionVolumeFrom `pulumi:"volumesFrom"` @@ -6368,7 +6368,7 @@ type TaskDefinitionContainerDefinitionArgs struct { // // This parameter is not supported for Windows containers. User pulumi.StringPtrInput `pulumi:"user"` - // Specifies whether Amazon ECS will resolve the container image tag provided in the container definition to an image digest. By default, the value is `enabled` . If you set the value for a container as `disabled` , Amazon ECS will not resolve the provided container image tag to a digest and will use the original image URI specified in the container definition for deployment. For more information about container image resolution, see [Container image resolution](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/deployment-type-ecs.html#deployment-container-image-stability) in the *Amazon ECS Developer Guide* . + // Specifies whether Amazon ECS will resolve the container image tag provided in the container definition to an image digest. By default, the value is ``enabled``. If you set the value for a container as ``disabled``, Amazon ECS will not resolve the provided container image tag to a digest and will use the original image URI specified in the container definition for deployment. For more information about container image resolution, see [Container image resolution](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/deployment-type-ecs.html#deployment-container-image-stability) in the *Amazon ECS Developer Guide*. VersionConsistency TaskDefinitionContainerDefinitionVersionConsistencyPtrInput `pulumi:"versionConsistency"` // Data volumes to mount from another container. This parameter maps to ``VolumesFrom`` in the docker container create command and the ``--volumes-from`` option to docker run. VolumesFrom TaskDefinitionVolumeFromArrayInput `pulumi:"volumesFrom"` @@ -6742,7 +6742,7 @@ func (o TaskDefinitionContainerDefinitionOutput) User() pulumi.StringPtrOutput { return o.ApplyT(func(v TaskDefinitionContainerDefinition) *string { return v.User }).(pulumi.StringPtrOutput) } -// Specifies whether Amazon ECS will resolve the container image tag provided in the container definition to an image digest. By default, the value is `enabled` . If you set the value for a container as `disabled` , Amazon ECS will not resolve the provided container image tag to a digest and will use the original image URI specified in the container definition for deployment. For more information about container image resolution, see [Container image resolution](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/deployment-type-ecs.html#deployment-container-image-stability) in the *Amazon ECS Developer Guide* . +// Specifies whether Amazon ECS will resolve the container image tag provided in the container definition to an image digest. By default, the value is “enabled“. If you set the value for a container as “disabled“, Amazon ECS will not resolve the provided container image tag to a digest and will use the original image URI specified in the container definition for deployment. For more information about container image resolution, see [Container image resolution](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/deployment-type-ecs.html#deployment-container-image-stability) in the *Amazon ECS Developer Guide*. func (o TaskDefinitionContainerDefinitionOutput) VersionConsistency() TaskDefinitionContainerDefinitionVersionConsistencyPtrOutput { return o.ApplyT(func(v TaskDefinitionContainerDefinition) *TaskDefinitionContainerDefinitionVersionConsistency { return v.VersionConsistency diff --git a/sdk/go/aws/ecs/taskDefinition.go b/sdk/go/aws/ecs/taskDefinition.go index 4dfc2bc740..d223a9b83e 100644 --- a/sdk/go/aws/ecs/taskDefinition.go +++ b/sdk/go/aws/ecs/taskDefinition.go @@ -301,7 +301,8 @@ type TaskDefinition struct { // This option requires Linux platform ``1.4.0`` or later. // + 16384 (16vCPU) - Available ``memory`` values: 32GB and 120 GB in 8 GB increments // This option requires Linux platform ``1.4.0`` or later. - Cpu pulumi.StringPtrOutput `pulumi:"cpu"` + Cpu pulumi.StringPtrOutput `pulumi:"cpu"` + EnableFaultInjection pulumi.BoolPtrOutput `pulumi:"enableFaultInjection"` // The ephemeral storage settings to use for tasks run with the task definition. EphemeralStorage TaskDefinitionEphemeralStoragePtrOutput `pulumi:"ephemeralStorage"` // The Amazon Resource Name (ARN) of the task execution role that grants the Amazon ECS container agent permission to make AWS API calls on your behalf. For informationabout the required IAM roles for Amazon ECS, see [IAM roles for Amazon ECS](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/security-ecs-iam-role-overview.html) in the *Amazon Elastic Container Service Developer Guide*. @@ -389,6 +390,7 @@ func NewTaskDefinition(ctx *pulumi.Context, replaceOnChanges := pulumi.ReplaceOnChanges([]string{ "containerDefinitions[*]", "cpu", + "enableFaultInjection", "ephemeralStorage", "executionRoleArn", "family", @@ -452,7 +454,8 @@ type taskDefinitionArgs struct { // This option requires Linux platform ``1.4.0`` or later. // + 16384 (16vCPU) - Available ``memory`` values: 32GB and 120 GB in 8 GB increments // This option requires Linux platform ``1.4.0`` or later. - Cpu *string `pulumi:"cpu"` + Cpu *string `pulumi:"cpu"` + EnableFaultInjection *bool `pulumi:"enableFaultInjection"` // The ephemeral storage settings to use for tasks run with the task definition. EphemeralStorage *TaskDefinitionEphemeralStorage `pulumi:"ephemeralStorage"` // The Amazon Resource Name (ARN) of the task execution role that grants the Amazon ECS container agent permission to make AWS API calls on your behalf. For informationabout the required IAM roles for Amazon ECS, see [IAM roles for Amazon ECS](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/security-ecs-iam-role-overview.html) in the *Amazon Elastic Container Service Developer Guide*. @@ -544,7 +547,8 @@ type TaskDefinitionArgs struct { // This option requires Linux platform ``1.4.0`` or later. // + 16384 (16vCPU) - Available ``memory`` values: 32GB and 120 GB in 8 GB increments // This option requires Linux platform ``1.4.0`` or later. - Cpu pulumi.StringPtrInput + Cpu pulumi.StringPtrInput + EnableFaultInjection pulumi.BoolPtrInput // The ephemeral storage settings to use for tasks run with the task definition. EphemeralStorage TaskDefinitionEphemeralStoragePtrInput // The Amazon Resource Name (ARN) of the task execution role that grants the Amazon ECS container agent permission to make AWS API calls on your behalf. For informationabout the required IAM roles for Amazon ECS, see [IAM roles for Amazon ECS](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/security-ecs-iam-role-overview.html) in the *Amazon Elastic Container Service Developer Guide*. @@ -679,6 +683,10 @@ func (o TaskDefinitionOutput) Cpu() pulumi.StringPtrOutput { return o.ApplyT(func(v *TaskDefinition) pulumi.StringPtrOutput { return v.Cpu }).(pulumi.StringPtrOutput) } +func (o TaskDefinitionOutput) EnableFaultInjection() pulumi.BoolPtrOutput { + return o.ApplyT(func(v *TaskDefinition) pulumi.BoolPtrOutput { return v.EnableFaultInjection }).(pulumi.BoolPtrOutput) +} + // The ephemeral storage settings to use for tasks run with the task definition. func (o TaskDefinitionOutput) EphemeralStorage() TaskDefinitionEphemeralStoragePtrOutput { return o.ApplyT(func(v *TaskDefinition) TaskDefinitionEphemeralStoragePtrOutput { return v.EphemeralStorage }).(TaskDefinitionEphemeralStoragePtrOutput) diff --git a/sdk/go/aws/events/pulumiTypes.go b/sdk/go/aws/events/pulumiTypes.go index cc8877a7f2..bc66a605ce 100644 --- a/sdk/go/aws/events/pulumiTypes.go +++ b/sdk/go/aws/events/pulumiTypes.go @@ -173,7 +173,10 @@ type ConnectionAuthParameters struct { // The API Key parameters to use for authorization. ApiKeyAuthParameters *ConnectionApiKeyAuthParameters `pulumi:"apiKeyAuthParameters"` // The authorization parameters for Basic authorization. - BasicAuthParameters *ConnectionBasicAuthParameters `pulumi:"basicAuthParameters"` + BasicAuthParameters *ConnectionBasicAuthParameters `pulumi:"basicAuthParameters"` + // For private OAuth authentication endpoints. The parameters EventBridge uses to authenticate against the endpoint. + // + // For more information, see [Authorization methods for connections](https://docs.aws.amazon.com/eventbridge/latest/userguide/eb-target-connection-auth.html) in the **Amazon EventBridge User Guide** . ConnectivityParameters *ConnectionConnectivityParameters `pulumi:"connectivityParameters"` // Additional parameters for the connection that are passed through with every invocation to the HTTP endpoint. InvocationHttpParameters *ConnectionHttpParameters `pulumi:"invocationHttpParameters"` @@ -196,7 +199,10 @@ type ConnectionAuthParametersArgs struct { // The API Key parameters to use for authorization. ApiKeyAuthParameters ConnectionApiKeyAuthParametersPtrInput `pulumi:"apiKeyAuthParameters"` // The authorization parameters for Basic authorization. - BasicAuthParameters ConnectionBasicAuthParametersPtrInput `pulumi:"basicAuthParameters"` + BasicAuthParameters ConnectionBasicAuthParametersPtrInput `pulumi:"basicAuthParameters"` + // For private OAuth authentication endpoints. The parameters EventBridge uses to authenticate against the endpoint. + // + // For more information, see [Authorization methods for connections](https://docs.aws.amazon.com/eventbridge/latest/userguide/eb-target-connection-auth.html) in the **Amazon EventBridge User Guide** . ConnectivityParameters ConnectionConnectivityParametersPtrInput `pulumi:"connectivityParameters"` // Additional parameters for the connection that are passed through with every invocation to the HTTP endpoint. InvocationHttpParameters ConnectionHttpParametersPtrInput `pulumi:"invocationHttpParameters"` @@ -291,6 +297,9 @@ func (o ConnectionAuthParametersOutput) BasicAuthParameters() ConnectionBasicAut return o.ApplyT(func(v ConnectionAuthParameters) *ConnectionBasicAuthParameters { return v.BasicAuthParameters }).(ConnectionBasicAuthParametersPtrOutput) } +// For private OAuth authentication endpoints. The parameters EventBridge uses to authenticate against the endpoint. +// +// For more information, see [Authorization methods for connections](https://docs.aws.amazon.com/eventbridge/latest/userguide/eb-target-connection-auth.html) in the **Amazon EventBridge User Guide** . func (o ConnectionAuthParametersOutput) ConnectivityParameters() ConnectionConnectivityParametersPtrOutput { return o.ApplyT(func(v ConnectionAuthParameters) *ConnectionConnectivityParameters { return v.ConnectivityParameters }).(ConnectionConnectivityParametersPtrOutput) } @@ -349,6 +358,9 @@ func (o ConnectionAuthParametersPtrOutput) BasicAuthParameters() ConnectionBasic }).(ConnectionBasicAuthParametersPtrOutput) } +// For private OAuth authentication endpoints. The parameters EventBridge uses to authenticate against the endpoint. +// +// For more information, see [Authorization methods for connections](https://docs.aws.amazon.com/eventbridge/latest/userguide/eb-target-connection-auth.html) in the **Amazon EventBridge User Guide** . func (o ConnectionAuthParametersPtrOutput) ConnectivityParameters() ConnectionConnectivityParametersPtrOutput { return o.ApplyT(func(v *ConnectionAuthParameters) *ConnectionConnectivityParameters { if v == nil { @@ -691,6 +703,7 @@ func (o ConnectionClientParametersPtrOutput) ClientSecret() pulumi.StringPtrOutp } type ConnectionConnectivityParameters struct { + // The parameters for EventBridge to use when invoking the resource endpoint. ResourceParameters ConnectionResourceParameters `pulumi:"resourceParameters"` } @@ -706,6 +719,7 @@ type ConnectionConnectivityParametersInput interface { } type ConnectionConnectivityParametersArgs struct { + // The parameters for EventBridge to use when invoking the resource endpoint. ResourceParameters ConnectionResourceParametersInput `pulumi:"resourceParameters"` } @@ -786,6 +800,7 @@ func (o ConnectionConnectivityParametersOutput) ToConnectionConnectivityParamete }).(ConnectionConnectivityParametersPtrOutput) } +// The parameters for EventBridge to use when invoking the resource endpoint. func (o ConnectionConnectivityParametersOutput) ResourceParameters() ConnectionResourceParametersOutput { return o.ApplyT(func(v ConnectionConnectivityParameters) ConnectionResourceParameters { return v.ResourceParameters }).(ConnectionResourceParametersOutput) } @@ -814,6 +829,7 @@ func (o ConnectionConnectivityParametersPtrOutput) Elem() ConnectionConnectivity }).(ConnectionConnectivityParametersOutput) } +// The parameters for EventBridge to use when invoking the resource endpoint. func (o ConnectionConnectivityParametersPtrOutput) ResourceParameters() ConnectionResourceParametersPtrOutput { return o.ApplyT(func(v *ConnectionConnectivityParameters) *ConnectionResourceParameters { if v == nil { @@ -1308,8 +1324,12 @@ func (o ConnectionParameterArrayOutput) Index(i pulumi.IntInput) ConnectionParam } type ConnectionResourceParameters struct { - ResourceAssociationArn *string `pulumi:"resourceAssociationArn"` - ResourceConfigurationArn string `pulumi:"resourceConfigurationArn"` + // For connections to private APIs, the Amazon Resource Name (ARN) of the resource association EventBridge created between the connection and the private API's resource configuration. + // + // > The value of this property is set by EventBridge . Any value you specify in your template is ignored. + ResourceAssociationArn *string `pulumi:"resourceAssociationArn"` + // The Amazon Resource Name (ARN) of the Amazon VPC Lattice resource configuration for the resource endpoint. + ResourceConfigurationArn string `pulumi:"resourceConfigurationArn"` } // ConnectionResourceParametersInput is an input type that accepts ConnectionResourceParametersArgs and ConnectionResourceParametersOutput values. @@ -1324,8 +1344,12 @@ type ConnectionResourceParametersInput interface { } type ConnectionResourceParametersArgs struct { - ResourceAssociationArn pulumi.StringPtrInput `pulumi:"resourceAssociationArn"` - ResourceConfigurationArn pulumi.StringInput `pulumi:"resourceConfigurationArn"` + // For connections to private APIs, the Amazon Resource Name (ARN) of the resource association EventBridge created between the connection and the private API's resource configuration. + // + // > The value of this property is set by EventBridge . Any value you specify in your template is ignored. + ResourceAssociationArn pulumi.StringPtrInput `pulumi:"resourceAssociationArn"` + // The Amazon Resource Name (ARN) of the Amazon VPC Lattice resource configuration for the resource endpoint. + ResourceConfigurationArn pulumi.StringInput `pulumi:"resourceConfigurationArn"` } func (ConnectionResourceParametersArgs) ElementType() reflect.Type { @@ -1405,10 +1429,14 @@ func (o ConnectionResourceParametersOutput) ToConnectionResourceParametersPtrOut }).(ConnectionResourceParametersPtrOutput) } +// For connections to private APIs, the Amazon Resource Name (ARN) of the resource association EventBridge created between the connection and the private API's resource configuration. +// +// > The value of this property is set by EventBridge . Any value you specify in your template is ignored. func (o ConnectionResourceParametersOutput) ResourceAssociationArn() pulumi.StringPtrOutput { return o.ApplyT(func(v ConnectionResourceParameters) *string { return v.ResourceAssociationArn }).(pulumi.StringPtrOutput) } +// The Amazon Resource Name (ARN) of the Amazon VPC Lattice resource configuration for the resource endpoint. func (o ConnectionResourceParametersOutput) ResourceConfigurationArn() pulumi.StringOutput { return o.ApplyT(func(v ConnectionResourceParameters) string { return v.ResourceConfigurationArn }).(pulumi.StringOutput) } @@ -1437,6 +1465,9 @@ func (o ConnectionResourceParametersPtrOutput) Elem() ConnectionResourceParamete }).(ConnectionResourceParametersOutput) } +// For connections to private APIs, the Amazon Resource Name (ARN) of the resource association EventBridge created between the connection and the private API's resource configuration. +// +// > The value of this property is set by EventBridge . Any value you specify in your template is ignored. func (o ConnectionResourceParametersPtrOutput) ResourceAssociationArn() pulumi.StringPtrOutput { return o.ApplyT(func(v *ConnectionResourceParameters) *string { if v == nil { @@ -1446,6 +1477,7 @@ func (o ConnectionResourceParametersPtrOutput) ResourceAssociationArn() pulumi.S }).(pulumi.StringPtrOutput) } +// The Amazon Resource Name (ARN) of the Amazon VPC Lattice resource configuration for the resource endpoint. func (o ConnectionResourceParametersPtrOutput) ResourceConfigurationArn() pulumi.StringPtrOutput { return o.ApplyT(func(v *ConnectionResourceParameters) *string { if v == nil { @@ -2198,6 +2230,7 @@ type EventBusTag struct { // The private resource the HTTP request will be sent to. type InvocationConnectivityParametersProperties struct { + // The parameters for EventBridge to use when invoking the resource endpoint. ResourceParameters ConnectionResourceParameters `pulumi:"resourceParameters"` } @@ -2214,6 +2247,7 @@ type InvocationConnectivityParametersPropertiesInput interface { // The private resource the HTTP request will be sent to. type InvocationConnectivityParametersPropertiesArgs struct { + // The parameters for EventBridge to use when invoking the resource endpoint. ResourceParameters ConnectionResourceParametersInput `pulumi:"resourceParameters"` } @@ -2295,6 +2329,7 @@ func (o InvocationConnectivityParametersPropertiesOutput) ToInvocationConnectivi }).(InvocationConnectivityParametersPropertiesPtrOutput) } +// The parameters for EventBridge to use when invoking the resource endpoint. func (o InvocationConnectivityParametersPropertiesOutput) ResourceParameters() ConnectionResourceParametersOutput { return o.ApplyT(func(v InvocationConnectivityParametersProperties) ConnectionResourceParameters { return v.ResourceParameters @@ -2325,6 +2360,7 @@ func (o InvocationConnectivityParametersPropertiesPtrOutput) Elem() InvocationCo }).(InvocationConnectivityParametersPropertiesOutput) } +// The parameters for EventBridge to use when invoking the resource endpoint. func (o InvocationConnectivityParametersPropertiesPtrOutput) ResourceParameters() ConnectionResourceParametersPtrOutput { return o.ApplyT(func(v *InvocationConnectivityParametersProperties) *ConnectionResourceParameters { if v == nil { diff --git a/sdk/go/aws/internetmonitor/getMonitor.go b/sdk/go/aws/internetmonitor/getMonitor.go index c9b843573a..cdd73b2fae 100644 --- a/sdk/go/aws/internetmonitor/getMonitor.go +++ b/sdk/go/aws/internetmonitor/getMonitor.go @@ -33,7 +33,7 @@ type LookupMonitorResult struct { CreatedAt *string `pulumi:"createdAt"` // A complex type with the configuration information that determines the threshold and other conditions for when Internet Monitor creates a health event for an overall performance or availability issue, across an application's geographies. // - // Defines the percentages, for overall performance scores and availability scores for an application, that are the thresholds for when Amazon CloudWatch Internet Monitor creates a health event. You can override the defaults to set a custom threshold for overall performance or availability scores, or both. + // Defines the percentages, for overall performance scores and availability scores for an application, that are the thresholds for when Internet Monitor creates a health event. You can override the defaults to set a custom threshold for overall performance or availability scores, or both. // // You can also set thresholds for local health scores,, where Internet Monitor creates a health event when scores cross a threshold for one or more city-networks, in addition to creating an event when an overall score crosses a threshold. // @@ -118,7 +118,7 @@ func (o LookupMonitorResultOutput) CreatedAt() pulumi.StringPtrOutput { // A complex type with the configuration information that determines the threshold and other conditions for when Internet Monitor creates a health event for an overall performance or availability issue, across an application's geographies. // -// Defines the percentages, for overall performance scores and availability scores for an application, that are the thresholds for when Amazon CloudWatch Internet Monitor creates a health event. You can override the defaults to set a custom threshold for overall performance or availability scores, or both. +// Defines the percentages, for overall performance scores and availability scores for an application, that are the thresholds for when Internet Monitor creates a health event. You can override the defaults to set a custom threshold for overall performance or availability scores, or both. // // You can also set thresholds for local health scores,, where Internet Monitor creates a health event when scores cross a threshold for one or more city-networks, in addition to creating an event when an overall score crosses a threshold. // diff --git a/sdk/go/aws/internetmonitor/monitor.go b/sdk/go/aws/internetmonitor/monitor.go index 2a1efc2e0c..836327999a 100644 --- a/sdk/go/aws/internetmonitor/monitor.go +++ b/sdk/go/aws/internetmonitor/monitor.go @@ -20,7 +20,7 @@ type Monitor struct { CreatedAt pulumi.StringOutput `pulumi:"createdAt"` // A complex type with the configuration information that determines the threshold and other conditions for when Internet Monitor creates a health event for an overall performance or availability issue, across an application's geographies. // - // Defines the percentages, for overall performance scores and availability scores for an application, that are the thresholds for when Amazon CloudWatch Internet Monitor creates a health event. You can override the defaults to set a custom threshold for overall performance or availability scores, or both. + // Defines the percentages, for overall performance scores and availability scores for an application, that are the thresholds for when Internet Monitor creates a health event. You can override the defaults to set a custom threshold for overall performance or availability scores, or both. // // You can also set thresholds for local health scores,, where Internet Monitor creates a health event when scores cross a threshold for one or more city-networks, in addition to creating an event when an overall score crosses a threshold. // @@ -120,7 +120,7 @@ func (MonitorState) ElementType() reflect.Type { type monitorArgs struct { // A complex type with the configuration information that determines the threshold and other conditions for when Internet Monitor creates a health event for an overall performance or availability issue, across an application's geographies. // - // Defines the percentages, for overall performance scores and availability scores for an application, that are the thresholds for when Amazon CloudWatch Internet Monitor creates a health event. You can override the defaults to set a custom threshold for overall performance or availability scores, or both. + // Defines the percentages, for overall performance scores and availability scores for an application, that are the thresholds for when Internet Monitor creates a health event. You can override the defaults to set a custom threshold for overall performance or availability scores, or both. // // You can also set thresholds for local health scores,, where Internet Monitor creates a health event when scores cross a threshold for one or more city-networks, in addition to creating an event when an overall score crosses a threshold. // @@ -170,7 +170,7 @@ type monitorArgs struct { type MonitorArgs struct { // A complex type with the configuration information that determines the threshold and other conditions for when Internet Monitor creates a health event for an overall performance or availability issue, across an application's geographies. // - // Defines the percentages, for overall performance scores and availability scores for an application, that are the thresholds for when Amazon CloudWatch Internet Monitor creates a health event. You can override the defaults to set a custom threshold for overall performance or availability scores, or both. + // Defines the percentages, for overall performance scores and availability scores for an application, that are the thresholds for when Internet Monitor creates a health event. You can override the defaults to set a custom threshold for overall performance or availability scores, or both. // // You can also set thresholds for local health scores,, where Internet Monitor creates a health event when scores cross a threshold for one or more city-networks, in addition to creating an event when an overall score crosses a threshold. // @@ -260,7 +260,7 @@ func (o MonitorOutput) CreatedAt() pulumi.StringOutput { // A complex type with the configuration information that determines the threshold and other conditions for when Internet Monitor creates a health event for an overall performance or availability issue, across an application's geographies. // -// Defines the percentages, for overall performance scores and availability scores for an application, that are the thresholds for when Amazon CloudWatch Internet Monitor creates a health event. You can override the defaults to set a custom threshold for overall performance or availability scores, or both. +// Defines the percentages, for overall performance scores and availability scores for an application, that are the thresholds for when Internet Monitor creates a health event. You can override the defaults to set a custom threshold for overall performance or availability scores, or both. // // You can also set thresholds for local health scores,, where Internet Monitor creates a health event when scores cross a threshold for one or more city-networks, in addition to creating an event when an overall score crosses a threshold. // diff --git a/sdk/go/aws/invoicing/getInvoiceUnit.go b/sdk/go/aws/invoicing/getInvoiceUnit.go index 2064599ac3..9b8246f7ee 100644 --- a/sdk/go/aws/invoicing/getInvoiceUnit.go +++ b/sdk/go/aws/invoicing/getInvoiceUnit.go @@ -24,16 +24,23 @@ func LookupInvoiceUnit(ctx *pulumi.Context, args *LookupInvoiceUnitArgs, opts .. } type LookupInvoiceUnitArgs struct { + // The ARN to identify an invoice unit. This information can't be modified or deleted. InvoiceUnitArn string `pulumi:"invoiceUnitArn"` } type LookupInvoiceUnitResult struct { - Description *string `pulumi:"description"` - InvoiceUnitArn *string `pulumi:"invoiceUnitArn"` - LastModified *float64 `pulumi:"lastModified"` - ResourceTags []aws.Tag `pulumi:"resourceTags"` - Rule *InvoiceUnitRule `pulumi:"rule"` - TaxInheritanceDisabled *bool `pulumi:"taxInheritanceDisabled"` + // The assigned description for an invoice unit. This information can't be modified or deleted. + Description *string `pulumi:"description"` + // The ARN to identify an invoice unit. This information can't be modified or deleted. + InvoiceUnitArn *string `pulumi:"invoiceUnitArn"` + // The last time the invoice unit was updated. This is important to determine the version of invoice unit configuration used to create the invoices. Any invoice created after this modified time will use this invoice unit configuration. + LastModified *float64 `pulumi:"lastModified"` + // The tag structure that contains a tag key and value. + ResourceTags []aws.Tag `pulumi:"resourceTags"` + // An `InvoiceUnitRule` object used the categorize invoice units. + Rule *InvoiceUnitRule `pulumi:"rule"` + // Whether the invoice unit based tax inheritance is/ should be enabled or disabled. + TaxInheritanceDisabled *bool `pulumi:"taxInheritanceDisabled"` } func LookupInvoiceUnitOutput(ctx *pulumi.Context, args LookupInvoiceUnitOutputArgs, opts ...pulumi.InvokeOption) LookupInvoiceUnitResultOutput { @@ -56,6 +63,7 @@ func LookupInvoiceUnitOutput(ctx *pulumi.Context, args LookupInvoiceUnitOutputAr } type LookupInvoiceUnitOutputArgs struct { + // The ARN to identify an invoice unit. This information can't be modified or deleted. InvoiceUnitArn pulumi.StringInput `pulumi:"invoiceUnitArn"` } @@ -77,26 +85,32 @@ func (o LookupInvoiceUnitResultOutput) ToLookupInvoiceUnitResultOutputWithContex return o } +// The assigned description for an invoice unit. This information can't be modified or deleted. func (o LookupInvoiceUnitResultOutput) Description() pulumi.StringPtrOutput { return o.ApplyT(func(v LookupInvoiceUnitResult) *string { return v.Description }).(pulumi.StringPtrOutput) } +// The ARN to identify an invoice unit. This information can't be modified or deleted. func (o LookupInvoiceUnitResultOutput) InvoiceUnitArn() pulumi.StringPtrOutput { return o.ApplyT(func(v LookupInvoiceUnitResult) *string { return v.InvoiceUnitArn }).(pulumi.StringPtrOutput) } +// The last time the invoice unit was updated. This is important to determine the version of invoice unit configuration used to create the invoices. Any invoice created after this modified time will use this invoice unit configuration. func (o LookupInvoiceUnitResultOutput) LastModified() pulumi.Float64PtrOutput { return o.ApplyT(func(v LookupInvoiceUnitResult) *float64 { return v.LastModified }).(pulumi.Float64PtrOutput) } +// The tag structure that contains a tag key and value. func (o LookupInvoiceUnitResultOutput) ResourceTags() aws.TagArrayOutput { return o.ApplyT(func(v LookupInvoiceUnitResult) []aws.Tag { return v.ResourceTags }).(aws.TagArrayOutput) } +// An `InvoiceUnitRule` object used the categorize invoice units. func (o LookupInvoiceUnitResultOutput) Rule() InvoiceUnitRulePtrOutput { return o.ApplyT(func(v LookupInvoiceUnitResult) *InvoiceUnitRule { return v.Rule }).(InvoiceUnitRulePtrOutput) } +// Whether the invoice unit based tax inheritance is/ should be enabled or disabled. func (o LookupInvoiceUnitResultOutput) TaxInheritanceDisabled() pulumi.BoolPtrOutput { return o.ApplyT(func(v LookupInvoiceUnitResult) *bool { return v.TaxInheritanceDisabled }).(pulumi.BoolPtrOutput) } diff --git a/sdk/go/aws/invoicing/invoiceUnit.go b/sdk/go/aws/invoicing/invoiceUnit.go index a677e1f30c..a15d8230b5 100644 --- a/sdk/go/aws/invoicing/invoiceUnit.go +++ b/sdk/go/aws/invoicing/invoiceUnit.go @@ -17,14 +17,22 @@ import ( type InvoiceUnit struct { pulumi.CustomResourceState - Description pulumi.StringPtrOutput `pulumi:"description"` - InvoiceReceiver pulumi.StringOutput `pulumi:"invoiceReceiver"` - InvoiceUnitArn pulumi.StringOutput `pulumi:"invoiceUnitArn"` - LastModified pulumi.Float64Output `pulumi:"lastModified"` - Name pulumi.StringOutput `pulumi:"name"` - ResourceTags aws.TagArrayOutput `pulumi:"resourceTags"` - Rule InvoiceUnitRuleOutput `pulumi:"rule"` - TaxInheritanceDisabled pulumi.BoolPtrOutput `pulumi:"taxInheritanceDisabled"` + // The assigned description for an invoice unit. This information can't be modified or deleted. + Description pulumi.StringPtrOutput `pulumi:"description"` + // The account that receives invoices related to the invoice unit. + InvoiceReceiver pulumi.StringOutput `pulumi:"invoiceReceiver"` + // The ARN to identify an invoice unit. This information can't be modified or deleted. + InvoiceUnitArn pulumi.StringOutput `pulumi:"invoiceUnitArn"` + // The last time the invoice unit was updated. This is important to determine the version of invoice unit configuration used to create the invoices. Any invoice created after this modified time will use this invoice unit configuration. + LastModified pulumi.Float64Output `pulumi:"lastModified"` + // A unique name that is distinctive within your AWS . + Name pulumi.StringOutput `pulumi:"name"` + // The tag structure that contains a tag key and value. + ResourceTags aws.TagArrayOutput `pulumi:"resourceTags"` + // An `InvoiceUnitRule` object used the categorize invoice units. + Rule InvoiceUnitRuleOutput `pulumi:"rule"` + // Whether the invoice unit based tax inheritance is/ should be enabled or disabled. + TaxInheritanceDisabled pulumi.BoolPtrOutput `pulumi:"taxInheritanceDisabled"` } // NewInvoiceUnit registers a new resource with the given unique name, arguments, and options. @@ -78,21 +86,33 @@ func (InvoiceUnitState) ElementType() reflect.Type { } type invoiceUnitArgs struct { - Description *string `pulumi:"description"` - InvoiceReceiver string `pulumi:"invoiceReceiver"` - Name *string `pulumi:"name"` - ResourceTags []aws.Tag `pulumi:"resourceTags"` - Rule InvoiceUnitRule `pulumi:"rule"` - TaxInheritanceDisabled *bool `pulumi:"taxInheritanceDisabled"` + // The assigned description for an invoice unit. This information can't be modified or deleted. + Description *string `pulumi:"description"` + // The account that receives invoices related to the invoice unit. + InvoiceReceiver string `pulumi:"invoiceReceiver"` + // A unique name that is distinctive within your AWS . + Name *string `pulumi:"name"` + // The tag structure that contains a tag key and value. + ResourceTags []aws.Tag `pulumi:"resourceTags"` + // An `InvoiceUnitRule` object used the categorize invoice units. + Rule InvoiceUnitRule `pulumi:"rule"` + // Whether the invoice unit based tax inheritance is/ should be enabled or disabled. + TaxInheritanceDisabled *bool `pulumi:"taxInheritanceDisabled"` } // The set of arguments for constructing a InvoiceUnit resource. type InvoiceUnitArgs struct { - Description pulumi.StringPtrInput - InvoiceReceiver pulumi.StringInput - Name pulumi.StringPtrInput - ResourceTags aws.TagArrayInput - Rule InvoiceUnitRuleInput + // The assigned description for an invoice unit. This information can't be modified or deleted. + Description pulumi.StringPtrInput + // The account that receives invoices related to the invoice unit. + InvoiceReceiver pulumi.StringInput + // A unique name that is distinctive within your AWS . + Name pulumi.StringPtrInput + // The tag structure that contains a tag key and value. + ResourceTags aws.TagArrayInput + // An `InvoiceUnitRule` object used the categorize invoice units. + Rule InvoiceUnitRuleInput + // Whether the invoice unit based tax inheritance is/ should be enabled or disabled. TaxInheritanceDisabled pulumi.BoolPtrInput } @@ -133,34 +153,42 @@ func (o InvoiceUnitOutput) ToInvoiceUnitOutputWithContext(ctx context.Context) I return o } +// The assigned description for an invoice unit. This information can't be modified or deleted. func (o InvoiceUnitOutput) Description() pulumi.StringPtrOutput { return o.ApplyT(func(v *InvoiceUnit) pulumi.StringPtrOutput { return v.Description }).(pulumi.StringPtrOutput) } +// The account that receives invoices related to the invoice unit. func (o InvoiceUnitOutput) InvoiceReceiver() pulumi.StringOutput { return o.ApplyT(func(v *InvoiceUnit) pulumi.StringOutput { return v.InvoiceReceiver }).(pulumi.StringOutput) } +// The ARN to identify an invoice unit. This information can't be modified or deleted. func (o InvoiceUnitOutput) InvoiceUnitArn() pulumi.StringOutput { return o.ApplyT(func(v *InvoiceUnit) pulumi.StringOutput { return v.InvoiceUnitArn }).(pulumi.StringOutput) } +// The last time the invoice unit was updated. This is important to determine the version of invoice unit configuration used to create the invoices. Any invoice created after this modified time will use this invoice unit configuration. func (o InvoiceUnitOutput) LastModified() pulumi.Float64Output { return o.ApplyT(func(v *InvoiceUnit) pulumi.Float64Output { return v.LastModified }).(pulumi.Float64Output) } +// A unique name that is distinctive within your AWS . func (o InvoiceUnitOutput) Name() pulumi.StringOutput { return o.ApplyT(func(v *InvoiceUnit) pulumi.StringOutput { return v.Name }).(pulumi.StringOutput) } +// The tag structure that contains a tag key and value. func (o InvoiceUnitOutput) ResourceTags() aws.TagArrayOutput { return o.ApplyT(func(v *InvoiceUnit) aws.TagArrayOutput { return v.ResourceTags }).(aws.TagArrayOutput) } +// An `InvoiceUnitRule` object used the categorize invoice units. func (o InvoiceUnitOutput) Rule() InvoiceUnitRuleOutput { return o.ApplyT(func(v *InvoiceUnit) InvoiceUnitRuleOutput { return v.Rule }).(InvoiceUnitRuleOutput) } +// Whether the invoice unit based tax inheritance is/ should be enabled or disabled. func (o InvoiceUnitOutput) TaxInheritanceDisabled() pulumi.BoolPtrOutput { return o.ApplyT(func(v *InvoiceUnit) pulumi.BoolPtrOutput { return v.TaxInheritanceDisabled }).(pulumi.BoolPtrOutput) } diff --git a/sdk/go/aws/invoicing/pulumiTypes.go b/sdk/go/aws/invoicing/pulumiTypes.go index 6c94211112..834d6fe82c 100644 --- a/sdk/go/aws/invoicing/pulumiTypes.go +++ b/sdk/go/aws/invoicing/pulumiTypes.go @@ -19,6 +19,7 @@ type InvoiceUnitResourceTag struct { } type InvoiceUnitRule struct { + // The list of `LINKED_ACCOUNT` IDs where charges are included within the invoice unit. LinkedAccounts []string `pulumi:"linkedAccounts"` } @@ -34,6 +35,7 @@ type InvoiceUnitRuleInput interface { } type InvoiceUnitRuleArgs struct { + // The list of `LINKED_ACCOUNT` IDs where charges are included within the invoice unit. LinkedAccounts pulumi.StringArrayInput `pulumi:"linkedAccounts"` } @@ -63,6 +65,7 @@ func (o InvoiceUnitRuleOutput) ToInvoiceUnitRuleOutputWithContext(ctx context.Co return o } +// The list of `LINKED_ACCOUNT` IDs where charges are included within the invoice unit. func (o InvoiceUnitRuleOutput) LinkedAccounts() pulumi.StringArrayOutput { return o.ApplyT(func(v InvoiceUnitRule) []string { return v.LinkedAccounts }).(pulumi.StringArrayOutput) } @@ -91,6 +94,7 @@ func (o InvoiceUnitRulePtrOutput) Elem() InvoiceUnitRuleOutput { }).(InvoiceUnitRuleOutput) } +// The list of `LINKED_ACCOUNT` IDs where charges are included within the invoice unit. func (o InvoiceUnitRulePtrOutput) LinkedAccounts() pulumi.StringArrayOutput { return o.ApplyT(func(v *InvoiceUnitRule) []string { if v == nil { diff --git a/sdk/go/aws/iot/command.go b/sdk/go/aws/iot/command.go new file mode 100644 index 0000000000..95c726020c --- /dev/null +++ b/sdk/go/aws/iot/command.go @@ -0,0 +1,254 @@ +// Code generated by pulumi-language-go DO NOT EDIT. +// *** WARNING: Do not edit by hand unless you're certain you know what you are doing! *** + +package iot + +import ( + "context" + "reflect" + + "errors" + "github.com/pulumi/pulumi-aws-native/sdk/go/aws" + "github.com/pulumi/pulumi-aws-native/sdk/go/aws/internal" + "github.com/pulumi/pulumi/sdk/v3/go/pulumi" +) + +// Represents the resource definition of AWS IoT Command. +type Command struct { + pulumi.CustomResourceState + + // The Amazon Resource Name (ARN) of the command. + CommandArn pulumi.StringOutput `pulumi:"commandArn"` + // The unique identifier for the command. + CommandId pulumi.StringOutput `pulumi:"commandId"` + // The date and time when the command was created. + CreatedAt pulumi.StringPtrOutput `pulumi:"createdAt"` + // A flag indicating whether the command is deprecated. + Deprecated pulumi.BoolPtrOutput `pulumi:"deprecated"` + // The description of the command. + Description pulumi.StringPtrOutput `pulumi:"description"` + // The display name for the command. + DisplayName pulumi.StringPtrOutput `pulumi:"displayName"` + // The date and time when the command was last updated. + LastUpdatedAt pulumi.StringPtrOutput `pulumi:"lastUpdatedAt"` + // The list of mandatory parameters for the command. + MandatoryParameters CommandParameterArrayOutput `pulumi:"mandatoryParameters"` + // The namespace to which the command belongs. + Namespace CommandNamespacePtrOutput `pulumi:"namespace"` + // The payload associated with the command. + Payload CommandPayloadPtrOutput `pulumi:"payload"` + // A flag indicating whether the command is pending deletion. + PendingDeletion pulumi.BoolPtrOutput `pulumi:"pendingDeletion"` + // The customer role associated with the command. + RoleArn pulumi.StringPtrOutput `pulumi:"roleArn"` + // The tags to be associated with the command. + Tags aws.TagArrayOutput `pulumi:"tags"` +} + +// NewCommand registers a new resource with the given unique name, arguments, and options. +func NewCommand(ctx *pulumi.Context, + name string, args *CommandArgs, opts ...pulumi.ResourceOption) (*Command, error) { + if args == nil { + return nil, errors.New("missing one or more required arguments") + } + + if args.CommandId == nil { + return nil, errors.New("invalid value for required argument 'CommandId'") + } + replaceOnChanges := pulumi.ReplaceOnChanges([]string{ + "commandId", + }) + opts = append(opts, replaceOnChanges) + opts = internal.PkgResourceDefaultOpts(opts) + var resource Command + err := ctx.RegisterResource("aws-native:iot:Command", name, args, &resource, opts...) + if err != nil { + return nil, err + } + return &resource, nil +} + +// GetCommand gets an existing Command resource's state with the given name, ID, and optional +// state properties that are used to uniquely qualify the lookup (nil if not required). +func GetCommand(ctx *pulumi.Context, + name string, id pulumi.IDInput, state *CommandState, opts ...pulumi.ResourceOption) (*Command, error) { + var resource Command + err := ctx.ReadResource("aws-native:iot:Command", name, id, state, &resource, opts...) + if err != nil { + return nil, err + } + return &resource, nil +} + +// Input properties used for looking up and filtering Command resources. +type commandState struct { +} + +type CommandState struct { +} + +func (CommandState) ElementType() reflect.Type { + return reflect.TypeOf((*commandState)(nil)).Elem() +} + +type commandArgs struct { + // The unique identifier for the command. + CommandId string `pulumi:"commandId"` + // The date and time when the command was created. + CreatedAt *string `pulumi:"createdAt"` + // A flag indicating whether the command is deprecated. + Deprecated *bool `pulumi:"deprecated"` + // The description of the command. + Description *string `pulumi:"description"` + // The display name for the command. + DisplayName *string `pulumi:"displayName"` + // The date and time when the command was last updated. + LastUpdatedAt *string `pulumi:"lastUpdatedAt"` + // The list of mandatory parameters for the command. + MandatoryParameters []CommandParameter `pulumi:"mandatoryParameters"` + // The namespace to which the command belongs. + Namespace *CommandNamespace `pulumi:"namespace"` + // The payload associated with the command. + Payload *CommandPayload `pulumi:"payload"` + // A flag indicating whether the command is pending deletion. + PendingDeletion *bool `pulumi:"pendingDeletion"` + // The customer role associated with the command. + RoleArn *string `pulumi:"roleArn"` + // The tags to be associated with the command. + Tags []aws.Tag `pulumi:"tags"` +} + +// The set of arguments for constructing a Command resource. +type CommandArgs struct { + // The unique identifier for the command. + CommandId pulumi.StringInput + // The date and time when the command was created. + CreatedAt pulumi.StringPtrInput + // A flag indicating whether the command is deprecated. + Deprecated pulumi.BoolPtrInput + // The description of the command. + Description pulumi.StringPtrInput + // The display name for the command. + DisplayName pulumi.StringPtrInput + // The date and time when the command was last updated. + LastUpdatedAt pulumi.StringPtrInput + // The list of mandatory parameters for the command. + MandatoryParameters CommandParameterArrayInput + // The namespace to which the command belongs. + Namespace CommandNamespacePtrInput + // The payload associated with the command. + Payload CommandPayloadPtrInput + // A flag indicating whether the command is pending deletion. + PendingDeletion pulumi.BoolPtrInput + // The customer role associated with the command. + RoleArn pulumi.StringPtrInput + // The tags to be associated with the command. + Tags aws.TagArrayInput +} + +func (CommandArgs) ElementType() reflect.Type { + return reflect.TypeOf((*commandArgs)(nil)).Elem() +} + +type CommandInput interface { + pulumi.Input + + ToCommandOutput() CommandOutput + ToCommandOutputWithContext(ctx context.Context) CommandOutput +} + +func (*Command) ElementType() reflect.Type { + return reflect.TypeOf((**Command)(nil)).Elem() +} + +func (i *Command) ToCommandOutput() CommandOutput { + return i.ToCommandOutputWithContext(context.Background()) +} + +func (i *Command) ToCommandOutputWithContext(ctx context.Context) CommandOutput { + return pulumi.ToOutputWithContext(ctx, i).(CommandOutput) +} + +type CommandOutput struct{ *pulumi.OutputState } + +func (CommandOutput) ElementType() reflect.Type { + return reflect.TypeOf((**Command)(nil)).Elem() +} + +func (o CommandOutput) ToCommandOutput() CommandOutput { + return o +} + +func (o CommandOutput) ToCommandOutputWithContext(ctx context.Context) CommandOutput { + return o +} + +// The Amazon Resource Name (ARN) of the command. +func (o CommandOutput) CommandArn() pulumi.StringOutput { + return o.ApplyT(func(v *Command) pulumi.StringOutput { return v.CommandArn }).(pulumi.StringOutput) +} + +// The unique identifier for the command. +func (o CommandOutput) CommandId() pulumi.StringOutput { + return o.ApplyT(func(v *Command) pulumi.StringOutput { return v.CommandId }).(pulumi.StringOutput) +} + +// The date and time when the command was created. +func (o CommandOutput) CreatedAt() pulumi.StringPtrOutput { + return o.ApplyT(func(v *Command) pulumi.StringPtrOutput { return v.CreatedAt }).(pulumi.StringPtrOutput) +} + +// A flag indicating whether the command is deprecated. +func (o CommandOutput) Deprecated() pulumi.BoolPtrOutput { + return o.ApplyT(func(v *Command) pulumi.BoolPtrOutput { return v.Deprecated }).(pulumi.BoolPtrOutput) +} + +// The description of the command. +func (o CommandOutput) Description() pulumi.StringPtrOutput { + return o.ApplyT(func(v *Command) pulumi.StringPtrOutput { return v.Description }).(pulumi.StringPtrOutput) +} + +// The display name for the command. +func (o CommandOutput) DisplayName() pulumi.StringPtrOutput { + return o.ApplyT(func(v *Command) pulumi.StringPtrOutput { return v.DisplayName }).(pulumi.StringPtrOutput) +} + +// The date and time when the command was last updated. +func (o CommandOutput) LastUpdatedAt() pulumi.StringPtrOutput { + return o.ApplyT(func(v *Command) pulumi.StringPtrOutput { return v.LastUpdatedAt }).(pulumi.StringPtrOutput) +} + +// The list of mandatory parameters for the command. +func (o CommandOutput) MandatoryParameters() CommandParameterArrayOutput { + return o.ApplyT(func(v *Command) CommandParameterArrayOutput { return v.MandatoryParameters }).(CommandParameterArrayOutput) +} + +// The namespace to which the command belongs. +func (o CommandOutput) Namespace() CommandNamespacePtrOutput { + return o.ApplyT(func(v *Command) CommandNamespacePtrOutput { return v.Namespace }).(CommandNamespacePtrOutput) +} + +// The payload associated with the command. +func (o CommandOutput) Payload() CommandPayloadPtrOutput { + return o.ApplyT(func(v *Command) CommandPayloadPtrOutput { return v.Payload }).(CommandPayloadPtrOutput) +} + +// A flag indicating whether the command is pending deletion. +func (o CommandOutput) PendingDeletion() pulumi.BoolPtrOutput { + return o.ApplyT(func(v *Command) pulumi.BoolPtrOutput { return v.PendingDeletion }).(pulumi.BoolPtrOutput) +} + +// The customer role associated with the command. +func (o CommandOutput) RoleArn() pulumi.StringPtrOutput { + return o.ApplyT(func(v *Command) pulumi.StringPtrOutput { return v.RoleArn }).(pulumi.StringPtrOutput) +} + +// The tags to be associated with the command. +func (o CommandOutput) Tags() aws.TagArrayOutput { + return o.ApplyT(func(v *Command) aws.TagArrayOutput { return v.Tags }).(aws.TagArrayOutput) +} + +func init() { + pulumi.RegisterInputType(reflect.TypeOf((*CommandInput)(nil)).Elem(), &Command{}) + pulumi.RegisterOutputType(CommandOutput{}) +} diff --git a/sdk/go/aws/iot/getCommand.go b/sdk/go/aws/iot/getCommand.go new file mode 100644 index 0000000000..1db3f6bc10 --- /dev/null +++ b/sdk/go/aws/iot/getCommand.go @@ -0,0 +1,155 @@ +// Code generated by pulumi-language-go DO NOT EDIT. +// *** WARNING: Do not edit by hand unless you're certain you know what you are doing! *** + +package iot + +import ( + "context" + "reflect" + + "github.com/pulumi/pulumi-aws-native/sdk/go/aws" + "github.com/pulumi/pulumi-aws-native/sdk/go/aws/internal" + "github.com/pulumi/pulumi/sdk/v3/go/pulumi" +) + +// Represents the resource definition of AWS IoT Command. +func LookupCommand(ctx *pulumi.Context, args *LookupCommandArgs, opts ...pulumi.InvokeOption) (*LookupCommandResult, error) { + opts = internal.PkgInvokeDefaultOpts(opts) + var rv LookupCommandResult + err := ctx.Invoke("aws-native:iot:getCommand", args, &rv, opts...) + if err != nil { + return nil, err + } + return &rv, nil +} + +type LookupCommandArgs struct { + // The unique identifier for the command. + CommandId string `pulumi:"commandId"` +} + +type LookupCommandResult struct { + // The Amazon Resource Name (ARN) of the command. + CommandArn *string `pulumi:"commandArn"` + // The date and time when the command was created. + CreatedAt *string `pulumi:"createdAt"` + // A flag indicating whether the command is deprecated. + Deprecated *bool `pulumi:"deprecated"` + // The description of the command. + Description *string `pulumi:"description"` + // The display name for the command. + DisplayName *string `pulumi:"displayName"` + // The list of mandatory parameters for the command. + MandatoryParameters []CommandParameter `pulumi:"mandatoryParameters"` + // The namespace to which the command belongs. + Namespace *CommandNamespace `pulumi:"namespace"` + // The payload associated with the command. + Payload *CommandPayload `pulumi:"payload"` + // A flag indicating whether the command is pending deletion. + PendingDeletion *bool `pulumi:"pendingDeletion"` + // The customer role associated with the command. + RoleArn *string `pulumi:"roleArn"` + // The tags to be associated with the command. + Tags []aws.Tag `pulumi:"tags"` +} + +func LookupCommandOutput(ctx *pulumi.Context, args LookupCommandOutputArgs, opts ...pulumi.InvokeOption) LookupCommandResultOutput { + return pulumi.ToOutputWithContext(context.Background(), args). + ApplyT(func(v interface{}) (LookupCommandResultOutput, error) { + args := v.(LookupCommandArgs) + opts = internal.PkgInvokeDefaultOpts(opts) + var rv LookupCommandResult + secret, err := ctx.InvokePackageRaw("aws-native:iot:getCommand", args, &rv, "", opts...) + if err != nil { + return LookupCommandResultOutput{}, err + } + + output := pulumi.ToOutput(rv).(LookupCommandResultOutput) + if secret { + return pulumi.ToSecret(output).(LookupCommandResultOutput), nil + } + return output, nil + }).(LookupCommandResultOutput) +} + +type LookupCommandOutputArgs struct { + // The unique identifier for the command. + CommandId pulumi.StringInput `pulumi:"commandId"` +} + +func (LookupCommandOutputArgs) ElementType() reflect.Type { + return reflect.TypeOf((*LookupCommandArgs)(nil)).Elem() +} + +type LookupCommandResultOutput struct{ *pulumi.OutputState } + +func (LookupCommandResultOutput) ElementType() reflect.Type { + return reflect.TypeOf((*LookupCommandResult)(nil)).Elem() +} + +func (o LookupCommandResultOutput) ToLookupCommandResultOutput() LookupCommandResultOutput { + return o +} + +func (o LookupCommandResultOutput) ToLookupCommandResultOutputWithContext(ctx context.Context) LookupCommandResultOutput { + return o +} + +// The Amazon Resource Name (ARN) of the command. +func (o LookupCommandResultOutput) CommandArn() pulumi.StringPtrOutput { + return o.ApplyT(func(v LookupCommandResult) *string { return v.CommandArn }).(pulumi.StringPtrOutput) +} + +// The date and time when the command was created. +func (o LookupCommandResultOutput) CreatedAt() pulumi.StringPtrOutput { + return o.ApplyT(func(v LookupCommandResult) *string { return v.CreatedAt }).(pulumi.StringPtrOutput) +} + +// A flag indicating whether the command is deprecated. +func (o LookupCommandResultOutput) Deprecated() pulumi.BoolPtrOutput { + return o.ApplyT(func(v LookupCommandResult) *bool { return v.Deprecated }).(pulumi.BoolPtrOutput) +} + +// The description of the command. +func (o LookupCommandResultOutput) Description() pulumi.StringPtrOutput { + return o.ApplyT(func(v LookupCommandResult) *string { return v.Description }).(pulumi.StringPtrOutput) +} + +// The display name for the command. +func (o LookupCommandResultOutput) DisplayName() pulumi.StringPtrOutput { + return o.ApplyT(func(v LookupCommandResult) *string { return v.DisplayName }).(pulumi.StringPtrOutput) +} + +// The list of mandatory parameters for the command. +func (o LookupCommandResultOutput) MandatoryParameters() CommandParameterArrayOutput { + return o.ApplyT(func(v LookupCommandResult) []CommandParameter { return v.MandatoryParameters }).(CommandParameterArrayOutput) +} + +// The namespace to which the command belongs. +func (o LookupCommandResultOutput) Namespace() CommandNamespacePtrOutput { + return o.ApplyT(func(v LookupCommandResult) *CommandNamespace { return v.Namespace }).(CommandNamespacePtrOutput) +} + +// The payload associated with the command. +func (o LookupCommandResultOutput) Payload() CommandPayloadPtrOutput { + return o.ApplyT(func(v LookupCommandResult) *CommandPayload { return v.Payload }).(CommandPayloadPtrOutput) +} + +// A flag indicating whether the command is pending deletion. +func (o LookupCommandResultOutput) PendingDeletion() pulumi.BoolPtrOutput { + return o.ApplyT(func(v LookupCommandResult) *bool { return v.PendingDeletion }).(pulumi.BoolPtrOutput) +} + +// The customer role associated with the command. +func (o LookupCommandResultOutput) RoleArn() pulumi.StringPtrOutput { + return o.ApplyT(func(v LookupCommandResult) *string { return v.RoleArn }).(pulumi.StringPtrOutput) +} + +// The tags to be associated with the command. +func (o LookupCommandResultOutput) Tags() aws.TagArrayOutput { + return o.ApplyT(func(v LookupCommandResult) []aws.Tag { return v.Tags }).(aws.TagArrayOutput) +} + +func init() { + pulumi.RegisterOutputType(LookupCommandResultOutput{}) +} diff --git a/sdk/go/aws/iot/init.go b/sdk/go/aws/iot/init.go index 597fd94a27..eae7d015b8 100644 --- a/sdk/go/aws/iot/init.go +++ b/sdk/go/aws/iot/init.go @@ -33,6 +33,8 @@ func (m *module) Construct(ctx *pulumi.Context, name, typ, urn string) (r pulumi r = &Certificate{} case "aws-native:iot:CertificateProvider": r = &CertificateProvider{} + case "aws-native:iot:Command": + r = &Command{} case "aws-native:iot:CustomMetric": r = &CustomMetric{} case "aws-native:iot:Dimension": diff --git a/sdk/go/aws/iot/pulumiEnums.go b/sdk/go/aws/iot/pulumiEnums.go index 274a18510e..f4676fc813 100644 --- a/sdk/go/aws/iot/pulumiEnums.go +++ b/sdk/go/aws/iot/pulumiEnums.go @@ -1236,6 +1236,172 @@ func (in *certificateStatusPtr) ToCertificateStatusPtrOutputWithContext(ctx cont return pulumi.ToOutputWithContext(ctx, in).(CertificateStatusPtrOutput) } +// The namespace to which the command belongs. +type CommandNamespace string + +const ( + CommandNamespaceAwsIoT = CommandNamespace("AWS-IoT") + CommandNamespaceAwsIoTFleetWise = CommandNamespace("AWS-IoT-FleetWise") +) + +func (CommandNamespace) ElementType() reflect.Type { + return reflect.TypeOf((*CommandNamespace)(nil)).Elem() +} + +func (e CommandNamespace) ToCommandNamespaceOutput() CommandNamespaceOutput { + return pulumi.ToOutput(e).(CommandNamespaceOutput) +} + +func (e CommandNamespace) ToCommandNamespaceOutputWithContext(ctx context.Context) CommandNamespaceOutput { + return pulumi.ToOutputWithContext(ctx, e).(CommandNamespaceOutput) +} + +func (e CommandNamespace) ToCommandNamespacePtrOutput() CommandNamespacePtrOutput { + return e.ToCommandNamespacePtrOutputWithContext(context.Background()) +} + +func (e CommandNamespace) ToCommandNamespacePtrOutputWithContext(ctx context.Context) CommandNamespacePtrOutput { + return CommandNamespace(e).ToCommandNamespaceOutputWithContext(ctx).ToCommandNamespacePtrOutputWithContext(ctx) +} + +func (e CommandNamespace) ToStringOutput() pulumi.StringOutput { + return pulumi.ToOutput(pulumi.String(e)).(pulumi.StringOutput) +} + +func (e CommandNamespace) ToStringOutputWithContext(ctx context.Context) pulumi.StringOutput { + return pulumi.ToOutputWithContext(ctx, pulumi.String(e)).(pulumi.StringOutput) +} + +func (e CommandNamespace) ToStringPtrOutput() pulumi.StringPtrOutput { + return pulumi.String(e).ToStringPtrOutputWithContext(context.Background()) +} + +func (e CommandNamespace) ToStringPtrOutputWithContext(ctx context.Context) pulumi.StringPtrOutput { + return pulumi.String(e).ToStringOutputWithContext(ctx).ToStringPtrOutputWithContext(ctx) +} + +type CommandNamespaceOutput struct{ *pulumi.OutputState } + +func (CommandNamespaceOutput) ElementType() reflect.Type { + return reflect.TypeOf((*CommandNamespace)(nil)).Elem() +} + +func (o CommandNamespaceOutput) ToCommandNamespaceOutput() CommandNamespaceOutput { + return o +} + +func (o CommandNamespaceOutput) ToCommandNamespaceOutputWithContext(ctx context.Context) CommandNamespaceOutput { + return o +} + +func (o CommandNamespaceOutput) ToCommandNamespacePtrOutput() CommandNamespacePtrOutput { + return o.ToCommandNamespacePtrOutputWithContext(context.Background()) +} + +func (o CommandNamespaceOutput) ToCommandNamespacePtrOutputWithContext(ctx context.Context) CommandNamespacePtrOutput { + return o.ApplyTWithContext(ctx, func(_ context.Context, v CommandNamespace) *CommandNamespace { + return &v + }).(CommandNamespacePtrOutput) +} + +func (o CommandNamespaceOutput) ToStringOutput() pulumi.StringOutput { + return o.ToStringOutputWithContext(context.Background()) +} + +func (o CommandNamespaceOutput) ToStringOutputWithContext(ctx context.Context) pulumi.StringOutput { + return o.ApplyTWithContext(ctx, func(_ context.Context, e CommandNamespace) string { + return string(e) + }).(pulumi.StringOutput) +} + +func (o CommandNamespaceOutput) ToStringPtrOutput() pulumi.StringPtrOutput { + return o.ToStringPtrOutputWithContext(context.Background()) +} + +func (o CommandNamespaceOutput) ToStringPtrOutputWithContext(ctx context.Context) pulumi.StringPtrOutput { + return o.ApplyTWithContext(ctx, func(_ context.Context, e CommandNamespace) *string { + v := string(e) + return &v + }).(pulumi.StringPtrOutput) +} + +type CommandNamespacePtrOutput struct{ *pulumi.OutputState } + +func (CommandNamespacePtrOutput) ElementType() reflect.Type { + return reflect.TypeOf((**CommandNamespace)(nil)).Elem() +} + +func (o CommandNamespacePtrOutput) ToCommandNamespacePtrOutput() CommandNamespacePtrOutput { + return o +} + +func (o CommandNamespacePtrOutput) ToCommandNamespacePtrOutputWithContext(ctx context.Context) CommandNamespacePtrOutput { + return o +} + +func (o CommandNamespacePtrOutput) Elem() CommandNamespaceOutput { + return o.ApplyT(func(v *CommandNamespace) CommandNamespace { + if v != nil { + return *v + } + var ret CommandNamespace + return ret + }).(CommandNamespaceOutput) +} + +func (o CommandNamespacePtrOutput) ToStringPtrOutput() pulumi.StringPtrOutput { + return o.ToStringPtrOutputWithContext(context.Background()) +} + +func (o CommandNamespacePtrOutput) ToStringPtrOutputWithContext(ctx context.Context) pulumi.StringPtrOutput { + return o.ApplyTWithContext(ctx, func(_ context.Context, e *CommandNamespace) *string { + if e == nil { + return nil + } + v := string(*e) + return &v + }).(pulumi.StringPtrOutput) +} + +// CommandNamespaceInput is an input type that accepts values of the CommandNamespace enum +// A concrete instance of `CommandNamespaceInput` can be one of the following: +// +// CommandNamespaceAwsIoT +// CommandNamespaceAwsIoTFleetWise +type CommandNamespaceInput interface { + pulumi.Input + + ToCommandNamespaceOutput() CommandNamespaceOutput + ToCommandNamespaceOutputWithContext(context.Context) CommandNamespaceOutput +} + +var commandNamespacePtrType = reflect.TypeOf((**CommandNamespace)(nil)).Elem() + +type CommandNamespacePtrInput interface { + pulumi.Input + + ToCommandNamespacePtrOutput() CommandNamespacePtrOutput + ToCommandNamespacePtrOutputWithContext(context.Context) CommandNamespacePtrOutput +} + +type commandNamespacePtr string + +func CommandNamespacePtr(v string) CommandNamespacePtrInput { + return (*commandNamespacePtr)(&v) +} + +func (*commandNamespacePtr) ElementType() reflect.Type { + return commandNamespacePtrType +} + +func (in *commandNamespacePtr) ToCommandNamespacePtrOutput() CommandNamespacePtrOutput { + return pulumi.ToOutput(in).(CommandNamespacePtrOutput) +} + +func (in *commandNamespacePtr) ToCommandNamespacePtrOutputWithContext(ctx context.Context) CommandNamespacePtrOutput { + return pulumi.ToOutputWithContext(ctx, in).(CommandNamespacePtrOutput) +} + // The type of the custom metric. Types include string-list, ip-address-list, number-list, and number. type CustomMetricMetricType string @@ -5951,6 +6117,8 @@ func init() { pulumi.RegisterInputType(reflect.TypeOf((*CertificateProviderOperationArrayInput)(nil)).Elem(), CertificateProviderOperationArray{}) pulumi.RegisterInputType(reflect.TypeOf((*CertificateStatusInput)(nil)).Elem(), CertificateStatus("ACTIVE")) pulumi.RegisterInputType(reflect.TypeOf((*CertificateStatusPtrInput)(nil)).Elem(), CertificateStatus("ACTIVE")) + pulumi.RegisterInputType(reflect.TypeOf((*CommandNamespaceInput)(nil)).Elem(), CommandNamespace("AWS-IoT")) + pulumi.RegisterInputType(reflect.TypeOf((*CommandNamespacePtrInput)(nil)).Elem(), CommandNamespace("AWS-IoT")) pulumi.RegisterInputType(reflect.TypeOf((*CustomMetricMetricTypeInput)(nil)).Elem(), CustomMetricMetricType("string-list")) pulumi.RegisterInputType(reflect.TypeOf((*CustomMetricMetricTypePtrInput)(nil)).Elem(), CustomMetricMetricType("string-list")) pulumi.RegisterInputType(reflect.TypeOf((*DimensionTypeInput)(nil)).Elem(), DimensionType("TOPIC_FILTER")) @@ -6018,6 +6186,8 @@ func init() { pulumi.RegisterOutputType(CertificateProviderOperationArrayOutput{}) pulumi.RegisterOutputType(CertificateStatusOutput{}) pulumi.RegisterOutputType(CertificateStatusPtrOutput{}) + pulumi.RegisterOutputType(CommandNamespaceOutput{}) + pulumi.RegisterOutputType(CommandNamespacePtrOutput{}) pulumi.RegisterOutputType(CustomMetricMetricTypeOutput{}) pulumi.RegisterOutputType(CustomMetricMetricTypePtrOutput{}) pulumi.RegisterOutputType(DimensionTypeOutput{}) diff --git a/sdk/go/aws/iot/pulumiTypes.go b/sdk/go/aws/iot/pulumiTypes.go index 2b20fc43d9..5ea49653ac 100644 --- a/sdk/go/aws/iot/pulumiTypes.go +++ b/sdk/go/aws/iot/pulumiTypes.go @@ -1362,6 +1362,497 @@ type CertificateProviderTag struct { Value string `pulumi:"value"` } +type CommandParameter struct { + DefaultValue *CommandParameterValue `pulumi:"defaultValue"` + Description *string `pulumi:"description"` + Name string `pulumi:"name"` + Value *CommandParameterValue `pulumi:"value"` +} + +// CommandParameterInput is an input type that accepts CommandParameterArgs and CommandParameterOutput values. +// You can construct a concrete instance of `CommandParameterInput` via: +// +// CommandParameterArgs{...} +type CommandParameterInput interface { + pulumi.Input + + ToCommandParameterOutput() CommandParameterOutput + ToCommandParameterOutputWithContext(context.Context) CommandParameterOutput +} + +type CommandParameterArgs struct { + DefaultValue CommandParameterValuePtrInput `pulumi:"defaultValue"` + Description pulumi.StringPtrInput `pulumi:"description"` + Name pulumi.StringInput `pulumi:"name"` + Value CommandParameterValuePtrInput `pulumi:"value"` +} + +func (CommandParameterArgs) ElementType() reflect.Type { + return reflect.TypeOf((*CommandParameter)(nil)).Elem() +} + +func (i CommandParameterArgs) ToCommandParameterOutput() CommandParameterOutput { + return i.ToCommandParameterOutputWithContext(context.Background()) +} + +func (i CommandParameterArgs) ToCommandParameterOutputWithContext(ctx context.Context) CommandParameterOutput { + return pulumi.ToOutputWithContext(ctx, i).(CommandParameterOutput) +} + +// CommandParameterArrayInput is an input type that accepts CommandParameterArray and CommandParameterArrayOutput values. +// You can construct a concrete instance of `CommandParameterArrayInput` via: +// +// CommandParameterArray{ CommandParameterArgs{...} } +type CommandParameterArrayInput interface { + pulumi.Input + + ToCommandParameterArrayOutput() CommandParameterArrayOutput + ToCommandParameterArrayOutputWithContext(context.Context) CommandParameterArrayOutput +} + +type CommandParameterArray []CommandParameterInput + +func (CommandParameterArray) ElementType() reflect.Type { + return reflect.TypeOf((*[]CommandParameter)(nil)).Elem() +} + +func (i CommandParameterArray) ToCommandParameterArrayOutput() CommandParameterArrayOutput { + return i.ToCommandParameterArrayOutputWithContext(context.Background()) +} + +func (i CommandParameterArray) ToCommandParameterArrayOutputWithContext(ctx context.Context) CommandParameterArrayOutput { + return pulumi.ToOutputWithContext(ctx, i).(CommandParameterArrayOutput) +} + +type CommandParameterOutput struct{ *pulumi.OutputState } + +func (CommandParameterOutput) ElementType() reflect.Type { + return reflect.TypeOf((*CommandParameter)(nil)).Elem() +} + +func (o CommandParameterOutput) ToCommandParameterOutput() CommandParameterOutput { + return o +} + +func (o CommandParameterOutput) ToCommandParameterOutputWithContext(ctx context.Context) CommandParameterOutput { + return o +} + +func (o CommandParameterOutput) DefaultValue() CommandParameterValuePtrOutput { + return o.ApplyT(func(v CommandParameter) *CommandParameterValue { return v.DefaultValue }).(CommandParameterValuePtrOutput) +} + +func (o CommandParameterOutput) Description() pulumi.StringPtrOutput { + return o.ApplyT(func(v CommandParameter) *string { return v.Description }).(pulumi.StringPtrOutput) +} + +func (o CommandParameterOutput) Name() pulumi.StringOutput { + return o.ApplyT(func(v CommandParameter) string { return v.Name }).(pulumi.StringOutput) +} + +func (o CommandParameterOutput) Value() CommandParameterValuePtrOutput { + return o.ApplyT(func(v CommandParameter) *CommandParameterValue { return v.Value }).(CommandParameterValuePtrOutput) +} + +type CommandParameterArrayOutput struct{ *pulumi.OutputState } + +func (CommandParameterArrayOutput) ElementType() reflect.Type { + return reflect.TypeOf((*[]CommandParameter)(nil)).Elem() +} + +func (o CommandParameterArrayOutput) ToCommandParameterArrayOutput() CommandParameterArrayOutput { + return o +} + +func (o CommandParameterArrayOutput) ToCommandParameterArrayOutputWithContext(ctx context.Context) CommandParameterArrayOutput { + return o +} + +func (o CommandParameterArrayOutput) Index(i pulumi.IntInput) CommandParameterOutput { + return pulumi.All(o, i).ApplyT(func(vs []interface{}) CommandParameter { + return vs[0].([]CommandParameter)[vs[1].(int)] + }).(CommandParameterOutput) +} + +type CommandParameterValue struct { + B *bool `pulumi:"b"` + Bin *string `pulumi:"bin"` + D *float64 `pulumi:"d"` + I *int `pulumi:"i"` + L *string `pulumi:"l"` + S *string `pulumi:"s"` + Ul *string `pulumi:"ul"` +} + +// CommandParameterValueInput is an input type that accepts CommandParameterValueArgs and CommandParameterValueOutput values. +// You can construct a concrete instance of `CommandParameterValueInput` via: +// +// CommandParameterValueArgs{...} +type CommandParameterValueInput interface { + pulumi.Input + + ToCommandParameterValueOutput() CommandParameterValueOutput + ToCommandParameterValueOutputWithContext(context.Context) CommandParameterValueOutput +} + +type CommandParameterValueArgs struct { + B pulumi.BoolPtrInput `pulumi:"b"` + Bin pulumi.StringPtrInput `pulumi:"bin"` + D pulumi.Float64PtrInput `pulumi:"d"` + I pulumi.IntPtrInput `pulumi:"i"` + L pulumi.StringPtrInput `pulumi:"l"` + S pulumi.StringPtrInput `pulumi:"s"` + Ul pulumi.StringPtrInput `pulumi:"ul"` +} + +func (CommandParameterValueArgs) ElementType() reflect.Type { + return reflect.TypeOf((*CommandParameterValue)(nil)).Elem() +} + +func (i CommandParameterValueArgs) ToCommandParameterValueOutput() CommandParameterValueOutput { + return i.ToCommandParameterValueOutputWithContext(context.Background()) +} + +func (i CommandParameterValueArgs) ToCommandParameterValueOutputWithContext(ctx context.Context) CommandParameterValueOutput { + return pulumi.ToOutputWithContext(ctx, i).(CommandParameterValueOutput) +} + +func (i CommandParameterValueArgs) ToCommandParameterValuePtrOutput() CommandParameterValuePtrOutput { + return i.ToCommandParameterValuePtrOutputWithContext(context.Background()) +} + +func (i CommandParameterValueArgs) ToCommandParameterValuePtrOutputWithContext(ctx context.Context) CommandParameterValuePtrOutput { + return pulumi.ToOutputWithContext(ctx, i).(CommandParameterValueOutput).ToCommandParameterValuePtrOutputWithContext(ctx) +} + +// CommandParameterValuePtrInput is an input type that accepts CommandParameterValueArgs, CommandParameterValuePtr and CommandParameterValuePtrOutput values. +// You can construct a concrete instance of `CommandParameterValuePtrInput` via: +// +// CommandParameterValueArgs{...} +// +// or: +// +// nil +type CommandParameterValuePtrInput interface { + pulumi.Input + + ToCommandParameterValuePtrOutput() CommandParameterValuePtrOutput + ToCommandParameterValuePtrOutputWithContext(context.Context) CommandParameterValuePtrOutput +} + +type commandParameterValuePtrType CommandParameterValueArgs + +func CommandParameterValuePtr(v *CommandParameterValueArgs) CommandParameterValuePtrInput { + return (*commandParameterValuePtrType)(v) +} + +func (*commandParameterValuePtrType) ElementType() reflect.Type { + return reflect.TypeOf((**CommandParameterValue)(nil)).Elem() +} + +func (i *commandParameterValuePtrType) ToCommandParameterValuePtrOutput() CommandParameterValuePtrOutput { + return i.ToCommandParameterValuePtrOutputWithContext(context.Background()) +} + +func (i *commandParameterValuePtrType) ToCommandParameterValuePtrOutputWithContext(ctx context.Context) CommandParameterValuePtrOutput { + return pulumi.ToOutputWithContext(ctx, i).(CommandParameterValuePtrOutput) +} + +type CommandParameterValueOutput struct{ *pulumi.OutputState } + +func (CommandParameterValueOutput) ElementType() reflect.Type { + return reflect.TypeOf((*CommandParameterValue)(nil)).Elem() +} + +func (o CommandParameterValueOutput) ToCommandParameterValueOutput() CommandParameterValueOutput { + return o +} + +func (o CommandParameterValueOutput) ToCommandParameterValueOutputWithContext(ctx context.Context) CommandParameterValueOutput { + return o +} + +func (o CommandParameterValueOutput) ToCommandParameterValuePtrOutput() CommandParameterValuePtrOutput { + return o.ToCommandParameterValuePtrOutputWithContext(context.Background()) +} + +func (o CommandParameterValueOutput) ToCommandParameterValuePtrOutputWithContext(ctx context.Context) CommandParameterValuePtrOutput { + return o.ApplyTWithContext(ctx, func(_ context.Context, v CommandParameterValue) *CommandParameterValue { + return &v + }).(CommandParameterValuePtrOutput) +} + +func (o CommandParameterValueOutput) B() pulumi.BoolPtrOutput { + return o.ApplyT(func(v CommandParameterValue) *bool { return v.B }).(pulumi.BoolPtrOutput) +} + +func (o CommandParameterValueOutput) Bin() pulumi.StringPtrOutput { + return o.ApplyT(func(v CommandParameterValue) *string { return v.Bin }).(pulumi.StringPtrOutput) +} + +func (o CommandParameterValueOutput) D() pulumi.Float64PtrOutput { + return o.ApplyT(func(v CommandParameterValue) *float64 { return v.D }).(pulumi.Float64PtrOutput) +} + +func (o CommandParameterValueOutput) I() pulumi.IntPtrOutput { + return o.ApplyT(func(v CommandParameterValue) *int { return v.I }).(pulumi.IntPtrOutput) +} + +func (o CommandParameterValueOutput) L() pulumi.StringPtrOutput { + return o.ApplyT(func(v CommandParameterValue) *string { return v.L }).(pulumi.StringPtrOutput) +} + +func (o CommandParameterValueOutput) S() pulumi.StringPtrOutput { + return o.ApplyT(func(v CommandParameterValue) *string { return v.S }).(pulumi.StringPtrOutput) +} + +func (o CommandParameterValueOutput) Ul() pulumi.StringPtrOutput { + return o.ApplyT(func(v CommandParameterValue) *string { return v.Ul }).(pulumi.StringPtrOutput) +} + +type CommandParameterValuePtrOutput struct{ *pulumi.OutputState } + +func (CommandParameterValuePtrOutput) ElementType() reflect.Type { + return reflect.TypeOf((**CommandParameterValue)(nil)).Elem() +} + +func (o CommandParameterValuePtrOutput) ToCommandParameterValuePtrOutput() CommandParameterValuePtrOutput { + return o +} + +func (o CommandParameterValuePtrOutput) ToCommandParameterValuePtrOutputWithContext(ctx context.Context) CommandParameterValuePtrOutput { + return o +} + +func (o CommandParameterValuePtrOutput) Elem() CommandParameterValueOutput { + return o.ApplyT(func(v *CommandParameterValue) CommandParameterValue { + if v != nil { + return *v + } + var ret CommandParameterValue + return ret + }).(CommandParameterValueOutput) +} + +func (o CommandParameterValuePtrOutput) B() pulumi.BoolPtrOutput { + return o.ApplyT(func(v *CommandParameterValue) *bool { + if v == nil { + return nil + } + return v.B + }).(pulumi.BoolPtrOutput) +} + +func (o CommandParameterValuePtrOutput) Bin() pulumi.StringPtrOutput { + return o.ApplyT(func(v *CommandParameterValue) *string { + if v == nil { + return nil + } + return v.Bin + }).(pulumi.StringPtrOutput) +} + +func (o CommandParameterValuePtrOutput) D() pulumi.Float64PtrOutput { + return o.ApplyT(func(v *CommandParameterValue) *float64 { + if v == nil { + return nil + } + return v.D + }).(pulumi.Float64PtrOutput) +} + +func (o CommandParameterValuePtrOutput) I() pulumi.IntPtrOutput { + return o.ApplyT(func(v *CommandParameterValue) *int { + if v == nil { + return nil + } + return v.I + }).(pulumi.IntPtrOutput) +} + +func (o CommandParameterValuePtrOutput) L() pulumi.StringPtrOutput { + return o.ApplyT(func(v *CommandParameterValue) *string { + if v == nil { + return nil + } + return v.L + }).(pulumi.StringPtrOutput) +} + +func (o CommandParameterValuePtrOutput) S() pulumi.StringPtrOutput { + return o.ApplyT(func(v *CommandParameterValue) *string { + if v == nil { + return nil + } + return v.S + }).(pulumi.StringPtrOutput) +} + +func (o CommandParameterValuePtrOutput) Ul() pulumi.StringPtrOutput { + return o.ApplyT(func(v *CommandParameterValue) *string { + if v == nil { + return nil + } + return v.Ul + }).(pulumi.StringPtrOutput) +} + +type CommandPayload struct { + Content *string `pulumi:"content"` + ContentType *string `pulumi:"contentType"` +} + +// CommandPayloadInput is an input type that accepts CommandPayloadArgs and CommandPayloadOutput values. +// You can construct a concrete instance of `CommandPayloadInput` via: +// +// CommandPayloadArgs{...} +type CommandPayloadInput interface { + pulumi.Input + + ToCommandPayloadOutput() CommandPayloadOutput + ToCommandPayloadOutputWithContext(context.Context) CommandPayloadOutput +} + +type CommandPayloadArgs struct { + Content pulumi.StringPtrInput `pulumi:"content"` + ContentType pulumi.StringPtrInput `pulumi:"contentType"` +} + +func (CommandPayloadArgs) ElementType() reflect.Type { + return reflect.TypeOf((*CommandPayload)(nil)).Elem() +} + +func (i CommandPayloadArgs) ToCommandPayloadOutput() CommandPayloadOutput { + return i.ToCommandPayloadOutputWithContext(context.Background()) +} + +func (i CommandPayloadArgs) ToCommandPayloadOutputWithContext(ctx context.Context) CommandPayloadOutput { + return pulumi.ToOutputWithContext(ctx, i).(CommandPayloadOutput) +} + +func (i CommandPayloadArgs) ToCommandPayloadPtrOutput() CommandPayloadPtrOutput { + return i.ToCommandPayloadPtrOutputWithContext(context.Background()) +} + +func (i CommandPayloadArgs) ToCommandPayloadPtrOutputWithContext(ctx context.Context) CommandPayloadPtrOutput { + return pulumi.ToOutputWithContext(ctx, i).(CommandPayloadOutput).ToCommandPayloadPtrOutputWithContext(ctx) +} + +// CommandPayloadPtrInput is an input type that accepts CommandPayloadArgs, CommandPayloadPtr and CommandPayloadPtrOutput values. +// You can construct a concrete instance of `CommandPayloadPtrInput` via: +// +// CommandPayloadArgs{...} +// +// or: +// +// nil +type CommandPayloadPtrInput interface { + pulumi.Input + + ToCommandPayloadPtrOutput() CommandPayloadPtrOutput + ToCommandPayloadPtrOutputWithContext(context.Context) CommandPayloadPtrOutput +} + +type commandPayloadPtrType CommandPayloadArgs + +func CommandPayloadPtr(v *CommandPayloadArgs) CommandPayloadPtrInput { + return (*commandPayloadPtrType)(v) +} + +func (*commandPayloadPtrType) ElementType() reflect.Type { + return reflect.TypeOf((**CommandPayload)(nil)).Elem() +} + +func (i *commandPayloadPtrType) ToCommandPayloadPtrOutput() CommandPayloadPtrOutput { + return i.ToCommandPayloadPtrOutputWithContext(context.Background()) +} + +func (i *commandPayloadPtrType) ToCommandPayloadPtrOutputWithContext(ctx context.Context) CommandPayloadPtrOutput { + return pulumi.ToOutputWithContext(ctx, i).(CommandPayloadPtrOutput) +} + +type CommandPayloadOutput struct{ *pulumi.OutputState } + +func (CommandPayloadOutput) ElementType() reflect.Type { + return reflect.TypeOf((*CommandPayload)(nil)).Elem() +} + +func (o CommandPayloadOutput) ToCommandPayloadOutput() CommandPayloadOutput { + return o +} + +func (o CommandPayloadOutput) ToCommandPayloadOutputWithContext(ctx context.Context) CommandPayloadOutput { + return o +} + +func (o CommandPayloadOutput) ToCommandPayloadPtrOutput() CommandPayloadPtrOutput { + return o.ToCommandPayloadPtrOutputWithContext(context.Background()) +} + +func (o CommandPayloadOutput) ToCommandPayloadPtrOutputWithContext(ctx context.Context) CommandPayloadPtrOutput { + return o.ApplyTWithContext(ctx, func(_ context.Context, v CommandPayload) *CommandPayload { + return &v + }).(CommandPayloadPtrOutput) +} + +func (o CommandPayloadOutput) Content() pulumi.StringPtrOutput { + return o.ApplyT(func(v CommandPayload) *string { return v.Content }).(pulumi.StringPtrOutput) +} + +func (o CommandPayloadOutput) ContentType() pulumi.StringPtrOutput { + return o.ApplyT(func(v CommandPayload) *string { return v.ContentType }).(pulumi.StringPtrOutput) +} + +type CommandPayloadPtrOutput struct{ *pulumi.OutputState } + +func (CommandPayloadPtrOutput) ElementType() reflect.Type { + return reflect.TypeOf((**CommandPayload)(nil)).Elem() +} + +func (o CommandPayloadPtrOutput) ToCommandPayloadPtrOutput() CommandPayloadPtrOutput { + return o +} + +func (o CommandPayloadPtrOutput) ToCommandPayloadPtrOutputWithContext(ctx context.Context) CommandPayloadPtrOutput { + return o +} + +func (o CommandPayloadPtrOutput) Elem() CommandPayloadOutput { + return o.ApplyT(func(v *CommandPayload) CommandPayload { + if v != nil { + return *v + } + var ret CommandPayload + return ret + }).(CommandPayloadOutput) +} + +func (o CommandPayloadPtrOutput) Content() pulumi.StringPtrOutput { + return o.ApplyT(func(v *CommandPayload) *string { + if v == nil { + return nil + } + return v.Content + }).(pulumi.StringPtrOutput) +} + +func (o CommandPayloadPtrOutput) ContentType() pulumi.StringPtrOutput { + return o.ApplyT(func(v *CommandPayload) *string { + if v == nil { + return nil + } + return v.ContentType + }).(pulumi.StringPtrOutput) +} + +// A key-value pair to associate with a resource. +type CommandTag struct { + // The tag's key. + Key string `pulumi:"key"` + // The tag's value. + Value string `pulumi:"value"` +} + // A key-value pair to associate with a resource. type CustomMetricTag struct { // The tag's key. @@ -14545,6 +15036,12 @@ func init() { pulumi.RegisterInputType(reflect.TypeOf((*BillingGroupPropertiesPropertiesPtrInput)(nil)).Elem(), BillingGroupPropertiesPropertiesArgs{}) pulumi.RegisterInputType(reflect.TypeOf((*CaCertificateRegistrationConfigInput)(nil)).Elem(), CaCertificateRegistrationConfigArgs{}) pulumi.RegisterInputType(reflect.TypeOf((*CaCertificateRegistrationConfigPtrInput)(nil)).Elem(), CaCertificateRegistrationConfigArgs{}) + pulumi.RegisterInputType(reflect.TypeOf((*CommandParameterInput)(nil)).Elem(), CommandParameterArgs{}) + pulumi.RegisterInputType(reflect.TypeOf((*CommandParameterArrayInput)(nil)).Elem(), CommandParameterArray{}) + pulumi.RegisterInputType(reflect.TypeOf((*CommandParameterValueInput)(nil)).Elem(), CommandParameterValueArgs{}) + pulumi.RegisterInputType(reflect.TypeOf((*CommandParameterValuePtrInput)(nil)).Elem(), CommandParameterValueArgs{}) + pulumi.RegisterInputType(reflect.TypeOf((*CommandPayloadInput)(nil)).Elem(), CommandPayloadArgs{}) + pulumi.RegisterInputType(reflect.TypeOf((*CommandPayloadPtrInput)(nil)).Elem(), CommandPayloadArgs{}) pulumi.RegisterInputType(reflect.TypeOf((*DomainConfigurationAuthorizerConfigInput)(nil)).Elem(), DomainConfigurationAuthorizerConfigArgs{}) pulumi.RegisterInputType(reflect.TypeOf((*DomainConfigurationAuthorizerConfigPtrInput)(nil)).Elem(), DomainConfigurationAuthorizerConfigArgs{}) pulumi.RegisterInputType(reflect.TypeOf((*DomainConfigurationClientCertificateConfigInput)(nil)).Elem(), DomainConfigurationClientCertificateConfigArgs{}) @@ -14710,6 +15207,12 @@ func init() { pulumi.RegisterOutputType(BillingGroupPropertiesPropertiesPtrOutput{}) pulumi.RegisterOutputType(CaCertificateRegistrationConfigOutput{}) pulumi.RegisterOutputType(CaCertificateRegistrationConfigPtrOutput{}) + pulumi.RegisterOutputType(CommandParameterOutput{}) + pulumi.RegisterOutputType(CommandParameterArrayOutput{}) + pulumi.RegisterOutputType(CommandParameterValueOutput{}) + pulumi.RegisterOutputType(CommandParameterValuePtrOutput{}) + pulumi.RegisterOutputType(CommandPayloadOutput{}) + pulumi.RegisterOutputType(CommandPayloadPtrOutput{}) pulumi.RegisterOutputType(DomainConfigurationAuthorizerConfigOutput{}) pulumi.RegisterOutputType(DomainConfigurationAuthorizerConfigPtrOutput{}) pulumi.RegisterOutputType(DomainConfigurationClientCertificateConfigOutput{}) diff --git a/sdk/go/aws/organizations/policy.go b/sdk/go/aws/organizations/policy.go index 0435c09875..6f31674665 100644 --- a/sdk/go/aws/organizations/policy.go +++ b/sdk/go/aws/organizations/policy.go @@ -35,7 +35,7 @@ type Policy struct { Tags aws.TagArrayOutput `pulumi:"tags"` // List of unique identifiers (IDs) of the root, OU, or account that you want to attach the policy to TargetIds pulumi.StringArrayOutput `pulumi:"targetIds"` - // The type of policy to create. You can specify one of the following values: AISERVICES_OPT_OUT_POLICY, BACKUP_POLICY, SERVICE_CONTROL_POLICY, TAG_POLICY, CHATBOT_POLICY, RESOURCE_CONTROL_POLICY + // The type of policy to create. You can specify one of the following values: AISERVICES_OPT_OUT_POLICY, BACKUP_POLICY, SERVICE_CONTROL_POLICY, TAG_POLICY, CHATBOT_POLICY, RESOURCE_CONTROL_POLICY,DECLARATIVE_POLICY_EC2 Type PolicyTypeOutput `pulumi:"type"` } @@ -101,7 +101,7 @@ type policyArgs struct { Tags []aws.Tag `pulumi:"tags"` // List of unique identifiers (IDs) of the root, OU, or account that you want to attach the policy to TargetIds []string `pulumi:"targetIds"` - // The type of policy to create. You can specify one of the following values: AISERVICES_OPT_OUT_POLICY, BACKUP_POLICY, SERVICE_CONTROL_POLICY, TAG_POLICY, CHATBOT_POLICY, RESOURCE_CONTROL_POLICY + // The type of policy to create. You can specify one of the following values: AISERVICES_OPT_OUT_POLICY, BACKUP_POLICY, SERVICE_CONTROL_POLICY, TAG_POLICY, CHATBOT_POLICY, RESOURCE_CONTROL_POLICY,DECLARATIVE_POLICY_EC2 Type PolicyType `pulumi:"type"` } @@ -119,7 +119,7 @@ type PolicyArgs struct { Tags aws.TagArrayInput // List of unique identifiers (IDs) of the root, OU, or account that you want to attach the policy to TargetIds pulumi.StringArrayInput - // The type of policy to create. You can specify one of the following values: AISERVICES_OPT_OUT_POLICY, BACKUP_POLICY, SERVICE_CONTROL_POLICY, TAG_POLICY, CHATBOT_POLICY, RESOURCE_CONTROL_POLICY + // The type of policy to create. You can specify one of the following values: AISERVICES_OPT_OUT_POLICY, BACKUP_POLICY, SERVICE_CONTROL_POLICY, TAG_POLICY, CHATBOT_POLICY, RESOURCE_CONTROL_POLICY,DECLARATIVE_POLICY_EC2 Type PolicyTypeInput } @@ -202,7 +202,7 @@ func (o PolicyOutput) TargetIds() pulumi.StringArrayOutput { return o.ApplyT(func(v *Policy) pulumi.StringArrayOutput { return v.TargetIds }).(pulumi.StringArrayOutput) } -// The type of policy to create. You can specify one of the following values: AISERVICES_OPT_OUT_POLICY, BACKUP_POLICY, SERVICE_CONTROL_POLICY, TAG_POLICY, CHATBOT_POLICY, RESOURCE_CONTROL_POLICY +// The type of policy to create. You can specify one of the following values: AISERVICES_OPT_OUT_POLICY, BACKUP_POLICY, SERVICE_CONTROL_POLICY, TAG_POLICY, CHATBOT_POLICY, RESOURCE_CONTROL_POLICY,DECLARATIVE_POLICY_EC2 func (o PolicyOutput) Type() PolicyTypeOutput { return o.ApplyT(func(v *Policy) PolicyTypeOutput { return v.Type }).(PolicyTypeOutput) } diff --git a/sdk/go/aws/organizations/pulumiEnums.go b/sdk/go/aws/organizations/pulumiEnums.go index a4454928e8..7046c3048d 100644 --- a/sdk/go/aws/organizations/pulumiEnums.go +++ b/sdk/go/aws/organizations/pulumiEnums.go @@ -359,7 +359,7 @@ func (in *organizationFeatureSetPtr) ToOrganizationFeatureSetPtrOutputWithContex return pulumi.ToOutputWithContext(ctx, in).(OrganizationFeatureSetPtrOutput) } -// The type of policy to create. You can specify one of the following values: AISERVICES_OPT_OUT_POLICY, BACKUP_POLICY, SERVICE_CONTROL_POLICY, TAG_POLICY, CHATBOT_POLICY, RESOURCE_CONTROL_POLICY +// The type of policy to create. You can specify one of the following values: AISERVICES_OPT_OUT_POLICY, BACKUP_POLICY, SERVICE_CONTROL_POLICY, TAG_POLICY, CHATBOT_POLICY, RESOURCE_CONTROL_POLICY,DECLARATIVE_POLICY_EC2 type PolicyType string const ( @@ -369,6 +369,7 @@ const ( PolicyTypeTagPolicy = PolicyType("TAG_POLICY") PolicyTypeChatbotPolicy = PolicyType("CHATBOT_POLICY") PolicyTypeResourceControlPolicy = PolicyType("RESOURCE_CONTROL_POLICY") + PolicyTypeDeclarativePolicyEc2 = PolicyType("DECLARATIVE_POLICY_EC2") ) func (PolicyType) ElementType() reflect.Type { @@ -499,6 +500,7 @@ func (o PolicyTypePtrOutput) ToStringPtrOutputWithContext(ctx context.Context) p // PolicyTypeTagPolicy // PolicyTypeChatbotPolicy // PolicyTypeResourceControlPolicy +// PolicyTypeDeclarativePolicyEc2 type PolicyTypeInput interface { pulumi.Input diff --git a/sdk/go/aws/qbusiness/application.go b/sdk/go/aws/qbusiness/application.go index 5393535195..905ac22eb6 100644 --- a/sdk/go/aws/qbusiness/application.go +++ b/sdk/go/aws/qbusiness/application.go @@ -25,7 +25,8 @@ type Application struct { AttachmentsConfiguration ApplicationAttachmentsConfigurationPtrOutput `pulumi:"attachmentsConfiguration"` // Subscription configuration information for an Amazon Q Business application using IAM identity federation for user management. AutoSubscriptionConfiguration ApplicationAutoSubscriptionConfigurationPtrOutput `pulumi:"autoSubscriptionConfiguration"` - ClientIdsForOidc pulumi.StringArrayOutput `pulumi:"clientIdsForOidc"` + // The OIDC client ID for a Amazon Q Business application. + ClientIdsForOidc pulumi.StringArrayOutput `pulumi:"clientIdsForOidc"` // The Unix timestamp when the Amazon Q Business application was created. CreatedAt pulumi.StringOutput `pulumi:"createdAt"` // A description for the Amazon Q Business application. @@ -114,7 +115,8 @@ type applicationArgs struct { AttachmentsConfiguration *ApplicationAttachmentsConfiguration `pulumi:"attachmentsConfiguration"` // Subscription configuration information for an Amazon Q Business application using IAM identity federation for user management. AutoSubscriptionConfiguration *ApplicationAutoSubscriptionConfiguration `pulumi:"autoSubscriptionConfiguration"` - ClientIdsForOidc []string `pulumi:"clientIdsForOidc"` + // The OIDC client ID for a Amazon Q Business application. + ClientIdsForOidc []string `pulumi:"clientIdsForOidc"` // A description for the Amazon Q Business application. Description *string `pulumi:"description"` // The name of the Amazon Q Business application. @@ -146,7 +148,8 @@ type ApplicationArgs struct { AttachmentsConfiguration ApplicationAttachmentsConfigurationPtrInput // Subscription configuration information for an Amazon Q Business application using IAM identity federation for user management. AutoSubscriptionConfiguration ApplicationAutoSubscriptionConfigurationPtrInput - ClientIdsForOidc pulumi.StringArrayInput + // The OIDC client ID for a Amazon Q Business application. + ClientIdsForOidc pulumi.StringArrayInput // A description for the Amazon Q Business application. Description pulumi.StringPtrInput // The name of the Amazon Q Business application. @@ -231,6 +234,7 @@ func (o ApplicationOutput) AutoSubscriptionConfiguration() ApplicationAutoSubscr }).(ApplicationAutoSubscriptionConfigurationPtrOutput) } +// The OIDC client ID for a Amazon Q Business application. func (o ApplicationOutput) ClientIdsForOidc() pulumi.StringArrayOutput { return o.ApplyT(func(v *Application) pulumi.StringArrayOutput { return v.ClientIdsForOidc }).(pulumi.StringArrayOutput) } diff --git a/sdk/go/aws/ram/getResourceShare.go b/sdk/go/aws/ram/getResourceShare.go new file mode 100644 index 0000000000..d77e4bd9a6 --- /dev/null +++ b/sdk/go/aws/ram/getResourceShare.go @@ -0,0 +1,106 @@ +// Code generated by pulumi-language-go DO NOT EDIT. +// *** WARNING: Do not edit by hand unless you're certain you know what you are doing! *** + +package ram + +import ( + "context" + "reflect" + + "github.com/pulumi/pulumi-aws-native/sdk/go/aws" + "github.com/pulumi/pulumi-aws-native/sdk/go/aws/internal" + "github.com/pulumi/pulumi/sdk/v3/go/pulumi" +) + +// Resource type definition for AWS::RAM::ResourceShare +func LookupResourceShare(ctx *pulumi.Context, args *LookupResourceShareArgs, opts ...pulumi.InvokeOption) (*LookupResourceShareResult, error) { + opts = internal.PkgInvokeDefaultOpts(opts) + var rv LookupResourceShareResult + err := ctx.Invoke("aws-native:ram:getResourceShare", args, &rv, opts...) + if err != nil { + return nil, err + } + return &rv, nil +} + +type LookupResourceShareArgs struct { + // The Amazon Resource Name (ARN) of the resource share. + Arn string `pulumi:"arn"` +} + +type LookupResourceShareResult struct { + // Specifies whether principals outside your organization in AWS Organizations can be associated with a resource share. A value of `true` lets you share with individual AWS accounts that are not in your organization. A value of `false` only has meaning if your account is a member of an AWS Organization. The default value is `true`. + AllowExternalPrincipals *bool `pulumi:"allowExternalPrincipals"` + // The Amazon Resource Name (ARN) of the resource share. + Arn *string `pulumi:"arn"` + // Specifies the name of the resource share. + Name *string `pulumi:"name"` + // Specifies one or more tags to attach to the resource share itself. It doesn't attach the tags to the resources associated with the resource share. + Tags []aws.Tag `pulumi:"tags"` +} + +func LookupResourceShareOutput(ctx *pulumi.Context, args LookupResourceShareOutputArgs, opts ...pulumi.InvokeOption) LookupResourceShareResultOutput { + return pulumi.ToOutputWithContext(context.Background(), args). + ApplyT(func(v interface{}) (LookupResourceShareResultOutput, error) { + args := v.(LookupResourceShareArgs) + opts = internal.PkgInvokeDefaultOpts(opts) + var rv LookupResourceShareResult + secret, err := ctx.InvokePackageRaw("aws-native:ram:getResourceShare", args, &rv, "", opts...) + if err != nil { + return LookupResourceShareResultOutput{}, err + } + + output := pulumi.ToOutput(rv).(LookupResourceShareResultOutput) + if secret { + return pulumi.ToSecret(output).(LookupResourceShareResultOutput), nil + } + return output, nil + }).(LookupResourceShareResultOutput) +} + +type LookupResourceShareOutputArgs struct { + // The Amazon Resource Name (ARN) of the resource share. + Arn pulumi.StringInput `pulumi:"arn"` +} + +func (LookupResourceShareOutputArgs) ElementType() reflect.Type { + return reflect.TypeOf((*LookupResourceShareArgs)(nil)).Elem() +} + +type LookupResourceShareResultOutput struct{ *pulumi.OutputState } + +func (LookupResourceShareResultOutput) ElementType() reflect.Type { + return reflect.TypeOf((*LookupResourceShareResult)(nil)).Elem() +} + +func (o LookupResourceShareResultOutput) ToLookupResourceShareResultOutput() LookupResourceShareResultOutput { + return o +} + +func (o LookupResourceShareResultOutput) ToLookupResourceShareResultOutputWithContext(ctx context.Context) LookupResourceShareResultOutput { + return o +} + +// Specifies whether principals outside your organization in AWS Organizations can be associated with a resource share. A value of `true` lets you share with individual AWS accounts that are not in your organization. A value of `false` only has meaning if your account is a member of an AWS Organization. The default value is `true`. +func (o LookupResourceShareResultOutput) AllowExternalPrincipals() pulumi.BoolPtrOutput { + return o.ApplyT(func(v LookupResourceShareResult) *bool { return v.AllowExternalPrincipals }).(pulumi.BoolPtrOutput) +} + +// The Amazon Resource Name (ARN) of the resource share. +func (o LookupResourceShareResultOutput) Arn() pulumi.StringPtrOutput { + return o.ApplyT(func(v LookupResourceShareResult) *string { return v.Arn }).(pulumi.StringPtrOutput) +} + +// Specifies the name of the resource share. +func (o LookupResourceShareResultOutput) Name() pulumi.StringPtrOutput { + return o.ApplyT(func(v LookupResourceShareResult) *string { return v.Name }).(pulumi.StringPtrOutput) +} + +// Specifies one or more tags to attach to the resource share itself. It doesn't attach the tags to the resources associated with the resource share. +func (o LookupResourceShareResultOutput) Tags() aws.TagArrayOutput { + return o.ApplyT(func(v LookupResourceShareResult) []aws.Tag { return v.Tags }).(aws.TagArrayOutput) +} + +func init() { + pulumi.RegisterOutputType(LookupResourceShareResultOutput{}) +} diff --git a/sdk/go/aws/ram/init.go b/sdk/go/aws/ram/init.go index 4ff620621b..b512687e6e 100644 --- a/sdk/go/aws/ram/init.go +++ b/sdk/go/aws/ram/init.go @@ -23,6 +23,8 @@ func (m *module) Construct(ctx *pulumi.Context, name, typ, urn string) (r pulumi switch typ { case "aws-native:ram:Permission": r = &Permission{} + case "aws-native:ram:ResourceShare": + r = &ResourceShare{} default: return nil, fmt.Errorf("unknown resource type: %s", typ) } diff --git a/sdk/go/aws/ram/pulumiTypes.go b/sdk/go/aws/ram/pulumiTypes.go index 453ff4cb02..93b1bb6dfc 100644 --- a/sdk/go/aws/ram/pulumiTypes.go +++ b/sdk/go/aws/ram/pulumiTypes.go @@ -16,5 +16,13 @@ type PermissionTag struct { Value string `pulumi:"value"` } +// A key-value pair to associate with a resource. +type ResourceShareTag struct { + // The key name of the tag. You can specify a value that is 1 to 128 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -. + Key string `pulumi:"key"` + // The value for the tag. You can specify a value that is 0 to 256 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -. + Value string `pulumi:"value"` +} + func init() { } diff --git a/sdk/go/aws/ram/resourceShare.go b/sdk/go/aws/ram/resourceShare.go new file mode 100644 index 0000000000..cfdd50b1f1 --- /dev/null +++ b/sdk/go/aws/ram/resourceShare.go @@ -0,0 +1,317 @@ +// Code generated by pulumi-language-go DO NOT EDIT. +// *** WARNING: Do not edit by hand unless you're certain you know what you are doing! *** + +package ram + +import ( + "context" + "reflect" + + "github.com/pulumi/pulumi-aws-native/sdk/go/aws" + "github.com/pulumi/pulumi-aws-native/sdk/go/aws/internal" + "github.com/pulumi/pulumi/sdk/v3/go/pulumi" +) + +// Resource type definition for AWS::RAM::ResourceShare +// +// ## Example Usage +// ### Example +// +// ```go +// package main +// +// import ( +// +// awsnative "github.com/pulumi/pulumi-aws-native/sdk/go/aws" +// "github.com/pulumi/pulumi-aws-native/sdk/go/aws/ram" +// "github.com/pulumi/pulumi/sdk/v3/go/pulumi" +// +// ) +// +// func main() { +// pulumi.Run(func(ctx *pulumi.Context) error { +// _, err := ram.NewResourceShare(ctx, "myresourceshare", &ram.ResourceShareArgs{ +// Name: pulumi.String("My Resource Share"), +// ResourceArns: pulumi.StringArray{ +// pulumi.String("arn:aws:ec2:us-east-1:123456789012:resource-type/12345678-1234-1234-1234-12345678"), +// }, +// Principals: pulumi.StringArray{ +// pulumi.String("210987654321"), +// }, +// Tags: aws.TagArray{ +// &aws.TagArgs{ +// Key: pulumi.String("Key1"), +// Value: pulumi.String("Value1"), +// }, +// &aws.TagArgs{ +// Key: pulumi.String("Key2"), +// Value: pulumi.String("Value2"), +// }, +// }, +// }) +// if err != nil { +// return err +// } +// return nil +// }) +// } +// +// ``` +// ### Example +// +// ```go +// package main +// +// import ( +// +// awsnative "github.com/pulumi/pulumi-aws-native/sdk/go/aws" +// "github.com/pulumi/pulumi-aws-native/sdk/go/aws/ram" +// "github.com/pulumi/pulumi/sdk/v3/go/pulumi" +// +// ) +// +// func main() { +// pulumi.Run(func(ctx *pulumi.Context) error { +// _, err := ram.NewResourceShare(ctx, "myresourceshare", &ram.ResourceShareArgs{ +// Name: pulumi.String("My Resource Share"), +// ResourceArns: pulumi.StringArray{ +// pulumi.String("arn:aws:ec2:us-east-1:123456789012:resource-type/12345678-1234-1234-1234-12345678"), +// }, +// Principals: pulumi.StringArray{ +// pulumi.String("210987654321"), +// }, +// Tags: aws.TagArray{ +// &aws.TagArgs{ +// Key: pulumi.String("Key1"), +// Value: pulumi.String("Value1"), +// }, +// &aws.TagArgs{ +// Key: pulumi.String("Key2"), +// Value: pulumi.String("Value2"), +// }, +// }, +// }) +// if err != nil { +// return err +// } +// return nil +// }) +// } +// +// ``` +type ResourceShare struct { + pulumi.CustomResourceState + + // Specifies whether principals outside your organization in AWS Organizations can be associated with a resource share. A value of `true` lets you share with individual AWS accounts that are not in your organization. A value of `false` only has meaning if your account is a member of an AWS Organization. The default value is `true`. + AllowExternalPrincipals pulumi.BoolPtrOutput `pulumi:"allowExternalPrincipals"` + // The Amazon Resource Name (ARN) of the resource share. + Arn pulumi.StringOutput `pulumi:"arn"` + // Specifies the name of the resource share. + Name pulumi.StringOutput `pulumi:"name"` + // Specifies the [Amazon Resource Names (ARNs)](https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html) of the AWS RAM permission to associate with the resource share. If you do not specify an ARN for the permission, AWS RAM automatically attaches the default version of the permission for each resource type. You can associate only one permission with each resource type included in the resource share. + PermissionArns pulumi.StringArrayOutput `pulumi:"permissionArns"` + // Specifies the principals to associate with the resource share. The possible values are: + // + // - An AWS account ID + // + // - An Amazon Resource Name (ARN) of an organization in AWS Organizations + // + // - An ARN of an organizational unit (OU) in AWS Organizations + // + // - An ARN of an IAM role + // + // - An ARN of an IAM user + Principals pulumi.StringArrayOutput `pulumi:"principals"` + // Specifies a list of one or more ARNs of the resources to associate with the resource share. + ResourceArns pulumi.StringArrayOutput `pulumi:"resourceArns"` + // Specifies from which source accounts the service principal has access to the resources in this resource share. + Sources pulumi.StringArrayOutput `pulumi:"sources"` + // Specifies one or more tags to attach to the resource share itself. It doesn't attach the tags to the resources associated with the resource share. + Tags aws.TagArrayOutput `pulumi:"tags"` +} + +// NewResourceShare registers a new resource with the given unique name, arguments, and options. +func NewResourceShare(ctx *pulumi.Context, + name string, args *ResourceShareArgs, opts ...pulumi.ResourceOption) (*ResourceShare, error) { + if args == nil { + args = &ResourceShareArgs{} + } + + opts = internal.PkgResourceDefaultOpts(opts) + var resource ResourceShare + err := ctx.RegisterResource("aws-native:ram:ResourceShare", name, args, &resource, opts...) + if err != nil { + return nil, err + } + return &resource, nil +} + +// GetResourceShare gets an existing ResourceShare resource's state with the given name, ID, and optional +// state properties that are used to uniquely qualify the lookup (nil if not required). +func GetResourceShare(ctx *pulumi.Context, + name string, id pulumi.IDInput, state *ResourceShareState, opts ...pulumi.ResourceOption) (*ResourceShare, error) { + var resource ResourceShare + err := ctx.ReadResource("aws-native:ram:ResourceShare", name, id, state, &resource, opts...) + if err != nil { + return nil, err + } + return &resource, nil +} + +// Input properties used for looking up and filtering ResourceShare resources. +type resourceShareState struct { +} + +type ResourceShareState struct { +} + +func (ResourceShareState) ElementType() reflect.Type { + return reflect.TypeOf((*resourceShareState)(nil)).Elem() +} + +type resourceShareArgs struct { + // Specifies whether principals outside your organization in AWS Organizations can be associated with a resource share. A value of `true` lets you share with individual AWS accounts that are not in your organization. A value of `false` only has meaning if your account is a member of an AWS Organization. The default value is `true`. + AllowExternalPrincipals *bool `pulumi:"allowExternalPrincipals"` + // Specifies the name of the resource share. + Name *string `pulumi:"name"` + // Specifies the [Amazon Resource Names (ARNs)](https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html) of the AWS RAM permission to associate with the resource share. If you do not specify an ARN for the permission, AWS RAM automatically attaches the default version of the permission for each resource type. You can associate only one permission with each resource type included in the resource share. + PermissionArns []string `pulumi:"permissionArns"` + // Specifies the principals to associate with the resource share. The possible values are: + // + // - An AWS account ID + // + // - An Amazon Resource Name (ARN) of an organization in AWS Organizations + // + // - An ARN of an organizational unit (OU) in AWS Organizations + // + // - An ARN of an IAM role + // + // - An ARN of an IAM user + Principals []string `pulumi:"principals"` + // Specifies a list of one or more ARNs of the resources to associate with the resource share. + ResourceArns []string `pulumi:"resourceArns"` + // Specifies from which source accounts the service principal has access to the resources in this resource share. + Sources []string `pulumi:"sources"` + // Specifies one or more tags to attach to the resource share itself. It doesn't attach the tags to the resources associated with the resource share. + Tags []aws.Tag `pulumi:"tags"` +} + +// The set of arguments for constructing a ResourceShare resource. +type ResourceShareArgs struct { + // Specifies whether principals outside your organization in AWS Organizations can be associated with a resource share. A value of `true` lets you share with individual AWS accounts that are not in your organization. A value of `false` only has meaning if your account is a member of an AWS Organization. The default value is `true`. + AllowExternalPrincipals pulumi.BoolPtrInput + // Specifies the name of the resource share. + Name pulumi.StringPtrInput + // Specifies the [Amazon Resource Names (ARNs)](https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html) of the AWS RAM permission to associate with the resource share. If you do not specify an ARN for the permission, AWS RAM automatically attaches the default version of the permission for each resource type. You can associate only one permission with each resource type included in the resource share. + PermissionArns pulumi.StringArrayInput + // Specifies the principals to associate with the resource share. The possible values are: + // + // - An AWS account ID + // + // - An Amazon Resource Name (ARN) of an organization in AWS Organizations + // + // - An ARN of an organizational unit (OU) in AWS Organizations + // + // - An ARN of an IAM role + // + // - An ARN of an IAM user + Principals pulumi.StringArrayInput + // Specifies a list of one or more ARNs of the resources to associate with the resource share. + ResourceArns pulumi.StringArrayInput + // Specifies from which source accounts the service principal has access to the resources in this resource share. + Sources pulumi.StringArrayInput + // Specifies one or more tags to attach to the resource share itself. It doesn't attach the tags to the resources associated with the resource share. + Tags aws.TagArrayInput +} + +func (ResourceShareArgs) ElementType() reflect.Type { + return reflect.TypeOf((*resourceShareArgs)(nil)).Elem() +} + +type ResourceShareInput interface { + pulumi.Input + + ToResourceShareOutput() ResourceShareOutput + ToResourceShareOutputWithContext(ctx context.Context) ResourceShareOutput +} + +func (*ResourceShare) ElementType() reflect.Type { + return reflect.TypeOf((**ResourceShare)(nil)).Elem() +} + +func (i *ResourceShare) ToResourceShareOutput() ResourceShareOutput { + return i.ToResourceShareOutputWithContext(context.Background()) +} + +func (i *ResourceShare) ToResourceShareOutputWithContext(ctx context.Context) ResourceShareOutput { + return pulumi.ToOutputWithContext(ctx, i).(ResourceShareOutput) +} + +type ResourceShareOutput struct{ *pulumi.OutputState } + +func (ResourceShareOutput) ElementType() reflect.Type { + return reflect.TypeOf((**ResourceShare)(nil)).Elem() +} + +func (o ResourceShareOutput) ToResourceShareOutput() ResourceShareOutput { + return o +} + +func (o ResourceShareOutput) ToResourceShareOutputWithContext(ctx context.Context) ResourceShareOutput { + return o +} + +// Specifies whether principals outside your organization in AWS Organizations can be associated with a resource share. A value of `true` lets you share with individual AWS accounts that are not in your organization. A value of `false` only has meaning if your account is a member of an AWS Organization. The default value is `true`. +func (o ResourceShareOutput) AllowExternalPrincipals() pulumi.BoolPtrOutput { + return o.ApplyT(func(v *ResourceShare) pulumi.BoolPtrOutput { return v.AllowExternalPrincipals }).(pulumi.BoolPtrOutput) +} + +// The Amazon Resource Name (ARN) of the resource share. +func (o ResourceShareOutput) Arn() pulumi.StringOutput { + return o.ApplyT(func(v *ResourceShare) pulumi.StringOutput { return v.Arn }).(pulumi.StringOutput) +} + +// Specifies the name of the resource share. +func (o ResourceShareOutput) Name() pulumi.StringOutput { + return o.ApplyT(func(v *ResourceShare) pulumi.StringOutput { return v.Name }).(pulumi.StringOutput) +} + +// Specifies the [Amazon Resource Names (ARNs)](https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html) of the AWS RAM permission to associate with the resource share. If you do not specify an ARN for the permission, AWS RAM automatically attaches the default version of the permission for each resource type. You can associate only one permission with each resource type included in the resource share. +func (o ResourceShareOutput) PermissionArns() pulumi.StringArrayOutput { + return o.ApplyT(func(v *ResourceShare) pulumi.StringArrayOutput { return v.PermissionArns }).(pulumi.StringArrayOutput) +} + +// Specifies the principals to associate with the resource share. The possible values are: +// +// - An AWS account ID +// +// - An Amazon Resource Name (ARN) of an organization in AWS Organizations +// +// - An ARN of an organizational unit (OU) in AWS Organizations +// +// - An ARN of an IAM role +// +// - An ARN of an IAM user +func (o ResourceShareOutput) Principals() pulumi.StringArrayOutput { + return o.ApplyT(func(v *ResourceShare) pulumi.StringArrayOutput { return v.Principals }).(pulumi.StringArrayOutput) +} + +// Specifies a list of one or more ARNs of the resources to associate with the resource share. +func (o ResourceShareOutput) ResourceArns() pulumi.StringArrayOutput { + return o.ApplyT(func(v *ResourceShare) pulumi.StringArrayOutput { return v.ResourceArns }).(pulumi.StringArrayOutput) +} + +// Specifies from which source accounts the service principal has access to the resources in this resource share. +func (o ResourceShareOutput) Sources() pulumi.StringArrayOutput { + return o.ApplyT(func(v *ResourceShare) pulumi.StringArrayOutput { return v.Sources }).(pulumi.StringArrayOutput) +} + +// Specifies one or more tags to attach to the resource share itself. It doesn't attach the tags to the resources associated with the resource share. +func (o ResourceShareOutput) Tags() aws.TagArrayOutput { + return o.ApplyT(func(v *ResourceShare) aws.TagArrayOutput { return v.Tags }).(aws.TagArrayOutput) +} + +func init() { + pulumi.RegisterInputType(reflect.TypeOf((*ResourceShareInput)(nil)).Elem(), &ResourceShare{}) + pulumi.RegisterOutputType(ResourceShareOutput{}) +} diff --git a/sdk/go/aws/rds/customDbEngineVersion.go b/sdk/go/aws/rds/customDbEngineVersion.go index ed6b70468e..1614d4dc3d 100644 --- a/sdk/go/aws/rds/customDbEngineVersion.go +++ b/sdk/go/aws/rds/customDbEngineVersion.go @@ -13,35 +13,45 @@ import ( "github.com/pulumi/pulumi/sdk/v3/go/pulumi" ) -// The AWS::RDS::CustomDBEngineVersion resource creates an Amazon RDS custom DB engine version. +// Creates a custom DB engine version (CEV). type CustomDbEngineVersion struct { pulumi.CustomResourceState - // The name of an Amazon S3 bucket that contains database installation files for your CEV. For example, a valid bucket name is `my-custom-installation-files`. + // The name of an Amazon S3 bucket that contains database installation files for your CEV. For example, a valid bucket name is ``my-custom-installation-files``. DatabaseInstallationFilesS3BucketName pulumi.StringPtrOutput `pulumi:"databaseInstallationFilesS3BucketName"` - // The Amazon S3 directory that contains the database installation files for your CEV. For example, a valid bucket name is `123456789012/cev1`. If this setting isn't specified, no prefix is assumed. + // The Amazon S3 directory that contains the database installation files for your CEV. For example, a valid bucket name is ``123456789012/cev1``. If this setting isn't specified, no prefix is assumed. DatabaseInstallationFilesS3Prefix pulumi.StringPtrOutput `pulumi:"databaseInstallationFilesS3Prefix"` // The ARN of the custom engine version. DbEngineVersionArn pulumi.StringOutput `pulumi:"dbEngineVersionArn"` // An optional description of your CEV. Description pulumi.StringPtrOutput `pulumi:"description"` - // The database engine to use for your custom engine version (CEV). The only supported value is `custom-oracle-ee`. + // The database engine to use for your custom engine version (CEV). + // Valid values: + // + ``custom-oracle-ee`` + // + ``custom-oracle-ee-cdb`` Engine pulumi.StringOutput `pulumi:"engine"` - // The name of your CEV. The name format is 19.customized_string . For example, a valid name is 19.my_cev1. This setting is required for RDS Custom for Oracle, but optional for Amazon RDS. The combination of Engine and EngineVersion is unique per customer per Region. + // The name of your CEV. The name format is ``major version.customized_string``. For example, a valid CEV name is ``19.my_cev1``. This setting is required for RDS Custom for Oracle, but optional for Amazon RDS. The combination of ``Engine`` and ``EngineVersion`` is unique per customer per Region. + // *Constraints:* Minimum length is 1. Maximum length is 60. + // *Pattern:* ``^[a-z0-9_.-]{1,60$``} EngineVersion pulumi.StringOutput `pulumi:"engineVersion"` - // The identifier of Amazon Machine Image (AMI) used for CEV. + // A value that indicates the ID of the AMI. ImageId pulumi.StringPtrOutput `pulumi:"imageId"` - // The AWS KMS key identifier for an encrypted CEV. A symmetric KMS key is required for RDS Custom, but optional for Amazon RDS. + // The AWS KMS key identifier for an encrypted CEV. A symmetric encryption KMS key is required for RDS Custom, but optional for Amazon RDS. + // If you have an existing symmetric encryption KMS key in your account, you can use it with RDS Custom. No further action is necessary. If you don't already have a symmetric encryption KMS key in your account, follow the instructions in [Creating a symmetric encryption KMS key](https://docs.aws.amazon.com/kms/latest/developerguide/create-keys.html#create-symmetric-cmk) in the *Key Management Service Developer Guide*. + // You can choose the same symmetric encryption key when you create a CEV and a DB instance, or choose different keys. KmsKeyId pulumi.StringPtrOutput `pulumi:"kmsKeyId"` // The CEV manifest, which is a JSON document that describes the installation .zip files stored in Amazon S3. Specify the name/value pairs in a file or a quoted string. RDS Custom applies the patches in the order in which they are listed. + // The following JSON fields are valid: + // + MediaImportTemplateVersion Version of the CEV manifest. The date is in the format YYYY-MM-DD. + databaseInstallationFileNames Ordered list of installation files for the CEV. + opatchFileNames Ordered list of OPatch installers used for the Oracle DB engine. + psuRuPatchFileNames The PSU and RU patches for this CEV. + OtherPatchFileNames The patches that are not in the list of PSU and RU patches. Amazon RDS applies these patches after applying the PSU and RU patches. + // For more information, see [Creating the CEV manifest](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/custom-cev.html#custom-cev.preparing.manifest) in the *Amazon RDS User Guide*. Manifest pulumi.StringPtrOutput `pulumi:"manifest"` - // The identifier of the source custom engine version. + // The ARN of a CEV to use as a source for creating a new CEV. You can specify a different Amazon Machine Imagine (AMI) by using either ``Source`` or ``UseAwsProvidedLatestImage``. You can't specify a different JSON manifest when you specify ``SourceCustomDbEngineVersionIdentifier``. SourceCustomDbEngineVersionIdentifier pulumi.StringPtrOutput `pulumi:"sourceCustomDbEngineVersionIdentifier"` - // The availability status to be assigned to the CEV. + // A value that indicates the status of a custom engine version (CEV). Status CustomDbEngineVersionStatusPtrOutput `pulumi:"status"` - // An array of key-value pairs to apply to this resource. + // A list of tags. For more information, see [Tagging Amazon RDS Resources](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_Tagging.html) in the *Amazon RDS User Guide.* Tags aws.TagArrayOutput `pulumi:"tags"` - // A value that indicates whether AWS provided latest image is applied automatically to the Custom Engine Version. By default, AWS provided latest image is applied automatically. This value is only applied on create. + // Specifies whether to use the latest service-provided Amazon Machine Image (AMI) for the CEV. If you specify ``UseAwsProvidedLatestImage``, you can't also specify ``ImageId``. UseAwsProvidedLatestImage pulumi.BoolPtrOutput `pulumi:"useAwsProvidedLatestImage"` } @@ -103,57 +113,77 @@ func (CustomDbEngineVersionState) ElementType() reflect.Type { } type customDbEngineVersionArgs struct { - // The name of an Amazon S3 bucket that contains database installation files for your CEV. For example, a valid bucket name is `my-custom-installation-files`. + // The name of an Amazon S3 bucket that contains database installation files for your CEV. For example, a valid bucket name is ``my-custom-installation-files``. DatabaseInstallationFilesS3BucketName *string `pulumi:"databaseInstallationFilesS3BucketName"` - // The Amazon S3 directory that contains the database installation files for your CEV. For example, a valid bucket name is `123456789012/cev1`. If this setting isn't specified, no prefix is assumed. + // The Amazon S3 directory that contains the database installation files for your CEV. For example, a valid bucket name is ``123456789012/cev1``. If this setting isn't specified, no prefix is assumed. DatabaseInstallationFilesS3Prefix *string `pulumi:"databaseInstallationFilesS3Prefix"` // An optional description of your CEV. Description *string `pulumi:"description"` - // The database engine to use for your custom engine version (CEV). The only supported value is `custom-oracle-ee`. + // The database engine to use for your custom engine version (CEV). + // Valid values: + // + ``custom-oracle-ee`` + // + ``custom-oracle-ee-cdb`` Engine string `pulumi:"engine"` - // The name of your CEV. The name format is 19.customized_string . For example, a valid name is 19.my_cev1. This setting is required for RDS Custom for Oracle, but optional for Amazon RDS. The combination of Engine and EngineVersion is unique per customer per Region. + // The name of your CEV. The name format is ``major version.customized_string``. For example, a valid CEV name is ``19.my_cev1``. This setting is required for RDS Custom for Oracle, but optional for Amazon RDS. The combination of ``Engine`` and ``EngineVersion`` is unique per customer per Region. + // *Constraints:* Minimum length is 1. Maximum length is 60. + // *Pattern:* ``^[a-z0-9_.-]{1,60$``} EngineVersion string `pulumi:"engineVersion"` - // The identifier of Amazon Machine Image (AMI) used for CEV. + // A value that indicates the ID of the AMI. ImageId *string `pulumi:"imageId"` - // The AWS KMS key identifier for an encrypted CEV. A symmetric KMS key is required for RDS Custom, but optional for Amazon RDS. + // The AWS KMS key identifier for an encrypted CEV. A symmetric encryption KMS key is required for RDS Custom, but optional for Amazon RDS. + // If you have an existing symmetric encryption KMS key in your account, you can use it with RDS Custom. No further action is necessary. If you don't already have a symmetric encryption KMS key in your account, follow the instructions in [Creating a symmetric encryption KMS key](https://docs.aws.amazon.com/kms/latest/developerguide/create-keys.html#create-symmetric-cmk) in the *Key Management Service Developer Guide*. + // You can choose the same symmetric encryption key when you create a CEV and a DB instance, or choose different keys. KmsKeyId *string `pulumi:"kmsKeyId"` // The CEV manifest, which is a JSON document that describes the installation .zip files stored in Amazon S3. Specify the name/value pairs in a file or a quoted string. RDS Custom applies the patches in the order in which they are listed. + // The following JSON fields are valid: + // + MediaImportTemplateVersion Version of the CEV manifest. The date is in the format YYYY-MM-DD. + databaseInstallationFileNames Ordered list of installation files for the CEV. + opatchFileNames Ordered list of OPatch installers used for the Oracle DB engine. + psuRuPatchFileNames The PSU and RU patches for this CEV. + OtherPatchFileNames The patches that are not in the list of PSU and RU patches. Amazon RDS applies these patches after applying the PSU and RU patches. + // For more information, see [Creating the CEV manifest](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/custom-cev.html#custom-cev.preparing.manifest) in the *Amazon RDS User Guide*. Manifest *string `pulumi:"manifest"` - // The identifier of the source custom engine version. + // The ARN of a CEV to use as a source for creating a new CEV. You can specify a different Amazon Machine Imagine (AMI) by using either ``Source`` or ``UseAwsProvidedLatestImage``. You can't specify a different JSON manifest when you specify ``SourceCustomDbEngineVersionIdentifier``. SourceCustomDbEngineVersionIdentifier *string `pulumi:"sourceCustomDbEngineVersionIdentifier"` - // The availability status to be assigned to the CEV. + // A value that indicates the status of a custom engine version (CEV). Status *CustomDbEngineVersionStatus `pulumi:"status"` - // An array of key-value pairs to apply to this resource. + // A list of tags. For more information, see [Tagging Amazon RDS Resources](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_Tagging.html) in the *Amazon RDS User Guide.* Tags []aws.Tag `pulumi:"tags"` - // A value that indicates whether AWS provided latest image is applied automatically to the Custom Engine Version. By default, AWS provided latest image is applied automatically. This value is only applied on create. + // Specifies whether to use the latest service-provided Amazon Machine Image (AMI) for the CEV. If you specify ``UseAwsProvidedLatestImage``, you can't also specify ``ImageId``. UseAwsProvidedLatestImage *bool `pulumi:"useAwsProvidedLatestImage"` } // The set of arguments for constructing a CustomDbEngineVersion resource. type CustomDbEngineVersionArgs struct { - // The name of an Amazon S3 bucket that contains database installation files for your CEV. For example, a valid bucket name is `my-custom-installation-files`. + // The name of an Amazon S3 bucket that contains database installation files for your CEV. For example, a valid bucket name is ``my-custom-installation-files``. DatabaseInstallationFilesS3BucketName pulumi.StringPtrInput - // The Amazon S3 directory that contains the database installation files for your CEV. For example, a valid bucket name is `123456789012/cev1`. If this setting isn't specified, no prefix is assumed. + // The Amazon S3 directory that contains the database installation files for your CEV. For example, a valid bucket name is ``123456789012/cev1``. If this setting isn't specified, no prefix is assumed. DatabaseInstallationFilesS3Prefix pulumi.StringPtrInput // An optional description of your CEV. Description pulumi.StringPtrInput - // The database engine to use for your custom engine version (CEV). The only supported value is `custom-oracle-ee`. + // The database engine to use for your custom engine version (CEV). + // Valid values: + // + ``custom-oracle-ee`` + // + ``custom-oracle-ee-cdb`` Engine pulumi.StringInput - // The name of your CEV. The name format is 19.customized_string . For example, a valid name is 19.my_cev1. This setting is required for RDS Custom for Oracle, but optional for Amazon RDS. The combination of Engine and EngineVersion is unique per customer per Region. + // The name of your CEV. The name format is ``major version.customized_string``. For example, a valid CEV name is ``19.my_cev1``. This setting is required for RDS Custom for Oracle, but optional for Amazon RDS. The combination of ``Engine`` and ``EngineVersion`` is unique per customer per Region. + // *Constraints:* Minimum length is 1. Maximum length is 60. + // *Pattern:* ``^[a-z0-9_.-]{1,60$``} EngineVersion pulumi.StringInput - // The identifier of Amazon Machine Image (AMI) used for CEV. + // A value that indicates the ID of the AMI. ImageId pulumi.StringPtrInput - // The AWS KMS key identifier for an encrypted CEV. A symmetric KMS key is required for RDS Custom, but optional for Amazon RDS. + // The AWS KMS key identifier for an encrypted CEV. A symmetric encryption KMS key is required for RDS Custom, but optional for Amazon RDS. + // If you have an existing symmetric encryption KMS key in your account, you can use it with RDS Custom. No further action is necessary. If you don't already have a symmetric encryption KMS key in your account, follow the instructions in [Creating a symmetric encryption KMS key](https://docs.aws.amazon.com/kms/latest/developerguide/create-keys.html#create-symmetric-cmk) in the *Key Management Service Developer Guide*. + // You can choose the same symmetric encryption key when you create a CEV and a DB instance, or choose different keys. KmsKeyId pulumi.StringPtrInput // The CEV manifest, which is a JSON document that describes the installation .zip files stored in Amazon S3. Specify the name/value pairs in a file or a quoted string. RDS Custom applies the patches in the order in which they are listed. + // The following JSON fields are valid: + // + MediaImportTemplateVersion Version of the CEV manifest. The date is in the format YYYY-MM-DD. + databaseInstallationFileNames Ordered list of installation files for the CEV. + opatchFileNames Ordered list of OPatch installers used for the Oracle DB engine. + psuRuPatchFileNames The PSU and RU patches for this CEV. + OtherPatchFileNames The patches that are not in the list of PSU and RU patches. Amazon RDS applies these patches after applying the PSU and RU patches. + // For more information, see [Creating the CEV manifest](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/custom-cev.html#custom-cev.preparing.manifest) in the *Amazon RDS User Guide*. Manifest pulumi.StringPtrInput - // The identifier of the source custom engine version. + // The ARN of a CEV to use as a source for creating a new CEV. You can specify a different Amazon Machine Imagine (AMI) by using either ``Source`` or ``UseAwsProvidedLatestImage``. You can't specify a different JSON manifest when you specify ``SourceCustomDbEngineVersionIdentifier``. SourceCustomDbEngineVersionIdentifier pulumi.StringPtrInput - // The availability status to be assigned to the CEV. + // A value that indicates the status of a custom engine version (CEV). Status CustomDbEngineVersionStatusPtrInput - // An array of key-value pairs to apply to this resource. + // A list of tags. For more information, see [Tagging Amazon RDS Resources](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_Tagging.html) in the *Amazon RDS User Guide.* Tags aws.TagArrayInput - // A value that indicates whether AWS provided latest image is applied automatically to the Custom Engine Version. By default, AWS provided latest image is applied automatically. This value is only applied on create. + // Specifies whether to use the latest service-provided Amazon Machine Image (AMI) for the CEV. If you specify ``UseAwsProvidedLatestImage``, you can't also specify ``ImageId``. UseAwsProvidedLatestImage pulumi.BoolPtrInput } @@ -194,12 +224,12 @@ func (o CustomDbEngineVersionOutput) ToCustomDbEngineVersionOutputWithContext(ct return o } -// The name of an Amazon S3 bucket that contains database installation files for your CEV. For example, a valid bucket name is `my-custom-installation-files`. +// The name of an Amazon S3 bucket that contains database installation files for your CEV. For example, a valid bucket name is “my-custom-installation-files“. func (o CustomDbEngineVersionOutput) DatabaseInstallationFilesS3BucketName() pulumi.StringPtrOutput { return o.ApplyT(func(v *CustomDbEngineVersion) pulumi.StringPtrOutput { return v.DatabaseInstallationFilesS3BucketName }).(pulumi.StringPtrOutput) } -// The Amazon S3 directory that contains the database installation files for your CEV. For example, a valid bucket name is `123456789012/cev1`. If this setting isn't specified, no prefix is assumed. +// The Amazon S3 directory that contains the database installation files for your CEV. For example, a valid bucket name is “123456789012/cev1“. If this setting isn't specified, no prefix is assumed. func (o CustomDbEngineVersionOutput) DatabaseInstallationFilesS3Prefix() pulumi.StringPtrOutput { return o.ApplyT(func(v *CustomDbEngineVersion) pulumi.StringPtrOutput { return v.DatabaseInstallationFilesS3Prefix }).(pulumi.StringPtrOutput) } @@ -214,47 +244,61 @@ func (o CustomDbEngineVersionOutput) Description() pulumi.StringPtrOutput { return o.ApplyT(func(v *CustomDbEngineVersion) pulumi.StringPtrOutput { return v.Description }).(pulumi.StringPtrOutput) } -// The database engine to use for your custom engine version (CEV). The only supported value is `custom-oracle-ee`. +// The database engine to use for your custom engine version (CEV). +// +// Valid values: +// + ``custom-oracle-ee`` +// + ``custom-oracle-ee-cdb`` func (o CustomDbEngineVersionOutput) Engine() pulumi.StringOutput { return o.ApplyT(func(v *CustomDbEngineVersion) pulumi.StringOutput { return v.Engine }).(pulumi.StringOutput) } -// The name of your CEV. The name format is 19.customized_string . For example, a valid name is 19.my_cev1. This setting is required for RDS Custom for Oracle, but optional for Amazon RDS. The combination of Engine and EngineVersion is unique per customer per Region. +// The name of your CEV. The name format is “major version.customized_string“. For example, a valid CEV name is “19.my_cev1“. This setting is required for RDS Custom for Oracle, but optional for Amazon RDS. The combination of “Engine“ and “EngineVersion“ is unique per customer per Region. +// +// *Constraints:* Minimum length is 1. Maximum length is 60. +// *Pattern:* ``^[a-z0-9_.-]{1,60$``} func (o CustomDbEngineVersionOutput) EngineVersion() pulumi.StringOutput { return o.ApplyT(func(v *CustomDbEngineVersion) pulumi.StringOutput { return v.EngineVersion }).(pulumi.StringOutput) } -// The identifier of Amazon Machine Image (AMI) used for CEV. +// A value that indicates the ID of the AMI. func (o CustomDbEngineVersionOutput) ImageId() pulumi.StringPtrOutput { return o.ApplyT(func(v *CustomDbEngineVersion) pulumi.StringPtrOutput { return v.ImageId }).(pulumi.StringPtrOutput) } -// The AWS KMS key identifier for an encrypted CEV. A symmetric KMS key is required for RDS Custom, but optional for Amazon RDS. +// The AWS KMS key identifier for an encrypted CEV. A symmetric encryption KMS key is required for RDS Custom, but optional for Amazon RDS. +// +// If you have an existing symmetric encryption KMS key in your account, you can use it with RDS Custom. No further action is necessary. If you don't already have a symmetric encryption KMS key in your account, follow the instructions in [Creating a symmetric encryption KMS key](https://docs.aws.amazon.com/kms/latest/developerguide/create-keys.html#create-symmetric-cmk) in the *Key Management Service Developer Guide*. +// You can choose the same symmetric encryption key when you create a CEV and a DB instance, or choose different keys. func (o CustomDbEngineVersionOutput) KmsKeyId() pulumi.StringPtrOutput { return o.ApplyT(func(v *CustomDbEngineVersion) pulumi.StringPtrOutput { return v.KmsKeyId }).(pulumi.StringPtrOutput) } // The CEV manifest, which is a JSON document that describes the installation .zip files stored in Amazon S3. Specify the name/value pairs in a file or a quoted string. RDS Custom applies the patches in the order in which they are listed. +// +// The following JSON fields are valid: +// + MediaImportTemplateVersion Version of the CEV manifest. The date is in the format YYYY-MM-DD. + databaseInstallationFileNames Ordered list of installation files for the CEV. + opatchFileNames Ordered list of OPatch installers used for the Oracle DB engine. + psuRuPatchFileNames The PSU and RU patches for this CEV. + OtherPatchFileNames The patches that are not in the list of PSU and RU patches. Amazon RDS applies these patches after applying the PSU and RU patches. +// For more information, see [Creating the CEV manifest](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/custom-cev.html#custom-cev.preparing.manifest) in the *Amazon RDS User Guide*. func (o CustomDbEngineVersionOutput) Manifest() pulumi.StringPtrOutput { return o.ApplyT(func(v *CustomDbEngineVersion) pulumi.StringPtrOutput { return v.Manifest }).(pulumi.StringPtrOutput) } -// The identifier of the source custom engine version. +// The ARN of a CEV to use as a source for creating a new CEV. You can specify a different Amazon Machine Imagine (AMI) by using either “Source“ or “UseAwsProvidedLatestImage“. You can't specify a different JSON manifest when you specify “SourceCustomDbEngineVersionIdentifier“. func (o CustomDbEngineVersionOutput) SourceCustomDbEngineVersionIdentifier() pulumi.StringPtrOutput { return o.ApplyT(func(v *CustomDbEngineVersion) pulumi.StringPtrOutput { return v.SourceCustomDbEngineVersionIdentifier }).(pulumi.StringPtrOutput) } -// The availability status to be assigned to the CEV. +// A value that indicates the status of a custom engine version (CEV). func (o CustomDbEngineVersionOutput) Status() CustomDbEngineVersionStatusPtrOutput { return o.ApplyT(func(v *CustomDbEngineVersion) CustomDbEngineVersionStatusPtrOutput { return v.Status }).(CustomDbEngineVersionStatusPtrOutput) } -// An array of key-value pairs to apply to this resource. +// A list of tags. For more information, see [Tagging Amazon RDS Resources](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_Tagging.html) in the *Amazon RDS User Guide.* func (o CustomDbEngineVersionOutput) Tags() aws.TagArrayOutput { return o.ApplyT(func(v *CustomDbEngineVersion) aws.TagArrayOutput { return v.Tags }).(aws.TagArrayOutput) } -// A value that indicates whether AWS provided latest image is applied automatically to the Custom Engine Version. By default, AWS provided latest image is applied automatically. This value is only applied on create. +// Specifies whether to use the latest service-provided Amazon Machine Image (AMI) for the CEV. If you specify “UseAwsProvidedLatestImage“, you can't also specify “ImageId“. func (o CustomDbEngineVersionOutput) UseAwsProvidedLatestImage() pulumi.BoolPtrOutput { return o.ApplyT(func(v *CustomDbEngineVersion) pulumi.BoolPtrOutput { return v.UseAwsProvidedLatestImage }).(pulumi.BoolPtrOutput) } diff --git a/sdk/go/aws/rds/getCustomDbEngineVersion.go b/sdk/go/aws/rds/getCustomDbEngineVersion.go index 0d8f92d6a1..e9a935af78 100644 --- a/sdk/go/aws/rds/getCustomDbEngineVersion.go +++ b/sdk/go/aws/rds/getCustomDbEngineVersion.go @@ -12,7 +12,7 @@ import ( "github.com/pulumi/pulumi/sdk/v3/go/pulumi" ) -// The AWS::RDS::CustomDBEngineVersion resource creates an Amazon RDS custom DB engine version. +// Creates a custom DB engine version (CEV). func LookupCustomDbEngineVersion(ctx *pulumi.Context, args *LookupCustomDbEngineVersionArgs, opts ...pulumi.InvokeOption) (*LookupCustomDbEngineVersionResult, error) { opts = internal.PkgInvokeDefaultOpts(opts) var rv LookupCustomDbEngineVersionResult @@ -24,9 +24,14 @@ func LookupCustomDbEngineVersion(ctx *pulumi.Context, args *LookupCustomDbEngine } type LookupCustomDbEngineVersionArgs struct { - // The database engine to use for your custom engine version (CEV). The only supported value is `custom-oracle-ee`. + // The database engine to use for your custom engine version (CEV). + // Valid values: + // + ``custom-oracle-ee`` + // + ``custom-oracle-ee-cdb`` Engine string `pulumi:"engine"` - // The name of your CEV. The name format is 19.customized_string . For example, a valid name is 19.my_cev1. This setting is required for RDS Custom for Oracle, but optional for Amazon RDS. The combination of Engine and EngineVersion is unique per customer per Region. + // The name of your CEV. The name format is ``major version.customized_string``. For example, a valid CEV name is ``19.my_cev1``. This setting is required for RDS Custom for Oracle, but optional for Amazon RDS. The combination of ``Engine`` and ``EngineVersion`` is unique per customer per Region. + // *Constraints:* Minimum length is 1. Maximum length is 60. + // *Pattern:* ``^[a-z0-9_.-]{1,60$``} EngineVersion string `pulumi:"engineVersion"` } @@ -35,9 +40,9 @@ type LookupCustomDbEngineVersionResult struct { DbEngineVersionArn *string `pulumi:"dbEngineVersionArn"` // An optional description of your CEV. Description *string `pulumi:"description"` - // The availability status to be assigned to the CEV. + // A value that indicates the status of a custom engine version (CEV). Status *CustomDbEngineVersionStatus `pulumi:"status"` - // An array of key-value pairs to apply to this resource. + // A list of tags. For more information, see [Tagging Amazon RDS Resources](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_Tagging.html) in the *Amazon RDS User Guide.* Tags []aws.Tag `pulumi:"tags"` } @@ -61,9 +66,14 @@ func LookupCustomDbEngineVersionOutput(ctx *pulumi.Context, args LookupCustomDbE } type LookupCustomDbEngineVersionOutputArgs struct { - // The database engine to use for your custom engine version (CEV). The only supported value is `custom-oracle-ee`. + // The database engine to use for your custom engine version (CEV). + // Valid values: + // + ``custom-oracle-ee`` + // + ``custom-oracle-ee-cdb`` Engine pulumi.StringInput `pulumi:"engine"` - // The name of your CEV. The name format is 19.customized_string . For example, a valid name is 19.my_cev1. This setting is required for RDS Custom for Oracle, but optional for Amazon RDS. The combination of Engine and EngineVersion is unique per customer per Region. + // The name of your CEV. The name format is ``major version.customized_string``. For example, a valid CEV name is ``19.my_cev1``. This setting is required for RDS Custom for Oracle, but optional for Amazon RDS. The combination of ``Engine`` and ``EngineVersion`` is unique per customer per Region. + // *Constraints:* Minimum length is 1. Maximum length is 60. + // *Pattern:* ``^[a-z0-9_.-]{1,60$``} EngineVersion pulumi.StringInput `pulumi:"engineVersion"` } @@ -95,12 +105,12 @@ func (o LookupCustomDbEngineVersionResultOutput) Description() pulumi.StringPtrO return o.ApplyT(func(v LookupCustomDbEngineVersionResult) *string { return v.Description }).(pulumi.StringPtrOutput) } -// The availability status to be assigned to the CEV. +// A value that indicates the status of a custom engine version (CEV). func (o LookupCustomDbEngineVersionResultOutput) Status() CustomDbEngineVersionStatusPtrOutput { return o.ApplyT(func(v LookupCustomDbEngineVersionResult) *CustomDbEngineVersionStatus { return v.Status }).(CustomDbEngineVersionStatusPtrOutput) } -// An array of key-value pairs to apply to this resource. +// A list of tags. For more information, see [Tagging Amazon RDS Resources](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_Tagging.html) in the *Amazon RDS User Guide.* func (o LookupCustomDbEngineVersionResultOutput) Tags() aws.TagArrayOutput { return o.ApplyT(func(v LookupCustomDbEngineVersionResult) []aws.Tag { return v.Tags }).(aws.TagArrayOutput) } diff --git a/sdk/go/aws/rds/pulumiEnums.go b/sdk/go/aws/rds/pulumiEnums.go index 5b37535ad0..6e40fbbb94 100644 --- a/sdk/go/aws/rds/pulumiEnums.go +++ b/sdk/go/aws/rds/pulumiEnums.go @@ -10,7 +10,7 @@ import ( "github.com/pulumi/pulumi/sdk/v3/go/pulumi" ) -// The availability status to be assigned to the CEV. +// A value that indicates the status of a custom engine version (CEV). type CustomDbEngineVersionStatus string const ( diff --git a/sdk/go/aws/rds/pulumiTypes.go b/sdk/go/aws/rds/pulumiTypes.go index 8a4355ecb9..38d1f34772 100644 --- a/sdk/go/aws/rds/pulumiTypes.go +++ b/sdk/go/aws/rds/pulumiTypes.go @@ -13,11 +13,13 @@ import ( var _ = internal.GetEnvOrDefault -// A key-value pair to associate with a resource. +// Metadata assigned to an Amazon RDS resource consisting of a key-value pair. +// +// For more information, see [Tagging Amazon RDS resources](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_Tagging.html) in the *Amazon RDS User Guide* or [Tagging Amazon Aurora and Amazon RDS resources](https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/USER_Tagging.html) in the *Amazon Aurora User Guide*. type CustomDbEngineVersionTag struct { - // The key name of the tag. You can specify a value that is 1 to 128 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -. + // A key is the required name of the tag. The string value can be from 1 to 128 Unicode characters in length and can't be prefixed with ``aws:`` or ``rds:``. The string can only contain only the set of Unicode letters, digits, white-space, '_', '.', ':', '/', '=', '+', '-', '@' (Java regex: "^([\\p{L}\\p{Z}\\p{N}_.:/=+\\-@]*)$"). Key string `pulumi:"key"` - // The value for the tag. You can specify a value that is 0 to 256 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -. + // A value is the optional value of the tag. The string value can be from 1 to 256 Unicode characters in length and can't be prefixed with ``aws:`` or ``rds:``. The string can only contain only the set of Unicode letters, digits, white-space, '_', '.', ':', '/', '=', '+', '-', '@' (Java regex: "^([\\p{L}\\p{Z}\\p{N}_.:/=+\\-@]*)$"). Value *string `pulumi:"value"` } diff --git a/sdk/go/aws/redshiftserverless/getWorkgroup.go b/sdk/go/aws/redshiftserverless/getWorkgroup.go index 73b6913274..eab2c7bfa5 100644 --- a/sdk/go/aws/redshiftserverless/getWorkgroup.go +++ b/sdk/go/aws/redshiftserverless/getWorkgroup.go @@ -33,6 +33,8 @@ type LookupWorkgroupResult struct { EnhancedVpcRouting *bool `pulumi:"enhancedVpcRouting"` // The custom port to use when connecting to a workgroup. Valid port ranges are 5431-5455 and 8191-8215. The default is 5439. Port *int `pulumi:"port"` + // A property that represents the price performance target settings for the workgroup. + PricePerformanceTarget *WorkgroupPerformanceTarget `pulumi:"pricePerformanceTarget"` // A value that specifies whether the workgroup can be accessible from a public network. PubliclyAccessible *bool `pulumi:"publiclyAccessible"` // The map of the key-value pairs used to tag the workgroup. @@ -93,6 +95,11 @@ func (o LookupWorkgroupResultOutput) Port() pulumi.IntPtrOutput { return o.ApplyT(func(v LookupWorkgroupResult) *int { return v.Port }).(pulumi.IntPtrOutput) } +// A property that represents the price performance target settings for the workgroup. +func (o LookupWorkgroupResultOutput) PricePerformanceTarget() WorkgroupPerformanceTargetPtrOutput { + return o.ApplyT(func(v LookupWorkgroupResult) *WorkgroupPerformanceTarget { return v.PricePerformanceTarget }).(WorkgroupPerformanceTargetPtrOutput) +} + // A value that specifies whether the workgroup can be accessible from a public network. func (o LookupWorkgroupResultOutput) PubliclyAccessible() pulumi.BoolPtrOutput { return o.ApplyT(func(v LookupWorkgroupResult) *bool { return v.PubliclyAccessible }).(pulumi.BoolPtrOutput) diff --git a/sdk/go/aws/redshiftserverless/pulumiEnums.go b/sdk/go/aws/redshiftserverless/pulumiEnums.go index 12db4e80bc..e75f4cec0e 100644 --- a/sdk/go/aws/redshiftserverless/pulumiEnums.go +++ b/sdk/go/aws/redshiftserverless/pulumiEnums.go @@ -313,6 +313,171 @@ func (o NamespaceStatusPtrOutput) ToStringPtrOutputWithContext(ctx context.Conte }).(pulumi.StringPtrOutput) } +type WorkgroupPerformanceTargetStatus string + +const ( + WorkgroupPerformanceTargetStatusEnabled = WorkgroupPerformanceTargetStatus("ENABLED") + WorkgroupPerformanceTargetStatusDisabled = WorkgroupPerformanceTargetStatus("DISABLED") +) + +func (WorkgroupPerformanceTargetStatus) ElementType() reflect.Type { + return reflect.TypeOf((*WorkgroupPerformanceTargetStatus)(nil)).Elem() +} + +func (e WorkgroupPerformanceTargetStatus) ToWorkgroupPerformanceTargetStatusOutput() WorkgroupPerformanceTargetStatusOutput { + return pulumi.ToOutput(e).(WorkgroupPerformanceTargetStatusOutput) +} + +func (e WorkgroupPerformanceTargetStatus) ToWorkgroupPerformanceTargetStatusOutputWithContext(ctx context.Context) WorkgroupPerformanceTargetStatusOutput { + return pulumi.ToOutputWithContext(ctx, e).(WorkgroupPerformanceTargetStatusOutput) +} + +func (e WorkgroupPerformanceTargetStatus) ToWorkgroupPerformanceTargetStatusPtrOutput() WorkgroupPerformanceTargetStatusPtrOutput { + return e.ToWorkgroupPerformanceTargetStatusPtrOutputWithContext(context.Background()) +} + +func (e WorkgroupPerformanceTargetStatus) ToWorkgroupPerformanceTargetStatusPtrOutputWithContext(ctx context.Context) WorkgroupPerformanceTargetStatusPtrOutput { + return WorkgroupPerformanceTargetStatus(e).ToWorkgroupPerformanceTargetStatusOutputWithContext(ctx).ToWorkgroupPerformanceTargetStatusPtrOutputWithContext(ctx) +} + +func (e WorkgroupPerformanceTargetStatus) ToStringOutput() pulumi.StringOutput { + return pulumi.ToOutput(pulumi.String(e)).(pulumi.StringOutput) +} + +func (e WorkgroupPerformanceTargetStatus) ToStringOutputWithContext(ctx context.Context) pulumi.StringOutput { + return pulumi.ToOutputWithContext(ctx, pulumi.String(e)).(pulumi.StringOutput) +} + +func (e WorkgroupPerformanceTargetStatus) ToStringPtrOutput() pulumi.StringPtrOutput { + return pulumi.String(e).ToStringPtrOutputWithContext(context.Background()) +} + +func (e WorkgroupPerformanceTargetStatus) ToStringPtrOutputWithContext(ctx context.Context) pulumi.StringPtrOutput { + return pulumi.String(e).ToStringOutputWithContext(ctx).ToStringPtrOutputWithContext(ctx) +} + +type WorkgroupPerformanceTargetStatusOutput struct{ *pulumi.OutputState } + +func (WorkgroupPerformanceTargetStatusOutput) ElementType() reflect.Type { + return reflect.TypeOf((*WorkgroupPerformanceTargetStatus)(nil)).Elem() +} + +func (o WorkgroupPerformanceTargetStatusOutput) ToWorkgroupPerformanceTargetStatusOutput() WorkgroupPerformanceTargetStatusOutput { + return o +} + +func (o WorkgroupPerformanceTargetStatusOutput) ToWorkgroupPerformanceTargetStatusOutputWithContext(ctx context.Context) WorkgroupPerformanceTargetStatusOutput { + return o +} + +func (o WorkgroupPerformanceTargetStatusOutput) ToWorkgroupPerformanceTargetStatusPtrOutput() WorkgroupPerformanceTargetStatusPtrOutput { + return o.ToWorkgroupPerformanceTargetStatusPtrOutputWithContext(context.Background()) +} + +func (o WorkgroupPerformanceTargetStatusOutput) ToWorkgroupPerformanceTargetStatusPtrOutputWithContext(ctx context.Context) WorkgroupPerformanceTargetStatusPtrOutput { + return o.ApplyTWithContext(ctx, func(_ context.Context, v WorkgroupPerformanceTargetStatus) *WorkgroupPerformanceTargetStatus { + return &v + }).(WorkgroupPerformanceTargetStatusPtrOutput) +} + +func (o WorkgroupPerformanceTargetStatusOutput) ToStringOutput() pulumi.StringOutput { + return o.ToStringOutputWithContext(context.Background()) +} + +func (o WorkgroupPerformanceTargetStatusOutput) ToStringOutputWithContext(ctx context.Context) pulumi.StringOutput { + return o.ApplyTWithContext(ctx, func(_ context.Context, e WorkgroupPerformanceTargetStatus) string { + return string(e) + }).(pulumi.StringOutput) +} + +func (o WorkgroupPerformanceTargetStatusOutput) ToStringPtrOutput() pulumi.StringPtrOutput { + return o.ToStringPtrOutputWithContext(context.Background()) +} + +func (o WorkgroupPerformanceTargetStatusOutput) ToStringPtrOutputWithContext(ctx context.Context) pulumi.StringPtrOutput { + return o.ApplyTWithContext(ctx, func(_ context.Context, e WorkgroupPerformanceTargetStatus) *string { + v := string(e) + return &v + }).(pulumi.StringPtrOutput) +} + +type WorkgroupPerformanceTargetStatusPtrOutput struct{ *pulumi.OutputState } + +func (WorkgroupPerformanceTargetStatusPtrOutput) ElementType() reflect.Type { + return reflect.TypeOf((**WorkgroupPerformanceTargetStatus)(nil)).Elem() +} + +func (o WorkgroupPerformanceTargetStatusPtrOutput) ToWorkgroupPerformanceTargetStatusPtrOutput() WorkgroupPerformanceTargetStatusPtrOutput { + return o +} + +func (o WorkgroupPerformanceTargetStatusPtrOutput) ToWorkgroupPerformanceTargetStatusPtrOutputWithContext(ctx context.Context) WorkgroupPerformanceTargetStatusPtrOutput { + return o +} + +func (o WorkgroupPerformanceTargetStatusPtrOutput) Elem() WorkgroupPerformanceTargetStatusOutput { + return o.ApplyT(func(v *WorkgroupPerformanceTargetStatus) WorkgroupPerformanceTargetStatus { + if v != nil { + return *v + } + var ret WorkgroupPerformanceTargetStatus + return ret + }).(WorkgroupPerformanceTargetStatusOutput) +} + +func (o WorkgroupPerformanceTargetStatusPtrOutput) ToStringPtrOutput() pulumi.StringPtrOutput { + return o.ToStringPtrOutputWithContext(context.Background()) +} + +func (o WorkgroupPerformanceTargetStatusPtrOutput) ToStringPtrOutputWithContext(ctx context.Context) pulumi.StringPtrOutput { + return o.ApplyTWithContext(ctx, func(_ context.Context, e *WorkgroupPerformanceTargetStatus) *string { + if e == nil { + return nil + } + v := string(*e) + return &v + }).(pulumi.StringPtrOutput) +} + +// WorkgroupPerformanceTargetStatusInput is an input type that accepts values of the WorkgroupPerformanceTargetStatus enum +// A concrete instance of `WorkgroupPerformanceTargetStatusInput` can be one of the following: +// +// WorkgroupPerformanceTargetStatusEnabled +// WorkgroupPerformanceTargetStatusDisabled +type WorkgroupPerformanceTargetStatusInput interface { + pulumi.Input + + ToWorkgroupPerformanceTargetStatusOutput() WorkgroupPerformanceTargetStatusOutput + ToWorkgroupPerformanceTargetStatusOutputWithContext(context.Context) WorkgroupPerformanceTargetStatusOutput +} + +var workgroupPerformanceTargetStatusPtrType = reflect.TypeOf((**WorkgroupPerformanceTargetStatus)(nil)).Elem() + +type WorkgroupPerformanceTargetStatusPtrInput interface { + pulumi.Input + + ToWorkgroupPerformanceTargetStatusPtrOutput() WorkgroupPerformanceTargetStatusPtrOutput + ToWorkgroupPerformanceTargetStatusPtrOutputWithContext(context.Context) WorkgroupPerformanceTargetStatusPtrOutput +} + +type workgroupPerformanceTargetStatusPtr string + +func WorkgroupPerformanceTargetStatusPtr(v string) WorkgroupPerformanceTargetStatusPtrInput { + return (*workgroupPerformanceTargetStatusPtr)(&v) +} + +func (*workgroupPerformanceTargetStatusPtr) ElementType() reflect.Type { + return workgroupPerformanceTargetStatusPtrType +} + +func (in *workgroupPerformanceTargetStatusPtr) ToWorkgroupPerformanceTargetStatusPtrOutput() WorkgroupPerformanceTargetStatusPtrOutput { + return pulumi.ToOutput(in).(WorkgroupPerformanceTargetStatusPtrOutput) +} + +func (in *workgroupPerformanceTargetStatusPtr) ToWorkgroupPerformanceTargetStatusPtrOutputWithContext(ctx context.Context) WorkgroupPerformanceTargetStatusPtrOutput { + return pulumi.ToOutputWithContext(ctx, in).(WorkgroupPerformanceTargetStatusPtrOutput) +} + type WorkgroupStatus string const ( @@ -409,11 +574,15 @@ func init() { pulumi.RegisterInputType(reflect.TypeOf((*NamespaceLogExportInput)(nil)).Elem(), NamespaceLogExport("useractivitylog")) pulumi.RegisterInputType(reflect.TypeOf((*NamespaceLogExportPtrInput)(nil)).Elem(), NamespaceLogExport("useractivitylog")) pulumi.RegisterInputType(reflect.TypeOf((*NamespaceLogExportArrayInput)(nil)).Elem(), NamespaceLogExportArray{}) + pulumi.RegisterInputType(reflect.TypeOf((*WorkgroupPerformanceTargetStatusInput)(nil)).Elem(), WorkgroupPerformanceTargetStatus("ENABLED")) + pulumi.RegisterInputType(reflect.TypeOf((*WorkgroupPerformanceTargetStatusPtrInput)(nil)).Elem(), WorkgroupPerformanceTargetStatus("ENABLED")) pulumi.RegisterOutputType(NamespaceLogExportOutput{}) pulumi.RegisterOutputType(NamespaceLogExportPtrOutput{}) pulumi.RegisterOutputType(NamespaceLogExportArrayOutput{}) pulumi.RegisterOutputType(NamespaceStatusOutput{}) pulumi.RegisterOutputType(NamespaceStatusPtrOutput{}) + pulumi.RegisterOutputType(WorkgroupPerformanceTargetStatusOutput{}) + pulumi.RegisterOutputType(WorkgroupPerformanceTargetStatusPtrOutput{}) pulumi.RegisterOutputType(WorkgroupStatusOutput{}) pulumi.RegisterOutputType(WorkgroupStatusPtrOutput{}) } diff --git a/sdk/go/aws/redshiftserverless/pulumiTypes.go b/sdk/go/aws/redshiftserverless/pulumiTypes.go index b68a3a5967..ab90961f2b 100644 --- a/sdk/go/aws/redshiftserverless/pulumiTypes.go +++ b/sdk/go/aws/redshiftserverless/pulumiTypes.go @@ -411,7 +411,8 @@ type WorkgroupType struct { // The maximum data-warehouse capacity Amazon Redshift Serverless uses to serve queries. The max capacity is specified in RPUs. MaxCapacity *int `pulumi:"maxCapacity"` // The namespace the workgroup is associated with. - NamespaceName *string `pulumi:"namespaceName"` + NamespaceName *string `pulumi:"namespaceName"` + PricePerformanceTarget *WorkgroupPerformanceTarget `pulumi:"pricePerformanceTarget"` // A value that specifies whether the workgroup can be accessible from a public network. PubliclyAccessible *bool `pulumi:"publiclyAccessible"` // An array of security group IDs to associate with the workgroup. @@ -477,6 +478,10 @@ func (o WorkgroupTypeOutput) NamespaceName() pulumi.StringPtrOutput { return o.ApplyT(func(v WorkgroupType) *string { return v.NamespaceName }).(pulumi.StringPtrOutput) } +func (o WorkgroupTypeOutput) PricePerformanceTarget() WorkgroupPerformanceTargetPtrOutput { + return o.ApplyT(func(v WorkgroupType) *WorkgroupPerformanceTarget { return v.PricePerformanceTarget }).(WorkgroupPerformanceTargetPtrOutput) +} + // A value that specifies whether the workgroup can be accessible from a public network. func (o WorkgroupTypeOutput) PubliclyAccessible() pulumi.BoolPtrOutput { return o.ApplyT(func(v WorkgroupType) *bool { return v.PubliclyAccessible }).(pulumi.BoolPtrOutput) @@ -606,6 +611,15 @@ func (o WorkgroupTypePtrOutput) NamespaceName() pulumi.StringPtrOutput { }).(pulumi.StringPtrOutput) } +func (o WorkgroupTypePtrOutput) PricePerformanceTarget() WorkgroupPerformanceTargetPtrOutput { + return o.ApplyT(func(v *WorkgroupType) *WorkgroupPerformanceTarget { + if v == nil { + return nil + } + return v.PricePerformanceTarget + }).(WorkgroupPerformanceTargetPtrOutput) +} + // A value that specifies whether the workgroup can be accessible from a public network. func (o WorkgroupTypePtrOutput) PubliclyAccessible() pulumi.BoolPtrOutput { return o.ApplyT(func(v *WorkgroupType) *bool { @@ -939,6 +953,154 @@ func (o WorkgroupNetworkInterfaceArrayOutput) Index(i pulumi.IntInput) Workgroup }).(WorkgroupNetworkInterfaceOutput) } +type WorkgroupPerformanceTarget struct { + Level *int `pulumi:"level"` + Status *WorkgroupPerformanceTargetStatus `pulumi:"status"` +} + +// WorkgroupPerformanceTargetInput is an input type that accepts WorkgroupPerformanceTargetArgs and WorkgroupPerformanceTargetOutput values. +// You can construct a concrete instance of `WorkgroupPerformanceTargetInput` via: +// +// WorkgroupPerformanceTargetArgs{...} +type WorkgroupPerformanceTargetInput interface { + pulumi.Input + + ToWorkgroupPerformanceTargetOutput() WorkgroupPerformanceTargetOutput + ToWorkgroupPerformanceTargetOutputWithContext(context.Context) WorkgroupPerformanceTargetOutput +} + +type WorkgroupPerformanceTargetArgs struct { + Level pulumi.IntPtrInput `pulumi:"level"` + Status WorkgroupPerformanceTargetStatusPtrInput `pulumi:"status"` +} + +func (WorkgroupPerformanceTargetArgs) ElementType() reflect.Type { + return reflect.TypeOf((*WorkgroupPerformanceTarget)(nil)).Elem() +} + +func (i WorkgroupPerformanceTargetArgs) ToWorkgroupPerformanceTargetOutput() WorkgroupPerformanceTargetOutput { + return i.ToWorkgroupPerformanceTargetOutputWithContext(context.Background()) +} + +func (i WorkgroupPerformanceTargetArgs) ToWorkgroupPerformanceTargetOutputWithContext(ctx context.Context) WorkgroupPerformanceTargetOutput { + return pulumi.ToOutputWithContext(ctx, i).(WorkgroupPerformanceTargetOutput) +} + +func (i WorkgroupPerformanceTargetArgs) ToWorkgroupPerformanceTargetPtrOutput() WorkgroupPerformanceTargetPtrOutput { + return i.ToWorkgroupPerformanceTargetPtrOutputWithContext(context.Background()) +} + +func (i WorkgroupPerformanceTargetArgs) ToWorkgroupPerformanceTargetPtrOutputWithContext(ctx context.Context) WorkgroupPerformanceTargetPtrOutput { + return pulumi.ToOutputWithContext(ctx, i).(WorkgroupPerformanceTargetOutput).ToWorkgroupPerformanceTargetPtrOutputWithContext(ctx) +} + +// WorkgroupPerformanceTargetPtrInput is an input type that accepts WorkgroupPerformanceTargetArgs, WorkgroupPerformanceTargetPtr and WorkgroupPerformanceTargetPtrOutput values. +// You can construct a concrete instance of `WorkgroupPerformanceTargetPtrInput` via: +// +// WorkgroupPerformanceTargetArgs{...} +// +// or: +// +// nil +type WorkgroupPerformanceTargetPtrInput interface { + pulumi.Input + + ToWorkgroupPerformanceTargetPtrOutput() WorkgroupPerformanceTargetPtrOutput + ToWorkgroupPerformanceTargetPtrOutputWithContext(context.Context) WorkgroupPerformanceTargetPtrOutput +} + +type workgroupPerformanceTargetPtrType WorkgroupPerformanceTargetArgs + +func WorkgroupPerformanceTargetPtr(v *WorkgroupPerformanceTargetArgs) WorkgroupPerformanceTargetPtrInput { + return (*workgroupPerformanceTargetPtrType)(v) +} + +func (*workgroupPerformanceTargetPtrType) ElementType() reflect.Type { + return reflect.TypeOf((**WorkgroupPerformanceTarget)(nil)).Elem() +} + +func (i *workgroupPerformanceTargetPtrType) ToWorkgroupPerformanceTargetPtrOutput() WorkgroupPerformanceTargetPtrOutput { + return i.ToWorkgroupPerformanceTargetPtrOutputWithContext(context.Background()) +} + +func (i *workgroupPerformanceTargetPtrType) ToWorkgroupPerformanceTargetPtrOutputWithContext(ctx context.Context) WorkgroupPerformanceTargetPtrOutput { + return pulumi.ToOutputWithContext(ctx, i).(WorkgroupPerformanceTargetPtrOutput) +} + +type WorkgroupPerformanceTargetOutput struct{ *pulumi.OutputState } + +func (WorkgroupPerformanceTargetOutput) ElementType() reflect.Type { + return reflect.TypeOf((*WorkgroupPerformanceTarget)(nil)).Elem() +} + +func (o WorkgroupPerformanceTargetOutput) ToWorkgroupPerformanceTargetOutput() WorkgroupPerformanceTargetOutput { + return o +} + +func (o WorkgroupPerformanceTargetOutput) ToWorkgroupPerformanceTargetOutputWithContext(ctx context.Context) WorkgroupPerformanceTargetOutput { + return o +} + +func (o WorkgroupPerformanceTargetOutput) ToWorkgroupPerformanceTargetPtrOutput() WorkgroupPerformanceTargetPtrOutput { + return o.ToWorkgroupPerformanceTargetPtrOutputWithContext(context.Background()) +} + +func (o WorkgroupPerformanceTargetOutput) ToWorkgroupPerformanceTargetPtrOutputWithContext(ctx context.Context) WorkgroupPerformanceTargetPtrOutput { + return o.ApplyTWithContext(ctx, func(_ context.Context, v WorkgroupPerformanceTarget) *WorkgroupPerformanceTarget { + return &v + }).(WorkgroupPerformanceTargetPtrOutput) +} + +func (o WorkgroupPerformanceTargetOutput) Level() pulumi.IntPtrOutput { + return o.ApplyT(func(v WorkgroupPerformanceTarget) *int { return v.Level }).(pulumi.IntPtrOutput) +} + +func (o WorkgroupPerformanceTargetOutput) Status() WorkgroupPerformanceTargetStatusPtrOutput { + return o.ApplyT(func(v WorkgroupPerformanceTarget) *WorkgroupPerformanceTargetStatus { return v.Status }).(WorkgroupPerformanceTargetStatusPtrOutput) +} + +type WorkgroupPerformanceTargetPtrOutput struct{ *pulumi.OutputState } + +func (WorkgroupPerformanceTargetPtrOutput) ElementType() reflect.Type { + return reflect.TypeOf((**WorkgroupPerformanceTarget)(nil)).Elem() +} + +func (o WorkgroupPerformanceTargetPtrOutput) ToWorkgroupPerformanceTargetPtrOutput() WorkgroupPerformanceTargetPtrOutput { + return o +} + +func (o WorkgroupPerformanceTargetPtrOutput) ToWorkgroupPerformanceTargetPtrOutputWithContext(ctx context.Context) WorkgroupPerformanceTargetPtrOutput { + return o +} + +func (o WorkgroupPerformanceTargetPtrOutput) Elem() WorkgroupPerformanceTargetOutput { + return o.ApplyT(func(v *WorkgroupPerformanceTarget) WorkgroupPerformanceTarget { + if v != nil { + return *v + } + var ret WorkgroupPerformanceTarget + return ret + }).(WorkgroupPerformanceTargetOutput) +} + +func (o WorkgroupPerformanceTargetPtrOutput) Level() pulumi.IntPtrOutput { + return o.ApplyT(func(v *WorkgroupPerformanceTarget) *int { + if v == nil { + return nil + } + return v.Level + }).(pulumi.IntPtrOutput) +} + +func (o WorkgroupPerformanceTargetPtrOutput) Status() WorkgroupPerformanceTargetStatusPtrOutput { + return o.ApplyT(func(v *WorkgroupPerformanceTarget) *WorkgroupPerformanceTargetStatus { + if v == nil { + return nil + } + return v.Status + }).(WorkgroupPerformanceTargetStatusPtrOutput) +} + type WorkgroupTag struct { // The key to use in the tag. Key string `pulumi:"key"` @@ -1009,6 +1171,8 @@ func init() { pulumi.RegisterInputType(reflect.TypeOf((*NamespaceSnapshotCopyConfigurationArrayInput)(nil)).Elem(), NamespaceSnapshotCopyConfigurationArray{}) pulumi.RegisterInputType(reflect.TypeOf((*WorkgroupConfigParameterInput)(nil)).Elem(), WorkgroupConfigParameterArgs{}) pulumi.RegisterInputType(reflect.TypeOf((*WorkgroupConfigParameterArrayInput)(nil)).Elem(), WorkgroupConfigParameterArray{}) + pulumi.RegisterInputType(reflect.TypeOf((*WorkgroupPerformanceTargetInput)(nil)).Elem(), WorkgroupPerformanceTargetArgs{}) + pulumi.RegisterInputType(reflect.TypeOf((*WorkgroupPerformanceTargetPtrInput)(nil)).Elem(), WorkgroupPerformanceTargetArgs{}) pulumi.RegisterOutputType(NamespaceTypeOutput{}) pulumi.RegisterOutputType(NamespaceTypePtrOutput{}) pulumi.RegisterOutputType(NamespaceSnapshotCopyConfigurationOutput{}) @@ -1021,6 +1185,8 @@ func init() { pulumi.RegisterOutputType(WorkgroupEndpointPtrOutput{}) pulumi.RegisterOutputType(WorkgroupNetworkInterfaceOutput{}) pulumi.RegisterOutputType(WorkgroupNetworkInterfaceArrayOutput{}) + pulumi.RegisterOutputType(WorkgroupPerformanceTargetOutput{}) + pulumi.RegisterOutputType(WorkgroupPerformanceTargetPtrOutput{}) pulumi.RegisterOutputType(WorkgroupVpcEndpointOutput{}) pulumi.RegisterOutputType(WorkgroupVpcEndpointArrayOutput{}) } diff --git a/sdk/go/aws/redshiftserverless/workgroup.go b/sdk/go/aws/redshiftserverless/workgroup.go index 58667dcaf2..346e2dc6e5 100644 --- a/sdk/go/aws/redshiftserverless/workgroup.go +++ b/sdk/go/aws/redshiftserverless/workgroup.go @@ -28,6 +28,8 @@ type Workgroup struct { NamespaceName pulumi.StringPtrOutput `pulumi:"namespaceName"` // The custom port to use when connecting to a workgroup. Valid port ranges are 5431-5455 and 8191-8215. The default is 5439. Port pulumi.IntPtrOutput `pulumi:"port"` + // A property that represents the price performance target settings for the workgroup. + PricePerformanceTarget WorkgroupPerformanceTargetPtrOutput `pulumi:"pricePerformanceTarget"` // A value that specifies whether the workgroup can be accessible from a public network. PubliclyAccessible pulumi.BoolPtrOutput `pulumi:"publiclyAccessible"` // A list of security group IDs to associate with the workgroup. @@ -99,6 +101,8 @@ type workgroupArgs struct { NamespaceName *string `pulumi:"namespaceName"` // The custom port to use when connecting to a workgroup. Valid port ranges are 5431-5455 and 8191-8215. The default is 5439. Port *int `pulumi:"port"` + // A property that represents the price performance target settings for the workgroup. + PricePerformanceTarget *WorkgroupPerformanceTarget `pulumi:"pricePerformanceTarget"` // A value that specifies whether the workgroup can be accessible from a public network. PubliclyAccessible *bool `pulumi:"publiclyAccessible"` // A list of security group IDs to associate with the workgroup. @@ -125,6 +129,8 @@ type WorkgroupArgs struct { NamespaceName pulumi.StringPtrInput // The custom port to use when connecting to a workgroup. Valid port ranges are 5431-5455 and 8191-8215. The default is 5439. Port pulumi.IntPtrInput + // A property that represents the price performance target settings for the workgroup. + PricePerformanceTarget WorkgroupPerformanceTargetPtrInput // A value that specifies whether the workgroup can be accessible from a public network. PubliclyAccessible pulumi.BoolPtrInput // A list of security group IDs to associate with the workgroup. @@ -204,6 +210,11 @@ func (o WorkgroupOutput) Port() pulumi.IntPtrOutput { return o.ApplyT(func(v *Workgroup) pulumi.IntPtrOutput { return v.Port }).(pulumi.IntPtrOutput) } +// A property that represents the price performance target settings for the workgroup. +func (o WorkgroupOutput) PricePerformanceTarget() WorkgroupPerformanceTargetPtrOutput { + return o.ApplyT(func(v *Workgroup) WorkgroupPerformanceTargetPtrOutput { return v.PricePerformanceTarget }).(WorkgroupPerformanceTargetPtrOutput) +} + // A value that specifies whether the workgroup can be accessible from a public network. func (o WorkgroupOutput) PubliclyAccessible() pulumi.BoolPtrOutput { return o.ApplyT(func(v *Workgroup) pulumi.BoolPtrOutput { return v.PubliclyAccessible }).(pulumi.BoolPtrOutput) diff --git a/sdk/go/aws/s3/bucket.go b/sdk/go/aws/s3/bucket.go index 7f6e4382e5..4c764e2581 100644 --- a/sdk/go/aws/s3/bucket.go +++ b/sdk/go/aws/s3/bucket.go @@ -820,7 +820,8 @@ type Bucket struct { // Specifies the lifecycle configuration for objects in an Amazon S3 bucket. For more information, see [Object Lifecycle Management](https://docs.aws.amazon.com/AmazonS3/latest/dev/object-lifecycle-mgmt.html) in the *Amazon S3 User Guide*. LifecycleConfiguration BucketLifecycleConfigurationPtrOutput `pulumi:"lifecycleConfiguration"` // Settings that define where logs are stored. - LoggingConfiguration BucketLoggingConfigurationPtrOutput `pulumi:"loggingConfiguration"` + LoggingConfiguration BucketLoggingConfigurationPtrOutput `pulumi:"loggingConfiguration"` + MetadataTableConfiguration BucketMetadataTableConfigurationPtrOutput `pulumi:"metadataTableConfiguration"` // Specifies a metrics configuration for the CloudWatch request metrics (specified by the metrics configuration ID) from an Amazon S3 bucket. If you're updating an existing metrics configuration, note that this is a full replacement of the existing metrics configuration. If you don't include the elements you want to keep, they are erased. For more information, see [PutBucketMetricsConfiguration](https://docs.aws.amazon.com/AmazonS3/latest/API/RESTBucketPUTMetricConfiguration.html). MetricsConfigurations BucketMetricsConfigurationArrayOutput `pulumi:"metricsConfigurations"` // Configuration that defines how Amazon S3 handles bucket notifications. @@ -926,7 +927,8 @@ type bucketArgs struct { // Specifies the lifecycle configuration for objects in an Amazon S3 bucket. For more information, see [Object Lifecycle Management](https://docs.aws.amazon.com/AmazonS3/latest/dev/object-lifecycle-mgmt.html) in the *Amazon S3 User Guide*. LifecycleConfiguration *BucketLifecycleConfiguration `pulumi:"lifecycleConfiguration"` // Settings that define where logs are stored. - LoggingConfiguration *BucketLoggingConfiguration `pulumi:"loggingConfiguration"` + LoggingConfiguration *BucketLoggingConfiguration `pulumi:"loggingConfiguration"` + MetadataTableConfiguration *BucketMetadataTableConfiguration `pulumi:"metadataTableConfiguration"` // Specifies a metrics configuration for the CloudWatch request metrics (specified by the metrics configuration ID) from an Amazon S3 bucket. If you're updating an existing metrics configuration, note that this is a full replacement of the existing metrics configuration. If you don't include the elements you want to keep, they are erased. For more information, see [PutBucketMetricsConfiguration](https://docs.aws.amazon.com/AmazonS3/latest/API/RESTBucketPUTMetricConfiguration.html). MetricsConfigurations []BucketMetricsConfiguration `pulumi:"metricsConfigurations"` // Configuration that defines how Amazon S3 handles bucket notifications. @@ -980,7 +982,8 @@ type BucketArgs struct { // Specifies the lifecycle configuration for objects in an Amazon S3 bucket. For more information, see [Object Lifecycle Management](https://docs.aws.amazon.com/AmazonS3/latest/dev/object-lifecycle-mgmt.html) in the *Amazon S3 User Guide*. LifecycleConfiguration BucketLifecycleConfigurationPtrInput // Settings that define where logs are stored. - LoggingConfiguration BucketLoggingConfigurationPtrInput + LoggingConfiguration BucketLoggingConfigurationPtrInput + MetadataTableConfiguration BucketMetadataTableConfigurationPtrInput // Specifies a metrics configuration for the CloudWatch request metrics (specified by the metrics configuration ID) from an Amazon S3 bucket. If you're updating an existing metrics configuration, note that this is a full replacement of the existing metrics configuration. If you don't include the elements you want to keep, they are erased. For more information, see [PutBucketMetricsConfiguration](https://docs.aws.amazon.com/AmazonS3/latest/API/RESTBucketPUTMetricConfiguration.html). MetricsConfigurations BucketMetricsConfigurationArrayInput // Configuration that defines how Amazon S3 handles bucket notifications. @@ -1127,6 +1130,10 @@ func (o BucketOutput) LoggingConfiguration() BucketLoggingConfigurationPtrOutput return o.ApplyT(func(v *Bucket) BucketLoggingConfigurationPtrOutput { return v.LoggingConfiguration }).(BucketLoggingConfigurationPtrOutput) } +func (o BucketOutput) MetadataTableConfiguration() BucketMetadataTableConfigurationPtrOutput { + return o.ApplyT(func(v *Bucket) BucketMetadataTableConfigurationPtrOutput { return v.MetadataTableConfiguration }).(BucketMetadataTableConfigurationPtrOutput) +} + // Specifies a metrics configuration for the CloudWatch request metrics (specified by the metrics configuration ID) from an Amazon S3 bucket. If you're updating an existing metrics configuration, note that this is a full replacement of the existing metrics configuration. If you don't include the elements you want to keep, they are erased. For more information, see [PutBucketMetricsConfiguration](https://docs.aws.amazon.com/AmazonS3/latest/API/RESTBucketPUTMetricConfiguration.html). func (o BucketOutput) MetricsConfigurations() BucketMetricsConfigurationArrayOutput { return o.ApplyT(func(v *Bucket) BucketMetricsConfigurationArrayOutput { return v.MetricsConfigurations }).(BucketMetricsConfigurationArrayOutput) diff --git a/sdk/go/aws/s3/getBucket.go b/sdk/go/aws/s3/getBucket.go index 2e49cb1152..158af14f64 100644 --- a/sdk/go/aws/s3/getBucket.go +++ b/sdk/go/aws/s3/getBucket.go @@ -62,7 +62,8 @@ type LookupBucketResult struct { // Specifies the lifecycle configuration for objects in an Amazon S3 bucket. For more information, see [Object Lifecycle Management](https://docs.aws.amazon.com/AmazonS3/latest/dev/object-lifecycle-mgmt.html) in the *Amazon S3 User Guide*. LifecycleConfiguration *BucketLifecycleConfiguration `pulumi:"lifecycleConfiguration"` // Settings that define where logs are stored. - LoggingConfiguration *BucketLoggingConfiguration `pulumi:"loggingConfiguration"` + LoggingConfiguration *BucketLoggingConfiguration `pulumi:"loggingConfiguration"` + MetadataTableConfiguration *BucketMetadataTableConfiguration `pulumi:"metadataTableConfiguration"` // Specifies a metrics configuration for the CloudWatch request metrics (specified by the metrics configuration ID) from an Amazon S3 bucket. If you're updating an existing metrics configuration, note that this is a full replacement of the existing metrics configuration. If you don't include the elements you want to keep, they are erased. For more information, see [PutBucketMetricsConfiguration](https://docs.aws.amazon.com/AmazonS3/latest/API/RESTBucketPUTMetricConfiguration.html). MetricsConfigurations []BucketMetricsConfiguration `pulumi:"metricsConfigurations"` // Configuration that defines how Amazon S3 handles bucket notifications. @@ -209,6 +210,10 @@ func (o LookupBucketResultOutput) LoggingConfiguration() BucketLoggingConfigurat return o.ApplyT(func(v LookupBucketResult) *BucketLoggingConfiguration { return v.LoggingConfiguration }).(BucketLoggingConfigurationPtrOutput) } +func (o LookupBucketResultOutput) MetadataTableConfiguration() BucketMetadataTableConfigurationPtrOutput { + return o.ApplyT(func(v LookupBucketResult) *BucketMetadataTableConfiguration { return v.MetadataTableConfiguration }).(BucketMetadataTableConfigurationPtrOutput) +} + // Specifies a metrics configuration for the CloudWatch request metrics (specified by the metrics configuration ID) from an Amazon S3 bucket. If you're updating an existing metrics configuration, note that this is a full replacement of the existing metrics configuration. If you don't include the elements you want to keep, they are erased. For more information, see [PutBucketMetricsConfiguration](https://docs.aws.amazon.com/AmazonS3/latest/API/RESTBucketPUTMetricConfiguration.html). func (o LookupBucketResultOutput) MetricsConfigurations() BucketMetricsConfigurationArrayOutput { return o.ApplyT(func(v LookupBucketResult) []BucketMetricsConfiguration { return v.MetricsConfigurations }).(BucketMetricsConfigurationArrayOutput) diff --git a/sdk/go/aws/s3/pulumiTypes.go b/sdk/go/aws/s3/pulumiTypes.go index ccbb58bc82..64a6b27868 100644 --- a/sdk/go/aws/s3/pulumiTypes.go +++ b/sdk/go/aws/s3/pulumiTypes.go @@ -3481,6 +3481,333 @@ func (o BucketLoggingConfigurationPtrOutput) TargetObjectKeyFormat() BucketTarge }).(BucketTargetObjectKeyFormatPtrOutput) } +type BucketMetadataTableConfiguration struct { + // Returns the Error value of the GetBucketMetadataTableConfiguration response. + Error *BucketMetadataTableError `pulumi:"error"` + S3TablesDestination BucketS3TablesDestination `pulumi:"s3TablesDestination"` + // Returns the Status value of the GetBucketMetadataTableConfigurationResult response. This value indicates the status of the metadata table. The status values are:
CREATING - The metadata table is in the process of being created in the specified table bucket.
ACTIVE - The metadata table has been created successfully and records are being delivered to the table.
FAILED - Amazon S3 is unable to create the metadata table, or Amazon S3 is unable to deliver records. + Status *string `pulumi:"status"` +} + +// BucketMetadataTableConfigurationInput is an input type that accepts BucketMetadataTableConfigurationArgs and BucketMetadataTableConfigurationOutput values. +// You can construct a concrete instance of `BucketMetadataTableConfigurationInput` via: +// +// BucketMetadataTableConfigurationArgs{...} +type BucketMetadataTableConfigurationInput interface { + pulumi.Input + + ToBucketMetadataTableConfigurationOutput() BucketMetadataTableConfigurationOutput + ToBucketMetadataTableConfigurationOutputWithContext(context.Context) BucketMetadataTableConfigurationOutput +} + +type BucketMetadataTableConfigurationArgs struct { + // Returns the Error value of the GetBucketMetadataTableConfiguration response. + Error BucketMetadataTableErrorPtrInput `pulumi:"error"` + S3TablesDestination BucketS3TablesDestinationInput `pulumi:"s3TablesDestination"` + // Returns the Status value of the GetBucketMetadataTableConfigurationResult response. This value indicates the status of the metadata table. The status values are:
CREATING - The metadata table is in the process of being created in the specified table bucket.
ACTIVE - The metadata table has been created successfully and records are being delivered to the table.
FAILED - Amazon S3 is unable to create the metadata table, or Amazon S3 is unable to deliver records. + Status pulumi.StringPtrInput `pulumi:"status"` +} + +func (BucketMetadataTableConfigurationArgs) ElementType() reflect.Type { + return reflect.TypeOf((*BucketMetadataTableConfiguration)(nil)).Elem() +} + +func (i BucketMetadataTableConfigurationArgs) ToBucketMetadataTableConfigurationOutput() BucketMetadataTableConfigurationOutput { + return i.ToBucketMetadataTableConfigurationOutputWithContext(context.Background()) +} + +func (i BucketMetadataTableConfigurationArgs) ToBucketMetadataTableConfigurationOutputWithContext(ctx context.Context) BucketMetadataTableConfigurationOutput { + return pulumi.ToOutputWithContext(ctx, i).(BucketMetadataTableConfigurationOutput) +} + +func (i BucketMetadataTableConfigurationArgs) ToBucketMetadataTableConfigurationPtrOutput() BucketMetadataTableConfigurationPtrOutput { + return i.ToBucketMetadataTableConfigurationPtrOutputWithContext(context.Background()) +} + +func (i BucketMetadataTableConfigurationArgs) ToBucketMetadataTableConfigurationPtrOutputWithContext(ctx context.Context) BucketMetadataTableConfigurationPtrOutput { + return pulumi.ToOutputWithContext(ctx, i).(BucketMetadataTableConfigurationOutput).ToBucketMetadataTableConfigurationPtrOutputWithContext(ctx) +} + +// BucketMetadataTableConfigurationPtrInput is an input type that accepts BucketMetadataTableConfigurationArgs, BucketMetadataTableConfigurationPtr and BucketMetadataTableConfigurationPtrOutput values. +// You can construct a concrete instance of `BucketMetadataTableConfigurationPtrInput` via: +// +// BucketMetadataTableConfigurationArgs{...} +// +// or: +// +// nil +type BucketMetadataTableConfigurationPtrInput interface { + pulumi.Input + + ToBucketMetadataTableConfigurationPtrOutput() BucketMetadataTableConfigurationPtrOutput + ToBucketMetadataTableConfigurationPtrOutputWithContext(context.Context) BucketMetadataTableConfigurationPtrOutput +} + +type bucketMetadataTableConfigurationPtrType BucketMetadataTableConfigurationArgs + +func BucketMetadataTableConfigurationPtr(v *BucketMetadataTableConfigurationArgs) BucketMetadataTableConfigurationPtrInput { + return (*bucketMetadataTableConfigurationPtrType)(v) +} + +func (*bucketMetadataTableConfigurationPtrType) ElementType() reflect.Type { + return reflect.TypeOf((**BucketMetadataTableConfiguration)(nil)).Elem() +} + +func (i *bucketMetadataTableConfigurationPtrType) ToBucketMetadataTableConfigurationPtrOutput() BucketMetadataTableConfigurationPtrOutput { + return i.ToBucketMetadataTableConfigurationPtrOutputWithContext(context.Background()) +} + +func (i *bucketMetadataTableConfigurationPtrType) ToBucketMetadataTableConfigurationPtrOutputWithContext(ctx context.Context) BucketMetadataTableConfigurationPtrOutput { + return pulumi.ToOutputWithContext(ctx, i).(BucketMetadataTableConfigurationPtrOutput) +} + +type BucketMetadataTableConfigurationOutput struct{ *pulumi.OutputState } + +func (BucketMetadataTableConfigurationOutput) ElementType() reflect.Type { + return reflect.TypeOf((*BucketMetadataTableConfiguration)(nil)).Elem() +} + +func (o BucketMetadataTableConfigurationOutput) ToBucketMetadataTableConfigurationOutput() BucketMetadataTableConfigurationOutput { + return o +} + +func (o BucketMetadataTableConfigurationOutput) ToBucketMetadataTableConfigurationOutputWithContext(ctx context.Context) BucketMetadataTableConfigurationOutput { + return o +} + +func (o BucketMetadataTableConfigurationOutput) ToBucketMetadataTableConfigurationPtrOutput() BucketMetadataTableConfigurationPtrOutput { + return o.ToBucketMetadataTableConfigurationPtrOutputWithContext(context.Background()) +} + +func (o BucketMetadataTableConfigurationOutput) ToBucketMetadataTableConfigurationPtrOutputWithContext(ctx context.Context) BucketMetadataTableConfigurationPtrOutput { + return o.ApplyTWithContext(ctx, func(_ context.Context, v BucketMetadataTableConfiguration) *BucketMetadataTableConfiguration { + return &v + }).(BucketMetadataTableConfigurationPtrOutput) +} + +// Returns the Error value of the GetBucketMetadataTableConfiguration response. +func (o BucketMetadataTableConfigurationOutput) Error() BucketMetadataTableErrorPtrOutput { + return o.ApplyT(func(v BucketMetadataTableConfiguration) *BucketMetadataTableError { return v.Error }).(BucketMetadataTableErrorPtrOutput) +} + +func (o BucketMetadataTableConfigurationOutput) S3TablesDestination() BucketS3TablesDestinationOutput { + return o.ApplyT(func(v BucketMetadataTableConfiguration) BucketS3TablesDestination { return v.S3TablesDestination }).(BucketS3TablesDestinationOutput) +} + +// Returns the Status value of the GetBucketMetadataTableConfigurationResult response. This value indicates the status of the metadata table. The status values are:
CREATING - The metadata table is in the process of being created in the specified table bucket.
ACTIVE - The metadata table has been created successfully and records are being delivered to the table.
FAILED - Amazon S3 is unable to create the metadata table, or Amazon S3 is unable to deliver records. +func (o BucketMetadataTableConfigurationOutput) Status() pulumi.StringPtrOutput { + return o.ApplyT(func(v BucketMetadataTableConfiguration) *string { return v.Status }).(pulumi.StringPtrOutput) +} + +type BucketMetadataTableConfigurationPtrOutput struct{ *pulumi.OutputState } + +func (BucketMetadataTableConfigurationPtrOutput) ElementType() reflect.Type { + return reflect.TypeOf((**BucketMetadataTableConfiguration)(nil)).Elem() +} + +func (o BucketMetadataTableConfigurationPtrOutput) ToBucketMetadataTableConfigurationPtrOutput() BucketMetadataTableConfigurationPtrOutput { + return o +} + +func (o BucketMetadataTableConfigurationPtrOutput) ToBucketMetadataTableConfigurationPtrOutputWithContext(ctx context.Context) BucketMetadataTableConfigurationPtrOutput { + return o +} + +func (o BucketMetadataTableConfigurationPtrOutput) Elem() BucketMetadataTableConfigurationOutput { + return o.ApplyT(func(v *BucketMetadataTableConfiguration) BucketMetadataTableConfiguration { + if v != nil { + return *v + } + var ret BucketMetadataTableConfiguration + return ret + }).(BucketMetadataTableConfigurationOutput) +} + +// Returns the Error value of the GetBucketMetadataTableConfiguration response. +func (o BucketMetadataTableConfigurationPtrOutput) Error() BucketMetadataTableErrorPtrOutput { + return o.ApplyT(func(v *BucketMetadataTableConfiguration) *BucketMetadataTableError { + if v == nil { + return nil + } + return v.Error + }).(BucketMetadataTableErrorPtrOutput) +} + +func (o BucketMetadataTableConfigurationPtrOutput) S3TablesDestination() BucketS3TablesDestinationPtrOutput { + return o.ApplyT(func(v *BucketMetadataTableConfiguration) *BucketS3TablesDestination { + if v == nil { + return nil + } + return &v.S3TablesDestination + }).(BucketS3TablesDestinationPtrOutput) +} + +// Returns the Status value of the GetBucketMetadataTableConfigurationResult response. This value indicates the status of the metadata table. The status values are:
CREATING - The metadata table is in the process of being created in the specified table bucket.
ACTIVE - The metadata table has been created successfully and records are being delivered to the table.
FAILED - Amazon S3 is unable to create the metadata table, or Amazon S3 is unable to deliver records. +func (o BucketMetadataTableConfigurationPtrOutput) Status() pulumi.StringPtrOutput { + return o.ApplyT(func(v *BucketMetadataTableConfiguration) *string { + if v == nil { + return nil + } + return v.Status + }).(pulumi.StringPtrOutput) +} + +type BucketMetadataTableError struct { + // If the CreateBucketMetadataTableConfiguration request succeeds, but S3 Metadata was unable to create the table, this structure contains the error code. The possible error codes and error messages are as follows:
AccessDeniedCreatingResources - You don't have sufficient permissions to create the required resources. Make sure that you have s3tables:CreateNamespace, s3tables:CreateTable, s3tables:GetTable and s3tables:PutTablePolicy permissions, and then try again. To create a new metadata table, you must delete the metadata configuration for this bucket, and then create a new metadata configuration.
AccessDeniedWritingToTable - Unable to write to the metadata table because of missing resource permissions. To fix the resource policy, Amazon S3 needs to create a new metadata table. To create a new metadata table, you must delete the metadata configuration for this bucket, and then create a new metadata configuration.
DestinationTableNotFound - The destination table doesn't exist. To create a new metadata table, you must delete the metadata configuration for this bucket, and then create a new metadata configuration.
ServerInternalError - An internal error has occurred. To create a new metadata table, you must delete the metadata configuration for this bucket, and then create a new metadata configuration.
TableAlreadyExists - The table that you specified already exists in the table bucket's namespace. Specify a different table name. To create a new metadata table, you must delete the metadata configuration for this bucket, and then create a new metadata configuration.
TableBucketNotFound - The table bucket that you specified doesn't exist in this AWS Region and account. Create or choose a different table bucket. To create a new metadata table, you must delete the metadata configuration for this bucket, and then create a new metadata configuration. + ErrorCode string `pulumi:"errorCode"` + // If the CreateBucketMetadataTableConfiguration request succeeds, but S3 Metadata was unable to create the table, this structure contains the error code. The possible error codes and error messages are as follows:
AccessDeniedCreatingResources - You don't have sufficient permissions to create the required resources. Make sure that you have s3tables:CreateNamespace, s3tables:CreateTable, s3tables:GetTable and s3tables:PutTablePolicy permissions, and then try again. To create a new metadata table, you must delete the metadata configuration for this bucket, and then create a new metadata configuration.
AccessDeniedWritingToTable - Unable to write to the metadata table because of missing resource permissions. To fix the resource policy, Amazon S3 needs to create a new metadata table. To create a new metadata table, you must delete the metadata configuration for this bucket, and then create a new metadata configuration.
DestinationTableNotFound - The destination table doesn't exist. To create a new metadata table, you must delete the metadata configuration for this bucket, and then create a new metadata configuration.
ServerInternalError - An internal error has occurred. To create a new metadata table, you must delete the metadata configuration for this bucket, and then create a new metadata configuration.
TableAlreadyExists - The table that you specified already exists in the table bucket's namespace. Specify a different table name. To create a new metadata table, you must delete the metadata configuration for this bucket, and then create a new metadata configuration.
TableBucketNotFound - The table bucket that you specified doesn't exist in this AWS Region and account. Create or choose a different table bucket. To create a new metadata table, you must delete the metadata configuration for this bucket, and then create a new metadata configuration. + ErrorMessage string `pulumi:"errorMessage"` +} + +// BucketMetadataTableErrorInput is an input type that accepts BucketMetadataTableErrorArgs and BucketMetadataTableErrorOutput values. +// You can construct a concrete instance of `BucketMetadataTableErrorInput` via: +// +// BucketMetadataTableErrorArgs{...} +type BucketMetadataTableErrorInput interface { + pulumi.Input + + ToBucketMetadataTableErrorOutput() BucketMetadataTableErrorOutput + ToBucketMetadataTableErrorOutputWithContext(context.Context) BucketMetadataTableErrorOutput +} + +type BucketMetadataTableErrorArgs struct { + // If the CreateBucketMetadataTableConfiguration request succeeds, but S3 Metadata was unable to create the table, this structure contains the error code. The possible error codes and error messages are as follows:
AccessDeniedCreatingResources - You don't have sufficient permissions to create the required resources. Make sure that you have s3tables:CreateNamespace, s3tables:CreateTable, s3tables:GetTable and s3tables:PutTablePolicy permissions, and then try again. To create a new metadata table, you must delete the metadata configuration for this bucket, and then create a new metadata configuration.
AccessDeniedWritingToTable - Unable to write to the metadata table because of missing resource permissions. To fix the resource policy, Amazon S3 needs to create a new metadata table. To create a new metadata table, you must delete the metadata configuration for this bucket, and then create a new metadata configuration.
DestinationTableNotFound - The destination table doesn't exist. To create a new metadata table, you must delete the metadata configuration for this bucket, and then create a new metadata configuration.
ServerInternalError - An internal error has occurred. To create a new metadata table, you must delete the metadata configuration for this bucket, and then create a new metadata configuration.
TableAlreadyExists - The table that you specified already exists in the table bucket's namespace. Specify a different table name. To create a new metadata table, you must delete the metadata configuration for this bucket, and then create a new metadata configuration.
TableBucketNotFound - The table bucket that you specified doesn't exist in this AWS Region and account. Create or choose a different table bucket. To create a new metadata table, you must delete the metadata configuration for this bucket, and then create a new metadata configuration. + ErrorCode pulumi.StringInput `pulumi:"errorCode"` + // If the CreateBucketMetadataTableConfiguration request succeeds, but S3 Metadata was unable to create the table, this structure contains the error code. The possible error codes and error messages are as follows:
AccessDeniedCreatingResources - You don't have sufficient permissions to create the required resources. Make sure that you have s3tables:CreateNamespace, s3tables:CreateTable, s3tables:GetTable and s3tables:PutTablePolicy permissions, and then try again. To create a new metadata table, you must delete the metadata configuration for this bucket, and then create a new metadata configuration.
AccessDeniedWritingToTable - Unable to write to the metadata table because of missing resource permissions. To fix the resource policy, Amazon S3 needs to create a new metadata table. To create a new metadata table, you must delete the metadata configuration for this bucket, and then create a new metadata configuration.
DestinationTableNotFound - The destination table doesn't exist. To create a new metadata table, you must delete the metadata configuration for this bucket, and then create a new metadata configuration.
ServerInternalError - An internal error has occurred. To create a new metadata table, you must delete the metadata configuration for this bucket, and then create a new metadata configuration.
TableAlreadyExists - The table that you specified already exists in the table bucket's namespace. Specify a different table name. To create a new metadata table, you must delete the metadata configuration for this bucket, and then create a new metadata configuration.
TableBucketNotFound - The table bucket that you specified doesn't exist in this AWS Region and account. Create or choose a different table bucket. To create a new metadata table, you must delete the metadata configuration for this bucket, and then create a new metadata configuration. + ErrorMessage pulumi.StringInput `pulumi:"errorMessage"` +} + +func (BucketMetadataTableErrorArgs) ElementType() reflect.Type { + return reflect.TypeOf((*BucketMetadataTableError)(nil)).Elem() +} + +func (i BucketMetadataTableErrorArgs) ToBucketMetadataTableErrorOutput() BucketMetadataTableErrorOutput { + return i.ToBucketMetadataTableErrorOutputWithContext(context.Background()) +} + +func (i BucketMetadataTableErrorArgs) ToBucketMetadataTableErrorOutputWithContext(ctx context.Context) BucketMetadataTableErrorOutput { + return pulumi.ToOutputWithContext(ctx, i).(BucketMetadataTableErrorOutput) +} + +func (i BucketMetadataTableErrorArgs) ToBucketMetadataTableErrorPtrOutput() BucketMetadataTableErrorPtrOutput { + return i.ToBucketMetadataTableErrorPtrOutputWithContext(context.Background()) +} + +func (i BucketMetadataTableErrorArgs) ToBucketMetadataTableErrorPtrOutputWithContext(ctx context.Context) BucketMetadataTableErrorPtrOutput { + return pulumi.ToOutputWithContext(ctx, i).(BucketMetadataTableErrorOutput).ToBucketMetadataTableErrorPtrOutputWithContext(ctx) +} + +// BucketMetadataTableErrorPtrInput is an input type that accepts BucketMetadataTableErrorArgs, BucketMetadataTableErrorPtr and BucketMetadataTableErrorPtrOutput values. +// You can construct a concrete instance of `BucketMetadataTableErrorPtrInput` via: +// +// BucketMetadataTableErrorArgs{...} +// +// or: +// +// nil +type BucketMetadataTableErrorPtrInput interface { + pulumi.Input + + ToBucketMetadataTableErrorPtrOutput() BucketMetadataTableErrorPtrOutput + ToBucketMetadataTableErrorPtrOutputWithContext(context.Context) BucketMetadataTableErrorPtrOutput +} + +type bucketMetadataTableErrorPtrType BucketMetadataTableErrorArgs + +func BucketMetadataTableErrorPtr(v *BucketMetadataTableErrorArgs) BucketMetadataTableErrorPtrInput { + return (*bucketMetadataTableErrorPtrType)(v) +} + +func (*bucketMetadataTableErrorPtrType) ElementType() reflect.Type { + return reflect.TypeOf((**BucketMetadataTableError)(nil)).Elem() +} + +func (i *bucketMetadataTableErrorPtrType) ToBucketMetadataTableErrorPtrOutput() BucketMetadataTableErrorPtrOutput { + return i.ToBucketMetadataTableErrorPtrOutputWithContext(context.Background()) +} + +func (i *bucketMetadataTableErrorPtrType) ToBucketMetadataTableErrorPtrOutputWithContext(ctx context.Context) BucketMetadataTableErrorPtrOutput { + return pulumi.ToOutputWithContext(ctx, i).(BucketMetadataTableErrorPtrOutput) +} + +type BucketMetadataTableErrorOutput struct{ *pulumi.OutputState } + +func (BucketMetadataTableErrorOutput) ElementType() reflect.Type { + return reflect.TypeOf((*BucketMetadataTableError)(nil)).Elem() +} + +func (o BucketMetadataTableErrorOutput) ToBucketMetadataTableErrorOutput() BucketMetadataTableErrorOutput { + return o +} + +func (o BucketMetadataTableErrorOutput) ToBucketMetadataTableErrorOutputWithContext(ctx context.Context) BucketMetadataTableErrorOutput { + return o +} + +func (o BucketMetadataTableErrorOutput) ToBucketMetadataTableErrorPtrOutput() BucketMetadataTableErrorPtrOutput { + return o.ToBucketMetadataTableErrorPtrOutputWithContext(context.Background()) +} + +func (o BucketMetadataTableErrorOutput) ToBucketMetadataTableErrorPtrOutputWithContext(ctx context.Context) BucketMetadataTableErrorPtrOutput { + return o.ApplyTWithContext(ctx, func(_ context.Context, v BucketMetadataTableError) *BucketMetadataTableError { + return &v + }).(BucketMetadataTableErrorPtrOutput) +} + +// If the CreateBucketMetadataTableConfiguration request succeeds, but S3 Metadata was unable to create the table, this structure contains the error code. The possible error codes and error messages are as follows:
AccessDeniedCreatingResources - You don't have sufficient permissions to create the required resources. Make sure that you have s3tables:CreateNamespace, s3tables:CreateTable, s3tables:GetTable and s3tables:PutTablePolicy permissions, and then try again. To create a new metadata table, you must delete the metadata configuration for this bucket, and then create a new metadata configuration.
AccessDeniedWritingToTable - Unable to write to the metadata table because of missing resource permissions. To fix the resource policy, Amazon S3 needs to create a new metadata table. To create a new metadata table, you must delete the metadata configuration for this bucket, and then create a new metadata configuration.
DestinationTableNotFound - The destination table doesn't exist. To create a new metadata table, you must delete the metadata configuration for this bucket, and then create a new metadata configuration.
ServerInternalError - An internal error has occurred. To create a new metadata table, you must delete the metadata configuration for this bucket, and then create a new metadata configuration.
TableAlreadyExists - The table that you specified already exists in the table bucket's namespace. Specify a different table name. To create a new metadata table, you must delete the metadata configuration for this bucket, and then create a new metadata configuration.
TableBucketNotFound - The table bucket that you specified doesn't exist in this AWS Region and account. Create or choose a different table bucket. To create a new metadata table, you must delete the metadata configuration for this bucket, and then create a new metadata configuration. +func (o BucketMetadataTableErrorOutput) ErrorCode() pulumi.StringOutput { + return o.ApplyT(func(v BucketMetadataTableError) string { return v.ErrorCode }).(pulumi.StringOutput) +} + +// If the CreateBucketMetadataTableConfiguration request succeeds, but S3 Metadata was unable to create the table, this structure contains the error code. The possible error codes and error messages are as follows:
AccessDeniedCreatingResources - You don't have sufficient permissions to create the required resources. Make sure that you have s3tables:CreateNamespace, s3tables:CreateTable, s3tables:GetTable and s3tables:PutTablePolicy permissions, and then try again. To create a new metadata table, you must delete the metadata configuration for this bucket, and then create a new metadata configuration.
AccessDeniedWritingToTable - Unable to write to the metadata table because of missing resource permissions. To fix the resource policy, Amazon S3 needs to create a new metadata table. To create a new metadata table, you must delete the metadata configuration for this bucket, and then create a new metadata configuration.
DestinationTableNotFound - The destination table doesn't exist. To create a new metadata table, you must delete the metadata configuration for this bucket, and then create a new metadata configuration.
ServerInternalError - An internal error has occurred. To create a new metadata table, you must delete the metadata configuration for this bucket, and then create a new metadata configuration.
TableAlreadyExists - The table that you specified already exists in the table bucket's namespace. Specify a different table name. To create a new metadata table, you must delete the metadata configuration for this bucket, and then create a new metadata configuration.
TableBucketNotFound - The table bucket that you specified doesn't exist in this AWS Region and account. Create or choose a different table bucket. To create a new metadata table, you must delete the metadata configuration for this bucket, and then create a new metadata configuration. +func (o BucketMetadataTableErrorOutput) ErrorMessage() pulumi.StringOutput { + return o.ApplyT(func(v BucketMetadataTableError) string { return v.ErrorMessage }).(pulumi.StringOutput) +} + +type BucketMetadataTableErrorPtrOutput struct{ *pulumi.OutputState } + +func (BucketMetadataTableErrorPtrOutput) ElementType() reflect.Type { + return reflect.TypeOf((**BucketMetadataTableError)(nil)).Elem() +} + +func (o BucketMetadataTableErrorPtrOutput) ToBucketMetadataTableErrorPtrOutput() BucketMetadataTableErrorPtrOutput { + return o +} + +func (o BucketMetadataTableErrorPtrOutput) ToBucketMetadataTableErrorPtrOutputWithContext(ctx context.Context) BucketMetadataTableErrorPtrOutput { + return o +} + +func (o BucketMetadataTableErrorPtrOutput) Elem() BucketMetadataTableErrorOutput { + return o.ApplyT(func(v *BucketMetadataTableError) BucketMetadataTableError { + if v != nil { + return *v + } + var ret BucketMetadataTableError + return ret + }).(BucketMetadataTableErrorOutput) +} + +// If the CreateBucketMetadataTableConfiguration request succeeds, but S3 Metadata was unable to create the table, this structure contains the error code. The possible error codes and error messages are as follows:
AccessDeniedCreatingResources - You don't have sufficient permissions to create the required resources. Make sure that you have s3tables:CreateNamespace, s3tables:CreateTable, s3tables:GetTable and s3tables:PutTablePolicy permissions, and then try again. To create a new metadata table, you must delete the metadata configuration for this bucket, and then create a new metadata configuration.
AccessDeniedWritingToTable - Unable to write to the metadata table because of missing resource permissions. To fix the resource policy, Amazon S3 needs to create a new metadata table. To create a new metadata table, you must delete the metadata configuration for this bucket, and then create a new metadata configuration.
DestinationTableNotFound - The destination table doesn't exist. To create a new metadata table, you must delete the metadata configuration for this bucket, and then create a new metadata configuration.
ServerInternalError - An internal error has occurred. To create a new metadata table, you must delete the metadata configuration for this bucket, and then create a new metadata configuration.
TableAlreadyExists - The table that you specified already exists in the table bucket's namespace. Specify a different table name. To create a new metadata table, you must delete the metadata configuration for this bucket, and then create a new metadata configuration.
TableBucketNotFound - The table bucket that you specified doesn't exist in this AWS Region and account. Create or choose a different table bucket. To create a new metadata table, you must delete the metadata configuration for this bucket, and then create a new metadata configuration. +func (o BucketMetadataTableErrorPtrOutput) ErrorCode() pulumi.StringPtrOutput { + return o.ApplyT(func(v *BucketMetadataTableError) *string { + if v == nil { + return nil + } + return &v.ErrorCode + }).(pulumi.StringPtrOutput) +} + +// If the CreateBucketMetadataTableConfiguration request succeeds, but S3 Metadata was unable to create the table, this structure contains the error code. The possible error codes and error messages are as follows:
AccessDeniedCreatingResources - You don't have sufficient permissions to create the required resources. Make sure that you have s3tables:CreateNamespace, s3tables:CreateTable, s3tables:GetTable and s3tables:PutTablePolicy permissions, and then try again. To create a new metadata table, you must delete the metadata configuration for this bucket, and then create a new metadata configuration.
AccessDeniedWritingToTable - Unable to write to the metadata table because of missing resource permissions. To fix the resource policy, Amazon S3 needs to create a new metadata table. To create a new metadata table, you must delete the metadata configuration for this bucket, and then create a new metadata configuration.
DestinationTableNotFound - The destination table doesn't exist. To create a new metadata table, you must delete the metadata configuration for this bucket, and then create a new metadata configuration.
ServerInternalError - An internal error has occurred. To create a new metadata table, you must delete the metadata configuration for this bucket, and then create a new metadata configuration.
TableAlreadyExists - The table that you specified already exists in the table bucket's namespace. Specify a different table name. To create a new metadata table, you must delete the metadata configuration for this bucket, and then create a new metadata configuration.
TableBucketNotFound - The table bucket that you specified doesn't exist in this AWS Region and account. Create or choose a different table bucket. To create a new metadata table, you must delete the metadata configuration for this bucket, and then create a new metadata configuration. +func (o BucketMetadataTableErrorPtrOutput) ErrorMessage() pulumi.StringPtrOutput { + return o.ApplyT(func(v *BucketMetadataTableError) *string { + if v == nil { + return nil + } + return &v.ErrorMessage + }).(pulumi.StringPtrOutput) +} + // A container specifying replication metrics-related settings enabling replication metrics and events. type BucketMetrics struct { // A container specifying the time threshold for emitting the ``s3:Replication:OperationMissedThreshold`` event. @@ -7626,6 +7953,200 @@ func (o BucketS3KeyFilterPtrOutput) Rules() BucketFilterRuleArrayOutput { }).(BucketFilterRuleArrayOutput) } +type BucketS3TablesDestination struct { + // The Amazon Resource Name (ARN) for the metadata table in the metadata table configuration. The specified metadata table name must be unique within the aws_s3_metadata namespace in the destination table bucket. + TableArn *string `pulumi:"tableArn"` + // The Amazon Resource Name (ARN) for the table bucket that's specified as the destination in the metadata table configuration. The destination table bucket must be in the same Region and AWS account as the general purpose bucket. + TableBucketArn string `pulumi:"tableBucketArn"` + // The name for the metadata table in your metadata table configuration. The specified metadata table name must be unique within the aws_s3_metadata namespace in the destination table bucket. + TableName string `pulumi:"tableName"` + // The table bucket namespace for the metadata table in your metadata table configuration. This value is always aws_s3_metadata. + TableNamespace *string `pulumi:"tableNamespace"` +} + +// BucketS3TablesDestinationInput is an input type that accepts BucketS3TablesDestinationArgs and BucketS3TablesDestinationOutput values. +// You can construct a concrete instance of `BucketS3TablesDestinationInput` via: +// +// BucketS3TablesDestinationArgs{...} +type BucketS3TablesDestinationInput interface { + pulumi.Input + + ToBucketS3TablesDestinationOutput() BucketS3TablesDestinationOutput + ToBucketS3TablesDestinationOutputWithContext(context.Context) BucketS3TablesDestinationOutput +} + +type BucketS3TablesDestinationArgs struct { + // The Amazon Resource Name (ARN) for the metadata table in the metadata table configuration. The specified metadata table name must be unique within the aws_s3_metadata namespace in the destination table bucket. + TableArn pulumi.StringPtrInput `pulumi:"tableArn"` + // The Amazon Resource Name (ARN) for the table bucket that's specified as the destination in the metadata table configuration. The destination table bucket must be in the same Region and AWS account as the general purpose bucket. + TableBucketArn pulumi.StringInput `pulumi:"tableBucketArn"` + // The name for the metadata table in your metadata table configuration. The specified metadata table name must be unique within the aws_s3_metadata namespace in the destination table bucket. + TableName pulumi.StringInput `pulumi:"tableName"` + // The table bucket namespace for the metadata table in your metadata table configuration. This value is always aws_s3_metadata. + TableNamespace pulumi.StringPtrInput `pulumi:"tableNamespace"` +} + +func (BucketS3TablesDestinationArgs) ElementType() reflect.Type { + return reflect.TypeOf((*BucketS3TablesDestination)(nil)).Elem() +} + +func (i BucketS3TablesDestinationArgs) ToBucketS3TablesDestinationOutput() BucketS3TablesDestinationOutput { + return i.ToBucketS3TablesDestinationOutputWithContext(context.Background()) +} + +func (i BucketS3TablesDestinationArgs) ToBucketS3TablesDestinationOutputWithContext(ctx context.Context) BucketS3TablesDestinationOutput { + return pulumi.ToOutputWithContext(ctx, i).(BucketS3TablesDestinationOutput) +} + +func (i BucketS3TablesDestinationArgs) ToBucketS3TablesDestinationPtrOutput() BucketS3TablesDestinationPtrOutput { + return i.ToBucketS3TablesDestinationPtrOutputWithContext(context.Background()) +} + +func (i BucketS3TablesDestinationArgs) ToBucketS3TablesDestinationPtrOutputWithContext(ctx context.Context) BucketS3TablesDestinationPtrOutput { + return pulumi.ToOutputWithContext(ctx, i).(BucketS3TablesDestinationOutput).ToBucketS3TablesDestinationPtrOutputWithContext(ctx) +} + +// BucketS3TablesDestinationPtrInput is an input type that accepts BucketS3TablesDestinationArgs, BucketS3TablesDestinationPtr and BucketS3TablesDestinationPtrOutput values. +// You can construct a concrete instance of `BucketS3TablesDestinationPtrInput` via: +// +// BucketS3TablesDestinationArgs{...} +// +// or: +// +// nil +type BucketS3TablesDestinationPtrInput interface { + pulumi.Input + + ToBucketS3TablesDestinationPtrOutput() BucketS3TablesDestinationPtrOutput + ToBucketS3TablesDestinationPtrOutputWithContext(context.Context) BucketS3TablesDestinationPtrOutput +} + +type bucketS3TablesDestinationPtrType BucketS3TablesDestinationArgs + +func BucketS3TablesDestinationPtr(v *BucketS3TablesDestinationArgs) BucketS3TablesDestinationPtrInput { + return (*bucketS3TablesDestinationPtrType)(v) +} + +func (*bucketS3TablesDestinationPtrType) ElementType() reflect.Type { + return reflect.TypeOf((**BucketS3TablesDestination)(nil)).Elem() +} + +func (i *bucketS3TablesDestinationPtrType) ToBucketS3TablesDestinationPtrOutput() BucketS3TablesDestinationPtrOutput { + return i.ToBucketS3TablesDestinationPtrOutputWithContext(context.Background()) +} + +func (i *bucketS3TablesDestinationPtrType) ToBucketS3TablesDestinationPtrOutputWithContext(ctx context.Context) BucketS3TablesDestinationPtrOutput { + return pulumi.ToOutputWithContext(ctx, i).(BucketS3TablesDestinationPtrOutput) +} + +type BucketS3TablesDestinationOutput struct{ *pulumi.OutputState } + +func (BucketS3TablesDestinationOutput) ElementType() reflect.Type { + return reflect.TypeOf((*BucketS3TablesDestination)(nil)).Elem() +} + +func (o BucketS3TablesDestinationOutput) ToBucketS3TablesDestinationOutput() BucketS3TablesDestinationOutput { + return o +} + +func (o BucketS3TablesDestinationOutput) ToBucketS3TablesDestinationOutputWithContext(ctx context.Context) BucketS3TablesDestinationOutput { + return o +} + +func (o BucketS3TablesDestinationOutput) ToBucketS3TablesDestinationPtrOutput() BucketS3TablesDestinationPtrOutput { + return o.ToBucketS3TablesDestinationPtrOutputWithContext(context.Background()) +} + +func (o BucketS3TablesDestinationOutput) ToBucketS3TablesDestinationPtrOutputWithContext(ctx context.Context) BucketS3TablesDestinationPtrOutput { + return o.ApplyTWithContext(ctx, func(_ context.Context, v BucketS3TablesDestination) *BucketS3TablesDestination { + return &v + }).(BucketS3TablesDestinationPtrOutput) +} + +// The Amazon Resource Name (ARN) for the metadata table in the metadata table configuration. The specified metadata table name must be unique within the aws_s3_metadata namespace in the destination table bucket. +func (o BucketS3TablesDestinationOutput) TableArn() pulumi.StringPtrOutput { + return o.ApplyT(func(v BucketS3TablesDestination) *string { return v.TableArn }).(pulumi.StringPtrOutput) +} + +// The Amazon Resource Name (ARN) for the table bucket that's specified as the destination in the metadata table configuration. The destination table bucket must be in the same Region and AWS account as the general purpose bucket. +func (o BucketS3TablesDestinationOutput) TableBucketArn() pulumi.StringOutput { + return o.ApplyT(func(v BucketS3TablesDestination) string { return v.TableBucketArn }).(pulumi.StringOutput) +} + +// The name for the metadata table in your metadata table configuration. The specified metadata table name must be unique within the aws_s3_metadata namespace in the destination table bucket. +func (o BucketS3TablesDestinationOutput) TableName() pulumi.StringOutput { + return o.ApplyT(func(v BucketS3TablesDestination) string { return v.TableName }).(pulumi.StringOutput) +} + +// The table bucket namespace for the metadata table in your metadata table configuration. This value is always aws_s3_metadata. +func (o BucketS3TablesDestinationOutput) TableNamespace() pulumi.StringPtrOutput { + return o.ApplyT(func(v BucketS3TablesDestination) *string { return v.TableNamespace }).(pulumi.StringPtrOutput) +} + +type BucketS3TablesDestinationPtrOutput struct{ *pulumi.OutputState } + +func (BucketS3TablesDestinationPtrOutput) ElementType() reflect.Type { + return reflect.TypeOf((**BucketS3TablesDestination)(nil)).Elem() +} + +func (o BucketS3TablesDestinationPtrOutput) ToBucketS3TablesDestinationPtrOutput() BucketS3TablesDestinationPtrOutput { + return o +} + +func (o BucketS3TablesDestinationPtrOutput) ToBucketS3TablesDestinationPtrOutputWithContext(ctx context.Context) BucketS3TablesDestinationPtrOutput { + return o +} + +func (o BucketS3TablesDestinationPtrOutput) Elem() BucketS3TablesDestinationOutput { + return o.ApplyT(func(v *BucketS3TablesDestination) BucketS3TablesDestination { + if v != nil { + return *v + } + var ret BucketS3TablesDestination + return ret + }).(BucketS3TablesDestinationOutput) +} + +// The Amazon Resource Name (ARN) for the metadata table in the metadata table configuration. The specified metadata table name must be unique within the aws_s3_metadata namespace in the destination table bucket. +func (o BucketS3TablesDestinationPtrOutput) TableArn() pulumi.StringPtrOutput { + return o.ApplyT(func(v *BucketS3TablesDestination) *string { + if v == nil { + return nil + } + return v.TableArn + }).(pulumi.StringPtrOutput) +} + +// The Amazon Resource Name (ARN) for the table bucket that's specified as the destination in the metadata table configuration. The destination table bucket must be in the same Region and AWS account as the general purpose bucket. +func (o BucketS3TablesDestinationPtrOutput) TableBucketArn() pulumi.StringPtrOutput { + return o.ApplyT(func(v *BucketS3TablesDestination) *string { + if v == nil { + return nil + } + return &v.TableBucketArn + }).(pulumi.StringPtrOutput) +} + +// The name for the metadata table in your metadata table configuration. The specified metadata table name must be unique within the aws_s3_metadata namespace in the destination table bucket. +func (o BucketS3TablesDestinationPtrOutput) TableName() pulumi.StringPtrOutput { + return o.ApplyT(func(v *BucketS3TablesDestination) *string { + if v == nil { + return nil + } + return &v.TableName + }).(pulumi.StringPtrOutput) +} + +// The table bucket namespace for the metadata table in your metadata table configuration. This value is always aws_s3_metadata. +func (o BucketS3TablesDestinationPtrOutput) TableNamespace() pulumi.StringPtrOutput { + return o.ApplyT(func(v *BucketS3TablesDestination) *string { + if v == nil { + return nil + } + return v.TableNamespace + }).(pulumi.StringPtrOutput) +} + // Describes the default server-side encryption to apply to new objects in the bucket. If a PUT Object request doesn't specify any server-side encryption, this default encryption will be applied. For more information, see [PutBucketEncryption](https://docs.aws.amazon.com/AmazonS3/latest/API/RESTBucketPUTencryption.html). // - *General purpose buckets* - If you don't specify a customer managed key at configuration, Amazon S3 automatically creates an AWS KMS key (“aws/s3“) in your AWS account the first time that you add an object encrypted with SSE-KMS to a bucket. By default, Amazon S3 uses this KMS key for SSE-KMS. // - *Directory buckets* - Your SSE-KMS configuration can only support 1 [customer managed key](https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#customer-cmk) per directory bucket for the lifetime of the bucket. The [managed key](https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#aws-managed-cmk) (“aws/s3“) isn't supported. @@ -13575,6 +14096,10 @@ func init() { pulumi.RegisterInputType(reflect.TypeOf((*BucketLifecycleConfigurationPtrInput)(nil)).Elem(), BucketLifecycleConfigurationArgs{}) pulumi.RegisterInputType(reflect.TypeOf((*BucketLoggingConfigurationInput)(nil)).Elem(), BucketLoggingConfigurationArgs{}) pulumi.RegisterInputType(reflect.TypeOf((*BucketLoggingConfigurationPtrInput)(nil)).Elem(), BucketLoggingConfigurationArgs{}) + pulumi.RegisterInputType(reflect.TypeOf((*BucketMetadataTableConfigurationInput)(nil)).Elem(), BucketMetadataTableConfigurationArgs{}) + pulumi.RegisterInputType(reflect.TypeOf((*BucketMetadataTableConfigurationPtrInput)(nil)).Elem(), BucketMetadataTableConfigurationArgs{}) + pulumi.RegisterInputType(reflect.TypeOf((*BucketMetadataTableErrorInput)(nil)).Elem(), BucketMetadataTableErrorArgs{}) + pulumi.RegisterInputType(reflect.TypeOf((*BucketMetadataTableErrorPtrInput)(nil)).Elem(), BucketMetadataTableErrorArgs{}) pulumi.RegisterInputType(reflect.TypeOf((*BucketMetricsInput)(nil)).Elem(), BucketMetricsArgs{}) pulumi.RegisterInputType(reflect.TypeOf((*BucketMetricsPtrInput)(nil)).Elem(), BucketMetricsArgs{}) pulumi.RegisterInputType(reflect.TypeOf((*BucketMetricsConfigurationInput)(nil)).Elem(), BucketMetricsConfigurationArgs{}) @@ -13626,6 +14151,8 @@ func init() { pulumi.RegisterInputType(reflect.TypeOf((*BucketRuleArrayInput)(nil)).Elem(), BucketRuleArray{}) pulumi.RegisterInputType(reflect.TypeOf((*BucketS3KeyFilterInput)(nil)).Elem(), BucketS3KeyFilterArgs{}) pulumi.RegisterInputType(reflect.TypeOf((*BucketS3KeyFilterPtrInput)(nil)).Elem(), BucketS3KeyFilterArgs{}) + pulumi.RegisterInputType(reflect.TypeOf((*BucketS3TablesDestinationInput)(nil)).Elem(), BucketS3TablesDestinationArgs{}) + pulumi.RegisterInputType(reflect.TypeOf((*BucketS3TablesDestinationPtrInput)(nil)).Elem(), BucketS3TablesDestinationArgs{}) pulumi.RegisterInputType(reflect.TypeOf((*BucketServerSideEncryptionByDefaultInput)(nil)).Elem(), BucketServerSideEncryptionByDefaultArgs{}) pulumi.RegisterInputType(reflect.TypeOf((*BucketServerSideEncryptionByDefaultPtrInput)(nil)).Elem(), BucketServerSideEncryptionByDefaultArgs{}) pulumi.RegisterInputType(reflect.TypeOf((*BucketServerSideEncryptionRuleInput)(nil)).Elem(), BucketServerSideEncryptionRuleArgs{}) @@ -13745,6 +14272,10 @@ func init() { pulumi.RegisterOutputType(BucketLifecycleConfigurationPtrOutput{}) pulumi.RegisterOutputType(BucketLoggingConfigurationOutput{}) pulumi.RegisterOutputType(BucketLoggingConfigurationPtrOutput{}) + pulumi.RegisterOutputType(BucketMetadataTableConfigurationOutput{}) + pulumi.RegisterOutputType(BucketMetadataTableConfigurationPtrOutput{}) + pulumi.RegisterOutputType(BucketMetadataTableErrorOutput{}) + pulumi.RegisterOutputType(BucketMetadataTableErrorPtrOutput{}) pulumi.RegisterOutputType(BucketMetricsOutput{}) pulumi.RegisterOutputType(BucketMetricsPtrOutput{}) pulumi.RegisterOutputType(BucketMetricsConfigurationOutput{}) @@ -13796,6 +14327,8 @@ func init() { pulumi.RegisterOutputType(BucketRuleArrayOutput{}) pulumi.RegisterOutputType(BucketS3KeyFilterOutput{}) pulumi.RegisterOutputType(BucketS3KeyFilterPtrOutput{}) + pulumi.RegisterOutputType(BucketS3TablesDestinationOutput{}) + pulumi.RegisterOutputType(BucketS3TablesDestinationPtrOutput{}) pulumi.RegisterOutputType(BucketServerSideEncryptionByDefaultOutput{}) pulumi.RegisterOutputType(BucketServerSideEncryptionByDefaultPtrOutput{}) pulumi.RegisterOutputType(BucketServerSideEncryptionRuleOutput{}) diff --git a/sdk/go/aws/s3express/directoryBucket.go b/sdk/go/aws/s3express/directoryBucket.go index 943bdeff26..bc64ee0873 100644 --- a/sdk/go/aws/s3express/directoryBucket.go +++ b/sdk/go/aws/s3express/directoryBucket.go @@ -18,17 +18,17 @@ type DirectoryBucket struct { // Returns the Amazon Resource Name (ARN) of the specified bucket. Arn pulumi.StringOutput `pulumi:"arn"` - // Returns the code for the Availability Zone where the directory bucket was created. + // Returns the code for the Availability Zone or Local Zone where the directory bucket was created. An example for the code of an Availability Zone is 'us-east-1f'. AvailabilityZoneName pulumi.StringOutput `pulumi:"availabilityZoneName"` // Specifies default encryption for a bucket using server-side encryption with Amazon S3 managed keys (SSE-S3) or AWS KMS keys (SSE-KMS). For information about default encryption for directory buckets, see [Setting and monitoring default encryption for directory buckets](https://docs.aws.amazon.com/AmazonS3/latest/userguide/s3-express-bucket-encryption.html) in the *Amazon S3 User Guide* . BucketEncryption DirectoryBucketBucketEncryptionPtrOutput `pulumi:"bucketEncryption"` - // Specifies a name for the bucket. The bucket name must contain only lowercase letters, numbers, and hyphens (-). A directory bucket name must be unique in the chosen Availability Zone. The bucket name must also follow the format 'bucket_base_name--az_id--x-s3' (for example, 'DOC-EXAMPLE-BUCKET--usw2-az1--x-s3'). If you don't specify a name, AWS CloudFormation generates a unique physical ID and uses that ID for the bucket name. + // Specifies a name for the bucket. The bucket name must contain only lowercase letters, numbers, and hyphens (-). A directory bucket name must be unique in the chosen Availability Zone or Local Zone. The bucket name must also follow the format 'bucket_base_name--zone_id--x-s3'. The zone_id can be the ID of an Availability Zone or a Local Zone. If you don't specify a name, AWS CloudFormation generates a unique physical ID and uses that ID for the bucket name. BucketName pulumi.StringPtrOutput `pulumi:"bucketName"` - // Specifies the number of Availability Zone that's used for redundancy for the bucket. + // Specifies the number of Availability Zone or Local Zone that's used for redundancy for the bucket. DataRedundancy DirectoryBucketDataRedundancyOutput `pulumi:"dataRedundancy"` // Lifecycle rules that define how Amazon S3 Express manages objects during their lifetime. LifecycleConfiguration DirectoryBucketLifecycleConfigurationPtrOutput `pulumi:"lifecycleConfiguration"` - // Specifies the AZ ID of the Availability Zone where the directory bucket will be created. An example AZ ID value is 'use1-az5'. + // Specifies the Zone ID of the Availability Zone or Local Zone where the directory bucket will be created. An example Availability Zone ID value is 'use1-az5'. LocationName pulumi.StringOutput `pulumi:"locationName"` } @@ -86,13 +86,13 @@ func (DirectoryBucketState) ElementType() reflect.Type { type directoryBucketArgs struct { // Specifies default encryption for a bucket using server-side encryption with Amazon S3 managed keys (SSE-S3) or AWS KMS keys (SSE-KMS). For information about default encryption for directory buckets, see [Setting and monitoring default encryption for directory buckets](https://docs.aws.amazon.com/AmazonS3/latest/userguide/s3-express-bucket-encryption.html) in the *Amazon S3 User Guide* . BucketEncryption *DirectoryBucketBucketEncryption `pulumi:"bucketEncryption"` - // Specifies a name for the bucket. The bucket name must contain only lowercase letters, numbers, and hyphens (-). A directory bucket name must be unique in the chosen Availability Zone. The bucket name must also follow the format 'bucket_base_name--az_id--x-s3' (for example, 'DOC-EXAMPLE-BUCKET--usw2-az1--x-s3'). If you don't specify a name, AWS CloudFormation generates a unique physical ID and uses that ID for the bucket name. + // Specifies a name for the bucket. The bucket name must contain only lowercase letters, numbers, and hyphens (-). A directory bucket name must be unique in the chosen Availability Zone or Local Zone. The bucket name must also follow the format 'bucket_base_name--zone_id--x-s3'. The zone_id can be the ID of an Availability Zone or a Local Zone. If you don't specify a name, AWS CloudFormation generates a unique physical ID and uses that ID for the bucket name. BucketName *string `pulumi:"bucketName"` - // Specifies the number of Availability Zone that's used for redundancy for the bucket. + // Specifies the number of Availability Zone or Local Zone that's used for redundancy for the bucket. DataRedundancy DirectoryBucketDataRedundancy `pulumi:"dataRedundancy"` // Lifecycle rules that define how Amazon S3 Express manages objects during their lifetime. LifecycleConfiguration *DirectoryBucketLifecycleConfiguration `pulumi:"lifecycleConfiguration"` - // Specifies the AZ ID of the Availability Zone where the directory bucket will be created. An example AZ ID value is 'use1-az5'. + // Specifies the Zone ID of the Availability Zone or Local Zone where the directory bucket will be created. An example Availability Zone ID value is 'use1-az5'. LocationName string `pulumi:"locationName"` } @@ -100,13 +100,13 @@ type directoryBucketArgs struct { type DirectoryBucketArgs struct { // Specifies default encryption for a bucket using server-side encryption with Amazon S3 managed keys (SSE-S3) or AWS KMS keys (SSE-KMS). For information about default encryption for directory buckets, see [Setting and monitoring default encryption for directory buckets](https://docs.aws.amazon.com/AmazonS3/latest/userguide/s3-express-bucket-encryption.html) in the *Amazon S3 User Guide* . BucketEncryption DirectoryBucketBucketEncryptionPtrInput - // Specifies a name for the bucket. The bucket name must contain only lowercase letters, numbers, and hyphens (-). A directory bucket name must be unique in the chosen Availability Zone. The bucket name must also follow the format 'bucket_base_name--az_id--x-s3' (for example, 'DOC-EXAMPLE-BUCKET--usw2-az1--x-s3'). If you don't specify a name, AWS CloudFormation generates a unique physical ID and uses that ID for the bucket name. + // Specifies a name for the bucket. The bucket name must contain only lowercase letters, numbers, and hyphens (-). A directory bucket name must be unique in the chosen Availability Zone or Local Zone. The bucket name must also follow the format 'bucket_base_name--zone_id--x-s3'. The zone_id can be the ID of an Availability Zone or a Local Zone. If you don't specify a name, AWS CloudFormation generates a unique physical ID and uses that ID for the bucket name. BucketName pulumi.StringPtrInput - // Specifies the number of Availability Zone that's used for redundancy for the bucket. + // Specifies the number of Availability Zone or Local Zone that's used for redundancy for the bucket. DataRedundancy DirectoryBucketDataRedundancyInput // Lifecycle rules that define how Amazon S3 Express manages objects during their lifetime. LifecycleConfiguration DirectoryBucketLifecycleConfigurationPtrInput - // Specifies the AZ ID of the Availability Zone where the directory bucket will be created. An example AZ ID value is 'use1-az5'. + // Specifies the Zone ID of the Availability Zone or Local Zone where the directory bucket will be created. An example Availability Zone ID value is 'use1-az5'. LocationName pulumi.StringInput } @@ -152,7 +152,7 @@ func (o DirectoryBucketOutput) Arn() pulumi.StringOutput { return o.ApplyT(func(v *DirectoryBucket) pulumi.StringOutput { return v.Arn }).(pulumi.StringOutput) } -// Returns the code for the Availability Zone where the directory bucket was created. +// Returns the code for the Availability Zone or Local Zone where the directory bucket was created. An example for the code of an Availability Zone is 'us-east-1f'. func (o DirectoryBucketOutput) AvailabilityZoneName() pulumi.StringOutput { return o.ApplyT(func(v *DirectoryBucket) pulumi.StringOutput { return v.AvailabilityZoneName }).(pulumi.StringOutput) } @@ -162,12 +162,12 @@ func (o DirectoryBucketOutput) BucketEncryption() DirectoryBucketBucketEncryptio return o.ApplyT(func(v *DirectoryBucket) DirectoryBucketBucketEncryptionPtrOutput { return v.BucketEncryption }).(DirectoryBucketBucketEncryptionPtrOutput) } -// Specifies a name for the bucket. The bucket name must contain only lowercase letters, numbers, and hyphens (-). A directory bucket name must be unique in the chosen Availability Zone. The bucket name must also follow the format 'bucket_base_name--az_id--x-s3' (for example, 'DOC-EXAMPLE-BUCKET--usw2-az1--x-s3'). If you don't specify a name, AWS CloudFormation generates a unique physical ID and uses that ID for the bucket name. +// Specifies a name for the bucket. The bucket name must contain only lowercase letters, numbers, and hyphens (-). A directory bucket name must be unique in the chosen Availability Zone or Local Zone. The bucket name must also follow the format 'bucket_base_name--zone_id--x-s3'. The zone_id can be the ID of an Availability Zone or a Local Zone. If you don't specify a name, AWS CloudFormation generates a unique physical ID and uses that ID for the bucket name. func (o DirectoryBucketOutput) BucketName() pulumi.StringPtrOutput { return o.ApplyT(func(v *DirectoryBucket) pulumi.StringPtrOutput { return v.BucketName }).(pulumi.StringPtrOutput) } -// Specifies the number of Availability Zone that's used for redundancy for the bucket. +// Specifies the number of Availability Zone or Local Zone that's used for redundancy for the bucket. func (o DirectoryBucketOutput) DataRedundancy() DirectoryBucketDataRedundancyOutput { return o.ApplyT(func(v *DirectoryBucket) DirectoryBucketDataRedundancyOutput { return v.DataRedundancy }).(DirectoryBucketDataRedundancyOutput) } @@ -179,7 +179,7 @@ func (o DirectoryBucketOutput) LifecycleConfiguration() DirectoryBucketLifecycle }).(DirectoryBucketLifecycleConfigurationPtrOutput) } -// Specifies the AZ ID of the Availability Zone where the directory bucket will be created. An example AZ ID value is 'use1-az5'. +// Specifies the Zone ID of the Availability Zone or Local Zone where the directory bucket will be created. An example Availability Zone ID value is 'use1-az5'. func (o DirectoryBucketOutput) LocationName() pulumi.StringOutput { return o.ApplyT(func(v *DirectoryBucket) pulumi.StringOutput { return v.LocationName }).(pulumi.StringOutput) } diff --git a/sdk/go/aws/s3express/getDirectoryBucket.go b/sdk/go/aws/s3express/getDirectoryBucket.go index d44971ab63..2cbbccbe84 100644 --- a/sdk/go/aws/s3express/getDirectoryBucket.go +++ b/sdk/go/aws/s3express/getDirectoryBucket.go @@ -23,14 +23,14 @@ func LookupDirectoryBucket(ctx *pulumi.Context, args *LookupDirectoryBucketArgs, } type LookupDirectoryBucketArgs struct { - // Specifies a name for the bucket. The bucket name must contain only lowercase letters, numbers, and hyphens (-). A directory bucket name must be unique in the chosen Availability Zone. The bucket name must also follow the format 'bucket_base_name--az_id--x-s3' (for example, 'DOC-EXAMPLE-BUCKET--usw2-az1--x-s3'). If you don't specify a name, AWS CloudFormation generates a unique physical ID and uses that ID for the bucket name. + // Specifies a name for the bucket. The bucket name must contain only lowercase letters, numbers, and hyphens (-). A directory bucket name must be unique in the chosen Availability Zone or Local Zone. The bucket name must also follow the format 'bucket_base_name--zone_id--x-s3'. The zone_id can be the ID of an Availability Zone or a Local Zone. If you don't specify a name, AWS CloudFormation generates a unique physical ID and uses that ID for the bucket name. BucketName string `pulumi:"bucketName"` } type LookupDirectoryBucketResult struct { // Returns the Amazon Resource Name (ARN) of the specified bucket. Arn *string `pulumi:"arn"` - // Returns the code for the Availability Zone where the directory bucket was created. + // Returns the code for the Availability Zone or Local Zone where the directory bucket was created. An example for the code of an Availability Zone is 'us-east-1f'. AvailabilityZoneName *string `pulumi:"availabilityZoneName"` // Specifies default encryption for a bucket using server-side encryption with Amazon S3 managed keys (SSE-S3) or AWS KMS keys (SSE-KMS). For information about default encryption for directory buckets, see [Setting and monitoring default encryption for directory buckets](https://docs.aws.amazon.com/AmazonS3/latest/userguide/s3-express-bucket-encryption.html) in the *Amazon S3 User Guide* . BucketEncryption *DirectoryBucketBucketEncryption `pulumi:"bucketEncryption"` @@ -58,7 +58,7 @@ func LookupDirectoryBucketOutput(ctx *pulumi.Context, args LookupDirectoryBucket } type LookupDirectoryBucketOutputArgs struct { - // Specifies a name for the bucket. The bucket name must contain only lowercase letters, numbers, and hyphens (-). A directory bucket name must be unique in the chosen Availability Zone. The bucket name must also follow the format 'bucket_base_name--az_id--x-s3' (for example, 'DOC-EXAMPLE-BUCKET--usw2-az1--x-s3'). If you don't specify a name, AWS CloudFormation generates a unique physical ID and uses that ID for the bucket name. + // Specifies a name for the bucket. The bucket name must contain only lowercase letters, numbers, and hyphens (-). A directory bucket name must be unique in the chosen Availability Zone or Local Zone. The bucket name must also follow the format 'bucket_base_name--zone_id--x-s3'. The zone_id can be the ID of an Availability Zone or a Local Zone. If you don't specify a name, AWS CloudFormation generates a unique physical ID and uses that ID for the bucket name. BucketName pulumi.StringInput `pulumi:"bucketName"` } @@ -85,7 +85,7 @@ func (o LookupDirectoryBucketResultOutput) Arn() pulumi.StringPtrOutput { return o.ApplyT(func(v LookupDirectoryBucketResult) *string { return v.Arn }).(pulumi.StringPtrOutput) } -// Returns the code for the Availability Zone where the directory bucket was created. +// Returns the code for the Availability Zone or Local Zone where the directory bucket was created. An example for the code of an Availability Zone is 'us-east-1f'. func (o LookupDirectoryBucketResultOutput) AvailabilityZoneName() pulumi.StringPtrOutput { return o.ApplyT(func(v LookupDirectoryBucketResult) *string { return v.AvailabilityZoneName }).(pulumi.StringPtrOutput) } diff --git a/sdk/go/aws/s3express/pulumiEnums.go b/sdk/go/aws/s3express/pulumiEnums.go index 3f0bc018a2..3534c375ae 100644 --- a/sdk/go/aws/s3express/pulumiEnums.go +++ b/sdk/go/aws/s3express/pulumiEnums.go @@ -10,11 +10,12 @@ import ( "github.com/pulumi/pulumi/sdk/v3/go/pulumi" ) -// Specifies the number of Availability Zone that's used for redundancy for the bucket. +// Specifies the number of Availability Zone or Local Zone that's used for redundancy for the bucket. type DirectoryBucketDataRedundancy string const ( DirectoryBucketDataRedundancySingleAvailabilityZone = DirectoryBucketDataRedundancy("SingleAvailabilityZone") + DirectoryBucketDataRedundancySingleLocalZone = DirectoryBucketDataRedundancy("SingleLocalZone") ) func (DirectoryBucketDataRedundancy) ElementType() reflect.Type { @@ -140,6 +141,7 @@ func (o DirectoryBucketDataRedundancyPtrOutput) ToStringPtrOutputWithContext(ctx // A concrete instance of `DirectoryBucketDataRedundancyInput` can be one of the following: // // DirectoryBucketDataRedundancySingleAvailabilityZone +// DirectoryBucketDataRedundancySingleLocalZone type DirectoryBucketDataRedundancyInput interface { pulumi.Input diff --git a/sdk/go/aws/s3tables/getTableBucket.go b/sdk/go/aws/s3tables/getTableBucket.go new file mode 100644 index 0000000000..d12f696c9f --- /dev/null +++ b/sdk/go/aws/s3tables/getTableBucket.go @@ -0,0 +1,85 @@ +// Code generated by pulumi-language-go DO NOT EDIT. +// *** WARNING: Do not edit by hand unless you're certain you know what you are doing! *** + +package s3tables + +import ( + "context" + "reflect" + + "github.com/pulumi/pulumi-aws-native/sdk/go/aws/internal" + "github.com/pulumi/pulumi/sdk/v3/go/pulumi" +) + +// Creates an Amazon S3 Tables table bucket in the same AWS Region where you create the AWS CloudFormation stack. +func LookupTableBucket(ctx *pulumi.Context, args *LookupTableBucketArgs, opts ...pulumi.InvokeOption) (*LookupTableBucketResult, error) { + opts = internal.PkgInvokeDefaultOpts(opts) + var rv LookupTableBucketResult + err := ctx.Invoke("aws-native:s3tables:getTableBucket", args, &rv, opts...) + if err != nil { + return nil, err + } + return &rv, nil +} + +type LookupTableBucketArgs struct { + TableBucketArn string `pulumi:"tableBucketArn"` +} + +type LookupTableBucketResult struct { + TableBucketArn *string `pulumi:"tableBucketArn"` + UnreferencedFileRemoval *TableBucketUnreferencedFileRemoval `pulumi:"unreferencedFileRemoval"` +} + +func LookupTableBucketOutput(ctx *pulumi.Context, args LookupTableBucketOutputArgs, opts ...pulumi.InvokeOption) LookupTableBucketResultOutput { + return pulumi.ToOutputWithContext(context.Background(), args). + ApplyT(func(v interface{}) (LookupTableBucketResultOutput, error) { + args := v.(LookupTableBucketArgs) + opts = internal.PkgInvokeDefaultOpts(opts) + var rv LookupTableBucketResult + secret, err := ctx.InvokePackageRaw("aws-native:s3tables:getTableBucket", args, &rv, "", opts...) + if err != nil { + return LookupTableBucketResultOutput{}, err + } + + output := pulumi.ToOutput(rv).(LookupTableBucketResultOutput) + if secret { + return pulumi.ToSecret(output).(LookupTableBucketResultOutput), nil + } + return output, nil + }).(LookupTableBucketResultOutput) +} + +type LookupTableBucketOutputArgs struct { + TableBucketArn pulumi.StringInput `pulumi:"tableBucketArn"` +} + +func (LookupTableBucketOutputArgs) ElementType() reflect.Type { + return reflect.TypeOf((*LookupTableBucketArgs)(nil)).Elem() +} + +type LookupTableBucketResultOutput struct{ *pulumi.OutputState } + +func (LookupTableBucketResultOutput) ElementType() reflect.Type { + return reflect.TypeOf((*LookupTableBucketResult)(nil)).Elem() +} + +func (o LookupTableBucketResultOutput) ToLookupTableBucketResultOutput() LookupTableBucketResultOutput { + return o +} + +func (o LookupTableBucketResultOutput) ToLookupTableBucketResultOutputWithContext(ctx context.Context) LookupTableBucketResultOutput { + return o +} + +func (o LookupTableBucketResultOutput) TableBucketArn() pulumi.StringPtrOutput { + return o.ApplyT(func(v LookupTableBucketResult) *string { return v.TableBucketArn }).(pulumi.StringPtrOutput) +} + +func (o LookupTableBucketResultOutput) UnreferencedFileRemoval() TableBucketUnreferencedFileRemovalPtrOutput { + return o.ApplyT(func(v LookupTableBucketResult) *TableBucketUnreferencedFileRemoval { return v.UnreferencedFileRemoval }).(TableBucketUnreferencedFileRemovalPtrOutput) +} + +func init() { + pulumi.RegisterOutputType(LookupTableBucketResultOutput{}) +} diff --git a/sdk/go/aws/s3tables/getTableBucketPolicy.go b/sdk/go/aws/s3tables/getTableBucketPolicy.go new file mode 100644 index 0000000000..950226827c --- /dev/null +++ b/sdk/go/aws/s3tables/getTableBucketPolicy.go @@ -0,0 +1,80 @@ +// Code generated by pulumi-language-go DO NOT EDIT. +// *** WARNING: Do not edit by hand unless you're certain you know what you are doing! *** + +package s3tables + +import ( + "context" + "reflect" + + "github.com/pulumi/pulumi-aws-native/sdk/go/aws/internal" + "github.com/pulumi/pulumi/sdk/v3/go/pulumi" +) + +// Applies an IAM resource policy to a table bucket. +func LookupTableBucketPolicy(ctx *pulumi.Context, args *LookupTableBucketPolicyArgs, opts ...pulumi.InvokeOption) (*LookupTableBucketPolicyResult, error) { + opts = internal.PkgInvokeDefaultOpts(opts) + var rv LookupTableBucketPolicyResult + err := ctx.Invoke("aws-native:s3tables:getTableBucketPolicy", args, &rv, opts...) + if err != nil { + return nil, err + } + return &rv, nil +} + +type LookupTableBucketPolicyArgs struct { + TableBucketArn string `pulumi:"tableBucketArn"` +} + +type LookupTableBucketPolicyResult struct { + ResourcePolicy *TableBucketPolicyResourcePolicy `pulumi:"resourcePolicy"` +} + +func LookupTableBucketPolicyOutput(ctx *pulumi.Context, args LookupTableBucketPolicyOutputArgs, opts ...pulumi.InvokeOption) LookupTableBucketPolicyResultOutput { + return pulumi.ToOutputWithContext(context.Background(), args). + ApplyT(func(v interface{}) (LookupTableBucketPolicyResultOutput, error) { + args := v.(LookupTableBucketPolicyArgs) + opts = internal.PkgInvokeDefaultOpts(opts) + var rv LookupTableBucketPolicyResult + secret, err := ctx.InvokePackageRaw("aws-native:s3tables:getTableBucketPolicy", args, &rv, "", opts...) + if err != nil { + return LookupTableBucketPolicyResultOutput{}, err + } + + output := pulumi.ToOutput(rv).(LookupTableBucketPolicyResultOutput) + if secret { + return pulumi.ToSecret(output).(LookupTableBucketPolicyResultOutput), nil + } + return output, nil + }).(LookupTableBucketPolicyResultOutput) +} + +type LookupTableBucketPolicyOutputArgs struct { + TableBucketArn pulumi.StringInput `pulumi:"tableBucketArn"` +} + +func (LookupTableBucketPolicyOutputArgs) ElementType() reflect.Type { + return reflect.TypeOf((*LookupTableBucketPolicyArgs)(nil)).Elem() +} + +type LookupTableBucketPolicyResultOutput struct{ *pulumi.OutputState } + +func (LookupTableBucketPolicyResultOutput) ElementType() reflect.Type { + return reflect.TypeOf((*LookupTableBucketPolicyResult)(nil)).Elem() +} + +func (o LookupTableBucketPolicyResultOutput) ToLookupTableBucketPolicyResultOutput() LookupTableBucketPolicyResultOutput { + return o +} + +func (o LookupTableBucketPolicyResultOutput) ToLookupTableBucketPolicyResultOutputWithContext(ctx context.Context) LookupTableBucketPolicyResultOutput { + return o +} + +func (o LookupTableBucketPolicyResultOutput) ResourcePolicy() TableBucketPolicyResourcePolicyPtrOutput { + return o.ApplyT(func(v LookupTableBucketPolicyResult) *TableBucketPolicyResourcePolicy { return v.ResourcePolicy }).(TableBucketPolicyResourcePolicyPtrOutput) +} + +func init() { + pulumi.RegisterOutputType(LookupTableBucketPolicyResultOutput{}) +} diff --git a/sdk/go/aws/s3tables/init.go b/sdk/go/aws/s3tables/init.go new file mode 100644 index 0000000000..6d51d0ef19 --- /dev/null +++ b/sdk/go/aws/s3tables/init.go @@ -0,0 +1,46 @@ +// Code generated by pulumi-language-go DO NOT EDIT. +// *** WARNING: Do not edit by hand unless you're certain you know what you are doing! *** + +package s3tables + +import ( + "fmt" + + "github.com/blang/semver" + "github.com/pulumi/pulumi-aws-native/sdk/go/aws/internal" + "github.com/pulumi/pulumi/sdk/v3/go/pulumi" +) + +type module struct { + version semver.Version +} + +func (m *module) Version() semver.Version { + return m.version +} + +func (m *module) Construct(ctx *pulumi.Context, name, typ, urn string) (r pulumi.Resource, err error) { + switch typ { + case "aws-native:s3tables:TableBucket": + r = &TableBucket{} + case "aws-native:s3tables:TableBucketPolicy": + r = &TableBucketPolicy{} + default: + return nil, fmt.Errorf("unknown resource type: %s", typ) + } + + err = ctx.RegisterResource(typ, name, nil, r, pulumi.URN_(urn)) + return +} + +func init() { + version, err := internal.PkgVersion() + if err != nil { + version = semver.Version{Major: 1} + } + pulumi.RegisterResourceModule( + "aws-native", + "s3tables", + &module{version}, + ) +} diff --git a/sdk/go/aws/s3tables/pulumiEnums.go b/sdk/go/aws/s3tables/pulumiEnums.go new file mode 100644 index 0000000000..15b5167ac4 --- /dev/null +++ b/sdk/go/aws/s3tables/pulumiEnums.go @@ -0,0 +1,184 @@ +// Code generated by pulumi-language-go DO NOT EDIT. +// *** WARNING: Do not edit by hand unless you're certain you know what you are doing! *** + +package s3tables + +import ( + "context" + "reflect" + + "github.com/pulumi/pulumi/sdk/v3/go/pulumi" +) + +// Indicates whether the Unreferenced File Removal maintenance action is enabled. +type TableBucketUnreferencedFileRemovalStatus string + +const ( + TableBucketUnreferencedFileRemovalStatusEnabled = TableBucketUnreferencedFileRemovalStatus("Enabled") + TableBucketUnreferencedFileRemovalStatusDisabled = TableBucketUnreferencedFileRemovalStatus("Disabled") +) + +func (TableBucketUnreferencedFileRemovalStatus) ElementType() reflect.Type { + return reflect.TypeOf((*TableBucketUnreferencedFileRemovalStatus)(nil)).Elem() +} + +func (e TableBucketUnreferencedFileRemovalStatus) ToTableBucketUnreferencedFileRemovalStatusOutput() TableBucketUnreferencedFileRemovalStatusOutput { + return pulumi.ToOutput(e).(TableBucketUnreferencedFileRemovalStatusOutput) +} + +func (e TableBucketUnreferencedFileRemovalStatus) ToTableBucketUnreferencedFileRemovalStatusOutputWithContext(ctx context.Context) TableBucketUnreferencedFileRemovalStatusOutput { + return pulumi.ToOutputWithContext(ctx, e).(TableBucketUnreferencedFileRemovalStatusOutput) +} + +func (e TableBucketUnreferencedFileRemovalStatus) ToTableBucketUnreferencedFileRemovalStatusPtrOutput() TableBucketUnreferencedFileRemovalStatusPtrOutput { + return e.ToTableBucketUnreferencedFileRemovalStatusPtrOutputWithContext(context.Background()) +} + +func (e TableBucketUnreferencedFileRemovalStatus) ToTableBucketUnreferencedFileRemovalStatusPtrOutputWithContext(ctx context.Context) TableBucketUnreferencedFileRemovalStatusPtrOutput { + return TableBucketUnreferencedFileRemovalStatus(e).ToTableBucketUnreferencedFileRemovalStatusOutputWithContext(ctx).ToTableBucketUnreferencedFileRemovalStatusPtrOutputWithContext(ctx) +} + +func (e TableBucketUnreferencedFileRemovalStatus) ToStringOutput() pulumi.StringOutput { + return pulumi.ToOutput(pulumi.String(e)).(pulumi.StringOutput) +} + +func (e TableBucketUnreferencedFileRemovalStatus) ToStringOutputWithContext(ctx context.Context) pulumi.StringOutput { + return pulumi.ToOutputWithContext(ctx, pulumi.String(e)).(pulumi.StringOutput) +} + +func (e TableBucketUnreferencedFileRemovalStatus) ToStringPtrOutput() pulumi.StringPtrOutput { + return pulumi.String(e).ToStringPtrOutputWithContext(context.Background()) +} + +func (e TableBucketUnreferencedFileRemovalStatus) ToStringPtrOutputWithContext(ctx context.Context) pulumi.StringPtrOutput { + return pulumi.String(e).ToStringOutputWithContext(ctx).ToStringPtrOutputWithContext(ctx) +} + +type TableBucketUnreferencedFileRemovalStatusOutput struct{ *pulumi.OutputState } + +func (TableBucketUnreferencedFileRemovalStatusOutput) ElementType() reflect.Type { + return reflect.TypeOf((*TableBucketUnreferencedFileRemovalStatus)(nil)).Elem() +} + +func (o TableBucketUnreferencedFileRemovalStatusOutput) ToTableBucketUnreferencedFileRemovalStatusOutput() TableBucketUnreferencedFileRemovalStatusOutput { + return o +} + +func (o TableBucketUnreferencedFileRemovalStatusOutput) ToTableBucketUnreferencedFileRemovalStatusOutputWithContext(ctx context.Context) TableBucketUnreferencedFileRemovalStatusOutput { + return o +} + +func (o TableBucketUnreferencedFileRemovalStatusOutput) ToTableBucketUnreferencedFileRemovalStatusPtrOutput() TableBucketUnreferencedFileRemovalStatusPtrOutput { + return o.ToTableBucketUnreferencedFileRemovalStatusPtrOutputWithContext(context.Background()) +} + +func (o TableBucketUnreferencedFileRemovalStatusOutput) ToTableBucketUnreferencedFileRemovalStatusPtrOutputWithContext(ctx context.Context) TableBucketUnreferencedFileRemovalStatusPtrOutput { + return o.ApplyTWithContext(ctx, func(_ context.Context, v TableBucketUnreferencedFileRemovalStatus) *TableBucketUnreferencedFileRemovalStatus { + return &v + }).(TableBucketUnreferencedFileRemovalStatusPtrOutput) +} + +func (o TableBucketUnreferencedFileRemovalStatusOutput) ToStringOutput() pulumi.StringOutput { + return o.ToStringOutputWithContext(context.Background()) +} + +func (o TableBucketUnreferencedFileRemovalStatusOutput) ToStringOutputWithContext(ctx context.Context) pulumi.StringOutput { + return o.ApplyTWithContext(ctx, func(_ context.Context, e TableBucketUnreferencedFileRemovalStatus) string { + return string(e) + }).(pulumi.StringOutput) +} + +func (o TableBucketUnreferencedFileRemovalStatusOutput) ToStringPtrOutput() pulumi.StringPtrOutput { + return o.ToStringPtrOutputWithContext(context.Background()) +} + +func (o TableBucketUnreferencedFileRemovalStatusOutput) ToStringPtrOutputWithContext(ctx context.Context) pulumi.StringPtrOutput { + return o.ApplyTWithContext(ctx, func(_ context.Context, e TableBucketUnreferencedFileRemovalStatus) *string { + v := string(e) + return &v + }).(pulumi.StringPtrOutput) +} + +type TableBucketUnreferencedFileRemovalStatusPtrOutput struct{ *pulumi.OutputState } + +func (TableBucketUnreferencedFileRemovalStatusPtrOutput) ElementType() reflect.Type { + return reflect.TypeOf((**TableBucketUnreferencedFileRemovalStatus)(nil)).Elem() +} + +func (o TableBucketUnreferencedFileRemovalStatusPtrOutput) ToTableBucketUnreferencedFileRemovalStatusPtrOutput() TableBucketUnreferencedFileRemovalStatusPtrOutput { + return o +} + +func (o TableBucketUnreferencedFileRemovalStatusPtrOutput) ToTableBucketUnreferencedFileRemovalStatusPtrOutputWithContext(ctx context.Context) TableBucketUnreferencedFileRemovalStatusPtrOutput { + return o +} + +func (o TableBucketUnreferencedFileRemovalStatusPtrOutput) Elem() TableBucketUnreferencedFileRemovalStatusOutput { + return o.ApplyT(func(v *TableBucketUnreferencedFileRemovalStatus) TableBucketUnreferencedFileRemovalStatus { + if v != nil { + return *v + } + var ret TableBucketUnreferencedFileRemovalStatus + return ret + }).(TableBucketUnreferencedFileRemovalStatusOutput) +} + +func (o TableBucketUnreferencedFileRemovalStatusPtrOutput) ToStringPtrOutput() pulumi.StringPtrOutput { + return o.ToStringPtrOutputWithContext(context.Background()) +} + +func (o TableBucketUnreferencedFileRemovalStatusPtrOutput) ToStringPtrOutputWithContext(ctx context.Context) pulumi.StringPtrOutput { + return o.ApplyTWithContext(ctx, func(_ context.Context, e *TableBucketUnreferencedFileRemovalStatus) *string { + if e == nil { + return nil + } + v := string(*e) + return &v + }).(pulumi.StringPtrOutput) +} + +// TableBucketUnreferencedFileRemovalStatusInput is an input type that accepts values of the TableBucketUnreferencedFileRemovalStatus enum +// A concrete instance of `TableBucketUnreferencedFileRemovalStatusInput` can be one of the following: +// +// TableBucketUnreferencedFileRemovalStatusEnabled +// TableBucketUnreferencedFileRemovalStatusDisabled +type TableBucketUnreferencedFileRemovalStatusInput interface { + pulumi.Input + + ToTableBucketUnreferencedFileRemovalStatusOutput() TableBucketUnreferencedFileRemovalStatusOutput + ToTableBucketUnreferencedFileRemovalStatusOutputWithContext(context.Context) TableBucketUnreferencedFileRemovalStatusOutput +} + +var tableBucketUnreferencedFileRemovalStatusPtrType = reflect.TypeOf((**TableBucketUnreferencedFileRemovalStatus)(nil)).Elem() + +type TableBucketUnreferencedFileRemovalStatusPtrInput interface { + pulumi.Input + + ToTableBucketUnreferencedFileRemovalStatusPtrOutput() TableBucketUnreferencedFileRemovalStatusPtrOutput + ToTableBucketUnreferencedFileRemovalStatusPtrOutputWithContext(context.Context) TableBucketUnreferencedFileRemovalStatusPtrOutput +} + +type tableBucketUnreferencedFileRemovalStatusPtr string + +func TableBucketUnreferencedFileRemovalStatusPtr(v string) TableBucketUnreferencedFileRemovalStatusPtrInput { + return (*tableBucketUnreferencedFileRemovalStatusPtr)(&v) +} + +func (*tableBucketUnreferencedFileRemovalStatusPtr) ElementType() reflect.Type { + return tableBucketUnreferencedFileRemovalStatusPtrType +} + +func (in *tableBucketUnreferencedFileRemovalStatusPtr) ToTableBucketUnreferencedFileRemovalStatusPtrOutput() TableBucketUnreferencedFileRemovalStatusPtrOutput { + return pulumi.ToOutput(in).(TableBucketUnreferencedFileRemovalStatusPtrOutput) +} + +func (in *tableBucketUnreferencedFileRemovalStatusPtr) ToTableBucketUnreferencedFileRemovalStatusPtrOutputWithContext(ctx context.Context) TableBucketUnreferencedFileRemovalStatusPtrOutput { + return pulumi.ToOutputWithContext(ctx, in).(TableBucketUnreferencedFileRemovalStatusPtrOutput) +} + +func init() { + pulumi.RegisterInputType(reflect.TypeOf((*TableBucketUnreferencedFileRemovalStatusInput)(nil)).Elem(), TableBucketUnreferencedFileRemovalStatus("Enabled")) + pulumi.RegisterInputType(reflect.TypeOf((*TableBucketUnreferencedFileRemovalStatusPtrInput)(nil)).Elem(), TableBucketUnreferencedFileRemovalStatus("Enabled")) + pulumi.RegisterOutputType(TableBucketUnreferencedFileRemovalStatusOutput{}) + pulumi.RegisterOutputType(TableBucketUnreferencedFileRemovalStatusPtrOutput{}) +} diff --git a/sdk/go/aws/s3tables/pulumiTypes.go b/sdk/go/aws/s3tables/pulumiTypes.go new file mode 100644 index 0000000000..795ac6286b --- /dev/null +++ b/sdk/go/aws/s3tables/pulumiTypes.go @@ -0,0 +1,272 @@ +// Code generated by pulumi-language-go DO NOT EDIT. +// *** WARNING: Do not edit by hand unless you're certain you know what you are doing! *** + +package s3tables + +import ( + "context" + "reflect" + + "github.com/pulumi/pulumi-aws-native/sdk/go/aws/internal" + "github.com/pulumi/pulumi/sdk/v3/go/pulumi" +) + +var _ = internal.GetEnvOrDefault + +// A policy document containing permissions to add to the specified table bucket. In IAM, you must provide policy documents in JSON format. However, in CloudFormation you can provide the policy in JSON or YAML format because CloudFormation converts YAML to JSON before submitting it to IAM. +type TableBucketPolicyResourcePolicy struct { +} + +// TableBucketPolicyResourcePolicyInput is an input type that accepts TableBucketPolicyResourcePolicyArgs and TableBucketPolicyResourcePolicyOutput values. +// You can construct a concrete instance of `TableBucketPolicyResourcePolicyInput` via: +// +// TableBucketPolicyResourcePolicyArgs{...} +type TableBucketPolicyResourcePolicyInput interface { + pulumi.Input + + ToTableBucketPolicyResourcePolicyOutput() TableBucketPolicyResourcePolicyOutput + ToTableBucketPolicyResourcePolicyOutputWithContext(context.Context) TableBucketPolicyResourcePolicyOutput +} + +// A policy document containing permissions to add to the specified table bucket. In IAM, you must provide policy documents in JSON format. However, in CloudFormation you can provide the policy in JSON or YAML format because CloudFormation converts YAML to JSON before submitting it to IAM. +type TableBucketPolicyResourcePolicyArgs struct { +} + +func (TableBucketPolicyResourcePolicyArgs) ElementType() reflect.Type { + return reflect.TypeOf((*TableBucketPolicyResourcePolicy)(nil)).Elem() +} + +func (i TableBucketPolicyResourcePolicyArgs) ToTableBucketPolicyResourcePolicyOutput() TableBucketPolicyResourcePolicyOutput { + return i.ToTableBucketPolicyResourcePolicyOutputWithContext(context.Background()) +} + +func (i TableBucketPolicyResourcePolicyArgs) ToTableBucketPolicyResourcePolicyOutputWithContext(ctx context.Context) TableBucketPolicyResourcePolicyOutput { + return pulumi.ToOutputWithContext(ctx, i).(TableBucketPolicyResourcePolicyOutput) +} + +// A policy document containing permissions to add to the specified table bucket. In IAM, you must provide policy documents in JSON format. However, in CloudFormation you can provide the policy in JSON or YAML format because CloudFormation converts YAML to JSON before submitting it to IAM. +type TableBucketPolicyResourcePolicyOutput struct{ *pulumi.OutputState } + +func (TableBucketPolicyResourcePolicyOutput) ElementType() reflect.Type { + return reflect.TypeOf((*TableBucketPolicyResourcePolicy)(nil)).Elem() +} + +func (o TableBucketPolicyResourcePolicyOutput) ToTableBucketPolicyResourcePolicyOutput() TableBucketPolicyResourcePolicyOutput { + return o +} + +func (o TableBucketPolicyResourcePolicyOutput) ToTableBucketPolicyResourcePolicyOutputWithContext(ctx context.Context) TableBucketPolicyResourcePolicyOutput { + return o +} + +type TableBucketPolicyResourcePolicyPtrOutput struct{ *pulumi.OutputState } + +func (TableBucketPolicyResourcePolicyPtrOutput) ElementType() reflect.Type { + return reflect.TypeOf((**TableBucketPolicyResourcePolicy)(nil)).Elem() +} + +func (o TableBucketPolicyResourcePolicyPtrOutput) ToTableBucketPolicyResourcePolicyPtrOutput() TableBucketPolicyResourcePolicyPtrOutput { + return o +} + +func (o TableBucketPolicyResourcePolicyPtrOutput) ToTableBucketPolicyResourcePolicyPtrOutputWithContext(ctx context.Context) TableBucketPolicyResourcePolicyPtrOutput { + return o +} + +func (o TableBucketPolicyResourcePolicyPtrOutput) Elem() TableBucketPolicyResourcePolicyOutput { + return o.ApplyT(func(v *TableBucketPolicyResourcePolicy) TableBucketPolicyResourcePolicy { + if v != nil { + return *v + } + var ret TableBucketPolicyResourcePolicy + return ret + }).(TableBucketPolicyResourcePolicyOutput) +} + +// Settings governing the Unreferenced File Removal maintenance action. Unreferenced file removal identifies and deletes all objects that are not referenced by any table snapshots. +type TableBucketUnreferencedFileRemoval struct { + // S3 permanently deletes noncurrent objects after the number of days specified by the NoncurrentDays property. + NoncurrentDays *int `pulumi:"noncurrentDays"` + // Indicates whether the Unreferenced File Removal maintenance action is enabled. + Status *TableBucketUnreferencedFileRemovalStatus `pulumi:"status"` + // For any object not referenced by your table and older than the UnreferencedDays property, S3 creates a delete marker and marks the object version as noncurrent. + UnreferencedDays *int `pulumi:"unreferencedDays"` +} + +// TableBucketUnreferencedFileRemovalInput is an input type that accepts TableBucketUnreferencedFileRemovalArgs and TableBucketUnreferencedFileRemovalOutput values. +// You can construct a concrete instance of `TableBucketUnreferencedFileRemovalInput` via: +// +// TableBucketUnreferencedFileRemovalArgs{...} +type TableBucketUnreferencedFileRemovalInput interface { + pulumi.Input + + ToTableBucketUnreferencedFileRemovalOutput() TableBucketUnreferencedFileRemovalOutput + ToTableBucketUnreferencedFileRemovalOutputWithContext(context.Context) TableBucketUnreferencedFileRemovalOutput +} + +// Settings governing the Unreferenced File Removal maintenance action. Unreferenced file removal identifies and deletes all objects that are not referenced by any table snapshots. +type TableBucketUnreferencedFileRemovalArgs struct { + // S3 permanently deletes noncurrent objects after the number of days specified by the NoncurrentDays property. + NoncurrentDays pulumi.IntPtrInput `pulumi:"noncurrentDays"` + // Indicates whether the Unreferenced File Removal maintenance action is enabled. + Status TableBucketUnreferencedFileRemovalStatusPtrInput `pulumi:"status"` + // For any object not referenced by your table and older than the UnreferencedDays property, S3 creates a delete marker and marks the object version as noncurrent. + UnreferencedDays pulumi.IntPtrInput `pulumi:"unreferencedDays"` +} + +func (TableBucketUnreferencedFileRemovalArgs) ElementType() reflect.Type { + return reflect.TypeOf((*TableBucketUnreferencedFileRemoval)(nil)).Elem() +} + +func (i TableBucketUnreferencedFileRemovalArgs) ToTableBucketUnreferencedFileRemovalOutput() TableBucketUnreferencedFileRemovalOutput { + return i.ToTableBucketUnreferencedFileRemovalOutputWithContext(context.Background()) +} + +func (i TableBucketUnreferencedFileRemovalArgs) ToTableBucketUnreferencedFileRemovalOutputWithContext(ctx context.Context) TableBucketUnreferencedFileRemovalOutput { + return pulumi.ToOutputWithContext(ctx, i).(TableBucketUnreferencedFileRemovalOutput) +} + +func (i TableBucketUnreferencedFileRemovalArgs) ToTableBucketUnreferencedFileRemovalPtrOutput() TableBucketUnreferencedFileRemovalPtrOutput { + return i.ToTableBucketUnreferencedFileRemovalPtrOutputWithContext(context.Background()) +} + +func (i TableBucketUnreferencedFileRemovalArgs) ToTableBucketUnreferencedFileRemovalPtrOutputWithContext(ctx context.Context) TableBucketUnreferencedFileRemovalPtrOutput { + return pulumi.ToOutputWithContext(ctx, i).(TableBucketUnreferencedFileRemovalOutput).ToTableBucketUnreferencedFileRemovalPtrOutputWithContext(ctx) +} + +// TableBucketUnreferencedFileRemovalPtrInput is an input type that accepts TableBucketUnreferencedFileRemovalArgs, TableBucketUnreferencedFileRemovalPtr and TableBucketUnreferencedFileRemovalPtrOutput values. +// You can construct a concrete instance of `TableBucketUnreferencedFileRemovalPtrInput` via: +// +// TableBucketUnreferencedFileRemovalArgs{...} +// +// or: +// +// nil +type TableBucketUnreferencedFileRemovalPtrInput interface { + pulumi.Input + + ToTableBucketUnreferencedFileRemovalPtrOutput() TableBucketUnreferencedFileRemovalPtrOutput + ToTableBucketUnreferencedFileRemovalPtrOutputWithContext(context.Context) TableBucketUnreferencedFileRemovalPtrOutput +} + +type tableBucketUnreferencedFileRemovalPtrType TableBucketUnreferencedFileRemovalArgs + +func TableBucketUnreferencedFileRemovalPtr(v *TableBucketUnreferencedFileRemovalArgs) TableBucketUnreferencedFileRemovalPtrInput { + return (*tableBucketUnreferencedFileRemovalPtrType)(v) +} + +func (*tableBucketUnreferencedFileRemovalPtrType) ElementType() reflect.Type { + return reflect.TypeOf((**TableBucketUnreferencedFileRemoval)(nil)).Elem() +} + +func (i *tableBucketUnreferencedFileRemovalPtrType) ToTableBucketUnreferencedFileRemovalPtrOutput() TableBucketUnreferencedFileRemovalPtrOutput { + return i.ToTableBucketUnreferencedFileRemovalPtrOutputWithContext(context.Background()) +} + +func (i *tableBucketUnreferencedFileRemovalPtrType) ToTableBucketUnreferencedFileRemovalPtrOutputWithContext(ctx context.Context) TableBucketUnreferencedFileRemovalPtrOutput { + return pulumi.ToOutputWithContext(ctx, i).(TableBucketUnreferencedFileRemovalPtrOutput) +} + +// Settings governing the Unreferenced File Removal maintenance action. Unreferenced file removal identifies and deletes all objects that are not referenced by any table snapshots. +type TableBucketUnreferencedFileRemovalOutput struct{ *pulumi.OutputState } + +func (TableBucketUnreferencedFileRemovalOutput) ElementType() reflect.Type { + return reflect.TypeOf((*TableBucketUnreferencedFileRemoval)(nil)).Elem() +} + +func (o TableBucketUnreferencedFileRemovalOutput) ToTableBucketUnreferencedFileRemovalOutput() TableBucketUnreferencedFileRemovalOutput { + return o +} + +func (o TableBucketUnreferencedFileRemovalOutput) ToTableBucketUnreferencedFileRemovalOutputWithContext(ctx context.Context) TableBucketUnreferencedFileRemovalOutput { + return o +} + +func (o TableBucketUnreferencedFileRemovalOutput) ToTableBucketUnreferencedFileRemovalPtrOutput() TableBucketUnreferencedFileRemovalPtrOutput { + return o.ToTableBucketUnreferencedFileRemovalPtrOutputWithContext(context.Background()) +} + +func (o TableBucketUnreferencedFileRemovalOutput) ToTableBucketUnreferencedFileRemovalPtrOutputWithContext(ctx context.Context) TableBucketUnreferencedFileRemovalPtrOutput { + return o.ApplyTWithContext(ctx, func(_ context.Context, v TableBucketUnreferencedFileRemoval) *TableBucketUnreferencedFileRemoval { + return &v + }).(TableBucketUnreferencedFileRemovalPtrOutput) +} + +// S3 permanently deletes noncurrent objects after the number of days specified by the NoncurrentDays property. +func (o TableBucketUnreferencedFileRemovalOutput) NoncurrentDays() pulumi.IntPtrOutput { + return o.ApplyT(func(v TableBucketUnreferencedFileRemoval) *int { return v.NoncurrentDays }).(pulumi.IntPtrOutput) +} + +// Indicates whether the Unreferenced File Removal maintenance action is enabled. +func (o TableBucketUnreferencedFileRemovalOutput) Status() TableBucketUnreferencedFileRemovalStatusPtrOutput { + return o.ApplyT(func(v TableBucketUnreferencedFileRemoval) *TableBucketUnreferencedFileRemovalStatus { return v.Status }).(TableBucketUnreferencedFileRemovalStatusPtrOutput) +} + +// For any object not referenced by your table and older than the UnreferencedDays property, S3 creates a delete marker and marks the object version as noncurrent. +func (o TableBucketUnreferencedFileRemovalOutput) UnreferencedDays() pulumi.IntPtrOutput { + return o.ApplyT(func(v TableBucketUnreferencedFileRemoval) *int { return v.UnreferencedDays }).(pulumi.IntPtrOutput) +} + +type TableBucketUnreferencedFileRemovalPtrOutput struct{ *pulumi.OutputState } + +func (TableBucketUnreferencedFileRemovalPtrOutput) ElementType() reflect.Type { + return reflect.TypeOf((**TableBucketUnreferencedFileRemoval)(nil)).Elem() +} + +func (o TableBucketUnreferencedFileRemovalPtrOutput) ToTableBucketUnreferencedFileRemovalPtrOutput() TableBucketUnreferencedFileRemovalPtrOutput { + return o +} + +func (o TableBucketUnreferencedFileRemovalPtrOutput) ToTableBucketUnreferencedFileRemovalPtrOutputWithContext(ctx context.Context) TableBucketUnreferencedFileRemovalPtrOutput { + return o +} + +func (o TableBucketUnreferencedFileRemovalPtrOutput) Elem() TableBucketUnreferencedFileRemovalOutput { + return o.ApplyT(func(v *TableBucketUnreferencedFileRemoval) TableBucketUnreferencedFileRemoval { + if v != nil { + return *v + } + var ret TableBucketUnreferencedFileRemoval + return ret + }).(TableBucketUnreferencedFileRemovalOutput) +} + +// S3 permanently deletes noncurrent objects after the number of days specified by the NoncurrentDays property. +func (o TableBucketUnreferencedFileRemovalPtrOutput) NoncurrentDays() pulumi.IntPtrOutput { + return o.ApplyT(func(v *TableBucketUnreferencedFileRemoval) *int { + if v == nil { + return nil + } + return v.NoncurrentDays + }).(pulumi.IntPtrOutput) +} + +// Indicates whether the Unreferenced File Removal maintenance action is enabled. +func (o TableBucketUnreferencedFileRemovalPtrOutput) Status() TableBucketUnreferencedFileRemovalStatusPtrOutput { + return o.ApplyT(func(v *TableBucketUnreferencedFileRemoval) *TableBucketUnreferencedFileRemovalStatus { + if v == nil { + return nil + } + return v.Status + }).(TableBucketUnreferencedFileRemovalStatusPtrOutput) +} + +// For any object not referenced by your table and older than the UnreferencedDays property, S3 creates a delete marker and marks the object version as noncurrent. +func (o TableBucketUnreferencedFileRemovalPtrOutput) UnreferencedDays() pulumi.IntPtrOutput { + return o.ApplyT(func(v *TableBucketUnreferencedFileRemoval) *int { + if v == nil { + return nil + } + return v.UnreferencedDays + }).(pulumi.IntPtrOutput) +} + +func init() { + pulumi.RegisterInputType(reflect.TypeOf((*TableBucketPolicyResourcePolicyInput)(nil)).Elem(), TableBucketPolicyResourcePolicyArgs{}) + pulumi.RegisterInputType(reflect.TypeOf((*TableBucketUnreferencedFileRemovalInput)(nil)).Elem(), TableBucketUnreferencedFileRemovalArgs{}) + pulumi.RegisterInputType(reflect.TypeOf((*TableBucketUnreferencedFileRemovalPtrInput)(nil)).Elem(), TableBucketUnreferencedFileRemovalArgs{}) + pulumi.RegisterOutputType(TableBucketPolicyResourcePolicyOutput{}) + pulumi.RegisterOutputType(TableBucketPolicyResourcePolicyPtrOutput{}) + pulumi.RegisterOutputType(TableBucketUnreferencedFileRemovalOutput{}) + pulumi.RegisterOutputType(TableBucketUnreferencedFileRemovalPtrOutput{}) +} diff --git a/sdk/go/aws/s3tables/tableBucket.go b/sdk/go/aws/s3tables/tableBucket.go new file mode 100644 index 0000000000..dc673a5403 --- /dev/null +++ b/sdk/go/aws/s3tables/tableBucket.go @@ -0,0 +1,129 @@ +// Code generated by pulumi-language-go DO NOT EDIT. +// *** WARNING: Do not edit by hand unless you're certain you know what you are doing! *** + +package s3tables + +import ( + "context" + "reflect" + + "github.com/pulumi/pulumi-aws-native/sdk/go/aws/internal" + "github.com/pulumi/pulumi/sdk/v3/go/pulumi" +) + +// Creates an Amazon S3 Tables table bucket in the same AWS Region where you create the AWS CloudFormation stack. +type TableBucket struct { + pulumi.CustomResourceState + + TableBucketArn pulumi.StringOutput `pulumi:"tableBucketArn"` + TableBucketName pulumi.StringOutput `pulumi:"tableBucketName"` + UnreferencedFileRemoval TableBucketUnreferencedFileRemovalPtrOutput `pulumi:"unreferencedFileRemoval"` +} + +// NewTableBucket registers a new resource with the given unique name, arguments, and options. +func NewTableBucket(ctx *pulumi.Context, + name string, args *TableBucketArgs, opts ...pulumi.ResourceOption) (*TableBucket, error) { + if args == nil { + args = &TableBucketArgs{} + } + + replaceOnChanges := pulumi.ReplaceOnChanges([]string{ + "tableBucketName", + }) + opts = append(opts, replaceOnChanges) + opts = internal.PkgResourceDefaultOpts(opts) + var resource TableBucket + err := ctx.RegisterResource("aws-native:s3tables:TableBucket", name, args, &resource, opts...) + if err != nil { + return nil, err + } + return &resource, nil +} + +// GetTableBucket gets an existing TableBucket resource's state with the given name, ID, and optional +// state properties that are used to uniquely qualify the lookup (nil if not required). +func GetTableBucket(ctx *pulumi.Context, + name string, id pulumi.IDInput, state *TableBucketState, opts ...pulumi.ResourceOption) (*TableBucket, error) { + var resource TableBucket + err := ctx.ReadResource("aws-native:s3tables:TableBucket", name, id, state, &resource, opts...) + if err != nil { + return nil, err + } + return &resource, nil +} + +// Input properties used for looking up and filtering TableBucket resources. +type tableBucketState struct { +} + +type TableBucketState struct { +} + +func (TableBucketState) ElementType() reflect.Type { + return reflect.TypeOf((*tableBucketState)(nil)).Elem() +} + +type tableBucketArgs struct { + TableBucketName *string `pulumi:"tableBucketName"` + UnreferencedFileRemoval *TableBucketUnreferencedFileRemoval `pulumi:"unreferencedFileRemoval"` +} + +// The set of arguments for constructing a TableBucket resource. +type TableBucketArgs struct { + TableBucketName pulumi.StringPtrInput + UnreferencedFileRemoval TableBucketUnreferencedFileRemovalPtrInput +} + +func (TableBucketArgs) ElementType() reflect.Type { + return reflect.TypeOf((*tableBucketArgs)(nil)).Elem() +} + +type TableBucketInput interface { + pulumi.Input + + ToTableBucketOutput() TableBucketOutput + ToTableBucketOutputWithContext(ctx context.Context) TableBucketOutput +} + +func (*TableBucket) ElementType() reflect.Type { + return reflect.TypeOf((**TableBucket)(nil)).Elem() +} + +func (i *TableBucket) ToTableBucketOutput() TableBucketOutput { + return i.ToTableBucketOutputWithContext(context.Background()) +} + +func (i *TableBucket) ToTableBucketOutputWithContext(ctx context.Context) TableBucketOutput { + return pulumi.ToOutputWithContext(ctx, i).(TableBucketOutput) +} + +type TableBucketOutput struct{ *pulumi.OutputState } + +func (TableBucketOutput) ElementType() reflect.Type { + return reflect.TypeOf((**TableBucket)(nil)).Elem() +} + +func (o TableBucketOutput) ToTableBucketOutput() TableBucketOutput { + return o +} + +func (o TableBucketOutput) ToTableBucketOutputWithContext(ctx context.Context) TableBucketOutput { + return o +} + +func (o TableBucketOutput) TableBucketArn() pulumi.StringOutput { + return o.ApplyT(func(v *TableBucket) pulumi.StringOutput { return v.TableBucketArn }).(pulumi.StringOutput) +} + +func (o TableBucketOutput) TableBucketName() pulumi.StringOutput { + return o.ApplyT(func(v *TableBucket) pulumi.StringOutput { return v.TableBucketName }).(pulumi.StringOutput) +} + +func (o TableBucketOutput) UnreferencedFileRemoval() TableBucketUnreferencedFileRemovalPtrOutput { + return o.ApplyT(func(v *TableBucket) TableBucketUnreferencedFileRemovalPtrOutput { return v.UnreferencedFileRemoval }).(TableBucketUnreferencedFileRemovalPtrOutput) +} + +func init() { + pulumi.RegisterInputType(reflect.TypeOf((*TableBucketInput)(nil)).Elem(), &TableBucket{}) + pulumi.RegisterOutputType(TableBucketOutput{}) +} diff --git a/sdk/go/aws/s3tables/tableBucketPolicy.go b/sdk/go/aws/s3tables/tableBucketPolicy.go new file mode 100644 index 0000000000..6f4b7b20d0 --- /dev/null +++ b/sdk/go/aws/s3tables/tableBucketPolicy.go @@ -0,0 +1,131 @@ +// Code generated by pulumi-language-go DO NOT EDIT. +// *** WARNING: Do not edit by hand unless you're certain you know what you are doing! *** + +package s3tables + +import ( + "context" + "reflect" + + "errors" + "github.com/pulumi/pulumi-aws-native/sdk/go/aws/internal" + "github.com/pulumi/pulumi/sdk/v3/go/pulumi" +) + +// Applies an IAM resource policy to a table bucket. +type TableBucketPolicy struct { + pulumi.CustomResourceState + + ResourcePolicy TableBucketPolicyResourcePolicyOutput `pulumi:"resourcePolicy"` + TableBucketArn pulumi.StringOutput `pulumi:"tableBucketArn"` +} + +// NewTableBucketPolicy registers a new resource with the given unique name, arguments, and options. +func NewTableBucketPolicy(ctx *pulumi.Context, + name string, args *TableBucketPolicyArgs, opts ...pulumi.ResourceOption) (*TableBucketPolicy, error) { + if args == nil { + return nil, errors.New("missing one or more required arguments") + } + + if args.ResourcePolicy == nil { + return nil, errors.New("invalid value for required argument 'ResourcePolicy'") + } + if args.TableBucketArn == nil { + return nil, errors.New("invalid value for required argument 'TableBucketArn'") + } + replaceOnChanges := pulumi.ReplaceOnChanges([]string{ + "tableBucketArn", + }) + opts = append(opts, replaceOnChanges) + opts = internal.PkgResourceDefaultOpts(opts) + var resource TableBucketPolicy + err := ctx.RegisterResource("aws-native:s3tables:TableBucketPolicy", name, args, &resource, opts...) + if err != nil { + return nil, err + } + return &resource, nil +} + +// GetTableBucketPolicy gets an existing TableBucketPolicy resource's state with the given name, ID, and optional +// state properties that are used to uniquely qualify the lookup (nil if not required). +func GetTableBucketPolicy(ctx *pulumi.Context, + name string, id pulumi.IDInput, state *TableBucketPolicyState, opts ...pulumi.ResourceOption) (*TableBucketPolicy, error) { + var resource TableBucketPolicy + err := ctx.ReadResource("aws-native:s3tables:TableBucketPolicy", name, id, state, &resource, opts...) + if err != nil { + return nil, err + } + return &resource, nil +} + +// Input properties used for looking up and filtering TableBucketPolicy resources. +type tableBucketPolicyState struct { +} + +type TableBucketPolicyState struct { +} + +func (TableBucketPolicyState) ElementType() reflect.Type { + return reflect.TypeOf((*tableBucketPolicyState)(nil)).Elem() +} + +type tableBucketPolicyArgs struct { + ResourcePolicy TableBucketPolicyResourcePolicy `pulumi:"resourcePolicy"` + TableBucketArn string `pulumi:"tableBucketArn"` +} + +// The set of arguments for constructing a TableBucketPolicy resource. +type TableBucketPolicyArgs struct { + ResourcePolicy TableBucketPolicyResourcePolicyInput + TableBucketArn pulumi.StringInput +} + +func (TableBucketPolicyArgs) ElementType() reflect.Type { + return reflect.TypeOf((*tableBucketPolicyArgs)(nil)).Elem() +} + +type TableBucketPolicyInput interface { + pulumi.Input + + ToTableBucketPolicyOutput() TableBucketPolicyOutput + ToTableBucketPolicyOutputWithContext(ctx context.Context) TableBucketPolicyOutput +} + +func (*TableBucketPolicy) ElementType() reflect.Type { + return reflect.TypeOf((**TableBucketPolicy)(nil)).Elem() +} + +func (i *TableBucketPolicy) ToTableBucketPolicyOutput() TableBucketPolicyOutput { + return i.ToTableBucketPolicyOutputWithContext(context.Background()) +} + +func (i *TableBucketPolicy) ToTableBucketPolicyOutputWithContext(ctx context.Context) TableBucketPolicyOutput { + return pulumi.ToOutputWithContext(ctx, i).(TableBucketPolicyOutput) +} + +type TableBucketPolicyOutput struct{ *pulumi.OutputState } + +func (TableBucketPolicyOutput) ElementType() reflect.Type { + return reflect.TypeOf((**TableBucketPolicy)(nil)).Elem() +} + +func (o TableBucketPolicyOutput) ToTableBucketPolicyOutput() TableBucketPolicyOutput { + return o +} + +func (o TableBucketPolicyOutput) ToTableBucketPolicyOutputWithContext(ctx context.Context) TableBucketPolicyOutput { + return o +} + +func (o TableBucketPolicyOutput) ResourcePolicy() TableBucketPolicyResourcePolicyOutput { + return o.ApplyT(func(v *TableBucketPolicy) TableBucketPolicyResourcePolicyOutput { return v.ResourcePolicy }).(TableBucketPolicyResourcePolicyOutput) +} + +func (o TableBucketPolicyOutput) TableBucketArn() pulumi.StringOutput { + return o.ApplyT(func(v *TableBucketPolicy) pulumi.StringOutput { return v.TableBucketArn }).(pulumi.StringOutput) +} + +func init() { + pulumi.RegisterInputType(reflect.TypeOf((*TableBucketPolicyInput)(nil)).Elem(), &TableBucketPolicy{}) + pulumi.RegisterOutputType(TableBucketPolicyOutput{}) +} diff --git a/sdk/nodejs/apigateway/domainNameV2.ts b/sdk/nodejs/apigateway/domainNameV2.ts index e2d78aee0a..10e6eba6f3 100644 --- a/sdk/nodejs/apigateway/domainNameV2.ts +++ b/sdk/nodejs/apigateway/domainNameV2.ts @@ -57,10 +57,6 @@ export class DomainNameV2 extends pulumi.CustomResource { * The endpoint configuration to indicate the types of endpoints an API (RestApi) or its custom domain name (DomainName) has. */ public readonly endpointConfiguration!: pulumi.Output; - /** - * Search the [CloudFormation User Guide](https://docs.aws.amazon.com/cloudformation/) for `AWS::ApiGateway::DomainNameV2` for more information about the expected schema for this property. - */ - public readonly managementPolicy!: pulumi.Output; /** * A stringified JSON policy document that applies to the `execute-api` service for this DomainName regardless of the caller and Method configuration. You can use `Fn::ToJsonString` to enter your `policy` . For more information, see [Fn::ToJsonString](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/intrinsic-function-reference-ToJsonString.html) . * @@ -90,7 +86,6 @@ export class DomainNameV2 extends pulumi.CustomResource { resourceInputs["certificateArn"] = args ? args.certificateArn : undefined; resourceInputs["domainName"] = args ? args.domainName : undefined; resourceInputs["endpointConfiguration"] = args ? args.endpointConfiguration : undefined; - resourceInputs["managementPolicy"] = args ? args.managementPolicy : undefined; resourceInputs["policy"] = args ? args.policy : undefined; resourceInputs["securityPolicy"] = args ? args.securityPolicy : undefined; resourceInputs["tags"] = args ? args.tags : undefined; @@ -102,7 +97,6 @@ export class DomainNameV2 extends pulumi.CustomResource { resourceInputs["domainNameArn"] = undefined /*out*/; resourceInputs["domainNameId"] = undefined /*out*/; resourceInputs["endpointConfiguration"] = undefined /*out*/; - resourceInputs["managementPolicy"] = undefined /*out*/; resourceInputs["policy"] = undefined /*out*/; resourceInputs["securityPolicy"] = undefined /*out*/; resourceInputs["tags"] = undefined /*out*/; @@ -130,10 +124,6 @@ export interface DomainNameV2Args { * The endpoint configuration to indicate the types of endpoints an API (RestApi) or its custom domain name (DomainName) has. */ endpointConfiguration?: pulumi.Input; - /** - * Search the [CloudFormation User Guide](https://docs.aws.amazon.com/cloudformation/) for `AWS::ApiGateway::DomainNameV2` for more information about the expected schema for this property. - */ - managementPolicy?: any; /** * A stringified JSON policy document that applies to the `execute-api` service for this DomainName regardless of the caller and Method configuration. You can use `Fn::ToJsonString` to enter your `policy` . For more information, see [Fn::ToJsonString](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/intrinsic-function-reference-ToJsonString.html) . * diff --git a/sdk/nodejs/apigateway/getDomainNameV2.ts b/sdk/nodejs/apigateway/getDomainNameV2.ts index 881150f9bf..542ce1d70c 100644 --- a/sdk/nodejs/apigateway/getDomainNameV2.ts +++ b/sdk/nodejs/apigateway/getDomainNameV2.ts @@ -37,10 +37,6 @@ export interface GetDomainNameV2Result { * The domain name ID. */ readonly domainNameId?: string; - /** - * Search the [CloudFormation User Guide](https://docs.aws.amazon.com/cloudformation/) for `AWS::ApiGateway::DomainNameV2` for more information about the expected schema for this property. - */ - readonly managementPolicy?: any; /** * A stringified JSON policy document that applies to the `execute-api` service for this DomainName regardless of the caller and Method configuration. You can use `Fn::ToJsonString` to enter your `policy` . For more information, see [Fn::ToJsonString](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/intrinsic-function-reference-ToJsonString.html) . * diff --git a/sdk/nodejs/cognito/getManagedLoginBranding.ts b/sdk/nodejs/cognito/getManagedLoginBranding.ts index 1499edc57c..f9abb61c12 100644 --- a/sdk/nodejs/cognito/getManagedLoginBranding.ts +++ b/sdk/nodejs/cognito/getManagedLoginBranding.ts @@ -45,7 +45,9 @@ export interface GetManagedLoginBrandingResult { */ readonly settings?: any; /** - * When true, applies the default branding style options. This option reverts to a "blank" style that you can modify later in the branding designer. + * When true, applies the default branding style options. This option reverts to default style options that are managed by Amazon Cognito. You can modify them later in the branding designer. + * + * When you specify `true` for this option, you must also omit values for `Settings` and `Assets` in the request. */ readonly useCognitoProvidedValues?: boolean; } diff --git a/sdk/nodejs/cognito/getUserPool.ts b/sdk/nodejs/cognito/getUserPool.ts index 364b2ac6c3..fcf25fab1e 100644 --- a/sdk/nodejs/cognito/getUserPool.ts +++ b/sdk/nodejs/cognito/getUserPool.ts @@ -36,7 +36,7 @@ export interface GetUserPoolResult { */ readonly adminCreateUserConfig?: outputs.cognito.UserPoolAdminCreateUserConfig; /** - * Attributes supported as an alias for this user pool. Possible values: *phone_number* , *email* , or *preferred_username* . + * Attributes supported as an alias for this user pool. Possible values: *phone_number* , *email* , or *preferred_username* . For more information about alias attributes, see [Customizing sign-in attributes](https://docs.aws.amazon.com/cognito/latest/developerguide/user-pool-settings-attributes.html#user-pool-settings-aliases) . */ readonly aliasAttributes?: string[]; /** @@ -44,7 +44,7 @@ export interface GetUserPoolResult { */ readonly arn?: string; /** - * The attributes to be auto-verified. Possible values: *email* , *phone_number* . + * The attributes that you want your user pool to automatically verify. Possible values: *email* , *phone_number* . For more information see [Verifying contact information at sign-up](https://docs.aws.amazon.com/cognito/latest/developerguide/signing-up-users-in-your-app.html#allowing-users-to-sign-up-and-confirm-themselves) . */ readonly autoVerifiedAttributes?: string[]; /** @@ -56,9 +56,9 @@ export interface GetUserPoolResult { */ readonly deletionProtection?: string; /** - * The device-remembering configuration for a user pool. A null value indicates that you have deactivated device remembering in your user pool. + * The device-remembering configuration for a user pool. Device remembering or device tracking is a "Remember me on this device" option for user pools that perform authentication with the device key of a trusted device in the back end, instead of a user-provided MFA code. For more information about device authentication, see [Working with user devices in your user pool](https://docs.aws.amazon.com/cognito/latest/developerguide/amazon-cognito-user-pools-device-tracking.html) . A null value indicates that you have deactivated device remembering in your user pool. * - * > When you provide a value for any `DeviceConfiguration` field, you activate the Amazon Cognito device-remembering feature. + * > When you provide a value for any `DeviceConfiguration` field, you activate the Amazon Cognito device-remembering feature. For more infor */ readonly deviceConfiguration?: outputs.cognito.UserPoolDeviceConfiguration; readonly emailAuthenticationMessage?: string; @@ -102,7 +102,7 @@ export interface GetUserPoolResult { */ readonly providerUrl?: string; /** - * An array of schema attributes for the new user pool. These attributes can be standard or custom attributes. + * An array of attributes for the new user pool. You can add custom attributes and modify the properties of default attributes. The specifications in this parameter set the required attributes in your user pool. For more information, see [Working with user attributes](https://docs.aws.amazon.com/cognito/latest/developerguide/user-pool-settings-attributes.html) . */ readonly schema?: outputs.cognito.UserPoolSchemaAttribute[]; /** @@ -110,7 +110,7 @@ export interface GetUserPoolResult { */ readonly smsAuthenticationMessage?: string; /** - * The SMS configuration with the settings that your Amazon Cognito user pool must use to send an SMS message from your AWS account through Amazon Simple Notification Service. To send SMS messages with Amazon SNS in the AWS Region that you want, the Amazon Cognito user pool uses an AWS Identity and Access Management (IAM) role in your AWS account . + * The SMS configuration with the settings that your Amazon Cognito user pool must use to send an SMS message from your AWS account through Amazon Simple Notification Service. To send SMS messages with Amazon SNS in the AWS Region that you want, the Amazon Cognito user pool uses an AWS Identity and Access Management (IAM) role in your AWS account . For more information see [SMS message settings](https://docs.aws.amazon.com/cognito/latest/developerguide/user-pool-sms-settings.html) . */ readonly smsConfiguration?: outputs.cognito.UserPoolSmsConfiguration; /** @@ -134,7 +134,7 @@ export interface GetUserPoolResult { */ readonly userPoolId?: string; /** - * A string used to name the user pool. + * A friendlhy name for your user pool. */ readonly userPoolName?: string; /** @@ -150,9 +150,11 @@ export interface GetUserPoolResult { */ readonly usernameAttributes?: string[]; /** - * Case sensitivity on the username input for the selected sign-in option. When case sensitivity is set to `False` (case insensitive), users can sign in with any combination of capital and lowercase letters. For example, `username` , `USERNAME` , or `UserName` , or for email, `email@example.com` or `EMaiL@eXamplE.Com` . For most use cases, set case sensitivity to `False` (case insensitive) as a best practice. When usernames and email addresses are case insensitive, Amazon Cognito treats any variation in case as the same user, and prevents a case variation from being assigned to the same attribute for a different user. + * Sets the case sensitivity option for sign-in usernames. When `CaseSensitive` is `false` (case insensitive), users can sign in with any combination of capital and lowercase letters. For example, `username` , `USERNAME` , or `UserName` , or for email, `email@example.com` or `EMaiL@eXamplE.Com` . For most use cases, set case sensitivity to `false` as a best practice. When usernames and email addresses are case insensitive, Amazon Cognito treats any variation in case as the same user, and prevents a case variation from being assigned to the same attribute for a different user. * - * This configuration is immutable after you set it. For more information, see [UsernameConfigurationType](https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_UsernameConfigurationType.html) . + * When `CaseSensitive` is `true` (case sensitive), Amazon Cognito interprets `USERNAME` and `UserName` as distinct users. + * + * This configuration is immutable after you set it. */ readonly usernameConfiguration?: outputs.cognito.UserPoolUsernameConfiguration; /** @@ -161,7 +163,19 @@ export interface GetUserPoolResult { * Set the email message type that corresponds to your `DefaultEmailOption` selection. For `CONFIRM_WITH_LINK` , specify an `EmailMessageByLink` and leave `EmailMessage` blank. For `CONFIRM_WITH_CODE` , specify an `EmailMessage` and leave `EmailMessageByLink` blank. When you supply both parameters with either choice, Amazon Cognito returns an error. */ readonly verificationMessageTemplate?: outputs.cognito.UserPoolVerificationMessageTemplate; + /** + * Sets or displays the authentication domain, typically your user pool domain, that passkey providers must use as a relying party (RP) in their configuration. + * + * Under the following conditions, the passkey relying party ID must be the fully-qualified domain name of your custom domain: + * + * - The user pool is configured for passkey authentication. + * - The user pool has a custom domain, whether or not it also has a prefix domain. + * - Your application performs authentication with managed login or the classic hosted UI. + */ readonly webAuthnRelyingPartyId?: string; + /** + * When `required` , users can only register and sign in users with passkeys that are capable of [user verification](https://docs.aws.amazon.com/https://www.w3.org/TR/webauthn-2/#enum-userVerificationRequirement) . When `preferred` , your user pool doesn't require the use of authenticators with user verification but encourages it. + */ readonly webAuthnUserVerification?: string; } /** diff --git a/sdk/nodejs/cognito/getUserPoolClient.ts b/sdk/nodejs/cognito/getUserPoolClient.ts index 9d23ef022f..860106b214 100644 --- a/sdk/nodejs/cognito/getUserPoolClient.ts +++ b/sdk/nodejs/cognito/getUserPoolClient.ts @@ -24,7 +24,7 @@ export interface GetUserPoolClientArgs { */ clientId: string; /** - * The user pool ID for the user pool where you want to create a user pool client. + * The ID of the user pool where you want to create an app client. */ userPoolId: string; } @@ -64,13 +64,13 @@ export interface GetUserPoolClientResult { */ readonly allowedOAuthFlowsUserPoolClient?: boolean; /** - * The allowed OAuth scopes. Possible values provided by OAuth are `phone` , `email` , `openid` , and `profile` . Possible values provided by AWS are `aws.cognito.signin.user.admin` . Custom scopes created in Resource Servers are also supported. + * The OAuth 2.0 scopes that you want to permit your app client to authorize. Scopes govern access control to user pool self-service API operations, user data from the `userInfo` endpoint, and third-party APIs. Possible values provided by OAuth are `phone` , `email` , `openid` , and `profile` . Possible values provided by AWS are `aws.cognito.signin.user.admin` . Custom scopes created in Resource Servers are also supported. */ readonly allowedOAuthScopes?: string[]; /** * The user pool analytics configuration for collecting metrics and sending them to your Amazon Pinpoint campaign. * - * > In AWS Regions where Amazon Pinpoint isn't available, user pools only support sending events to Amazon Pinpoint projects in AWS Region us-east-1. In Regions where Amazon Pinpoint is available, user pools support sending events to Amazon Pinpoint projects within that same Region. + * In AWS Regions where Amazon Pinpoint isn't available, user pools might not have access to analytics or might be configurable with campaigns in the US East (N. Virginia) Region. For more information, see [Using Amazon Pinpoint analytics](https://docs.aws.amazon.com/cognito/latest/developerguide/cognito-user-pools-pinpoint-integration.html) . */ readonly analyticsConfiguration?: outputs.cognito.UserPoolClientAnalyticsConfiguration; /** @@ -83,7 +83,7 @@ export interface GetUserPoolClientResult { * A redirect URI must: * * - Be an absolute URI. - * - Be registered with the authorization server. + * - Be registered with the authorization server. Amazon Cognito doesn't accept authorization requests with `redirect_uri` values that aren't in the list of `CallbackURLs` that you provide in this parameter. * - Not include a fragment component. * * See [OAuth 2.0 - Redirection Endpoint](https://docs.aws.amazon.com/https://tools.ietf.org/html/rfc6749#section-3.1.2) . @@ -98,24 +98,12 @@ export interface GetUserPoolClientResult { */ readonly clientId?: string; /** - * The client name for the user pool client you would like to create. + * A friendly name for the app client that you want to create. */ readonly clientName?: string; readonly clientSecret?: string; /** * The default redirect URI. In app clients with one assigned IdP, replaces `redirect_uri` in authentication requests. Must be in the `CallbackURLs` list. - * - * A redirect URI must: - * - * - Be an absolute URI. - * - Be registered with the authorization server. - * - Not include a fragment component. - * - * For more information, see [Default redirect URI](https://docs.aws.amazon.com/cognito/latest/developerguide/user-pool-settings-client-apps.html#cognito-user-pools-app-idp-settings-about) . - * - * Amazon Cognito requires HTTPS over HTTP except for http://localhost for testing purposes only. - * - * App callback URLs such as myapp://example are also supported. */ readonly defaultRedirectUri?: string; /** @@ -158,7 +146,7 @@ export interface GetUserPoolClientResult { */ readonly idTokenValidity?: number; /** - * A list of allowed logout URLs for the IdPs. + * A list of allowed logout URLs for managed login authentication. For more information, see [Logout endpoint](https://docs.aws.amazon.com/cognito/latest/developerguide/logout-endpoint.html) . */ readonly logoutUrls?: string[]; readonly name?: string; @@ -194,11 +182,11 @@ export interface GetUserPoolClientResult { /** * A list of provider names for the identity providers (IdPs) that are supported on this client. The following are supported: `COGNITO` , `Facebook` , `Google` , `SignInWithApple` , and `LoginWithAmazon` . You can also specify the names that you configured for the SAML and OIDC IdPs in your user pool, for example `MySAMLIdP` or `MyOIDCIdP` . * - * This setting applies to providers that you can access with the [hosted UI and OAuth 2.0 authorization server](https://docs.aws.amazon.com/cognito/latest/developerguide/cognito-user-pools-app-integration.html) . The removal of `COGNITO` from this list doesn't prevent authentication operations for local users with the user pools API in an AWS SDK. The only way to prevent API-based authentication is to block access with a [AWS WAF rule](https://docs.aws.amazon.com/cognito/latest/developerguide/user-pool-waf.html) . + * This setting applies to providers that you can access with [managed login](https://docs.aws.amazon.com/cognito/latest/developerguide/cognito-user-pools-managed-login.html) . The removal of `COGNITO` from this list doesn't prevent authentication operations for local users with the user pools API in an AWS SDK. The only way to prevent API-based authentication is to block access with a [AWS WAF rule](https://docs.aws.amazon.com/cognito/latest/developerguide/user-pool-waf.html) . */ readonly supportedIdentityProviders?: string[]; /** - * The units in which the validity times are represented. The default unit for RefreshToken is days, and default for ID and access tokens are hours. + * The units that validity times are represented in. The default unit for refresh tokens is days, and the default for ID and access tokens are hours. */ readonly tokenValidityUnits?: outputs.cognito.UserPoolClientTokenValidityUnits; /** @@ -227,7 +215,7 @@ export interface GetUserPoolClientOutputArgs { */ clientId: pulumi.Input; /** - * The user pool ID for the user pool where you want to create a user pool client. + * The ID of the user pool where you want to create an app client. */ userPoolId: pulumi.Input; } diff --git a/sdk/nodejs/cognito/getUserPoolGroup.ts b/sdk/nodejs/cognito/getUserPoolGroup.ts index d9ab5fe574..921b9b7b43 100644 --- a/sdk/nodejs/cognito/getUserPoolGroup.ts +++ b/sdk/nodejs/cognito/getUserPoolGroup.ts @@ -17,18 +17,18 @@ export function getUserPoolGroup(args: GetUserPoolGroupArgs, opts?: pulumi.Invok export interface GetUserPoolGroupArgs { /** - * The name of the group. Must be unique. + * A name for the group. This name must be unique in your user pool. */ groupName: string; /** - * The user pool ID for the user pool. + * The ID of the user pool where you want to create a user group. */ userPoolId: string; } export interface GetUserPoolGroupResult { /** - * A string containing the description of the group. + * A description of the group that you're creating. */ readonly description?: string; /** @@ -40,7 +40,7 @@ export interface GetUserPoolGroupResult { */ readonly precedence?: number; /** - * The role Amazon Resource Name (ARN) for the group. + * The Amazon Resource Name (ARN) for the IAM role that you want to associate with the group. A group role primarily declares a preferred role for the credentials that you get from an identity pool. Amazon Cognito ID tokens have a `cognito:preferred_role` claim that presents the highest-precedence group that a user belongs to. Both ID and access tokens also contain a `cognito:groups` claim that list all the groups that a user is a member of. */ readonly roleArn?: string; } @@ -57,11 +57,11 @@ export function getUserPoolGroupOutput(args: GetUserPoolGroupOutputArgs, opts?: export interface GetUserPoolGroupOutputArgs { /** - * The name of the group. Must be unique. + * A name for the group. This name must be unique in your user pool. */ groupName: pulumi.Input; /** - * The user pool ID for the user pool. + * The ID of the user pool where you want to create a user group. */ userPoolId: pulumi.Input; } diff --git a/sdk/nodejs/cognito/getUserPoolIdentityProvider.ts b/sdk/nodejs/cognito/getUserPoolIdentityProvider.ts index 85c1840ed5..6d84693cf6 100644 --- a/sdk/nodejs/cognito/getUserPoolIdentityProvider.ts +++ b/sdk/nodejs/cognito/getUserPoolIdentityProvider.ts @@ -17,22 +17,22 @@ export function getUserPoolIdentityProvider(args: GetUserPoolIdentityProviderArg export interface GetUserPoolIdentityProviderArgs { /** - * The IdP name. + * The name that you want to assign to the IdP. You can pass the identity provider name in the `identity_provider` query parameter of requests to the [Authorize endpoint](https://docs.aws.amazon.com/cognito/latest/developerguide/authorization-endpoint.html) to silently redirect to sign-in with the associated IdP. */ providerName: string; /** - * The user pool ID. + * The Id of the user pool where you want to create an IdP. */ userPoolId: string; } export interface GetUserPoolIdentityProviderResult { /** - * A mapping of IdP attributes to standard and custom user pool attributes. + * A mapping of IdP attributes to standard and custom user pool attributes. Specify a user pool attribute as the key of the key-value pair, and the IdP attribute claim name as the value. */ readonly attributeMapping?: {[key: string]: string}; /** - * A list of IdP identifiers. + * An array of IdP identifiers, for example `"IdPIdentifiers": [ "MyIdP", "MyIdP2" ]` . Identifiers are friendly names that you can pass in the `idp_identifier` query parameter of requests to the [Authorize endpoint](https://docs.aws.amazon.com/cognito/latest/developerguide/authorization-endpoint.html) to silently redirect to sign-in with the associated IdP. Identifiers in a domain format also enable the use of [email-address matching with SAML providers](https://docs.aws.amazon.com/cognito/latest/developerguide/cognito-user-pools-managing-saml-idp-naming.html) . */ readonly idpIdentifiers?: string[]; /** @@ -81,11 +81,11 @@ export function getUserPoolIdentityProviderOutput(args: GetUserPoolIdentityProvi export interface GetUserPoolIdentityProviderOutputArgs { /** - * The IdP name. + * The name that you want to assign to the IdP. You can pass the identity provider name in the `identity_provider` query parameter of requests to the [Authorize endpoint](https://docs.aws.amazon.com/cognito/latest/developerguide/authorization-endpoint.html) to silently redirect to sign-in with the associated IdP. */ providerName: pulumi.Input; /** - * The user pool ID. + * The Id of the user pool where you want to create an IdP. */ userPoolId: pulumi.Input; } diff --git a/sdk/nodejs/cognito/getUserPoolResourceServer.ts b/sdk/nodejs/cognito/getUserPoolResourceServer.ts index 0d0876ab83..2f52218a65 100644 --- a/sdk/nodejs/cognito/getUserPoolResourceServer.ts +++ b/sdk/nodejs/cognito/getUserPoolResourceServer.ts @@ -26,7 +26,7 @@ export interface GetUserPoolResourceServerArgs { */ identifier: string; /** - * The user pool ID for the user pool. + * The ID of the user pool where you want to create a resource server. */ userPoolId: string; } @@ -60,7 +60,7 @@ export interface GetUserPoolResourceServerOutputArgs { */ identifier: pulumi.Input; /** - * The user pool ID for the user pool. + * The ID of the user pool where you want to create a resource server. */ userPoolId: pulumi.Input; } diff --git a/sdk/nodejs/cognito/getUserPoolUiCustomizationAttachment.ts b/sdk/nodejs/cognito/getUserPoolUiCustomizationAttachment.ts index 8f61689fbd..327b91f477 100644 --- a/sdk/nodejs/cognito/getUserPoolUiCustomizationAttachment.ts +++ b/sdk/nodejs/cognito/getUserPoolUiCustomizationAttachment.ts @@ -21,7 +21,7 @@ export interface GetUserPoolUiCustomizationAttachmentArgs { */ clientId: string; /** - * The user pool ID for the user pool. + * The ID of the user pool. */ userPoolId: string; } @@ -49,7 +49,7 @@ export interface GetUserPoolUiCustomizationAttachmentOutputArgs { */ clientId: pulumi.Input; /** - * The user pool ID for the user pool. + * The ID of the user pool. */ userPoolId: pulumi.Input; } diff --git a/sdk/nodejs/cognito/managedLoginBranding.ts b/sdk/nodejs/cognito/managedLoginBranding.ts index 011cdc8302..947b554044 100644 --- a/sdk/nodejs/cognito/managedLoginBranding.ts +++ b/sdk/nodejs/cognito/managedLoginBranding.ts @@ -41,11 +41,17 @@ export class ManagedLoginBranding extends pulumi.CustomResource { * An array of image files that you want to apply to roles like backgrounds, logos, and icons. Each object must also indicate whether it is for dark mode, light mode, or browser-adaptive mode. */ public readonly assets!: pulumi.Output; + /** + * The app client that's assigned to the branding style that you want more information about. + */ public readonly clientId!: pulumi.Output; /** * The ID of the managed login branding style. */ public /*out*/ readonly managedLoginBrandingId!: pulumi.Output; + /** + * When `true` , returns values for branding options that are unchanged from Amazon Cognito defaults. When `false` or when you omit this parameter, returns only values that you customized in your branding style. + */ public readonly returnMergedResources!: pulumi.Output; /** * A JSON file, encoded as a `Document` type, with the the settings that you want to apply to your style. @@ -54,7 +60,9 @@ export class ManagedLoginBranding extends pulumi.CustomResource { */ public readonly settings!: pulumi.Output; /** - * When true, applies the default branding style options. This option reverts to a "blank" style that you can modify later in the branding designer. + * When true, applies the default branding style options. This option reverts to default style options that are managed by Amazon Cognito. You can modify them later in the branding designer. + * + * When you specify `true` for this option, you must also omit values for `Settings` and `Assets` in the request. */ public readonly useCognitoProvidedValues!: pulumi.Output; /** @@ -107,7 +115,13 @@ export interface ManagedLoginBrandingArgs { * An array of image files that you want to apply to roles like backgrounds, logos, and icons. Each object must also indicate whether it is for dark mode, light mode, or browser-adaptive mode. */ assets?: pulumi.Input[]>; + /** + * The app client that's assigned to the branding style that you want more information about. + */ clientId?: pulumi.Input; + /** + * When `true` , returns values for branding options that are unchanged from Amazon Cognito defaults. When `false` or when you omit this parameter, returns only values that you customized in your branding style. + */ returnMergedResources?: pulumi.Input; /** * A JSON file, encoded as a `Document` type, with the the settings that you want to apply to your style. @@ -116,7 +130,9 @@ export interface ManagedLoginBrandingArgs { */ settings?: any; /** - * When true, applies the default branding style options. This option reverts to a "blank" style that you can modify later in the branding designer. + * When true, applies the default branding style options. This option reverts to default style options that are managed by Amazon Cognito. You can modify them later in the branding designer. + * + * When you specify `true` for this option, you must also omit values for `Settings` and `Assets` in the request. */ useCognitoProvidedValues?: pulumi.Input; /** diff --git a/sdk/nodejs/cognito/userPool.ts b/sdk/nodejs/cognito/userPool.ts index 9989fa21ce..0158ccc7d5 100644 --- a/sdk/nodejs/cognito/userPool.ts +++ b/sdk/nodejs/cognito/userPool.ts @@ -48,7 +48,7 @@ export class UserPool extends pulumi.CustomResource { */ public readonly adminCreateUserConfig!: pulumi.Output; /** - * Attributes supported as an alias for this user pool. Possible values: *phone_number* , *email* , or *preferred_username* . + * Attributes supported as an alias for this user pool. Possible values: *phone_number* , *email* , or *preferred_username* . For more information about alias attributes, see [Customizing sign-in attributes](https://docs.aws.amazon.com/cognito/latest/developerguide/user-pool-settings-attributes.html#user-pool-settings-aliases) . */ public readonly aliasAttributes!: pulumi.Output; /** @@ -56,7 +56,7 @@ export class UserPool extends pulumi.CustomResource { */ public /*out*/ readonly arn!: pulumi.Output; /** - * The attributes to be auto-verified. Possible values: *email* , *phone_number* . + * The attributes that you want your user pool to automatically verify. Possible values: *email* , *phone_number* . For more information see [Verifying contact information at sign-up](https://docs.aws.amazon.com/cognito/latest/developerguide/signing-up-users-in-your-app.html#allowing-users-to-sign-up-and-confirm-themselves) . */ public readonly autoVerifiedAttributes!: pulumi.Output; /** @@ -68,9 +68,9 @@ export class UserPool extends pulumi.CustomResource { */ public readonly deletionProtection!: pulumi.Output; /** - * The device-remembering configuration for a user pool. A null value indicates that you have deactivated device remembering in your user pool. + * The device-remembering configuration for a user pool. Device remembering or device tracking is a "Remember me on this device" option for user pools that perform authentication with the device key of a trusted device in the back end, instead of a user-provided MFA code. For more information about device authentication, see [Working with user devices in your user pool](https://docs.aws.amazon.com/cognito/latest/developerguide/amazon-cognito-user-pools-device-tracking.html) . A null value indicates that you have deactivated device remembering in your user pool. * - * > When you provide a value for any `DeviceConfiguration` field, you activate the Amazon Cognito device-remembering feature. + * > When you provide a value for any `DeviceConfiguration` field, you activate the Amazon Cognito device-remembering feature. For more infor */ public readonly deviceConfiguration!: pulumi.Output; public readonly emailAuthenticationMessage!: pulumi.Output; @@ -124,7 +124,7 @@ export class UserPool extends pulumi.CustomResource { */ public /*out*/ readonly providerUrl!: pulumi.Output; /** - * An array of schema attributes for the new user pool. These attributes can be standard or custom attributes. + * An array of attributes for the new user pool. You can add custom attributes and modify the properties of default attributes. The specifications in this parameter set the required attributes in your user pool. For more information, see [Working with user attributes](https://docs.aws.amazon.com/cognito/latest/developerguide/user-pool-settings-attributes.html) . */ public readonly schema!: pulumi.Output; /** @@ -132,7 +132,7 @@ export class UserPool extends pulumi.CustomResource { */ public readonly smsAuthenticationMessage!: pulumi.Output; /** - * The SMS configuration with the settings that your Amazon Cognito user pool must use to send an SMS message from your AWS account through Amazon Simple Notification Service. To send SMS messages with Amazon SNS in the AWS Region that you want, the Amazon Cognito user pool uses an AWS Identity and Access Management (IAM) role in your AWS account . + * The SMS configuration with the settings that your Amazon Cognito user pool must use to send an SMS message from your AWS account through Amazon Simple Notification Service. To send SMS messages with Amazon SNS in the AWS Region that you want, the Amazon Cognito user pool uses an AWS Identity and Access Management (IAM) role in your AWS account . For more information see [SMS message settings](https://docs.aws.amazon.com/cognito/latest/developerguide/user-pool-sms-settings.html) . */ public readonly smsConfiguration!: pulumi.Output; /** @@ -156,7 +156,7 @@ export class UserPool extends pulumi.CustomResource { */ public /*out*/ readonly userPoolId!: pulumi.Output; /** - * A string used to name the user pool. + * A friendlhy name for your user pool. */ public readonly userPoolName!: pulumi.Output; /** @@ -172,9 +172,11 @@ export class UserPool extends pulumi.CustomResource { */ public readonly usernameAttributes!: pulumi.Output; /** - * Case sensitivity on the username input for the selected sign-in option. When case sensitivity is set to `False` (case insensitive), users can sign in with any combination of capital and lowercase letters. For example, `username` , `USERNAME` , or `UserName` , or for email, `email@example.com` or `EMaiL@eXamplE.Com` . For most use cases, set case sensitivity to `False` (case insensitive) as a best practice. When usernames and email addresses are case insensitive, Amazon Cognito treats any variation in case as the same user, and prevents a case variation from being assigned to the same attribute for a different user. + * Sets the case sensitivity option for sign-in usernames. When `CaseSensitive` is `false` (case insensitive), users can sign in with any combination of capital and lowercase letters. For example, `username` , `USERNAME` , or `UserName` , or for email, `email@example.com` or `EMaiL@eXamplE.Com` . For most use cases, set case sensitivity to `false` as a best practice. When usernames and email addresses are case insensitive, Amazon Cognito treats any variation in case as the same user, and prevents a case variation from being assigned to the same attribute for a different user. * - * This configuration is immutable after you set it. For more information, see [UsernameConfigurationType](https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_UsernameConfigurationType.html) . + * When `CaseSensitive` is `true` (case sensitive), Amazon Cognito interprets `USERNAME` and `UserName` as distinct users. + * + * This configuration is immutable after you set it. */ public readonly usernameConfiguration!: pulumi.Output; /** @@ -183,7 +185,19 @@ export class UserPool extends pulumi.CustomResource { * Set the email message type that corresponds to your `DefaultEmailOption` selection. For `CONFIRM_WITH_LINK` , specify an `EmailMessageByLink` and leave `EmailMessage` blank. For `CONFIRM_WITH_CODE` , specify an `EmailMessage` and leave `EmailMessageByLink` blank. When you supply both parameters with either choice, Amazon Cognito returns an error. */ public readonly verificationMessageTemplate!: pulumi.Output; + /** + * Sets or displays the authentication domain, typically your user pool domain, that passkey providers must use as a relying party (RP) in their configuration. + * + * Under the following conditions, the passkey relying party ID must be the fully-qualified domain name of your custom domain: + * + * - The user pool is configured for passkey authentication. + * - The user pool has a custom domain, whether or not it also has a prefix domain. + * - Your application performs authentication with managed login or the classic hosted UI. + */ public readonly webAuthnRelyingPartyId!: pulumi.Output; + /** + * When `required` , users can only register and sign in users with passkeys that are capable of [user verification](https://docs.aws.amazon.com/https://www.w3.org/TR/webauthn-2/#enum-userVerificationRequirement) . When `preferred` , your user pool doesn't require the use of authenticators with user verification but encourages it. + */ public readonly webAuthnUserVerification!: pulumi.Output; /** @@ -285,11 +299,11 @@ export interface UserPoolArgs { */ adminCreateUserConfig?: pulumi.Input; /** - * Attributes supported as an alias for this user pool. Possible values: *phone_number* , *email* , or *preferred_username* . + * Attributes supported as an alias for this user pool. Possible values: *phone_number* , *email* , or *preferred_username* . For more information about alias attributes, see [Customizing sign-in attributes](https://docs.aws.amazon.com/cognito/latest/developerguide/user-pool-settings-attributes.html#user-pool-settings-aliases) . */ aliasAttributes?: pulumi.Input[]>; /** - * The attributes to be auto-verified. Possible values: *email* , *phone_number* . + * The attributes that you want your user pool to automatically verify. Possible values: *email* , *phone_number* . For more information see [Verifying contact information at sign-up](https://docs.aws.amazon.com/cognito/latest/developerguide/signing-up-users-in-your-app.html#allowing-users-to-sign-up-and-confirm-themselves) . */ autoVerifiedAttributes?: pulumi.Input[]>; /** @@ -301,9 +315,9 @@ export interface UserPoolArgs { */ deletionProtection?: pulumi.Input; /** - * The device-remembering configuration for a user pool. A null value indicates that you have deactivated device remembering in your user pool. + * The device-remembering configuration for a user pool. Device remembering or device tracking is a "Remember me on this device" option for user pools that perform authentication with the device key of a trusted device in the back end, instead of a user-provided MFA code. For more information about device authentication, see [Working with user devices in your user pool](https://docs.aws.amazon.com/cognito/latest/developerguide/amazon-cognito-user-pools-device-tracking.html) . A null value indicates that you have deactivated device remembering in your user pool. * - * > When you provide a value for any `DeviceConfiguration` field, you activate the Amazon Cognito device-remembering feature. + * > When you provide a value for any `DeviceConfiguration` field, you activate the Amazon Cognito device-remembering feature. For more infor */ deviceConfiguration?: pulumi.Input; emailAuthenticationMessage?: pulumi.Input; @@ -349,7 +363,7 @@ export interface UserPoolArgs { */ policies?: pulumi.Input; /** - * An array of schema attributes for the new user pool. These attributes can be standard or custom attributes. + * An array of attributes for the new user pool. You can add custom attributes and modify the properties of default attributes. The specifications in this parameter set the required attributes in your user pool. For more information, see [Working with user attributes](https://docs.aws.amazon.com/cognito/latest/developerguide/user-pool-settings-attributes.html) . */ schema?: pulumi.Input[]>; /** @@ -357,7 +371,7 @@ export interface UserPoolArgs { */ smsAuthenticationMessage?: pulumi.Input; /** - * The SMS configuration with the settings that your Amazon Cognito user pool must use to send an SMS message from your AWS account through Amazon Simple Notification Service. To send SMS messages with Amazon SNS in the AWS Region that you want, the Amazon Cognito user pool uses an AWS Identity and Access Management (IAM) role in your AWS account . + * The SMS configuration with the settings that your Amazon Cognito user pool must use to send an SMS message from your AWS account through Amazon Simple Notification Service. To send SMS messages with Amazon SNS in the AWS Region that you want, the Amazon Cognito user pool uses an AWS Identity and Access Management (IAM) role in your AWS account . For more information see [SMS message settings](https://docs.aws.amazon.com/cognito/latest/developerguide/user-pool-sms-settings.html) . */ smsConfiguration?: pulumi.Input; /** @@ -377,7 +391,7 @@ export interface UserPoolArgs { */ userPoolAddOns?: pulumi.Input; /** - * A string used to name the user pool. + * A friendlhy name for your user pool. */ userPoolName?: pulumi.Input; /** @@ -393,9 +407,11 @@ export interface UserPoolArgs { */ usernameAttributes?: pulumi.Input[]>; /** - * Case sensitivity on the username input for the selected sign-in option. When case sensitivity is set to `False` (case insensitive), users can sign in with any combination of capital and lowercase letters. For example, `username` , `USERNAME` , or `UserName` , or for email, `email@example.com` or `EMaiL@eXamplE.Com` . For most use cases, set case sensitivity to `False` (case insensitive) as a best practice. When usernames and email addresses are case insensitive, Amazon Cognito treats any variation in case as the same user, and prevents a case variation from being assigned to the same attribute for a different user. + * Sets the case sensitivity option for sign-in usernames. When `CaseSensitive` is `false` (case insensitive), users can sign in with any combination of capital and lowercase letters. For example, `username` , `USERNAME` , or `UserName` , or for email, `email@example.com` or `EMaiL@eXamplE.Com` . For most use cases, set case sensitivity to `false` as a best practice. When usernames and email addresses are case insensitive, Amazon Cognito treats any variation in case as the same user, and prevents a case variation from being assigned to the same attribute for a different user. * - * This configuration is immutable after you set it. For more information, see [UsernameConfigurationType](https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_UsernameConfigurationType.html) . + * When `CaseSensitive` is `true` (case sensitive), Amazon Cognito interprets `USERNAME` and `UserName` as distinct users. + * + * This configuration is immutable after you set it. */ usernameConfiguration?: pulumi.Input; /** @@ -404,6 +420,18 @@ export interface UserPoolArgs { * Set the email message type that corresponds to your `DefaultEmailOption` selection. For `CONFIRM_WITH_LINK` , specify an `EmailMessageByLink` and leave `EmailMessage` blank. For `CONFIRM_WITH_CODE` , specify an `EmailMessage` and leave `EmailMessageByLink` blank. When you supply both parameters with either choice, Amazon Cognito returns an error. */ verificationMessageTemplate?: pulumi.Input; + /** + * Sets or displays the authentication domain, typically your user pool domain, that passkey providers must use as a relying party (RP) in their configuration. + * + * Under the following conditions, the passkey relying party ID must be the fully-qualified domain name of your custom domain: + * + * - The user pool is configured for passkey authentication. + * - The user pool has a custom domain, whether or not it also has a prefix domain. + * - Your application performs authentication with managed login or the classic hosted UI. + */ webAuthnRelyingPartyId?: pulumi.Input; + /** + * When `required` , users can only register and sign in users with passkeys that are capable of [user verification](https://docs.aws.amazon.com/https://www.w3.org/TR/webauthn-2/#enum-userVerificationRequirement) . When `preferred` , your user pool doesn't require the use of authenticators with user verification but encourages it. + */ webAuthnUserVerification?: pulumi.Input; } diff --git a/sdk/nodejs/cognito/userPoolClient.ts b/sdk/nodejs/cognito/userPoolClient.ts index 654bfdeff3..a967d1b49f 100644 --- a/sdk/nodejs/cognito/userPoolClient.ts +++ b/sdk/nodejs/cognito/userPoolClient.ts @@ -71,13 +71,13 @@ export class UserPoolClient extends pulumi.CustomResource { */ public readonly allowedOAuthFlowsUserPoolClient!: pulumi.Output; /** - * The allowed OAuth scopes. Possible values provided by OAuth are `phone` , `email` , `openid` , and `profile` . Possible values provided by AWS are `aws.cognito.signin.user.admin` . Custom scopes created in Resource Servers are also supported. + * The OAuth 2.0 scopes that you want to permit your app client to authorize. Scopes govern access control to user pool self-service API operations, user data from the `userInfo` endpoint, and third-party APIs. Possible values provided by OAuth are `phone` , `email` , `openid` , and `profile` . Possible values provided by AWS are `aws.cognito.signin.user.admin` . Custom scopes created in Resource Servers are also supported. */ public readonly allowedOAuthScopes!: pulumi.Output; /** * The user pool analytics configuration for collecting metrics and sending them to your Amazon Pinpoint campaign. * - * > In AWS Regions where Amazon Pinpoint isn't available, user pools only support sending events to Amazon Pinpoint projects in AWS Region us-east-1. In Regions where Amazon Pinpoint is available, user pools support sending events to Amazon Pinpoint projects within that same Region. + * In AWS Regions where Amazon Pinpoint isn't available, user pools might not have access to analytics or might be configurable with campaigns in the US East (N. Virginia) Region. For more information, see [Using Amazon Pinpoint analytics](https://docs.aws.amazon.com/cognito/latest/developerguide/cognito-user-pools-pinpoint-integration.html) . */ public readonly analyticsConfiguration!: pulumi.Output; /** @@ -90,7 +90,7 @@ export class UserPoolClient extends pulumi.CustomResource { * A redirect URI must: * * - Be an absolute URI. - * - Be registered with the authorization server. + * - Be registered with the authorization server. Amazon Cognito doesn't accept authorization requests with `redirect_uri` values that aren't in the list of `CallbackURLs` that you provide in this parameter. * - Not include a fragment component. * * See [OAuth 2.0 - Redirection Endpoint](https://docs.aws.amazon.com/https://tools.ietf.org/html/rfc6749#section-3.1.2) . @@ -105,24 +105,12 @@ export class UserPoolClient extends pulumi.CustomResource { */ public /*out*/ readonly clientId!: pulumi.Output; /** - * The client name for the user pool client you would like to create. + * A friendly name for the app client that you want to create. */ public readonly clientName!: pulumi.Output; public /*out*/ readonly clientSecret!: pulumi.Output; /** * The default redirect URI. In app clients with one assigned IdP, replaces `redirect_uri` in authentication requests. Must be in the `CallbackURLs` list. - * - * A redirect URI must: - * - * - Be an absolute URI. - * - Be registered with the authorization server. - * - Not include a fragment component. - * - * For more information, see [Default redirect URI](https://docs.aws.amazon.com/cognito/latest/developerguide/user-pool-settings-client-apps.html#cognito-user-pools-app-idp-settings-about) . - * - * Amazon Cognito requires HTTPS over HTTP except for http://localhost for testing purposes only. - * - * App callback URLs such as myapp://example are also supported. */ public readonly defaultRedirectUri!: pulumi.Output; /** @@ -154,7 +142,7 @@ export class UserPoolClient extends pulumi.CustomResource { */ public readonly explicitAuthFlows!: pulumi.Output; /** - * Boolean to specify whether you want to generate a secret for the user pool client being created. + * When `true` , generates a client secret for the app client. Client secrets are used with server-side and machine-to-machine applications. For more information, see [App client types](https://docs.aws.amazon.com/cognito/latest/developerguide/user-pool-settings-client-apps.html#user-pool-settings-client-app-client-types) . */ public readonly generateSecret!: pulumi.Output; /** @@ -169,7 +157,7 @@ export class UserPoolClient extends pulumi.CustomResource { */ public readonly idTokenValidity!: pulumi.Output; /** - * A list of allowed logout URLs for the IdPs. + * A list of allowed logout URLs for managed login authentication. For more information, see [Logout endpoint](https://docs.aws.amazon.com/cognito/latest/developerguide/logout-endpoint.html) . */ public readonly logoutUrls!: pulumi.Output; public /*out*/ readonly name!: pulumi.Output; @@ -205,15 +193,15 @@ export class UserPoolClient extends pulumi.CustomResource { /** * A list of provider names for the identity providers (IdPs) that are supported on this client. The following are supported: `COGNITO` , `Facebook` , `Google` , `SignInWithApple` , and `LoginWithAmazon` . You can also specify the names that you configured for the SAML and OIDC IdPs in your user pool, for example `MySAMLIdP` or `MyOIDCIdP` . * - * This setting applies to providers that you can access with the [hosted UI and OAuth 2.0 authorization server](https://docs.aws.amazon.com/cognito/latest/developerguide/cognito-user-pools-app-integration.html) . The removal of `COGNITO` from this list doesn't prevent authentication operations for local users with the user pools API in an AWS SDK. The only way to prevent API-based authentication is to block access with a [AWS WAF rule](https://docs.aws.amazon.com/cognito/latest/developerguide/user-pool-waf.html) . + * This setting applies to providers that you can access with [managed login](https://docs.aws.amazon.com/cognito/latest/developerguide/cognito-user-pools-managed-login.html) . The removal of `COGNITO` from this list doesn't prevent authentication operations for local users with the user pools API in an AWS SDK. The only way to prevent API-based authentication is to block access with a [AWS WAF rule](https://docs.aws.amazon.com/cognito/latest/developerguide/user-pool-waf.html) . */ public readonly supportedIdentityProviders!: pulumi.Output; /** - * The units in which the validity times are represented. The default unit for RefreshToken is days, and default for ID and access tokens are hours. + * The units that validity times are represented in. The default unit for refresh tokens is days, and the default for ID and access tokens are hours. */ public readonly tokenValidityUnits!: pulumi.Output; /** - * The user pool ID for the user pool where you want to create a user pool client. + * The ID of the user pool where you want to create an app client. */ public readonly userPoolId!: pulumi.Output; /** @@ -336,13 +324,13 @@ export interface UserPoolClientArgs { */ allowedOAuthFlowsUserPoolClient?: pulumi.Input; /** - * The allowed OAuth scopes. Possible values provided by OAuth are `phone` , `email` , `openid` , and `profile` . Possible values provided by AWS are `aws.cognito.signin.user.admin` . Custom scopes created in Resource Servers are also supported. + * The OAuth 2.0 scopes that you want to permit your app client to authorize. Scopes govern access control to user pool self-service API operations, user data from the `userInfo` endpoint, and third-party APIs. Possible values provided by OAuth are `phone` , `email` , `openid` , and `profile` . Possible values provided by AWS are `aws.cognito.signin.user.admin` . Custom scopes created in Resource Servers are also supported. */ allowedOAuthScopes?: pulumi.Input[]>; /** * The user pool analytics configuration for collecting metrics and sending them to your Amazon Pinpoint campaign. * - * > In AWS Regions where Amazon Pinpoint isn't available, user pools only support sending events to Amazon Pinpoint projects in AWS Region us-east-1. In Regions where Amazon Pinpoint is available, user pools support sending events to Amazon Pinpoint projects within that same Region. + * In AWS Regions where Amazon Pinpoint isn't available, user pools might not have access to analytics or might be configurable with campaigns in the US East (N. Virginia) Region. For more information, see [Using Amazon Pinpoint analytics](https://docs.aws.amazon.com/cognito/latest/developerguide/cognito-user-pools-pinpoint-integration.html) . */ analyticsConfiguration?: pulumi.Input; /** @@ -355,7 +343,7 @@ export interface UserPoolClientArgs { * A redirect URI must: * * - Be an absolute URI. - * - Be registered with the authorization server. + * - Be registered with the authorization server. Amazon Cognito doesn't accept authorization requests with `redirect_uri` values that aren't in the list of `CallbackURLs` that you provide in this parameter. * - Not include a fragment component. * * See [OAuth 2.0 - Redirection Endpoint](https://docs.aws.amazon.com/https://tools.ietf.org/html/rfc6749#section-3.1.2) . @@ -366,23 +354,11 @@ export interface UserPoolClientArgs { */ callbackUrls?: pulumi.Input[]>; /** - * The client name for the user pool client you would like to create. + * A friendly name for the app client that you want to create. */ clientName?: pulumi.Input; /** * The default redirect URI. In app clients with one assigned IdP, replaces `redirect_uri` in authentication requests. Must be in the `CallbackURLs` list. - * - * A redirect URI must: - * - * - Be an absolute URI. - * - Be registered with the authorization server. - * - Not include a fragment component. - * - * For more information, see [Default redirect URI](https://docs.aws.amazon.com/cognito/latest/developerguide/user-pool-settings-client-apps.html#cognito-user-pools-app-idp-settings-about) . - * - * Amazon Cognito requires HTTPS over HTTP except for http://localhost for testing purposes only. - * - * App callback URLs such as myapp://example are also supported. */ defaultRedirectUri?: pulumi.Input; /** @@ -414,7 +390,7 @@ export interface UserPoolClientArgs { */ explicitAuthFlows?: pulumi.Input[]>; /** - * Boolean to specify whether you want to generate a secret for the user pool client being created. + * When `true` , generates a client secret for the app client. Client secrets are used with server-side and machine-to-machine applications. For more information, see [App client types](https://docs.aws.amazon.com/cognito/latest/developerguide/user-pool-settings-client-apps.html#user-pool-settings-client-app-client-types) . */ generateSecret?: pulumi.Input; /** @@ -429,7 +405,7 @@ export interface UserPoolClientArgs { */ idTokenValidity?: pulumi.Input; /** - * A list of allowed logout URLs for the IdPs. + * A list of allowed logout URLs for managed login authentication. For more information, see [Logout endpoint](https://docs.aws.amazon.com/cognito/latest/developerguide/logout-endpoint.html) . */ logoutUrls?: pulumi.Input[]>; /** @@ -464,15 +440,15 @@ export interface UserPoolClientArgs { /** * A list of provider names for the identity providers (IdPs) that are supported on this client. The following are supported: `COGNITO` , `Facebook` , `Google` , `SignInWithApple` , and `LoginWithAmazon` . You can also specify the names that you configured for the SAML and OIDC IdPs in your user pool, for example `MySAMLIdP` or `MyOIDCIdP` . * - * This setting applies to providers that you can access with the [hosted UI and OAuth 2.0 authorization server](https://docs.aws.amazon.com/cognito/latest/developerguide/cognito-user-pools-app-integration.html) . The removal of `COGNITO` from this list doesn't prevent authentication operations for local users with the user pools API in an AWS SDK. The only way to prevent API-based authentication is to block access with a [AWS WAF rule](https://docs.aws.amazon.com/cognito/latest/developerguide/user-pool-waf.html) . + * This setting applies to providers that you can access with [managed login](https://docs.aws.amazon.com/cognito/latest/developerguide/cognito-user-pools-managed-login.html) . The removal of `COGNITO` from this list doesn't prevent authentication operations for local users with the user pools API in an AWS SDK. The only way to prevent API-based authentication is to block access with a [AWS WAF rule](https://docs.aws.amazon.com/cognito/latest/developerguide/user-pool-waf.html) . */ supportedIdentityProviders?: pulumi.Input[]>; /** - * The units in which the validity times are represented. The default unit for RefreshToken is days, and default for ID and access tokens are hours. + * The units that validity times are represented in. The default unit for refresh tokens is days, and the default for ID and access tokens are hours. */ tokenValidityUnits?: pulumi.Input; /** - * The user pool ID for the user pool where you want to create a user pool client. + * The ID of the user pool where you want to create an app client. */ userPoolId: pulumi.Input; /** diff --git a/sdk/nodejs/cognito/userPoolGroup.ts b/sdk/nodejs/cognito/userPoolGroup.ts index 656271164c..e2f80ff93a 100644 --- a/sdk/nodejs/cognito/userPoolGroup.ts +++ b/sdk/nodejs/cognito/userPoolGroup.ts @@ -35,11 +35,11 @@ export class UserPoolGroup extends pulumi.CustomResource { } /** - * A string containing the description of the group. + * A description of the group that you're creating. */ public readonly description!: pulumi.Output; /** - * The name of the group. Must be unique. + * A name for the group. This name must be unique in your user pool. */ public readonly groupName!: pulumi.Output; /** @@ -51,11 +51,11 @@ export class UserPoolGroup extends pulumi.CustomResource { */ public readonly precedence!: pulumi.Output; /** - * The role Amazon Resource Name (ARN) for the group. + * The Amazon Resource Name (ARN) for the IAM role that you want to associate with the group. A group role primarily declares a preferred role for the credentials that you get from an identity pool. Amazon Cognito ID tokens have a `cognito:preferred_role` claim that presents the highest-precedence group that a user belongs to. Both ID and access tokens also contain a `cognito:groups` claim that list all the groups that a user is a member of. */ public readonly roleArn!: pulumi.Output; /** - * The user pool ID for the user pool. + * The ID of the user pool where you want to create a user group. */ public readonly userPoolId!: pulumi.Output; @@ -97,11 +97,11 @@ export class UserPoolGroup extends pulumi.CustomResource { */ export interface UserPoolGroupArgs { /** - * A string containing the description of the group. + * A description of the group that you're creating. */ description?: pulumi.Input; /** - * The name of the group. Must be unique. + * A name for the group. This name must be unique in your user pool. */ groupName?: pulumi.Input; /** @@ -113,11 +113,11 @@ export interface UserPoolGroupArgs { */ precedence?: pulumi.Input; /** - * The role Amazon Resource Name (ARN) for the group. + * The Amazon Resource Name (ARN) for the IAM role that you want to associate with the group. A group role primarily declares a preferred role for the credentials that you get from an identity pool. Amazon Cognito ID tokens have a `cognito:preferred_role` claim that presents the highest-precedence group that a user belongs to. Both ID and access tokens also contain a `cognito:groups` claim that list all the groups that a user is a member of. */ roleArn?: pulumi.Input; /** - * The user pool ID for the user pool. + * The ID of the user pool where you want to create a user group. */ userPoolId: pulumi.Input; } diff --git a/sdk/nodejs/cognito/userPoolIdentityProvider.ts b/sdk/nodejs/cognito/userPoolIdentityProvider.ts index c41167628f..7e4d357079 100644 --- a/sdk/nodejs/cognito/userPoolIdentityProvider.ts +++ b/sdk/nodejs/cognito/userPoolIdentityProvider.ts @@ -35,11 +35,11 @@ export class UserPoolIdentityProvider extends pulumi.CustomResource { } /** - * A mapping of IdP attributes to standard and custom user pool attributes. + * A mapping of IdP attributes to standard and custom user pool attributes. Specify a user pool attribute as the key of the key-value pair, and the IdP attribute claim name as the value. */ public readonly attributeMapping!: pulumi.Output<{[key: string]: string} | undefined>; /** - * A list of IdP identifiers. + * An array of IdP identifiers, for example `"IdPIdentifiers": [ "MyIdP", "MyIdP2" ]` . Identifiers are friendly names that you can pass in the `idp_identifier` query parameter of requests to the [Authorize endpoint](https://docs.aws.amazon.com/cognito/latest/developerguide/authorization-endpoint.html) to silently redirect to sign-in with the associated IdP. Identifiers in a domain format also enable the use of [email-address matching with SAML providers](https://docs.aws.amazon.com/cognito/latest/developerguide/cognito-user-pools-managing-saml-idp-naming.html) . */ public readonly idpIdentifiers!: pulumi.Output; /** @@ -75,15 +75,15 @@ export class UserPoolIdentityProvider extends pulumi.CustomResource { */ public readonly providerDetails!: pulumi.Output<{[key: string]: string}>; /** - * The IdP name. + * The name that you want to assign to the IdP. You can pass the identity provider name in the `identity_provider` query parameter of requests to the [Authorize endpoint](https://docs.aws.amazon.com/cognito/latest/developerguide/authorization-endpoint.html) to silently redirect to sign-in with the associated IdP. */ public readonly providerName!: pulumi.Output; /** - * The IdP type. + * The type of IdP that you want to add. Amazon Cognito supports OIDC, SAML 2.0, Login With Amazon, Sign In With Apple, Google, and Facebook IdPs. */ public readonly providerType!: pulumi.Output; /** - * The user pool ID. + * The Id of the user pool where you want to create an IdP. */ public readonly userPoolId!: pulumi.Output; @@ -133,11 +133,11 @@ export class UserPoolIdentityProvider extends pulumi.CustomResource { */ export interface UserPoolIdentityProviderArgs { /** - * A mapping of IdP attributes to standard and custom user pool attributes. + * A mapping of IdP attributes to standard and custom user pool attributes. Specify a user pool attribute as the key of the key-value pair, and the IdP attribute claim name as the value. */ attributeMapping?: pulumi.Input<{[key: string]: pulumi.Input}>; /** - * A list of IdP identifiers. + * An array of IdP identifiers, for example `"IdPIdentifiers": [ "MyIdP", "MyIdP2" ]` . Identifiers are friendly names that you can pass in the `idp_identifier` query parameter of requests to the [Authorize endpoint](https://docs.aws.amazon.com/cognito/latest/developerguide/authorization-endpoint.html) to silently redirect to sign-in with the associated IdP. Identifiers in a domain format also enable the use of [email-address matching with SAML providers](https://docs.aws.amazon.com/cognito/latest/developerguide/cognito-user-pools-managing-saml-idp-naming.html) . */ idpIdentifiers?: pulumi.Input[]>; /** @@ -173,15 +173,15 @@ export interface UserPoolIdentityProviderArgs { */ providerDetails: pulumi.Input<{[key: string]: pulumi.Input}>; /** - * The IdP name. + * The name that you want to assign to the IdP. You can pass the identity provider name in the `identity_provider` query parameter of requests to the [Authorize endpoint](https://docs.aws.amazon.com/cognito/latest/developerguide/authorization-endpoint.html) to silently redirect to sign-in with the associated IdP. */ providerName?: pulumi.Input; /** - * The IdP type. + * The type of IdP that you want to add. Amazon Cognito supports OIDC, SAML 2.0, Login With Amazon, Sign In With Apple, Google, and Facebook IdPs. */ providerType: pulumi.Input; /** - * The user pool ID. + * The Id of the user pool where you want to create an IdP. */ userPoolId: pulumi.Input; } diff --git a/sdk/nodejs/cognito/userPoolResourceServer.ts b/sdk/nodejs/cognito/userPoolResourceServer.ts index 66b74c37da..a3b9688d87 100644 --- a/sdk/nodejs/cognito/userPoolResourceServer.ts +++ b/sdk/nodejs/cognito/userPoolResourceServer.ts @@ -52,7 +52,7 @@ export class UserPoolResourceServer extends pulumi.CustomResource { */ public readonly scopes!: pulumi.Output; /** - * The user pool ID for the user pool. + * The ID of the user pool where you want to create a resource server. */ public readonly userPoolId!: pulumi.Output; @@ -109,7 +109,7 @@ export interface UserPoolResourceServerArgs { */ scopes?: pulumi.Input[]>; /** - * The user pool ID for the user pool. + * The ID of the user pool where you want to create a resource server. */ userPoolId: pulumi.Input; } diff --git a/sdk/nodejs/cognito/userPoolUiCustomizationAttachment.ts b/sdk/nodejs/cognito/userPoolUiCustomizationAttachment.ts index 55a8516ce5..ee2ee5fb92 100644 --- a/sdk/nodejs/cognito/userPoolUiCustomizationAttachment.ts +++ b/sdk/nodejs/cognito/userPoolUiCustomizationAttachment.ts @@ -43,7 +43,7 @@ export class UserPoolUiCustomizationAttachment extends pulumi.CustomResource { */ public readonly css!: pulumi.Output; /** - * The user pool ID for the user pool. + * The ID of the user pool. */ public readonly userPoolId!: pulumi.Output; @@ -92,7 +92,7 @@ export interface UserPoolUiCustomizationAttachmentArgs { */ css?: pulumi.Input; /** - * The user pool ID for the user pool. + * The ID of the user pool. */ userPoolId: pulumi.Input; } diff --git a/sdk/nodejs/cognito/userPoolUser.ts b/sdk/nodejs/cognito/userPoolUser.ts index 51ae335690..aa25f9f7c6 100644 --- a/sdk/nodejs/cognito/userPoolUser.ts +++ b/sdk/nodejs/cognito/userPoolUser.ts @@ -40,31 +40,31 @@ export class UserPoolUser extends pulumi.CustomResource { /** * A map of custom key-value pairs that you can provide as input for any custom workflows that this action triggers. * - * You create custom workflows by assigning AWS Lambda functions to user pool triggers. When you use the AdminCreateUser API action, Amazon Cognito invokes the function that is assigned to the *pre sign-up* trigger. When Amazon Cognito invokes this function, it passes a JSON payload, which the function receives as input. This payload contains a `clientMetadata` attribute, which provides the data that you assigned to the ClientMetadata parameter in your AdminCreateUser request. In your function code in AWS Lambda , you can process the `clientMetadata` value to enhance your workflow for your specific needs. + * You create custom workflows by assigning AWS Lambda functions to user pool triggers. When you use the AdminCreateUser API action, Amazon Cognito invokes the function that is assigned to the *pre sign-up* trigger. When Amazon Cognito invokes this function, it passes a JSON payload, which the function receives as input. This payload contains a `ClientMetadata` attribute, which provides the data that you assigned to the ClientMetadata parameter in your AdminCreateUser request. In your function code in AWS Lambda , you can process the `clientMetadata` value to enhance your workflow for your specific needs. * * For more information, see [Customizing user pool Workflows with Lambda Triggers](https://docs.aws.amazon.com/cognito/latest/developerguide/cognito-user-identity-pools-working-with-aws-lambda-triggers.html) in the *Amazon Cognito Developer Guide* . * - * > When you use the ClientMetadata parameter, remember that Amazon Cognito won't do the following: + * > When you use the `ClientMetadata` parameter, note that Amazon Cognito won't do the following: * > - * > - Store the ClientMetadata value. This data is available only to AWS Lambda triggers that are assigned to a user pool to support custom workflows. If your user pool configuration doesn't include triggers, the ClientMetadata parameter serves no purpose. - * > - Validate the ClientMetadata value. - * > - Encrypt the ClientMetadata value. Don't use Amazon Cognito to provide sensitive information. + * > - Store the `ClientMetadata` value. This data is available only to AWS Lambda triggers that are assigned to a user pool to support custom workflows. If your user pool configuration doesn't include triggers, the `ClientMetadata` parameter serves no purpose. + * > - Validate the `ClientMetadata` value. + * > - Encrypt the `ClientMetadata` value. Don't send sensitive information in this parameter. */ public readonly clientMetadata!: pulumi.Output<{[key: string]: string} | undefined>; /** - * Specify `"EMAIL"` if email will be used to send the welcome message. Specify `"SMS"` if the phone number will be used. The default value is `"SMS"` . You can specify more than one value. + * Specify `EMAIL` if email will be used to send the welcome message. Specify `SMS` if the phone number will be used. The default value is `SMS` . You can specify more than one value. */ public readonly desiredDeliveryMediums!: pulumi.Output; /** * This parameter is used only if the `phone_number_verified` or `email_verified` attribute is set to `True` . Otherwise, it is ignored. * - * If this parameter is set to `True` and the phone number or email address specified in the UserAttributes parameter already exists as an alias with a different user, the API call will migrate the alias from the previous user to the newly created user. The previous user will no longer be able to log in using that alias. + * If this parameter is set to `True` and the phone number or email address specified in the `UserAttributes` parameter already exists as an alias with a different user, this request migrates the alias from the previous user to the newly-created user. The previous user will no longer be able to log in using that alias. * * If this parameter is set to `False` , the API throws an `AliasExistsException` error if the alias already exists. The default value is `False` . */ public readonly forceAliasCreation!: pulumi.Output; /** - * Set to `RESEND` to resend the invitation message to a user that already exists and reset the expiration limit on the user's account. Set to `SUPPRESS` to suppress sending the message. You can specify only one value. + * Set to `RESEND` to resend the invitation message to a user that already exists, and to reset the temporary-password duration with a new temporary password. Set to `SUPPRESS` to suppress sending the message. You can specify only one value. */ public readonly messageAction!: pulumi.Output; /** @@ -83,7 +83,7 @@ export class UserPoolUser extends pulumi.CustomResource { */ public readonly userAttributes!: pulumi.Output; /** - * The user pool ID for the user pool where the user will be created. + * The ID of the user pool where you want to create a user. */ public readonly userPoolId!: pulumi.Output; /** @@ -149,31 +149,31 @@ export interface UserPoolUserArgs { /** * A map of custom key-value pairs that you can provide as input for any custom workflows that this action triggers. * - * You create custom workflows by assigning AWS Lambda functions to user pool triggers. When you use the AdminCreateUser API action, Amazon Cognito invokes the function that is assigned to the *pre sign-up* trigger. When Amazon Cognito invokes this function, it passes a JSON payload, which the function receives as input. This payload contains a `clientMetadata` attribute, which provides the data that you assigned to the ClientMetadata parameter in your AdminCreateUser request. In your function code in AWS Lambda , you can process the `clientMetadata` value to enhance your workflow for your specific needs. + * You create custom workflows by assigning AWS Lambda functions to user pool triggers. When you use the AdminCreateUser API action, Amazon Cognito invokes the function that is assigned to the *pre sign-up* trigger. When Amazon Cognito invokes this function, it passes a JSON payload, which the function receives as input. This payload contains a `ClientMetadata` attribute, which provides the data that you assigned to the ClientMetadata parameter in your AdminCreateUser request. In your function code in AWS Lambda , you can process the `clientMetadata` value to enhance your workflow for your specific needs. * * For more information, see [Customizing user pool Workflows with Lambda Triggers](https://docs.aws.amazon.com/cognito/latest/developerguide/cognito-user-identity-pools-working-with-aws-lambda-triggers.html) in the *Amazon Cognito Developer Guide* . * - * > When you use the ClientMetadata parameter, remember that Amazon Cognito won't do the following: + * > When you use the `ClientMetadata` parameter, note that Amazon Cognito won't do the following: * > - * > - Store the ClientMetadata value. This data is available only to AWS Lambda triggers that are assigned to a user pool to support custom workflows. If your user pool configuration doesn't include triggers, the ClientMetadata parameter serves no purpose. - * > - Validate the ClientMetadata value. - * > - Encrypt the ClientMetadata value. Don't use Amazon Cognito to provide sensitive information. + * > - Store the `ClientMetadata` value. This data is available only to AWS Lambda triggers that are assigned to a user pool to support custom workflows. If your user pool configuration doesn't include triggers, the `ClientMetadata` parameter serves no purpose. + * > - Validate the `ClientMetadata` value. + * > - Encrypt the `ClientMetadata` value. Don't send sensitive information in this parameter. */ clientMetadata?: pulumi.Input<{[key: string]: pulumi.Input}>; /** - * Specify `"EMAIL"` if email will be used to send the welcome message. Specify `"SMS"` if the phone number will be used. The default value is `"SMS"` . You can specify more than one value. + * Specify `EMAIL` if email will be used to send the welcome message. Specify `SMS` if the phone number will be used. The default value is `SMS` . You can specify more than one value. */ desiredDeliveryMediums?: pulumi.Input[]>; /** * This parameter is used only if the `phone_number_verified` or `email_verified` attribute is set to `True` . Otherwise, it is ignored. * - * If this parameter is set to `True` and the phone number or email address specified in the UserAttributes parameter already exists as an alias with a different user, the API call will migrate the alias from the previous user to the newly created user. The previous user will no longer be able to log in using that alias. + * If this parameter is set to `True` and the phone number or email address specified in the `UserAttributes` parameter already exists as an alias with a different user, this request migrates the alias from the previous user to the newly-created user. The previous user will no longer be able to log in using that alias. * * If this parameter is set to `False` , the API throws an `AliasExistsException` error if the alias already exists. The default value is `False` . */ forceAliasCreation?: pulumi.Input; /** - * Set to `RESEND` to resend the invitation message to a user that already exists and reset the expiration limit on the user's account. Set to `SUPPRESS` to suppress sending the message. You can specify only one value. + * Set to `RESEND` to resend the invitation message to a user that already exists, and to reset the temporary-password duration with a new temporary password. Set to `SUPPRESS` to suppress sending the message. You can specify only one value. */ messageAction?: pulumi.Input; /** @@ -192,7 +192,7 @@ export interface UserPoolUserArgs { */ userAttributes?: pulumi.Input[]>; /** - * The user pool ID for the user pool where the user will be created. + * The ID of the user pool where you want to create a user. */ userPoolId: pulumi.Input; /** diff --git a/sdk/nodejs/cognito/userPoolUserToGroupAttachment.ts b/sdk/nodejs/cognito/userPoolUserToGroupAttachment.ts index 3ccd5130b1..c99c0dc332 100644 --- a/sdk/nodejs/cognito/userPoolUserToGroupAttachment.ts +++ b/sdk/nodejs/cognito/userPoolUserToGroupAttachment.ts @@ -39,7 +39,7 @@ export class UserPoolUserToGroupAttachment extends pulumi.CustomResource { */ public readonly groupName!: pulumi.Output; /** - * The user pool ID for the user pool. + * The ID of the user pool that contains the group that you want to add the user to. */ public readonly userPoolId!: pulumi.Output; /** @@ -91,7 +91,7 @@ export interface UserPoolUserToGroupAttachmentArgs { */ groupName: pulumi.Input; /** - * The user pool ID for the user pool. + * The ID of the user pool that contains the group that you want to add the user to. */ userPoolId: pulumi.Input; /** diff --git a/sdk/nodejs/connect/getTaskTemplate.ts b/sdk/nodejs/connect/getTaskTemplate.ts index 1218ffe852..7c25f73df8 100644 --- a/sdk/nodejs/connect/getTaskTemplate.ts +++ b/sdk/nodejs/connect/getTaskTemplate.ts @@ -61,6 +61,10 @@ export interface GetTaskTemplateResult { * The name of the task template. */ readonly name?: string; + /** + * The identifier of the contact flow. + */ + readonly selfAssignContactFlowArn?: string; /** * The status of the task template. */ diff --git a/sdk/nodejs/connect/taskTemplate.ts b/sdk/nodejs/connect/taskTemplate.ts index 5a3336da73..f882e328d3 100644 --- a/sdk/nodejs/connect/taskTemplate.ts +++ b/sdk/nodejs/connect/taskTemplate.ts @@ -73,6 +73,10 @@ export class TaskTemplate extends pulumi.CustomResource { * The name of the task template. */ public readonly name!: pulumi.Output; + /** + * The identifier of the contact flow. + */ + public readonly selfAssignContactFlowArn!: pulumi.Output; /** * The status of the task template. */ @@ -104,6 +108,7 @@ export class TaskTemplate extends pulumi.CustomResource { resourceInputs["fields"] = args ? args.fields : undefined; resourceInputs["instanceArn"] = args ? args.instanceArn : undefined; resourceInputs["name"] = args ? args.name : undefined; + resourceInputs["selfAssignContactFlowArn"] = args ? args.selfAssignContactFlowArn : undefined; resourceInputs["status"] = args ? args.status : undefined; resourceInputs["tags"] = args ? args.tags : undefined; resourceInputs["arn"] = undefined /*out*/; @@ -117,6 +122,7 @@ export class TaskTemplate extends pulumi.CustomResource { resourceInputs["fields"] = undefined /*out*/; resourceInputs["instanceArn"] = undefined /*out*/; resourceInputs["name"] = undefined /*out*/; + resourceInputs["selfAssignContactFlowArn"] = undefined /*out*/; resourceInputs["status"] = undefined /*out*/; resourceInputs["tags"] = undefined /*out*/; } @@ -161,6 +167,10 @@ export interface TaskTemplateArgs { * The name of the task template. */ name?: pulumi.Input; + /** + * The identifier of the contact flow. + */ + selfAssignContactFlowArn?: pulumi.Input; /** * The status of the task template. */ diff --git a/sdk/nodejs/dynamodb/table.ts b/sdk/nodejs/dynamodb/table.ts index ca197f314d..9748690e50 100644 --- a/sdk/nodejs/dynamodb/table.ts +++ b/sdk/nodejs/dynamodb/table.ts @@ -306,8 +306,8 @@ export class Table extends pulumi.CustomResource { */ public readonly globalSecondaryIndexes!: pulumi.Output; /** - * Specifies the properties of data being imported from the S3 bucket source to the table. - * 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. + * Specifies the properties of data being imported from the S3 bucket source to the" table. + * 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. */ public readonly importSourceSpecification!: pulumi.Output; /** @@ -482,8 +482,8 @@ export interface TableArgs { */ globalSecondaryIndexes?: pulumi.Input[]>; /** - * Specifies the properties of data being imported from the S3 bucket source to the table. - * 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. + * Specifies the properties of data being imported from the S3 bucket source to the" table. + * 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. */ importSourceSpecification?: pulumi.Input; /** diff --git a/sdk/nodejs/ec2/launchTemplate.ts b/sdk/nodejs/ec2/launchTemplate.ts index 9f8891347c..a0a732adbd 100644 --- a/sdk/nodejs/ec2/launchTemplate.ts +++ b/sdk/nodejs/ec2/launchTemplate.ts @@ -67,7 +67,7 @@ export class LaunchTemplate extends pulumi.CustomResource { public readonly launchTemplateName!: pulumi.Output; /** * The tags to apply to the launch template on creation. To tag the launch template, the resource type must be ``launch-template``. - * To specify the tags for resources that are created during instance launch, use [TagSpecifications](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-launchtemplate-launchtemplatedata.html#cfn-ec2-launchtemplate-launchtemplatedata-tagspecifications). + * To specify the tags for the resources that are created when an instance is launched, you must use [TagSpecifications](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-launchtemplate-launchtemplatedata.html#cfn-ec2-launchtemplate-launchtemplatedata-tagspecifications). */ public readonly tagSpecifications!: pulumi.Output; /** @@ -126,7 +126,7 @@ export interface LaunchTemplateArgs { launchTemplateName?: pulumi.Input; /** * The tags to apply to the launch template on creation. To tag the launch template, the resource type must be ``launch-template``. - * To specify the tags for resources that are created during instance launch, use [TagSpecifications](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-launchtemplate-launchtemplatedata.html#cfn-ec2-launchtemplate-launchtemplatedata-tagspecifications). + * To specify the tags for the resources that are created when an instance is launched, you must use [TagSpecifications](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-launchtemplate-launchtemplatedata.html#cfn-ec2-launchtemplate-launchtemplatedata-tagspecifications). */ tagSpecifications?: pulumi.Input[]>; /** diff --git a/sdk/nodejs/ecs/taskDefinition.ts b/sdk/nodejs/ecs/taskDefinition.ts index 05e9a864ff..6b8826f3c6 100644 --- a/sdk/nodejs/ecs/taskDefinition.ts +++ b/sdk/nodejs/ecs/taskDefinition.ts @@ -238,6 +238,7 @@ export class TaskDefinition extends pulumi.CustomResource { * This option requires Linux platform ``1.4.0`` or later. */ public readonly cpu!: pulumi.Output; + public readonly enableFaultInjection!: pulumi.Output; /** * The ephemeral storage settings to use for tasks run with the task definition. */ @@ -359,6 +360,7 @@ export class TaskDefinition extends pulumi.CustomResource { if (!opts.id) { resourceInputs["containerDefinitions"] = args ? args.containerDefinitions : undefined; resourceInputs["cpu"] = args ? args.cpu : undefined; + resourceInputs["enableFaultInjection"] = args ? args.enableFaultInjection : undefined; resourceInputs["ephemeralStorage"] = args ? args.ephemeralStorage : undefined; resourceInputs["executionRoleArn"] = args ? args.executionRoleArn : undefined; resourceInputs["family"] = args ? args.family : undefined; @@ -378,6 +380,7 @@ export class TaskDefinition extends pulumi.CustomResource { } else { resourceInputs["containerDefinitions"] = undefined /*out*/; resourceInputs["cpu"] = undefined /*out*/; + resourceInputs["enableFaultInjection"] = undefined /*out*/; resourceInputs["ephemeralStorage"] = undefined /*out*/; resourceInputs["executionRoleArn"] = undefined /*out*/; resourceInputs["family"] = undefined /*out*/; @@ -396,7 +399,7 @@ export class TaskDefinition extends pulumi.CustomResource { resourceInputs["volumes"] = undefined /*out*/; } opts = pulumi.mergeOptions(utilities.resourceOptsDefaults(), opts); - const replaceOnChanges = { replaceOnChanges: ["containerDefinitions[*]", "cpu", "ephemeralStorage", "executionRoleArn", "family", "inferenceAccelerators[*]", "ipcMode", "memory", "networkMode", "pidMode", "placementConstraints[*]", "proxyConfiguration", "requiresCompatibilities[*]", "runtimePlatform", "taskRoleArn", "volumes[*]"] }; + const replaceOnChanges = { replaceOnChanges: ["containerDefinitions[*]", "cpu", "enableFaultInjection", "ephemeralStorage", "executionRoleArn", "family", "inferenceAccelerators[*]", "ipcMode", "memory", "networkMode", "pidMode", "placementConstraints[*]", "proxyConfiguration", "requiresCompatibilities[*]", "runtimePlatform", "taskRoleArn", "volumes[*]"] }; opts = pulumi.mergeOptions(opts, replaceOnChanges); super(TaskDefinition.__pulumiType, name, resourceInputs, opts); } @@ -425,6 +428,7 @@ export interface TaskDefinitionArgs { * This option requires Linux platform ``1.4.0`` or later. */ cpu?: pulumi.Input; + enableFaultInjection?: pulumi.Input; /** * The ephemeral storage settings to use for tasks run with the task definition. */ diff --git a/sdk/nodejs/index.ts b/sdk/nodejs/index.ts index 2d538fdd6c..2f0891a8f2 100644 --- a/sdk/nodejs/index.ts +++ b/sdk/nodejs/index.ts @@ -252,6 +252,7 @@ import * as s3 from "./s3"; import * as s3express from "./s3express"; import * as s3objectlambda from "./s3objectlambda"; import * as s3outposts from "./s3outposts"; +import * as s3tables from "./s3tables"; import * as sagemaker from "./sagemaker"; import * as scheduler from "./scheduler"; import * as secretsmanager from "./secretsmanager"; @@ -475,6 +476,7 @@ export { s3express, s3objectlambda, s3outposts, + s3tables, sagemaker, scheduler, secretsmanager, diff --git a/sdk/nodejs/internetmonitor/getMonitor.ts b/sdk/nodejs/internetmonitor/getMonitor.ts index b46f128de5..3ab54e4d50 100644 --- a/sdk/nodejs/internetmonitor/getMonitor.ts +++ b/sdk/nodejs/internetmonitor/getMonitor.ts @@ -32,7 +32,7 @@ export interface GetMonitorResult { /** * A complex type with the configuration information that determines the threshold and other conditions for when Internet Monitor creates a health event for an overall performance or availability issue, across an application's geographies. * - * Defines the percentages, for overall performance scores and availability scores for an application, that are the thresholds for when Amazon CloudWatch Internet Monitor creates a health event. You can override the defaults to set a custom threshold for overall performance or availability scores, or both. + * Defines the percentages, for overall performance scores and availability scores for an application, that are the thresholds for when Internet Monitor creates a health event. You can override the defaults to set a custom threshold for overall performance or availability scores, or both. * * You can also set thresholds for local health scores,, where Internet Monitor creates a health event when scores cross a threshold for one or more city-networks, in addition to creating an event when an overall score crosses a threshold. * diff --git a/sdk/nodejs/internetmonitor/monitor.ts b/sdk/nodejs/internetmonitor/monitor.ts index 0ca01db82c..4d4161fff7 100644 --- a/sdk/nodejs/internetmonitor/monitor.ts +++ b/sdk/nodejs/internetmonitor/monitor.ts @@ -44,7 +44,7 @@ export class Monitor extends pulumi.CustomResource { /** * A complex type with the configuration information that determines the threshold and other conditions for when Internet Monitor creates a health event for an overall performance or availability issue, across an application's geographies. * - * Defines the percentages, for overall performance scores and availability scores for an application, that are the thresholds for when Amazon CloudWatch Internet Monitor creates a health event. You can override the defaults to set a custom threshold for overall performance or availability scores, or both. + * Defines the percentages, for overall performance scores and availability scores for an application, that are the thresholds for when Internet Monitor creates a health event. You can override the defaults to set a custom threshold for overall performance or availability scores, or both. * * You can also set thresholds for local health scores,, where Internet Monitor creates a health event when scores cross a threshold for one or more city-networks, in addition to creating an event when an overall score crosses a threshold. * @@ -189,7 +189,7 @@ export interface MonitorArgs { /** * A complex type with the configuration information that determines the threshold and other conditions for when Internet Monitor creates a health event for an overall performance or availability issue, across an application's geographies. * - * Defines the percentages, for overall performance scores and availability scores for an application, that are the thresholds for when Amazon CloudWatch Internet Monitor creates a health event. You can override the defaults to set a custom threshold for overall performance or availability scores, or both. + * Defines the percentages, for overall performance scores and availability scores for an application, that are the thresholds for when Internet Monitor creates a health event. You can override the defaults to set a custom threshold for overall performance or availability scores, or both. * * You can also set thresholds for local health scores,, where Internet Monitor creates a health event when scores cross a threshold for one or more city-networks, in addition to creating an event when an overall score crosses a threshold. * diff --git a/sdk/nodejs/invoicing/getInvoiceUnit.ts b/sdk/nodejs/invoicing/getInvoiceUnit.ts index 6a908294e2..78d00dd2c4 100644 --- a/sdk/nodejs/invoicing/getInvoiceUnit.ts +++ b/sdk/nodejs/invoicing/getInvoiceUnit.ts @@ -18,15 +18,36 @@ export function getInvoiceUnit(args: GetInvoiceUnitArgs, opts?: pulumi.InvokeOpt } export interface GetInvoiceUnitArgs { + /** + * The ARN to identify an invoice unit. This information can't be modified or deleted. + */ invoiceUnitArn: string; } export interface GetInvoiceUnitResult { + /** + * The assigned description for an invoice unit. This information can't be modified or deleted. + */ readonly description?: string; + /** + * The ARN to identify an invoice unit. This information can't be modified or deleted. + */ readonly invoiceUnitArn?: string; + /** + * The last time the invoice unit was updated. This is important to determine the version of invoice unit configuration used to create the invoices. Any invoice created after this modified time will use this invoice unit configuration. + */ readonly lastModified?: number; + /** + * The tag structure that contains a tag key and value. + */ readonly resourceTags?: outputs.Tag[]; + /** + * An `InvoiceUnitRule` object used the categorize invoice units. + */ readonly rule?: outputs.invoicing.InvoiceUnitRule; + /** + * Whether the invoice unit based tax inheritance is/ should be enabled or disabled. + */ readonly taxInheritanceDisabled?: boolean; } /** @@ -40,5 +61,8 @@ export function getInvoiceUnitOutput(args: GetInvoiceUnitOutputArgs, opts?: pulu } export interface GetInvoiceUnitOutputArgs { + /** + * The ARN to identify an invoice unit. This information can't be modified or deleted. + */ invoiceUnitArn: pulumi.Input; } diff --git a/sdk/nodejs/invoicing/invoiceUnit.ts b/sdk/nodejs/invoicing/invoiceUnit.ts index e875a6bf00..112d34e75b 100644 --- a/sdk/nodejs/invoicing/invoiceUnit.ts +++ b/sdk/nodejs/invoicing/invoiceUnit.ts @@ -37,13 +37,37 @@ export class InvoiceUnit extends pulumi.CustomResource { return obj['__pulumiType'] === InvoiceUnit.__pulumiType; } + /** + * The assigned description for an invoice unit. This information can't be modified or deleted. + */ public readonly description!: pulumi.Output; + /** + * The account that receives invoices related to the invoice unit. + */ public readonly invoiceReceiver!: pulumi.Output; + /** + * The ARN to identify an invoice unit. This information can't be modified or deleted. + */ public /*out*/ readonly invoiceUnitArn!: pulumi.Output; + /** + * The last time the invoice unit was updated. This is important to determine the version of invoice unit configuration used to create the invoices. Any invoice created after this modified time will use this invoice unit configuration. + */ public /*out*/ readonly lastModified!: pulumi.Output; + /** + * A unique name that is distinctive within your AWS . + */ public readonly name!: pulumi.Output; + /** + * The tag structure that contains a tag key and value. + */ public readonly resourceTags!: pulumi.Output; + /** + * An `InvoiceUnitRule` object used the categorize invoice units. + */ public readonly rule!: pulumi.Output; + /** + * Whether the invoice unit based tax inheritance is/ should be enabled or disabled. + */ public readonly taxInheritanceDisabled!: pulumi.Output; /** @@ -92,10 +116,28 @@ export class InvoiceUnit extends pulumi.CustomResource { * The set of arguments for constructing a InvoiceUnit resource. */ export interface InvoiceUnitArgs { + /** + * The assigned description for an invoice unit. This information can't be modified or deleted. + */ description?: pulumi.Input; + /** + * The account that receives invoices related to the invoice unit. + */ invoiceReceiver: pulumi.Input; + /** + * A unique name that is distinctive within your AWS . + */ name?: pulumi.Input; + /** + * The tag structure that contains a tag key and value. + */ resourceTags?: pulumi.Input[]>; + /** + * An `InvoiceUnitRule` object used the categorize invoice units. + */ rule: pulumi.Input; + /** + * Whether the invoice unit based tax inheritance is/ should be enabled or disabled. + */ taxInheritanceDisabled?: pulumi.Input; } diff --git a/sdk/nodejs/iot/command.ts b/sdk/nodejs/iot/command.ts new file mode 100644 index 0000000000..84a406b8d6 --- /dev/null +++ b/sdk/nodejs/iot/command.ts @@ -0,0 +1,194 @@ +// *** WARNING: this file was generated by pulumi-language-nodejs. *** +// *** Do not edit by hand unless you're certain you know what you are doing! *** + +import * as pulumi from "@pulumi/pulumi"; +import * as inputs from "../types/input"; +import * as outputs from "../types/output"; +import * as enums from "../types/enums"; +import * as utilities from "../utilities"; + +/** + * Represents the resource definition of AWS IoT Command. + */ +export class Command extends pulumi.CustomResource { + /** + * Get an existing Command resource's state with the given name, ID, and optional extra + * properties used to qualify the lookup. + * + * @param name The _unique_ name of the resulting resource. + * @param id The _unique_ provider ID of the resource to lookup. + * @param opts Optional settings to control the behavior of the CustomResource. + */ + public static get(name: string, id: pulumi.Input, opts?: pulumi.CustomResourceOptions): Command { + return new Command(name, undefined as any, { ...opts, id: id }); + } + + /** @internal */ + public static readonly __pulumiType = 'aws-native:iot:Command'; + + /** + * Returns true if the given object is an instance of Command. This is designed to work even + * when multiple copies of the Pulumi SDK have been loaded into the same process. + */ + public static isInstance(obj: any): obj is Command { + if (obj === undefined || obj === null) { + return false; + } + return obj['__pulumiType'] === Command.__pulumiType; + } + + /** + * The Amazon Resource Name (ARN) of the command. + */ + public /*out*/ readonly commandArn!: pulumi.Output; + /** + * The unique identifier for the command. + */ + public readonly commandId!: pulumi.Output; + /** + * The date and time when the command was created. + */ + public readonly createdAt!: pulumi.Output; + /** + * A flag indicating whether the command is deprecated. + */ + public readonly deprecated!: pulumi.Output; + /** + * The description of the command. + */ + public readonly description!: pulumi.Output; + /** + * The display name for the command. + */ + public readonly displayName!: pulumi.Output; + /** + * The date and time when the command was last updated. + */ + public readonly lastUpdatedAt!: pulumi.Output; + /** + * The list of mandatory parameters for the command. + */ + public readonly mandatoryParameters!: pulumi.Output; + /** + * The namespace to which the command belongs. + */ + public readonly namespace!: pulumi.Output; + /** + * The payload associated with the command. + */ + public readonly payload!: pulumi.Output; + /** + * A flag indicating whether the command is pending deletion. + */ + public readonly pendingDeletion!: pulumi.Output; + /** + * The customer role associated with the command. + */ + public readonly roleArn!: pulumi.Output; + /** + * The tags to be associated with the command. + */ + public readonly tags!: pulumi.Output; + + /** + * Create a Command resource with the given unique name, arguments, and options. + * + * @param name The _unique_ name of the resource. + * @param args The arguments to use to populate this resource's properties. + * @param opts A bag of options that control this resource's behavior. + */ + constructor(name: string, args: CommandArgs, opts?: pulumi.CustomResourceOptions) { + let resourceInputs: pulumi.Inputs = {}; + opts = opts || {}; + if (!opts.id) { + if ((!args || args.commandId === undefined) && !opts.urn) { + throw new Error("Missing required property 'commandId'"); + } + resourceInputs["commandId"] = args ? args.commandId : undefined; + resourceInputs["createdAt"] = args ? args.createdAt : undefined; + resourceInputs["deprecated"] = args ? args.deprecated : undefined; + resourceInputs["description"] = args ? args.description : undefined; + resourceInputs["displayName"] = args ? args.displayName : undefined; + resourceInputs["lastUpdatedAt"] = args ? args.lastUpdatedAt : undefined; + resourceInputs["mandatoryParameters"] = args ? args.mandatoryParameters : undefined; + resourceInputs["namespace"] = args ? args.namespace : undefined; + resourceInputs["payload"] = args ? args.payload : undefined; + resourceInputs["pendingDeletion"] = args ? args.pendingDeletion : undefined; + resourceInputs["roleArn"] = args ? args.roleArn : undefined; + resourceInputs["tags"] = args ? args.tags : undefined; + resourceInputs["commandArn"] = undefined /*out*/; + } else { + resourceInputs["commandArn"] = undefined /*out*/; + resourceInputs["commandId"] = undefined /*out*/; + resourceInputs["createdAt"] = undefined /*out*/; + resourceInputs["deprecated"] = undefined /*out*/; + resourceInputs["description"] = undefined /*out*/; + resourceInputs["displayName"] = undefined /*out*/; + resourceInputs["lastUpdatedAt"] = undefined /*out*/; + resourceInputs["mandatoryParameters"] = undefined /*out*/; + resourceInputs["namespace"] = undefined /*out*/; + resourceInputs["payload"] = undefined /*out*/; + resourceInputs["pendingDeletion"] = undefined /*out*/; + resourceInputs["roleArn"] = undefined /*out*/; + resourceInputs["tags"] = undefined /*out*/; + } + opts = pulumi.mergeOptions(utilities.resourceOptsDefaults(), opts); + const replaceOnChanges = { replaceOnChanges: ["commandId"] }; + opts = pulumi.mergeOptions(opts, replaceOnChanges); + super(Command.__pulumiType, name, resourceInputs, opts); + } +} + +/** + * The set of arguments for constructing a Command resource. + */ +export interface CommandArgs { + /** + * The unique identifier for the command. + */ + commandId: pulumi.Input; + /** + * The date and time when the command was created. + */ + createdAt?: pulumi.Input; + /** + * A flag indicating whether the command is deprecated. + */ + deprecated?: pulumi.Input; + /** + * The description of the command. + */ + description?: pulumi.Input; + /** + * The display name for the command. + */ + displayName?: pulumi.Input; + /** + * The date and time when the command was last updated. + */ + lastUpdatedAt?: pulumi.Input; + /** + * The list of mandatory parameters for the command. + */ + mandatoryParameters?: pulumi.Input[]>; + /** + * The namespace to which the command belongs. + */ + namespace?: pulumi.Input; + /** + * The payload associated with the command. + */ + payload?: pulumi.Input; + /** + * A flag indicating whether the command is pending deletion. + */ + pendingDeletion?: pulumi.Input; + /** + * The customer role associated with the command. + */ + roleArn?: pulumi.Input; + /** + * The tags to be associated with the command. + */ + tags?: pulumi.Input[]>; +} diff --git a/sdk/nodejs/iot/getCommand.ts b/sdk/nodejs/iot/getCommand.ts new file mode 100644 index 0000000000..79a20457cb --- /dev/null +++ b/sdk/nodejs/iot/getCommand.ts @@ -0,0 +1,88 @@ +// *** WARNING: this file was generated by pulumi-language-nodejs. *** +// *** Do not edit by hand unless you're certain you know what you are doing! *** + +import * as pulumi from "@pulumi/pulumi"; +import * as inputs from "../types/input"; +import * as outputs from "../types/output"; +import * as enums from "../types/enums"; +import * as utilities from "../utilities"; + +/** + * Represents the resource definition of AWS IoT Command. + */ +export function getCommand(args: GetCommandArgs, opts?: pulumi.InvokeOptions): Promise { + opts = pulumi.mergeOptions(utilities.resourceOptsDefaults(), opts || {}); + return pulumi.runtime.invoke("aws-native:iot:getCommand", { + "commandId": args.commandId, + }, opts); +} + +export interface GetCommandArgs { + /** + * The unique identifier for the command. + */ + commandId: string; +} + +export interface GetCommandResult { + /** + * The Amazon Resource Name (ARN) of the command. + */ + readonly commandArn?: string; + /** + * The date and time when the command was created. + */ + readonly createdAt?: string; + /** + * A flag indicating whether the command is deprecated. + */ + readonly deprecated?: boolean; + /** + * The description of the command. + */ + readonly description?: string; + /** + * The display name for the command. + */ + readonly displayName?: string; + /** + * The list of mandatory parameters for the command. + */ + readonly mandatoryParameters?: outputs.iot.CommandParameter[]; + /** + * The namespace to which the command belongs. + */ + readonly namespace?: enums.iot.CommandNamespace; + /** + * The payload associated with the command. + */ + readonly payload?: outputs.iot.CommandPayload; + /** + * A flag indicating whether the command is pending deletion. + */ + readonly pendingDeletion?: boolean; + /** + * The customer role associated with the command. + */ + readonly roleArn?: string; + /** + * The tags to be associated with the command. + */ + readonly tags?: outputs.Tag[]; +} +/** + * Represents the resource definition of AWS IoT Command. + */ +export function getCommandOutput(args: GetCommandOutputArgs, opts?: pulumi.InvokeOutputOptions): pulumi.Output { + opts = pulumi.mergeOptions(utilities.resourceOptsDefaults(), opts || {}); + return pulumi.runtime.invokeOutput("aws-native:iot:getCommand", { + "commandId": args.commandId, + }, opts); +} + +export interface GetCommandOutputArgs { + /** + * The unique identifier for the command. + */ + commandId: pulumi.Input; +} diff --git a/sdk/nodejs/iot/index.ts b/sdk/nodejs/iot/index.ts index 179e3f1166..b4c747012c 100644 --- a/sdk/nodejs/iot/index.ts +++ b/sdk/nodejs/iot/index.ts @@ -35,6 +35,11 @@ export type CertificateProvider = import("./certificateProvider").CertificatePro export const CertificateProvider: typeof import("./certificateProvider").CertificateProvider = null as any; utilities.lazyLoad(exports, ["CertificateProvider"], () => require("./certificateProvider")); +export { CommandArgs } from "./command"; +export type Command = import("./command").Command; +export const Command: typeof import("./command").Command = null as any; +utilities.lazyLoad(exports, ["Command"], () => require("./command")); + export { CustomMetricArgs } from "./customMetric"; export type CustomMetric = import("./customMetric").CustomMetric; export const CustomMetric: typeof import("./customMetric").CustomMetric = null as any; @@ -85,6 +90,11 @@ export const getCertificateProvider: typeof import("./getCertificateProvider").g export const getCertificateProviderOutput: typeof import("./getCertificateProvider").getCertificateProviderOutput = null as any; utilities.lazyLoad(exports, ["getCertificateProvider","getCertificateProviderOutput"], () => require("./getCertificateProvider")); +export { GetCommandArgs, GetCommandResult, GetCommandOutputArgs } from "./getCommand"; +export const getCommand: typeof import("./getCommand").getCommand = null as any; +export const getCommandOutput: typeof import("./getCommand").getCommandOutput = null as any; +utilities.lazyLoad(exports, ["getCommand","getCommandOutput"], () => require("./getCommand")); + export { GetCustomMetricArgs, GetCustomMetricResult, GetCustomMetricOutputArgs } from "./getCustomMetric"; export const getCustomMetric: typeof import("./getCustomMetric").getCustomMetric = null as any; export const getCustomMetricOutput: typeof import("./getCustomMetric").getCustomMetricOutput = null as any; @@ -285,6 +295,8 @@ const _module = { return new Certificate(name, undefined, { urn }) case "aws-native:iot:CertificateProvider": return new CertificateProvider(name, undefined, { urn }) + case "aws-native:iot:Command": + return new Command(name, undefined, { urn }) case "aws-native:iot:CustomMetric": return new CustomMetric(name, undefined, { urn }) case "aws-native:iot:Dimension": diff --git a/sdk/nodejs/organizations/policy.ts b/sdk/nodejs/organizations/policy.ts index b685c7f99d..a612829b2b 100644 --- a/sdk/nodejs/organizations/policy.ts +++ b/sdk/nodejs/organizations/policy.ts @@ -72,7 +72,7 @@ export class Policy extends pulumi.CustomResource { */ public readonly targetIds!: pulumi.Output; /** - * The type of policy to create. You can specify one of the following values: AISERVICES_OPT_OUT_POLICY, BACKUP_POLICY, SERVICE_CONTROL_POLICY, TAG_POLICY, CHATBOT_POLICY, RESOURCE_CONTROL_POLICY + * The type of policy to create. You can specify one of the following values: AISERVICES_OPT_OUT_POLICY, BACKUP_POLICY, SERVICE_CONTROL_POLICY, TAG_POLICY, CHATBOT_POLICY, RESOURCE_CONTROL_POLICY,DECLARATIVE_POLICY_EC2 */ public readonly type!: pulumi.Output; @@ -147,7 +147,7 @@ export interface PolicyArgs { */ targetIds?: pulumi.Input[]>; /** - * The type of policy to create. You can specify one of the following values: AISERVICES_OPT_OUT_POLICY, BACKUP_POLICY, SERVICE_CONTROL_POLICY, TAG_POLICY, CHATBOT_POLICY, RESOURCE_CONTROL_POLICY + * The type of policy to create. You can specify one of the following values: AISERVICES_OPT_OUT_POLICY, BACKUP_POLICY, SERVICE_CONTROL_POLICY, TAG_POLICY, CHATBOT_POLICY, RESOURCE_CONTROL_POLICY,DECLARATIVE_POLICY_EC2 */ type: pulumi.Input; } diff --git a/sdk/nodejs/qbusiness/application.ts b/sdk/nodejs/qbusiness/application.ts index 66da780a6b..38420d29d0 100644 --- a/sdk/nodejs/qbusiness/application.ts +++ b/sdk/nodejs/qbusiness/application.ts @@ -53,6 +53,9 @@ export class Application extends pulumi.CustomResource { * Subscription configuration information for an Amazon Q Business application using IAM identity federation for user management. */ public readonly autoSubscriptionConfiguration!: pulumi.Output; + /** + * The OIDC client ID for a Amazon Q Business application. + */ public readonly clientIdsForOidc!: pulumi.Output; /** * The Unix timestamp when the Amazon Q Business application was created. @@ -189,6 +192,9 @@ export interface ApplicationArgs { * Subscription configuration information for an Amazon Q Business application using IAM identity federation for user management. */ autoSubscriptionConfiguration?: pulumi.Input; + /** + * The OIDC client ID for a Amazon Q Business application. + */ clientIdsForOidc?: pulumi.Input[]>; /** * A description for the Amazon Q Business application. diff --git a/sdk/nodejs/ram/getResourceShare.ts b/sdk/nodejs/ram/getResourceShare.ts new file mode 100644 index 0000000000..f0f60f6e9e --- /dev/null +++ b/sdk/nodejs/ram/getResourceShare.ts @@ -0,0 +1,60 @@ +// *** WARNING: this file was generated by pulumi-language-nodejs. *** +// *** Do not edit by hand unless you're certain you know what you are doing! *** + +import * as pulumi from "@pulumi/pulumi"; +import * as inputs from "../types/input"; +import * as outputs from "../types/output"; +import * as enums from "../types/enums"; +import * as utilities from "../utilities"; + +/** + * Resource type definition for AWS::RAM::ResourceShare + */ +export function getResourceShare(args: GetResourceShareArgs, opts?: pulumi.InvokeOptions): Promise { + opts = pulumi.mergeOptions(utilities.resourceOptsDefaults(), opts || {}); + return pulumi.runtime.invoke("aws-native:ram:getResourceShare", { + "arn": args.arn, + }, opts); +} + +export interface GetResourceShareArgs { + /** + * The Amazon Resource Name (ARN) of the resource share. + */ + arn: string; +} + +export interface GetResourceShareResult { + /** + * Specifies whether principals outside your organization in AWS Organizations can be associated with a resource share. A value of `true` lets you share with individual AWS accounts that are not in your organization. A value of `false` only has meaning if your account is a member of an AWS Organization. The default value is `true`. + */ + readonly allowExternalPrincipals?: boolean; + /** + * The Amazon Resource Name (ARN) of the resource share. + */ + readonly arn?: string; + /** + * Specifies the name of the resource share. + */ + readonly name?: string; + /** + * Specifies one or more tags to attach to the resource share itself. It doesn't attach the tags to the resources associated with the resource share. + */ + readonly tags?: outputs.Tag[]; +} +/** + * Resource type definition for AWS::RAM::ResourceShare + */ +export function getResourceShareOutput(args: GetResourceShareOutputArgs, opts?: pulumi.InvokeOutputOptions): pulumi.Output { + opts = pulumi.mergeOptions(utilities.resourceOptsDefaults(), opts || {}); + return pulumi.runtime.invokeOutput("aws-native:ram:getResourceShare", { + "arn": args.arn, + }, opts); +} + +export interface GetResourceShareOutputArgs { + /** + * The Amazon Resource Name (ARN) of the resource share. + */ + arn: pulumi.Input; +} diff --git a/sdk/nodejs/ram/index.ts b/sdk/nodejs/ram/index.ts index 6c83c9340b..cbbf368692 100644 --- a/sdk/nodejs/ram/index.ts +++ b/sdk/nodejs/ram/index.ts @@ -10,11 +10,21 @@ export const getPermission: typeof import("./getPermission").getPermission = nul export const getPermissionOutput: typeof import("./getPermission").getPermissionOutput = null as any; utilities.lazyLoad(exports, ["getPermission","getPermissionOutput"], () => require("./getPermission")); +export { GetResourceShareArgs, GetResourceShareResult, GetResourceShareOutputArgs } from "./getResourceShare"; +export const getResourceShare: typeof import("./getResourceShare").getResourceShare = null as any; +export const getResourceShareOutput: typeof import("./getResourceShare").getResourceShareOutput = null as any; +utilities.lazyLoad(exports, ["getResourceShare","getResourceShareOutput"], () => require("./getResourceShare")); + export { PermissionArgs } from "./permission"; export type Permission = import("./permission").Permission; export const Permission: typeof import("./permission").Permission = null as any; utilities.lazyLoad(exports, ["Permission"], () => require("./permission")); +export { ResourceShareArgs } from "./resourceShare"; +export type ResourceShare = import("./resourceShare").ResourceShare; +export const ResourceShare: typeof import("./resourceShare").ResourceShare = null as any; +utilities.lazyLoad(exports, ["ResourceShare"], () => require("./resourceShare")); + const _module = { version: utilities.getVersion(), @@ -22,6 +32,8 @@ const _module = { switch (type) { case "aws-native:ram:Permission": return new Permission(name, undefined, { urn }) + case "aws-native:ram:ResourceShare": + return new ResourceShare(name, undefined, { urn }) default: throw new Error(`unknown resource type ${type}`); } diff --git a/sdk/nodejs/ram/resourceShare.ts b/sdk/nodejs/ram/resourceShare.ts new file mode 100644 index 0000000000..4edf9ac4f0 --- /dev/null +++ b/sdk/nodejs/ram/resourceShare.ts @@ -0,0 +1,207 @@ +// *** WARNING: this file was generated by pulumi-language-nodejs. *** +// *** Do not edit by hand unless you're certain you know what you are doing! *** + +import * as pulumi from "@pulumi/pulumi"; +import * as inputs from "../types/input"; +import * as outputs from "../types/output"; +import * as enums from "../types/enums"; +import * as utilities from "../utilities"; + +/** + * Resource type definition for AWS::RAM::ResourceShare + * + * ## Example Usage + * ### Example + * + * ```typescript + * import * as pulumi from "@pulumi/pulumi"; + * import * as aws_native from "@pulumi/aws-native"; + * + * const myresourceshare = new aws_native.ram.ResourceShare("myresourceshare", { + * name: "My Resource Share", + * resourceArns: ["arn:aws:ec2:us-east-1:123456789012:resource-type/12345678-1234-1234-1234-12345678"], + * principals: ["210987654321"], + * tags: [ + * { + * key: "Key1", + * value: "Value1", + * }, + * { + * key: "Key2", + * value: "Value2", + * }, + * ], + * }); + * + * ``` + * ### Example + * + * ```typescript + * import * as pulumi from "@pulumi/pulumi"; + * import * as aws_native from "@pulumi/aws-native"; + * + * const myresourceshare = new aws_native.ram.ResourceShare("myresourceshare", { + * name: "My Resource Share", + * resourceArns: ["arn:aws:ec2:us-east-1:123456789012:resource-type/12345678-1234-1234-1234-12345678"], + * principals: ["210987654321"], + * tags: [ + * { + * key: "Key1", + * value: "Value1", + * }, + * { + * key: "Key2", + * value: "Value2", + * }, + * ], + * }); + * + * ``` + */ +export class ResourceShare extends pulumi.CustomResource { + /** + * Get an existing ResourceShare resource's state with the given name, ID, and optional extra + * properties used to qualify the lookup. + * + * @param name The _unique_ name of the resulting resource. + * @param id The _unique_ provider ID of the resource to lookup. + * @param opts Optional settings to control the behavior of the CustomResource. + */ + public static get(name: string, id: pulumi.Input, opts?: pulumi.CustomResourceOptions): ResourceShare { + return new ResourceShare(name, undefined as any, { ...opts, id: id }); + } + + /** @internal */ + public static readonly __pulumiType = 'aws-native:ram:ResourceShare'; + + /** + * Returns true if the given object is an instance of ResourceShare. This is designed to work even + * when multiple copies of the Pulumi SDK have been loaded into the same process. + */ + public static isInstance(obj: any): obj is ResourceShare { + if (obj === undefined || obj === null) { + return false; + } + return obj['__pulumiType'] === ResourceShare.__pulumiType; + } + + /** + * Specifies whether principals outside your organization in AWS Organizations can be associated with a resource share. A value of `true` lets you share with individual AWS accounts that are not in your organization. A value of `false` only has meaning if your account is a member of an AWS Organization. The default value is `true`. + */ + public readonly allowExternalPrincipals!: pulumi.Output; + /** + * The Amazon Resource Name (ARN) of the resource share. + */ + public /*out*/ readonly arn!: pulumi.Output; + /** + * Specifies the name of the resource share. + */ + public readonly name!: pulumi.Output; + /** + * Specifies the [Amazon Resource Names (ARNs)](https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html) of the AWS RAM permission to associate with the resource share. If you do not specify an ARN for the permission, AWS RAM automatically attaches the default version of the permission for each resource type. You can associate only one permission with each resource type included in the resource share. + */ + public readonly permissionArns!: pulumi.Output; + /** + * Specifies the principals to associate with the resource share. The possible values are: + * + * - An AWS account ID + * + * - An Amazon Resource Name (ARN) of an organization in AWS Organizations + * + * - An ARN of an organizational unit (OU) in AWS Organizations + * + * - An ARN of an IAM role + * + * - An ARN of an IAM user + */ + public readonly principals!: pulumi.Output; + /** + * Specifies a list of one or more ARNs of the resources to associate with the resource share. + */ + public readonly resourceArns!: pulumi.Output; + /** + * Specifies from which source accounts the service principal has access to the resources in this resource share. + */ + public readonly sources!: pulumi.Output; + /** + * Specifies one or more tags to attach to the resource share itself. It doesn't attach the tags to the resources associated with the resource share. + */ + public readonly tags!: pulumi.Output; + + /** + * Create a ResourceShare resource with the given unique name, arguments, and options. + * + * @param name The _unique_ name of the resource. + * @param args The arguments to use to populate this resource's properties. + * @param opts A bag of options that control this resource's behavior. + */ + constructor(name: string, args?: ResourceShareArgs, opts?: pulumi.CustomResourceOptions) { + let resourceInputs: pulumi.Inputs = {}; + opts = opts || {}; + if (!opts.id) { + resourceInputs["allowExternalPrincipals"] = args ? args.allowExternalPrincipals : undefined; + resourceInputs["name"] = args ? args.name : undefined; + resourceInputs["permissionArns"] = args ? args.permissionArns : undefined; + resourceInputs["principals"] = args ? args.principals : undefined; + resourceInputs["resourceArns"] = args ? args.resourceArns : undefined; + resourceInputs["sources"] = args ? args.sources : undefined; + resourceInputs["tags"] = args ? args.tags : undefined; + resourceInputs["arn"] = undefined /*out*/; + } else { + resourceInputs["allowExternalPrincipals"] = undefined /*out*/; + resourceInputs["arn"] = undefined /*out*/; + resourceInputs["name"] = undefined /*out*/; + resourceInputs["permissionArns"] = undefined /*out*/; + resourceInputs["principals"] = undefined /*out*/; + resourceInputs["resourceArns"] = undefined /*out*/; + resourceInputs["sources"] = undefined /*out*/; + resourceInputs["tags"] = undefined /*out*/; + } + opts = pulumi.mergeOptions(utilities.resourceOptsDefaults(), opts); + super(ResourceShare.__pulumiType, name, resourceInputs, opts); + } +} + +/** + * The set of arguments for constructing a ResourceShare resource. + */ +export interface ResourceShareArgs { + /** + * Specifies whether principals outside your organization in AWS Organizations can be associated with a resource share. A value of `true` lets you share with individual AWS accounts that are not in your organization. A value of `false` only has meaning if your account is a member of an AWS Organization. The default value is `true`. + */ + allowExternalPrincipals?: pulumi.Input; + /** + * Specifies the name of the resource share. + */ + name?: pulumi.Input; + /** + * Specifies the [Amazon Resource Names (ARNs)](https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html) of the AWS RAM permission to associate with the resource share. If you do not specify an ARN for the permission, AWS RAM automatically attaches the default version of the permission for each resource type. You can associate only one permission with each resource type included in the resource share. + */ + permissionArns?: pulumi.Input[]>; + /** + * Specifies the principals to associate with the resource share. The possible values are: + * + * - An AWS account ID + * + * - An Amazon Resource Name (ARN) of an organization in AWS Organizations + * + * - An ARN of an organizational unit (OU) in AWS Organizations + * + * - An ARN of an IAM role + * + * - An ARN of an IAM user + */ + principals?: pulumi.Input[]>; + /** + * Specifies a list of one or more ARNs of the resources to associate with the resource share. + */ + resourceArns?: pulumi.Input[]>; + /** + * Specifies from which source accounts the service principal has access to the resources in this resource share. + */ + sources?: pulumi.Input[]>; + /** + * Specifies one or more tags to attach to the resource share itself. It doesn't attach the tags to the resources associated with the resource share. + */ + tags?: pulumi.Input[]>; +} diff --git a/sdk/nodejs/rds/customDbEngineVersion.ts b/sdk/nodejs/rds/customDbEngineVersion.ts index 09c5e98f28..9fe2207019 100644 --- a/sdk/nodejs/rds/customDbEngineVersion.ts +++ b/sdk/nodejs/rds/customDbEngineVersion.ts @@ -8,7 +8,7 @@ import * as enums from "../types/enums"; import * as utilities from "../utilities"; /** - * The AWS::RDS::CustomDBEngineVersion resource creates an Amazon RDS custom DB engine version. + * Creates a custom DB engine version (CEV). */ export class CustomDbEngineVersion extends pulumi.CustomResource { /** @@ -38,11 +38,11 @@ export class CustomDbEngineVersion extends pulumi.CustomResource { } /** - * The name of an Amazon S3 bucket that contains database installation files for your CEV. For example, a valid bucket name is `my-custom-installation-files`. + * The name of an Amazon S3 bucket that contains database installation files for your CEV. For example, a valid bucket name is ``my-custom-installation-files``. */ public readonly databaseInstallationFilesS3BucketName!: pulumi.Output; /** - * The Amazon S3 directory that contains the database installation files for your CEV. For example, a valid bucket name is `123456789012/cev1`. If this setting isn't specified, no prefix is assumed. + * The Amazon S3 directory that contains the database installation files for your CEV. For example, a valid bucket name is ``123456789012/cev1``. If this setting isn't specified, no prefix is assumed. */ public readonly databaseInstallationFilesS3Prefix!: pulumi.Output; /** @@ -54,39 +54,49 @@ export class CustomDbEngineVersion extends pulumi.CustomResource { */ public readonly description!: pulumi.Output; /** - * The database engine to use for your custom engine version (CEV). The only supported value is `custom-oracle-ee`. + * The database engine to use for your custom engine version (CEV). + * Valid values: + * + ``custom-oracle-ee`` + * + ``custom-oracle-ee-cdb`` */ public readonly engine!: pulumi.Output; /** - * The name of your CEV. The name format is 19.customized_string . For example, a valid name is 19.my_cev1. This setting is required for RDS Custom for Oracle, but optional for Amazon RDS. The combination of Engine and EngineVersion is unique per customer per Region. + * The name of your CEV. The name format is ``major version.customized_string``. For example, a valid CEV name is ``19.my_cev1``. This setting is required for RDS Custom for Oracle, but optional for Amazon RDS. The combination of ``Engine`` and ``EngineVersion`` is unique per customer per Region. + * *Constraints:* Minimum length is 1. Maximum length is 60. + * *Pattern:* ``^[a-z0-9_.-]{1,60$``} */ public readonly engineVersion!: pulumi.Output; /** - * The identifier of Amazon Machine Image (AMI) used for CEV. + * A value that indicates the ID of the AMI. */ public readonly imageId!: pulumi.Output; /** - * The AWS KMS key identifier for an encrypted CEV. A symmetric KMS key is required for RDS Custom, but optional for Amazon RDS. + * The AWS KMS key identifier for an encrypted CEV. A symmetric encryption KMS key is required for RDS Custom, but optional for Amazon RDS. + * If you have an existing symmetric encryption KMS key in your account, you can use it with RDS Custom. No further action is necessary. If you don't already have a symmetric encryption KMS key in your account, follow the instructions in [Creating a symmetric encryption KMS key](https://docs.aws.amazon.com/kms/latest/developerguide/create-keys.html#create-symmetric-cmk) in the *Key Management Service Developer Guide*. + * You can choose the same symmetric encryption key when you create a CEV and a DB instance, or choose different keys. */ public readonly kmsKeyId!: pulumi.Output; /** * The CEV manifest, which is a JSON document that describes the installation .zip files stored in Amazon S3. Specify the name/value pairs in a file or a quoted string. RDS Custom applies the patches in the order in which they are listed. + * The following JSON fields are valid: + * + MediaImportTemplateVersion Version of the CEV manifest. The date is in the format YYYY-MM-DD. + databaseInstallationFileNames Ordered list of installation files for the CEV. + opatchFileNames Ordered list of OPatch installers used for the Oracle DB engine. + psuRuPatchFileNames The PSU and RU patches for this CEV. + OtherPatchFileNames The patches that are not in the list of PSU and RU patches. Amazon RDS applies these patches after applying the PSU and RU patches. + * For more information, see [Creating the CEV manifest](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/custom-cev.html#custom-cev.preparing.manifest) in the *Amazon RDS User Guide*. */ public readonly manifest!: pulumi.Output; /** - * The identifier of the source custom engine version. + * The ARN of a CEV to use as a source for creating a new CEV. You can specify a different Amazon Machine Imagine (AMI) by using either ``Source`` or ``UseAwsProvidedLatestImage``. You can't specify a different JSON manifest when you specify ``SourceCustomDbEngineVersionIdentifier``. */ public readonly sourceCustomDbEngineVersionIdentifier!: pulumi.Output; /** - * The availability status to be assigned to the CEV. + * A value that indicates the status of a custom engine version (CEV). */ public readonly status!: pulumi.Output; /** - * An array of key-value pairs to apply to this resource. + * A list of tags. For more information, see [Tagging Amazon RDS Resources](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_Tagging.html) in the *Amazon RDS User Guide.* */ public readonly tags!: pulumi.Output; /** - * A value that indicates whether AWS provided latest image is applied automatically to the Custom Engine Version. By default, AWS provided latest image is applied automatically. This value is only applied on create. + * Specifies whether to use the latest service-provided Amazon Machine Image (AMI) for the CEV. If you specify ``UseAwsProvidedLatestImage``, you can't also specify ``ImageId``. */ public readonly useAwsProvidedLatestImage!: pulumi.Output; @@ -147,11 +157,11 @@ export class CustomDbEngineVersion extends pulumi.CustomResource { */ export interface CustomDbEngineVersionArgs { /** - * The name of an Amazon S3 bucket that contains database installation files for your CEV. For example, a valid bucket name is `my-custom-installation-files`. + * The name of an Amazon S3 bucket that contains database installation files for your CEV. For example, a valid bucket name is ``my-custom-installation-files``. */ databaseInstallationFilesS3BucketName?: pulumi.Input; /** - * The Amazon S3 directory that contains the database installation files for your CEV. For example, a valid bucket name is `123456789012/cev1`. If this setting isn't specified, no prefix is assumed. + * The Amazon S3 directory that contains the database installation files for your CEV. For example, a valid bucket name is ``123456789012/cev1``. If this setting isn't specified, no prefix is assumed. */ databaseInstallationFilesS3Prefix?: pulumi.Input; /** @@ -159,39 +169,49 @@ export interface CustomDbEngineVersionArgs { */ description?: pulumi.Input; /** - * The database engine to use for your custom engine version (CEV). The only supported value is `custom-oracle-ee`. + * The database engine to use for your custom engine version (CEV). + * Valid values: + * + ``custom-oracle-ee`` + * + ``custom-oracle-ee-cdb`` */ engine: pulumi.Input; /** - * The name of your CEV. The name format is 19.customized_string . For example, a valid name is 19.my_cev1. This setting is required for RDS Custom for Oracle, but optional for Amazon RDS. The combination of Engine and EngineVersion is unique per customer per Region. + * The name of your CEV. The name format is ``major version.customized_string``. For example, a valid CEV name is ``19.my_cev1``. This setting is required for RDS Custom for Oracle, but optional for Amazon RDS. The combination of ``Engine`` and ``EngineVersion`` is unique per customer per Region. + * *Constraints:* Minimum length is 1. Maximum length is 60. + * *Pattern:* ``^[a-z0-9_.-]{1,60$``} */ engineVersion: pulumi.Input; /** - * The identifier of Amazon Machine Image (AMI) used for CEV. + * A value that indicates the ID of the AMI. */ imageId?: pulumi.Input; /** - * The AWS KMS key identifier for an encrypted CEV. A symmetric KMS key is required for RDS Custom, but optional for Amazon RDS. + * The AWS KMS key identifier for an encrypted CEV. A symmetric encryption KMS key is required for RDS Custom, but optional for Amazon RDS. + * If you have an existing symmetric encryption KMS key in your account, you can use it with RDS Custom. No further action is necessary. If you don't already have a symmetric encryption KMS key in your account, follow the instructions in [Creating a symmetric encryption KMS key](https://docs.aws.amazon.com/kms/latest/developerguide/create-keys.html#create-symmetric-cmk) in the *Key Management Service Developer Guide*. + * You can choose the same symmetric encryption key when you create a CEV and a DB instance, or choose different keys. */ kmsKeyId?: pulumi.Input; /** * The CEV manifest, which is a JSON document that describes the installation .zip files stored in Amazon S3. Specify the name/value pairs in a file or a quoted string. RDS Custom applies the patches in the order in which they are listed. + * The following JSON fields are valid: + * + MediaImportTemplateVersion Version of the CEV manifest. The date is in the format YYYY-MM-DD. + databaseInstallationFileNames Ordered list of installation files for the CEV. + opatchFileNames Ordered list of OPatch installers used for the Oracle DB engine. + psuRuPatchFileNames The PSU and RU patches for this CEV. + OtherPatchFileNames The patches that are not in the list of PSU and RU patches. Amazon RDS applies these patches after applying the PSU and RU patches. + * For more information, see [Creating the CEV manifest](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/custom-cev.html#custom-cev.preparing.manifest) in the *Amazon RDS User Guide*. */ manifest?: pulumi.Input; /** - * The identifier of the source custom engine version. + * The ARN of a CEV to use as a source for creating a new CEV. You can specify a different Amazon Machine Imagine (AMI) by using either ``Source`` or ``UseAwsProvidedLatestImage``. You can't specify a different JSON manifest when you specify ``SourceCustomDbEngineVersionIdentifier``. */ sourceCustomDbEngineVersionIdentifier?: pulumi.Input; /** - * The availability status to be assigned to the CEV. + * A value that indicates the status of a custom engine version (CEV). */ status?: pulumi.Input; /** - * An array of key-value pairs to apply to this resource. + * A list of tags. For more information, see [Tagging Amazon RDS Resources](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_Tagging.html) in the *Amazon RDS User Guide.* */ tags?: pulumi.Input[]>; /** - * A value that indicates whether AWS provided latest image is applied automatically to the Custom Engine Version. By default, AWS provided latest image is applied automatically. This value is only applied on create. + * Specifies whether to use the latest service-provided Amazon Machine Image (AMI) for the CEV. If you specify ``UseAwsProvidedLatestImage``, you can't also specify ``ImageId``. */ useAwsProvidedLatestImage?: pulumi.Input; } diff --git a/sdk/nodejs/rds/getCustomDbEngineVersion.ts b/sdk/nodejs/rds/getCustomDbEngineVersion.ts index fde4ba0662..f55bfbb95d 100644 --- a/sdk/nodejs/rds/getCustomDbEngineVersion.ts +++ b/sdk/nodejs/rds/getCustomDbEngineVersion.ts @@ -8,7 +8,7 @@ import * as enums from "../types/enums"; import * as utilities from "../utilities"; /** - * The AWS::RDS::CustomDBEngineVersion resource creates an Amazon RDS custom DB engine version. + * Creates a custom DB engine version (CEV). */ export function getCustomDbEngineVersion(args: GetCustomDbEngineVersionArgs, opts?: pulumi.InvokeOptions): Promise { opts = pulumi.mergeOptions(utilities.resourceOptsDefaults(), opts || {}); @@ -20,11 +20,16 @@ export function getCustomDbEngineVersion(args: GetCustomDbEngineVersionArgs, opt export interface GetCustomDbEngineVersionArgs { /** - * The database engine to use for your custom engine version (CEV). The only supported value is `custom-oracle-ee`. + * The database engine to use for your custom engine version (CEV). + * Valid values: + * + ``custom-oracle-ee`` + * + ``custom-oracle-ee-cdb`` */ engine: string; /** - * The name of your CEV. The name format is 19.customized_string . For example, a valid name is 19.my_cev1. This setting is required for RDS Custom for Oracle, but optional for Amazon RDS. The combination of Engine and EngineVersion is unique per customer per Region. + * The name of your CEV. The name format is ``major version.customized_string``. For example, a valid CEV name is ``19.my_cev1``. This setting is required for RDS Custom for Oracle, but optional for Amazon RDS. The combination of ``Engine`` and ``EngineVersion`` is unique per customer per Region. + * *Constraints:* Minimum length is 1. Maximum length is 60. + * *Pattern:* ``^[a-z0-9_.-]{1,60$``} */ engineVersion: string; } @@ -39,16 +44,16 @@ export interface GetCustomDbEngineVersionResult { */ readonly description?: string; /** - * The availability status to be assigned to the CEV. + * A value that indicates the status of a custom engine version (CEV). */ readonly status?: enums.rds.CustomDbEngineVersionStatus; /** - * An array of key-value pairs to apply to this resource. + * A list of tags. For more information, see [Tagging Amazon RDS Resources](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_Tagging.html) in the *Amazon RDS User Guide.* */ readonly tags?: outputs.Tag[]; } /** - * The AWS::RDS::CustomDBEngineVersion resource creates an Amazon RDS custom DB engine version. + * Creates a custom DB engine version (CEV). */ export function getCustomDbEngineVersionOutput(args: GetCustomDbEngineVersionOutputArgs, opts?: pulumi.InvokeOutputOptions): pulumi.Output { opts = pulumi.mergeOptions(utilities.resourceOptsDefaults(), opts || {}); @@ -60,11 +65,16 @@ export function getCustomDbEngineVersionOutput(args: GetCustomDbEngineVersionOut export interface GetCustomDbEngineVersionOutputArgs { /** - * The database engine to use for your custom engine version (CEV). The only supported value is `custom-oracle-ee`. + * The database engine to use for your custom engine version (CEV). + * Valid values: + * + ``custom-oracle-ee`` + * + ``custom-oracle-ee-cdb`` */ engine: pulumi.Input; /** - * The name of your CEV. The name format is 19.customized_string . For example, a valid name is 19.my_cev1. This setting is required for RDS Custom for Oracle, but optional for Amazon RDS. The combination of Engine and EngineVersion is unique per customer per Region. + * The name of your CEV. The name format is ``major version.customized_string``. For example, a valid CEV name is ``19.my_cev1``. This setting is required for RDS Custom for Oracle, but optional for Amazon RDS. The combination of ``Engine`` and ``EngineVersion`` is unique per customer per Region. + * *Constraints:* Minimum length is 1. Maximum length is 60. + * *Pattern:* ``^[a-z0-9_.-]{1,60$``} */ engineVersion: pulumi.Input; } diff --git a/sdk/nodejs/redshiftserverless/getWorkgroup.ts b/sdk/nodejs/redshiftserverless/getWorkgroup.ts index 9081755aba..1dcce9341d 100644 --- a/sdk/nodejs/redshiftserverless/getWorkgroup.ts +++ b/sdk/nodejs/redshiftserverless/getWorkgroup.ts @@ -33,6 +33,10 @@ export interface GetWorkgroupResult { * The custom port to use when connecting to a workgroup. Valid port ranges are 5431-5455 and 8191-8215. The default is 5439. */ readonly port?: number; + /** + * A property that represents the price performance target settings for the workgroup. + */ + readonly pricePerformanceTarget?: outputs.redshiftserverless.WorkgroupPerformanceTarget; /** * A value that specifies whether the workgroup can be accessible from a public network. */ diff --git a/sdk/nodejs/redshiftserverless/workgroup.ts b/sdk/nodejs/redshiftserverless/workgroup.ts index a84acd5c92..5b68a2e704 100644 --- a/sdk/nodejs/redshiftserverless/workgroup.ts +++ b/sdk/nodejs/redshiftserverless/workgroup.ts @@ -61,6 +61,10 @@ export class Workgroup extends pulumi.CustomResource { * The custom port to use when connecting to a workgroup. Valid port ranges are 5431-5455 and 8191-8215. The default is 5439. */ public readonly port!: pulumi.Output; + /** + * A property that represents the price performance target settings for the workgroup. + */ + public readonly pricePerformanceTarget!: pulumi.Output; /** * A value that specifies whether the workgroup can be accessible from a public network. */ @@ -103,6 +107,7 @@ export class Workgroup extends pulumi.CustomResource { resourceInputs["maxCapacity"] = args ? args.maxCapacity : undefined; resourceInputs["namespaceName"] = args ? args.namespaceName : undefined; resourceInputs["port"] = args ? args.port : undefined; + resourceInputs["pricePerformanceTarget"] = args ? args.pricePerformanceTarget : undefined; resourceInputs["publiclyAccessible"] = args ? args.publiclyAccessible : undefined; resourceInputs["securityGroupIds"] = args ? args.securityGroupIds : undefined; resourceInputs["subnetIds"] = args ? args.subnetIds : undefined; @@ -116,6 +121,7 @@ export class Workgroup extends pulumi.CustomResource { resourceInputs["maxCapacity"] = undefined /*out*/; resourceInputs["namespaceName"] = undefined /*out*/; resourceInputs["port"] = undefined /*out*/; + resourceInputs["pricePerformanceTarget"] = undefined /*out*/; resourceInputs["publiclyAccessible"] = undefined /*out*/; resourceInputs["securityGroupIds"] = undefined /*out*/; resourceInputs["subnetIds"] = undefined /*out*/; @@ -158,6 +164,10 @@ export interface WorkgroupArgs { * The custom port to use when connecting to a workgroup. Valid port ranges are 5431-5455 and 8191-8215. The default is 5439. */ port?: pulumi.Input; + /** + * A property that represents the price performance target settings for the workgroup. + */ + pricePerformanceTarget?: pulumi.Input; /** * A value that specifies whether the workgroup can be accessible from a public network. */ diff --git a/sdk/nodejs/s3/bucket.ts b/sdk/nodejs/s3/bucket.ts index 32ff025c3a..3d8509e700 100644 --- a/sdk/nodejs/s3/bucket.ts +++ b/sdk/nodejs/s3/bucket.ts @@ -609,6 +609,7 @@ export class Bucket extends pulumi.CustomResource { * Settings that define where logs are stored. */ public readonly loggingConfiguration!: pulumi.Output; + public readonly metadataTableConfiguration!: pulumi.Output; /** * Specifies a metrics configuration for the CloudWatch request metrics (specified by the metrics configuration ID) from an Amazon S3 bucket. If you're updating an existing metrics configuration, note that this is a full replacement of the existing metrics configuration. If you don't include the elements you want to keep, they are erased. For more information, see [PutBucketMetricsConfiguration](https://docs.aws.amazon.com/AmazonS3/latest/API/RESTBucketPUTMetricConfiguration.html). */ @@ -691,6 +692,7 @@ export class Bucket extends pulumi.CustomResource { resourceInputs["inventoryConfigurations"] = args ? args.inventoryConfigurations : undefined; resourceInputs["lifecycleConfiguration"] = args ? args.lifecycleConfiguration : undefined; resourceInputs["loggingConfiguration"] = args ? args.loggingConfiguration : undefined; + resourceInputs["metadataTableConfiguration"] = args ? args.metadataTableConfiguration : undefined; resourceInputs["metricsConfigurations"] = args ? args.metricsConfigurations : undefined; resourceInputs["notificationConfiguration"] = args ? args.notificationConfiguration : undefined; resourceInputs["objectLockConfiguration"] = args ? args.objectLockConfiguration : undefined; @@ -720,6 +722,7 @@ export class Bucket extends pulumi.CustomResource { resourceInputs["inventoryConfigurations"] = undefined /*out*/; resourceInputs["lifecycleConfiguration"] = undefined /*out*/; resourceInputs["loggingConfiguration"] = undefined /*out*/; + resourceInputs["metadataTableConfiguration"] = undefined /*out*/; resourceInputs["metricsConfigurations"] = undefined /*out*/; resourceInputs["notificationConfiguration"] = undefined /*out*/; resourceInputs["objectLockConfiguration"] = undefined /*out*/; @@ -788,6 +791,7 @@ export interface BucketArgs { * Settings that define where logs are stored. */ loggingConfiguration?: pulumi.Input; + metadataTableConfiguration?: pulumi.Input; /** * Specifies a metrics configuration for the CloudWatch request metrics (specified by the metrics configuration ID) from an Amazon S3 bucket. If you're updating an existing metrics configuration, note that this is a full replacement of the existing metrics configuration. If you don't include the elements you want to keep, they are erased. For more information, see [PutBucketMetricsConfiguration](https://docs.aws.amazon.com/AmazonS3/latest/API/RESTBucketPUTMetricConfiguration.html). */ diff --git a/sdk/nodejs/s3/getBucket.ts b/sdk/nodejs/s3/getBucket.ts index f3ec4c0c05..9272f4d1a5 100644 --- a/sdk/nodejs/s3/getBucket.ts +++ b/sdk/nodejs/s3/getBucket.ts @@ -80,6 +80,7 @@ export interface GetBucketResult { * Settings that define where logs are stored. */ readonly loggingConfiguration?: outputs.s3.BucketLoggingConfiguration; + readonly metadataTableConfiguration?: outputs.s3.BucketMetadataTableConfiguration; /** * Specifies a metrics configuration for the CloudWatch request metrics (specified by the metrics configuration ID) from an Amazon S3 bucket. If you're updating an existing metrics configuration, note that this is a full replacement of the existing metrics configuration. If you don't include the elements you want to keep, they are erased. For more information, see [PutBucketMetricsConfiguration](https://docs.aws.amazon.com/AmazonS3/latest/API/RESTBucketPUTMetricConfiguration.html). */ diff --git a/sdk/nodejs/s3express/directoryBucket.ts b/sdk/nodejs/s3express/directoryBucket.ts index 25fd9d9c83..1c9ceefbad 100644 --- a/sdk/nodejs/s3express/directoryBucket.ts +++ b/sdk/nodejs/s3express/directoryBucket.ts @@ -42,7 +42,7 @@ export class DirectoryBucket extends pulumi.CustomResource { */ public /*out*/ readonly arn!: pulumi.Output; /** - * Returns the code for the Availability Zone where the directory bucket was created. + * Returns the code for the Availability Zone or Local Zone where the directory bucket was created. An example for the code of an Availability Zone is 'us-east-1f'. */ public /*out*/ readonly availabilityZoneName!: pulumi.Output; /** @@ -50,11 +50,11 @@ export class DirectoryBucket extends pulumi.CustomResource { */ public readonly bucketEncryption!: pulumi.Output; /** - * Specifies a name for the bucket. The bucket name must contain only lowercase letters, numbers, and hyphens (-). A directory bucket name must be unique in the chosen Availability Zone. The bucket name must also follow the format 'bucket_base_name--az_id--x-s3' (for example, 'DOC-EXAMPLE-BUCKET--usw2-az1--x-s3'). If you don't specify a name, AWS CloudFormation generates a unique physical ID and uses that ID for the bucket name. + * Specifies a name for the bucket. The bucket name must contain only lowercase letters, numbers, and hyphens (-). A directory bucket name must be unique in the chosen Availability Zone or Local Zone. The bucket name must also follow the format 'bucket_base_name--zone_id--x-s3'. The zone_id can be the ID of an Availability Zone or a Local Zone. If you don't specify a name, AWS CloudFormation generates a unique physical ID and uses that ID for the bucket name. */ public readonly bucketName!: pulumi.Output; /** - * Specifies the number of Availability Zone that's used for redundancy for the bucket. + * Specifies the number of Availability Zone or Local Zone that's used for redundancy for the bucket. */ public readonly dataRedundancy!: pulumi.Output; /** @@ -62,7 +62,7 @@ export class DirectoryBucket extends pulumi.CustomResource { */ public readonly lifecycleConfiguration!: pulumi.Output; /** - * Specifies the AZ ID of the Availability Zone where the directory bucket will be created. An example AZ ID value is 'use1-az5'. + * Specifies the Zone ID of the Availability Zone or Local Zone where the directory bucket will be created. An example Availability Zone ID value is 'use1-az5'. */ public readonly locationName!: pulumi.Output; @@ -115,11 +115,11 @@ export interface DirectoryBucketArgs { */ bucketEncryption?: pulumi.Input; /** - * Specifies a name for the bucket. The bucket name must contain only lowercase letters, numbers, and hyphens (-). A directory bucket name must be unique in the chosen Availability Zone. The bucket name must also follow the format 'bucket_base_name--az_id--x-s3' (for example, 'DOC-EXAMPLE-BUCKET--usw2-az1--x-s3'). If you don't specify a name, AWS CloudFormation generates a unique physical ID and uses that ID for the bucket name. + * Specifies a name for the bucket. The bucket name must contain only lowercase letters, numbers, and hyphens (-). A directory bucket name must be unique in the chosen Availability Zone or Local Zone. The bucket name must also follow the format 'bucket_base_name--zone_id--x-s3'. The zone_id can be the ID of an Availability Zone or a Local Zone. If you don't specify a name, AWS CloudFormation generates a unique physical ID and uses that ID for the bucket name. */ bucketName?: pulumi.Input; /** - * Specifies the number of Availability Zone that's used for redundancy for the bucket. + * Specifies the number of Availability Zone or Local Zone that's used for redundancy for the bucket. */ dataRedundancy: pulumi.Input; /** @@ -127,7 +127,7 @@ export interface DirectoryBucketArgs { */ lifecycleConfiguration?: pulumi.Input; /** - * Specifies the AZ ID of the Availability Zone where the directory bucket will be created. An example AZ ID value is 'use1-az5'. + * Specifies the Zone ID of the Availability Zone or Local Zone where the directory bucket will be created. An example Availability Zone ID value is 'use1-az5'. */ locationName: pulumi.Input; } diff --git a/sdk/nodejs/s3express/getDirectoryBucket.ts b/sdk/nodejs/s3express/getDirectoryBucket.ts index c6a630a325..4fa2fed119 100644 --- a/sdk/nodejs/s3express/getDirectoryBucket.ts +++ b/sdk/nodejs/s3express/getDirectoryBucket.ts @@ -19,7 +19,7 @@ export function getDirectoryBucket(args: GetDirectoryBucketArgs, opts?: pulumi.I export interface GetDirectoryBucketArgs { /** - * Specifies a name for the bucket. The bucket name must contain only lowercase letters, numbers, and hyphens (-). A directory bucket name must be unique in the chosen Availability Zone. The bucket name must also follow the format 'bucket_base_name--az_id--x-s3' (for example, 'DOC-EXAMPLE-BUCKET--usw2-az1--x-s3'). If you don't specify a name, AWS CloudFormation generates a unique physical ID and uses that ID for the bucket name. + * Specifies a name for the bucket. The bucket name must contain only lowercase letters, numbers, and hyphens (-). A directory bucket name must be unique in the chosen Availability Zone or Local Zone. The bucket name must also follow the format 'bucket_base_name--zone_id--x-s3'. The zone_id can be the ID of an Availability Zone or a Local Zone. If you don't specify a name, AWS CloudFormation generates a unique physical ID and uses that ID for the bucket name. */ bucketName: string; } @@ -30,7 +30,7 @@ export interface GetDirectoryBucketResult { */ readonly arn?: string; /** - * Returns the code for the Availability Zone where the directory bucket was created. + * Returns the code for the Availability Zone or Local Zone where the directory bucket was created. An example for the code of an Availability Zone is 'us-east-1f'. */ readonly availabilityZoneName?: string; /** @@ -54,7 +54,7 @@ export function getDirectoryBucketOutput(args: GetDirectoryBucketOutputArgs, opt export interface GetDirectoryBucketOutputArgs { /** - * Specifies a name for the bucket. The bucket name must contain only lowercase letters, numbers, and hyphens (-). A directory bucket name must be unique in the chosen Availability Zone. The bucket name must also follow the format 'bucket_base_name--az_id--x-s3' (for example, 'DOC-EXAMPLE-BUCKET--usw2-az1--x-s3'). If you don't specify a name, AWS CloudFormation generates a unique physical ID and uses that ID for the bucket name. + * Specifies a name for the bucket. The bucket name must contain only lowercase letters, numbers, and hyphens (-). A directory bucket name must be unique in the chosen Availability Zone or Local Zone. The bucket name must also follow the format 'bucket_base_name--zone_id--x-s3'. The zone_id can be the ID of an Availability Zone or a Local Zone. If you don't specify a name, AWS CloudFormation generates a unique physical ID and uses that ID for the bucket name. */ bucketName: pulumi.Input; } diff --git a/sdk/nodejs/s3tables/getTableBucket.ts b/sdk/nodejs/s3tables/getTableBucket.ts new file mode 100644 index 0000000000..819755a067 --- /dev/null +++ b/sdk/nodejs/s3tables/getTableBucket.ts @@ -0,0 +1,40 @@ +// *** WARNING: this file was generated by pulumi-language-nodejs. *** +// *** Do not edit by hand unless you're certain you know what you are doing! *** + +import * as pulumi from "@pulumi/pulumi"; +import * as inputs from "../types/input"; +import * as outputs from "../types/output"; +import * as enums from "../types/enums"; +import * as utilities from "../utilities"; + +/** + * Creates an Amazon S3 Tables table bucket in the same AWS Region where you create the AWS CloudFormation stack. + */ +export function getTableBucket(args: GetTableBucketArgs, opts?: pulumi.InvokeOptions): Promise { + opts = pulumi.mergeOptions(utilities.resourceOptsDefaults(), opts || {}); + return pulumi.runtime.invoke("aws-native:s3tables:getTableBucket", { + "tableBucketArn": args.tableBucketArn, + }, opts); +} + +export interface GetTableBucketArgs { + tableBucketArn: string; +} + +export interface GetTableBucketResult { + readonly tableBucketArn?: string; + readonly unreferencedFileRemoval?: outputs.s3tables.TableBucketUnreferencedFileRemoval; +} +/** + * Creates an Amazon S3 Tables table bucket in the same AWS Region where you create the AWS CloudFormation stack. + */ +export function getTableBucketOutput(args: GetTableBucketOutputArgs, opts?: pulumi.InvokeOutputOptions): pulumi.Output { + opts = pulumi.mergeOptions(utilities.resourceOptsDefaults(), opts || {}); + return pulumi.runtime.invokeOutput("aws-native:s3tables:getTableBucket", { + "tableBucketArn": args.tableBucketArn, + }, opts); +} + +export interface GetTableBucketOutputArgs { + tableBucketArn: pulumi.Input; +} diff --git a/sdk/nodejs/s3tables/getTableBucketPolicy.ts b/sdk/nodejs/s3tables/getTableBucketPolicy.ts new file mode 100644 index 0000000000..af89830cd9 --- /dev/null +++ b/sdk/nodejs/s3tables/getTableBucketPolicy.ts @@ -0,0 +1,39 @@ +// *** WARNING: this file was generated by pulumi-language-nodejs. *** +// *** Do not edit by hand unless you're certain you know what you are doing! *** + +import * as pulumi from "@pulumi/pulumi"; +import * as inputs from "../types/input"; +import * as outputs from "../types/output"; +import * as enums from "../types/enums"; +import * as utilities from "../utilities"; + +/** + * Applies an IAM resource policy to a table bucket. + */ +export function getTableBucketPolicy(args: GetTableBucketPolicyArgs, opts?: pulumi.InvokeOptions): Promise { + opts = pulumi.mergeOptions(utilities.resourceOptsDefaults(), opts || {}); + return pulumi.runtime.invoke("aws-native:s3tables:getTableBucketPolicy", { + "tableBucketArn": args.tableBucketArn, + }, opts); +} + +export interface GetTableBucketPolicyArgs { + tableBucketArn: string; +} + +export interface GetTableBucketPolicyResult { + readonly resourcePolicy?: outputs.s3tables.TableBucketPolicyResourcePolicy; +} +/** + * Applies an IAM resource policy to a table bucket. + */ +export function getTableBucketPolicyOutput(args: GetTableBucketPolicyOutputArgs, opts?: pulumi.InvokeOutputOptions): pulumi.Output { + opts = pulumi.mergeOptions(utilities.resourceOptsDefaults(), opts || {}); + return pulumi.runtime.invokeOutput("aws-native:s3tables:getTableBucketPolicy", { + "tableBucketArn": args.tableBucketArn, + }, opts); +} + +export interface GetTableBucketPolicyOutputArgs { + tableBucketArn: pulumi.Input; +} diff --git a/sdk/nodejs/s3tables/index.ts b/sdk/nodejs/s3tables/index.ts new file mode 100644 index 0000000000..5c1ae83ab8 --- /dev/null +++ b/sdk/nodejs/s3tables/index.ts @@ -0,0 +1,45 @@ +// *** WARNING: this file was generated by pulumi-language-nodejs. *** +// *** Do not edit by hand unless you're certain you know what you are doing! *** + +import * as pulumi from "@pulumi/pulumi"; +import * as utilities from "../utilities"; + +// Export members: +export { GetTableBucketArgs, GetTableBucketResult, GetTableBucketOutputArgs } from "./getTableBucket"; +export const getTableBucket: typeof import("./getTableBucket").getTableBucket = null as any; +export const getTableBucketOutput: typeof import("./getTableBucket").getTableBucketOutput = null as any; +utilities.lazyLoad(exports, ["getTableBucket","getTableBucketOutput"], () => require("./getTableBucket")); + +export { GetTableBucketPolicyArgs, GetTableBucketPolicyResult, GetTableBucketPolicyOutputArgs } from "./getTableBucketPolicy"; +export const getTableBucketPolicy: typeof import("./getTableBucketPolicy").getTableBucketPolicy = null as any; +export const getTableBucketPolicyOutput: typeof import("./getTableBucketPolicy").getTableBucketPolicyOutput = null as any; +utilities.lazyLoad(exports, ["getTableBucketPolicy","getTableBucketPolicyOutput"], () => require("./getTableBucketPolicy")); + +export { TableBucketArgs } from "./tableBucket"; +export type TableBucket = import("./tableBucket").TableBucket; +export const TableBucket: typeof import("./tableBucket").TableBucket = null as any; +utilities.lazyLoad(exports, ["TableBucket"], () => require("./tableBucket")); + +export { TableBucketPolicyArgs } from "./tableBucketPolicy"; +export type TableBucketPolicy = import("./tableBucketPolicy").TableBucketPolicy; +export const TableBucketPolicy: typeof import("./tableBucketPolicy").TableBucketPolicy = null as any; +utilities.lazyLoad(exports, ["TableBucketPolicy"], () => require("./tableBucketPolicy")); + + +// Export enums: +export * from "../types/enums/s3tables"; + +const _module = { + version: utilities.getVersion(), + construct: (name: string, type: string, urn: string): pulumi.Resource => { + switch (type) { + case "aws-native:s3tables:TableBucket": + return new TableBucket(name, undefined, { urn }) + case "aws-native:s3tables:TableBucketPolicy": + return new TableBucketPolicy(name, undefined, { urn }) + default: + throw new Error(`unknown resource type ${type}`); + } + }, +}; +pulumi.runtime.registerResourceModule("aws-native", "s3tables", _module) diff --git a/sdk/nodejs/s3tables/tableBucket.ts b/sdk/nodejs/s3tables/tableBucket.ts new file mode 100644 index 0000000000..4394b2c734 --- /dev/null +++ b/sdk/nodejs/s3tables/tableBucket.ts @@ -0,0 +1,76 @@ +// *** WARNING: this file was generated by pulumi-language-nodejs. *** +// *** Do not edit by hand unless you're certain you know what you are doing! *** + +import * as pulumi from "@pulumi/pulumi"; +import * as inputs from "../types/input"; +import * as outputs from "../types/output"; +import * as enums from "../types/enums"; +import * as utilities from "../utilities"; + +/** + * Creates an Amazon S3 Tables table bucket in the same AWS Region where you create the AWS CloudFormation stack. + */ +export class TableBucket extends pulumi.CustomResource { + /** + * Get an existing TableBucket resource's state with the given name, ID, and optional extra + * properties used to qualify the lookup. + * + * @param name The _unique_ name of the resulting resource. + * @param id The _unique_ provider ID of the resource to lookup. + * @param opts Optional settings to control the behavior of the CustomResource. + */ + public static get(name: string, id: pulumi.Input, opts?: pulumi.CustomResourceOptions): TableBucket { + return new TableBucket(name, undefined as any, { ...opts, id: id }); + } + + /** @internal */ + public static readonly __pulumiType = 'aws-native:s3tables:TableBucket'; + + /** + * Returns true if the given object is an instance of TableBucket. This is designed to work even + * when multiple copies of the Pulumi SDK have been loaded into the same process. + */ + public static isInstance(obj: any): obj is TableBucket { + if (obj === undefined || obj === null) { + return false; + } + return obj['__pulumiType'] === TableBucket.__pulumiType; + } + + public /*out*/ readonly tableBucketArn!: pulumi.Output; + public readonly tableBucketName!: pulumi.Output; + public readonly unreferencedFileRemoval!: pulumi.Output; + + /** + * Create a TableBucket resource with the given unique name, arguments, and options. + * + * @param name The _unique_ name of the resource. + * @param args The arguments to use to populate this resource's properties. + * @param opts A bag of options that control this resource's behavior. + */ + constructor(name: string, args?: TableBucketArgs, opts?: pulumi.CustomResourceOptions) { + let resourceInputs: pulumi.Inputs = {}; + opts = opts || {}; + if (!opts.id) { + resourceInputs["tableBucketName"] = args ? args.tableBucketName : undefined; + resourceInputs["unreferencedFileRemoval"] = args ? args.unreferencedFileRemoval : undefined; + resourceInputs["tableBucketArn"] = undefined /*out*/; + } else { + resourceInputs["tableBucketArn"] = undefined /*out*/; + resourceInputs["tableBucketName"] = undefined /*out*/; + resourceInputs["unreferencedFileRemoval"] = undefined /*out*/; + } + opts = pulumi.mergeOptions(utilities.resourceOptsDefaults(), opts); + const replaceOnChanges = { replaceOnChanges: ["tableBucketName"] }; + opts = pulumi.mergeOptions(opts, replaceOnChanges); + super(TableBucket.__pulumiType, name, resourceInputs, opts); + } +} + +/** + * The set of arguments for constructing a TableBucket resource. + */ +export interface TableBucketArgs { + tableBucketName?: pulumi.Input; + unreferencedFileRemoval?: pulumi.Input; +} diff --git a/sdk/nodejs/s3tables/tableBucketPolicy.ts b/sdk/nodejs/s3tables/tableBucketPolicy.ts new file mode 100644 index 0000000000..ef0c00be2f --- /dev/null +++ b/sdk/nodejs/s3tables/tableBucketPolicy.ts @@ -0,0 +1,79 @@ +// *** WARNING: this file was generated by pulumi-language-nodejs. *** +// *** Do not edit by hand unless you're certain you know what you are doing! *** + +import * as pulumi from "@pulumi/pulumi"; +import * as inputs from "../types/input"; +import * as outputs from "../types/output"; +import * as enums from "../types/enums"; +import * as utilities from "../utilities"; + +/** + * Applies an IAM resource policy to a table bucket. + */ +export class TableBucketPolicy extends pulumi.CustomResource { + /** + * Get an existing TableBucketPolicy resource's state with the given name, ID, and optional extra + * properties used to qualify the lookup. + * + * @param name The _unique_ name of the resulting resource. + * @param id The _unique_ provider ID of the resource to lookup. + * @param opts Optional settings to control the behavior of the CustomResource. + */ + public static get(name: string, id: pulumi.Input, opts?: pulumi.CustomResourceOptions): TableBucketPolicy { + return new TableBucketPolicy(name, undefined as any, { ...opts, id: id }); + } + + /** @internal */ + public static readonly __pulumiType = 'aws-native:s3tables:TableBucketPolicy'; + + /** + * Returns true if the given object is an instance of TableBucketPolicy. This is designed to work even + * when multiple copies of the Pulumi SDK have been loaded into the same process. + */ + public static isInstance(obj: any): obj is TableBucketPolicy { + if (obj === undefined || obj === null) { + return false; + } + return obj['__pulumiType'] === TableBucketPolicy.__pulumiType; + } + + public readonly resourcePolicy!: pulumi.Output; + public readonly tableBucketArn!: pulumi.Output; + + /** + * Create a TableBucketPolicy resource with the given unique name, arguments, and options. + * + * @param name The _unique_ name of the resource. + * @param args The arguments to use to populate this resource's properties. + * @param opts A bag of options that control this resource's behavior. + */ + constructor(name: string, args: TableBucketPolicyArgs, opts?: pulumi.CustomResourceOptions) { + let resourceInputs: pulumi.Inputs = {}; + opts = opts || {}; + if (!opts.id) { + if ((!args || args.resourcePolicy === undefined) && !opts.urn) { + throw new Error("Missing required property 'resourcePolicy'"); + } + if ((!args || args.tableBucketArn === undefined) && !opts.urn) { + throw new Error("Missing required property 'tableBucketArn'"); + } + resourceInputs["resourcePolicy"] = args ? args.resourcePolicy : undefined; + resourceInputs["tableBucketArn"] = args ? args.tableBucketArn : undefined; + } else { + resourceInputs["resourcePolicy"] = undefined /*out*/; + resourceInputs["tableBucketArn"] = undefined /*out*/; + } + opts = pulumi.mergeOptions(utilities.resourceOptsDefaults(), opts); + const replaceOnChanges = { replaceOnChanges: ["tableBucketArn"] }; + opts = pulumi.mergeOptions(opts, replaceOnChanges); + super(TableBucketPolicy.__pulumiType, name, resourceInputs, opts); + } +} + +/** + * The set of arguments for constructing a TableBucketPolicy resource. + */ +export interface TableBucketPolicyArgs { + resourcePolicy: pulumi.Input; + tableBucketArn: pulumi.Input; +} diff --git a/sdk/nodejs/tsconfig.json b/sdk/nodejs/tsconfig.json index 26b64e3507..28eb535378 100644 --- a/sdk/nodejs/tsconfig.json +++ b/sdk/nodejs/tsconfig.json @@ -1228,6 +1228,7 @@ "iot/caCertificate.ts", "iot/certificate.ts", "iot/certificateProvider.ts", + "iot/command.ts", "iot/customMetric.ts", "iot/dimension.ts", "iot/domainConfiguration.ts", @@ -1238,6 +1239,7 @@ "iot/getCaCertificate.ts", "iot/getCertificate.ts", "iot/getCertificateProvider.ts", + "iot/getCommand.ts", "iot/getCustomMetric.ts", "iot/getDimension.ts", "iot/getDomainConfiguration.ts", @@ -1842,8 +1844,10 @@ "quicksight/topic.ts", "quicksight/vpcConnection.ts", "ram/getPermission.ts", + "ram/getResourceShare.ts", "ram/index.ts", "ram/permission.ts", + "ram/resourceShare.ts", "rbin/getRule.ts", "rbin/index.ts", "rbin/rule.ts", @@ -2049,6 +2053,11 @@ "s3outposts/getBucketPolicy.ts", "s3outposts/getEndpoint.ts", "s3outposts/index.ts", + "s3tables/getTableBucket.ts", + "s3tables/getTableBucketPolicy.ts", + "s3tables/index.ts", + "s3tables/tableBucket.ts", + "s3tables/tableBucketPolicy.ts", "sagemaker/app.ts", "sagemaker/appImageConfig.ts", "sagemaker/cluster.ts", @@ -2455,6 +2464,7 @@ "types/enums/s3/index.ts", "types/enums/s3express/index.ts", "types/enums/s3outposts/index.ts", + "types/enums/s3tables/index.ts", "types/enums/sagemaker/index.ts", "types/enums/scheduler/index.ts", "types/enums/securityhub/index.ts", diff --git a/sdk/nodejs/types/enums/ecs/index.ts b/sdk/nodejs/types/enums/ecs/index.ts index 79de6d0d36..a2009279bd 100644 --- a/sdk/nodejs/types/enums/ecs/index.ts +++ b/sdk/nodejs/types/enums/ecs/index.ts @@ -179,7 +179,7 @@ export const TaskDefinitionContainerDefinitionVersionConsistency = { } as const; /** - * Specifies whether Amazon ECS will resolve the container image tag provided in the container definition to an image digest. By default, the value is `enabled` . If you set the value for a container as `disabled` , Amazon ECS will not resolve the provided container image tag to a digest and will use the original image URI specified in the container definition for deployment. For more information about container image resolution, see [Container image resolution](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/deployment-type-ecs.html#deployment-container-image-stability) in the *Amazon ECS Developer Guide* . + * Specifies whether Amazon ECS will resolve the container image tag provided in the container definition to an image digest. By default, the value is ``enabled``. If you set the value for a container as ``disabled``, Amazon ECS will not resolve the provided container image tag to a digest and will use the original image URI specified in the container definition for deployment. For more information about container image resolution, see [Container image resolution](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/deployment-type-ecs.html#deployment-container-image-stability) in the *Amazon ECS Developer Guide*. */ export type TaskDefinitionContainerDefinitionVersionConsistency = (typeof TaskDefinitionContainerDefinitionVersionConsistency)[keyof typeof TaskDefinitionContainerDefinitionVersionConsistency]; diff --git a/sdk/nodejs/types/enums/index.ts b/sdk/nodejs/types/enums/index.ts index 206077cc01..ef60f91200 100644 --- a/sdk/nodejs/types/enums/index.ts +++ b/sdk/nodejs/types/enums/index.ts @@ -145,6 +145,7 @@ import * as rum from "./rum"; import * as s3 from "./s3"; import * as s3express from "./s3express"; import * as s3outposts from "./s3outposts"; +import * as s3tables from "./s3tables"; import * as sagemaker from "./sagemaker"; import * as scheduler from "./scheduler"; import * as securityhub from "./securityhub"; @@ -318,6 +319,7 @@ export { s3, s3express, s3outposts, + s3tables, sagemaker, scheduler, securityhub, diff --git a/sdk/nodejs/types/enums/iot/index.ts b/sdk/nodejs/types/enums/iot/index.ts index 73c41608b1..ae510bd8f0 100644 --- a/sdk/nodejs/types/enums/iot/index.ts +++ b/sdk/nodejs/types/enums/iot/index.ts @@ -87,6 +87,16 @@ export const CertificateStatus = { */ export type CertificateStatus = (typeof CertificateStatus)[keyof typeof CertificateStatus]; +export const CommandNamespace = { + AwsIoT: "AWS-IoT", + AwsIoTFleetWise: "AWS-IoT-FleetWise", +} as const; + +/** + * The namespace to which the command belongs. + */ +export type CommandNamespace = (typeof CommandNamespace)[keyof typeof CommandNamespace]; + export const CustomMetricMetricType = { StringList: "string-list", IpAddressList: "ip-address-list", diff --git a/sdk/nodejs/types/enums/organizations/index.ts b/sdk/nodejs/types/enums/organizations/index.ts index 99aa4aa5fd..10abf727c4 100644 --- a/sdk/nodejs/types/enums/organizations/index.ts +++ b/sdk/nodejs/types/enums/organizations/index.ts @@ -40,9 +40,10 @@ export const PolicyType = { TagPolicy: "TAG_POLICY", ChatbotPolicy: "CHATBOT_POLICY", ResourceControlPolicy: "RESOURCE_CONTROL_POLICY", + DeclarativePolicyEc2: "DECLARATIVE_POLICY_EC2", } as const; /** - * The type of policy to create. You can specify one of the following values: AISERVICES_OPT_OUT_POLICY, BACKUP_POLICY, SERVICE_CONTROL_POLICY, TAG_POLICY, CHATBOT_POLICY, RESOURCE_CONTROL_POLICY + * The type of policy to create. You can specify one of the following values: AISERVICES_OPT_OUT_POLICY, BACKUP_POLICY, SERVICE_CONTROL_POLICY, TAG_POLICY, CHATBOT_POLICY, RESOURCE_CONTROL_POLICY,DECLARATIVE_POLICY_EC2 */ export type PolicyType = (typeof PolicyType)[keyof typeof PolicyType]; diff --git a/sdk/nodejs/types/enums/rds/index.ts b/sdk/nodejs/types/enums/rds/index.ts index 262f897938..924b6aca69 100644 --- a/sdk/nodejs/types/enums/rds/index.ts +++ b/sdk/nodejs/types/enums/rds/index.ts @@ -9,7 +9,7 @@ export const CustomDbEngineVersionStatus = { } as const; /** - * The availability status to be assigned to the CEV. + * A value that indicates the status of a custom engine version (CEV). */ export type CustomDbEngineVersionStatus = (typeof CustomDbEngineVersionStatus)[keyof typeof CustomDbEngineVersionStatus]; diff --git a/sdk/nodejs/types/enums/redshiftserverless/index.ts b/sdk/nodejs/types/enums/redshiftserverless/index.ts index 25aea46dc7..c73d7f91b2 100644 --- a/sdk/nodejs/types/enums/redshiftserverless/index.ts +++ b/sdk/nodejs/types/enums/redshiftserverless/index.ts @@ -18,6 +18,13 @@ export const NamespaceStatus = { export type NamespaceStatus = (typeof NamespaceStatus)[keyof typeof NamespaceStatus]; +export const WorkgroupPerformanceTargetStatus = { + Enabled: "ENABLED", + Disabled: "DISABLED", +} as const; + +export type WorkgroupPerformanceTargetStatus = (typeof WorkgroupPerformanceTargetStatus)[keyof typeof WorkgroupPerformanceTargetStatus]; + export const WorkgroupStatus = { Creating: "CREATING", Available: "AVAILABLE", diff --git a/sdk/nodejs/types/enums/s3express/index.ts b/sdk/nodejs/types/enums/s3express/index.ts index dd0cdde51d..ea3fbf0303 100644 --- a/sdk/nodejs/types/enums/s3express/index.ts +++ b/sdk/nodejs/types/enums/s3express/index.ts @@ -4,10 +4,11 @@ export const DirectoryBucketDataRedundancy = { SingleAvailabilityZone: "SingleAvailabilityZone", + SingleLocalZone: "SingleLocalZone", } as const; /** - * Specifies the number of Availability Zone that's used for redundancy for the bucket. + * Specifies the number of Availability Zone or Local Zone that's used for redundancy for the bucket. */ export type DirectoryBucketDataRedundancy = (typeof DirectoryBucketDataRedundancy)[keyof typeof DirectoryBucketDataRedundancy]; diff --git a/sdk/nodejs/types/enums/s3tables/index.ts b/sdk/nodejs/types/enums/s3tables/index.ts new file mode 100644 index 0000000000..2f20200e98 --- /dev/null +++ b/sdk/nodejs/types/enums/s3tables/index.ts @@ -0,0 +1,13 @@ +// *** WARNING: this file was generated by pulumi-language-nodejs. *** +// *** Do not edit by hand unless you're certain you know what you are doing! *** + + +export const TableBucketUnreferencedFileRemovalStatus = { + Enabled: "Enabled", + Disabled: "Disabled", +} as const; + +/** + * Indicates whether the Unreferenced File Removal maintenance action is enabled. + */ +export type TableBucketUnreferencedFileRemovalStatus = (typeof TableBucketUnreferencedFileRemovalStatus)[keyof typeof TableBucketUnreferencedFileRemovalStatus]; diff --git a/sdk/nodejs/types/input.ts b/sdk/nodejs/types/input.ts index 9d34d5a319..5e3295ec5d 100644 --- a/sdk/nodejs/types/input.ts +++ b/sdk/nodejs/types/input.ts @@ -4250,6 +4250,9 @@ export namespace applicationautoscaling { resourceLabel?: pulumi.Input; } + /** + * Represents a CloudWatch metric of your choosing for a predictive scaling policy. + */ export interface ScalingPolicyPredictiveScalingCustomizedCapacityMetricArgs { /** * One or more metric data queries to provide data points for a metric specification. @@ -4257,10 +4260,16 @@ export namespace applicationautoscaling { metricDataQueries: pulumi.Input[]>; } + /** + * The customized load metric specification. + */ export interface ScalingPolicyPredictiveScalingCustomizedLoadMetricArgs { metricDataQueries: pulumi.Input[]>; } + /** + * One or more metric data queries to provide data points for a metric specification. + */ export interface ScalingPolicyPredictiveScalingCustomizedScalingMetricArgs { /** * One or more metric data queries to provide data points for a metric specification. @@ -4268,9 +4277,12 @@ export namespace applicationautoscaling { metricDataQueries: pulumi.Input[]>; } + /** + * Describes the scaling metric. + */ export interface ScalingPolicyPredictiveScalingMetricArgs { /** - * The dimensions for the metric. + * Describes the dimensions of the metric. */ dimensions?: pulumi.Input[]>; /** @@ -4283,13 +4295,17 @@ export namespace applicationautoscaling { namespace?: pulumi.Input; } + /** + * 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. + */ export interface ScalingPolicyPredictiveScalingMetricDataQueryArgs { /** - * The math expression to perform on the returned data, if this object is performing a math expression. + * 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. + * Conditional: Within each ``MetricDataQuery`` object, you must specify either ``Expression`` or ``MetricStat``, but not both. */ expression?: pulumi.Input; /** - * A short name that identifies the object's results in the response. + * 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. */ id?: pulumi.Input; /** @@ -4297,15 +4313,21 @@ export namespace applicationautoscaling { */ label?: pulumi.Input; /** - * Information about the metric data to return. + * Information about the metric data to return. + * Conditional: Within each ``MetricDataQuery`` object, you must specify either ``Expression`` or ``MetricStat``, but not both. */ metricStat?: pulumi.Input; /** - * Indicates whether to return the timestamps and raw data values of this metric. + * Indicates whether to return the timestamps and raw data values of this metric. + * 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. + * 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``). */ returnData?: pulumi.Input; } + /** + * Describes the dimension of a metric. + */ export interface ScalingPolicyPredictiveScalingMetricDimensionArgs { /** * The name of the dimension. @@ -4317,6 +4339,10 @@ export namespace applicationautoscaling { value?: pulumi.Input; } + /** + * This structure specifies the metrics and target utilization settings for a predictive scaling policy. + * 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. + */ export interface ScalingPolicyPredictiveScalingMetricSpecificationArgs { /** * The customized capacity metric specification. @@ -4348,50 +4374,58 @@ export namespace applicationautoscaling { targetValue: pulumi.Input; } + /** + * This structure defines the CloudWatch metric to return, along with the statistic and unit. + */ export interface ScalingPolicyPredictiveScalingMetricStatArgs { /** - * The CloudWatch metric to return, including the metric name, namespace, and dimensions. + * 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). */ metric?: pulumi.Input; /** - * The statistic to return. It can include any CloudWatch statistic or extended statistic. + * 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*. + * The most commonly used metrics for predictive scaling are ``Average`` and ``Sum``. */ stat?: pulumi.Input; /** - * The unit to use for the returned data points. + * 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*. */ unit?: pulumi.Input; } + /** + * Represents a predictive scaling policy configuration. + */ export interface ScalingPolicyPredictiveScalingPolicyConfigurationArgs { /** - * Defines the behavior that should be applied if the forecast capacity approaches or exceeds the maximum capacity. Defaults to `HonorMaxCapacity` if not specified. + * Defines the behavior that should be applied if the forecast capacity approaches or exceeds the maximum capacity. Defaults to ``HonorMaxCapacity`` if not specified. */ maxCapacityBreachBehavior?: pulumi.Input; /** - * 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. - * - * Required if the `MaxCapacityBreachBehavior` property is set to `IncreaseMaxCapacity` , and cannot be used otherwise. + * 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. + * Required if the ``MaxCapacityBreachBehavior`` property is set to ``IncreaseMaxCapacity``, and cannot be used otherwise. */ maxCapacityBuffer?: pulumi.Input; /** - * This structure includes the metrics and target utilization to use for predictive scaling. - * - * 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. + * This structure includes the metrics and target utilization to use for predictive scaling. + * 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. */ metricSpecifications: pulumi.Input[]>; /** - * The predictive scaling mode. Defaults to `ForecastOnly` if not specified. + * The predictive scaling mode. Defaults to ``ForecastOnly`` if not specified. */ mode?: pulumi.Input; /** - * The amount of time, in seconds, that the start time can be advanced. - * - * The value must be less than the forecast interval duration of 3600 seconds (60 minutes). Defaults to 300 seconds if not specified. + * The amount of time, in seconds, that the start time can be advanced. + * The value must be less than the forecast interval duration of 3600 seconds (60 minutes). Defaults to 300 seconds if not specified. */ schedulingBufferTime?: pulumi.Input; } + /** + * Describes a load metric for a predictive scaling policy. + * 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. + */ export interface ScalingPolicyPredictiveScalingPredefinedLoadMetricArgs { /** * The metric type. @@ -4403,6 +4437,9 @@ export namespace applicationautoscaling { resourceLabel?: pulumi.Input; } + /** + * Represents a metric pair for a predictive scaling policy. + */ export interface ScalingPolicyPredictiveScalingPredefinedMetricPairArgs { /** * 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. @@ -4414,6 +4451,10 @@ export namespace applicationautoscaling { resourceLabel?: pulumi.Input; } + /** + * Describes a scaling metric for a predictive scaling policy. + * 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. + */ export interface ScalingPolicyPredictiveScalingPredefinedScalingMetricArgs { /** * The metric type. @@ -10043,7 +10084,7 @@ export namespace bedrock { */ export interface DataSourceParsingConfigurationArgs { /** - * Settings for a foundation model used to parse documents for a data source. + * If you specify `BEDROCK_FOUNDATION_MODEL` as the parsing strategy for ingesting your data source, use this object to modify configurations for using a foundation model to parse documents. */ bedrockFoundationModelConfiguration?: pulumi.Input; /** @@ -10303,7 +10344,7 @@ export namespace bedrock { */ customTransformationConfiguration?: pulumi.Input; /** - * A custom parser for data source documents. + * Configurations for a parser to use for parsing documents in your data source. If you exclude this field, the default parser will be used. */ parsingConfiguration?: pulumi.Input; } @@ -10960,7 +11001,7 @@ export namespace bedrock { * A physical address, such as "100 Main Street, Anytown, USA" or "Suite #12, Building 123". An address can include information such as the street, building, location, city, state, country, county, zip code, precinct, and neighborhood. * - *AGE* * - * An individual's age, including the quantity and unit of time. For example, in the phrase "I am 40 years old," Guarrails recognizes "40 years" as an age. + * An individual's age, including the quantity and unit of time. For example, in the phrase "I am 40 years old," Guardrails recognizes "40 years" as an age. * - *NAME* * * An individual's name. This entity type does not include titles, such as Dr., Mr., Mrs., or Miss. guardrails doesn't apply this entity type to names that are part of organizations or addresses. For example, guardrails recognizes the "John Doe Organization" as an organization, and it recognizes "Jane Doe Street" as an address. @@ -10987,7 +11028,7 @@ export namespace bedrock { * A Vehicle Identification Number (VIN) uniquely identifies a vehicle. VIN content and format are defined in the *ISO 3779* specification. Each country has specific codes and formats for VINs. * - *Finance* * - * - *REDIT_DEBIT_CARD_CVV* + * - *CREDIT_DEBIT_CARD_CVV* * * A three-digit card verification code (CVV) that is present on VISA, MasterCard, and Discover credit and debit cards. For American Express credit or debit cards, the CVV is a four-digit numeric code. * - *CREDIT_DEBIT_CARD_EXPIRY* @@ -15537,6 +15578,9 @@ export namespace cognito { } export interface UserPoolAddOnsArgs { + /** + * Advanced security configuration options for additional authentication types in your user pool, including custom authentication. + */ advancedSecurityAdditionalFlows?: pulumi.Input; /** * The operating mode of advanced security features for standard authentication types in your user pool, including username-password and secure remote password (SRP) authentication. @@ -15566,6 +15610,9 @@ export namespace cognito { } export interface UserPoolAdvancedSecurityAdditionalFlowsArgs { + /** + * The operating mode of advanced security features in custom authentication with [Custom authentication challenge Lambda triggers](https://docs.aws.amazon.com/cognito/latest/developerguide/user-pool-lambda-challenge.html) . + */ customAuthMode?: pulumi.Input; } @@ -15824,6 +15871,11 @@ export namespace cognito { * The password policy settings for a user pool, including complexity, history, and length requirements. */ passwordPolicy?: pulumi.Input; + /** + * The policy for allowed types of authentication in a user pool. + * + * This data type is a request and response parameter of [CreateUserPool](https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_CreateUserPool.html) and [UpdateUserPool](https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_UpdateUserPool.html) , and a response parameter of [DescribeUserPool](https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_DescribeUserPool.html) . + */ signInPolicy?: pulumi.Input; } @@ -16011,6 +16063,11 @@ export namespace cognito { } export interface UserPoolSignInPolicyArgs { + /** + * The sign-in methods that a user pool supports as the first factor. You can permit users to start authentication with a standard username and password, or with other one-time password and hardware factors. + * + * Supports values of `EMAIL_OTP` , `SMS_OTP` , `WEB_AUTHN` and `PASSWORD` , + */ allowedFirstAuthFactors?: pulumi.Input[]>; } @@ -22730,10 +22787,6 @@ export namespace ec2 { min?: pulumi.Input; } - /** - * The baseline performance to consider, using an instance family as a baseline reference. The instance family establishes the lowest acceptable level of performance. Amazon EC2 uses this baseline to guide instance type selection, but there is no guarantee that the selected instance types will always exceed the baseline for every application. - * Currently, this parameter only supports CPU performance as a baseline performance factor. For example, specifying ``c6i`` would use the CPU performance of the ``c6i`` family as the baseline reference. - */ export interface LaunchTemplateBaselinePerformanceFactorsArgs { /** * The CPU performance to consider, using an instance family as the baseline reference. @@ -22771,8 +22824,7 @@ export namespace ec2 { export interface LaunchTemplateCapacityReservationSpecificationArgs { /** * Indicates the instance's Capacity Reservation preferences. Possible preferences include: - * + ``capacity-reservations-only`` - The instance will only run in a Capacity Reservation or Capacity Reservation group. If capacity isn't available, the instance will fail to launch. - * + ``open`` - The instance can run in any ``open`` Capacity Reservation that has matching attributes (instance type, platform, Availability Zone, tenancy). + * + ``open`` - The instance can run in any ``open`` Capacity Reservation that has matching attributes (instance type, platform, Availability Zone). * + ``none`` - The instance avoids running in a Capacity Reservation even if one is available. The instance runs in On-Demand capacity. */ capacityReservationPreference?: pulumi.Input; @@ -22889,8 +22941,7 @@ export namespace ec2 { */ elasticGpuSpecifications?: pulumi.Input[]>; /** - * Amazon Elastic Inference is no longer available. - * An elastic inference accelerator to associate with the instance. Elastic inference accelerators are a resource you can attach to your Amazon EC2 instances to accelerate your Deep Learning (DL) inference workloads. + * An elastic inference accelerator to associate with the instance. Elastic inference accelerators are a resource you can attach to your Amazon EC2 instances to accelerate your Deep Learning (DL) inference workloads. * You cannot specify accelerators from different generations in the same request. * Starting April 15, 2023, AWS will not onboard new customers to Amazon Elastic Inference (EI), and will help current customers migrate their workloads to options that offer better price and performance. After April 15, 2023, new customers will not be able to launch instances with Amazon EI accelerators in Amazon SageMaker, Amazon ECS, or Amazon EC2. However, customers who have used Amazon EI at least once during the past 30-day period are considered current customers and will be able to continue using the service. */ @@ -22938,7 +22989,7 @@ export namespace ec2 { * * If you specify ``InstanceRequirements``, you can't specify ``InstanceType``. * Attribute-based instance type selection is only supported when using Auto Scaling groups, EC2 Fleet, and Spot Fleet to launch instances. If you plan to use the launch template in the [launch instance wizard](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ec2-launch-instance-wizard.html), or with the [RunInstances](https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_RunInstances.html) API or [AWS::EC2::Instance](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-instance.html) AWS CloudFormation resource, you can't specify ``InstanceRequirements``. - * For more information, see [Specify attributes for instance type selection for EC2 Fleet or Spot Fleet](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ec2-fleet-attribute-based-instance-type-selection.html) and [Spot placement score](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/spot-placement-score.html) in the *Amazon EC2 User Guide*. + * For more information, see [Attribute-based instance type selection for EC2 Fleet](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ec2-fleet-attribute-based-instance-type-selection.html), [Attribute-based instance type selection for Spot Fleet](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/spot-fleet-attribute-based-instance-type-selection.html), and [Spot placement score](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/spot-placement-score.html) in the *Amazon EC2 User Guide*. */ instanceRequirements?: pulumi.Input; /** @@ -22976,7 +23027,6 @@ export namespace ec2 { * The network interfaces for the instance. */ networkInterfaces?: pulumi.Input[]>; - networkPerformanceOptions?: any; /** * The placement for the instance. */ @@ -23001,7 +23051,8 @@ export namespace ec2 { */ securityGroups?: pulumi.Input[]>; /** - * The tags to apply to resources that are created during instance launch. + * The tags to apply to the resources that are created during instance launch. + * To tag a resource after it has been created, see [CreateTags](https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_CreateTags.html). * To tag the launch template itself, use [TagSpecifications](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-launchtemplate.html#cfn-ec2-launchtemplate-tagspecifications). */ tagSpecifications?: pulumi.Input[]>; @@ -23037,7 +23088,7 @@ export namespace ec2 { */ iops?: pulumi.Input; /** - * Identifier (key ID, key alias, key ARN, or alias ARN) of the customer managed KMS key to use for EBS encryption. + * The ARN of the symmetric KMSlong (KMS) CMK used for encryption. */ kmsKeyId?: pulumi.Input; /** @@ -23180,7 +23231,7 @@ export namespace ec2 { * * If you specify ``InstanceRequirements``, you can't specify ``InstanceType``. * Attribute-based instance type selection is only supported when using Auto Scaling groups, EC2 Fleet, and Spot Fleet to launch instances. If you plan to use the launch template in the [launch instance wizard](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ec2-launch-instance-wizard.html), or with the [RunInstances](https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_RunInstances.html) API or [AWS::EC2::Instance](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-instance.html) AWS CloudFormation resource, you can't specify ``InstanceRequirements``. - * For more information, see [Specify attributes for instance type selection for EC2 Fleet or Spot Fleet](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ec2-fleet-attribute-based-instance-type-selection.html) and [Spot placement score](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/spot-placement-score.html) in the *Amazon EC2 User Guide*. + * For more information, see [Attribute-based instance type selection for EC2 Fleet](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ec2-fleet-attribute-based-instance-type-selection.html), [Attribute-based instance type selection for Spot Fleet](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/spot-fleet-attribute-based-instance-type-selection.html), and [Spot placement score](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/spot-placement-score.html) in the *Amazon EC2 User Guide*. */ export interface LaunchTemplateInstanceRequirementsArgs { /** @@ -23227,6 +23278,7 @@ export namespace ec2 { * The accelerator types that must be on the instance type. * + For instance types with GPU accelerators, specify ``gpu``. * + For instance types with FPGA accelerators, specify ``fpga``. + * + For instance types with inference accelerators, specify ``inference``. * * Default: Any accelerator type */ @@ -23254,7 +23306,7 @@ export namespace ec2 { */ baselineEbsBandwidthMbps?: pulumi.Input; /** - * The baseline performance to consider, using an instance family as a baseline reference. The instance family establishes the lowest acceptable level of performance. Amazon EC2 uses this baseline to guide instance type selection, but there is no guarantee that the selected instance types will always exceed the baseline for every application. Currently, this parameter only supports CPU performance as a baseline performance factor. For more information, see [Performance protection](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ec2-fleet-attribute-based-instance-type-selection.html#ec2fleet-abis-performance-protection) in the *Amazon EC2 User Guide*. + * The baseline performance to consider, using an instance family as a baseline reference. The instance family establishes the lowest acceptable level of performance. Amazon EC2 uses this baseline to guide instance type selection, but there is no guarantee that the selected instance types will always exceed the baseline for every application. Currently, this parameter only supports CPU performance as a baseline performance factor. For more information, see [Performance protection](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ec2-fleet-attribute-based-instance-type-selection.html#ec2fleet-abis-performance-protection) in the *Amazon EC2 User Guide* . */ baselinePerformanceFactors?: pulumi.Input; /** @@ -23271,7 +23323,6 @@ export namespace ec2 { * + For instance types with Intel CPUs, specify ``intel``. * + For instance types with AMD CPUs, specify ``amd``. * + For instance types with AWS CPUs, specify ``amazon-web-services``. - * + For instance types with Apple CPUs, specify ``apple``. * * Don't confuse the CPU manufacturer with the CPU architecture. Instances will be launched with a compatible CPU architecture based on the Amazon Machine Image (AMI) that you specify in your launch template. * Default: Any manufacturer @@ -23554,10 +23605,9 @@ export namespace ec2 { */ groups?: pulumi.Input[]>; /** - * The type of network interface. To create an Elastic Fabric Adapter (EFA), specify ``efa`` or ``efa``. For more information, see [Elastic Fabric Adapter](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/efa.html) in the *Amazon EC2 User Guide*. + * The type of network interface. To create an Elastic Fabric Adapter (EFA), specify ``efa``. For more information, see [Elastic Fabric Adapter](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/efa.html) in the *Amazon EC2 User Guide*. * If you are not creating an EFA, specify ``interface`` or omit this parameter. - * If you specify ``efa-only``, do not assign any IP addresses to the network interface. EFA-only network interfaces do not support IP addresses. - * Valid values: ``interface`` | ``efa`` | ``efa-only`` + * Valid values: ``interface`` | ``efa`` */ interfaceType?: pulumi.Input; /** @@ -23705,6 +23755,9 @@ export namespace ec2 { } export interface LaunchTemplateReferenceArgs { + /** + * The instance family to refer. Ensure that you specify the correct family name. For example, C6i and C6g are valid values, but C6 is not. + */ instanceFamily?: pulumi.Input; } @@ -23757,7 +23810,6 @@ export namespace ec2 { /** * Specifies the tags to apply to the launch template during creation. - * To specify the tags for the resources that are created during instance launch, use [AWS::EC2::LaunchTemplate TagSpecification](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-launchtemplate-tagspecification.html). * ``LaunchTemplateTagSpecification`` is a property of [AWS::EC2::LaunchTemplate](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-launchtemplate.html). */ export interface LaunchTemplateTagSpecificationArgs { @@ -24347,7 +24399,7 @@ export namespace ec2 { */ privateIpAddresses?: pulumi.Input[]>; /** - * The number of secondary private IPv4 addresses. You can't specify this option and specify more than one private IP address using the private IP addresses option. You cannot specify this option if you're launching more than one instance in a [RunInstances](https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_RunInstances.html) request. + * The number of secondary private IPv4 addresses. You can’t specify this parameter and also specify a secondary private IP address using the `PrivateIpAddress` parameter. */ secondaryPrivateIpAddressCount?: pulumi.Input; /** @@ -25039,7 +25091,7 @@ export namespace ec2 { } /** - * Specifies the tags to apply to resources that are created during instance launch. + * Specifies the tags to apply to a resource when the resource is created for the launch template. * ``TagSpecification`` is a property type of [TagSpecifications](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-launchtemplate-launchtemplatedata.html#cfn-ec2-launchtemplate-launchtemplatedata-tagspecifications). [TagSpecifications](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-launchtemplate-launchtemplatedata.html#cfn-ec2-launchtemplate-launchtemplatedata-tagspecifications) is a property of [AWS::EC2::LaunchTemplate LaunchTemplateData](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-launchtemplate-launchtemplatedata.html). */ export interface TagSpecificationArgs { @@ -26654,7 +26706,7 @@ export namespace ecs { */ user?: pulumi.Input; /** - * Specifies whether Amazon ECS will resolve the container image tag provided in the container definition to an image digest. By default, the value is `enabled` . If you set the value for a container as `disabled` , Amazon ECS will not resolve the provided container image tag to a digest and will use the original image URI specified in the container definition for deployment. For more information about container image resolution, see [Container image resolution](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/deployment-type-ecs.html#deployment-container-image-stability) in the *Amazon ECS Developer Guide* . + * Specifies whether Amazon ECS will resolve the container image tag provided in the container definition to an image digest. By default, the value is ``enabled``. If you set the value for a container as ``disabled``, Amazon ECS will not resolve the provided container image tag to a digest and will use the original image URI specified in the container definition for deployment. For more information about container image resolution, see [Container image resolution](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/deployment-type-ecs.html#deployment-container-image-stability) in the *Amazon ECS Developer Guide*. */ versionConsistency?: pulumi.Input; /** @@ -29687,6 +29739,11 @@ export namespace events { * The authorization parameters for Basic authorization. */ basicAuthParameters?: pulumi.Input; + /** + * For private OAuth authentication endpoints. The parameters EventBridge uses to authenticate against the endpoint. + * + * For more information, see [Authorization methods for connections](https://docs.aws.amazon.com/eventbridge/latest/userguide/eb-target-connection-auth.html) in the **Amazon EventBridge User Guide** . + */ connectivityParameters?: pulumi.Input; /** * Additional parameters for the connection that are passed through with every invocation to the HTTP endpoint. @@ -29721,6 +29778,9 @@ export namespace events { } export interface ConnectionConnectivityParametersArgs { + /** + * The parameters for EventBridge to use when invoking the resource endpoint. + */ resourceParameters: pulumi.Input; } @@ -29774,7 +29834,15 @@ export namespace events { } export interface ConnectionResourceParametersArgs { + /** + * For connections to private APIs, the Amazon Resource Name (ARN) of the resource association EventBridge created between the connection and the private API's resource configuration. + * + * > The value of this property is set by EventBridge . Any value you specify in your template is ignored. + */ resourceAssociationArn?: pulumi.Input; + /** + * The Amazon Resource Name (ARN) of the Amazon VPC Lattice resource configuration for the resource endpoint. + */ resourceConfigurationArn: pulumi.Input; } @@ -29835,6 +29903,9 @@ export namespace events { * The private resource the HTTP request will be sent to. */ export interface InvocationConnectivityParametersPropertiesArgs { + /** + * The parameters for EventBridge to use when invoking the resource endpoint. + */ resourceParameters: pulumi.Input; } @@ -35127,6 +35198,9 @@ export namespace internetmonitor { export namespace invoicing { export interface InvoiceUnitRuleArgs { + /** + * The list of `LINKED_ACCOUNT` IDs where charges are included within the invoice unit. + */ linkedAccounts: pulumi.Input[]>; } } @@ -35272,6 +35346,28 @@ export namespace iot { templateName?: pulumi.Input; } + export interface CommandParameterArgs { + defaultValue?: pulumi.Input; + description?: pulumi.Input; + name: pulumi.Input; + value?: pulumi.Input; + } + + export interface CommandParameterValueArgs { + b?: pulumi.Input; + bin?: pulumi.Input; + d?: pulumi.Input; + i?: pulumi.Input; + l?: pulumi.Input; + s?: pulumi.Input; + ul?: pulumi.Input; + } + + export interface CommandPayloadArgs { + content?: pulumi.Input; + contentType?: pulumi.Input; + } + export interface DomainConfigurationAuthorizerConfigArgs { /** * A Boolean that specifies whether the domain configuration's authorization service can be overridden. @@ -81912,6 +82008,11 @@ export namespace redshiftserverless { parameterValue?: pulumi.Input; } + export interface WorkgroupPerformanceTargetArgs { + level?: pulumi.Input; + status?: pulumi.Input; + } + } export namespace refactorspaces { @@ -83494,6 +83595,29 @@ export namespace s3 { targetObjectKeyFormat?: pulumi.Input; } + export interface BucketMetadataTableConfigurationArgs { + /** + * Returns the Error value of the GetBucketMetadataTableConfiguration response. + */ + error?: pulumi.Input; + s3TablesDestination: pulumi.Input; + /** + * Returns the Status value of the GetBucketMetadataTableConfigurationResult response. This value indicates the status of the metadata table. The status values are:
CREATING - The metadata table is in the process of being created in the specified table bucket.
ACTIVE - The metadata table has been created successfully and records are being delivered to the table.
FAILED - Amazon S3 is unable to create the metadata table, or Amazon S3 is unable to deliver records. + */ + status?: pulumi.Input; + } + + export interface BucketMetadataTableErrorArgs { + /** + * If the CreateBucketMetadataTableConfiguration request succeeds, but S3 Metadata was unable to create the table, this structure contains the error code. The possible error codes and error messages are as follows:
AccessDeniedCreatingResources - You don't have sufficient permissions to create the required resources. Make sure that you have s3tables:CreateNamespace, s3tables:CreateTable, s3tables:GetTable and s3tables:PutTablePolicy permissions, and then try again. To create a new metadata table, you must delete the metadata configuration for this bucket, and then create a new metadata configuration.
AccessDeniedWritingToTable - Unable to write to the metadata table because of missing resource permissions. To fix the resource policy, Amazon S3 needs to create a new metadata table. To create a new metadata table, you must delete the metadata configuration for this bucket, and then create a new metadata configuration.
DestinationTableNotFound - The destination table doesn't exist. To create a new metadata table, you must delete the metadata configuration for this bucket, and then create a new metadata configuration.
ServerInternalError - An internal error has occurred. To create a new metadata table, you must delete the metadata configuration for this bucket, and then create a new metadata configuration.
TableAlreadyExists - The table that you specified already exists in the table bucket's namespace. Specify a different table name. To create a new metadata table, you must delete the metadata configuration for this bucket, and then create a new metadata configuration.
TableBucketNotFound - The table bucket that you specified doesn't exist in this AWS Region and account. Create or choose a different table bucket. To create a new metadata table, you must delete the metadata configuration for this bucket, and then create a new metadata configuration. + */ + errorCode: pulumi.Input; + /** + * If the CreateBucketMetadataTableConfiguration request succeeds, but S3 Metadata was unable to create the table, this structure contains the error code. The possible error codes and error messages are as follows:
AccessDeniedCreatingResources - You don't have sufficient permissions to create the required resources. Make sure that you have s3tables:CreateNamespace, s3tables:CreateTable, s3tables:GetTable and s3tables:PutTablePolicy permissions, and then try again. To create a new metadata table, you must delete the metadata configuration for this bucket, and then create a new metadata configuration.
AccessDeniedWritingToTable - Unable to write to the metadata table because of missing resource permissions. To fix the resource policy, Amazon S3 needs to create a new metadata table. To create a new metadata table, you must delete the metadata configuration for this bucket, and then create a new metadata configuration.
DestinationTableNotFound - The destination table doesn't exist. To create a new metadata table, you must delete the metadata configuration for this bucket, and then create a new metadata configuration.
ServerInternalError - An internal error has occurred. To create a new metadata table, you must delete the metadata configuration for this bucket, and then create a new metadata configuration.
TableAlreadyExists - The table that you specified already exists in the table bucket's namespace. Specify a different table name. To create a new metadata table, you must delete the metadata configuration for this bucket, and then create a new metadata configuration.
TableBucketNotFound - The table bucket that you specified doesn't exist in this AWS Region and account. Create or choose a different table bucket. To create a new metadata table, you must delete the metadata configuration for this bucket, and then create a new metadata configuration. + */ + errorMessage: pulumi.Input; + } + /** * A container specifying replication metrics-related settings enabling replication metrics and events. */ @@ -84015,6 +84139,25 @@ export namespace s3 { rules: pulumi.Input[]>; } + export interface BucketS3TablesDestinationArgs { + /** + * The Amazon Resource Name (ARN) for the metadata table in the metadata table configuration. The specified metadata table name must be unique within the aws_s3_metadata namespace in the destination table bucket. + */ + tableArn?: pulumi.Input; + /** + * The Amazon Resource Name (ARN) for the table bucket that's specified as the destination in the metadata table configuration. The destination table bucket must be in the same Region and AWS account as the general purpose bucket. + */ + tableBucketArn: pulumi.Input; + /** + * The name for the metadata table in your metadata table configuration. The specified metadata table name must be unique within the aws_s3_metadata namespace in the destination table bucket. + */ + tableName: pulumi.Input; + /** + * The table bucket namespace for the metadata table in your metadata table configuration. This value is always aws_s3_metadata. + */ + tableNamespace?: pulumi.Input; + } + /** * Describes the default server-side encryption to apply to new objects in the bucket. If a PUT Object request doesn't specify any server-side encryption, this default encryption will be applied. For more information, see [PutBucketEncryption](https://docs.aws.amazon.com/AmazonS3/latest/API/RESTBucketPUTencryption.html). * + *General purpose buckets* - If you don't specify a customer managed key at configuration, Amazon S3 automatically creates an AWS KMS key (``aws/s3``) in your AWS account the first time that you add an object encrypted with SSE-KMS to a bucket. By default, Amazon S3 uses this KMS key for SSE-KMS. @@ -84888,6 +85031,32 @@ export namespace s3outposts { } +export namespace s3tables { + /** + * A policy document containing permissions to add to the specified table bucket. In IAM, you must provide policy documents in JSON format. However, in CloudFormation you can provide the policy in JSON or YAML format because CloudFormation converts YAML to JSON before submitting it to IAM. + */ + export interface TableBucketPolicyResourcePolicyArgs { + } + + /** + * Settings governing the Unreferenced File Removal maintenance action. Unreferenced file removal identifies and deletes all objects that are not referenced by any table snapshots. + */ + export interface TableBucketUnreferencedFileRemovalArgs { + /** + * S3 permanently deletes noncurrent objects after the number of days specified by the NoncurrentDays property. + */ + noncurrentDays?: pulumi.Input; + /** + * Indicates whether the Unreferenced File Removal maintenance action is enabled. + */ + status?: pulumi.Input; + /** + * For any object not referenced by your table and older than the UnreferencedDays property, S3 creates a delete marker and marks the object version as noncurrent. + */ + unreferencedDays?: pulumi.Input; + } +} + export namespace sagemaker { /** * The configuration for the kernels in a SageMaker image running as a CodeEditor app. diff --git a/sdk/nodejs/types/output.ts b/sdk/nodejs/types/output.ts index 07ed13d707..fc98509909 100644 --- a/sdk/nodejs/types/output.ts +++ b/sdk/nodejs/types/output.ts @@ -4149,6 +4149,9 @@ export namespace applicationautoscaling { resourceLabel?: string; } + /** + * Represents a CloudWatch metric of your choosing for a predictive scaling policy. + */ export interface ScalingPolicyPredictiveScalingCustomizedCapacityMetric { /** * One or more metric data queries to provide data points for a metric specification. @@ -4156,10 +4159,16 @@ export namespace applicationautoscaling { metricDataQueries: outputs.applicationautoscaling.ScalingPolicyPredictiveScalingMetricDataQuery[]; } + /** + * The customized load metric specification. + */ export interface ScalingPolicyPredictiveScalingCustomizedLoadMetric { metricDataQueries: outputs.applicationautoscaling.ScalingPolicyPredictiveScalingMetricDataQuery[]; } + /** + * One or more metric data queries to provide data points for a metric specification. + */ export interface ScalingPolicyPredictiveScalingCustomizedScalingMetric { /** * One or more metric data queries to provide data points for a metric specification. @@ -4167,9 +4176,12 @@ export namespace applicationautoscaling { metricDataQueries: outputs.applicationautoscaling.ScalingPolicyPredictiveScalingMetricDataQuery[]; } + /** + * Describes the scaling metric. + */ export interface ScalingPolicyPredictiveScalingMetric { /** - * The dimensions for the metric. + * Describes the dimensions of the metric. */ dimensions?: outputs.applicationautoscaling.ScalingPolicyPredictiveScalingMetricDimension[]; /** @@ -4182,13 +4194,17 @@ export namespace applicationautoscaling { namespace?: string; } + /** + * 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. + */ export interface ScalingPolicyPredictiveScalingMetricDataQuery { /** - * The math expression to perform on the returned data, if this object is performing a math expression. + * 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. + * Conditional: Within each ``MetricDataQuery`` object, you must specify either ``Expression`` or ``MetricStat``, but not both. */ expression?: string; /** - * A short name that identifies the object's results in the response. + * 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. */ id?: string; /** @@ -4196,15 +4212,21 @@ export namespace applicationautoscaling { */ label?: string; /** - * Information about the metric data to return. + * Information about the metric data to return. + * Conditional: Within each ``MetricDataQuery`` object, you must specify either ``Expression`` or ``MetricStat``, but not both. */ metricStat?: outputs.applicationautoscaling.ScalingPolicyPredictiveScalingMetricStat; /** - * Indicates whether to return the timestamps and raw data values of this metric. + * Indicates whether to return the timestamps and raw data values of this metric. + * 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. + * 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``). */ returnData?: boolean; } + /** + * Describes the dimension of a metric. + */ export interface ScalingPolicyPredictiveScalingMetricDimension { /** * The name of the dimension. @@ -4216,6 +4238,10 @@ export namespace applicationautoscaling { value?: string; } + /** + * This structure specifies the metrics and target utilization settings for a predictive scaling policy. + * 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. + */ export interface ScalingPolicyPredictiveScalingMetricSpecification { /** * The customized capacity metric specification. @@ -4247,50 +4273,58 @@ export namespace applicationautoscaling { targetValue: number; } + /** + * This structure defines the CloudWatch metric to return, along with the statistic and unit. + */ export interface ScalingPolicyPredictiveScalingMetricStat { /** - * The CloudWatch metric to return, including the metric name, namespace, and dimensions. + * 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). */ metric?: outputs.applicationautoscaling.ScalingPolicyPredictiveScalingMetric; /** - * The statistic to return. It can include any CloudWatch statistic or extended statistic. + * 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*. + * The most commonly used metrics for predictive scaling are ``Average`` and ``Sum``. */ stat?: string; /** - * The unit to use for the returned data points. + * 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*. */ unit?: string; } + /** + * Represents a predictive scaling policy configuration. + */ export interface ScalingPolicyPredictiveScalingPolicyConfiguration { /** - * Defines the behavior that should be applied if the forecast capacity approaches or exceeds the maximum capacity. Defaults to `HonorMaxCapacity` if not specified. + * Defines the behavior that should be applied if the forecast capacity approaches or exceeds the maximum capacity. Defaults to ``HonorMaxCapacity`` if not specified. */ maxCapacityBreachBehavior?: string; /** - * 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. - * - * Required if the `MaxCapacityBreachBehavior` property is set to `IncreaseMaxCapacity` , and cannot be used otherwise. + * 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. + * Required if the ``MaxCapacityBreachBehavior`` property is set to ``IncreaseMaxCapacity``, and cannot be used otherwise. */ maxCapacityBuffer?: number; /** - * This structure includes the metrics and target utilization to use for predictive scaling. - * - * 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. + * This structure includes the metrics and target utilization to use for predictive scaling. + * 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. */ metricSpecifications: outputs.applicationautoscaling.ScalingPolicyPredictiveScalingMetricSpecification[]; /** - * The predictive scaling mode. Defaults to `ForecastOnly` if not specified. + * The predictive scaling mode. Defaults to ``ForecastOnly`` if not specified. */ mode?: string; /** - * The amount of time, in seconds, that the start time can be advanced. - * - * The value must be less than the forecast interval duration of 3600 seconds (60 minutes). Defaults to 300 seconds if not specified. + * The amount of time, in seconds, that the start time can be advanced. + * The value must be less than the forecast interval duration of 3600 seconds (60 minutes). Defaults to 300 seconds if not specified. */ schedulingBufferTime?: number; } + /** + * Describes a load metric for a predictive scaling policy. + * 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. + */ export interface ScalingPolicyPredictiveScalingPredefinedLoadMetric { /** * The metric type. @@ -4302,6 +4336,9 @@ export namespace applicationautoscaling { resourceLabel?: string; } + /** + * Represents a metric pair for a predictive scaling policy. + */ export interface ScalingPolicyPredictiveScalingPredefinedMetricPair { /** * 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. @@ -4313,6 +4350,10 @@ export namespace applicationautoscaling { resourceLabel?: string; } + /** + * Describes a scaling metric for a predictive scaling policy. + * 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. + */ export interface ScalingPolicyPredictiveScalingPredefinedScalingMetric { /** * The metric type. @@ -9993,7 +10034,7 @@ export namespace bedrock { */ export interface DataSourceParsingConfiguration { /** - * Settings for a foundation model used to parse documents for a data source. + * If you specify `BEDROCK_FOUNDATION_MODEL` as the parsing strategy for ingesting your data source, use this object to modify configurations for using a foundation model to parse documents. */ bedrockFoundationModelConfiguration?: outputs.bedrock.DataSourceBedrockFoundationModelConfiguration; /** @@ -10253,7 +10294,7 @@ export namespace bedrock { */ customTransformationConfiguration?: outputs.bedrock.DataSourceCustomTransformationConfiguration; /** - * A custom parser for data source documents. + * Configurations for a parser to use for parsing documents in your data source. If you exclude this field, the default parser will be used. */ parsingConfiguration?: outputs.bedrock.DataSourceParsingConfiguration; } @@ -11404,7 +11445,7 @@ export namespace bedrock { * A physical address, such as "100 Main Street, Anytown, USA" or "Suite #12, Building 123". An address can include information such as the street, building, location, city, state, country, county, zip code, precinct, and neighborhood. * - *AGE* * - * An individual's age, including the quantity and unit of time. For example, in the phrase "I am 40 years old," Guarrails recognizes "40 years" as an age. + * An individual's age, including the quantity and unit of time. For example, in the phrase "I am 40 years old," Guardrails recognizes "40 years" as an age. * - *NAME* * * An individual's name. This entity type does not include titles, such as Dr., Mr., Mrs., or Miss. guardrails doesn't apply this entity type to names that are part of organizations or addresses. For example, guardrails recognizes the "John Doe Organization" as an organization, and it recognizes "Jane Doe Street" as an address. @@ -11431,7 +11472,7 @@ export namespace bedrock { * A Vehicle Identification Number (VIN) uniquely identifies a vehicle. VIN content and format are defined in the *ISO 3779* specification. Each country has specific codes and formats for VINs. * - *Finance* * - * - *REDIT_DEBIT_CARD_CVV* + * - *CREDIT_DEBIT_CARD_CVV* * * A three-digit card verification code (CVV) that is present on VISA, MasterCard, and Discover credit and debit cards. For American Express credit or debit cards, the CVV is a four-digit numeric code. * - *CREDIT_DEBIT_CARD_EXPIRY* @@ -16135,6 +16176,9 @@ export namespace cognito { } export interface UserPoolAddOns { + /** + * Advanced security configuration options for additional authentication types in your user pool, including custom authentication. + */ advancedSecurityAdditionalFlows?: outputs.cognito.UserPoolAdvancedSecurityAdditionalFlows; /** * The operating mode of advanced security features for standard authentication types in your user pool, including username-password and secure remote password (SRP) authentication. @@ -16164,6 +16208,9 @@ export namespace cognito { } export interface UserPoolAdvancedSecurityAdditionalFlows { + /** + * The operating mode of advanced security features in custom authentication with [Custom authentication challenge Lambda triggers](https://docs.aws.amazon.com/cognito/latest/developerguide/user-pool-lambda-challenge.html) . + */ customAuthMode?: string; } @@ -16422,6 +16469,11 @@ export namespace cognito { * The password policy settings for a user pool, including complexity, history, and length requirements. */ passwordPolicy?: outputs.cognito.UserPoolPasswordPolicy; + /** + * The policy for allowed types of authentication in a user pool. + * + * This data type is a request and response parameter of [CreateUserPool](https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_CreateUserPool.html) and [UpdateUserPool](https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_UpdateUserPool.html) , and a response parameter of [DescribeUserPool](https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_DescribeUserPool.html) . + */ signInPolicy?: outputs.cognito.UserPoolSignInPolicy; } @@ -16609,6 +16661,11 @@ export namespace cognito { } export interface UserPoolSignInPolicy { + /** + * The sign-in methods that a user pool supports as the first factor. You can permit users to start authentication with a standard username and password, or with other one-time password and hardware factors. + * + * Supports values of `EMAIL_OTP` , `SMS_OTP` , `WEB_AUTHN` and `PASSWORD` , + */ allowedFirstAuthFactors?: string[]; } @@ -23545,10 +23602,6 @@ export namespace ec2 { min?: number; } - /** - * The baseline performance to consider, using an instance family as a baseline reference. The instance family establishes the lowest acceptable level of performance. Amazon EC2 uses this baseline to guide instance type selection, but there is no guarantee that the selected instance types will always exceed the baseline for every application. - * Currently, this parameter only supports CPU performance as a baseline performance factor. For example, specifying ``c6i`` would use the CPU performance of the ``c6i`` family as the baseline reference. - */ export interface LaunchTemplateBaselinePerformanceFactors { /** * The CPU performance to consider, using an instance family as the baseline reference. @@ -23586,8 +23639,7 @@ export namespace ec2 { export interface LaunchTemplateCapacityReservationSpecification { /** * Indicates the instance's Capacity Reservation preferences. Possible preferences include: - * + ``capacity-reservations-only`` - The instance will only run in a Capacity Reservation or Capacity Reservation group. If capacity isn't available, the instance will fail to launch. - * + ``open`` - The instance can run in any ``open`` Capacity Reservation that has matching attributes (instance type, platform, Availability Zone, tenancy). + * + ``open`` - The instance can run in any ``open`` Capacity Reservation that has matching attributes (instance type, platform, Availability Zone). * + ``none`` - The instance avoids running in a Capacity Reservation even if one is available. The instance runs in On-Demand capacity. */ capacityReservationPreference?: string; @@ -23704,8 +23756,7 @@ export namespace ec2 { */ elasticGpuSpecifications?: outputs.ec2.LaunchTemplateElasticGpuSpecification[]; /** - * Amazon Elastic Inference is no longer available. - * An elastic inference accelerator to associate with the instance. Elastic inference accelerators are a resource you can attach to your Amazon EC2 instances to accelerate your Deep Learning (DL) inference workloads. + * An elastic inference accelerator to associate with the instance. Elastic inference accelerators are a resource you can attach to your Amazon EC2 instances to accelerate your Deep Learning (DL) inference workloads. * You cannot specify accelerators from different generations in the same request. * Starting April 15, 2023, AWS will not onboard new customers to Amazon Elastic Inference (EI), and will help current customers migrate their workloads to options that offer better price and performance. After April 15, 2023, new customers will not be able to launch instances with Amazon EI accelerators in Amazon SageMaker, Amazon ECS, or Amazon EC2. However, customers who have used Amazon EI at least once during the past 30-day period are considered current customers and will be able to continue using the service. */ @@ -23753,7 +23804,7 @@ export namespace ec2 { * * If you specify ``InstanceRequirements``, you can't specify ``InstanceType``. * Attribute-based instance type selection is only supported when using Auto Scaling groups, EC2 Fleet, and Spot Fleet to launch instances. If you plan to use the launch template in the [launch instance wizard](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ec2-launch-instance-wizard.html), or with the [RunInstances](https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_RunInstances.html) API or [AWS::EC2::Instance](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-instance.html) AWS CloudFormation resource, you can't specify ``InstanceRequirements``. - * For more information, see [Specify attributes for instance type selection for EC2 Fleet or Spot Fleet](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ec2-fleet-attribute-based-instance-type-selection.html) and [Spot placement score](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/spot-placement-score.html) in the *Amazon EC2 User Guide*. + * For more information, see [Attribute-based instance type selection for EC2 Fleet](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ec2-fleet-attribute-based-instance-type-selection.html), [Attribute-based instance type selection for Spot Fleet](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/spot-fleet-attribute-based-instance-type-selection.html), and [Spot placement score](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/spot-placement-score.html) in the *Amazon EC2 User Guide*. */ instanceRequirements?: outputs.ec2.LaunchTemplateInstanceRequirements; /** @@ -23791,7 +23842,6 @@ export namespace ec2 { * The network interfaces for the instance. */ networkInterfaces?: outputs.ec2.LaunchTemplateNetworkInterface[]; - networkPerformanceOptions?: any; /** * The placement for the instance. */ @@ -23816,7 +23866,8 @@ export namespace ec2 { */ securityGroups?: string[]; /** - * The tags to apply to resources that are created during instance launch. + * The tags to apply to the resources that are created during instance launch. + * To tag a resource after it has been created, see [CreateTags](https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_CreateTags.html). * To tag the launch template itself, use [TagSpecifications](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-launchtemplate.html#cfn-ec2-launchtemplate-tagspecifications). */ tagSpecifications?: outputs.ec2.TagSpecification[]; @@ -23852,7 +23903,7 @@ export namespace ec2 { */ iops?: number; /** - * Identifier (key ID, key alias, key ARN, or alias ARN) of the customer managed KMS key to use for EBS encryption. + * The ARN of the symmetric KMSlong (KMS) CMK used for encryption. */ kmsKeyId?: string; /** @@ -23995,7 +24046,7 @@ export namespace ec2 { * * If you specify ``InstanceRequirements``, you can't specify ``InstanceType``. * Attribute-based instance type selection is only supported when using Auto Scaling groups, EC2 Fleet, and Spot Fleet to launch instances. If you plan to use the launch template in the [launch instance wizard](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ec2-launch-instance-wizard.html), or with the [RunInstances](https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_RunInstances.html) API or [AWS::EC2::Instance](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-instance.html) AWS CloudFormation resource, you can't specify ``InstanceRequirements``. - * For more information, see [Specify attributes for instance type selection for EC2 Fleet or Spot Fleet](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ec2-fleet-attribute-based-instance-type-selection.html) and [Spot placement score](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/spot-placement-score.html) in the *Amazon EC2 User Guide*. + * For more information, see [Attribute-based instance type selection for EC2 Fleet](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ec2-fleet-attribute-based-instance-type-selection.html), [Attribute-based instance type selection for Spot Fleet](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/spot-fleet-attribute-based-instance-type-selection.html), and [Spot placement score](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/spot-placement-score.html) in the *Amazon EC2 User Guide*. */ export interface LaunchTemplateInstanceRequirements { /** @@ -24042,6 +24093,7 @@ export namespace ec2 { * The accelerator types that must be on the instance type. * + For instance types with GPU accelerators, specify ``gpu``. * + For instance types with FPGA accelerators, specify ``fpga``. + * + For instance types with inference accelerators, specify ``inference``. * * Default: Any accelerator type */ @@ -24069,7 +24121,7 @@ export namespace ec2 { */ baselineEbsBandwidthMbps?: outputs.ec2.LaunchTemplateBaselineEbsBandwidthMbps; /** - * The baseline performance to consider, using an instance family as a baseline reference. The instance family establishes the lowest acceptable level of performance. Amazon EC2 uses this baseline to guide instance type selection, but there is no guarantee that the selected instance types will always exceed the baseline for every application. Currently, this parameter only supports CPU performance as a baseline performance factor. For more information, see [Performance protection](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ec2-fleet-attribute-based-instance-type-selection.html#ec2fleet-abis-performance-protection) in the *Amazon EC2 User Guide*. + * The baseline performance to consider, using an instance family as a baseline reference. The instance family establishes the lowest acceptable level of performance. Amazon EC2 uses this baseline to guide instance type selection, but there is no guarantee that the selected instance types will always exceed the baseline for every application. Currently, this parameter only supports CPU performance as a baseline performance factor. For more information, see [Performance protection](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ec2-fleet-attribute-based-instance-type-selection.html#ec2fleet-abis-performance-protection) in the *Amazon EC2 User Guide* . */ baselinePerformanceFactors?: outputs.ec2.LaunchTemplateBaselinePerformanceFactors; /** @@ -24086,7 +24138,6 @@ export namespace ec2 { * + For instance types with Intel CPUs, specify ``intel``. * + For instance types with AMD CPUs, specify ``amd``. * + For instance types with AWS CPUs, specify ``amazon-web-services``. - * + For instance types with Apple CPUs, specify ``apple``. * * Don't confuse the CPU manufacturer with the CPU architecture. Instances will be launched with a compatible CPU architecture based on the Amazon Machine Image (AMI) that you specify in your launch template. * Default: Any manufacturer @@ -24369,10 +24420,9 @@ export namespace ec2 { */ groups?: string[]; /** - * The type of network interface. To create an Elastic Fabric Adapter (EFA), specify ``efa`` or ``efa``. For more information, see [Elastic Fabric Adapter](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/efa.html) in the *Amazon EC2 User Guide*. + * The type of network interface. To create an Elastic Fabric Adapter (EFA), specify ``efa``. For more information, see [Elastic Fabric Adapter](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/efa.html) in the *Amazon EC2 User Guide*. * If you are not creating an EFA, specify ``interface`` or omit this parameter. - * If you specify ``efa-only``, do not assign any IP addresses to the network interface. EFA-only network interfaces do not support IP addresses. - * Valid values: ``interface`` | ``efa`` | ``efa-only`` + * Valid values: ``interface`` | ``efa`` */ interfaceType?: string; /** @@ -24520,6 +24570,9 @@ export namespace ec2 { } export interface LaunchTemplateReference { + /** + * The instance family to refer. Ensure that you specify the correct family name. For example, C6i and C6g are valid values, but C6 is not. + */ instanceFamily?: string; } @@ -24572,7 +24625,6 @@ export namespace ec2 { /** * Specifies the tags to apply to the launch template during creation. - * To specify the tags for the resources that are created during instance launch, use [AWS::EC2::LaunchTemplate TagSpecification](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-launchtemplate-tagspecification.html). * ``LaunchTemplateTagSpecification`` is a property of [AWS::EC2::LaunchTemplate](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-launchtemplate.html). */ export interface LaunchTemplateTagSpecification { @@ -25693,7 +25745,7 @@ export namespace ec2 { */ privateIpAddresses?: outputs.ec2.SpotFleetPrivateIpAddressSpecification[]; /** - * The number of secondary private IPv4 addresses. You can't specify this option and specify more than one private IP address using the private IP addresses option. You cannot specify this option if you're launching more than one instance in a [RunInstances](https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_RunInstances.html) request. + * The number of secondary private IPv4 addresses. You can’t specify this parameter and also specify a secondary private IP address using the `PrivateIpAddress` parameter. */ secondaryPrivateIpAddressCount?: number; /** @@ -26385,7 +26437,7 @@ export namespace ec2 { } /** - * Specifies the tags to apply to resources that are created during instance launch. + * Specifies the tags to apply to a resource when the resource is created for the launch template. * ``TagSpecification`` is a property type of [TagSpecifications](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-launchtemplate-launchtemplatedata.html#cfn-ec2-launchtemplate-launchtemplatedata-tagspecifications). [TagSpecifications](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-launchtemplate-launchtemplatedata.html#cfn-ec2-launchtemplate-launchtemplatedata-tagspecifications) is a property of [AWS::EC2::LaunchTemplate LaunchTemplateData](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-launchtemplate-launchtemplatedata.html). */ export interface TagSpecification { @@ -28011,7 +28063,7 @@ export namespace ecs { */ user?: string; /** - * Specifies whether Amazon ECS will resolve the container image tag provided in the container definition to an image digest. By default, the value is `enabled` . If you set the value for a container as `disabled` , Amazon ECS will not resolve the provided container image tag to a digest and will use the original image URI specified in the container definition for deployment. For more information about container image resolution, see [Container image resolution](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/deployment-type-ecs.html#deployment-container-image-stability) in the *Amazon ECS Developer Guide* . + * Specifies whether Amazon ECS will resolve the container image tag provided in the container definition to an image digest. By default, the value is ``enabled``. If you set the value for a container as ``disabled``, Amazon ECS will not resolve the provided container image tag to a digest and will use the original image URI specified in the container definition for deployment. For more information about container image resolution, see [Container image resolution](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/deployment-type-ecs.html#deployment-container-image-stability) in the *Amazon ECS Developer Guide*. */ versionConsistency?: enums.ecs.TaskDefinitionContainerDefinitionVersionConsistency; /** @@ -31066,6 +31118,11 @@ export namespace events { * The authorization parameters for Basic authorization. */ basicAuthParameters?: outputs.events.ConnectionBasicAuthParameters; + /** + * For private OAuth authentication endpoints. The parameters EventBridge uses to authenticate against the endpoint. + * + * For more information, see [Authorization methods for connections](https://docs.aws.amazon.com/eventbridge/latest/userguide/eb-target-connection-auth.html) in the **Amazon EventBridge User Guide** . + */ connectivityParameters?: outputs.events.ConnectionConnectivityParameters; /** * Additional parameters for the connection that are passed through with every invocation to the HTTP endpoint. @@ -31100,6 +31157,9 @@ export namespace events { } export interface ConnectionConnectivityParameters { + /** + * The parameters for EventBridge to use when invoking the resource endpoint. + */ resourceParameters: outputs.events.ConnectionResourceParameters; } @@ -31153,7 +31213,15 @@ export namespace events { } export interface ConnectionResourceParameters { + /** + * For connections to private APIs, the Amazon Resource Name (ARN) of the resource association EventBridge created between the connection and the private API's resource configuration. + * + * > The value of this property is set by EventBridge . Any value you specify in your template is ignored. + */ resourceAssociationArn?: string; + /** + * The Amazon Resource Name (ARN) of the Amazon VPC Lattice resource configuration for the resource endpoint. + */ resourceConfigurationArn: string; } @@ -31214,6 +31282,9 @@ export namespace events { * The private resource the HTTP request will be sent to. */ export interface InvocationConnectivityParametersProperties { + /** + * The parameters for EventBridge to use when invoking the resource endpoint. + */ resourceParameters: outputs.events.ConnectionResourceParameters; } @@ -36550,6 +36621,9 @@ export namespace internetmonitor { export namespace invoicing { export interface InvoiceUnitRule { + /** + * The list of `LINKED_ACCOUNT` IDs where charges are included within the invoice unit. + */ linkedAccounts: string[]; } @@ -36696,6 +36770,28 @@ export namespace iot { templateName?: string; } + export interface CommandParameter { + defaultValue?: outputs.iot.CommandParameterValue; + description?: string; + name: string; + value?: outputs.iot.CommandParameterValue; + } + + export interface CommandParameterValue { + b?: boolean; + bin?: string; + d?: number; + i?: number; + l?: string; + s?: string; + ul?: string; + } + + export interface CommandPayload { + content?: string; + contentType?: string; + } + export interface DomainConfigurationAuthorizerConfig { /** * A Boolean that specifies whether the domain configuration's authorization service can be overridden. @@ -84133,6 +84229,7 @@ export namespace redshiftserverless { * The namespace the workgroup is associated with. */ namespaceName?: string; + pricePerformanceTarget?: outputs.redshiftserverless.WorkgroupPerformanceTarget; /** * A value that specifies whether the workgroup can be accessible from a public network. */ @@ -84208,6 +84305,11 @@ export namespace redshiftserverless { subnetId?: string; } + export interface WorkgroupPerformanceTarget { + level?: number; + status?: enums.redshiftserverless.WorkgroupPerformanceTargetStatus; + } + export interface WorkgroupVpcEndpoint { /** * One or more network interfaces of the endpoint. Also known as an interface endpoint. @@ -85824,6 +85926,29 @@ export namespace s3 { targetObjectKeyFormat?: outputs.s3.BucketTargetObjectKeyFormat; } + export interface BucketMetadataTableConfiguration { + /** + * Returns the Error value of the GetBucketMetadataTableConfiguration response. + */ + error?: outputs.s3.BucketMetadataTableError; + s3TablesDestination: outputs.s3.BucketS3TablesDestination; + /** + * Returns the Status value of the GetBucketMetadataTableConfigurationResult response. This value indicates the status of the metadata table. The status values are:
CREATING - The metadata table is in the process of being created in the specified table bucket.
ACTIVE - The metadata table has been created successfully and records are being delivered to the table.
FAILED - Amazon S3 is unable to create the metadata table, or Amazon S3 is unable to deliver records. + */ + status?: string; + } + + export interface BucketMetadataTableError { + /** + * If the CreateBucketMetadataTableConfiguration request succeeds, but S3 Metadata was unable to create the table, this structure contains the error code. The possible error codes and error messages are as follows:
AccessDeniedCreatingResources - You don't have sufficient permissions to create the required resources. Make sure that you have s3tables:CreateNamespace, s3tables:CreateTable, s3tables:GetTable and s3tables:PutTablePolicy permissions, and then try again. To create a new metadata table, you must delete the metadata configuration for this bucket, and then create a new metadata configuration.
AccessDeniedWritingToTable - Unable to write to the metadata table because of missing resource permissions. To fix the resource policy, Amazon S3 needs to create a new metadata table. To create a new metadata table, you must delete the metadata configuration for this bucket, and then create a new metadata configuration.
DestinationTableNotFound - The destination table doesn't exist. To create a new metadata table, you must delete the metadata configuration for this bucket, and then create a new metadata configuration.
ServerInternalError - An internal error has occurred. To create a new metadata table, you must delete the metadata configuration for this bucket, and then create a new metadata configuration.
TableAlreadyExists - The table that you specified already exists in the table bucket's namespace. Specify a different table name. To create a new metadata table, you must delete the metadata configuration for this bucket, and then create a new metadata configuration.
TableBucketNotFound - The table bucket that you specified doesn't exist in this AWS Region and account. Create or choose a different table bucket. To create a new metadata table, you must delete the metadata configuration for this bucket, and then create a new metadata configuration. + */ + errorCode: string; + /** + * If the CreateBucketMetadataTableConfiguration request succeeds, but S3 Metadata was unable to create the table, this structure contains the error code. The possible error codes and error messages are as follows:
AccessDeniedCreatingResources - You don't have sufficient permissions to create the required resources. Make sure that you have s3tables:CreateNamespace, s3tables:CreateTable, s3tables:GetTable and s3tables:PutTablePolicy permissions, and then try again. To create a new metadata table, you must delete the metadata configuration for this bucket, and then create a new metadata configuration.
AccessDeniedWritingToTable - Unable to write to the metadata table because of missing resource permissions. To fix the resource policy, Amazon S3 needs to create a new metadata table. To create a new metadata table, you must delete the metadata configuration for this bucket, and then create a new metadata configuration.
DestinationTableNotFound - The destination table doesn't exist. To create a new metadata table, you must delete the metadata configuration for this bucket, and then create a new metadata configuration.
ServerInternalError - An internal error has occurred. To create a new metadata table, you must delete the metadata configuration for this bucket, and then create a new metadata configuration.
TableAlreadyExists - The table that you specified already exists in the table bucket's namespace. Specify a different table name. To create a new metadata table, you must delete the metadata configuration for this bucket, and then create a new metadata configuration.
TableBucketNotFound - The table bucket that you specified doesn't exist in this AWS Region and account. Create or choose a different table bucket. To create a new metadata table, you must delete the metadata configuration for this bucket, and then create a new metadata configuration. + */ + errorMessage: string; + } + /** * A container specifying replication metrics-related settings enabling replication metrics and events. */ @@ -86345,6 +86470,25 @@ export namespace s3 { rules: outputs.s3.BucketFilterRule[]; } + export interface BucketS3TablesDestination { + /** + * The Amazon Resource Name (ARN) for the metadata table in the metadata table configuration. The specified metadata table name must be unique within the aws_s3_metadata namespace in the destination table bucket. + */ + tableArn?: string; + /** + * The Amazon Resource Name (ARN) for the table bucket that's specified as the destination in the metadata table configuration. The destination table bucket must be in the same Region and AWS account as the general purpose bucket. + */ + tableBucketArn: string; + /** + * The name for the metadata table in your metadata table configuration. The specified metadata table name must be unique within the aws_s3_metadata namespace in the destination table bucket. + */ + tableName: string; + /** + * The table bucket namespace for the metadata table in your metadata table configuration. This value is always aws_s3_metadata. + */ + tableNamespace?: string; + } + /** * Describes the default server-side encryption to apply to new objects in the bucket. If a PUT Object request doesn't specify any server-side encryption, this default encryption will be applied. For more information, see [PutBucketEncryption](https://docs.aws.amazon.com/AmazonS3/latest/API/RESTBucketPUTencryption.html). * + *General purpose buckets* - If you don't specify a customer managed key at configuration, Amazon S3 automatically creates an AWS KMS key (``aws/s3``) in your AWS account the first time that you add an object encrypted with SSE-KMS to a bucket. By default, Amazon S3 uses this KMS key for SSE-KMS. @@ -87285,6 +87429,33 @@ export namespace s3outposts { } +export namespace s3tables { + /** + * A policy document containing permissions to add to the specified table bucket. In IAM, you must provide policy documents in JSON format. However, in CloudFormation you can provide the policy in JSON or YAML format because CloudFormation converts YAML to JSON before submitting it to IAM. + */ + export interface TableBucketPolicyResourcePolicy { + } + + /** + * Settings governing the Unreferenced File Removal maintenance action. Unreferenced file removal identifies and deletes all objects that are not referenced by any table snapshots. + */ + export interface TableBucketUnreferencedFileRemoval { + /** + * S3 permanently deletes noncurrent objects after the number of days specified by the NoncurrentDays property. + */ + noncurrentDays?: number; + /** + * Indicates whether the Unreferenced File Removal maintenance action is enabled. + */ + status?: enums.s3tables.TableBucketUnreferencedFileRemovalStatus; + /** + * For any object not referenced by your table and older than the UnreferencedDays property, S3 creates a delete marker and marks the object version as noncurrent. + */ + unreferencedDays?: number; + } + +} + export namespace sagemaker { /** * The configuration for the kernels in a SageMaker image running as a CodeEditor app. diff --git a/sdk/python/pulumi_aws_native/__init__.py b/sdk/python/pulumi_aws_native/__init__.py index cada67ec1a..d485aa7e16 100644 --- a/sdk/python/pulumi_aws_native/__init__.py +++ b/sdk/python/pulumi_aws_native/__init__.py @@ -396,6 +396,8 @@ s3objectlambda = __s3objectlambda import pulumi_aws_native.s3outposts as __s3outposts s3outposts = __s3outposts + import pulumi_aws_native.s3tables as __s3tables + s3tables = __s3tables import pulumi_aws_native.sagemaker as __sagemaker sagemaker = __sagemaker import pulumi_aws_native.scheduler as __scheduler @@ -650,6 +652,7 @@ s3express = _utilities.lazy_import('pulumi_aws_native.s3express') s3objectlambda = _utilities.lazy_import('pulumi_aws_native.s3objectlambda') s3outposts = _utilities.lazy_import('pulumi_aws_native.s3outposts') + s3tables = _utilities.lazy_import('pulumi_aws_native.s3tables') sagemaker = _utilities.lazy_import('pulumi_aws_native.sagemaker') scheduler = _utilities.lazy_import('pulumi_aws_native.scheduler') secretsmanager = _utilities.lazy_import('pulumi_aws_native.secretsmanager') @@ -1985,6 +1988,7 @@ "aws-native:iot:CaCertificate": "CaCertificate", "aws-native:iot:Certificate": "Certificate", "aws-native:iot:CertificateProvider": "CertificateProvider", + "aws-native:iot:Command": "Command", "aws-native:iot:CustomMetric": "CustomMetric", "aws-native:iot:Dimension": "Dimension", "aws-native:iot:DomainConfiguration": "DomainConfiguration", @@ -2690,7 +2694,8 @@ "mod": "ram", "fqn": "pulumi_aws_native.ram", "classes": { - "aws-native:ram:Permission": "Permission" + "aws-native:ram:Permission": "Permission", + "aws-native:ram:ResourceShare": "ResourceShare" } }, { @@ -2933,6 +2938,15 @@ "aws-native:s3outposts:Endpoint": "Endpoint" } }, + { + "pkg": "aws-native", + "mod": "s3tables", + "fqn": "pulumi_aws_native.s3tables", + "classes": { + "aws-native:s3tables:TableBucket": "TableBucket", + "aws-native:s3tables:TableBucketPolicy": "TableBucketPolicy" + } + }, { "pkg": "aws-native", "mod": "sagemaker", diff --git a/sdk/python/pulumi_aws_native/apigateway/domain_name_v2.py b/sdk/python/pulumi_aws_native/apigateway/domain_name_v2.py index f7fe69c0de..c00ccc6170 100644 --- a/sdk/python/pulumi_aws_native/apigateway/domain_name_v2.py +++ b/sdk/python/pulumi_aws_native/apigateway/domain_name_v2.py @@ -26,7 +26,6 @@ def __init__(__self__, *, certificate_arn: Optional[pulumi.Input[str]] = None, domain_name: Optional[pulumi.Input[str]] = None, endpoint_configuration: Optional[pulumi.Input['DomainNameV2EndpointConfigurationArgs']] = None, - management_policy: Optional[Any] = None, policy: Optional[Any] = None, security_policy: Optional[pulumi.Input[str]] = None, tags: Optional[pulumi.Input[Sequence[pulumi.Input['_root_inputs.TagArgs']]]] = None): @@ -35,7 +34,6 @@ def __init__(__self__, *, :param pulumi.Input[str] certificate_arn: The reference to an AWS -managed certificate that will be used by the private endpoint for this domain name. AWS Certificate Manager is the only supported source. :param pulumi.Input[str] domain_name: Represents a custom domain name as a user-friendly host name of an API (RestApi). :param pulumi.Input['DomainNameV2EndpointConfigurationArgs'] endpoint_configuration: The endpoint configuration to indicate the types of endpoints an API (RestApi) or its custom domain name (DomainName) has. - :param Any management_policy: Search the [CloudFormation User Guide](https://docs.aws.amazon.com/cloudformation/) for `AWS::ApiGateway::DomainNameV2` for more information about the expected schema for this property. :param Any policy: A stringified JSON policy document that applies to the `execute-api` service for this DomainName regardless of the caller and Method configuration. You can use `Fn::ToJsonString` to enter your `policy` . For more information, see [Fn::ToJsonString](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/intrinsic-function-reference-ToJsonString.html) . Search the [CloudFormation User Guide](https://docs.aws.amazon.com/cloudformation/) for `AWS::ApiGateway::DomainNameV2` for more information about the expected schema for this property. @@ -48,8 +46,6 @@ def __init__(__self__, *, pulumi.set(__self__, "domain_name", domain_name) if endpoint_configuration is not None: pulumi.set(__self__, "endpoint_configuration", endpoint_configuration) - if management_policy is not None: - pulumi.set(__self__, "management_policy", management_policy) if policy is not None: pulumi.set(__self__, "policy", policy) if security_policy is not None: @@ -93,18 +89,6 @@ def endpoint_configuration(self) -> Optional[pulumi.Input['DomainNameV2EndpointC def endpoint_configuration(self, value: Optional[pulumi.Input['DomainNameV2EndpointConfigurationArgs']]): pulumi.set(self, "endpoint_configuration", value) - @property - @pulumi.getter(name="managementPolicy") - def management_policy(self) -> Optional[Any]: - """ - Search the [CloudFormation User Guide](https://docs.aws.amazon.com/cloudformation/) for `AWS::ApiGateway::DomainNameV2` for more information about the expected schema for this property. - """ - return pulumi.get(self, "management_policy") - - @management_policy.setter - def management_policy(self, value: Optional[Any]): - pulumi.set(self, "management_policy", value) - @property @pulumi.getter def policy(self) -> Optional[Any]: @@ -152,7 +136,6 @@ def __init__(__self__, certificate_arn: Optional[pulumi.Input[str]] = None, domain_name: Optional[pulumi.Input[str]] = None, endpoint_configuration: Optional[pulumi.Input[Union['DomainNameV2EndpointConfigurationArgs', 'DomainNameV2EndpointConfigurationArgsDict']]] = None, - management_policy: Optional[Any] = None, policy: Optional[Any] = None, security_policy: Optional[pulumi.Input[str]] = None, tags: Optional[pulumi.Input[Sequence[pulumi.Input[Union['_root_inputs.TagArgs', '_root_inputs.TagArgsDict']]]]] = None, @@ -165,7 +148,6 @@ def __init__(__self__, :param pulumi.Input[str] certificate_arn: The reference to an AWS -managed certificate that will be used by the private endpoint for this domain name. AWS Certificate Manager is the only supported source. :param pulumi.Input[str] domain_name: Represents a custom domain name as a user-friendly host name of an API (RestApi). :param pulumi.Input[Union['DomainNameV2EndpointConfigurationArgs', 'DomainNameV2EndpointConfigurationArgsDict']] endpoint_configuration: The endpoint configuration to indicate the types of endpoints an API (RestApi) or its custom domain name (DomainName) has. - :param Any management_policy: Search the [CloudFormation User Guide](https://docs.aws.amazon.com/cloudformation/) for `AWS::ApiGateway::DomainNameV2` for more information about the expected schema for this property. :param Any policy: A stringified JSON policy document that applies to the `execute-api` service for this DomainName regardless of the caller and Method configuration. You can use `Fn::ToJsonString` to enter your `policy` . For more information, see [Fn::ToJsonString](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/intrinsic-function-reference-ToJsonString.html) . Search the [CloudFormation User Guide](https://docs.aws.amazon.com/cloudformation/) for `AWS::ApiGateway::DomainNameV2` for more information about the expected schema for this property. @@ -199,7 +181,6 @@ def _internal_init(__self__, certificate_arn: Optional[pulumi.Input[str]] = None, domain_name: Optional[pulumi.Input[str]] = None, endpoint_configuration: Optional[pulumi.Input[Union['DomainNameV2EndpointConfigurationArgs', 'DomainNameV2EndpointConfigurationArgsDict']]] = None, - management_policy: Optional[Any] = None, policy: Optional[Any] = None, security_policy: Optional[pulumi.Input[str]] = None, tags: Optional[pulumi.Input[Sequence[pulumi.Input[Union['_root_inputs.TagArgs', '_root_inputs.TagArgsDict']]]]] = None, @@ -215,7 +196,6 @@ def _internal_init(__self__, __props__.__dict__["certificate_arn"] = certificate_arn __props__.__dict__["domain_name"] = domain_name __props__.__dict__["endpoint_configuration"] = endpoint_configuration - __props__.__dict__["management_policy"] = management_policy __props__.__dict__["policy"] = policy __props__.__dict__["security_policy"] = security_policy __props__.__dict__["tags"] = tags @@ -250,7 +230,6 @@ def get(resource_name: str, __props__.__dict__["domain_name_arn"] = None __props__.__dict__["domain_name_id"] = None __props__.__dict__["endpoint_configuration"] = None - __props__.__dict__["management_policy"] = None __props__.__dict__["policy"] = None __props__.__dict__["security_policy"] = None __props__.__dict__["tags"] = None @@ -296,14 +275,6 @@ def endpoint_configuration(self) -> pulumi.Output[Optional['outputs.DomainNameV2 """ return pulumi.get(self, "endpoint_configuration") - @property - @pulumi.getter(name="managementPolicy") - def management_policy(self) -> pulumi.Output[Optional[Any]]: - """ - Search the [CloudFormation User Guide](https://docs.aws.amazon.com/cloudformation/) for `AWS::ApiGateway::DomainNameV2` for more information about the expected schema for this property. - """ - return pulumi.get(self, "management_policy") - @property @pulumi.getter def policy(self) -> pulumi.Output[Optional[Any]]: diff --git a/sdk/python/pulumi_aws_native/apigateway/get_domain_name_v2.py b/sdk/python/pulumi_aws_native/apigateway/get_domain_name_v2.py index 1edc53cf57..9da5758c48 100644 --- a/sdk/python/pulumi_aws_native/apigateway/get_domain_name_v2.py +++ b/sdk/python/pulumi_aws_native/apigateway/get_domain_name_v2.py @@ -24,7 +24,7 @@ @pulumi.output_type class GetDomainNameV2Result: - def __init__(__self__, certificate_arn=None, domain_name_arn=None, domain_name_id=None, management_policy=None, policy=None, tags=None): + def __init__(__self__, certificate_arn=None, domain_name_arn=None, domain_name_id=None, policy=None, tags=None): if certificate_arn and not isinstance(certificate_arn, str): raise TypeError("Expected argument 'certificate_arn' to be a str") pulumi.set(__self__, "certificate_arn", certificate_arn) @@ -34,9 +34,6 @@ def __init__(__self__, certificate_arn=None, domain_name_arn=None, domain_name_i if domain_name_id and not isinstance(domain_name_id, str): raise TypeError("Expected argument 'domain_name_id' to be a str") pulumi.set(__self__, "domain_name_id", domain_name_id) - if management_policy and not isinstance(management_policy, dict): - raise TypeError("Expected argument 'management_policy' to be a dict") - pulumi.set(__self__, "management_policy", management_policy) if policy and not isinstance(policy, dict): raise TypeError("Expected argument 'policy' to be a dict") pulumi.set(__self__, "policy", policy) @@ -68,14 +65,6 @@ def domain_name_id(self) -> Optional[str]: """ return pulumi.get(self, "domain_name_id") - @property - @pulumi.getter(name="managementPolicy") - def management_policy(self) -> Optional[Any]: - """ - Search the [CloudFormation User Guide](https://docs.aws.amazon.com/cloudformation/) for `AWS::ApiGateway::DomainNameV2` for more information about the expected schema for this property. - """ - return pulumi.get(self, "management_policy") - @property @pulumi.getter def policy(self) -> Optional[Any]: @@ -104,7 +93,6 @@ def __await__(self): certificate_arn=self.certificate_arn, domain_name_arn=self.domain_name_arn, domain_name_id=self.domain_name_id, - management_policy=self.management_policy, policy=self.policy, tags=self.tags) @@ -126,7 +114,6 @@ def get_domain_name_v2(domain_name_arn: Optional[str] = None, certificate_arn=pulumi.get(__ret__, 'certificate_arn'), domain_name_arn=pulumi.get(__ret__, 'domain_name_arn'), domain_name_id=pulumi.get(__ret__, 'domain_name_id'), - management_policy=pulumi.get(__ret__, 'management_policy'), policy=pulumi.get(__ret__, 'policy'), tags=pulumi.get(__ret__, 'tags')) def get_domain_name_v2_output(domain_name_arn: Optional[pulumi.Input[str]] = None, @@ -145,6 +132,5 @@ def get_domain_name_v2_output(domain_name_arn: Optional[pulumi.Input[str]] = Non certificate_arn=pulumi.get(__response__, 'certificate_arn'), domain_name_arn=pulumi.get(__response__, 'domain_name_arn'), domain_name_id=pulumi.get(__response__, 'domain_name_id'), - management_policy=pulumi.get(__response__, 'management_policy'), policy=pulumi.get(__response__, 'policy'), tags=pulumi.get(__response__, 'tags'))) diff --git a/sdk/python/pulumi_aws_native/applicationautoscaling/_inputs.py b/sdk/python/pulumi_aws_native/applicationautoscaling/_inputs.py index 52fe40b482..32f6cfc16d 100644 --- a/sdk/python/pulumi_aws_native/applicationautoscaling/_inputs.py +++ b/sdk/python/pulumi_aws_native/applicationautoscaling/_inputs.py @@ -652,6 +652,9 @@ def resource_label(self, value: Optional[pulumi.Input[str]]): if not MYPY: class ScalingPolicyPredictiveScalingCustomizedCapacityMetricArgsDict(TypedDict): + """ + Represents a CloudWatch metric of your choosing for a predictive scaling policy. + """ metric_data_queries: pulumi.Input[Sequence[pulumi.Input['ScalingPolicyPredictiveScalingMetricDataQueryArgsDict']]] """ One or more metric data queries to provide data points for a metric specification. @@ -664,6 +667,7 @@ class ScalingPolicyPredictiveScalingCustomizedCapacityMetricArgs: def __init__(__self__, *, metric_data_queries: pulumi.Input[Sequence[pulumi.Input['ScalingPolicyPredictiveScalingMetricDataQueryArgs']]]): """ + Represents a CloudWatch metric of your choosing for a predictive scaling policy. :param pulumi.Input[Sequence[pulumi.Input['ScalingPolicyPredictiveScalingMetricDataQueryArgs']]] metric_data_queries: One or more metric data queries to provide data points for a metric specification. """ pulumi.set(__self__, "metric_data_queries", metric_data_queries) @@ -683,6 +687,9 @@ def metric_data_queries(self, value: pulumi.Input[Sequence[pulumi.Input['Scaling if not MYPY: class ScalingPolicyPredictiveScalingCustomizedLoadMetricArgsDict(TypedDict): + """ + The customized load metric specification. + """ metric_data_queries: pulumi.Input[Sequence[pulumi.Input['ScalingPolicyPredictiveScalingMetricDataQueryArgsDict']]] elif False: ScalingPolicyPredictiveScalingCustomizedLoadMetricArgsDict: TypeAlias = Mapping[str, Any] @@ -691,6 +698,9 @@ class ScalingPolicyPredictiveScalingCustomizedLoadMetricArgsDict(TypedDict): class ScalingPolicyPredictiveScalingCustomizedLoadMetricArgs: def __init__(__self__, *, metric_data_queries: pulumi.Input[Sequence[pulumi.Input['ScalingPolicyPredictiveScalingMetricDataQueryArgs']]]): + """ + The customized load metric specification. + """ pulumi.set(__self__, "metric_data_queries", metric_data_queries) @property @@ -705,6 +715,9 @@ def metric_data_queries(self, value: pulumi.Input[Sequence[pulumi.Input['Scaling if not MYPY: class ScalingPolicyPredictiveScalingCustomizedScalingMetricArgsDict(TypedDict): + """ + One or more metric data queries to provide data points for a metric specification. + """ metric_data_queries: pulumi.Input[Sequence[pulumi.Input['ScalingPolicyPredictiveScalingMetricDataQueryArgsDict']]] """ One or more metric data queries to provide data points for a metric specification. @@ -717,6 +730,7 @@ class ScalingPolicyPredictiveScalingCustomizedScalingMetricArgs: def __init__(__self__, *, metric_data_queries: pulumi.Input[Sequence[pulumi.Input['ScalingPolicyPredictiveScalingMetricDataQueryArgs']]]): """ + One or more metric data queries to provide data points for a metric specification. :param pulumi.Input[Sequence[pulumi.Input['ScalingPolicyPredictiveScalingMetricDataQueryArgs']]] metric_data_queries: One or more metric data queries to provide data points for a metric specification. """ pulumi.set(__self__, "metric_data_queries", metric_data_queries) @@ -736,13 +750,17 @@ def metric_data_queries(self, value: pulumi.Input[Sequence[pulumi.Input['Scaling if not MYPY: class ScalingPolicyPredictiveScalingMetricDataQueryArgsDict(TypedDict): + """ + 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. + """ expression: NotRequired[pulumi.Input[str]] """ - The math expression to perform on the returned data, if this object is performing a math expression. + 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. + Conditional: Within each ``MetricDataQuery`` object, you must specify either ``Expression`` or ``MetricStat``, but not both. """ id: NotRequired[pulumi.Input[str]] """ - A short name that identifies the object's results in the response. + 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. """ label: NotRequired[pulumi.Input[str]] """ @@ -750,11 +768,14 @@ class ScalingPolicyPredictiveScalingMetricDataQueryArgsDict(TypedDict): """ metric_stat: NotRequired[pulumi.Input['ScalingPolicyPredictiveScalingMetricStatArgsDict']] """ - Information about the metric data to return. + Information about the metric data to return. + Conditional: Within each ``MetricDataQuery`` object, you must specify either ``Expression`` or ``MetricStat``, but not both. """ return_data: NotRequired[pulumi.Input[bool]] """ - Indicates whether to return the timestamps and raw data values of this metric. + Indicates whether to return the timestamps and raw data values of this metric. + 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. + 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``). """ elif False: ScalingPolicyPredictiveScalingMetricDataQueryArgsDict: TypeAlias = Mapping[str, Any] @@ -768,11 +789,16 @@ def __init__(__self__, *, metric_stat: Optional[pulumi.Input['ScalingPolicyPredictiveScalingMetricStatArgs']] = None, return_data: Optional[pulumi.Input[bool]] = None): """ - :param pulumi.Input[str] expression: The math expression to perform on the returned data, if this object is performing a math expression. - :param pulumi.Input[str] id: A short name that identifies the object's results in the response. + 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. + :param pulumi.Input[str] expression: 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. + Conditional: Within each ``MetricDataQuery`` object, you must specify either ``Expression`` or ``MetricStat``, but not both. + :param pulumi.Input[str] id: 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. :param pulumi.Input[str] label: 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. - :param pulumi.Input['ScalingPolicyPredictiveScalingMetricStatArgs'] metric_stat: Information about the metric data to return. - :param pulumi.Input[bool] return_data: Indicates whether to return the timestamps and raw data values of this metric. + :param pulumi.Input['ScalingPolicyPredictiveScalingMetricStatArgs'] metric_stat: Information about the metric data to return. + Conditional: Within each ``MetricDataQuery`` object, you must specify either ``Expression`` or ``MetricStat``, but not both. + :param pulumi.Input[bool] return_data: Indicates whether to return the timestamps and raw data values of this metric. + 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. + 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``). """ if expression is not None: pulumi.set(__self__, "expression", expression) @@ -789,7 +815,8 @@ def __init__(__self__, *, @pulumi.getter def expression(self) -> Optional[pulumi.Input[str]]: """ - The math expression to perform on the returned data, if this object is performing a math expression. + 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. + Conditional: Within each ``MetricDataQuery`` object, you must specify either ``Expression`` or ``MetricStat``, but not both. """ return pulumi.get(self, "expression") @@ -801,7 +828,7 @@ def expression(self, value: Optional[pulumi.Input[str]]): @pulumi.getter def id(self) -> Optional[pulumi.Input[str]]: """ - A short name that identifies the object's results in the response. + 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. """ return pulumi.get(self, "id") @@ -825,7 +852,8 @@ def label(self, value: Optional[pulumi.Input[str]]): @pulumi.getter(name="metricStat") def metric_stat(self) -> Optional[pulumi.Input['ScalingPolicyPredictiveScalingMetricStatArgs']]: """ - Information about the metric data to return. + Information about the metric data to return. + Conditional: Within each ``MetricDataQuery`` object, you must specify either ``Expression`` or ``MetricStat``, but not both. """ return pulumi.get(self, "metric_stat") @@ -837,7 +865,9 @@ def metric_stat(self, value: Optional[pulumi.Input['ScalingPolicyPredictiveScali @pulumi.getter(name="returnData") def return_data(self) -> Optional[pulumi.Input[bool]]: """ - Indicates whether to return the timestamps and raw data values of this metric. + Indicates whether to return the timestamps and raw data values of this metric. + 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. + 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``). """ return pulumi.get(self, "return_data") @@ -848,6 +878,9 @@ def return_data(self, value: Optional[pulumi.Input[bool]]): if not MYPY: class ScalingPolicyPredictiveScalingMetricDimensionArgsDict(TypedDict): + """ + Describes the dimension of a metric. + """ name: NotRequired[pulumi.Input[str]] """ The name of the dimension. @@ -865,6 +898,7 @@ def __init__(__self__, *, name: Optional[pulumi.Input[str]] = None, value: Optional[pulumi.Input[str]] = None): """ + Describes the dimension of a metric. :param pulumi.Input[str] name: The name of the dimension. :param pulumi.Input[str] value: The value of the dimension. """ @@ -900,6 +934,10 @@ def value(self, value: Optional[pulumi.Input[str]]): if not MYPY: class ScalingPolicyPredictiveScalingMetricSpecificationArgsDict(TypedDict): + """ + This structure specifies the metrics and target utilization settings for a predictive scaling policy. + 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. + """ target_value: pulumi.Input[float] """ Specifies the target utilization. @@ -942,6 +980,8 @@ def __init__(__self__, *, predefined_metric_pair_specification: Optional[pulumi.Input['ScalingPolicyPredictiveScalingPredefinedMetricPairArgs']] = None, predefined_scaling_metric_specification: Optional[pulumi.Input['ScalingPolicyPredictiveScalingPredefinedScalingMetricArgs']] = None): """ + This structure specifies the metrics and target utilization settings for a predictive scaling policy. + 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. :param pulumi.Input[float] target_value: Specifies the target utilization. :param pulumi.Input['ScalingPolicyPredictiveScalingCustomizedCapacityMetricArgs'] customized_capacity_metric_specification: The customized capacity metric specification. :param pulumi.Input['ScalingPolicyPredictiveScalingCustomizedLoadMetricArgs'] customized_load_metric_specification: The customized load metric specification. @@ -1051,17 +1091,21 @@ def predefined_scaling_metric_specification(self, value: Optional[pulumi.Input[' if not MYPY: class ScalingPolicyPredictiveScalingMetricStatArgsDict(TypedDict): + """ + This structure defines the CloudWatch metric to return, along with the statistic and unit. + """ metric: NotRequired[pulumi.Input['ScalingPolicyPredictiveScalingMetricArgsDict']] """ - The CloudWatch metric to return, including the metric name, namespace, and dimensions. + 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). """ stat: NotRequired[pulumi.Input[str]] """ - The statistic to return. It can include any CloudWatch statistic or extended statistic. + 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*. + The most commonly used metrics for predictive scaling are ``Average`` and ``Sum``. """ unit: NotRequired[pulumi.Input[str]] """ - The unit to use for the returned data points. + 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*. """ elif False: ScalingPolicyPredictiveScalingMetricStatArgsDict: TypeAlias = Mapping[str, Any] @@ -1073,9 +1117,11 @@ def __init__(__self__, *, stat: Optional[pulumi.Input[str]] = None, unit: Optional[pulumi.Input[str]] = None): """ - :param pulumi.Input['ScalingPolicyPredictiveScalingMetricArgs'] metric: The CloudWatch metric to return, including the metric name, namespace, and dimensions. - :param pulumi.Input[str] stat: The statistic to return. It can include any CloudWatch statistic or extended statistic. - :param pulumi.Input[str] unit: The unit to use for the returned data points. + This structure defines the CloudWatch metric to return, along with the statistic and unit. + :param pulumi.Input['ScalingPolicyPredictiveScalingMetricArgs'] metric: 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). + :param pulumi.Input[str] stat: 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*. + The most commonly used metrics for predictive scaling are ``Average`` and ``Sum``. + :param pulumi.Input[str] unit: 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*. """ if metric is not None: pulumi.set(__self__, "metric", metric) @@ -1088,7 +1134,7 @@ def __init__(__self__, *, @pulumi.getter def metric(self) -> Optional[pulumi.Input['ScalingPolicyPredictiveScalingMetricArgs']]: """ - The CloudWatch metric to return, including the metric name, namespace, and dimensions. + 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). """ return pulumi.get(self, "metric") @@ -1100,7 +1146,8 @@ def metric(self, value: Optional[pulumi.Input['ScalingPolicyPredictiveScalingMet @pulumi.getter def stat(self) -> Optional[pulumi.Input[str]]: """ - The statistic to return. It can include any CloudWatch statistic or extended statistic. + 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*. + The most commonly used metrics for predictive scaling are ``Average`` and ``Sum``. """ return pulumi.get(self, "stat") @@ -1112,7 +1159,7 @@ def stat(self, value: Optional[pulumi.Input[str]]): @pulumi.getter def unit(self) -> Optional[pulumi.Input[str]]: """ - The unit to use for the returned data points. + 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*. """ return pulumi.get(self, "unit") @@ -1123,9 +1170,12 @@ def unit(self, value: Optional[pulumi.Input[str]]): if not MYPY: class ScalingPolicyPredictiveScalingMetricArgsDict(TypedDict): + """ + Describes the scaling metric. + """ dimensions: NotRequired[pulumi.Input[Sequence[pulumi.Input['ScalingPolicyPredictiveScalingMetricDimensionArgsDict']]]] """ - The dimensions for the metric. + Describes the dimensions of the metric. """ metric_name: NotRequired[pulumi.Input[str]] """ @@ -1145,7 +1195,8 @@ def __init__(__self__, *, metric_name: Optional[pulumi.Input[str]] = None, namespace: Optional[pulumi.Input[str]] = None): """ - :param pulumi.Input[Sequence[pulumi.Input['ScalingPolicyPredictiveScalingMetricDimensionArgs']]] dimensions: The dimensions for the metric. + Describes the scaling metric. + :param pulumi.Input[Sequence[pulumi.Input['ScalingPolicyPredictiveScalingMetricDimensionArgs']]] dimensions: Describes the dimensions of the metric. :param pulumi.Input[str] metric_name: The name of the metric. :param pulumi.Input[str] namespace: The namespace of the metric. """ @@ -1160,7 +1211,7 @@ def __init__(__self__, *, @pulumi.getter def dimensions(self) -> Optional[pulumi.Input[Sequence[pulumi.Input['ScalingPolicyPredictiveScalingMetricDimensionArgs']]]]: """ - The dimensions for the metric. + Describes the dimensions of the metric. """ return pulumi.get(self, "dimensions") @@ -1195,31 +1246,31 @@ def namespace(self, value: Optional[pulumi.Input[str]]): if not MYPY: class ScalingPolicyPredictiveScalingPolicyConfigurationArgsDict(TypedDict): + """ + Represents a predictive scaling policy configuration. + """ metric_specifications: pulumi.Input[Sequence[pulumi.Input['ScalingPolicyPredictiveScalingMetricSpecificationArgsDict']]] """ - This structure includes the metrics and target utilization to use for predictive scaling. - - 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. + This structure includes the metrics and target utilization to use for predictive scaling. + 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. """ max_capacity_breach_behavior: NotRequired[pulumi.Input[str]] """ - Defines the behavior that should be applied if the forecast capacity approaches or exceeds the maximum capacity. Defaults to `HonorMaxCapacity` if not specified. + Defines the behavior that should be applied if the forecast capacity approaches or exceeds the maximum capacity. Defaults to ``HonorMaxCapacity`` if not specified. """ max_capacity_buffer: NotRequired[pulumi.Input[int]] """ - 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. - - Required if the `MaxCapacityBreachBehavior` property is set to `IncreaseMaxCapacity` , and cannot be used otherwise. + 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. + Required if the ``MaxCapacityBreachBehavior`` property is set to ``IncreaseMaxCapacity``, and cannot be used otherwise. """ mode: NotRequired[pulumi.Input[str]] """ - The predictive scaling mode. Defaults to `ForecastOnly` if not specified. + The predictive scaling mode. Defaults to ``ForecastOnly`` if not specified. """ scheduling_buffer_time: NotRequired[pulumi.Input[int]] """ - The amount of time, in seconds, that the start time can be advanced. - - The value must be less than the forecast interval duration of 3600 seconds (60 minutes). Defaults to 300 seconds if not specified. + The amount of time, in seconds, that the start time can be advanced. + The value must be less than the forecast interval duration of 3600 seconds (60 minutes). Defaults to 300 seconds if not specified. """ elif False: ScalingPolicyPredictiveScalingPolicyConfigurationArgsDict: TypeAlias = Mapping[str, Any] @@ -1233,17 +1284,15 @@ def __init__(__self__, *, mode: Optional[pulumi.Input[str]] = None, scheduling_buffer_time: Optional[pulumi.Input[int]] = None): """ - :param pulumi.Input[Sequence[pulumi.Input['ScalingPolicyPredictiveScalingMetricSpecificationArgs']]] metric_specifications: This structure includes the metrics and target utilization to use for predictive scaling. - - 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. - :param pulumi.Input[str] max_capacity_breach_behavior: Defines the behavior that should be applied if the forecast capacity approaches or exceeds the maximum capacity. Defaults to `HonorMaxCapacity` if not specified. - :param pulumi.Input[int] max_capacity_buffer: 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. - - Required if the `MaxCapacityBreachBehavior` property is set to `IncreaseMaxCapacity` , and cannot be used otherwise. - :param pulumi.Input[str] mode: The predictive scaling mode. Defaults to `ForecastOnly` if not specified. - :param pulumi.Input[int] scheduling_buffer_time: The amount of time, in seconds, that the start time can be advanced. - - The value must be less than the forecast interval duration of 3600 seconds (60 minutes). Defaults to 300 seconds if not specified. + Represents a predictive scaling policy configuration. + :param pulumi.Input[Sequence[pulumi.Input['ScalingPolicyPredictiveScalingMetricSpecificationArgs']]] metric_specifications: This structure includes the metrics and target utilization to use for predictive scaling. + 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. + :param pulumi.Input[str] max_capacity_breach_behavior: Defines the behavior that should be applied if the forecast capacity approaches or exceeds the maximum capacity. Defaults to ``HonorMaxCapacity`` if not specified. + :param pulumi.Input[int] max_capacity_buffer: 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. + Required if the ``MaxCapacityBreachBehavior`` property is set to ``IncreaseMaxCapacity``, and cannot be used otherwise. + :param pulumi.Input[str] mode: The predictive scaling mode. Defaults to ``ForecastOnly`` if not specified. + :param pulumi.Input[int] scheduling_buffer_time: The amount of time, in seconds, that the start time can be advanced. + The value must be less than the forecast interval duration of 3600 seconds (60 minutes). Defaults to 300 seconds if not specified. """ pulumi.set(__self__, "metric_specifications", metric_specifications) if max_capacity_breach_behavior is not None: @@ -1259,9 +1308,8 @@ def __init__(__self__, *, @pulumi.getter(name="metricSpecifications") def metric_specifications(self) -> pulumi.Input[Sequence[pulumi.Input['ScalingPolicyPredictiveScalingMetricSpecificationArgs']]]: """ - This structure includes the metrics and target utilization to use for predictive scaling. - - 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. + This structure includes the metrics and target utilization to use for predictive scaling. + 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. """ return pulumi.get(self, "metric_specifications") @@ -1273,7 +1321,7 @@ def metric_specifications(self, value: pulumi.Input[Sequence[pulumi.Input['Scali @pulumi.getter(name="maxCapacityBreachBehavior") def max_capacity_breach_behavior(self) -> Optional[pulumi.Input[str]]: """ - Defines the behavior that should be applied if the forecast capacity approaches or exceeds the maximum capacity. Defaults to `HonorMaxCapacity` if not specified. + Defines the behavior that should be applied if the forecast capacity approaches or exceeds the maximum capacity. Defaults to ``HonorMaxCapacity`` if not specified. """ return pulumi.get(self, "max_capacity_breach_behavior") @@ -1285,9 +1333,8 @@ def max_capacity_breach_behavior(self, value: Optional[pulumi.Input[str]]): @pulumi.getter(name="maxCapacityBuffer") def max_capacity_buffer(self) -> Optional[pulumi.Input[int]]: """ - 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. - - Required if the `MaxCapacityBreachBehavior` property is set to `IncreaseMaxCapacity` , and cannot be used otherwise. + 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. + Required if the ``MaxCapacityBreachBehavior`` property is set to ``IncreaseMaxCapacity``, and cannot be used otherwise. """ return pulumi.get(self, "max_capacity_buffer") @@ -1299,7 +1346,7 @@ def max_capacity_buffer(self, value: Optional[pulumi.Input[int]]): @pulumi.getter def mode(self) -> Optional[pulumi.Input[str]]: """ - The predictive scaling mode. Defaults to `ForecastOnly` if not specified. + The predictive scaling mode. Defaults to ``ForecastOnly`` if not specified. """ return pulumi.get(self, "mode") @@ -1311,9 +1358,8 @@ def mode(self, value: Optional[pulumi.Input[str]]): @pulumi.getter(name="schedulingBufferTime") def scheduling_buffer_time(self) -> Optional[pulumi.Input[int]]: """ - The amount of time, in seconds, that the start time can be advanced. - - The value must be less than the forecast interval duration of 3600 seconds (60 minutes). Defaults to 300 seconds if not specified. + The amount of time, in seconds, that the start time can be advanced. + The value must be less than the forecast interval duration of 3600 seconds (60 minutes). Defaults to 300 seconds if not specified. """ return pulumi.get(self, "scheduling_buffer_time") @@ -1324,6 +1370,10 @@ def scheduling_buffer_time(self, value: Optional[pulumi.Input[int]]): if not MYPY: class ScalingPolicyPredictiveScalingPredefinedLoadMetricArgsDict(TypedDict): + """ + Describes a load metric for a predictive scaling policy. + 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. + """ predefined_metric_type: pulumi.Input[str] """ The metric type. @@ -1341,6 +1391,8 @@ def __init__(__self__, *, predefined_metric_type: pulumi.Input[str], resource_label: Optional[pulumi.Input[str]] = None): """ + Describes a load metric for a predictive scaling policy. + 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. :param pulumi.Input[str] predefined_metric_type: The metric type. :param pulumi.Input[str] resource_label: A label that uniquely identifies a target group. """ @@ -1375,6 +1427,9 @@ def resource_label(self, value: Optional[pulumi.Input[str]]): if not MYPY: class ScalingPolicyPredictiveScalingPredefinedMetricPairArgsDict(TypedDict): + """ + Represents a metric pair for a predictive scaling policy. + """ predefined_metric_type: pulumi.Input[str] """ 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. @@ -1392,6 +1447,7 @@ def __init__(__self__, *, predefined_metric_type: pulumi.Input[str], resource_label: Optional[pulumi.Input[str]] = None): """ + Represents a metric pair for a predictive scaling policy. :param pulumi.Input[str] predefined_metric_type: 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. :param pulumi.Input[str] resource_label: A label that uniquely identifies a specific target group from which to determine the total and average request count. """ @@ -1426,6 +1482,10 @@ def resource_label(self, value: Optional[pulumi.Input[str]]): if not MYPY: class ScalingPolicyPredictiveScalingPredefinedScalingMetricArgsDict(TypedDict): + """ + Describes a scaling metric for a predictive scaling policy. + 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. + """ predefined_metric_type: pulumi.Input[str] """ The metric type. @@ -1443,6 +1503,8 @@ def __init__(__self__, *, predefined_metric_type: pulumi.Input[str], resource_label: Optional[pulumi.Input[str]] = None): """ + Describes a scaling metric for a predictive scaling policy. + 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. :param pulumi.Input[str] predefined_metric_type: The metric type. :param pulumi.Input[str] resource_label: A label that uniquely identifies a specific target group from which to determine the average request count. """ diff --git a/sdk/python/pulumi_aws_native/applicationautoscaling/outputs.py b/sdk/python/pulumi_aws_native/applicationautoscaling/outputs.py index a6167e4a5d..3c78802f0d 100644 --- a/sdk/python/pulumi_aws_native/applicationautoscaling/outputs.py +++ b/sdk/python/pulumi_aws_native/applicationautoscaling/outputs.py @@ -511,6 +511,9 @@ def resource_label(self) -> Optional[str]: @pulumi.output_type class ScalingPolicyPredictiveScalingCustomizedCapacityMetric(dict): + """ + Represents a CloudWatch metric of your choosing for a predictive scaling policy. + """ @staticmethod def __key_warning(key: str): suggest = None @@ -531,6 +534,7 @@ def get(self, key: str, default = None) -> Any: def __init__(__self__, *, metric_data_queries: Sequence['outputs.ScalingPolicyPredictiveScalingMetricDataQuery']): """ + Represents a CloudWatch metric of your choosing for a predictive scaling policy. :param Sequence['ScalingPolicyPredictiveScalingMetricDataQuery'] metric_data_queries: One or more metric data queries to provide data points for a metric specification. """ pulumi.set(__self__, "metric_data_queries", metric_data_queries) @@ -546,6 +550,9 @@ def metric_data_queries(self) -> Sequence['outputs.ScalingPolicyPredictiveScalin @pulumi.output_type class ScalingPolicyPredictiveScalingCustomizedLoadMetric(dict): + """ + The customized load metric specification. + """ @staticmethod def __key_warning(key: str): suggest = None @@ -565,6 +572,9 @@ def get(self, key: str, default = None) -> Any: def __init__(__self__, *, metric_data_queries: Sequence['outputs.ScalingPolicyPredictiveScalingMetricDataQuery']): + """ + The customized load metric specification. + """ pulumi.set(__self__, "metric_data_queries", metric_data_queries) @property @@ -575,6 +585,9 @@ def metric_data_queries(self) -> Sequence['outputs.ScalingPolicyPredictiveScalin @pulumi.output_type class ScalingPolicyPredictiveScalingCustomizedScalingMetric(dict): + """ + One or more metric data queries to provide data points for a metric specification. + """ @staticmethod def __key_warning(key: str): suggest = None @@ -595,6 +608,7 @@ def get(self, key: str, default = None) -> Any: def __init__(__self__, *, metric_data_queries: Sequence['outputs.ScalingPolicyPredictiveScalingMetricDataQuery']): """ + One or more metric data queries to provide data points for a metric specification. :param Sequence['ScalingPolicyPredictiveScalingMetricDataQuery'] metric_data_queries: One or more metric data queries to provide data points for a metric specification. """ pulumi.set(__self__, "metric_data_queries", metric_data_queries) @@ -610,6 +624,9 @@ def metric_data_queries(self) -> Sequence['outputs.ScalingPolicyPredictiveScalin @pulumi.output_type class ScalingPolicyPredictiveScalingMetric(dict): + """ + Describes the scaling metric. + """ @staticmethod def __key_warning(key: str): suggest = None @@ -632,7 +649,8 @@ def __init__(__self__, *, metric_name: Optional[str] = None, namespace: Optional[str] = None): """ - :param Sequence['ScalingPolicyPredictiveScalingMetricDimension'] dimensions: The dimensions for the metric. + Describes the scaling metric. + :param Sequence['ScalingPolicyPredictiveScalingMetricDimension'] dimensions: Describes the dimensions of the metric. :param str metric_name: The name of the metric. :param str namespace: The namespace of the metric. """ @@ -647,7 +665,7 @@ def __init__(__self__, *, @pulumi.getter def dimensions(self) -> Optional[Sequence['outputs.ScalingPolicyPredictiveScalingMetricDimension']]: """ - The dimensions for the metric. + Describes the dimensions of the metric. """ return pulumi.get(self, "dimensions") @@ -670,6 +688,9 @@ def namespace(self) -> Optional[str]: @pulumi.output_type class ScalingPolicyPredictiveScalingMetricDataQuery(dict): + """ + 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. + """ @staticmethod def __key_warning(key: str): suggest = None @@ -696,11 +717,16 @@ def __init__(__self__, *, metric_stat: Optional['outputs.ScalingPolicyPredictiveScalingMetricStat'] = None, return_data: Optional[bool] = None): """ - :param str expression: The math expression to perform on the returned data, if this object is performing a math expression. - :param str id: A short name that identifies the object's results in the response. + 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. + :param str expression: 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. + Conditional: Within each ``MetricDataQuery`` object, you must specify either ``Expression`` or ``MetricStat``, but not both. + :param str id: 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. :param str label: 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. - :param 'ScalingPolicyPredictiveScalingMetricStat' metric_stat: Information about the metric data to return. - :param bool return_data: Indicates whether to return the timestamps and raw data values of this metric. + :param 'ScalingPolicyPredictiveScalingMetricStat' metric_stat: Information about the metric data to return. + Conditional: Within each ``MetricDataQuery`` object, you must specify either ``Expression`` or ``MetricStat``, but not both. + :param bool return_data: Indicates whether to return the timestamps and raw data values of this metric. + 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. + 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``). """ if expression is not None: pulumi.set(__self__, "expression", expression) @@ -717,7 +743,8 @@ def __init__(__self__, *, @pulumi.getter def expression(self) -> Optional[str]: """ - The math expression to perform on the returned data, if this object is performing a math expression. + 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. + Conditional: Within each ``MetricDataQuery`` object, you must specify either ``Expression`` or ``MetricStat``, but not both. """ return pulumi.get(self, "expression") @@ -725,7 +752,7 @@ def expression(self) -> Optional[str]: @pulumi.getter def id(self) -> Optional[str]: """ - A short name that identifies the object's results in the response. + 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. """ return pulumi.get(self, "id") @@ -741,7 +768,8 @@ def label(self) -> Optional[str]: @pulumi.getter(name="metricStat") def metric_stat(self) -> Optional['outputs.ScalingPolicyPredictiveScalingMetricStat']: """ - Information about the metric data to return. + Information about the metric data to return. + Conditional: Within each ``MetricDataQuery`` object, you must specify either ``Expression`` or ``MetricStat``, but not both. """ return pulumi.get(self, "metric_stat") @@ -749,17 +777,23 @@ def metric_stat(self) -> Optional['outputs.ScalingPolicyPredictiveScalingMetricS @pulumi.getter(name="returnData") def return_data(self) -> Optional[bool]: """ - Indicates whether to return the timestamps and raw data values of this metric. + Indicates whether to return the timestamps and raw data values of this metric. + 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. + 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``). """ return pulumi.get(self, "return_data") @pulumi.output_type class ScalingPolicyPredictiveScalingMetricDimension(dict): + """ + Describes the dimension of a metric. + """ def __init__(__self__, *, name: Optional[str] = None, value: Optional[str] = None): """ + Describes the dimension of a metric. :param str name: The name of the dimension. :param str value: The value of the dimension. """ @@ -787,6 +821,10 @@ def value(self) -> Optional[str]: @pulumi.output_type class ScalingPolicyPredictiveScalingMetricSpecification(dict): + """ + This structure specifies the metrics and target utilization settings for a predictive scaling policy. + 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. + """ @staticmethod def __key_warning(key: str): suggest = None @@ -825,6 +863,8 @@ def __init__(__self__, *, predefined_metric_pair_specification: Optional['outputs.ScalingPolicyPredictiveScalingPredefinedMetricPair'] = None, predefined_scaling_metric_specification: Optional['outputs.ScalingPolicyPredictiveScalingPredefinedScalingMetric'] = None): """ + This structure specifies the metrics and target utilization settings for a predictive scaling policy. + 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. :param float target_value: Specifies the target utilization. :param 'ScalingPolicyPredictiveScalingCustomizedCapacityMetric' customized_capacity_metric_specification: The customized capacity metric specification. :param 'ScalingPolicyPredictiveScalingCustomizedLoadMetric' customized_load_metric_specification: The customized load metric specification. @@ -906,14 +946,19 @@ def predefined_scaling_metric_specification(self) -> Optional['outputs.ScalingPo @pulumi.output_type class ScalingPolicyPredictiveScalingMetricStat(dict): + """ + This structure defines the CloudWatch metric to return, along with the statistic and unit. + """ def __init__(__self__, *, metric: Optional['outputs.ScalingPolicyPredictiveScalingMetric'] = None, stat: Optional[str] = None, unit: Optional[str] = None): """ - :param 'ScalingPolicyPredictiveScalingMetric' metric: The CloudWatch metric to return, including the metric name, namespace, and dimensions. - :param str stat: The statistic to return. It can include any CloudWatch statistic or extended statistic. - :param str unit: The unit to use for the returned data points. + This structure defines the CloudWatch metric to return, along with the statistic and unit. + :param 'ScalingPolicyPredictiveScalingMetric' metric: 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). + :param str stat: 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*. + The most commonly used metrics for predictive scaling are ``Average`` and ``Sum``. + :param str unit: 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*. """ if metric is not None: pulumi.set(__self__, "metric", metric) @@ -926,7 +971,7 @@ def __init__(__self__, *, @pulumi.getter def metric(self) -> Optional['outputs.ScalingPolicyPredictiveScalingMetric']: """ - The CloudWatch metric to return, including the metric name, namespace, and dimensions. + 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). """ return pulumi.get(self, "metric") @@ -934,7 +979,8 @@ def metric(self) -> Optional['outputs.ScalingPolicyPredictiveScalingMetric']: @pulumi.getter def stat(self) -> Optional[str]: """ - The statistic to return. It can include any CloudWatch statistic or extended statistic. + 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*. + The most commonly used metrics for predictive scaling are ``Average`` and ``Sum``. """ return pulumi.get(self, "stat") @@ -942,13 +988,16 @@ def stat(self) -> Optional[str]: @pulumi.getter def unit(self) -> Optional[str]: """ - The unit to use for the returned data points. + 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*. """ return pulumi.get(self, "unit") @pulumi.output_type class ScalingPolicyPredictiveScalingPolicyConfiguration(dict): + """ + Represents a predictive scaling policy configuration. + """ @staticmethod def __key_warning(key: str): suggest = None @@ -979,17 +1028,15 @@ def __init__(__self__, *, mode: Optional[str] = None, scheduling_buffer_time: Optional[int] = None): """ - :param Sequence['ScalingPolicyPredictiveScalingMetricSpecification'] metric_specifications: This structure includes the metrics and target utilization to use for predictive scaling. - - 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. - :param str max_capacity_breach_behavior: Defines the behavior that should be applied if the forecast capacity approaches or exceeds the maximum capacity. Defaults to `HonorMaxCapacity` if not specified. - :param int max_capacity_buffer: 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. - - Required if the `MaxCapacityBreachBehavior` property is set to `IncreaseMaxCapacity` , and cannot be used otherwise. - :param str mode: The predictive scaling mode. Defaults to `ForecastOnly` if not specified. - :param int scheduling_buffer_time: The amount of time, in seconds, that the start time can be advanced. - - The value must be less than the forecast interval duration of 3600 seconds (60 minutes). Defaults to 300 seconds if not specified. + Represents a predictive scaling policy configuration. + :param Sequence['ScalingPolicyPredictiveScalingMetricSpecification'] metric_specifications: This structure includes the metrics and target utilization to use for predictive scaling. + 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. + :param str max_capacity_breach_behavior: Defines the behavior that should be applied if the forecast capacity approaches or exceeds the maximum capacity. Defaults to ``HonorMaxCapacity`` if not specified. + :param int max_capacity_buffer: 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. + Required if the ``MaxCapacityBreachBehavior`` property is set to ``IncreaseMaxCapacity``, and cannot be used otherwise. + :param str mode: The predictive scaling mode. Defaults to ``ForecastOnly`` if not specified. + :param int scheduling_buffer_time: The amount of time, in seconds, that the start time can be advanced. + The value must be less than the forecast interval duration of 3600 seconds (60 minutes). Defaults to 300 seconds if not specified. """ pulumi.set(__self__, "metric_specifications", metric_specifications) if max_capacity_breach_behavior is not None: @@ -1005,9 +1052,8 @@ def __init__(__self__, *, @pulumi.getter(name="metricSpecifications") def metric_specifications(self) -> Sequence['outputs.ScalingPolicyPredictiveScalingMetricSpecification']: """ - This structure includes the metrics and target utilization to use for predictive scaling. - - 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. + This structure includes the metrics and target utilization to use for predictive scaling. + 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. """ return pulumi.get(self, "metric_specifications") @@ -1015,7 +1061,7 @@ def metric_specifications(self) -> Sequence['outputs.ScalingPolicyPredictiveScal @pulumi.getter(name="maxCapacityBreachBehavior") def max_capacity_breach_behavior(self) -> Optional[str]: """ - Defines the behavior that should be applied if the forecast capacity approaches or exceeds the maximum capacity. Defaults to `HonorMaxCapacity` if not specified. + Defines the behavior that should be applied if the forecast capacity approaches or exceeds the maximum capacity. Defaults to ``HonorMaxCapacity`` if not specified. """ return pulumi.get(self, "max_capacity_breach_behavior") @@ -1023,9 +1069,8 @@ def max_capacity_breach_behavior(self) -> Optional[str]: @pulumi.getter(name="maxCapacityBuffer") def max_capacity_buffer(self) -> Optional[int]: """ - 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. - - Required if the `MaxCapacityBreachBehavior` property is set to `IncreaseMaxCapacity` , and cannot be used otherwise. + 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. + Required if the ``MaxCapacityBreachBehavior`` property is set to ``IncreaseMaxCapacity``, and cannot be used otherwise. """ return pulumi.get(self, "max_capacity_buffer") @@ -1033,7 +1078,7 @@ def max_capacity_buffer(self) -> Optional[int]: @pulumi.getter def mode(self) -> Optional[str]: """ - The predictive scaling mode. Defaults to `ForecastOnly` if not specified. + The predictive scaling mode. Defaults to ``ForecastOnly`` if not specified. """ return pulumi.get(self, "mode") @@ -1041,15 +1086,18 @@ def mode(self) -> Optional[str]: @pulumi.getter(name="schedulingBufferTime") def scheduling_buffer_time(self) -> Optional[int]: """ - The amount of time, in seconds, that the start time can be advanced. - - The value must be less than the forecast interval duration of 3600 seconds (60 minutes). Defaults to 300 seconds if not specified. + The amount of time, in seconds, that the start time can be advanced. + The value must be less than the forecast interval duration of 3600 seconds (60 minutes). Defaults to 300 seconds if not specified. """ return pulumi.get(self, "scheduling_buffer_time") @pulumi.output_type class ScalingPolicyPredictiveScalingPredefinedLoadMetric(dict): + """ + Describes a load metric for a predictive scaling policy. + 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. + """ @staticmethod def __key_warning(key: str): suggest = None @@ -1073,6 +1121,8 @@ def __init__(__self__, *, predefined_metric_type: str, resource_label: Optional[str] = None): """ + Describes a load metric for a predictive scaling policy. + 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. :param str predefined_metric_type: The metric type. :param str resource_label: A label that uniquely identifies a target group. """ @@ -1099,6 +1149,9 @@ def resource_label(self) -> Optional[str]: @pulumi.output_type class ScalingPolicyPredictiveScalingPredefinedMetricPair(dict): + """ + Represents a metric pair for a predictive scaling policy. + """ @staticmethod def __key_warning(key: str): suggest = None @@ -1122,6 +1175,7 @@ def __init__(__self__, *, predefined_metric_type: str, resource_label: Optional[str] = None): """ + Represents a metric pair for a predictive scaling policy. :param str predefined_metric_type: 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. :param str resource_label: A label that uniquely identifies a specific target group from which to determine the total and average request count. """ @@ -1148,6 +1202,10 @@ def resource_label(self) -> Optional[str]: @pulumi.output_type class ScalingPolicyPredictiveScalingPredefinedScalingMetric(dict): + """ + Describes a scaling metric for a predictive scaling policy. + 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. + """ @staticmethod def __key_warning(key: str): suggest = None @@ -1171,6 +1229,8 @@ def __init__(__self__, *, predefined_metric_type: str, resource_label: Optional[str] = None): """ + Describes a scaling metric for a predictive scaling policy. + 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. :param str predefined_metric_type: The metric type. :param str resource_label: A label that uniquely identifies a specific target group from which to determine the average request count. """ diff --git a/sdk/python/pulumi_aws_native/bedrock/_inputs.py b/sdk/python/pulumi_aws_native/bedrock/_inputs.py index 4e1e8b6f46..c62490df71 100644 --- a/sdk/python/pulumi_aws_native/bedrock/_inputs.py +++ b/sdk/python/pulumi_aws_native/bedrock/_inputs.py @@ -2166,7 +2166,7 @@ class DataSourceParsingConfigurationArgsDict(TypedDict): """ bedrock_foundation_model_configuration: NotRequired[pulumi.Input['DataSourceBedrockFoundationModelConfigurationArgsDict']] """ - Settings for a foundation model used to parse documents for a data source. + If you specify `BEDROCK_FOUNDATION_MODEL` as the parsing strategy for ingesting your data source, use this object to modify configurations for using a foundation model to parse documents. """ elif False: DataSourceParsingConfigurationArgsDict: TypeAlias = Mapping[str, Any] @@ -2179,7 +2179,7 @@ def __init__(__self__, *, """ Settings for parsing document contents :param pulumi.Input['DataSourceParsingStrategy'] parsing_strategy: The parsing strategy for the data source. - :param pulumi.Input['DataSourceBedrockFoundationModelConfigurationArgs'] bedrock_foundation_model_configuration: Settings for a foundation model used to parse documents for a data source. + :param pulumi.Input['DataSourceBedrockFoundationModelConfigurationArgs'] bedrock_foundation_model_configuration: If you specify `BEDROCK_FOUNDATION_MODEL` as the parsing strategy for ingesting your data source, use this object to modify configurations for using a foundation model to parse documents. """ pulumi.set(__self__, "parsing_strategy", parsing_strategy) if bedrock_foundation_model_configuration is not None: @@ -2201,7 +2201,7 @@ def parsing_strategy(self, value: pulumi.Input['DataSourceParsingStrategy']): @pulumi.getter(name="bedrockFoundationModelConfiguration") def bedrock_foundation_model_configuration(self) -> Optional[pulumi.Input['DataSourceBedrockFoundationModelConfigurationArgs']]: """ - Settings for a foundation model used to parse documents for a data source. + If you specify `BEDROCK_FOUNDATION_MODEL` as the parsing strategy for ingesting your data source, use this object to modify configurations for using a foundation model to parse documents. """ return pulumi.get(self, "bedrock_foundation_model_configuration") @@ -3155,7 +3155,7 @@ class DataSourceVectorIngestionConfigurationArgsDict(TypedDict): """ parsing_configuration: NotRequired[pulumi.Input['DataSourceParsingConfigurationArgsDict']] """ - A custom parser for data source documents. + Configurations for a parser to use for parsing documents in your data source. If you exclude this field, the default parser will be used. """ elif False: DataSourceVectorIngestionConfigurationArgsDict: TypeAlias = Mapping[str, Any] @@ -3170,7 +3170,7 @@ def __init__(__self__, *, Details about how to chunk the documents in the data source. A chunk refers to an excerpt from a data source that is returned when the knowledge base that it belongs to is queried. :param pulumi.Input['DataSourceChunkingConfigurationArgs'] chunking_configuration: Details about how to chunk the documents in the data source. A *chunk* refers to an excerpt from a data source that is returned when the knowledge base that it belongs to is queried. :param pulumi.Input['DataSourceCustomTransformationConfigurationArgs'] custom_transformation_configuration: A custom document transformer for parsed data source documents. - :param pulumi.Input['DataSourceParsingConfigurationArgs'] parsing_configuration: A custom parser for data source documents. + :param pulumi.Input['DataSourceParsingConfigurationArgs'] parsing_configuration: Configurations for a parser to use for parsing documents in your data source. If you exclude this field, the default parser will be used. """ if chunking_configuration is not None: pulumi.set(__self__, "chunking_configuration", chunking_configuration) @@ -3207,7 +3207,7 @@ def custom_transformation_configuration(self, value: Optional[pulumi.Input['Data @pulumi.getter(name="parsingConfiguration") def parsing_configuration(self) -> Optional[pulumi.Input['DataSourceParsingConfigurationArgs']]: """ - A custom parser for data source documents. + Configurations for a parser to use for parsing documents in your data source. If you exclude this field, the default parser will be used. """ return pulumi.get(self, "parsing_configuration") @@ -5739,7 +5739,7 @@ class GuardrailPiiEntityConfigArgsDict(TypedDict): A physical address, such as "100 Main Street, Anytown, USA" or "Suite #12, Building 123". An address can include information such as the street, building, location, city, state, country, county, zip code, precinct, and neighborhood. - *AGE* - An individual's age, including the quantity and unit of time. For example, in the phrase "I am 40 years old," Guarrails recognizes "40 years" as an age. + An individual's age, including the quantity and unit of time. For example, in the phrase "I am 40 years old," Guardrails recognizes "40 years" as an age. - *NAME* An individual's name. This entity type does not include titles, such as Dr., Mr., Mrs., or Miss. guardrails doesn't apply this entity type to names that are part of organizations or addresses. For example, guardrails recognizes the "John Doe Organization" as an organization, and it recognizes "Jane Doe Street" as an address. @@ -5766,7 +5766,7 @@ class GuardrailPiiEntityConfigArgsDict(TypedDict): A Vehicle Identification Number (VIN) uniquely identifies a vehicle. VIN content and format are defined in the *ISO 3779* specification. Each country has specific codes and formats for VINs. - *Finance* - - *REDIT_DEBIT_CARD_CVV* + - *CREDIT_DEBIT_CARD_CVV* A three-digit card verification code (CVV) that is present on VISA, MasterCard, and Discover credit and debit cards. For American Express credit or debit cards, the CVV is a four-digit numeric code. - *CREDIT_DEBIT_CARD_EXPIRY* @@ -5869,7 +5869,7 @@ def __init__(__self__, *, A physical address, such as "100 Main Street, Anytown, USA" or "Suite #12, Building 123". An address can include information such as the street, building, location, city, state, country, county, zip code, precinct, and neighborhood. - *AGE* - An individual's age, including the quantity and unit of time. For example, in the phrase "I am 40 years old," Guarrails recognizes "40 years" as an age. + An individual's age, including the quantity and unit of time. For example, in the phrase "I am 40 years old," Guardrails recognizes "40 years" as an age. - *NAME* An individual's name. This entity type does not include titles, such as Dr., Mr., Mrs., or Miss. guardrails doesn't apply this entity type to names that are part of organizations or addresses. For example, guardrails recognizes the "John Doe Organization" as an organization, and it recognizes "Jane Doe Street" as an address. @@ -5896,7 +5896,7 @@ def __init__(__self__, *, A Vehicle Identification Number (VIN) uniquely identifies a vehicle. VIN content and format are defined in the *ISO 3779* specification. Each country has specific codes and formats for VINs. - *Finance* - - *REDIT_DEBIT_CARD_CVV* + - *CREDIT_DEBIT_CARD_CVV* A three-digit card verification code (CVV) that is present on VISA, MasterCard, and Discover credit and debit cards. For American Express credit or debit cards, the CVV is a four-digit numeric code. - *CREDIT_DEBIT_CARD_EXPIRY* @@ -6007,7 +6007,7 @@ def type(self) -> pulumi.Input['GuardrailPiiEntityType']: A physical address, such as "100 Main Street, Anytown, USA" or "Suite #12, Building 123". An address can include information such as the street, building, location, city, state, country, county, zip code, precinct, and neighborhood. - *AGE* - An individual's age, including the quantity and unit of time. For example, in the phrase "I am 40 years old," Guarrails recognizes "40 years" as an age. + An individual's age, including the quantity and unit of time. For example, in the phrase "I am 40 years old," Guardrails recognizes "40 years" as an age. - *NAME* An individual's name. This entity type does not include titles, such as Dr., Mr., Mrs., or Miss. guardrails doesn't apply this entity type to names that are part of organizations or addresses. For example, guardrails recognizes the "John Doe Organization" as an organization, and it recognizes "Jane Doe Street" as an address. @@ -6034,7 +6034,7 @@ def type(self) -> pulumi.Input['GuardrailPiiEntityType']: A Vehicle Identification Number (VIN) uniquely identifies a vehicle. VIN content and format are defined in the *ISO 3779* specification. Each country has specific codes and formats for VINs. - *Finance* - - *REDIT_DEBIT_CARD_CVV* + - *CREDIT_DEBIT_CARD_CVV* A three-digit card verification code (CVV) that is present on VISA, MasterCard, and Discover credit and debit cards. For American Express credit or debit cards, the CVV is a four-digit numeric code. - *CREDIT_DEBIT_CARD_EXPIRY* diff --git a/sdk/python/pulumi_aws_native/bedrock/outputs.py b/sdk/python/pulumi_aws_native/bedrock/outputs.py index f28b172596..4bdc36a997 100644 --- a/sdk/python/pulumi_aws_native/bedrock/outputs.py +++ b/sdk/python/pulumi_aws_native/bedrock/outputs.py @@ -1955,7 +1955,7 @@ def __init__(__self__, *, """ Settings for parsing document contents :param 'DataSourceParsingStrategy' parsing_strategy: The parsing strategy for the data source. - :param 'DataSourceBedrockFoundationModelConfiguration' bedrock_foundation_model_configuration: Settings for a foundation model used to parse documents for a data source. + :param 'DataSourceBedrockFoundationModelConfiguration' bedrock_foundation_model_configuration: If you specify `BEDROCK_FOUNDATION_MODEL` as the parsing strategy for ingesting your data source, use this object to modify configurations for using a foundation model to parse documents. """ pulumi.set(__self__, "parsing_strategy", parsing_strategy) if bedrock_foundation_model_configuration is not None: @@ -1973,7 +1973,7 @@ def parsing_strategy(self) -> 'DataSourceParsingStrategy': @pulumi.getter(name="bedrockFoundationModelConfiguration") def bedrock_foundation_model_configuration(self) -> Optional['outputs.DataSourceBedrockFoundationModelConfiguration']: """ - Settings for a foundation model used to parse documents for a data source. + If you specify `BEDROCK_FOUNDATION_MODEL` as the parsing strategy for ingesting your data source, use this object to modify configurations for using a foundation model to parse documents. """ return pulumi.get(self, "bedrock_foundation_model_configuration") @@ -2871,7 +2871,7 @@ def __init__(__self__, *, Details about how to chunk the documents in the data source. A chunk refers to an excerpt from a data source that is returned when the knowledge base that it belongs to is queried. :param 'DataSourceChunkingConfiguration' chunking_configuration: Details about how to chunk the documents in the data source. A *chunk* refers to an excerpt from a data source that is returned when the knowledge base that it belongs to is queried. :param 'DataSourceCustomTransformationConfiguration' custom_transformation_configuration: A custom document transformer for parsed data source documents. - :param 'DataSourceParsingConfiguration' parsing_configuration: A custom parser for data source documents. + :param 'DataSourceParsingConfiguration' parsing_configuration: Configurations for a parser to use for parsing documents in your data source. If you exclude this field, the default parser will be used. """ if chunking_configuration is not None: pulumi.set(__self__, "chunking_configuration", chunking_configuration) @@ -2900,7 +2900,7 @@ def custom_transformation_configuration(self) -> Optional['outputs.DataSourceCus @pulumi.getter(name="parsingConfiguration") def parsing_configuration(self) -> Optional['outputs.DataSourceParsingConfiguration']: """ - A custom parser for data source documents. + Configurations for a parser to use for parsing documents in your data source. If you exclude this field, the default parser will be used. """ return pulumi.get(self, "parsing_configuration") @@ -6490,7 +6490,7 @@ def __init__(__self__, *, A physical address, such as "100 Main Street, Anytown, USA" or "Suite #12, Building 123". An address can include information such as the street, building, location, city, state, country, county, zip code, precinct, and neighborhood. - *AGE* - An individual's age, including the quantity and unit of time. For example, in the phrase "I am 40 years old," Guarrails recognizes "40 years" as an age. + An individual's age, including the quantity and unit of time. For example, in the phrase "I am 40 years old," Guardrails recognizes "40 years" as an age. - *NAME* An individual's name. This entity type does not include titles, such as Dr., Mr., Mrs., or Miss. guardrails doesn't apply this entity type to names that are part of organizations or addresses. For example, guardrails recognizes the "John Doe Organization" as an organization, and it recognizes "Jane Doe Street" as an address. @@ -6517,7 +6517,7 @@ def __init__(__self__, *, A Vehicle Identification Number (VIN) uniquely identifies a vehicle. VIN content and format are defined in the *ISO 3779* specification. Each country has specific codes and formats for VINs. - *Finance* - - *REDIT_DEBIT_CARD_CVV* + - *CREDIT_DEBIT_CARD_CVV* A three-digit card verification code (CVV) that is present on VISA, MasterCard, and Discover credit and debit cards. For American Express credit or debit cards, the CVV is a four-digit numeric code. - *CREDIT_DEBIT_CARD_EXPIRY* @@ -6624,7 +6624,7 @@ def type(self) -> 'GuardrailPiiEntityType': A physical address, such as "100 Main Street, Anytown, USA" or "Suite #12, Building 123". An address can include information such as the street, building, location, city, state, country, county, zip code, precinct, and neighborhood. - *AGE* - An individual's age, including the quantity and unit of time. For example, in the phrase "I am 40 years old," Guarrails recognizes "40 years" as an age. + An individual's age, including the quantity and unit of time. For example, in the phrase "I am 40 years old," Guardrails recognizes "40 years" as an age. - *NAME* An individual's name. This entity type does not include titles, such as Dr., Mr., Mrs., or Miss. guardrails doesn't apply this entity type to names that are part of organizations or addresses. For example, guardrails recognizes the "John Doe Organization" as an organization, and it recognizes "Jane Doe Street" as an address. @@ -6651,7 +6651,7 @@ def type(self) -> 'GuardrailPiiEntityType': A Vehicle Identification Number (VIN) uniquely identifies a vehicle. VIN content and format are defined in the *ISO 3779* specification. Each country has specific codes and formats for VINs. - *Finance* - - *REDIT_DEBIT_CARD_CVV* + - *CREDIT_DEBIT_CARD_CVV* A three-digit card verification code (CVV) that is present on VISA, MasterCard, and Discover credit and debit cards. For American Express credit or debit cards, the CVV is a four-digit numeric code. - *CREDIT_DEBIT_CARD_EXPIRY* diff --git a/sdk/python/pulumi_aws_native/cognito/_inputs.py b/sdk/python/pulumi_aws_native/cognito/_inputs.py index c7b3b168cd..909d7b932b 100644 --- a/sdk/python/pulumi_aws_native/cognito/_inputs.py +++ b/sdk/python/pulumi_aws_native/cognito/_inputs.py @@ -710,6 +710,9 @@ def recovery_mechanisms(self, value: Optional[pulumi.Input[Sequence[pulumi.Input if not MYPY: class UserPoolAddOnsArgsDict(TypedDict): advanced_security_additional_flows: NotRequired[pulumi.Input['UserPoolAdvancedSecurityAdditionalFlowsArgsDict']] + """ + Advanced security configuration options for additional authentication types in your user pool, including custom authentication. + """ advanced_security_mode: NotRequired[pulumi.Input[str]] """ The operating mode of advanced security features for standard authentication types in your user pool, including username-password and secure remote password (SRP) authentication. @@ -723,6 +726,7 @@ def __init__(__self__, *, advanced_security_additional_flows: Optional[pulumi.Input['UserPoolAdvancedSecurityAdditionalFlowsArgs']] = None, advanced_security_mode: Optional[pulumi.Input[str]] = None): """ + :param pulumi.Input['UserPoolAdvancedSecurityAdditionalFlowsArgs'] advanced_security_additional_flows: Advanced security configuration options for additional authentication types in your user pool, including custom authentication. :param pulumi.Input[str] advanced_security_mode: The operating mode of advanced security features for standard authentication types in your user pool, including username-password and secure remote password (SRP) authentication. """ if advanced_security_additional_flows is not None: @@ -733,6 +737,9 @@ def __init__(__self__, *, @property @pulumi.getter(name="advancedSecurityAdditionalFlows") def advanced_security_additional_flows(self) -> Optional[pulumi.Input['UserPoolAdvancedSecurityAdditionalFlowsArgs']]: + """ + Advanced security configuration options for additional authentication types in your user pool, including custom authentication. + """ return pulumi.get(self, "advanced_security_additional_flows") @advanced_security_additional_flows.setter @@ -845,6 +852,9 @@ def unused_account_validity_days(self, value: Optional[pulumi.Input[int]]): if not MYPY: class UserPoolAdvancedSecurityAdditionalFlowsArgsDict(TypedDict): custom_auth_mode: NotRequired[pulumi.Input[str]] + """ + The operating mode of advanced security features in custom authentication with [Custom authentication challenge Lambda triggers](https://docs.aws.amazon.com/cognito/latest/developerguide/user-pool-lambda-challenge.html) . + """ elif False: UserPoolAdvancedSecurityAdditionalFlowsArgsDict: TypeAlias = Mapping[str, Any] @@ -852,12 +862,18 @@ class UserPoolAdvancedSecurityAdditionalFlowsArgsDict(TypedDict): class UserPoolAdvancedSecurityAdditionalFlowsArgs: def __init__(__self__, *, custom_auth_mode: Optional[pulumi.Input[str]] = None): + """ + :param pulumi.Input[str] custom_auth_mode: The operating mode of advanced security features in custom authentication with [Custom authentication challenge Lambda triggers](https://docs.aws.amazon.com/cognito/latest/developerguide/user-pool-lambda-challenge.html) . + """ if custom_auth_mode is not None: pulumi.set(__self__, "custom_auth_mode", custom_auth_mode) @property @pulumi.getter(name="customAuthMode") def custom_auth_mode(self) -> Optional[pulumi.Input[str]]: + """ + The operating mode of advanced security features in custom authentication with [Custom authentication challenge Lambda triggers](https://docs.aws.amazon.com/cognito/latest/developerguide/user-pool-lambda-challenge.html) . + """ return pulumi.get(self, "custom_auth_mode") @custom_auth_mode.setter @@ -2023,6 +2039,11 @@ class UserPoolPoliciesArgsDict(TypedDict): The password policy settings for a user pool, including complexity, history, and length requirements. """ sign_in_policy: NotRequired[pulumi.Input['UserPoolSignInPolicyArgsDict']] + """ + The policy for allowed types of authentication in a user pool. + + This data type is a request and response parameter of [CreateUserPool](https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_CreateUserPool.html) and [UpdateUserPool](https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_UpdateUserPool.html) , and a response parameter of [DescribeUserPool](https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_DescribeUserPool.html) . + """ elif False: UserPoolPoliciesArgsDict: TypeAlias = Mapping[str, Any] @@ -2033,6 +2054,9 @@ def __init__(__self__, *, sign_in_policy: Optional[pulumi.Input['UserPoolSignInPolicyArgs']] = None): """ :param pulumi.Input['UserPoolPasswordPolicyArgs'] password_policy: The password policy settings for a user pool, including complexity, history, and length requirements. + :param pulumi.Input['UserPoolSignInPolicyArgs'] sign_in_policy: The policy for allowed types of authentication in a user pool. + + This data type is a request and response parameter of [CreateUserPool](https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_CreateUserPool.html) and [UpdateUserPool](https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_UpdateUserPool.html) , and a response parameter of [DescribeUserPool](https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_DescribeUserPool.html) . """ if password_policy is not None: pulumi.set(__self__, "password_policy", password_policy) @@ -2054,6 +2078,11 @@ def password_policy(self, value: Optional[pulumi.Input['UserPoolPasswordPolicyAr @property @pulumi.getter(name="signInPolicy") def sign_in_policy(self) -> Optional[pulumi.Input['UserPoolSignInPolicyArgs']]: + """ + The policy for allowed types of authentication in a user pool. + + This data type is a request and response parameter of [CreateUserPool](https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_CreateUserPool.html) and [UpdateUserPool](https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_UpdateUserPool.html) , and a response parameter of [DescribeUserPool](https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_DescribeUserPool.html) . + """ return pulumi.get(self, "sign_in_policy") @sign_in_policy.setter @@ -2912,6 +2941,11 @@ def string_attribute_constraints(self, value: Optional[pulumi.Input['UserPoolStr if not MYPY: class UserPoolSignInPolicyArgsDict(TypedDict): allowed_first_auth_factors: NotRequired[pulumi.Input[Sequence[pulumi.Input[str]]]] + """ + The sign-in methods that a user pool supports as the first factor. You can permit users to start authentication with a standard username and password, or with other one-time password and hardware factors. + + Supports values of `EMAIL_OTP` , `SMS_OTP` , `WEB_AUTHN` and `PASSWORD` , + """ elif False: UserPoolSignInPolicyArgsDict: TypeAlias = Mapping[str, Any] @@ -2919,12 +2953,22 @@ class UserPoolSignInPolicyArgsDict(TypedDict): class UserPoolSignInPolicyArgs: def __init__(__self__, *, allowed_first_auth_factors: Optional[pulumi.Input[Sequence[pulumi.Input[str]]]] = None): + """ + :param pulumi.Input[Sequence[pulumi.Input[str]]] allowed_first_auth_factors: The sign-in methods that a user pool supports as the first factor. You can permit users to start authentication with a standard username and password, or with other one-time password and hardware factors. + + Supports values of `EMAIL_OTP` , `SMS_OTP` , `WEB_AUTHN` and `PASSWORD` , + """ if allowed_first_auth_factors is not None: pulumi.set(__self__, "allowed_first_auth_factors", allowed_first_auth_factors) @property @pulumi.getter(name="allowedFirstAuthFactors") def allowed_first_auth_factors(self) -> Optional[pulumi.Input[Sequence[pulumi.Input[str]]]]: + """ + The sign-in methods that a user pool supports as the first factor. You can permit users to start authentication with a standard username and password, or with other one-time password and hardware factors. + + Supports values of `EMAIL_OTP` , `SMS_OTP` , `WEB_AUTHN` and `PASSWORD` , + """ return pulumi.get(self, "allowed_first_auth_factors") @allowed_first_auth_factors.setter diff --git a/sdk/python/pulumi_aws_native/cognito/get_managed_login_branding.py b/sdk/python/pulumi_aws_native/cognito/get_managed_login_branding.py index e99b474fa1..891c754a96 100644 --- a/sdk/python/pulumi_aws_native/cognito/get_managed_login_branding.py +++ b/sdk/python/pulumi_aws_native/cognito/get_managed_login_branding.py @@ -69,7 +69,9 @@ def settings(self) -> Optional[Any]: @pulumi.getter(name="useCognitoProvidedValues") def use_cognito_provided_values(self) -> Optional[bool]: """ - When true, applies the default branding style options. This option reverts to a "blank" style that you can modify later in the branding designer. + When true, applies the default branding style options. This option reverts to default style options that are managed by Amazon Cognito. You can modify them later in the branding designer. + + When you specify `true` for this option, you must also omit values for `Settings` and `Assets` in the request. """ return pulumi.get(self, "use_cognito_provided_values") diff --git a/sdk/python/pulumi_aws_native/cognito/get_user_pool.py b/sdk/python/pulumi_aws_native/cognito/get_user_pool.py index f1bf038b65..e00e92d8fb 100644 --- a/sdk/python/pulumi_aws_native/cognito/get_user_pool.py +++ b/sdk/python/pulumi_aws_native/cognito/get_user_pool.py @@ -145,7 +145,7 @@ def admin_create_user_config(self) -> Optional['outputs.UserPoolAdminCreateUserC @pulumi.getter(name="aliasAttributes") def alias_attributes(self) -> Optional[Sequence[str]]: """ - Attributes supported as an alias for this user pool. Possible values: *phone_number* , *email* , or *preferred_username* . + Attributes supported as an alias for this user pool. Possible values: *phone_number* , *email* , or *preferred_username* . For more information about alias attributes, see [Customizing sign-in attributes](https://docs.aws.amazon.com/cognito/latest/developerguide/user-pool-settings-attributes.html#user-pool-settings-aliases) . """ return pulumi.get(self, "alias_attributes") @@ -161,7 +161,7 @@ def arn(self) -> Optional[str]: @pulumi.getter(name="autoVerifiedAttributes") def auto_verified_attributes(self) -> Optional[Sequence[str]]: """ - The attributes to be auto-verified. Possible values: *email* , *phone_number* . + The attributes that you want your user pool to automatically verify. Possible values: *email* , *phone_number* . For more information see [Verifying contact information at sign-up](https://docs.aws.amazon.com/cognito/latest/developerguide/signing-up-users-in-your-app.html#allowing-users-to-sign-up-and-confirm-themselves) . """ return pulumi.get(self, "auto_verified_attributes") @@ -181,9 +181,9 @@ def deletion_protection(self) -> Optional[str]: @pulumi.getter(name="deviceConfiguration") def device_configuration(self) -> Optional['outputs.UserPoolDeviceConfiguration']: """ - The device-remembering configuration for a user pool. A null value indicates that you have deactivated device remembering in your user pool. + The device-remembering configuration for a user pool. Device remembering or device tracking is a "Remember me on this device" option for user pools that perform authentication with the device key of a trusted device in the back end, instead of a user-provided MFA code. For more information about device authentication, see [Working with user devices in your user pool](https://docs.aws.amazon.com/cognito/latest/developerguide/amazon-cognito-user-pools-device-tracking.html) . A null value indicates that you have deactivated device remembering in your user pool. - > When you provide a value for any `DeviceConfiguration` field, you activate the Amazon Cognito device-remembering feature. + > When you provide a value for any `DeviceConfiguration` field, you activate the Amazon Cognito device-remembering feature. For more infor """ return pulumi.get(self, "device_configuration") @@ -271,7 +271,7 @@ def provider_url(self) -> Optional[str]: @pulumi.getter def schema(self) -> Optional[Sequence['outputs.UserPoolSchemaAttribute']]: """ - An array of schema attributes for the new user pool. These attributes can be standard or custom attributes. + An array of attributes for the new user pool. You can add custom attributes and modify the properties of default attributes. The specifications in this parameter set the required attributes in your user pool. For more information, see [Working with user attributes](https://docs.aws.amazon.com/cognito/latest/developerguide/user-pool-settings-attributes.html) . """ return pulumi.get(self, "schema") @@ -287,7 +287,7 @@ def sms_authentication_message(self) -> Optional[str]: @pulumi.getter(name="smsConfiguration") def sms_configuration(self) -> Optional['outputs.UserPoolSmsConfiguration']: """ - The SMS configuration with the settings that your Amazon Cognito user pool must use to send an SMS message from your AWS account through Amazon Simple Notification Service. To send SMS messages with Amazon SNS in the AWS Region that you want, the Amazon Cognito user pool uses an AWS Identity and Access Management (IAM) role in your AWS account . + The SMS configuration with the settings that your Amazon Cognito user pool must use to send an SMS message from your AWS account through Amazon Simple Notification Service. To send SMS messages with Amazon SNS in the AWS Region that you want, the Amazon Cognito user pool uses an AWS Identity and Access Management (IAM) role in your AWS account . For more information see [SMS message settings](https://docs.aws.amazon.com/cognito/latest/developerguide/user-pool-sms-settings.html) . """ return pulumi.get(self, "sms_configuration") @@ -331,7 +331,7 @@ def user_pool_id(self) -> Optional[str]: @pulumi.getter(name="userPoolName") def user_pool_name(self) -> Optional[str]: """ - A string used to name the user pool. + A friendlhy name for your user pool. """ return pulumi.get(self, "user_pool_name") @@ -363,9 +363,11 @@ def username_attributes(self) -> Optional[Sequence[str]]: @pulumi.getter(name="usernameConfiguration") def username_configuration(self) -> Optional['outputs.UserPoolUsernameConfiguration']: """ - Case sensitivity on the username input for the selected sign-in option. When case sensitivity is set to `False` (case insensitive), users can sign in with any combination of capital and lowercase letters. For example, `username` , `USERNAME` , or `UserName` , or for email, `email@example.com` or `EMaiL@eXamplE.Com` . For most use cases, set case sensitivity to `False` (case insensitive) as a best practice. When usernames and email addresses are case insensitive, Amazon Cognito treats any variation in case as the same user, and prevents a case variation from being assigned to the same attribute for a different user. + Sets the case sensitivity option for sign-in usernames. When `CaseSensitive` is `false` (case insensitive), users can sign in with any combination of capital and lowercase letters. For example, `username` , `USERNAME` , or `UserName` , or for email, `email@example.com` or `EMaiL@eXamplE.Com` . For most use cases, set case sensitivity to `false` as a best practice. When usernames and email addresses are case insensitive, Amazon Cognito treats any variation in case as the same user, and prevents a case variation from being assigned to the same attribute for a different user. - This configuration is immutable after you set it. For more information, see [UsernameConfigurationType](https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_UsernameConfigurationType.html) . + When `CaseSensitive` is `true` (case sensitive), Amazon Cognito interprets `USERNAME` and `UserName` as distinct users. + + This configuration is immutable after you set it. """ return pulumi.get(self, "username_configuration") @@ -382,11 +384,23 @@ def verification_message_template(self) -> Optional['outputs.UserPoolVerificatio @property @pulumi.getter(name="webAuthnRelyingPartyId") def web_authn_relying_party_id(self) -> Optional[str]: + """ + Sets or displays the authentication domain, typically your user pool domain, that passkey providers must use as a relying party (RP) in their configuration. + + Under the following conditions, the passkey relying party ID must be the fully-qualified domain name of your custom domain: + + - The user pool is configured for passkey authentication. + - The user pool has a custom domain, whether or not it also has a prefix domain. + - Your application performs authentication with managed login or the classic hosted UI. + """ return pulumi.get(self, "web_authn_relying_party_id") @property @pulumi.getter(name="webAuthnUserVerification") def web_authn_user_verification(self) -> Optional[str]: + """ + When `required` , users can only register and sign in users with passkeys that are capable of [user verification](https://docs.aws.amazon.com/https://www.w3.org/TR/webauthn-2/#enum-userVerificationRequirement) . When `preferred` , your user pool doesn't require the use of authenticators with user verification but encourages it. + """ return pulumi.get(self, "web_authn_user_verification") diff --git a/sdk/python/pulumi_aws_native/cognito/get_user_pool_client.py b/sdk/python/pulumi_aws_native/cognito/get_user_pool_client.py index f2c0674854..0c42465acb 100644 --- a/sdk/python/pulumi_aws_native/cognito/get_user_pool_client.py +++ b/sdk/python/pulumi_aws_native/cognito/get_user_pool_client.py @@ -144,7 +144,7 @@ def allowed_o_auth_flows_user_pool_client(self) -> Optional[bool]: @pulumi.getter(name="allowedOAuthScopes") def allowed_o_auth_scopes(self) -> Optional[Sequence[str]]: """ - The allowed OAuth scopes. Possible values provided by OAuth are `phone` , `email` , `openid` , and `profile` . Possible values provided by AWS are `aws.cognito.signin.user.admin` . Custom scopes created in Resource Servers are also supported. + The OAuth 2.0 scopes that you want to permit your app client to authorize. Scopes govern access control to user pool self-service API operations, user data from the `userInfo` endpoint, and third-party APIs. Possible values provided by OAuth are `phone` , `email` , `openid` , and `profile` . Possible values provided by AWS are `aws.cognito.signin.user.admin` . Custom scopes created in Resource Servers are also supported. """ return pulumi.get(self, "allowed_o_auth_scopes") @@ -154,7 +154,7 @@ def analytics_configuration(self) -> Optional['outputs.UserPoolClientAnalyticsCo """ The user pool analytics configuration for collecting metrics and sending them to your Amazon Pinpoint campaign. - > In AWS Regions where Amazon Pinpoint isn't available, user pools only support sending events to Amazon Pinpoint projects in AWS Region us-east-1. In Regions where Amazon Pinpoint is available, user pools support sending events to Amazon Pinpoint projects within that same Region. + In AWS Regions where Amazon Pinpoint isn't available, user pools might not have access to analytics or might be configurable with campaigns in the US East (N. Virginia) Region. For more information, see [Using Amazon Pinpoint analytics](https://docs.aws.amazon.com/cognito/latest/developerguide/cognito-user-pools-pinpoint-integration.html) . """ return pulumi.get(self, "analytics_configuration") @@ -175,7 +175,7 @@ def callback_urls(self) -> Optional[Sequence[str]]: A redirect URI must: - Be an absolute URI. - - Be registered with the authorization server. + - Be registered with the authorization server. Amazon Cognito doesn't accept authorization requests with `redirect_uri` values that aren't in the list of `CallbackURLs` that you provide in this parameter. - Not include a fragment component. See [OAuth 2.0 - Redirection Endpoint](https://docs.aws.amazon.com/https://tools.ietf.org/html/rfc6749#section-3.1.2) . @@ -198,7 +198,7 @@ def client_id(self) -> Optional[str]: @pulumi.getter(name="clientName") def client_name(self) -> Optional[str]: """ - The client name for the user pool client you would like to create. + A friendly name for the app client that you want to create. """ return pulumi.get(self, "client_name") @@ -212,18 +212,6 @@ def client_secret(self) -> Optional[str]: def default_redirect_uri(self) -> Optional[str]: """ The default redirect URI. In app clients with one assigned IdP, replaces `redirect_uri` in authentication requests. Must be in the `CallbackURLs` list. - - A redirect URI must: - - - Be an absolute URI. - - Be registered with the authorization server. - - Not include a fragment component. - - For more information, see [Default redirect URI](https://docs.aws.amazon.com/cognito/latest/developerguide/user-pool-settings-client-apps.html#cognito-user-pools-app-idp-settings-about) . - - Amazon Cognito requires HTTPS over HTTP except for http://localhost for testing purposes only. - - App callback URLs such as myapp://example are also supported. """ return pulumi.get(self, "default_redirect_uri") @@ -286,7 +274,7 @@ def id_token_validity(self) -> Optional[int]: @pulumi.getter(name="logoutUrls") def logout_urls(self) -> Optional[Sequence[str]]: """ - A list of allowed logout URLs for the IdPs. + A list of allowed logout URLs for managed login authentication. For more information, see [Logout endpoint](https://docs.aws.amazon.com/cognito/latest/developerguide/logout-endpoint.html) . """ return pulumi.get(self, "logout_urls") @@ -342,7 +330,7 @@ def supported_identity_providers(self) -> Optional[Sequence[str]]: """ A list of provider names for the identity providers (IdPs) that are supported on this client. The following are supported: `COGNITO` , `Facebook` , `Google` , `SignInWithApple` , and `LoginWithAmazon` . You can also specify the names that you configured for the SAML and OIDC IdPs in your user pool, for example `MySAMLIdP` or `MyOIDCIdP` . - This setting applies to providers that you can access with the [hosted UI and OAuth 2.0 authorization server](https://docs.aws.amazon.com/cognito/latest/developerguide/cognito-user-pools-app-integration.html) . The removal of `COGNITO` from this list doesn't prevent authentication operations for local users with the user pools API in an AWS SDK. The only way to prevent API-based authentication is to block access with a [AWS WAF rule](https://docs.aws.amazon.com/cognito/latest/developerguide/user-pool-waf.html) . + This setting applies to providers that you can access with [managed login](https://docs.aws.amazon.com/cognito/latest/developerguide/cognito-user-pools-managed-login.html) . The removal of `COGNITO` from this list doesn't prevent authentication operations for local users with the user pools API in an AWS SDK. The only way to prevent API-based authentication is to block access with a [AWS WAF rule](https://docs.aws.amazon.com/cognito/latest/developerguide/user-pool-waf.html) . """ return pulumi.get(self, "supported_identity_providers") @@ -350,7 +338,7 @@ def supported_identity_providers(self) -> Optional[Sequence[str]]: @pulumi.getter(name="tokenValidityUnits") def token_validity_units(self) -> Optional['outputs.UserPoolClientTokenValidityUnits']: """ - The units in which the validity times are represented. The default unit for RefreshToken is days, and default for ID and access tokens are hours. + The units that validity times are represented in. The default unit for refresh tokens is days, and the default for ID and access tokens are hours. """ return pulumi.get(self, "token_validity_units") @@ -406,7 +394,7 @@ def get_user_pool_client(client_id: Optional[str] = None, :param str client_id: The ID of the app client, for example `1example23456789` . - :param str user_pool_id: The user pool ID for the user pool where you want to create a user pool client. + :param str user_pool_id: The ID of the user pool where you want to create an app client. """ __args__ = dict() __args__['clientId'] = client_id @@ -446,7 +434,7 @@ def get_user_pool_client_output(client_id: Optional[pulumi.Input[str]] = None, :param str client_id: The ID of the app client, for example `1example23456789` . - :param str user_pool_id: The user pool ID for the user pool where you want to create a user pool client. + :param str user_pool_id: The ID of the user pool where you want to create an app client. """ __args__ = dict() __args__['clientId'] = client_id diff --git a/sdk/python/pulumi_aws_native/cognito/get_user_pool_group.py b/sdk/python/pulumi_aws_native/cognito/get_user_pool_group.py index 957144ccb3..734aaa29b3 100644 --- a/sdk/python/pulumi_aws_native/cognito/get_user_pool_group.py +++ b/sdk/python/pulumi_aws_native/cognito/get_user_pool_group.py @@ -38,7 +38,7 @@ def __init__(__self__, description=None, precedence=None, role_arn=None): @pulumi.getter def description(self) -> Optional[str]: """ - A string containing the description of the group. + A description of the group that you're creating. """ return pulumi.get(self, "description") @@ -58,7 +58,7 @@ def precedence(self) -> Optional[int]: @pulumi.getter(name="roleArn") def role_arn(self) -> Optional[str]: """ - The role Amazon Resource Name (ARN) for the group. + The Amazon Resource Name (ARN) for the IAM role that you want to associate with the group. A group role primarily declares a preferred role for the credentials that you get from an identity pool. Amazon Cognito ID tokens have a `cognito:preferred_role` claim that presents the highest-precedence group that a user belongs to. Both ID and access tokens also contain a `cognito:groups` claim that list all the groups that a user is a member of. """ return pulumi.get(self, "role_arn") @@ -81,8 +81,8 @@ def get_user_pool_group(group_name: Optional[str] = None, Resource Type definition for AWS::Cognito::UserPoolGroup - :param str group_name: The name of the group. Must be unique. - :param str user_pool_id: The user pool ID for the user pool. + :param str group_name: A name for the group. This name must be unique in your user pool. + :param str user_pool_id: The ID of the user pool where you want to create a user group. """ __args__ = dict() __args__['groupName'] = group_name @@ -101,8 +101,8 @@ def get_user_pool_group_output(group_name: Optional[pulumi.Input[str]] = None, Resource Type definition for AWS::Cognito::UserPoolGroup - :param str group_name: The name of the group. Must be unique. - :param str user_pool_id: The user pool ID for the user pool. + :param str group_name: A name for the group. This name must be unique in your user pool. + :param str user_pool_id: The ID of the user pool where you want to create a user group. """ __args__ = dict() __args__['groupName'] = group_name diff --git a/sdk/python/pulumi_aws_native/cognito/get_user_pool_identity_provider.py b/sdk/python/pulumi_aws_native/cognito/get_user_pool_identity_provider.py index bcb0b3e066..7aad9476be 100644 --- a/sdk/python/pulumi_aws_native/cognito/get_user_pool_identity_provider.py +++ b/sdk/python/pulumi_aws_native/cognito/get_user_pool_identity_provider.py @@ -38,7 +38,7 @@ def __init__(__self__, attribute_mapping=None, idp_identifiers=None, provider_de @pulumi.getter(name="attributeMapping") def attribute_mapping(self) -> Optional[Mapping[str, str]]: """ - A mapping of IdP attributes to standard and custom user pool attributes. + A mapping of IdP attributes to standard and custom user pool attributes. Specify a user pool attribute as the key of the key-value pair, and the IdP attribute claim name as the value. """ return pulumi.get(self, "attribute_mapping") @@ -46,7 +46,7 @@ def attribute_mapping(self) -> Optional[Mapping[str, str]]: @pulumi.getter(name="idpIdentifiers") def idp_identifiers(self) -> Optional[Sequence[str]]: """ - A list of IdP identifiers. + An array of IdP identifiers, for example `"IdPIdentifiers": [ "MyIdP", "MyIdP2" ]` . Identifiers are friendly names that you can pass in the `idp_identifier` query parameter of requests to the [Authorize endpoint](https://docs.aws.amazon.com/cognito/latest/developerguide/authorization-endpoint.html) to silently redirect to sign-in with the associated IdP. Identifiers in a domain format also enable the use of [email-address matching with SAML providers](https://docs.aws.amazon.com/cognito/latest/developerguide/cognito-user-pools-managing-saml-idp-naming.html) . """ return pulumi.get(self, "idp_identifiers") @@ -105,8 +105,8 @@ def get_user_pool_identity_provider(provider_name: Optional[str] = None, Resource Type definition for AWS::Cognito::UserPoolIdentityProvider - :param str provider_name: The IdP name. - :param str user_pool_id: The user pool ID. + :param str provider_name: The name that you want to assign to the IdP. You can pass the identity provider name in the `identity_provider` query parameter of requests to the [Authorize endpoint](https://docs.aws.amazon.com/cognito/latest/developerguide/authorization-endpoint.html) to silently redirect to sign-in with the associated IdP. + :param str user_pool_id: The Id of the user pool where you want to create an IdP. """ __args__ = dict() __args__['providerName'] = provider_name @@ -125,8 +125,8 @@ def get_user_pool_identity_provider_output(provider_name: Optional[pulumi.Input[ Resource Type definition for AWS::Cognito::UserPoolIdentityProvider - :param str provider_name: The IdP name. - :param str user_pool_id: The user pool ID. + :param str provider_name: The name that you want to assign to the IdP. You can pass the identity provider name in the `identity_provider` query parameter of requests to the [Authorize endpoint](https://docs.aws.amazon.com/cognito/latest/developerguide/authorization-endpoint.html) to silently redirect to sign-in with the associated IdP. + :param str user_pool_id: The Id of the user pool where you want to create an IdP. """ __args__ = dict() __args__['providerName'] = provider_name diff --git a/sdk/python/pulumi_aws_native/cognito/get_user_pool_resource_server.py b/sdk/python/pulumi_aws_native/cognito/get_user_pool_resource_server.py index e045a5a4c5..93deed4a30 100644 --- a/sdk/python/pulumi_aws_native/cognito/get_user_pool_resource_server.py +++ b/sdk/python/pulumi_aws_native/cognito/get_user_pool_resource_server.py @@ -69,7 +69,7 @@ def get_user_pool_resource_server(identifier: Optional[str] = None, :param str identifier: A unique resource server identifier for the resource server. The identifier can be an API friendly name like `solar-system-data` . You can also set an API URL like `https://solar-system-data-api.example.com` as your identifier. Amazon Cognito represents scopes in the access token in the format `$resource-server-identifier/$scope` . Longer scope-identifier strings increase the size of your access tokens. - :param str user_pool_id: The user pool ID for the user pool. + :param str user_pool_id: The ID of the user pool where you want to create a resource server. """ __args__ = dict() __args__['identifier'] = identifier @@ -90,7 +90,7 @@ def get_user_pool_resource_server_output(identifier: Optional[pulumi.Input[str]] :param str identifier: A unique resource server identifier for the resource server. The identifier can be an API friendly name like `solar-system-data` . You can also set an API URL like `https://solar-system-data-api.example.com` as your identifier. Amazon Cognito represents scopes in the access token in the format `$resource-server-identifier/$scope` . Longer scope-identifier strings increase the size of your access tokens. - :param str user_pool_id: The user pool ID for the user pool. + :param str user_pool_id: The ID of the user pool where you want to create a resource server. """ __args__ = dict() __args__['identifier'] = identifier diff --git a/sdk/python/pulumi_aws_native/cognito/get_user_pool_ui_customization_attachment.py b/sdk/python/pulumi_aws_native/cognito/get_user_pool_ui_customization_attachment.py index 28831df49b..c0782b1ffb 100644 --- a/sdk/python/pulumi_aws_native/cognito/get_user_pool_ui_customization_attachment.py +++ b/sdk/python/pulumi_aws_native/cognito/get_user_pool_ui_customization_attachment.py @@ -54,7 +54,7 @@ def get_user_pool_ui_customization_attachment(client_id: Optional[str] = None, :param str client_id: The app client ID for your UI customization. When this value isn't present, the customization applies to all user pool app clients that don't have client-level settings.. - :param str user_pool_id: The user pool ID for the user pool. + :param str user_pool_id: The ID of the user pool. """ __args__ = dict() __args__['clientId'] = client_id @@ -72,7 +72,7 @@ def get_user_pool_ui_customization_attachment_output(client_id: Optional[pulumi. :param str client_id: The app client ID for your UI customization. When this value isn't present, the customization applies to all user pool app clients that don't have client-level settings.. - :param str user_pool_id: The user pool ID for the user pool. + :param str user_pool_id: The ID of the user pool. """ __args__ = dict() __args__['clientId'] = client_id diff --git a/sdk/python/pulumi_aws_native/cognito/managed_login_branding.py b/sdk/python/pulumi_aws_native/cognito/managed_login_branding.py index fd1fc76dfd..1934d11872 100644 --- a/sdk/python/pulumi_aws_native/cognito/managed_login_branding.py +++ b/sdk/python/pulumi_aws_native/cognito/managed_login_branding.py @@ -32,10 +32,14 @@ def __init__(__self__, *, The set of arguments for constructing a ManagedLoginBranding resource. :param pulumi.Input[str] user_pool_id: The user pool where the branding style is assigned. :param pulumi.Input[Sequence[pulumi.Input['ManagedLoginBrandingAssetTypeArgs']]] assets: An array of image files that you want to apply to roles like backgrounds, logos, and icons. Each object must also indicate whether it is for dark mode, light mode, or browser-adaptive mode. + :param pulumi.Input[str] client_id: The app client that's assigned to the branding style that you want more information about. + :param pulumi.Input[bool] return_merged_resources: When `true` , returns values for branding options that are unchanged from Amazon Cognito defaults. When `false` or when you omit this parameter, returns only values that you customized in your branding style. :param Any settings: A JSON file, encoded as a `Document` type, with the the settings that you want to apply to your style. Search the [CloudFormation User Guide](https://docs.aws.amazon.com/cloudformation/) for `AWS::Cognito::ManagedLoginBranding` for more information about the expected schema for this property. - :param pulumi.Input[bool] use_cognito_provided_values: When true, applies the default branding style options. This option reverts to a "blank" style that you can modify later in the branding designer. + :param pulumi.Input[bool] use_cognito_provided_values: When true, applies the default branding style options. This option reverts to default style options that are managed by Amazon Cognito. You can modify them later in the branding designer. + + When you specify `true` for this option, you must also omit values for `Settings` and `Assets` in the request. """ pulumi.set(__self__, "user_pool_id", user_pool_id) if assets is not None: @@ -76,6 +80,9 @@ def assets(self, value: Optional[pulumi.Input[Sequence[pulumi.Input['ManagedLogi @property @pulumi.getter(name="clientId") def client_id(self) -> Optional[pulumi.Input[str]]: + """ + The app client that's assigned to the branding style that you want more information about. + """ return pulumi.get(self, "client_id") @client_id.setter @@ -85,6 +92,9 @@ def client_id(self, value: Optional[pulumi.Input[str]]): @property @pulumi.getter(name="returnMergedResources") def return_merged_resources(self) -> Optional[pulumi.Input[bool]]: + """ + When `true` , returns values for branding options that are unchanged from Amazon Cognito defaults. When `false` or when you omit this parameter, returns only values that you customized in your branding style. + """ return pulumi.get(self, "return_merged_resources") @return_merged_resources.setter @@ -109,7 +119,9 @@ def settings(self, value: Optional[Any]): @pulumi.getter(name="useCognitoProvidedValues") def use_cognito_provided_values(self) -> Optional[pulumi.Input[bool]]: """ - When true, applies the default branding style options. This option reverts to a "blank" style that you can modify later in the branding designer. + When true, applies the default branding style options. This option reverts to default style options that are managed by Amazon Cognito. You can modify them later in the branding designer. + + When you specify `true` for this option, you must also omit values for `Settings` and `Assets` in the request. """ return pulumi.get(self, "use_cognito_provided_values") @@ -136,10 +148,14 @@ def __init__(__self__, :param str resource_name: The name of the resource. :param pulumi.ResourceOptions opts: Options for the resource. :param pulumi.Input[Sequence[pulumi.Input[Union['ManagedLoginBrandingAssetTypeArgs', 'ManagedLoginBrandingAssetTypeArgsDict']]]] assets: An array of image files that you want to apply to roles like backgrounds, logos, and icons. Each object must also indicate whether it is for dark mode, light mode, or browser-adaptive mode. + :param pulumi.Input[str] client_id: The app client that's assigned to the branding style that you want more information about. + :param pulumi.Input[bool] return_merged_resources: When `true` , returns values for branding options that are unchanged from Amazon Cognito defaults. When `false` or when you omit this parameter, returns only values that you customized in your branding style. :param Any settings: A JSON file, encoded as a `Document` type, with the the settings that you want to apply to your style. Search the [CloudFormation User Guide](https://docs.aws.amazon.com/cloudformation/) for `AWS::Cognito::ManagedLoginBranding` for more information about the expected schema for this property. - :param pulumi.Input[bool] use_cognito_provided_values: When true, applies the default branding style options. This option reverts to a "blank" style that you can modify later in the branding designer. + :param pulumi.Input[bool] use_cognito_provided_values: When true, applies the default branding style options. This option reverts to default style options that are managed by Amazon Cognito. You can modify them later in the branding designer. + + When you specify `true` for this option, you must also omit values for `Settings` and `Assets` in the request. :param pulumi.Input[str] user_pool_id: The user pool where the branding style is assigned. """ ... @@ -234,6 +250,9 @@ def assets(self) -> pulumi.Output[Optional[Sequence['outputs.ManagedLoginBrandin @property @pulumi.getter(name="clientId") def client_id(self) -> pulumi.Output[Optional[str]]: + """ + The app client that's assigned to the branding style that you want more information about. + """ return pulumi.get(self, "client_id") @property @@ -247,6 +266,9 @@ def managed_login_branding_id(self) -> pulumi.Output[str]: @property @pulumi.getter(name="returnMergedResources") def return_merged_resources(self) -> pulumi.Output[Optional[bool]]: + """ + When `true` , returns values for branding options that are unchanged from Amazon Cognito defaults. When `false` or when you omit this parameter, returns only values that you customized in your branding style. + """ return pulumi.get(self, "return_merged_resources") @property @@ -263,7 +285,9 @@ def settings(self) -> pulumi.Output[Optional[Any]]: @pulumi.getter(name="useCognitoProvidedValues") def use_cognito_provided_values(self) -> pulumi.Output[Optional[bool]]: """ - When true, applies the default branding style options. This option reverts to a "blank" style that you can modify later in the branding designer. + When true, applies the default branding style options. This option reverts to default style options that are managed by Amazon Cognito. You can modify them later in the branding designer. + + When you specify `true` for this option, you must also omit values for `Settings` and `Assets` in the request. """ return pulumi.get(self, "use_cognito_provided_values") diff --git a/sdk/python/pulumi_aws_native/cognito/outputs.py b/sdk/python/pulumi_aws_native/cognito/outputs.py index 5e5eaa8c31..fb39a6b6be 100644 --- a/sdk/python/pulumi_aws_native/cognito/outputs.py +++ b/sdk/python/pulumi_aws_native/cognito/outputs.py @@ -652,6 +652,7 @@ def __init__(__self__, *, advanced_security_additional_flows: Optional['outputs.UserPoolAdvancedSecurityAdditionalFlows'] = None, advanced_security_mode: Optional[str] = None): """ + :param 'UserPoolAdvancedSecurityAdditionalFlows' advanced_security_additional_flows: Advanced security configuration options for additional authentication types in your user pool, including custom authentication. :param str advanced_security_mode: The operating mode of advanced security features for standard authentication types in your user pool, including username-password and secure remote password (SRP) authentication. """ if advanced_security_additional_flows is not None: @@ -662,6 +663,9 @@ def __init__(__self__, *, @property @pulumi.getter(name="advancedSecurityAdditionalFlows") def advanced_security_additional_flows(self) -> Optional['outputs.UserPoolAdvancedSecurityAdditionalFlows']: + """ + Advanced security configuration options for additional authentication types in your user pool, including custom authentication. + """ return pulumi.get(self, "advanced_security_additional_flows") @property @@ -770,12 +774,18 @@ def get(self, key: str, default = None) -> Any: def __init__(__self__, *, custom_auth_mode: Optional[str] = None): + """ + :param str custom_auth_mode: The operating mode of advanced security features in custom authentication with [Custom authentication challenge Lambda triggers](https://docs.aws.amazon.com/cognito/latest/developerguide/user-pool-lambda-challenge.html) . + """ if custom_auth_mode is not None: pulumi.set(__self__, "custom_auth_mode", custom_auth_mode) @property @pulumi.getter(name="customAuthMode") def custom_auth_mode(self) -> Optional[str]: + """ + The operating mode of advanced security features in custom authentication with [Custom authentication challenge Lambda triggers](https://docs.aws.amazon.com/cognito/latest/developerguide/user-pool-lambda-challenge.html) . + """ return pulumi.get(self, "custom_auth_mode") @@ -1757,6 +1767,9 @@ def __init__(__self__, *, sign_in_policy: Optional['outputs.UserPoolSignInPolicy'] = None): """ :param 'UserPoolPasswordPolicy' password_policy: The password policy settings for a user pool, including complexity, history, and length requirements. + :param 'UserPoolSignInPolicy' sign_in_policy: The policy for allowed types of authentication in a user pool. + + This data type is a request and response parameter of [CreateUserPool](https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_CreateUserPool.html) and [UpdateUserPool](https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_UpdateUserPool.html) , and a response parameter of [DescribeUserPool](https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_DescribeUserPool.html) . """ if password_policy is not None: pulumi.set(__self__, "password_policy", password_policy) @@ -1774,6 +1787,11 @@ def password_policy(self) -> Optional['outputs.UserPoolPasswordPolicy']: @property @pulumi.getter(name="signInPolicy") def sign_in_policy(self) -> Optional['outputs.UserPoolSignInPolicy']: + """ + The policy for allowed types of authentication in a user pool. + + This data type is a request and response parameter of [CreateUserPool](https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_CreateUserPool.html) and [UpdateUserPool](https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_UpdateUserPool.html) , and a response parameter of [DescribeUserPool](https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_DescribeUserPool.html) . + """ return pulumi.get(self, "sign_in_policy") @@ -2518,12 +2536,22 @@ def get(self, key: str, default = None) -> Any: def __init__(__self__, *, allowed_first_auth_factors: Optional[Sequence[str]] = None): + """ + :param Sequence[str] allowed_first_auth_factors: The sign-in methods that a user pool supports as the first factor. You can permit users to start authentication with a standard username and password, or with other one-time password and hardware factors. + + Supports values of `EMAIL_OTP` , `SMS_OTP` , `WEB_AUTHN` and `PASSWORD` , + """ if allowed_first_auth_factors is not None: pulumi.set(__self__, "allowed_first_auth_factors", allowed_first_auth_factors) @property @pulumi.getter(name="allowedFirstAuthFactors") def allowed_first_auth_factors(self) -> Optional[Sequence[str]]: + """ + The sign-in methods that a user pool supports as the first factor. You can permit users to start authentication with a standard username and password, or with other one-time password and hardware factors. + + Supports values of `EMAIL_OTP` , `SMS_OTP` , `WEB_AUTHN` and `PASSWORD` , + """ return pulumi.get(self, "allowed_first_auth_factors") diff --git a/sdk/python/pulumi_aws_native/cognito/user_pool.py b/sdk/python/pulumi_aws_native/cognito/user_pool.py index 00103ecbe2..7b697e43dc 100644 --- a/sdk/python/pulumi_aws_native/cognito/user_pool.py +++ b/sdk/python/pulumi_aws_native/cognito/user_pool.py @@ -57,16 +57,16 @@ def __init__(__self__, *, :param pulumi.Input['UserPoolAdminCreateUserConfigArgs'] admin_create_user_config: The settings for administrator creation of users in a user pool. Contains settings for allowing user sign-up, customizing invitation messages to new users, and the amount of time before temporary passwords expire. This data type is a request and response parameter of [CreateUserPool](https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_CreateUserPool.html) and [UpdateUserPool](https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_UpdateUserPool.html) , and a response parameter of [DescribeUserPool](https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_DescribeUserPool.html) . - :param pulumi.Input[Sequence[pulumi.Input[str]]] alias_attributes: Attributes supported as an alias for this user pool. Possible values: *phone_number* , *email* , or *preferred_username* . - :param pulumi.Input[Sequence[pulumi.Input[str]]] auto_verified_attributes: The attributes to be auto-verified. Possible values: *email* , *phone_number* . + :param pulumi.Input[Sequence[pulumi.Input[str]]] alias_attributes: Attributes supported as an alias for this user pool. Possible values: *phone_number* , *email* , or *preferred_username* . For more information about alias attributes, see [Customizing sign-in attributes](https://docs.aws.amazon.com/cognito/latest/developerguide/user-pool-settings-attributes.html#user-pool-settings-aliases) . + :param pulumi.Input[Sequence[pulumi.Input[str]]] auto_verified_attributes: The attributes that you want your user pool to automatically verify. Possible values: *email* , *phone_number* . For more information see [Verifying contact information at sign-up](https://docs.aws.amazon.com/cognito/latest/developerguide/signing-up-users-in-your-app.html#allowing-users-to-sign-up-and-confirm-themselves) . :param pulumi.Input[str] deletion_protection: When active, `DeletionProtection` prevents accidental deletion of your user pool. Before you can delete a user pool that you have protected against deletion, you must deactivate this feature. When you try to delete a protected user pool in a `DeleteUserPool` API request, Amazon Cognito returns an `InvalidParameterException` error. To delete a protected user pool, send a new `DeleteUserPool` request after you deactivate deletion protection in an `UpdateUserPool` API request. - :param pulumi.Input['UserPoolDeviceConfigurationArgs'] device_configuration: The device-remembering configuration for a user pool. A null value indicates that you have deactivated device remembering in your user pool. + :param pulumi.Input['UserPoolDeviceConfigurationArgs'] device_configuration: The device-remembering configuration for a user pool. Device remembering or device tracking is a "Remember me on this device" option for user pools that perform authentication with the device key of a trusted device in the back end, instead of a user-provided MFA code. For more information about device authentication, see [Working with user devices in your user pool](https://docs.aws.amazon.com/cognito/latest/developerguide/amazon-cognito-user-pools-device-tracking.html) . A null value indicates that you have deactivated device remembering in your user pool. - > When you provide a value for any `DeviceConfiguration` field, you activate the Amazon Cognito device-remembering feature. + > When you provide a value for any `DeviceConfiguration` field, you activate the Amazon Cognito device-remembering feature. For more infor :param pulumi.Input['UserPoolEmailConfigurationArgs'] email_configuration: The email configuration of your user pool. The email configuration type sets your preferred sending method, AWS Region, and sender for messages from your user pool. :param pulumi.Input[str] email_verification_message: This parameter is no longer used. See [VerificationMessageTemplateType](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cognito-userpool-verificationmessagetemplate.html) . :param pulumi.Input[str] email_verification_subject: This parameter is no longer used. See [VerificationMessageTemplateType](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cognito-userpool-verificationmessagetemplate.html) . @@ -86,9 +86,9 @@ def __init__(__self__, *, :param pulumi.Input['UserPoolPoliciesArgs'] policies: A list of user pool policies. Contains the policy that sets password-complexity requirements. This data type is a request and response parameter of [CreateUserPool](https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_CreateUserPool.html) and [UpdateUserPool](https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_UpdateUserPool.html) , and a response parameter of [DescribeUserPool](https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_DescribeUserPool.html) . - :param pulumi.Input[Sequence[pulumi.Input['UserPoolSchemaAttributeArgs']]] schema: An array of schema attributes for the new user pool. These attributes can be standard or custom attributes. + :param pulumi.Input[Sequence[pulumi.Input['UserPoolSchemaAttributeArgs']]] schema: An array of attributes for the new user pool. You can add custom attributes and modify the properties of default attributes. The specifications in this parameter set the required attributes in your user pool. For more information, see [Working with user attributes](https://docs.aws.amazon.com/cognito/latest/developerguide/user-pool-settings-attributes.html) . :param pulumi.Input[str] sms_authentication_message: The contents of the SMS authentication message. - :param pulumi.Input['UserPoolSmsConfigurationArgs'] sms_configuration: The SMS configuration with the settings that your Amazon Cognito user pool must use to send an SMS message from your AWS account through Amazon Simple Notification Service. To send SMS messages with Amazon SNS in the AWS Region that you want, the Amazon Cognito user pool uses an AWS Identity and Access Management (IAM) role in your AWS account . + :param pulumi.Input['UserPoolSmsConfigurationArgs'] sms_configuration: The SMS configuration with the settings that your Amazon Cognito user pool must use to send an SMS message from your AWS account through Amazon Simple Notification Service. To send SMS messages with Amazon SNS in the AWS Region that you want, the Amazon Cognito user pool uses an AWS Identity and Access Management (IAM) role in your AWS account . For more information see [SMS message settings](https://docs.aws.amazon.com/cognito/latest/developerguide/user-pool-sms-settings.html) . :param pulumi.Input[str] sms_verification_message: This parameter is no longer used. See [VerificationMessageTemplateType](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cognito-userpool-verificationmessagetemplate.html) . :param pulumi.Input['UserPoolUserAttributeUpdateSettingsArgs'] user_attribute_update_settings: The settings for updates to user attributes. These settings include the property `AttributesRequireVerificationBeforeUpdate` , a user-pool setting that tells Amazon Cognito how to handle changes to the value of your users' email address and phone number attributes. For @@ -96,16 +96,26 @@ def __init__(__self__, *, :param pulumi.Input['UserPoolAddOnsArgs'] user_pool_add_ons: User pool add-ons. Contains settings for activation of advanced security features. To log user security information but take no action, set to `AUDIT` . To configure automatic security responses to risky traffic to your user pool, set to `ENFORCED` . For more information, see [Adding advanced security to a user pool](https://docs.aws.amazon.com/cognito/latest/developerguide/cognito-user-pool-settings-advanced-security.html) . - :param pulumi.Input[str] user_pool_name: A string used to name the user pool. + :param pulumi.Input[str] user_pool_name: A friendlhy name for your user pool. :param pulumi.Input[Mapping[str, pulumi.Input[str]]] user_pool_tags: The tag keys and values to assign to the user pool. A tag is a label that you can use to categorize and manage user pools in different ways, such as by purpose, owner, environment, or other criteria. :param pulumi.Input['UserPoolTier'] user_pool_tier: The user pool [feature plan](https://docs.aws.amazon.com/cognito/latest/developerguide/cognito-sign-in-feature-plans.html) , or tier. This parameter determines the eligibility of the user pool for features like managed login, access-token customization, and threat protection. Defaults to `ESSENTIALS` . :param pulumi.Input[Sequence[pulumi.Input[str]]] username_attributes: Specifies whether a user can use an email address or phone number as a username when they sign up. - :param pulumi.Input['UserPoolUsernameConfigurationArgs'] username_configuration: Case sensitivity on the username input for the selected sign-in option. When case sensitivity is set to `False` (case insensitive), users can sign in with any combination of capital and lowercase letters. For example, `username` , `USERNAME` , or `UserName` , or for email, `email@example.com` or `EMaiL@eXamplE.Com` . For most use cases, set case sensitivity to `False` (case insensitive) as a best practice. When usernames and email addresses are case insensitive, Amazon Cognito treats any variation in case as the same user, and prevents a case variation from being assigned to the same attribute for a different user. + :param pulumi.Input['UserPoolUsernameConfigurationArgs'] username_configuration: Sets the case sensitivity option for sign-in usernames. When `CaseSensitive` is `false` (case insensitive), users can sign in with any combination of capital and lowercase letters. For example, `username` , `USERNAME` , or `UserName` , or for email, `email@example.com` or `EMaiL@eXamplE.Com` . For most use cases, set case sensitivity to `false` as a best practice. When usernames and email addresses are case insensitive, Amazon Cognito treats any variation in case as the same user, and prevents a case variation from being assigned to the same attribute for a different user. - This configuration is immutable after you set it. For more information, see [UsernameConfigurationType](https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_UsernameConfigurationType.html) . + When `CaseSensitive` is `true` (case sensitive), Amazon Cognito interprets `USERNAME` and `UserName` as distinct users. + + This configuration is immutable after you set it. :param pulumi.Input['UserPoolVerificationMessageTemplateArgs'] verification_message_template: The template for the verification message that your user pool delivers to users who set an email address or phone number attribute. Set the email message type that corresponds to your `DefaultEmailOption` selection. For `CONFIRM_WITH_LINK` , specify an `EmailMessageByLink` and leave `EmailMessage` blank. For `CONFIRM_WITH_CODE` , specify an `EmailMessage` and leave `EmailMessageByLink` blank. When you supply both parameters with either choice, Amazon Cognito returns an error. + :param pulumi.Input[str] web_authn_relying_party_id: Sets or displays the authentication domain, typically your user pool domain, that passkey providers must use as a relying party (RP) in their configuration. + + Under the following conditions, the passkey relying party ID must be the fully-qualified domain name of your custom domain: + + - The user pool is configured for passkey authentication. + - The user pool has a custom domain, whether or not it also has a prefix domain. + - Your application performs authentication with managed login or the classic hosted UI. + :param pulumi.Input[str] web_authn_user_verification: When `required` , users can only register and sign in users with passkeys that are capable of [user verification](https://docs.aws.amazon.com/https://www.w3.org/TR/webauthn-2/#enum-userVerificationRequirement) . When `preferred` , your user pool doesn't require the use of authenticators with user verification but encourages it. """ if account_recovery_setting is not None: pulumi.set(__self__, "account_recovery_setting", account_recovery_setting) @@ -196,7 +206,7 @@ def admin_create_user_config(self, value: Optional[pulumi.Input['UserPoolAdminCr @pulumi.getter(name="aliasAttributes") def alias_attributes(self) -> Optional[pulumi.Input[Sequence[pulumi.Input[str]]]]: """ - Attributes supported as an alias for this user pool. Possible values: *phone_number* , *email* , or *preferred_username* . + Attributes supported as an alias for this user pool. Possible values: *phone_number* , *email* , or *preferred_username* . For more information about alias attributes, see [Customizing sign-in attributes](https://docs.aws.amazon.com/cognito/latest/developerguide/user-pool-settings-attributes.html#user-pool-settings-aliases) . """ return pulumi.get(self, "alias_attributes") @@ -208,7 +218,7 @@ def alias_attributes(self, value: Optional[pulumi.Input[Sequence[pulumi.Input[st @pulumi.getter(name="autoVerifiedAttributes") def auto_verified_attributes(self) -> Optional[pulumi.Input[Sequence[pulumi.Input[str]]]]: """ - The attributes to be auto-verified. Possible values: *email* , *phone_number* . + The attributes that you want your user pool to automatically verify. Possible values: *email* , *phone_number* . For more information see [Verifying contact information at sign-up](https://docs.aws.amazon.com/cognito/latest/developerguide/signing-up-users-in-your-app.html#allowing-users-to-sign-up-and-confirm-themselves) . """ return pulumi.get(self, "auto_verified_attributes") @@ -236,9 +246,9 @@ def deletion_protection(self, value: Optional[pulumi.Input[str]]): @pulumi.getter(name="deviceConfiguration") def device_configuration(self) -> Optional[pulumi.Input['UserPoolDeviceConfigurationArgs']]: """ - The device-remembering configuration for a user pool. A null value indicates that you have deactivated device remembering in your user pool. + The device-remembering configuration for a user pool. Device remembering or device tracking is a "Remember me on this device" option for user pools that perform authentication with the device key of a trusted device in the back end, instead of a user-provided MFA code. For more information about device authentication, see [Working with user devices in your user pool](https://docs.aws.amazon.com/cognito/latest/developerguide/amazon-cognito-user-pools-device-tracking.html) . A null value indicates that you have deactivated device remembering in your user pool. - > When you provide a value for any `DeviceConfiguration` field, you activate the Amazon Cognito device-remembering feature. + > When you provide a value for any `DeviceConfiguration` field, you activate the Amazon Cognito device-remembering feature. For more infor """ return pulumi.get(self, "device_configuration") @@ -364,7 +374,7 @@ def policies(self, value: Optional[pulumi.Input['UserPoolPoliciesArgs']]): @pulumi.getter def schema(self) -> Optional[pulumi.Input[Sequence[pulumi.Input['UserPoolSchemaAttributeArgs']]]]: """ - An array of schema attributes for the new user pool. These attributes can be standard or custom attributes. + An array of attributes for the new user pool. You can add custom attributes and modify the properties of default attributes. The specifications in this parameter set the required attributes in your user pool. For more information, see [Working with user attributes](https://docs.aws.amazon.com/cognito/latest/developerguide/user-pool-settings-attributes.html) . """ return pulumi.get(self, "schema") @@ -388,7 +398,7 @@ def sms_authentication_message(self, value: Optional[pulumi.Input[str]]): @pulumi.getter(name="smsConfiguration") def sms_configuration(self) -> Optional[pulumi.Input['UserPoolSmsConfigurationArgs']]: """ - The SMS configuration with the settings that your Amazon Cognito user pool must use to send an SMS message from your AWS account through Amazon Simple Notification Service. To send SMS messages with Amazon SNS in the AWS Region that you want, the Amazon Cognito user pool uses an AWS Identity and Access Management (IAM) role in your AWS account . + The SMS configuration with the settings that your Amazon Cognito user pool must use to send an SMS message from your AWS account through Amazon Simple Notification Service. To send SMS messages with Amazon SNS in the AWS Region that you want, the Amazon Cognito user pool uses an AWS Identity and Access Management (IAM) role in your AWS account . For more information see [SMS message settings](https://docs.aws.amazon.com/cognito/latest/developerguide/user-pool-sms-settings.html) . """ return pulumi.get(self, "sms_configuration") @@ -440,7 +450,7 @@ def user_pool_add_ons(self, value: Optional[pulumi.Input['UserPoolAddOnsArgs']]) @pulumi.getter(name="userPoolName") def user_pool_name(self) -> Optional[pulumi.Input[str]]: """ - A string used to name the user pool. + A friendlhy name for your user pool. """ return pulumi.get(self, "user_pool_name") @@ -488,9 +498,11 @@ def username_attributes(self, value: Optional[pulumi.Input[Sequence[pulumi.Input @pulumi.getter(name="usernameConfiguration") def username_configuration(self) -> Optional[pulumi.Input['UserPoolUsernameConfigurationArgs']]: """ - Case sensitivity on the username input for the selected sign-in option. When case sensitivity is set to `False` (case insensitive), users can sign in with any combination of capital and lowercase letters. For example, `username` , `USERNAME` , or `UserName` , or for email, `email@example.com` or `EMaiL@eXamplE.Com` . For most use cases, set case sensitivity to `False` (case insensitive) as a best practice. When usernames and email addresses are case insensitive, Amazon Cognito treats any variation in case as the same user, and prevents a case variation from being assigned to the same attribute for a different user. + Sets the case sensitivity option for sign-in usernames. When `CaseSensitive` is `false` (case insensitive), users can sign in with any combination of capital and lowercase letters. For example, `username` , `USERNAME` , or `UserName` , or for email, `email@example.com` or `EMaiL@eXamplE.Com` . For most use cases, set case sensitivity to `false` as a best practice. When usernames and email addresses are case insensitive, Amazon Cognito treats any variation in case as the same user, and prevents a case variation from being assigned to the same attribute for a different user. - This configuration is immutable after you set it. For more information, see [UsernameConfigurationType](https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_UsernameConfigurationType.html) . + When `CaseSensitive` is `true` (case sensitive), Amazon Cognito interprets `USERNAME` and `UserName` as distinct users. + + This configuration is immutable after you set it. """ return pulumi.get(self, "username_configuration") @@ -515,6 +527,15 @@ def verification_message_template(self, value: Optional[pulumi.Input['UserPoolVe @property @pulumi.getter(name="webAuthnRelyingPartyId") def web_authn_relying_party_id(self) -> Optional[pulumi.Input[str]]: + """ + Sets or displays the authentication domain, typically your user pool domain, that passkey providers must use as a relying party (RP) in their configuration. + + Under the following conditions, the passkey relying party ID must be the fully-qualified domain name of your custom domain: + + - The user pool is configured for passkey authentication. + - The user pool has a custom domain, whether or not it also has a prefix domain. + - Your application performs authentication with managed login or the classic hosted UI. + """ return pulumi.get(self, "web_authn_relying_party_id") @web_authn_relying_party_id.setter @@ -524,6 +545,9 @@ def web_authn_relying_party_id(self, value: Optional[pulumi.Input[str]]): @property @pulumi.getter(name="webAuthnUserVerification") def web_authn_user_verification(self) -> Optional[pulumi.Input[str]]: + """ + When `required` , users can only register and sign in users with passkeys that are capable of [user verification](https://docs.aws.amazon.com/https://www.w3.org/TR/webauthn-2/#enum-userVerificationRequirement) . When `preferred` , your user pool doesn't require the use of authenticators with user verification but encourages it. + """ return pulumi.get(self, "web_authn_user_verification") @web_authn_user_verification.setter @@ -575,16 +599,16 @@ def __init__(__self__, :param pulumi.Input[Union['UserPoolAdminCreateUserConfigArgs', 'UserPoolAdminCreateUserConfigArgsDict']] admin_create_user_config: The settings for administrator creation of users in a user pool. Contains settings for allowing user sign-up, customizing invitation messages to new users, and the amount of time before temporary passwords expire. This data type is a request and response parameter of [CreateUserPool](https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_CreateUserPool.html) and [UpdateUserPool](https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_UpdateUserPool.html) , and a response parameter of [DescribeUserPool](https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_DescribeUserPool.html) . - :param pulumi.Input[Sequence[pulumi.Input[str]]] alias_attributes: Attributes supported as an alias for this user pool. Possible values: *phone_number* , *email* , or *preferred_username* . - :param pulumi.Input[Sequence[pulumi.Input[str]]] auto_verified_attributes: The attributes to be auto-verified. Possible values: *email* , *phone_number* . + :param pulumi.Input[Sequence[pulumi.Input[str]]] alias_attributes: Attributes supported as an alias for this user pool. Possible values: *phone_number* , *email* , or *preferred_username* . For more information about alias attributes, see [Customizing sign-in attributes](https://docs.aws.amazon.com/cognito/latest/developerguide/user-pool-settings-attributes.html#user-pool-settings-aliases) . + :param pulumi.Input[Sequence[pulumi.Input[str]]] auto_verified_attributes: The attributes that you want your user pool to automatically verify. Possible values: *email* , *phone_number* . For more information see [Verifying contact information at sign-up](https://docs.aws.amazon.com/cognito/latest/developerguide/signing-up-users-in-your-app.html#allowing-users-to-sign-up-and-confirm-themselves) . :param pulumi.Input[str] deletion_protection: When active, `DeletionProtection` prevents accidental deletion of your user pool. Before you can delete a user pool that you have protected against deletion, you must deactivate this feature. When you try to delete a protected user pool in a `DeleteUserPool` API request, Amazon Cognito returns an `InvalidParameterException` error. To delete a protected user pool, send a new `DeleteUserPool` request after you deactivate deletion protection in an `UpdateUserPool` API request. - :param pulumi.Input[Union['UserPoolDeviceConfigurationArgs', 'UserPoolDeviceConfigurationArgsDict']] device_configuration: The device-remembering configuration for a user pool. A null value indicates that you have deactivated device remembering in your user pool. + :param pulumi.Input[Union['UserPoolDeviceConfigurationArgs', 'UserPoolDeviceConfigurationArgsDict']] device_configuration: The device-remembering configuration for a user pool. Device remembering or device tracking is a "Remember me on this device" option for user pools that perform authentication with the device key of a trusted device in the back end, instead of a user-provided MFA code. For more information about device authentication, see [Working with user devices in your user pool](https://docs.aws.amazon.com/cognito/latest/developerguide/amazon-cognito-user-pools-device-tracking.html) . A null value indicates that you have deactivated device remembering in your user pool. - > When you provide a value for any `DeviceConfiguration` field, you activate the Amazon Cognito device-remembering feature. + > When you provide a value for any `DeviceConfiguration` field, you activate the Amazon Cognito device-remembering feature. For more infor :param pulumi.Input[Union['UserPoolEmailConfigurationArgs', 'UserPoolEmailConfigurationArgsDict']] email_configuration: The email configuration of your user pool. The email configuration type sets your preferred sending method, AWS Region, and sender for messages from your user pool. :param pulumi.Input[str] email_verification_message: This parameter is no longer used. See [VerificationMessageTemplateType](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cognito-userpool-verificationmessagetemplate.html) . :param pulumi.Input[str] email_verification_subject: This parameter is no longer used. See [VerificationMessageTemplateType](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cognito-userpool-verificationmessagetemplate.html) . @@ -604,9 +628,9 @@ def __init__(__self__, :param pulumi.Input[Union['UserPoolPoliciesArgs', 'UserPoolPoliciesArgsDict']] policies: A list of user pool policies. Contains the policy that sets password-complexity requirements. This data type is a request and response parameter of [CreateUserPool](https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_CreateUserPool.html) and [UpdateUserPool](https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_UpdateUserPool.html) , and a response parameter of [DescribeUserPool](https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_DescribeUserPool.html) . - :param pulumi.Input[Sequence[pulumi.Input[Union['UserPoolSchemaAttributeArgs', 'UserPoolSchemaAttributeArgsDict']]]] schema: An array of schema attributes for the new user pool. These attributes can be standard or custom attributes. + :param pulumi.Input[Sequence[pulumi.Input[Union['UserPoolSchemaAttributeArgs', 'UserPoolSchemaAttributeArgsDict']]]] schema: An array of attributes for the new user pool. You can add custom attributes and modify the properties of default attributes. The specifications in this parameter set the required attributes in your user pool. For more information, see [Working with user attributes](https://docs.aws.amazon.com/cognito/latest/developerguide/user-pool-settings-attributes.html) . :param pulumi.Input[str] sms_authentication_message: The contents of the SMS authentication message. - :param pulumi.Input[Union['UserPoolSmsConfigurationArgs', 'UserPoolSmsConfigurationArgsDict']] sms_configuration: The SMS configuration with the settings that your Amazon Cognito user pool must use to send an SMS message from your AWS account through Amazon Simple Notification Service. To send SMS messages with Amazon SNS in the AWS Region that you want, the Amazon Cognito user pool uses an AWS Identity and Access Management (IAM) role in your AWS account . + :param pulumi.Input[Union['UserPoolSmsConfigurationArgs', 'UserPoolSmsConfigurationArgsDict']] sms_configuration: The SMS configuration with the settings that your Amazon Cognito user pool must use to send an SMS message from your AWS account through Amazon Simple Notification Service. To send SMS messages with Amazon SNS in the AWS Region that you want, the Amazon Cognito user pool uses an AWS Identity and Access Management (IAM) role in your AWS account . For more information see [SMS message settings](https://docs.aws.amazon.com/cognito/latest/developerguide/user-pool-sms-settings.html) . :param pulumi.Input[str] sms_verification_message: This parameter is no longer used. See [VerificationMessageTemplateType](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cognito-userpool-verificationmessagetemplate.html) . :param pulumi.Input[Union['UserPoolUserAttributeUpdateSettingsArgs', 'UserPoolUserAttributeUpdateSettingsArgsDict']] user_attribute_update_settings: The settings for updates to user attributes. These settings include the property `AttributesRequireVerificationBeforeUpdate` , a user-pool setting that tells Amazon Cognito how to handle changes to the value of your users' email address and phone number attributes. For @@ -614,16 +638,26 @@ def __init__(__self__, :param pulumi.Input[Union['UserPoolAddOnsArgs', 'UserPoolAddOnsArgsDict']] user_pool_add_ons: User pool add-ons. Contains settings for activation of advanced security features. To log user security information but take no action, set to `AUDIT` . To configure automatic security responses to risky traffic to your user pool, set to `ENFORCED` . For more information, see [Adding advanced security to a user pool](https://docs.aws.amazon.com/cognito/latest/developerguide/cognito-user-pool-settings-advanced-security.html) . - :param pulumi.Input[str] user_pool_name: A string used to name the user pool. + :param pulumi.Input[str] user_pool_name: A friendlhy name for your user pool. :param pulumi.Input[Mapping[str, pulumi.Input[str]]] user_pool_tags: The tag keys and values to assign to the user pool. A tag is a label that you can use to categorize and manage user pools in different ways, such as by purpose, owner, environment, or other criteria. :param pulumi.Input['UserPoolTier'] user_pool_tier: The user pool [feature plan](https://docs.aws.amazon.com/cognito/latest/developerguide/cognito-sign-in-feature-plans.html) , or tier. This parameter determines the eligibility of the user pool for features like managed login, access-token customization, and threat protection. Defaults to `ESSENTIALS` . :param pulumi.Input[Sequence[pulumi.Input[str]]] username_attributes: Specifies whether a user can use an email address or phone number as a username when they sign up. - :param pulumi.Input[Union['UserPoolUsernameConfigurationArgs', 'UserPoolUsernameConfigurationArgsDict']] username_configuration: Case sensitivity on the username input for the selected sign-in option. When case sensitivity is set to `False` (case insensitive), users can sign in with any combination of capital and lowercase letters. For example, `username` , `USERNAME` , or `UserName` , or for email, `email@example.com` or `EMaiL@eXamplE.Com` . For most use cases, set case sensitivity to `False` (case insensitive) as a best practice. When usernames and email addresses are case insensitive, Amazon Cognito treats any variation in case as the same user, and prevents a case variation from being assigned to the same attribute for a different user. + :param pulumi.Input[Union['UserPoolUsernameConfigurationArgs', 'UserPoolUsernameConfigurationArgsDict']] username_configuration: Sets the case sensitivity option for sign-in usernames. When `CaseSensitive` is `false` (case insensitive), users can sign in with any combination of capital and lowercase letters. For example, `username` , `USERNAME` , or `UserName` , or for email, `email@example.com` or `EMaiL@eXamplE.Com` . For most use cases, set case sensitivity to `false` as a best practice. When usernames and email addresses are case insensitive, Amazon Cognito treats any variation in case as the same user, and prevents a case variation from being assigned to the same attribute for a different user. - This configuration is immutable after you set it. For more information, see [UsernameConfigurationType](https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_UsernameConfigurationType.html) . + When `CaseSensitive` is `true` (case sensitive), Amazon Cognito interprets `USERNAME` and `UserName` as distinct users. + + This configuration is immutable after you set it. :param pulumi.Input[Union['UserPoolVerificationMessageTemplateArgs', 'UserPoolVerificationMessageTemplateArgsDict']] verification_message_template: The template for the verification message that your user pool delivers to users who set an email address or phone number attribute. Set the email message type that corresponds to your `DefaultEmailOption` selection. For `CONFIRM_WITH_LINK` , specify an `EmailMessageByLink` and leave `EmailMessage` blank. For `CONFIRM_WITH_CODE` , specify an `EmailMessage` and leave `EmailMessageByLink` blank. When you supply both parameters with either choice, Amazon Cognito returns an error. + :param pulumi.Input[str] web_authn_relying_party_id: Sets or displays the authentication domain, typically your user pool domain, that passkey providers must use as a relying party (RP) in their configuration. + + Under the following conditions, the passkey relying party ID must be the fully-qualified domain name of your custom domain: + + - The user pool is configured for passkey authentication. + - The user pool has a custom domain, whether or not it also has a prefix domain. + - Your application performs authentication with managed login or the classic hosted UI. + :param pulumi.Input[str] web_authn_user_verification: When `required` , users can only register and sign in users with passkeys that are capable of [user verification](https://docs.aws.amazon.com/https://www.w3.org/TR/webauthn-2/#enum-userVerificationRequirement) . When `preferred` , your user pool doesn't require the use of authenticators with user verification but encourages it. """ ... @overload @@ -799,7 +833,7 @@ def admin_create_user_config(self) -> pulumi.Output[Optional['outputs.UserPoolAd @pulumi.getter(name="aliasAttributes") def alias_attributes(self) -> pulumi.Output[Optional[Sequence[str]]]: """ - Attributes supported as an alias for this user pool. Possible values: *phone_number* , *email* , or *preferred_username* . + Attributes supported as an alias for this user pool. Possible values: *phone_number* , *email* , or *preferred_username* . For more information about alias attributes, see [Customizing sign-in attributes](https://docs.aws.amazon.com/cognito/latest/developerguide/user-pool-settings-attributes.html#user-pool-settings-aliases) . """ return pulumi.get(self, "alias_attributes") @@ -815,7 +849,7 @@ def arn(self) -> pulumi.Output[str]: @pulumi.getter(name="autoVerifiedAttributes") def auto_verified_attributes(self) -> pulumi.Output[Optional[Sequence[str]]]: """ - The attributes to be auto-verified. Possible values: *email* , *phone_number* . + The attributes that you want your user pool to automatically verify. Possible values: *email* , *phone_number* . For more information see [Verifying contact information at sign-up](https://docs.aws.amazon.com/cognito/latest/developerguide/signing-up-users-in-your-app.html#allowing-users-to-sign-up-and-confirm-themselves) . """ return pulumi.get(self, "auto_verified_attributes") @@ -835,9 +869,9 @@ def deletion_protection(self) -> pulumi.Output[Optional[str]]: @pulumi.getter(name="deviceConfiguration") def device_configuration(self) -> pulumi.Output[Optional['outputs.UserPoolDeviceConfiguration']]: """ - The device-remembering configuration for a user pool. A null value indicates that you have deactivated device remembering in your user pool. + The device-remembering configuration for a user pool. Device remembering or device tracking is a "Remember me on this device" option for user pools that perform authentication with the device key of a trusted device in the back end, instead of a user-provided MFA code. For more information about device authentication, see [Working with user devices in your user pool](https://docs.aws.amazon.com/cognito/latest/developerguide/amazon-cognito-user-pools-device-tracking.html) . A null value indicates that you have deactivated device remembering in your user pool. - > When you provide a value for any `DeviceConfiguration` field, you activate the Amazon Cognito device-remembering feature. + > When you provide a value for any `DeviceConfiguration` field, you activate the Amazon Cognito device-remembering feature. For more infor """ return pulumi.get(self, "device_configuration") @@ -939,7 +973,7 @@ def provider_url(self) -> pulumi.Output[str]: @pulumi.getter def schema(self) -> pulumi.Output[Optional[Sequence['outputs.UserPoolSchemaAttribute']]]: """ - An array of schema attributes for the new user pool. These attributes can be standard or custom attributes. + An array of attributes for the new user pool. You can add custom attributes and modify the properties of default attributes. The specifications in this parameter set the required attributes in your user pool. For more information, see [Working with user attributes](https://docs.aws.amazon.com/cognito/latest/developerguide/user-pool-settings-attributes.html) . """ return pulumi.get(self, "schema") @@ -955,7 +989,7 @@ def sms_authentication_message(self) -> pulumi.Output[Optional[str]]: @pulumi.getter(name="smsConfiguration") def sms_configuration(self) -> pulumi.Output[Optional['outputs.UserPoolSmsConfiguration']]: """ - The SMS configuration with the settings that your Amazon Cognito user pool must use to send an SMS message from your AWS account through Amazon Simple Notification Service. To send SMS messages with Amazon SNS in the AWS Region that you want, the Amazon Cognito user pool uses an AWS Identity and Access Management (IAM) role in your AWS account . + The SMS configuration with the settings that your Amazon Cognito user pool must use to send an SMS message from your AWS account through Amazon Simple Notification Service. To send SMS messages with Amazon SNS in the AWS Region that you want, the Amazon Cognito user pool uses an AWS Identity and Access Management (IAM) role in your AWS account . For more information see [SMS message settings](https://docs.aws.amazon.com/cognito/latest/developerguide/user-pool-sms-settings.html) . """ return pulumi.get(self, "sms_configuration") @@ -999,7 +1033,7 @@ def user_pool_id(self) -> pulumi.Output[str]: @pulumi.getter(name="userPoolName") def user_pool_name(self) -> pulumi.Output[Optional[str]]: """ - A string used to name the user pool. + A friendlhy name for your user pool. """ return pulumi.get(self, "user_pool_name") @@ -1031,9 +1065,11 @@ def username_attributes(self) -> pulumi.Output[Optional[Sequence[str]]]: @pulumi.getter(name="usernameConfiguration") def username_configuration(self) -> pulumi.Output[Optional['outputs.UserPoolUsernameConfiguration']]: """ - Case sensitivity on the username input for the selected sign-in option. When case sensitivity is set to `False` (case insensitive), users can sign in with any combination of capital and lowercase letters. For example, `username` , `USERNAME` , or `UserName` , or for email, `email@example.com` or `EMaiL@eXamplE.Com` . For most use cases, set case sensitivity to `False` (case insensitive) as a best practice. When usernames and email addresses are case insensitive, Amazon Cognito treats any variation in case as the same user, and prevents a case variation from being assigned to the same attribute for a different user. + Sets the case sensitivity option for sign-in usernames. When `CaseSensitive` is `false` (case insensitive), users can sign in with any combination of capital and lowercase letters. For example, `username` , `USERNAME` , or `UserName` , or for email, `email@example.com` or `EMaiL@eXamplE.Com` . For most use cases, set case sensitivity to `false` as a best practice. When usernames and email addresses are case insensitive, Amazon Cognito treats any variation in case as the same user, and prevents a case variation from being assigned to the same attribute for a different user. - This configuration is immutable after you set it. For more information, see [UsernameConfigurationType](https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_UsernameConfigurationType.html) . + When `CaseSensitive` is `true` (case sensitive), Amazon Cognito interprets `USERNAME` and `UserName` as distinct users. + + This configuration is immutable after you set it. """ return pulumi.get(self, "username_configuration") @@ -1050,10 +1086,22 @@ def verification_message_template(self) -> pulumi.Output[Optional['outputs.UserP @property @pulumi.getter(name="webAuthnRelyingPartyId") def web_authn_relying_party_id(self) -> pulumi.Output[Optional[str]]: + """ + Sets or displays the authentication domain, typically your user pool domain, that passkey providers must use as a relying party (RP) in their configuration. + + Under the following conditions, the passkey relying party ID must be the fully-qualified domain name of your custom domain: + + - The user pool is configured for passkey authentication. + - The user pool has a custom domain, whether or not it also has a prefix domain. + - Your application performs authentication with managed login or the classic hosted UI. + """ return pulumi.get(self, "web_authn_relying_party_id") @property @pulumi.getter(name="webAuthnUserVerification") def web_authn_user_verification(self) -> pulumi.Output[Optional[str]]: + """ + When `required` , users can only register and sign in users with passkeys that are capable of [user verification](https://docs.aws.amazon.com/https://www.w3.org/TR/webauthn-2/#enum-userVerificationRequirement) . When `preferred` , your user pool doesn't require the use of authenticators with user verification but encourages it. + """ return pulumi.get(self, "web_authn_user_verification") diff --git a/sdk/python/pulumi_aws_native/cognito/user_pool_client.py b/sdk/python/pulumi_aws_native/cognito/user_pool_client.py index 088d1b147b..ba7099a8ca 100644 --- a/sdk/python/pulumi_aws_native/cognito/user_pool_client.py +++ b/sdk/python/pulumi_aws_native/cognito/user_pool_client.py @@ -45,7 +45,7 @@ def __init__(__self__, *, write_attributes: Optional[pulumi.Input[Sequence[pulumi.Input[str]]]] = None): """ The set of arguments for constructing a UserPoolClient resource. - :param pulumi.Input[str] user_pool_id: The user pool ID for the user pool where you want to create a user pool client. + :param pulumi.Input[str] user_pool_id: The ID of the user pool where you want to create an app client. :param pulumi.Input[int] access_token_validity: The access token time limit. After this limit expires, your user can't use their access token. To specify the time unit for `AccessTokenValidity` as `seconds` , `minutes` , `hours` , or `days` , set a `TokenValidityUnits` value in your API request. For example, when you set `AccessTokenValidity` to `10` and `TokenValidityUnits` to `hours` , your user can authorize access with @@ -70,17 +70,17 @@ def __init__(__self__, *, - `AllowedOAuthFlows` : Support for authorization code, implicit, and client credentials OAuth 2.0 grants. To use OAuth 2.0 features, configure one of these features in the Amazon Cognito console or set `AllowedOAuthFlowsUserPoolClient` to `true` in a `CreateUserPoolClient` or `UpdateUserPoolClient` API request. If you don't set a value for `AllowedOAuthFlowsUserPoolClient` in a request with the AWS CLI or SDKs, it defaults to `false` . - :param pulumi.Input[Sequence[pulumi.Input[str]]] allowed_o_auth_scopes: The allowed OAuth scopes. Possible values provided by OAuth are `phone` , `email` , `openid` , and `profile` . Possible values provided by AWS are `aws.cognito.signin.user.admin` . Custom scopes created in Resource Servers are also supported. + :param pulumi.Input[Sequence[pulumi.Input[str]]] allowed_o_auth_scopes: The OAuth 2.0 scopes that you want to permit your app client to authorize. Scopes govern access control to user pool self-service API operations, user data from the `userInfo` endpoint, and third-party APIs. Possible values provided by OAuth are `phone` , `email` , `openid` , and `profile` . Possible values provided by AWS are `aws.cognito.signin.user.admin` . Custom scopes created in Resource Servers are also supported. :param pulumi.Input['UserPoolClientAnalyticsConfigurationArgs'] analytics_configuration: The user pool analytics configuration for collecting metrics and sending them to your Amazon Pinpoint campaign. - > In AWS Regions where Amazon Pinpoint isn't available, user pools only support sending events to Amazon Pinpoint projects in AWS Region us-east-1. In Regions where Amazon Pinpoint is available, user pools support sending events to Amazon Pinpoint projects within that same Region. + In AWS Regions where Amazon Pinpoint isn't available, user pools might not have access to analytics or might be configurable with campaigns in the US East (N. Virginia) Region. For more information, see [Using Amazon Pinpoint analytics](https://docs.aws.amazon.com/cognito/latest/developerguide/cognito-user-pools-pinpoint-integration.html) . :param pulumi.Input[int] auth_session_validity: Amazon Cognito creates a session token for each API request in an authentication flow. `AuthSessionValidity` is the duration, in minutes, of that session token. Your user pool native user must respond to each authentication challenge before the session expires. :param pulumi.Input[Sequence[pulumi.Input[str]]] callback_urls: A list of allowed redirect (callback) URLs for the IdPs. A redirect URI must: - Be an absolute URI. - - Be registered with the authorization server. + - Be registered with the authorization server. Amazon Cognito doesn't accept authorization requests with `redirect_uri` values that aren't in the list of `CallbackURLs` that you provide in this parameter. - Not include a fragment component. See [OAuth 2.0 - Redirection Endpoint](https://docs.aws.amazon.com/https://tools.ietf.org/html/rfc6749#section-3.1.2) . @@ -88,20 +88,8 @@ def __init__(__self__, *, Amazon Cognito requires HTTPS over HTTP except for http://localhost for testing purposes only. App callback URLs such as myapp://example are also supported. - :param pulumi.Input[str] client_name: The client name for the user pool client you would like to create. + :param pulumi.Input[str] client_name: A friendly name for the app client that you want to create. :param pulumi.Input[str] default_redirect_uri: The default redirect URI. In app clients with one assigned IdP, replaces `redirect_uri` in authentication requests. Must be in the `CallbackURLs` list. - - A redirect URI must: - - - Be an absolute URI. - - Be registered with the authorization server. - - Not include a fragment component. - - For more information, see [Default redirect URI](https://docs.aws.amazon.com/cognito/latest/developerguide/user-pool-settings-client-apps.html#cognito-user-pools-app-idp-settings-about) . - - Amazon Cognito requires HTTPS over HTTP except for http://localhost for testing purposes only. - - App callback URLs such as myapp://example are also supported. :param pulumi.Input[bool] enable_propagate_additional_user_context_data: Activates the propagation of additional user context data. For more information about propagation of user context data, see [Adding advanced security to a user pool](https://docs.aws.amazon.com/cognito/latest/developerguide/cognito-user-pool-settings-threat-protection.html) . If you don’t include this parameter, you can't send device fingerprint information, including source IP address, to Amazon Cognito advanced security. You can only activate `EnablePropagateAdditionalUserContextData` in an app client that has a client secret. :param pulumi.Input[bool] enable_token_revocation: Activates or deactivates token revocation. For more information about revoking tokens, see [RevokeToken](https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_RevokeToken.html) . @@ -121,7 +109,7 @@ def __init__(__self__, *, In some environments, you will see the values `ADMIN_NO_SRP_AUTH` , `CUSTOM_AUTH_FLOW_ONLY` , or `USER_PASSWORD_AUTH` . You can't assign these legacy `ExplicitAuthFlows` values to user pool clients at the same time as values that begin with `ALLOW_` , like `ALLOW_USER_SRP_AUTH` . - :param pulumi.Input[bool] generate_secret: Boolean to specify whether you want to generate a secret for the user pool client being created. + :param pulumi.Input[bool] generate_secret: When `true` , generates a client secret for the app client. Client secrets are used with server-side and machine-to-machine applications. For more information, see [App client types](https://docs.aws.amazon.com/cognito/latest/developerguide/user-pool-settings-client-apps.html#user-pool-settings-client-app-client-types) . :param pulumi.Input[int] id_token_validity: The ID token time limit. After this limit expires, your user can't use their ID token. To specify the time unit for `IdTokenValidity` as `seconds` , `minutes` , `hours` , or `days` , set a `TokenValidityUnits` value in your API request. For example, when you set `IdTokenValidity` as `10` and `TokenValidityUnits` as `hours` , your user can authenticate their session with their ID token for 10 hours. @@ -130,7 +118,7 @@ def __init__(__self__, *, If you don't specify otherwise in the configuration of your app client, your ID tokens are valid for one hour. - :param pulumi.Input[Sequence[pulumi.Input[str]]] logout_urls: A list of allowed logout URLs for the IdPs. + :param pulumi.Input[Sequence[pulumi.Input[str]]] logout_urls: A list of allowed logout URLs for managed login authentication. For more information, see [Logout endpoint](https://docs.aws.amazon.com/cognito/latest/developerguide/logout-endpoint.html) . :param pulumi.Input[str] prevent_user_existence_errors: Errors and responses that you want Amazon Cognito APIs to return during authentication, account confirmation, and password recovery when the user doesn't exist in the user pool. When set to `ENABLED` and the user doesn't exist, authentication returns an error indicating either the username or password was incorrect. Account confirmation and password recovery return a response indicating a code was sent to a simulated destination. When set to `LEGACY` , those APIs return a `UserNotFoundException` exception if the user doesn't exist in the user pool. Valid values include: @@ -153,8 +141,8 @@ def __init__(__self__, *, tokens are valid for 30 days. :param pulumi.Input[Sequence[pulumi.Input[str]]] supported_identity_providers: A list of provider names for the identity providers (IdPs) that are supported on this client. The following are supported: `COGNITO` , `Facebook` , `Google` , `SignInWithApple` , and `LoginWithAmazon` . You can also specify the names that you configured for the SAML and OIDC IdPs in your user pool, for example `MySAMLIdP` or `MyOIDCIdP` . - This setting applies to providers that you can access with the [hosted UI and OAuth 2.0 authorization server](https://docs.aws.amazon.com/cognito/latest/developerguide/cognito-user-pools-app-integration.html) . The removal of `COGNITO` from this list doesn't prevent authentication operations for local users with the user pools API in an AWS SDK. The only way to prevent API-based authentication is to block access with a [AWS WAF rule](https://docs.aws.amazon.com/cognito/latest/developerguide/user-pool-waf.html) . - :param pulumi.Input['UserPoolClientTokenValidityUnitsArgs'] token_validity_units: The units in which the validity times are represented. The default unit for RefreshToken is days, and default for ID and access tokens are hours. + This setting applies to providers that you can access with [managed login](https://docs.aws.amazon.com/cognito/latest/developerguide/cognito-user-pools-managed-login.html) . The removal of `COGNITO` from this list doesn't prevent authentication operations for local users with the user pools API in an AWS SDK. The only way to prevent API-based authentication is to block access with a [AWS WAF rule](https://docs.aws.amazon.com/cognito/latest/developerguide/user-pool-waf.html) . + :param pulumi.Input['UserPoolClientTokenValidityUnitsArgs'] token_validity_units: The units that validity times are represented in. The default unit for refresh tokens is days, and the default for ID and access tokens are hours. :param pulumi.Input[Sequence[pulumi.Input[str]]] write_attributes: The list of user attributes that you want your app client to have write access to. After your user authenticates in your app, their access token authorizes them to set or modify their own attribute value for any attribute in this list. An example of this kind of activity is when you present your user with a form to update their profile information and they change their last name. Your app then makes an [UpdateUserAttributes](https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_UpdateUserAttributes.html) API request and sets `family_name` to the new value. When you don't specify the `WriteAttributes` for your app client, your app can write the values of the Standard attributes of your user pool. When your user pool has write access to these default attributes, `WriteAttributes` doesn't return any information. Amazon Cognito only populates `WriteAttributes` in the API response if you have specified your own custom set of write attributes. @@ -209,7 +197,7 @@ def __init__(__self__, *, @pulumi.getter(name="userPoolId") def user_pool_id(self) -> pulumi.Input[str]: """ - The user pool ID for the user pool where you want to create a user pool client. + The ID of the user pool where you want to create an app client. """ return pulumi.get(self, "user_pool_id") @@ -278,7 +266,7 @@ def allowed_o_auth_flows_user_pool_client(self, value: Optional[pulumi.Input[boo @pulumi.getter(name="allowedOAuthScopes") def allowed_o_auth_scopes(self) -> Optional[pulumi.Input[Sequence[pulumi.Input[str]]]]: """ - The allowed OAuth scopes. Possible values provided by OAuth are `phone` , `email` , `openid` , and `profile` . Possible values provided by AWS are `aws.cognito.signin.user.admin` . Custom scopes created in Resource Servers are also supported. + The OAuth 2.0 scopes that you want to permit your app client to authorize. Scopes govern access control to user pool self-service API operations, user data from the `userInfo` endpoint, and third-party APIs. Possible values provided by OAuth are `phone` , `email` , `openid` , and `profile` . Possible values provided by AWS are `aws.cognito.signin.user.admin` . Custom scopes created in Resource Servers are also supported. """ return pulumi.get(self, "allowed_o_auth_scopes") @@ -292,7 +280,7 @@ def analytics_configuration(self) -> Optional[pulumi.Input['UserPoolClientAnalyt """ The user pool analytics configuration for collecting metrics and sending them to your Amazon Pinpoint campaign. - > In AWS Regions where Amazon Pinpoint isn't available, user pools only support sending events to Amazon Pinpoint projects in AWS Region us-east-1. In Regions where Amazon Pinpoint is available, user pools support sending events to Amazon Pinpoint projects within that same Region. + In AWS Regions where Amazon Pinpoint isn't available, user pools might not have access to analytics or might be configurable with campaigns in the US East (N. Virginia) Region. For more information, see [Using Amazon Pinpoint analytics](https://docs.aws.amazon.com/cognito/latest/developerguide/cognito-user-pools-pinpoint-integration.html) . """ return pulumi.get(self, "analytics_configuration") @@ -321,7 +309,7 @@ def callback_urls(self) -> Optional[pulumi.Input[Sequence[pulumi.Input[str]]]]: A redirect URI must: - Be an absolute URI. - - Be registered with the authorization server. + - Be registered with the authorization server. Amazon Cognito doesn't accept authorization requests with `redirect_uri` values that aren't in the list of `CallbackURLs` that you provide in this parameter. - Not include a fragment component. See [OAuth 2.0 - Redirection Endpoint](https://docs.aws.amazon.com/https://tools.ietf.org/html/rfc6749#section-3.1.2) . @@ -340,7 +328,7 @@ def callback_urls(self, value: Optional[pulumi.Input[Sequence[pulumi.Input[str]] @pulumi.getter(name="clientName") def client_name(self) -> Optional[pulumi.Input[str]]: """ - The client name for the user pool client you would like to create. + A friendly name for the app client that you want to create. """ return pulumi.get(self, "client_name") @@ -353,18 +341,6 @@ def client_name(self, value: Optional[pulumi.Input[str]]): def default_redirect_uri(self) -> Optional[pulumi.Input[str]]: """ The default redirect URI. In app clients with one assigned IdP, replaces `redirect_uri` in authentication requests. Must be in the `CallbackURLs` list. - - A redirect URI must: - - - Be an absolute URI. - - Be registered with the authorization server. - - Not include a fragment component. - - For more information, see [Default redirect URI](https://docs.aws.amazon.com/cognito/latest/developerguide/user-pool-settings-client-apps.html#cognito-user-pools-app-idp-settings-about) . - - Amazon Cognito requires HTTPS over HTTP except for http://localhost for testing purposes only. - - App callback URLs such as myapp://example are also supported. """ return pulumi.get(self, "default_redirect_uri") @@ -428,7 +404,7 @@ def explicit_auth_flows(self, value: Optional[pulumi.Input[Sequence[pulumi.Input @pulumi.getter(name="generateSecret") def generate_secret(self) -> Optional[pulumi.Input[bool]]: """ - Boolean to specify whether you want to generate a secret for the user pool client being created. + When `true` , generates a client secret for the app client. Client secrets are used with server-side and machine-to-machine applications. For more information, see [App client types](https://docs.aws.amazon.com/cognito/latest/developerguide/user-pool-settings-client-apps.html#user-pool-settings-client-app-client-types) . """ return pulumi.get(self, "generate_secret") @@ -459,7 +435,7 @@ def id_token_validity(self, value: Optional[pulumi.Input[int]]): @pulumi.getter(name="logoutUrls") def logout_urls(self) -> Optional[pulumi.Input[Sequence[pulumi.Input[str]]]]: """ - A list of allowed logout URLs for the IdPs. + A list of allowed logout URLs for managed login authentication. For more information, see [Logout endpoint](https://docs.aws.amazon.com/cognito/latest/developerguide/logout-endpoint.html) . """ return pulumi.get(self, "logout_urls") @@ -526,7 +502,7 @@ def supported_identity_providers(self) -> Optional[pulumi.Input[Sequence[pulumi. """ A list of provider names for the identity providers (IdPs) that are supported on this client. The following are supported: `COGNITO` , `Facebook` , `Google` , `SignInWithApple` , and `LoginWithAmazon` . You can also specify the names that you configured for the SAML and OIDC IdPs in your user pool, for example `MySAMLIdP` or `MyOIDCIdP` . - This setting applies to providers that you can access with the [hosted UI and OAuth 2.0 authorization server](https://docs.aws.amazon.com/cognito/latest/developerguide/cognito-user-pools-app-integration.html) . The removal of `COGNITO` from this list doesn't prevent authentication operations for local users with the user pools API in an AWS SDK. The only way to prevent API-based authentication is to block access with a [AWS WAF rule](https://docs.aws.amazon.com/cognito/latest/developerguide/user-pool-waf.html) . + This setting applies to providers that you can access with [managed login](https://docs.aws.amazon.com/cognito/latest/developerguide/cognito-user-pools-managed-login.html) . The removal of `COGNITO` from this list doesn't prevent authentication operations for local users with the user pools API in an AWS SDK. The only way to prevent API-based authentication is to block access with a [AWS WAF rule](https://docs.aws.amazon.com/cognito/latest/developerguide/user-pool-waf.html) . """ return pulumi.get(self, "supported_identity_providers") @@ -538,7 +514,7 @@ def supported_identity_providers(self, value: Optional[pulumi.Input[Sequence[pul @pulumi.getter(name="tokenValidityUnits") def token_validity_units(self) -> Optional[pulumi.Input['UserPoolClientTokenValidityUnitsArgs']]: """ - The units in which the validity times are represented. The default unit for RefreshToken is days, and default for ID and access tokens are hours. + The units that validity times are represented in. The default unit for refresh tokens is days, and the default for ID and access tokens are hours. """ return pulumi.get(self, "token_validity_units") @@ -620,17 +596,17 @@ def __init__(__self__, - `AllowedOAuthFlows` : Support for authorization code, implicit, and client credentials OAuth 2.0 grants. To use OAuth 2.0 features, configure one of these features in the Amazon Cognito console or set `AllowedOAuthFlowsUserPoolClient` to `true` in a `CreateUserPoolClient` or `UpdateUserPoolClient` API request. If you don't set a value for `AllowedOAuthFlowsUserPoolClient` in a request with the AWS CLI or SDKs, it defaults to `false` . - :param pulumi.Input[Sequence[pulumi.Input[str]]] allowed_o_auth_scopes: The allowed OAuth scopes. Possible values provided by OAuth are `phone` , `email` , `openid` , and `profile` . Possible values provided by AWS are `aws.cognito.signin.user.admin` . Custom scopes created in Resource Servers are also supported. + :param pulumi.Input[Sequence[pulumi.Input[str]]] allowed_o_auth_scopes: The OAuth 2.0 scopes that you want to permit your app client to authorize. Scopes govern access control to user pool self-service API operations, user data from the `userInfo` endpoint, and third-party APIs. Possible values provided by OAuth are `phone` , `email` , `openid` , and `profile` . Possible values provided by AWS are `aws.cognito.signin.user.admin` . Custom scopes created in Resource Servers are also supported. :param pulumi.Input[Union['UserPoolClientAnalyticsConfigurationArgs', 'UserPoolClientAnalyticsConfigurationArgsDict']] analytics_configuration: The user pool analytics configuration for collecting metrics and sending them to your Amazon Pinpoint campaign. - > In AWS Regions where Amazon Pinpoint isn't available, user pools only support sending events to Amazon Pinpoint projects in AWS Region us-east-1. In Regions where Amazon Pinpoint is available, user pools support sending events to Amazon Pinpoint projects within that same Region. + In AWS Regions where Amazon Pinpoint isn't available, user pools might not have access to analytics or might be configurable with campaigns in the US East (N. Virginia) Region. For more information, see [Using Amazon Pinpoint analytics](https://docs.aws.amazon.com/cognito/latest/developerguide/cognito-user-pools-pinpoint-integration.html) . :param pulumi.Input[int] auth_session_validity: Amazon Cognito creates a session token for each API request in an authentication flow. `AuthSessionValidity` is the duration, in minutes, of that session token. Your user pool native user must respond to each authentication challenge before the session expires. :param pulumi.Input[Sequence[pulumi.Input[str]]] callback_urls: A list of allowed redirect (callback) URLs for the IdPs. A redirect URI must: - Be an absolute URI. - - Be registered with the authorization server. + - Be registered with the authorization server. Amazon Cognito doesn't accept authorization requests with `redirect_uri` values that aren't in the list of `CallbackURLs` that you provide in this parameter. - Not include a fragment component. See [OAuth 2.0 - Redirection Endpoint](https://docs.aws.amazon.com/https://tools.ietf.org/html/rfc6749#section-3.1.2) . @@ -638,20 +614,8 @@ def __init__(__self__, Amazon Cognito requires HTTPS over HTTP except for http://localhost for testing purposes only. App callback URLs such as myapp://example are also supported. - :param pulumi.Input[str] client_name: The client name for the user pool client you would like to create. + :param pulumi.Input[str] client_name: A friendly name for the app client that you want to create. :param pulumi.Input[str] default_redirect_uri: The default redirect URI. In app clients with one assigned IdP, replaces `redirect_uri` in authentication requests. Must be in the `CallbackURLs` list. - - A redirect URI must: - - - Be an absolute URI. - - Be registered with the authorization server. - - Not include a fragment component. - - For more information, see [Default redirect URI](https://docs.aws.amazon.com/cognito/latest/developerguide/user-pool-settings-client-apps.html#cognito-user-pools-app-idp-settings-about) . - - Amazon Cognito requires HTTPS over HTTP except for http://localhost for testing purposes only. - - App callback URLs such as myapp://example are also supported. :param pulumi.Input[bool] enable_propagate_additional_user_context_data: Activates the propagation of additional user context data. For more information about propagation of user context data, see [Adding advanced security to a user pool](https://docs.aws.amazon.com/cognito/latest/developerguide/cognito-user-pool-settings-threat-protection.html) . If you don’t include this parameter, you can't send device fingerprint information, including source IP address, to Amazon Cognito advanced security. You can only activate `EnablePropagateAdditionalUserContextData` in an app client that has a client secret. :param pulumi.Input[bool] enable_token_revocation: Activates or deactivates token revocation. For more information about revoking tokens, see [RevokeToken](https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_RevokeToken.html) . @@ -671,7 +635,7 @@ def __init__(__self__, In some environments, you will see the values `ADMIN_NO_SRP_AUTH` , `CUSTOM_AUTH_FLOW_ONLY` , or `USER_PASSWORD_AUTH` . You can't assign these legacy `ExplicitAuthFlows` values to user pool clients at the same time as values that begin with `ALLOW_` , like `ALLOW_USER_SRP_AUTH` . - :param pulumi.Input[bool] generate_secret: Boolean to specify whether you want to generate a secret for the user pool client being created. + :param pulumi.Input[bool] generate_secret: When `true` , generates a client secret for the app client. Client secrets are used with server-side and machine-to-machine applications. For more information, see [App client types](https://docs.aws.amazon.com/cognito/latest/developerguide/user-pool-settings-client-apps.html#user-pool-settings-client-app-client-types) . :param pulumi.Input[int] id_token_validity: The ID token time limit. After this limit expires, your user can't use their ID token. To specify the time unit for `IdTokenValidity` as `seconds` , `minutes` , `hours` , or `days` , set a `TokenValidityUnits` value in your API request. For example, when you set `IdTokenValidity` as `10` and `TokenValidityUnits` as `hours` , your user can authenticate their session with their ID token for 10 hours. @@ -680,7 +644,7 @@ def __init__(__self__, If you don't specify otherwise in the configuration of your app client, your ID tokens are valid for one hour. - :param pulumi.Input[Sequence[pulumi.Input[str]]] logout_urls: A list of allowed logout URLs for the IdPs. + :param pulumi.Input[Sequence[pulumi.Input[str]]] logout_urls: A list of allowed logout URLs for managed login authentication. For more information, see [Logout endpoint](https://docs.aws.amazon.com/cognito/latest/developerguide/logout-endpoint.html) . :param pulumi.Input[str] prevent_user_existence_errors: Errors and responses that you want Amazon Cognito APIs to return during authentication, account confirmation, and password recovery when the user doesn't exist in the user pool. When set to `ENABLED` and the user doesn't exist, authentication returns an error indicating either the username or password was incorrect. Account confirmation and password recovery return a response indicating a code was sent to a simulated destination. When set to `LEGACY` , those APIs return a `UserNotFoundException` exception if the user doesn't exist in the user pool. Valid values include: @@ -703,9 +667,9 @@ def __init__(__self__, tokens are valid for 30 days. :param pulumi.Input[Sequence[pulumi.Input[str]]] supported_identity_providers: A list of provider names for the identity providers (IdPs) that are supported on this client. The following are supported: `COGNITO` , `Facebook` , `Google` , `SignInWithApple` , and `LoginWithAmazon` . You can also specify the names that you configured for the SAML and OIDC IdPs in your user pool, for example `MySAMLIdP` or `MyOIDCIdP` . - This setting applies to providers that you can access with the [hosted UI and OAuth 2.0 authorization server](https://docs.aws.amazon.com/cognito/latest/developerguide/cognito-user-pools-app-integration.html) . The removal of `COGNITO` from this list doesn't prevent authentication operations for local users with the user pools API in an AWS SDK. The only way to prevent API-based authentication is to block access with a [AWS WAF rule](https://docs.aws.amazon.com/cognito/latest/developerguide/user-pool-waf.html) . - :param pulumi.Input[Union['UserPoolClientTokenValidityUnitsArgs', 'UserPoolClientTokenValidityUnitsArgsDict']] token_validity_units: The units in which the validity times are represented. The default unit for RefreshToken is days, and default for ID and access tokens are hours. - :param pulumi.Input[str] user_pool_id: The user pool ID for the user pool where you want to create a user pool client. + This setting applies to providers that you can access with [managed login](https://docs.aws.amazon.com/cognito/latest/developerguide/cognito-user-pools-managed-login.html) . The removal of `COGNITO` from this list doesn't prevent authentication operations for local users with the user pools API in an AWS SDK. The only way to prevent API-based authentication is to block access with a [AWS WAF rule](https://docs.aws.amazon.com/cognito/latest/developerguide/user-pool-waf.html) . + :param pulumi.Input[Union['UserPoolClientTokenValidityUnitsArgs', 'UserPoolClientTokenValidityUnitsArgsDict']] token_validity_units: The units that validity times are represented in. The default unit for refresh tokens is days, and the default for ID and access tokens are hours. + :param pulumi.Input[str] user_pool_id: The ID of the user pool where you want to create an app client. :param pulumi.Input[Sequence[pulumi.Input[str]]] write_attributes: The list of user attributes that you want your app client to have write access to. After your user authenticates in your app, their access token authorizes them to set or modify their own attribute value for any attribute in this list. An example of this kind of activity is when you present your user with a form to update their profile information and they change their last name. Your app then makes an [UpdateUserAttributes](https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_UpdateUserAttributes.html) API request and sets `family_name` to the new value. When you don't specify the `WriteAttributes` for your app client, your app can write the values of the Standard attributes of your user pool. When your user pool has write access to these default attributes, `WriteAttributes` doesn't return any information. Amazon Cognito only populates `WriteAttributes` in the API response if you have specified your own custom set of write attributes. @@ -894,7 +858,7 @@ def allowed_o_auth_flows_user_pool_client(self) -> pulumi.Output[Optional[bool]] @pulumi.getter(name="allowedOAuthScopes") def allowed_o_auth_scopes(self) -> pulumi.Output[Optional[Sequence[str]]]: """ - The allowed OAuth scopes. Possible values provided by OAuth are `phone` , `email` , `openid` , and `profile` . Possible values provided by AWS are `aws.cognito.signin.user.admin` . Custom scopes created in Resource Servers are also supported. + The OAuth 2.0 scopes that you want to permit your app client to authorize. Scopes govern access control to user pool self-service API operations, user data from the `userInfo` endpoint, and third-party APIs. Possible values provided by OAuth are `phone` , `email` , `openid` , and `profile` . Possible values provided by AWS are `aws.cognito.signin.user.admin` . Custom scopes created in Resource Servers are also supported. """ return pulumi.get(self, "allowed_o_auth_scopes") @@ -904,7 +868,7 @@ def analytics_configuration(self) -> pulumi.Output[Optional['outputs.UserPoolCli """ The user pool analytics configuration for collecting metrics and sending them to your Amazon Pinpoint campaign. - > In AWS Regions where Amazon Pinpoint isn't available, user pools only support sending events to Amazon Pinpoint projects in AWS Region us-east-1. In Regions where Amazon Pinpoint is available, user pools support sending events to Amazon Pinpoint projects within that same Region. + In AWS Regions where Amazon Pinpoint isn't available, user pools might not have access to analytics or might be configurable with campaigns in the US East (N. Virginia) Region. For more information, see [Using Amazon Pinpoint analytics](https://docs.aws.amazon.com/cognito/latest/developerguide/cognito-user-pools-pinpoint-integration.html) . """ return pulumi.get(self, "analytics_configuration") @@ -925,7 +889,7 @@ def callback_urls(self) -> pulumi.Output[Optional[Sequence[str]]]: A redirect URI must: - Be an absolute URI. - - Be registered with the authorization server. + - Be registered with the authorization server. Amazon Cognito doesn't accept authorization requests with `redirect_uri` values that aren't in the list of `CallbackURLs` that you provide in this parameter. - Not include a fragment component. See [OAuth 2.0 - Redirection Endpoint](https://docs.aws.amazon.com/https://tools.ietf.org/html/rfc6749#section-3.1.2) . @@ -948,7 +912,7 @@ def client_id(self) -> pulumi.Output[str]: @pulumi.getter(name="clientName") def client_name(self) -> pulumi.Output[Optional[str]]: """ - The client name for the user pool client you would like to create. + A friendly name for the app client that you want to create. """ return pulumi.get(self, "client_name") @@ -962,18 +926,6 @@ def client_secret(self) -> pulumi.Output[str]: def default_redirect_uri(self) -> pulumi.Output[Optional[str]]: """ The default redirect URI. In app clients with one assigned IdP, replaces `redirect_uri` in authentication requests. Must be in the `CallbackURLs` list. - - A redirect URI must: - - - Be an absolute URI. - - Be registered with the authorization server. - - Not include a fragment component. - - For more information, see [Default redirect URI](https://docs.aws.amazon.com/cognito/latest/developerguide/user-pool-settings-client-apps.html#cognito-user-pools-app-idp-settings-about) . - - Amazon Cognito requires HTTPS over HTTP except for http://localhost for testing purposes only. - - App callback URLs such as myapp://example are also supported. """ return pulumi.get(self, "default_redirect_uri") @@ -1021,7 +973,7 @@ def explicit_auth_flows(self) -> pulumi.Output[Optional[Sequence[str]]]: @pulumi.getter(name="generateSecret") def generate_secret(self) -> pulumi.Output[Optional[bool]]: """ - Boolean to specify whether you want to generate a secret for the user pool client being created. + When `true` , generates a client secret for the app client. Client secrets are used with server-side and machine-to-machine applications. For more information, see [App client types](https://docs.aws.amazon.com/cognito/latest/developerguide/user-pool-settings-client-apps.html#user-pool-settings-client-app-client-types) . """ return pulumi.get(self, "generate_secret") @@ -1044,7 +996,7 @@ def id_token_validity(self) -> pulumi.Output[Optional[int]]: @pulumi.getter(name="logoutUrls") def logout_urls(self) -> pulumi.Output[Optional[Sequence[str]]]: """ - A list of allowed logout URLs for the IdPs. + A list of allowed logout URLs for managed login authentication. For more information, see [Logout endpoint](https://docs.aws.amazon.com/cognito/latest/developerguide/logout-endpoint.html) . """ return pulumi.get(self, "logout_urls") @@ -1100,7 +1052,7 @@ def supported_identity_providers(self) -> pulumi.Output[Optional[Sequence[str]]] """ A list of provider names for the identity providers (IdPs) that are supported on this client. The following are supported: `COGNITO` , `Facebook` , `Google` , `SignInWithApple` , and `LoginWithAmazon` . You can also specify the names that you configured for the SAML and OIDC IdPs in your user pool, for example `MySAMLIdP` or `MyOIDCIdP` . - This setting applies to providers that you can access with the [hosted UI and OAuth 2.0 authorization server](https://docs.aws.amazon.com/cognito/latest/developerguide/cognito-user-pools-app-integration.html) . The removal of `COGNITO` from this list doesn't prevent authentication operations for local users with the user pools API in an AWS SDK. The only way to prevent API-based authentication is to block access with a [AWS WAF rule](https://docs.aws.amazon.com/cognito/latest/developerguide/user-pool-waf.html) . + This setting applies to providers that you can access with [managed login](https://docs.aws.amazon.com/cognito/latest/developerguide/cognito-user-pools-managed-login.html) . The removal of `COGNITO` from this list doesn't prevent authentication operations for local users with the user pools API in an AWS SDK. The only way to prevent API-based authentication is to block access with a [AWS WAF rule](https://docs.aws.amazon.com/cognito/latest/developerguide/user-pool-waf.html) . """ return pulumi.get(self, "supported_identity_providers") @@ -1108,7 +1060,7 @@ def supported_identity_providers(self) -> pulumi.Output[Optional[Sequence[str]]] @pulumi.getter(name="tokenValidityUnits") def token_validity_units(self) -> pulumi.Output[Optional['outputs.UserPoolClientTokenValidityUnits']]: """ - The units in which the validity times are represented. The default unit for RefreshToken is days, and default for ID and access tokens are hours. + The units that validity times are represented in. The default unit for refresh tokens is days, and the default for ID and access tokens are hours. """ return pulumi.get(self, "token_validity_units") @@ -1116,7 +1068,7 @@ def token_validity_units(self) -> pulumi.Output[Optional['outputs.UserPoolClient @pulumi.getter(name="userPoolId") def user_pool_id(self) -> pulumi.Output[str]: """ - The user pool ID for the user pool where you want to create a user pool client. + The ID of the user pool where you want to create an app client. """ return pulumi.get(self, "user_pool_id") diff --git a/sdk/python/pulumi_aws_native/cognito/user_pool_group.py b/sdk/python/pulumi_aws_native/cognito/user_pool_group.py index 9245128ece..9986b1da65 100644 --- a/sdk/python/pulumi_aws_native/cognito/user_pool_group.py +++ b/sdk/python/pulumi_aws_native/cognito/user_pool_group.py @@ -26,15 +26,15 @@ def __init__(__self__, *, role_arn: Optional[pulumi.Input[str]] = None): """ The set of arguments for constructing a UserPoolGroup resource. - :param pulumi.Input[str] user_pool_id: The user pool ID for the user pool. - :param pulumi.Input[str] description: A string containing the description of the group. - :param pulumi.Input[str] group_name: The name of the group. Must be unique. + :param pulumi.Input[str] user_pool_id: The ID of the user pool where you want to create a user group. + :param pulumi.Input[str] description: A description of the group that you're creating. + :param pulumi.Input[str] group_name: A name for the group. This name must be unique in your user pool. :param pulumi.Input[int] precedence: A non-negative integer value that specifies the precedence of this group relative to the other groups that a user can belong to in the user pool. Zero is the highest precedence value. Groups with lower `Precedence` values take precedence over groups with higher or null `Precedence` values. If a user belongs to two or more groups, it is the group with the lowest precedence value whose role ARN is given in the user's tokens for the `cognito:roles` and `cognito:preferred_role` claims. Two groups can have the same `Precedence` value. If this happens, neither group takes precedence over the other. If two groups with the same `Precedence` have the same role ARN, that role is used in the `cognito:preferred_role` claim in tokens for users in each group. If the two groups have different role ARNs, the `cognito:preferred_role` claim isn't set in users' tokens. The default `Precedence` value is null. The maximum `Precedence` value is `2^31-1` . - :param pulumi.Input[str] role_arn: The role Amazon Resource Name (ARN) for the group. + :param pulumi.Input[str] role_arn: The Amazon Resource Name (ARN) for the IAM role that you want to associate with the group. A group role primarily declares a preferred role for the credentials that you get from an identity pool. Amazon Cognito ID tokens have a `cognito:preferred_role` claim that presents the highest-precedence group that a user belongs to. Both ID and access tokens also contain a `cognito:groups` claim that list all the groups that a user is a member of. """ pulumi.set(__self__, "user_pool_id", user_pool_id) if description is not None: @@ -50,7 +50,7 @@ def __init__(__self__, *, @pulumi.getter(name="userPoolId") def user_pool_id(self) -> pulumi.Input[str]: """ - The user pool ID for the user pool. + The ID of the user pool where you want to create a user group. """ return pulumi.get(self, "user_pool_id") @@ -62,7 +62,7 @@ def user_pool_id(self, value: pulumi.Input[str]): @pulumi.getter def description(self) -> Optional[pulumi.Input[str]]: """ - A string containing the description of the group. + A description of the group that you're creating. """ return pulumi.get(self, "description") @@ -74,7 +74,7 @@ def description(self, value: Optional[pulumi.Input[str]]): @pulumi.getter(name="groupName") def group_name(self) -> Optional[pulumi.Input[str]]: """ - The name of the group. Must be unique. + A name for the group. This name must be unique in your user pool. """ return pulumi.get(self, "group_name") @@ -102,7 +102,7 @@ def precedence(self, value: Optional[pulumi.Input[int]]): @pulumi.getter(name="roleArn") def role_arn(self) -> Optional[pulumi.Input[str]]: """ - The role Amazon Resource Name (ARN) for the group. + The Amazon Resource Name (ARN) for the IAM role that you want to associate with the group. A group role primarily declares a preferred role for the credentials that you get from an identity pool. Amazon Cognito ID tokens have a `cognito:preferred_role` claim that presents the highest-precedence group that a user belongs to. Both ID and access tokens also contain a `cognito:groups` claim that list all the groups that a user is a member of. """ return pulumi.get(self, "role_arn") @@ -127,15 +127,15 @@ def __init__(__self__, :param str resource_name: The name of the resource. :param pulumi.ResourceOptions opts: Options for the resource. - :param pulumi.Input[str] description: A string containing the description of the group. - :param pulumi.Input[str] group_name: The name of the group. Must be unique. + :param pulumi.Input[str] description: A description of the group that you're creating. + :param pulumi.Input[str] group_name: A name for the group. This name must be unique in your user pool. :param pulumi.Input[int] precedence: A non-negative integer value that specifies the precedence of this group relative to the other groups that a user can belong to in the user pool. Zero is the highest precedence value. Groups with lower `Precedence` values take precedence over groups with higher or null `Precedence` values. If a user belongs to two or more groups, it is the group with the lowest precedence value whose role ARN is given in the user's tokens for the `cognito:roles` and `cognito:preferred_role` claims. Two groups can have the same `Precedence` value. If this happens, neither group takes precedence over the other. If two groups with the same `Precedence` have the same role ARN, that role is used in the `cognito:preferred_role` claim in tokens for users in each group. If the two groups have different role ARNs, the `cognito:preferred_role` claim isn't set in users' tokens. The default `Precedence` value is null. The maximum `Precedence` value is `2^31-1` . - :param pulumi.Input[str] role_arn: The role Amazon Resource Name (ARN) for the group. - :param pulumi.Input[str] user_pool_id: The user pool ID for the user pool. + :param pulumi.Input[str] role_arn: The Amazon Resource Name (ARN) for the IAM role that you want to associate with the group. A group role primarily declares a preferred role for the credentials that you get from an identity pool. Amazon Cognito ID tokens have a `cognito:preferred_role` claim that presents the highest-precedence group that a user belongs to. Both ID and access tokens also contain a `cognito:groups` claim that list all the groups that a user is a member of. + :param pulumi.Input[str] user_pool_id: The ID of the user pool where you want to create a user group. """ ... @overload @@ -217,7 +217,7 @@ def get(resource_name: str, @pulumi.getter def description(self) -> pulumi.Output[Optional[str]]: """ - A string containing the description of the group. + A description of the group that you're creating. """ return pulumi.get(self, "description") @@ -225,7 +225,7 @@ def description(self) -> pulumi.Output[Optional[str]]: @pulumi.getter(name="groupName") def group_name(self) -> pulumi.Output[Optional[str]]: """ - The name of the group. Must be unique. + A name for the group. This name must be unique in your user pool. """ return pulumi.get(self, "group_name") @@ -245,7 +245,7 @@ def precedence(self) -> pulumi.Output[Optional[int]]: @pulumi.getter(name="roleArn") def role_arn(self) -> pulumi.Output[Optional[str]]: """ - The role Amazon Resource Name (ARN) for the group. + The Amazon Resource Name (ARN) for the IAM role that you want to associate with the group. A group role primarily declares a preferred role for the credentials that you get from an identity pool. Amazon Cognito ID tokens have a `cognito:preferred_role` claim that presents the highest-precedence group that a user belongs to. Both ID and access tokens also contain a `cognito:groups` claim that list all the groups that a user is a member of. """ return pulumi.get(self, "role_arn") @@ -253,7 +253,7 @@ def role_arn(self) -> pulumi.Output[Optional[str]]: @pulumi.getter(name="userPoolId") def user_pool_id(self) -> pulumi.Output[str]: """ - The user pool ID for the user pool. + The ID of the user pool where you want to create a user group. """ return pulumi.get(self, "user_pool_id") diff --git a/sdk/python/pulumi_aws_native/cognito/user_pool_identity_provider.py b/sdk/python/pulumi_aws_native/cognito/user_pool_identity_provider.py index 493fd94652..5338d80f82 100644 --- a/sdk/python/pulumi_aws_native/cognito/user_pool_identity_provider.py +++ b/sdk/python/pulumi_aws_native/cognito/user_pool_identity_provider.py @@ -56,11 +56,11 @@ def __init__(__self__, *, - **Facebook** - Create or update request: `"ProviderDetails": { "api_version": "v17.0", "authorize_scopes": "public_profile, email", "client_id": "1example23456789", "client_secret": "provider-app-client-secret" }` Describe response: `"ProviderDetails": { "api_version": "v17.0", "attributes_url": "https://graph.facebook.com/v17.0/me?fields=", "attributes_url_add_attributes": "true", "authorize_scopes": "public_profile, email", "authorize_url": "https://www.facebook.com/v17.0/dialog/oauth", "client_id": "1example23456789", "client_secret": "provider-app-client-secret", "token_request_method": "GET", "token_url": "https://graph.facebook.com/v17.0/oauth/access_token" }` - :param pulumi.Input[str] provider_type: The IdP type. - :param pulumi.Input[str] user_pool_id: The user pool ID. - :param pulumi.Input[Mapping[str, pulumi.Input[str]]] attribute_mapping: A mapping of IdP attributes to standard and custom user pool attributes. - :param pulumi.Input[Sequence[pulumi.Input[str]]] idp_identifiers: A list of IdP identifiers. - :param pulumi.Input[str] provider_name: The IdP name. + :param pulumi.Input[str] provider_type: The type of IdP that you want to add. Amazon Cognito supports OIDC, SAML 2.0, Login With Amazon, Sign In With Apple, Google, and Facebook IdPs. + :param pulumi.Input[str] user_pool_id: The Id of the user pool where you want to create an IdP. + :param pulumi.Input[Mapping[str, pulumi.Input[str]]] attribute_mapping: A mapping of IdP attributes to standard and custom user pool attributes. Specify a user pool attribute as the key of the key-value pair, and the IdP attribute claim name as the value. + :param pulumi.Input[Sequence[pulumi.Input[str]]] idp_identifiers: An array of IdP identifiers, for example `"IdPIdentifiers": [ "MyIdP", "MyIdP2" ]` . Identifiers are friendly names that you can pass in the `idp_identifier` query parameter of requests to the [Authorize endpoint](https://docs.aws.amazon.com/cognito/latest/developerguide/authorization-endpoint.html) to silently redirect to sign-in with the associated IdP. Identifiers in a domain format also enable the use of [email-address matching with SAML providers](https://docs.aws.amazon.com/cognito/latest/developerguide/cognito-user-pools-managing-saml-idp-naming.html) . + :param pulumi.Input[str] provider_name: The name that you want to assign to the IdP. You can pass the identity provider name in the `identity_provider` query parameter of requests to the [Authorize endpoint](https://docs.aws.amazon.com/cognito/latest/developerguide/authorization-endpoint.html) to silently redirect to sign-in with the associated IdP. """ pulumi.set(__self__, "provider_details", provider_details) pulumi.set(__self__, "provider_type", provider_type) @@ -116,7 +116,7 @@ def provider_details(self, value: pulumi.Input[Mapping[str, pulumi.Input[str]]]) @pulumi.getter(name="providerType") def provider_type(self) -> pulumi.Input[str]: """ - The IdP type. + The type of IdP that you want to add. Amazon Cognito supports OIDC, SAML 2.0, Login With Amazon, Sign In With Apple, Google, and Facebook IdPs. """ return pulumi.get(self, "provider_type") @@ -128,7 +128,7 @@ def provider_type(self, value: pulumi.Input[str]): @pulumi.getter(name="userPoolId") def user_pool_id(self) -> pulumi.Input[str]: """ - The user pool ID. + The Id of the user pool where you want to create an IdP. """ return pulumi.get(self, "user_pool_id") @@ -140,7 +140,7 @@ def user_pool_id(self, value: pulumi.Input[str]): @pulumi.getter(name="attributeMapping") def attribute_mapping(self) -> Optional[pulumi.Input[Mapping[str, pulumi.Input[str]]]]: """ - A mapping of IdP attributes to standard and custom user pool attributes. + A mapping of IdP attributes to standard and custom user pool attributes. Specify a user pool attribute as the key of the key-value pair, and the IdP attribute claim name as the value. """ return pulumi.get(self, "attribute_mapping") @@ -152,7 +152,7 @@ def attribute_mapping(self, value: Optional[pulumi.Input[Mapping[str, pulumi.Inp @pulumi.getter(name="idpIdentifiers") def idp_identifiers(self) -> Optional[pulumi.Input[Sequence[pulumi.Input[str]]]]: """ - A list of IdP identifiers. + An array of IdP identifiers, for example `"IdPIdentifiers": [ "MyIdP", "MyIdP2" ]` . Identifiers are friendly names that you can pass in the `idp_identifier` query parameter of requests to the [Authorize endpoint](https://docs.aws.amazon.com/cognito/latest/developerguide/authorization-endpoint.html) to silently redirect to sign-in with the associated IdP. Identifiers in a domain format also enable the use of [email-address matching with SAML providers](https://docs.aws.amazon.com/cognito/latest/developerguide/cognito-user-pools-managing-saml-idp-naming.html) . """ return pulumi.get(self, "idp_identifiers") @@ -164,7 +164,7 @@ def idp_identifiers(self, value: Optional[pulumi.Input[Sequence[pulumi.Input[str @pulumi.getter(name="providerName") def provider_name(self) -> Optional[pulumi.Input[str]]: """ - The IdP name. + The name that you want to assign to the IdP. You can pass the identity provider name in the `identity_provider` query parameter of requests to the [Authorize endpoint](https://docs.aws.amazon.com/cognito/latest/developerguide/authorization-endpoint.html) to silently redirect to sign-in with the associated IdP. """ return pulumi.get(self, "provider_name") @@ -190,8 +190,8 @@ def __init__(__self__, :param str resource_name: The name of the resource. :param pulumi.ResourceOptions opts: Options for the resource. - :param pulumi.Input[Mapping[str, pulumi.Input[str]]] attribute_mapping: A mapping of IdP attributes to standard and custom user pool attributes. - :param pulumi.Input[Sequence[pulumi.Input[str]]] idp_identifiers: A list of IdP identifiers. + :param pulumi.Input[Mapping[str, pulumi.Input[str]]] attribute_mapping: A mapping of IdP attributes to standard and custom user pool attributes. Specify a user pool attribute as the key of the key-value pair, and the IdP attribute claim name as the value. + :param pulumi.Input[Sequence[pulumi.Input[str]]] idp_identifiers: An array of IdP identifiers, for example `"IdPIdentifiers": [ "MyIdP", "MyIdP2" ]` . Identifiers are friendly names that you can pass in the `idp_identifier` query parameter of requests to the [Authorize endpoint](https://docs.aws.amazon.com/cognito/latest/developerguide/authorization-endpoint.html) to silently redirect to sign-in with the associated IdP. Identifiers in a domain format also enable the use of [email-address matching with SAML providers](https://docs.aws.amazon.com/cognito/latest/developerguide/cognito-user-pools-managing-saml-idp-naming.html) . :param pulumi.Input[Mapping[str, pulumi.Input[str]]] provider_details: The scopes, URLs, and identifiers for your external identity provider. The following examples describe the provider detail keys for each IdP type. These values and their schema are subject to change. Social IdP `authorize_scopes` values must match @@ -221,9 +221,9 @@ def __init__(__self__, - **Facebook** - Create or update request: `"ProviderDetails": { "api_version": "v17.0", "authorize_scopes": "public_profile, email", "client_id": "1example23456789", "client_secret": "provider-app-client-secret" }` Describe response: `"ProviderDetails": { "api_version": "v17.0", "attributes_url": "https://graph.facebook.com/v17.0/me?fields=", "attributes_url_add_attributes": "true", "authorize_scopes": "public_profile, email", "authorize_url": "https://www.facebook.com/v17.0/dialog/oauth", "client_id": "1example23456789", "client_secret": "provider-app-client-secret", "token_request_method": "GET", "token_url": "https://graph.facebook.com/v17.0/oauth/access_token" }` - :param pulumi.Input[str] provider_name: The IdP name. - :param pulumi.Input[str] provider_type: The IdP type. - :param pulumi.Input[str] user_pool_id: The user pool ID. + :param pulumi.Input[str] provider_name: The name that you want to assign to the IdP. You can pass the identity provider name in the `identity_provider` query parameter of requests to the [Authorize endpoint](https://docs.aws.amazon.com/cognito/latest/developerguide/authorization-endpoint.html) to silently redirect to sign-in with the associated IdP. + :param pulumi.Input[str] provider_type: The type of IdP that you want to add. Amazon Cognito supports OIDC, SAML 2.0, Login With Amazon, Sign In With Apple, Google, and Facebook IdPs. + :param pulumi.Input[str] user_pool_id: The Id of the user pool where you want to create an IdP. """ ... @overload @@ -312,7 +312,7 @@ def get(resource_name: str, @pulumi.getter(name="attributeMapping") def attribute_mapping(self) -> pulumi.Output[Optional[Mapping[str, str]]]: """ - A mapping of IdP attributes to standard and custom user pool attributes. + A mapping of IdP attributes to standard and custom user pool attributes. Specify a user pool attribute as the key of the key-value pair, and the IdP attribute claim name as the value. """ return pulumi.get(self, "attribute_mapping") @@ -320,7 +320,7 @@ def attribute_mapping(self) -> pulumi.Output[Optional[Mapping[str, str]]]: @pulumi.getter(name="idpIdentifiers") def idp_identifiers(self) -> pulumi.Output[Optional[Sequence[str]]]: """ - A list of IdP identifiers. + An array of IdP identifiers, for example `"IdPIdentifiers": [ "MyIdP", "MyIdP2" ]` . Identifiers are friendly names that you can pass in the `idp_identifier` query parameter of requests to the [Authorize endpoint](https://docs.aws.amazon.com/cognito/latest/developerguide/authorization-endpoint.html) to silently redirect to sign-in with the associated IdP. Identifiers in a domain format also enable the use of [email-address matching with SAML providers](https://docs.aws.amazon.com/cognito/latest/developerguide/cognito-user-pools-managing-saml-idp-naming.html) . """ return pulumi.get(self, "idp_identifiers") @@ -364,7 +364,7 @@ def provider_details(self) -> pulumi.Output[Mapping[str, str]]: @pulumi.getter(name="providerName") def provider_name(self) -> pulumi.Output[str]: """ - The IdP name. + The name that you want to assign to the IdP. You can pass the identity provider name in the `identity_provider` query parameter of requests to the [Authorize endpoint](https://docs.aws.amazon.com/cognito/latest/developerguide/authorization-endpoint.html) to silently redirect to sign-in with the associated IdP. """ return pulumi.get(self, "provider_name") @@ -372,7 +372,7 @@ def provider_name(self) -> pulumi.Output[str]: @pulumi.getter(name="providerType") def provider_type(self) -> pulumi.Output[str]: """ - The IdP type. + The type of IdP that you want to add. Amazon Cognito supports OIDC, SAML 2.0, Login With Amazon, Sign In With Apple, Google, and Facebook IdPs. """ return pulumi.get(self, "provider_type") @@ -380,7 +380,7 @@ def provider_type(self) -> pulumi.Output[str]: @pulumi.getter(name="userPoolId") def user_pool_id(self) -> pulumi.Output[str]: """ - The user pool ID. + The Id of the user pool where you want to create an IdP. """ return pulumi.get(self, "user_pool_id") diff --git a/sdk/python/pulumi_aws_native/cognito/user_pool_resource_server.py b/sdk/python/pulumi_aws_native/cognito/user_pool_resource_server.py index 21be36db1f..1b2e3d53f0 100644 --- a/sdk/python/pulumi_aws_native/cognito/user_pool_resource_server.py +++ b/sdk/python/pulumi_aws_native/cognito/user_pool_resource_server.py @@ -30,7 +30,7 @@ def __init__(__self__, *, :param pulumi.Input[str] identifier: A unique resource server identifier for the resource server. The identifier can be an API friendly name like `solar-system-data` . You can also set an API URL like `https://solar-system-data-api.example.com` as your identifier. Amazon Cognito represents scopes in the access token in the format `$resource-server-identifier/$scope` . Longer scope-identifier strings increase the size of your access tokens. - :param pulumi.Input[str] user_pool_id: The user pool ID for the user pool. + :param pulumi.Input[str] user_pool_id: The ID of the user pool where you want to create a resource server. :param pulumi.Input[str] name: A friendly name for the resource server. :param pulumi.Input[Sequence[pulumi.Input['UserPoolResourceServerResourceServerScopeTypeArgs']]] scopes: A list of scopes. Each scope is a map with keys `ScopeName` and `ScopeDescription` . """ @@ -59,7 +59,7 @@ def identifier(self, value: pulumi.Input[str]): @pulumi.getter(name="userPoolId") def user_pool_id(self) -> pulumi.Input[str]: """ - The user pool ID for the user pool. + The ID of the user pool where you want to create a resource server. """ return pulumi.get(self, "user_pool_id") @@ -112,7 +112,7 @@ def __init__(__self__, Amazon Cognito represents scopes in the access token in the format `$resource-server-identifier/$scope` . Longer scope-identifier strings increase the size of your access tokens. :param pulumi.Input[str] name: A friendly name for the resource server. :param pulumi.Input[Sequence[pulumi.Input[Union['UserPoolResourceServerResourceServerScopeTypeArgs', 'UserPoolResourceServerResourceServerScopeTypeArgsDict']]]] scopes: A list of scopes. Each scope is a map with keys `ScopeName` and `ScopeDescription` . - :param pulumi.Input[str] user_pool_id: The user pool ID for the user pool. + :param pulumi.Input[str] user_pool_id: The ID of the user pool where you want to create a resource server. """ ... @overload @@ -219,7 +219,7 @@ def scopes(self) -> pulumi.Output[Optional[Sequence['outputs.UserPoolResourceSer @pulumi.getter(name="userPoolId") def user_pool_id(self) -> pulumi.Output[str]: """ - The user pool ID for the user pool. + The ID of the user pool where you want to create a resource server. """ return pulumi.get(self, "user_pool_id") diff --git a/sdk/python/pulumi_aws_native/cognito/user_pool_ui_customization_attachment.py b/sdk/python/pulumi_aws_native/cognito/user_pool_ui_customization_attachment.py index 11f863ed3d..f07617d381 100644 --- a/sdk/python/pulumi_aws_native/cognito/user_pool_ui_customization_attachment.py +++ b/sdk/python/pulumi_aws_native/cognito/user_pool_ui_customization_attachment.py @@ -25,7 +25,7 @@ def __init__(__self__, *, """ The set of arguments for constructing a UserPoolUiCustomizationAttachment resource. :param pulumi.Input[str] client_id: The app client ID for your UI customization. When this value isn't present, the customization applies to all user pool app clients that don't have client-level settings.. - :param pulumi.Input[str] user_pool_id: The user pool ID for the user pool. + :param pulumi.Input[str] user_pool_id: The ID of the user pool. :param pulumi.Input[str] css: The CSS values in the UI customization. """ pulumi.set(__self__, "client_id", client_id) @@ -49,7 +49,7 @@ def client_id(self, value: pulumi.Input[str]): @pulumi.getter(name="userPoolId") def user_pool_id(self) -> pulumi.Input[str]: """ - The user pool ID for the user pool. + The ID of the user pool. """ return pulumi.get(self, "user_pool_id") @@ -86,7 +86,7 @@ def __init__(__self__, :param pulumi.ResourceOptions opts: Options for the resource. :param pulumi.Input[str] client_id: The app client ID for your UI customization. When this value isn't present, the customization applies to all user pool app clients that don't have client-level settings.. :param pulumi.Input[str] css: The CSS values in the UI customization. - :param pulumi.Input[str] user_pool_id: The user pool ID for the user pool. + :param pulumi.Input[str] user_pool_id: The ID of the user pool. """ ... @overload @@ -180,7 +180,7 @@ def css(self) -> pulumi.Output[Optional[str]]: @pulumi.getter(name="userPoolId") def user_pool_id(self) -> pulumi.Output[str]: """ - The user pool ID for the user pool. + The ID of the user pool. """ return pulumi.get(self, "user_pool_id") diff --git a/sdk/python/pulumi_aws_native/cognito/user_pool_user.py b/sdk/python/pulumi_aws_native/cognito/user_pool_user.py index ea9345ee65..5a6406f0fb 100644 --- a/sdk/python/pulumi_aws_native/cognito/user_pool_user.py +++ b/sdk/python/pulumi_aws_native/cognito/user_pool_user.py @@ -31,25 +31,25 @@ def __init__(__self__, *, validation_data: Optional[pulumi.Input[Sequence[pulumi.Input['UserPoolUserAttributeTypeArgs']]]] = None): """ The set of arguments for constructing a UserPoolUser resource. - :param pulumi.Input[str] user_pool_id: The user pool ID for the user pool where the user will be created. + :param pulumi.Input[str] user_pool_id: The ID of the user pool where you want to create a user. :param pulumi.Input[Mapping[str, pulumi.Input[str]]] client_metadata: A map of custom key-value pairs that you can provide as input for any custom workflows that this action triggers. - You create custom workflows by assigning AWS Lambda functions to user pool triggers. When you use the AdminCreateUser API action, Amazon Cognito invokes the function that is assigned to the *pre sign-up* trigger. When Amazon Cognito invokes this function, it passes a JSON payload, which the function receives as input. This payload contains a `clientMetadata` attribute, which provides the data that you assigned to the ClientMetadata parameter in your AdminCreateUser request. In your function code in AWS Lambda , you can process the `clientMetadata` value to enhance your workflow for your specific needs. + You create custom workflows by assigning AWS Lambda functions to user pool triggers. When you use the AdminCreateUser API action, Amazon Cognito invokes the function that is assigned to the *pre sign-up* trigger. When Amazon Cognito invokes this function, it passes a JSON payload, which the function receives as input. This payload contains a `ClientMetadata` attribute, which provides the data that you assigned to the ClientMetadata parameter in your AdminCreateUser request. In your function code in AWS Lambda , you can process the `clientMetadata` value to enhance your workflow for your specific needs. For more information, see [Customizing user pool Workflows with Lambda Triggers](https://docs.aws.amazon.com/cognito/latest/developerguide/cognito-user-identity-pools-working-with-aws-lambda-triggers.html) in the *Amazon Cognito Developer Guide* . - > When you use the ClientMetadata parameter, remember that Amazon Cognito won't do the following: + > When you use the `ClientMetadata` parameter, note that Amazon Cognito won't do the following: > - > - Store the ClientMetadata value. This data is available only to AWS Lambda triggers that are assigned to a user pool to support custom workflows. If your user pool configuration doesn't include triggers, the ClientMetadata parameter serves no purpose. - > - Validate the ClientMetadata value. - > - Encrypt the ClientMetadata value. Don't use Amazon Cognito to provide sensitive information. - :param pulumi.Input[Sequence[pulumi.Input[str]]] desired_delivery_mediums: Specify `"EMAIL"` if email will be used to send the welcome message. Specify `"SMS"` if the phone number will be used. The default value is `"SMS"` . You can specify more than one value. + > - Store the `ClientMetadata` value. This data is available only to AWS Lambda triggers that are assigned to a user pool to support custom workflows. If your user pool configuration doesn't include triggers, the `ClientMetadata` parameter serves no purpose. + > - Validate the `ClientMetadata` value. + > - Encrypt the `ClientMetadata` value. Don't send sensitive information in this parameter. + :param pulumi.Input[Sequence[pulumi.Input[str]]] desired_delivery_mediums: Specify `EMAIL` if email will be used to send the welcome message. Specify `SMS` if the phone number will be used. The default value is `SMS` . You can specify more than one value. :param pulumi.Input[bool] force_alias_creation: This parameter is used only if the `phone_number_verified` or `email_verified` attribute is set to `True` . Otherwise, it is ignored. - If this parameter is set to `True` and the phone number or email address specified in the UserAttributes parameter already exists as an alias with a different user, the API call will migrate the alias from the previous user to the newly created user. The previous user will no longer be able to log in using that alias. + If this parameter is set to `True` and the phone number or email address specified in the `UserAttributes` parameter already exists as an alias with a different user, this request migrates the alias from the previous user to the newly-created user. The previous user will no longer be able to log in using that alias. If this parameter is set to `False` , the API throws an `AliasExistsException` error if the alias already exists. The default value is `False` . - :param pulumi.Input[str] message_action: Set to `RESEND` to resend the invitation message to a user that already exists and reset the expiration limit on the user's account. Set to `SUPPRESS` to suppress sending the message. You can specify only one value. + :param pulumi.Input[str] message_action: Set to `RESEND` to resend the invitation message to a user that already exists, and to reset the temporary-password duration with a new temporary password. Set to `SUPPRESS` to suppress sending the message. You can specify only one value. :param pulumi.Input[Sequence[pulumi.Input['UserPoolUserAttributeTypeArgs']]] user_attributes: An array of name-value pairs that contain user attributes and attribute values to be set for the user to be created. You can create a user without specifying any attributes other than `Username` . However, any attributes that you specify as required (when creating a user pool or in the *Attributes* tab of the console) either you should supply (in your call to `AdminCreateUser` ) or the user should supply (when they sign up in response to your welcome message). For custom attributes, you must prepend the `custom:` prefix to the attribute name. @@ -93,7 +93,7 @@ def __init__(__self__, *, @pulumi.getter(name="userPoolId") def user_pool_id(self) -> pulumi.Input[str]: """ - The user pool ID for the user pool where the user will be created. + The ID of the user pool where you want to create a user. """ return pulumi.get(self, "user_pool_id") @@ -107,15 +107,15 @@ def client_metadata(self) -> Optional[pulumi.Input[Mapping[str, pulumi.Input[str """ A map of custom key-value pairs that you can provide as input for any custom workflows that this action triggers. - You create custom workflows by assigning AWS Lambda functions to user pool triggers. When you use the AdminCreateUser API action, Amazon Cognito invokes the function that is assigned to the *pre sign-up* trigger. When Amazon Cognito invokes this function, it passes a JSON payload, which the function receives as input. This payload contains a `clientMetadata` attribute, which provides the data that you assigned to the ClientMetadata parameter in your AdminCreateUser request. In your function code in AWS Lambda , you can process the `clientMetadata` value to enhance your workflow for your specific needs. + You create custom workflows by assigning AWS Lambda functions to user pool triggers. When you use the AdminCreateUser API action, Amazon Cognito invokes the function that is assigned to the *pre sign-up* trigger. When Amazon Cognito invokes this function, it passes a JSON payload, which the function receives as input. This payload contains a `ClientMetadata` attribute, which provides the data that you assigned to the ClientMetadata parameter in your AdminCreateUser request. In your function code in AWS Lambda , you can process the `clientMetadata` value to enhance your workflow for your specific needs. For more information, see [Customizing user pool Workflows with Lambda Triggers](https://docs.aws.amazon.com/cognito/latest/developerguide/cognito-user-identity-pools-working-with-aws-lambda-triggers.html) in the *Amazon Cognito Developer Guide* . - > When you use the ClientMetadata parameter, remember that Amazon Cognito won't do the following: + > When you use the `ClientMetadata` parameter, note that Amazon Cognito won't do the following: > - > - Store the ClientMetadata value. This data is available only to AWS Lambda triggers that are assigned to a user pool to support custom workflows. If your user pool configuration doesn't include triggers, the ClientMetadata parameter serves no purpose. - > - Validate the ClientMetadata value. - > - Encrypt the ClientMetadata value. Don't use Amazon Cognito to provide sensitive information. + > - Store the `ClientMetadata` value. This data is available only to AWS Lambda triggers that are assigned to a user pool to support custom workflows. If your user pool configuration doesn't include triggers, the `ClientMetadata` parameter serves no purpose. + > - Validate the `ClientMetadata` value. + > - Encrypt the `ClientMetadata` value. Don't send sensitive information in this parameter. """ return pulumi.get(self, "client_metadata") @@ -127,7 +127,7 @@ def client_metadata(self, value: Optional[pulumi.Input[Mapping[str, pulumi.Input @pulumi.getter(name="desiredDeliveryMediums") def desired_delivery_mediums(self) -> Optional[pulumi.Input[Sequence[pulumi.Input[str]]]]: """ - Specify `"EMAIL"` if email will be used to send the welcome message. Specify `"SMS"` if the phone number will be used. The default value is `"SMS"` . You can specify more than one value. + Specify `EMAIL` if email will be used to send the welcome message. Specify `SMS` if the phone number will be used. The default value is `SMS` . You can specify more than one value. """ return pulumi.get(self, "desired_delivery_mediums") @@ -141,7 +141,7 @@ def force_alias_creation(self) -> Optional[pulumi.Input[bool]]: """ This parameter is used only if the `phone_number_verified` or `email_verified` attribute is set to `True` . Otherwise, it is ignored. - If this parameter is set to `True` and the phone number or email address specified in the UserAttributes parameter already exists as an alias with a different user, the API call will migrate the alias from the previous user to the newly created user. The previous user will no longer be able to log in using that alias. + If this parameter is set to `True` and the phone number or email address specified in the `UserAttributes` parameter already exists as an alias with a different user, this request migrates the alias from the previous user to the newly-created user. The previous user will no longer be able to log in using that alias. If this parameter is set to `False` , the API throws an `AliasExistsException` error if the alias already exists. The default value is `False` . """ @@ -155,7 +155,7 @@ def force_alias_creation(self, value: Optional[pulumi.Input[bool]]): @pulumi.getter(name="messageAction") def message_action(self) -> Optional[pulumi.Input[str]]: """ - Set to `RESEND` to resend the invitation message to a user that already exists and reset the expiration limit on the user's account. Set to `SUPPRESS` to suppress sending the message. You can specify only one value. + Set to `RESEND` to resend the invitation message to a user that already exists, and to reset the temporary-password duration with a new temporary password. Set to `SUPPRESS` to suppress sending the message. You can specify only one value. """ return pulumi.get(self, "message_action") @@ -240,22 +240,22 @@ def __init__(__self__, :param pulumi.ResourceOptions opts: Options for the resource. :param pulumi.Input[Mapping[str, pulumi.Input[str]]] client_metadata: A map of custom key-value pairs that you can provide as input for any custom workflows that this action triggers. - You create custom workflows by assigning AWS Lambda functions to user pool triggers. When you use the AdminCreateUser API action, Amazon Cognito invokes the function that is assigned to the *pre sign-up* trigger. When Amazon Cognito invokes this function, it passes a JSON payload, which the function receives as input. This payload contains a `clientMetadata` attribute, which provides the data that you assigned to the ClientMetadata parameter in your AdminCreateUser request. In your function code in AWS Lambda , you can process the `clientMetadata` value to enhance your workflow for your specific needs. + You create custom workflows by assigning AWS Lambda functions to user pool triggers. When you use the AdminCreateUser API action, Amazon Cognito invokes the function that is assigned to the *pre sign-up* trigger. When Amazon Cognito invokes this function, it passes a JSON payload, which the function receives as input. This payload contains a `ClientMetadata` attribute, which provides the data that you assigned to the ClientMetadata parameter in your AdminCreateUser request. In your function code in AWS Lambda , you can process the `clientMetadata` value to enhance your workflow for your specific needs. For more information, see [Customizing user pool Workflows with Lambda Triggers](https://docs.aws.amazon.com/cognito/latest/developerguide/cognito-user-identity-pools-working-with-aws-lambda-triggers.html) in the *Amazon Cognito Developer Guide* . - > When you use the ClientMetadata parameter, remember that Amazon Cognito won't do the following: + > When you use the `ClientMetadata` parameter, note that Amazon Cognito won't do the following: > - > - Store the ClientMetadata value. This data is available only to AWS Lambda triggers that are assigned to a user pool to support custom workflows. If your user pool configuration doesn't include triggers, the ClientMetadata parameter serves no purpose. - > - Validate the ClientMetadata value. - > - Encrypt the ClientMetadata value. Don't use Amazon Cognito to provide sensitive information. - :param pulumi.Input[Sequence[pulumi.Input[str]]] desired_delivery_mediums: Specify `"EMAIL"` if email will be used to send the welcome message. Specify `"SMS"` if the phone number will be used. The default value is `"SMS"` . You can specify more than one value. + > - Store the `ClientMetadata` value. This data is available only to AWS Lambda triggers that are assigned to a user pool to support custom workflows. If your user pool configuration doesn't include triggers, the `ClientMetadata` parameter serves no purpose. + > - Validate the `ClientMetadata` value. + > - Encrypt the `ClientMetadata` value. Don't send sensitive information in this parameter. + :param pulumi.Input[Sequence[pulumi.Input[str]]] desired_delivery_mediums: Specify `EMAIL` if email will be used to send the welcome message. Specify `SMS` if the phone number will be used. The default value is `SMS` . You can specify more than one value. :param pulumi.Input[bool] force_alias_creation: This parameter is used only if the `phone_number_verified` or `email_verified` attribute is set to `True` . Otherwise, it is ignored. - If this parameter is set to `True` and the phone number or email address specified in the UserAttributes parameter already exists as an alias with a different user, the API call will migrate the alias from the previous user to the newly created user. The previous user will no longer be able to log in using that alias. + If this parameter is set to `True` and the phone number or email address specified in the `UserAttributes` parameter already exists as an alias with a different user, this request migrates the alias from the previous user to the newly-created user. The previous user will no longer be able to log in using that alias. If this parameter is set to `False` , the API throws an `AliasExistsException` error if the alias already exists. The default value is `False` . - :param pulumi.Input[str] message_action: Set to `RESEND` to resend the invitation message to a user that already exists and reset the expiration limit on the user's account. Set to `SUPPRESS` to suppress sending the message. You can specify only one value. + :param pulumi.Input[str] message_action: Set to `RESEND` to resend the invitation message to a user that already exists, and to reset the temporary-password duration with a new temporary password. Set to `SUPPRESS` to suppress sending the message. You can specify only one value. :param pulumi.Input[Sequence[pulumi.Input[Union['UserPoolUserAttributeTypeArgs', 'UserPoolUserAttributeTypeArgsDict']]]] user_attributes: An array of name-value pairs that contain user attributes and attribute values to be set for the user to be created. You can create a user without specifying any attributes other than `Username` . However, any attributes that you specify as required (when creating a user pool or in the *Attributes* tab of the console) either you should supply (in your call to `AdminCreateUser` ) or the user should supply (when they sign up in response to your welcome message). For custom attributes, you must prepend the `custom:` prefix to the attribute name. @@ -268,7 +268,7 @@ def __init__(__self__, - *email* : The email address of the user to whom the message that contains the code and username will be sent. Required if the `email_verified` attribute is set to `True` , or if `"EMAIL"` is specified in the `DesiredDeliveryMediums` parameter. - *phone_number* : The phone number of the user to whom the message that contains the code and username will be sent. Required if the `phone_number_verified` attribute is set to `True` , or if `"SMS"` is specified in the `DesiredDeliveryMediums` parameter. - :param pulumi.Input[str] user_pool_id: The user pool ID for the user pool where the user will be created. + :param pulumi.Input[str] user_pool_id: The ID of the user pool where you want to create a user. :param pulumi.Input[str] username: The value that you want to set as the username sign-in attribute. The following conditions apply to the username parameter. - The username can't be a duplicate of another username in the same user pool. @@ -371,15 +371,15 @@ def client_metadata(self) -> pulumi.Output[Optional[Mapping[str, str]]]: """ A map of custom key-value pairs that you can provide as input for any custom workflows that this action triggers. - You create custom workflows by assigning AWS Lambda functions to user pool triggers. When you use the AdminCreateUser API action, Amazon Cognito invokes the function that is assigned to the *pre sign-up* trigger. When Amazon Cognito invokes this function, it passes a JSON payload, which the function receives as input. This payload contains a `clientMetadata` attribute, which provides the data that you assigned to the ClientMetadata parameter in your AdminCreateUser request. In your function code in AWS Lambda , you can process the `clientMetadata` value to enhance your workflow for your specific needs. + You create custom workflows by assigning AWS Lambda functions to user pool triggers. When you use the AdminCreateUser API action, Amazon Cognito invokes the function that is assigned to the *pre sign-up* trigger. When Amazon Cognito invokes this function, it passes a JSON payload, which the function receives as input. This payload contains a `ClientMetadata` attribute, which provides the data that you assigned to the ClientMetadata parameter in your AdminCreateUser request. In your function code in AWS Lambda , you can process the `clientMetadata` value to enhance your workflow for your specific needs. For more information, see [Customizing user pool Workflows with Lambda Triggers](https://docs.aws.amazon.com/cognito/latest/developerguide/cognito-user-identity-pools-working-with-aws-lambda-triggers.html) in the *Amazon Cognito Developer Guide* . - > When you use the ClientMetadata parameter, remember that Amazon Cognito won't do the following: + > When you use the `ClientMetadata` parameter, note that Amazon Cognito won't do the following: > - > - Store the ClientMetadata value. This data is available only to AWS Lambda triggers that are assigned to a user pool to support custom workflows. If your user pool configuration doesn't include triggers, the ClientMetadata parameter serves no purpose. - > - Validate the ClientMetadata value. - > - Encrypt the ClientMetadata value. Don't use Amazon Cognito to provide sensitive information. + > - Store the `ClientMetadata` value. This data is available only to AWS Lambda triggers that are assigned to a user pool to support custom workflows. If your user pool configuration doesn't include triggers, the `ClientMetadata` parameter serves no purpose. + > - Validate the `ClientMetadata` value. + > - Encrypt the `ClientMetadata` value. Don't send sensitive information in this parameter. """ return pulumi.get(self, "client_metadata") @@ -387,7 +387,7 @@ def client_metadata(self) -> pulumi.Output[Optional[Mapping[str, str]]]: @pulumi.getter(name="desiredDeliveryMediums") def desired_delivery_mediums(self) -> pulumi.Output[Optional[Sequence[str]]]: """ - Specify `"EMAIL"` if email will be used to send the welcome message. Specify `"SMS"` if the phone number will be used. The default value is `"SMS"` . You can specify more than one value. + Specify `EMAIL` if email will be used to send the welcome message. Specify `SMS` if the phone number will be used. The default value is `SMS` . You can specify more than one value. """ return pulumi.get(self, "desired_delivery_mediums") @@ -397,7 +397,7 @@ def force_alias_creation(self) -> pulumi.Output[Optional[bool]]: """ This parameter is used only if the `phone_number_verified` or `email_verified` attribute is set to `True` . Otherwise, it is ignored. - If this parameter is set to `True` and the phone number or email address specified in the UserAttributes parameter already exists as an alias with a different user, the API call will migrate the alias from the previous user to the newly created user. The previous user will no longer be able to log in using that alias. + If this parameter is set to `True` and the phone number or email address specified in the `UserAttributes` parameter already exists as an alias with a different user, this request migrates the alias from the previous user to the newly-created user. The previous user will no longer be able to log in using that alias. If this parameter is set to `False` , the API throws an `AliasExistsException` error if the alias already exists. The default value is `False` . """ @@ -407,7 +407,7 @@ def force_alias_creation(self) -> pulumi.Output[Optional[bool]]: @pulumi.getter(name="messageAction") def message_action(self) -> pulumi.Output[Optional[str]]: """ - Set to `RESEND` to resend the invitation message to a user that already exists and reset the expiration limit on the user's account. Set to `SUPPRESS` to suppress sending the message. You can specify only one value. + Set to `RESEND` to resend the invitation message to a user that already exists, and to reset the temporary-password duration with a new temporary password. Set to `SUPPRESS` to suppress sending the message. You can specify only one value. """ return pulumi.get(self, "message_action") @@ -434,7 +434,7 @@ def user_attributes(self) -> pulumi.Output[Optional[Sequence['outputs.UserPoolUs @pulumi.getter(name="userPoolId") def user_pool_id(self) -> pulumi.Output[str]: """ - The user pool ID for the user pool where the user will be created. + The ID of the user pool where you want to create a user. """ return pulumi.get(self, "user_pool_id") diff --git a/sdk/python/pulumi_aws_native/cognito/user_pool_user_to_group_attachment.py b/sdk/python/pulumi_aws_native/cognito/user_pool_user_to_group_attachment.py index b14f123d7a..c64db5b22e 100644 --- a/sdk/python/pulumi_aws_native/cognito/user_pool_user_to_group_attachment.py +++ b/sdk/python/pulumi_aws_native/cognito/user_pool_user_to_group_attachment.py @@ -25,7 +25,7 @@ def __init__(__self__, *, """ The set of arguments for constructing a UserPoolUserToGroupAttachment resource. :param pulumi.Input[str] group_name: The name of the group that you want to add your user to. - :param pulumi.Input[str] user_pool_id: The user pool ID for the user pool. + :param pulumi.Input[str] user_pool_id: The ID of the user pool that contains the group that you want to add the user to. :param pulumi.Input[str] username: The user's username. """ pulumi.set(__self__, "group_name", group_name) @@ -48,7 +48,7 @@ def group_name(self, value: pulumi.Input[str]): @pulumi.getter(name="userPoolId") def user_pool_id(self) -> pulumi.Input[str]: """ - The user pool ID for the user pool. + The ID of the user pool that contains the group that you want to add the user to. """ return pulumi.get(self, "user_pool_id") @@ -84,7 +84,7 @@ def __init__(__self__, :param str resource_name: The name of the resource. :param pulumi.ResourceOptions opts: Options for the resource. :param pulumi.Input[str] group_name: The name of the group that you want to add your user to. - :param pulumi.Input[str] user_pool_id: The user pool ID for the user pool. + :param pulumi.Input[str] user_pool_id: The ID of the user pool that contains the group that you want to add the user to. :param pulumi.Input[str] username: The user's username. """ ... @@ -173,7 +173,7 @@ def group_name(self) -> pulumi.Output[str]: @pulumi.getter(name="userPoolId") def user_pool_id(self) -> pulumi.Output[str]: """ - The user pool ID for the user pool. + The ID of the user pool that contains the group that you want to add the user to. """ return pulumi.get(self, "user_pool_id") diff --git a/sdk/python/pulumi_aws_native/connect/get_task_template.py b/sdk/python/pulumi_aws_native/connect/get_task_template.py index 043bdebedf..1b94b06c35 100644 --- a/sdk/python/pulumi_aws_native/connect/get_task_template.py +++ b/sdk/python/pulumi_aws_native/connect/get_task_template.py @@ -26,7 +26,7 @@ @pulumi.output_type class GetTaskTemplateResult: - def __init__(__self__, arn=None, client_token=None, constraints=None, contact_flow_arn=None, defaults=None, description=None, fields=None, instance_arn=None, name=None, status=None, tags=None): + def __init__(__self__, arn=None, client_token=None, constraints=None, contact_flow_arn=None, defaults=None, description=None, fields=None, instance_arn=None, name=None, self_assign_contact_flow_arn=None, status=None, tags=None): if arn and not isinstance(arn, str): raise TypeError("Expected argument 'arn' to be a str") pulumi.set(__self__, "arn", arn) @@ -54,6 +54,9 @@ def __init__(__self__, arn=None, client_token=None, constraints=None, contact_fl if name and not isinstance(name, str): raise TypeError("Expected argument 'name' to be a str") pulumi.set(__self__, "name", name) + if self_assign_contact_flow_arn and not isinstance(self_assign_contact_flow_arn, str): + raise TypeError("Expected argument 'self_assign_contact_flow_arn' to be a str") + pulumi.set(__self__, "self_assign_contact_flow_arn", self_assign_contact_flow_arn) if status and not isinstance(status, str): raise TypeError("Expected argument 'status' to be a str") pulumi.set(__self__, "status", status) @@ -133,6 +136,14 @@ def name(self) -> Optional[str]: """ return pulumi.get(self, "name") + @property + @pulumi.getter(name="selfAssignContactFlowArn") + def self_assign_contact_flow_arn(self) -> Optional[str]: + """ + The identifier of the contact flow. + """ + return pulumi.get(self, "self_assign_contact_flow_arn") + @property @pulumi.getter def status(self) -> Optional['TaskTemplateStatus']: @@ -165,6 +176,7 @@ def __await__(self): fields=self.fields, instance_arn=self.instance_arn, name=self.name, + self_assign_contact_flow_arn=self.self_assign_contact_flow_arn, status=self.status, tags=self.tags) @@ -192,6 +204,7 @@ def get_task_template(arn: Optional[str] = None, fields=pulumi.get(__ret__, 'fields'), instance_arn=pulumi.get(__ret__, 'instance_arn'), name=pulumi.get(__ret__, 'name'), + self_assign_contact_flow_arn=pulumi.get(__ret__, 'self_assign_contact_flow_arn'), status=pulumi.get(__ret__, 'status'), tags=pulumi.get(__ret__, 'tags')) def get_task_template_output(arn: Optional[pulumi.Input[str]] = None, @@ -216,5 +229,6 @@ def get_task_template_output(arn: Optional[pulumi.Input[str]] = None, fields=pulumi.get(__response__, 'fields'), instance_arn=pulumi.get(__response__, 'instance_arn'), name=pulumi.get(__response__, 'name'), + self_assign_contact_flow_arn=pulumi.get(__response__, 'self_assign_contact_flow_arn'), status=pulumi.get(__response__, 'status'), tags=pulumi.get(__response__, 'tags'))) diff --git a/sdk/python/pulumi_aws_native/connect/task_template.py b/sdk/python/pulumi_aws_native/connect/task_template.py index 8e4a9239be..fa1e79cb51 100644 --- a/sdk/python/pulumi_aws_native/connect/task_template.py +++ b/sdk/python/pulumi_aws_native/connect/task_template.py @@ -32,6 +32,7 @@ def __init__(__self__, *, description: Optional[pulumi.Input[str]] = None, fields: Optional[pulumi.Input[Sequence[pulumi.Input['TaskTemplateFieldArgs']]]] = None, name: Optional[pulumi.Input[str]] = None, + self_assign_contact_flow_arn: Optional[pulumi.Input[str]] = None, status: Optional[pulumi.Input['TaskTemplateStatus']] = None, tags: Optional[pulumi.Input[Sequence[pulumi.Input['_root_inputs.TagArgs']]]] = None): """ @@ -44,6 +45,7 @@ def __init__(__self__, *, :param pulumi.Input[str] description: The description of the task template. :param pulumi.Input[Sequence[pulumi.Input['TaskTemplateFieldArgs']]] fields: The list of task template's fields :param pulumi.Input[str] name: The name of the task template. + :param pulumi.Input[str] self_assign_contact_flow_arn: The identifier of the contact flow. :param pulumi.Input['TaskTemplateStatus'] status: The status of the task template. :param pulumi.Input[Sequence[pulumi.Input['_root_inputs.TagArgs']]] tags: One or more tags. """ @@ -62,6 +64,8 @@ def __init__(__self__, *, pulumi.set(__self__, "fields", fields) if name is not None: pulumi.set(__self__, "name", name) + if self_assign_contact_flow_arn is not None: + pulumi.set(__self__, "self_assign_contact_flow_arn", self_assign_contact_flow_arn) if status is not None: pulumi.set(__self__, "status", status) if tags is not None: @@ -163,6 +167,18 @@ def name(self) -> Optional[pulumi.Input[str]]: def name(self, value: Optional[pulumi.Input[str]]): pulumi.set(self, "name", value) + @property + @pulumi.getter(name="selfAssignContactFlowArn") + def self_assign_contact_flow_arn(self) -> Optional[pulumi.Input[str]]: + """ + The identifier of the contact flow. + """ + return pulumi.get(self, "self_assign_contact_flow_arn") + + @self_assign_contact_flow_arn.setter + def self_assign_contact_flow_arn(self, value: Optional[pulumi.Input[str]]): + pulumi.set(self, "self_assign_contact_flow_arn", value) + @property @pulumi.getter def status(self) -> Optional[pulumi.Input['TaskTemplateStatus']]: @@ -201,6 +217,7 @@ def __init__(__self__, fields: Optional[pulumi.Input[Sequence[pulumi.Input[Union['TaskTemplateFieldArgs', 'TaskTemplateFieldArgsDict']]]]] = None, instance_arn: Optional[pulumi.Input[str]] = None, name: Optional[pulumi.Input[str]] = None, + self_assign_contact_flow_arn: Optional[pulumi.Input[str]] = None, status: Optional[pulumi.Input['TaskTemplateStatus']] = None, tags: Optional[pulumi.Input[Sequence[pulumi.Input[Union['_root_inputs.TagArgs', '_root_inputs.TagArgsDict']]]]] = None, __props__=None): @@ -217,6 +234,7 @@ def __init__(__self__, :param pulumi.Input[Sequence[pulumi.Input[Union['TaskTemplateFieldArgs', 'TaskTemplateFieldArgsDict']]]] fields: The list of task template's fields :param pulumi.Input[str] instance_arn: The identifier (arn) of the instance. :param pulumi.Input[str] name: The name of the task template. + :param pulumi.Input[str] self_assign_contact_flow_arn: The identifier of the contact flow. :param pulumi.Input['TaskTemplateStatus'] status: The status of the task template. :param pulumi.Input[Sequence[pulumi.Input[Union['_root_inputs.TagArgs', '_root_inputs.TagArgsDict']]]] tags: One or more tags. """ @@ -252,6 +270,7 @@ def _internal_init(__self__, fields: Optional[pulumi.Input[Sequence[pulumi.Input[Union['TaskTemplateFieldArgs', 'TaskTemplateFieldArgsDict']]]]] = None, instance_arn: Optional[pulumi.Input[str]] = None, name: Optional[pulumi.Input[str]] = None, + self_assign_contact_flow_arn: Optional[pulumi.Input[str]] = None, status: Optional[pulumi.Input['TaskTemplateStatus']] = None, tags: Optional[pulumi.Input[Sequence[pulumi.Input[Union['_root_inputs.TagArgs', '_root_inputs.TagArgsDict']]]]] = None, __props__=None): @@ -273,6 +292,7 @@ def _internal_init(__self__, raise TypeError("Missing required property 'instance_arn'") __props__.__dict__["instance_arn"] = instance_arn __props__.__dict__["name"] = name + __props__.__dict__["self_assign_contact_flow_arn"] = self_assign_contact_flow_arn __props__.__dict__["status"] = status __props__.__dict__["tags"] = tags __props__.__dict__["arn"] = None @@ -307,6 +327,7 @@ def get(resource_name: str, __props__.__dict__["fields"] = None __props__.__dict__["instance_arn"] = None __props__.__dict__["name"] = None + __props__.__dict__["self_assign_contact_flow_arn"] = None __props__.__dict__["status"] = None __props__.__dict__["tags"] = None return TaskTemplate(resource_name, opts=opts, __props__=__props__) @@ -383,6 +404,14 @@ def name(self) -> pulumi.Output[Optional[str]]: """ return pulumi.get(self, "name") + @property + @pulumi.getter(name="selfAssignContactFlowArn") + def self_assign_contact_flow_arn(self) -> pulumi.Output[Optional[str]]: + """ + The identifier of the contact flow. + """ + return pulumi.get(self, "self_assign_contact_flow_arn") + @property @pulumi.getter def status(self) -> pulumi.Output[Optional['TaskTemplateStatus']]: diff --git a/sdk/python/pulumi_aws_native/dynamodb/table.py b/sdk/python/pulumi_aws_native/dynamodb/table.py index 09d7743f13..e6814f5884 100644 --- a/sdk/python/pulumi_aws_native/dynamodb/table.py +++ b/sdk/python/pulumi_aws_native/dynamodb/table.py @@ -64,8 +64,8 @@ def __init__(__self__, *, Updates are not supported. The following are exceptions: + If you update either the contributor insights specification or the provisioned throughput values of global secondary indexes, you can update the table without interruption. + You can delete or add one global secondary index without interruption. If you do both in the same update (for example, by changing the index's logical ID), the update fails. - :param pulumi.Input['TableImportSourceSpecificationArgs'] import_source_specification: Specifies the properties of data being imported from the S3 bucket source to the table. - 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. + :param pulumi.Input['TableImportSourceSpecificationArgs'] import_source_specification: Specifies the properties of data being imported from the S3 bucket source to the" table. + 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. :param pulumi.Input['TableKinesisStreamSpecificationArgs'] kinesis_stream_specification: The Kinesis Data Streams configuration for the specified table. :param pulumi.Input[Sequence[pulumi.Input['TableLocalSecondaryIndexArgs']]] local_secondary_indexes: Local secondary indexes to be created on the table. You can create up to 5 local secondary indexes. Each index is scoped to a given hash key value. The size of each hash key can be up to 10 gigabytes. :param pulumi.Input['TableOnDemandThroughputArgs'] on_demand_throughput: Sets the maximum number of read and write units for the specified on-demand table. If you use this property, you must specify ``MaxReadRequestUnits``, ``MaxWriteRequestUnits``, or both. @@ -213,8 +213,8 @@ def global_secondary_indexes(self, value: Optional[pulumi.Input[Sequence[pulumi. @pulumi.getter(name="importSourceSpecification") def import_source_specification(self) -> Optional[pulumi.Input['TableImportSourceSpecificationArgs']]: """ - Specifies the properties of data being imported from the S3 bucket source to the table. - 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. + Specifies the properties of data being imported from the S3 bucket source to the" table. + 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. """ return pulumi.get(self, "import_source_specification") @@ -662,8 +662,8 @@ def __init__(__self__, Updates are not supported. The following are exceptions: + If you update either the contributor insights specification or the provisioned throughput values of global secondary indexes, you can update the table without interruption. + You can delete or add one global secondary index without interruption. If you do both in the same update (for example, by changing the index's logical ID), the update fails. - :param pulumi.Input[Union['TableImportSourceSpecificationArgs', 'TableImportSourceSpecificationArgsDict']] import_source_specification: Specifies the properties of data being imported from the S3 bucket source to the table. - 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. + :param pulumi.Input[Union['TableImportSourceSpecificationArgs', 'TableImportSourceSpecificationArgsDict']] import_source_specification: Specifies the properties of data being imported from the S3 bucket source to the" table. + 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. :param pulumi.Input[Union[Sequence[pulumi.Input[Union['TableKeySchemaArgs', 'TableKeySchemaArgsDict']]], Any]] key_schema: Specifies the attributes that make up the primary key for the table. The attributes in the ``KeySchema`` property must also be defined in the ``AttributeDefinitions`` property. :param pulumi.Input[Union['TableKinesisStreamSpecificationArgs', 'TableKinesisStreamSpecificationArgsDict']] kinesis_stream_specification: The Kinesis Data Streams configuration for the specified table. :param pulumi.Input[Sequence[pulumi.Input[Union['TableLocalSecondaryIndexArgs', 'TableLocalSecondaryIndexArgsDict']]]] local_secondary_indexes: Local secondary indexes to be created on the table. You can create up to 5 local secondary indexes. Each index is scoped to a given hash key value. The size of each hash key can be up to 10 gigabytes. @@ -1103,8 +1103,8 @@ def global_secondary_indexes(self) -> pulumi.Output[Optional[Sequence['outputs.T @pulumi.getter(name="importSourceSpecification") def import_source_specification(self) -> pulumi.Output[Optional['outputs.TableImportSourceSpecification']]: """ - Specifies the properties of data being imported from the S3 bucket source to the table. - 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. + Specifies the properties of data being imported from the S3 bucket source to the" table. + 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. """ return pulumi.get(self, "import_source_specification") diff --git a/sdk/python/pulumi_aws_native/ec2/_inputs.py b/sdk/python/pulumi_aws_native/ec2/_inputs.py index 77d1dad358..1c65caf8d9 100644 --- a/sdk/python/pulumi_aws_native/ec2/_inputs.py +++ b/sdk/python/pulumi_aws_native/ec2/_inputs.py @@ -5167,10 +5167,6 @@ def min(self, value: Optional[pulumi.Input[int]]): if not MYPY: class LaunchTemplateBaselinePerformanceFactorsArgsDict(TypedDict): - """ - The baseline performance to consider, using an instance family as a baseline reference. The instance family establishes the lowest acceptable level of performance. Amazon EC2 uses this baseline to guide instance type selection, but there is no guarantee that the selected instance types will always exceed the baseline for every application. - Currently, this parameter only supports CPU performance as a baseline performance factor. For example, specifying ``c6i`` would use the CPU performance of the ``c6i`` family as the baseline reference. - """ cpu: NotRequired[pulumi.Input['LaunchTemplateCpuArgsDict']] """ The CPU performance to consider, using an instance family as the baseline reference. @@ -5183,8 +5179,6 @@ class LaunchTemplateBaselinePerformanceFactorsArgs: def __init__(__self__, *, cpu: Optional[pulumi.Input['LaunchTemplateCpuArgs']] = None): """ - The baseline performance to consider, using an instance family as a baseline reference. The instance family establishes the lowest acceptable level of performance. Amazon EC2 uses this baseline to guide instance type selection, but there is no guarantee that the selected instance types will always exceed the baseline for every application. - Currently, this parameter only supports CPU performance as a baseline performance factor. For example, specifying ``c6i`` would use the CPU performance of the ``c6i`` family as the baseline reference. :param pulumi.Input['LaunchTemplateCpuArgs'] cpu: The CPU performance to consider, using an instance family as the baseline reference. """ if cpu is not None: @@ -5310,8 +5304,7 @@ class LaunchTemplateCapacityReservationSpecificationArgsDict(TypedDict): capacity_reservation_preference: NotRequired[pulumi.Input[str]] """ Indicates the instance's Capacity Reservation preferences. Possible preferences include: - + ``capacity-reservations-only`` - The instance will only run in a Capacity Reservation or Capacity Reservation group. If capacity isn't available, the instance will fail to launch. - + ``open`` - The instance can run in any ``open`` Capacity Reservation that has matching attributes (instance type, platform, Availability Zone, tenancy). + + ``open`` - The instance can run in any ``open`` Capacity Reservation that has matching attributes (instance type, platform, Availability Zone). + ``none`` - The instance avoids running in a Capacity Reservation even if one is available. The instance runs in On-Demand capacity. """ capacity_reservation_target: NotRequired[pulumi.Input['LaunchTemplateCapacityReservationTargetArgsDict']] @@ -5330,8 +5323,7 @@ def __init__(__self__, *, Specifies an instance's Capacity Reservation targeting option. You can specify only one option at a time. ``CapacityReservationSpecification`` is a property of [AWS::EC2::LaunchTemplate LaunchTemplateData](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-launchtemplate-launchtemplatedata.html). :param pulumi.Input[str] capacity_reservation_preference: Indicates the instance's Capacity Reservation preferences. Possible preferences include: - + ``capacity-reservations-only`` - The instance will only run in a Capacity Reservation or Capacity Reservation group. If capacity isn't available, the instance will fail to launch. - + ``open`` - The instance can run in any ``open`` Capacity Reservation that has matching attributes (instance type, platform, Availability Zone, tenancy). + + ``open`` - The instance can run in any ``open`` Capacity Reservation that has matching attributes (instance type, platform, Availability Zone). + ``none`` - The instance avoids running in a Capacity Reservation even if one is available. The instance runs in On-Demand capacity. :param pulumi.Input['LaunchTemplateCapacityReservationTargetArgs'] capacity_reservation_target: Information about the target Capacity Reservation or Capacity Reservation group. """ @@ -5345,8 +5337,7 @@ def __init__(__self__, *, def capacity_reservation_preference(self) -> Optional[pulumi.Input[str]]: """ Indicates the instance's Capacity Reservation preferences. Possible preferences include: - + ``capacity-reservations-only`` - The instance will only run in a Capacity Reservation or Capacity Reservation group. If capacity isn't available, the instance will fail to launch. - + ``open`` - The instance can run in any ``open`` Capacity Reservation that has matching attributes (instance type, platform, Availability Zone, tenancy). + + ``open`` - The instance can run in any ``open`` Capacity Reservation that has matching attributes (instance type, platform, Availability Zone). + ``none`` - The instance avoids running in a Capacity Reservation even if one is available. The instance runs in On-Demand capacity. """ return pulumi.get(self, "capacity_reservation_preference") @@ -5685,8 +5676,7 @@ class LaunchTemplateDataArgsDict(TypedDict): """ elastic_inference_accelerators: NotRequired[pulumi.Input[Sequence[pulumi.Input['LaunchTemplateElasticInferenceAcceleratorArgsDict']]]] """ - Amazon Elastic Inference is no longer available. - An elastic inference accelerator to associate with the instance. Elastic inference accelerators are a resource you can attach to your Amazon EC2 instances to accelerate your Deep Learning (DL) inference workloads. + An elastic inference accelerator to associate with the instance. Elastic inference accelerators are a resource you can attach to your Amazon EC2 instances to accelerate your Deep Learning (DL) inference workloads. You cannot specify accelerators from different generations in the same request. Starting April 15, 2023, AWS will not onboard new customers to Amazon Elastic Inference (EI), and will help current customers migrate their workloads to options that offer better price and performance. After April 15, 2023, new customers will not be able to launch instances with Amazon EI accelerators in Amazon SageMaker, Amazon ECS, or Amazon EC2. However, customers who have used Amazon EI at least once during the past 30-day period are considered current customers and will be able to continue using the service. """ @@ -5734,7 +5724,7 @@ class LaunchTemplateDataArgsDict(TypedDict): If you specify ``InstanceRequirements``, you can't specify ``InstanceType``. Attribute-based instance type selection is only supported when using Auto Scaling groups, EC2 Fleet, and Spot Fleet to launch instances. If you plan to use the launch template in the [launch instance wizard](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ec2-launch-instance-wizard.html), or with the [RunInstances](https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_RunInstances.html) API or [AWS::EC2::Instance](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-instance.html) AWS CloudFormation resource, you can't specify ``InstanceRequirements``. - For more information, see [Specify attributes for instance type selection for EC2 Fleet or Spot Fleet](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ec2-fleet-attribute-based-instance-type-selection.html) and [Spot placement score](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/spot-placement-score.html) in the *Amazon EC2 User Guide*. + For more information, see [Attribute-based instance type selection for EC2 Fleet](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ec2-fleet-attribute-based-instance-type-selection.html), [Attribute-based instance type selection for Spot Fleet](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/spot-fleet-attribute-based-instance-type-selection.html), and [Spot placement score](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/spot-placement-score.html) in the *Amazon EC2 User Guide*. """ instance_type: NotRequired[pulumi.Input[str]] """ @@ -5771,7 +5761,6 @@ class LaunchTemplateDataArgsDict(TypedDict): """ The network interfaces for the instance. """ - network_performance_options: NotRequired[Any] placement: NotRequired[pulumi.Input['LaunchTemplatePlacementArgsDict']] """ The placement for the instance. @@ -5797,7 +5786,8 @@ class LaunchTemplateDataArgsDict(TypedDict): """ tag_specifications: NotRequired[pulumi.Input[Sequence[pulumi.Input['TagSpecificationArgsDict']]]] """ - The tags to apply to resources that are created during instance launch. + The tags to apply to the resources that are created during instance launch. + To tag a resource after it has been created, see [CreateTags](https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_CreateTags.html). To tag the launch template itself, use [TagSpecifications](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-launchtemplate.html#cfn-ec2-launchtemplate-tagspecifications). """ user_data: NotRequired[pulumi.Input[str]] @@ -5835,7 +5825,6 @@ def __init__(__self__, *, metadata_options: Optional[pulumi.Input['LaunchTemplateMetadataOptionsArgs']] = None, monitoring: Optional[pulumi.Input['LaunchTemplateMonitoringArgs']] = None, network_interfaces: Optional[pulumi.Input[Sequence[pulumi.Input['LaunchTemplateNetworkInterfaceArgs']]]] = None, - network_performance_options: Optional[Any] = None, placement: Optional[pulumi.Input['LaunchTemplatePlacementArgs']] = None, private_dns_name_options: Optional[pulumi.Input['LaunchTemplatePrivateDnsNameOptionsArgs']] = None, ram_disk_id: Optional[pulumi.Input[str]] = None, @@ -5855,8 +5844,7 @@ def __init__(__self__, *, :param pulumi.Input[bool] ebs_optimized: Indicates whether the instance is optimized for Amazon EBS I/O. This optimization provides dedicated throughput to Amazon EBS and an optimized configuration stack to provide optimal Amazon EBS I/O performance. This optimization isn't available with all instance types. Additional usage charges apply when using an EBS-optimized instance. :param pulumi.Input[Sequence[pulumi.Input['LaunchTemplateElasticGpuSpecificationArgs']]] elastic_gpu_specifications: Deprecated. Amazon Elastic Graphics reached end of life on January 8, 2024. For workloads that require graphics acceleration, we recommend that you use Amazon EC2 G4ad, G4dn, or G5 instances. - :param pulumi.Input[Sequence[pulumi.Input['LaunchTemplateElasticInferenceAcceleratorArgs']]] elastic_inference_accelerators: Amazon Elastic Inference is no longer available. - An elastic inference accelerator to associate with the instance. Elastic inference accelerators are a resource you can attach to your Amazon EC2 instances to accelerate your Deep Learning (DL) inference workloads. + :param pulumi.Input[Sequence[pulumi.Input['LaunchTemplateElasticInferenceAcceleratorArgs']]] elastic_inference_accelerators: An elastic inference accelerator to associate with the instance. Elastic inference accelerators are a resource you can attach to your Amazon EC2 instances to accelerate your Deep Learning (DL) inference workloads. You cannot specify accelerators from different generations in the same request. Starting April 15, 2023, AWS will not onboard new customers to Amazon Elastic Inference (EI), and will help current customers migrate their workloads to options that offer better price and performance. After April 15, 2023, new customers will not be able to launch instances with Amazon EI accelerators in Amazon SageMaker, Amazon ECS, or Amazon EC2. However, customers who have used Amazon EI at least once during the past 30-day period are considered current customers and will be able to continue using the service. :param pulumi.Input['LaunchTemplateEnclaveOptionsArgs'] enclave_options: Indicates whether the instance is enabled for AWS Nitro Enclaves. For more information, see [What is Nitro Enclaves?](https://docs.aws.amazon.com/enclaves/latest/user/nitro-enclave.html) in the *Nitro Enclaves User Guide*. @@ -5883,7 +5871,7 @@ def __init__(__self__, *, If you specify ``InstanceRequirements``, you can't specify ``InstanceType``. Attribute-based instance type selection is only supported when using Auto Scaling groups, EC2 Fleet, and Spot Fleet to launch instances. If you plan to use the launch template in the [launch instance wizard](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ec2-launch-instance-wizard.html), or with the [RunInstances](https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_RunInstances.html) API or [AWS::EC2::Instance](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-instance.html) AWS CloudFormation resource, you can't specify ``InstanceRequirements``. - For more information, see [Specify attributes for instance type selection for EC2 Fleet or Spot Fleet](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ec2-fleet-attribute-based-instance-type-selection.html) and [Spot placement score](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/spot-placement-score.html) in the *Amazon EC2 User Guide*. + For more information, see [Attribute-based instance type selection for EC2 Fleet](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ec2-fleet-attribute-based-instance-type-selection.html), [Attribute-based instance type selection for Spot Fleet](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/spot-fleet-attribute-based-instance-type-selection.html), and [Spot placement score](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/spot-placement-score.html) in the *Amazon EC2 User Guide*. :param pulumi.Input[str] instance_type: The instance type. For more information, see [Amazon EC2 instance types](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/instance-types.html) in the *Amazon EC2 User Guide*. If you specify ``InstanceType``, you can't specify ``InstanceRequirements``. :param pulumi.Input[str] kernel_id: The ID of the kernel. @@ -5903,7 +5891,8 @@ def __init__(__self__, *, If you specify a network interface, you must specify any security groups as part of the network interface instead. :param pulumi.Input[Sequence[pulumi.Input[str]]] security_groups: The names of the security groups. For a nondefault VPC, you must use security group IDs instead. If you specify a network interface, you must specify any security groups as part of the network interface instead of using this parameter. - :param pulumi.Input[Sequence[pulumi.Input['TagSpecificationArgs']]] tag_specifications: The tags to apply to resources that are created during instance launch. + :param pulumi.Input[Sequence[pulumi.Input['TagSpecificationArgs']]] tag_specifications: The tags to apply to the resources that are created during instance launch. + To tag a resource after it has been created, see [CreateTags](https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_CreateTags.html). To tag the launch template itself, use [TagSpecifications](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-launchtemplate.html#cfn-ec2-launchtemplate-tagspecifications). :param pulumi.Input[str] user_data: The user data to make available to the instance. You must provide base64-encoded text. User data is limited to 16 KB. For more information, see [Run commands on your Amazon EC2 instance at launch](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/user-data.html) in the *Amazon EC2 User Guide*. If you are creating the launch template for use with BATCH, the user data must be provided in the [MIME multi-part archive format](https://docs.aws.amazon.com/https://cloudinit.readthedocs.io/en/latest/topics/format.html#mime-multi-part-archive). For more information, see [Amazon EC2 user data in launch templates](https://docs.aws.amazon.com/batch/latest/userguide/launch-templates.html) in the *User Guide*. @@ -5956,8 +5945,6 @@ def __init__(__self__, *, pulumi.set(__self__, "monitoring", monitoring) if network_interfaces is not None: pulumi.set(__self__, "network_interfaces", network_interfaces) - if network_performance_options is not None: - pulumi.set(__self__, "network_performance_options", network_performance_options) if placement is not None: pulumi.set(__self__, "placement", placement) if private_dns_name_options is not None: @@ -6074,8 +6061,7 @@ def elastic_gpu_specifications(self, value: Optional[pulumi.Input[Sequence[pulum @pulumi.getter(name="elasticInferenceAccelerators") def elastic_inference_accelerators(self) -> Optional[pulumi.Input[Sequence[pulumi.Input['LaunchTemplateElasticInferenceAcceleratorArgs']]]]: """ - Amazon Elastic Inference is no longer available. - An elastic inference accelerator to associate with the instance. Elastic inference accelerators are a resource you can attach to your Amazon EC2 instances to accelerate your Deep Learning (DL) inference workloads. + An elastic inference accelerator to associate with the instance. Elastic inference accelerators are a resource you can attach to your Amazon EC2 instances to accelerate your Deep Learning (DL) inference workloads. You cannot specify accelerators from different generations in the same request. Starting April 15, 2023, AWS will not onboard new customers to Amazon Elastic Inference (EI), and will help current customers migrate their workloads to options that offer better price and performance. After April 15, 2023, new customers will not be able to launch instances with Amazon EI accelerators in Amazon SageMaker, Amazon ECS, or Amazon EC2. However, customers who have used Amazon EI at least once during the past 30-day period are considered current customers and will be able to continue using the service. """ @@ -6179,7 +6165,7 @@ def instance_requirements(self) -> Optional[pulumi.Input['LaunchTemplateInstance If you specify ``InstanceRequirements``, you can't specify ``InstanceType``. Attribute-based instance type selection is only supported when using Auto Scaling groups, EC2 Fleet, and Spot Fleet to launch instances. If you plan to use the launch template in the [launch instance wizard](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ec2-launch-instance-wizard.html), or with the [RunInstances](https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_RunInstances.html) API or [AWS::EC2::Instance](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-instance.html) AWS CloudFormation resource, you can't specify ``InstanceRequirements``. - For more information, see [Specify attributes for instance type selection for EC2 Fleet or Spot Fleet](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ec2-fleet-attribute-based-instance-type-selection.html) and [Spot placement score](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/spot-placement-score.html) in the *Amazon EC2 User Guide*. + For more information, see [Attribute-based instance type selection for EC2 Fleet](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ec2-fleet-attribute-based-instance-type-selection.html), [Attribute-based instance type selection for Spot Fleet](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/spot-fleet-attribute-based-instance-type-selection.html), and [Spot placement score](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/spot-placement-score.html) in the *Amazon EC2 User Guide*. """ return pulumi.get(self, "instance_requirements") @@ -6286,15 +6272,6 @@ def network_interfaces(self) -> Optional[pulumi.Input[Sequence[pulumi.Input['Lau def network_interfaces(self, value: Optional[pulumi.Input[Sequence[pulumi.Input['LaunchTemplateNetworkInterfaceArgs']]]]): pulumi.set(self, "network_interfaces", value) - @property - @pulumi.getter(name="networkPerformanceOptions") - def network_performance_options(self) -> Optional[Any]: - return pulumi.get(self, "network_performance_options") - - @network_performance_options.setter - def network_performance_options(self, value: Optional[Any]): - pulumi.set(self, "network_performance_options", value) - @property @pulumi.getter def placement(self) -> Optional[pulumi.Input['LaunchTemplatePlacementArgs']]: @@ -6362,7 +6339,8 @@ def security_groups(self, value: Optional[pulumi.Input[Sequence[pulumi.Input[str @pulumi.getter(name="tagSpecifications") def tag_specifications(self) -> Optional[pulumi.Input[Sequence[pulumi.Input['TagSpecificationArgs']]]]: """ - The tags to apply to resources that are created during instance launch. + The tags to apply to the resources that are created during instance launch. + To tag a resource after it has been created, see [CreateTags](https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_CreateTags.html). To tag the launch template itself, use [TagSpecifications](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-launchtemplate.html#cfn-ec2-launchtemplate-tagspecifications). """ return pulumi.get(self, "tag_specifications") @@ -6412,7 +6390,7 @@ class LaunchTemplateEbsArgsDict(TypedDict): """ kms_key_id: NotRequired[pulumi.Input[str]] """ - Identifier (key ID, key alias, key ARN, or alias ARN) of the customer managed KMS key to use for EBS encryption. + The ARN of the symmetric KMSlong (KMS) CMK used for encryption. """ snapshot_id: NotRequired[pulumi.Input[str]] """ @@ -6463,7 +6441,7 @@ def __init__(__self__, *, For ``io2`` volumes, you can achieve up to 256,000 IOPS on [instances built on the Nitro System](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/instance-types.html#ec2-nitro-instances). On other instances, you can achieve performance up to 32,000 IOPS. This parameter is supported for ``io1``, ``io2``, and ``gp3`` volumes only. - :param pulumi.Input[str] kms_key_id: Identifier (key ID, key alias, key ARN, or alias ARN) of the customer managed KMS key to use for EBS encryption. + :param pulumi.Input[str] kms_key_id: The ARN of the symmetric KMSlong (KMS) CMK used for encryption. :param pulumi.Input[str] snapshot_id: The ID of the snapshot. :param pulumi.Input[int] throughput: The throughput to provision for a ``gp3`` volume, with a maximum of 1,000 MiB/s. Valid Range: Minimum value of 125. Maximum value of 1000. @@ -6539,7 +6517,7 @@ def iops(self, value: Optional[pulumi.Input[int]]): @pulumi.getter(name="kmsKeyId") def kms_key_id(self) -> Optional[pulumi.Input[str]]: """ - Identifier (key ID, key alias, key ARN, or alias ARN) of the customer managed KMS key to use for EBS encryption. + The ARN of the symmetric KMSlong (KMS) CMK used for encryption. """ return pulumi.get(self, "kms_key_id") @@ -7004,7 +6982,7 @@ class LaunchTemplateInstanceRequirementsArgsDict(TypedDict): If you specify ``InstanceRequirements``, you can't specify ``InstanceType``. Attribute-based instance type selection is only supported when using Auto Scaling groups, EC2 Fleet, and Spot Fleet to launch instances. If you plan to use the launch template in the [launch instance wizard](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ec2-launch-instance-wizard.html), or with the [RunInstances](https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_RunInstances.html) API or [AWS::EC2::Instance](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-instance.html) AWS CloudFormation resource, you can't specify ``InstanceRequirements``. - For more information, see [Specify attributes for instance type selection for EC2 Fleet or Spot Fleet](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ec2-fleet-attribute-based-instance-type-selection.html) and [Spot placement score](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/spot-placement-score.html) in the *Amazon EC2 User Guide*. + For more information, see [Attribute-based instance type selection for EC2 Fleet](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ec2-fleet-attribute-based-instance-type-selection.html), [Attribute-based instance type selection for Spot Fleet](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/spot-fleet-attribute-based-instance-type-selection.html), and [Spot placement score](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/spot-placement-score.html) in the *Amazon EC2 User Guide*. """ accelerator_count: NotRequired[pulumi.Input['LaunchTemplateAcceleratorCountArgsDict']] """ @@ -7051,6 +7029,7 @@ class LaunchTemplateInstanceRequirementsArgsDict(TypedDict): The accelerator types that must be on the instance type. + For instance types with GPU accelerators, specify ``gpu``. + For instance types with FPGA accelerators, specify ``fpga``. + + For instance types with inference accelerators, specify ``inference``. Default: Any accelerator type """ @@ -7078,7 +7057,7 @@ class LaunchTemplateInstanceRequirementsArgsDict(TypedDict): """ baseline_performance_factors: NotRequired[pulumi.Input['LaunchTemplateBaselinePerformanceFactorsArgsDict']] """ - The baseline performance to consider, using an instance family as a baseline reference. The instance family establishes the lowest acceptable level of performance. Amazon EC2 uses this baseline to guide instance type selection, but there is no guarantee that the selected instance types will always exceed the baseline for every application. Currently, this parameter only supports CPU performance as a baseline performance factor. For more information, see [Performance protection](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ec2-fleet-attribute-based-instance-type-selection.html#ec2fleet-abis-performance-protection) in the *Amazon EC2 User Guide*. + The baseline performance to consider, using an instance family as a baseline reference. The instance family establishes the lowest acceptable level of performance. Amazon EC2 uses this baseline to guide instance type selection, but there is no guarantee that the selected instance types will always exceed the baseline for every application. Currently, this parameter only supports CPU performance as a baseline performance factor. For more information, see [Performance protection](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ec2-fleet-attribute-based-instance-type-selection.html#ec2fleet-abis-performance-protection) in the *Amazon EC2 User Guide* . """ burstable_performance: NotRequired[pulumi.Input[str]] """ @@ -7095,7 +7074,6 @@ class LaunchTemplateInstanceRequirementsArgsDict(TypedDict): + For instance types with Intel CPUs, specify ``intel``. + For instance types with AMD CPUs, specify ``amd``. + For instance types with AWS CPUs, specify ``amazon-web-services``. - + For instance types with Apple CPUs, specify ``apple``. Don't confuse the CPU manufacturer with the CPU architecture. Instances will be launched with a compatible CPU architecture based on the Amazon Machine Image (AMI) that you specify in your launch template. Default: Any manufacturer @@ -7232,7 +7210,7 @@ def __init__(__self__, *, If you specify ``InstanceRequirements``, you can't specify ``InstanceType``. Attribute-based instance type selection is only supported when using Auto Scaling groups, EC2 Fleet, and Spot Fleet to launch instances. If you plan to use the launch template in the [launch instance wizard](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ec2-launch-instance-wizard.html), or with the [RunInstances](https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_RunInstances.html) API or [AWS::EC2::Instance](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-instance.html) AWS CloudFormation resource, you can't specify ``InstanceRequirements``. - For more information, see [Specify attributes for instance type selection for EC2 Fleet or Spot Fleet](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ec2-fleet-attribute-based-instance-type-selection.html) and [Spot placement score](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/spot-placement-score.html) in the *Amazon EC2 User Guide*. + For more information, see [Attribute-based instance type selection for EC2 Fleet](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ec2-fleet-attribute-based-instance-type-selection.html), [Attribute-based instance type selection for Spot Fleet](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/spot-fleet-attribute-based-instance-type-selection.html), and [Spot placement score](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/spot-placement-score.html) in the *Amazon EC2 User Guide*. :param pulumi.Input['LaunchTemplateAcceleratorCountArgs'] accelerator_count: The minimum and maximum number of accelerators (GPUs, FPGAs, or AWS Inferentia chips) on an instance. To exclude accelerator-enabled instance types, set ``Max`` to ``0``. Default: No minimum or maximum limits @@ -7264,6 +7242,7 @@ def __init__(__self__, *, :param pulumi.Input[Sequence[pulumi.Input[str]]] accelerator_types: The accelerator types that must be on the instance type. + For instance types with GPU accelerators, specify ``gpu``. + For instance types with FPGA accelerators, specify ``fpga``. + + For instance types with inference accelerators, specify ``inference``. Default: Any accelerator type :param pulumi.Input[Sequence[pulumi.Input[str]]] allowed_instance_types: The instance types to apply your specified attributes against. All other instance types are ignored, even if they match your specified attributes. @@ -7279,7 +7258,7 @@ def __init__(__self__, *, Default: ``excluded`` :param pulumi.Input['LaunchTemplateBaselineEbsBandwidthMbpsArgs'] baseline_ebs_bandwidth_mbps: The minimum and maximum baseline bandwidth to Amazon EBS, in Mbps. For more information, see [Amazon EBS–optimized instances](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ebs-optimized.html) in the *Amazon EC2 User Guide*. Default: No minimum or maximum limits - :param pulumi.Input['LaunchTemplateBaselinePerformanceFactorsArgs'] baseline_performance_factors: The baseline performance to consider, using an instance family as a baseline reference. The instance family establishes the lowest acceptable level of performance. Amazon EC2 uses this baseline to guide instance type selection, but there is no guarantee that the selected instance types will always exceed the baseline for every application. Currently, this parameter only supports CPU performance as a baseline performance factor. For more information, see [Performance protection](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ec2-fleet-attribute-based-instance-type-selection.html#ec2fleet-abis-performance-protection) in the *Amazon EC2 User Guide*. + :param pulumi.Input['LaunchTemplateBaselinePerformanceFactorsArgs'] baseline_performance_factors: The baseline performance to consider, using an instance family as a baseline reference. The instance family establishes the lowest acceptable level of performance. Amazon EC2 uses this baseline to guide instance type selection, but there is no guarantee that the selected instance types will always exceed the baseline for every application. Currently, this parameter only supports CPU performance as a baseline performance factor. For more information, see [Performance protection](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ec2-fleet-attribute-based-instance-type-selection.html#ec2fleet-abis-performance-protection) in the *Amazon EC2 User Guide* . :param pulumi.Input[str] burstable_performance: Indicates whether burstable performance T instance types are included, excluded, or required. For more information, see [Burstable performance instances](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/burstable-performance-instances.html). + To include burstable performance instance types, specify ``included``. + To require only burstable performance instance types, specify ``required``. @@ -7290,7 +7269,6 @@ def __init__(__self__, *, + For instance types with Intel CPUs, specify ``intel``. + For instance types with AMD CPUs, specify ``amd``. + For instance types with AWS CPUs, specify ``amazon-web-services``. - + For instance types with Apple CPUs, specify ``apple``. Don't confuse the CPU manufacturer with the CPU architecture. Instances will be launched with a compatible CPU architecture based on the Amazon Machine Image (AMI) that you specify in your launch template. Default: Any manufacturer @@ -7474,6 +7452,7 @@ def accelerator_types(self) -> Optional[pulumi.Input[Sequence[pulumi.Input[str]] The accelerator types that must be on the instance type. + For instance types with GPU accelerators, specify ``gpu``. + For instance types with FPGA accelerators, specify ``fpga``. + + For instance types with inference accelerators, specify ``inference``. Default: Any accelerator type """ @@ -7533,7 +7512,7 @@ def baseline_ebs_bandwidth_mbps(self, value: Optional[pulumi.Input['LaunchTempla @pulumi.getter(name="baselinePerformanceFactors") def baseline_performance_factors(self) -> Optional[pulumi.Input['LaunchTemplateBaselinePerformanceFactorsArgs']]: """ - The baseline performance to consider, using an instance family as a baseline reference. The instance family establishes the lowest acceptable level of performance. Amazon EC2 uses this baseline to guide instance type selection, but there is no guarantee that the selected instance types will always exceed the baseline for every application. Currently, this parameter only supports CPU performance as a baseline performance factor. For more information, see [Performance protection](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ec2-fleet-attribute-based-instance-type-selection.html#ec2fleet-abis-performance-protection) in the *Amazon EC2 User Guide*. + The baseline performance to consider, using an instance family as a baseline reference. The instance family establishes the lowest acceptable level of performance. Amazon EC2 uses this baseline to guide instance type selection, but there is no guarantee that the selected instance types will always exceed the baseline for every application. Currently, this parameter only supports CPU performance as a baseline performance factor. For more information, see [Performance protection](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ec2-fleet-attribute-based-instance-type-selection.html#ec2fleet-abis-performance-protection) in the *Amazon EC2 User Guide* . """ return pulumi.get(self, "baseline_performance_factors") @@ -7566,7 +7545,6 @@ def cpu_manufacturers(self) -> Optional[pulumi.Input[Sequence[pulumi.Input[str]] + For instance types with Intel CPUs, specify ``intel``. + For instance types with AMD CPUs, specify ``amd``. + For instance types with AWS CPUs, specify ``amazon-web-services``. - + For instance types with Apple CPUs, specify ``apple``. Don't confuse the CPU manufacturer with the CPU architecture. Instances will be launched with a compatible CPU architecture based on the Amazon Machine Image (AMI) that you specify in your launch template. Default: Any manufacturer @@ -8420,10 +8398,9 @@ class LaunchTemplateNetworkInterfaceArgsDict(TypedDict): """ interface_type: NotRequired[pulumi.Input[str]] """ - The type of network interface. To create an Elastic Fabric Adapter (EFA), specify ``efa`` or ``efa``. For more information, see [Elastic Fabric Adapter](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/efa.html) in the *Amazon EC2 User Guide*. + The type of network interface. To create an Elastic Fabric Adapter (EFA), specify ``efa``. For more information, see [Elastic Fabric Adapter](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/efa.html) in the *Amazon EC2 User Guide*. If you are not creating an EFA, specify ``interface`` or omit this parameter. - If you specify ``efa-only``, do not assign any IP addresses to the network interface. EFA-only network interfaces do not support IP addresses. - Valid values: ``interface`` | ``efa`` | ``efa-only`` + Valid values: ``interface`` | ``efa`` """ ipv4_prefix_count: NotRequired[pulumi.Input[int]] """ @@ -8518,10 +8495,9 @@ def __init__(__self__, *, :param pulumi.Input[int] device_index: The device index for the network interface attachment. Each network interface requires a device index. If you create a launch template that includes secondary network interfaces but not a primary network interface, then you must add a primary network interface as a launch parameter when you launch an instance from the template. :param pulumi.Input['LaunchTemplateEnaSrdSpecificationArgs'] ena_srd_specification: The ENA Express configuration for the network interface. :param pulumi.Input[Sequence[pulumi.Input[str]]] groups: The IDs of one or more security groups. - :param pulumi.Input[str] interface_type: The type of network interface. To create an Elastic Fabric Adapter (EFA), specify ``efa`` or ``efa``. For more information, see [Elastic Fabric Adapter](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/efa.html) in the *Amazon EC2 User Guide*. + :param pulumi.Input[str] interface_type: The type of network interface. To create an Elastic Fabric Adapter (EFA), specify ``efa``. For more information, see [Elastic Fabric Adapter](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/efa.html) in the *Amazon EC2 User Guide*. If you are not creating an EFA, specify ``interface`` or omit this parameter. - If you specify ``efa-only``, do not assign any IP addresses to the network interface. EFA-only network interfaces do not support IP addresses. - Valid values: ``interface`` | ``efa`` | ``efa-only`` + Valid values: ``interface`` | ``efa`` :param pulumi.Input[int] ipv4_prefix_count: The number of IPv4 prefixes to be automatically assigned to the network interface. You cannot use this option if you use the ``Ipv4Prefix`` option. :param pulumi.Input[Sequence[pulumi.Input['LaunchTemplateIpv4PrefixSpecificationArgs']]] ipv4_prefixes: One or more IPv4 prefixes to be assigned to the network interface. You cannot use this option if you use the ``Ipv4PrefixCount`` option. :param pulumi.Input[int] ipv6_address_count: The number of IPv6 addresses to assign to a network interface. Amazon EC2 automatically selects the IPv6 addresses from the subnet range. You can't use this option if specifying specific IPv6 addresses. @@ -8683,10 +8659,9 @@ def groups(self, value: Optional[pulumi.Input[Sequence[pulumi.Input[str]]]]): @pulumi.getter(name="interfaceType") def interface_type(self) -> Optional[pulumi.Input[str]]: """ - The type of network interface. To create an Elastic Fabric Adapter (EFA), specify ``efa`` or ``efa``. For more information, see [Elastic Fabric Adapter](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/efa.html) in the *Amazon EC2 User Guide*. + The type of network interface. To create an Elastic Fabric Adapter (EFA), specify ``efa``. For more information, see [Elastic Fabric Adapter](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/efa.html) in the *Amazon EC2 User Guide*. If you are not creating an EFA, specify ``interface`` or omit this parameter. - If you specify ``efa-only``, do not assign any IP addresses to the network interface. EFA-only network interfaces do not support IP addresses. - Valid values: ``interface`` | ``efa`` | ``efa-only`` + Valid values: ``interface`` | ``efa`` """ return pulumi.get(self, "interface_type") @@ -9186,6 +9161,9 @@ def private_ip_address(self, value: Optional[pulumi.Input[str]]): if not MYPY: class LaunchTemplateReferenceArgsDict(TypedDict): instance_family: NotRequired[pulumi.Input[str]] + """ + The instance family to refer. Ensure that you specify the correct family name. For example, C6i and C6g are valid values, but C6 is not. + """ elif False: LaunchTemplateReferenceArgsDict: TypeAlias = Mapping[str, Any] @@ -9193,12 +9171,18 @@ class LaunchTemplateReferenceArgsDict(TypedDict): class LaunchTemplateReferenceArgs: def __init__(__self__, *, instance_family: Optional[pulumi.Input[str]] = None): + """ + :param pulumi.Input[str] instance_family: The instance family to refer. Ensure that you specify the correct family name. For example, C6i and C6g are valid values, but C6 is not. + """ if instance_family is not None: pulumi.set(__self__, "instance_family", instance_family) @property @pulumi.getter(name="instanceFamily") def instance_family(self) -> Optional[pulumi.Input[str]]: + """ + The instance family to refer. Ensure that you specify the correct family name. For example, C6i and C6g are valid values, but C6 is not. + """ return pulumi.get(self, "instance_family") @instance_family.setter @@ -9346,7 +9330,6 @@ def valid_until(self, value: Optional[pulumi.Input[str]]): class LaunchTemplateTagSpecificationArgsDict(TypedDict): """ Specifies the tags to apply to the launch template during creation. - To specify the tags for the resources that are created during instance launch, use [AWS::EC2::LaunchTemplate TagSpecification](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-launchtemplate-tagspecification.html). ``LaunchTemplateTagSpecification`` is a property of [AWS::EC2::LaunchTemplate](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-launchtemplate.html). """ resource_type: NotRequired[pulumi.Input[str]] @@ -9367,7 +9350,6 @@ def __init__(__self__, *, tags: Optional[pulumi.Input[Sequence[pulumi.Input['LaunchTemplateTagArgs']]]] = None): """ Specifies the tags to apply to the launch template during creation. - To specify the tags for the resources that are created during instance launch, use [AWS::EC2::LaunchTemplate TagSpecification](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-launchtemplate-tagspecification.html). ``LaunchTemplateTagSpecification`` is a property of [AWS::EC2::LaunchTemplate](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-launchtemplate.html). :param pulumi.Input[str] resource_type: The type of resource. To tag a launch template, ``ResourceType`` must be ``launch-template``. :param pulumi.Input[Sequence[pulumi.Input['LaunchTemplateTagArgs']]] tags: The tags for the resource. @@ -11843,7 +11825,7 @@ class SpotFleetInstanceNetworkInterfaceSpecificationArgsDict(TypedDict): """ secondary_private_ip_address_count: NotRequired[pulumi.Input[int]] """ - The number of secondary private IPv4 addresses. You can't specify this option and specify more than one private IP address using the private IP addresses option. You cannot specify this option if you're launching more than one instance in a [RunInstances](https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_RunInstances.html) request. + The number of secondary private IPv4 addresses. You can’t specify this parameter and also specify a secondary private IP address using the `PrivateIpAddress` parameter. """ subnet_id: NotRequired[pulumi.Input[str]] """ @@ -11882,7 +11864,7 @@ def __init__(__self__, *, If you are creating a Spot Fleet, omit this parameter because you can’t specify a network interface ID in a launch specification. :param pulumi.Input[Sequence[pulumi.Input['SpotFleetPrivateIpAddressSpecificationArgs']]] private_ip_addresses: The private IPv4 addresses to assign to the network interface. Only one private IPv4 address can be designated as primary. You cannot specify this option if you're launching more than one instance in a [RunInstances](https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_RunInstances.html) request. - :param pulumi.Input[int] secondary_private_ip_address_count: The number of secondary private IPv4 addresses. You can't specify this option and specify more than one private IP address using the private IP addresses option. You cannot specify this option if you're launching more than one instance in a [RunInstances](https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_RunInstances.html) request. + :param pulumi.Input[int] secondary_private_ip_address_count: The number of secondary private IPv4 addresses. You can’t specify this parameter and also specify a secondary private IP address using the `PrivateIpAddress` parameter. :param pulumi.Input[str] subnet_id: The ID of the subnet associated with the network interface. """ if associate_public_ip_address is not None: @@ -12026,7 +12008,7 @@ def private_ip_addresses(self, value: Optional[pulumi.Input[Sequence[pulumi.Inpu @pulumi.getter(name="secondaryPrivateIpAddressCount") def secondary_private_ip_address_count(self) -> Optional[pulumi.Input[int]]: """ - The number of secondary private IPv4 addresses. You can't specify this option and specify more than one private IP address using the private IP addresses option. You cannot specify this option if you're launching more than one instance in a [RunInstances](https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_RunInstances.html) request. + The number of secondary private IPv4 addresses. You can’t specify this parameter and also specify a secondary private IP address using the `PrivateIpAddress` parameter. """ return pulumi.get(self, "secondary_private_ip_address_count") @@ -14989,7 +14971,7 @@ def kms_key_arn(self, value: Optional[pulumi.Input[str]]): if not MYPY: class TagSpecificationArgsDict(TypedDict): """ - Specifies the tags to apply to resources that are created during instance launch. + Specifies the tags to apply to a resource when the resource is created for the launch template. ``TagSpecification`` is a property type of [TagSpecifications](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-launchtemplate-launchtemplatedata.html#cfn-ec2-launchtemplate-launchtemplatedata-tagspecifications). [TagSpecifications](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-launchtemplate-launchtemplatedata.html#cfn-ec2-launchtemplate-launchtemplatedata-tagspecifications) is a property of [AWS::EC2::LaunchTemplate LaunchTemplateData](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-launchtemplate-launchtemplatedata.html). """ resource_type: NotRequired[pulumi.Input[str]] @@ -15010,7 +14992,7 @@ def __init__(__self__, *, resource_type: Optional[pulumi.Input[str]] = None, tags: Optional[pulumi.Input[Sequence[pulumi.Input['LaunchTemplateTagArgs']]]] = None): """ - Specifies the tags to apply to resources that are created during instance launch. + Specifies the tags to apply to a resource when the resource is created for the launch template. ``TagSpecification`` is a property type of [TagSpecifications](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-launchtemplate-launchtemplatedata.html#cfn-ec2-launchtemplate-launchtemplatedata-tagspecifications). [TagSpecifications](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-launchtemplate-launchtemplatedata.html#cfn-ec2-launchtemplate-launchtemplatedata-tagspecifications) is a property of [AWS::EC2::LaunchTemplate LaunchTemplateData](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-launchtemplate-launchtemplatedata.html). :param pulumi.Input[str] resource_type: The type of resource to tag. You can specify tags for the following resource types only: ``instance`` | ``volume`` | ``network-interface`` | ``spot-instances-request``. If the instance does not include the resource type that you specify, the instance launch fails. For example, not all instance types include a volume. To tag a resource after it has been created, see [CreateTags](https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_CreateTags.html). diff --git a/sdk/python/pulumi_aws_native/ec2/launch_template.py b/sdk/python/pulumi_aws_native/ec2/launch_template.py index 8c3ec70739..eef1d68d48 100644 --- a/sdk/python/pulumi_aws_native/ec2/launch_template.py +++ b/sdk/python/pulumi_aws_native/ec2/launch_template.py @@ -31,7 +31,7 @@ def __init__(__self__, *, :param pulumi.Input['LaunchTemplateDataArgs'] launch_template_data: The information for the launch template. :param pulumi.Input[str] launch_template_name: A name for the launch template. :param pulumi.Input[Sequence[pulumi.Input['LaunchTemplateTagSpecificationArgs']]] tag_specifications: The tags to apply to the launch template on creation. To tag the launch template, the resource type must be ``launch-template``. - To specify the tags for resources that are created during instance launch, use [TagSpecifications](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-launchtemplate-launchtemplatedata.html#cfn-ec2-launchtemplate-launchtemplatedata-tagspecifications). + To specify the tags for the resources that are created when an instance is launched, you must use [TagSpecifications](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-launchtemplate-launchtemplatedata.html#cfn-ec2-launchtemplate-launchtemplatedata-tagspecifications). :param pulumi.Input[str] version_description: A description for the first version of the launch template. """ pulumi.set(__self__, "launch_template_data", launch_template_data) @@ -71,7 +71,7 @@ def launch_template_name(self, value: Optional[pulumi.Input[str]]): def tag_specifications(self) -> Optional[pulumi.Input[Sequence[pulumi.Input['LaunchTemplateTagSpecificationArgs']]]]: """ The tags to apply to the launch template on creation. To tag the launch template, the resource type must be ``launch-template``. - To specify the tags for resources that are created during instance launch, use [TagSpecifications](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-launchtemplate-launchtemplatedata.html#cfn-ec2-launchtemplate-launchtemplatedata-tagspecifications). + To specify the tags for the resources that are created when an instance is launched, you must use [TagSpecifications](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-launchtemplate-launchtemplatedata.html#cfn-ec2-launchtemplate-launchtemplatedata-tagspecifications). """ return pulumi.get(self, "tag_specifications") @@ -116,7 +116,7 @@ def __init__(__self__, :param pulumi.Input[Union['LaunchTemplateDataArgs', 'LaunchTemplateDataArgsDict']] launch_template_data: The information for the launch template. :param pulumi.Input[str] launch_template_name: A name for the launch template. :param pulumi.Input[Sequence[pulumi.Input[Union['LaunchTemplateTagSpecificationArgs', 'LaunchTemplateTagSpecificationArgsDict']]]] tag_specifications: The tags to apply to the launch template on creation. To tag the launch template, the resource type must be ``launch-template``. - To specify the tags for resources that are created during instance launch, use [TagSpecifications](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-launchtemplate-launchtemplatedata.html#cfn-ec2-launchtemplate-launchtemplatedata-tagspecifications). + To specify the tags for the resources that are created when an instance is launched, you must use [TagSpecifications](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-launchtemplate-launchtemplatedata.html#cfn-ec2-launchtemplate-launchtemplatedata-tagspecifications). :param pulumi.Input[str] version_description: A description for the first version of the launch template. """ ... @@ -251,7 +251,7 @@ def launch_template_name(self) -> pulumi.Output[Optional[str]]: def tag_specifications(self) -> pulumi.Output[Optional[Sequence['outputs.LaunchTemplateTagSpecification']]]: """ The tags to apply to the launch template on creation. To tag the launch template, the resource type must be ``launch-template``. - To specify the tags for resources that are created during instance launch, use [TagSpecifications](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-launchtemplate-launchtemplatedata.html#cfn-ec2-launchtemplate-launchtemplatedata-tagspecifications). + To specify the tags for the resources that are created when an instance is launched, you must use [TagSpecifications](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-launchtemplate-launchtemplatedata.html#cfn-ec2-launchtemplate-launchtemplatedata-tagspecifications). """ return pulumi.get(self, "tag_specifications") diff --git a/sdk/python/pulumi_aws_native/ec2/outputs.py b/sdk/python/pulumi_aws_native/ec2/outputs.py index adec0597e8..5126394b80 100644 --- a/sdk/python/pulumi_aws_native/ec2/outputs.py +++ b/sdk/python/pulumi_aws_native/ec2/outputs.py @@ -3861,15 +3861,9 @@ def min(self) -> Optional[int]: @pulumi.output_type class LaunchTemplateBaselinePerformanceFactors(dict): - """ - The baseline performance to consider, using an instance family as a baseline reference. The instance family establishes the lowest acceptable level of performance. Amazon EC2 uses this baseline to guide instance type selection, but there is no guarantee that the selected instance types will always exceed the baseline for every application. - Currently, this parameter only supports CPU performance as a baseline performance factor. For example, specifying ``c6i`` would use the CPU performance of the ``c6i`` family as the baseline reference. - """ def __init__(__self__, *, cpu: Optional['outputs.LaunchTemplateCpu'] = None): """ - The baseline performance to consider, using an instance family as a baseline reference. The instance family establishes the lowest acceptable level of performance. Amazon EC2 uses this baseline to guide instance type selection, but there is no guarantee that the selected instance types will always exceed the baseline for every application. - Currently, this parameter only supports CPU performance as a baseline performance factor. For example, specifying ``c6i`` would use the CPU performance of the ``c6i`` family as the baseline reference. :param 'LaunchTemplateCpu' cpu: The CPU performance to consider, using an instance family as the baseline reference. """ if cpu is not None: @@ -3998,8 +3992,7 @@ def __init__(__self__, *, Specifies an instance's Capacity Reservation targeting option. You can specify only one option at a time. ``CapacityReservationSpecification`` is a property of [AWS::EC2::LaunchTemplate LaunchTemplateData](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-launchtemplate-launchtemplatedata.html). :param str capacity_reservation_preference: Indicates the instance's Capacity Reservation preferences. Possible preferences include: - + ``capacity-reservations-only`` - The instance will only run in a Capacity Reservation or Capacity Reservation group. If capacity isn't available, the instance will fail to launch. - + ``open`` - The instance can run in any ``open`` Capacity Reservation that has matching attributes (instance type, platform, Availability Zone, tenancy). + + ``open`` - The instance can run in any ``open`` Capacity Reservation that has matching attributes (instance type, platform, Availability Zone). + ``none`` - The instance avoids running in a Capacity Reservation even if one is available. The instance runs in On-Demand capacity. :param 'LaunchTemplateCapacityReservationTarget' capacity_reservation_target: Information about the target Capacity Reservation or Capacity Reservation group. """ @@ -4013,8 +4006,7 @@ def __init__(__self__, *, def capacity_reservation_preference(self) -> Optional[str]: """ Indicates the instance's Capacity Reservation preferences. Possible preferences include: - + ``capacity-reservations-only`` - The instance will only run in a Capacity Reservation or Capacity Reservation group. If capacity isn't available, the instance will fail to launch. - + ``open`` - The instance can run in any ``open`` Capacity Reservation that has matching attributes (instance type, platform, Availability Zone, tenancy). + + ``open`` - The instance can run in any ``open`` Capacity Reservation that has matching attributes (instance type, platform, Availability Zone). + ``none`` - The instance avoids running in a Capacity Reservation even if one is available. The instance runs in On-Demand capacity. """ return pulumi.get(self, "capacity_reservation_preference") @@ -4334,8 +4326,6 @@ def __key_warning(key: str): suggest = "metadata_options" elif key == "networkInterfaces": suggest = "network_interfaces" - elif key == "networkPerformanceOptions": - suggest = "network_performance_options" elif key == "privateDnsNameOptions": suggest = "private_dns_name_options" elif key == "ramDiskId": @@ -4385,7 +4375,6 @@ def __init__(__self__, *, metadata_options: Optional['outputs.LaunchTemplateMetadataOptions'] = None, monitoring: Optional['outputs.LaunchTemplateMonitoring'] = None, network_interfaces: Optional[Sequence['outputs.LaunchTemplateNetworkInterface']] = None, - network_performance_options: Optional[Any] = None, placement: Optional['outputs.LaunchTemplatePlacement'] = None, private_dns_name_options: Optional['outputs.LaunchTemplatePrivateDnsNameOptions'] = None, ram_disk_id: Optional[str] = None, @@ -4405,8 +4394,7 @@ def __init__(__self__, *, :param bool ebs_optimized: Indicates whether the instance is optimized for Amazon EBS I/O. This optimization provides dedicated throughput to Amazon EBS and an optimized configuration stack to provide optimal Amazon EBS I/O performance. This optimization isn't available with all instance types. Additional usage charges apply when using an EBS-optimized instance. :param Sequence['LaunchTemplateElasticGpuSpecification'] elastic_gpu_specifications: Deprecated. Amazon Elastic Graphics reached end of life on January 8, 2024. For workloads that require graphics acceleration, we recommend that you use Amazon EC2 G4ad, G4dn, or G5 instances. - :param Sequence['LaunchTemplateElasticInferenceAccelerator'] elastic_inference_accelerators: Amazon Elastic Inference is no longer available. - An elastic inference accelerator to associate with the instance. Elastic inference accelerators are a resource you can attach to your Amazon EC2 instances to accelerate your Deep Learning (DL) inference workloads. + :param Sequence['LaunchTemplateElasticInferenceAccelerator'] elastic_inference_accelerators: An elastic inference accelerator to associate with the instance. Elastic inference accelerators are a resource you can attach to your Amazon EC2 instances to accelerate your Deep Learning (DL) inference workloads. You cannot specify accelerators from different generations in the same request. Starting April 15, 2023, AWS will not onboard new customers to Amazon Elastic Inference (EI), and will help current customers migrate their workloads to options that offer better price and performance. After April 15, 2023, new customers will not be able to launch instances with Amazon EI accelerators in Amazon SageMaker, Amazon ECS, or Amazon EC2. However, customers who have used Amazon EI at least once during the past 30-day period are considered current customers and will be able to continue using the service. :param 'LaunchTemplateEnclaveOptions' enclave_options: Indicates whether the instance is enabled for AWS Nitro Enclaves. For more information, see [What is Nitro Enclaves?](https://docs.aws.amazon.com/enclaves/latest/user/nitro-enclave.html) in the *Nitro Enclaves User Guide*. @@ -4433,7 +4421,7 @@ def __init__(__self__, *, If you specify ``InstanceRequirements``, you can't specify ``InstanceType``. Attribute-based instance type selection is only supported when using Auto Scaling groups, EC2 Fleet, and Spot Fleet to launch instances. If you plan to use the launch template in the [launch instance wizard](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ec2-launch-instance-wizard.html), or with the [RunInstances](https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_RunInstances.html) API or [AWS::EC2::Instance](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-instance.html) AWS CloudFormation resource, you can't specify ``InstanceRequirements``. - For more information, see [Specify attributes for instance type selection for EC2 Fleet or Spot Fleet](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ec2-fleet-attribute-based-instance-type-selection.html) and [Spot placement score](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/spot-placement-score.html) in the *Amazon EC2 User Guide*. + For more information, see [Attribute-based instance type selection for EC2 Fleet](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ec2-fleet-attribute-based-instance-type-selection.html), [Attribute-based instance type selection for Spot Fleet](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/spot-fleet-attribute-based-instance-type-selection.html), and [Spot placement score](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/spot-placement-score.html) in the *Amazon EC2 User Guide*. :param str instance_type: The instance type. For more information, see [Amazon EC2 instance types](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/instance-types.html) in the *Amazon EC2 User Guide*. If you specify ``InstanceType``, you can't specify ``InstanceRequirements``. :param str kernel_id: The ID of the kernel. @@ -4453,7 +4441,8 @@ def __init__(__self__, *, If you specify a network interface, you must specify any security groups as part of the network interface instead. :param Sequence[str] security_groups: The names of the security groups. For a nondefault VPC, you must use security group IDs instead. If you specify a network interface, you must specify any security groups as part of the network interface instead of using this parameter. - :param Sequence['TagSpecification'] tag_specifications: The tags to apply to resources that are created during instance launch. + :param Sequence['TagSpecification'] tag_specifications: The tags to apply to the resources that are created during instance launch. + To tag a resource after it has been created, see [CreateTags](https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_CreateTags.html). To tag the launch template itself, use [TagSpecifications](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-launchtemplate.html#cfn-ec2-launchtemplate-tagspecifications). :param str user_data: The user data to make available to the instance. You must provide base64-encoded text. User data is limited to 16 KB. For more information, see [Run commands on your Amazon EC2 instance at launch](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/user-data.html) in the *Amazon EC2 User Guide*. If you are creating the launch template for use with BATCH, the user data must be provided in the [MIME multi-part archive format](https://docs.aws.amazon.com/https://cloudinit.readthedocs.io/en/latest/topics/format.html#mime-multi-part-archive). For more information, see [Amazon EC2 user data in launch templates](https://docs.aws.amazon.com/batch/latest/userguide/launch-templates.html) in the *User Guide*. @@ -4506,8 +4495,6 @@ def __init__(__self__, *, pulumi.set(__self__, "monitoring", monitoring) if network_interfaces is not None: pulumi.set(__self__, "network_interfaces", network_interfaces) - if network_performance_options is not None: - pulumi.set(__self__, "network_performance_options", network_performance_options) if placement is not None: pulumi.set(__self__, "placement", placement) if private_dns_name_options is not None: @@ -4592,8 +4579,7 @@ def elastic_gpu_specifications(self) -> Optional[Sequence['outputs.LaunchTemplat @pulumi.getter(name="elasticInferenceAccelerators") def elastic_inference_accelerators(self) -> Optional[Sequence['outputs.LaunchTemplateElasticInferenceAccelerator']]: """ - Amazon Elastic Inference is no longer available. - An elastic inference accelerator to associate with the instance. Elastic inference accelerators are a resource you can attach to your Amazon EC2 instances to accelerate your Deep Learning (DL) inference workloads. + An elastic inference accelerator to associate with the instance. Elastic inference accelerators are a resource you can attach to your Amazon EC2 instances to accelerate your Deep Learning (DL) inference workloads. You cannot specify accelerators from different generations in the same request. Starting April 15, 2023, AWS will not onboard new customers to Amazon Elastic Inference (EI), and will help current customers migrate their workloads to options that offer better price and performance. After April 15, 2023, new customers will not be able to launch instances with Amazon EI accelerators in Amazon SageMaker, Amazon ECS, or Amazon EC2. However, customers who have used Amazon EI at least once during the past 30-day period are considered current customers and will be able to continue using the service. """ @@ -4669,7 +4655,7 @@ def instance_requirements(self) -> Optional['outputs.LaunchTemplateInstanceRequi If you specify ``InstanceRequirements``, you can't specify ``InstanceType``. Attribute-based instance type selection is only supported when using Auto Scaling groups, EC2 Fleet, and Spot Fleet to launch instances. If you plan to use the launch template in the [launch instance wizard](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ec2-launch-instance-wizard.html), or with the [RunInstances](https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_RunInstances.html) API or [AWS::EC2::Instance](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-instance.html) AWS CloudFormation resource, you can't specify ``InstanceRequirements``. - For more information, see [Specify attributes for instance type selection for EC2 Fleet or Spot Fleet](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ec2-fleet-attribute-based-instance-type-selection.html) and [Spot placement score](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/spot-placement-score.html) in the *Amazon EC2 User Guide*. + For more information, see [Attribute-based instance type selection for EC2 Fleet](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ec2-fleet-attribute-based-instance-type-selection.html), [Attribute-based instance type selection for Spot Fleet](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/spot-fleet-attribute-based-instance-type-selection.html), and [Spot placement score](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/spot-placement-score.html) in the *Amazon EC2 User Guide*. """ return pulumi.get(self, "instance_requirements") @@ -4740,11 +4726,6 @@ def network_interfaces(self) -> Optional[Sequence['outputs.LaunchTemplateNetwork """ return pulumi.get(self, "network_interfaces") - @property - @pulumi.getter(name="networkPerformanceOptions") - def network_performance_options(self) -> Optional[Any]: - return pulumi.get(self, "network_performance_options") - @property @pulumi.getter def placement(self) -> Optional['outputs.LaunchTemplatePlacement']: @@ -4792,7 +4773,8 @@ def security_groups(self) -> Optional[Sequence[str]]: @pulumi.getter(name="tagSpecifications") def tag_specifications(self) -> Optional[Sequence['outputs.TagSpecification']]: """ - The tags to apply to resources that are created during instance launch. + The tags to apply to the resources that are created during instance launch. + To tag a resource after it has been created, see [CreateTags](https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_CreateTags.html). To tag the launch template itself, use [TagSpecifications](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-launchtemplate.html#cfn-ec2-launchtemplate-tagspecifications). """ return pulumi.get(self, "tag_specifications") @@ -4860,7 +4842,7 @@ def __init__(__self__, *, For ``io2`` volumes, you can achieve up to 256,000 IOPS on [instances built on the Nitro System](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/instance-types.html#ec2-nitro-instances). On other instances, you can achieve performance up to 32,000 IOPS. This parameter is supported for ``io1``, ``io2``, and ``gp3`` volumes only. - :param str kms_key_id: Identifier (key ID, key alias, key ARN, or alias ARN) of the customer managed KMS key to use for EBS encryption. + :param str kms_key_id: The ARN of the symmetric KMSlong (KMS) CMK used for encryption. :param str snapshot_id: The ID of the snapshot. :param int throughput: The throughput to provision for a ``gp3`` volume, with a maximum of 1,000 MiB/s. Valid Range: Minimum value of 125. Maximum value of 1000. @@ -4924,7 +4906,7 @@ def iops(self) -> Optional[int]: @pulumi.getter(name="kmsKeyId") def kms_key_id(self) -> Optional[str]: """ - Identifier (key ID, key alias, key ARN, or alias ARN) of the customer managed KMS key to use for EBS encryption. + The ARN of the symmetric KMSlong (KMS) CMK used for encryption. """ return pulumi.get(self, "kms_key_id") @@ -5286,7 +5268,7 @@ class LaunchTemplateInstanceRequirements(dict): If you specify ``InstanceRequirements``, you can't specify ``InstanceType``. Attribute-based instance type selection is only supported when using Auto Scaling groups, EC2 Fleet, and Spot Fleet to launch instances. If you plan to use the launch template in the [launch instance wizard](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ec2-launch-instance-wizard.html), or with the [RunInstances](https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_RunInstances.html) API or [AWS::EC2::Instance](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-instance.html) AWS CloudFormation resource, you can't specify ``InstanceRequirements``. - For more information, see [Specify attributes for instance type selection for EC2 Fleet or Spot Fleet](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ec2-fleet-attribute-based-instance-type-selection.html) and [Spot placement score](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/spot-placement-score.html) in the *Amazon EC2 User Guide*. + For more information, see [Attribute-based instance type selection for EC2 Fleet](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ec2-fleet-attribute-based-instance-type-selection.html), [Attribute-based instance type selection for Spot Fleet](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/spot-fleet-attribute-based-instance-type-selection.html), and [Spot placement score](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/spot-placement-score.html) in the *Amazon EC2 User Guide*. """ @staticmethod def __key_warning(key: str): @@ -5389,7 +5371,7 @@ def __init__(__self__, *, If you specify ``InstanceRequirements``, you can't specify ``InstanceType``. Attribute-based instance type selection is only supported when using Auto Scaling groups, EC2 Fleet, and Spot Fleet to launch instances. If you plan to use the launch template in the [launch instance wizard](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ec2-launch-instance-wizard.html), or with the [RunInstances](https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_RunInstances.html) API or [AWS::EC2::Instance](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-instance.html) AWS CloudFormation resource, you can't specify ``InstanceRequirements``. - For more information, see [Specify attributes for instance type selection for EC2 Fleet or Spot Fleet](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ec2-fleet-attribute-based-instance-type-selection.html) and [Spot placement score](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/spot-placement-score.html) in the *Amazon EC2 User Guide*. + For more information, see [Attribute-based instance type selection for EC2 Fleet](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ec2-fleet-attribute-based-instance-type-selection.html), [Attribute-based instance type selection for Spot Fleet](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/spot-fleet-attribute-based-instance-type-selection.html), and [Spot placement score](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/spot-placement-score.html) in the *Amazon EC2 User Guide*. :param 'LaunchTemplateAcceleratorCount' accelerator_count: The minimum and maximum number of accelerators (GPUs, FPGAs, or AWS Inferentia chips) on an instance. To exclude accelerator-enabled instance types, set ``Max`` to ``0``. Default: No minimum or maximum limits @@ -5421,6 +5403,7 @@ def __init__(__self__, *, :param Sequence[str] accelerator_types: The accelerator types that must be on the instance type. + For instance types with GPU accelerators, specify ``gpu``. + For instance types with FPGA accelerators, specify ``fpga``. + + For instance types with inference accelerators, specify ``inference``. Default: Any accelerator type :param Sequence[str] allowed_instance_types: The instance types to apply your specified attributes against. All other instance types are ignored, even if they match your specified attributes. @@ -5436,7 +5419,7 @@ def __init__(__self__, *, Default: ``excluded`` :param 'LaunchTemplateBaselineEbsBandwidthMbps' baseline_ebs_bandwidth_mbps: The minimum and maximum baseline bandwidth to Amazon EBS, in Mbps. For more information, see [Amazon EBS–optimized instances](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ebs-optimized.html) in the *Amazon EC2 User Guide*. Default: No minimum or maximum limits - :param 'LaunchTemplateBaselinePerformanceFactors' baseline_performance_factors: The baseline performance to consider, using an instance family as a baseline reference. The instance family establishes the lowest acceptable level of performance. Amazon EC2 uses this baseline to guide instance type selection, but there is no guarantee that the selected instance types will always exceed the baseline for every application. Currently, this parameter only supports CPU performance as a baseline performance factor. For more information, see [Performance protection](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ec2-fleet-attribute-based-instance-type-selection.html#ec2fleet-abis-performance-protection) in the *Amazon EC2 User Guide*. + :param 'LaunchTemplateBaselinePerformanceFactors' baseline_performance_factors: The baseline performance to consider, using an instance family as a baseline reference. The instance family establishes the lowest acceptable level of performance. Amazon EC2 uses this baseline to guide instance type selection, but there is no guarantee that the selected instance types will always exceed the baseline for every application. Currently, this parameter only supports CPU performance as a baseline performance factor. For more information, see [Performance protection](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ec2-fleet-attribute-based-instance-type-selection.html#ec2fleet-abis-performance-protection) in the *Amazon EC2 User Guide* . :param str burstable_performance: Indicates whether burstable performance T instance types are included, excluded, or required. For more information, see [Burstable performance instances](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/burstable-performance-instances.html). + To include burstable performance instance types, specify ``included``. + To require only burstable performance instance types, specify ``required``. @@ -5447,7 +5430,6 @@ def __init__(__self__, *, + For instance types with Intel CPUs, specify ``intel``. + For instance types with AMD CPUs, specify ``amd``. + For instance types with AWS CPUs, specify ``amazon-web-services``. - + For instance types with Apple CPUs, specify ``apple``. Don't confuse the CPU manufacturer with the CPU architecture. Instances will be launched with a compatible CPU architecture based on the Amazon Machine Image (AMI) that you specify in your launch template. Default: Any manufacturer @@ -5615,6 +5597,7 @@ def accelerator_types(self) -> Optional[Sequence[str]]: The accelerator types that must be on the instance type. + For instance types with GPU accelerators, specify ``gpu``. + For instance types with FPGA accelerators, specify ``fpga``. + + For instance types with inference accelerators, specify ``inference``. Default: Any accelerator type """ @@ -5658,7 +5641,7 @@ def baseline_ebs_bandwidth_mbps(self) -> Optional['outputs.LaunchTemplateBaselin @pulumi.getter(name="baselinePerformanceFactors") def baseline_performance_factors(self) -> Optional['outputs.LaunchTemplateBaselinePerformanceFactors']: """ - The baseline performance to consider, using an instance family as a baseline reference. The instance family establishes the lowest acceptable level of performance. Amazon EC2 uses this baseline to guide instance type selection, but there is no guarantee that the selected instance types will always exceed the baseline for every application. Currently, this parameter only supports CPU performance as a baseline performance factor. For more information, see [Performance protection](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ec2-fleet-attribute-based-instance-type-selection.html#ec2fleet-abis-performance-protection) in the *Amazon EC2 User Guide*. + The baseline performance to consider, using an instance family as a baseline reference. The instance family establishes the lowest acceptable level of performance. Amazon EC2 uses this baseline to guide instance type selection, but there is no guarantee that the selected instance types will always exceed the baseline for every application. Currently, this parameter only supports CPU performance as a baseline performance factor. For more information, see [Performance protection](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ec2-fleet-attribute-based-instance-type-selection.html#ec2fleet-abis-performance-protection) in the *Amazon EC2 User Guide* . """ return pulumi.get(self, "baseline_performance_factors") @@ -5683,7 +5666,6 @@ def cpu_manufacturers(self) -> Optional[Sequence[str]]: + For instance types with Intel CPUs, specify ``intel``. + For instance types with AMD CPUs, specify ``amd``. + For instance types with AWS CPUs, specify ``amazon-web-services``. - + For instance types with Apple CPUs, specify ``apple``. Don't confuse the CPU manufacturer with the CPU architecture. Instances will be launched with a compatible CPU architecture based on the Amazon Machine Image (AMI) that you specify in your launch template. Default: Any manufacturer @@ -6391,10 +6373,9 @@ def __init__(__self__, *, :param int device_index: The device index for the network interface attachment. Each network interface requires a device index. If you create a launch template that includes secondary network interfaces but not a primary network interface, then you must add a primary network interface as a launch parameter when you launch an instance from the template. :param 'LaunchTemplateEnaSrdSpecification' ena_srd_specification: The ENA Express configuration for the network interface. :param Sequence[str] groups: The IDs of one or more security groups. - :param str interface_type: The type of network interface. To create an Elastic Fabric Adapter (EFA), specify ``efa`` or ``efa``. For more information, see [Elastic Fabric Adapter](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/efa.html) in the *Amazon EC2 User Guide*. + :param str interface_type: The type of network interface. To create an Elastic Fabric Adapter (EFA), specify ``efa``. For more information, see [Elastic Fabric Adapter](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/efa.html) in the *Amazon EC2 User Guide*. If you are not creating an EFA, specify ``interface`` or omit this parameter. - If you specify ``efa-only``, do not assign any IP addresses to the network interface. EFA-only network interfaces do not support IP addresses. - Valid values: ``interface`` | ``efa`` | ``efa-only`` + Valid values: ``interface`` | ``efa`` :param int ipv4_prefix_count: The number of IPv4 prefixes to be automatically assigned to the network interface. You cannot use this option if you use the ``Ipv4Prefix`` option. :param Sequence['LaunchTemplateIpv4PrefixSpecification'] ipv4_prefixes: One or more IPv4 prefixes to be assigned to the network interface. You cannot use this option if you use the ``Ipv4PrefixCount`` option. :param int ipv6_address_count: The number of IPv6 addresses to assign to a network interface. Amazon EC2 automatically selects the IPv6 addresses from the subnet range. You can't use this option if specifying specific IPv6 addresses. @@ -6524,10 +6505,9 @@ def groups(self) -> Optional[Sequence[str]]: @pulumi.getter(name="interfaceType") def interface_type(self) -> Optional[str]: """ - The type of network interface. To create an Elastic Fabric Adapter (EFA), specify ``efa`` or ``efa``. For more information, see [Elastic Fabric Adapter](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/efa.html) in the *Amazon EC2 User Guide*. + The type of network interface. To create an Elastic Fabric Adapter (EFA), specify ``efa``. For more information, see [Elastic Fabric Adapter](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/efa.html) in the *Amazon EC2 User Guide*. If you are not creating an EFA, specify ``interface`` or omit this parameter. - If you specify ``efa-only``, do not assign any IP addresses to the network interface. EFA-only network interfaces do not support IP addresses. - Valid values: ``interface`` | ``efa`` | ``efa-only`` + Valid values: ``interface`` | ``efa`` """ return pulumi.get(self, "interface_type") @@ -6964,12 +6944,18 @@ def get(self, key: str, default = None) -> Any: def __init__(__self__, *, instance_family: Optional[str] = None): + """ + :param str instance_family: The instance family to refer. Ensure that you specify the correct family name. For example, C6i and C6g are valid values, but C6 is not. + """ if instance_family is not None: pulumi.set(__self__, "instance_family", instance_family) @property @pulumi.getter(name="instanceFamily") def instance_family(self) -> Optional[str]: + """ + The instance family to refer. Ensure that you specify the correct family name. For example, C6i and C6g are valid values, but C6 is not. + """ return pulumi.get(self, "instance_family") @@ -7120,7 +7106,6 @@ def value(self) -> str: class LaunchTemplateTagSpecification(dict): """ Specifies the tags to apply to the launch template during creation. - To specify the tags for the resources that are created during instance launch, use [AWS::EC2::LaunchTemplate TagSpecification](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-launchtemplate-tagspecification.html). ``LaunchTemplateTagSpecification`` is a property of [AWS::EC2::LaunchTemplate](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-launchtemplate.html). """ @staticmethod @@ -7145,7 +7130,6 @@ def __init__(__self__, *, tags: Optional[Sequence['outputs.LaunchTemplateTag']] = None): """ Specifies the tags to apply to the launch template during creation. - To specify the tags for the resources that are created during instance launch, use [AWS::EC2::LaunchTemplate TagSpecification](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-launchtemplate-tagspecification.html). ``LaunchTemplateTagSpecification`` is a property of [AWS::EC2::LaunchTemplate](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-launchtemplate.html). :param str resource_type: The type of resource. To tag a launch template, ``ResourceType`` must be ``launch-template``. :param Sequence['LaunchTemplateTag'] tags: The tags for the resource. @@ -11042,7 +11026,7 @@ def __init__(__self__, *, If you are creating a Spot Fleet, omit this parameter because you can’t specify a network interface ID in a launch specification. :param Sequence['SpotFleetPrivateIpAddressSpecification'] private_ip_addresses: The private IPv4 addresses to assign to the network interface. Only one private IPv4 address can be designated as primary. You cannot specify this option if you're launching more than one instance in a [RunInstances](https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_RunInstances.html) request. - :param int secondary_private_ip_address_count: The number of secondary private IPv4 addresses. You can't specify this option and specify more than one private IP address using the private IP addresses option. You cannot specify this option if you're launching more than one instance in a [RunInstances](https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_RunInstances.html) request. + :param int secondary_private_ip_address_count: The number of secondary private IPv4 addresses. You can’t specify this parameter and also specify a secondary private IP address using the `PrivateIpAddress` parameter. :param str subnet_id: The ID of the subnet associated with the network interface. """ if associate_public_ip_address is not None: @@ -11150,7 +11134,7 @@ def private_ip_addresses(self) -> Optional[Sequence['outputs.SpotFleetPrivateIpA @pulumi.getter(name="secondaryPrivateIpAddressCount") def secondary_private_ip_address_count(self) -> Optional[int]: """ - The number of secondary private IPv4 addresses. You can't specify this option and specify more than one private IP address using the private IP addresses option. You cannot specify this option if you're launching more than one instance in a [RunInstances](https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_RunInstances.html) request. + The number of secondary private IPv4 addresses. You can’t specify this parameter and also specify a secondary private IP address using the `PrivateIpAddress` parameter. """ return pulumi.get(self, "secondary_private_ip_address_count") @@ -13317,7 +13301,7 @@ def kms_key_arn(self) -> Optional[str]: @pulumi.output_type class TagSpecification(dict): """ - Specifies the tags to apply to resources that are created during instance launch. + Specifies the tags to apply to a resource when the resource is created for the launch template. ``TagSpecification`` is a property type of [TagSpecifications](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-launchtemplate-launchtemplatedata.html#cfn-ec2-launchtemplate-launchtemplatedata-tagspecifications). [TagSpecifications](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-launchtemplate-launchtemplatedata.html#cfn-ec2-launchtemplate-launchtemplatedata-tagspecifications) is a property of [AWS::EC2::LaunchTemplate LaunchTemplateData](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-launchtemplate-launchtemplatedata.html). """ @staticmethod @@ -13341,7 +13325,7 @@ def __init__(__self__, *, resource_type: Optional[str] = None, tags: Optional[Sequence['outputs.LaunchTemplateTag']] = None): """ - Specifies the tags to apply to resources that are created during instance launch. + Specifies the tags to apply to a resource when the resource is created for the launch template. ``TagSpecification`` is a property type of [TagSpecifications](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-launchtemplate-launchtemplatedata.html#cfn-ec2-launchtemplate-launchtemplatedata-tagspecifications). [TagSpecifications](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-launchtemplate-launchtemplatedata.html#cfn-ec2-launchtemplate-launchtemplatedata-tagspecifications) is a property of [AWS::EC2::LaunchTemplate LaunchTemplateData](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-launchtemplate-launchtemplatedata.html). :param str resource_type: The type of resource to tag. You can specify tags for the following resource types only: ``instance`` | ``volume`` | ``network-interface`` | ``spot-instances-request``. If the instance does not include the resource type that you specify, the instance launch fails. For example, not all instance types include a volume. To tag a resource after it has been created, see [CreateTags](https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_CreateTags.html). diff --git a/sdk/python/pulumi_aws_native/ecs/_enums.py b/sdk/python/pulumi_aws_native/ecs/_enums.py index 94b6c7f0b8..26db1806a0 100644 --- a/sdk/python/pulumi_aws_native/ecs/_enums.py +++ b/sdk/python/pulumi_aws_native/ecs/_enums.py @@ -172,7 +172,7 @@ class TaskDefinitionAuthorizationConfigIam(str, Enum): class TaskDefinitionContainerDefinitionVersionConsistency(str, Enum): """ - Specifies whether Amazon ECS will resolve the container image tag provided in the container definition to an image digest. By default, the value is `enabled` . If you set the value for a container as `disabled` , Amazon ECS will not resolve the provided container image tag to a digest and will use the original image URI specified in the container definition for deployment. For more information about container image resolution, see [Container image resolution](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/deployment-type-ecs.html#deployment-container-image-stability) in the *Amazon ECS Developer Guide* . + Specifies whether Amazon ECS will resolve the container image tag provided in the container definition to an image digest. By default, the value is ``enabled``. If you set the value for a container as ``disabled``, Amazon ECS will not resolve the provided container image tag to a digest and will use the original image URI specified in the container definition for deployment. For more information about container image resolution, see [Container image resolution](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/deployment-type-ecs.html#deployment-container-image-stability) in the *Amazon ECS Developer Guide*. """ ENABLED = "enabled" DISABLED = "disabled" diff --git a/sdk/python/pulumi_aws_native/ecs/_inputs.py b/sdk/python/pulumi_aws_native/ecs/_inputs.py index 2b9496e97c..fca45f87d5 100644 --- a/sdk/python/pulumi_aws_native/ecs/_inputs.py +++ b/sdk/python/pulumi_aws_native/ecs/_inputs.py @@ -3426,7 +3426,7 @@ class TaskDefinitionContainerDefinitionArgsDict(TypedDict): """ version_consistency: NotRequired[pulumi.Input['TaskDefinitionContainerDefinitionVersionConsistency']] """ - Specifies whether Amazon ECS will resolve the container image tag provided in the container definition to an image digest. By default, the value is `enabled` . If you set the value for a container as `disabled` , Amazon ECS will not resolve the provided container image tag to a digest and will use the original image URI specified in the container definition for deployment. For more information about container image resolution, see [Container image resolution](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/deployment-type-ecs.html#deployment-container-image-stability) in the *Amazon ECS Developer Guide* . + Specifies whether Amazon ECS will resolve the container image tag provided in the container definition to an image digest. By default, the value is ``enabled``. If you set the value for a container as ``disabled``, Amazon ECS will not resolve the provided container image tag to a digest and will use the original image URI specified in the container definition for deployment. For more information about container image resolution, see [Container image resolution](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/deployment-type-ecs.html#deployment-container-image-stability) in the *Amazon ECS Developer Guide*. """ volumes_from: NotRequired[pulumi.Input[Sequence[pulumi.Input['TaskDefinitionVolumeFromArgsDict']]]] """ @@ -3612,7 +3612,7 @@ def __init__(__self__, *, + ``uid:group`` This parameter is not supported for Windows containers. - :param pulumi.Input['TaskDefinitionContainerDefinitionVersionConsistency'] version_consistency: Specifies whether Amazon ECS will resolve the container image tag provided in the container definition to an image digest. By default, the value is `enabled` . If you set the value for a container as `disabled` , Amazon ECS will not resolve the provided container image tag to a digest and will use the original image URI specified in the container definition for deployment. For more information about container image resolution, see [Container image resolution](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/deployment-type-ecs.html#deployment-container-image-stability) in the *Amazon ECS Developer Guide* . + :param pulumi.Input['TaskDefinitionContainerDefinitionVersionConsistency'] version_consistency: Specifies whether Amazon ECS will resolve the container image tag provided in the container definition to an image digest. By default, the value is ``enabled``. If you set the value for a container as ``disabled``, Amazon ECS will not resolve the provided container image tag to a digest and will use the original image URI specified in the container definition for deployment. For more information about container image resolution, see [Container image resolution](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/deployment-type-ecs.html#deployment-container-image-stability) in the *Amazon ECS Developer Guide*. :param pulumi.Input[Sequence[pulumi.Input['TaskDefinitionVolumeFromArgs']]] volumes_from: Data volumes to mount from another container. This parameter maps to ``VolumesFrom`` in the docker container create command and the ``--volumes-from`` option to docker run. :param pulumi.Input[str] working_directory: The working directory to run commands inside the container in. This parameter maps to ``WorkingDir`` in the docker container create command and the ``--workdir`` option to docker run. """ @@ -4258,7 +4258,7 @@ def user(self, value: Optional[pulumi.Input[str]]): @pulumi.getter(name="versionConsistency") def version_consistency(self) -> Optional[pulumi.Input['TaskDefinitionContainerDefinitionVersionConsistency']]: """ - Specifies whether Amazon ECS will resolve the container image tag provided in the container definition to an image digest. By default, the value is `enabled` . If you set the value for a container as `disabled` , Amazon ECS will not resolve the provided container image tag to a digest and will use the original image URI specified in the container definition for deployment. For more information about container image resolution, see [Container image resolution](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/deployment-type-ecs.html#deployment-container-image-stability) in the *Amazon ECS Developer Guide* . + Specifies whether Amazon ECS will resolve the container image tag provided in the container definition to an image digest. By default, the value is ``enabled``. If you set the value for a container as ``disabled``, Amazon ECS will not resolve the provided container image tag to a digest and will use the original image URI specified in the container definition for deployment. For more information about container image resolution, see [Container image resolution](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/deployment-type-ecs.html#deployment-container-image-stability) in the *Amazon ECS Developer Guide*. """ return pulumi.get(self, "version_consistency") diff --git a/sdk/python/pulumi_aws_native/ecs/outputs.py b/sdk/python/pulumi_aws_native/ecs/outputs.py index 4ee9c763fa..6aa8d46cf0 100644 --- a/sdk/python/pulumi_aws_native/ecs/outputs.py +++ b/sdk/python/pulumi_aws_native/ecs/outputs.py @@ -2785,7 +2785,7 @@ def __init__(__self__, *, + ``uid:group`` This parameter is not supported for Windows containers. - :param 'TaskDefinitionContainerDefinitionVersionConsistency' version_consistency: Specifies whether Amazon ECS will resolve the container image tag provided in the container definition to an image digest. By default, the value is `enabled` . If you set the value for a container as `disabled` , Amazon ECS will not resolve the provided container image tag to a digest and will use the original image URI specified in the container definition for deployment. For more information about container image resolution, see [Container image resolution](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/deployment-type-ecs.html#deployment-container-image-stability) in the *Amazon ECS Developer Guide* . + :param 'TaskDefinitionContainerDefinitionVersionConsistency' version_consistency: Specifies whether Amazon ECS will resolve the container image tag provided in the container definition to an image digest. By default, the value is ``enabled``. If you set the value for a container as ``disabled``, Amazon ECS will not resolve the provided container image tag to a digest and will use the original image URI specified in the container definition for deployment. For more information about container image resolution, see [Container image resolution](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/deployment-type-ecs.html#deployment-container-image-stability) in the *Amazon ECS Developer Guide*. :param Sequence['TaskDefinitionVolumeFrom'] volumes_from: Data volumes to mount from another container. This parameter maps to ``VolumesFrom`` in the docker container create command and the ``--volumes-from`` option to docker run. :param str working_directory: The working directory to run commands inside the container in. This parameter maps to ``WorkingDir`` in the docker container create command and the ``--workdir`` option to docker run. """ @@ -3275,7 +3275,7 @@ def user(self) -> Optional[str]: @pulumi.getter(name="versionConsistency") def version_consistency(self) -> Optional['TaskDefinitionContainerDefinitionVersionConsistency']: """ - Specifies whether Amazon ECS will resolve the container image tag provided in the container definition to an image digest. By default, the value is `enabled` . If you set the value for a container as `disabled` , Amazon ECS will not resolve the provided container image tag to a digest and will use the original image URI specified in the container definition for deployment. For more information about container image resolution, see [Container image resolution](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/deployment-type-ecs.html#deployment-container-image-stability) in the *Amazon ECS Developer Guide* . + Specifies whether Amazon ECS will resolve the container image tag provided in the container definition to an image digest. By default, the value is ``enabled``. If you set the value for a container as ``disabled``, Amazon ECS will not resolve the provided container image tag to a digest and will use the original image URI specified in the container definition for deployment. For more information about container image resolution, see [Container image resolution](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/deployment-type-ecs.html#deployment-container-image-stability) in the *Amazon ECS Developer Guide*. """ return pulumi.get(self, "version_consistency") diff --git a/sdk/python/pulumi_aws_native/ecs/task_definition.py b/sdk/python/pulumi_aws_native/ecs/task_definition.py index ea2ec66f68..b07734d47a 100644 --- a/sdk/python/pulumi_aws_native/ecs/task_definition.py +++ b/sdk/python/pulumi_aws_native/ecs/task_definition.py @@ -26,6 +26,7 @@ class TaskDefinitionArgs: def __init__(__self__, *, container_definitions: Optional[pulumi.Input[Sequence[pulumi.Input['TaskDefinitionContainerDefinitionArgs']]]] = None, cpu: Optional[pulumi.Input[str]] = None, + enable_fault_injection: Optional[pulumi.Input[bool]] = None, ephemeral_storage: Optional[pulumi.Input['TaskDefinitionEphemeralStorageArgs']] = None, execution_role_arn: Optional[pulumi.Input[str]] = None, family: Optional[pulumi.Input[str]] = None, @@ -119,6 +120,8 @@ def __init__(__self__, *, pulumi.set(__self__, "container_definitions", container_definitions) if cpu is not None: pulumi.set(__self__, "cpu", cpu) + if enable_fault_injection is not None: + pulumi.set(__self__, "enable_fault_injection", enable_fault_injection) if ephemeral_storage is not None: pulumi.set(__self__, "ephemeral_storage", ephemeral_storage) if execution_role_arn is not None: @@ -185,6 +188,15 @@ def cpu(self) -> Optional[pulumi.Input[str]]: def cpu(self, value: Optional[pulumi.Input[str]]): pulumi.set(self, "cpu", value) + @property + @pulumi.getter(name="enableFaultInjection") + def enable_fault_injection(self) -> Optional[pulumi.Input[bool]]: + return pulumi.get(self, "enable_fault_injection") + + @enable_fault_injection.setter + def enable_fault_injection(self, value: Optional[pulumi.Input[bool]]): + pulumi.set(self, "enable_fault_injection", value) + @property @pulumi.getter(name="ephemeralStorage") def ephemeral_storage(self) -> Optional[pulumi.Input['TaskDefinitionEphemeralStorageArgs']]: @@ -416,6 +428,7 @@ def __init__(__self__, opts: Optional[pulumi.ResourceOptions] = None, container_definitions: Optional[pulumi.Input[Sequence[pulumi.Input[Union['TaskDefinitionContainerDefinitionArgs', 'TaskDefinitionContainerDefinitionArgsDict']]]]] = None, cpu: Optional[pulumi.Input[str]] = None, + enable_fault_injection: Optional[pulumi.Input[bool]] = None, ephemeral_storage: Optional[pulumi.Input[Union['TaskDefinitionEphemeralStorageArgs', 'TaskDefinitionEphemeralStorageArgsDict']]] = None, execution_role_arn: Optional[pulumi.Input[str]] = None, family: Optional[pulumi.Input[str]] = None, @@ -891,6 +904,7 @@ def _internal_init(__self__, opts: Optional[pulumi.ResourceOptions] = None, container_definitions: Optional[pulumi.Input[Sequence[pulumi.Input[Union['TaskDefinitionContainerDefinitionArgs', 'TaskDefinitionContainerDefinitionArgsDict']]]]] = None, cpu: Optional[pulumi.Input[str]] = None, + enable_fault_injection: Optional[pulumi.Input[bool]] = None, ephemeral_storage: Optional[pulumi.Input[Union['TaskDefinitionEphemeralStorageArgs', 'TaskDefinitionEphemeralStorageArgsDict']]] = None, execution_role_arn: Optional[pulumi.Input[str]] = None, family: Optional[pulumi.Input[str]] = None, @@ -917,6 +931,7 @@ def _internal_init(__self__, __props__.__dict__["container_definitions"] = container_definitions __props__.__dict__["cpu"] = cpu + __props__.__dict__["enable_fault_injection"] = enable_fault_injection __props__.__dict__["ephemeral_storage"] = ephemeral_storage __props__.__dict__["execution_role_arn"] = execution_role_arn __props__.__dict__["family"] = family @@ -933,7 +948,7 @@ def _internal_init(__self__, __props__.__dict__["task_role_arn"] = task_role_arn __props__.__dict__["volumes"] = volumes __props__.__dict__["task_definition_arn"] = None - replace_on_changes = pulumi.ResourceOptions(replace_on_changes=["containerDefinitions[*]", "cpu", "ephemeralStorage", "executionRoleArn", "family", "inferenceAccelerators[*]", "ipcMode", "memory", "networkMode", "pidMode", "placementConstraints[*]", "proxyConfiguration", "requiresCompatibilities[*]", "runtimePlatform", "taskRoleArn", "volumes[*]"]) + replace_on_changes = pulumi.ResourceOptions(replace_on_changes=["containerDefinitions[*]", "cpu", "enableFaultInjection", "ephemeralStorage", "executionRoleArn", "family", "inferenceAccelerators[*]", "ipcMode", "memory", "networkMode", "pidMode", "placementConstraints[*]", "proxyConfiguration", "requiresCompatibilities[*]", "runtimePlatform", "taskRoleArn", "volumes[*]"]) opts = pulumi.ResourceOptions.merge(opts, replace_on_changes) super(TaskDefinition, __self__).__init__( 'aws-native:ecs:TaskDefinition', @@ -959,6 +974,7 @@ def get(resource_name: str, __props__.__dict__["container_definitions"] = None __props__.__dict__["cpu"] = None + __props__.__dict__["enable_fault_injection"] = None __props__.__dict__["ephemeral_storage"] = None __props__.__dict__["execution_role_arn"] = None __props__.__dict__["family"] = None @@ -1004,6 +1020,11 @@ def cpu(self) -> pulumi.Output[Optional[str]]: """ return pulumi.get(self, "cpu") + @property + @pulumi.getter(name="enableFaultInjection") + def enable_fault_injection(self) -> pulumi.Output[Optional[bool]]: + return pulumi.get(self, "enable_fault_injection") + @property @pulumi.getter(name="ephemeralStorage") def ephemeral_storage(self) -> pulumi.Output[Optional['outputs.TaskDefinitionEphemeralStorage']]: diff --git a/sdk/python/pulumi_aws_native/events/_inputs.py b/sdk/python/pulumi_aws_native/events/_inputs.py index 52347ee90f..fc395aa34f 100644 --- a/sdk/python/pulumi_aws_native/events/_inputs.py +++ b/sdk/python/pulumi_aws_native/events/_inputs.py @@ -161,6 +161,11 @@ class ConnectionAuthParametersArgsDict(TypedDict): The authorization parameters for Basic authorization. """ connectivity_parameters: NotRequired[pulumi.Input['ConnectionConnectivityParametersArgsDict']] + """ + For private OAuth authentication endpoints. The parameters EventBridge uses to authenticate against the endpoint. + + For more information, see [Authorization methods for connections](https://docs.aws.amazon.com/eventbridge/latest/userguide/eb-target-connection-auth.html) in the **Amazon EventBridge User Guide** . + """ invocation_http_parameters: NotRequired[pulumi.Input['ConnectionHttpParametersArgsDict']] """ Additional parameters for the connection that are passed through with every invocation to the HTTP endpoint. @@ -183,6 +188,9 @@ def __init__(__self__, *, """ :param pulumi.Input['ConnectionApiKeyAuthParametersArgs'] api_key_auth_parameters: The API Key parameters to use for authorization. :param pulumi.Input['ConnectionBasicAuthParametersArgs'] basic_auth_parameters: The authorization parameters for Basic authorization. + :param pulumi.Input['ConnectionConnectivityParametersArgs'] connectivity_parameters: For private OAuth authentication endpoints. The parameters EventBridge uses to authenticate against the endpoint. + + For more information, see [Authorization methods for connections](https://docs.aws.amazon.com/eventbridge/latest/userguide/eb-target-connection-auth.html) in the **Amazon EventBridge User Guide** . :param pulumi.Input['ConnectionHttpParametersArgs'] invocation_http_parameters: Additional parameters for the connection that are passed through with every invocation to the HTTP endpoint. :param pulumi.Input['ConnectionOAuthParametersArgs'] o_auth_parameters: The OAuth parameters to use for authorization. """ @@ -224,6 +232,11 @@ def basic_auth_parameters(self, value: Optional[pulumi.Input['ConnectionBasicAut @property @pulumi.getter(name="connectivityParameters") def connectivity_parameters(self) -> Optional[pulumi.Input['ConnectionConnectivityParametersArgs']]: + """ + For private OAuth authentication endpoints. The parameters EventBridge uses to authenticate against the endpoint. + + For more information, see [Authorization methods for connections](https://docs.aws.amazon.com/eventbridge/latest/userguide/eb-target-connection-auth.html) in the **Amazon EventBridge User Guide** . + """ return pulumi.get(self, "connectivity_parameters") @connectivity_parameters.setter @@ -358,6 +371,9 @@ def client_secret(self, value: pulumi.Input[str]): if not MYPY: class ConnectionConnectivityParametersArgsDict(TypedDict): resource_parameters: pulumi.Input['ConnectionResourceParametersArgsDict'] + """ + The parameters for EventBridge to use when invoking the resource endpoint. + """ elif False: ConnectionConnectivityParametersArgsDict: TypeAlias = Mapping[str, Any] @@ -365,11 +381,17 @@ class ConnectionConnectivityParametersArgsDict(TypedDict): class ConnectionConnectivityParametersArgs: def __init__(__self__, *, resource_parameters: pulumi.Input['ConnectionResourceParametersArgs']): + """ + :param pulumi.Input['ConnectionResourceParametersArgs'] resource_parameters: The parameters for EventBridge to use when invoking the resource endpoint. + """ pulumi.set(__self__, "resource_parameters", resource_parameters) @property @pulumi.getter(name="resourceParameters") def resource_parameters(self) -> pulumi.Input['ConnectionResourceParametersArgs']: + """ + The parameters for EventBridge to use when invoking the resource endpoint. + """ return pulumi.get(self, "resource_parameters") @resource_parameters.setter @@ -611,7 +633,15 @@ def is_value_secret(self, value: Optional[pulumi.Input[bool]]): if not MYPY: class ConnectionResourceParametersArgsDict(TypedDict): resource_configuration_arn: pulumi.Input[str] + """ + The Amazon Resource Name (ARN) of the Amazon VPC Lattice resource configuration for the resource endpoint. + """ resource_association_arn: NotRequired[pulumi.Input[str]] + """ + For connections to private APIs, the Amazon Resource Name (ARN) of the resource association EventBridge created between the connection and the private API's resource configuration. + + > The value of this property is set by EventBridge . Any value you specify in your template is ignored. + """ elif False: ConnectionResourceParametersArgsDict: TypeAlias = Mapping[str, Any] @@ -620,6 +650,12 @@ class ConnectionResourceParametersArgs: def __init__(__self__, *, resource_configuration_arn: pulumi.Input[str], resource_association_arn: Optional[pulumi.Input[str]] = None): + """ + :param pulumi.Input[str] resource_configuration_arn: The Amazon Resource Name (ARN) of the Amazon VPC Lattice resource configuration for the resource endpoint. + :param pulumi.Input[str] resource_association_arn: For connections to private APIs, the Amazon Resource Name (ARN) of the resource association EventBridge created between the connection and the private API's resource configuration. + + > The value of this property is set by EventBridge . Any value you specify in your template is ignored. + """ pulumi.set(__self__, "resource_configuration_arn", resource_configuration_arn) if resource_association_arn is not None: pulumi.set(__self__, "resource_association_arn", resource_association_arn) @@ -627,6 +663,9 @@ def __init__(__self__, *, @property @pulumi.getter(name="resourceConfigurationArn") def resource_configuration_arn(self) -> pulumi.Input[str]: + """ + The Amazon Resource Name (ARN) of the Amazon VPC Lattice resource configuration for the resource endpoint. + """ return pulumi.get(self, "resource_configuration_arn") @resource_configuration_arn.setter @@ -636,6 +675,11 @@ def resource_configuration_arn(self, value: pulumi.Input[str]): @property @pulumi.getter(name="resourceAssociationArn") def resource_association_arn(self) -> Optional[pulumi.Input[str]]: + """ + For connections to private APIs, the Amazon Resource Name (ARN) of the resource association EventBridge created between the connection and the private API's resource configuration. + + > The value of this property is set by EventBridge . Any value you specify in your template is ignored. + """ return pulumi.get(self, "resource_association_arn") @resource_association_arn.setter @@ -881,6 +925,9 @@ class InvocationConnectivityParametersPropertiesArgsDict(TypedDict): The private resource the HTTP request will be sent to. """ resource_parameters: pulumi.Input['ConnectionResourceParametersArgsDict'] + """ + The parameters for EventBridge to use when invoking the resource endpoint. + """ elif False: InvocationConnectivityParametersPropertiesArgsDict: TypeAlias = Mapping[str, Any] @@ -890,12 +937,16 @@ def __init__(__self__, *, resource_parameters: pulumi.Input['ConnectionResourceParametersArgs']): """ The private resource the HTTP request will be sent to. + :param pulumi.Input['ConnectionResourceParametersArgs'] resource_parameters: The parameters for EventBridge to use when invoking the resource endpoint. """ pulumi.set(__self__, "resource_parameters", resource_parameters) @property @pulumi.getter(name="resourceParameters") def resource_parameters(self) -> pulumi.Input['ConnectionResourceParametersArgs']: + """ + The parameters for EventBridge to use when invoking the resource endpoint. + """ return pulumi.get(self, "resource_parameters") @resource_parameters.setter diff --git a/sdk/python/pulumi_aws_native/events/outputs.py b/sdk/python/pulumi_aws_native/events/outputs.py index 90b01bb58a..f9d4ddacd7 100644 --- a/sdk/python/pulumi_aws_native/events/outputs.py +++ b/sdk/python/pulumi_aws_native/events/outputs.py @@ -143,6 +143,9 @@ def __init__(__self__, *, """ :param 'ConnectionApiKeyAuthParameters' api_key_auth_parameters: The API Key parameters to use for authorization. :param 'ConnectionBasicAuthParameters' basic_auth_parameters: The authorization parameters for Basic authorization. + :param 'ConnectionConnectivityParameters' connectivity_parameters: For private OAuth authentication endpoints. The parameters EventBridge uses to authenticate against the endpoint. + + For more information, see [Authorization methods for connections](https://docs.aws.amazon.com/eventbridge/latest/userguide/eb-target-connection-auth.html) in the **Amazon EventBridge User Guide** . :param 'ConnectionHttpParameters' invocation_http_parameters: Additional parameters for the connection that are passed through with every invocation to the HTTP endpoint. :param 'ConnectionOAuthParameters' o_auth_parameters: The OAuth parameters to use for authorization. """ @@ -176,6 +179,11 @@ def basic_auth_parameters(self) -> Optional['outputs.ConnectionBasicAuthParamete @property @pulumi.getter(name="connectivityParameters") def connectivity_parameters(self) -> Optional['outputs.ConnectionConnectivityParameters']: + """ + For private OAuth authentication endpoints. The parameters EventBridge uses to authenticate against the endpoint. + + For more information, see [Authorization methods for connections](https://docs.aws.amazon.com/eventbridge/latest/userguide/eb-target-connection-auth.html) in the **Amazon EventBridge User Guide** . + """ return pulumi.get(self, "connectivity_parameters") @property @@ -293,11 +301,17 @@ def get(self, key: str, default = None) -> Any: def __init__(__self__, *, resource_parameters: 'outputs.ConnectionResourceParameters'): + """ + :param 'ConnectionResourceParameters' resource_parameters: The parameters for EventBridge to use when invoking the resource endpoint. + """ pulumi.set(__self__, "resource_parameters", resource_parameters) @property @pulumi.getter(name="resourceParameters") def resource_parameters(self) -> 'outputs.ConnectionResourceParameters': + """ + The parameters for EventBridge to use when invoking the resource endpoint. + """ return pulumi.get(self, "resource_parameters") @@ -522,6 +536,12 @@ def get(self, key: str, default = None) -> Any: def __init__(__self__, *, resource_configuration_arn: str, resource_association_arn: Optional[str] = None): + """ + :param str resource_configuration_arn: The Amazon Resource Name (ARN) of the Amazon VPC Lattice resource configuration for the resource endpoint. + :param str resource_association_arn: For connections to private APIs, the Amazon Resource Name (ARN) of the resource association EventBridge created between the connection and the private API's resource configuration. + + > The value of this property is set by EventBridge . Any value you specify in your template is ignored. + """ pulumi.set(__self__, "resource_configuration_arn", resource_configuration_arn) if resource_association_arn is not None: pulumi.set(__self__, "resource_association_arn", resource_association_arn) @@ -529,11 +549,19 @@ def __init__(__self__, *, @property @pulumi.getter(name="resourceConfigurationArn") def resource_configuration_arn(self) -> str: + """ + The Amazon Resource Name (ARN) of the Amazon VPC Lattice resource configuration for the resource endpoint. + """ return pulumi.get(self, "resource_configuration_arn") @property @pulumi.getter(name="resourceAssociationArn") def resource_association_arn(self) -> Optional[str]: + """ + For connections to private APIs, the Amazon Resource Name (ARN) of the resource association EventBridge created between the connection and the private API's resource configuration. + + > The value of this property is set by EventBridge . Any value you specify in your template is ignored. + """ return pulumi.get(self, "resource_association_arn") @@ -750,12 +778,16 @@ def __init__(__self__, *, resource_parameters: 'outputs.ConnectionResourceParameters'): """ The private resource the HTTP request will be sent to. + :param 'ConnectionResourceParameters' resource_parameters: The parameters for EventBridge to use when invoking the resource endpoint. """ pulumi.set(__self__, "resource_parameters", resource_parameters) @property @pulumi.getter(name="resourceParameters") def resource_parameters(self) -> 'outputs.ConnectionResourceParameters': + """ + The parameters for EventBridge to use when invoking the resource endpoint. + """ return pulumi.get(self, "resource_parameters") diff --git a/sdk/python/pulumi_aws_native/internetmonitor/get_monitor.py b/sdk/python/pulumi_aws_native/internetmonitor/get_monitor.py index 8465e6a18d..482461236d 100644 --- a/sdk/python/pulumi_aws_native/internetmonitor/get_monitor.py +++ b/sdk/python/pulumi_aws_native/internetmonitor/get_monitor.py @@ -78,7 +78,7 @@ def health_events_config(self) -> Optional['outputs.MonitorHealthEventsConfig']: """ A complex type with the configuration information that determines the threshold and other conditions for when Internet Monitor creates a health event for an overall performance or availability issue, across an application's geographies. - Defines the percentages, for overall performance scores and availability scores for an application, that are the thresholds for when Amazon CloudWatch Internet Monitor creates a health event. You can override the defaults to set a custom threshold for overall performance or availability scores, or both. + Defines the percentages, for overall performance scores and availability scores for an application, that are the thresholds for when Internet Monitor creates a health event. You can override the defaults to set a custom threshold for overall performance or availability scores, or both. You can also set thresholds for local health scores,, where Internet Monitor creates a health event when scores cross a threshold for one or more city-networks, in addition to creating an event when an overall score crosses a threshold. diff --git a/sdk/python/pulumi_aws_native/internetmonitor/monitor.py b/sdk/python/pulumi_aws_native/internetmonitor/monitor.py index 2756754236..7925cd93f3 100644 --- a/sdk/python/pulumi_aws_native/internetmonitor/monitor.py +++ b/sdk/python/pulumi_aws_native/internetmonitor/monitor.py @@ -40,7 +40,7 @@ def __init__(__self__, *, The set of arguments for constructing a Monitor resource. :param pulumi.Input['MonitorHealthEventsConfigArgs'] health_events_config: A complex type with the configuration information that determines the threshold and other conditions for when Internet Monitor creates a health event for an overall performance or availability issue, across an application's geographies. - Defines the percentages, for overall performance scores and availability scores for an application, that are the thresholds for when Amazon CloudWatch Internet Monitor creates a health event. You can override the defaults to set a custom threshold for overall performance or availability scores, or both. + Defines the percentages, for overall performance scores and availability scores for an application, that are the thresholds for when Internet Monitor creates a health event. You can override the defaults to set a custom threshold for overall performance or availability scores, or both. You can also set thresholds for local health scores,, where Internet Monitor creates a health event when scores cross a threshold for one or more city-networks, in addition to creating an event when an overall score crosses a threshold. @@ -104,7 +104,7 @@ def health_events_config(self) -> Optional[pulumi.Input['MonitorHealthEventsConf """ A complex type with the configuration information that determines the threshold and other conditions for when Internet Monitor creates a health event for an overall performance or availability issue, across an application's geographies. - Defines the percentages, for overall performance scores and availability scores for an application, that are the thresholds for when Amazon CloudWatch Internet Monitor creates a health event. You can override the defaults to set a custom threshold for overall performance or availability scores, or both. + Defines the percentages, for overall performance scores and availability scores for an application, that are the thresholds for when Internet Monitor creates a health event. You can override the defaults to set a custom threshold for overall performance or availability scores, or both. You can also set thresholds for local health scores,, where Internet Monitor creates a health event when scores cross a threshold for one or more city-networks, in addition to creating an event when an overall score crosses a threshold. @@ -290,7 +290,7 @@ def __init__(__self__, :param pulumi.ResourceOptions opts: Options for the resource. :param pulumi.Input[Union['MonitorHealthEventsConfigArgs', 'MonitorHealthEventsConfigArgsDict']] health_events_config: A complex type with the configuration information that determines the threshold and other conditions for when Internet Monitor creates a health event for an overall performance or availability issue, across an application's geographies. - Defines the percentages, for overall performance scores and availability scores for an application, that are the thresholds for when Amazon CloudWatch Internet Monitor creates a health event. You can override the defaults to set a custom threshold for overall performance or availability scores, or both. + Defines the percentages, for overall performance scores and availability scores for an application, that are the thresholds for when Internet Monitor creates a health event. You can override the defaults to set a custom threshold for overall performance or availability scores, or both. You can also set thresholds for local health scores,, where Internet Monitor creates a health event when scores cross a threshold for one or more city-networks, in addition to creating an event when an overall score crosses a threshold. @@ -442,7 +442,7 @@ def health_events_config(self) -> pulumi.Output[Optional['outputs.MonitorHealthE """ A complex type with the configuration information that determines the threshold and other conditions for when Internet Monitor creates a health event for an overall performance or availability issue, across an application's geographies. - Defines the percentages, for overall performance scores and availability scores for an application, that are the thresholds for when Amazon CloudWatch Internet Monitor creates a health event. You can override the defaults to set a custom threshold for overall performance or availability scores, or both. + Defines the percentages, for overall performance scores and availability scores for an application, that are the thresholds for when Internet Monitor creates a health event. You can override the defaults to set a custom threshold for overall performance or availability scores, or both. You can also set thresholds for local health scores,, where Internet Monitor creates a health event when scores cross a threshold for one or more city-networks, in addition to creating an event when an overall score crosses a threshold. diff --git a/sdk/python/pulumi_aws_native/invoicing/_inputs.py b/sdk/python/pulumi_aws_native/invoicing/_inputs.py index ae2b29ea99..3c465f2ca6 100644 --- a/sdk/python/pulumi_aws_native/invoicing/_inputs.py +++ b/sdk/python/pulumi_aws_native/invoicing/_inputs.py @@ -24,6 +24,9 @@ if not MYPY: class InvoiceUnitRuleArgsDict(TypedDict): linked_accounts: pulumi.Input[Sequence[pulumi.Input[str]]] + """ + The list of `LINKED_ACCOUNT` IDs where charges are included within the invoice unit. + """ elif False: InvoiceUnitRuleArgsDict: TypeAlias = Mapping[str, Any] @@ -31,11 +34,17 @@ class InvoiceUnitRuleArgsDict(TypedDict): class InvoiceUnitRuleArgs: def __init__(__self__, *, linked_accounts: pulumi.Input[Sequence[pulumi.Input[str]]]): + """ + :param pulumi.Input[Sequence[pulumi.Input[str]]] linked_accounts: The list of `LINKED_ACCOUNT` IDs where charges are included within the invoice unit. + """ pulumi.set(__self__, "linked_accounts", linked_accounts) @property @pulumi.getter(name="linkedAccounts") def linked_accounts(self) -> pulumi.Input[Sequence[pulumi.Input[str]]]: + """ + The list of `LINKED_ACCOUNT` IDs where charges are included within the invoice unit. + """ return pulumi.get(self, "linked_accounts") @linked_accounts.setter diff --git a/sdk/python/pulumi_aws_native/invoicing/get_invoice_unit.py b/sdk/python/pulumi_aws_native/invoicing/get_invoice_unit.py index b0bc73d199..93cb195e96 100644 --- a/sdk/python/pulumi_aws_native/invoicing/get_invoice_unit.py +++ b/sdk/python/pulumi_aws_native/invoicing/get_invoice_unit.py @@ -48,31 +48,49 @@ def __init__(__self__, description=None, invoice_unit_arn=None, last_modified=No @property @pulumi.getter def description(self) -> Optional[str]: + """ + The assigned description for an invoice unit. This information can't be modified or deleted. + """ return pulumi.get(self, "description") @property @pulumi.getter(name="invoiceUnitArn") def invoice_unit_arn(self) -> Optional[str]: + """ + The ARN to identify an invoice unit. This information can't be modified or deleted. + """ return pulumi.get(self, "invoice_unit_arn") @property @pulumi.getter(name="lastModified") def last_modified(self) -> Optional[float]: + """ + The last time the invoice unit was updated. This is important to determine the version of invoice unit configuration used to create the invoices. Any invoice created after this modified time will use this invoice unit configuration. + """ return pulumi.get(self, "last_modified") @property @pulumi.getter(name="resourceTags") def resource_tags(self) -> Optional[Sequence['_root_outputs.Tag']]: + """ + The tag structure that contains a tag key and value. + """ return pulumi.get(self, "resource_tags") @property @pulumi.getter def rule(self) -> Optional['outputs.InvoiceUnitRule']: + """ + An `InvoiceUnitRule` object used the categorize invoice units. + """ return pulumi.get(self, "rule") @property @pulumi.getter(name="taxInheritanceDisabled") def tax_inheritance_disabled(self) -> Optional[bool]: + """ + Whether the invoice unit based tax inheritance is/ should be enabled or disabled. + """ return pulumi.get(self, "tax_inheritance_disabled") @@ -94,6 +112,9 @@ def get_invoice_unit(invoice_unit_arn: Optional[str] = None, opts: Optional[pulumi.InvokeOptions] = None) -> AwaitableGetInvoiceUnitResult: """ An invoice unit is a set of mutually exclusive accounts that correspond to your business entity. Invoice units allow you to separate AWS account costs and configures your invoice for each business entity. + + + :param str invoice_unit_arn: The ARN to identify an invoice unit. This information can't be modified or deleted. """ __args__ = dict() __args__['invoiceUnitArn'] = invoice_unit_arn @@ -111,6 +132,9 @@ def get_invoice_unit_output(invoice_unit_arn: Optional[pulumi.Input[str]] = None opts: Optional[Union[pulumi.InvokeOptions, pulumi.InvokeOutputOptions]] = None) -> pulumi.Output[GetInvoiceUnitResult]: """ An invoice unit is a set of mutually exclusive accounts that correspond to your business entity. Invoice units allow you to separate AWS account costs and configures your invoice for each business entity. + + + :param str invoice_unit_arn: The ARN to identify an invoice unit. This information can't be modified or deleted. """ __args__ = dict() __args__['invoiceUnitArn'] = invoice_unit_arn diff --git a/sdk/python/pulumi_aws_native/invoicing/invoice_unit.py b/sdk/python/pulumi_aws_native/invoicing/invoice_unit.py index 4b0d7fcf41..bb57466920 100644 --- a/sdk/python/pulumi_aws_native/invoicing/invoice_unit.py +++ b/sdk/python/pulumi_aws_native/invoicing/invoice_unit.py @@ -31,6 +31,12 @@ def __init__(__self__, *, tax_inheritance_disabled: Optional[pulumi.Input[bool]] = None): """ The set of arguments for constructing a InvoiceUnit resource. + :param pulumi.Input[str] invoice_receiver: The account that receives invoices related to the invoice unit. + :param pulumi.Input['InvoiceUnitRuleArgs'] rule: An `InvoiceUnitRule` object used the categorize invoice units. + :param pulumi.Input[str] description: The assigned description for an invoice unit. This information can't be modified or deleted. + :param pulumi.Input[str] name: A unique name that is distinctive within your AWS . + :param pulumi.Input[Sequence[pulumi.Input['_root_inputs.TagArgs']]] resource_tags: The tag structure that contains a tag key and value. + :param pulumi.Input[bool] tax_inheritance_disabled: Whether the invoice unit based tax inheritance is/ should be enabled or disabled. """ pulumi.set(__self__, "invoice_receiver", invoice_receiver) pulumi.set(__self__, "rule", rule) @@ -46,6 +52,9 @@ def __init__(__self__, *, @property @pulumi.getter(name="invoiceReceiver") def invoice_receiver(self) -> pulumi.Input[str]: + """ + The account that receives invoices related to the invoice unit. + """ return pulumi.get(self, "invoice_receiver") @invoice_receiver.setter @@ -55,6 +64,9 @@ def invoice_receiver(self, value: pulumi.Input[str]): @property @pulumi.getter def rule(self) -> pulumi.Input['InvoiceUnitRuleArgs']: + """ + An `InvoiceUnitRule` object used the categorize invoice units. + """ return pulumi.get(self, "rule") @rule.setter @@ -64,6 +76,9 @@ def rule(self, value: pulumi.Input['InvoiceUnitRuleArgs']): @property @pulumi.getter def description(self) -> Optional[pulumi.Input[str]]: + """ + The assigned description for an invoice unit. This information can't be modified or deleted. + """ return pulumi.get(self, "description") @description.setter @@ -73,6 +88,9 @@ def description(self, value: Optional[pulumi.Input[str]]): @property @pulumi.getter def name(self) -> Optional[pulumi.Input[str]]: + """ + A unique name that is distinctive within your AWS . + """ return pulumi.get(self, "name") @name.setter @@ -82,6 +100,9 @@ def name(self, value: Optional[pulumi.Input[str]]): @property @pulumi.getter(name="resourceTags") def resource_tags(self) -> Optional[pulumi.Input[Sequence[pulumi.Input['_root_inputs.TagArgs']]]]: + """ + The tag structure that contains a tag key and value. + """ return pulumi.get(self, "resource_tags") @resource_tags.setter @@ -91,6 +112,9 @@ def resource_tags(self, value: Optional[pulumi.Input[Sequence[pulumi.Input['_roo @property @pulumi.getter(name="taxInheritanceDisabled") def tax_inheritance_disabled(self) -> Optional[pulumi.Input[bool]]: + """ + Whether the invoice unit based tax inheritance is/ should be enabled or disabled. + """ return pulumi.get(self, "tax_inheritance_disabled") @tax_inheritance_disabled.setter @@ -115,6 +139,12 @@ def __init__(__self__, :param str resource_name: The name of the resource. :param pulumi.ResourceOptions opts: Options for the resource. + :param pulumi.Input[str] description: The assigned description for an invoice unit. This information can't be modified or deleted. + :param pulumi.Input[str] invoice_receiver: The account that receives invoices related to the invoice unit. + :param pulumi.Input[str] name: A unique name that is distinctive within your AWS . + :param pulumi.Input[Sequence[pulumi.Input[Union['_root_inputs.TagArgs', '_root_inputs.TagArgsDict']]]] resource_tags: The tag structure that contains a tag key and value. + :param pulumi.Input[Union['InvoiceUnitRuleArgs', 'InvoiceUnitRuleArgsDict']] rule: An `InvoiceUnitRule` object used the categorize invoice units. + :param pulumi.Input[bool] tax_inheritance_disabled: Whether the invoice unit based tax inheritance is/ should be enabled or disabled. """ ... @overload @@ -204,40 +234,64 @@ def get(resource_name: str, @property @pulumi.getter def description(self) -> pulumi.Output[Optional[str]]: + """ + The assigned description for an invoice unit. This information can't be modified or deleted. + """ return pulumi.get(self, "description") @property @pulumi.getter(name="invoiceReceiver") def invoice_receiver(self) -> pulumi.Output[str]: + """ + The account that receives invoices related to the invoice unit. + """ return pulumi.get(self, "invoice_receiver") @property @pulumi.getter(name="invoiceUnitArn") def invoice_unit_arn(self) -> pulumi.Output[str]: + """ + The ARN to identify an invoice unit. This information can't be modified or deleted. + """ return pulumi.get(self, "invoice_unit_arn") @property @pulumi.getter(name="lastModified") def last_modified(self) -> pulumi.Output[float]: + """ + The last time the invoice unit was updated. This is important to determine the version of invoice unit configuration used to create the invoices. Any invoice created after this modified time will use this invoice unit configuration. + """ return pulumi.get(self, "last_modified") @property @pulumi.getter def name(self) -> pulumi.Output[str]: + """ + A unique name that is distinctive within your AWS . + """ return pulumi.get(self, "name") @property @pulumi.getter(name="resourceTags") def resource_tags(self) -> pulumi.Output[Optional[Sequence['_root_outputs.Tag']]]: + """ + The tag structure that contains a tag key and value. + """ return pulumi.get(self, "resource_tags") @property @pulumi.getter def rule(self) -> pulumi.Output['outputs.InvoiceUnitRule']: + """ + An `InvoiceUnitRule` object used the categorize invoice units. + """ return pulumi.get(self, "rule") @property @pulumi.getter(name="taxInheritanceDisabled") def tax_inheritance_disabled(self) -> pulumi.Output[Optional[bool]]: + """ + Whether the invoice unit based tax inheritance is/ should be enabled or disabled. + """ return pulumi.get(self, "tax_inheritance_disabled") diff --git a/sdk/python/pulumi_aws_native/invoicing/outputs.py b/sdk/python/pulumi_aws_native/invoicing/outputs.py index e71dac952b..3af4b94e94 100644 --- a/sdk/python/pulumi_aws_native/invoicing/outputs.py +++ b/sdk/python/pulumi_aws_native/invoicing/outputs.py @@ -39,11 +39,17 @@ def get(self, key: str, default = None) -> Any: def __init__(__self__, *, linked_accounts: Sequence[str]): + """ + :param Sequence[str] linked_accounts: The list of `LINKED_ACCOUNT` IDs where charges are included within the invoice unit. + """ pulumi.set(__self__, "linked_accounts", linked_accounts) @property @pulumi.getter(name="linkedAccounts") def linked_accounts(self) -> Sequence[str]: + """ + The list of `LINKED_ACCOUNT` IDs where charges are included within the invoice unit. + """ return pulumi.get(self, "linked_accounts") diff --git a/sdk/python/pulumi_aws_native/iot/__init__.py b/sdk/python/pulumi_aws_native/iot/__init__.py index d16ba7cbc5..2d97bd71aa 100644 --- a/sdk/python/pulumi_aws_native/iot/__init__.py +++ b/sdk/python/pulumi_aws_native/iot/__init__.py @@ -12,6 +12,7 @@ from .ca_certificate import * from .certificate import * from .certificate_provider import * +from .command import * from .custom_metric import * from .dimension import * from .domain_configuration import * @@ -22,6 +23,7 @@ from .get_ca_certificate import * from .get_certificate import * from .get_certificate_provider import * +from .get_command import * from .get_custom_metric import * from .get_dimension import * from .get_domain_configuration import * diff --git a/sdk/python/pulumi_aws_native/iot/_enums.py b/sdk/python/pulumi_aws_native/iot/_enums.py index fb91ab4fac..4ecda0e3ff 100644 --- a/sdk/python/pulumi_aws_native/iot/_enums.py +++ b/sdk/python/pulumi_aws_native/iot/_enums.py @@ -12,6 +12,7 @@ 'CertificateMode', 'CertificateProviderOperation', 'CertificateStatus', + 'CommandNamespace', 'CustomMetricMetricType', 'DimensionType', 'DomainConfigurationApplicationProtocol', @@ -115,6 +116,14 @@ class CertificateStatus(str, Enum): PENDING_ACTIVATION = "PENDING_ACTIVATION" +class CommandNamespace(str, Enum): + """ + The namespace to which the command belongs. + """ + AWS_IO_T = "AWS-IoT" + AWS_IO_T_FLEET_WISE = "AWS-IoT-FleetWise" + + class CustomMetricMetricType(str, Enum): """ The type of the custom metric. Types include string-list, ip-address-list, number-list, and number. diff --git a/sdk/python/pulumi_aws_native/iot/_inputs.py b/sdk/python/pulumi_aws_native/iot/_inputs.py index fd243e3161..e01d9535ab 100644 --- a/sdk/python/pulumi_aws_native/iot/_inputs.py +++ b/sdk/python/pulumi_aws_native/iot/_inputs.py @@ -30,6 +30,12 @@ 'BillingGroupPropertiesPropertiesArgsDict', 'CaCertificateRegistrationConfigArgs', 'CaCertificateRegistrationConfigArgsDict', + 'CommandParameterValueArgs', + 'CommandParameterValueArgsDict', + 'CommandParameterArgs', + 'CommandParameterArgsDict', + 'CommandPayloadArgs', + 'CommandPayloadArgsDict', 'DomainConfigurationAuthorizerConfigArgs', 'DomainConfigurationAuthorizerConfigArgsDict', 'DomainConfigurationClientCertificateConfigArgs', @@ -811,6 +817,204 @@ def template_name(self, value: Optional[pulumi.Input[str]]): pulumi.set(self, "template_name", value) +if not MYPY: + class CommandParameterValueArgsDict(TypedDict): + b: NotRequired[pulumi.Input[bool]] + bin: NotRequired[pulumi.Input[str]] + d: NotRequired[pulumi.Input[float]] + i: NotRequired[pulumi.Input[int]] + l: NotRequired[pulumi.Input[str]] + s: NotRequired[pulumi.Input[str]] + ul: NotRequired[pulumi.Input[str]] +elif False: + CommandParameterValueArgsDict: TypeAlias = Mapping[str, Any] + +@pulumi.input_type +class CommandParameterValueArgs: + def __init__(__self__, *, + b: Optional[pulumi.Input[bool]] = None, + bin: Optional[pulumi.Input[str]] = None, + d: Optional[pulumi.Input[float]] = None, + i: Optional[pulumi.Input[int]] = None, + l: Optional[pulumi.Input[str]] = None, + s: Optional[pulumi.Input[str]] = None, + ul: Optional[pulumi.Input[str]] = None): + if b is not None: + pulumi.set(__self__, "b", b) + if bin is not None: + pulumi.set(__self__, "bin", bin) + if d is not None: + pulumi.set(__self__, "d", d) + if i is not None: + pulumi.set(__self__, "i", i) + if l is not None: + pulumi.set(__self__, "l", l) + if s is not None: + pulumi.set(__self__, "s", s) + if ul is not None: + pulumi.set(__self__, "ul", ul) + + @property + @pulumi.getter + def b(self) -> Optional[pulumi.Input[bool]]: + return pulumi.get(self, "b") + + @b.setter + def b(self, value: Optional[pulumi.Input[bool]]): + pulumi.set(self, "b", value) + + @property + @pulumi.getter + def bin(self) -> Optional[pulumi.Input[str]]: + return pulumi.get(self, "bin") + + @bin.setter + def bin(self, value: Optional[pulumi.Input[str]]): + pulumi.set(self, "bin", value) + + @property + @pulumi.getter + def d(self) -> Optional[pulumi.Input[float]]: + return pulumi.get(self, "d") + + @d.setter + def d(self, value: Optional[pulumi.Input[float]]): + pulumi.set(self, "d", value) + + @property + @pulumi.getter + def i(self) -> Optional[pulumi.Input[int]]: + return pulumi.get(self, "i") + + @i.setter + def i(self, value: Optional[pulumi.Input[int]]): + pulumi.set(self, "i", value) + + @property + @pulumi.getter + def l(self) -> Optional[pulumi.Input[str]]: + return pulumi.get(self, "l") + + @l.setter + def l(self, value: Optional[pulumi.Input[str]]): + pulumi.set(self, "l", value) + + @property + @pulumi.getter + def s(self) -> Optional[pulumi.Input[str]]: + return pulumi.get(self, "s") + + @s.setter + def s(self, value: Optional[pulumi.Input[str]]): + pulumi.set(self, "s", value) + + @property + @pulumi.getter + def ul(self) -> Optional[pulumi.Input[str]]: + return pulumi.get(self, "ul") + + @ul.setter + def ul(self, value: Optional[pulumi.Input[str]]): + pulumi.set(self, "ul", value) + + +if not MYPY: + class CommandParameterArgsDict(TypedDict): + name: pulumi.Input[str] + default_value: NotRequired[pulumi.Input['CommandParameterValueArgsDict']] + description: NotRequired[pulumi.Input[str]] + value: NotRequired[pulumi.Input['CommandParameterValueArgsDict']] +elif False: + CommandParameterArgsDict: TypeAlias = Mapping[str, Any] + +@pulumi.input_type +class CommandParameterArgs: + def __init__(__self__, *, + name: pulumi.Input[str], + default_value: Optional[pulumi.Input['CommandParameterValueArgs']] = None, + description: Optional[pulumi.Input[str]] = None, + value: Optional[pulumi.Input['CommandParameterValueArgs']] = None): + pulumi.set(__self__, "name", name) + if default_value is not None: + pulumi.set(__self__, "default_value", default_value) + if description is not None: + pulumi.set(__self__, "description", description) + if value is not None: + pulumi.set(__self__, "value", value) + + @property + @pulumi.getter + def name(self) -> pulumi.Input[str]: + return pulumi.get(self, "name") + + @name.setter + def name(self, value: pulumi.Input[str]): + pulumi.set(self, "name", value) + + @property + @pulumi.getter(name="defaultValue") + def default_value(self) -> Optional[pulumi.Input['CommandParameterValueArgs']]: + return pulumi.get(self, "default_value") + + @default_value.setter + def default_value(self, value: Optional[pulumi.Input['CommandParameterValueArgs']]): + pulumi.set(self, "default_value", value) + + @property + @pulumi.getter + def description(self) -> Optional[pulumi.Input[str]]: + return pulumi.get(self, "description") + + @description.setter + def description(self, value: Optional[pulumi.Input[str]]): + pulumi.set(self, "description", value) + + @property + @pulumi.getter + def value(self) -> Optional[pulumi.Input['CommandParameterValueArgs']]: + return pulumi.get(self, "value") + + @value.setter + def value(self, value: Optional[pulumi.Input['CommandParameterValueArgs']]): + pulumi.set(self, "value", value) + + +if not MYPY: + class CommandPayloadArgsDict(TypedDict): + content: NotRequired[pulumi.Input[str]] + content_type: NotRequired[pulumi.Input[str]] +elif False: + CommandPayloadArgsDict: TypeAlias = Mapping[str, Any] + +@pulumi.input_type +class CommandPayloadArgs: + def __init__(__self__, *, + content: Optional[pulumi.Input[str]] = None, + content_type: Optional[pulumi.Input[str]] = None): + if content is not None: + pulumi.set(__self__, "content", content) + if content_type is not None: + pulumi.set(__self__, "content_type", content_type) + + @property + @pulumi.getter + def content(self) -> Optional[pulumi.Input[str]]: + return pulumi.get(self, "content") + + @content.setter + def content(self, value: Optional[pulumi.Input[str]]): + pulumi.set(self, "content", value) + + @property + @pulumi.getter(name="contentType") + def content_type(self) -> Optional[pulumi.Input[str]]: + return pulumi.get(self, "content_type") + + @content_type.setter + def content_type(self, value: Optional[pulumi.Input[str]]): + pulumi.set(self, "content_type", value) + + if not MYPY: class DomainConfigurationAuthorizerConfigArgsDict(TypedDict): allow_authorizer_override: NotRequired[pulumi.Input[bool]] diff --git a/sdk/python/pulumi_aws_native/iot/command.py b/sdk/python/pulumi_aws_native/iot/command.py new file mode 100644 index 0000000000..999d8611cb --- /dev/null +++ b/sdk/python/pulumi_aws_native/iot/command.py @@ -0,0 +1,461 @@ +# coding=utf-8 +# *** WARNING: this file was generated by pulumi-language-python. *** +# *** Do not edit by hand unless you're certain you know what you are doing! *** + +import copy +import warnings +import sys +import pulumi +import pulumi.runtime +from typing import Any, Mapping, Optional, Sequence, Union, overload +if sys.version_info >= (3, 11): + from typing import NotRequired, TypedDict, TypeAlias +else: + from typing_extensions import NotRequired, TypedDict, TypeAlias +from .. import _utilities +from . import outputs +from .. import _inputs as _root_inputs +from .. import outputs as _root_outputs +from ._enums import * +from ._inputs import * + +__all__ = ['CommandArgs', 'Command'] + +@pulumi.input_type +class CommandArgs: + def __init__(__self__, *, + command_id: pulumi.Input[str], + created_at: Optional[pulumi.Input[str]] = None, + deprecated: Optional[pulumi.Input[bool]] = None, + description: Optional[pulumi.Input[str]] = None, + display_name: Optional[pulumi.Input[str]] = None, + last_updated_at: Optional[pulumi.Input[str]] = None, + mandatory_parameters: Optional[pulumi.Input[Sequence[pulumi.Input['CommandParameterArgs']]]] = None, + namespace: Optional[pulumi.Input['CommandNamespace']] = None, + payload: Optional[pulumi.Input['CommandPayloadArgs']] = None, + pending_deletion: Optional[pulumi.Input[bool]] = None, + role_arn: Optional[pulumi.Input[str]] = None, + tags: Optional[pulumi.Input[Sequence[pulumi.Input['_root_inputs.TagArgs']]]] = None): + """ + The set of arguments for constructing a Command resource. + :param pulumi.Input[str] command_id: The unique identifier for the command. + :param pulumi.Input[str] created_at: The date and time when the command was created. + :param pulumi.Input[bool] deprecated: A flag indicating whether the command is deprecated. + :param pulumi.Input[str] description: The description of the command. + :param pulumi.Input[str] display_name: The display name for the command. + :param pulumi.Input[str] last_updated_at: The date and time when the command was last updated. + :param pulumi.Input[Sequence[pulumi.Input['CommandParameterArgs']]] mandatory_parameters: The list of mandatory parameters for the command. + :param pulumi.Input['CommandNamespace'] namespace: The namespace to which the command belongs. + :param pulumi.Input['CommandPayloadArgs'] payload: The payload associated with the command. + :param pulumi.Input[bool] pending_deletion: A flag indicating whether the command is pending deletion. + :param pulumi.Input[str] role_arn: The customer role associated with the command. + :param pulumi.Input[Sequence[pulumi.Input['_root_inputs.TagArgs']]] tags: The tags to be associated with the command. + """ + pulumi.set(__self__, "command_id", command_id) + if created_at is not None: + pulumi.set(__self__, "created_at", created_at) + if deprecated is not None: + pulumi.set(__self__, "deprecated", deprecated) + if description is not None: + pulumi.set(__self__, "description", description) + if display_name is not None: + pulumi.set(__self__, "display_name", display_name) + if last_updated_at is not None: + pulumi.set(__self__, "last_updated_at", last_updated_at) + if mandatory_parameters is not None: + pulumi.set(__self__, "mandatory_parameters", mandatory_parameters) + if namespace is not None: + pulumi.set(__self__, "namespace", namespace) + if payload is not None: + pulumi.set(__self__, "payload", payload) + if pending_deletion is not None: + pulumi.set(__self__, "pending_deletion", pending_deletion) + if role_arn is not None: + pulumi.set(__self__, "role_arn", role_arn) + if tags is not None: + pulumi.set(__self__, "tags", tags) + + @property + @pulumi.getter(name="commandId") + def command_id(self) -> pulumi.Input[str]: + """ + The unique identifier for the command. + """ + return pulumi.get(self, "command_id") + + @command_id.setter + def command_id(self, value: pulumi.Input[str]): + pulumi.set(self, "command_id", value) + + @property + @pulumi.getter(name="createdAt") + def created_at(self) -> Optional[pulumi.Input[str]]: + """ + The date and time when the command was created. + """ + return pulumi.get(self, "created_at") + + @created_at.setter + def created_at(self, value: Optional[pulumi.Input[str]]): + pulumi.set(self, "created_at", value) + + @property + @pulumi.getter + def deprecated(self) -> Optional[pulumi.Input[bool]]: + """ + A flag indicating whether the command is deprecated. + """ + return pulumi.get(self, "deprecated") + + @deprecated.setter + def deprecated(self, value: Optional[pulumi.Input[bool]]): + pulumi.set(self, "deprecated", value) + + @property + @pulumi.getter + def description(self) -> Optional[pulumi.Input[str]]: + """ + The description of the command. + """ + return pulumi.get(self, "description") + + @description.setter + def description(self, value: Optional[pulumi.Input[str]]): + pulumi.set(self, "description", value) + + @property + @pulumi.getter(name="displayName") + def display_name(self) -> Optional[pulumi.Input[str]]: + """ + The display name for the command. + """ + return pulumi.get(self, "display_name") + + @display_name.setter + def display_name(self, value: Optional[pulumi.Input[str]]): + pulumi.set(self, "display_name", value) + + @property + @pulumi.getter(name="lastUpdatedAt") + def last_updated_at(self) -> Optional[pulumi.Input[str]]: + """ + The date and time when the command was last updated. + """ + return pulumi.get(self, "last_updated_at") + + @last_updated_at.setter + def last_updated_at(self, value: Optional[pulumi.Input[str]]): + pulumi.set(self, "last_updated_at", value) + + @property + @pulumi.getter(name="mandatoryParameters") + def mandatory_parameters(self) -> Optional[pulumi.Input[Sequence[pulumi.Input['CommandParameterArgs']]]]: + """ + The list of mandatory parameters for the command. + """ + return pulumi.get(self, "mandatory_parameters") + + @mandatory_parameters.setter + def mandatory_parameters(self, value: Optional[pulumi.Input[Sequence[pulumi.Input['CommandParameterArgs']]]]): + pulumi.set(self, "mandatory_parameters", value) + + @property + @pulumi.getter + def namespace(self) -> Optional[pulumi.Input['CommandNamespace']]: + """ + The namespace to which the command belongs. + """ + return pulumi.get(self, "namespace") + + @namespace.setter + def namespace(self, value: Optional[pulumi.Input['CommandNamespace']]): + pulumi.set(self, "namespace", value) + + @property + @pulumi.getter + def payload(self) -> Optional[pulumi.Input['CommandPayloadArgs']]: + """ + The payload associated with the command. + """ + return pulumi.get(self, "payload") + + @payload.setter + def payload(self, value: Optional[pulumi.Input['CommandPayloadArgs']]): + pulumi.set(self, "payload", value) + + @property + @pulumi.getter(name="pendingDeletion") + def pending_deletion(self) -> Optional[pulumi.Input[bool]]: + """ + A flag indicating whether the command is pending deletion. + """ + return pulumi.get(self, "pending_deletion") + + @pending_deletion.setter + def pending_deletion(self, value: Optional[pulumi.Input[bool]]): + pulumi.set(self, "pending_deletion", value) + + @property + @pulumi.getter(name="roleArn") + def role_arn(self) -> Optional[pulumi.Input[str]]: + """ + The customer role associated with the command. + """ + return pulumi.get(self, "role_arn") + + @role_arn.setter + def role_arn(self, value: Optional[pulumi.Input[str]]): + pulumi.set(self, "role_arn", value) + + @property + @pulumi.getter + def tags(self) -> Optional[pulumi.Input[Sequence[pulumi.Input['_root_inputs.TagArgs']]]]: + """ + The tags to be associated with the command. + """ + return pulumi.get(self, "tags") + + @tags.setter + def tags(self, value: Optional[pulumi.Input[Sequence[pulumi.Input['_root_inputs.TagArgs']]]]): + pulumi.set(self, "tags", value) + + +class Command(pulumi.CustomResource): + @overload + def __init__(__self__, + resource_name: str, + opts: Optional[pulumi.ResourceOptions] = None, + command_id: Optional[pulumi.Input[str]] = None, + created_at: Optional[pulumi.Input[str]] = None, + deprecated: Optional[pulumi.Input[bool]] = None, + description: Optional[pulumi.Input[str]] = None, + display_name: Optional[pulumi.Input[str]] = None, + last_updated_at: Optional[pulumi.Input[str]] = None, + mandatory_parameters: Optional[pulumi.Input[Sequence[pulumi.Input[Union['CommandParameterArgs', 'CommandParameterArgsDict']]]]] = None, + namespace: Optional[pulumi.Input['CommandNamespace']] = None, + payload: Optional[pulumi.Input[Union['CommandPayloadArgs', 'CommandPayloadArgsDict']]] = None, + pending_deletion: Optional[pulumi.Input[bool]] = None, + role_arn: Optional[pulumi.Input[str]] = None, + tags: Optional[pulumi.Input[Sequence[pulumi.Input[Union['_root_inputs.TagArgs', '_root_inputs.TagArgsDict']]]]] = None, + __props__=None): + """ + Represents the resource definition of AWS IoT Command. + + :param str resource_name: The name of the resource. + :param pulumi.ResourceOptions opts: Options for the resource. + :param pulumi.Input[str] command_id: The unique identifier for the command. + :param pulumi.Input[str] created_at: The date and time when the command was created. + :param pulumi.Input[bool] deprecated: A flag indicating whether the command is deprecated. + :param pulumi.Input[str] description: The description of the command. + :param pulumi.Input[str] display_name: The display name for the command. + :param pulumi.Input[str] last_updated_at: The date and time when the command was last updated. + :param pulumi.Input[Sequence[pulumi.Input[Union['CommandParameterArgs', 'CommandParameterArgsDict']]]] mandatory_parameters: The list of mandatory parameters for the command. + :param pulumi.Input['CommandNamespace'] namespace: The namespace to which the command belongs. + :param pulumi.Input[Union['CommandPayloadArgs', 'CommandPayloadArgsDict']] payload: The payload associated with the command. + :param pulumi.Input[bool] pending_deletion: A flag indicating whether the command is pending deletion. + :param pulumi.Input[str] role_arn: The customer role associated with the command. + :param pulumi.Input[Sequence[pulumi.Input[Union['_root_inputs.TagArgs', '_root_inputs.TagArgsDict']]]] tags: The tags to be associated with the command. + """ + ... + @overload + def __init__(__self__, + resource_name: str, + args: CommandArgs, + opts: Optional[pulumi.ResourceOptions] = None): + """ + Represents the resource definition of AWS IoT Command. + + :param str resource_name: The name of the resource. + :param CommandArgs args: The arguments to use to populate this resource's properties. + :param pulumi.ResourceOptions opts: Options for the resource. + """ + ... + def __init__(__self__, resource_name: str, *args, **kwargs): + resource_args, opts = _utilities.get_resource_args_opts(CommandArgs, pulumi.ResourceOptions, *args, **kwargs) + if resource_args is not None: + __self__._internal_init(resource_name, opts, **resource_args.__dict__) + else: + __self__._internal_init(resource_name, *args, **kwargs) + + def _internal_init(__self__, + resource_name: str, + opts: Optional[pulumi.ResourceOptions] = None, + command_id: Optional[pulumi.Input[str]] = None, + created_at: Optional[pulumi.Input[str]] = None, + deprecated: Optional[pulumi.Input[bool]] = None, + description: Optional[pulumi.Input[str]] = None, + display_name: Optional[pulumi.Input[str]] = None, + last_updated_at: Optional[pulumi.Input[str]] = None, + mandatory_parameters: Optional[pulumi.Input[Sequence[pulumi.Input[Union['CommandParameterArgs', 'CommandParameterArgsDict']]]]] = None, + namespace: Optional[pulumi.Input['CommandNamespace']] = None, + payload: Optional[pulumi.Input[Union['CommandPayloadArgs', 'CommandPayloadArgsDict']]] = None, + pending_deletion: Optional[pulumi.Input[bool]] = None, + role_arn: Optional[pulumi.Input[str]] = None, + tags: Optional[pulumi.Input[Sequence[pulumi.Input[Union['_root_inputs.TagArgs', '_root_inputs.TagArgsDict']]]]] = None, + __props__=None): + opts = pulumi.ResourceOptions.merge(_utilities.get_resource_opts_defaults(), opts) + if not isinstance(opts, pulumi.ResourceOptions): + raise TypeError('Expected resource options to be a ResourceOptions instance') + if opts.id is None: + if __props__ is not None: + raise TypeError('__props__ is only valid when passed in combination with a valid opts.id to get an existing resource') + __props__ = CommandArgs.__new__(CommandArgs) + + if command_id is None and not opts.urn: + raise TypeError("Missing required property 'command_id'") + __props__.__dict__["command_id"] = command_id + __props__.__dict__["created_at"] = created_at + __props__.__dict__["deprecated"] = deprecated + __props__.__dict__["description"] = description + __props__.__dict__["display_name"] = display_name + __props__.__dict__["last_updated_at"] = last_updated_at + __props__.__dict__["mandatory_parameters"] = mandatory_parameters + __props__.__dict__["namespace"] = namespace + __props__.__dict__["payload"] = payload + __props__.__dict__["pending_deletion"] = pending_deletion + __props__.__dict__["role_arn"] = role_arn + __props__.__dict__["tags"] = tags + __props__.__dict__["command_arn"] = None + replace_on_changes = pulumi.ResourceOptions(replace_on_changes=["commandId"]) + opts = pulumi.ResourceOptions.merge(opts, replace_on_changes) + super(Command, __self__).__init__( + 'aws-native:iot:Command', + resource_name, + __props__, + opts) + + @staticmethod + def get(resource_name: str, + id: pulumi.Input[str], + opts: Optional[pulumi.ResourceOptions] = None) -> 'Command': + """ + Get an existing Command resource's state with the given name, id, and optional extra + properties used to qualify the lookup. + + :param str resource_name: The unique name of the resulting resource. + :param pulumi.Input[str] id: The unique provider ID of the resource to lookup. + :param pulumi.ResourceOptions opts: Options for the resource. + """ + opts = pulumi.ResourceOptions.merge(opts, pulumi.ResourceOptions(id=id)) + + __props__ = CommandArgs.__new__(CommandArgs) + + __props__.__dict__["command_arn"] = None + __props__.__dict__["command_id"] = None + __props__.__dict__["created_at"] = None + __props__.__dict__["deprecated"] = None + __props__.__dict__["description"] = None + __props__.__dict__["display_name"] = None + __props__.__dict__["last_updated_at"] = None + __props__.__dict__["mandatory_parameters"] = None + __props__.__dict__["namespace"] = None + __props__.__dict__["payload"] = None + __props__.__dict__["pending_deletion"] = None + __props__.__dict__["role_arn"] = None + __props__.__dict__["tags"] = None + return Command(resource_name, opts=opts, __props__=__props__) + + @property + @pulumi.getter(name="commandArn") + def command_arn(self) -> pulumi.Output[str]: + """ + The Amazon Resource Name (ARN) of the command. + """ + return pulumi.get(self, "command_arn") + + @property + @pulumi.getter(name="commandId") + def command_id(self) -> pulumi.Output[str]: + """ + The unique identifier for the command. + """ + return pulumi.get(self, "command_id") + + @property + @pulumi.getter(name="createdAt") + def created_at(self) -> pulumi.Output[Optional[str]]: + """ + The date and time when the command was created. + """ + return pulumi.get(self, "created_at") + + @property + @pulumi.getter + def deprecated(self) -> pulumi.Output[Optional[bool]]: + """ + A flag indicating whether the command is deprecated. + """ + return pulumi.get(self, "deprecated") + + @property + @pulumi.getter + def description(self) -> pulumi.Output[Optional[str]]: + """ + The description of the command. + """ + return pulumi.get(self, "description") + + @property + @pulumi.getter(name="displayName") + def display_name(self) -> pulumi.Output[Optional[str]]: + """ + The display name for the command. + """ + return pulumi.get(self, "display_name") + + @property + @pulumi.getter(name="lastUpdatedAt") + def last_updated_at(self) -> pulumi.Output[Optional[str]]: + """ + The date and time when the command was last updated. + """ + return pulumi.get(self, "last_updated_at") + + @property + @pulumi.getter(name="mandatoryParameters") + def mandatory_parameters(self) -> pulumi.Output[Optional[Sequence['outputs.CommandParameter']]]: + """ + The list of mandatory parameters for the command. + """ + return pulumi.get(self, "mandatory_parameters") + + @property + @pulumi.getter + def namespace(self) -> pulumi.Output[Optional['CommandNamespace']]: + """ + The namespace to which the command belongs. + """ + return pulumi.get(self, "namespace") + + @property + @pulumi.getter + def payload(self) -> pulumi.Output[Optional['outputs.CommandPayload']]: + """ + The payload associated with the command. + """ + return pulumi.get(self, "payload") + + @property + @pulumi.getter(name="pendingDeletion") + def pending_deletion(self) -> pulumi.Output[Optional[bool]]: + """ + A flag indicating whether the command is pending deletion. + """ + return pulumi.get(self, "pending_deletion") + + @property + @pulumi.getter(name="roleArn") + def role_arn(self) -> pulumi.Output[Optional[str]]: + """ + The customer role associated with the command. + """ + return pulumi.get(self, "role_arn") + + @property + @pulumi.getter + def tags(self) -> pulumi.Output[Optional[Sequence['_root_outputs.Tag']]]: + """ + The tags to be associated with the command. + """ + return pulumi.get(self, "tags") + diff --git a/sdk/python/pulumi_aws_native/iot/get_command.py b/sdk/python/pulumi_aws_native/iot/get_command.py new file mode 100644 index 0000000000..7cf27254f1 --- /dev/null +++ b/sdk/python/pulumi_aws_native/iot/get_command.py @@ -0,0 +1,220 @@ +# coding=utf-8 +# *** WARNING: this file was generated by pulumi-language-python. *** +# *** Do not edit by hand unless you're certain you know what you are doing! *** + +import copy +import warnings +import sys +import pulumi +import pulumi.runtime +from typing import Any, Mapping, Optional, Sequence, Union, overload +if sys.version_info >= (3, 11): + from typing import NotRequired, TypedDict, TypeAlias +else: + from typing_extensions import NotRequired, TypedDict, TypeAlias +from .. import _utilities +from . import outputs +from .. import outputs as _root_outputs +from ._enums import * + +__all__ = [ + 'GetCommandResult', + 'AwaitableGetCommandResult', + 'get_command', + 'get_command_output', +] + +@pulumi.output_type +class GetCommandResult: + def __init__(__self__, command_arn=None, created_at=None, deprecated=None, description=None, display_name=None, mandatory_parameters=None, namespace=None, payload=None, pending_deletion=None, role_arn=None, tags=None): + if command_arn and not isinstance(command_arn, str): + raise TypeError("Expected argument 'command_arn' to be a str") + pulumi.set(__self__, "command_arn", command_arn) + if created_at and not isinstance(created_at, str): + raise TypeError("Expected argument 'created_at' to be a str") + pulumi.set(__self__, "created_at", created_at) + if deprecated and not isinstance(deprecated, bool): + raise TypeError("Expected argument 'deprecated' to be a bool") + pulumi.set(__self__, "deprecated", deprecated) + if description and not isinstance(description, str): + raise TypeError("Expected argument 'description' to be a str") + pulumi.set(__self__, "description", description) + if display_name and not isinstance(display_name, str): + raise TypeError("Expected argument 'display_name' to be a str") + pulumi.set(__self__, "display_name", display_name) + if mandatory_parameters and not isinstance(mandatory_parameters, list): + raise TypeError("Expected argument 'mandatory_parameters' to be a list") + pulumi.set(__self__, "mandatory_parameters", mandatory_parameters) + if namespace and not isinstance(namespace, str): + raise TypeError("Expected argument 'namespace' to be a str") + pulumi.set(__self__, "namespace", namespace) + if payload and not isinstance(payload, dict): + raise TypeError("Expected argument 'payload' to be a dict") + pulumi.set(__self__, "payload", payload) + if pending_deletion and not isinstance(pending_deletion, bool): + raise TypeError("Expected argument 'pending_deletion' to be a bool") + pulumi.set(__self__, "pending_deletion", pending_deletion) + if role_arn and not isinstance(role_arn, str): + raise TypeError("Expected argument 'role_arn' to be a str") + pulumi.set(__self__, "role_arn", role_arn) + if tags and not isinstance(tags, list): + raise TypeError("Expected argument 'tags' to be a list") + pulumi.set(__self__, "tags", tags) + + @property + @pulumi.getter(name="commandArn") + def command_arn(self) -> Optional[str]: + """ + The Amazon Resource Name (ARN) of the command. + """ + return pulumi.get(self, "command_arn") + + @property + @pulumi.getter(name="createdAt") + def created_at(self) -> Optional[str]: + """ + The date and time when the command was created. + """ + return pulumi.get(self, "created_at") + + @property + @pulumi.getter + def deprecated(self) -> Optional[bool]: + """ + A flag indicating whether the command is deprecated. + """ + return pulumi.get(self, "deprecated") + + @property + @pulumi.getter + def description(self) -> Optional[str]: + """ + The description of the command. + """ + return pulumi.get(self, "description") + + @property + @pulumi.getter(name="displayName") + def display_name(self) -> Optional[str]: + """ + The display name for the command. + """ + return pulumi.get(self, "display_name") + + @property + @pulumi.getter(name="mandatoryParameters") + def mandatory_parameters(self) -> Optional[Sequence['outputs.CommandParameter']]: + """ + The list of mandatory parameters for the command. + """ + return pulumi.get(self, "mandatory_parameters") + + @property + @pulumi.getter + def namespace(self) -> Optional['CommandNamespace']: + """ + The namespace to which the command belongs. + """ + return pulumi.get(self, "namespace") + + @property + @pulumi.getter + def payload(self) -> Optional['outputs.CommandPayload']: + """ + The payload associated with the command. + """ + return pulumi.get(self, "payload") + + @property + @pulumi.getter(name="pendingDeletion") + def pending_deletion(self) -> Optional[bool]: + """ + A flag indicating whether the command is pending deletion. + """ + return pulumi.get(self, "pending_deletion") + + @property + @pulumi.getter(name="roleArn") + def role_arn(self) -> Optional[str]: + """ + The customer role associated with the command. + """ + return pulumi.get(self, "role_arn") + + @property + @pulumi.getter + def tags(self) -> Optional[Sequence['_root_outputs.Tag']]: + """ + The tags to be associated with the command. + """ + return pulumi.get(self, "tags") + + +class AwaitableGetCommandResult(GetCommandResult): + # pylint: disable=using-constant-test + def __await__(self): + if False: + yield self + return GetCommandResult( + command_arn=self.command_arn, + created_at=self.created_at, + deprecated=self.deprecated, + description=self.description, + display_name=self.display_name, + mandatory_parameters=self.mandatory_parameters, + namespace=self.namespace, + payload=self.payload, + pending_deletion=self.pending_deletion, + role_arn=self.role_arn, + tags=self.tags) + + +def get_command(command_id: Optional[str] = None, + opts: Optional[pulumi.InvokeOptions] = None) -> AwaitableGetCommandResult: + """ + Represents the resource definition of AWS IoT Command. + + + :param str command_id: The unique identifier for the command. + """ + __args__ = dict() + __args__['commandId'] = command_id + opts = pulumi.InvokeOptions.merge(_utilities.get_invoke_opts_defaults(), opts) + __ret__ = pulumi.runtime.invoke('aws-native:iot:getCommand', __args__, opts=opts, typ=GetCommandResult).value + + return AwaitableGetCommandResult( + command_arn=pulumi.get(__ret__, 'command_arn'), + created_at=pulumi.get(__ret__, 'created_at'), + deprecated=pulumi.get(__ret__, 'deprecated'), + description=pulumi.get(__ret__, 'description'), + display_name=pulumi.get(__ret__, 'display_name'), + mandatory_parameters=pulumi.get(__ret__, 'mandatory_parameters'), + namespace=pulumi.get(__ret__, 'namespace'), + payload=pulumi.get(__ret__, 'payload'), + pending_deletion=pulumi.get(__ret__, 'pending_deletion'), + role_arn=pulumi.get(__ret__, 'role_arn'), + tags=pulumi.get(__ret__, 'tags')) +def get_command_output(command_id: Optional[pulumi.Input[str]] = None, + opts: Optional[Union[pulumi.InvokeOptions, pulumi.InvokeOutputOptions]] = None) -> pulumi.Output[GetCommandResult]: + """ + Represents the resource definition of AWS IoT Command. + + + :param str command_id: The unique identifier for the command. + """ + __args__ = dict() + __args__['commandId'] = command_id + opts = pulumi.InvokeOutputOptions.merge(_utilities.get_invoke_opts_defaults(), opts) + __ret__ = pulumi.runtime.invoke_output('aws-native:iot:getCommand', __args__, opts=opts, typ=GetCommandResult) + return __ret__.apply(lambda __response__: GetCommandResult( + command_arn=pulumi.get(__response__, 'command_arn'), + created_at=pulumi.get(__response__, 'created_at'), + deprecated=pulumi.get(__response__, 'deprecated'), + description=pulumi.get(__response__, 'description'), + display_name=pulumi.get(__response__, 'display_name'), + mandatory_parameters=pulumi.get(__response__, 'mandatory_parameters'), + namespace=pulumi.get(__response__, 'namespace'), + payload=pulumi.get(__response__, 'payload'), + pending_deletion=pulumi.get(__response__, 'pending_deletion'), + role_arn=pulumi.get(__response__, 'role_arn'), + tags=pulumi.get(__response__, 'tags'))) diff --git a/sdk/python/pulumi_aws_native/iot/outputs.py b/sdk/python/pulumi_aws_native/iot/outputs.py index eb7290080a..a198bad3fb 100644 --- a/sdk/python/pulumi_aws_native/iot/outputs.py +++ b/sdk/python/pulumi_aws_native/iot/outputs.py @@ -24,6 +24,9 @@ 'AccountAuditConfigurationAuditNotificationTargetConfigurations', 'BillingGroupPropertiesProperties', 'CaCertificateRegistrationConfig', + 'CommandParameter', + 'CommandParameterValue', + 'CommandPayload', 'DomainConfigurationAuthorizerConfig', 'DomainConfigurationClientCertificateConfig', 'DomainConfigurationServerCertificateConfig', @@ -605,6 +608,158 @@ def template_name(self) -> Optional[str]: return pulumi.get(self, "template_name") +@pulumi.output_type +class CommandParameter(dict): + @staticmethod + def __key_warning(key: str): + suggest = None + if key == "defaultValue": + suggest = "default_value" + + if suggest: + pulumi.log.warn(f"Key '{key}' not found in CommandParameter. Access the value via the '{suggest}' property getter instead.") + + def __getitem__(self, key: str) -> Any: + CommandParameter.__key_warning(key) + return super().__getitem__(key) + + def get(self, key: str, default = None) -> Any: + CommandParameter.__key_warning(key) + return super().get(key, default) + + def __init__(__self__, *, + name: str, + default_value: Optional['outputs.CommandParameterValue'] = None, + description: Optional[str] = None, + value: Optional['outputs.CommandParameterValue'] = None): + pulumi.set(__self__, "name", name) + if default_value is not None: + pulumi.set(__self__, "default_value", default_value) + if description is not None: + pulumi.set(__self__, "description", description) + if value is not None: + pulumi.set(__self__, "value", value) + + @property + @pulumi.getter + def name(self) -> str: + return pulumi.get(self, "name") + + @property + @pulumi.getter(name="defaultValue") + def default_value(self) -> Optional['outputs.CommandParameterValue']: + return pulumi.get(self, "default_value") + + @property + @pulumi.getter + def description(self) -> Optional[str]: + return pulumi.get(self, "description") + + @property + @pulumi.getter + def value(self) -> Optional['outputs.CommandParameterValue']: + return pulumi.get(self, "value") + + +@pulumi.output_type +class CommandParameterValue(dict): + def __init__(__self__, *, + b: Optional[bool] = None, + bin: Optional[str] = None, + d: Optional[float] = None, + i: Optional[int] = None, + l: Optional[str] = None, + s: Optional[str] = None, + ul: Optional[str] = None): + if b is not None: + pulumi.set(__self__, "b", b) + if bin is not None: + pulumi.set(__self__, "bin", bin) + if d is not None: + pulumi.set(__self__, "d", d) + if i is not None: + pulumi.set(__self__, "i", i) + if l is not None: + pulumi.set(__self__, "l", l) + if s is not None: + pulumi.set(__self__, "s", s) + if ul is not None: + pulumi.set(__self__, "ul", ul) + + @property + @pulumi.getter + def b(self) -> Optional[bool]: + return pulumi.get(self, "b") + + @property + @pulumi.getter + def bin(self) -> Optional[str]: + return pulumi.get(self, "bin") + + @property + @pulumi.getter + def d(self) -> Optional[float]: + return pulumi.get(self, "d") + + @property + @pulumi.getter + def i(self) -> Optional[int]: + return pulumi.get(self, "i") + + @property + @pulumi.getter + def l(self) -> Optional[str]: + return pulumi.get(self, "l") + + @property + @pulumi.getter + def s(self) -> Optional[str]: + return pulumi.get(self, "s") + + @property + @pulumi.getter + def ul(self) -> Optional[str]: + return pulumi.get(self, "ul") + + +@pulumi.output_type +class CommandPayload(dict): + @staticmethod + def __key_warning(key: str): + suggest = None + if key == "contentType": + suggest = "content_type" + + if suggest: + pulumi.log.warn(f"Key '{key}' not found in CommandPayload. Access the value via the '{suggest}' property getter instead.") + + def __getitem__(self, key: str) -> Any: + CommandPayload.__key_warning(key) + return super().__getitem__(key) + + def get(self, key: str, default = None) -> Any: + CommandPayload.__key_warning(key) + return super().get(key, default) + + def __init__(__self__, *, + content: Optional[str] = None, + content_type: Optional[str] = None): + if content is not None: + pulumi.set(__self__, "content", content) + if content_type is not None: + pulumi.set(__self__, "content_type", content_type) + + @property + @pulumi.getter + def content(self) -> Optional[str]: + return pulumi.get(self, "content") + + @property + @pulumi.getter(name="contentType") + def content_type(self) -> Optional[str]: + return pulumi.get(self, "content_type") + + @pulumi.output_type class DomainConfigurationAuthorizerConfig(dict): @staticmethod diff --git a/sdk/python/pulumi_aws_native/organizations/_enums.py b/sdk/python/pulumi_aws_native/organizations/_enums.py index e184a2f2d3..6c577d782f 100644 --- a/sdk/python/pulumi_aws_native/organizations/_enums.py +++ b/sdk/python/pulumi_aws_native/organizations/_enums.py @@ -39,7 +39,7 @@ class OrganizationFeatureSet(str, Enum): class PolicyType(str, Enum): """ - The type of policy to create. You can specify one of the following values: AISERVICES_OPT_OUT_POLICY, BACKUP_POLICY, SERVICE_CONTROL_POLICY, TAG_POLICY, CHATBOT_POLICY, RESOURCE_CONTROL_POLICY + The type of policy to create. You can specify one of the following values: AISERVICES_OPT_OUT_POLICY, BACKUP_POLICY, SERVICE_CONTROL_POLICY, TAG_POLICY, CHATBOT_POLICY, RESOURCE_CONTROL_POLICY,DECLARATIVE_POLICY_EC2 """ SERVICE_CONTROL_POLICY = "SERVICE_CONTROL_POLICY" AISERVICES_OPT_OUT_POLICY = "AISERVICES_OPT_OUT_POLICY" @@ -47,3 +47,4 @@ class PolicyType(str, Enum): TAG_POLICY = "TAG_POLICY" CHATBOT_POLICY = "CHATBOT_POLICY" RESOURCE_CONTROL_POLICY = "RESOURCE_CONTROL_POLICY" + DECLARATIVE_POLICY_EC2 = "DECLARATIVE_POLICY_EC2" diff --git a/sdk/python/pulumi_aws_native/organizations/policy.py b/sdk/python/pulumi_aws_native/organizations/policy.py index c5e230a8de..d4338a4dbd 100644 --- a/sdk/python/pulumi_aws_native/organizations/policy.py +++ b/sdk/python/pulumi_aws_native/organizations/policy.py @@ -33,7 +33,7 @@ def __init__(__self__, *, :param Any content: The Policy text content. For AWS CloudFormation templates formatted in YAML, you can provide the policy in JSON or YAML format. AWS CloudFormation always converts a YAML policy to JSON format before submitting it. Search the [CloudFormation User Guide](https://docs.aws.amazon.com/cloudformation/) for `AWS::Organizations::Policy` for more information about the expected schema for this property. - :param pulumi.Input['PolicyType'] type: The type of policy to create. You can specify one of the following values: AISERVICES_OPT_OUT_POLICY, BACKUP_POLICY, SERVICE_CONTROL_POLICY, TAG_POLICY, CHATBOT_POLICY, RESOURCE_CONTROL_POLICY + :param pulumi.Input['PolicyType'] type: The type of policy to create. You can specify one of the following values: AISERVICES_OPT_OUT_POLICY, BACKUP_POLICY, SERVICE_CONTROL_POLICY, TAG_POLICY, CHATBOT_POLICY, RESOURCE_CONTROL_POLICY,DECLARATIVE_POLICY_EC2 :param pulumi.Input[str] description: Human readable description of the policy :param pulumi.Input[str] name: Name of the Policy :param pulumi.Input[Sequence[pulumi.Input['_root_inputs.TagArgs']]] tags: A list of tags that you want to attach to the newly created policy. For each tag in the list, you must specify both a tag key and a value. You can set the value to an empty string, but you can't set it to null. @@ -68,7 +68,7 @@ def content(self, value: Any): @pulumi.getter def type(self) -> pulumi.Input['PolicyType']: """ - The type of policy to create. You can specify one of the following values: AISERVICES_OPT_OUT_POLICY, BACKUP_POLICY, SERVICE_CONTROL_POLICY, TAG_POLICY, CHATBOT_POLICY, RESOURCE_CONTROL_POLICY + The type of policy to create. You can specify one of the following values: AISERVICES_OPT_OUT_POLICY, BACKUP_POLICY, SERVICE_CONTROL_POLICY, TAG_POLICY, CHATBOT_POLICY, RESOURCE_CONTROL_POLICY,DECLARATIVE_POLICY_EC2 """ return pulumi.get(self, "type") @@ -149,7 +149,7 @@ def __init__(__self__, :param pulumi.Input[str] name: Name of the Policy :param pulumi.Input[Sequence[pulumi.Input[Union['_root_inputs.TagArgs', '_root_inputs.TagArgsDict']]]] tags: A list of tags that you want to attach to the newly created policy. For each tag in the list, you must specify both a tag key and a value. You can set the value to an empty string, but you can't set it to null. :param pulumi.Input[Sequence[pulumi.Input[str]]] target_ids: List of unique identifiers (IDs) of the root, OU, or account that you want to attach the policy to - :param pulumi.Input['PolicyType'] type: The type of policy to create. You can specify one of the following values: AISERVICES_OPT_OUT_POLICY, BACKUP_POLICY, SERVICE_CONTROL_POLICY, TAG_POLICY, CHATBOT_POLICY, RESOURCE_CONTROL_POLICY + :param pulumi.Input['PolicyType'] type: The type of policy to create. You can specify one of the following values: AISERVICES_OPT_OUT_POLICY, BACKUP_POLICY, SERVICE_CONTROL_POLICY, TAG_POLICY, CHATBOT_POLICY, RESOURCE_CONTROL_POLICY,DECLARATIVE_POLICY_EC2 """ ... @overload @@ -308,7 +308,7 @@ def target_ids(self) -> pulumi.Output[Optional[Sequence[str]]]: @pulumi.getter def type(self) -> pulumi.Output['PolicyType']: """ - The type of policy to create. You can specify one of the following values: AISERVICES_OPT_OUT_POLICY, BACKUP_POLICY, SERVICE_CONTROL_POLICY, TAG_POLICY, CHATBOT_POLICY, RESOURCE_CONTROL_POLICY + The type of policy to create. You can specify one of the following values: AISERVICES_OPT_OUT_POLICY, BACKUP_POLICY, SERVICE_CONTROL_POLICY, TAG_POLICY, CHATBOT_POLICY, RESOURCE_CONTROL_POLICY,DECLARATIVE_POLICY_EC2 """ return pulumi.get(self, "type") diff --git a/sdk/python/pulumi_aws_native/qbusiness/application.py b/sdk/python/pulumi_aws_native/qbusiness/application.py index 343a6a6818..145f5da629 100644 --- a/sdk/python/pulumi_aws_native/qbusiness/application.py +++ b/sdk/python/pulumi_aws_native/qbusiness/application.py @@ -43,6 +43,7 @@ def __init__(__self__, *, :param pulumi.Input[str] display_name: The name of the Amazon Q Business application. :param pulumi.Input['ApplicationAttachmentsConfigurationArgs'] attachments_configuration: Configuration information for the file upload during chat feature. :param pulumi.Input['ApplicationAutoSubscriptionConfigurationArgs'] auto_subscription_configuration: Subscription configuration information for an Amazon Q Business application using IAM identity federation for user management. + :param pulumi.Input[Sequence[pulumi.Input[str]]] client_ids_for_oidc: The OIDC client ID for a Amazon Q Business application. :param pulumi.Input[str] description: A description for the Amazon Q Business application. :param pulumi.Input['ApplicationEncryptionConfigurationArgs'] encryption_configuration: Provides the identifier of the AWS KMS key used to encrypt data indexed by Amazon Q Business. Amazon Q Business doesn't support asymmetric keys. :param pulumi.Input[str] iam_identity_provider_arn: The Amazon Resource Name (ARN) of an identity provider being used by an Amazon Q Business application. @@ -122,6 +123,9 @@ def auto_subscription_configuration(self, value: Optional[pulumi.Input['Applicat @property @pulumi.getter(name="clientIdsForOidc") def client_ids_for_oidc(self) -> Optional[pulumi.Input[Sequence[pulumi.Input[str]]]]: + """ + The OIDC client ID for a Amazon Q Business application. + """ return pulumi.get(self, "client_ids_for_oidc") @client_ids_for_oidc.setter @@ -275,6 +279,7 @@ def __init__(__self__, :param pulumi.ResourceOptions opts: Options for the resource. :param pulumi.Input[Union['ApplicationAttachmentsConfigurationArgs', 'ApplicationAttachmentsConfigurationArgsDict']] attachments_configuration: Configuration information for the file upload during chat feature. :param pulumi.Input[Union['ApplicationAutoSubscriptionConfigurationArgs', 'ApplicationAutoSubscriptionConfigurationArgsDict']] auto_subscription_configuration: Subscription configuration information for an Amazon Q Business application using IAM identity federation for user management. + :param pulumi.Input[Sequence[pulumi.Input[str]]] client_ids_for_oidc: The OIDC client ID for a Amazon Q Business application. :param pulumi.Input[str] description: A description for the Amazon Q Business application. :param pulumi.Input[str] display_name: The name of the Amazon Q Business application. :param pulumi.Input[Union['ApplicationEncryptionConfigurationArgs', 'ApplicationEncryptionConfigurationArgsDict']] encryption_configuration: Provides the identifier of the AWS KMS key used to encrypt data indexed by Amazon Q Business. Amazon Q Business doesn't support asymmetric keys. @@ -438,6 +443,9 @@ def auto_subscription_configuration(self) -> pulumi.Output[Optional['outputs.App @property @pulumi.getter(name="clientIdsForOidc") def client_ids_for_oidc(self) -> pulumi.Output[Optional[Sequence[str]]]: + """ + The OIDC client ID for a Amazon Q Business application. + """ return pulumi.get(self, "client_ids_for_oidc") @property diff --git a/sdk/python/pulumi_aws_native/ram/__init__.py b/sdk/python/pulumi_aws_native/ram/__init__.py index 17c2d8426d..f66aaba885 100644 --- a/sdk/python/pulumi_aws_native/ram/__init__.py +++ b/sdk/python/pulumi_aws_native/ram/__init__.py @@ -6,4 +6,6 @@ import typing # Export this package's modules as members: from .get_permission import * +from .get_resource_share import * from .permission import * +from .resource_share import * diff --git a/sdk/python/pulumi_aws_native/ram/get_resource_share.py b/sdk/python/pulumi_aws_native/ram/get_resource_share.py new file mode 100644 index 0000000000..f252c74204 --- /dev/null +++ b/sdk/python/pulumi_aws_native/ram/get_resource_share.py @@ -0,0 +1,120 @@ +# coding=utf-8 +# *** WARNING: this file was generated by pulumi-language-python. *** +# *** Do not edit by hand unless you're certain you know what you are doing! *** + +import copy +import warnings +import sys +import pulumi +import pulumi.runtime +from typing import Any, Mapping, Optional, Sequence, Union, overload +if sys.version_info >= (3, 11): + from typing import NotRequired, TypedDict, TypeAlias +else: + from typing_extensions import NotRequired, TypedDict, TypeAlias +from .. import _utilities +from .. import outputs as _root_outputs + +__all__ = [ + 'GetResourceShareResult', + 'AwaitableGetResourceShareResult', + 'get_resource_share', + 'get_resource_share_output', +] + +@pulumi.output_type +class GetResourceShareResult: + def __init__(__self__, allow_external_principals=None, arn=None, name=None, tags=None): + if allow_external_principals and not isinstance(allow_external_principals, bool): + raise TypeError("Expected argument 'allow_external_principals' to be a bool") + pulumi.set(__self__, "allow_external_principals", allow_external_principals) + if arn and not isinstance(arn, str): + raise TypeError("Expected argument 'arn' to be a str") + pulumi.set(__self__, "arn", arn) + if name and not isinstance(name, str): + raise TypeError("Expected argument 'name' to be a str") + pulumi.set(__self__, "name", name) + if tags and not isinstance(tags, list): + raise TypeError("Expected argument 'tags' to be a list") + pulumi.set(__self__, "tags", tags) + + @property + @pulumi.getter(name="allowExternalPrincipals") + def allow_external_principals(self) -> Optional[bool]: + """ + Specifies whether principals outside your organization in AWS Organizations can be associated with a resource share. A value of `true` lets you share with individual AWS accounts that are not in your organization. A value of `false` only has meaning if your account is a member of an AWS Organization. The default value is `true`. + """ + return pulumi.get(self, "allow_external_principals") + + @property + @pulumi.getter + def arn(self) -> Optional[str]: + """ + The Amazon Resource Name (ARN) of the resource share. + """ + return pulumi.get(self, "arn") + + @property + @pulumi.getter + def name(self) -> Optional[str]: + """ + Specifies the name of the resource share. + """ + return pulumi.get(self, "name") + + @property + @pulumi.getter + def tags(self) -> Optional[Sequence['_root_outputs.Tag']]: + """ + Specifies one or more tags to attach to the resource share itself. It doesn't attach the tags to the resources associated with the resource share. + """ + return pulumi.get(self, "tags") + + +class AwaitableGetResourceShareResult(GetResourceShareResult): + # pylint: disable=using-constant-test + def __await__(self): + if False: + yield self + return GetResourceShareResult( + allow_external_principals=self.allow_external_principals, + arn=self.arn, + name=self.name, + tags=self.tags) + + +def get_resource_share(arn: Optional[str] = None, + opts: Optional[pulumi.InvokeOptions] = None) -> AwaitableGetResourceShareResult: + """ + Resource type definition for AWS::RAM::ResourceShare + + + :param str arn: The Amazon Resource Name (ARN) of the resource share. + """ + __args__ = dict() + __args__['arn'] = arn + opts = pulumi.InvokeOptions.merge(_utilities.get_invoke_opts_defaults(), opts) + __ret__ = pulumi.runtime.invoke('aws-native:ram:getResourceShare', __args__, opts=opts, typ=GetResourceShareResult).value + + return AwaitableGetResourceShareResult( + allow_external_principals=pulumi.get(__ret__, 'allow_external_principals'), + arn=pulumi.get(__ret__, 'arn'), + name=pulumi.get(__ret__, 'name'), + tags=pulumi.get(__ret__, 'tags')) +def get_resource_share_output(arn: Optional[pulumi.Input[str]] = None, + opts: Optional[Union[pulumi.InvokeOptions, pulumi.InvokeOutputOptions]] = None) -> pulumi.Output[GetResourceShareResult]: + """ + Resource type definition for AWS::RAM::ResourceShare + + + :param str arn: The Amazon Resource Name (ARN) of the resource share. + """ + __args__ = dict() + __args__['arn'] = arn + opts = pulumi.InvokeOutputOptions.merge(_utilities.get_invoke_opts_defaults(), opts) + __ret__ = pulumi.runtime.invoke_output('aws-native:ram:getResourceShare', __args__, opts=opts, typ=GetResourceShareResult) + return __ret__.apply(lambda __response__: GetResourceShareResult( + allow_external_principals=pulumi.get(__response__, 'allow_external_principals'), + arn=pulumi.get(__response__, 'arn'), + name=pulumi.get(__response__, 'name'), + tags=pulumi.get(__response__, 'tags'))) diff --git a/sdk/python/pulumi_aws_native/ram/resource_share.py b/sdk/python/pulumi_aws_native/ram/resource_share.py new file mode 100644 index 0000000000..f250ea2a3a --- /dev/null +++ b/sdk/python/pulumi_aws_native/ram/resource_share.py @@ -0,0 +1,442 @@ +# coding=utf-8 +# *** WARNING: this file was generated by pulumi-language-python. *** +# *** Do not edit by hand unless you're certain you know what you are doing! *** + +import copy +import warnings +import sys +import pulumi +import pulumi.runtime +from typing import Any, Mapping, Optional, Sequence, Union, overload +if sys.version_info >= (3, 11): + from typing import NotRequired, TypedDict, TypeAlias +else: + from typing_extensions import NotRequired, TypedDict, TypeAlias +from .. import _utilities +from .. import _inputs as _root_inputs +from .. import outputs as _root_outputs + +__all__ = ['ResourceShareArgs', 'ResourceShare'] + +@pulumi.input_type +class ResourceShareArgs: + def __init__(__self__, *, + allow_external_principals: Optional[pulumi.Input[bool]] = None, + name: Optional[pulumi.Input[str]] = None, + permission_arns: Optional[pulumi.Input[Sequence[pulumi.Input[str]]]] = None, + principals: Optional[pulumi.Input[Sequence[pulumi.Input[str]]]] = None, + resource_arns: Optional[pulumi.Input[Sequence[pulumi.Input[str]]]] = None, + sources: Optional[pulumi.Input[Sequence[pulumi.Input[str]]]] = None, + tags: Optional[pulumi.Input[Sequence[pulumi.Input['_root_inputs.TagArgs']]]] = None): + """ + The set of arguments for constructing a ResourceShare resource. + :param pulumi.Input[bool] allow_external_principals: Specifies whether principals outside your organization in AWS Organizations can be associated with a resource share. A value of `true` lets you share with individual AWS accounts that are not in your organization. A value of `false` only has meaning if your account is a member of an AWS Organization. The default value is `true`. + :param pulumi.Input[str] name: Specifies the name of the resource share. + :param pulumi.Input[Sequence[pulumi.Input[str]]] permission_arns: Specifies the [Amazon Resource Names (ARNs)](https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html) of the AWS RAM permission to associate with the resource share. If you do not specify an ARN for the permission, AWS RAM automatically attaches the default version of the permission for each resource type. You can associate only one permission with each resource type included in the resource share. + :param pulumi.Input[Sequence[pulumi.Input[str]]] principals: Specifies the principals to associate with the resource share. The possible values are: + + - An AWS account ID + + - An Amazon Resource Name (ARN) of an organization in AWS Organizations + + - An ARN of an organizational unit (OU) in AWS Organizations + + - An ARN of an IAM role + + - An ARN of an IAM user + :param pulumi.Input[Sequence[pulumi.Input[str]]] resource_arns: Specifies a list of one or more ARNs of the resources to associate with the resource share. + :param pulumi.Input[Sequence[pulumi.Input[str]]] sources: Specifies from which source accounts the service principal has access to the resources in this resource share. + :param pulumi.Input[Sequence[pulumi.Input['_root_inputs.TagArgs']]] tags: Specifies one or more tags to attach to the resource share itself. It doesn't attach the tags to the resources associated with the resource share. + """ + if allow_external_principals is not None: + pulumi.set(__self__, "allow_external_principals", allow_external_principals) + if name is not None: + pulumi.set(__self__, "name", name) + if permission_arns is not None: + pulumi.set(__self__, "permission_arns", permission_arns) + if principals is not None: + pulumi.set(__self__, "principals", principals) + if resource_arns is not None: + pulumi.set(__self__, "resource_arns", resource_arns) + if sources is not None: + pulumi.set(__self__, "sources", sources) + if tags is not None: + pulumi.set(__self__, "tags", tags) + + @property + @pulumi.getter(name="allowExternalPrincipals") + def allow_external_principals(self) -> Optional[pulumi.Input[bool]]: + """ + Specifies whether principals outside your organization in AWS Organizations can be associated with a resource share. A value of `true` lets you share with individual AWS accounts that are not in your organization. A value of `false` only has meaning if your account is a member of an AWS Organization. The default value is `true`. + """ + return pulumi.get(self, "allow_external_principals") + + @allow_external_principals.setter + def allow_external_principals(self, value: Optional[pulumi.Input[bool]]): + pulumi.set(self, "allow_external_principals", value) + + @property + @pulumi.getter + def name(self) -> Optional[pulumi.Input[str]]: + """ + Specifies the name of the resource share. + """ + return pulumi.get(self, "name") + + @name.setter + def name(self, value: Optional[pulumi.Input[str]]): + pulumi.set(self, "name", value) + + @property + @pulumi.getter(name="permissionArns") + def permission_arns(self) -> Optional[pulumi.Input[Sequence[pulumi.Input[str]]]]: + """ + Specifies the [Amazon Resource Names (ARNs)](https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html) of the AWS RAM permission to associate with the resource share. If you do not specify an ARN for the permission, AWS RAM automatically attaches the default version of the permission for each resource type. You can associate only one permission with each resource type included in the resource share. + """ + return pulumi.get(self, "permission_arns") + + @permission_arns.setter + def permission_arns(self, value: Optional[pulumi.Input[Sequence[pulumi.Input[str]]]]): + pulumi.set(self, "permission_arns", value) + + @property + @pulumi.getter + def principals(self) -> Optional[pulumi.Input[Sequence[pulumi.Input[str]]]]: + """ + Specifies the principals to associate with the resource share. The possible values are: + + - An AWS account ID + + - An Amazon Resource Name (ARN) of an organization in AWS Organizations + + - An ARN of an organizational unit (OU) in AWS Organizations + + - An ARN of an IAM role + + - An ARN of an IAM user + """ + return pulumi.get(self, "principals") + + @principals.setter + def principals(self, value: Optional[pulumi.Input[Sequence[pulumi.Input[str]]]]): + pulumi.set(self, "principals", value) + + @property + @pulumi.getter(name="resourceArns") + def resource_arns(self) -> Optional[pulumi.Input[Sequence[pulumi.Input[str]]]]: + """ + Specifies a list of one or more ARNs of the resources to associate with the resource share. + """ + return pulumi.get(self, "resource_arns") + + @resource_arns.setter + def resource_arns(self, value: Optional[pulumi.Input[Sequence[pulumi.Input[str]]]]): + pulumi.set(self, "resource_arns", value) + + @property + @pulumi.getter + def sources(self) -> Optional[pulumi.Input[Sequence[pulumi.Input[str]]]]: + """ + Specifies from which source accounts the service principal has access to the resources in this resource share. + """ + return pulumi.get(self, "sources") + + @sources.setter + def sources(self, value: Optional[pulumi.Input[Sequence[pulumi.Input[str]]]]): + pulumi.set(self, "sources", value) + + @property + @pulumi.getter + def tags(self) -> Optional[pulumi.Input[Sequence[pulumi.Input['_root_inputs.TagArgs']]]]: + """ + Specifies one or more tags to attach to the resource share itself. It doesn't attach the tags to the resources associated with the resource share. + """ + return pulumi.get(self, "tags") + + @tags.setter + def tags(self, value: Optional[pulumi.Input[Sequence[pulumi.Input['_root_inputs.TagArgs']]]]): + pulumi.set(self, "tags", value) + + +class ResourceShare(pulumi.CustomResource): + @overload + def __init__(__self__, + resource_name: str, + opts: Optional[pulumi.ResourceOptions] = None, + allow_external_principals: Optional[pulumi.Input[bool]] = None, + name: Optional[pulumi.Input[str]] = None, + permission_arns: Optional[pulumi.Input[Sequence[pulumi.Input[str]]]] = None, + principals: Optional[pulumi.Input[Sequence[pulumi.Input[str]]]] = None, + resource_arns: Optional[pulumi.Input[Sequence[pulumi.Input[str]]]] = None, + sources: Optional[pulumi.Input[Sequence[pulumi.Input[str]]]] = None, + tags: Optional[pulumi.Input[Sequence[pulumi.Input[Union['_root_inputs.TagArgs', '_root_inputs.TagArgsDict']]]]] = None, + __props__=None): + """ + Resource type definition for AWS::RAM::ResourceShare + + ## Example Usage + ### Example + + ```python + import pulumi + import pulumi_aws_native as aws_native + + myresourceshare = aws_native.ram.ResourceShare("myresourceshare", + name="My Resource Share", + resource_arns=["arn:aws:ec2:us-east-1:123456789012:resource-type/12345678-1234-1234-1234-12345678"], + principals=["210987654321"], + tags=[ + { + "key": "Key1", + "value": "Value1", + }, + { + "key": "Key2", + "value": "Value2", + }, + ]) + + ``` + ### Example + + ```python + import pulumi + import pulumi_aws_native as aws_native + + myresourceshare = aws_native.ram.ResourceShare("myresourceshare", + name="My Resource Share", + resource_arns=["arn:aws:ec2:us-east-1:123456789012:resource-type/12345678-1234-1234-1234-12345678"], + principals=["210987654321"], + tags=[ + { + "key": "Key1", + "value": "Value1", + }, + { + "key": "Key2", + "value": "Value2", + }, + ]) + + ``` + + :param str resource_name: The name of the resource. + :param pulumi.ResourceOptions opts: Options for the resource. + :param pulumi.Input[bool] allow_external_principals: Specifies whether principals outside your organization in AWS Organizations can be associated with a resource share. A value of `true` lets you share with individual AWS accounts that are not in your organization. A value of `false` only has meaning if your account is a member of an AWS Organization. The default value is `true`. + :param pulumi.Input[str] name: Specifies the name of the resource share. + :param pulumi.Input[Sequence[pulumi.Input[str]]] permission_arns: Specifies the [Amazon Resource Names (ARNs)](https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html) of the AWS RAM permission to associate with the resource share. If you do not specify an ARN for the permission, AWS RAM automatically attaches the default version of the permission for each resource type. You can associate only one permission with each resource type included in the resource share. + :param pulumi.Input[Sequence[pulumi.Input[str]]] principals: Specifies the principals to associate with the resource share. The possible values are: + + - An AWS account ID + + - An Amazon Resource Name (ARN) of an organization in AWS Organizations + + - An ARN of an organizational unit (OU) in AWS Organizations + + - An ARN of an IAM role + + - An ARN of an IAM user + :param pulumi.Input[Sequence[pulumi.Input[str]]] resource_arns: Specifies a list of one or more ARNs of the resources to associate with the resource share. + :param pulumi.Input[Sequence[pulumi.Input[str]]] sources: Specifies from which source accounts the service principal has access to the resources in this resource share. + :param pulumi.Input[Sequence[pulumi.Input[Union['_root_inputs.TagArgs', '_root_inputs.TagArgsDict']]]] tags: Specifies one or more tags to attach to the resource share itself. It doesn't attach the tags to the resources associated with the resource share. + """ + ... + @overload + def __init__(__self__, + resource_name: str, + args: Optional[ResourceShareArgs] = None, + opts: Optional[pulumi.ResourceOptions] = None): + """ + Resource type definition for AWS::RAM::ResourceShare + + ## Example Usage + ### Example + + ```python + import pulumi + import pulumi_aws_native as aws_native + + myresourceshare = aws_native.ram.ResourceShare("myresourceshare", + name="My Resource Share", + resource_arns=["arn:aws:ec2:us-east-1:123456789012:resource-type/12345678-1234-1234-1234-12345678"], + principals=["210987654321"], + tags=[ + { + "key": "Key1", + "value": "Value1", + }, + { + "key": "Key2", + "value": "Value2", + }, + ]) + + ``` + ### Example + + ```python + import pulumi + import pulumi_aws_native as aws_native + + myresourceshare = aws_native.ram.ResourceShare("myresourceshare", + name="My Resource Share", + resource_arns=["arn:aws:ec2:us-east-1:123456789012:resource-type/12345678-1234-1234-1234-12345678"], + principals=["210987654321"], + tags=[ + { + "key": "Key1", + "value": "Value1", + }, + { + "key": "Key2", + "value": "Value2", + }, + ]) + + ``` + + :param str resource_name: The name of the resource. + :param ResourceShareArgs args: The arguments to use to populate this resource's properties. + :param pulumi.ResourceOptions opts: Options for the resource. + """ + ... + def __init__(__self__, resource_name: str, *args, **kwargs): + resource_args, opts = _utilities.get_resource_args_opts(ResourceShareArgs, pulumi.ResourceOptions, *args, **kwargs) + if resource_args is not None: + __self__._internal_init(resource_name, opts, **resource_args.__dict__) + else: + __self__._internal_init(resource_name, *args, **kwargs) + + def _internal_init(__self__, + resource_name: str, + opts: Optional[pulumi.ResourceOptions] = None, + allow_external_principals: Optional[pulumi.Input[bool]] = None, + name: Optional[pulumi.Input[str]] = None, + permission_arns: Optional[pulumi.Input[Sequence[pulumi.Input[str]]]] = None, + principals: Optional[pulumi.Input[Sequence[pulumi.Input[str]]]] = None, + resource_arns: Optional[pulumi.Input[Sequence[pulumi.Input[str]]]] = None, + sources: Optional[pulumi.Input[Sequence[pulumi.Input[str]]]] = None, + tags: Optional[pulumi.Input[Sequence[pulumi.Input[Union['_root_inputs.TagArgs', '_root_inputs.TagArgsDict']]]]] = None, + __props__=None): + opts = pulumi.ResourceOptions.merge(_utilities.get_resource_opts_defaults(), opts) + if not isinstance(opts, pulumi.ResourceOptions): + raise TypeError('Expected resource options to be a ResourceOptions instance') + if opts.id is None: + if __props__ is not None: + raise TypeError('__props__ is only valid when passed in combination with a valid opts.id to get an existing resource') + __props__ = ResourceShareArgs.__new__(ResourceShareArgs) + + __props__.__dict__["allow_external_principals"] = allow_external_principals + __props__.__dict__["name"] = name + __props__.__dict__["permission_arns"] = permission_arns + __props__.__dict__["principals"] = principals + __props__.__dict__["resource_arns"] = resource_arns + __props__.__dict__["sources"] = sources + __props__.__dict__["tags"] = tags + __props__.__dict__["arn"] = None + super(ResourceShare, __self__).__init__( + 'aws-native:ram:ResourceShare', + resource_name, + __props__, + opts) + + @staticmethod + def get(resource_name: str, + id: pulumi.Input[str], + opts: Optional[pulumi.ResourceOptions] = None) -> 'ResourceShare': + """ + Get an existing ResourceShare resource's state with the given name, id, and optional extra + properties used to qualify the lookup. + + :param str resource_name: The unique name of the resulting resource. + :param pulumi.Input[str] id: The unique provider ID of the resource to lookup. + :param pulumi.ResourceOptions opts: Options for the resource. + """ + opts = pulumi.ResourceOptions.merge(opts, pulumi.ResourceOptions(id=id)) + + __props__ = ResourceShareArgs.__new__(ResourceShareArgs) + + __props__.__dict__["allow_external_principals"] = None + __props__.__dict__["arn"] = None + __props__.__dict__["name"] = None + __props__.__dict__["permission_arns"] = None + __props__.__dict__["principals"] = None + __props__.__dict__["resource_arns"] = None + __props__.__dict__["sources"] = None + __props__.__dict__["tags"] = None + return ResourceShare(resource_name, opts=opts, __props__=__props__) + + @property + @pulumi.getter(name="allowExternalPrincipals") + def allow_external_principals(self) -> pulumi.Output[Optional[bool]]: + """ + Specifies whether principals outside your organization in AWS Organizations can be associated with a resource share. A value of `true` lets you share with individual AWS accounts that are not in your organization. A value of `false` only has meaning if your account is a member of an AWS Organization. The default value is `true`. + """ + return pulumi.get(self, "allow_external_principals") + + @property + @pulumi.getter + def arn(self) -> pulumi.Output[str]: + """ + The Amazon Resource Name (ARN) of the resource share. + """ + return pulumi.get(self, "arn") + + @property + @pulumi.getter + def name(self) -> pulumi.Output[str]: + """ + Specifies the name of the resource share. + """ + return pulumi.get(self, "name") + + @property + @pulumi.getter(name="permissionArns") + def permission_arns(self) -> pulumi.Output[Optional[Sequence[str]]]: + """ + Specifies the [Amazon Resource Names (ARNs)](https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html) of the AWS RAM permission to associate with the resource share. If you do not specify an ARN for the permission, AWS RAM automatically attaches the default version of the permission for each resource type. You can associate only one permission with each resource type included in the resource share. + """ + return pulumi.get(self, "permission_arns") + + @property + @pulumi.getter + def principals(self) -> pulumi.Output[Optional[Sequence[str]]]: + """ + Specifies the principals to associate with the resource share. The possible values are: + + - An AWS account ID + + - An Amazon Resource Name (ARN) of an organization in AWS Organizations + + - An ARN of an organizational unit (OU) in AWS Organizations + + - An ARN of an IAM role + + - An ARN of an IAM user + """ + return pulumi.get(self, "principals") + + @property + @pulumi.getter(name="resourceArns") + def resource_arns(self) -> pulumi.Output[Optional[Sequence[str]]]: + """ + Specifies a list of one or more ARNs of the resources to associate with the resource share. + """ + return pulumi.get(self, "resource_arns") + + @property + @pulumi.getter + def sources(self) -> pulumi.Output[Optional[Sequence[str]]]: + """ + Specifies from which source accounts the service principal has access to the resources in this resource share. + """ + return pulumi.get(self, "sources") + + @property + @pulumi.getter + def tags(self) -> pulumi.Output[Optional[Sequence['_root_outputs.Tag']]]: + """ + Specifies one or more tags to attach to the resource share itself. It doesn't attach the tags to the resources associated with the resource share. + """ + return pulumi.get(self, "tags") + diff --git a/sdk/python/pulumi_aws_native/rds/_enums.py b/sdk/python/pulumi_aws_native/rds/_enums.py index e63ccd2f4d..eb09d5e53b 100644 --- a/sdk/python/pulumi_aws_native/rds/_enums.py +++ b/sdk/python/pulumi_aws_native/rds/_enums.py @@ -19,7 +19,7 @@ class CustomDbEngineVersionStatus(str, Enum): """ - The availability status to be assigned to the CEV. + A value that indicates the status of a custom engine version (CEV). """ AVAILABLE = "available" INACTIVE = "inactive" diff --git a/sdk/python/pulumi_aws_native/rds/custom_db_engine_version.py b/sdk/python/pulumi_aws_native/rds/custom_db_engine_version.py index ba412aeeb1..7adc2dbad9 100644 --- a/sdk/python/pulumi_aws_native/rds/custom_db_engine_version.py +++ b/sdk/python/pulumi_aws_native/rds/custom_db_engine_version.py @@ -36,18 +36,28 @@ def __init__(__self__, *, use_aws_provided_latest_image: Optional[pulumi.Input[bool]] = None): """ The set of arguments for constructing a CustomDbEngineVersion resource. - :param pulumi.Input[str] engine: The database engine to use for your custom engine version (CEV). The only supported value is `custom-oracle-ee`. - :param pulumi.Input[str] engine_version: The name of your CEV. The name format is 19.customized_string . For example, a valid name is 19.my_cev1. This setting is required for RDS Custom for Oracle, but optional for Amazon RDS. The combination of Engine and EngineVersion is unique per customer per Region. - :param pulumi.Input[str] database_installation_files_s3_bucket_name: The name of an Amazon S3 bucket that contains database installation files for your CEV. For example, a valid bucket name is `my-custom-installation-files`. - :param pulumi.Input[str] database_installation_files_s3_prefix: The Amazon S3 directory that contains the database installation files for your CEV. For example, a valid bucket name is `123456789012/cev1`. If this setting isn't specified, no prefix is assumed. + :param pulumi.Input[str] engine: The database engine to use for your custom engine version (CEV). + Valid values: + + ``custom-oracle-ee`` + + ``custom-oracle-ee-cdb`` + :param pulumi.Input[str] engine_version: The name of your CEV. The name format is ``major version.customized_string``. For example, a valid CEV name is ``19.my_cev1``. This setting is required for RDS Custom for Oracle, but optional for Amazon RDS. The combination of ``Engine`` and ``EngineVersion`` is unique per customer per Region. + *Constraints:* Minimum length is 1. Maximum length is 60. + *Pattern:* ``^[a-z0-9_.-]{1,60$``} + :param pulumi.Input[str] database_installation_files_s3_bucket_name: The name of an Amazon S3 bucket that contains database installation files for your CEV. For example, a valid bucket name is ``my-custom-installation-files``. + :param pulumi.Input[str] database_installation_files_s3_prefix: The Amazon S3 directory that contains the database installation files for your CEV. For example, a valid bucket name is ``123456789012/cev1``. If this setting isn't specified, no prefix is assumed. :param pulumi.Input[str] description: An optional description of your CEV. - :param pulumi.Input[str] image_id: The identifier of Amazon Machine Image (AMI) used for CEV. - :param pulumi.Input[str] kms_key_id: The AWS KMS key identifier for an encrypted CEV. A symmetric KMS key is required for RDS Custom, but optional for Amazon RDS. + :param pulumi.Input[str] image_id: A value that indicates the ID of the AMI. + :param pulumi.Input[str] kms_key_id: The AWS KMS key identifier for an encrypted CEV. A symmetric encryption KMS key is required for RDS Custom, but optional for Amazon RDS. + If you have an existing symmetric encryption KMS key in your account, you can use it with RDS Custom. No further action is necessary. If you don't already have a symmetric encryption KMS key in your account, follow the instructions in [Creating a symmetric encryption KMS key](https://docs.aws.amazon.com/kms/latest/developerguide/create-keys.html#create-symmetric-cmk) in the *Key Management Service Developer Guide*. + You can choose the same symmetric encryption key when you create a CEV and a DB instance, or choose different keys. :param pulumi.Input[str] manifest: The CEV manifest, which is a JSON document that describes the installation .zip files stored in Amazon S3. Specify the name/value pairs in a file or a quoted string. RDS Custom applies the patches in the order in which they are listed. - :param pulumi.Input[str] source_custom_db_engine_version_identifier: The identifier of the source custom engine version. - :param pulumi.Input['CustomDbEngineVersionStatus'] status: The availability status to be assigned to the CEV. - :param pulumi.Input[Sequence[pulumi.Input['_root_inputs.TagArgs']]] tags: An array of key-value pairs to apply to this resource. - :param pulumi.Input[bool] use_aws_provided_latest_image: A value that indicates whether AWS provided latest image is applied automatically to the Custom Engine Version. By default, AWS provided latest image is applied automatically. This value is only applied on create. + The following JSON fields are valid: + + MediaImportTemplateVersion Version of the CEV manifest. The date is in the format YYYY-MM-DD. + databaseInstallationFileNames Ordered list of installation files for the CEV. + opatchFileNames Ordered list of OPatch installers used for the Oracle DB engine. + psuRuPatchFileNames The PSU and RU patches for this CEV. + OtherPatchFileNames The patches that are not in the list of PSU and RU patches. Amazon RDS applies these patches after applying the PSU and RU patches. + For more information, see [Creating the CEV manifest](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/custom-cev.html#custom-cev.preparing.manifest) in the *Amazon RDS User Guide*. + :param pulumi.Input[str] source_custom_db_engine_version_identifier: The ARN of a CEV to use as a source for creating a new CEV. You can specify a different Amazon Machine Imagine (AMI) by using either ``Source`` or ``UseAwsProvidedLatestImage``. You can't specify a different JSON manifest when you specify ``SourceCustomDbEngineVersionIdentifier``. + :param pulumi.Input['CustomDbEngineVersionStatus'] status: A value that indicates the status of a custom engine version (CEV). + :param pulumi.Input[Sequence[pulumi.Input['_root_inputs.TagArgs']]] tags: A list of tags. For more information, see [Tagging Amazon RDS Resources](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_Tagging.html) in the *Amazon RDS User Guide.* + :param pulumi.Input[bool] use_aws_provided_latest_image: Specifies whether to use the latest service-provided Amazon Machine Image (AMI) for the CEV. If you specify ``UseAwsProvidedLatestImage``, you can't also specify ``ImageId``. """ pulumi.set(__self__, "engine", engine) pulumi.set(__self__, "engine_version", engine_version) @@ -76,7 +86,10 @@ def __init__(__self__, *, @pulumi.getter def engine(self) -> pulumi.Input[str]: """ - The database engine to use for your custom engine version (CEV). The only supported value is `custom-oracle-ee`. + The database engine to use for your custom engine version (CEV). + Valid values: + + ``custom-oracle-ee`` + + ``custom-oracle-ee-cdb`` """ return pulumi.get(self, "engine") @@ -88,7 +101,9 @@ def engine(self, value: pulumi.Input[str]): @pulumi.getter(name="engineVersion") def engine_version(self) -> pulumi.Input[str]: """ - The name of your CEV. The name format is 19.customized_string . For example, a valid name is 19.my_cev1. This setting is required for RDS Custom for Oracle, but optional for Amazon RDS. The combination of Engine and EngineVersion is unique per customer per Region. + The name of your CEV. The name format is ``major version.customized_string``. For example, a valid CEV name is ``19.my_cev1``. This setting is required for RDS Custom for Oracle, but optional for Amazon RDS. The combination of ``Engine`` and ``EngineVersion`` is unique per customer per Region. + *Constraints:* Minimum length is 1. Maximum length is 60. + *Pattern:* ``^[a-z0-9_.-]{1,60$``} """ return pulumi.get(self, "engine_version") @@ -100,7 +115,7 @@ def engine_version(self, value: pulumi.Input[str]): @pulumi.getter(name="databaseInstallationFilesS3BucketName") def database_installation_files_s3_bucket_name(self) -> Optional[pulumi.Input[str]]: """ - The name of an Amazon S3 bucket that contains database installation files for your CEV. For example, a valid bucket name is `my-custom-installation-files`. + The name of an Amazon S3 bucket that contains database installation files for your CEV. For example, a valid bucket name is ``my-custom-installation-files``. """ return pulumi.get(self, "database_installation_files_s3_bucket_name") @@ -112,7 +127,7 @@ def database_installation_files_s3_bucket_name(self, value: Optional[pulumi.Inpu @pulumi.getter(name="databaseInstallationFilesS3Prefix") def database_installation_files_s3_prefix(self) -> Optional[pulumi.Input[str]]: """ - The Amazon S3 directory that contains the database installation files for your CEV. For example, a valid bucket name is `123456789012/cev1`. If this setting isn't specified, no prefix is assumed. + The Amazon S3 directory that contains the database installation files for your CEV. For example, a valid bucket name is ``123456789012/cev1``. If this setting isn't specified, no prefix is assumed. """ return pulumi.get(self, "database_installation_files_s3_prefix") @@ -136,7 +151,7 @@ def description(self, value: Optional[pulumi.Input[str]]): @pulumi.getter(name="imageId") def image_id(self) -> Optional[pulumi.Input[str]]: """ - The identifier of Amazon Machine Image (AMI) used for CEV. + A value that indicates the ID of the AMI. """ return pulumi.get(self, "image_id") @@ -148,7 +163,9 @@ def image_id(self, value: Optional[pulumi.Input[str]]): @pulumi.getter(name="kmsKeyId") def kms_key_id(self) -> Optional[pulumi.Input[str]]: """ - The AWS KMS key identifier for an encrypted CEV. A symmetric KMS key is required for RDS Custom, but optional for Amazon RDS. + The AWS KMS key identifier for an encrypted CEV. A symmetric encryption KMS key is required for RDS Custom, but optional for Amazon RDS. + If you have an existing symmetric encryption KMS key in your account, you can use it with RDS Custom. No further action is necessary. If you don't already have a symmetric encryption KMS key in your account, follow the instructions in [Creating a symmetric encryption KMS key](https://docs.aws.amazon.com/kms/latest/developerguide/create-keys.html#create-symmetric-cmk) in the *Key Management Service Developer Guide*. + You can choose the same symmetric encryption key when you create a CEV and a DB instance, or choose different keys. """ return pulumi.get(self, "kms_key_id") @@ -161,6 +178,9 @@ def kms_key_id(self, value: Optional[pulumi.Input[str]]): def manifest(self) -> Optional[pulumi.Input[str]]: """ The CEV manifest, which is a JSON document that describes the installation .zip files stored in Amazon S3. Specify the name/value pairs in a file or a quoted string. RDS Custom applies the patches in the order in which they are listed. + The following JSON fields are valid: + + MediaImportTemplateVersion Version of the CEV manifest. The date is in the format YYYY-MM-DD. + databaseInstallationFileNames Ordered list of installation files for the CEV. + opatchFileNames Ordered list of OPatch installers used for the Oracle DB engine. + psuRuPatchFileNames The PSU and RU patches for this CEV. + OtherPatchFileNames The patches that are not in the list of PSU and RU patches. Amazon RDS applies these patches after applying the PSU and RU patches. + For more information, see [Creating the CEV manifest](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/custom-cev.html#custom-cev.preparing.manifest) in the *Amazon RDS User Guide*. """ return pulumi.get(self, "manifest") @@ -172,7 +192,7 @@ def manifest(self, value: Optional[pulumi.Input[str]]): @pulumi.getter(name="sourceCustomDbEngineVersionIdentifier") def source_custom_db_engine_version_identifier(self) -> Optional[pulumi.Input[str]]: """ - The identifier of the source custom engine version. + The ARN of a CEV to use as a source for creating a new CEV. You can specify a different Amazon Machine Imagine (AMI) by using either ``Source`` or ``UseAwsProvidedLatestImage``. You can't specify a different JSON manifest when you specify ``SourceCustomDbEngineVersionIdentifier``. """ return pulumi.get(self, "source_custom_db_engine_version_identifier") @@ -184,7 +204,7 @@ def source_custom_db_engine_version_identifier(self, value: Optional[pulumi.Inpu @pulumi.getter def status(self) -> Optional[pulumi.Input['CustomDbEngineVersionStatus']]: """ - The availability status to be assigned to the CEV. + A value that indicates the status of a custom engine version (CEV). """ return pulumi.get(self, "status") @@ -196,7 +216,7 @@ def status(self, value: Optional[pulumi.Input['CustomDbEngineVersionStatus']]): @pulumi.getter def tags(self) -> Optional[pulumi.Input[Sequence[pulumi.Input['_root_inputs.TagArgs']]]]: """ - An array of key-value pairs to apply to this resource. + A list of tags. For more information, see [Tagging Amazon RDS Resources](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_Tagging.html) in the *Amazon RDS User Guide.* """ return pulumi.get(self, "tags") @@ -208,7 +228,7 @@ def tags(self, value: Optional[pulumi.Input[Sequence[pulumi.Input['_root_inputs. @pulumi.getter(name="useAwsProvidedLatestImage") def use_aws_provided_latest_image(self) -> Optional[pulumi.Input[bool]]: """ - A value that indicates whether AWS provided latest image is applied automatically to the Custom Engine Version. By default, AWS provided latest image is applied automatically. This value is only applied on create. + Specifies whether to use the latest service-provided Amazon Machine Image (AMI) for the CEV. If you specify ``UseAwsProvidedLatestImage``, you can't also specify ``ImageId``. """ return pulumi.get(self, "use_aws_provided_latest_image") @@ -236,22 +256,32 @@ def __init__(__self__, use_aws_provided_latest_image: Optional[pulumi.Input[bool]] = None, __props__=None): """ - The AWS::RDS::CustomDBEngineVersion resource creates an Amazon RDS custom DB engine version. + Creates a custom DB engine version (CEV). :param str resource_name: The name of the resource. :param pulumi.ResourceOptions opts: Options for the resource. - :param pulumi.Input[str] database_installation_files_s3_bucket_name: The name of an Amazon S3 bucket that contains database installation files for your CEV. For example, a valid bucket name is `my-custom-installation-files`. - :param pulumi.Input[str] database_installation_files_s3_prefix: The Amazon S3 directory that contains the database installation files for your CEV. For example, a valid bucket name is `123456789012/cev1`. If this setting isn't specified, no prefix is assumed. + :param pulumi.Input[str] database_installation_files_s3_bucket_name: The name of an Amazon S3 bucket that contains database installation files for your CEV. For example, a valid bucket name is ``my-custom-installation-files``. + :param pulumi.Input[str] database_installation_files_s3_prefix: The Amazon S3 directory that contains the database installation files for your CEV. For example, a valid bucket name is ``123456789012/cev1``. If this setting isn't specified, no prefix is assumed. :param pulumi.Input[str] description: An optional description of your CEV. - :param pulumi.Input[str] engine: The database engine to use for your custom engine version (CEV). The only supported value is `custom-oracle-ee`. - :param pulumi.Input[str] engine_version: The name of your CEV. The name format is 19.customized_string . For example, a valid name is 19.my_cev1. This setting is required for RDS Custom for Oracle, but optional for Amazon RDS. The combination of Engine and EngineVersion is unique per customer per Region. - :param pulumi.Input[str] image_id: The identifier of Amazon Machine Image (AMI) used for CEV. - :param pulumi.Input[str] kms_key_id: The AWS KMS key identifier for an encrypted CEV. A symmetric KMS key is required for RDS Custom, but optional for Amazon RDS. + :param pulumi.Input[str] engine: The database engine to use for your custom engine version (CEV). + Valid values: + + ``custom-oracle-ee`` + + ``custom-oracle-ee-cdb`` + :param pulumi.Input[str] engine_version: The name of your CEV. The name format is ``major version.customized_string``. For example, a valid CEV name is ``19.my_cev1``. This setting is required for RDS Custom for Oracle, but optional for Amazon RDS. The combination of ``Engine`` and ``EngineVersion`` is unique per customer per Region. + *Constraints:* Minimum length is 1. Maximum length is 60. + *Pattern:* ``^[a-z0-9_.-]{1,60$``} + :param pulumi.Input[str] image_id: A value that indicates the ID of the AMI. + :param pulumi.Input[str] kms_key_id: The AWS KMS key identifier for an encrypted CEV. A symmetric encryption KMS key is required for RDS Custom, but optional for Amazon RDS. + If you have an existing symmetric encryption KMS key in your account, you can use it with RDS Custom. No further action is necessary. If you don't already have a symmetric encryption KMS key in your account, follow the instructions in [Creating a symmetric encryption KMS key](https://docs.aws.amazon.com/kms/latest/developerguide/create-keys.html#create-symmetric-cmk) in the *Key Management Service Developer Guide*. + You can choose the same symmetric encryption key when you create a CEV and a DB instance, or choose different keys. :param pulumi.Input[str] manifest: The CEV manifest, which is a JSON document that describes the installation .zip files stored in Amazon S3. Specify the name/value pairs in a file or a quoted string. RDS Custom applies the patches in the order in which they are listed. - :param pulumi.Input[str] source_custom_db_engine_version_identifier: The identifier of the source custom engine version. - :param pulumi.Input['CustomDbEngineVersionStatus'] status: The availability status to be assigned to the CEV. - :param pulumi.Input[Sequence[pulumi.Input[Union['_root_inputs.TagArgs', '_root_inputs.TagArgsDict']]]] tags: An array of key-value pairs to apply to this resource. - :param pulumi.Input[bool] use_aws_provided_latest_image: A value that indicates whether AWS provided latest image is applied automatically to the Custom Engine Version. By default, AWS provided latest image is applied automatically. This value is only applied on create. + The following JSON fields are valid: + + MediaImportTemplateVersion Version of the CEV manifest. The date is in the format YYYY-MM-DD. + databaseInstallationFileNames Ordered list of installation files for the CEV. + opatchFileNames Ordered list of OPatch installers used for the Oracle DB engine. + psuRuPatchFileNames The PSU and RU patches for this CEV. + OtherPatchFileNames The patches that are not in the list of PSU and RU patches. Amazon RDS applies these patches after applying the PSU and RU patches. + For more information, see [Creating the CEV manifest](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/custom-cev.html#custom-cev.preparing.manifest) in the *Amazon RDS User Guide*. + :param pulumi.Input[str] source_custom_db_engine_version_identifier: The ARN of a CEV to use as a source for creating a new CEV. You can specify a different Amazon Machine Imagine (AMI) by using either ``Source`` or ``UseAwsProvidedLatestImage``. You can't specify a different JSON manifest when you specify ``SourceCustomDbEngineVersionIdentifier``. + :param pulumi.Input['CustomDbEngineVersionStatus'] status: A value that indicates the status of a custom engine version (CEV). + :param pulumi.Input[Sequence[pulumi.Input[Union['_root_inputs.TagArgs', '_root_inputs.TagArgsDict']]]] tags: A list of tags. For more information, see [Tagging Amazon RDS Resources](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_Tagging.html) in the *Amazon RDS User Guide.* + :param pulumi.Input[bool] use_aws_provided_latest_image: Specifies whether to use the latest service-provided Amazon Machine Image (AMI) for the CEV. If you specify ``UseAwsProvidedLatestImage``, you can't also specify ``ImageId``. """ ... @overload @@ -260,7 +290,7 @@ def __init__(__self__, args: CustomDbEngineVersionArgs, opts: Optional[pulumi.ResourceOptions] = None): """ - The AWS::RDS::CustomDBEngineVersion resource creates an Amazon RDS custom DB engine version. + Creates a custom DB engine version (CEV). :param str resource_name: The name of the resource. :param CustomDbEngineVersionArgs args: The arguments to use to populate this resource's properties. @@ -358,7 +388,7 @@ def get(resource_name: str, @pulumi.getter(name="databaseInstallationFilesS3BucketName") def database_installation_files_s3_bucket_name(self) -> pulumi.Output[Optional[str]]: """ - The name of an Amazon S3 bucket that contains database installation files for your CEV. For example, a valid bucket name is `my-custom-installation-files`. + The name of an Amazon S3 bucket that contains database installation files for your CEV. For example, a valid bucket name is ``my-custom-installation-files``. """ return pulumi.get(self, "database_installation_files_s3_bucket_name") @@ -366,7 +396,7 @@ def database_installation_files_s3_bucket_name(self) -> pulumi.Output[Optional[s @pulumi.getter(name="databaseInstallationFilesS3Prefix") def database_installation_files_s3_prefix(self) -> pulumi.Output[Optional[str]]: """ - The Amazon S3 directory that contains the database installation files for your CEV. For example, a valid bucket name is `123456789012/cev1`. If this setting isn't specified, no prefix is assumed. + The Amazon S3 directory that contains the database installation files for your CEV. For example, a valid bucket name is ``123456789012/cev1``. If this setting isn't specified, no prefix is assumed. """ return pulumi.get(self, "database_installation_files_s3_prefix") @@ -390,7 +420,10 @@ def description(self) -> pulumi.Output[Optional[str]]: @pulumi.getter def engine(self) -> pulumi.Output[str]: """ - The database engine to use for your custom engine version (CEV). The only supported value is `custom-oracle-ee`. + The database engine to use for your custom engine version (CEV). + Valid values: + + ``custom-oracle-ee`` + + ``custom-oracle-ee-cdb`` """ return pulumi.get(self, "engine") @@ -398,7 +431,9 @@ def engine(self) -> pulumi.Output[str]: @pulumi.getter(name="engineVersion") def engine_version(self) -> pulumi.Output[str]: """ - The name of your CEV. The name format is 19.customized_string . For example, a valid name is 19.my_cev1. This setting is required for RDS Custom for Oracle, but optional for Amazon RDS. The combination of Engine and EngineVersion is unique per customer per Region. + The name of your CEV. The name format is ``major version.customized_string``. For example, a valid CEV name is ``19.my_cev1``. This setting is required for RDS Custom for Oracle, but optional for Amazon RDS. The combination of ``Engine`` and ``EngineVersion`` is unique per customer per Region. + *Constraints:* Minimum length is 1. Maximum length is 60. + *Pattern:* ``^[a-z0-9_.-]{1,60$``} """ return pulumi.get(self, "engine_version") @@ -406,7 +441,7 @@ def engine_version(self) -> pulumi.Output[str]: @pulumi.getter(name="imageId") def image_id(self) -> pulumi.Output[Optional[str]]: """ - The identifier of Amazon Machine Image (AMI) used for CEV. + A value that indicates the ID of the AMI. """ return pulumi.get(self, "image_id") @@ -414,7 +449,9 @@ def image_id(self) -> pulumi.Output[Optional[str]]: @pulumi.getter(name="kmsKeyId") def kms_key_id(self) -> pulumi.Output[Optional[str]]: """ - The AWS KMS key identifier for an encrypted CEV. A symmetric KMS key is required for RDS Custom, but optional for Amazon RDS. + The AWS KMS key identifier for an encrypted CEV. A symmetric encryption KMS key is required for RDS Custom, but optional for Amazon RDS. + If you have an existing symmetric encryption KMS key in your account, you can use it with RDS Custom. No further action is necessary. If you don't already have a symmetric encryption KMS key in your account, follow the instructions in [Creating a symmetric encryption KMS key](https://docs.aws.amazon.com/kms/latest/developerguide/create-keys.html#create-symmetric-cmk) in the *Key Management Service Developer Guide*. + You can choose the same symmetric encryption key when you create a CEV and a DB instance, or choose different keys. """ return pulumi.get(self, "kms_key_id") @@ -423,6 +460,9 @@ def kms_key_id(self) -> pulumi.Output[Optional[str]]: def manifest(self) -> pulumi.Output[Optional[str]]: """ The CEV manifest, which is a JSON document that describes the installation .zip files stored in Amazon S3. Specify the name/value pairs in a file or a quoted string. RDS Custom applies the patches in the order in which they are listed. + The following JSON fields are valid: + + MediaImportTemplateVersion Version of the CEV manifest. The date is in the format YYYY-MM-DD. + databaseInstallationFileNames Ordered list of installation files for the CEV. + opatchFileNames Ordered list of OPatch installers used for the Oracle DB engine. + psuRuPatchFileNames The PSU and RU patches for this CEV. + OtherPatchFileNames The patches that are not in the list of PSU and RU patches. Amazon RDS applies these patches after applying the PSU and RU patches. + For more information, see [Creating the CEV manifest](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/custom-cev.html#custom-cev.preparing.manifest) in the *Amazon RDS User Guide*. """ return pulumi.get(self, "manifest") @@ -430,7 +470,7 @@ def manifest(self) -> pulumi.Output[Optional[str]]: @pulumi.getter(name="sourceCustomDbEngineVersionIdentifier") def source_custom_db_engine_version_identifier(self) -> pulumi.Output[Optional[str]]: """ - The identifier of the source custom engine version. + The ARN of a CEV to use as a source for creating a new CEV. You can specify a different Amazon Machine Imagine (AMI) by using either ``Source`` or ``UseAwsProvidedLatestImage``. You can't specify a different JSON manifest when you specify ``SourceCustomDbEngineVersionIdentifier``. """ return pulumi.get(self, "source_custom_db_engine_version_identifier") @@ -438,7 +478,7 @@ def source_custom_db_engine_version_identifier(self) -> pulumi.Output[Optional[s @pulumi.getter def status(self) -> pulumi.Output[Optional['CustomDbEngineVersionStatus']]: """ - The availability status to be assigned to the CEV. + A value that indicates the status of a custom engine version (CEV). """ return pulumi.get(self, "status") @@ -446,7 +486,7 @@ def status(self) -> pulumi.Output[Optional['CustomDbEngineVersionStatus']]: @pulumi.getter def tags(self) -> pulumi.Output[Optional[Sequence['_root_outputs.Tag']]]: """ - An array of key-value pairs to apply to this resource. + A list of tags. For more information, see [Tagging Amazon RDS Resources](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_Tagging.html) in the *Amazon RDS User Guide.* """ return pulumi.get(self, "tags") @@ -454,7 +494,7 @@ def tags(self) -> pulumi.Output[Optional[Sequence['_root_outputs.Tag']]]: @pulumi.getter(name="useAwsProvidedLatestImage") def use_aws_provided_latest_image(self) -> pulumi.Output[Optional[bool]]: """ - A value that indicates whether AWS provided latest image is applied automatically to the Custom Engine Version. By default, AWS provided latest image is applied automatically. This value is only applied on create. + Specifies whether to use the latest service-provided Amazon Machine Image (AMI) for the CEV. If you specify ``UseAwsProvidedLatestImage``, you can't also specify ``ImageId``. """ return pulumi.get(self, "use_aws_provided_latest_image") diff --git a/sdk/python/pulumi_aws_native/rds/get_custom_db_engine_version.py b/sdk/python/pulumi_aws_native/rds/get_custom_db_engine_version.py index 27a6e836ad..e792dc31fc 100644 --- a/sdk/python/pulumi_aws_native/rds/get_custom_db_engine_version.py +++ b/sdk/python/pulumi_aws_native/rds/get_custom_db_engine_version.py @@ -59,7 +59,7 @@ def description(self) -> Optional[str]: @pulumi.getter def status(self) -> Optional['CustomDbEngineVersionStatus']: """ - The availability status to be assigned to the CEV. + A value that indicates the status of a custom engine version (CEV). """ return pulumi.get(self, "status") @@ -67,7 +67,7 @@ def status(self) -> Optional['CustomDbEngineVersionStatus']: @pulumi.getter def tags(self) -> Optional[Sequence['_root_outputs.Tag']]: """ - An array of key-value pairs to apply to this resource. + A list of tags. For more information, see [Tagging Amazon RDS Resources](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_Tagging.html) in the *Amazon RDS User Guide.* """ return pulumi.get(self, "tags") @@ -88,11 +88,16 @@ def get_custom_db_engine_version(engine: Optional[str] = None, engine_version: Optional[str] = None, opts: Optional[pulumi.InvokeOptions] = None) -> AwaitableGetCustomDbEngineVersionResult: """ - The AWS::RDS::CustomDBEngineVersion resource creates an Amazon RDS custom DB engine version. + Creates a custom DB engine version (CEV). - :param str engine: The database engine to use for your custom engine version (CEV). The only supported value is `custom-oracle-ee`. - :param str engine_version: The name of your CEV. The name format is 19.customized_string . For example, a valid name is 19.my_cev1. This setting is required for RDS Custom for Oracle, but optional for Amazon RDS. The combination of Engine and EngineVersion is unique per customer per Region. + :param str engine: The database engine to use for your custom engine version (CEV). + Valid values: + + ``custom-oracle-ee`` + + ``custom-oracle-ee-cdb`` + :param str engine_version: The name of your CEV. The name format is ``major version.customized_string``. For example, a valid CEV name is ``19.my_cev1``. This setting is required for RDS Custom for Oracle, but optional for Amazon RDS. The combination of ``Engine`` and ``EngineVersion`` is unique per customer per Region. + *Constraints:* Minimum length is 1. Maximum length is 60. + *Pattern:* ``^[a-z0-9_.-]{1,60$``} """ __args__ = dict() __args__['engine'] = engine @@ -109,11 +114,16 @@ def get_custom_db_engine_version_output(engine: Optional[pulumi.Input[str]] = No engine_version: Optional[pulumi.Input[str]] = None, opts: Optional[Union[pulumi.InvokeOptions, pulumi.InvokeOutputOptions]] = None) -> pulumi.Output[GetCustomDbEngineVersionResult]: """ - The AWS::RDS::CustomDBEngineVersion resource creates an Amazon RDS custom DB engine version. + Creates a custom DB engine version (CEV). - :param str engine: The database engine to use for your custom engine version (CEV). The only supported value is `custom-oracle-ee`. - :param str engine_version: The name of your CEV. The name format is 19.customized_string . For example, a valid name is 19.my_cev1. This setting is required for RDS Custom for Oracle, but optional for Amazon RDS. The combination of Engine and EngineVersion is unique per customer per Region. + :param str engine: The database engine to use for your custom engine version (CEV). + Valid values: + + ``custom-oracle-ee`` + + ``custom-oracle-ee-cdb`` + :param str engine_version: The name of your CEV. The name format is ``major version.customized_string``. For example, a valid CEV name is ``19.my_cev1``. This setting is required for RDS Custom for Oracle, but optional for Amazon RDS. The combination of ``Engine`` and ``EngineVersion`` is unique per customer per Region. + *Constraints:* Minimum length is 1. Maximum length is 60. + *Pattern:* ``^[a-z0-9_.-]{1,60$``} """ __args__ = dict() __args__['engine'] = engine diff --git a/sdk/python/pulumi_aws_native/redshiftserverless/_enums.py b/sdk/python/pulumi_aws_native/redshiftserverless/_enums.py index bad6ffcff7..d324c356c5 100644 --- a/sdk/python/pulumi_aws_native/redshiftserverless/_enums.py +++ b/sdk/python/pulumi_aws_native/redshiftserverless/_enums.py @@ -7,6 +7,7 @@ __all__ = [ 'NamespaceLogExport', 'NamespaceStatus', + 'WorkgroupPerformanceTargetStatus', 'WorkgroupStatus', ] @@ -23,6 +24,11 @@ class NamespaceStatus(str, Enum): DELETING = "DELETING" +class WorkgroupPerformanceTargetStatus(str, Enum): + ENABLED = "ENABLED" + DISABLED = "DISABLED" + + class WorkgroupStatus(str, Enum): CREATING = "CREATING" AVAILABLE = "AVAILABLE" diff --git a/sdk/python/pulumi_aws_native/redshiftserverless/_inputs.py b/sdk/python/pulumi_aws_native/redshiftserverless/_inputs.py index 69551e0c28..7be87c19f9 100644 --- a/sdk/python/pulumi_aws_native/redshiftserverless/_inputs.py +++ b/sdk/python/pulumi_aws_native/redshiftserverless/_inputs.py @@ -20,6 +20,8 @@ 'NamespaceSnapshotCopyConfigurationArgsDict', 'WorkgroupConfigParameterArgs', 'WorkgroupConfigParameterArgsDict', + 'WorkgroupPerformanceTargetArgs', + 'WorkgroupPerformanceTargetArgsDict', ] MYPY = False @@ -147,3 +149,39 @@ def parameter_value(self, value: Optional[pulumi.Input[str]]): pulumi.set(self, "parameter_value", value) +if not MYPY: + class WorkgroupPerformanceTargetArgsDict(TypedDict): + level: NotRequired[pulumi.Input[int]] + status: NotRequired[pulumi.Input['WorkgroupPerformanceTargetStatus']] +elif False: + WorkgroupPerformanceTargetArgsDict: TypeAlias = Mapping[str, Any] + +@pulumi.input_type +class WorkgroupPerformanceTargetArgs: + def __init__(__self__, *, + level: Optional[pulumi.Input[int]] = None, + status: Optional[pulumi.Input['WorkgroupPerformanceTargetStatus']] = None): + if level is not None: + pulumi.set(__self__, "level", level) + if status is not None: + pulumi.set(__self__, "status", status) + + @property + @pulumi.getter + def level(self) -> Optional[pulumi.Input[int]]: + return pulumi.get(self, "level") + + @level.setter + def level(self, value: Optional[pulumi.Input[int]]): + pulumi.set(self, "level", value) + + @property + @pulumi.getter + def status(self) -> Optional[pulumi.Input['WorkgroupPerformanceTargetStatus']]: + return pulumi.get(self, "status") + + @status.setter + def status(self, value: Optional[pulumi.Input['WorkgroupPerformanceTargetStatus']]): + pulumi.set(self, "status", value) + + diff --git a/sdk/python/pulumi_aws_native/redshiftserverless/get_workgroup.py b/sdk/python/pulumi_aws_native/redshiftserverless/get_workgroup.py index 7a8b3d72b7..ac8c96ea4f 100644 --- a/sdk/python/pulumi_aws_native/redshiftserverless/get_workgroup.py +++ b/sdk/python/pulumi_aws_native/redshiftserverless/get_workgroup.py @@ -26,13 +26,16 @@ @pulumi.output_type class GetWorkgroupResult: - def __init__(__self__, enhanced_vpc_routing=None, port=None, publicly_accessible=None, tags=None, workgroup=None): + def __init__(__self__, enhanced_vpc_routing=None, port=None, price_performance_target=None, publicly_accessible=None, tags=None, workgroup=None): if enhanced_vpc_routing and not isinstance(enhanced_vpc_routing, bool): raise TypeError("Expected argument 'enhanced_vpc_routing' to be a bool") pulumi.set(__self__, "enhanced_vpc_routing", enhanced_vpc_routing) if port and not isinstance(port, int): raise TypeError("Expected argument 'port' to be a int") pulumi.set(__self__, "port", port) + if price_performance_target and not isinstance(price_performance_target, dict): + raise TypeError("Expected argument 'price_performance_target' to be a dict") + pulumi.set(__self__, "price_performance_target", price_performance_target) if publicly_accessible and not isinstance(publicly_accessible, bool): raise TypeError("Expected argument 'publicly_accessible' to be a bool") pulumi.set(__self__, "publicly_accessible", publicly_accessible) @@ -59,6 +62,14 @@ def port(self) -> Optional[int]: """ return pulumi.get(self, "port") + @property + @pulumi.getter(name="pricePerformanceTarget") + def price_performance_target(self) -> Optional['outputs.WorkgroupPerformanceTarget']: + """ + A property that represents the price performance target settings for the workgroup. + """ + return pulumi.get(self, "price_performance_target") + @property @pulumi.getter(name="publiclyAccessible") def publicly_accessible(self) -> Optional[bool]: @@ -92,6 +103,7 @@ def __await__(self): return GetWorkgroupResult( enhanced_vpc_routing=self.enhanced_vpc_routing, port=self.port, + price_performance_target=self.price_performance_target, publicly_accessible=self.publicly_accessible, tags=self.tags, workgroup=self.workgroup) @@ -113,6 +125,7 @@ def get_workgroup(workgroup_name: Optional[str] = None, return AwaitableGetWorkgroupResult( enhanced_vpc_routing=pulumi.get(__ret__, 'enhanced_vpc_routing'), port=pulumi.get(__ret__, 'port'), + price_performance_target=pulumi.get(__ret__, 'price_performance_target'), publicly_accessible=pulumi.get(__ret__, 'publicly_accessible'), tags=pulumi.get(__ret__, 'tags'), workgroup=pulumi.get(__ret__, 'workgroup')) @@ -131,6 +144,7 @@ def get_workgroup_output(workgroup_name: Optional[pulumi.Input[str]] = None, return __ret__.apply(lambda __response__: GetWorkgroupResult( enhanced_vpc_routing=pulumi.get(__response__, 'enhanced_vpc_routing'), port=pulumi.get(__response__, 'port'), + price_performance_target=pulumi.get(__response__, 'price_performance_target'), publicly_accessible=pulumi.get(__response__, 'publicly_accessible'), tags=pulumi.get(__response__, 'tags'), workgroup=pulumi.get(__response__, 'workgroup'))) diff --git a/sdk/python/pulumi_aws_native/redshiftserverless/outputs.py b/sdk/python/pulumi_aws_native/redshiftserverless/outputs.py index 29fdead938..cf321871e0 100644 --- a/sdk/python/pulumi_aws_native/redshiftserverless/outputs.py +++ b/sdk/python/pulumi_aws_native/redshiftserverless/outputs.py @@ -23,6 +23,7 @@ 'WorkgroupConfigParameter', 'WorkgroupEndpoint', 'WorkgroupNetworkInterface', + 'WorkgroupPerformanceTarget', 'WorkgroupVpcEndpoint', ] @@ -308,6 +309,8 @@ def __key_warning(key: str): suggest = "max_capacity" elif key == "namespaceName": suggest = "namespace_name" + elif key == "pricePerformanceTarget": + suggest = "price_performance_target" elif key == "publiclyAccessible": suggest = "publicly_accessible" elif key == "securityGroupIds": @@ -340,6 +343,7 @@ def __init__(__self__, *, enhanced_vpc_routing: Optional[bool] = None, max_capacity: Optional[int] = None, namespace_name: Optional[str] = None, + price_performance_target: Optional['outputs.WorkgroupPerformanceTarget'] = None, publicly_accessible: Optional[bool] = None, security_group_ids: Optional[Sequence[str]] = None, status: Optional['WorkgroupStatus'] = None, @@ -377,6 +381,8 @@ def __init__(__self__, *, pulumi.set(__self__, "max_capacity", max_capacity) if namespace_name is not None: pulumi.set(__self__, "namespace_name", namespace_name) + if price_performance_target is not None: + pulumi.set(__self__, "price_performance_target", price_performance_target) if publicly_accessible is not None: pulumi.set(__self__, "publicly_accessible", publicly_accessible) if security_group_ids is not None: @@ -448,6 +454,11 @@ def namespace_name(self) -> Optional[str]: """ return pulumi.get(self, "namespace_name") + @property + @pulumi.getter(name="pricePerformanceTarget") + def price_performance_target(self) -> Optional['outputs.WorkgroupPerformanceTarget']: + return pulumi.get(self, "price_performance_target") + @property @pulumi.getter(name="publiclyAccessible") def publicly_accessible(self) -> Optional[bool]: @@ -693,6 +704,27 @@ def subnet_id(self) -> Optional[str]: return pulumi.get(self, "subnet_id") +@pulumi.output_type +class WorkgroupPerformanceTarget(dict): + def __init__(__self__, *, + level: Optional[int] = None, + status: Optional['WorkgroupPerformanceTargetStatus'] = None): + if level is not None: + pulumi.set(__self__, "level", level) + if status is not None: + pulumi.set(__self__, "status", status) + + @property + @pulumi.getter + def level(self) -> Optional[int]: + return pulumi.get(self, "level") + + @property + @pulumi.getter + def status(self) -> Optional['WorkgroupPerformanceTargetStatus']: + return pulumi.get(self, "status") + + @pulumi.output_type class WorkgroupVpcEndpoint(dict): @staticmethod diff --git a/sdk/python/pulumi_aws_native/redshiftserverless/workgroup.py b/sdk/python/pulumi_aws_native/redshiftserverless/workgroup.py index 650f61f2e9..4eed3bc0ba 100644 --- a/sdk/python/pulumi_aws_native/redshiftserverless/workgroup.py +++ b/sdk/python/pulumi_aws_native/redshiftserverless/workgroup.py @@ -30,6 +30,7 @@ def __init__(__self__, *, max_capacity: Optional[pulumi.Input[int]] = None, namespace_name: Optional[pulumi.Input[str]] = None, port: Optional[pulumi.Input[int]] = None, + price_performance_target: Optional[pulumi.Input['WorkgroupPerformanceTargetArgs']] = None, publicly_accessible: Optional[pulumi.Input[bool]] = None, security_group_ids: Optional[pulumi.Input[Sequence[pulumi.Input[str]]]] = None, subnet_ids: Optional[pulumi.Input[Sequence[pulumi.Input[str]]]] = None, @@ -43,6 +44,7 @@ def __init__(__self__, *, :param pulumi.Input[int] max_capacity: The max compute capacity of the workgroup in Redshift Processing Units (RPUs). :param pulumi.Input[str] namespace_name: The namespace the workgroup is associated with. :param pulumi.Input[int] port: The custom port to use when connecting to a workgroup. Valid port ranges are 5431-5455 and 8191-8215. The default is 5439. + :param pulumi.Input['WorkgroupPerformanceTargetArgs'] price_performance_target: A property that represents the price performance target settings for the workgroup. :param pulumi.Input[bool] publicly_accessible: A value that specifies whether the workgroup can be accessible from a public network. :param pulumi.Input[Sequence[pulumi.Input[str]]] security_group_ids: A list of security group IDs to associate with the workgroup. :param pulumi.Input[Sequence[pulumi.Input[str]]] subnet_ids: A list of subnet IDs the workgroup is associated with. @@ -61,6 +63,8 @@ def __init__(__self__, *, pulumi.set(__self__, "namespace_name", namespace_name) if port is not None: pulumi.set(__self__, "port", port) + if price_performance_target is not None: + pulumi.set(__self__, "price_performance_target", price_performance_target) if publicly_accessible is not None: pulumi.set(__self__, "publicly_accessible", publicly_accessible) if security_group_ids is not None: @@ -144,6 +148,18 @@ def port(self) -> Optional[pulumi.Input[int]]: def port(self, value: Optional[pulumi.Input[int]]): pulumi.set(self, "port", value) + @property + @pulumi.getter(name="pricePerformanceTarget") + def price_performance_target(self) -> Optional[pulumi.Input['WorkgroupPerformanceTargetArgs']]: + """ + A property that represents the price performance target settings for the workgroup. + """ + return pulumi.get(self, "price_performance_target") + + @price_performance_target.setter + def price_performance_target(self, value: Optional[pulumi.Input['WorkgroupPerformanceTargetArgs']]): + pulumi.set(self, "price_performance_target", value) + @property @pulumi.getter(name="publiclyAccessible") def publicly_accessible(self) -> Optional[pulumi.Input[bool]]: @@ -216,6 +232,7 @@ def __init__(__self__, max_capacity: Optional[pulumi.Input[int]] = None, namespace_name: Optional[pulumi.Input[str]] = None, port: Optional[pulumi.Input[int]] = None, + price_performance_target: Optional[pulumi.Input[Union['WorkgroupPerformanceTargetArgs', 'WorkgroupPerformanceTargetArgsDict']]] = None, publicly_accessible: Optional[pulumi.Input[bool]] = None, security_group_ids: Optional[pulumi.Input[Sequence[pulumi.Input[str]]]] = None, subnet_ids: Optional[pulumi.Input[Sequence[pulumi.Input[str]]]] = None, @@ -233,6 +250,7 @@ def __init__(__self__, :param pulumi.Input[int] max_capacity: The max compute capacity of the workgroup in Redshift Processing Units (RPUs). :param pulumi.Input[str] namespace_name: The namespace the workgroup is associated with. :param pulumi.Input[int] port: The custom port to use when connecting to a workgroup. Valid port ranges are 5431-5455 and 8191-8215. The default is 5439. + :param pulumi.Input[Union['WorkgroupPerformanceTargetArgs', 'WorkgroupPerformanceTargetArgsDict']] price_performance_target: A property that represents the price performance target settings for the workgroup. :param pulumi.Input[bool] publicly_accessible: A value that specifies whether the workgroup can be accessible from a public network. :param pulumi.Input[Sequence[pulumi.Input[str]]] security_group_ids: A list of security group IDs to associate with the workgroup. :param pulumi.Input[Sequence[pulumi.Input[str]]] subnet_ids: A list of subnet IDs the workgroup is associated with. @@ -269,6 +287,7 @@ def _internal_init(__self__, max_capacity: Optional[pulumi.Input[int]] = None, namespace_name: Optional[pulumi.Input[str]] = None, port: Optional[pulumi.Input[int]] = None, + price_performance_target: Optional[pulumi.Input[Union['WorkgroupPerformanceTargetArgs', 'WorkgroupPerformanceTargetArgsDict']]] = None, publicly_accessible: Optional[pulumi.Input[bool]] = None, security_group_ids: Optional[pulumi.Input[Sequence[pulumi.Input[str]]]] = None, subnet_ids: Optional[pulumi.Input[Sequence[pulumi.Input[str]]]] = None, @@ -289,6 +308,7 @@ def _internal_init(__self__, __props__.__dict__["max_capacity"] = max_capacity __props__.__dict__["namespace_name"] = namespace_name __props__.__dict__["port"] = port + __props__.__dict__["price_performance_target"] = price_performance_target __props__.__dict__["publicly_accessible"] = publicly_accessible __props__.__dict__["security_group_ids"] = security_group_ids __props__.__dict__["subnet_ids"] = subnet_ids @@ -325,6 +345,7 @@ def get(resource_name: str, __props__.__dict__["max_capacity"] = None __props__.__dict__["namespace_name"] = None __props__.__dict__["port"] = None + __props__.__dict__["price_performance_target"] = None __props__.__dict__["publicly_accessible"] = None __props__.__dict__["security_group_ids"] = None __props__.__dict__["subnet_ids"] = None @@ -381,6 +402,14 @@ def port(self) -> pulumi.Output[Optional[int]]: """ return pulumi.get(self, "port") + @property + @pulumi.getter(name="pricePerformanceTarget") + def price_performance_target(self) -> pulumi.Output[Optional['outputs.WorkgroupPerformanceTarget']]: + """ + A property that represents the price performance target settings for the workgroup. + """ + return pulumi.get(self, "price_performance_target") + @property @pulumi.getter(name="publiclyAccessible") def publicly_accessible(self) -> pulumi.Output[Optional[bool]]: diff --git a/sdk/python/pulumi_aws_native/s3/_inputs.py b/sdk/python/pulumi_aws_native/s3/_inputs.py index 718ae2698c..74e1dcdc3b 100644 --- a/sdk/python/pulumi_aws_native/s3/_inputs.py +++ b/sdk/python/pulumi_aws_native/s3/_inputs.py @@ -62,6 +62,10 @@ 'BucketLifecycleConfigurationArgsDict', 'BucketLoggingConfigurationArgs', 'BucketLoggingConfigurationArgsDict', + 'BucketMetadataTableConfigurationArgs', + 'BucketMetadataTableConfigurationArgsDict', + 'BucketMetadataTableErrorArgs', + 'BucketMetadataTableErrorArgsDict', 'BucketMetricsConfigurationArgs', 'BucketMetricsConfigurationArgsDict', 'BucketMetricsArgs', @@ -114,6 +118,8 @@ 'BucketRuleArgsDict', 'BucketS3KeyFilterArgs', 'BucketS3KeyFilterArgsDict', + 'BucketS3TablesDestinationArgs', + 'BucketS3TablesDestinationArgsDict', 'BucketServerSideEncryptionByDefaultArgs', 'BucketServerSideEncryptionByDefaultArgsDict', 'BucketServerSideEncryptionRuleArgs', @@ -1698,6 +1704,120 @@ def target_object_key_format(self, value: Optional[pulumi.Input['BucketTargetObj pulumi.set(self, "target_object_key_format", value) +if not MYPY: + class BucketMetadataTableConfigurationArgsDict(TypedDict): + s3_tables_destination: pulumi.Input['BucketS3TablesDestinationArgsDict'] + error: NotRequired[pulumi.Input['BucketMetadataTableErrorArgsDict']] + """ + Returns the Error value of the GetBucketMetadataTableConfiguration response. + """ + status: NotRequired[pulumi.Input[str]] + """ + Returns the Status value of the GetBucketMetadataTableConfigurationResult response. This value indicates the status of the metadata table. The status values are:
CREATING - The metadata table is in the process of being created in the specified table bucket.
ACTIVE - The metadata table has been created successfully and records are being delivered to the table.
FAILED - Amazon S3 is unable to create the metadata table, or Amazon S3 is unable to deliver records. + """ +elif False: + BucketMetadataTableConfigurationArgsDict: TypeAlias = Mapping[str, Any] + +@pulumi.input_type +class BucketMetadataTableConfigurationArgs: + def __init__(__self__, *, + s3_tables_destination: pulumi.Input['BucketS3TablesDestinationArgs'], + error: Optional[pulumi.Input['BucketMetadataTableErrorArgs']] = None, + status: Optional[pulumi.Input[str]] = None): + """ + :param pulumi.Input['BucketMetadataTableErrorArgs'] error: Returns the Error value of the GetBucketMetadataTableConfiguration response. + :param pulumi.Input[str] status: Returns the Status value of the GetBucketMetadataTableConfigurationResult response. This value indicates the status of the metadata table. The status values are:
CREATING - The metadata table is in the process of being created in the specified table bucket.
ACTIVE - The metadata table has been created successfully and records are being delivered to the table.
FAILED - Amazon S3 is unable to create the metadata table, or Amazon S3 is unable to deliver records. + """ + pulumi.set(__self__, "s3_tables_destination", s3_tables_destination) + if error is not None: + pulumi.set(__self__, "error", error) + if status is not None: + pulumi.set(__self__, "status", status) + + @property + @pulumi.getter(name="s3TablesDestination") + def s3_tables_destination(self) -> pulumi.Input['BucketS3TablesDestinationArgs']: + return pulumi.get(self, "s3_tables_destination") + + @s3_tables_destination.setter + def s3_tables_destination(self, value: pulumi.Input['BucketS3TablesDestinationArgs']): + pulumi.set(self, "s3_tables_destination", value) + + @property + @pulumi.getter + def error(self) -> Optional[pulumi.Input['BucketMetadataTableErrorArgs']]: + """ + Returns the Error value of the GetBucketMetadataTableConfiguration response. + """ + return pulumi.get(self, "error") + + @error.setter + def error(self, value: Optional[pulumi.Input['BucketMetadataTableErrorArgs']]): + pulumi.set(self, "error", value) + + @property + @pulumi.getter + def status(self) -> Optional[pulumi.Input[str]]: + """ + Returns the Status value of the GetBucketMetadataTableConfigurationResult response. This value indicates the status of the metadata table. The status values are:
CREATING - The metadata table is in the process of being created in the specified table bucket.
ACTIVE - The metadata table has been created successfully and records are being delivered to the table.
FAILED - Amazon S3 is unable to create the metadata table, or Amazon S3 is unable to deliver records. + """ + return pulumi.get(self, "status") + + @status.setter + def status(self, value: Optional[pulumi.Input[str]]): + pulumi.set(self, "status", value) + + +if not MYPY: + class BucketMetadataTableErrorArgsDict(TypedDict): + error_code: pulumi.Input[str] + """ + If the CreateBucketMetadataTableConfiguration request succeeds, but S3 Metadata was unable to create the table, this structure contains the error code. The possible error codes and error messages are as follows:
AccessDeniedCreatingResources - You don't have sufficient permissions to create the required resources. Make sure that you have s3tables:CreateNamespace, s3tables:CreateTable, s3tables:GetTable and s3tables:PutTablePolicy permissions, and then try again. To create a new metadata table, you must delete the metadata configuration for this bucket, and then create a new metadata configuration.
AccessDeniedWritingToTable - Unable to write to the metadata table because of missing resource permissions. To fix the resource policy, Amazon S3 needs to create a new metadata table. To create a new metadata table, you must delete the metadata configuration for this bucket, and then create a new metadata configuration.
DestinationTableNotFound - The destination table doesn't exist. To create a new metadata table, you must delete the metadata configuration for this bucket, and then create a new metadata configuration.
ServerInternalError - An internal error has occurred. To create a new metadata table, you must delete the metadata configuration for this bucket, and then create a new metadata configuration.
TableAlreadyExists - The table that you specified already exists in the table bucket's namespace. Specify a different table name. To create a new metadata table, you must delete the metadata configuration for this bucket, and then create a new metadata configuration.
TableBucketNotFound - The table bucket that you specified doesn't exist in this AWS Region and account. Create or choose a different table bucket. To create a new metadata table, you must delete the metadata configuration for this bucket, and then create a new metadata configuration. + """ + error_message: pulumi.Input[str] + """ + If the CreateBucketMetadataTableConfiguration request succeeds, but S3 Metadata was unable to create the table, this structure contains the error code. The possible error codes and error messages are as follows:
AccessDeniedCreatingResources - You don't have sufficient permissions to create the required resources. Make sure that you have s3tables:CreateNamespace, s3tables:CreateTable, s3tables:GetTable and s3tables:PutTablePolicy permissions, and then try again. To create a new metadata table, you must delete the metadata configuration for this bucket, and then create a new metadata configuration.
AccessDeniedWritingToTable - Unable to write to the metadata table because of missing resource permissions. To fix the resource policy, Amazon S3 needs to create a new metadata table. To create a new metadata table, you must delete the metadata configuration for this bucket, and then create a new metadata configuration.
DestinationTableNotFound - The destination table doesn't exist. To create a new metadata table, you must delete the metadata configuration for this bucket, and then create a new metadata configuration.
ServerInternalError - An internal error has occurred. To create a new metadata table, you must delete the metadata configuration for this bucket, and then create a new metadata configuration.
TableAlreadyExists - The table that you specified already exists in the table bucket's namespace. Specify a different table name. To create a new metadata table, you must delete the metadata configuration for this bucket, and then create a new metadata configuration.
TableBucketNotFound - The table bucket that you specified doesn't exist in this AWS Region and account. Create or choose a different table bucket. To create a new metadata table, you must delete the metadata configuration for this bucket, and then create a new metadata configuration. + """ +elif False: + BucketMetadataTableErrorArgsDict: TypeAlias = Mapping[str, Any] + +@pulumi.input_type +class BucketMetadataTableErrorArgs: + def __init__(__self__, *, + error_code: pulumi.Input[str], + error_message: pulumi.Input[str]): + """ + :param pulumi.Input[str] error_code: If the CreateBucketMetadataTableConfiguration request succeeds, but S3 Metadata was unable to create the table, this structure contains the error code. The possible error codes and error messages are as follows:
AccessDeniedCreatingResources - You don't have sufficient permissions to create the required resources. Make sure that you have s3tables:CreateNamespace, s3tables:CreateTable, s3tables:GetTable and s3tables:PutTablePolicy permissions, and then try again. To create a new metadata table, you must delete the metadata configuration for this bucket, and then create a new metadata configuration.
AccessDeniedWritingToTable - Unable to write to the metadata table because of missing resource permissions. To fix the resource policy, Amazon S3 needs to create a new metadata table. To create a new metadata table, you must delete the metadata configuration for this bucket, and then create a new metadata configuration.
DestinationTableNotFound - The destination table doesn't exist. To create a new metadata table, you must delete the metadata configuration for this bucket, and then create a new metadata configuration.
ServerInternalError - An internal error has occurred. To create a new metadata table, you must delete the metadata configuration for this bucket, and then create a new metadata configuration.
TableAlreadyExists - The table that you specified already exists in the table bucket's namespace. Specify a different table name. To create a new metadata table, you must delete the metadata configuration for this bucket, and then create a new metadata configuration.
TableBucketNotFound - The table bucket that you specified doesn't exist in this AWS Region and account. Create or choose a different table bucket. To create a new metadata table, you must delete the metadata configuration for this bucket, and then create a new metadata configuration. + :param pulumi.Input[str] error_message: If the CreateBucketMetadataTableConfiguration request succeeds, but S3 Metadata was unable to create the table, this structure contains the error code. The possible error codes and error messages are as follows:
AccessDeniedCreatingResources - You don't have sufficient permissions to create the required resources. Make sure that you have s3tables:CreateNamespace, s3tables:CreateTable, s3tables:GetTable and s3tables:PutTablePolicy permissions, and then try again. To create a new metadata table, you must delete the metadata configuration for this bucket, and then create a new metadata configuration.
AccessDeniedWritingToTable - Unable to write to the metadata table because of missing resource permissions. To fix the resource policy, Amazon S3 needs to create a new metadata table. To create a new metadata table, you must delete the metadata configuration for this bucket, and then create a new metadata configuration.
DestinationTableNotFound - The destination table doesn't exist. To create a new metadata table, you must delete the metadata configuration for this bucket, and then create a new metadata configuration.
ServerInternalError - An internal error has occurred. To create a new metadata table, you must delete the metadata configuration for this bucket, and then create a new metadata configuration.
TableAlreadyExists - The table that you specified already exists in the table bucket's namespace. Specify a different table name. To create a new metadata table, you must delete the metadata configuration for this bucket, and then create a new metadata configuration.
TableBucketNotFound - The table bucket that you specified doesn't exist in this AWS Region and account. Create or choose a different table bucket. To create a new metadata table, you must delete the metadata configuration for this bucket, and then create a new metadata configuration. + """ + pulumi.set(__self__, "error_code", error_code) + pulumi.set(__self__, "error_message", error_message) + + @property + @pulumi.getter(name="errorCode") + def error_code(self) -> pulumi.Input[str]: + """ + If the CreateBucketMetadataTableConfiguration request succeeds, but S3 Metadata was unable to create the table, this structure contains the error code. The possible error codes and error messages are as follows:
AccessDeniedCreatingResources - You don't have sufficient permissions to create the required resources. Make sure that you have s3tables:CreateNamespace, s3tables:CreateTable, s3tables:GetTable and s3tables:PutTablePolicy permissions, and then try again. To create a new metadata table, you must delete the metadata configuration for this bucket, and then create a new metadata configuration.
AccessDeniedWritingToTable - Unable to write to the metadata table because of missing resource permissions. To fix the resource policy, Amazon S3 needs to create a new metadata table. To create a new metadata table, you must delete the metadata configuration for this bucket, and then create a new metadata configuration.
DestinationTableNotFound - The destination table doesn't exist. To create a new metadata table, you must delete the metadata configuration for this bucket, and then create a new metadata configuration.
ServerInternalError - An internal error has occurred. To create a new metadata table, you must delete the metadata configuration for this bucket, and then create a new metadata configuration.
TableAlreadyExists - The table that you specified already exists in the table bucket's namespace. Specify a different table name. To create a new metadata table, you must delete the metadata configuration for this bucket, and then create a new metadata configuration.
TableBucketNotFound - The table bucket that you specified doesn't exist in this AWS Region and account. Create or choose a different table bucket. To create a new metadata table, you must delete the metadata configuration for this bucket, and then create a new metadata configuration. + """ + return pulumi.get(self, "error_code") + + @error_code.setter + def error_code(self, value: pulumi.Input[str]): + pulumi.set(self, "error_code", value) + + @property + @pulumi.getter(name="errorMessage") + def error_message(self) -> pulumi.Input[str]: + """ + If the CreateBucketMetadataTableConfiguration request succeeds, but S3 Metadata was unable to create the table, this structure contains the error code. The possible error codes and error messages are as follows:
AccessDeniedCreatingResources - You don't have sufficient permissions to create the required resources. Make sure that you have s3tables:CreateNamespace, s3tables:CreateTable, s3tables:GetTable and s3tables:PutTablePolicy permissions, and then try again. To create a new metadata table, you must delete the metadata configuration for this bucket, and then create a new metadata configuration.
AccessDeniedWritingToTable - Unable to write to the metadata table because of missing resource permissions. To fix the resource policy, Amazon S3 needs to create a new metadata table. To create a new metadata table, you must delete the metadata configuration for this bucket, and then create a new metadata configuration.
DestinationTableNotFound - The destination table doesn't exist. To create a new metadata table, you must delete the metadata configuration for this bucket, and then create a new metadata configuration.
ServerInternalError - An internal error has occurred. To create a new metadata table, you must delete the metadata configuration for this bucket, and then create a new metadata configuration.
TableAlreadyExists - The table that you specified already exists in the table bucket's namespace. Specify a different table name. To create a new metadata table, you must delete the metadata configuration for this bucket, and then create a new metadata configuration.
TableBucketNotFound - The table bucket that you specified doesn't exist in this AWS Region and account. Create or choose a different table bucket. To create a new metadata table, you must delete the metadata configuration for this bucket, and then create a new metadata configuration. + """ + return pulumi.get(self, "error_message") + + @error_message.setter + def error_message(self, value: pulumi.Input[str]): + pulumi.set(self, "error_message", value) + + if not MYPY: class BucketMetricsConfigurationArgsDict(TypedDict): """ @@ -3832,6 +3952,96 @@ def rules(self, value: pulumi.Input[Sequence[pulumi.Input['BucketFilterRuleArgs' pulumi.set(self, "rules", value) +if not MYPY: + class BucketS3TablesDestinationArgsDict(TypedDict): + table_bucket_arn: pulumi.Input[str] + """ + The Amazon Resource Name (ARN) for the table bucket that's specified as the destination in the metadata table configuration. The destination table bucket must be in the same Region and AWS account as the general purpose bucket. + """ + table_name: pulumi.Input[str] + """ + The name for the metadata table in your metadata table configuration. The specified metadata table name must be unique within the aws_s3_metadata namespace in the destination table bucket. + """ + table_arn: NotRequired[pulumi.Input[str]] + """ + The Amazon Resource Name (ARN) for the metadata table in the metadata table configuration. The specified metadata table name must be unique within the aws_s3_metadata namespace in the destination table bucket. + """ + table_namespace: NotRequired[pulumi.Input[str]] + """ + The table bucket namespace for the metadata table in your metadata table configuration. This value is always aws_s3_metadata. + """ +elif False: + BucketS3TablesDestinationArgsDict: TypeAlias = Mapping[str, Any] + +@pulumi.input_type +class BucketS3TablesDestinationArgs: + def __init__(__self__, *, + table_bucket_arn: pulumi.Input[str], + table_name: pulumi.Input[str], + table_arn: Optional[pulumi.Input[str]] = None, + table_namespace: Optional[pulumi.Input[str]] = None): + """ + :param pulumi.Input[str] table_bucket_arn: The Amazon Resource Name (ARN) for the table bucket that's specified as the destination in the metadata table configuration. The destination table bucket must be in the same Region and AWS account as the general purpose bucket. + :param pulumi.Input[str] table_name: The name for the metadata table in your metadata table configuration. The specified metadata table name must be unique within the aws_s3_metadata namespace in the destination table bucket. + :param pulumi.Input[str] table_arn: The Amazon Resource Name (ARN) for the metadata table in the metadata table configuration. The specified metadata table name must be unique within the aws_s3_metadata namespace in the destination table bucket. + :param pulumi.Input[str] table_namespace: The table bucket namespace for the metadata table in your metadata table configuration. This value is always aws_s3_metadata. + """ + pulumi.set(__self__, "table_bucket_arn", table_bucket_arn) + pulumi.set(__self__, "table_name", table_name) + if table_arn is not None: + pulumi.set(__self__, "table_arn", table_arn) + if table_namespace is not None: + pulumi.set(__self__, "table_namespace", table_namespace) + + @property + @pulumi.getter(name="tableBucketArn") + def table_bucket_arn(self) -> pulumi.Input[str]: + """ + The Amazon Resource Name (ARN) for the table bucket that's specified as the destination in the metadata table configuration. The destination table bucket must be in the same Region and AWS account as the general purpose bucket. + """ + return pulumi.get(self, "table_bucket_arn") + + @table_bucket_arn.setter + def table_bucket_arn(self, value: pulumi.Input[str]): + pulumi.set(self, "table_bucket_arn", value) + + @property + @pulumi.getter(name="tableName") + def table_name(self) -> pulumi.Input[str]: + """ + The name for the metadata table in your metadata table configuration. The specified metadata table name must be unique within the aws_s3_metadata namespace in the destination table bucket. + """ + return pulumi.get(self, "table_name") + + @table_name.setter + def table_name(self, value: pulumi.Input[str]): + pulumi.set(self, "table_name", value) + + @property + @pulumi.getter(name="tableArn") + def table_arn(self) -> Optional[pulumi.Input[str]]: + """ + The Amazon Resource Name (ARN) for the metadata table in the metadata table configuration. The specified metadata table name must be unique within the aws_s3_metadata namespace in the destination table bucket. + """ + return pulumi.get(self, "table_arn") + + @table_arn.setter + def table_arn(self, value: Optional[pulumi.Input[str]]): + pulumi.set(self, "table_arn", value) + + @property + @pulumi.getter(name="tableNamespace") + def table_namespace(self) -> Optional[pulumi.Input[str]]: + """ + The table bucket namespace for the metadata table in your metadata table configuration. This value is always aws_s3_metadata. + """ + return pulumi.get(self, "table_namespace") + + @table_namespace.setter + def table_namespace(self, value: Optional[pulumi.Input[str]]): + pulumi.set(self, "table_namespace", value) + + if not MYPY: class BucketServerSideEncryptionByDefaultArgsDict(TypedDict): """ diff --git a/sdk/python/pulumi_aws_native/s3/bucket.py b/sdk/python/pulumi_aws_native/s3/bucket.py index 9f5336c7ac..b2a0601416 100644 --- a/sdk/python/pulumi_aws_native/s3/bucket.py +++ b/sdk/python/pulumi_aws_native/s3/bucket.py @@ -34,6 +34,7 @@ def __init__(__self__, *, inventory_configurations: Optional[pulumi.Input[Sequence[pulumi.Input['BucketInventoryConfigurationArgs']]]] = None, lifecycle_configuration: Optional[pulumi.Input['BucketLifecycleConfigurationArgs']] = None, logging_configuration: Optional[pulumi.Input['BucketLoggingConfigurationArgs']] = None, + metadata_table_configuration: Optional[pulumi.Input['BucketMetadataTableConfigurationArgs']] = None, metrics_configurations: Optional[pulumi.Input[Sequence[pulumi.Input['BucketMetricsConfigurationArgs']]]] = None, notification_configuration: Optional[pulumi.Input['BucketNotificationConfigurationArgs']] = None, object_lock_configuration: Optional[pulumi.Input['BucketObjectLockConfigurationArgs']] = None, @@ -97,6 +98,8 @@ def __init__(__self__, *, pulumi.set(__self__, "lifecycle_configuration", lifecycle_configuration) if logging_configuration is not None: pulumi.set(__self__, "logging_configuration", logging_configuration) + if metadata_table_configuration is not None: + pulumi.set(__self__, "metadata_table_configuration", metadata_table_configuration) if metrics_configurations is not None: pulumi.set(__self__, "metrics_configurations", metrics_configurations) if notification_configuration is not None: @@ -242,6 +245,15 @@ def logging_configuration(self) -> Optional[pulumi.Input['BucketLoggingConfigura def logging_configuration(self, value: Optional[pulumi.Input['BucketLoggingConfigurationArgs']]): pulumi.set(self, "logging_configuration", value) + @property + @pulumi.getter(name="metadataTableConfiguration") + def metadata_table_configuration(self) -> Optional[pulumi.Input['BucketMetadataTableConfigurationArgs']]: + return pulumi.get(self, "metadata_table_configuration") + + @metadata_table_configuration.setter + def metadata_table_configuration(self, value: Optional[pulumi.Input['BucketMetadataTableConfigurationArgs']]): + pulumi.set(self, "metadata_table_configuration", value) + @property @pulumi.getter(name="metricsConfigurations") def metrics_configurations(self) -> Optional[pulumi.Input[Sequence[pulumi.Input['BucketMetricsConfigurationArgs']]]]: @@ -384,6 +396,7 @@ def __init__(__self__, inventory_configurations: Optional[pulumi.Input[Sequence[pulumi.Input[Union['BucketInventoryConfigurationArgs', 'BucketInventoryConfigurationArgsDict']]]]] = None, lifecycle_configuration: Optional[pulumi.Input[Union['BucketLifecycleConfigurationArgs', 'BucketLifecycleConfigurationArgsDict']]] = None, logging_configuration: Optional[pulumi.Input[Union['BucketLoggingConfigurationArgs', 'BucketLoggingConfigurationArgsDict']]] = None, + metadata_table_configuration: Optional[pulumi.Input[Union['BucketMetadataTableConfigurationArgs', 'BucketMetadataTableConfigurationArgsDict']]] = None, metrics_configurations: Optional[pulumi.Input[Sequence[pulumi.Input[Union['BucketMetricsConfigurationArgs', 'BucketMetricsConfigurationArgsDict']]]]] = None, notification_configuration: Optional[pulumi.Input[Union['BucketNotificationConfigurationArgs', 'BucketNotificationConfigurationArgsDict']]] = None, object_lock_configuration: Optional[pulumi.Input[Union['BucketObjectLockConfigurationArgs', 'BucketObjectLockConfigurationArgsDict']]] = None, @@ -1439,6 +1452,7 @@ def _internal_init(__self__, inventory_configurations: Optional[pulumi.Input[Sequence[pulumi.Input[Union['BucketInventoryConfigurationArgs', 'BucketInventoryConfigurationArgsDict']]]]] = None, lifecycle_configuration: Optional[pulumi.Input[Union['BucketLifecycleConfigurationArgs', 'BucketLifecycleConfigurationArgsDict']]] = None, logging_configuration: Optional[pulumi.Input[Union['BucketLoggingConfigurationArgs', 'BucketLoggingConfigurationArgsDict']]] = None, + metadata_table_configuration: Optional[pulumi.Input[Union['BucketMetadataTableConfigurationArgs', 'BucketMetadataTableConfigurationArgsDict']]] = None, metrics_configurations: Optional[pulumi.Input[Sequence[pulumi.Input[Union['BucketMetricsConfigurationArgs', 'BucketMetricsConfigurationArgsDict']]]]] = None, notification_configuration: Optional[pulumi.Input[Union['BucketNotificationConfigurationArgs', 'BucketNotificationConfigurationArgsDict']]] = None, object_lock_configuration: Optional[pulumi.Input[Union['BucketObjectLockConfigurationArgs', 'BucketObjectLockConfigurationArgsDict']]] = None, @@ -1468,6 +1482,7 @@ def _internal_init(__self__, __props__.__dict__["inventory_configurations"] = inventory_configurations __props__.__dict__["lifecycle_configuration"] = lifecycle_configuration __props__.__dict__["logging_configuration"] = logging_configuration + __props__.__dict__["metadata_table_configuration"] = metadata_table_configuration __props__.__dict__["metrics_configurations"] = metrics_configurations __props__.__dict__["notification_configuration"] = notification_configuration __props__.__dict__["object_lock_configuration"] = object_lock_configuration @@ -1520,6 +1535,7 @@ def get(resource_name: str, __props__.__dict__["inventory_configurations"] = None __props__.__dict__["lifecycle_configuration"] = None __props__.__dict__["logging_configuration"] = None + __props__.__dict__["metadata_table_configuration"] = None __props__.__dict__["metrics_configurations"] = None __props__.__dict__["notification_configuration"] = None __props__.__dict__["object_lock_configuration"] = None @@ -1650,6 +1666,11 @@ def logging_configuration(self) -> pulumi.Output[Optional['outputs.BucketLogging """ return pulumi.get(self, "logging_configuration") + @property + @pulumi.getter(name="metadataTableConfiguration") + def metadata_table_configuration(self) -> pulumi.Output[Optional['outputs.BucketMetadataTableConfiguration']]: + return pulumi.get(self, "metadata_table_configuration") + @property @pulumi.getter(name="metricsConfigurations") def metrics_configurations(self) -> pulumi.Output[Optional[Sequence['outputs.BucketMetricsConfiguration']]]: diff --git a/sdk/python/pulumi_aws_native/s3/get_bucket.py b/sdk/python/pulumi_aws_native/s3/get_bucket.py index 840a0517ad..42b6590b18 100644 --- a/sdk/python/pulumi_aws_native/s3/get_bucket.py +++ b/sdk/python/pulumi_aws_native/s3/get_bucket.py @@ -26,7 +26,7 @@ @pulumi.output_type class GetBucketResult: - def __init__(__self__, accelerate_configuration=None, analytics_configurations=None, arn=None, bucket_encryption=None, cors_configuration=None, domain_name=None, dual_stack_domain_name=None, intelligent_tiering_configurations=None, inventory_configurations=None, lifecycle_configuration=None, logging_configuration=None, metrics_configurations=None, notification_configuration=None, object_lock_configuration=None, object_lock_enabled=None, ownership_controls=None, public_access_block_configuration=None, regional_domain_name=None, replication_configuration=None, tags=None, versioning_configuration=None, website_configuration=None, website_url=None): + def __init__(__self__, accelerate_configuration=None, analytics_configurations=None, arn=None, bucket_encryption=None, cors_configuration=None, domain_name=None, dual_stack_domain_name=None, intelligent_tiering_configurations=None, inventory_configurations=None, lifecycle_configuration=None, logging_configuration=None, metadata_table_configuration=None, metrics_configurations=None, notification_configuration=None, object_lock_configuration=None, object_lock_enabled=None, ownership_controls=None, public_access_block_configuration=None, regional_domain_name=None, replication_configuration=None, tags=None, versioning_configuration=None, website_configuration=None, website_url=None): if accelerate_configuration and not isinstance(accelerate_configuration, dict): raise TypeError("Expected argument 'accelerate_configuration' to be a dict") pulumi.set(__self__, "accelerate_configuration", accelerate_configuration) @@ -60,6 +60,9 @@ def __init__(__self__, accelerate_configuration=None, analytics_configurations=N if logging_configuration and not isinstance(logging_configuration, dict): raise TypeError("Expected argument 'logging_configuration' to be a dict") pulumi.set(__self__, "logging_configuration", logging_configuration) + if metadata_table_configuration and not isinstance(metadata_table_configuration, dict): + raise TypeError("Expected argument 'metadata_table_configuration' to be a dict") + pulumi.set(__self__, "metadata_table_configuration", metadata_table_configuration) if metrics_configurations and not isinstance(metrics_configurations, list): raise TypeError("Expected argument 'metrics_configurations' to be a list") pulumi.set(__self__, "metrics_configurations", metrics_configurations) @@ -193,6 +196,11 @@ def logging_configuration(self) -> Optional['outputs.BucketLoggingConfiguration' """ return pulumi.get(self, "logging_configuration") + @property + @pulumi.getter(name="metadataTableConfiguration") + def metadata_table_configuration(self) -> Optional['outputs.BucketMetadataTableConfiguration']: + return pulumi.get(self, "metadata_table_configuration") + @property @pulumi.getter(name="metricsConfigurations") def metrics_configurations(self) -> Optional[Sequence['outputs.BucketMetricsConfiguration']]: @@ -319,6 +327,7 @@ def __await__(self): inventory_configurations=self.inventory_configurations, lifecycle_configuration=self.lifecycle_configuration, logging_configuration=self.logging_configuration, + metadata_table_configuration=self.metadata_table_configuration, metrics_configurations=self.metrics_configurations, notification_configuration=self.notification_configuration, object_lock_configuration=self.object_lock_configuration, @@ -361,6 +370,7 @@ def get_bucket(bucket_name: Optional[str] = None, inventory_configurations=pulumi.get(__ret__, 'inventory_configurations'), lifecycle_configuration=pulumi.get(__ret__, 'lifecycle_configuration'), logging_configuration=pulumi.get(__ret__, 'logging_configuration'), + metadata_table_configuration=pulumi.get(__ret__, 'metadata_table_configuration'), metrics_configurations=pulumi.get(__ret__, 'metrics_configurations'), notification_configuration=pulumi.get(__ret__, 'notification_configuration'), object_lock_configuration=pulumi.get(__ret__, 'object_lock_configuration'), @@ -400,6 +410,7 @@ def get_bucket_output(bucket_name: Optional[pulumi.Input[str]] = None, inventory_configurations=pulumi.get(__response__, 'inventory_configurations'), lifecycle_configuration=pulumi.get(__response__, 'lifecycle_configuration'), logging_configuration=pulumi.get(__response__, 'logging_configuration'), + metadata_table_configuration=pulumi.get(__response__, 'metadata_table_configuration'), metrics_configurations=pulumi.get(__response__, 'metrics_configurations'), notification_configuration=pulumi.get(__response__, 'notification_configuration'), object_lock_configuration=pulumi.get(__response__, 'object_lock_configuration'), diff --git a/sdk/python/pulumi_aws_native/s3/outputs.py b/sdk/python/pulumi_aws_native/s3/outputs.py index 9e38275ede..b480fb06b4 100644 --- a/sdk/python/pulumi_aws_native/s3/outputs.py +++ b/sdk/python/pulumi_aws_native/s3/outputs.py @@ -40,6 +40,8 @@ 'BucketLambdaConfiguration', 'BucketLifecycleConfiguration', 'BucketLoggingConfiguration', + 'BucketMetadataTableConfiguration', + 'BucketMetadataTableError', 'BucketMetrics', 'BucketMetricsConfiguration', 'BucketNoncurrentVersionExpiration', @@ -66,6 +68,7 @@ 'BucketRoutingRuleCondition', 'BucketRule', 'BucketS3KeyFilter', + 'BucketS3TablesDestination', 'BucketServerSideEncryptionByDefault', 'BucketServerSideEncryptionRule', 'BucketSourceSelectionCriteria', @@ -1367,6 +1370,109 @@ def target_object_key_format(self) -> Optional['outputs.BucketTargetObjectKeyFor return pulumi.get(self, "target_object_key_format") +@pulumi.output_type +class BucketMetadataTableConfiguration(dict): + @staticmethod + def __key_warning(key: str): + suggest = None + if key == "s3TablesDestination": + suggest = "s3_tables_destination" + + if suggest: + pulumi.log.warn(f"Key '{key}' not found in BucketMetadataTableConfiguration. Access the value via the '{suggest}' property getter instead.") + + def __getitem__(self, key: str) -> Any: + BucketMetadataTableConfiguration.__key_warning(key) + return super().__getitem__(key) + + def get(self, key: str, default = None) -> Any: + BucketMetadataTableConfiguration.__key_warning(key) + return super().get(key, default) + + def __init__(__self__, *, + s3_tables_destination: 'outputs.BucketS3TablesDestination', + error: Optional['outputs.BucketMetadataTableError'] = None, + status: Optional[str] = None): + """ + :param 'BucketMetadataTableError' error: Returns the Error value of the GetBucketMetadataTableConfiguration response. + :param str status: Returns the Status value of the GetBucketMetadataTableConfigurationResult response. This value indicates the status of the metadata table. The status values are:
CREATING - The metadata table is in the process of being created in the specified table bucket.
ACTIVE - The metadata table has been created successfully and records are being delivered to the table.
FAILED - Amazon S3 is unable to create the metadata table, or Amazon S3 is unable to deliver records. + """ + pulumi.set(__self__, "s3_tables_destination", s3_tables_destination) + if error is not None: + pulumi.set(__self__, "error", error) + if status is not None: + pulumi.set(__self__, "status", status) + + @property + @pulumi.getter(name="s3TablesDestination") + def s3_tables_destination(self) -> 'outputs.BucketS3TablesDestination': + return pulumi.get(self, "s3_tables_destination") + + @property + @pulumi.getter + def error(self) -> Optional['outputs.BucketMetadataTableError']: + """ + Returns the Error value of the GetBucketMetadataTableConfiguration response. + """ + return pulumi.get(self, "error") + + @property + @pulumi.getter + def status(self) -> Optional[str]: + """ + Returns the Status value of the GetBucketMetadataTableConfigurationResult response. This value indicates the status of the metadata table. The status values are:
CREATING - The metadata table is in the process of being created in the specified table bucket.
ACTIVE - The metadata table has been created successfully and records are being delivered to the table.
FAILED - Amazon S3 is unable to create the metadata table, or Amazon S3 is unable to deliver records. + """ + return pulumi.get(self, "status") + + +@pulumi.output_type +class BucketMetadataTableError(dict): + @staticmethod + def __key_warning(key: str): + suggest = None + if key == "errorCode": + suggest = "error_code" + elif key == "errorMessage": + suggest = "error_message" + + if suggest: + pulumi.log.warn(f"Key '{key}' not found in BucketMetadataTableError. Access the value via the '{suggest}' property getter instead.") + + def __getitem__(self, key: str) -> Any: + BucketMetadataTableError.__key_warning(key) + return super().__getitem__(key) + + def get(self, key: str, default = None) -> Any: + BucketMetadataTableError.__key_warning(key) + return super().get(key, default) + + def __init__(__self__, *, + error_code: str, + error_message: str): + """ + :param str error_code: If the CreateBucketMetadataTableConfiguration request succeeds, but S3 Metadata was unable to create the table, this structure contains the error code. The possible error codes and error messages are as follows:
AccessDeniedCreatingResources - You don't have sufficient permissions to create the required resources. Make sure that you have s3tables:CreateNamespace, s3tables:CreateTable, s3tables:GetTable and s3tables:PutTablePolicy permissions, and then try again. To create a new metadata table, you must delete the metadata configuration for this bucket, and then create a new metadata configuration.
AccessDeniedWritingToTable - Unable to write to the metadata table because of missing resource permissions. To fix the resource policy, Amazon S3 needs to create a new metadata table. To create a new metadata table, you must delete the metadata configuration for this bucket, and then create a new metadata configuration.
DestinationTableNotFound - The destination table doesn't exist. To create a new metadata table, you must delete the metadata configuration for this bucket, and then create a new metadata configuration.
ServerInternalError - An internal error has occurred. To create a new metadata table, you must delete the metadata configuration for this bucket, and then create a new metadata configuration.
TableAlreadyExists - The table that you specified already exists in the table bucket's namespace. Specify a different table name. To create a new metadata table, you must delete the metadata configuration for this bucket, and then create a new metadata configuration.
TableBucketNotFound - The table bucket that you specified doesn't exist in this AWS Region and account. Create or choose a different table bucket. To create a new metadata table, you must delete the metadata configuration for this bucket, and then create a new metadata configuration. + :param str error_message: If the CreateBucketMetadataTableConfiguration request succeeds, but S3 Metadata was unable to create the table, this structure contains the error code. The possible error codes and error messages are as follows:
AccessDeniedCreatingResources - You don't have sufficient permissions to create the required resources. Make sure that you have s3tables:CreateNamespace, s3tables:CreateTable, s3tables:GetTable and s3tables:PutTablePolicy permissions, and then try again. To create a new metadata table, you must delete the metadata configuration for this bucket, and then create a new metadata configuration.
AccessDeniedWritingToTable - Unable to write to the metadata table because of missing resource permissions. To fix the resource policy, Amazon S3 needs to create a new metadata table. To create a new metadata table, you must delete the metadata configuration for this bucket, and then create a new metadata configuration.
DestinationTableNotFound - The destination table doesn't exist. To create a new metadata table, you must delete the metadata configuration for this bucket, and then create a new metadata configuration.
ServerInternalError - An internal error has occurred. To create a new metadata table, you must delete the metadata configuration for this bucket, and then create a new metadata configuration.
TableAlreadyExists - The table that you specified already exists in the table bucket's namespace. Specify a different table name. To create a new metadata table, you must delete the metadata configuration for this bucket, and then create a new metadata configuration.
TableBucketNotFound - The table bucket that you specified doesn't exist in this AWS Region and account. Create or choose a different table bucket. To create a new metadata table, you must delete the metadata configuration for this bucket, and then create a new metadata configuration. + """ + pulumi.set(__self__, "error_code", error_code) + pulumi.set(__self__, "error_message", error_message) + + @property + @pulumi.getter(name="errorCode") + def error_code(self) -> str: + """ + If the CreateBucketMetadataTableConfiguration request succeeds, but S3 Metadata was unable to create the table, this structure contains the error code. The possible error codes and error messages are as follows:
AccessDeniedCreatingResources - You don't have sufficient permissions to create the required resources. Make sure that you have s3tables:CreateNamespace, s3tables:CreateTable, s3tables:GetTable and s3tables:PutTablePolicy permissions, and then try again. To create a new metadata table, you must delete the metadata configuration for this bucket, and then create a new metadata configuration.
AccessDeniedWritingToTable - Unable to write to the metadata table because of missing resource permissions. To fix the resource policy, Amazon S3 needs to create a new metadata table. To create a new metadata table, you must delete the metadata configuration for this bucket, and then create a new metadata configuration.
DestinationTableNotFound - The destination table doesn't exist. To create a new metadata table, you must delete the metadata configuration for this bucket, and then create a new metadata configuration.
ServerInternalError - An internal error has occurred. To create a new metadata table, you must delete the metadata configuration for this bucket, and then create a new metadata configuration.
TableAlreadyExists - The table that you specified already exists in the table bucket's namespace. Specify a different table name. To create a new metadata table, you must delete the metadata configuration for this bucket, and then create a new metadata configuration.
TableBucketNotFound - The table bucket that you specified doesn't exist in this AWS Region and account. Create or choose a different table bucket. To create a new metadata table, you must delete the metadata configuration for this bucket, and then create a new metadata configuration. + """ + return pulumi.get(self, "error_code") + + @property + @pulumi.getter(name="errorMessage") + def error_message(self) -> str: + """ + If the CreateBucketMetadataTableConfiguration request succeeds, but S3 Metadata was unable to create the table, this structure contains the error code. The possible error codes and error messages are as follows:
AccessDeniedCreatingResources - You don't have sufficient permissions to create the required resources. Make sure that you have s3tables:CreateNamespace, s3tables:CreateTable, s3tables:GetTable and s3tables:PutTablePolicy permissions, and then try again. To create a new metadata table, you must delete the metadata configuration for this bucket, and then create a new metadata configuration.
AccessDeniedWritingToTable - Unable to write to the metadata table because of missing resource permissions. To fix the resource policy, Amazon S3 needs to create a new metadata table. To create a new metadata table, you must delete the metadata configuration for this bucket, and then create a new metadata configuration.
DestinationTableNotFound - The destination table doesn't exist. To create a new metadata table, you must delete the metadata configuration for this bucket, and then create a new metadata configuration.
ServerInternalError - An internal error has occurred. To create a new metadata table, you must delete the metadata configuration for this bucket, and then create a new metadata configuration.
TableAlreadyExists - The table that you specified already exists in the table bucket's namespace. Specify a different table name. To create a new metadata table, you must delete the metadata configuration for this bucket, and then create a new metadata configuration.
TableBucketNotFound - The table bucket that you specified doesn't exist in this AWS Region and account. Create or choose a different table bucket. To create a new metadata table, you must delete the metadata configuration for this bucket, and then create a new metadata configuration. + """ + return pulumi.get(self, "error_message") + + @pulumi.output_type class BucketMetrics(dict): """ @@ -3072,6 +3178,82 @@ def rules(self) -> Sequence['outputs.BucketFilterRule']: return pulumi.get(self, "rules") +@pulumi.output_type +class BucketS3TablesDestination(dict): + @staticmethod + def __key_warning(key: str): + suggest = None + if key == "tableBucketArn": + suggest = "table_bucket_arn" + elif key == "tableName": + suggest = "table_name" + elif key == "tableArn": + suggest = "table_arn" + elif key == "tableNamespace": + suggest = "table_namespace" + + if suggest: + pulumi.log.warn(f"Key '{key}' not found in BucketS3TablesDestination. Access the value via the '{suggest}' property getter instead.") + + def __getitem__(self, key: str) -> Any: + BucketS3TablesDestination.__key_warning(key) + return super().__getitem__(key) + + def get(self, key: str, default = None) -> Any: + BucketS3TablesDestination.__key_warning(key) + return super().get(key, default) + + def __init__(__self__, *, + table_bucket_arn: str, + table_name: str, + table_arn: Optional[str] = None, + table_namespace: Optional[str] = None): + """ + :param str table_bucket_arn: The Amazon Resource Name (ARN) for the table bucket that's specified as the destination in the metadata table configuration. The destination table bucket must be in the same Region and AWS account as the general purpose bucket. + :param str table_name: The name for the metadata table in your metadata table configuration. The specified metadata table name must be unique within the aws_s3_metadata namespace in the destination table bucket. + :param str table_arn: The Amazon Resource Name (ARN) for the metadata table in the metadata table configuration. The specified metadata table name must be unique within the aws_s3_metadata namespace in the destination table bucket. + :param str table_namespace: The table bucket namespace for the metadata table in your metadata table configuration. This value is always aws_s3_metadata. + """ + pulumi.set(__self__, "table_bucket_arn", table_bucket_arn) + pulumi.set(__self__, "table_name", table_name) + if table_arn is not None: + pulumi.set(__self__, "table_arn", table_arn) + if table_namespace is not None: + pulumi.set(__self__, "table_namespace", table_namespace) + + @property + @pulumi.getter(name="tableBucketArn") + def table_bucket_arn(self) -> str: + """ + The Amazon Resource Name (ARN) for the table bucket that's specified as the destination in the metadata table configuration. The destination table bucket must be in the same Region and AWS account as the general purpose bucket. + """ + return pulumi.get(self, "table_bucket_arn") + + @property + @pulumi.getter(name="tableName") + def table_name(self) -> str: + """ + The name for the metadata table in your metadata table configuration. The specified metadata table name must be unique within the aws_s3_metadata namespace in the destination table bucket. + """ + return pulumi.get(self, "table_name") + + @property + @pulumi.getter(name="tableArn") + def table_arn(self) -> Optional[str]: + """ + The Amazon Resource Name (ARN) for the metadata table in the metadata table configuration. The specified metadata table name must be unique within the aws_s3_metadata namespace in the destination table bucket. + """ + return pulumi.get(self, "table_arn") + + @property + @pulumi.getter(name="tableNamespace") + def table_namespace(self) -> Optional[str]: + """ + The table bucket namespace for the metadata table in your metadata table configuration. This value is always aws_s3_metadata. + """ + return pulumi.get(self, "table_namespace") + + @pulumi.output_type class BucketServerSideEncryptionByDefault(dict): """ diff --git a/sdk/python/pulumi_aws_native/s3express/_enums.py b/sdk/python/pulumi_aws_native/s3express/_enums.py index d3eaf62a03..8a3056ed5f 100644 --- a/sdk/python/pulumi_aws_native/s3express/_enums.py +++ b/sdk/python/pulumi_aws_native/s3express/_enums.py @@ -13,9 +13,10 @@ class DirectoryBucketDataRedundancy(str, Enum): """ - Specifies the number of Availability Zone that's used for redundancy for the bucket. + Specifies the number of Availability Zone or Local Zone that's used for redundancy for the bucket. """ SINGLE_AVAILABILITY_ZONE = "SingleAvailabilityZone" + SINGLE_LOCAL_ZONE = "SingleLocalZone" class DirectoryBucketRuleStatus(str, Enum): diff --git a/sdk/python/pulumi_aws_native/s3express/directory_bucket.py b/sdk/python/pulumi_aws_native/s3express/directory_bucket.py index 258723f07e..c64a85f4ad 100644 --- a/sdk/python/pulumi_aws_native/s3express/directory_bucket.py +++ b/sdk/python/pulumi_aws_native/s3express/directory_bucket.py @@ -29,10 +29,10 @@ def __init__(__self__, *, lifecycle_configuration: Optional[pulumi.Input['DirectoryBucketLifecycleConfigurationArgs']] = None): """ The set of arguments for constructing a DirectoryBucket resource. - :param pulumi.Input['DirectoryBucketDataRedundancy'] data_redundancy: Specifies the number of Availability Zone that's used for redundancy for the bucket. - :param pulumi.Input[str] location_name: Specifies the AZ ID of the Availability Zone where the directory bucket will be created. An example AZ ID value is 'use1-az5'. + :param pulumi.Input['DirectoryBucketDataRedundancy'] data_redundancy: Specifies the number of Availability Zone or Local Zone that's used for redundancy for the bucket. + :param pulumi.Input[str] location_name: Specifies the Zone ID of the Availability Zone or Local Zone where the directory bucket will be created. An example Availability Zone ID value is 'use1-az5'. :param pulumi.Input['DirectoryBucketBucketEncryptionArgs'] bucket_encryption: Specifies default encryption for a bucket using server-side encryption with Amazon S3 managed keys (SSE-S3) or AWS KMS keys (SSE-KMS). For information about default encryption for directory buckets, see [Setting and monitoring default encryption for directory buckets](https://docs.aws.amazon.com/AmazonS3/latest/userguide/s3-express-bucket-encryption.html) in the *Amazon S3 User Guide* . - :param pulumi.Input[str] bucket_name: Specifies a name for the bucket. The bucket name must contain only lowercase letters, numbers, and hyphens (-). A directory bucket name must be unique in the chosen Availability Zone. The bucket name must also follow the format 'bucket_base_name--az_id--x-s3' (for example, 'DOC-EXAMPLE-BUCKET--usw2-az1--x-s3'). If you don't specify a name, AWS CloudFormation generates a unique physical ID and uses that ID for the bucket name. + :param pulumi.Input[str] bucket_name: Specifies a name for the bucket. The bucket name must contain only lowercase letters, numbers, and hyphens (-). A directory bucket name must be unique in the chosen Availability Zone or Local Zone. The bucket name must also follow the format 'bucket_base_name--zone_id--x-s3'. The zone_id can be the ID of an Availability Zone or a Local Zone. If you don't specify a name, AWS CloudFormation generates a unique physical ID and uses that ID for the bucket name. :param pulumi.Input['DirectoryBucketLifecycleConfigurationArgs'] lifecycle_configuration: Lifecycle rules that define how Amazon S3 Express manages objects during their lifetime. """ pulumi.set(__self__, "data_redundancy", data_redundancy) @@ -48,7 +48,7 @@ def __init__(__self__, *, @pulumi.getter(name="dataRedundancy") def data_redundancy(self) -> pulumi.Input['DirectoryBucketDataRedundancy']: """ - Specifies the number of Availability Zone that's used for redundancy for the bucket. + Specifies the number of Availability Zone or Local Zone that's used for redundancy for the bucket. """ return pulumi.get(self, "data_redundancy") @@ -60,7 +60,7 @@ def data_redundancy(self, value: pulumi.Input['DirectoryBucketDataRedundancy']): @pulumi.getter(name="locationName") def location_name(self) -> pulumi.Input[str]: """ - Specifies the AZ ID of the Availability Zone where the directory bucket will be created. An example AZ ID value is 'use1-az5'. + Specifies the Zone ID of the Availability Zone or Local Zone where the directory bucket will be created. An example Availability Zone ID value is 'use1-az5'. """ return pulumi.get(self, "location_name") @@ -84,7 +84,7 @@ def bucket_encryption(self, value: Optional[pulumi.Input['DirectoryBucketBucketE @pulumi.getter(name="bucketName") def bucket_name(self) -> Optional[pulumi.Input[str]]: """ - Specifies a name for the bucket. The bucket name must contain only lowercase letters, numbers, and hyphens (-). A directory bucket name must be unique in the chosen Availability Zone. The bucket name must also follow the format 'bucket_base_name--az_id--x-s3' (for example, 'DOC-EXAMPLE-BUCKET--usw2-az1--x-s3'). If you don't specify a name, AWS CloudFormation generates a unique physical ID and uses that ID for the bucket name. + Specifies a name for the bucket. The bucket name must contain only lowercase letters, numbers, and hyphens (-). A directory bucket name must be unique in the chosen Availability Zone or Local Zone. The bucket name must also follow the format 'bucket_base_name--zone_id--x-s3'. The zone_id can be the ID of an Availability Zone or a Local Zone. If you don't specify a name, AWS CloudFormation generates a unique physical ID and uses that ID for the bucket name. """ return pulumi.get(self, "bucket_name") @@ -122,10 +122,10 @@ def __init__(__self__, :param str resource_name: The name of the resource. :param pulumi.ResourceOptions opts: Options for the resource. :param pulumi.Input[Union['DirectoryBucketBucketEncryptionArgs', 'DirectoryBucketBucketEncryptionArgsDict']] bucket_encryption: Specifies default encryption for a bucket using server-side encryption with Amazon S3 managed keys (SSE-S3) or AWS KMS keys (SSE-KMS). For information about default encryption for directory buckets, see [Setting and monitoring default encryption for directory buckets](https://docs.aws.amazon.com/AmazonS3/latest/userguide/s3-express-bucket-encryption.html) in the *Amazon S3 User Guide* . - :param pulumi.Input[str] bucket_name: Specifies a name for the bucket. The bucket name must contain only lowercase letters, numbers, and hyphens (-). A directory bucket name must be unique in the chosen Availability Zone. The bucket name must also follow the format 'bucket_base_name--az_id--x-s3' (for example, 'DOC-EXAMPLE-BUCKET--usw2-az1--x-s3'). If you don't specify a name, AWS CloudFormation generates a unique physical ID and uses that ID for the bucket name. - :param pulumi.Input['DirectoryBucketDataRedundancy'] data_redundancy: Specifies the number of Availability Zone that's used for redundancy for the bucket. + :param pulumi.Input[str] bucket_name: Specifies a name for the bucket. The bucket name must contain only lowercase letters, numbers, and hyphens (-). A directory bucket name must be unique in the chosen Availability Zone or Local Zone. The bucket name must also follow the format 'bucket_base_name--zone_id--x-s3'. The zone_id can be the ID of an Availability Zone or a Local Zone. If you don't specify a name, AWS CloudFormation generates a unique physical ID and uses that ID for the bucket name. + :param pulumi.Input['DirectoryBucketDataRedundancy'] data_redundancy: Specifies the number of Availability Zone or Local Zone that's used for redundancy for the bucket. :param pulumi.Input[Union['DirectoryBucketLifecycleConfigurationArgs', 'DirectoryBucketLifecycleConfigurationArgsDict']] lifecycle_configuration: Lifecycle rules that define how Amazon S3 Express manages objects during their lifetime. - :param pulumi.Input[str] location_name: Specifies the AZ ID of the Availability Zone where the directory bucket will be created. An example AZ ID value is 'use1-az5'. + :param pulumi.Input[str] location_name: Specifies the Zone ID of the Availability Zone or Local Zone where the directory bucket will be created. An example Availability Zone ID value is 'use1-az5'. """ ... @overload @@ -221,7 +221,7 @@ def arn(self) -> pulumi.Output[str]: @pulumi.getter(name="availabilityZoneName") def availability_zone_name(self) -> pulumi.Output[str]: """ - Returns the code for the Availability Zone where the directory bucket was created. + Returns the code for the Availability Zone or Local Zone where the directory bucket was created. An example for the code of an Availability Zone is 'us-east-1f'. """ return pulumi.get(self, "availability_zone_name") @@ -237,7 +237,7 @@ def bucket_encryption(self) -> pulumi.Output[Optional['outputs.DirectoryBucketBu @pulumi.getter(name="bucketName") def bucket_name(self) -> pulumi.Output[Optional[str]]: """ - Specifies a name for the bucket. The bucket name must contain only lowercase letters, numbers, and hyphens (-). A directory bucket name must be unique in the chosen Availability Zone. The bucket name must also follow the format 'bucket_base_name--az_id--x-s3' (for example, 'DOC-EXAMPLE-BUCKET--usw2-az1--x-s3'). If you don't specify a name, AWS CloudFormation generates a unique physical ID and uses that ID for the bucket name. + Specifies a name for the bucket. The bucket name must contain only lowercase letters, numbers, and hyphens (-). A directory bucket name must be unique in the chosen Availability Zone or Local Zone. The bucket name must also follow the format 'bucket_base_name--zone_id--x-s3'. The zone_id can be the ID of an Availability Zone or a Local Zone. If you don't specify a name, AWS CloudFormation generates a unique physical ID and uses that ID for the bucket name. """ return pulumi.get(self, "bucket_name") @@ -245,7 +245,7 @@ def bucket_name(self) -> pulumi.Output[Optional[str]]: @pulumi.getter(name="dataRedundancy") def data_redundancy(self) -> pulumi.Output['DirectoryBucketDataRedundancy']: """ - Specifies the number of Availability Zone that's used for redundancy for the bucket. + Specifies the number of Availability Zone or Local Zone that's used for redundancy for the bucket. """ return pulumi.get(self, "data_redundancy") @@ -261,7 +261,7 @@ def lifecycle_configuration(self) -> pulumi.Output[Optional['outputs.DirectoryBu @pulumi.getter(name="locationName") def location_name(self) -> pulumi.Output[str]: """ - Specifies the AZ ID of the Availability Zone where the directory bucket will be created. An example AZ ID value is 'use1-az5'. + Specifies the Zone ID of the Availability Zone or Local Zone where the directory bucket will be created. An example Availability Zone ID value is 'use1-az5'. """ return pulumi.get(self, "location_name") diff --git a/sdk/python/pulumi_aws_native/s3express/get_directory_bucket.py b/sdk/python/pulumi_aws_native/s3express/get_directory_bucket.py index f6550d61a0..34a0ce9ba0 100644 --- a/sdk/python/pulumi_aws_native/s3express/get_directory_bucket.py +++ b/sdk/python/pulumi_aws_native/s3express/get_directory_bucket.py @@ -51,7 +51,7 @@ def arn(self) -> Optional[str]: @pulumi.getter(name="availabilityZoneName") def availability_zone_name(self) -> Optional[str]: """ - Returns the code for the Availability Zone where the directory bucket was created. + Returns the code for the Availability Zone or Local Zone where the directory bucket was created. An example for the code of an Availability Zone is 'us-east-1f'. """ return pulumi.get(self, "availability_zone_name") @@ -90,7 +90,7 @@ def get_directory_bucket(bucket_name: Optional[str] = None, Resource Type definition for AWS::S3Express::DirectoryBucket. - :param str bucket_name: Specifies a name for the bucket. The bucket name must contain only lowercase letters, numbers, and hyphens (-). A directory bucket name must be unique in the chosen Availability Zone. The bucket name must also follow the format 'bucket_base_name--az_id--x-s3' (for example, 'DOC-EXAMPLE-BUCKET--usw2-az1--x-s3'). If you don't specify a name, AWS CloudFormation generates a unique physical ID and uses that ID for the bucket name. + :param str bucket_name: Specifies a name for the bucket. The bucket name must contain only lowercase letters, numbers, and hyphens (-). A directory bucket name must be unique in the chosen Availability Zone or Local Zone. The bucket name must also follow the format 'bucket_base_name--zone_id--x-s3'. The zone_id can be the ID of an Availability Zone or a Local Zone. If you don't specify a name, AWS CloudFormation generates a unique physical ID and uses that ID for the bucket name. """ __args__ = dict() __args__['bucketName'] = bucket_name @@ -108,7 +108,7 @@ def get_directory_bucket_output(bucket_name: Optional[pulumi.Input[str]] = None, Resource Type definition for AWS::S3Express::DirectoryBucket. - :param str bucket_name: Specifies a name for the bucket. The bucket name must contain only lowercase letters, numbers, and hyphens (-). A directory bucket name must be unique in the chosen Availability Zone. The bucket name must also follow the format 'bucket_base_name--az_id--x-s3' (for example, 'DOC-EXAMPLE-BUCKET--usw2-az1--x-s3'). If you don't specify a name, AWS CloudFormation generates a unique physical ID and uses that ID for the bucket name. + :param str bucket_name: Specifies a name for the bucket. The bucket name must contain only lowercase letters, numbers, and hyphens (-). A directory bucket name must be unique in the chosen Availability Zone or Local Zone. The bucket name must also follow the format 'bucket_base_name--zone_id--x-s3'. The zone_id can be the ID of an Availability Zone or a Local Zone. If you don't specify a name, AWS CloudFormation generates a unique physical ID and uses that ID for the bucket name. """ __args__ = dict() __args__['bucketName'] = bucket_name diff --git a/sdk/python/pulumi_aws_native/s3tables/__init__.py b/sdk/python/pulumi_aws_native/s3tables/__init__.py new file mode 100644 index 0000000000..55704b84ff --- /dev/null +++ b/sdk/python/pulumi_aws_native/s3tables/__init__.py @@ -0,0 +1,14 @@ +# coding=utf-8 +# *** WARNING: this file was generated by pulumi-language-python. *** +# *** Do not edit by hand unless you're certain you know what you are doing! *** + +from .. import _utilities +import typing +# Export this package's modules as members: +from ._enums import * +from .get_table_bucket import * +from .get_table_bucket_policy import * +from .table_bucket import * +from .table_bucket_policy import * +from ._inputs import * +from . import outputs diff --git a/sdk/python/pulumi_aws_native/s3tables/_enums.py b/sdk/python/pulumi_aws_native/s3tables/_enums.py new file mode 100644 index 0000000000..bc5898aeb9 --- /dev/null +++ b/sdk/python/pulumi_aws_native/s3tables/_enums.py @@ -0,0 +1,17 @@ +# coding=utf-8 +# *** WARNING: this file was generated by pulumi-language-python. *** +# *** Do not edit by hand unless you're certain you know what you are doing! *** + +from enum import Enum + +__all__ = [ + 'TableBucketUnreferencedFileRemovalStatus', +] + + +class TableBucketUnreferencedFileRemovalStatus(str, Enum): + """ + Indicates whether the Unreferenced File Removal maintenance action is enabled. + """ + ENABLED = "Enabled" + DISABLED = "Disabled" diff --git a/sdk/python/pulumi_aws_native/s3tables/_inputs.py b/sdk/python/pulumi_aws_native/s3tables/_inputs.py new file mode 100644 index 0000000000..2f558f7ada --- /dev/null +++ b/sdk/python/pulumi_aws_native/s3tables/_inputs.py @@ -0,0 +1,120 @@ +# coding=utf-8 +# *** WARNING: this file was generated by pulumi-language-python. *** +# *** Do not edit by hand unless you're certain you know what you are doing! *** + +import copy +import warnings +import sys +import pulumi +import pulumi.runtime +from typing import Any, Mapping, Optional, Sequence, Union, overload +if sys.version_info >= (3, 11): + from typing import NotRequired, TypedDict, TypeAlias +else: + from typing_extensions import NotRequired, TypedDict, TypeAlias +from .. import _utilities +from ._enums import * + +__all__ = [ + 'TableBucketPolicyResourcePolicyArgs', + 'TableBucketPolicyResourcePolicyArgsDict', + 'TableBucketUnreferencedFileRemovalArgs', + 'TableBucketUnreferencedFileRemovalArgsDict', +] + +MYPY = False + +if not MYPY: + class TableBucketPolicyResourcePolicyArgsDict(TypedDict): + """ + A policy document containing permissions to add to the specified table bucket. In IAM, you must provide policy documents in JSON format. However, in CloudFormation you can provide the policy in JSON or YAML format because CloudFormation converts YAML to JSON before submitting it to IAM. + """ + pass +elif False: + TableBucketPolicyResourcePolicyArgsDict: TypeAlias = Mapping[str, Any] + +@pulumi.input_type +class TableBucketPolicyResourcePolicyArgs: + def __init__(__self__): + """ + A policy document containing permissions to add to the specified table bucket. In IAM, you must provide policy documents in JSON format. However, in CloudFormation you can provide the policy in JSON or YAML format because CloudFormation converts YAML to JSON before submitting it to IAM. + """ + pass + + +if not MYPY: + class TableBucketUnreferencedFileRemovalArgsDict(TypedDict): + """ + Settings governing the Unreferenced File Removal maintenance action. Unreferenced file removal identifies and deletes all objects that are not referenced by any table snapshots. + """ + noncurrent_days: NotRequired[pulumi.Input[int]] + """ + S3 permanently deletes noncurrent objects after the number of days specified by the NoncurrentDays property. + """ + status: NotRequired[pulumi.Input['TableBucketUnreferencedFileRemovalStatus']] + """ + Indicates whether the Unreferenced File Removal maintenance action is enabled. + """ + unreferenced_days: NotRequired[pulumi.Input[int]] + """ + For any object not referenced by your table and older than the UnreferencedDays property, S3 creates a delete marker and marks the object version as noncurrent. + """ +elif False: + TableBucketUnreferencedFileRemovalArgsDict: TypeAlias = Mapping[str, Any] + +@pulumi.input_type +class TableBucketUnreferencedFileRemovalArgs: + def __init__(__self__, *, + noncurrent_days: Optional[pulumi.Input[int]] = None, + status: Optional[pulumi.Input['TableBucketUnreferencedFileRemovalStatus']] = None, + unreferenced_days: Optional[pulumi.Input[int]] = None): + """ + Settings governing the Unreferenced File Removal maintenance action. Unreferenced file removal identifies and deletes all objects that are not referenced by any table snapshots. + :param pulumi.Input[int] noncurrent_days: S3 permanently deletes noncurrent objects after the number of days specified by the NoncurrentDays property. + :param pulumi.Input['TableBucketUnreferencedFileRemovalStatus'] status: Indicates whether the Unreferenced File Removal maintenance action is enabled. + :param pulumi.Input[int] unreferenced_days: For any object not referenced by your table and older than the UnreferencedDays property, S3 creates a delete marker and marks the object version as noncurrent. + """ + if noncurrent_days is not None: + pulumi.set(__self__, "noncurrent_days", noncurrent_days) + if status is not None: + pulumi.set(__self__, "status", status) + if unreferenced_days is not None: + pulumi.set(__self__, "unreferenced_days", unreferenced_days) + + @property + @pulumi.getter(name="noncurrentDays") + def noncurrent_days(self) -> Optional[pulumi.Input[int]]: + """ + S3 permanently deletes noncurrent objects after the number of days specified by the NoncurrentDays property. + """ + return pulumi.get(self, "noncurrent_days") + + @noncurrent_days.setter + def noncurrent_days(self, value: Optional[pulumi.Input[int]]): + pulumi.set(self, "noncurrent_days", value) + + @property + @pulumi.getter + def status(self) -> Optional[pulumi.Input['TableBucketUnreferencedFileRemovalStatus']]: + """ + Indicates whether the Unreferenced File Removal maintenance action is enabled. + """ + return pulumi.get(self, "status") + + @status.setter + def status(self, value: Optional[pulumi.Input['TableBucketUnreferencedFileRemovalStatus']]): + pulumi.set(self, "status", value) + + @property + @pulumi.getter(name="unreferencedDays") + def unreferenced_days(self) -> Optional[pulumi.Input[int]]: + """ + For any object not referenced by your table and older than the UnreferencedDays property, S3 creates a delete marker and marks the object version as noncurrent. + """ + return pulumi.get(self, "unreferenced_days") + + @unreferenced_days.setter + def unreferenced_days(self, value: Optional[pulumi.Input[int]]): + pulumi.set(self, "unreferenced_days", value) + + diff --git a/sdk/python/pulumi_aws_native/s3tables/get_table_bucket.py b/sdk/python/pulumi_aws_native/s3tables/get_table_bucket.py new file mode 100644 index 0000000000..a8209d8bb0 --- /dev/null +++ b/sdk/python/pulumi_aws_native/s3tables/get_table_bucket.py @@ -0,0 +1,81 @@ +# coding=utf-8 +# *** WARNING: this file was generated by pulumi-language-python. *** +# *** Do not edit by hand unless you're certain you know what you are doing! *** + +import copy +import warnings +import sys +import pulumi +import pulumi.runtime +from typing import Any, Mapping, Optional, Sequence, Union, overload +if sys.version_info >= (3, 11): + from typing import NotRequired, TypedDict, TypeAlias +else: + from typing_extensions import NotRequired, TypedDict, TypeAlias +from .. import _utilities +from . import outputs +from ._enums import * + +__all__ = [ + 'GetTableBucketResult', + 'AwaitableGetTableBucketResult', + 'get_table_bucket', + 'get_table_bucket_output', +] + +@pulumi.output_type +class GetTableBucketResult: + def __init__(__self__, table_bucket_arn=None, unreferenced_file_removal=None): + if table_bucket_arn and not isinstance(table_bucket_arn, str): + raise TypeError("Expected argument 'table_bucket_arn' to be a str") + pulumi.set(__self__, "table_bucket_arn", table_bucket_arn) + if unreferenced_file_removal and not isinstance(unreferenced_file_removal, dict): + raise TypeError("Expected argument 'unreferenced_file_removal' to be a dict") + pulumi.set(__self__, "unreferenced_file_removal", unreferenced_file_removal) + + @property + @pulumi.getter(name="tableBucketArn") + def table_bucket_arn(self) -> Optional[str]: + return pulumi.get(self, "table_bucket_arn") + + @property + @pulumi.getter(name="unreferencedFileRemoval") + def unreferenced_file_removal(self) -> Optional['outputs.TableBucketUnreferencedFileRemoval']: + return pulumi.get(self, "unreferenced_file_removal") + + +class AwaitableGetTableBucketResult(GetTableBucketResult): + # pylint: disable=using-constant-test + def __await__(self): + if False: + yield self + return GetTableBucketResult( + table_bucket_arn=self.table_bucket_arn, + unreferenced_file_removal=self.unreferenced_file_removal) + + +def get_table_bucket(table_bucket_arn: Optional[str] = None, + opts: Optional[pulumi.InvokeOptions] = None) -> AwaitableGetTableBucketResult: + """ + Creates an Amazon S3 Tables table bucket in the same AWS Region where you create the AWS CloudFormation stack. + """ + __args__ = dict() + __args__['tableBucketArn'] = table_bucket_arn + opts = pulumi.InvokeOptions.merge(_utilities.get_invoke_opts_defaults(), opts) + __ret__ = pulumi.runtime.invoke('aws-native:s3tables:getTableBucket', __args__, opts=opts, typ=GetTableBucketResult).value + + return AwaitableGetTableBucketResult( + table_bucket_arn=pulumi.get(__ret__, 'table_bucket_arn'), + unreferenced_file_removal=pulumi.get(__ret__, 'unreferenced_file_removal')) +def get_table_bucket_output(table_bucket_arn: Optional[pulumi.Input[str]] = None, + opts: Optional[Union[pulumi.InvokeOptions, pulumi.InvokeOutputOptions]] = None) -> pulumi.Output[GetTableBucketResult]: + """ + Creates an Amazon S3 Tables table bucket in the same AWS Region where you create the AWS CloudFormation stack. + """ + __args__ = dict() + __args__['tableBucketArn'] = table_bucket_arn + opts = pulumi.InvokeOutputOptions.merge(_utilities.get_invoke_opts_defaults(), opts) + __ret__ = pulumi.runtime.invoke_output('aws-native:s3tables:getTableBucket', __args__, opts=opts, typ=GetTableBucketResult) + return __ret__.apply(lambda __response__: GetTableBucketResult( + table_bucket_arn=pulumi.get(__response__, 'table_bucket_arn'), + unreferenced_file_removal=pulumi.get(__response__, 'unreferenced_file_removal'))) diff --git a/sdk/python/pulumi_aws_native/s3tables/get_table_bucket_policy.py b/sdk/python/pulumi_aws_native/s3tables/get_table_bucket_policy.py new file mode 100644 index 0000000000..2f301e44dc --- /dev/null +++ b/sdk/python/pulumi_aws_native/s3tables/get_table_bucket_policy.py @@ -0,0 +1,69 @@ +# coding=utf-8 +# *** WARNING: this file was generated by pulumi-language-python. *** +# *** Do not edit by hand unless you're certain you know what you are doing! *** + +import copy +import warnings +import sys +import pulumi +import pulumi.runtime +from typing import Any, Mapping, Optional, Sequence, Union, overload +if sys.version_info >= (3, 11): + from typing import NotRequired, TypedDict, TypeAlias +else: + from typing_extensions import NotRequired, TypedDict, TypeAlias +from .. import _utilities +from . import outputs + +__all__ = [ + 'GetTableBucketPolicyResult', + 'AwaitableGetTableBucketPolicyResult', + 'get_table_bucket_policy', + 'get_table_bucket_policy_output', +] + +@pulumi.output_type +class GetTableBucketPolicyResult: + def __init__(__self__, resource_policy=None): + if resource_policy and not isinstance(resource_policy, dict): + raise TypeError("Expected argument 'resource_policy' to be a dict") + pulumi.set(__self__, "resource_policy", resource_policy) + + @property + @pulumi.getter(name="resourcePolicy") + def resource_policy(self) -> Optional['outputs.TableBucketPolicyResourcePolicy']: + return pulumi.get(self, "resource_policy") + + +class AwaitableGetTableBucketPolicyResult(GetTableBucketPolicyResult): + # pylint: disable=using-constant-test + def __await__(self): + if False: + yield self + return GetTableBucketPolicyResult( + resource_policy=self.resource_policy) + + +def get_table_bucket_policy(table_bucket_arn: Optional[str] = None, + opts: Optional[pulumi.InvokeOptions] = None) -> AwaitableGetTableBucketPolicyResult: + """ + Applies an IAM resource policy to a table bucket. + """ + __args__ = dict() + __args__['tableBucketArn'] = table_bucket_arn + opts = pulumi.InvokeOptions.merge(_utilities.get_invoke_opts_defaults(), opts) + __ret__ = pulumi.runtime.invoke('aws-native:s3tables:getTableBucketPolicy', __args__, opts=opts, typ=GetTableBucketPolicyResult).value + + return AwaitableGetTableBucketPolicyResult( + resource_policy=pulumi.get(__ret__, 'resource_policy')) +def get_table_bucket_policy_output(table_bucket_arn: Optional[pulumi.Input[str]] = None, + opts: Optional[Union[pulumi.InvokeOptions, pulumi.InvokeOutputOptions]] = None) -> pulumi.Output[GetTableBucketPolicyResult]: + """ + Applies an IAM resource policy to a table bucket. + """ + __args__ = dict() + __args__['tableBucketArn'] = table_bucket_arn + opts = pulumi.InvokeOutputOptions.merge(_utilities.get_invoke_opts_defaults(), opts) + __ret__ = pulumi.runtime.invoke_output('aws-native:s3tables:getTableBucketPolicy', __args__, opts=opts, typ=GetTableBucketPolicyResult) + return __ret__.apply(lambda __response__: GetTableBucketPolicyResult( + resource_policy=pulumi.get(__response__, 'resource_policy'))) diff --git a/sdk/python/pulumi_aws_native/s3tables/outputs.py b/sdk/python/pulumi_aws_native/s3tables/outputs.py new file mode 100644 index 0000000000..387e9f83d1 --- /dev/null +++ b/sdk/python/pulumi_aws_native/s3tables/outputs.py @@ -0,0 +1,100 @@ +# coding=utf-8 +# *** WARNING: this file was generated by pulumi-language-python. *** +# *** Do not edit by hand unless you're certain you know what you are doing! *** + +import copy +import warnings +import sys +import pulumi +import pulumi.runtime +from typing import Any, Mapping, Optional, Sequence, Union, overload +if sys.version_info >= (3, 11): + from typing import NotRequired, TypedDict, TypeAlias +else: + from typing_extensions import NotRequired, TypedDict, TypeAlias +from .. import _utilities +from ._enums import * + +__all__ = [ + 'TableBucketPolicyResourcePolicy', + 'TableBucketUnreferencedFileRemoval', +] + +@pulumi.output_type +class TableBucketPolicyResourcePolicy(dict): + """ + A policy document containing permissions to add to the specified table bucket. In IAM, you must provide policy documents in JSON format. However, in CloudFormation you can provide the policy in JSON or YAML format because CloudFormation converts YAML to JSON before submitting it to IAM. + """ + def __init__(__self__): + """ + A policy document containing permissions to add to the specified table bucket. In IAM, you must provide policy documents in JSON format. However, in CloudFormation you can provide the policy in JSON or YAML format because CloudFormation converts YAML to JSON before submitting it to IAM. + """ + pass + + +@pulumi.output_type +class TableBucketUnreferencedFileRemoval(dict): + """ + Settings governing the Unreferenced File Removal maintenance action. Unreferenced file removal identifies and deletes all objects that are not referenced by any table snapshots. + """ + @staticmethod + def __key_warning(key: str): + suggest = None + if key == "noncurrentDays": + suggest = "noncurrent_days" + elif key == "unreferencedDays": + suggest = "unreferenced_days" + + if suggest: + pulumi.log.warn(f"Key '{key}' not found in TableBucketUnreferencedFileRemoval. Access the value via the '{suggest}' property getter instead.") + + def __getitem__(self, key: str) -> Any: + TableBucketUnreferencedFileRemoval.__key_warning(key) + return super().__getitem__(key) + + def get(self, key: str, default = None) -> Any: + TableBucketUnreferencedFileRemoval.__key_warning(key) + return super().get(key, default) + + def __init__(__self__, *, + noncurrent_days: Optional[int] = None, + status: Optional['TableBucketUnreferencedFileRemovalStatus'] = None, + unreferenced_days: Optional[int] = None): + """ + Settings governing the Unreferenced File Removal maintenance action. Unreferenced file removal identifies and deletes all objects that are not referenced by any table snapshots. + :param int noncurrent_days: S3 permanently deletes noncurrent objects after the number of days specified by the NoncurrentDays property. + :param 'TableBucketUnreferencedFileRemovalStatus' status: Indicates whether the Unreferenced File Removal maintenance action is enabled. + :param int unreferenced_days: For any object not referenced by your table and older than the UnreferencedDays property, S3 creates a delete marker and marks the object version as noncurrent. + """ + if noncurrent_days is not None: + pulumi.set(__self__, "noncurrent_days", noncurrent_days) + if status is not None: + pulumi.set(__self__, "status", status) + if unreferenced_days is not None: + pulumi.set(__self__, "unreferenced_days", unreferenced_days) + + @property + @pulumi.getter(name="noncurrentDays") + def noncurrent_days(self) -> Optional[int]: + """ + S3 permanently deletes noncurrent objects after the number of days specified by the NoncurrentDays property. + """ + return pulumi.get(self, "noncurrent_days") + + @property + @pulumi.getter + def status(self) -> Optional['TableBucketUnreferencedFileRemovalStatus']: + """ + Indicates whether the Unreferenced File Removal maintenance action is enabled. + """ + return pulumi.get(self, "status") + + @property + @pulumi.getter(name="unreferencedDays") + def unreferenced_days(self) -> Optional[int]: + """ + For any object not referenced by your table and older than the UnreferencedDays property, S3 creates a delete marker and marks the object version as noncurrent. + """ + return pulumi.get(self, "unreferenced_days") + + diff --git a/sdk/python/pulumi_aws_native/s3tables/table_bucket.py b/sdk/python/pulumi_aws_native/s3tables/table_bucket.py new file mode 100644 index 0000000000..5edbd4cea4 --- /dev/null +++ b/sdk/python/pulumi_aws_native/s3tables/table_bucket.py @@ -0,0 +1,149 @@ +# coding=utf-8 +# *** WARNING: this file was generated by pulumi-language-python. *** +# *** Do not edit by hand unless you're certain you know what you are doing! *** + +import copy +import warnings +import sys +import pulumi +import pulumi.runtime +from typing import Any, Mapping, Optional, Sequence, Union, overload +if sys.version_info >= (3, 11): + from typing import NotRequired, TypedDict, TypeAlias +else: + from typing_extensions import NotRequired, TypedDict, TypeAlias +from .. import _utilities +from . import outputs +from ._enums import * +from ._inputs import * + +__all__ = ['TableBucketArgs', 'TableBucket'] + +@pulumi.input_type +class TableBucketArgs: + def __init__(__self__, *, + table_bucket_name: Optional[pulumi.Input[str]] = None, + unreferenced_file_removal: Optional[pulumi.Input['TableBucketUnreferencedFileRemovalArgs']] = None): + """ + The set of arguments for constructing a TableBucket resource. + """ + if table_bucket_name is not None: + pulumi.set(__self__, "table_bucket_name", table_bucket_name) + if unreferenced_file_removal is not None: + pulumi.set(__self__, "unreferenced_file_removal", unreferenced_file_removal) + + @property + @pulumi.getter(name="tableBucketName") + def table_bucket_name(self) -> Optional[pulumi.Input[str]]: + return pulumi.get(self, "table_bucket_name") + + @table_bucket_name.setter + def table_bucket_name(self, value: Optional[pulumi.Input[str]]): + pulumi.set(self, "table_bucket_name", value) + + @property + @pulumi.getter(name="unreferencedFileRemoval") + def unreferenced_file_removal(self) -> Optional[pulumi.Input['TableBucketUnreferencedFileRemovalArgs']]: + return pulumi.get(self, "unreferenced_file_removal") + + @unreferenced_file_removal.setter + def unreferenced_file_removal(self, value: Optional[pulumi.Input['TableBucketUnreferencedFileRemovalArgs']]): + pulumi.set(self, "unreferenced_file_removal", value) + + +class TableBucket(pulumi.CustomResource): + @overload + def __init__(__self__, + resource_name: str, + opts: Optional[pulumi.ResourceOptions] = None, + table_bucket_name: Optional[pulumi.Input[str]] = None, + unreferenced_file_removal: Optional[pulumi.Input[Union['TableBucketUnreferencedFileRemovalArgs', 'TableBucketUnreferencedFileRemovalArgsDict']]] = None, + __props__=None): + """ + Creates an Amazon S3 Tables table bucket in the same AWS Region where you create the AWS CloudFormation stack. + + :param str resource_name: The name of the resource. + :param pulumi.ResourceOptions opts: Options for the resource. + """ + ... + @overload + def __init__(__self__, + resource_name: str, + args: Optional[TableBucketArgs] = None, + opts: Optional[pulumi.ResourceOptions] = None): + """ + Creates an Amazon S3 Tables table bucket in the same AWS Region where you create the AWS CloudFormation stack. + + :param str resource_name: The name of the resource. + :param TableBucketArgs args: The arguments to use to populate this resource's properties. + :param pulumi.ResourceOptions opts: Options for the resource. + """ + ... + def __init__(__self__, resource_name: str, *args, **kwargs): + resource_args, opts = _utilities.get_resource_args_opts(TableBucketArgs, pulumi.ResourceOptions, *args, **kwargs) + if resource_args is not None: + __self__._internal_init(resource_name, opts, **resource_args.__dict__) + else: + __self__._internal_init(resource_name, *args, **kwargs) + + def _internal_init(__self__, + resource_name: str, + opts: Optional[pulumi.ResourceOptions] = None, + table_bucket_name: Optional[pulumi.Input[str]] = None, + unreferenced_file_removal: Optional[pulumi.Input[Union['TableBucketUnreferencedFileRemovalArgs', 'TableBucketUnreferencedFileRemovalArgsDict']]] = None, + __props__=None): + opts = pulumi.ResourceOptions.merge(_utilities.get_resource_opts_defaults(), opts) + if not isinstance(opts, pulumi.ResourceOptions): + raise TypeError('Expected resource options to be a ResourceOptions instance') + if opts.id is None: + if __props__ is not None: + raise TypeError('__props__ is only valid when passed in combination with a valid opts.id to get an existing resource') + __props__ = TableBucketArgs.__new__(TableBucketArgs) + + __props__.__dict__["table_bucket_name"] = table_bucket_name + __props__.__dict__["unreferenced_file_removal"] = unreferenced_file_removal + __props__.__dict__["table_bucket_arn"] = None + replace_on_changes = pulumi.ResourceOptions(replace_on_changes=["tableBucketName"]) + opts = pulumi.ResourceOptions.merge(opts, replace_on_changes) + super(TableBucket, __self__).__init__( + 'aws-native:s3tables:TableBucket', + resource_name, + __props__, + opts) + + @staticmethod + def get(resource_name: str, + id: pulumi.Input[str], + opts: Optional[pulumi.ResourceOptions] = None) -> 'TableBucket': + """ + Get an existing TableBucket resource's state with the given name, id, and optional extra + properties used to qualify the lookup. + + :param str resource_name: The unique name of the resulting resource. + :param pulumi.Input[str] id: The unique provider ID of the resource to lookup. + :param pulumi.ResourceOptions opts: Options for the resource. + """ + opts = pulumi.ResourceOptions.merge(opts, pulumi.ResourceOptions(id=id)) + + __props__ = TableBucketArgs.__new__(TableBucketArgs) + + __props__.__dict__["table_bucket_arn"] = None + __props__.__dict__["table_bucket_name"] = None + __props__.__dict__["unreferenced_file_removal"] = None + return TableBucket(resource_name, opts=opts, __props__=__props__) + + @property + @pulumi.getter(name="tableBucketArn") + def table_bucket_arn(self) -> pulumi.Output[str]: + return pulumi.get(self, "table_bucket_arn") + + @property + @pulumi.getter(name="tableBucketName") + def table_bucket_name(self) -> pulumi.Output[str]: + return pulumi.get(self, "table_bucket_name") + + @property + @pulumi.getter(name="unreferencedFileRemoval") + def unreferenced_file_removal(self) -> pulumi.Output[Optional['outputs.TableBucketUnreferencedFileRemoval']]: + return pulumi.get(self, "unreferenced_file_removal") + diff --git a/sdk/python/pulumi_aws_native/s3tables/table_bucket_policy.py b/sdk/python/pulumi_aws_native/s3tables/table_bucket_policy.py new file mode 100644 index 0000000000..f80deaeafa --- /dev/null +++ b/sdk/python/pulumi_aws_native/s3tables/table_bucket_policy.py @@ -0,0 +1,143 @@ +# coding=utf-8 +# *** WARNING: this file was generated by pulumi-language-python. *** +# *** Do not edit by hand unless you're certain you know what you are doing! *** + +import copy +import warnings +import sys +import pulumi +import pulumi.runtime +from typing import Any, Mapping, Optional, Sequence, Union, overload +if sys.version_info >= (3, 11): + from typing import NotRequired, TypedDict, TypeAlias +else: + from typing_extensions import NotRequired, TypedDict, TypeAlias +from .. import _utilities +from . import outputs +from ._inputs import * + +__all__ = ['TableBucketPolicyArgs', 'TableBucketPolicy'] + +@pulumi.input_type +class TableBucketPolicyArgs: + def __init__(__self__, *, + resource_policy: pulumi.Input['TableBucketPolicyResourcePolicyArgs'], + table_bucket_arn: pulumi.Input[str]): + """ + The set of arguments for constructing a TableBucketPolicy resource. + """ + pulumi.set(__self__, "resource_policy", resource_policy) + pulumi.set(__self__, "table_bucket_arn", table_bucket_arn) + + @property + @pulumi.getter(name="resourcePolicy") + def resource_policy(self) -> pulumi.Input['TableBucketPolicyResourcePolicyArgs']: + return pulumi.get(self, "resource_policy") + + @resource_policy.setter + def resource_policy(self, value: pulumi.Input['TableBucketPolicyResourcePolicyArgs']): + pulumi.set(self, "resource_policy", value) + + @property + @pulumi.getter(name="tableBucketArn") + def table_bucket_arn(self) -> pulumi.Input[str]: + return pulumi.get(self, "table_bucket_arn") + + @table_bucket_arn.setter + def table_bucket_arn(self, value: pulumi.Input[str]): + pulumi.set(self, "table_bucket_arn", value) + + +class TableBucketPolicy(pulumi.CustomResource): + @overload + def __init__(__self__, + resource_name: str, + opts: Optional[pulumi.ResourceOptions] = None, + resource_policy: Optional[pulumi.Input[Union['TableBucketPolicyResourcePolicyArgs', 'TableBucketPolicyResourcePolicyArgsDict']]] = None, + table_bucket_arn: Optional[pulumi.Input[str]] = None, + __props__=None): + """ + Applies an IAM resource policy to a table bucket. + + :param str resource_name: The name of the resource. + :param pulumi.ResourceOptions opts: Options for the resource. + """ + ... + @overload + def __init__(__self__, + resource_name: str, + args: TableBucketPolicyArgs, + opts: Optional[pulumi.ResourceOptions] = None): + """ + Applies an IAM resource policy to a table bucket. + + :param str resource_name: The name of the resource. + :param TableBucketPolicyArgs args: The arguments to use to populate this resource's properties. + :param pulumi.ResourceOptions opts: Options for the resource. + """ + ... + def __init__(__self__, resource_name: str, *args, **kwargs): + resource_args, opts = _utilities.get_resource_args_opts(TableBucketPolicyArgs, pulumi.ResourceOptions, *args, **kwargs) + if resource_args is not None: + __self__._internal_init(resource_name, opts, **resource_args.__dict__) + else: + __self__._internal_init(resource_name, *args, **kwargs) + + def _internal_init(__self__, + resource_name: str, + opts: Optional[pulumi.ResourceOptions] = None, + resource_policy: Optional[pulumi.Input[Union['TableBucketPolicyResourcePolicyArgs', 'TableBucketPolicyResourcePolicyArgsDict']]] = None, + table_bucket_arn: Optional[pulumi.Input[str]] = None, + __props__=None): + opts = pulumi.ResourceOptions.merge(_utilities.get_resource_opts_defaults(), opts) + if not isinstance(opts, pulumi.ResourceOptions): + raise TypeError('Expected resource options to be a ResourceOptions instance') + if opts.id is None: + if __props__ is not None: + raise TypeError('__props__ is only valid when passed in combination with a valid opts.id to get an existing resource') + __props__ = TableBucketPolicyArgs.__new__(TableBucketPolicyArgs) + + if resource_policy is None and not opts.urn: + raise TypeError("Missing required property 'resource_policy'") + __props__.__dict__["resource_policy"] = resource_policy + if table_bucket_arn is None and not opts.urn: + raise TypeError("Missing required property 'table_bucket_arn'") + __props__.__dict__["table_bucket_arn"] = table_bucket_arn + replace_on_changes = pulumi.ResourceOptions(replace_on_changes=["tableBucketArn"]) + opts = pulumi.ResourceOptions.merge(opts, replace_on_changes) + super(TableBucketPolicy, __self__).__init__( + 'aws-native:s3tables:TableBucketPolicy', + resource_name, + __props__, + opts) + + @staticmethod + def get(resource_name: str, + id: pulumi.Input[str], + opts: Optional[pulumi.ResourceOptions] = None) -> 'TableBucketPolicy': + """ + Get an existing TableBucketPolicy resource's state with the given name, id, and optional extra + properties used to qualify the lookup. + + :param str resource_name: The unique name of the resulting resource. + :param pulumi.Input[str] id: The unique provider ID of the resource to lookup. + :param pulumi.ResourceOptions opts: Options for the resource. + """ + opts = pulumi.ResourceOptions.merge(opts, pulumi.ResourceOptions(id=id)) + + __props__ = TableBucketPolicyArgs.__new__(TableBucketPolicyArgs) + + __props__.__dict__["resource_policy"] = None + __props__.__dict__["table_bucket_arn"] = None + return TableBucketPolicy(resource_name, opts=opts, __props__=__props__) + + @property + @pulumi.getter(name="resourcePolicy") + def resource_policy(self) -> pulumi.Output['outputs.TableBucketPolicyResourcePolicy']: + return pulumi.get(self, "resource_policy") + + @property + @pulumi.getter(name="tableBucketArn") + def table_bucket_arn(self) -> pulumi.Output[str]: + return pulumi.get(self, "table_bucket_arn") +