@propulsionworks/cloudformation 0.1.0 → 0.1.2

package/out/exports/resources.generated/aws-sso-instance.d.ts

@@ -1,4 +1,13 @@
 import type { ResourceDefinitionWithAttributes, Tag } from "../main.ts";
+/**
+ * Creates an instance of IAM Identity Center for a standalone AWS account that is not managed by AWS Organizations or a member AWS account in an organization. You can create only one instance per account and across all AWS Regions .
+ *
+ * The CreateInstance request is rejected if the following apply:
+ *
+ * - The instance is created within the organization management account.
+ * - An instance already exists in the same account.
+ * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sso-instance.html}
+ */
 export type SSOInstance = ResourceDefinitionWithAttributes<"AWS::SSO::Instance", SSOInstanceProps, SSOInstanceAttribs>;
 /**
  * Creates an instance of IAM Identity Center for a standalone AWS account that is not managed by AWS Organizations or a member AWS account in an organization. You can create only one instance per account and across all AWS Regions .
@@ -7,6 +16,7 @@ export type SSOInstance = ResourceDefinitionWithAttributes<"AWS::SSO::Instance",
  *
  * - The instance is created within the organization management account.
  * - An instance already exists in the same account.
+ * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sso-instance.html}
  */
 export type SSOInstanceProps = {
     /**
@@ -14,19 +24,25 @@ export type SSOInstanceProps = {
      * @minLength 1
      * @maxLength 32
      * @pattern ^[\w+=,.@-]+$
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sso-instance.html#cfn-sso-instance-name}
      */
     Name?: string | undefined;
     /**
      * Specifies tags to be attached to the instance of IAM Identity Center.
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sso-instance.html#cfn-sso-instance-tags}
      */
     Tags?: Tag[] | undefined;
 };
+/**
+ * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sso-instance.html#aws-resource-sso-instance-return-values}
+ */
 export type SSOInstanceAttribs = {
     /**
      * The identifier of the identity store that is connected to the Identity Center instance.
      * @minLength 1
      * @maxLength 64
      * @pattern ^[a-zA-Z0-9-]*$
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sso-instance.html#cfn-sso-instance-identitystoreid}
      */
     IdentityStoreId: string;
     /**
@@ -35,6 +51,7 @@ export type SSOInstanceAttribs = {
      * @minLength 10
      * @maxLength 1224
      * @pattern ^arn:(aws|aws-us-gov|aws-cn|aws-iso|aws-iso-b):sso:::instance/(sso)?ins-[a-zA-Z0-9-.]{16}$
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sso-instance.html#cfn-sso-instance-instancearn}
      */
     InstanceArn: string;
     /**
@@ -42,10 +59,12 @@ export type SSOInstanceAttribs = {
      * @minLength 12
      * @maxLength 12
      * @pattern ^\d{12}?$
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sso-instance.html#cfn-sso-instance-owneraccountid}
      */
     OwnerAccountId: string;
     /**
      * The current status of this Identity Center instance.
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sso-instance.html#cfn-sso-instance-status}
      */
     Status: "CREATE_IN_PROGRESS" | "DELETE_IN_PROGRESS" | "ACTIVE";
 };

package/out/exports/resources.generated/aws-sso-instanceaccesscontrolattributeconfiguration.d.ts

@@ -1,17 +1,26 @@
 import type { ResourceDefinition } from "../main.ts";
