@propulsionworks/cloudformation 0.0.2 → 0.1.0

package/out/exports/resources.generated/aws-iam-virtualmfadevice.d.ts

@@ -0,0 +1,51 @@
+import type { ResourceDefinitionWithAttributes, Tag } from "../main.ts";
+export type IAMVirtualMFADevice = ResourceDefinitionWithAttributes<"AWS::IAM::VirtualMFADevice", IAMVirtualMFADeviceProps, IAMVirtualMFADeviceAttribs>;
+/**
+ * Creates a new virtual MFA device for the AWS account . After creating the virtual MFA, use [EnableMFADevice](https://docs.aws.amazon.com/IAM/latest/APIReference/API_EnableMFADevice.html) to attach the MFA device to an IAM user. For more information about creating and working with virtual MFA devices, see [Using a virtual MFA device](https://docs.aws.amazon.com/IAM/latest/UserGuide/Using_VirtualMFA.html) in the *IAM User Guide* .
+ *
+ * For information about the maximum number of MFA devices you can create, see [IAM and AWS STS quotas](https://docs.aws.amazon.com/IAM/latest/UserGuide/reference_iam-quotas.html) in the *IAM User Guide* .
+ *
+ * > The seed information contained in the QR code and the Base32 string should be treated like any other secret access information. In other words, protect the seed information as you would your AWS access keys or your passwords. After you provision your virtual device, you should ensure that the information is destroyed following secure procedures.
+ */
+export type IAMVirtualMFADeviceProps = {
+    /**
+     * The path for the virtual MFA device. For more information about paths, see [IAM identifiers](https://docs.aws.amazon.com/IAM/latest/UserGuide/Using_Identifiers.html) in the *IAM User Guide* .
+     *
+     * This parameter is optional. If it is not included, it defaults to a slash (/).
+     *
+     * This parameter allows (through its [regex pattern](https://docs.aws.amazon.com/http://wikipedia.org/wiki/regex) ) a string of characters consisting of either a forward slash (/) by itself or a string that must begin and end with forward slashes. In addition, it can contain any ASCII character from the ! ( `\u0021` ) through the DEL character ( `\u007F` ), including most punctuation characters, digits, and upper and lowercased letters.
+     * @minLength 1
+     * @maxLength 512
+     * @pattern (\u002F)|(\u002F[\u0021-\u007F]+\u002F)
+     */
+    Path?: string | undefined;
+    /**
+     * A list of tags that you want to attach to the new IAM virtual MFA device. Each tag consists of a key name and an associated value. For more information about tagging, see [Tagging IAM resources](https://docs.aws.amazon.com/IAM/latest/UserGuide/id_tags.html) in the *IAM User Guide* .
+     *
+     * > If any one of the tags is invalid or if you exceed the allowed maximum number of tags, then the entire request fails and the resource is not created.
+     */
+    Tags?: Tag[] | undefined;
+    /**
+     * The IAM user associated with this virtual MFA device.
+     */
+    Users: string[];
+    /**
+     * The name of the virtual MFA device, which must be unique. Use with path to uniquely identify a virtual MFA device.
+     *
+     * This parameter allows (through its [regex pattern](https://docs.aws.amazon.com/http://wikipedia.org/wiki/regex) ) a string of characters consisting of upper and lowercase alphanumeric characters with no spaces. You can also include any of the following characters: _+=,.@-
+     * @minLength 1
+     * @maxLength 226
+     * @pattern [\w+=,.@-]+
+     */
+    VirtualMfaDeviceName?: string | undefined;
+};
+export type IAMVirtualMFADeviceAttribs = {
+    /**
+     * Returns the serial number for the specified `AWS::IAM::VirtualMFADevice` resource.
+     * @minLength 9
+     * @maxLength 256
+     * @pattern [\w+=/:,.@-]+
+     */
+    SerialNumber: string;
+};
+//# sourceMappingURL=aws-iam-virtualmfadevice.d.ts.map

package/out/exports/resources.generated/aws-identitystore-group.d.ts

