Skip to content

Commit ac81ec0

Browse files
docs(cfnspec): update CloudFormation documentation (#24922)
1 parent 8d0b97b commit ac81ec0

File tree

1 file changed

+34
-34
lines changed

1 file changed

+34
-34
lines changed

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

+34-34
Original file line numberDiff line numberDiff line change
@@ -5640,7 +5640,7 @@
56405640
"DesiredCapacity": "The desired capacity is the initial capacity of the Auto Scaling group at the time of its creation and the capacity it attempts to maintain. It can scale beyond this capacity if you configure automatic scaling.\n\nThe number must be greater than or equal to the minimum size of the group and less than or equal to the maximum size of the group. If you do not specify a desired capacity when creating the stack, the default is the minimum size of the group.\n\nCloudFormation marks the Auto Scaling group as successful (by setting its status to CREATE_COMPLETE) when the desired capacity is reached. However, if a maximum Spot price is set in the launch template or launch configuration that you specified, then desired capacity is not used as a criteria for success. Whether your request is fulfilled depends on Spot Instance capacity and your maximum price.",
56415641
"DesiredCapacityType": "The unit of measurement for the value specified for desired capacity. Amazon EC2 Auto Scaling supports `DesiredCapacityType` for attribute-based instance type selection only. For more information, see [Creating an Auto Scaling group using attribute-based instance type selection](https://docs.aws.amazon.com/autoscaling/ec2/userguide/create-asg-instance-type-requirements.html) in the *Amazon EC2 Auto Scaling User Guide* .\n\nBy default, Amazon EC2 Auto Scaling specifies `units` , which translates into number of instances.\n\nValid values: `units` | `vcpu` | `memory-mib`",
56425642
"HealthCheckGracePeriod": "The amount of time, in seconds, that Amazon EC2 Auto Scaling waits before checking the health status of an EC2 instance that has come into service and marking it unhealthy due to a failed health check. This is useful if your instances do not immediately pass their health checks after they enter the `InService` state. For more information, see [Set the health check grace period for an Auto Scaling group](https://docs.aws.amazon.com/autoscaling/ec2/userguide/health-check-grace-period.html) in the *Amazon EC2 Auto Scaling User Guide* .\n\nDefault: `0` seconds",
5643-
"HealthCheckType": "A comma-separated list of one or more health check types.\n\nThe valid values are `EC2` , `ELB` , and `VPC_LATTICE` . `EC2` is the default health check and cannot be disabled. For more information, see [Health checks for Auto Scaling instances](https://docs.aws.amazon.com/autoscaling/ec2/userguide/healthcheck.html) in the *Amazon EC2 Auto Scaling User Guide* .\n\nOnly specify `EC2` if you must clear a value that was previously set.",
5643+
"HealthCheckType": "A comma-separated value string of one or more health check types.\n\nThe valid values are `EC2` , `ELB` , and `VPC_LATTICE` . `EC2` is the default health check and cannot be disabled. For more information, see [Health checks for Auto Scaling instances](https://docs.aws.amazon.com/autoscaling/ec2/userguide/healthcheck.html) in the *Amazon EC2 Auto Scaling User Guide* .\n\nOnly specify `EC2` if you must clear a value that was previously set.",
56445644
"InstanceId": "The ID of the instance used to base the launch configuration on. For more information, see [Create an Auto Scaling group using an EC2 instance](https://docs.aws.amazon.com/autoscaling/ec2/userguide/create-asg-from-instance.html) in the *Amazon EC2 Auto Scaling User Guide* .\n\nIf you specify `LaunchTemplate` , `MixedInstancesPolicy` , or `LaunchConfigurationName` , don't specify `InstanceId` .",
56455645
"LaunchConfigurationName": "The name of the launch configuration to use to launch instances.\n\nRequired only if you don't specify `LaunchTemplate` , `MixedInstancesPolicy` , or `InstanceId` .",
56465646
"LaunchTemplate": "Information used to specify the launch template and version to use to launch instances. You can alternatively associate a launch template to the Auto Scaling group by specifying a `MixedInstancesPolicy` . For more information about creating launch templates, see [Create a launch template for an Auto Scaling group](https://docs.aws.amazon.com/autoscaling/ec2/userguide/create-launch-template.html) in the *Amazon EC2 Auto Scaling User Guide* .\n\nIf you omit this property, you must specify `MixedInstancesPolicy` , `LaunchConfigurationName` , or `InstanceId` .",
@@ -54985,33 +54985,33 @@
5498554985
"AWS::RolesAnywhere::CRL": {
5498654986
"attributes": {
5498754987
"CrlId": "The unique primary identifier of the Crl",
54988-
"Ref": "The name of the CRL."
54988+
"Ref": "`Ref` returns `CrlId` ."
5498954989
},
54990-
"description": "Creates a Crl.",
54990+
"description": "Imports the certificate revocation list (CRL). A CRL is a list of certificates that have been revoked by the issuing certificate Authority (CA). IAM Roles Anywhere validates against the CRL before issuing credentials.\n\n*Required permissions:* `rolesanywhere:ImportCrl` .",
5499154991
"properties": {
54992-
"CrlData": "x509 v3 Certificate Revocation List to revoke auth for corresponding certificates presented in CreateSession operations",
54993-
"Enabled": "The enabled status of the resource.",
54994-
"Name": "The customer specified name of the resource.",
54995-
"Tags": "A list of Tags.",
54992+
"CrlData": "The x509 v3 specified certificate revocation list (CRL).",
54993+
"Enabled": "Specifies whether the certificate revocation list (CRL) is enabled.",
54994+
"Name": "The name of the certificate revocation list (CRL).",
54995+
"Tags": "A list of tags to attach to the certificate revocation list (CRL).",
5499654996
"TrustAnchorArn": "The ARN of the TrustAnchor the certificate revocation list (CRL) will provide revocation for."
5499754997
}
5499854998
},
5499954999
"AWS::RolesAnywhere::Profile": {
5500055000
"attributes": {
5500155001
"ProfileArn": "The ARN of the profile.",
5500255002
"ProfileId": "The unique primary identifier of the Profile",
55003-
"Ref": "The name of the Profile"
55003+
"Ref": "`Ref` returns `ProfileId` ."
5500455004
},
55005-
"description": "Creates a Profile.",
55005+
"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` .",
5500655006
"properties": {
55007-
"DurationSeconds": "The number of seconds vended session credentials will be valid for",
55008-
"Enabled": "The enabled status of the resource.",
55009-
"ManagedPolicyArns": "A list of managed policy ARNs. Managed policies identified by this list will be applied to the vended session credentials.",
55010-
"Name": "The customer specified name of the resource.",
55011-
"RequireInstanceProperties": "Specifies whether instance properties are required in CreateSession requests with this profile.",
55012-
"RoleArns": "A list of IAM role ARNs that can be assumed when this profile is specified in a CreateSession request.",
55013-
"SessionPolicy": "A session policy that will applied to the trust boundary of the vended session credentials.",
55014-
"Tags": "A list of Tags."
55007+
"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.",
55008+
"Enabled": "Indicates whether the profile is enabled.",
55009+
"ManagedPolicyArns": "A list of managed policy ARNs that apply to the vended session credentials.",
55010+
"Name": "The name of the profile.",
55011+
"RequireInstanceProperties": "Specifies whether instance properties are required in temporary credential requests with this profile.",
55012+
"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.",
55013+
"SessionPolicy": "A session policy that applies to the trust boundary of the vended session credentials.",
55014+
"Tags": "The tags to attach to the profile."
5501555015
}
5501655016
},
5501755017
"AWS::RolesAnywhere::TrustAnchor": {
@@ -55020,7 +55020,7 @@
5502055020
"TrustAnchorArn": "The ARN of the trust anchor.",
5502155021
"TrustAnchorId": "The unique identifier of the trust anchor."
5502255022
},
55023-
"description": "Creates a TrustAnchor.",
55023+
"description": "Creates a trust anchor to establish trust between IAM Roles Anywhere and your certificate authority (CA). You can define a trust anchor as a reference to an AWS Private Certificate Authority ( AWS Private CA ) or by uploading a CA certificate. Your AWS workloads can authenticate with the trust anchor using certificates issued by the CA in exchange for temporary AWS credentials.\n\n*Required permissions:* `rolesanywhere:CreateTrustAnchor` .",
5502455024
"properties": {
5502555025
"Enabled": "Indicates whether the trust anchor is enabled.",
5502655026
"Name": "The name of the trust anchor.",
@@ -55030,15 +55030,15 @@
5503055030
},
5503155031
"AWS::RolesAnywhere::TrustAnchor.Source": {
5503255032
"attributes": {},
55033-
"description": "Object representing the TrustAnchor type and its related certificate data.",
55033+
"description": "The trust anchor type and its related certificate data.",
5503455034
"properties": {
55035-
"SourceData": "A union object representing the data field of the TrustAnchor depending on its type",
55036-
"SourceType": "The type of the TrustAnchor."
55035+
"SourceData": "The data field of the trust anchor depending on its type.",
55036+
"SourceType": "The type of the TrustAnchor.\n\n> `AWS_ACM_PCA` is not an allowed value in your region."
5503755037
}
5503855038
},
5503955039
"AWS::RolesAnywhere::TrustAnchor.SourceData": {
5504055040
"attributes": {},
55041-
"description": "A union object representing the data field of the TrustAnchor depending on its type",
55041+
"description": "The data field of the trust anchor depending on its type.",
5504255042
"properties": {
5504355043
"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` .\n\n> This field is not supported in your region.",
5504455044
"X509CertificateData": "The PEM-encoded data for the certificate anchor. Included for trust anchors of type `CERTIFICATE_BUNDLE` ."
@@ -60604,7 +60604,7 @@
6060460604
},
6060560605
"description": "Accepts an offer to share the specified portfolio.",
6060660606
"properties": {
60607-
"AcceptLanguage": "The language code.\n\n- `en` - English (default)\n- `jp` - Japanese\n- `zh` - Chinese",
60607+
"AcceptLanguage": "The language code.\n\n- `jp` - Japanese\n- `zh` - Chinese",
6060860608
"PortfolioId": "The portfolio identifier."
6060960609
}
6061060610
},
@@ -60617,7 +60617,7 @@
6061760617
},
6061860618
"description": "Specifies a product.",
6061960619
"properties": {
60620-
"AcceptLanguage": "The language code.\n\n- `en` - English (default)\n- `jp` - Japanese\n- `zh` - Chinese",
60620+
"AcceptLanguage": "The language code.\n\n- `jp` - Japanese\n- `zh` - Chinese",
6062160621
"Description": "The description of the product.",
6062260622
"Distributor": "The distributor of the product.",
6062360623
"Name": "The name of the product.",
@@ -60678,7 +60678,7 @@
6067860678
},
6067960679
"description": "Provisions the specified product.\n\nA provisioned product is a resourced instance of a product. For example, provisioning a product based on a AWS CloudFormation template launches a AWS CloudFormation stack and its underlying resources. You can check the status of this request using [DescribeRecord](https://docs.aws.amazon.com/servicecatalog/latest/dg/API_DescribeRecord.html) .\n\nIf the request contains a tag key with an empty list of values, there is a tag conflict for that key. Do not include conflicted keys as tags, or this causes the error \"Parameter validation failed: Missing required parameter in Tags[ *N* ]: *Value* \".",
6068060680
"properties": {
60681-
"AcceptLanguage": "The language code.\n\n- `en` - English (default)\n- `jp` - Japanese\n- `zh` - Chinese",
60681+
"AcceptLanguage": "The language code.\n\n- `jp` - Japanese\n- `zh` - Chinese",
6068260682
"NotificationArns": "Passed to AWS CloudFormation . The SNS topic ARNs to which to publish stack-related events.",
6068360683
"PathId": "The path identifier of the product. This value is optional if the product has a default path, and required if the product has more than one path. To list the paths for a product, use [ListLaunchPaths](https://docs.aws.amazon.com/servicecatalog/latest/dg/API_ListLaunchPaths.html) .\n\n> You must provide the name or ID, but not both.",
6068460684
"PathName": "The name of the path. This value is optional if the product has a default path, and required if the product has more than one path. To list the paths for a product, use [ListLaunchPaths](https://docs.aws.amazon.com/servicecatalog/latest/dg/API_ListLaunchPaths.html) .\n\n> You must provide the name or ID, but not both.",
@@ -60719,7 +60719,7 @@
6071960719
},
6072060720
"description": "Specifies a notification constraint.",
6072160721
"properties": {
60722-
"AcceptLanguage": "The language code.\n\n- `en` - English (default)\n- `jp` - Japanese\n- `zh` - Chinese",
60722+
"AcceptLanguage": "The language code.\n\n- `jp` - Japanese\n- `zh` - Chinese",
6072360723
"Description": "The description of the constraint.",
6072460724
"NotificationArns": "The notification ARNs.",
6072560725
"PortfolioId": "The portfolio identifier.",
@@ -60732,7 +60732,7 @@
6073260732
},
6073360733
"description": "Specifies a launch constraint.",
6073460734
"properties": {
60735-
"AcceptLanguage": "The language code.\n\n- `en` - English (default)\n- `jp` - Japanese\n- `zh` - Chinese",
60735+
"AcceptLanguage": "The language code.\n\n- `jp` - Japanese\n- `zh` - Chinese",
6073660736
"Description": "The description of the constraint.",
6073760737
"LocalRoleName": "You are required to specify either the `RoleArn` or the `LocalRoleName` but can't use both.\n\nIf you specify the `LocalRoleName` property, when an account uses the launch constraint, the IAM role with that name in the account will be used. This allows launch-role constraints to be account-agnostic so the administrator can create fewer resources per shared account.\n\nThe given role name must exist in the account used to create the launch constraint and the account of the user who launches a product with this launch constraint.",
6073860738
"PortfolioId": "The portfolio identifier.",
@@ -60746,7 +60746,7 @@
6074660746
},
6074760747
"description": "Specifies a template constraint.",
6074860748
"properties": {
60749-
"AcceptLanguage": "The language code.\n\n- `en` - English (default)\n- `jp` - Japanese\n- `zh` - Chinese",
60749+
"AcceptLanguage": "The language code.\n\n- `jp` - Japanese\n- `zh` - Chinese",
6075060750
"Description": "The description of the constraint.",
6075160751
"PortfolioId": "The portfolio identifier.",
6075260752
"ProductId": "The product identifier.",
@@ -60760,7 +60760,7 @@
6076060760
},
6076160761
"description": "Specifies a portfolio.",
6076260762
"properties": {
60763-
"AcceptLanguage": "The language code.\n\n- `en` - English (default)\n- `jp` - Japanese\n- `zh` - Chinese",
60763+
"AcceptLanguage": "The language code.\n\n- `jp` - Japanese\n- `zh` - Chinese",
6076460764
"Description": "The description of the portfolio.",
6076560765
"DisplayName": "The name to use for display purposes.",
6076660766
"ProviderName": "The name of the portfolio provider.",
@@ -60773,7 +60773,7 @@
6077360773
},
6077460774
"description": "Associates the specified principal ARN with the specified portfolio.",
6077560775
"properties": {
60776-
"AcceptLanguage": "The language code.\n\n- `en` - English (default)\n- `jp` - Japanese\n- `zh` - Chinese",
60776+
"AcceptLanguage": "The language code.\n\n- `jp` - Japanese\n- `zh` - Chinese",
6077760777
"PortfolioId": "The portfolio identifier.",
6077860778
"PrincipalARN": "The ARN of the principal ( IAM user, role, or group).",
6077960779
"PrincipalType": "The principal type. The supported value is `IAM` .\n\n*Allowed Values* : `IAM`"
@@ -60785,7 +60785,7 @@
6078560785
},
6078660786
"description": "Associates the specified product with the specified portfolio.\n\nA delegated admin is authorized to invoke this command.",
6078760787
"properties": {
60788-
"AcceptLanguage": "The language code.\n\n- `en` - English (default)\n- `jp` - Japanese\n- `zh` - Chinese",
60788+
"AcceptLanguage": "The language code.\n\n- `jp` - Japanese\n- `zh` - Chinese",
6078960789
"PortfolioId": "The portfolio identifier.",
6079060790
"ProductId": "The product identifier.",
6079160791
"SourcePortfolioId": "The identifier of the source portfolio."
@@ -60797,7 +60797,7 @@
6079760797
},
6079860798
"description": "Shares the specified portfolio with the specified account.",
6079960799
"properties": {
60800-
"AcceptLanguage": "The language code.\n\n- `en` - English (default)\n- `jp` - Japanese\n- `zh` - Chinese",
60800+
"AcceptLanguage": "The language code.\n\n- `jp` - Japanese\n- `zh` - Chinese",
6080160801
"AccountId": "The AWS account ID. For example, `123456789012` .",
6080260802
"PortfolioId": "The portfolio identifier.",
6080360803
"ShareTagOptions": "Indicates whether TagOptions sharing is enabled or disabled for the portfolio share."
@@ -60809,7 +60809,7 @@
6080960809
},
6081060810
"description": "Specifies a `RESOURCE_UPDATE` constraint.",
6081160811
"properties": {
60812-
"AcceptLanguage": "The language code.\n\n- `en` - English (default)\n- `jp` - Japanese\n- `zh` - Chinese",
60812+
"AcceptLanguage": "The language code.\n\n- `jp` - Japanese\n- `zh` - Chinese",
6081360813
"Description": "The description of the constraint.",
6081460814
"PortfolioId": "The portfolio identifier.",
6081560815
"ProductId": "The product identifier.",
@@ -60855,7 +60855,7 @@
6085560855
},
6085660856
"description": "Specifies a StackSet constraint.",
6085760857
"properties": {
60858-
"AcceptLanguage": "The language code.\n\n- `en` - English (default)\n- `jp` - Japanese\n- `zh` - Chinese",
60858+
"AcceptLanguage": "The language code.\n\n- `jp` - Japanese\n- `zh` - Chinese",
6085960859
"AccountList": "One or more AWS accounts that will have access to the provisioned product.",
6086060860
"AdminRole": "AdminRole ARN",
6086160861
"Description": "The description of the constraint.",

0 commit comments

Comments
 (0)