+/**
+ * Enables the attribute-based access control (ABAC) feature for the specified IAM Identity Center instance. You can also specify new attributes to add to your ABAC configuration during the enabling process. For more information about ABAC, see [Attribute-Based Access Control](https://docs.aws.amazon.com//singlesignon/latest/userguide/abac.html) in the *IAM Identity Center User Guide* .
+ *
+ * > The `InstanceAccessControlAttributeConfiguration` property has been deprecated but is still supported for backwards compatibility purposes. We recommend that you use the `AccessControlAttributes` property instead.
+ * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sso-instanceaccesscontrolattributeconfiguration.html}
+ */
 export type SSOInstanceAccessControlAttributeConfiguration = ResourceDefinition<"AWS::SSO::InstanceAccessControlAttributeConfiguration", SSOInstanceAccessControlAttributeConfigurationProps>;
 /**
  * Enables the attribute-based access control (ABAC) feature for the specified IAM Identity Center instance. You can also specify new attributes to add to your ABAC configuration during the enabling process. For more information about ABAC, see [Attribute-Based Access Control](https://docs.aws.amazon.com//singlesignon/latest/userguide/abac.html) in the *IAM Identity Center User Guide* .
  *
  * > The `InstanceAccessControlAttributeConfiguration` property has been deprecated but is still supported for backwards compatibility purposes. We recommend that you use the `AccessControlAttributes` property instead.
+ * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sso-instanceaccesscontrolattributeconfiguration.html}
  */
 export type SSOInstanceAccessControlAttributeConfigurationProps = {
     /**
      * Lists the attributes that are configured for ABAC in the specified IAM Identity Center instance.
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sso-instanceaccesscontrolattributeconfiguration.html#cfn-sso-instanceaccesscontrolattributeconfiguration-accesscontrolattributes}
      */
     AccessControlAttributes?: AccessControlAttribute[] | undefined;
     /**
      * The InstanceAccessControlAttributeConfiguration property has been deprecated but is still supported for backwards compatibility purposes. We recomend that you use  AccessControlAttributes property instead.
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sso-instanceaccesscontrolattributeconfiguration.html#cfn-sso-instanceaccesscontrolattributeconfiguration-instanceaccesscontrolattributeconfiguration}
      */
     InstanceAccessControlAttributeConfiguration?: {
         AccessControlAttributes: AccessControlAttribute[];
@@ -21,11 +30,13 @@ export type SSOInstanceAccessControlAttributeConfigurationProps = {
      * @minLength 10
      * @maxLength 1224
      * @pattern arn:(aws|aws-us-gov|aws-cn|aws-iso|aws-iso-b):sso:::instance/(sso)?ins-[a-zA-Z0-9-.]{16}
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sso-instanceaccesscontrolattributeconfiguration.html#cfn-sso-instanceaccesscontrolattributeconfiguration-instancearn}
      */
     InstanceArn: string;
 };
 /**
  * These are IAM Identity Center identity store attributes that you can configure for use in attributes-based access control (ABAC). You can create permissions policies that determine who can access your AWS resources based upon the configured attribute values. When you enable ABAC and specify `AccessControlAttributes` , IAM Identity Center passes the attribute values of the authenticated user into IAM for use in policy evaluation.
+ * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sso-instanceaccesscontrolattributeconfiguration-accesscontrolattribute.html}
  */
 export type AccessControlAttribute = {
     /**
@@ -33,19 +44,23 @@ export type AccessControlAttribute = {
      * @minLength 1
      * @maxLength 128
      * @pattern [\p{L}\p{Z}\p{N}_.:\/=+\-@]+
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sso-instanceaccesscontrolattributeconfiguration-accesscontrolattribute.html#cfn-sso-instanceaccesscontrolattributeconfiguration-accesscontrolattribute-key}
      */
     Key: string;
     /**
      * The value used for mapping a specified attribute to an identity source.
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sso-instanceaccesscontrolattributeconfiguration-accesscontrolattribute.html#cfn-sso-instanceaccesscontrolattributeconfiguration-accesscontrolattribute-value}
      */
     Value: AccessControlAttributeValue;
 };
 /**
  * The value used for mapping a specified attribute to an identity source.
+ * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sso-instanceaccesscontrolattributeconfiguration-accesscontrolattributevalue.html}
  */
 export type AccessControlAttributeValue = {
     /**
      * The identity source to use when mapping a specified attribute to IAM Identity Center .
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sso-instanceaccesscontrolattributeconfiguration-accesscontrolattributevalue.html#cfn-sso-instanceaccesscontrolattributeconfiguration-accesscontrolattributevalue-source}
      */
     Source: string[];
 };

package/out/exports/resources.generated/aws-sso-permissionset.d.ts

@@ -1,12 +1,18 @@
 import type { ResourceDefinitionWithAttributes, TemplatePolicyDocument, Tag } from "../main.ts";
+/**
+ * Specifies a permission set within a specified IAM Identity Center instance.
+ * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sso-permissionset.html}
+ */
 export type SSOPermissionSet = ResourceDefinitionWithAttributes<"AWS::SSO::PermissionSet", SSOPermissionSetProps, SSOPermissionSetAttribs>;
 /**
  * Specifies a permission set within a specified IAM Identity Center instance.
+ * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sso-permissionset.html}
  */
 export type SSOPermissionSetProps = {
     /**
      * Specifies the names and paths of the customer managed policies that you have attached to your permission set.
      * @default []
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sso-permissionset.html#cfn-sso-permissionset-customermanagedpolicyreferences}
      */
     CustomerManagedPolicyReferences?: CustomerManagedPolicyReference[] | undefined;
     /**
@@ -14,13 +20,14 @@ export type SSOPermissionSetProps = {
      * @minLength 1
      * @maxLength 700
      * @pattern [\u0009\u000A\u000D\u0020-\u007E\u00A1-\u00FF]*
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sso-permissionset.html#cfn-sso-permissionset-description}
      */
     Description?: string | undefined;
     /**
      * The inline policy that is attached to the permission set.
      *
      * > For `Length Constraints` , if a valid ARN is provided for a permission set, it is possible for an empty inline policy to be returned.
-     * @policy
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sso-permissionset.html#cfn-sso-permissionset-inlinepolicy}
      */
     InlinePolicy?: TemplatePolicyDocument | undefined;
     /**
@@ -28,11 +35,13 @@ export type SSOPermissionSetProps = {
      * @minLength 10
      * @maxLength 1224
      * @pattern arn:(aws|aws-us-gov|aws-cn|aws-iso|aws-iso-b):sso:::instance/(sso)?ins-[a-zA-Z0-9-.]{16}
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sso-permissionset.html#cfn-sso-permissionset-instancearn}
      */
     InstanceArn: string;
     /**
      * A structure that stores a list of managed policy ARNs that describe the associated AWS managed policy.
      * @default []
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sso-permissionset.html#cfn-sso-permissionset-managedpolicies}
      */
     ManagedPolicies?: string[] | undefined;
     /**
@@ -40,12 +49,14 @@ export type SSOPermissionSetProps = {
      * @minLength 1
      * @maxLength 32
      * @pattern [\w+=,.@-]+
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sso-permissionset.html#cfn-sso-permissionset-name}
      */
     Name: string;
     /**
      * Specifies the configuration of the AWS managed or customer managed policy that you want to set as a permissions boundary. Specify either `CustomerManagedPolicyReference` to use the name and path of a customer managed policy, or `ManagedPolicyArn` to use the ARN of an AWS managed policy. A permissions boundary represents the maximum permissions that any policy can grant your role. For more information, see [Permissions boundaries for IAM entities](https://docs.aws.amazon.com/IAM/latest/UserGuide/access_policies_boundaries.html) in the *IAM User Guide* .
      *
      * > Policies used as permissions boundaries don't provide permissions. You must also attach an IAM policy to the role. To learn how the effective permissions for a role are evaluated, see [IAM JSON policy evaluation logic](https://docs.aws.amazon.com/IAM/latest/UserGuide/reference_policies_evaluation-logic.html) in the *IAM User Guide* .
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sso-permissionset.html#cfn-sso-permissionset-permissionsboundary}
      */
     PermissionsBoundary?: PermissionsBoundary | undefined;
     /**
@@ -53,6 +64,7 @@ export type SSOPermissionSetProps = {
      * @minLength 1
      * @maxLength 240
      * @pattern [a-zA-Z0-9&amp;$@#\/%?=~\-_'&quot;|!:,.;*+\[\]\ \(\)\{\}]+
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sso-permissionset.html#cfn-sso-permissionset-relaystatetype}
      */
     RelayStateType?: string | undefined;
     /**
@@ -60,24 +72,31 @@ export type SSOPermissionSetProps = {
      * @minLength 1
      * @maxLength 100
      * @pattern ^(-?)P(?=\d|T\d)(?:(\d+)Y)?(?:(\d+)M)?(?:(\d+)([DW]))?(?:T(?:(\d+)H)?(?:(\d+)M)?(?:(\d+(?:\.\d+)?)S)?)?$
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sso-permissionset.html#cfn-sso-permissionset-sessionduration}
      */
     SessionDuration?: string | undefined;
     /**
      * The tags to attach to the new `PermissionSet` .
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sso-permissionset.html#cfn-sso-permissionset-tags}
      */
     Tags?: Tag[] | undefined;
 };
+/**
+ * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sso-permissionset.html#aws-resource-sso-permissionset-return-values}
+ */
 export type SSOPermissionSetAttribs = {
     /**
      * The permission set ARN of the permission set, such as `arn:aws:sso:::permissionSet/ins-instanceid/ps-permissionsetid` .
      * @minLength 10
      * @maxLength 1224
      * @pattern arn:(aws|aws-us-gov|aws-cn|aws-iso|aws-iso-b):sso:::permissionSet/(sso)?ins-[a-zA-Z0-9-.]{16}/ps-[a-zA-Z0-9-./]{16}
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sso-permissionset.html#cfn-sso-permissionset-permissionsetarn}
      */
     PermissionSetArn: string;
 };
 /**
  * Specifies the name and path of a customer managed policy. You must have an IAM policy that matches the name and path in each AWS account where you want to deploy your permission set.
+ * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sso-permissionset-customermanagedpolicyreference.html}
  */
 export type CustomerManagedPolicyReference = {
     /**
@@ -85,6 +104,7 @@ export type CustomerManagedPolicyReference = {
      * @minLength 1
      * @maxLength 128
      * @pattern [\w+=,.@-]+
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sso-permissionset-customermanagedpolicyreference.html#cfn-sso-permissionset-customermanagedpolicyreference-name}
      */
     Name: string;
     /**
@@ -92,6 +112,7 @@ export type CustomerManagedPolicyReference = {
      * @minLength 1
      * @maxLength 512
      * @pattern ((/[A-Za-z0-9\.,\+@=_-]+)*)/
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sso-permissionset-customermanagedpolicyreference.html#cfn-sso-permissionset-customermanagedpolicyreference-path}
      */
     Path?: string | undefined;
 };
@@ -99,14 +120,17 @@ export type CustomerManagedPolicyReference = {
  * Specifies the configuration of the AWS managed or customer managed policy that you want to set as a permissions boundary. Specify either `CustomerManagedPolicyReference` to use the name and path of a customer managed policy, or `ManagedPolicyArn` to use the ARN of an AWS managed policy. A permissions boundary represents the maximum permissions that any policy can grant your role. For more information, see [Permissions boundaries for IAM entities](https://docs.aws.amazon.com/IAM/latest/UserGuide/access_policies_boundaries.html) in the *IAM User Guide* .
  *
  * > Policies used as permissions boundaries don't provide permissions. You must also attach an IAM policy to the role. To learn how the effective permissions for a role are evaluated, see [IAM JSON policy evaluation logic](https://docs.aws.amazon.com/IAM/latest/UserGuide/reference_policies_evaluation-logic.html) in the *IAM User Guide* .
+ * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sso-permissionset-permissionsboundary.html}
  */
 export type PermissionsBoundary = {
     /**
      * Specifies the name and path of a customer managed policy. You must have an IAM policy that matches the name and path in each AWS account where you want to deploy your permission set.
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sso-permissionset-permissionsboundary.html#cfn-sso-permissionset-permissionsboundary-customermanagedpolicyreference}
      */
     CustomerManagedPolicyReference?: CustomerManagedPolicyReference | undefined;
     /**
      * The AWS managed policy ARN that you want to attach to a permission set as a permissions boundary.
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sso-permissionset-permissionsboundary.html#cfn-sso-permissionset-permissionsboundary-managedpolicyarn}
      */
     ManagedPolicyArn?: string | undefined;
 };

package/out/exports/resources.generated/aws-stepfunctions-activity.d.ts

@@ -1,9 +1,16 @@
 import type { ResourceDefinitionWithAttributes } from "../main.ts";
+/**
+ * An activity is a task that you write in any programming language and host on any machine that has access to AWS Step Functions . Activities must poll Step Functions using the `GetActivityTask` API action and respond using `SendTask*` API actions. This function makes Step Functions aware of your activity and returns an identifier for use in a state machine and when polling from the activity.
+ *
+ * For information about creating an activity, see [Creating an Activity State Machine](https://docs.aws.amazon.com/step-functions/latest/dg/tutorial-creating-activity-state-machine.html) in the *AWS Step Functions Developer Guide* and [CreateActivity](https://docs.aws.amazon.com/step-functions/latest/apireference/API_CreateActivity.html) in the *AWS Step Functions API Reference* .
+ * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-stepfunctions-activity.html}
+ */
 export type StepFunctionsActivity = ResourceDefinitionWithAttributes<"AWS::StepFunctions::Activity", StepFunctionsActivityProps, StepFunctionsActivityAttribs>;
 /**
  * An activity is a task that you write in any programming language and host on any machine that has access to AWS Step Functions . Activities must poll Step Functions using the `GetActivityTask` API action and respond using `SendTask*` API actions. This function makes Step Functions aware of your activity and returns an identifier for use in a state machine and when polling from the activity.
  *
  * For information about creating an activity, see [Creating an Activity State Machine](https://docs.aws.amazon.com/step-functions/latest/dg/tutorial-creating-activity-state-machine.html) in the *AWS Step Functions Developer Guide* and [CreateActivity](https://docs.aws.amazon.com/step-functions/latest/apireference/API_CreateActivity.html) in the *AWS Step Functions API Reference* .
+ * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-stepfunctions-activity.html}
  */
 export type StepFunctionsActivityProps = {
     /**
@@ -12,6 +19,7 @@ export type StepFunctionsActivityProps = {
      * Activity configuration is immutable, and resource names must be unique. To set customer managed keys for encryption, you must create a *new Activity* . If you attempt to change the configuration in your CFN template for an existing activity, you will receive an `ActivityAlreadyExists` exception.
      *
      * To update your activity to include customer managed keys, set a new activity name within your AWS CloudFormation template.
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-stepfunctions-activity.html#cfn-stepfunctions-activity-encryptionconfiguration}
      */
     EncryptionConfiguration?: EncryptionConfiguration | undefined;
     /**
@@ -30,20 +38,26 @@ export type StepFunctionsActivityProps = {
      * To enable logging with CloudWatch Logs, the name should only contain 0-9, A-Z, a-z, - and _.
      * @minLength 1
      * @maxLength 80
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-stepfunctions-activity.html#cfn-stepfunctions-activity-name}
      */
     Name: string;
     /**
      * The list of tags to add to a resource.
      *
      * Tags may only contain Unicode letters, digits, white space, or these symbols: `_ . : / = + - @` .
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-stepfunctions-activity.html#cfn-stepfunctions-activity-tags}
      */
     Tags?: TagsEntry[] | undefined;
 };
+/**
+ * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-stepfunctions-activity.html#aws-resource-stepfunctions-activity-return-values}
+ */
 export type StepFunctionsActivityAttribs = {
     /**
      * Returns the ARN of the resource.
      * @minLength 1
      * @maxLength 2048
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-stepfunctions-activity.html#cfn-stepfunctions-activity-arn}
      */
     Arn: string;
     /**
@@ -58,44 +72,52 @@ export type StepFunctionsActivityAttribs = {
      * For more information about using `Fn::GetAtt` , see [Fn::GetAtt](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/intrinsic-function-reference-getatt.html) .
      * @minLength 1
      * @maxLength 80
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-stepfunctions-activity.html#cfn-stepfunctions-activity-name}
      */
     Name: string;
 };
 /**
  * Settings to configure server-side encryption for an activity. By default, Step Functions provides transparent server-side encryption. With this configuration, you can specify a customer managed AWS KMS key for encryption.
+ * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-stepfunctions-activity-encryptionconfiguration.html}
  */
 export type EncryptionConfiguration = {
     /**
      * Maximum duration that Step Functions will reuse data keys. When the period expires, Step Functions will call `GenerateDataKey` . Only applies to customer managed keys.
      * @min 60
      * @max 900
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-stepfunctions-activity-encryptionconfiguration.html#cfn-stepfunctions-activity-encryptionconfiguration-kmsdatakeyreuseperiodseconds}
      */
     KmsDataKeyReusePeriodSeconds?: number | undefined;
     /**
      * An alias, alias ARN, key ID, or key ARN of a symmetric encryption AWS KMS key to encrypt data. To specify a AWS KMS key in a different AWS account, you must use the key ARN or alias ARN.
      * @minLength 1
      * @maxLength 2048
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-stepfunctions-activity-encryptionconfiguration.html#cfn-stepfunctions-activity-encryptionconfiguration-kmskeyid}
      */
     KmsKeyId?: string | undefined;
     /**
      * Encryption option for an activity.
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-stepfunctions-activity-encryptionconfiguration.html#cfn-stepfunctions-activity-encryptionconfiguration-type}
      */
     Type: "CUSTOMER_MANAGED_KMS_KEY" | "AWS_OWNED_KEY";
 };
 /**
  * The `TagsEntry` property specifies *tags* to identify an activity.
+ * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-stepfunctions-activity-tagsentry.html}
  */
 export type TagsEntry = {
     /**
      * The `key` for a key-value pair in a tag entry.
      * @minLength 1
      * @maxLength 128
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-stepfunctions-activity-tagsentry.html#cfn-stepfunctions-activity-tagsentry-key}
      */
     Key: string;
     /**
      * The `value` for a key-value pair in a tag entry.
      * @minLength 1
      * @maxLength 256
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-stepfunctions-activity-tagsentry.html#cfn-stepfunctions-activity-tagsentry-value}
      */
     Value: string;
 };

package/out/exports/resources.generated/aws-stepfunctions-statemachine.d.ts

@@ -1,43 +1,55 @@
 import type { ResourceDefinitionWithAttributes } from "../main.ts";
+/**
+ * Provisions a state machine. A state machine consists of a collection of states that can do work ( `Task` states), determine to which states to transition next ( `Choice` states), stop an execution with an error ( `Fail` states), and so on. State machines are specified using a JSON-based, structured language.
+ * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-stepfunctions-statemachine.html}
+ */
 export type StepFunctionsStateMachine = ResourceDefinitionWithAttributes<"AWS::StepFunctions::StateMachine", StepFunctionsStateMachineProps, StepFunctionsStateMachineAttribs>;
 /**
  * Provisions a state machine. A state machine consists of a collection of states that can do work ( `Task` states), determine to which states to transition next ( `Choice` states), stop an execution with an error ( `Fail` states), and so on. State machines are specified using a JSON-based, structured language.
+ * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-stepfunctions-statemachine.html}
  */
 export type StepFunctionsStateMachineProps = {
     /**
      * The Amazon States Language definition of the state machine. The state machine definition must be in JSON or YAML, and the format of the object must match the format of your CloudFormation template file. See [Amazon States Language](https://docs.aws.amazon.com/step-functions/latest/dg/concepts-amazon-states-language.html) .
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-stepfunctions-statemachine.html#cfn-stepfunctions-statemachine-definition}
      */
     Definition?: Record<string, unknown> | undefined;
     /**
      * The name of the S3 bucket where the state machine definition is stored. The state machine definition must be a JSON or YAML file.
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-stepfunctions-statemachine.html#cfn-stepfunctions-statemachine-definitions3location}
      */
     DefinitionS3Location?: S3Location | undefined;
     /**
      * The Amazon States Language definition of the state machine. The state machine definition must be in JSON. See [Amazon States Language](https://docs.aws.amazon.com/step-functions/latest/dg/concepts-amazon-states-language.html) .
      * @minLength 1
      * @maxLength 1048576
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-stepfunctions-statemachine.html#cfn-stepfunctions-statemachine-definitionstring}
      */
     DefinitionString?: string | undefined;
     /**
      * A map (string to string) that specifies the mappings for placeholder variables in the state machine definition. This enables the customer to inject values obtained at runtime, for example from intrinsic functions, in the state machine definition. Variables can be template parameter names, resource logical IDs, resource attributes, or a variable in a key-value map.
      *
      * Substitutions must follow the syntax: `${key_name}` or `${variable_1,variable_2,...}` .
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-stepfunctions-statemachine.html#cfn-stepfunctions-statemachine-definitionsubstitutions}
      */
     DefinitionSubstitutions?: Record<string, string | number | boolean> | undefined;
     /**
      * Encryption configuration for the state machine.
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-stepfunctions-statemachine.html#cfn-stepfunctions-statemachine-encryptionconfiguration}
      */
     EncryptionConfiguration?: EncryptionConfiguration | undefined;
     /**
      * Defines what execution history events are logged and where they are logged.
      *
      * > By default, the `level` is set to `OFF` . For more information see [Log Levels](https://docs.aws.amazon.com/step-functions/latest/dg/cloudwatch-log-level.html) in the AWS Step Functions User Guide.
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-stepfunctions-statemachine.html#cfn-stepfunctions-statemachine-loggingconfiguration}
      */
     LoggingConfiguration?: LoggingConfiguration | undefined;
     /**
      * The Amazon Resource Name (ARN) of the IAM role to use for this state machine.
      * @minLength 1
      * @maxLength 256
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-stepfunctions-statemachine.html#cfn-stepfunctions-statemachine-rolearn}
      */
     RoleArn: string;
     /**
@@ -54,28 +66,36 @@ export type StepFunctionsStateMachineProps = {
      * > If you specify a name, you cannot perform updates that require replacement of this resource. You can perform updates that require no or some interruption. If you must replace the resource, specify a new name.
      * @minLength 1
      * @maxLength 80
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-stepfunctions-statemachine.html#cfn-stepfunctions-statemachine-statemachinename}
      */
     StateMachineName?: string | undefined;
     /**
      * Determines whether a `STANDARD` or `EXPRESS` state machine is created. The default is `STANDARD` . You cannot update the `type` of a state machine once it has been created. For more information on `STANDARD` and `EXPRESS` workflows, see [Standard Versus Express Workflows](https://docs.aws.amazon.com/step-functions/latest/dg/concepts-standard-vs-express.html) in the AWS Step Functions Developer Guide.
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-stepfunctions-statemachine.html#cfn-stepfunctions-statemachine-statemachinetype}
      */
     StateMachineType?: "STANDARD" | "EXPRESS" | undefined;
     /**
      * The list of tags to add to a resource.
      *
      * Tags may only contain Unicode letters, digits, white space, or these symbols: `_ . : / = + - @` .
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-stepfunctions-statemachine.html#cfn-stepfunctions-statemachine-tags}
      */
     Tags?: TagsEntry[] | undefined;
     /**
      * Selects whether or not the state machine's AWS X-Ray tracing is enabled.
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-stepfunctions-statemachine.html#cfn-stepfunctions-statemachine-tracingconfiguration}
      */
     TracingConfiguration?: TracingConfiguration | undefined;
 };
+/**
+ * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-stepfunctions-statemachine.html#aws-resource-stepfunctions-statemachine-return-values}
+ */
 export type StepFunctionsStateMachineAttribs = {
     /**
      * Returns the ARN of the resource.
      * @minLength 1
      * @maxLength 2048
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-stepfunctions-statemachine.html#cfn-stepfunctions-statemachine-arn}
      */
     Arn: string;
     /**
@@ -94,12 +114,14 @@ export type StepFunctionsStateMachineAttribs = {
      * For more information about using `Fn::GetAtt` , see [Fn::GetAtt](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/intrinsic-function-reference-getatt.html) .
      * @minLength 1
      * @maxLength 80
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-stepfunctions-statemachine.html#cfn-stepfunctions-statemachine-name}
      */
     Name: string;
     /**
      * Identifier for a state machine revision, which is an immutable, read-only snapshot of a state machine’s definition and configuration.
      * @minLength 1
      * @maxLength 256
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-stepfunctions-statemachine.html#cfn-stepfunctions-statemachine-statemachinerevisionid}
      */
     StateMachineRevisionId: string;
 };
@@ -107,33 +129,39 @@ export type StepFunctionsStateMachineAttribs = {
  * Defines a CloudWatch log group.
  *
  * > For more information see [Standard Versus Express Workflows](https://docs.aws.amazon.com/step-functions/latest/dg/concepts-standard-vs-express.html) in the AWS Step Functions Developer Guide.
+ * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-stepfunctions-statemachine-cloudwatchlogsloggroup.html}
  */
 export type CloudWatchLogsLogGroup = {
     /**
      * The ARN of the the CloudWatch log group to which you want your logs emitted to. The ARN must end with `:*`
      * @minLength 1
      * @maxLength 256
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-stepfunctions-statemachine-cloudwatchlogsloggroup.html#cfn-stepfunctions-statemachine-cloudwatchlogsloggroup-loggrouparn}
      */
     LogGroupArn?: string | undefined;
 };
 /**
  * Settings to configure server-side encryption for a state machine. By default, Step Functions provides transparent server-side encryption. With this configuration, you can specify a customer managed AWS KMS key for encryption.
+ * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-stepfunctions-statemachine-encryptionconfiguration.html}
  */
 export type EncryptionConfiguration = {
     /**
      * Maximum duration that Step Functions will reuse data keys. When the period expires, Step Functions will call `GenerateDataKey` . Only applies to customer managed keys.
      * @min 60
      * @max 900
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-stepfunctions-statemachine-encryptionconfiguration.html#cfn-stepfunctions-statemachine-encryptionconfiguration-kmsdatakeyreuseperiodseconds}
      */
     KmsDataKeyReusePeriodSeconds?: number | undefined;
     /**
      * An alias, alias ARN, key ID, or key ARN of a symmetric encryption AWS KMS key to encrypt data. To specify a AWS KMS key in a different AWS account, you must use the key ARN or alias ARN.
      * @minLength 1
      * @maxLength 2048
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-stepfunctions-statemachine-encryptionconfiguration.html#cfn-stepfunctions-statemachine-encryptionconfiguration-kmskeyid}
      */
     KmsKeyId?: string | undefined;
     /**
      * Encryption option for a state machine.
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-stepfunctions-statemachine-encryptionconfiguration.html#cfn-stepfunctions-statemachine-encryptionconfiguration-type}
      */
     Type: "CUSTOMER_MANAGED_KMS_KEY" | "AWS_OWNED_KEY";
 };
@@ -141,10 +169,12 @@ export type EncryptionConfiguration = {
  * Defines a destination for `LoggingConfiguration` .
  *
  * > For more information on logging with `EXPRESS` workflows, see [Logging Express Workflows Using CloudWatch Logs](https://docs.aws.amazon.com/step-functions/latest/dg/cw-logs.html) .
+ * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-stepfunctions-statemachine-logdestination.html}
  */
 export type LogDestination = {
     /**
      * An object describing a CloudWatch log group. For more information, see [AWS::Logs::LogGroup](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-logs-loggroup.html) in the AWS CloudFormation User Guide.
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-stepfunctions-statemachine-logdestination.html#cfn-stepfunctions-statemachine-logdestination-cloudwatchlogsloggroup}
      */
     CloudWatchLogsLogGroup?: CloudWatchLogsLogGroup | undefined;
 };
@@ -154,61 +184,74 @@ export type LogDestination = {
  * Step Functions provides the log levels — `OFF` , `ALL` , `ERROR` , and `FATAL` . No event types log when set to `OFF` and all event types do when set to `ALL` .
  *
  * > By default, the `level` is set to `OFF` . For more information see [Log Levels](https://docs.aws.amazon.com/step-functions/latest/dg/cloudwatch-log-level.html) in the AWS Step Functions User Guide.
+ * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-stepfunctions-statemachine-loggingconfiguration.html}
  */
 export type LoggingConfiguration = {
     /**
      * An array of objects that describes where your execution history events will be logged. Limited to size 1. Required, if your log level is not set to `OFF` .
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-stepfunctions-statemachine-loggingconfiguration.html#cfn-stepfunctions-statemachine-loggingconfiguration-destinations}
      */
     Destinations?: LogDestination[] | undefined;
     /**
      * Determines whether execution data is included in your log. When set to `false` , data is excluded.
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-stepfunctions-statemachine-loggingconfiguration.html#cfn-stepfunctions-statemachine-loggingconfiguration-includeexecutiondata}
      */
     IncludeExecutionData?: boolean | undefined;
     /**
      * Defines which category of execution history events are logged.
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-stepfunctions-statemachine-loggingconfiguration.html#cfn-stepfunctions-statemachine-loggingconfiguration-level}
      */
     Level?: "ALL" | "ERROR" | "FATAL" | "OFF" | undefined;
 };
 /**
  * Defines the S3 bucket location where a state machine definition is stored. The state machine definition must be a JSON or YAML file.
+ * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-stepfunctions-statemachine-s3location.html}
  */
 export type S3Location = {
     /**
      * The name of the S3 bucket where the state machine definition JSON or YAML file is stored.
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-stepfunctions-statemachine-s3location.html#cfn-stepfunctions-statemachine-s3location-bucket}
      */
     Bucket: string;
     /**
      * The name of the state machine definition file (Amazon S3 object name).
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-stepfunctions-statemachine-s3location.html#cfn-stepfunctions-statemachine-s3location-key}
      */
     Key: string;
     /**
      * For versioning-enabled buckets, a specific version of the state machine definition.
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-stepfunctions-statemachine-s3location.html#cfn-stepfunctions-statemachine-s3location-version}
      */
     Version?: string | undefined;
 };
 /**
  * The `TagsEntry` property specifies *tags* to identify a state machine.
+ * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-stepfunctions-statemachine-tagsentry.html}
  */
 export type TagsEntry = {
     /**
      * The `key` for a key-value pair in a tag entry.
      * @minLength 1
      * @maxLength 128
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-stepfunctions-statemachine-tagsentry.html#cfn-stepfunctions-statemachine-tagsentry-key}
      */
     Key: string;
     /**
      * The `value` for a key-value pair in a tag entry.
      * @minLength 1
      * @maxLength 256
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-stepfunctions-statemachine-tagsentry.html#cfn-stepfunctions-statemachine-tagsentry-value}
      */
     Value: string;
 };
 /**
  * Selects whether or not the state machine's AWS X-Ray tracing is enabled. To configure your state machine to send trace data to X-Ray, set `Enabled` to `true` .
+ * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-stepfunctions-statemachine-tracingconfiguration.html}
  */
 export type TracingConfiguration = {
     /**
      * When set to `true` , X-Ray tracing is enabled.
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-stepfunctions-statemachine-tracingconfiguration.html#cfn-stepfunctions-statemachine-tracingconfiguration-enabled}
      */
     Enabled?: boolean | undefined;
 };