@@ -0,0 +1,40 @@
+import type { ResourceDefinitionWithAttributes } from "../main.ts";
+export type IdentityStoreGroup = ResourceDefinitionWithAttributes<"AWS::IdentityStore::Group", IdentityStoreGroupProps, IdentityStoreGroupAttribs>;
+/**
+ * A group object, which contains a specified group’s metadata and attributes.
+ */
+export type IdentityStoreGroupProps = {
+    /**
+     * A string containing the description of the group.
+     * @minLength 1
+     * @maxLength 1024
+     * @pattern ^[\p{L}\p{M}\p{S}\p{N}\p{P}\t\n\r  　]+$
+     */
+    Description?: string | undefined;
+    /**
+     * The display name value for the group. The length limit is 1,024 characters. This value can consist of letters, accented characters, symbols, numbers, punctuation, tab, new line, carriage return, space, and nonbreaking space in this attribute. This value is specified at the time the group is created and stored as an attribute of the group object in the identity store.
+     *
+     * Prefix search supports a maximum of 1,000 characters for the string.
+     * @minLength 1
+     * @maxLength 1024
+     * @pattern ^[\p{L}\p{M}\p{S}\p{N}\p{P}\t\n\r  ]+$
+     */
+    DisplayName: string;
+    /**
+     * The globally unique identifier for the identity store.
+     * @minLength 1
+     * @maxLength 36
+     * @pattern ^d-[0-9a-f]{10}$|^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$
+     */
+    IdentityStoreId: string;
+};
+export type IdentityStoreGroupAttribs = {
+    /**
+     * The identifier of the newly created group in the identity store.
+     * @minLength 1
+     * @maxLength 47
+     * @pattern ^([0-9a-f]{10}-|)[A-Fa-f0-9]{8}-[A-Fa-f0-9]{4}-[A-Fa-f0-9]{4}-[A-Fa-f0-9]{4}-[A-Fa-f0-9]{12}$
+     */
+    GroupId: string;
+};
+//# sourceMappingURL=aws-identitystore-group.d.ts.map

package/out/exports/resources.generated/aws-identitystore-groupmembership.d.ts

@@ -0,0 +1,47 @@
+import type { ResourceDefinitionWithAttributes } from "../main.ts";
+export type IdentityStoreGroupMembership = ResourceDefinitionWithAttributes<"AWS::IdentityStore::GroupMembership", IdentityStoreGroupMembershipProps, IdentityStoreGroupMembershipAttribs>;
+/**
+ * Creates a relationship between a member and a group. The following identifiers must be specified: `GroupId` , `IdentityStoreId` , and `MemberId` .
+ */
+export type IdentityStoreGroupMembershipProps = {
+    /**
+     * The identifier for a group in the identity store.
+     * @minLength 1
+     * @maxLength 47
+     * @pattern ^([0-9a-f]{10}-|)[A-Fa-f0-9]{8}-[A-Fa-f0-9]{4}-[A-Fa-f0-9]{4}-[A-Fa-f0-9]{4}-[A-Fa-f0-9]{12}$
+     */
+    GroupId: string;
+    /**
+     * The globally unique identifier for the identity store.
+     * @minLength 1
+     * @maxLength 36
+     * @pattern ^d-[0-9a-f]{10}$|^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$
+     */
+    IdentityStoreId: string;
+    /**
+     * An object containing the identifier of a group member. Setting the `MemberId` 's `UserId` field to a specific User's ID indicates that user is a member of the group.
+     */
+    MemberId: MemberId;
+};
+export type IdentityStoreGroupMembershipAttribs = {
+    /**
+     * The identifier for a `GroupMembership` in the identity store.
+     * @minLength 1
+     * @maxLength 47
+     * @pattern ^([0-9a-f]{10}-|)[A-Fa-f0-9]{8}-[A-Fa-f0-9]{4}-[A-Fa-f0-9]{4}-[A-Fa-f0-9]{4}-[A-Fa-f0-9]{12}$
+     */
+    MembershipId: string;
+};
+/**
+ * An object that contains the identifier of a group member. Setting the `UserID` field to the specific identifier for a user indicates that the user is a member of the group.
+ */
+export type MemberId = {
+    /**
+     * An object containing the identifiers of resources that can be members.
+     * @minLength 1
+     * @maxLength 47
+     * @pattern ^([0-9a-f]{10}-|)[A-Fa-f0-9]{8}-[A-Fa-f0-9]{4}-[A-Fa-f0-9]{4}-[A-Fa-f0-9]{4}-[A-Fa-f0-9]{12}$
+     */
+    UserId: string;
+};
+//# sourceMappingURL=aws-identitystore-groupmembership.d.ts.map

