Skip to content

Commit 01c6c39

Browse files
docs(cfnspec): update CloudFormation documentation (#24394)
1 parent f9af47f commit 01c6c39

File tree

1 file changed

+32
-32
lines changed

1 file changed

+32
-32
lines changed

packages/@aws-cdk/cfnspec/spec-source/cfn-docs/cfn-docs.json

+32-32
Original file line numberDiff line numberDiff line change
@@ -33555,9 +33555,9 @@
3355533555
},
3355633556
"AWS::ManagedBlockchain::Member.MemberFabricConfiguration": {
3355733557
"attributes": {},
33558-
"description": "Configuration properties for Hyperledger Fabric for a member in a Managed Blockchain network using the Hyperledger Fabric framework.",
33558+
"description": "Configuration properties for Hyperledger Fabric for a member in a Managed Blockchain network that is using the Hyperledger Fabric framework.",
3355933559
"properties": {
33560-
"AdminPassword": "The password for the member's initial administrative user. The `AdminPassword` must be at least eight characters long and no more than 32 characters. It must contain at least one uppercase letter, one lowercase letter, and one digit. It cannot have a single quotation mark (\u2018), a double quotation marks (\u201c), a forward slash(/), a backward slash(\\), @, or a space.",
33560+
"AdminPassword": "The password for the member's initial administrative user. The `AdminPassword` must be at least 8 characters long and no more than 32 characters. It must contain at least one uppercase letter, one lowercase letter, and one digit. It cannot have a single quotation mark (\u2018), a double quotation marks (\u201c), a forward slash(/), a backward slash(\\), @, or a space.",
3356133561
"AdminUsername": "The user name for the member's initial administrative user."
3356233562
}
3356333563
},
@@ -33577,21 +33577,21 @@
3357733577
"FrameworkVersion": "The version of the blockchain framework that the network uses.",
3357833578
"Name": "The name of the network.",
3357933579
"NetworkFrameworkConfiguration": "Configuration properties relevant to the network for the blockchain framework that the network uses.",
33580-
"VotingPolicy": "The voting rules for the network to decide if a proposal is accepted."
33580+
"VotingPolicy": "The voting rules that the network uses to decide if a proposal is accepted."
3358133581
}
3358233582
},
3358333583
"AWS::ManagedBlockchain::Member.NetworkFabricConfiguration": {
3358433584
"attributes": {},
3358533585
"description": "Hyperledger Fabric configuration properties for the network.",
3358633586
"properties": {
33587-
"Edition": "The edition of Amazon Managed Blockchain that the network uses. Valid values are `standard` and `starter` . For more information, see"
33587+
"Edition": "The edition of Amazon Managed Blockchain that the network uses. Valid values are `standard` and `starter` . For more information, see [Amazon Managed Blockchain Pricing](https://docs.aws.amazon.com/managed-blockchain/pricing/)"
3358833588
}
3358933589
},
3359033590
"AWS::ManagedBlockchain::Member.NetworkFrameworkConfiguration": {
3359133591
"attributes": {},
3359233592
"description": "Configuration properties relevant to the network for the blockchain framework that the network uses.",
3359333593
"properties": {
33594-
"NetworkFabricConfiguration": "Configuration properties for Hyperledger Fabric for a member in a Managed Blockchain network using the Hyperledger Fabric framework."
33594+
"NetworkFabricConfiguration": "Configuration properties for Hyperledger Fabric for a member in a Managed Blockchain network that is using the Hyperledger Fabric framework."
3359533595
}
3359633596
},
3359733597
"AWS::ManagedBlockchain::Member.VotingPolicy": {
@@ -38509,7 +38509,7 @@
3850938509
"CustomDeliveryConfiguration": "The delivery configuration settings for sending the treatment through a custom channel. This object is required if the `MessageConfiguration` object for the treatment specifies a `CustomMessage` object.",
3851038510
"Description": "A custom description of the campaign.",
3851138511
"HoldoutPercent": "The allocated percentage of users (segment members) who shouldn't receive messages from the campaign.",
38512-
"IsPaused": "Specifies whether to pause the campaign. A paused campaign doesn't run unless you resume it by changing this value to `false` . If you restart a campaign, the campaign restarts from the beginning and not at the point you paused it.",
38512+
"IsPaused": "Specifies whether to pause the campaign. A paused campaign doesn't run unless you resume it by changing this value to `false` . If you restart a campaign, the campaign restarts from the beginning and not at the point you paused it. If a campaign is running it will complete and then pause. Pause only pauses or skips the next run for a recurring future scheduled campaign. A campaign scheduled for immediate can't be paused.",
3851338513
"Limits": "The messaging limits for the campaign.",
3851438514
"MessageConfiguration": "The message configuration settings for the campaign.",
3851538515
"Name": "The name of the campaign.",
@@ -39795,7 +39795,7 @@
3979539795
"attributes": {},
3979639796
"description": "The configuration settings of the Amazon Kinesis Data Streams destination for an Amazon QLDB journal stream.",
3979739797
"properties": {
39798-
"AggregationEnabled": "Enables QLDB to publish multiple data records in a single Kinesis Data Streams record, increasing the number of records sent per API call.\n\n*This option is enabled by default.* Record aggregation has important implications for processing records and requires de-aggregation in your stream consumer. To learn more, see [KPL Key Concepts](https://docs.aws.amazon.com/streams/latest/dev/kinesis-kpl-concepts.html) and [Consumer De-aggregation](https://docs.aws.amazon.com/streams/latest/dev/kinesis-kpl-consumer-deaggregation.html) in the *Amazon Kinesis Data Streams Developer Guide* .",
39798+
"AggregationEnabled": "Enables QLDB to publish multiple data records in a single Kinesis Data Streams record, increasing the number of records sent per API call.\n\nDefault: `True`\n\nRecord aggregation has important implications for processing records and requires de-aggregation in your stream consumer. To learn more, see [KPL Key Concepts](https://docs.aws.amazon.com/streams/latest/dev/kinesis-kpl-concepts.html) and [Consumer De-aggregation](https://docs.aws.amazon.com/streams/latest/dev/kinesis-kpl-consumer-deaggregation.html) in the *Amazon Kinesis Data Streams Developer Guide* .",
3979939799
"StreamArn": "The Amazon Resource Name (ARN) of the Kinesis Data Streams resource."
3980039800
}
3980139801
},
@@ -41046,7 +41046,7 @@
4104641046
},
4104741047
"description": "The `AWS::RDS::DBClusterParameterGroup` resource creates a new Amazon RDS DB cluster parameter group.\n\nFor information about configuring parameters for Amazon Aurora DB clusters, see [Working with parameter groups](https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/USER_WorkingWithParamGroups.html) in the *Amazon Aurora User Guide* .\n\n> If you apply a parameter group to a DB cluster, then its DB instances might need to reboot. This can result in an outage while the DB instances are rebooting.\n> \n> If you apply a change to parameter group associated with a stopped DB cluster, then the update stack waits until the DB cluster is started.",
4104841048
"properties": {
41049-
"DBClusterParameterGroupName": "The name of the DB cluster parameter group.\n\nConstraints:\n\n- Must not match the name of an existing DB cluster parameter group.\n\nIf you don't specify a value for `DBClusterParameterGroupName` property, a name is automatically created for the DB cluster paramter group.\n\n> This value is stored as a lowercase string.",
41049+
"DBClusterParameterGroupName": "The name of the DB cluster parameter group.\n\nConstraints:\n\n- Must not match the name of an existing DB cluster parameter group.\n\nIf you don't specify a value for `DBClusterParameterGroupName` property, a name is automatically created for the DB cluster parameter group.\n\n> This value is stored as a lowercase string.",
4105041050
"Description": "A friendly description for this DB cluster parameter group.",
4105141051
"Family": "The DB cluster parameter group family name. A DB cluster parameter group can be associated with one and only one DB cluster parameter group family, and can be applied only to a DB cluster running a DB engine and engine version compatible with that DB cluster parameter group family.\n\n> The DB cluster parameter group family can't be changed when updating a DB cluster parameter group. \n\nTo list all of the available parameter group families, use the following command:\n\n`aws rds describe-db-engine-versions --query \"DBEngineVersions[].DBParameterGroupFamily\"`\n\nThe output contains duplicates.\n\nFor more information, see `[CreateDBClusterParameterGroup](https://docs.aws.amazon.com//AmazonRDS/latest/APIReference/API_CreateDBClusterParameterGroup.html)` .",
4105241052
"Parameters": "Provides a list of parameters for the DB cluster parameter group.",
@@ -41114,7 +41114,7 @@
4111441114
"NetworkType": "The network type of the DB instance.\n\nValid values:\n\n- `IPV4`\n- `DUAL`\n\nThe network type is determined by the `DBSubnetGroup` specified for the DB instance. A `DBSubnetGroup` can support only the IPv4 protocol or the IPv4 and IPv6 protocols ( `DUAL` ).\n\nFor more information, see [Working with a DB instance in a VPC](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_VPC.WorkingWithRDSInstanceinaVPC.html) in the *Amazon RDS User Guide.*",
4111541115
"OptionGroupName": "Indicates that the DB instance should be associated with the specified option group.\n\nPermanent options, such as the TDE option for Oracle Advanced Security TDE, can't be removed from an option group. Also, that option group can't be removed from a DB instance once it is associated with a DB instance.",
4111641116
"PerformanceInsightsKMSKeyId": "The AWS KMS key identifier for encryption of Performance Insights data.\n\nThe KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the KMS key.\n\nIf you do not specify a value for `PerformanceInsightsKMSKeyId` , then Amazon RDS uses your default KMS key. There is a default KMS key for your AWS account. Your AWS account has a different default KMS key for each AWS Region.\n\nFor information about enabling Performance Insights, see [EnablePerformanceInsights](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-rds-database-instance.html#cfn-rds-dbinstance-enableperformanceinsights) .",
41117-
"PerformanceInsightsRetentionPeriod": "The amount of time, in days, to retain Performance Insights data. Valid values are 7 or 731 (2 years).\n\nFor information about enabling Performance Insights, see [EnablePerformanceInsights](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-rds-database-instance.html#cfn-rds-dbinstance-enableperformanceinsights) .",
41117+
"PerformanceInsightsRetentionPeriod": "The number of days to retain Performance Insights data. The default is 7 days. The following values are valid:\n\n- 7\n- *month* * 31, where *month* is a number of months from 1-23\n- 731\n\nFor example, the following values are valid:\n\n- 93 (3 months * 31)\n- 341 (11 months * 31)\n- 589 (19 months * 31)\n- 731\n\nIf you specify a retention period such as 94, which isn't a valid value, RDS issues an error.\n\nThis setting doesn't apply to RDS Custom.",
4111841118
"Port": "The port number on which the database accepts connections.\n\n*Amazon Aurora*\n\nNot applicable. The port number is managed by the DB cluster.",
4111941119
"PreferredBackupWindow": "The daily time range during which automated backups are created if automated backups are enabled, using the `BackupRetentionPeriod` parameter. For more information, see [Backup Window](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_WorkingWithAutomatedBackups.html#USER_WorkingWithAutomatedBackups.BackupWindow) in the *Amazon RDS User Guide.*\n\nConstraints:\n\n- Must be in the format `hh24:mi-hh24:mi` .\n- Must be in Universal Coordinated Time (UTC).\n- Must not conflict with the preferred maintenance window.\n- Must be at least 30 minutes.\n\n*Amazon Aurora*\n\nNot applicable. The daily time range for creating automated backups is managed by the DB cluster.",
4112041120
"PreferredMaintenanceWindow": "The weekly time range during which system maintenance can occur, in Universal Coordinated Time (UTC).\n\nFormat: `ddd:hh24:mi-ddd:hh24:mi`\n\nThe default is a 30-minute window selected at random from an 8-hour block of time for each AWS Region, occurring on a random day of the week. To see the time blocks available, see [Adjusting the Preferred DB Instance Maintenance Window](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_UpgradeDBInstance.Maintenance.html#AdjustingTheMaintenanceWindow) in the *Amazon RDS User Guide.*\n\n> This property applies when AWS CloudFormation initially creates the DB instance. If you use AWS CloudFormation to update the DB instance, those updates are applied immediately. \n\nConstraints: Minimum 30-minute window.",
@@ -42381,42 +42381,42 @@
4238142381
"AWS::RolesAnywhere::CRL": {
4238242382
"attributes": {
4238342383
"CrlId": "The unique primary identifier of the Crl",
42384-
"Ref": "`Ref` returns `CrlId` ."
42384+
"Ref": "The name of the CRL."
4238542385
},
42386-
"description": "The state of the certificate revocation list (CRL) after a read or write operation.",
42386+
"description": "Creates a Crl.",
4238742387
"properties": {
42388-
"CrlData": "The revocation record for a certificate, following the x509 v3 standard.",
42389-
"Enabled": "Indicates whether the certificate revocation list (CRL) is enabled.",
42390-
"Name": "The name of the certificate revocation list (CRL).",
42391-
"Tags": "A list of tags to attach to the CRL.",
42388+
"CrlData": "x509 v3 Certificate Revocation List to revoke auth for corresponding certificates presented in CreateSession operations",
42389+
"Enabled": "The enabled status of the resource.",
42390+
"Name": "The customer specified name of the resource.",
42391+
"Tags": "A list of Tags.",
4239242392
"TrustAnchorArn": "The ARN of the TrustAnchor the certificate revocation list (CRL) will provide revocation for."
4239342393
}
4239442394
},
4239542395
"AWS::RolesAnywhere::Profile": {
4239642396
"attributes": {
42397-
"ProfileArn": "The ARN of the profile.",
42397+
"ProfileArn": "",
4239842398
"ProfileId": "The unique primary identifier of the Profile",
42399-
"Ref": "`Ref` returns `ProfileId` ."
42399+
"Ref": "The name of the Profile"
4240042400
},
42401-
"description": "Creates a *profile* , a list of the roles that Roles Anywhere service is trusted to assume. You use profiles to intersect permissions with IAM managed policies.\n\n*Required permissions:* `rolesanywhere:CreateProfile` .",
42401+
"description": "Creates a Profile.",
4240242402
"properties": {
42403-
"DurationSeconds": "Sets the maximum number of seconds that vended temporary credentials through [CreateSession](https://docs.aws.amazon.com/rolesanywhere/latest/userguide/authentication-create-session.html) will be valid for, between 900 and 3600.",
42404-
"Enabled": "Indicates whether the profile is enabled.",
42405-
"ManagedPolicyArns": "A list of managed policy ARNs that apply to the vended session credentials.",
42406-
"Name": "The name of the profile.",
42407-
"RequireInstanceProperties": "Specifies whether instance properties are required in temporary credential requests with this profile.",
42408-
"RoleArns": "A list of IAM role ARNs. During `CreateSession` , if a matching role ARN is provided, the properties in this profile will be applied to the intersection session policy.",
42409-
"SessionPolicy": "A session policy that applies to the trust boundary of the vended session credentials.",
42410-
"Tags": "A list of tags to attach to the profile."
42403+
"DurationSeconds": "The number of seconds vended session credentials will be valid for",
42404+
"Enabled": "The enabled status of the resource.",
42405+
"ManagedPolicyArns": "A list of managed policy ARNs. Managed policies identified by this list will be applied to the vended session credentials.",
42406+
"Name": "The customer specified name of the resource.",
42407+
"RequireInstanceProperties": "Specifies whether instance properties are required in CreateSession requests with this profile.",
42408+
"RoleArns": "A list of IAM role ARNs that can be assumed when this profile is specified in a CreateSession request.",
42409+
"SessionPolicy": "A session policy that will applied to the trust boundary of the vended session credentials.",
42410+
"Tags": "A list of Tags."
4241142411
}
4241242412
},
4241342413
"AWS::RolesAnywhere::TrustAnchor": {
4241442414
"attributes": {
4241542415
"Ref": "`Ref` returns `TrustAnchorId` .",
4241642416
"TrustAnchorArn": "The ARN of the trust anchor.",
42417-
"TrustAnchorId": "The unique primary identifier of the TrustAnchor"
42417+
"TrustAnchorId": ""
4241842418
},
42419-
"description": "The state of the trust anchor after a read or write operation.",
42419+
"description": "Creates a TrustAnchor.",
4242042420
"properties": {
4242142421
"Enabled": "Indicates whether the trust anchor is enabled.",
4242242422
"Name": "The name of the trust anchor.",
@@ -42426,15 +42426,15 @@
4242642426
},
4242742427
"AWS::RolesAnywhere::TrustAnchor.Source": {
4242842428
"attributes": {},
42429-
"description": "The trust anchor type and its related certificate data.",
42429+
"description": "Object representing the TrustAnchor type and its related certificate data.",
4243042430
"properties": {
42431-
"SourceData": "The data field of the trust anchor depending on its type.",
42432-
"SourceType": "The type of the trust anchor."
42431+
"SourceData": "A union object representing the data field of the TrustAnchor depending on its type",
42432+
"SourceType": "The type of the TrustAnchor."
4243342433
}
4243442434
},
4243542435
"AWS::RolesAnywhere::TrustAnchor.SourceData": {
4243642436
"attributes": {},
42437-
"description": "The data field of the trust anchor depending on its type.",
42437+
"description": "A union object representing the data field of the TrustAnchor depending on its type",
4243842438
"properties": {
4243942439
"AcmPcaArn": "The root certificate of the AWS Private Certificate Authority specified by this ARN is used in trust validation for temporary credential requests. Included for trust anchors of type `AWS_ACM_PCA` .",
4244042440
"X509CertificateData": "The PEM-encoded data for the certificate anchor. Included for trust anchors of type `CERTIFICATE_BUNDLE` ."

0 commit comments

Comments
 (0)