@awboost/cfn-resource-types 0.1.43 → 0.1.45

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
@@ -88,6 +88,7 @@ export type Range = {
88
88
  * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudwatch-anomalydetector-singlemetricanomalydetector.html}
89
89
  */
90
90
  export type SingleMetricAnomalyDetector = {
91
+ AccountId?: string;
91
92
  Dimensions?: Dimension[];
92
93
  MetricName?: string;
93
94
  Namespace?: string;
@@ -1,37 +1,58 @@
1
1
  import { Resource as $Resource } from "@awboost/cfn-template-builder/template/resource";
2
2
  import type { ResourceOptions as $ResourceOptions } from "@awboost/cfn-template-builder/template";
3
3
  /**
4
- * Resource Type definition for AWS::IAM::ManagedPolicy
4
+ * Resource type definition for `AWS::IAM::ManagedPolicy`.
5
+ * Creates a new managed policy for your AWS-account.
6
+ This operation creates a policy version with a version identifier of ``v1`` and sets v1 as the policy's default version. For more information about policy versions, see [Versioning for managed policies](https://docs.aws.amazon.com/IAM/latest/UserGuide/policies-managed-versions.html) in the *IAM User Guide*.
7
+ As a best practice, you can validate your IAM policies. To learn more, see [Validating IAM policies](https://docs.aws.amazon.com/IAM/latest/UserGuide/access_policies_policy-validator.html) in the *IAM User Guide*.
8
+ For more information about managed policies in general, see [Managed policies and inline policies](https://docs.aws.amazon.com/IAM/latest/UserGuide/policies-managed-vs-inline.html) in the *IAM User Guide*.
5
9
  * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iam-managedpolicy.html}
6
10
  */
7
11
  export type IAMManagedPolicyProperties = {
8
12
  /**
9
- * A friendly description of the policy.
10
- */
13
+ * A friendly description of the policy.
14
+ Typically used to store information about the permissions defined in the policy. For example, "Grants access to production DynamoDB tables."
15
+ The policy description is immutable. After a value is assigned, it cannot be changed.
16
+ */
11
17
  Description?: string;
12
18
  /**
13
- * The name (friendly name, not ARN) of the group to attach the policy to.
14
- */
19
+ * The name (friendly name, not ARN) of the group to attach the policy to.
20
+ 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: _+=,.@-
21
+ */
15
22
  Groups?: string[];
16
23
  /**
17
- * The friendly name of the policy.
18
- */
24
+ * The friendly name of the policy.
25
+ 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.
26
+ If you specify a name, you must specify the ``CAPABILITY_NAMED_IAM`` value to acknowledge your template's capabilities. For more information, see [Acknowledging Resources in Templates](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-iam-template.html#using-iam-capabilities).
27
+ Naming an IAM resource can cause an unrecoverable error if you reuse the same template in multiple Regions. To prevent this, we recommend using ``Fn::Join`` and ``AWS::Region`` to create a Region-specific name, as in the following example: ``{"Fn::Join": ["", [{"Ref": "AWS::Region"}, {"Ref": "MyResourceName"}]]}``.
28
+ */
19
29
  ManagedPolicyName?: string;
20
30
  /**
21
- * The path for the policy.
22
- */
31
+ * The path for the policy.
32
+ For more information about paths, see [IAM identifiers](https://docs.aws.amazon.com/IAM/latest/UserGuide/Using_Identifiers.html) in the *IAM User Guide*.
33
+ This parameter is optional. If it is not included, it defaults to a slash (/).
34
+ 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.
35
+ You cannot use an asterisk (*) in the path name.
36
+ */
23
37
  Path?: string;
24
38
  /**
25
- * The JSON policy document that you want to use as the content for the new policy.
26
- */
39
+ * The JSON policy document that you want to use as the content for the new policy.
40
+ You must provide policies in JSON format in IAM. However, for CFN templates formatted in YAML, you can provide the policy in JSON or YAML format. CFN always converts a YAML policy to JSON format before submitting it to IAM.
41
+ The maximum length of the policy document that you can pass in this operation, including whitespace, is listed below. To view the maximum character counts of a managed policy with no whitespaces, see [IAM and character quotas](https://docs.aws.amazon.com/IAM/latest/UserGuide/reference_iam-quotas.html#reference_iam-quotas-entity-length).
42
+ To learn more about JSON policy grammar, see [Grammar of the IAM JSON policy language](https://docs.aws.amazon.com/IAM/latest/UserGuide/reference_policies_grammar.html) in the *IAM User Guide*.
43
+ The [regex pattern](https://docs.aws.amazon.com/http://wikipedia.org/wiki/regex) used to validate this parameter is a string of characters consisting of the
44
+ */
27
45
  PolicyDocument: Record<string, any> | string;
28
46
  /**
29
- * The name (friendly name, not ARN) of the role to attach the policy to.
30
- */
47
+ * The name (friendly name, not ARN) of the role to attach the policy to.
48
+ This parameter allows (per 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: _+=,.@-
49
+ If an external policy (such as ``AWS::IAM::Policy`` or ``AWS::IAM::ManagedPolicy``) has a ``Ref`` to a role and if a resource (such as ``AWS::ECS::Service``) also has a ``Ref`` to the same role, add a ``DependsOn`` attribute to the resource to make the resource depend on the external policy. This dependency ensures that the role's policy is available throughout the resource's lifecycle. For example, when you delete a stack with an ``AWS::ECS::Service`` resource, the ``DependsOn`` attribute ensures that CFN deletes the ``AWS::ECS::Service`` resource before deleting its role's policy.
50
+ */
31
51
  Roles?: string[];
32
52
  /**
33
- * The name (friendly name, not ARN) of the IAM user to attach the policy to.
34
- */
53
+ * The name (friendly name, not ARN) of the IAM user to attach the policy to.
54
+ 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: _+=,.@-
55
+ */
35
56
  Users?: string[];
36
57
  };
37
58
  /**
@@ -39,41 +60,21 @@ export type IAMManagedPolicyProperties = {
39
60
  * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iam-managedpolicy.html#aws-resource-iam-managedpolicy-return-values}
40
61
  */
41
62
  export type IAMManagedPolicyAttributes = {
42
- /**
43
- * The number of entities (users, groups, and roles) that the policy is attached to.
44
- */
45
63
  AttachmentCount: number;
46
- /**
47
- * The date and time, in ISO 8601 date-time format, when the policy was created.
48
- */
49
64
  CreateDate: string;
50
- /**
51
- * The identifier for the version of the policy that is set as the default version.
52
- */
53
65
  DefaultVersionId: string;
54
- /**
55
- * Specifies whether the policy can be attached to an IAM user, group, or role.
56
- */
57
66
  IsAttachable: boolean;
58
- /**
59
- * The number of entities (users and roles) for which the policy is used to set the permissions boundary.
60
- */
61
67
  PermissionsBoundaryUsageCount: number;
62
- /**
63
- * Amazon Resource Name (ARN) of the managed policy
64
- */
65
68
  PolicyArn: string;
66
- /**
67
- * The stable and unique string identifying the policy.
68
- */
69
69
  PolicyId: string;
70
- /**
71
- * The date and time, in ISO 8601 date-time format, when the policy was last updated.
72
- */
73
70
  UpdateDate: string;
74
71
  };
75
72
  /**
76
- * Resource Type definition for AWS::IAM::ManagedPolicy
73
+ * Resource type definition for `AWS::IAM::ManagedPolicy`.
74
+ * Creates a new managed policy for your AWS-account.
75
+ This operation creates a policy version with a version identifier of ``v1`` and sets v1 as the policy's default version. For more information about policy versions, see [Versioning for managed policies](https://docs.aws.amazon.com/IAM/latest/UserGuide/policies-managed-versions.html) in the *IAM User Guide*.
76
+ As a best practice, you can validate your IAM policies. To learn more, see [Validating IAM policies](https://docs.aws.amazon.com/IAM/latest/UserGuide/access_policies_policy-validator.html) in the *IAM User Guide*.
77
+ For more information about managed policies in general, see [Managed policies and inline policies](https://docs.aws.amazon.com/IAM/latest/UserGuide/policies-managed-vs-inline.html) in the *IAM User Guide*.
77
78
  * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iam-managedpolicy.html}
78
79
  */
79
80
  export declare class IAMManagedPolicy extends $Resource<"AWS::IAM::ManagedPolicy", IAMManagedPolicyProperties, IAMManagedPolicyAttributes> {
@@ -1,6 +1,10 @@
1
1
  import { Resource as $Resource } from "@awboost/cfn-template-builder/template/resource";
2
2
  /**
3
- * Resource Type definition for AWS::IAM::ManagedPolicy
3
+ * Resource type definition for `AWS::IAM::ManagedPolicy`.
4
+ * Creates a new managed policy for your AWS-account.
5
+ This operation creates a policy version with a version identifier of ``v1`` and sets v1 as the policy's default version. For more information about policy versions, see [Versioning for managed policies](https://docs.aws.amazon.com/IAM/latest/UserGuide/policies-managed-versions.html) in the *IAM User Guide*.
6
+ As a best practice, you can validate your IAM policies. To learn more, see [Validating IAM policies](https://docs.aws.amazon.com/IAM/latest/UserGuide/access_policies_policy-validator.html) in the *IAM User Guide*.
7
+ For more information about managed policies in general, see [Managed policies and inline policies](https://docs.aws.amazon.com/IAM/latest/UserGuide/policies-managed-vs-inline.html) in the *IAM User Guide*.
4
8
  * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iam-managedpolicy.html}
5
9
  */
6
10
  export class IAMManagedPolicy extends $Resource {
@@ -0,0 +1,134 @@
1
+ import { Resource as $Resource } from "@awboost/cfn-template-builder/template/resource";
2
+ import type { ResourceOptions as $ResourceOptions } from "@awboost/cfn-template-builder/template";
3
+ /**
4
+ * Resource type definition for `AWS::KafkaConnect::CustomPlugin`.
5
+ * An example resource schema demonstrating some basic constructs and validation rules.
6
+ * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-kafkaconnect-customplugin.html}
7
+ */
8
+ export type KafkaConnectCustomPluginProperties = {
9
+ /**
10
+ * The type of the plugin file.
11
+ */
12
+ ContentType: "JAR" | "ZIP";
13
+ /**
14
+ * A summary description of the custom plugin.
15
+ * @maxLength `1024`
16
+ */
17
+ Description?: string;
18
+ /**
19
+ * Information about the location of a custom plugin.
20
+ */
21
+ Location: CustomPluginLocation;
22
+ /**
23
+ * The name of the custom plugin.
24
+ * @minLength `1`
25
+ * @maxLength `128`
26
+ */
27
+ Name: string;
28
+ /**
29
+ * An array of key-value pairs to apply to this resource.
30
+ */
31
+ Tags?: Tag[];
32
+ };
33
+ /**
34
+ * Attribute type definition for `AWS::KafkaConnect::CustomPlugin`.
35
+ * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-kafkaconnect-customplugin.html#aws-resource-kafkaconnect-customplugin-return-values}
36
+ */
37
+ export type KafkaConnectCustomPluginAttributes = {
38
+ /**
39
+ * The Amazon Resource Name (ARN) of the custom plugin to use.
40
+ * @pattern `arn:(aws|aws-us-gov|aws-cn):kafkaconnect:.*`
41
+ */
42
+ CustomPluginArn: string;
43
+ /**
44
+ * Details about the custom plugin file.
45
+ */
46
+ FileDescription: {
47
+ /**
48
+ * The hex-encoded MD5 checksum of the custom plugin file. You can use it to validate the file.
49
+ */
50
+ FileMd5: string;
51
+ /**
52
+ * The size in bytes of the custom plugin file. You can use it to validate the file.
53
+ */
54
+ FileSize: number;
55
+ };
56
+ /**
57
+ * The revision of the custom plugin.
58
+ */
59
+ Revision: number;
60
+ };
61
+ /**
62
+ * Type definition for `AWS::KafkaConnect::CustomPlugin.CustomPluginFileDescription`.
63
+ * Details about the custom plugin file.
64
+ * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kafkaconnect-customplugin-custompluginfiledescription.html}
65
+ */
66
+ export type CustomPluginFileDescription = {
67
+ /**
68
+ * The hex-encoded MD5 checksum of the custom plugin file. You can use it to validate the file.
69
+ */
70
+ FileMd5?: string;
71
+ /**
72
+ * The size in bytes of the custom plugin file. You can use it to validate the file.
73
+ */
74
+ FileSize?: number;
75
+ };
76
+ /**
77
+ * Type definition for `AWS::KafkaConnect::CustomPlugin.CustomPluginLocation`.
78
+ * Information about the location of a custom plugin.
79
+ * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kafkaconnect-customplugin-custompluginlocation.html}
80
+ */
81
+ export type CustomPluginLocation = {
82
+ /**
83
+ * The S3 bucket Amazon Resource Name (ARN), file key, and object version of the plugin file stored in Amazon S3.
84
+ */
85
+ S3Location: S3Location;
86
+ };
87
+ /**
88
+ * Type definition for `AWS::KafkaConnect::CustomPlugin.S3Location`.
89
+ * The S3 bucket Amazon Resource Name (ARN), file key, and object version of the plugin file stored in Amazon S3.
90
+ * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kafkaconnect-customplugin-s3location.html}
91
+ */
92
+ export type S3Location = {
93
+ /**
94
+ * The Amazon Resource Name (ARN) of an S3 bucket.
95
+ */
96
+ BucketArn: string;
97
+ /**
98
+ * The file key for an object in an S3 bucket.
99
+ */
100
+ FileKey: string;
101
+ /**
102
+ * The version of an object in an S3 bucket.
103
+ */
104
+ ObjectVersion?: string;
105
+ };
106
+ /**
107
+ * Type definition for `AWS::KafkaConnect::CustomPlugin.Tag`.
108
+ * A key-value pair to associate with a resource.
109
+ * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kafkaconnect-customplugin-tag.html}
110
+ */
111
+ export type Tag = {
112
+ /**
113
+ * The key name of the tag. You can specify a value that is 1 to 128 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -.
114
+ * @minLength `1`
115
+ * @maxLength `128`
116
+ */
117
+ Key: string;
118
+ /**
119
+ * The value for the tag. You can specify a value that is 0 to 256 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -.
120
+ * @minLength `0`
121
+ * @maxLength `256`
122
+ */
123
+ Value: string;
124
+ };
125
+ /**
126
+ * Resource type definition for `AWS::KafkaConnect::CustomPlugin`.
127
+ * An example resource schema demonstrating some basic constructs and validation rules.
128
+ * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-kafkaconnect-customplugin.html}
129
+ */
130
+ export declare class KafkaConnectCustomPlugin extends $Resource<"AWS::KafkaConnect::CustomPlugin", KafkaConnectCustomPluginProperties, KafkaConnectCustomPluginAttributes> {
131
+ static readonly Type = "AWS::KafkaConnect::CustomPlugin";
132
+ constructor(logicalId: string, properties: KafkaConnectCustomPluginProperties, options?: $ResourceOptions);
133
+ }
134
+ //# sourceMappingURL=AWS-KafkaConnect-CustomPlugin.d.ts.map
@@ -0,0 +1,13 @@
1
+ import { Resource as $Resource } from "@awboost/cfn-template-builder/template/resource";
2
+ /**
3
+ * Resource type definition for `AWS::KafkaConnect::CustomPlugin`.
4
+ * An example resource schema demonstrating some basic constructs and validation rules.
5
+ * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-kafkaconnect-customplugin.html}
6
+ */
7
+ export class KafkaConnectCustomPlugin extends $Resource {
8
+ static Type = "AWS::KafkaConnect::CustomPlugin";
9
+ constructor(logicalId, properties, options) {
10
+ super(logicalId, KafkaConnectCustomPlugin.Type, properties, options);
11
+ }
12
+ }
13
+ //# sourceMappingURL=AWS-KafkaConnect-CustomPlugin.js.map
@@ -0,0 +1,68 @@
1
+ import { Resource as $Resource } from "@awboost/cfn-template-builder/template/resource";
2
+ import type { ResourceOptions as $ResourceOptions } from "@awboost/cfn-template-builder/template";
3
+ /**
4
+ * Resource type definition for `AWS::KafkaConnect::WorkerConfiguration`.
5
+ * The configuration of the workers, which are the processes that run the connector logic.
6
+ * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-kafkaconnect-workerconfiguration.html}
7
+ */
8
+ export type KafkaConnectWorkerConfigurationProperties = {
9
+ /**
10
+ * A summary description of the worker configuration.
11
+ * @maxLength `1024`
12
+ */
13
+ Description?: string;
14
+ /**
15
+ * The name of the worker configuration.
16
+ * @minLength `1`
17
+ * @maxLength `128`
18
+ */
19
+ Name: string;
20
+ /**
21
+ * Base64 encoded contents of connect-distributed.properties file.
22
+ */
23
+ PropertiesFileContent: string;
24
+ /**
25
+ * A collection of tags associated with a resource
26
+ */
27
+ Tags?: Tag[];
28
+ };
29
+ /**
30
+ * Attribute type definition for `AWS::KafkaConnect::WorkerConfiguration`.
31
+ * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-kafkaconnect-workerconfiguration.html#aws-resource-kafkaconnect-workerconfiguration-return-values}
32
+ */
33
+ export type KafkaConnectWorkerConfigurationAttributes = {
34
+ /**
35
+ * The description of a revision of the worker configuration.
36
+ */
37
+ Revision: number;
38
+ /**
39
+ * The Amazon Resource Name (ARN) of the custom configuration.
40
+ * @pattern `arn:(aws|aws-us-gov|aws-cn):kafkaconnect:.*`
41
+ */
42
+ WorkerConfigurationArn: string;
43
+ };
44
+ /**
45
+ * Type definition for `AWS::KafkaConnect::WorkerConfiguration.Tag`.
46
+ * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kafkaconnect-workerconfiguration-tag.html}
47
+ */
48
+ export type Tag = {
49
+ /**
50
+ * @minLength `1`
51
+ * @maxLength `128`
52
+ */
53
+ Key: string;
54
+ /**
55
+ * @maxLength `256`
56
+ */
57
+ Value: string;
58
+ };
59
+ /**
60
+ * Resource type definition for `AWS::KafkaConnect::WorkerConfiguration`.
61
+ * The configuration of the workers, which are the processes that run the connector logic.
62
+ * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-kafkaconnect-workerconfiguration.html}
63
+ */
64
+ export declare class KafkaConnectWorkerConfiguration extends $Resource<"AWS::KafkaConnect::WorkerConfiguration", KafkaConnectWorkerConfigurationProperties, KafkaConnectWorkerConfigurationAttributes> {
65
+ static readonly Type = "AWS::KafkaConnect::WorkerConfiguration";
66
+ constructor(logicalId: string, properties: KafkaConnectWorkerConfigurationProperties, options?: $ResourceOptions);
67
+ }
68
+ //# sourceMappingURL=AWS-KafkaConnect-WorkerConfiguration.d.ts.map
@@ -0,0 +1,13 @@
1
+ import { Resource as $Resource } from "@awboost/cfn-template-builder/template/resource";
2
+ /**
3
+ * Resource type definition for `AWS::KafkaConnect::WorkerConfiguration`.
4
+ * The configuration of the workers, which are the processes that run the connector logic.
5
+ * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-kafkaconnect-workerconfiguration.html}
6
+ */
7
+ export class KafkaConnectWorkerConfiguration extends $Resource {
8
+ static Type = "AWS::KafkaConnect::WorkerConfiguration";
9
+ constructor(logicalId, properties, options) {
10
+ super(logicalId, KafkaConnectWorkerConfiguration.Type, properties, options);
11
+ }
12
+ }
13
+ //# sourceMappingURL=AWS-KafkaConnect-WorkerConfiguration.js.map
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@awboost/cfn-resource-types",
3
- "version": "0.1.43",
3
+ "version": "0.1.45",
4
4
  "publishConfig": {
5
5
  "access": "public"
6
6
  },