package/out/exports/resources.generated/aws-imagebuilder-component.d.ts

@@ -0,0 +1,118 @@
+import type { ResourceDefinitionWithAttributes } from "../main.ts";
+export type ImageBuilderComponent = ResourceDefinitionWithAttributes<"AWS::ImageBuilder::Component", ImageBuilderComponentProps, ImageBuilderComponentAttribs>;
+/**
+ * Creates a new component that can be used to build, validate, test, and assess your image. The component is based on a YAML document that you specify using exactly one of the following methods:
+ *
+ * - Inline, using the `data` property in the request body.
+ * - A URL that points to a YAML document file stored in Amazon S3, using the `uri` property in the request body.
+ */
+export type ImageBuilderComponentProps = {
+    /**
+     * The change description of the component. Describes what change has been made in this version, or what makes this version different from other versions of the component.
+     */
+    ChangeDescription?: string | undefined;
+    /**
+     * Component `data` contains inline YAML document content for the component. Alternatively, you can specify the `uri` of a YAML document file stored in Amazon S3. However, you cannot specify both properties.
+     * @minLength 1
+     * @maxLength 16000
+     */
+    Data: string;
+    /**
+     * Describes the contents of the component.
+     */
+    Description?: string | undefined;
+    /**
+     * The ID of the KMS key that is used to encrypt this component.
+     */
+    KmsKeyId?: string | undefined;
+    /**
+     * The name of the component.
+     */
+    Name: string;
+    /**
+     * The operating system platform of the component.
+     */
+    Platform: "Windows" | "Linux" | "macOS";
+    /**
+     * The operating system (OS) version supported by the component. If the OS information is available, a prefix match is performed against the base image OS version during image recipe creation.
+     */
+    SupportedOsVersions?: string[] | undefined;
+    /**
+     * The tags that apply to the component.
+     */
+    Tags?: Record<string, string> | undefined;
+    /**
+     * The `uri` of a YAML component document file. This must be an S3 URL ( `s3://bucket/key` ), and the requester must have permission to access the S3 bucket it points to. If you use Amazon S3, you can specify component content up to your service quota.
+     *
+     * Alternatively, you can specify the YAML document inline, using the component `data` property. You cannot specify both properties.
+     */
+    Uri?: string | undefined;
+    /**
+     * The component version. For example, `1.0.0` .
+     */
+    Version: string;
+} | {
+    /**
+     * The change description of the component. Describes what change has been made in this version, or what makes this version different from other versions of the component.
+     */
+    ChangeDescription?: string | undefined;
+    /**
+     * Component `data` contains inline YAML document content for the component. Alternatively, you can specify the `uri` of a YAML document file stored in Amazon S3. However, you cannot specify both properties.
+     * @minLength 1
+     * @maxLength 16000
+     */
+    Data?: string | undefined;
+    /**
+     * Describes the contents of the component.
+     */
+    Description?: string | undefined;
+    /**
+     * The ID of the KMS key that is used to encrypt this component.
+     */
+    KmsKeyId?: string | undefined;
+    /**
+     * The name of the component.
+     */
+    Name: string;
+    /**
+     * The operating system platform of the component.
+     */
+    Platform: "Windows" | "Linux" | "macOS";
+    /**
+     * The operating system (OS) version supported by the component. If the OS information is available, a prefix match is performed against the base image OS version during image recipe creation.
+     */
+    SupportedOsVersions?: string[] | undefined;
+    /**
+     * The tags that apply to the component.
+     */
+    Tags?: Record<string, string> | undefined;
+    /**
+     * The `uri` of a YAML component document file. This must be an S3 URL ( `s3://bucket/key` ), and the requester must have permission to access the S3 bucket it points to. If you use Amazon S3, you can specify component content up to your service quota.
+     *
+     * Alternatively, you can specify the YAML document inline, using the component `data` property. You cannot specify both properties.
+     */
+    Uri: string;
+    /**
+     * The component version. For example, `1.0.0` .
+     */
+    Version: string;
+};
+export type ImageBuilderComponentAttribs = {
+    /**
+     * Returns the Amazon Resource Name (ARN) of the component. The following pattern is applied: `^arn:aws[^:]*:imagebuilder:[^:]+:(?:\d{12}|aws):(?:image-recipe|infrastructure-configuration|distribution-configuration|component|image|image-pipeline)/[a-z0-9-_]+(?:/(?:(?:x|\d+)\.(?:x|\d+)\.(?:x|\d+))(?:/\d+)?)?$` .
+     */
+    Arn: string;
+    /**
+     * Returns the encryption status of the component. For example `true` or `false` .
+     */
+    Encrypted: boolean;
+    /**
+     * Returns the name of the component.
+     */
+    Name: string;
+    /**
+     * Image Builder determines the component type based on the phases that are defined in the component document. If there is only one phase, and its name is "test", then the type is `TEST` . For all other components, the type is `BUILD` .
+     */
+    Type: "BUILD" | "TEST";
+};
+//# sourceMappingURL=aws-imagebuilder-component.d.ts.map

package/out/exports/resources.generated/aws-imagebuilder-containerrecipe.d.ts

@@ -0,0 +1,267 @@
+import type { ResourceDefinitionWithAttributes } from "../main.ts";
+export type ImageBuilderContainerRecipe = ResourceDefinitionWithAttributes<"AWS::ImageBuilder::ContainerRecipe", ImageBuilderContainerRecipeProps, ImageBuilderContainerRecipeAttribs>;
+/**
+ * Creates a new container recipe. Container recipes define how images are configured, tested, and assessed.
+ */
+export type ImageBuilderContainerRecipeProps = {
+    /**
+     * Build and test components that are included in the container recipe. Recipes require a minimum of one build component, and can have a maximum of 20 build and test components in any combination.
+     */
+    Components: ComponentConfiguration[];
+    /**
+     * Specifies the type of container, such as Docker.
+     */
+    ContainerType: "DOCKER";
+    /**
+     * The description of the container recipe.
+     */
+    Description?: string | undefined;
+    /**
+     * Dockerfiles are text documents that are used to build Docker containers, and ensure that they contain all of the elements required by the application running inside. The template data consists of contextual variables where Image Builder places build information or scripts, based on your container image recipe.
+     */
+    DockerfileTemplateData: string;
+    /**
+     * The S3 URI for the Dockerfile that will be used to build your container image.
+     */
+    DockerfileTemplateUri?: string | undefined;
+    /**
+     * Specifies the operating system version for the base image.
+     */
+    ImageOsVersionOverride?: string | undefined;
+    /**
+     * A group of options that can be used to configure an instance for building and testing container images.
+     */
+    InstanceConfiguration?: InstanceConfiguration | undefined;
+    /**
+     * Identifies which KMS key is used to encrypt the container image for distribution to the target Region.
+     */
+    KmsKeyId?: string | undefined;
+    /**
+     * The name of the container recipe.
+     */
+    Name: string;
+    /**
+     * The base image for customizations specified in the container recipe. This can contain an Image Builder image resource ARN or a container image URI, for example `amazonlinux:latest` .
+     */
+    ParentImage: string;
+    /**
+     * Specifies the operating system platform when you use a custom base image.
+     */
+    PlatformOverride?: "Windows" | "Linux" | undefined;
+    /**
+     * Tags that are attached to the container recipe.
+     */
+    Tags?: Record<string, string> | undefined;
+    /**
+     * The destination repository for the container image.
+     */
+    TargetRepository: TargetContainerRepository;
+    /**
+     * The semantic version of the container recipe.
+     *
+     * > The semantic version has four nodes: <major>.<minor>.<patch>/<build>. You can assign values for the first three, and can filter on all of them.
+     * >
+     * > *Assignment:* For the first three nodes you can assign any positive integer value, including zero, with an upper limit of 2^30-1, or 1073741823 for each node. Image Builder automatically assigns the build number to the fourth node.
+     * >
+     * > *Patterns:* You can use any numeric pattern that adheres to the assignment requirements for the nodes that you can assign. For example, you might choose a software version pattern, such as 1.0.0, or a date, such as 2021.01.01.
+     * >
+     * > *Filtering:* With semantic versioning, you have the flexibility to use wildcards (x) to specify the most recent versions or nodes when selecting the base image or components for your recipe. When you use a wildcard in any node, all nodes to the right of the first wildcard must also be wildcards.
+     */
+    Version: string;
+    /**
+     * The working directory for use during build and test workflows.
+     */
+    WorkingDirectory?: string | undefined;
+} | {
+    /**
+     * Build and test components that are included in the container recipe. Recipes require a minimum of one build component, and can have a maximum of 20 build and test components in any combination.
+     */
+    Components: ComponentConfiguration[];
+    /**
+     * Specifies the type of container, such as Docker.
+     */
+    ContainerType: "DOCKER";
+    /**
+     * The description of the container recipe.
+     */
+    Description?: string | undefined;
+    /**
+     * Dockerfiles are text documents that are used to build Docker containers, and ensure that they contain all of the elements required by the application running inside. The template data consists of contextual variables where Image Builder places build information or scripts, based on your container image recipe.
+     */
+    DockerfileTemplateData?: string | undefined;
+    /**
+     * The S3 URI for the Dockerfile that will be used to build your container image.
+     */
+    DockerfileTemplateUri: string;
+    /**
+     * Specifies the operating system version for the base image.
+     */
+    ImageOsVersionOverride?: string | undefined;
+    /**
+     * A group of options that can be used to configure an instance for building and testing container images.
+     */
+    InstanceConfiguration?: InstanceConfiguration | undefined;
+    /**
+     * Identifies which KMS key is used to encrypt the container image for distribution to the target Region.
+     */
+    KmsKeyId?: string | undefined;
+    /**
+     * The name of the container recipe.
+     */
+    Name: string;
+    /**
+     * The base image for customizations specified in the container recipe. This can contain an Image Builder image resource ARN or a container image URI, for example `amazonlinux:latest` .
+     */
+    ParentImage: string;
+    /**
+     * Specifies the operating system platform when you use a custom base image.
+     */
+    PlatformOverride?: "Windows" | "Linux" | undefined;
+    /**
+     * Tags that are attached to the container recipe.
+     */
+    Tags?: Record<string, string> | undefined;
+    /**
+     * The destination repository for the container image.
+     */
+    TargetRepository: TargetContainerRepository;
+    /**
+     * The semantic version of the container recipe.
+     *
+     * > The semantic version has four nodes: <major>.<minor>.<patch>/<build>. You can assign values for the first three, and can filter on all of them.
+     * >
+     * > *Assignment:* For the first three nodes you can assign any positive integer value, including zero, with an upper limit of 2^30-1, or 1073741823 for each node. Image Builder automatically assigns the build number to the fourth node.
+     * >
+     * > *Patterns:* You can use any numeric pattern that adheres to the assignment requirements for the nodes that you can assign. For example, you might choose a software version pattern, such as 1.0.0, or a date, such as 2021.01.01.
+     * >
+     * > *Filtering:* With semantic versioning, you have the flexibility to use wildcards (x) to specify the most recent versions or nodes when selecting the base image or components for your recipe. When you use a wildcard in any node, all nodes to the right of the first wildcard must also be wildcards.
+     */
+    Version: string;
+    /**
+     * The working directory for use during build and test workflows.
+     */
+    WorkingDirectory?: string | undefined;
+};
+export type ImageBuilderContainerRecipeAttribs = {
+    /**
+     * Returns the Amazon Resource Name (ARN) of the container recipe. For example, `arn:aws:imagebuilder:us-east-1:123456789012:container-recipe/mybasicrecipe/2020.12.17` .
+     */
+    Arn: string;
+    /**
+     * Returns the name of the container recipe.
+     */
+    Name: string;
+};
+/**
+ * Configuration details of the component.
+ */
+export type ComponentConfiguration = {
+    /**
+     * The Amazon Resource Name (ARN) of the component.
+     */
+    ComponentArn?: string | undefined;
+    /**
+     * A group of parameter settings that Image Builder uses to configure the component for a specific recipe.
+     */
+    Parameters?: ComponentParameter[] | undefined;
+};
+/**
+ * Contains a key/value pair that sets the named component parameter.
+ */
+export type ComponentParameter = {
+    /**
+     * The name of the component parameter to set.
+     */
+    Name: string;
+    /**
+     * Sets the value for the named component parameter.
+     */
+    Value: string[];
+};
+/**
+ * Amazon EBS-specific block device mapping specifications.
+ */
+export type EbsInstanceBlockDeviceSpecification = {
+    /**
+     * Use to configure delete on termination of the associated device.
+     */
+    DeleteOnTermination?: boolean | undefined;
+    /**
+     * Use to configure device encryption.
+     */
+    Encrypted?: boolean | undefined;
+    /**
+     * Use to configure device IOPS.
+     */
+    Iops?: number | undefined;
+    /**
+     * Use to configure the KMS key to use when encrypting the device.
+     */
+    KmsKeyId?: string | undefined;
+    /**
+     * The snapshot that defines the device contents.
+     */
+    SnapshotId?: string | undefined;
+    /**
+     * *For GP3 volumes only* – The throughput in MiB/s that the volume supports.
+     */
+    Throughput?: number | undefined;
+    /**
+     * Use to override the device's volume size.
+     */
+    VolumeSize?: number | undefined;
+    /**
+     * Use to override the device's volume type.
+     */
+    VolumeType?: "standard" | "io1" | "io2" | "gp2" | "gp3" | "sc1" | "st1" | undefined;
+};
+/**
+ * Defines block device mappings for the instance used to configure your image.
+ */
+export type InstanceBlockDeviceMapping = {
+    /**
+     * The device to which these mappings apply.
+     */
+    DeviceName?: string | undefined;
+    /**
+     * Use to manage Amazon EBS-specific configuration for this mapping.
+     */
+    Ebs?: EbsInstanceBlockDeviceSpecification | undefined;
+    /**
+     * Use to remove a mapping from the base image.
+     */
+    NoDevice?: string | undefined;
+    /**
+     * Use to manage instance ephemeral devices.
+     */
+    VirtualName?: string | undefined;
+};
+/**
+ * Defines a custom base AMI and block device mapping configurations of an instance used for building and testing container images.
+ */
+export type InstanceConfiguration = {
+    /**
+     * Defines the block devices to attach for building an instance from this Image Builder AMI.
+     */
+    BlockDeviceMappings?: InstanceBlockDeviceMapping[] | undefined;
+    /**
+     * The base image for a container build and test instance. This can contain an AMI ID or it can specify an AWS Systems Manager (SSM) Parameter Store Parameter, prefixed by `ssm:` , followed by the parameter name or ARN.
+     *
+     * If not specified, Image Builder uses the appropriate ECS-optimized AMI as a base image.
+     */
+    Image?: string | undefined;
+};
+/**
+ * The container repository where the output container image is stored.
+ */
+export type TargetContainerRepository = {
+    /**
+     * The name of the container repository where the output container image is stored. This name is prefixed by the repository location. For example, `<repository location url>/repository_name` .
+     */
+    RepositoryName?: string | undefined;
+    /**
+     * Specifies the service in which this image was registered.
+     */
+    Service?: "ECR" | undefined;
+};
+//# sourceMappingURL=aws-imagebuilder-containerrecipe.d.ts.map