diff --git a/5.x/_gen/data/cognito_identity_pool.libsonnet b/5.x/_gen/data/cognito_identity_pool.libsonnet new file mode 100644 index 00000000..6f9095e7 --- /dev/null +++ b/5.x/_gen/data/cognito_identity_pool.libsonnet @@ -0,0 +1,45 @@ +local tf = (import 'github.com/tf-libsonnet/core/main.libsonnet'); +local d = (import 'github.com/jsonnet-libs/docsonnet/doc-util/main.libsonnet'); +{ + '#':: d.pkg(name='cognito_identity_pool', url='', help='`cognito_identity_pool` represents the `aws_cognito_identity_pool` Terraform data source.\n\n\n\nThis package contains functions and utilities for setting up the data source using Jsonnet code.\n'), + '#new':: d.fn(help="\n`aws.data.cognito_identity_pool.new` injects a new `data_aws_cognito_identity_pool` Terraform `data source`\nblock into the root module document.\n\nAdditionally, this inserts a private function into the `_ref` attribute that generates references to attributes of the\nresource. For example, if you added a new instance to the root using:\n\n # arguments omitted for brevity\n aws.data.cognito_identity_pool.new('some_id')\n\nYou can get the reference to the `id` field of the created `aws.data.cognito_identity_pool` using the reference:\n\n $._ref.data_aws_cognito_identity_pool.some_id.get('id')\n\nThis is the same as directly entering `\"${ data_aws_cognito_identity_pool.some_id.id }\"` as the value.\n\nNOTE: if you are chaining multiple resources together in a merge operation, you may not be able to use `super`, `self`,\nor `$` to refer to the root object. Instead, make an explicit outer object using `local`.\n\n**Args**:\n - `dataSrcLabel` (`string`): The name label of the block.\n - `identity_pool_name` (`string`): Set the `identity_pool_name` field on the resulting data source block.\n - `tags` (`obj`): Set the `tags` field on the resulting data source block. When `null`, the `tags` field will be omitted from the resulting object.\n\n**Returns**:\n- A mixin object that injects the new data source into the root Terraform configuration.\n", args=[]), + new( + dataSrcLabel, + identity_pool_name, + tags=null, + _meta={} + ):: tf.withData( + type='aws_cognito_identity_pool', + label=dataSrcLabel, + attrs=self.newAttrs(identity_pool_name=identity_pool_name, tags=tags), + _meta=_meta + ), + '#newAttrs':: d.fn(help='\n`aws.data.cognito_identity_pool.newAttrs` constructs a new object with attributes and blocks configured for the `cognito_identity_pool`\nTerraform data source.\n\nUnlike [aws.data.cognito_identity_pool.new](#fn-new), this function will not inject the `data source`\nblock into the root Terraform document. Instead, this must be passed in as the `attrs` argument for the\n[tf.withData](https://github.com/tf-libsonnet/core/tree/main/docs#fn-withdata) function to build a complete block.\n\nThis is most useful when you need to preprocess the attributes with functions, conditional, or looping logic prior to\ninjecting into a complete block.\n\n**Args**:\n - `identity_pool_name` (`string`): Set the `identity_pool_name` field on the resulting object.\n - `tags` (`obj`): Set the `tags` field on the resulting object. When `null`, the `tags` field will be omitted from the resulting object.\n\n**Returns**:\n - An attribute object that can be used with [tf.withData](https://github.com/tf-libsonnet/core/tree/main/docs#fn-withdata) to construct a new `cognito_identity_pool` data source into the root Terraform configuration.\n', args=[]), + newAttrs( + identity_pool_name, + tags=null + ):: std.prune(a={ + identity_pool_name: identity_pool_name, + tags: tags, + }), + '#withIdentityPoolName':: d.fn(help='`aws.string.withIdentityPoolName` constructs a mixin object that can be merged into the `string`\nTerraform data source block to set or update the identity_pool_name field.\n\n\n\n**Args**:\n - `dataSrcLabel` (`string`): The name label of the block to update.\n - `value` (`string`): The value to set for the `identity_pool_name` field.\n', args=[]), + withIdentityPoolName(dataSrcLabel, value): { + data+: { + aws_cognito_identity_pool+: { + [dataSrcLabel]+: { + identity_pool_name: value, + }, + }, + }, + }, + '#withTags':: d.fn(help='`aws.obj.withTags` constructs a mixin object that can be merged into the `obj`\nTerraform data source block to set or update the tags field.\n\n\n\n**Args**:\n - `dataSrcLabel` (`string`): The name label of the block to update.\n - `value` (`obj`): The value to set for the `tags` field.\n', args=[]), + withTags(dataSrcLabel, value): { + data+: { + aws_cognito_identity_pool+: { + [dataSrcLabel]+: { + tags: value, + }, + }, + }, + }, +} diff --git a/5.x/_gen/data/dms_endpoint.libsonnet b/5.x/_gen/data/dms_endpoint.libsonnet index 5dec387f..348cba1c 100644 --- a/5.x/_gen/data/dms_endpoint.libsonnet +++ b/5.x/_gen/data/dms_endpoint.libsonnet @@ -2,89 +2,26 @@ local tf = (import 'github.com/tf-libsonnet/core/main.libsonnet'); local d = (import 'github.com/jsonnet-libs/docsonnet/doc-util/main.libsonnet'); { '#':: d.pkg(name='dms_endpoint', url='', help='`dms_endpoint` represents the `aws_dms_endpoint` Terraform data source.\n\n\n\nThis package contains functions and utilities for setting up the data source using Jsonnet code.\n'), - elasticsearch_settings:: { - '#new':: d.fn(help='\n`aws.dms_endpoint.elasticsearch_settings.new` constructs a new object with attributes and blocks configured for the `elasticsearch_settings`\nTerraform sub block.\n\n\n\n**Args**:\n - `endpoint_uri` (`string`): Set the `endpoint_uri` field on the resulting object.\n - `service_access_role_arn` (`string`): Set the `service_access_role_arn` field on the resulting object.\n\n**Returns**:\n - An attribute object that represents the `elasticsearch_settings` sub block.\n', args=[]), - new( - endpoint_uri, - service_access_role_arn - ):: std.prune(a={ - endpoint_uri: endpoint_uri, - service_access_role_arn: service_access_role_arn, - }), - }, - kafka_settings:: { - '#new':: d.fn(help='\n`aws.dms_endpoint.kafka_settings.new` constructs a new object with attributes and blocks configured for the `kafka_settings`\nTerraform sub block.\n\n\n\n**Args**:\n - `broker` (`string`): Set the `broker` field on the resulting object.\n\n**Returns**:\n - An attribute object that represents the `kafka_settings` sub block.\n', args=[]), - new( - broker - ):: std.prune(a={ - broker: broker, - }), - }, - mongodb_settings:: { - '#new':: d.fn(help='\n`aws.dms_endpoint.mongodb_settings.new` constructs a new object with attributes and blocks configured for the `mongodb_settings`\nTerraform sub block.\n\n\n\n**Returns**:\n - An attribute object that represents the `mongodb_settings` sub block.\n', args=[]), - new( - - ):: std.prune(a={}), - }, - '#new':: d.fn(help="\n`aws.data.dms_endpoint.new` injects a new `data_aws_dms_endpoint` Terraform `data source`\nblock into the root module document.\n\nAdditionally, this inserts a private function into the `_ref` attribute that generates references to attributes of the\nresource. For example, if you added a new instance to the root using:\n\n # arguments omitted for brevity\n aws.data.dms_endpoint.new('some_id')\n\nYou can get the reference to the `id` field of the created `aws.data.dms_endpoint` using the reference:\n\n $._ref.data_aws_dms_endpoint.some_id.get('id')\n\nThis is the same as directly entering `\"${ data_aws_dms_endpoint.some_id.id }\"` as the value.\n\nNOTE: if you are chaining multiple resources together in a merge operation, you may not be able to use `super`, `self`,\nor `$` to refer to the root object. Instead, make an explicit outer object using `local`.\n\n**Args**:\n - `dataSrcLabel` (`string`): The name label of the block.\n - `endpoint_id` (`string`): Set the `endpoint_id` field on the resulting data source block.\n - `extra_connection_attributes` (`string`): Set the `extra_connection_attributes` field on the resulting data source block. When `null`, the `extra_connection_attributes` field will be omitted from the resulting object.\n - `tags` (`obj`): Set the `tags` field on the resulting data source block. When `null`, the `tags` field will be omitted from the resulting object.\n - `elasticsearch_settings` (`list[obj]`): Set the `elasticsearch_settings` field on the resulting data source block. When `null`, the `elasticsearch_settings` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [aws.data.dms_endpoint.elasticsearch_settings.new](#fn-elasticsearch_settingsnew) constructor.\n - `kafka_settings` (`list[obj]`): Set the `kafka_settings` field on the resulting data source block. When `null`, the `kafka_settings` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [aws.data.dms_endpoint.kafka_settings.new](#fn-kafka_settingsnew) constructor.\n - `mongodb_settings` (`list[obj]`): Set the `mongodb_settings` field on the resulting data source block. When `null`, the `mongodb_settings` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [aws.data.dms_endpoint.mongodb_settings.new](#fn-mongodb_settingsnew) constructor.\n\n**Returns**:\n- A mixin object that injects the new data source into the root Terraform configuration.\n", args=[]), + '#new':: d.fn(help="\n`aws.data.dms_endpoint.new` injects a new `data_aws_dms_endpoint` Terraform `data source`\nblock into the root module document.\n\nAdditionally, this inserts a private function into the `_ref` attribute that generates references to attributes of the\nresource. For example, if you added a new instance to the root using:\n\n # arguments omitted for brevity\n aws.data.dms_endpoint.new('some_id')\n\nYou can get the reference to the `id` field of the created `aws.data.dms_endpoint` using the reference:\n\n $._ref.data_aws_dms_endpoint.some_id.get('id')\n\nThis is the same as directly entering `\"${ data_aws_dms_endpoint.some_id.id }\"` as the value.\n\nNOTE: if you are chaining multiple resources together in a merge operation, you may not be able to use `super`, `self`,\nor `$` to refer to the root object. Instead, make an explicit outer object using `local`.\n\n**Args**:\n - `dataSrcLabel` (`string`): The name label of the block.\n - `endpoint_id` (`string`): Set the `endpoint_id` field on the resulting data source block.\n - `tags` (`obj`): Set the `tags` field on the resulting data source block. When `null`, the `tags` field will be omitted from the resulting object.\n\n**Returns**:\n- A mixin object that injects the new data source into the root Terraform configuration.\n", args=[]), new( dataSrcLabel, endpoint_id, - elasticsearch_settings=null, - extra_connection_attributes=null, - kafka_settings=null, - mongodb_settings=null, tags=null, _meta={} ):: tf.withData( type='aws_dms_endpoint', label=dataSrcLabel, - attrs=self.newAttrs( - elasticsearch_settings=elasticsearch_settings, - endpoint_id=endpoint_id, - extra_connection_attributes=extra_connection_attributes, - kafka_settings=kafka_settings, - mongodb_settings=mongodb_settings, - tags=tags - ), + attrs=self.newAttrs(endpoint_id=endpoint_id, tags=tags), _meta=_meta ), - '#newAttrs':: d.fn(help='\n`aws.data.dms_endpoint.newAttrs` constructs a new object with attributes and blocks configured for the `dms_endpoint`\nTerraform data source.\n\nUnlike [aws.data.dms_endpoint.new](#fn-new), this function will not inject the `data source`\nblock into the root Terraform document. Instead, this must be passed in as the `attrs` argument for the\n[tf.withData](https://github.com/tf-libsonnet/core/tree/main/docs#fn-withdata) function to build a complete block.\n\nThis is most useful when you need to preprocess the attributes with functions, conditional, or looping logic prior to\ninjecting into a complete block.\n\n**Args**:\n - `endpoint_id` (`string`): Set the `endpoint_id` field on the resulting object.\n - `extra_connection_attributes` (`string`): Set the `extra_connection_attributes` field on the resulting object. When `null`, the `extra_connection_attributes` field will be omitted from the resulting object.\n - `tags` (`obj`): Set the `tags` field on the resulting object. When `null`, the `tags` field will be omitted from the resulting object.\n - `elasticsearch_settings` (`list[obj]`): Set the `elasticsearch_settings` field on the resulting object. When `null`, the `elasticsearch_settings` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [aws.data.dms_endpoint.elasticsearch_settings.new](#fn-elasticsearch_settingsnew) constructor.\n - `kafka_settings` (`list[obj]`): Set the `kafka_settings` field on the resulting object. When `null`, the `kafka_settings` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [aws.data.dms_endpoint.kafka_settings.new](#fn-kafka_settingsnew) constructor.\n - `mongodb_settings` (`list[obj]`): Set the `mongodb_settings` field on the resulting object. When `null`, the `mongodb_settings` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [aws.data.dms_endpoint.mongodb_settings.new](#fn-mongodb_settingsnew) constructor.\n\n**Returns**:\n - An attribute object that can be used with [tf.withData](https://github.com/tf-libsonnet/core/tree/main/docs#fn-withdata) to construct a new `dms_endpoint` data source into the root Terraform configuration.\n', args=[]), + '#newAttrs':: d.fn(help='\n`aws.data.dms_endpoint.newAttrs` constructs a new object with attributes and blocks configured for the `dms_endpoint`\nTerraform data source.\n\nUnlike [aws.data.dms_endpoint.new](#fn-new), this function will not inject the `data source`\nblock into the root Terraform document. Instead, this must be passed in as the `attrs` argument for the\n[tf.withData](https://github.com/tf-libsonnet/core/tree/main/docs#fn-withdata) function to build a complete block.\n\nThis is most useful when you need to preprocess the attributes with functions, conditional, or looping logic prior to\ninjecting into a complete block.\n\n**Args**:\n - `endpoint_id` (`string`): Set the `endpoint_id` field on the resulting object.\n - `tags` (`obj`): Set the `tags` field on the resulting object. When `null`, the `tags` field will be omitted from the resulting object.\n\n**Returns**:\n - An attribute object that can be used with [tf.withData](https://github.com/tf-libsonnet/core/tree/main/docs#fn-withdata) to construct a new `dms_endpoint` data source into the root Terraform configuration.\n', args=[]), newAttrs( endpoint_id, - elasticsearch_settings=null, - extra_connection_attributes=null, - kafka_settings=null, - mongodb_settings=null, tags=null ):: std.prune(a={ - elasticsearch_settings: elasticsearch_settings, endpoint_id: endpoint_id, - extra_connection_attributes: extra_connection_attributes, - kafka_settings: kafka_settings, - mongodb_settings: mongodb_settings, tags: tags, }), - '#withElasticsearchSettings':: d.fn(help='`aws.list[obj].withElasticsearchSettings` constructs a mixin object that can be merged into the `list[obj]`\nTerraform data source block to set or update the elasticsearch_settings field.\n\nThis function will replace the array with the passed in `value`. If you wish to instead append the\npassed in value to the existing array, use the [aws.list[obj].withElasticsearchSettingsMixin](TODO) function.\n\n\n**Args**:\n - `dataSrcLabel` (`string`): The name label of the block to update.\n - `value` (`list[obj]`): The value to set for the `elasticsearch_settings` field.\n', args=[]), - withElasticsearchSettings(dataSrcLabel, value): { - data+: { - aws_dms_endpoint+: { - [dataSrcLabel]+: { - elasticsearch_settings: value, - }, - }, - }, - }, - '#withElasticsearchSettingsMixin':: d.fn(help='`aws.list[obj].withElasticsearchSettingsMixin` constructs a mixin object that can be merged into the `list[obj]`\nTerraform data source block to set or update the elasticsearch_settings field.\n\nThis function will append the passed in array or object to the existing array. If you wish\nto instead replace the array with the passed in `value`, use the [aws.list[obj].withElasticsearchSettings](TODO)\nfunction.\n\n\n**Args**:\n - `dataSrcLabel` (`string`): The name label of the block to update.\n - `value` (`list[obj]`): The value to set for the `elasticsearch_settings` field.\n', args=[]), - withElasticsearchSettingsMixin(dataSrcLabel, value): { - data+: { - aws_dms_endpoint+: { - [dataSrcLabel]+: { - elasticsearch_settings+: if std.isArray(v=value) then value else [value], - }, - }, - }, - }, '#withEndpointId':: d.fn(help='`aws.string.withEndpointId` constructs a mixin object that can be merged into the `string`\nTerraform data source block to set or update the endpoint_id field.\n\n\n\n**Args**:\n - `dataSrcLabel` (`string`): The name label of the block to update.\n - `value` (`string`): The value to set for the `endpoint_id` field.\n', args=[]), withEndpointId(dataSrcLabel, value): { data+: { @@ -95,56 +32,6 @@ local d = (import 'github.com/jsonnet-libs/docsonnet/doc-util/main.libsonnet'); }, }, }, - '#withExtraConnectionAttributes':: d.fn(help='`aws.string.withExtraConnectionAttributes` constructs a mixin object that can be merged into the `string`\nTerraform data source block to set or update the extra_connection_attributes field.\n\n\n\n**Args**:\n - `dataSrcLabel` (`string`): The name label of the block to update.\n - `value` (`string`): The value to set for the `extra_connection_attributes` field.\n', args=[]), - withExtraConnectionAttributes(dataSrcLabel, value): { - data+: { - aws_dms_endpoint+: { - [dataSrcLabel]+: { - extra_connection_attributes: value, - }, - }, - }, - }, - '#withKafkaSettings':: d.fn(help='`aws.list[obj].withKafkaSettings` constructs a mixin object that can be merged into the `list[obj]`\nTerraform data source block to set or update the kafka_settings field.\n\nThis function will replace the array with the passed in `value`. If you wish to instead append the\npassed in value to the existing array, use the [aws.list[obj].withKafkaSettingsMixin](TODO) function.\n\n\n**Args**:\n - `dataSrcLabel` (`string`): The name label of the block to update.\n - `value` (`list[obj]`): The value to set for the `kafka_settings` field.\n', args=[]), - withKafkaSettings(dataSrcLabel, value): { - data+: { - aws_dms_endpoint+: { - [dataSrcLabel]+: { - kafka_settings: value, - }, - }, - }, - }, - '#withKafkaSettingsMixin':: d.fn(help='`aws.list[obj].withKafkaSettingsMixin` constructs a mixin object that can be merged into the `list[obj]`\nTerraform data source block to set or update the kafka_settings field.\n\nThis function will append the passed in array or object to the existing array. If you wish\nto instead replace the array with the passed in `value`, use the [aws.list[obj].withKafkaSettings](TODO)\nfunction.\n\n\n**Args**:\n - `dataSrcLabel` (`string`): The name label of the block to update.\n - `value` (`list[obj]`): The value to set for the `kafka_settings` field.\n', args=[]), - withKafkaSettingsMixin(dataSrcLabel, value): { - data+: { - aws_dms_endpoint+: { - [dataSrcLabel]+: { - kafka_settings+: if std.isArray(v=value) then value else [value], - }, - }, - }, - }, - '#withMongodbSettings':: d.fn(help='`aws.list[obj].withMongodbSettings` constructs a mixin object that can be merged into the `list[obj]`\nTerraform data source block to set or update the mongodb_settings field.\n\nThis function will replace the array with the passed in `value`. If you wish to instead append the\npassed in value to the existing array, use the [aws.list[obj].withMongodbSettingsMixin](TODO) function.\n\n\n**Args**:\n - `dataSrcLabel` (`string`): The name label of the block to update.\n - `value` (`list[obj]`): The value to set for the `mongodb_settings` field.\n', args=[]), - withMongodbSettings(dataSrcLabel, value): { - data+: { - aws_dms_endpoint+: { - [dataSrcLabel]+: { - mongodb_settings: value, - }, - }, - }, - }, - '#withMongodbSettingsMixin':: d.fn(help='`aws.list[obj].withMongodbSettingsMixin` constructs a mixin object that can be merged into the `list[obj]`\nTerraform data source block to set or update the mongodb_settings field.\n\nThis function will append the passed in array or object to the existing array. If you wish\nto instead replace the array with the passed in `value`, use the [aws.list[obj].withMongodbSettings](TODO)\nfunction.\n\n\n**Args**:\n - `dataSrcLabel` (`string`): The name label of the block to update.\n - `value` (`list[obj]`): The value to set for the `mongodb_settings` field.\n', args=[]), - withMongodbSettingsMixin(dataSrcLabel, value): { - data+: { - aws_dms_endpoint+: { - [dataSrcLabel]+: { - mongodb_settings+: if std.isArray(v=value) then value else [value], - }, - }, - }, - }, '#withTags':: d.fn(help='`aws.obj.withTags` constructs a mixin object that can be merged into the `obj`\nTerraform data source block to set or update the tags field.\n\n\n\n**Args**:\n - `dataSrcLabel` (`string`): The name label of the block to update.\n - `value` (`obj`): The value to set for the `tags` field.\n', args=[]), withTags(dataSrcLabel, value): { data+: { diff --git a/5.x/_gen/data/identitystore_group.libsonnet b/5.x/_gen/data/identitystore_group.libsonnet index f5219eb8..ebb87f9d 100644 --- a/5.x/_gen/data/identitystore_group.libsonnet +++ b/5.x/_gen/data/identitystore_group.libsonnet @@ -30,26 +30,44 @@ local d = (import 'github.com/jsonnet-libs/docsonnet/doc-util/main.libsonnet'); }), }, }, - '#new':: d.fn(help="\n`aws.data.identitystore_group.new` injects a new `data_aws_identitystore_group` Terraform `data source`\nblock into the root module document.\n\nAdditionally, this inserts a private function into the `_ref` attribute that generates references to attributes of the\nresource. For example, if you added a new instance to the root using:\n\n # arguments omitted for brevity\n aws.data.identitystore_group.new('some_id')\n\nYou can get the reference to the `id` field of the created `aws.data.identitystore_group` using the reference:\n\n $._ref.data_aws_identitystore_group.some_id.get('id')\n\nThis is the same as directly entering `\"${ data_aws_identitystore_group.some_id.id }\"` as the value.\n\nNOTE: if you are chaining multiple resources together in a merge operation, you may not be able to use `super`, `self`,\nor `$` to refer to the root object. Instead, make an explicit outer object using `local`.\n\n**Args**:\n - `dataSrcLabel` (`string`): The name label of the block.\n - `group_id` (`string`): Set the `group_id` field on the resulting data source block. When `null`, the `group_id` field will be omitted from the resulting object.\n - `identity_store_id` (`string`): Set the `identity_store_id` field on the resulting data source block.\n - `alternate_identifier` (`list[obj]`): Set the `alternate_identifier` field on the resulting data source block. When `null`, the `alternate_identifier` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [aws.data.identitystore_group.alternate_identifier.new](#fn-alternate_identifiernew) constructor.\n\n**Returns**:\n- A mixin object that injects the new data source into the root Terraform configuration.\n", args=[]), + filter:: { + '#new':: d.fn(help='\n`aws.identitystore_group.filter.new` constructs a new object with attributes and blocks configured for the `filter`\nTerraform sub block.\n\n\n\n**Args**:\n - `attribute_path` (`string`): Set the `attribute_path` field on the resulting object.\n - `attribute_value` (`string`): Set the `attribute_value` field on the resulting object.\n\n**Returns**:\n - An attribute object that represents the `filter` sub block.\n', args=[]), + new( + attribute_path, + attribute_value + ):: std.prune(a={ + attribute_path: attribute_path, + attribute_value: attribute_value, + }), + }, + '#new':: d.fn(help="\n`aws.data.identitystore_group.new` injects a new `data_aws_identitystore_group` Terraform `data source`\nblock into the root module document.\n\nAdditionally, this inserts a private function into the `_ref` attribute that generates references to attributes of the\nresource. For example, if you added a new instance to the root using:\n\n # arguments omitted for brevity\n aws.data.identitystore_group.new('some_id')\n\nYou can get the reference to the `id` field of the created `aws.data.identitystore_group` using the reference:\n\n $._ref.data_aws_identitystore_group.some_id.get('id')\n\nThis is the same as directly entering `\"${ data_aws_identitystore_group.some_id.id }\"` as the value.\n\nNOTE: if you are chaining multiple resources together in a merge operation, you may not be able to use `super`, `self`,\nor `$` to refer to the root object. Instead, make an explicit outer object using `local`.\n\n**Args**:\n - `dataSrcLabel` (`string`): The name label of the block.\n - `group_id` (`string`): Set the `group_id` field on the resulting data source block. When `null`, the `group_id` field will be omitted from the resulting object.\n - `identity_store_id` (`string`): Set the `identity_store_id` field on the resulting data source block.\n - `alternate_identifier` (`list[obj]`): Set the `alternate_identifier` field on the resulting data source block. When `null`, the `alternate_identifier` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [aws.data.identitystore_group.alternate_identifier.new](#fn-alternate_identifiernew) constructor.\n - `filter` (`list[obj]`): Set the `filter` field on the resulting data source block. When `null`, the `filter` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [aws.data.identitystore_group.filter.new](#fn-filternew) constructor.\n\n**Returns**:\n- A mixin object that injects the new data source into the root Terraform configuration.\n", args=[]), new( dataSrcLabel, identity_store_id, alternate_identifier=null, + filter=null, group_id=null, _meta={} ):: tf.withData( type='aws_identitystore_group', label=dataSrcLabel, - attrs=self.newAttrs(alternate_identifier=alternate_identifier, group_id=group_id, identity_store_id=identity_store_id), + attrs=self.newAttrs( + alternate_identifier=alternate_identifier, + filter=filter, + group_id=group_id, + identity_store_id=identity_store_id + ), _meta=_meta ), - '#newAttrs':: d.fn(help='\n`aws.data.identitystore_group.newAttrs` constructs a new object with attributes and blocks configured for the `identitystore_group`\nTerraform data source.\n\nUnlike [aws.data.identitystore_group.new](#fn-new), this function will not inject the `data source`\nblock into the root Terraform document. Instead, this must be passed in as the `attrs` argument for the\n[tf.withData](https://github.com/tf-libsonnet/core/tree/main/docs#fn-withdata) function to build a complete block.\n\nThis is most useful when you need to preprocess the attributes with functions, conditional, or looping logic prior to\ninjecting into a complete block.\n\n**Args**:\n - `group_id` (`string`): Set the `group_id` field on the resulting object. When `null`, the `group_id` field will be omitted from the resulting object.\n - `identity_store_id` (`string`): Set the `identity_store_id` field on the resulting object.\n - `alternate_identifier` (`list[obj]`): Set the `alternate_identifier` field on the resulting object. When `null`, the `alternate_identifier` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [aws.data.identitystore_group.alternate_identifier.new](#fn-alternate_identifiernew) constructor.\n\n**Returns**:\n - An attribute object that can be used with [tf.withData](https://github.com/tf-libsonnet/core/tree/main/docs#fn-withdata) to construct a new `identitystore_group` data source into the root Terraform configuration.\n', args=[]), + '#newAttrs':: d.fn(help='\n`aws.data.identitystore_group.newAttrs` constructs a new object with attributes and blocks configured for the `identitystore_group`\nTerraform data source.\n\nUnlike [aws.data.identitystore_group.new](#fn-new), this function will not inject the `data source`\nblock into the root Terraform document. Instead, this must be passed in as the `attrs` argument for the\n[tf.withData](https://github.com/tf-libsonnet/core/tree/main/docs#fn-withdata) function to build a complete block.\n\nThis is most useful when you need to preprocess the attributes with functions, conditional, or looping logic prior to\ninjecting into a complete block.\n\n**Args**:\n - `group_id` (`string`): Set the `group_id` field on the resulting object. When `null`, the `group_id` field will be omitted from the resulting object.\n - `identity_store_id` (`string`): Set the `identity_store_id` field on the resulting object.\n - `alternate_identifier` (`list[obj]`): Set the `alternate_identifier` field on the resulting object. When `null`, the `alternate_identifier` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [aws.data.identitystore_group.alternate_identifier.new](#fn-alternate_identifiernew) constructor.\n - `filter` (`list[obj]`): Set the `filter` field on the resulting object. When `null`, the `filter` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [aws.data.identitystore_group.filter.new](#fn-filternew) constructor.\n\n**Returns**:\n - An attribute object that can be used with [tf.withData](https://github.com/tf-libsonnet/core/tree/main/docs#fn-withdata) to construct a new `identitystore_group` data source into the root Terraform configuration.\n', args=[]), newAttrs( identity_store_id, alternate_identifier=null, + filter=null, group_id=null ):: std.prune(a={ alternate_identifier: alternate_identifier, + filter: filter, group_id: group_id, identity_store_id: identity_store_id, }), @@ -73,6 +91,26 @@ local d = (import 'github.com/jsonnet-libs/docsonnet/doc-util/main.libsonnet'); }, }, }, + '#withFilter':: d.fn(help='`aws.list[obj].withFilter` constructs a mixin object that can be merged into the `list[obj]`\nTerraform data source block to set or update the filter field.\n\nThis function will replace the array with the passed in `value`. If you wish to instead append the\npassed in value to the existing array, use the [aws.list[obj].withFilterMixin](TODO) function.\n\n\n**Args**:\n - `dataSrcLabel` (`string`): The name label of the block to update.\n - `value` (`list[obj]`): The value to set for the `filter` field.\n', args=[]), + withFilter(dataSrcLabel, value): { + data+: { + aws_identitystore_group+: { + [dataSrcLabel]+: { + filter: value, + }, + }, + }, + }, + '#withFilterMixin':: d.fn(help='`aws.list[obj].withFilterMixin` constructs a mixin object that can be merged into the `list[obj]`\nTerraform data source block to set or update the filter field.\n\nThis function will append the passed in array or object to the existing array. If you wish\nto instead replace the array with the passed in `value`, use the [aws.list[obj].withFilter](TODO)\nfunction.\n\n\n**Args**:\n - `dataSrcLabel` (`string`): The name label of the block to update.\n - `value` (`list[obj]`): The value to set for the `filter` field.\n', args=[]), + withFilterMixin(dataSrcLabel, value): { + data+: { + aws_identitystore_group+: { + [dataSrcLabel]+: { + filter+: if std.isArray(v=value) then value else [value], + }, + }, + }, + }, '#withGroupId':: d.fn(help='`aws.string.withGroupId` constructs a mixin object that can be merged into the `string`\nTerraform data source block to set or update the group_id field.\n\n\n\n**Args**:\n - `dataSrcLabel` (`string`): The name label of the block to update.\n - `value` (`string`): The value to set for the `group_id` field.\n', args=[]), withGroupId(dataSrcLabel, value): { data+: { diff --git a/5.x/_gen/data/identitystore_user.libsonnet b/5.x/_gen/data/identitystore_user.libsonnet index a796bfea..18b3e5a8 100644 --- a/5.x/_gen/data/identitystore_user.libsonnet +++ b/5.x/_gen/data/identitystore_user.libsonnet @@ -30,26 +30,44 @@ local d = (import 'github.com/jsonnet-libs/docsonnet/doc-util/main.libsonnet'); }), }, }, - '#new':: d.fn(help="\n`aws.data.identitystore_user.new` injects a new `data_aws_identitystore_user` Terraform `data source`\nblock into the root module document.\n\nAdditionally, this inserts a private function into the `_ref` attribute that generates references to attributes of the\nresource. For example, if you added a new instance to the root using:\n\n # arguments omitted for brevity\n aws.data.identitystore_user.new('some_id')\n\nYou can get the reference to the `id` field of the created `aws.data.identitystore_user` using the reference:\n\n $._ref.data_aws_identitystore_user.some_id.get('id')\n\nThis is the same as directly entering `\"${ data_aws_identitystore_user.some_id.id }\"` as the value.\n\nNOTE: if you are chaining multiple resources together in a merge operation, you may not be able to use `super`, `self`,\nor `$` to refer to the root object. Instead, make an explicit outer object using `local`.\n\n**Args**:\n - `dataSrcLabel` (`string`): The name label of the block.\n - `identity_store_id` (`string`): Set the `identity_store_id` field on the resulting data source block.\n - `user_id` (`string`): Set the `user_id` field on the resulting data source block. When `null`, the `user_id` field will be omitted from the resulting object.\n - `alternate_identifier` (`list[obj]`): Set the `alternate_identifier` field on the resulting data source block. When `null`, the `alternate_identifier` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [aws.data.identitystore_user.alternate_identifier.new](#fn-alternate_identifiernew) constructor.\n\n**Returns**:\n- A mixin object that injects the new data source into the root Terraform configuration.\n", args=[]), + filter:: { + '#new':: d.fn(help='\n`aws.identitystore_user.filter.new` constructs a new object with attributes and blocks configured for the `filter`\nTerraform sub block.\n\n\n\n**Args**:\n - `attribute_path` (`string`): Set the `attribute_path` field on the resulting object.\n - `attribute_value` (`string`): Set the `attribute_value` field on the resulting object.\n\n**Returns**:\n - An attribute object that represents the `filter` sub block.\n', args=[]), + new( + attribute_path, + attribute_value + ):: std.prune(a={ + attribute_path: attribute_path, + attribute_value: attribute_value, + }), + }, + '#new':: d.fn(help="\n`aws.data.identitystore_user.new` injects a new `data_aws_identitystore_user` Terraform `data source`\nblock into the root module document.\n\nAdditionally, this inserts a private function into the `_ref` attribute that generates references to attributes of the\nresource. For example, if you added a new instance to the root using:\n\n # arguments omitted for brevity\n aws.data.identitystore_user.new('some_id')\n\nYou can get the reference to the `id` field of the created `aws.data.identitystore_user` using the reference:\n\n $._ref.data_aws_identitystore_user.some_id.get('id')\n\nThis is the same as directly entering `\"${ data_aws_identitystore_user.some_id.id }\"` as the value.\n\nNOTE: if you are chaining multiple resources together in a merge operation, you may not be able to use `super`, `self`,\nor `$` to refer to the root object. Instead, make an explicit outer object using `local`.\n\n**Args**:\n - `dataSrcLabel` (`string`): The name label of the block.\n - `identity_store_id` (`string`): Set the `identity_store_id` field on the resulting data source block.\n - `user_id` (`string`): Set the `user_id` field on the resulting data source block. When `null`, the `user_id` field will be omitted from the resulting object.\n - `alternate_identifier` (`list[obj]`): Set the `alternate_identifier` field on the resulting data source block. When `null`, the `alternate_identifier` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [aws.data.identitystore_user.alternate_identifier.new](#fn-alternate_identifiernew) constructor.\n - `filter` (`list[obj]`): Set the `filter` field on the resulting data source block. When `null`, the `filter` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [aws.data.identitystore_user.filter.new](#fn-filternew) constructor.\n\n**Returns**:\n- A mixin object that injects the new data source into the root Terraform configuration.\n", args=[]), new( dataSrcLabel, identity_store_id, alternate_identifier=null, + filter=null, user_id=null, _meta={} ):: tf.withData( type='aws_identitystore_user', label=dataSrcLabel, - attrs=self.newAttrs(alternate_identifier=alternate_identifier, identity_store_id=identity_store_id, user_id=user_id), + attrs=self.newAttrs( + alternate_identifier=alternate_identifier, + filter=filter, + identity_store_id=identity_store_id, + user_id=user_id + ), _meta=_meta ), - '#newAttrs':: d.fn(help='\n`aws.data.identitystore_user.newAttrs` constructs a new object with attributes and blocks configured for the `identitystore_user`\nTerraform data source.\n\nUnlike [aws.data.identitystore_user.new](#fn-new), this function will not inject the `data source`\nblock into the root Terraform document. Instead, this must be passed in as the `attrs` argument for the\n[tf.withData](https://github.com/tf-libsonnet/core/tree/main/docs#fn-withdata) function to build a complete block.\n\nThis is most useful when you need to preprocess the attributes with functions, conditional, or looping logic prior to\ninjecting into a complete block.\n\n**Args**:\n - `identity_store_id` (`string`): Set the `identity_store_id` field on the resulting object.\n - `user_id` (`string`): Set the `user_id` field on the resulting object. When `null`, the `user_id` field will be omitted from the resulting object.\n - `alternate_identifier` (`list[obj]`): Set the `alternate_identifier` field on the resulting object. When `null`, the `alternate_identifier` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [aws.data.identitystore_user.alternate_identifier.new](#fn-alternate_identifiernew) constructor.\n\n**Returns**:\n - An attribute object that can be used with [tf.withData](https://github.com/tf-libsonnet/core/tree/main/docs#fn-withdata) to construct a new `identitystore_user` data source into the root Terraform configuration.\n', args=[]), + '#newAttrs':: d.fn(help='\n`aws.data.identitystore_user.newAttrs` constructs a new object with attributes and blocks configured for the `identitystore_user`\nTerraform data source.\n\nUnlike [aws.data.identitystore_user.new](#fn-new), this function will not inject the `data source`\nblock into the root Terraform document. Instead, this must be passed in as the `attrs` argument for the\n[tf.withData](https://github.com/tf-libsonnet/core/tree/main/docs#fn-withdata) function to build a complete block.\n\nThis is most useful when you need to preprocess the attributes with functions, conditional, or looping logic prior to\ninjecting into a complete block.\n\n**Args**:\n - `identity_store_id` (`string`): Set the `identity_store_id` field on the resulting object.\n - `user_id` (`string`): Set the `user_id` field on the resulting object. When `null`, the `user_id` field will be omitted from the resulting object.\n - `alternate_identifier` (`list[obj]`): Set the `alternate_identifier` field on the resulting object. When `null`, the `alternate_identifier` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [aws.data.identitystore_user.alternate_identifier.new](#fn-alternate_identifiernew) constructor.\n - `filter` (`list[obj]`): Set the `filter` field on the resulting object. When `null`, the `filter` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [aws.data.identitystore_user.filter.new](#fn-filternew) constructor.\n\n**Returns**:\n - An attribute object that can be used with [tf.withData](https://github.com/tf-libsonnet/core/tree/main/docs#fn-withdata) to construct a new `identitystore_user` data source into the root Terraform configuration.\n', args=[]), newAttrs( identity_store_id, alternate_identifier=null, + filter=null, user_id=null ):: std.prune(a={ alternate_identifier: alternate_identifier, + filter: filter, identity_store_id: identity_store_id, user_id: user_id, }), @@ -73,6 +91,26 @@ local d = (import 'github.com/jsonnet-libs/docsonnet/doc-util/main.libsonnet'); }, }, }, + '#withFilter':: d.fn(help='`aws.list[obj].withFilter` constructs a mixin object that can be merged into the `list[obj]`\nTerraform data source block to set or update the filter field.\n\nThis function will replace the array with the passed in `value`. If you wish to instead append the\npassed in value to the existing array, use the [aws.list[obj].withFilterMixin](TODO) function.\n\n\n**Args**:\n - `dataSrcLabel` (`string`): The name label of the block to update.\n - `value` (`list[obj]`): The value to set for the `filter` field.\n', args=[]), + withFilter(dataSrcLabel, value): { + data+: { + aws_identitystore_user+: { + [dataSrcLabel]+: { + filter: value, + }, + }, + }, + }, + '#withFilterMixin':: d.fn(help='`aws.list[obj].withFilterMixin` constructs a mixin object that can be merged into the `list[obj]`\nTerraform data source block to set or update the filter field.\n\nThis function will append the passed in array or object to the existing array. If you wish\nto instead replace the array with the passed in `value`, use the [aws.list[obj].withFilter](TODO)\nfunction.\n\n\n**Args**:\n - `dataSrcLabel` (`string`): The name label of the block to update.\n - `value` (`list[obj]`): The value to set for the `filter` field.\n', args=[]), + withFilterMixin(dataSrcLabel, value): { + data+: { + aws_identitystore_user+: { + [dataSrcLabel]+: { + filter+: if std.isArray(v=value) then value else [value], + }, + }, + }, + }, '#withIdentityStoreId':: d.fn(help='`aws.string.withIdentityStoreId` constructs a mixin object that can be merged into the `string`\nTerraform data source block to set or update the identity_store_id field.\n\n\n\n**Args**:\n - `dataSrcLabel` (`string`): The name label of the block to update.\n - `value` (`string`): The value to set for the `identity_store_id` field.\n', args=[]), withIdentityStoreId(dataSrcLabel, value): { data+: { diff --git a/5.x/_gen/data/main.libsonnet b/5.x/_gen/data/main.libsonnet index c0a7a1ee..4c13a929 100644 --- a/5.x/_gen/data/main.libsonnet +++ b/5.x/_gen/data/main.libsonnet @@ -81,6 +81,7 @@ local d = (import 'github.com/jsonnet-libs/docsonnet/doc-util/main.libsonnet'); codecommit_approval_rule_template: (import 'codecommit_approval_rule_template.libsonnet'), codecommit_repository: (import 'codecommit_repository.libsonnet'), codestarconnections_connection: (import 'codestarconnections_connection.libsonnet'), + cognito_identity_pool: (import 'cognito_identity_pool.libsonnet'), cognito_user_pool_client: (import 'cognito_user_pool_client.libsonnet'), cognito_user_pool_clients: (import 'cognito_user_pool_clients.libsonnet'), cognito_user_pool_signing_certificate: (import 'cognito_user_pool_signing_certificate.libsonnet'), diff --git a/5.x/_gen/data/s3_object.libsonnet b/5.x/_gen/data/s3_object.libsonnet index 6307d948..388d5381 100644 --- a/5.x/_gen/data/s3_object.libsonnet +++ b/5.x/_gen/data/s3_object.libsonnet @@ -2,11 +2,12 @@ local tf = (import 'github.com/tf-libsonnet/core/main.libsonnet'); local d = (import 'github.com/jsonnet-libs/docsonnet/doc-util/main.libsonnet'); { '#':: d.pkg(name='s3_object', url='', help='`s3_object` represents the `aws_s3_object` Terraform data source.\n\n\n\nThis package contains functions and utilities for setting up the data source using Jsonnet code.\n'), - '#new':: d.fn(help="\n`aws.data.s3_object.new` injects a new `data_aws_s3_object` Terraform `data source`\nblock into the root module document.\n\nAdditionally, this inserts a private function into the `_ref` attribute that generates references to attributes of the\nresource. For example, if you added a new instance to the root using:\n\n # arguments omitted for brevity\n aws.data.s3_object.new('some_id')\n\nYou can get the reference to the `id` field of the created `aws.data.s3_object` using the reference:\n\n $._ref.data_aws_s3_object.some_id.get('id')\n\nThis is the same as directly entering `\"${ data_aws_s3_object.some_id.id }\"` as the value.\n\nNOTE: if you are chaining multiple resources together in a merge operation, you may not be able to use `super`, `self`,\nor `$` to refer to the root object. Instead, make an explicit outer object using `local`.\n\n**Args**:\n - `dataSrcLabel` (`string`): The name label of the block.\n - `bucket` (`string`): Set the `bucket` field on the resulting data source block.\n - `key` (`string`): Set the `key` field on the resulting data source block.\n - `range` (`string`): Set the `range` field on the resulting data source block. When `null`, the `range` field will be omitted from the resulting object.\n - `tags` (`obj`): Set the `tags` field on the resulting data source block. When `null`, the `tags` field will be omitted from the resulting object.\n - `version_id` (`string`): Set the `version_id` field on the resulting data source block. When `null`, the `version_id` field will be omitted from the resulting object.\n\n**Returns**:\n- A mixin object that injects the new data source into the root Terraform configuration.\n", args=[]), + '#new':: d.fn(help="\n`aws.data.s3_object.new` injects a new `data_aws_s3_object` Terraform `data source`\nblock into the root module document.\n\nAdditionally, this inserts a private function into the `_ref` attribute that generates references to attributes of the\nresource. For example, if you added a new instance to the root using:\n\n # arguments omitted for brevity\n aws.data.s3_object.new('some_id')\n\nYou can get the reference to the `id` field of the created `aws.data.s3_object` using the reference:\n\n $._ref.data_aws_s3_object.some_id.get('id')\n\nThis is the same as directly entering `\"${ data_aws_s3_object.some_id.id }\"` as the value.\n\nNOTE: if you are chaining multiple resources together in a merge operation, you may not be able to use `super`, `self`,\nor `$` to refer to the root object. Instead, make an explicit outer object using `local`.\n\n**Args**:\n - `dataSrcLabel` (`string`): The name label of the block.\n - `bucket` (`string`): Set the `bucket` field on the resulting data source block.\n - `checksum_mode` (`string`): Set the `checksum_mode` field on the resulting data source block. When `null`, the `checksum_mode` field will be omitted from the resulting object.\n - `key` (`string`): Set the `key` field on the resulting data source block.\n - `range` (`string`): Set the `range` field on the resulting data source block. When `null`, the `range` field will be omitted from the resulting object.\n - `tags` (`obj`): Set the `tags` field on the resulting data source block. When `null`, the `tags` field will be omitted from the resulting object.\n - `version_id` (`string`): Set the `version_id` field on the resulting data source block. When `null`, the `version_id` field will be omitted from the resulting object.\n\n**Returns**:\n- A mixin object that injects the new data source into the root Terraform configuration.\n", args=[]), new( dataSrcLabel, bucket, key, + checksum_mode=null, range=null, tags=null, version_id=null, @@ -16,6 +17,7 @@ local d = (import 'github.com/jsonnet-libs/docsonnet/doc-util/main.libsonnet'); label=dataSrcLabel, attrs=self.newAttrs( bucket=bucket, + checksum_mode=checksum_mode, key=key, range=range, tags=tags, @@ -23,15 +25,17 @@ local d = (import 'github.com/jsonnet-libs/docsonnet/doc-util/main.libsonnet'); ), _meta=_meta ), - '#newAttrs':: d.fn(help='\n`aws.data.s3_object.newAttrs` constructs a new object with attributes and blocks configured for the `s3_object`\nTerraform data source.\n\nUnlike [aws.data.s3_object.new](#fn-new), this function will not inject the `data source`\nblock into the root Terraform document. Instead, this must be passed in as the `attrs` argument for the\n[tf.withData](https://github.com/tf-libsonnet/core/tree/main/docs#fn-withdata) function to build a complete block.\n\nThis is most useful when you need to preprocess the attributes with functions, conditional, or looping logic prior to\ninjecting into a complete block.\n\n**Args**:\n - `bucket` (`string`): Set the `bucket` field on the resulting object.\n - `key` (`string`): Set the `key` field on the resulting object.\n - `range` (`string`): Set the `range` field on the resulting object. When `null`, the `range` field will be omitted from the resulting object.\n - `tags` (`obj`): Set the `tags` field on the resulting object. When `null`, the `tags` field will be omitted from the resulting object.\n - `version_id` (`string`): Set the `version_id` field on the resulting object. When `null`, the `version_id` field will be omitted from the resulting object.\n\n**Returns**:\n - An attribute object that can be used with [tf.withData](https://github.com/tf-libsonnet/core/tree/main/docs#fn-withdata) to construct a new `s3_object` data source into the root Terraform configuration.\n', args=[]), + '#newAttrs':: d.fn(help='\n`aws.data.s3_object.newAttrs` constructs a new object with attributes and blocks configured for the `s3_object`\nTerraform data source.\n\nUnlike [aws.data.s3_object.new](#fn-new), this function will not inject the `data source`\nblock into the root Terraform document. Instead, this must be passed in as the `attrs` argument for the\n[tf.withData](https://github.com/tf-libsonnet/core/tree/main/docs#fn-withdata) function to build a complete block.\n\nThis is most useful when you need to preprocess the attributes with functions, conditional, or looping logic prior to\ninjecting into a complete block.\n\n**Args**:\n - `bucket` (`string`): Set the `bucket` field on the resulting object.\n - `checksum_mode` (`string`): Set the `checksum_mode` field on the resulting object. When `null`, the `checksum_mode` field will be omitted from the resulting object.\n - `key` (`string`): Set the `key` field on the resulting object.\n - `range` (`string`): Set the `range` field on the resulting object. When `null`, the `range` field will be omitted from the resulting object.\n - `tags` (`obj`): Set the `tags` field on the resulting object. When `null`, the `tags` field will be omitted from the resulting object.\n - `version_id` (`string`): Set the `version_id` field on the resulting object. When `null`, the `version_id` field will be omitted from the resulting object.\n\n**Returns**:\n - An attribute object that can be used with [tf.withData](https://github.com/tf-libsonnet/core/tree/main/docs#fn-withdata) to construct a new `s3_object` data source into the root Terraform configuration.\n', args=[]), newAttrs( bucket, key, + checksum_mode=null, range=null, tags=null, version_id=null ):: std.prune(a={ bucket: bucket, + checksum_mode: checksum_mode, key: key, range: range, tags: tags, @@ -47,6 +51,16 @@ local d = (import 'github.com/jsonnet-libs/docsonnet/doc-util/main.libsonnet'); }, }, }, + '#withChecksumMode':: d.fn(help='`aws.string.withChecksumMode` constructs a mixin object that can be merged into the `string`\nTerraform data source block to set or update the checksum_mode field.\n\n\n\n**Args**:\n - `dataSrcLabel` (`string`): The name label of the block to update.\n - `value` (`string`): The value to set for the `checksum_mode` field.\n', args=[]), + withChecksumMode(dataSrcLabel, value): { + data+: { + aws_s3_object+: { + [dataSrcLabel]+: { + checksum_mode: value, + }, + }, + }, + }, '#withKey':: d.fn(help='`aws.string.withKey` constructs a mixin object that can be merged into the `string`\nTerraform data source block to set or update the key field.\n\n\n\n**Args**:\n - `dataSrcLabel` (`string`): The name label of the block to update.\n - `value` (`string`): The value to set for the `key` field.\n', args=[]), withKey(dataSrcLabel, value): { data+: { diff --git a/5.x/_gen/data/s3_objects.libsonnet b/5.x/_gen/data/s3_objects.libsonnet index 5657a268..9c205e4c 100644 --- a/5.x/_gen/data/s3_objects.libsonnet +++ b/5.x/_gen/data/s3_objects.libsonnet @@ -2,7 +2,7 @@ local tf = (import 'github.com/tf-libsonnet/core/main.libsonnet'); local d = (import 'github.com/jsonnet-libs/docsonnet/doc-util/main.libsonnet'); { '#':: d.pkg(name='s3_objects', url='', help='`s3_objects` represents the `aws_s3_objects` Terraform data source.\n\n\n\nThis package contains functions and utilities for setting up the data source using Jsonnet code.\n'), - '#new':: d.fn(help="\n`aws.data.s3_objects.new` injects a new `data_aws_s3_objects` Terraform `data source`\nblock into the root module document.\n\nAdditionally, this inserts a private function into the `_ref` attribute that generates references to attributes of the\nresource. For example, if you added a new instance to the root using:\n\n # arguments omitted for brevity\n aws.data.s3_objects.new('some_id')\n\nYou can get the reference to the `id` field of the created `aws.data.s3_objects` using the reference:\n\n $._ref.data_aws_s3_objects.some_id.get('id')\n\nThis is the same as directly entering `\"${ data_aws_s3_objects.some_id.id }\"` as the value.\n\nNOTE: if you are chaining multiple resources together in a merge operation, you may not be able to use `super`, `self`,\nor `$` to refer to the root object. Instead, make an explicit outer object using `local`.\n\n**Args**:\n - `dataSrcLabel` (`string`): The name label of the block.\n - `bucket` (`string`): Set the `bucket` field on the resulting data source block.\n - `delimiter` (`string`): Set the `delimiter` field on the resulting data source block. When `null`, the `delimiter` field will be omitted from the resulting object.\n - `encoding_type` (`string`): Set the `encoding_type` field on the resulting data source block. When `null`, the `encoding_type` field will be omitted from the resulting object.\n - `fetch_owner` (`bool`): Set the `fetch_owner` field on the resulting data source block. When `null`, the `fetch_owner` field will be omitted from the resulting object.\n - `max_keys` (`number`): Set the `max_keys` field on the resulting data source block. When `null`, the `max_keys` field will be omitted from the resulting object.\n - `prefix` (`string`): Set the `prefix` field on the resulting data source block. When `null`, the `prefix` field will be omitted from the resulting object.\n - `start_after` (`string`): Set the `start_after` field on the resulting data source block. When `null`, the `start_after` field will be omitted from the resulting object.\n\n**Returns**:\n- A mixin object that injects the new data source into the root Terraform configuration.\n", args=[]), + '#new':: d.fn(help="\n`aws.data.s3_objects.new` injects a new `data_aws_s3_objects` Terraform `data source`\nblock into the root module document.\n\nAdditionally, this inserts a private function into the `_ref` attribute that generates references to attributes of the\nresource. For example, if you added a new instance to the root using:\n\n # arguments omitted for brevity\n aws.data.s3_objects.new('some_id')\n\nYou can get the reference to the `id` field of the created `aws.data.s3_objects` using the reference:\n\n $._ref.data_aws_s3_objects.some_id.get('id')\n\nThis is the same as directly entering `\"${ data_aws_s3_objects.some_id.id }\"` as the value.\n\nNOTE: if you are chaining multiple resources together in a merge operation, you may not be able to use `super`, `self`,\nor `$` to refer to the root object. Instead, make an explicit outer object using `local`.\n\n**Args**:\n - `dataSrcLabel` (`string`): The name label of the block.\n - `bucket` (`string`): Set the `bucket` field on the resulting data source block.\n - `delimiter` (`string`): Set the `delimiter` field on the resulting data source block. When `null`, the `delimiter` field will be omitted from the resulting object.\n - `encoding_type` (`string`): Set the `encoding_type` field on the resulting data source block. When `null`, the `encoding_type` field will be omitted from the resulting object.\n - `fetch_owner` (`bool`): Set the `fetch_owner` field on the resulting data source block. When `null`, the `fetch_owner` field will be omitted from the resulting object.\n - `max_keys` (`number`): Set the `max_keys` field on the resulting data source block. When `null`, the `max_keys` field will be omitted from the resulting object.\n - `prefix` (`string`): Set the `prefix` field on the resulting data source block. When `null`, the `prefix` field will be omitted from the resulting object.\n - `request_payer` (`string`): Set the `request_payer` field on the resulting data source block. When `null`, the `request_payer` field will be omitted from the resulting object.\n - `start_after` (`string`): Set the `start_after` field on the resulting data source block. When `null`, the `start_after` field will be omitted from the resulting object.\n\n**Returns**:\n- A mixin object that injects the new data source into the root Terraform configuration.\n", args=[]), new( dataSrcLabel, bucket, @@ -11,6 +11,7 @@ local d = (import 'github.com/jsonnet-libs/docsonnet/doc-util/main.libsonnet'); fetch_owner=null, max_keys=null, prefix=null, + request_payer=null, start_after=null, _meta={} ):: tf.withData( @@ -23,11 +24,12 @@ local d = (import 'github.com/jsonnet-libs/docsonnet/doc-util/main.libsonnet'); fetch_owner=fetch_owner, max_keys=max_keys, prefix=prefix, + request_payer=request_payer, start_after=start_after ), _meta=_meta ), - '#newAttrs':: d.fn(help='\n`aws.data.s3_objects.newAttrs` constructs a new object with attributes and blocks configured for the `s3_objects`\nTerraform data source.\n\nUnlike [aws.data.s3_objects.new](#fn-new), this function will not inject the `data source`\nblock into the root Terraform document. Instead, this must be passed in as the `attrs` argument for the\n[tf.withData](https://github.com/tf-libsonnet/core/tree/main/docs#fn-withdata) function to build a complete block.\n\nThis is most useful when you need to preprocess the attributes with functions, conditional, or looping logic prior to\ninjecting into a complete block.\n\n**Args**:\n - `bucket` (`string`): Set the `bucket` field on the resulting object.\n - `delimiter` (`string`): Set the `delimiter` field on the resulting object. When `null`, the `delimiter` field will be omitted from the resulting object.\n - `encoding_type` (`string`): Set the `encoding_type` field on the resulting object. When `null`, the `encoding_type` field will be omitted from the resulting object.\n - `fetch_owner` (`bool`): Set the `fetch_owner` field on the resulting object. When `null`, the `fetch_owner` field will be omitted from the resulting object.\n - `max_keys` (`number`): Set the `max_keys` field on the resulting object. When `null`, the `max_keys` field will be omitted from the resulting object.\n - `prefix` (`string`): Set the `prefix` field on the resulting object. When `null`, the `prefix` field will be omitted from the resulting object.\n - `start_after` (`string`): Set the `start_after` field on the resulting object. When `null`, the `start_after` field will be omitted from the resulting object.\n\n**Returns**:\n - An attribute object that can be used with [tf.withData](https://github.com/tf-libsonnet/core/tree/main/docs#fn-withdata) to construct a new `s3_objects` data source into the root Terraform configuration.\n', args=[]), + '#newAttrs':: d.fn(help='\n`aws.data.s3_objects.newAttrs` constructs a new object with attributes and blocks configured for the `s3_objects`\nTerraform data source.\n\nUnlike [aws.data.s3_objects.new](#fn-new), this function will not inject the `data source`\nblock into the root Terraform document. Instead, this must be passed in as the `attrs` argument for the\n[tf.withData](https://github.com/tf-libsonnet/core/tree/main/docs#fn-withdata) function to build a complete block.\n\nThis is most useful when you need to preprocess the attributes with functions, conditional, or looping logic prior to\ninjecting into a complete block.\n\n**Args**:\n - `bucket` (`string`): Set the `bucket` field on the resulting object.\n - `delimiter` (`string`): Set the `delimiter` field on the resulting object. When `null`, the `delimiter` field will be omitted from the resulting object.\n - `encoding_type` (`string`): Set the `encoding_type` field on the resulting object. When `null`, the `encoding_type` field will be omitted from the resulting object.\n - `fetch_owner` (`bool`): Set the `fetch_owner` field on the resulting object. When `null`, the `fetch_owner` field will be omitted from the resulting object.\n - `max_keys` (`number`): Set the `max_keys` field on the resulting object. When `null`, the `max_keys` field will be omitted from the resulting object.\n - `prefix` (`string`): Set the `prefix` field on the resulting object. When `null`, the `prefix` field will be omitted from the resulting object.\n - `request_payer` (`string`): Set the `request_payer` field on the resulting object. When `null`, the `request_payer` field will be omitted from the resulting object.\n - `start_after` (`string`): Set the `start_after` field on the resulting object. When `null`, the `start_after` field will be omitted from the resulting object.\n\n**Returns**:\n - An attribute object that can be used with [tf.withData](https://github.com/tf-libsonnet/core/tree/main/docs#fn-withdata) to construct a new `s3_objects` data source into the root Terraform configuration.\n', args=[]), newAttrs( bucket, delimiter=null, @@ -35,6 +37,7 @@ local d = (import 'github.com/jsonnet-libs/docsonnet/doc-util/main.libsonnet'); fetch_owner=null, max_keys=null, prefix=null, + request_payer=null, start_after=null ):: std.prune(a={ bucket: bucket, @@ -43,6 +46,7 @@ local d = (import 'github.com/jsonnet-libs/docsonnet/doc-util/main.libsonnet'); fetch_owner: fetch_owner, max_keys: max_keys, prefix: prefix, + request_payer: request_payer, start_after: start_after, }), '#withBucket':: d.fn(help='`aws.string.withBucket` constructs a mixin object that can be merged into the `string`\nTerraform data source block to set or update the bucket field.\n\n\n\n**Args**:\n - `dataSrcLabel` (`string`): The name label of the block to update.\n - `value` (`string`): The value to set for the `bucket` field.\n', args=[]), @@ -105,6 +109,16 @@ local d = (import 'github.com/jsonnet-libs/docsonnet/doc-util/main.libsonnet'); }, }, }, + '#withRequestPayer':: d.fn(help='`aws.string.withRequestPayer` constructs a mixin object that can be merged into the `string`\nTerraform data source block to set or update the request_payer field.\n\n\n\n**Args**:\n - `dataSrcLabel` (`string`): The name label of the block to update.\n - `value` (`string`): The value to set for the `request_payer` field.\n', args=[]), + withRequestPayer(dataSrcLabel, value): { + data+: { + aws_s3_objects+: { + [dataSrcLabel]+: { + request_payer: value, + }, + }, + }, + }, '#withStartAfter':: d.fn(help='`aws.string.withStartAfter` constructs a mixin object that can be merged into the `string`\nTerraform data source block to set or update the start_after field.\n\n\n\n**Args**:\n - `dataSrcLabel` (`string`): The name label of the block to update.\n - `value` (`string`): The value to set for the `start_after` field.\n', args=[]), withStartAfter(dataSrcLabel, value): { data+: { diff --git a/5.x/_gen/main.libsonnet b/5.x/_gen/main.libsonnet index 85094712..b125915a 100644 --- a/5.x/_gen/main.libsonnet +++ b/5.x/_gen/main.libsonnet @@ -292,8 +292,10 @@ local d = (import 'github.com/jsonnet-libs/docsonnet/doc-util/main.libsonnet'); datapipeline_pipeline: (import 'resources/datapipeline_pipeline.libsonnet'), datapipeline_pipeline_definition: (import 'resources/datapipeline_pipeline_definition.libsonnet'), datasync_agent: (import 'resources/datasync_agent.libsonnet'), + datasync_location_azure_blob: (import 'resources/datasync_location_azure_blob.libsonnet'), datasync_location_efs: (import 'resources/datasync_location_efs.libsonnet'), datasync_location_fsx_lustre_file_system: (import 'resources/datasync_location_fsx_lustre_file_system.libsonnet'), + datasync_location_fsx_ontap_file_system: (import 'resources/datasync_location_fsx_ontap_file_system.libsonnet'), datasync_location_fsx_openzfs_file_system: (import 'resources/datasync_location_fsx_openzfs_file_system.libsonnet'), datasync_location_fsx_windows_file_system: (import 'resources/datasync_location_fsx_windows_file_system.libsonnet'), datasync_location_hdfs: (import 'resources/datasync_location_hdfs.libsonnet'), @@ -748,6 +750,7 @@ local d = (import 'github.com/jsonnet-libs/docsonnet/doc-util/main.libsonnet'); mq_broker: (import 'resources/mq_broker.libsonnet'), mq_configuration: (import 'resources/mq_configuration.libsonnet'), msk_cluster: (import 'resources/msk_cluster.libsonnet'), + msk_cluster_policy: (import 'resources/msk_cluster_policy.libsonnet'), msk_configuration: (import 'resources/msk_configuration.libsonnet'), msk_scram_secret_association: (import 'resources/msk_scram_secret_association.libsonnet'), msk_serverless_cluster: (import 'resources/msk_serverless_cluster.libsonnet'), @@ -803,6 +806,7 @@ local d = (import 'github.com/jsonnet-libs/docsonnet/doc-util/main.libsonnet'); opensearch_domain_saml_options: (import 'resources/opensearch_domain_saml_options.libsonnet'), opensearch_inbound_connection_accepter: (import 'resources/opensearch_inbound_connection_accepter.libsonnet'), opensearch_outbound_connection: (import 'resources/opensearch_outbound_connection.libsonnet'), + opensearch_vpc_endpoint: (import 'resources/opensearch_vpc_endpoint.libsonnet'), opensearchserverless_access_policy: (import 'resources/opensearchserverless_access_policy.libsonnet'), opensearchserverless_collection: (import 'resources/opensearchserverless_collection.libsonnet'), opensearchserverless_security_config: (import 'resources/opensearchserverless_security_config.libsonnet'), @@ -873,6 +877,7 @@ local d = (import 'github.com/jsonnet-libs/docsonnet/doc-util/main.libsonnet'); ram_resource_association: (import 'resources/ram_resource_association.libsonnet'), ram_resource_share: (import 'resources/ram_resource_share.libsonnet'), ram_resource_share_accepter: (import 'resources/ram_resource_share_accepter.libsonnet'), + ram_sharing_with_organization: (import 'resources/ram_sharing_with_organization.libsonnet'), rbin_rule: (import 'resources/rbin_rule.libsonnet'), rds_cluster: (import 'resources/rds_cluster.libsonnet'), rds_cluster_activity_stream: (import 'resources/rds_cluster_activity_stream.libsonnet'), @@ -1083,6 +1088,9 @@ local d = (import 'github.com/jsonnet-libs/docsonnet/doc-util/main.libsonnet'); sfn_activity: (import 'resources/sfn_activity.libsonnet'), sfn_alias: (import 'resources/sfn_alias.libsonnet'), sfn_state_machine: (import 'resources/sfn_state_machine.libsonnet'), + shield_application_layer_automatic_response: (import 'resources/shield_application_layer_automatic_response.libsonnet'), + shield_drt_access_log_bucket_association: (import 'resources/shield_drt_access_log_bucket_association.libsonnet'), + shield_drt_access_role_arn_association: (import 'resources/shield_drt_access_role_arn_association.libsonnet'), shield_protection: (import 'resources/shield_protection.libsonnet'), shield_protection_group: (import 'resources/shield_protection_group.libsonnet'), shield_protection_health_check_association: (import 'resources/shield_protection_health_check_association.libsonnet'), @@ -1159,6 +1167,8 @@ local d = (import 'github.com/jsonnet-libs/docsonnet/doc-util/main.libsonnet'); transfer_tag: (import 'resources/transfer_tag.libsonnet'), transfer_user: (import 'resources/transfer_user.libsonnet'), transfer_workflow: (import 'resources/transfer_workflow.libsonnet'), + verifiedaccess_instance: (import 'resources/verifiedaccess_instance.libsonnet'), + verifiedaccess_trust_provider: (import 'resources/verifiedaccess_trust_provider.libsonnet'), volume_attachment: (import 'resources/volume_attachment.libsonnet'), vpc: (import 'resources/vpc.libsonnet'), vpc_dhcp_options: (import 'resources/vpc_dhcp_options.libsonnet'), diff --git a/5.x/_gen/provider_aws.libsonnet b/5.x/_gen/provider_aws.libsonnet index f76443f5..2c6d4de5 100644 --- a/5.x/_gen/provider_aws.libsonnet +++ b/5.x/_gen/provider_aws.libsonnet @@ -2,7 +2,7 @@ local tf = (import 'github.com/tf-libsonnet/core/main.libsonnet'); local d = (import 'github.com/jsonnet-libs/docsonnet/doc-util/main.libsonnet'); { '#':: d.pkg(name='provider', url='', help='`provider` represents the `aws` Terraform provider config.\n\n\n\nThis package contains functions and utilities for setting up the provider using Jsonnet code.\n'), - '#new':: d.fn(help='\n`aws.provider.new` injects a new `aws` Terraform `provider`\nblock into the root module document.\n\nOptionally, this inserts the provider into the\n[required_providers](https://developer.hashicorp.com/terraform/language/providers/requirements) `terraform` sub block if\nthe `src` and/or `version` parameters are set.\n\n**Args**:\n - `access_key` (`string`): The access key for API operations. You can retrieve this\nfrom the 'Security & Credentials' section of the AWS console. When `null`, the `access_key` field will be omitted from the resulting object.\n - `allowed_account_ids` (`list`): Set the `allowed_account_ids` field on the resulting provider block. When `null`, the `allowed_account_ids` field will be omitted from the resulting object.\n - `custom_ca_bundle` (`string`): File containing custom root and intermediate certificates. Can also be configured using the `AWS_CA_BUNDLE` environment variable. (Setting `ca_bundle` in the shared config file is not supported.) When `null`, the `custom_ca_bundle` field will be omitted from the resulting object.\n - `ec2_metadata_service_endpoint` (`string`): Address of the EC2 metadata service endpoint to use. Can also be configured using the `AWS_EC2_METADATA_SERVICE_ENDPOINT` environment variable. When `null`, the `ec2_metadata_service_endpoint` field will be omitted from the resulting object.\n - `ec2_metadata_service_endpoint_mode` (`string`): Protocol to use with EC2 metadata service endpoint.Valid values are `IPv4` and `IPv6`. Can also be configured using the `AWS_EC2_METADATA_SERVICE_ENDPOINT_MODE` environment variable. When `null`, the `ec2_metadata_service_endpoint_mode` field will be omitted from the resulting object.\n - `forbidden_account_ids` (`list`): Set the `forbidden_account_ids` field on the resulting provider block. When `null`, the `forbidden_account_ids` field will be omitted from the resulting object.\n - `http_proxy` (`string`): The address of an HTTP proxy to use when accessing the AWS API. Can also be configured using the `HTTP_PROXY` or `HTTPS_PROXY` environment variables. When `null`, the `http_proxy` field will be omitted from the resulting object.\n - `insecure` (`bool`): Explicitly allow the provider to perform "insecure" SSL requests. If omitted, default value is `false` When `null`, the `insecure` field will be omitted from the resulting object.\n - `max_retries` (`number`): The maximum number of times an AWS API request is\nbeing executed. If the API request still fails, an error is\nthrown. When `null`, the `max_retries` field will be omitted from the resulting object.\n - `profile` (`string`): The profile for API operations. If not set, the default profile\ncreated with `aws configure` will be used. When `null`, the `profile` field will be omitted from the resulting object.\n - `region` (`string`): The region where AWS operations will take place. Examples\nare us-east-1, us-west-2, etc. When `null`, the `region` field will be omitted from the resulting object.\n - `retry_mode` (`string`): Specifies how retries are attempted. Valid values are `standard` and `adaptive`. Can also be configured using the `AWS_RETRY_MODE` environment variable. When `null`, the `retry_mode` field will be omitted from the resulting object.\n - `s3_use_path_style` (`bool`): Set this to true to enable the request to use path-style addressing,\ni.e., https://s3.amazonaws.com/BUCKET/KEY. By default, the S3 client will\nuse virtual hosted bucket addressing when possible\n(https://BUCKET.s3.amazonaws.com/KEY). Specific to the Amazon S3 service. When `null`, the `s3_use_path_style` field will be omitted from the resulting object.\n - `secret_key` (`string`): The secret key for API operations. You can retrieve this\nfrom the 'Security & Credentials' section of the AWS console. When `null`, the `secret_key` field will be omitted from the resulting object.\n - `shared_config_files` (`list`): List of paths to shared config files. If not set, defaults to [~/.aws/config]. When `null`, the `shared_config_files` field will be omitted from the resulting object.\n - `shared_credentials_files` (`list`): List of paths to shared credentials files. If not set, defaults to [~/.aws/credentials]. When `null`, the `shared_credentials_files` field will be omitted from the resulting object.\n - `skip_credentials_validation` (`bool`): Skip the credentials validation via STS API. Used for AWS API implementations that do not have STS available/implemented. When `null`, the `skip_credentials_validation` field will be omitted from the resulting object.\n - `skip_metadata_api_check` (`string`): Skip the AWS Metadata API check. Used for AWS API implementations that do not have a metadata api endpoint. When `null`, the `skip_metadata_api_check` field will be omitted from the resulting object.\n - `skip_region_validation` (`bool`): Skip static validation of region name. Used by users of alternative AWS-like APIs or users w/ access to regions that are not public (yet). When `null`, the `skip_region_validation` field will be omitted from the resulting object.\n - `skip_requesting_account_id` (`bool`): Skip requesting the account ID. Used for AWS API implementations that do not have IAM/STS API and/or metadata API. When `null`, the `skip_requesting_account_id` field will be omitted from the resulting object.\n - `sts_region` (`string`): The region where AWS STS operations will take place. Examples\nare us-east-1 and us-west-2. When `null`, the `sts_region` field will be omitted from the resulting object.\n - `token` (`string`): session token. A session token is only required if you are\nusing temporary security credentials. When `null`, the `token` field will be omitted from the resulting object.\n - `use_dualstack_endpoint` (`bool`): Resolve an endpoint with DualStack capability When `null`, the `use_dualstack_endpoint` field will be omitted from the resulting object.\n - `use_fips_endpoint` (`bool`): Resolve an endpoint with FIPS capability When `null`, the `use_fips_endpoint` field will be omitted from the resulting object.\n - `assume_role` (`list[obj]`): Set the `assume_role` field on the resulting provider block. When `null`, the `assume_role` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [aws.provider.assume_role.new](#fn-awsassumerolenew) constructor.\n - `assume_role_with_web_identity` (`list[obj]`): Set the `assume_role_with_web_identity` field on the resulting provider block. When `null`, the `assume_role_with_web_identity` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [aws.provider.assume_role_with_web_identity.new](#fn-awsassumerolewithwebidentitynew) constructor.\n - `default_tags` (`list[obj]`): Configuration block with settings to default resource tags across all resources. When `null`, the `default_tags` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [aws.provider.default_tags.new](#fn-awsdefaulttagsnew) constructor.\n - `endpoints` (`list[obj]`): Set the `endpoints` field on the resulting provider block. When `null`, the `endpoints` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [aws.provider.endpoints.new](#fn-awsendpointsnew) constructor.\n - `ignore_tags` (`list[obj]`): Configuration block with settings to ignore resource tags across all resources. When `null`, the `ignore_tags` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [aws.provider.ignore_tags.new](#fn-awsignoretagsnew) constructor.\n - `alias` (`string`): The provider `alias` to set for this instance of the provider block. When `null`, the `alias`\n field will be omitted from the resulting provider block.\n - `src` (`string`): The provider `source` to set on the resulting `required_providers` block. If `src` or `version` is\n set and is not `null`, a `required_providers` block and entry for the provider will be injected into the document.\n - `version` (`string`): The provider `version` to set on the resulting `required_providers` block. If `src` or\n `version` is set and is not `null`, a `required_providers` block and entry for the provider will be injected into the\n document.\n\n\n**Returns**:\n- A mixin object that injects the new provider (and optionally, `required_providers` block) into the root Terraform configuration.\n', args=[]), + '#new':: d.fn(help='\n`aws.provider.new` injects a new `aws` Terraform `provider`\nblock into the root module document.\n\nOptionally, this inserts the provider into the\n[required_providers](https://developer.hashicorp.com/terraform/language/providers/requirements) `terraform` sub block if\nthe `src` and/or `version` parameters are set.\n\n**Args**:\n - `access_key` (`string`): The access key for API operations. You can retrieve this\nfrom the 'Security & Credentials' section of the AWS console. When `null`, the `access_key` field will be omitted from the resulting object.\n - `allowed_account_ids` (`list`): Set the `allowed_account_ids` field on the resulting provider block. When `null`, the `allowed_account_ids` field will be omitted from the resulting object.\n - `custom_ca_bundle` (`string`): File containing custom root and intermediate certificates. Can also be configured using the `AWS_CA_BUNDLE` environment variable. (Setting `ca_bundle` in the shared config file is not supported.) When `null`, the `custom_ca_bundle` field will be omitted from the resulting object.\n - `ec2_metadata_service_endpoint` (`string`): Address of the EC2 metadata service endpoint to use. Can also be configured using the `AWS_EC2_METADATA_SERVICE_ENDPOINT` environment variable. When `null`, the `ec2_metadata_service_endpoint` field will be omitted from the resulting object.\n - `ec2_metadata_service_endpoint_mode` (`string`): Protocol to use with EC2 metadata service endpoint.Valid values are `IPv4` and `IPv6`. Can also be configured using the `AWS_EC2_METADATA_SERVICE_ENDPOINT_MODE` environment variable. When `null`, the `ec2_metadata_service_endpoint_mode` field will be omitted from the resulting object.\n - `forbidden_account_ids` (`list`): Set the `forbidden_account_ids` field on the resulting provider block. When `null`, the `forbidden_account_ids` field will be omitted from the resulting object.\n - `http_proxy` (`string`): The address of an HTTP proxy to use when accessing the AWS API. Can also be configured using the `HTTP_PROXY` or `HTTPS_PROXY` environment variables. When `null`, the `http_proxy` field will be omitted from the resulting object.\n - `insecure` (`bool`): Explicitly allow the provider to perform "insecure" SSL requests. If omitted, default value is `false` When `null`, the `insecure` field will be omitted from the resulting object.\n - `max_retries` (`number`): The maximum number of times an AWS API request is\nbeing executed. If the API request still fails, an error is\nthrown. When `null`, the `max_retries` field will be omitted from the resulting object.\n - `profile` (`string`): The profile for API operations. If not set, the default profile\ncreated with `aws configure` will be used. When `null`, the `profile` field will be omitted from the resulting object.\n - `region` (`string`): The region where AWS operations will take place. Examples\nare us-east-1, us-west-2, etc. When `null`, the `region` field will be omitted from the resulting object.\n - `retry_mode` (`string`): Specifies how retries are attempted. Valid values are `standard` and `adaptive`. Can also be configured using the `AWS_RETRY_MODE` environment variable. When `null`, the `retry_mode` field will be omitted from the resulting object.\n - `s3_us_east_1_regional_endpoint` (`string`): Specifies whether S3 API calls in the `us-east-1` region use the legacy global endpoint or a regional endpoint. Valid values are `legacy` or `regional`. Can also be configured using the `AWS_S3_US_EAST_1_REGIONAL_ENDPOINT` environment variable or the `s3_us_east_1_regional_endpoint` shared config file parameter When `null`, the `s3_us_east_1_regional_endpoint` field will be omitted from the resulting object.\n - `s3_use_path_style` (`bool`): Set this to true to enable the request to use path-style addressing,\ni.e., https://s3.amazonaws.com/BUCKET/KEY. By default, the S3 client will\nuse virtual hosted bucket addressing when possible\n(https://BUCKET.s3.amazonaws.com/KEY). Specific to the Amazon S3 service. When `null`, the `s3_use_path_style` field will be omitted from the resulting object.\n - `secret_key` (`string`): The secret key for API operations. You can retrieve this\nfrom the 'Security & Credentials' section of the AWS console. When `null`, the `secret_key` field will be omitted from the resulting object.\n - `shared_config_files` (`list`): List of paths to shared config files. If not set, defaults to [~/.aws/config]. When `null`, the `shared_config_files` field will be omitted from the resulting object.\n - `shared_credentials_files` (`list`): List of paths to shared credentials files. If not set, defaults to [~/.aws/credentials]. When `null`, the `shared_credentials_files` field will be omitted from the resulting object.\n - `skip_credentials_validation` (`bool`): Skip the credentials validation via STS API. Used for AWS API implementations that do not have STS available/implemented. When `null`, the `skip_credentials_validation` field will be omitted from the resulting object.\n - `skip_metadata_api_check` (`string`): Skip the AWS Metadata API check. Used for AWS API implementations that do not have a metadata api endpoint. When `null`, the `skip_metadata_api_check` field will be omitted from the resulting object.\n - `skip_region_validation` (`bool`): Skip static validation of region name. Used by users of alternative AWS-like APIs or users w/ access to regions that are not public (yet). When `null`, the `skip_region_validation` field will be omitted from the resulting object.\n - `skip_requesting_account_id` (`bool`): Skip requesting the account ID. Used for AWS API implementations that do not have IAM/STS API and/or metadata API. When `null`, the `skip_requesting_account_id` field will be omitted from the resulting object.\n - `sts_region` (`string`): The region where AWS STS operations will take place. Examples\nare us-east-1 and us-west-2. When `null`, the `sts_region` field will be omitted from the resulting object.\n - `token` (`string`): session token. A session token is only required if you are\nusing temporary security credentials. When `null`, the `token` field will be omitted from the resulting object.\n - `use_dualstack_endpoint` (`bool`): Resolve an endpoint with DualStack capability When `null`, the `use_dualstack_endpoint` field will be omitted from the resulting object.\n - `use_fips_endpoint` (`bool`): Resolve an endpoint with FIPS capability When `null`, the `use_fips_endpoint` field will be omitted from the resulting object.\n - `assume_role` (`list[obj]`): Set the `assume_role` field on the resulting provider block. When `null`, the `assume_role` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [aws.provider.assume_role.new](#fn-awsassumerolenew) constructor.\n - `assume_role_with_web_identity` (`list[obj]`): Set the `assume_role_with_web_identity` field on the resulting provider block. When `null`, the `assume_role_with_web_identity` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [aws.provider.assume_role_with_web_identity.new](#fn-awsassumerolewithwebidentitynew) constructor.\n - `default_tags` (`list[obj]`): Configuration block with settings to default resource tags across all resources. When `null`, the `default_tags` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [aws.provider.default_tags.new](#fn-awsdefaulttagsnew) constructor.\n - `endpoints` (`list[obj]`): Set the `endpoints` field on the resulting provider block. When `null`, the `endpoints` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [aws.provider.endpoints.new](#fn-awsendpointsnew) constructor.\n - `ignore_tags` (`list[obj]`): Configuration block with settings to ignore resource tags across all resources. When `null`, the `ignore_tags` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [aws.provider.ignore_tags.new](#fn-awsignoretagsnew) constructor.\n - `alias` (`string`): The provider `alias` to set for this instance of the provider block. When `null`, the `alias`\n field will be omitted from the resulting provider block.\n - `src` (`string`): The provider `source` to set on the resulting `required_providers` block. If `src` or `version` is\n set and is not `null`, a `required_providers` block and entry for the provider will be injected into the document.\n - `version` (`string`): The provider `version` to set on the resulting `required_providers` block. If `src` or\n `version` is set and is not `null`, a `required_providers` block and entry for the provider will be injected into the\n document.\n\n\n**Returns**:\n- A mixin object that injects the new provider (and optionally, `required_providers` block) into the root Terraform configuration.\n', args=[]), new( access_key=null, allowed_account_ids=null, @@ -21,6 +21,7 @@ local d = (import 'github.com/jsonnet-libs/docsonnet/doc-util/main.libsonnet'); profile=null, region=null, retry_mode=null, + s3_us_east_1_regional_endpoint=null, s3_use_path_style=null, secret_key=null, shared_config_files=null, @@ -59,6 +60,7 @@ local d = (import 'github.com/jsonnet-libs/docsonnet/doc-util/main.libsonnet'); profile=profile, region=region, retry_mode=retry_mode, + s3_us_east_1_regional_endpoint=s3_us_east_1_regional_endpoint, s3_use_path_style=s3_use_path_style, secret_key=secret_key, shared_config_files=shared_config_files, @@ -73,7 +75,7 @@ local d = (import 'github.com/jsonnet-libs/docsonnet/doc-util/main.libsonnet'); use_fips_endpoint=use_fips_endpoint ) ), - '#newAttrs':: d.fn(help='\n`aws.provider.` constructs a new object with attributes and blocks configured for the `aws`\nTerraform `provider`.\n\nUnlike [aws.provider.new](#fn-awsnew), this function will not inject the `provider`\nblock into the root Terraform document. Instead, this must be passed in as the `attrs` argument for the\n[tf.withProvider](https://github.com/tf-libsonnet/core/tree/main/docs#fn-withprovider) function to build a complete block.\n\nThis is most useful when you need to preprocess the attributes with functions, conditional, or looping logic prior to\ninjecting into a complete block.\n\n**Args**:\n - `access_key` (`string`): The access key for API operations. You can retrieve this\nfrom the 'Security & Credentials' section of the AWS console. When `null`, the `access_key` field will be omitted from the resulting object.\n - `allowed_account_ids` (`list`): Set the `allowed_account_ids` field on the resulting object. When `null`, the `allowed_account_ids` field will be omitted from the resulting object.\n - `custom_ca_bundle` (`string`): File containing custom root and intermediate certificates. Can also be configured using the `AWS_CA_BUNDLE` environment variable. (Setting `ca_bundle` in the shared config file is not supported.) When `null`, the `custom_ca_bundle` field will be omitted from the resulting object.\n - `ec2_metadata_service_endpoint` (`string`): Address of the EC2 metadata service endpoint to use. Can also be configured using the `AWS_EC2_METADATA_SERVICE_ENDPOINT` environment variable. When `null`, the `ec2_metadata_service_endpoint` field will be omitted from the resulting object.\n - `ec2_metadata_service_endpoint_mode` (`string`): Protocol to use with EC2 metadata service endpoint.Valid values are `IPv4` and `IPv6`. Can also be configured using the `AWS_EC2_METADATA_SERVICE_ENDPOINT_MODE` environment variable. When `null`, the `ec2_metadata_service_endpoint_mode` field will be omitted from the resulting object.\n - `forbidden_account_ids` (`list`): Set the `forbidden_account_ids` field on the resulting object. When `null`, the `forbidden_account_ids` field will be omitted from the resulting object.\n - `http_proxy` (`string`): The address of an HTTP proxy to use when accessing the AWS API. Can also be configured using the `HTTP_PROXY` or `HTTPS_PROXY` environment variables. When `null`, the `http_proxy` field will be omitted from the resulting object.\n - `insecure` (`bool`): Explicitly allow the provider to perform "insecure" SSL requests. If omitted, default value is `false` When `null`, the `insecure` field will be omitted from the resulting object.\n - `max_retries` (`number`): The maximum number of times an AWS API request is\nbeing executed. If the API request still fails, an error is\nthrown. When `null`, the `max_retries` field will be omitted from the resulting object.\n - `profile` (`string`): The profile for API operations. If not set, the default profile\ncreated with `aws configure` will be used. When `null`, the `profile` field will be omitted from the resulting object.\n - `region` (`string`): The region where AWS operations will take place. Examples\nare us-east-1, us-west-2, etc. When `null`, the `region` field will be omitted from the resulting object.\n - `retry_mode` (`string`): Specifies how retries are attempted. Valid values are `standard` and `adaptive`. Can also be configured using the `AWS_RETRY_MODE` environment variable. When `null`, the `retry_mode` field will be omitted from the resulting object.\n - `s3_use_path_style` (`bool`): Set this to true to enable the request to use path-style addressing,\ni.e., https://s3.amazonaws.com/BUCKET/KEY. By default, the S3 client will\nuse virtual hosted bucket addressing when possible\n(https://BUCKET.s3.amazonaws.com/KEY). Specific to the Amazon S3 service. When `null`, the `s3_use_path_style` field will be omitted from the resulting object.\n - `secret_key` (`string`): The secret key for API operations. You can retrieve this\nfrom the 'Security & Credentials' section of the AWS console. When `null`, the `secret_key` field will be omitted from the resulting object.\n - `shared_config_files` (`list`): List of paths to shared config files. If not set, defaults to [~/.aws/config]. When `null`, the `shared_config_files` field will be omitted from the resulting object.\n - `shared_credentials_files` (`list`): List of paths to shared credentials files. If not set, defaults to [~/.aws/credentials]. When `null`, the `shared_credentials_files` field will be omitted from the resulting object.\n - `skip_credentials_validation` (`bool`): Skip the credentials validation via STS API. Used for AWS API implementations that do not have STS available/implemented. When `null`, the `skip_credentials_validation` field will be omitted from the resulting object.\n - `skip_metadata_api_check` (`string`): Skip the AWS Metadata API check. Used for AWS API implementations that do not have a metadata api endpoint. When `null`, the `skip_metadata_api_check` field will be omitted from the resulting object.\n - `skip_region_validation` (`bool`): Skip static validation of region name. Used by users of alternative AWS-like APIs or users w/ access to regions that are not public (yet). When `null`, the `skip_region_validation` field will be omitted from the resulting object.\n - `skip_requesting_account_id` (`bool`): Skip requesting the account ID. Used for AWS API implementations that do not have IAM/STS API and/or metadata API. When `null`, the `skip_requesting_account_id` field will be omitted from the resulting object.\n - `sts_region` (`string`): The region where AWS STS operations will take place. Examples\nare us-east-1 and us-west-2. When `null`, the `sts_region` field will be omitted from the resulting object.\n - `token` (`string`): session token. A session token is only required if you are\nusing temporary security credentials. When `null`, the `token` field will be omitted from the resulting object.\n - `use_dualstack_endpoint` (`bool`): Resolve an endpoint with DualStack capability When `null`, the `use_dualstack_endpoint` field will be omitted from the resulting object.\n - `use_fips_endpoint` (`bool`): Resolve an endpoint with FIPS capability When `null`, the `use_fips_endpoint` field will be omitted from the resulting object.\n - `assume_role` (`list[obj]`): Set the `assume_role` field on the resulting object. When `null`, the `assume_role` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [aws.provider.assume_role.new](#fn-awsassumerolenew) constructor.\n - `assume_role_with_web_identity` (`list[obj]`): Set the `assume_role_with_web_identity` field on the resulting object. When `null`, the `assume_role_with_web_identity` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [aws.provider.assume_role_with_web_identity.new](#fn-awsassumerolewithwebidentitynew) constructor.\n - `default_tags` (`list[obj]`): Configuration block with settings to default resource tags across all resources. When `null`, the `default_tags` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [aws.provider.default_tags.new](#fn-awsdefaulttagsnew) constructor.\n - `endpoints` (`list[obj]`): Set the `endpoints` field on the resulting object. When `null`, the `endpoints` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [aws.provider.endpoints.new](#fn-awsendpointsnew) constructor.\n - `ignore_tags` (`list[obj]`): Configuration block with settings to ignore resource tags across all resources. When `null`, the `ignore_tags` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [aws.provider.ignore_tags.new](#fn-awsignoretagsnew) constructor.\n\n**Returns**:\n - An attribute object that can be used with [tf.withProvider](https://github.com/tf-libsonnet/core/tree/main/docs#fn-withprovider) to construct a new `aws` provider\n configuration into the root Terraform configuration.\n', args=[]), + '#newAttrs':: d.fn(help='\n`aws.provider.` constructs a new object with attributes and blocks configured for the `aws`\nTerraform `provider`.\n\nUnlike [aws.provider.new](#fn-awsnew), this function will not inject the `provider`\nblock into the root Terraform document. Instead, this must be passed in as the `attrs` argument for the\n[tf.withProvider](https://github.com/tf-libsonnet/core/tree/main/docs#fn-withprovider) function to build a complete block.\n\nThis is most useful when you need to preprocess the attributes with functions, conditional, or looping logic prior to\ninjecting into a complete block.\n\n**Args**:\n - `access_key` (`string`): The access key for API operations. You can retrieve this\nfrom the 'Security & Credentials' section of the AWS console. When `null`, the `access_key` field will be omitted from the resulting object.\n - `allowed_account_ids` (`list`): Set the `allowed_account_ids` field on the resulting object. When `null`, the `allowed_account_ids` field will be omitted from the resulting object.\n - `custom_ca_bundle` (`string`): File containing custom root and intermediate certificates. Can also be configured using the `AWS_CA_BUNDLE` environment variable. (Setting `ca_bundle` in the shared config file is not supported.) When `null`, the `custom_ca_bundle` field will be omitted from the resulting object.\n - `ec2_metadata_service_endpoint` (`string`): Address of the EC2 metadata service endpoint to use. Can also be configured using the `AWS_EC2_METADATA_SERVICE_ENDPOINT` environment variable. When `null`, the `ec2_metadata_service_endpoint` field will be omitted from the resulting object.\n - `ec2_metadata_service_endpoint_mode` (`string`): Protocol to use with EC2 metadata service endpoint.Valid values are `IPv4` and `IPv6`. Can also be configured using the `AWS_EC2_METADATA_SERVICE_ENDPOINT_MODE` environment variable. When `null`, the `ec2_metadata_service_endpoint_mode` field will be omitted from the resulting object.\n - `forbidden_account_ids` (`list`): Set the `forbidden_account_ids` field on the resulting object. When `null`, the `forbidden_account_ids` field will be omitted from the resulting object.\n - `http_proxy` (`string`): The address of an HTTP proxy to use when accessing the AWS API. Can also be configured using the `HTTP_PROXY` or `HTTPS_PROXY` environment variables. When `null`, the `http_proxy` field will be omitted from the resulting object.\n - `insecure` (`bool`): Explicitly allow the provider to perform "insecure" SSL requests. If omitted, default value is `false` When `null`, the `insecure` field will be omitted from the resulting object.\n - `max_retries` (`number`): The maximum number of times an AWS API request is\nbeing executed. If the API request still fails, an error is\nthrown. When `null`, the `max_retries` field will be omitted from the resulting object.\n - `profile` (`string`): The profile for API operations. If not set, the default profile\ncreated with `aws configure` will be used. When `null`, the `profile` field will be omitted from the resulting object.\n - `region` (`string`): The region where AWS operations will take place. Examples\nare us-east-1, us-west-2, etc. When `null`, the `region` field will be omitted from the resulting object.\n - `retry_mode` (`string`): Specifies how retries are attempted. Valid values are `standard` and `adaptive`. Can also be configured using the `AWS_RETRY_MODE` environment variable. When `null`, the `retry_mode` field will be omitted from the resulting object.\n - `s3_us_east_1_regional_endpoint` (`string`): Specifies whether S3 API calls in the `us-east-1` region use the legacy global endpoint or a regional endpoint. Valid values are `legacy` or `regional`. Can also be configured using the `AWS_S3_US_EAST_1_REGIONAL_ENDPOINT` environment variable or the `s3_us_east_1_regional_endpoint` shared config file parameter When `null`, the `s3_us_east_1_regional_endpoint` field will be omitted from the resulting object.\n - `s3_use_path_style` (`bool`): Set this to true to enable the request to use path-style addressing,\ni.e., https://s3.amazonaws.com/BUCKET/KEY. By default, the S3 client will\nuse virtual hosted bucket addressing when possible\n(https://BUCKET.s3.amazonaws.com/KEY). Specific to the Amazon S3 service. When `null`, the `s3_use_path_style` field will be omitted from the resulting object.\n - `secret_key` (`string`): The secret key for API operations. You can retrieve this\nfrom the 'Security & Credentials' section of the AWS console. When `null`, the `secret_key` field will be omitted from the resulting object.\n - `shared_config_files` (`list`): List of paths to shared config files. If not set, defaults to [~/.aws/config]. When `null`, the `shared_config_files` field will be omitted from the resulting object.\n - `shared_credentials_files` (`list`): List of paths to shared credentials files. If not set, defaults to [~/.aws/credentials]. When `null`, the `shared_credentials_files` field will be omitted from the resulting object.\n - `skip_credentials_validation` (`bool`): Skip the credentials validation via STS API. Used for AWS API implementations that do not have STS available/implemented. When `null`, the `skip_credentials_validation` field will be omitted from the resulting object.\n - `skip_metadata_api_check` (`string`): Skip the AWS Metadata API check. Used for AWS API implementations that do not have a metadata api endpoint. When `null`, the `skip_metadata_api_check` field will be omitted from the resulting object.\n - `skip_region_validation` (`bool`): Skip static validation of region name. Used by users of alternative AWS-like APIs or users w/ access to regions that are not public (yet). When `null`, the `skip_region_validation` field will be omitted from the resulting object.\n - `skip_requesting_account_id` (`bool`): Skip requesting the account ID. Used for AWS API implementations that do not have IAM/STS API and/or metadata API. When `null`, the `skip_requesting_account_id` field will be omitted from the resulting object.\n - `sts_region` (`string`): The region where AWS STS operations will take place. Examples\nare us-east-1 and us-west-2. When `null`, the `sts_region` field will be omitted from the resulting object.\n - `token` (`string`): session token. A session token is only required if you are\nusing temporary security credentials. When `null`, the `token` field will be omitted from the resulting object.\n - `use_dualstack_endpoint` (`bool`): Resolve an endpoint with DualStack capability When `null`, the `use_dualstack_endpoint` field will be omitted from the resulting object.\n - `use_fips_endpoint` (`bool`): Resolve an endpoint with FIPS capability When `null`, the `use_fips_endpoint` field will be omitted from the resulting object.\n - `assume_role` (`list[obj]`): Set the `assume_role` field on the resulting object. When `null`, the `assume_role` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [aws.provider.assume_role.new](#fn-awsassumerolenew) constructor.\n - `assume_role_with_web_identity` (`list[obj]`): Set the `assume_role_with_web_identity` field on the resulting object. When `null`, the `assume_role_with_web_identity` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [aws.provider.assume_role_with_web_identity.new](#fn-awsassumerolewithwebidentitynew) constructor.\n - `default_tags` (`list[obj]`): Configuration block with settings to default resource tags across all resources. When `null`, the `default_tags` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [aws.provider.default_tags.new](#fn-awsdefaulttagsnew) constructor.\n - `endpoints` (`list[obj]`): Set the `endpoints` field on the resulting object. When `null`, the `endpoints` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [aws.provider.endpoints.new](#fn-awsendpointsnew) constructor.\n - `ignore_tags` (`list[obj]`): Configuration block with settings to ignore resource tags across all resources. When `null`, the `ignore_tags` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [aws.provider.ignore_tags.new](#fn-awsignoretagsnew) constructor.\n\n**Returns**:\n - An attribute object that can be used with [tf.withProvider](https://github.com/tf-libsonnet/core/tree/main/docs#fn-withprovider) to construct a new `aws` provider\n configuration into the root Terraform configuration.\n', args=[]), newAttrs( access_key=null, allowed_account_ids=null, @@ -92,6 +94,7 @@ local d = (import 'github.com/jsonnet-libs/docsonnet/doc-util/main.libsonnet'); profile=null, region=null, retry_mode=null, + s3_us_east_1_regional_endpoint=null, s3_use_path_style=null, secret_key=null, shared_config_files=null, @@ -122,6 +125,7 @@ local d = (import 'github.com/jsonnet-libs/docsonnet/doc-util/main.libsonnet'); profile: profile, region: region, retry_mode: retry_mode, + s3_us_east_1_regional_endpoint: s3_us_east_1_regional_endpoint, s3_use_path_style: s3_use_path_style, secret_key: secret_key, shared_config_files: shared_config_files, @@ -188,7 +192,7 @@ local d = (import 'github.com/jsonnet-libs/docsonnet/doc-util/main.libsonnet'); }), }, endpoints:: { - '#new':: d.fn(help='\n`aws.endpoints.new` constructs a new object with attributes and blocks configured for the `endpoints`\nTerraform sub block.\n\n\n\n**Args**:\n - `accessanalyzer` (`string`): Use this to override the default service endpoint URL When `null`, the `accessanalyzer` field will be omitted from the resulting object.\n - `account` (`string`): Use this to override the default service endpoint URL When `null`, the `account` field will be omitted from the resulting object.\n - `acm` (`string`): Use this to override the default service endpoint URL When `null`, the `acm` field will be omitted from the resulting object.\n - `acmpca` (`string`): Use this to override the default service endpoint URL When `null`, the `acmpca` field will be omitted from the resulting object.\n - `amg` (`string`): Use this to override the default service endpoint URL When `null`, the `amg` field will be omitted from the resulting object.\n - `amp` (`string`): Use this to override the default service endpoint URL When `null`, the `amp` field will be omitted from the resulting object.\n - `amplify` (`string`): Use this to override the default service endpoint URL When `null`, the `amplify` field will be omitted from the resulting object.\n - `apigateway` (`string`): Use this to override the default service endpoint URL When `null`, the `apigateway` field will be omitted from the resulting object.\n - `apigatewayv2` (`string`): Use this to override the default service endpoint URL When `null`, the `apigatewayv2` field will be omitted from the resulting object.\n - `appautoscaling` (`string`): Use this to override the default service endpoint URL When `null`, the `appautoscaling` field will be omitted from the resulting object.\n - `appconfig` (`string`): Use this to override the default service endpoint URL When `null`, the `appconfig` field will be omitted from the resulting object.\n - `appflow` (`string`): Use this to override the default service endpoint URL When `null`, the `appflow` field will be omitted from the resulting object.\n - `appintegrations` (`string`): Use this to override the default service endpoint URL When `null`, the `appintegrations` field will be omitted from the resulting object.\n - `appintegrationsservice` (`string`): Use this to override the default service endpoint URL When `null`, the `appintegrationsservice` field will be omitted from the resulting object.\n - `applicationautoscaling` (`string`): Use this to override the default service endpoint URL When `null`, the `applicationautoscaling` field will be omitted from the resulting object.\n - `applicationinsights` (`string`): Use this to override the default service endpoint URL When `null`, the `applicationinsights` field will be omitted from the resulting object.\n - `appmesh` (`string`): Use this to override the default service endpoint URL When `null`, the `appmesh` field will be omitted from the resulting object.\n - `apprunner` (`string`): Use this to override the default service endpoint URL When `null`, the `apprunner` field will be omitted from the resulting object.\n - `appstream` (`string`): Use this to override the default service endpoint URL When `null`, the `appstream` field will be omitted from the resulting object.\n - `appsync` (`string`): Use this to override the default service endpoint URL When `null`, the `appsync` field will be omitted from the resulting object.\n - `athena` (`string`): Use this to override the default service endpoint URL When `null`, the `athena` field will be omitted from the resulting object.\n - `auditmanager` (`string`): Use this to override the default service endpoint URL When `null`, the `auditmanager` field will be omitted from the resulting object.\n - `autoscaling` (`string`): Use this to override the default service endpoint URL When `null`, the `autoscaling` field will be omitted from the resulting object.\n - `autoscalingplans` (`string`): Use this to override the default service endpoint URL When `null`, the `autoscalingplans` field will be omitted from the resulting object.\n - `backup` (`string`): Use this to override the default service endpoint URL When `null`, the `backup` field will be omitted from the resulting object.\n - `batch` (`string`): Use this to override the default service endpoint URL When `null`, the `batch` field will be omitted from the resulting object.\n - `beanstalk` (`string`): Use this to override the default service endpoint URL When `null`, the `beanstalk` field will be omitted from the resulting object.\n - `budgets` (`string`): Use this to override the default service endpoint URL When `null`, the `budgets` field will be omitted from the resulting object.\n - `ce` (`string`): Use this to override the default service endpoint URL When `null`, the `ce` field will be omitted from the resulting object.\n - `chime` (`string`): Use this to override the default service endpoint URL When `null`, the `chime` field will be omitted from the resulting object.\n - `chimesdkmediapipelines` (`string`): Use this to override the default service endpoint URL When `null`, the `chimesdkmediapipelines` field will be omitted from the resulting object.\n - `chimesdkvoice` (`string`): Use this to override the default service endpoint URL When `null`, the `chimesdkvoice` field will be omitted from the resulting object.\n - `cleanrooms` (`string`): Use this to override the default service endpoint URL When `null`, the `cleanrooms` field will be omitted from the resulting object.\n - `cloud9` (`string`): Use this to override the default service endpoint URL When `null`, the `cloud9` field will be omitted from the resulting object.\n - `cloudcontrol` (`string`): Use this to override the default service endpoint URL When `null`, the `cloudcontrol` field will be omitted from the resulting object.\n - `cloudcontrolapi` (`string`): Use this to override the default service endpoint URL When `null`, the `cloudcontrolapi` field will be omitted from the resulting object.\n - `cloudformation` (`string`): Use this to override the default service endpoint URL When `null`, the `cloudformation` field will be omitted from the resulting object.\n - `cloudfront` (`string`): Use this to override the default service endpoint URL When `null`, the `cloudfront` field will be omitted from the resulting object.\n - `cloudhsm` (`string`): Use this to override the default service endpoint URL When `null`, the `cloudhsm` field will be omitted from the resulting object.\n - `cloudhsmv2` (`string`): Use this to override the default service endpoint URL When `null`, the `cloudhsmv2` field will be omitted from the resulting object.\n - `cloudsearch` (`string`): Use this to override the default service endpoint URL When `null`, the `cloudsearch` field will be omitted from the resulting object.\n - `cloudtrail` (`string`): Use this to override the default service endpoint URL When `null`, the `cloudtrail` field will be omitted from the resulting object.\n - `cloudwatch` (`string`): Use this to override the default service endpoint URL When `null`, the `cloudwatch` field will be omitted from the resulting object.\n - `cloudwatchevents` (`string`): Use this to override the default service endpoint URL When `null`, the `cloudwatchevents` field will be omitted from the resulting object.\n - `cloudwatchevidently` (`string`): Use this to override the default service endpoint URL When `null`, the `cloudwatchevidently` field will be omitted from the resulting object.\n - `cloudwatchlog` (`string`): Use this to override the default service endpoint URL When `null`, the `cloudwatchlog` field will be omitted from the resulting object.\n - `cloudwatchlogs` (`string`): Use this to override the default service endpoint URL When `null`, the `cloudwatchlogs` field will be omitted from the resulting object.\n - `cloudwatchobservabilityaccessmanager` (`string`): Use this to override the default service endpoint URL When `null`, the `cloudwatchobservabilityaccessmanager` field will be omitted from the resulting object.\n - `cloudwatchrum` (`string`): Use this to override the default service endpoint URL When `null`, the `cloudwatchrum` field will be omitted from the resulting object.\n - `codeartifact` (`string`): Use this to override the default service endpoint URL When `null`, the `codeartifact` field will be omitted from the resulting object.\n - `codebuild` (`string`): Use this to override the default service endpoint URL When `null`, the `codebuild` field will be omitted from the resulting object.\n - `codecatalyst` (`string`): Use this to override the default service endpoint URL When `null`, the `codecatalyst` field will be omitted from the resulting object.\n - `codecommit` (`string`): Use this to override the default service endpoint URL When `null`, the `codecommit` field will be omitted from the resulting object.\n - `codedeploy` (`string`): Use this to override the default service endpoint URL When `null`, the `codedeploy` field will be omitted from the resulting object.\n - `codegurureviewer` (`string`): Use this to override the default service endpoint URL When `null`, the `codegurureviewer` field will be omitted from the resulting object.\n - `codepipeline` (`string`): Use this to override the default service endpoint URL When `null`, the `codepipeline` field will be omitted from the resulting object.\n - `codestarconnections` (`string`): Use this to override the default service endpoint URL When `null`, the `codestarconnections` field will be omitted from the resulting object.\n - `codestarnotifications` (`string`): Use this to override the default service endpoint URL When `null`, the `codestarnotifications` field will be omitted from the resulting object.\n - `cognitoidentity` (`string`): Use this to override the default service endpoint URL When `null`, the `cognitoidentity` field will be omitted from the resulting object.\n - `cognitoidentityprovider` (`string`): Use this to override the default service endpoint URL When `null`, the `cognitoidentityprovider` field will be omitted from the resulting object.\n - `cognitoidp` (`string`): Use this to override the default service endpoint URL When `null`, the `cognitoidp` field will be omitted from the resulting object.\n - `comprehend` (`string`): Use this to override the default service endpoint URL When `null`, the `comprehend` field will be omitted from the resulting object.\n - `computeoptimizer` (`string`): Use this to override the default service endpoint URL When `null`, the `computeoptimizer` field will be omitted from the resulting object.\n - `config` (`string`): Use this to override the default service endpoint URL When `null`, the `config` field will be omitted from the resulting object.\n - `configservice` (`string`): Use this to override the default service endpoint URL When `null`, the `configservice` field will be omitted from the resulting object.\n - `connect` (`string`): Use this to override the default service endpoint URL When `null`, the `connect` field will be omitted from the resulting object.\n - `controltower` (`string`): Use this to override the default service endpoint URL When `null`, the `controltower` field will be omitted from the resulting object.\n - `costandusagereportservice` (`string`): Use this to override the default service endpoint URL When `null`, the `costandusagereportservice` field will be omitted from the resulting object.\n - `costexplorer` (`string`): Use this to override the default service endpoint URL When `null`, the `costexplorer` field will be omitted from the resulting object.\n - `cur` (`string`): Use this to override the default service endpoint URL When `null`, the `cur` field will be omitted from the resulting object.\n - `databasemigration` (`string`): Use this to override the default service endpoint URL When `null`, the `databasemigration` field will be omitted from the resulting object.\n - `databasemigrationservice` (`string`): Use this to override the default service endpoint URL When `null`, the `databasemigrationservice` field will be omitted from the resulting object.\n - `dataexchange` (`string`): Use this to override the default service endpoint URL When `null`, the `dataexchange` field will be omitted from the resulting object.\n - `datapipeline` (`string`): Use this to override the default service endpoint URL When `null`, the `datapipeline` field will be omitted from the resulting object.\n - `datasync` (`string`): Use this to override the default service endpoint URL When `null`, the `datasync` field will be omitted from the resulting object.\n - `dax` (`string`): Use this to override the default service endpoint URL When `null`, the `dax` field will be omitted from the resulting object.\n - `deploy` (`string`): Use this to override the default service endpoint URL When `null`, the `deploy` field will be omitted from the resulting object.\n - `detective` (`string`): Use this to override the default service endpoint URL When `null`, the `detective` field will be omitted from the resulting object.\n - `devicefarm` (`string`): Use this to override the default service endpoint URL When `null`, the `devicefarm` field will be omitted from the resulting object.\n - `directconnect` (`string`): Use this to override the default service endpoint URL When `null`, the `directconnect` field will be omitted from the resulting object.\n - `directoryservice` (`string`): Use this to override the default service endpoint URL When `null`, the `directoryservice` field will be omitted from the resulting object.\n - `dlm` (`string`): Use this to override the default service endpoint URL When `null`, the `dlm` field will be omitted from the resulting object.\n - `dms` (`string`): Use this to override the default service endpoint URL When `null`, the `dms` field will be omitted from the resulting object.\n - `docdb` (`string`): Use this to override the default service endpoint URL When `null`, the `docdb` field will be omitted from the resulting object.\n - `docdbelastic` (`string`): Use this to override the default service endpoint URL When `null`, the `docdbelastic` field will be omitted from the resulting object.\n - `ds` (`string`): Use this to override the default service endpoint URL When `null`, the `ds` field will be omitted from the resulting object.\n - `dynamodb` (`string`): Use this to override the default service endpoint URL When `null`, the `dynamodb` field will be omitted from the resulting object.\n - `ec2` (`string`): Use this to override the default service endpoint URL When `null`, the `ec2` field will be omitted from the resulting object.\n - `ecr` (`string`): Use this to override the default service endpoint URL When `null`, the `ecr` field will be omitted from the resulting object.\n - `ecrpublic` (`string`): Use this to override the default service endpoint URL When `null`, the `ecrpublic` field will be omitted from the resulting object.\n - `ecs` (`string`): Use this to override the default service endpoint URL When `null`, the `ecs` field will be omitted from the resulting object.\n - `efs` (`string`): Use this to override the default service endpoint URL When `null`, the `efs` field will be omitted from the resulting object.\n - `eks` (`string`): Use this to override the default service endpoint URL When `null`, the `eks` field will be omitted from the resulting object.\n - `elasticache` (`string`): Use this to override the default service endpoint URL When `null`, the `elasticache` field will be omitted from the resulting object.\n - `elasticbeanstalk` (`string`): Use this to override the default service endpoint URL When `null`, the `elasticbeanstalk` field will be omitted from the resulting object.\n - `elasticloadbalancing` (`string`): Use this to override the default service endpoint URL When `null`, the `elasticloadbalancing` field will be omitted from the resulting object.\n - `elasticloadbalancingv2` (`string`): Use this to override the default service endpoint URL When `null`, the `elasticloadbalancingv2` field will be omitted from the resulting object.\n - `elasticsearch` (`string`): Use this to override the default service endpoint URL When `null`, the `elasticsearch` field will be omitted from the resulting object.\n - `elasticsearchservice` (`string`): Use this to override the default service endpoint URL When `null`, the `elasticsearchservice` field will be omitted from the resulting object.\n - `elastictranscoder` (`string`): Use this to override the default service endpoint URL When `null`, the `elastictranscoder` field will be omitted from the resulting object.\n - `elb` (`string`): Use this to override the default service endpoint URL When `null`, the `elb` field will be omitted from the resulting object.\n - `elbv2` (`string`): Use this to override the default service endpoint URL When `null`, the `elbv2` field will be omitted from the resulting object.\n - `emr` (`string`): Use this to override the default service endpoint URL When `null`, the `emr` field will be omitted from the resulting object.\n - `emrcontainers` (`string`): Use this to override the default service endpoint URL When `null`, the `emrcontainers` field will be omitted from the resulting object.\n - `emrserverless` (`string`): Use this to override the default service endpoint URL When `null`, the `emrserverless` field will be omitted from the resulting object.\n - `es` (`string`): Use this to override the default service endpoint URL When `null`, the `es` field will be omitted from the resulting object.\n - `eventbridge` (`string`): Use this to override the default service endpoint URL When `null`, the `eventbridge` field will be omitted from the resulting object.\n - `events` (`string`): Use this to override the default service endpoint URL When `null`, the `events` field will be omitted from the resulting object.\n - `evidently` (`string`): Use this to override the default service endpoint URL When `null`, the `evidently` field will be omitted from the resulting object.\n - `finspace` (`string`): Use this to override the default service endpoint URL When `null`, the `finspace` field will be omitted from the resulting object.\n - `firehose` (`string`): Use this to override the default service endpoint URL When `null`, the `firehose` field will be omitted from the resulting object.\n - `fis` (`string`): Use this to override the default service endpoint URL When `null`, the `fis` field will be omitted from the resulting object.\n - `fms` (`string`): Use this to override the default service endpoint URL When `null`, the `fms` field will be omitted from the resulting object.\n - `fsx` (`string`): Use this to override the default service endpoint URL When `null`, the `fsx` field will be omitted from the resulting object.\n - `gamelift` (`string`): Use this to override the default service endpoint URL When `null`, the `gamelift` field will be omitted from the resulting object.\n - `glacier` (`string`): Use this to override the default service endpoint URL When `null`, the `glacier` field will be omitted from the resulting object.\n - `globalaccelerator` (`string`): Use this to override the default service endpoint URL When `null`, the `globalaccelerator` field will be omitted from the resulting object.\n - `glue` (`string`): Use this to override the default service endpoint URL When `null`, the `glue` field will be omitted from the resulting object.\n - `grafana` (`string`): Use this to override the default service endpoint URL When `null`, the `grafana` field will be omitted from the resulting object.\n - `greengrass` (`string`): Use this to override the default service endpoint URL When `null`, the `greengrass` field will be omitted from the resulting object.\n - `guardduty` (`string`): Use this to override the default service endpoint URL When `null`, the `guardduty` field will be omitted from the resulting object.\n - `healthlake` (`string`): Use this to override the default service endpoint URL When `null`, the `healthlake` field will be omitted from the resulting object.\n - `iam` (`string`): Use this to override the default service endpoint URL When `null`, the `iam` field will be omitted from the resulting object.\n - `identitystore` (`string`): Use this to override the default service endpoint URL When `null`, the `identitystore` field will be omitted from the resulting object.\n - `imagebuilder` (`string`): Use this to override the default service endpoint URL When `null`, the `imagebuilder` field will be omitted from the resulting object.\n - `inspector` (`string`): Use this to override the default service endpoint URL When `null`, the `inspector` field will be omitted from the resulting object.\n - `inspector2` (`string`): Use this to override the default service endpoint URL When `null`, the `inspector2` field will be omitted from the resulting object.\n - `inspectorv2` (`string`): Use this to override the default service endpoint URL When `null`, the `inspectorv2` field will be omitted from the resulting object.\n - `internetmonitor` (`string`): Use this to override the default service endpoint URL When `null`, the `internetmonitor` field will be omitted from the resulting object.\n - `iot` (`string`): Use this to override the default service endpoint URL When `null`, the `iot` field will be omitted from the resulting object.\n - `iotanalytics` (`string`): Use this to override the default service endpoint URL When `null`, the `iotanalytics` field will be omitted from the resulting object.\n - `iotevents` (`string`): Use this to override the default service endpoint URL When `null`, the `iotevents` field will be omitted from the resulting object.\n - `ivs` (`string`): Use this to override the default service endpoint URL When `null`, the `ivs` field will be omitted from the resulting object.\n - `ivschat` (`string`): Use this to override the default service endpoint URL When `null`, the `ivschat` field will be omitted from the resulting object.\n - `kafka` (`string`): Use this to override the default service endpoint URL When `null`, the `kafka` field will be omitted from the resulting object.\n - `kafkaconnect` (`string`): Use this to override the default service endpoint URL When `null`, the `kafkaconnect` field will be omitted from the resulting object.\n - `kendra` (`string`): Use this to override the default service endpoint URL When `null`, the `kendra` field will be omitted from the resulting object.\n - `keyspaces` (`string`): Use this to override the default service endpoint URL When `null`, the `keyspaces` field will be omitted from the resulting object.\n - `kinesis` (`string`): Use this to override the default service endpoint URL When `null`, the `kinesis` field will be omitted from the resulting object.\n - `kinesisanalytics` (`string`): Use this to override the default service endpoint URL When `null`, the `kinesisanalytics` field will be omitted from the resulting object.\n - `kinesisanalyticsv2` (`string`): Use this to override the default service endpoint URL When `null`, the `kinesisanalyticsv2` field will be omitted from the resulting object.\n - `kinesisvideo` (`string`): Use this to override the default service endpoint URL When `null`, the `kinesisvideo` field will be omitted from the resulting object.\n - `kms` (`string`): Use this to override the default service endpoint URL When `null`, the `kms` field will be omitted from the resulting object.\n - `lakeformation` (`string`): Use this to override the default service endpoint URL When `null`, the `lakeformation` field will be omitted from the resulting object.\n - `lambda` (`string`): Use this to override the default service endpoint URL When `null`, the `lambda` field will be omitted from the resulting object.\n - `lex` (`string`): Use this to override the default service endpoint URL When `null`, the `lex` field will be omitted from the resulting object.\n - `lexmodelbuilding` (`string`): Use this to override the default service endpoint URL When `null`, the `lexmodelbuilding` field will be omitted from the resulting object.\n - `lexmodelbuildingservice` (`string`): Use this to override the default service endpoint URL When `null`, the `lexmodelbuildingservice` field will be omitted from the resulting object.\n - `lexmodels` (`string`): Use this to override the default service endpoint URL When `null`, the `lexmodels` field will be omitted from the resulting object.\n - `licensemanager` (`string`): Use this to override the default service endpoint URL When `null`, the `licensemanager` field will be omitted from the resulting object.\n - `lightsail` (`string`): Use this to override the default service endpoint URL When `null`, the `lightsail` field will be omitted from the resulting object.\n - `location` (`string`): Use this to override the default service endpoint URL When `null`, the `location` field will be omitted from the resulting object.\n - `locationservice` (`string`): Use this to override the default service endpoint URL When `null`, the `locationservice` field will be omitted from the resulting object.\n - `logs` (`string`): Use this to override the default service endpoint URL When `null`, the `logs` field will be omitted from the resulting object.\n - `macie2` (`string`): Use this to override the default service endpoint URL When `null`, the `macie2` field will be omitted from the resulting object.\n - `managedgrafana` (`string`): Use this to override the default service endpoint URL When `null`, the `managedgrafana` field will be omitted from the resulting object.\n - `mediaconnect` (`string`): Use this to override the default service endpoint URL When `null`, the `mediaconnect` field will be omitted from the resulting object.\n - `mediaconvert` (`string`): Use this to override the default service endpoint URL When `null`, the `mediaconvert` field will be omitted from the resulting object.\n - `medialive` (`string`): Use this to override the default service endpoint URL When `null`, the `medialive` field will be omitted from the resulting object.\n - `mediapackage` (`string`): Use this to override the default service endpoint URL When `null`, the `mediapackage` field will be omitted from the resulting object.\n - `mediastore` (`string`): Use this to override the default service endpoint URL When `null`, the `mediastore` field will be omitted from the resulting object.\n - `memorydb` (`string`): Use this to override the default service endpoint URL When `null`, the `memorydb` field will be omitted from the resulting object.\n - `mq` (`string`): Use this to override the default service endpoint URL When `null`, the `mq` field will be omitted from the resulting object.\n - `msk` (`string`): Use this to override the default service endpoint URL When `null`, the `msk` field will be omitted from the resulting object.\n - `mwaa` (`string`): Use this to override the default service endpoint URL When `null`, the `mwaa` field will be omitted from the resulting object.\n - `neptune` (`string`): Use this to override the default service endpoint URL When `null`, the `neptune` field will be omitted from the resulting object.\n - `networkfirewall` (`string`): Use this to override the default service endpoint URL When `null`, the `networkfirewall` field will be omitted from the resulting object.\n - `networkmanager` (`string`): Use this to override the default service endpoint URL When `null`, the `networkmanager` field will be omitted from the resulting object.\n - `oam` (`string`): Use this to override the default service endpoint URL When `null`, the `oam` field will be omitted from the resulting object.\n - `opensearch` (`string`): Use this to override the default service endpoint URL When `null`, the `opensearch` field will be omitted from the resulting object.\n - `opensearchserverless` (`string`): Use this to override the default service endpoint URL When `null`, the `opensearchserverless` field will be omitted from the resulting object.\n - `opensearchservice` (`string`): Use this to override the default service endpoint URL When `null`, the `opensearchservice` field will be omitted from the resulting object.\n - `opsworks` (`string`): Use this to override the default service endpoint URL When `null`, the `opsworks` field will be omitted from the resulting object.\n - `organizations` (`string`): Use this to override the default service endpoint URL When `null`, the `organizations` field will be omitted from the resulting object.\n - `outposts` (`string`): Use this to override the default service endpoint URL When `null`, the `outposts` field will be omitted from the resulting object.\n - `pinpoint` (`string`): Use this to override the default service endpoint URL When `null`, the `pinpoint` field will be omitted from the resulting object.\n - `pipes` (`string`): Use this to override the default service endpoint URL When `null`, the `pipes` field will be omitted from the resulting object.\n - `pricing` (`string`): Use this to override the default service endpoint URL When `null`, the `pricing` field will be omitted from the resulting object.\n - `prometheus` (`string`): Use this to override the default service endpoint URL When `null`, the `prometheus` field will be omitted from the resulting object.\n - `prometheusservice` (`string`): Use this to override the default service endpoint URL When `null`, the `prometheusservice` field will be omitted from the resulting object.\n - `qldb` (`string`): Use this to override the default service endpoint URL When `null`, the `qldb` field will be omitted from the resulting object.\n - `quicksight` (`string`): Use this to override the default service endpoint URL When `null`, the `quicksight` field will be omitted from the resulting object.\n - `ram` (`string`): Use this to override the default service endpoint URL When `null`, the `ram` field will be omitted from the resulting object.\n - `rbin` (`string`): Use this to override the default service endpoint URL When `null`, the `rbin` field will be omitted from the resulting object.\n - `rds` (`string`): Use this to override the default service endpoint URL When `null`, the `rds` field will be omitted from the resulting object.\n - `recyclebin` (`string`): Use this to override the default service endpoint URL When `null`, the `recyclebin` field will be omitted from the resulting object.\n - `redshift` (`string`): Use this to override the default service endpoint URL When `null`, the `redshift` field will be omitted from the resulting object.\n - `redshiftdata` (`string`): Use this to override the default service endpoint URL When `null`, the `redshiftdata` field will be omitted from the resulting object.\n - `redshiftdataapiservice` (`string`): Use this to override the default service endpoint URL When `null`, the `redshiftdataapiservice` field will be omitted from the resulting object.\n - `redshiftserverless` (`string`): Use this to override the default service endpoint URL When `null`, the `redshiftserverless` field will be omitted from the resulting object.\n - `resourceexplorer2` (`string`): Use this to override the default service endpoint URL When `null`, the `resourceexplorer2` field will be omitted from the resulting object.\n - `resourcegroups` (`string`): Use this to override the default service endpoint URL When `null`, the `resourcegroups` field will be omitted from the resulting object.\n - `resourcegroupstagging` (`string`): Use this to override the default service endpoint URL When `null`, the `resourcegroupstagging` field will be omitted from the resulting object.\n - `resourcegroupstaggingapi` (`string`): Use this to override the default service endpoint URL When `null`, the `resourcegroupstaggingapi` field will be omitted from the resulting object.\n - `rolesanywhere` (`string`): Use this to override the default service endpoint URL When `null`, the `rolesanywhere` field will be omitted from the resulting object.\n - `route53` (`string`): Use this to override the default service endpoint URL When `null`, the `route53` field will be omitted from the resulting object.\n - `route53domains` (`string`): Use this to override the default service endpoint URL When `null`, the `route53domains` field will be omitted from the resulting object.\n - `route53recoverycontrolconfig` (`string`): Use this to override the default service endpoint URL When `null`, the `route53recoverycontrolconfig` field will be omitted from the resulting object.\n - `route53recoveryreadiness` (`string`): Use this to override the default service endpoint URL When `null`, the `route53recoveryreadiness` field will be omitted from the resulting object.\n - `route53resolver` (`string`): Use this to override the default service endpoint URL When `null`, the `route53resolver` field will be omitted from the resulting object.\n - `rum` (`string`): Use this to override the default service endpoint URL When `null`, the `rum` field will be omitted from the resulting object.\n - `s3` (`string`): Use this to override the default service endpoint URL When `null`, the `s3` field will be omitted from the resulting object.\n - `s3api` (`string`): Use this to override the default service endpoint URL When `null`, the `s3api` field will be omitted from the resulting object.\n - `s3control` (`string`): Use this to override the default service endpoint URL When `null`, the `s3control` field will be omitted from the resulting object.\n - `s3outposts` (`string`): Use this to override the default service endpoint URL When `null`, the `s3outposts` field will be omitted from the resulting object.\n - `sagemaker` (`string`): Use this to override the default service endpoint URL When `null`, the `sagemaker` field will be omitted from the resulting object.\n - `scheduler` (`string`): Use this to override the default service endpoint URL When `null`, the `scheduler` field will be omitted from the resulting object.\n - `schemas` (`string`): Use this to override the default service endpoint URL When `null`, the `schemas` field will be omitted from the resulting object.\n - `sdb` (`string`): Use this to override the default service endpoint URL When `null`, the `sdb` field will be omitted from the resulting object.\n - `secretsmanager` (`string`): Use this to override the default service endpoint URL When `null`, the `secretsmanager` field will be omitted from the resulting object.\n - `securityhub` (`string`): Use this to override the default service endpoint URL When `null`, the `securityhub` field will be omitted from the resulting object.\n - `securitylake` (`string`): Use this to override the default service endpoint URL When `null`, the `securitylake` field will be omitted from the resulting object.\n - `serverlessapplicationrepository` (`string`): Use this to override the default service endpoint URL When `null`, the `serverlessapplicationrepository` field will be omitted from the resulting object.\n - `serverlessapprepo` (`string`): Use this to override the default service endpoint URL When `null`, the `serverlessapprepo` field will be omitted from the resulting object.\n - `serverlessrepo` (`string`): Use this to override the default service endpoint URL When `null`, the `serverlessrepo` field will be omitted from the resulting object.\n - `servicecatalog` (`string`): Use this to override the default service endpoint URL When `null`, the `servicecatalog` field will be omitted from the resulting object.\n - `servicediscovery` (`string`): Use this to override the default service endpoint URL When `null`, the `servicediscovery` field will be omitted from the resulting object.\n - `servicequotas` (`string`): Use this to override the default service endpoint URL When `null`, the `servicequotas` field will be omitted from the resulting object.\n - `ses` (`string`): Use this to override the default service endpoint URL When `null`, the `ses` field will be omitted from the resulting object.\n - `sesv2` (`string`): Use this to override the default service endpoint URL When `null`, the `sesv2` field will be omitted from the resulting object.\n - `sfn` (`string`): Use this to override the default service endpoint URL When `null`, the `sfn` field will be omitted from the resulting object.\n - `shield` (`string`): Use this to override the default service endpoint URL When `null`, the `shield` field will be omitted from the resulting object.\n - `signer` (`string`): Use this to override the default service endpoint URL When `null`, the `signer` field will be omitted from the resulting object.\n - `simpledb` (`string`): Use this to override the default service endpoint URL When `null`, the `simpledb` field will be omitted from the resulting object.\n - `sns` (`string`): Use this to override the default service endpoint URL When `null`, the `sns` field will be omitted from the resulting object.\n - `sqs` (`string`): Use this to override the default service endpoint URL When `null`, the `sqs` field will be omitted from the resulting object.\n - `ssm` (`string`): Use this to override the default service endpoint URL When `null`, the `ssm` field will be omitted from the resulting object.\n - `ssmcontacts` (`string`): Use this to override the default service endpoint URL When `null`, the `ssmcontacts` field will be omitted from the resulting object.\n - `ssmincidents` (`string`): Use this to override the default service endpoint URL When `null`, the `ssmincidents` field will be omitted from the resulting object.\n - `ssoadmin` (`string`): Use this to override the default service endpoint URL When `null`, the `ssoadmin` field will be omitted from the resulting object.\n - `stepfunctions` (`string`): Use this to override the default service endpoint URL When `null`, the `stepfunctions` field will be omitted from the resulting object.\n - `storagegateway` (`string`): Use this to override the default service endpoint URL When `null`, the `storagegateway` field will be omitted from the resulting object.\n - `sts` (`string`): Use this to override the default service endpoint URL When `null`, the `sts` field will be omitted from the resulting object.\n - `swf` (`string`): Use this to override the default service endpoint URL When `null`, the `swf` field will be omitted from the resulting object.\n - `synthetics` (`string`): Use this to override the default service endpoint URL When `null`, the `synthetics` field will be omitted from the resulting object.\n - `timestreamwrite` (`string`): Use this to override the default service endpoint URL When `null`, the `timestreamwrite` field will be omitted from the resulting object.\n - `transcribe` (`string`): Use this to override the default service endpoint URL When `null`, the `transcribe` field will be omitted from the resulting object.\n - `transcribeservice` (`string`): Use this to override the default service endpoint URL When `null`, the `transcribeservice` field will be omitted from the resulting object.\n - `transfer` (`string`): Use this to override the default service endpoint URL When `null`, the `transfer` field will be omitted from the resulting object.\n - `verifiedpermissions` (`string`): Use this to override the default service endpoint URL When `null`, the `verifiedpermissions` field will be omitted from the resulting object.\n - `vpclattice` (`string`): Use this to override the default service endpoint URL When `null`, the `vpclattice` field will be omitted from the resulting object.\n - `waf` (`string`): Use this to override the default service endpoint URL When `null`, the `waf` field will be omitted from the resulting object.\n - `wafregional` (`string`): Use this to override the default service endpoint URL When `null`, the `wafregional` field will be omitted from the resulting object.\n - `wafv2` (`string`): Use this to override the default service endpoint URL When `null`, the `wafv2` field will be omitted from the resulting object.\n - `worklink` (`string`): Use this to override the default service endpoint URL When `null`, the `worklink` field will be omitted from the resulting object.\n - `workspaces` (`string`): Use this to override the default service endpoint URL When `null`, the `workspaces` field will be omitted from the resulting object.\n - `xray` (`string`): Use this to override the default service endpoint URL When `null`, the `xray` field will be omitted from the resulting object.\n\n**Returns**:\n - An attribute object that represents the `endpoints` sub block.\n', args=[]), + '#new':: d.fn(help='\n`aws.endpoints.new` constructs a new object with attributes and blocks configured for the `endpoints`\nTerraform sub block.\n\n\n\n**Args**:\n - `accessanalyzer` (`string`): Use this to override the default service endpoint URL When `null`, the `accessanalyzer` field will be omitted from the resulting object.\n - `account` (`string`): Use this to override the default service endpoint URL When `null`, the `account` field will be omitted from the resulting object.\n - `acm` (`string`): Use this to override the default service endpoint URL When `null`, the `acm` field will be omitted from the resulting object.\n - `acmpca` (`string`): Use this to override the default service endpoint URL When `null`, the `acmpca` field will be omitted from the resulting object.\n - `amg` (`string`): Use this to override the default service endpoint URL When `null`, the `amg` field will be omitted from the resulting object.\n - `amp` (`string`): Use this to override the default service endpoint URL When `null`, the `amp` field will be omitted from the resulting object.\n - `amplify` (`string`): Use this to override the default service endpoint URL When `null`, the `amplify` field will be omitted from the resulting object.\n - `apigateway` (`string`): Use this to override the default service endpoint URL When `null`, the `apigateway` field will be omitted from the resulting object.\n - `apigatewayv2` (`string`): Use this to override the default service endpoint URL When `null`, the `apigatewayv2` field will be omitted from the resulting object.\n - `appautoscaling` (`string`): Use this to override the default service endpoint URL When `null`, the `appautoscaling` field will be omitted from the resulting object.\n - `appconfig` (`string`): Use this to override the default service endpoint URL When `null`, the `appconfig` field will be omitted from the resulting object.\n - `appflow` (`string`): Use this to override the default service endpoint URL When `null`, the `appflow` field will be omitted from the resulting object.\n - `appintegrations` (`string`): Use this to override the default service endpoint URL When `null`, the `appintegrations` field will be omitted from the resulting object.\n - `appintegrationsservice` (`string`): Use this to override the default service endpoint URL When `null`, the `appintegrationsservice` field will be omitted from the resulting object.\n - `applicationautoscaling` (`string`): Use this to override the default service endpoint URL When `null`, the `applicationautoscaling` field will be omitted from the resulting object.\n - `applicationinsights` (`string`): Use this to override the default service endpoint URL When `null`, the `applicationinsights` field will be omitted from the resulting object.\n - `appmesh` (`string`): Use this to override the default service endpoint URL When `null`, the `appmesh` field will be omitted from the resulting object.\n - `apprunner` (`string`): Use this to override the default service endpoint URL When `null`, the `apprunner` field will be omitted from the resulting object.\n - `appstream` (`string`): Use this to override the default service endpoint URL When `null`, the `appstream` field will be omitted from the resulting object.\n - `appsync` (`string`): Use this to override the default service endpoint URL When `null`, the `appsync` field will be omitted from the resulting object.\n - `athena` (`string`): Use this to override the default service endpoint URL When `null`, the `athena` field will be omitted from the resulting object.\n - `auditmanager` (`string`): Use this to override the default service endpoint URL When `null`, the `auditmanager` field will be omitted from the resulting object.\n - `autoscaling` (`string`): Use this to override the default service endpoint URL When `null`, the `autoscaling` field will be omitted from the resulting object.\n - `autoscalingplans` (`string`): Use this to override the default service endpoint URL When `null`, the `autoscalingplans` field will be omitted from the resulting object.\n - `backup` (`string`): Use this to override the default service endpoint URL When `null`, the `backup` field will be omitted from the resulting object.\n - `batch` (`string`): Use this to override the default service endpoint URL When `null`, the `batch` field will be omitted from the resulting object.\n - `beanstalk` (`string`): Use this to override the default service endpoint URL When `null`, the `beanstalk` field will be omitted from the resulting object.\n - `budgets` (`string`): Use this to override the default service endpoint URL When `null`, the `budgets` field will be omitted from the resulting object.\n - `ce` (`string`): Use this to override the default service endpoint URL When `null`, the `ce` field will be omitted from the resulting object.\n - `chime` (`string`): Use this to override the default service endpoint URL When `null`, the `chime` field will be omitted from the resulting object.\n - `chimesdkmediapipelines` (`string`): Use this to override the default service endpoint URL When `null`, the `chimesdkmediapipelines` field will be omitted from the resulting object.\n - `chimesdkvoice` (`string`): Use this to override the default service endpoint URL When `null`, the `chimesdkvoice` field will be omitted from the resulting object.\n - `cleanrooms` (`string`): Use this to override the default service endpoint URL When `null`, the `cleanrooms` field will be omitted from the resulting object.\n - `cloud9` (`string`): Use this to override the default service endpoint URL When `null`, the `cloud9` field will be omitted from the resulting object.\n - `cloudcontrol` (`string`): Use this to override the default service endpoint URL When `null`, the `cloudcontrol` field will be omitted from the resulting object.\n - `cloudcontrolapi` (`string`): Use this to override the default service endpoint URL When `null`, the `cloudcontrolapi` field will be omitted from the resulting object.\n - `cloudformation` (`string`): Use this to override the default service endpoint URL When `null`, the `cloudformation` field will be omitted from the resulting object.\n - `cloudfront` (`string`): Use this to override the default service endpoint URL When `null`, the `cloudfront` field will be omitted from the resulting object.\n - `cloudhsm` (`string`): Use this to override the default service endpoint URL When `null`, the `cloudhsm` field will be omitted from the resulting object.\n - `cloudhsmv2` (`string`): Use this to override the default service endpoint URL When `null`, the `cloudhsmv2` field will be omitted from the resulting object.\n - `cloudsearch` (`string`): Use this to override the default service endpoint URL When `null`, the `cloudsearch` field will be omitted from the resulting object.\n - `cloudtrail` (`string`): Use this to override the default service endpoint URL When `null`, the `cloudtrail` field will be omitted from the resulting object.\n - `cloudwatch` (`string`): Use this to override the default service endpoint URL When `null`, the `cloudwatch` field will be omitted from the resulting object.\n - `cloudwatchevents` (`string`): Use this to override the default service endpoint URL When `null`, the `cloudwatchevents` field will be omitted from the resulting object.\n - `cloudwatchevidently` (`string`): Use this to override the default service endpoint URL When `null`, the `cloudwatchevidently` field will be omitted from the resulting object.\n - `cloudwatchlog` (`string`): Use this to override the default service endpoint URL When `null`, the `cloudwatchlog` field will be omitted from the resulting object.\n - `cloudwatchlogs` (`string`): Use this to override the default service endpoint URL When `null`, the `cloudwatchlogs` field will be omitted from the resulting object.\n - `cloudwatchobservabilityaccessmanager` (`string`): Use this to override the default service endpoint URL When `null`, the `cloudwatchobservabilityaccessmanager` field will be omitted from the resulting object.\n - `cloudwatchrum` (`string`): Use this to override the default service endpoint URL When `null`, the `cloudwatchrum` field will be omitted from the resulting object.\n - `codeartifact` (`string`): Use this to override the default service endpoint URL When `null`, the `codeartifact` field will be omitted from the resulting object.\n - `codebuild` (`string`): Use this to override the default service endpoint URL When `null`, the `codebuild` field will be omitted from the resulting object.\n - `codecatalyst` (`string`): Use this to override the default service endpoint URL When `null`, the `codecatalyst` field will be omitted from the resulting object.\n - `codecommit` (`string`): Use this to override the default service endpoint URL When `null`, the `codecommit` field will be omitted from the resulting object.\n - `codedeploy` (`string`): Use this to override the default service endpoint URL When `null`, the `codedeploy` field will be omitted from the resulting object.\n - `codegurureviewer` (`string`): Use this to override the default service endpoint URL When `null`, the `codegurureviewer` field will be omitted from the resulting object.\n - `codepipeline` (`string`): Use this to override the default service endpoint URL When `null`, the `codepipeline` field will be omitted from the resulting object.\n - `codestarconnections` (`string`): Use this to override the default service endpoint URL When `null`, the `codestarconnections` field will be omitted from the resulting object.\n - `codestarnotifications` (`string`): Use this to override the default service endpoint URL When `null`, the `codestarnotifications` field will be omitted from the resulting object.\n - `cognitoidentity` (`string`): Use this to override the default service endpoint URL When `null`, the `cognitoidentity` field will be omitted from the resulting object.\n - `cognitoidentityprovider` (`string`): Use this to override the default service endpoint URL When `null`, the `cognitoidentityprovider` field will be omitted from the resulting object.\n - `cognitoidp` (`string`): Use this to override the default service endpoint URL When `null`, the `cognitoidp` field will be omitted from the resulting object.\n - `comprehend` (`string`): Use this to override the default service endpoint URL When `null`, the `comprehend` field will be omitted from the resulting object.\n - `computeoptimizer` (`string`): Use this to override the default service endpoint URL When `null`, the `computeoptimizer` field will be omitted from the resulting object.\n - `config` (`string`): Use this to override the default service endpoint URL When `null`, the `config` field will be omitted from the resulting object.\n - `configservice` (`string`): Use this to override the default service endpoint URL When `null`, the `configservice` field will be omitted from the resulting object.\n - `connect` (`string`): Use this to override the default service endpoint URL When `null`, the `connect` field will be omitted from the resulting object.\n - `controltower` (`string`): Use this to override the default service endpoint URL When `null`, the `controltower` field will be omitted from the resulting object.\n - `costandusagereportservice` (`string`): Use this to override the default service endpoint URL When `null`, the `costandusagereportservice` field will be omitted from the resulting object.\n - `costexplorer` (`string`): Use this to override the default service endpoint URL When `null`, the `costexplorer` field will be omitted from the resulting object.\n - `cur` (`string`): Use this to override the default service endpoint URL When `null`, the `cur` field will be omitted from the resulting object.\n - `databasemigration` (`string`): Use this to override the default service endpoint URL When `null`, the `databasemigration` field will be omitted from the resulting object.\n - `databasemigrationservice` (`string`): Use this to override the default service endpoint URL When `null`, the `databasemigrationservice` field will be omitted from the resulting object.\n - `dataexchange` (`string`): Use this to override the default service endpoint URL When `null`, the `dataexchange` field will be omitted from the resulting object.\n - `datapipeline` (`string`): Use this to override the default service endpoint URL When `null`, the `datapipeline` field will be omitted from the resulting object.\n - `datasync` (`string`): Use this to override the default service endpoint URL When `null`, the `datasync` field will be omitted from the resulting object.\n - `dax` (`string`): Use this to override the default service endpoint URL When `null`, the `dax` field will be omitted from the resulting object.\n - `deploy` (`string`): Use this to override the default service endpoint URL When `null`, the `deploy` field will be omitted from the resulting object.\n - `detective` (`string`): Use this to override the default service endpoint URL When `null`, the `detective` field will be omitted from the resulting object.\n - `devicefarm` (`string`): Use this to override the default service endpoint URL When `null`, the `devicefarm` field will be omitted from the resulting object.\n - `directconnect` (`string`): Use this to override the default service endpoint URL When `null`, the `directconnect` field will be omitted from the resulting object.\n - `directoryservice` (`string`): Use this to override the default service endpoint URL When `null`, the `directoryservice` field will be omitted from the resulting object.\n - `dlm` (`string`): Use this to override the default service endpoint URL When `null`, the `dlm` field will be omitted from the resulting object.\n - `dms` (`string`): Use this to override the default service endpoint URL When `null`, the `dms` field will be omitted from the resulting object.\n - `docdb` (`string`): Use this to override the default service endpoint URL When `null`, the `docdb` field will be omitted from the resulting object.\n - `docdbelastic` (`string`): Use this to override the default service endpoint URL When `null`, the `docdbelastic` field will be omitted from the resulting object.\n - `ds` (`string`): Use this to override the default service endpoint URL When `null`, the `ds` field will be omitted from the resulting object.\n - `dynamodb` (`string`): Use this to override the default service endpoint URL When `null`, the `dynamodb` field will be omitted from the resulting object.\n - `ec2` (`string`): Use this to override the default service endpoint URL When `null`, the `ec2` field will be omitted from the resulting object.\n - `ecr` (`string`): Use this to override the default service endpoint URL When `null`, the `ecr` field will be omitted from the resulting object.\n - `ecrpublic` (`string`): Use this to override the default service endpoint URL When `null`, the `ecrpublic` field will be omitted from the resulting object.\n - `ecs` (`string`): Use this to override the default service endpoint URL When `null`, the `ecs` field will be omitted from the resulting object.\n - `efs` (`string`): Use this to override the default service endpoint URL When `null`, the `efs` field will be omitted from the resulting object.\n - `eks` (`string`): Use this to override the default service endpoint URL When `null`, the `eks` field will be omitted from the resulting object.\n - `elasticache` (`string`): Use this to override the default service endpoint URL When `null`, the `elasticache` field will be omitted from the resulting object.\n - `elasticbeanstalk` (`string`): Use this to override the default service endpoint URL When `null`, the `elasticbeanstalk` field will be omitted from the resulting object.\n - `elasticloadbalancing` (`string`): Use this to override the default service endpoint URL When `null`, the `elasticloadbalancing` field will be omitted from the resulting object.\n - `elasticloadbalancingv2` (`string`): Use this to override the default service endpoint URL When `null`, the `elasticloadbalancingv2` field will be omitted from the resulting object.\n - `elasticsearch` (`string`): Use this to override the default service endpoint URL When `null`, the `elasticsearch` field will be omitted from the resulting object.\n - `elasticsearchservice` (`string`): Use this to override the default service endpoint URL When `null`, the `elasticsearchservice` field will be omitted from the resulting object.\n - `elastictranscoder` (`string`): Use this to override the default service endpoint URL When `null`, the `elastictranscoder` field will be omitted from the resulting object.\n - `elb` (`string`): Use this to override the default service endpoint URL When `null`, the `elb` field will be omitted from the resulting object.\n - `elbv2` (`string`): Use this to override the default service endpoint URL When `null`, the `elbv2` field will be omitted from the resulting object.\n - `emr` (`string`): Use this to override the default service endpoint URL When `null`, the `emr` field will be omitted from the resulting object.\n - `emrcontainers` (`string`): Use this to override the default service endpoint URL When `null`, the `emrcontainers` field will be omitted from the resulting object.\n - `emrserverless` (`string`): Use this to override the default service endpoint URL When `null`, the `emrserverless` field will be omitted from the resulting object.\n - `es` (`string`): Use this to override the default service endpoint URL When `null`, the `es` field will be omitted from the resulting object.\n - `eventbridge` (`string`): Use this to override the default service endpoint URL When `null`, the `eventbridge` field will be omitted from the resulting object.\n - `events` (`string`): Use this to override the default service endpoint URL When `null`, the `events` field will be omitted from the resulting object.\n - `evidently` (`string`): Use this to override the default service endpoint URL When `null`, the `evidently` field will be omitted from the resulting object.\n - `finspace` (`string`): Use this to override the default service endpoint URL When `null`, the `finspace` field will be omitted from the resulting object.\n - `firehose` (`string`): Use this to override the default service endpoint URL When `null`, the `firehose` field will be omitted from the resulting object.\n - `fis` (`string`): Use this to override the default service endpoint URL When `null`, the `fis` field will be omitted from the resulting object.\n - `fms` (`string`): Use this to override the default service endpoint URL When `null`, the `fms` field will be omitted from the resulting object.\n - `fsx` (`string`): Use this to override the default service endpoint URL When `null`, the `fsx` field will be omitted from the resulting object.\n - `gamelift` (`string`): Use this to override the default service endpoint URL When `null`, the `gamelift` field will be omitted from the resulting object.\n - `glacier` (`string`): Use this to override the default service endpoint URL When `null`, the `glacier` field will be omitted from the resulting object.\n - `globalaccelerator` (`string`): Use this to override the default service endpoint URL When `null`, the `globalaccelerator` field will be omitted from the resulting object.\n - `glue` (`string`): Use this to override the default service endpoint URL When `null`, the `glue` field will be omitted from the resulting object.\n - `grafana` (`string`): Use this to override the default service endpoint URL When `null`, the `grafana` field will be omitted from the resulting object.\n - `greengrass` (`string`): Use this to override the default service endpoint URL When `null`, the `greengrass` field will be omitted from the resulting object.\n - `guardduty` (`string`): Use this to override the default service endpoint URL When `null`, the `guardduty` field will be omitted from the resulting object.\n - `healthlake` (`string`): Use this to override the default service endpoint URL When `null`, the `healthlake` field will be omitted from the resulting object.\n - `iam` (`string`): Use this to override the default service endpoint URL When `null`, the `iam` field will be omitted from the resulting object.\n - `identitystore` (`string`): Use this to override the default service endpoint URL When `null`, the `identitystore` field will be omitted from the resulting object.\n - `imagebuilder` (`string`): Use this to override the default service endpoint URL When `null`, the `imagebuilder` field will be omitted from the resulting object.\n - `inspector` (`string`): Use this to override the default service endpoint URL When `null`, the `inspector` field will be omitted from the resulting object.\n - `inspector2` (`string`): Use this to override the default service endpoint URL When `null`, the `inspector2` field will be omitted from the resulting object.\n - `inspectorv2` (`string`): Use this to override the default service endpoint URL When `null`, the `inspectorv2` field will be omitted from the resulting object.\n - `internetmonitor` (`string`): Use this to override the default service endpoint URL When `null`, the `internetmonitor` field will be omitted from the resulting object.\n - `iot` (`string`): Use this to override the default service endpoint URL When `null`, the `iot` field will be omitted from the resulting object.\n - `iotanalytics` (`string`): Use this to override the default service endpoint URL When `null`, the `iotanalytics` field will be omitted from the resulting object.\n - `iotevents` (`string`): Use this to override the default service endpoint URL When `null`, the `iotevents` field will be omitted from the resulting object.\n - `ivs` (`string`): Use this to override the default service endpoint URL When `null`, the `ivs` field will be omitted from the resulting object.\n - `ivschat` (`string`): Use this to override the default service endpoint URL When `null`, the `ivschat` field will be omitted from the resulting object.\n - `kafka` (`string`): Use this to override the default service endpoint URL When `null`, the `kafka` field will be omitted from the resulting object.\n - `kafkaconnect` (`string`): Use this to override the default service endpoint URL When `null`, the `kafkaconnect` field will be omitted from the resulting object.\n - `kendra` (`string`): Use this to override the default service endpoint URL When `null`, the `kendra` field will be omitted from the resulting object.\n - `keyspaces` (`string`): Use this to override the default service endpoint URL When `null`, the `keyspaces` field will be omitted from the resulting object.\n - `kinesis` (`string`): Use this to override the default service endpoint URL When `null`, the `kinesis` field will be omitted from the resulting object.\n - `kinesisanalytics` (`string`): Use this to override the default service endpoint URL When `null`, the `kinesisanalytics` field will be omitted from the resulting object.\n - `kinesisanalyticsv2` (`string`): Use this to override the default service endpoint URL When `null`, the `kinesisanalyticsv2` field will be omitted from the resulting object.\n - `kinesisvideo` (`string`): Use this to override the default service endpoint URL When `null`, the `kinesisvideo` field will be omitted from the resulting object.\n - `kms` (`string`): Use this to override the default service endpoint URL When `null`, the `kms` field will be omitted from the resulting object.\n - `lakeformation` (`string`): Use this to override the default service endpoint URL When `null`, the `lakeformation` field will be omitted from the resulting object.\n - `lambda` (`string`): Use this to override the default service endpoint URL When `null`, the `lambda` field will be omitted from the resulting object.\n - `lex` (`string`): Use this to override the default service endpoint URL When `null`, the `lex` field will be omitted from the resulting object.\n - `lexmodelbuilding` (`string`): Use this to override the default service endpoint URL When `null`, the `lexmodelbuilding` field will be omitted from the resulting object.\n - `lexmodelbuildingservice` (`string`): Use this to override the default service endpoint URL When `null`, the `lexmodelbuildingservice` field will be omitted from the resulting object.\n - `lexmodels` (`string`): Use this to override the default service endpoint URL When `null`, the `lexmodels` field will be omitted from the resulting object.\n - `lexmodelsv2` (`string`): Use this to override the default service endpoint URL When `null`, the `lexmodelsv2` field will be omitted from the resulting object.\n - `lexv2models` (`string`): Use this to override the default service endpoint URL When `null`, the `lexv2models` field will be omitted from the resulting object.\n - `licensemanager` (`string`): Use this to override the default service endpoint URL When `null`, the `licensemanager` field will be omitted from the resulting object.\n - `lightsail` (`string`): Use this to override the default service endpoint URL When `null`, the `lightsail` field will be omitted from the resulting object.\n - `location` (`string`): Use this to override the default service endpoint URL When `null`, the `location` field will be omitted from the resulting object.\n - `locationservice` (`string`): Use this to override the default service endpoint URL When `null`, the `locationservice` field will be omitted from the resulting object.\n - `logs` (`string`): Use this to override the default service endpoint URL When `null`, the `logs` field will be omitted from the resulting object.\n - `macie2` (`string`): Use this to override the default service endpoint URL When `null`, the `macie2` field will be omitted from the resulting object.\n - `managedgrafana` (`string`): Use this to override the default service endpoint URL When `null`, the `managedgrafana` field will be omitted from the resulting object.\n - `mediaconnect` (`string`): Use this to override the default service endpoint URL When `null`, the `mediaconnect` field will be omitted from the resulting object.\n - `mediaconvert` (`string`): Use this to override the default service endpoint URL When `null`, the `mediaconvert` field will be omitted from the resulting object.\n - `medialive` (`string`): Use this to override the default service endpoint URL When `null`, the `medialive` field will be omitted from the resulting object.\n - `mediapackage` (`string`): Use this to override the default service endpoint URL When `null`, the `mediapackage` field will be omitted from the resulting object.\n - `mediastore` (`string`): Use this to override the default service endpoint URL When `null`, the `mediastore` field will be omitted from the resulting object.\n - `memorydb` (`string`): Use this to override the default service endpoint URL When `null`, the `memorydb` field will be omitted from the resulting object.\n - `mq` (`string`): Use this to override the default service endpoint URL When `null`, the `mq` field will be omitted from the resulting object.\n - `msk` (`string`): Use this to override the default service endpoint URL When `null`, the `msk` field will be omitted from the resulting object.\n - `mwaa` (`string`): Use this to override the default service endpoint URL When `null`, the `mwaa` field will be omitted from the resulting object.\n - `neptune` (`string`): Use this to override the default service endpoint URL When `null`, the `neptune` field will be omitted from the resulting object.\n - `networkfirewall` (`string`): Use this to override the default service endpoint URL When `null`, the `networkfirewall` field will be omitted from the resulting object.\n - `networkmanager` (`string`): Use this to override the default service endpoint URL When `null`, the `networkmanager` field will be omitted from the resulting object.\n - `oam` (`string`): Use this to override the default service endpoint URL When `null`, the `oam` field will be omitted from the resulting object.\n - `opensearch` (`string`): Use this to override the default service endpoint URL When `null`, the `opensearch` field will be omitted from the resulting object.\n - `opensearchserverless` (`string`): Use this to override the default service endpoint URL When `null`, the `opensearchserverless` field will be omitted from the resulting object.\n - `opensearchservice` (`string`): Use this to override the default service endpoint URL When `null`, the `opensearchservice` field will be omitted from the resulting object.\n - `opsworks` (`string`): Use this to override the default service endpoint URL When `null`, the `opsworks` field will be omitted from the resulting object.\n - `organizations` (`string`): Use this to override the default service endpoint URL When `null`, the `organizations` field will be omitted from the resulting object.\n - `outposts` (`string`): Use this to override the default service endpoint URL When `null`, the `outposts` field will be omitted from the resulting object.\n - `pinpoint` (`string`): Use this to override the default service endpoint URL When `null`, the `pinpoint` field will be omitted from the resulting object.\n - `pipes` (`string`): Use this to override the default service endpoint URL When `null`, the `pipes` field will be omitted from the resulting object.\n - `pricing` (`string`): Use this to override the default service endpoint URL When `null`, the `pricing` field will be omitted from the resulting object.\n - `prometheus` (`string`): Use this to override the default service endpoint URL When `null`, the `prometheus` field will be omitted from the resulting object.\n - `prometheusservice` (`string`): Use this to override the default service endpoint URL When `null`, the `prometheusservice` field will be omitted from the resulting object.\n - `qldb` (`string`): Use this to override the default service endpoint URL When `null`, the `qldb` field will be omitted from the resulting object.\n - `quicksight` (`string`): Use this to override the default service endpoint URL When `null`, the `quicksight` field will be omitted from the resulting object.\n - `ram` (`string`): Use this to override the default service endpoint URL When `null`, the `ram` field will be omitted from the resulting object.\n - `rbin` (`string`): Use this to override the default service endpoint URL When `null`, the `rbin` field will be omitted from the resulting object.\n - `rds` (`string`): Use this to override the default service endpoint URL When `null`, the `rds` field will be omitted from the resulting object.\n - `recyclebin` (`string`): Use this to override the default service endpoint URL When `null`, the `recyclebin` field will be omitted from the resulting object.\n - `redshift` (`string`): Use this to override the default service endpoint URL When `null`, the `redshift` field will be omitted from the resulting object.\n - `redshiftdata` (`string`): Use this to override the default service endpoint URL When `null`, the `redshiftdata` field will be omitted from the resulting object.\n - `redshiftdataapiservice` (`string`): Use this to override the default service endpoint URL When `null`, the `redshiftdataapiservice` field will be omitted from the resulting object.\n - `redshiftserverless` (`string`): Use this to override the default service endpoint URL When `null`, the `redshiftserverless` field will be omitted from the resulting object.\n - `resourceexplorer2` (`string`): Use this to override the default service endpoint URL When `null`, the `resourceexplorer2` field will be omitted from the resulting object.\n - `resourcegroups` (`string`): Use this to override the default service endpoint URL When `null`, the `resourcegroups` field will be omitted from the resulting object.\n - `resourcegroupstagging` (`string`): Use this to override the default service endpoint URL When `null`, the `resourcegroupstagging` field will be omitted from the resulting object.\n - `resourcegroupstaggingapi` (`string`): Use this to override the default service endpoint URL When `null`, the `resourcegroupstaggingapi` field will be omitted from the resulting object.\n - `rolesanywhere` (`string`): Use this to override the default service endpoint URL When `null`, the `rolesanywhere` field will be omitted from the resulting object.\n - `route53` (`string`): Use this to override the default service endpoint URL When `null`, the `route53` field will be omitted from the resulting object.\n - `route53domains` (`string`): Use this to override the default service endpoint URL When `null`, the `route53domains` field will be omitted from the resulting object.\n - `route53recoverycontrolconfig` (`string`): Use this to override the default service endpoint URL When `null`, the `route53recoverycontrolconfig` field will be omitted from the resulting object.\n - `route53recoveryreadiness` (`string`): Use this to override the default service endpoint URL When `null`, the `route53recoveryreadiness` field will be omitted from the resulting object.\n - `route53resolver` (`string`): Use this to override the default service endpoint URL When `null`, the `route53resolver` field will be omitted from the resulting object.\n - `rum` (`string`): Use this to override the default service endpoint URL When `null`, the `rum` field will be omitted from the resulting object.\n - `s3` (`string`): Use this to override the default service endpoint URL When `null`, the `s3` field will be omitted from the resulting object.\n - `s3api` (`string`): Use this to override the default service endpoint URL When `null`, the `s3api` field will be omitted from the resulting object.\n - `s3control` (`string`): Use this to override the default service endpoint URL When `null`, the `s3control` field will be omitted from the resulting object.\n - `s3outposts` (`string`): Use this to override the default service endpoint URL When `null`, the `s3outposts` field will be omitted from the resulting object.\n - `sagemaker` (`string`): Use this to override the default service endpoint URL When `null`, the `sagemaker` field will be omitted from the resulting object.\n - `scheduler` (`string`): Use this to override the default service endpoint URL When `null`, the `scheduler` field will be omitted from the resulting object.\n - `schemas` (`string`): Use this to override the default service endpoint URL When `null`, the `schemas` field will be omitted from the resulting object.\n - `sdb` (`string`): Use this to override the default service endpoint URL When `null`, the `sdb` field will be omitted from the resulting object.\n - `secretsmanager` (`string`): Use this to override the default service endpoint URL When `null`, the `secretsmanager` field will be omitted from the resulting object.\n - `securityhub` (`string`): Use this to override the default service endpoint URL When `null`, the `securityhub` field will be omitted from the resulting object.\n - `securitylake` (`string`): Use this to override the default service endpoint URL When `null`, the `securitylake` field will be omitted from the resulting object.\n - `serverlessapplicationrepository` (`string`): Use this to override the default service endpoint URL When `null`, the `serverlessapplicationrepository` field will be omitted from the resulting object.\n - `serverlessapprepo` (`string`): Use this to override the default service endpoint URL When `null`, the `serverlessapprepo` field will be omitted from the resulting object.\n - `serverlessrepo` (`string`): Use this to override the default service endpoint URL When `null`, the `serverlessrepo` field will be omitted from the resulting object.\n - `servicecatalog` (`string`): Use this to override the default service endpoint URL When `null`, the `servicecatalog` field will be omitted from the resulting object.\n - `servicediscovery` (`string`): Use this to override the default service endpoint URL When `null`, the `servicediscovery` field will be omitted from the resulting object.\n - `servicequotas` (`string`): Use this to override the default service endpoint URL When `null`, the `servicequotas` field will be omitted from the resulting object.\n - `ses` (`string`): Use this to override the default service endpoint URL When `null`, the `ses` field will be omitted from the resulting object.\n - `sesv2` (`string`): Use this to override the default service endpoint URL When `null`, the `sesv2` field will be omitted from the resulting object.\n - `sfn` (`string`): Use this to override the default service endpoint URL When `null`, the `sfn` field will be omitted from the resulting object.\n - `shield` (`string`): Use this to override the default service endpoint URL When `null`, the `shield` field will be omitted from the resulting object.\n - `signer` (`string`): Use this to override the default service endpoint URL When `null`, the `signer` field will be omitted from the resulting object.\n - `simpledb` (`string`): Use this to override the default service endpoint URL When `null`, the `simpledb` field will be omitted from the resulting object.\n - `sns` (`string`): Use this to override the default service endpoint URL When `null`, the `sns` field will be omitted from the resulting object.\n - `sqs` (`string`): Use this to override the default service endpoint URL When `null`, the `sqs` field will be omitted from the resulting object.\n - `ssm` (`string`): Use this to override the default service endpoint URL When `null`, the `ssm` field will be omitted from the resulting object.\n - `ssmcontacts` (`string`): Use this to override the default service endpoint URL When `null`, the `ssmcontacts` field will be omitted from the resulting object.\n - `ssmincidents` (`string`): Use this to override the default service endpoint URL When `null`, the `ssmincidents` field will be omitted from the resulting object.\n - `ssoadmin` (`string`): Use this to override the default service endpoint URL When `null`, the `ssoadmin` field will be omitted from the resulting object.\n - `stepfunctions` (`string`): Use this to override the default service endpoint URL When `null`, the `stepfunctions` field will be omitted from the resulting object.\n - `storagegateway` (`string`): Use this to override the default service endpoint URL When `null`, the `storagegateway` field will be omitted from the resulting object.\n - `sts` (`string`): Use this to override the default service endpoint URL When `null`, the `sts` field will be omitted from the resulting object.\n - `swf` (`string`): Use this to override the default service endpoint URL When `null`, the `swf` field will be omitted from the resulting object.\n - `synthetics` (`string`): Use this to override the default service endpoint URL When `null`, the `synthetics` field will be omitted from the resulting object.\n - `timestreamwrite` (`string`): Use this to override the default service endpoint URL When `null`, the `timestreamwrite` field will be omitted from the resulting object.\n - `transcribe` (`string`): Use this to override the default service endpoint URL When `null`, the `transcribe` field will be omitted from the resulting object.\n - `transcribeservice` (`string`): Use this to override the default service endpoint URL When `null`, the `transcribeservice` field will be omitted from the resulting object.\n - `transfer` (`string`): Use this to override the default service endpoint URL When `null`, the `transfer` field will be omitted from the resulting object.\n - `verifiedpermissions` (`string`): Use this to override the default service endpoint URL When `null`, the `verifiedpermissions` field will be omitted from the resulting object.\n - `vpclattice` (`string`): Use this to override the default service endpoint URL When `null`, the `vpclattice` field will be omitted from the resulting object.\n - `waf` (`string`): Use this to override the default service endpoint URL When `null`, the `waf` field will be omitted from the resulting object.\n - `wafregional` (`string`): Use this to override the default service endpoint URL When `null`, the `wafregional` field will be omitted from the resulting object.\n - `wafv2` (`string`): Use this to override the default service endpoint URL When `null`, the `wafv2` field will be omitted from the resulting object.\n - `worklink` (`string`): Use this to override the default service endpoint URL When `null`, the `worklink` field will be omitted from the resulting object.\n - `workspaces` (`string`): Use this to override the default service endpoint URL When `null`, the `workspaces` field will be omitted from the resulting object.\n - `xray` (`string`): Use this to override the default service endpoint URL When `null`, the `xray` field will be omitted from the resulting object.\n\n**Returns**:\n - An attribute object that represents the `endpoints` sub block.\n', args=[]), new( accessanalyzer=null, account=null, @@ -339,6 +343,8 @@ local d = (import 'github.com/jsonnet-libs/docsonnet/doc-util/main.libsonnet'); lexmodelbuilding=null, lexmodelbuildingservice=null, lexmodels=null, + lexmodelsv2=null, + lexv2models=null, licensemanager=null, lightsail=null, location=null, @@ -587,6 +593,8 @@ local d = (import 'github.com/jsonnet-libs/docsonnet/doc-util/main.libsonnet'); lexmodelbuilding: lexmodelbuilding, lexmodelbuildingservice: lexmodelbuildingservice, lexmodels: lexmodels, + lexmodelsv2: lexmodelsv2, + lexv2models: lexv2models, licensemanager: licensemanager, lightsail: lightsail, location: location, diff --git a/5.x/_gen/resources/api_gateway_api_key.libsonnet b/5.x/_gen/resources/api_gateway_api_key.libsonnet index b722a498..0bc98ba7 100644 --- a/5.x/_gen/resources/api_gateway_api_key.libsonnet +++ b/5.x/_gen/resources/api_gateway_api_key.libsonnet @@ -2,10 +2,11 @@ local tf = (import 'github.com/tf-libsonnet/core/main.libsonnet'); local d = (import 'github.com/jsonnet-libs/docsonnet/doc-util/main.libsonnet'); { '#':: d.pkg(name='api_gateway_api_key', url='', help='`api_gateway_api_key` represents the `aws_api_gateway_api_key` Terraform resource.\n\n\n\nThis package contains functions and utilities for setting up the resource using Jsonnet code.\n'), - '#new':: d.fn(help="\n`aws.api_gateway_api_key.new` injects a new `aws_api_gateway_api_key` Terraform `resource`\nblock into the root module document.\n\nAdditionally, this inserts a private function into the `_ref` attribute that generates references to attributes of the\nresource. For example, if you added a new instance to the root using:\n\n # arguments omitted for brevity\n aws.api_gateway_api_key.new('some_id')\n\nYou can get the reference to the `id` field of the created `aws.api_gateway_api_key` using the reference:\n\n $._ref.aws_api_gateway_api_key.some_id.get('id')\n\nThis is the same as directly entering `\"${ aws_api_gateway_api_key.some_id.id }\"` as the value.\n\nNOTE: if you are chaining multiple resources together in a merge operation, you may not be able to use `super`, `self`,\nor `$` to refer to the root object. Instead, make an explicit outer object using `local`.\n\n**Args**:\n - `resourceLabel` (`string`): The name label of the block.\n - `description` (`string`): Set the `description` field on the resulting resource block. When `null`, the `description` field will be omitted from the resulting object.\n - `enabled` (`bool`): Set the `enabled` field on the resulting resource block. When `null`, the `enabled` field will be omitted from the resulting object.\n - `name` (`string`): Set the `name` field on the resulting resource block.\n - `tags` (`obj`): Set the `tags` field on the resulting resource block. When `null`, the `tags` field will be omitted from the resulting object.\n - `tags_all` (`obj`): Set the `tags_all` field on the resulting resource block. When `null`, the `tags_all` field will be omitted from the resulting object.\n - `value` (`string`): Set the `value` field on the resulting resource block. When `null`, the `value` field will be omitted from the resulting object.\n\n**Returns**:\n- A mixin object that injects the new resource into the root Terraform configuration.\n", args=[]), + '#new':: d.fn(help="\n`aws.api_gateway_api_key.new` injects a new `aws_api_gateway_api_key` Terraform `resource`\nblock into the root module document.\n\nAdditionally, this inserts a private function into the `_ref` attribute that generates references to attributes of the\nresource. For example, if you added a new instance to the root using:\n\n # arguments omitted for brevity\n aws.api_gateway_api_key.new('some_id')\n\nYou can get the reference to the `id` field of the created `aws.api_gateway_api_key` using the reference:\n\n $._ref.aws_api_gateway_api_key.some_id.get('id')\n\nThis is the same as directly entering `\"${ aws_api_gateway_api_key.some_id.id }\"` as the value.\n\nNOTE: if you are chaining multiple resources together in a merge operation, you may not be able to use `super`, `self`,\nor `$` to refer to the root object. Instead, make an explicit outer object using `local`.\n\n**Args**:\n - `resourceLabel` (`string`): The name label of the block.\n - `customer_id` (`string`): Set the `customer_id` field on the resulting resource block. When `null`, the `customer_id` field will be omitted from the resulting object.\n - `description` (`string`): Set the `description` field on the resulting resource block. When `null`, the `description` field will be omitted from the resulting object.\n - `enabled` (`bool`): Set the `enabled` field on the resulting resource block. When `null`, the `enabled` field will be omitted from the resulting object.\n - `name` (`string`): Set the `name` field on the resulting resource block.\n - `tags` (`obj`): Set the `tags` field on the resulting resource block. When `null`, the `tags` field will be omitted from the resulting object.\n - `tags_all` (`obj`): Set the `tags_all` field on the resulting resource block. When `null`, the `tags_all` field will be omitted from the resulting object.\n - `value` (`string`): Set the `value` field on the resulting resource block. When `null`, the `value` field will be omitted from the resulting object.\n\n**Returns**:\n- A mixin object that injects the new resource into the root Terraform configuration.\n", args=[]), new( resourceLabel, name, + customer_id=null, description=null, enabled=null, tags=null, @@ -16,6 +17,7 @@ local d = (import 'github.com/jsonnet-libs/docsonnet/doc-util/main.libsonnet'); type='aws_api_gateway_api_key', label=resourceLabel, attrs=self.newAttrs( + customer_id=customer_id, description=description, enabled=enabled, name=name, @@ -25,15 +27,17 @@ local d = (import 'github.com/jsonnet-libs/docsonnet/doc-util/main.libsonnet'); ), _meta=_meta ), - '#newAttrs':: d.fn(help='\n`aws.api_gateway_api_key.newAttrs` constructs a new object with attributes and blocks configured for the `api_gateway_api_key`\nTerraform resource.\n\nUnlike [aws.api_gateway_api_key.new](#fn-new), this function will not inject the `resource`\nblock into the root Terraform document. Instead, this must be passed in as the `attrs` argument for the\n[tf.withResource](https://github.com/tf-libsonnet/core/tree/main/docs#fn-withresource) function to build a complete block.\n\nThis is most useful when you need to preprocess the attributes with functions, conditional, or looping logic prior to\ninjecting into a complete block.\n\n**Args**:\n - `description` (`string`): Set the `description` field on the resulting object. When `null`, the `description` field will be omitted from the resulting object.\n - `enabled` (`bool`): Set the `enabled` field on the resulting object. When `null`, the `enabled` field will be omitted from the resulting object.\n - `name` (`string`): Set the `name` field on the resulting object.\n - `tags` (`obj`): Set the `tags` field on the resulting object. When `null`, the `tags` field will be omitted from the resulting object.\n - `tags_all` (`obj`): Set the `tags_all` field on the resulting object. When `null`, the `tags_all` field will be omitted from the resulting object.\n - `value` (`string`): Set the `value` field on the resulting object. When `null`, the `value` field will be omitted from the resulting object.\n\n**Returns**:\n - An attribute object that can be used with [tf.withResource](https://github.com/tf-libsonnet/core/tree/main/docs#fn-withresource) to construct a new `api_gateway_api_key` resource into the root Terraform configuration.\n', args=[]), + '#newAttrs':: d.fn(help='\n`aws.api_gateway_api_key.newAttrs` constructs a new object with attributes and blocks configured for the `api_gateway_api_key`\nTerraform resource.\n\nUnlike [aws.api_gateway_api_key.new](#fn-new), this function will not inject the `resource`\nblock into the root Terraform document. Instead, this must be passed in as the `attrs` argument for the\n[tf.withResource](https://github.com/tf-libsonnet/core/tree/main/docs#fn-withresource) function to build a complete block.\n\nThis is most useful when you need to preprocess the attributes with functions, conditional, or looping logic prior to\ninjecting into a complete block.\n\n**Args**:\n - `customer_id` (`string`): Set the `customer_id` field on the resulting object. When `null`, the `customer_id` field will be omitted from the resulting object.\n - `description` (`string`): Set the `description` field on the resulting object. When `null`, the `description` field will be omitted from the resulting object.\n - `enabled` (`bool`): Set the `enabled` field on the resulting object. When `null`, the `enabled` field will be omitted from the resulting object.\n - `name` (`string`): Set the `name` field on the resulting object.\n - `tags` (`obj`): Set the `tags` field on the resulting object. When `null`, the `tags` field will be omitted from the resulting object.\n - `tags_all` (`obj`): Set the `tags_all` field on the resulting object. When `null`, the `tags_all` field will be omitted from the resulting object.\n - `value` (`string`): Set the `value` field on the resulting object. When `null`, the `value` field will be omitted from the resulting object.\n\n**Returns**:\n - An attribute object that can be used with [tf.withResource](https://github.com/tf-libsonnet/core/tree/main/docs#fn-withresource) to construct a new `api_gateway_api_key` resource into the root Terraform configuration.\n', args=[]), newAttrs( name, + customer_id=null, description=null, enabled=null, tags=null, tags_all=null, value=null ):: std.prune(a={ + customer_id: customer_id, description: description, enabled: enabled, name: name, @@ -41,6 +45,16 @@ local d = (import 'github.com/jsonnet-libs/docsonnet/doc-util/main.libsonnet'); tags_all: tags_all, value: value, }), + '#withCustomerId':: d.fn(help='`aws.string.withCustomerId` constructs a mixin object that can be merged into the `string`\nTerraform resource block to set or update the customer_id field.\n\n\n\n**Args**:\n - `resourceLabel` (`string`): The name label of the block to update.\n - `value` (`string`): The value to set for the `customer_id` field.\n', args=[]), + withCustomerId(resourceLabel, value): { + resource+: { + aws_api_gateway_api_key+: { + [resourceLabel]+: { + customer_id: value, + }, + }, + }, + }, '#withDescription':: d.fn(help='`aws.string.withDescription` constructs a mixin object that can be merged into the `string`\nTerraform resource block to set or update the description field.\n\n\n\n**Args**:\n - `resourceLabel` (`string`): The name label of the block to update.\n - `value` (`string`): The value to set for the `description` field.\n', args=[]), withDescription(resourceLabel, value): { resource+: { diff --git a/5.x/_gen/resources/autoscaling_group.libsonnet b/5.x/_gen/resources/autoscaling_group.libsonnet index 2399c624..153fd343 100644 --- a/5.x/_gen/resources/autoscaling_group.libsonnet +++ b/5.x/_gen/resources/autoscaling_group.libsonnet @@ -34,21 +34,25 @@ local d = (import 'github.com/jsonnet-libs/docsonnet/doc-util/main.libsonnet'); triggers: triggers, }), preferences:: { - '#new':: d.fn(help='\n`aws.autoscaling_group.instance_refresh.preferences.new` constructs a new object with attributes and blocks configured for the `preferences`\nTerraform sub block.\n\n\n\n**Args**:\n - `auto_rollback` (`bool`): Set the `auto_rollback` field on the resulting object. When `null`, the `auto_rollback` field will be omitted from the resulting object.\n - `checkpoint_delay` (`string`): Set the `checkpoint_delay` field on the resulting object. When `null`, the `checkpoint_delay` field will be omitted from the resulting object.\n - `checkpoint_percentages` (`list`): Set the `checkpoint_percentages` field on the resulting object. When `null`, the `checkpoint_percentages` field will be omitted from the resulting object.\n - `instance_warmup` (`string`): Set the `instance_warmup` field on the resulting object. When `null`, the `instance_warmup` field will be omitted from the resulting object.\n - `min_healthy_percentage` (`number`): Set the `min_healthy_percentage` field on the resulting object. When `null`, the `min_healthy_percentage` field will be omitted from the resulting object.\n - `skip_matching` (`bool`): Set the `skip_matching` field on the resulting object. When `null`, the `skip_matching` field will be omitted from the resulting object.\n\n**Returns**:\n - An attribute object that represents the `preferences` sub block.\n', args=[]), + '#new':: d.fn(help='\n`aws.autoscaling_group.instance_refresh.preferences.new` constructs a new object with attributes and blocks configured for the `preferences`\nTerraform sub block.\n\n\n\n**Args**:\n - `auto_rollback` (`bool`): Set the `auto_rollback` field on the resulting object. When `null`, the `auto_rollback` field will be omitted from the resulting object.\n - `checkpoint_delay` (`string`): Set the `checkpoint_delay` field on the resulting object. When `null`, the `checkpoint_delay` field will be omitted from the resulting object.\n - `checkpoint_percentages` (`list`): Set the `checkpoint_percentages` field on the resulting object. When `null`, the `checkpoint_percentages` field will be omitted from the resulting object.\n - `instance_warmup` (`string`): Set the `instance_warmup` field on the resulting object. When `null`, the `instance_warmup` field will be omitted from the resulting object.\n - `min_healthy_percentage` (`number`): Set the `min_healthy_percentage` field on the resulting object. When `null`, the `min_healthy_percentage` field will be omitted from the resulting object.\n - `scale_in_protected_instances` (`string`): Set the `scale_in_protected_instances` field on the resulting object. When `null`, the `scale_in_protected_instances` field will be omitted from the resulting object.\n - `skip_matching` (`bool`): Set the `skip_matching` field on the resulting object. When `null`, the `skip_matching` field will be omitted from the resulting object.\n - `standby_instances` (`string`): Set the `standby_instances` field on the resulting object. When `null`, the `standby_instances` field will be omitted from the resulting object.\n\n**Returns**:\n - An attribute object that represents the `preferences` sub block.\n', args=[]), new( auto_rollback=null, checkpoint_delay=null, checkpoint_percentages=null, instance_warmup=null, min_healthy_percentage=null, - skip_matching=null + scale_in_protected_instances=null, + skip_matching=null, + standby_instances=null ):: std.prune(a={ auto_rollback: auto_rollback, checkpoint_delay: checkpoint_delay, checkpoint_percentages: checkpoint_percentages, instance_warmup: instance_warmup, min_healthy_percentage: min_healthy_percentage, + scale_in_protected_instances: scale_in_protected_instances, skip_matching: skip_matching, + standby_instances: standby_instances, }), }, }, diff --git a/5.x/_gen/resources/batch_job_queue.libsonnet b/5.x/_gen/resources/batch_job_queue.libsonnet index b4a7720c..eec0c97a 100644 --- a/5.x/_gen/resources/batch_job_queue.libsonnet +++ b/5.x/_gen/resources/batch_job_queue.libsonnet @@ -2,7 +2,7 @@ local tf = (import 'github.com/tf-libsonnet/core/main.libsonnet'); local d = (import 'github.com/jsonnet-libs/docsonnet/doc-util/main.libsonnet'); { '#':: d.pkg(name='batch_job_queue', url='', help='`batch_job_queue` represents the `aws_batch_job_queue` Terraform resource.\n\n\n\nThis package contains functions and utilities for setting up the resource using Jsonnet code.\n'), - '#new':: d.fn(help="\n`aws.batch_job_queue.new` injects a new `aws_batch_job_queue` Terraform `resource`\nblock into the root module document.\n\nAdditionally, this inserts a private function into the `_ref` attribute that generates references to attributes of the\nresource. For example, if you added a new instance to the root using:\n\n # arguments omitted for brevity\n aws.batch_job_queue.new('some_id')\n\nYou can get the reference to the `id` field of the created `aws.batch_job_queue` using the reference:\n\n $._ref.aws_batch_job_queue.some_id.get('id')\n\nThis is the same as directly entering `\"${ aws_batch_job_queue.some_id.id }\"` as the value.\n\nNOTE: if you are chaining multiple resources together in a merge operation, you may not be able to use `super`, `self`,\nor `$` to refer to the root object. Instead, make an explicit outer object using `local`.\n\n**Args**:\n - `resourceLabel` (`string`): The name label of the block.\n - `compute_environments` (`list`): Set the `compute_environments` field on the resulting resource block.\n - `name` (`string`): Set the `name` field on the resulting resource block.\n - `priority` (`number`): Set the `priority` field on the resulting resource block.\n - `scheduling_policy_arn` (`string`): Set the `scheduling_policy_arn` field on the resulting resource block. When `null`, the `scheduling_policy_arn` field will be omitted from the resulting object.\n - `state` (`string`): Set the `state` field on the resulting resource block.\n - `tags` (`obj`): Set the `tags` field on the resulting resource block. When `null`, the `tags` field will be omitted from the resulting object.\n - `tags_all` (`obj`): Set the `tags_all` field on the resulting resource block. When `null`, the `tags_all` field will be omitted from the resulting object.\n\n**Returns**:\n- A mixin object that injects the new resource into the root Terraform configuration.\n", args=[]), + '#new':: d.fn(help="\n`aws.batch_job_queue.new` injects a new `aws_batch_job_queue` Terraform `resource`\nblock into the root module document.\n\nAdditionally, this inserts a private function into the `_ref` attribute that generates references to attributes of the\nresource. For example, if you added a new instance to the root using:\n\n # arguments omitted for brevity\n aws.batch_job_queue.new('some_id')\n\nYou can get the reference to the `id` field of the created `aws.batch_job_queue` using the reference:\n\n $._ref.aws_batch_job_queue.some_id.get('id')\n\nThis is the same as directly entering `\"${ aws_batch_job_queue.some_id.id }\"` as the value.\n\nNOTE: if you are chaining multiple resources together in a merge operation, you may not be able to use `super`, `self`,\nor `$` to refer to the root object. Instead, make an explicit outer object using `local`.\n\n**Args**:\n - `resourceLabel` (`string`): The name label of the block.\n - `compute_environments` (`list`): Set the `compute_environments` field on the resulting resource block.\n - `name` (`string`): Set the `name` field on the resulting resource block.\n - `priority` (`number`): Set the `priority` field on the resulting resource block.\n - `scheduling_policy_arn` (`string`): Set the `scheduling_policy_arn` field on the resulting resource block. When `null`, the `scheduling_policy_arn` field will be omitted from the resulting object.\n - `state` (`string`): Set the `state` field on the resulting resource block.\n - `tags` (`obj`): Set the `tags` field on the resulting resource block. When `null`, the `tags` field will be omitted from the resulting object.\n - `timeouts` (`obj`): Set the `timeouts` field on the resulting resource block. When `null`, the `timeouts` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [aws.batch_job_queue.timeouts.new](#fn-timeoutsnew) constructor.\n\n**Returns**:\n- A mixin object that injects the new resource into the root Terraform configuration.\n", args=[]), new( resourceLabel, compute_environments, @@ -11,7 +11,7 @@ local d = (import 'github.com/jsonnet-libs/docsonnet/doc-util/main.libsonnet'); state, scheduling_policy_arn=null, tags=null, - tags_all=null, + timeouts=null, _meta={} ):: tf.withResource( type='aws_batch_job_queue', @@ -23,11 +23,11 @@ local d = (import 'github.com/jsonnet-libs/docsonnet/doc-util/main.libsonnet'); scheduling_policy_arn=scheduling_policy_arn, state=state, tags=tags, - tags_all=tags_all + timeouts=timeouts ), _meta=_meta ), - '#newAttrs':: d.fn(help='\n`aws.batch_job_queue.newAttrs` constructs a new object with attributes and blocks configured for the `batch_job_queue`\nTerraform resource.\n\nUnlike [aws.batch_job_queue.new](#fn-new), this function will not inject the `resource`\nblock into the root Terraform document. Instead, this must be passed in as the `attrs` argument for the\n[tf.withResource](https://github.com/tf-libsonnet/core/tree/main/docs#fn-withresource) function to build a complete block.\n\nThis is most useful when you need to preprocess the attributes with functions, conditional, or looping logic prior to\ninjecting into a complete block.\n\n**Args**:\n - `compute_environments` (`list`): Set the `compute_environments` field on the resulting object.\n - `name` (`string`): Set the `name` field on the resulting object.\n - `priority` (`number`): Set the `priority` field on the resulting object.\n - `scheduling_policy_arn` (`string`): Set the `scheduling_policy_arn` field on the resulting object. When `null`, the `scheduling_policy_arn` field will be omitted from the resulting object.\n - `state` (`string`): Set the `state` field on the resulting object.\n - `tags` (`obj`): Set the `tags` field on the resulting object. When `null`, the `tags` field will be omitted from the resulting object.\n - `tags_all` (`obj`): Set the `tags_all` field on the resulting object. When `null`, the `tags_all` field will be omitted from the resulting object.\n\n**Returns**:\n - An attribute object that can be used with [tf.withResource](https://github.com/tf-libsonnet/core/tree/main/docs#fn-withresource) to construct a new `batch_job_queue` resource into the root Terraform configuration.\n', args=[]), + '#newAttrs':: d.fn(help='\n`aws.batch_job_queue.newAttrs` constructs a new object with attributes and blocks configured for the `batch_job_queue`\nTerraform resource.\n\nUnlike [aws.batch_job_queue.new](#fn-new), this function will not inject the `resource`\nblock into the root Terraform document. Instead, this must be passed in as the `attrs` argument for the\n[tf.withResource](https://github.com/tf-libsonnet/core/tree/main/docs#fn-withresource) function to build a complete block.\n\nThis is most useful when you need to preprocess the attributes with functions, conditional, or looping logic prior to\ninjecting into a complete block.\n\n**Args**:\n - `compute_environments` (`list`): Set the `compute_environments` field on the resulting object.\n - `name` (`string`): Set the `name` field on the resulting object.\n - `priority` (`number`): Set the `priority` field on the resulting object.\n - `scheduling_policy_arn` (`string`): Set the `scheduling_policy_arn` field on the resulting object. When `null`, the `scheduling_policy_arn` field will be omitted from the resulting object.\n - `state` (`string`): Set the `state` field on the resulting object.\n - `tags` (`obj`): Set the `tags` field on the resulting object. When `null`, the `tags` field will be omitted from the resulting object.\n - `timeouts` (`obj`): Set the `timeouts` field on the resulting object. When `null`, the `timeouts` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [aws.batch_job_queue.timeouts.new](#fn-timeoutsnew) constructor.\n\n**Returns**:\n - An attribute object that can be used with [tf.withResource](https://github.com/tf-libsonnet/core/tree/main/docs#fn-withresource) to construct a new `batch_job_queue` resource into the root Terraform configuration.\n', args=[]), newAttrs( compute_environments, name, @@ -35,7 +35,7 @@ local d = (import 'github.com/jsonnet-libs/docsonnet/doc-util/main.libsonnet'); state, scheduling_policy_arn=null, tags=null, - tags_all=null + timeouts=null ):: std.prune(a={ compute_environments: compute_environments, name: name, @@ -43,8 +43,20 @@ local d = (import 'github.com/jsonnet-libs/docsonnet/doc-util/main.libsonnet'); scheduling_policy_arn: scheduling_policy_arn, state: state, tags: tags, - tags_all: tags_all, + timeouts: timeouts, }), + timeouts:: { + '#new':: d.fn(help='\n`aws.batch_job_queue.timeouts.new` constructs a new object with attributes and blocks configured for the `timeouts`\nTerraform sub block.\n\n\n\n**Args**:\n - `create` (`string`): A string that can be [parsed as a duration](https://pkg.go.dev/time#ParseDuration) consisting of numbers and unit suffixes, such as "30s" or "2h45m". Valid time units are "s" (seconds), "m" (minutes), "h" (hours). When `null`, the `create` field will be omitted from the resulting object.\n - `delete` (`string`): A string that can be [parsed as a duration](https://pkg.go.dev/time#ParseDuration) consisting of numbers and unit suffixes, such as "30s" or "2h45m". Valid time units are "s" (seconds), "m" (minutes), "h" (hours). Setting a timeout for a Delete operation is only applicable if changes are saved into state before the destroy operation occurs. When `null`, the `delete` field will be omitted from the resulting object.\n - `update` (`string`): A string that can be [parsed as a duration](https://pkg.go.dev/time#ParseDuration) consisting of numbers and unit suffixes, such as "30s" or "2h45m". Valid time units are "s" (seconds), "m" (minutes), "h" (hours). When `null`, the `update` field will be omitted from the resulting object.\n\n**Returns**:\n - An attribute object that represents the `timeouts` sub block.\n', args=[]), + new( + create=null, + delete=null, + update=null + ):: std.prune(a={ + create: create, + delete: delete, + update: update, + }), + }, '#withComputeEnvironments':: d.fn(help='`aws.list.withComputeEnvironments` constructs a mixin object that can be merged into the `list`\nTerraform resource block to set or update the compute_environments field.\n\n\n\n**Args**:\n - `resourceLabel` (`string`): The name label of the block to update.\n - `value` (`list`): The value to set for the `compute_environments` field.\n', args=[]), withComputeEnvironments(resourceLabel, value): { resource+: { @@ -105,12 +117,22 @@ local d = (import 'github.com/jsonnet-libs/docsonnet/doc-util/main.libsonnet'); }, }, }, - '#withTagsAll':: d.fn(help='`aws.obj.withTagsAll` constructs a mixin object that can be merged into the `obj`\nTerraform resource block to set or update the tags_all field.\n\n\n\n**Args**:\n - `resourceLabel` (`string`): The name label of the block to update.\n - `value` (`obj`): The value to set for the `tags_all` field.\n', args=[]), - withTagsAll(resourceLabel, value): { + '#withTimeouts':: d.fn(help='`aws.obj.withTimeouts` constructs a mixin object that can be merged into the `obj`\nTerraform resource block to set or update the timeouts field.\n\nThis function will replace the map with the passed in `value`. If you wish to instead merge the\npassed in value to the existing map, use the [aws.obj.withTimeoutsMixin](TODO) function.\n\n**Args**:\n - `resourceLabel` (`string`): The name label of the block to update.\n - `value` (`obj`): The value to set for the `timeouts` field.\n', args=[]), + withTimeouts(resourceLabel, value): { + resource+: { + aws_batch_job_queue+: { + [resourceLabel]+: { + timeouts: value, + }, + }, + }, + }, + '#withTimeoutsMixin':: d.fn(help='`aws.obj.withTimeoutsMixin` constructs a mixin object that can be merged into the `obj`\nTerraform resource block to set or update the timeouts field.\n\nThis function will merge the passed in value to the existing map. If you wish\nto instead replace the entire map with the passed in `value`, use the [aws.obj.withTimeouts](TODO)\nfunction.\n\n\n**Args**:\n - `resourceLabel` (`string`): The name label of the block to update.\n - `value` (`obj`): The value to set for the `timeouts` field.\n', args=[]), + withTimeoutsMixin(resourceLabel, value): { resource+: { aws_batch_job_queue+: { [resourceLabel]+: { - tags_all: value, + timeouts+: value, }, }, }, diff --git a/5.x/_gen/resources/budgets_budget_action.libsonnet b/5.x/_gen/resources/budgets_budget_action.libsonnet index de3f3807..7eda2db5 100644 --- a/5.x/_gen/resources/budgets_budget_action.libsonnet +++ b/5.x/_gen/resources/budgets_budget_action.libsonnet @@ -126,12 +126,14 @@ local d = (import 'github.com/jsonnet-libs/docsonnet/doc-util/main.libsonnet'); }), }, timeouts:: { - '#new':: d.fn(help='\n`aws.budgets_budget_action.timeouts.new` constructs a new object with attributes and blocks configured for the `timeouts`\nTerraform sub block.\n\n\n\n**Args**:\n - `create` (`string`): Set the `create` field on the resulting object. When `null`, the `create` field will be omitted from the resulting object.\n - `update` (`string`): Set the `update` field on the resulting object. When `null`, the `update` field will be omitted from the resulting object.\n\n**Returns**:\n - An attribute object that represents the `timeouts` sub block.\n', args=[]), + '#new':: d.fn(help='\n`aws.budgets_budget_action.timeouts.new` constructs a new object with attributes and blocks configured for the `timeouts`\nTerraform sub block.\n\n\n\n**Args**:\n - `create` (`string`): Set the `create` field on the resulting object. When `null`, the `create` field will be omitted from the resulting object.\n - `delete` (`string`): Set the `delete` field on the resulting object. When `null`, the `delete` field will be omitted from the resulting object.\n - `update` (`string`): Set the `update` field on the resulting object. When `null`, the `update` field will be omitted from the resulting object.\n\n**Returns**:\n - An attribute object that represents the `timeouts` sub block.\n', args=[]), new( create=null, + delete=null, update=null ):: std.prune(a={ create: create, + delete: delete, update: update, }), }, diff --git a/5.x/_gen/resources/datasync_location_azure_blob.libsonnet b/5.x/_gen/resources/datasync_location_azure_blob.libsonnet new file mode 100644 index 00000000..aa89bb0b --- /dev/null +++ b/5.x/_gen/resources/datasync_location_azure_blob.libsonnet @@ -0,0 +1,164 @@ +local tf = (import 'github.com/tf-libsonnet/core/main.libsonnet'); +local d = (import 'github.com/jsonnet-libs/docsonnet/doc-util/main.libsonnet'); +{ + '#':: d.pkg(name='datasync_location_azure_blob', url='', help='`datasync_location_azure_blob` represents the `aws_datasync_location_azure_blob` Terraform resource.\n\n\n\nThis package contains functions and utilities for setting up the resource using Jsonnet code.\n'), + '#new':: d.fn(help="\n`aws.datasync_location_azure_blob.new` injects a new `aws_datasync_location_azure_blob` Terraform `resource`\nblock into the root module document.\n\nAdditionally, this inserts a private function into the `_ref` attribute that generates references to attributes of the\nresource. For example, if you added a new instance to the root using:\n\n # arguments omitted for brevity\n aws.datasync_location_azure_blob.new('some_id')\n\nYou can get the reference to the `id` field of the created `aws.datasync_location_azure_blob` using the reference:\n\n $._ref.aws_datasync_location_azure_blob.some_id.get('id')\n\nThis is the same as directly entering `\"${ aws_datasync_location_azure_blob.some_id.id }\"` as the value.\n\nNOTE: if you are chaining multiple resources together in a merge operation, you may not be able to use `super`, `self`,\nor `$` to refer to the root object. Instead, make an explicit outer object using `local`.\n\n**Args**:\n - `resourceLabel` (`string`): The name label of the block.\n - `access_tier` (`string`): Set the `access_tier` field on the resulting resource block. When `null`, the `access_tier` field will be omitted from the resulting object.\n - `agent_arns` (`list`): Set the `agent_arns` field on the resulting resource block.\n - `authentication_type` (`string`): Set the `authentication_type` field on the resulting resource block.\n - `blob_type` (`string`): Set the `blob_type` field on the resulting resource block. When `null`, the `blob_type` field will be omitted from the resulting object.\n - `container_url` (`string`): Set the `container_url` field on the resulting resource block.\n - `subdirectory` (`string`): Set the `subdirectory` field on the resulting resource block. When `null`, the `subdirectory` field will be omitted from the resulting object.\n - `tags` (`obj`): Set the `tags` field on the resulting resource block. When `null`, the `tags` field will be omitted from the resulting object.\n - `tags_all` (`obj`): Set the `tags_all` field on the resulting resource block. When `null`, the `tags_all` field will be omitted from the resulting object.\n - `sas_configuration` (`list[obj]`): Set the `sas_configuration` field on the resulting resource block. When `null`, the `sas_configuration` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [aws.datasync_location_azure_blob.sas_configuration.new](#fn-sas_configurationnew) constructor.\n\n**Returns**:\n- A mixin object that injects the new resource into the root Terraform configuration.\n", args=[]), + new( + resourceLabel, + agent_arns, + authentication_type, + container_url, + access_tier=null, + blob_type=null, + sas_configuration=null, + subdirectory=null, + tags=null, + tags_all=null, + _meta={} + ):: tf.withResource( + type='aws_datasync_location_azure_blob', + label=resourceLabel, + attrs=self.newAttrs( + access_tier=access_tier, + agent_arns=agent_arns, + authentication_type=authentication_type, + blob_type=blob_type, + container_url=container_url, + sas_configuration=sas_configuration, + subdirectory=subdirectory, + tags=tags, + tags_all=tags_all + ), + _meta=_meta + ), + '#newAttrs':: d.fn(help='\n`aws.datasync_location_azure_blob.newAttrs` constructs a new object with attributes and blocks configured for the `datasync_location_azure_blob`\nTerraform resource.\n\nUnlike [aws.datasync_location_azure_blob.new](#fn-new), this function will not inject the `resource`\nblock into the root Terraform document. Instead, this must be passed in as the `attrs` argument for the\n[tf.withResource](https://github.com/tf-libsonnet/core/tree/main/docs#fn-withresource) function to build a complete block.\n\nThis is most useful when you need to preprocess the attributes with functions, conditional, or looping logic prior to\ninjecting into a complete block.\n\n**Args**:\n - `access_tier` (`string`): Set the `access_tier` field on the resulting object. When `null`, the `access_tier` field will be omitted from the resulting object.\n - `agent_arns` (`list`): Set the `agent_arns` field on the resulting object.\n - `authentication_type` (`string`): Set the `authentication_type` field on the resulting object.\n - `blob_type` (`string`): Set the `blob_type` field on the resulting object. When `null`, the `blob_type` field will be omitted from the resulting object.\n - `container_url` (`string`): Set the `container_url` field on the resulting object.\n - `subdirectory` (`string`): Set the `subdirectory` field on the resulting object. When `null`, the `subdirectory` field will be omitted from the resulting object.\n - `tags` (`obj`): Set the `tags` field on the resulting object. When `null`, the `tags` field will be omitted from the resulting object.\n - `tags_all` (`obj`): Set the `tags_all` field on the resulting object. When `null`, the `tags_all` field will be omitted from the resulting object.\n - `sas_configuration` (`list[obj]`): Set the `sas_configuration` field on the resulting object. When `null`, the `sas_configuration` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [aws.datasync_location_azure_blob.sas_configuration.new](#fn-sas_configurationnew) constructor.\n\n**Returns**:\n - An attribute object that can be used with [tf.withResource](https://github.com/tf-libsonnet/core/tree/main/docs#fn-withresource) to construct a new `datasync_location_azure_blob` resource into the root Terraform configuration.\n', args=[]), + newAttrs( + agent_arns, + authentication_type, + container_url, + access_tier=null, + blob_type=null, + sas_configuration=null, + subdirectory=null, + tags=null, + tags_all=null + ):: std.prune(a={ + access_tier: access_tier, + agent_arns: agent_arns, + authentication_type: authentication_type, + blob_type: blob_type, + container_url: container_url, + sas_configuration: sas_configuration, + subdirectory: subdirectory, + tags: tags, + tags_all: tags_all, + }), + sas_configuration:: { + '#new':: d.fn(help='\n`aws.datasync_location_azure_blob.sas_configuration.new` constructs a new object with attributes and blocks configured for the `sas_configuration`\nTerraform sub block.\n\n\n\n**Args**:\n - `token` (`string`): Set the `token` field on the resulting object.\n\n**Returns**:\n - An attribute object that represents the `sas_configuration` sub block.\n', args=[]), + new( + token + ):: std.prune(a={ + token: token, + }), + }, + '#withAccessTier':: d.fn(help='`aws.string.withAccessTier` constructs a mixin object that can be merged into the `string`\nTerraform resource block to set or update the access_tier field.\n\n\n\n**Args**:\n - `resourceLabel` (`string`): The name label of the block to update.\n - `value` (`string`): The value to set for the `access_tier` field.\n', args=[]), + withAccessTier(resourceLabel, value): { + resource+: { + aws_datasync_location_azure_blob+: { + [resourceLabel]+: { + access_tier: value, + }, + }, + }, + }, + '#withAgentArns':: d.fn(help='`aws.list.withAgentArns` constructs a mixin object that can be merged into the `list`\nTerraform resource block to set or update the agent_arns field.\n\n\n\n**Args**:\n - `resourceLabel` (`string`): The name label of the block to update.\n - `value` (`list`): The value to set for the `agent_arns` field.\n', args=[]), + withAgentArns(resourceLabel, value): { + resource+: { + aws_datasync_location_azure_blob+: { + [resourceLabel]+: { + agent_arns: value, + }, + }, + }, + }, + '#withAuthenticationType':: d.fn(help='`aws.string.withAuthenticationType` constructs a mixin object that can be merged into the `string`\nTerraform resource block to set or update the authentication_type field.\n\n\n\n**Args**:\n - `resourceLabel` (`string`): The name label of the block to update.\n - `value` (`string`): The value to set for the `authentication_type` field.\n', args=[]), + withAuthenticationType(resourceLabel, value): { + resource+: { + aws_datasync_location_azure_blob+: { + [resourceLabel]+: { + authentication_type: value, + }, + }, + }, + }, + '#withBlobType':: d.fn(help='`aws.string.withBlobType` constructs a mixin object that can be merged into the `string`\nTerraform resource block to set or update the blob_type field.\n\n\n\n**Args**:\n - `resourceLabel` (`string`): The name label of the block to update.\n - `value` (`string`): The value to set for the `blob_type` field.\n', args=[]), + withBlobType(resourceLabel, value): { + resource+: { + aws_datasync_location_azure_blob+: { + [resourceLabel]+: { + blob_type: value, + }, + }, + }, + }, + '#withContainerUrl':: d.fn(help='`aws.string.withContainerUrl` constructs a mixin object that can be merged into the `string`\nTerraform resource block to set or update the container_url field.\n\n\n\n**Args**:\n - `resourceLabel` (`string`): The name label of the block to update.\n - `value` (`string`): The value to set for the `container_url` field.\n', args=[]), + withContainerUrl(resourceLabel, value): { + resource+: { + aws_datasync_location_azure_blob+: { + [resourceLabel]+: { + container_url: value, + }, + }, + }, + }, + '#withSasConfiguration':: d.fn(help='`aws.list[obj].withSasConfiguration` constructs a mixin object that can be merged into the `list[obj]`\nTerraform resource block to set or update the sas_configuration field.\n\nThis function will replace the array with the passed in `value`. If you wish to instead append the\npassed in value to the existing array, use the [aws.list[obj].withSasConfigurationMixin](TODO) function.\n\n\n**Args**:\n - `resourceLabel` (`string`): The name label of the block to update.\n - `value` (`list[obj]`): The value to set for the `sas_configuration` field.\n', args=[]), + withSasConfiguration(resourceLabel, value): { + resource+: { + aws_datasync_location_azure_blob+: { + [resourceLabel]+: { + sas_configuration: value, + }, + }, + }, + }, + '#withSasConfigurationMixin':: d.fn(help='`aws.list[obj].withSasConfigurationMixin` constructs a mixin object that can be merged into the `list[obj]`\nTerraform resource block to set or update the sas_configuration field.\n\nThis function will append the passed in array or object to the existing array. If you wish\nto instead replace the array with the passed in `value`, use the [aws.list[obj].withSasConfiguration](TODO)\nfunction.\n\n\n**Args**:\n - `resourceLabel` (`string`): The name label of the block to update.\n - `value` (`list[obj]`): The value to set for the `sas_configuration` field.\n', args=[]), + withSasConfigurationMixin(resourceLabel, value): { + resource+: { + aws_datasync_location_azure_blob+: { + [resourceLabel]+: { + sas_configuration+: if std.isArray(v=value) then value else [value], + }, + }, + }, + }, + '#withSubdirectory':: d.fn(help='`aws.string.withSubdirectory` constructs a mixin object that can be merged into the `string`\nTerraform resource block to set or update the subdirectory field.\n\n\n\n**Args**:\n - `resourceLabel` (`string`): The name label of the block to update.\n - `value` (`string`): The value to set for the `subdirectory` field.\n', args=[]), + withSubdirectory(resourceLabel, value): { + resource+: { + aws_datasync_location_azure_blob+: { + [resourceLabel]+: { + subdirectory: value, + }, + }, + }, + }, + '#withTags':: d.fn(help='`aws.obj.withTags` constructs a mixin object that can be merged into the `obj`\nTerraform resource block to set or update the tags field.\n\n\n\n**Args**:\n - `resourceLabel` (`string`): The name label of the block to update.\n - `value` (`obj`): The value to set for the `tags` field.\n', args=[]), + withTags(resourceLabel, value): { + resource+: { + aws_datasync_location_azure_blob+: { + [resourceLabel]+: { + tags: value, + }, + }, + }, + }, + '#withTagsAll':: d.fn(help='`aws.obj.withTagsAll` constructs a mixin object that can be merged into the `obj`\nTerraform resource block to set or update the tags_all field.\n\n\n\n**Args**:\n - `resourceLabel` (`string`): The name label of the block to update.\n - `value` (`obj`): The value to set for the `tags_all` field.\n', args=[]), + withTagsAll(resourceLabel, value): { + resource+: { + aws_datasync_location_azure_blob+: { + [resourceLabel]+: { + tags_all: value, + }, + }, + }, + }, +} diff --git a/5.x/_gen/resources/datasync_location_fsx_ontap_file_system.libsonnet b/5.x/_gen/resources/datasync_location_fsx_ontap_file_system.libsonnet new file mode 100644 index 00000000..7c191482 --- /dev/null +++ b/5.x/_gen/resources/datasync_location_fsx_ontap_file_system.libsonnet @@ -0,0 +1,162 @@ +local tf = (import 'github.com/tf-libsonnet/core/main.libsonnet'); +local d = (import 'github.com/jsonnet-libs/docsonnet/doc-util/main.libsonnet'); +{ + '#':: d.pkg(name='datasync_location_fsx_ontap_file_system', url='', help='`datasync_location_fsx_ontap_file_system` represents the `aws_datasync_location_fsx_ontap_file_system` Terraform resource.\n\n\n\nThis package contains functions and utilities for setting up the resource using Jsonnet code.\n'), + '#new':: d.fn(help="\n`aws.datasync_location_fsx_ontap_file_system.new` injects a new `aws_datasync_location_fsx_ontap_file_system` Terraform `resource`\nblock into the root module document.\n\nAdditionally, this inserts a private function into the `_ref` attribute that generates references to attributes of the\nresource. For example, if you added a new instance to the root using:\n\n # arguments omitted for brevity\n aws.datasync_location_fsx_ontap_file_system.new('some_id')\n\nYou can get the reference to the `id` field of the created `aws.datasync_location_fsx_ontap_file_system` using the reference:\n\n $._ref.aws_datasync_location_fsx_ontap_file_system.some_id.get('id')\n\nThis is the same as directly entering `\"${ aws_datasync_location_fsx_ontap_file_system.some_id.id }\"` as the value.\n\nNOTE: if you are chaining multiple resources together in a merge operation, you may not be able to use `super`, `self`,\nor `$` to refer to the root object. Instead, make an explicit outer object using `local`.\n\n**Args**:\n - `resourceLabel` (`string`): The name label of the block.\n - `security_group_arns` (`list`): Set the `security_group_arns` field on the resulting resource block.\n - `storage_virtual_machine_arn` (`string`): Set the `storage_virtual_machine_arn` field on the resulting resource block.\n - `subdirectory` (`string`): Set the `subdirectory` field on the resulting resource block. When `null`, the `subdirectory` field will be omitted from the resulting object.\n - `tags` (`obj`): Set the `tags` field on the resulting resource block. When `null`, the `tags` field will be omitted from the resulting object.\n - `tags_all` (`obj`): Set the `tags_all` field on the resulting resource block. When `null`, the `tags_all` field will be omitted from the resulting object.\n - `protocol` (`list[obj]`): Set the `protocol` field on the resulting resource block. When `null`, the `protocol` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [aws.datasync_location_fsx_ontap_file_system.protocol.new](#fn-protocolnew) constructor.\n\n**Returns**:\n- A mixin object that injects the new resource into the root Terraform configuration.\n", args=[]), + new( + resourceLabel, + security_group_arns, + storage_virtual_machine_arn, + protocol=null, + subdirectory=null, + tags=null, + tags_all=null, + _meta={} + ):: tf.withResource( + type='aws_datasync_location_fsx_ontap_file_system', + label=resourceLabel, + attrs=self.newAttrs( + protocol=protocol, + security_group_arns=security_group_arns, + storage_virtual_machine_arn=storage_virtual_machine_arn, + subdirectory=subdirectory, + tags=tags, + tags_all=tags_all + ), + _meta=_meta + ), + '#newAttrs':: d.fn(help='\n`aws.datasync_location_fsx_ontap_file_system.newAttrs` constructs a new object with attributes and blocks configured for the `datasync_location_fsx_ontap_file_system`\nTerraform resource.\n\nUnlike [aws.datasync_location_fsx_ontap_file_system.new](#fn-new), this function will not inject the `resource`\nblock into the root Terraform document. Instead, this must be passed in as the `attrs` argument for the\n[tf.withResource](https://github.com/tf-libsonnet/core/tree/main/docs#fn-withresource) function to build a complete block.\n\nThis is most useful when you need to preprocess the attributes with functions, conditional, or looping logic prior to\ninjecting into a complete block.\n\n**Args**:\n - `security_group_arns` (`list`): Set the `security_group_arns` field on the resulting object.\n - `storage_virtual_machine_arn` (`string`): Set the `storage_virtual_machine_arn` field on the resulting object.\n - `subdirectory` (`string`): Set the `subdirectory` field on the resulting object. When `null`, the `subdirectory` field will be omitted from the resulting object.\n - `tags` (`obj`): Set the `tags` field on the resulting object. When `null`, the `tags` field will be omitted from the resulting object.\n - `tags_all` (`obj`): Set the `tags_all` field on the resulting object. When `null`, the `tags_all` field will be omitted from the resulting object.\n - `protocol` (`list[obj]`): Set the `protocol` field on the resulting object. When `null`, the `protocol` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [aws.datasync_location_fsx_ontap_file_system.protocol.new](#fn-protocolnew) constructor.\n\n**Returns**:\n - An attribute object that can be used with [tf.withResource](https://github.com/tf-libsonnet/core/tree/main/docs#fn-withresource) to construct a new `datasync_location_fsx_ontap_file_system` resource into the root Terraform configuration.\n', args=[]), + newAttrs( + security_group_arns, + storage_virtual_machine_arn, + protocol=null, + subdirectory=null, + tags=null, + tags_all=null + ):: std.prune(a={ + protocol: protocol, + security_group_arns: security_group_arns, + storage_virtual_machine_arn: storage_virtual_machine_arn, + subdirectory: subdirectory, + tags: tags, + tags_all: tags_all, + }), + protocol:: { + '#new':: d.fn(help='\n`aws.datasync_location_fsx_ontap_file_system.protocol.new` constructs a new object with attributes and blocks configured for the `protocol`\nTerraform sub block.\n\n\n\n**Args**:\n - `nfs` (`list[obj]`): Set the `nfs` field on the resulting object. When `null`, the `nfs` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [aws.datasync_location_fsx_ontap_file_system.protocol.nfs.new](#fn-protocolnfsnew) constructor.\n - `smb` (`list[obj]`): Set the `smb` field on the resulting object. When `null`, the `smb` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [aws.datasync_location_fsx_ontap_file_system.protocol.smb.new](#fn-protocolsmbnew) constructor.\n\n**Returns**:\n - An attribute object that represents the `protocol` sub block.\n', args=[]), + new( + nfs=null, + smb=null + ):: std.prune(a={ + nfs: nfs, + smb: smb, + }), + nfs:: { + mount_options:: { + '#new':: d.fn(help='\n`aws.datasync_location_fsx_ontap_file_system.protocol.nfs.mount_options.new` constructs a new object with attributes and blocks configured for the `mount_options`\nTerraform sub block.\n\n\n\n**Args**:\n - `version` (`string`): Set the `version` field on the resulting object. When `null`, the `version` field will be omitted from the resulting object.\n\n**Returns**:\n - An attribute object that represents the `mount_options` sub block.\n', args=[]), + new( + version=null + ):: std.prune(a={ + version: version, + }), + }, + '#new':: d.fn(help='\n`aws.datasync_location_fsx_ontap_file_system.protocol.nfs.new` constructs a new object with attributes and blocks configured for the `nfs`\nTerraform sub block.\n\n\n\n**Args**:\n - `mount_options` (`list[obj]`): Set the `mount_options` field on the resulting object. When `null`, the `mount_options` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [aws.datasync_location_fsx_ontap_file_system.protocol.nfs.mount_options.new](#fn-protocolprotocolmount_optionsnew) constructor.\n\n**Returns**:\n - An attribute object that represents the `nfs` sub block.\n', args=[]), + new( + mount_options=null + ):: std.prune(a={ + mount_options: mount_options, + }), + }, + smb:: { + mount_options:: { + '#new':: d.fn(help='\n`aws.datasync_location_fsx_ontap_file_system.protocol.smb.mount_options.new` constructs a new object with attributes and blocks configured for the `mount_options`\nTerraform sub block.\n\n\n\n**Args**:\n - `version` (`string`): Set the `version` field on the resulting object. When `null`, the `version` field will be omitted from the resulting object.\n\n**Returns**:\n - An attribute object that represents the `mount_options` sub block.\n', args=[]), + new( + version=null + ):: std.prune(a={ + version: version, + }), + }, + '#new':: d.fn(help='\n`aws.datasync_location_fsx_ontap_file_system.protocol.smb.new` constructs a new object with attributes and blocks configured for the `smb`\nTerraform sub block.\n\n\n\n**Args**:\n - `domain` (`string`): Set the `domain` field on the resulting object. When `null`, the `domain` field will be omitted from the resulting object.\n - `password` (`string`): Set the `password` field on the resulting object.\n - `user` (`string`): Set the `user` field on the resulting object.\n - `mount_options` (`list[obj]`): Set the `mount_options` field on the resulting object. When `null`, the `mount_options` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [aws.datasync_location_fsx_ontap_file_system.protocol.smb.mount_options.new](#fn-protocolprotocolmount_optionsnew) constructor.\n\n**Returns**:\n - An attribute object that represents the `smb` sub block.\n', args=[]), + new( + password, + user, + domain=null, + mount_options=null + ):: std.prune(a={ + domain: domain, + mount_options: mount_options, + password: password, + user: user, + }), + }, + }, + '#withProtocol':: d.fn(help='`aws.list[obj].withProtocol` constructs a mixin object that can be merged into the `list[obj]`\nTerraform resource block to set or update the protocol field.\n\nThis function will replace the array with the passed in `value`. If you wish to instead append the\npassed in value to the existing array, use the [aws.list[obj].withProtocolMixin](TODO) function.\n\n\n**Args**:\n - `resourceLabel` (`string`): The name label of the block to update.\n - `value` (`list[obj]`): The value to set for the `protocol` field.\n', args=[]), + withProtocol(resourceLabel, value): { + resource+: { + aws_datasync_location_fsx_ontap_file_system+: { + [resourceLabel]+: { + protocol: value, + }, + }, + }, + }, + '#withProtocolMixin':: d.fn(help='`aws.list[obj].withProtocolMixin` constructs a mixin object that can be merged into the `list[obj]`\nTerraform resource block to set or update the protocol field.\n\nThis function will append the passed in array or object to the existing array. If you wish\nto instead replace the array with the passed in `value`, use the [aws.list[obj].withProtocol](TODO)\nfunction.\n\n\n**Args**:\n - `resourceLabel` (`string`): The name label of the block to update.\n - `value` (`list[obj]`): The value to set for the `protocol` field.\n', args=[]), + withProtocolMixin(resourceLabel, value): { + resource+: { + aws_datasync_location_fsx_ontap_file_system+: { + [resourceLabel]+: { + protocol+: if std.isArray(v=value) then value else [value], + }, + }, + }, + }, + '#withSecurityGroupArns':: d.fn(help='`aws.list.withSecurityGroupArns` constructs a mixin object that can be merged into the `list`\nTerraform resource block to set or update the security_group_arns field.\n\n\n\n**Args**:\n - `resourceLabel` (`string`): The name label of the block to update.\n - `value` (`list`): The value to set for the `security_group_arns` field.\n', args=[]), + withSecurityGroupArns(resourceLabel, value): { + resource+: { + aws_datasync_location_fsx_ontap_file_system+: { + [resourceLabel]+: { + security_group_arns: value, + }, + }, + }, + }, + '#withStorageVirtualMachineArn':: d.fn(help='`aws.string.withStorageVirtualMachineArn` constructs a mixin object that can be merged into the `string`\nTerraform resource block to set or update the storage_virtual_machine_arn field.\n\n\n\n**Args**:\n - `resourceLabel` (`string`): The name label of the block to update.\n - `value` (`string`): The value to set for the `storage_virtual_machine_arn` field.\n', args=[]), + withStorageVirtualMachineArn(resourceLabel, value): { + resource+: { + aws_datasync_location_fsx_ontap_file_system+: { + [resourceLabel]+: { + storage_virtual_machine_arn: value, + }, + }, + }, + }, + '#withSubdirectory':: d.fn(help='`aws.string.withSubdirectory` constructs a mixin object that can be merged into the `string`\nTerraform resource block to set or update the subdirectory field.\n\n\n\n**Args**:\n - `resourceLabel` (`string`): The name label of the block to update.\n - `value` (`string`): The value to set for the `subdirectory` field.\n', args=[]), + withSubdirectory(resourceLabel, value): { + resource+: { + aws_datasync_location_fsx_ontap_file_system+: { + [resourceLabel]+: { + subdirectory: value, + }, + }, + }, + }, + '#withTags':: d.fn(help='`aws.obj.withTags` constructs a mixin object that can be merged into the `obj`\nTerraform resource block to set or update the tags field.\n\n\n\n**Args**:\n - `resourceLabel` (`string`): The name label of the block to update.\n - `value` (`obj`): The value to set for the `tags` field.\n', args=[]), + withTags(resourceLabel, value): { + resource+: { + aws_datasync_location_fsx_ontap_file_system+: { + [resourceLabel]+: { + tags: value, + }, + }, + }, + }, + '#withTagsAll':: d.fn(help='`aws.obj.withTagsAll` constructs a mixin object that can be merged into the `obj`\nTerraform resource block to set or update the tags_all field.\n\n\n\n**Args**:\n - `resourceLabel` (`string`): The name label of the block to update.\n - `value` (`obj`): The value to set for the `tags_all` field.\n', args=[]), + withTagsAll(resourceLabel, value): { + resource+: { + aws_datasync_location_fsx_ontap_file_system+: { + [resourceLabel]+: { + tags_all: value, + }, + }, + }, + }, +} diff --git a/5.x/_gen/resources/dms_replication_instance.libsonnet b/5.x/_gen/resources/dms_replication_instance.libsonnet index 53e73b1e..41337411 100644 --- a/5.x/_gen/resources/dms_replication_instance.libsonnet +++ b/5.x/_gen/resources/dms_replication_instance.libsonnet @@ -2,7 +2,7 @@ local tf = (import 'github.com/tf-libsonnet/core/main.libsonnet'); local d = (import 'github.com/jsonnet-libs/docsonnet/doc-util/main.libsonnet'); { '#':: d.pkg(name='dms_replication_instance', url='', help='`dms_replication_instance` represents the `aws_dms_replication_instance` Terraform resource.\n\n\n\nThis package contains functions and utilities for setting up the resource using Jsonnet code.\n'), - '#new':: d.fn(help="\n`aws.dms_replication_instance.new` injects a new `aws_dms_replication_instance` Terraform `resource`\nblock into the root module document.\n\nAdditionally, this inserts a private function into the `_ref` attribute that generates references to attributes of the\nresource. For example, if you added a new instance to the root using:\n\n # arguments omitted for brevity\n aws.dms_replication_instance.new('some_id')\n\nYou can get the reference to the `id` field of the created `aws.dms_replication_instance` using the reference:\n\n $._ref.aws_dms_replication_instance.some_id.get('id')\n\nThis is the same as directly entering `\"${ aws_dms_replication_instance.some_id.id }\"` as the value.\n\nNOTE: if you are chaining multiple resources together in a merge operation, you may not be able to use `super`, `self`,\nor `$` to refer to the root object. Instead, make an explicit outer object using `local`.\n\n**Args**:\n - `resourceLabel` (`string`): The name label of the block.\n - `allocated_storage` (`number`): Set the `allocated_storage` field on the resulting resource block. When `null`, the `allocated_storage` field will be omitted from the resulting object.\n - `allow_major_version_upgrade` (`bool`): Set the `allow_major_version_upgrade` field on the resulting resource block. When `null`, the `allow_major_version_upgrade` field will be omitted from the resulting object.\n - `apply_immediately` (`bool`): Set the `apply_immediately` field on the resulting resource block. When `null`, the `apply_immediately` field will be omitted from the resulting object.\n - `auto_minor_version_upgrade` (`bool`): Set the `auto_minor_version_upgrade` field on the resulting resource block. When `null`, the `auto_minor_version_upgrade` field will be omitted from the resulting object.\n - `availability_zone` (`string`): Set the `availability_zone` field on the resulting resource block. When `null`, the `availability_zone` field will be omitted from the resulting object.\n - `engine_version` (`string`): Set the `engine_version` field on the resulting resource block. When `null`, the `engine_version` field will be omitted from the resulting object.\n - `kms_key_arn` (`string`): Set the `kms_key_arn` field on the resulting resource block. When `null`, the `kms_key_arn` field will be omitted from the resulting object.\n - `multi_az` (`bool`): Set the `multi_az` field on the resulting resource block. When `null`, the `multi_az` field will be omitted from the resulting object.\n - `preferred_maintenance_window` (`string`): Set the `preferred_maintenance_window` field on the resulting resource block. When `null`, the `preferred_maintenance_window` field will be omitted from the resulting object.\n - `publicly_accessible` (`bool`): Set the `publicly_accessible` field on the resulting resource block. When `null`, the `publicly_accessible` field will be omitted from the resulting object.\n - `replication_instance_class` (`string`): Set the `replication_instance_class` field on the resulting resource block.\n - `replication_instance_id` (`string`): Set the `replication_instance_id` field on the resulting resource block.\n - `replication_subnet_group_id` (`string`): Set the `replication_subnet_group_id` field on the resulting resource block. When `null`, the `replication_subnet_group_id` field will be omitted from the resulting object.\n - `tags` (`obj`): Set the `tags` field on the resulting resource block. When `null`, the `tags` field will be omitted from the resulting object.\n - `tags_all` (`obj`): Set the `tags_all` field on the resulting resource block. When `null`, the `tags_all` field will be omitted from the resulting object.\n - `vpc_security_group_ids` (`list`): Set the `vpc_security_group_ids` field on the resulting resource block. When `null`, the `vpc_security_group_ids` field will be omitted from the resulting object.\n - `timeouts` (`obj`): Set the `timeouts` field on the resulting resource block. When `null`, the `timeouts` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [aws.dms_replication_instance.timeouts.new](#fn-timeoutsnew) constructor.\n\n**Returns**:\n- A mixin object that injects the new resource into the root Terraform configuration.\n", args=[]), + '#new':: d.fn(help="\n`aws.dms_replication_instance.new` injects a new `aws_dms_replication_instance` Terraform `resource`\nblock into the root module document.\n\nAdditionally, this inserts a private function into the `_ref` attribute that generates references to attributes of the\nresource. For example, if you added a new instance to the root using:\n\n # arguments omitted for brevity\n aws.dms_replication_instance.new('some_id')\n\nYou can get the reference to the `id` field of the created `aws.dms_replication_instance` using the reference:\n\n $._ref.aws_dms_replication_instance.some_id.get('id')\n\nThis is the same as directly entering `\"${ aws_dms_replication_instance.some_id.id }\"` as the value.\n\nNOTE: if you are chaining multiple resources together in a merge operation, you may not be able to use `super`, `self`,\nor `$` to refer to the root object. Instead, make an explicit outer object using `local`.\n\n**Args**:\n - `resourceLabel` (`string`): The name label of the block.\n - `allocated_storage` (`number`): Set the `allocated_storage` field on the resulting resource block. When `null`, the `allocated_storage` field will be omitted from the resulting object.\n - `allow_major_version_upgrade` (`bool`): Set the `allow_major_version_upgrade` field on the resulting resource block. When `null`, the `allow_major_version_upgrade` field will be omitted from the resulting object.\n - `apply_immediately` (`bool`): Set the `apply_immediately` field on the resulting resource block. When `null`, the `apply_immediately` field will be omitted from the resulting object.\n - `auto_minor_version_upgrade` (`bool`): Set the `auto_minor_version_upgrade` field on the resulting resource block. When `null`, the `auto_minor_version_upgrade` field will be omitted from the resulting object.\n - `availability_zone` (`string`): Set the `availability_zone` field on the resulting resource block. When `null`, the `availability_zone` field will be omitted from the resulting object.\n - `engine_version` (`string`): Set the `engine_version` field on the resulting resource block. When `null`, the `engine_version` field will be omitted from the resulting object.\n - `kms_key_arn` (`string`): Set the `kms_key_arn` field on the resulting resource block. When `null`, the `kms_key_arn` field will be omitted from the resulting object.\n - `multi_az` (`bool`): Set the `multi_az` field on the resulting resource block. When `null`, the `multi_az` field will be omitted from the resulting object.\n - `network_type` (`string`): Set the `network_type` field on the resulting resource block. When `null`, the `network_type` field will be omitted from the resulting object.\n - `preferred_maintenance_window` (`string`): Set the `preferred_maintenance_window` field on the resulting resource block. When `null`, the `preferred_maintenance_window` field will be omitted from the resulting object.\n - `publicly_accessible` (`bool`): Set the `publicly_accessible` field on the resulting resource block. When `null`, the `publicly_accessible` field will be omitted from the resulting object.\n - `replication_instance_class` (`string`): Set the `replication_instance_class` field on the resulting resource block.\n - `replication_instance_id` (`string`): Set the `replication_instance_id` field on the resulting resource block.\n - `replication_subnet_group_id` (`string`): Set the `replication_subnet_group_id` field on the resulting resource block. When `null`, the `replication_subnet_group_id` field will be omitted from the resulting object.\n - `tags` (`obj`): Set the `tags` field on the resulting resource block. When `null`, the `tags` field will be omitted from the resulting object.\n - `tags_all` (`obj`): Set the `tags_all` field on the resulting resource block. When `null`, the `tags_all` field will be omitted from the resulting object.\n - `vpc_security_group_ids` (`list`): Set the `vpc_security_group_ids` field on the resulting resource block. When `null`, the `vpc_security_group_ids` field will be omitted from the resulting object.\n - `timeouts` (`obj`): Set the `timeouts` field on the resulting resource block. When `null`, the `timeouts` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [aws.dms_replication_instance.timeouts.new](#fn-timeoutsnew) constructor.\n\n**Returns**:\n- A mixin object that injects the new resource into the root Terraform configuration.\n", args=[]), new( resourceLabel, replication_instance_class, @@ -15,6 +15,7 @@ local d = (import 'github.com/jsonnet-libs/docsonnet/doc-util/main.libsonnet'); engine_version=null, kms_key_arn=null, multi_az=null, + network_type=null, preferred_maintenance_window=null, publicly_accessible=null, replication_subnet_group_id=null, @@ -35,6 +36,7 @@ local d = (import 'github.com/jsonnet-libs/docsonnet/doc-util/main.libsonnet'); engine_version=engine_version, kms_key_arn=kms_key_arn, multi_az=multi_az, + network_type=network_type, preferred_maintenance_window=preferred_maintenance_window, publicly_accessible=publicly_accessible, replication_instance_class=replication_instance_class, @@ -47,7 +49,7 @@ local d = (import 'github.com/jsonnet-libs/docsonnet/doc-util/main.libsonnet'); ), _meta=_meta ), - '#newAttrs':: d.fn(help='\n`aws.dms_replication_instance.newAttrs` constructs a new object with attributes and blocks configured for the `dms_replication_instance`\nTerraform resource.\n\nUnlike [aws.dms_replication_instance.new](#fn-new), this function will not inject the `resource`\nblock into the root Terraform document. Instead, this must be passed in as the `attrs` argument for the\n[tf.withResource](https://github.com/tf-libsonnet/core/tree/main/docs#fn-withresource) function to build a complete block.\n\nThis is most useful when you need to preprocess the attributes with functions, conditional, or looping logic prior to\ninjecting into a complete block.\n\n**Args**:\n - `allocated_storage` (`number`): Set the `allocated_storage` field on the resulting object. When `null`, the `allocated_storage` field will be omitted from the resulting object.\n - `allow_major_version_upgrade` (`bool`): Set the `allow_major_version_upgrade` field on the resulting object. When `null`, the `allow_major_version_upgrade` field will be omitted from the resulting object.\n - `apply_immediately` (`bool`): Set the `apply_immediately` field on the resulting object. When `null`, the `apply_immediately` field will be omitted from the resulting object.\n - `auto_minor_version_upgrade` (`bool`): Set the `auto_minor_version_upgrade` field on the resulting object. When `null`, the `auto_minor_version_upgrade` field will be omitted from the resulting object.\n - `availability_zone` (`string`): Set the `availability_zone` field on the resulting object. When `null`, the `availability_zone` field will be omitted from the resulting object.\n - `engine_version` (`string`): Set the `engine_version` field on the resulting object. When `null`, the `engine_version` field will be omitted from the resulting object.\n - `kms_key_arn` (`string`): Set the `kms_key_arn` field on the resulting object. When `null`, the `kms_key_arn` field will be omitted from the resulting object.\n - `multi_az` (`bool`): Set the `multi_az` field on the resulting object. When `null`, the `multi_az` field will be omitted from the resulting object.\n - `preferred_maintenance_window` (`string`): Set the `preferred_maintenance_window` field on the resulting object. When `null`, the `preferred_maintenance_window` field will be omitted from the resulting object.\n - `publicly_accessible` (`bool`): Set the `publicly_accessible` field on the resulting object. When `null`, the `publicly_accessible` field will be omitted from the resulting object.\n - `replication_instance_class` (`string`): Set the `replication_instance_class` field on the resulting object.\n - `replication_instance_id` (`string`): Set the `replication_instance_id` field on the resulting object.\n - `replication_subnet_group_id` (`string`): Set the `replication_subnet_group_id` field on the resulting object. When `null`, the `replication_subnet_group_id` field will be omitted from the resulting object.\n - `tags` (`obj`): Set the `tags` field on the resulting object. When `null`, the `tags` field will be omitted from the resulting object.\n - `tags_all` (`obj`): Set the `tags_all` field on the resulting object. When `null`, the `tags_all` field will be omitted from the resulting object.\n - `vpc_security_group_ids` (`list`): Set the `vpc_security_group_ids` field on the resulting object. When `null`, the `vpc_security_group_ids` field will be omitted from the resulting object.\n - `timeouts` (`obj`): Set the `timeouts` field on the resulting object. When `null`, the `timeouts` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [aws.dms_replication_instance.timeouts.new](#fn-timeoutsnew) constructor.\n\n**Returns**:\n - An attribute object that can be used with [tf.withResource](https://github.com/tf-libsonnet/core/tree/main/docs#fn-withresource) to construct a new `dms_replication_instance` resource into the root Terraform configuration.\n', args=[]), + '#newAttrs':: d.fn(help='\n`aws.dms_replication_instance.newAttrs` constructs a new object with attributes and blocks configured for the `dms_replication_instance`\nTerraform resource.\n\nUnlike [aws.dms_replication_instance.new](#fn-new), this function will not inject the `resource`\nblock into the root Terraform document. Instead, this must be passed in as the `attrs` argument for the\n[tf.withResource](https://github.com/tf-libsonnet/core/tree/main/docs#fn-withresource) function to build a complete block.\n\nThis is most useful when you need to preprocess the attributes with functions, conditional, or looping logic prior to\ninjecting into a complete block.\n\n**Args**:\n - `allocated_storage` (`number`): Set the `allocated_storage` field on the resulting object. When `null`, the `allocated_storage` field will be omitted from the resulting object.\n - `allow_major_version_upgrade` (`bool`): Set the `allow_major_version_upgrade` field on the resulting object. When `null`, the `allow_major_version_upgrade` field will be omitted from the resulting object.\n - `apply_immediately` (`bool`): Set the `apply_immediately` field on the resulting object. When `null`, the `apply_immediately` field will be omitted from the resulting object.\n - `auto_minor_version_upgrade` (`bool`): Set the `auto_minor_version_upgrade` field on the resulting object. When `null`, the `auto_minor_version_upgrade` field will be omitted from the resulting object.\n - `availability_zone` (`string`): Set the `availability_zone` field on the resulting object. When `null`, the `availability_zone` field will be omitted from the resulting object.\n - `engine_version` (`string`): Set the `engine_version` field on the resulting object. When `null`, the `engine_version` field will be omitted from the resulting object.\n - `kms_key_arn` (`string`): Set the `kms_key_arn` field on the resulting object. When `null`, the `kms_key_arn` field will be omitted from the resulting object.\n - `multi_az` (`bool`): Set the `multi_az` field on the resulting object. When `null`, the `multi_az` field will be omitted from the resulting object.\n - `network_type` (`string`): Set the `network_type` field on the resulting object. When `null`, the `network_type` field will be omitted from the resulting object.\n - `preferred_maintenance_window` (`string`): Set the `preferred_maintenance_window` field on the resulting object. When `null`, the `preferred_maintenance_window` field will be omitted from the resulting object.\n - `publicly_accessible` (`bool`): Set the `publicly_accessible` field on the resulting object. When `null`, the `publicly_accessible` field will be omitted from the resulting object.\n - `replication_instance_class` (`string`): Set the `replication_instance_class` field on the resulting object.\n - `replication_instance_id` (`string`): Set the `replication_instance_id` field on the resulting object.\n - `replication_subnet_group_id` (`string`): Set the `replication_subnet_group_id` field on the resulting object. When `null`, the `replication_subnet_group_id` field will be omitted from the resulting object.\n - `tags` (`obj`): Set the `tags` field on the resulting object. When `null`, the `tags` field will be omitted from the resulting object.\n - `tags_all` (`obj`): Set the `tags_all` field on the resulting object. When `null`, the `tags_all` field will be omitted from the resulting object.\n - `vpc_security_group_ids` (`list`): Set the `vpc_security_group_ids` field on the resulting object. When `null`, the `vpc_security_group_ids` field will be omitted from the resulting object.\n - `timeouts` (`obj`): Set the `timeouts` field on the resulting object. When `null`, the `timeouts` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [aws.dms_replication_instance.timeouts.new](#fn-timeoutsnew) constructor.\n\n**Returns**:\n - An attribute object that can be used with [tf.withResource](https://github.com/tf-libsonnet/core/tree/main/docs#fn-withresource) to construct a new `dms_replication_instance` resource into the root Terraform configuration.\n', args=[]), newAttrs( replication_instance_class, replication_instance_id, @@ -59,6 +61,7 @@ local d = (import 'github.com/jsonnet-libs/docsonnet/doc-util/main.libsonnet'); engine_version=null, kms_key_arn=null, multi_az=null, + network_type=null, preferred_maintenance_window=null, publicly_accessible=null, replication_subnet_group_id=null, @@ -75,6 +78,7 @@ local d = (import 'github.com/jsonnet-libs/docsonnet/doc-util/main.libsonnet'); engine_version: engine_version, kms_key_arn: kms_key_arn, multi_az: multi_az, + network_type: network_type, preferred_maintenance_window: preferred_maintenance_window, publicly_accessible: publicly_accessible, replication_instance_class: replication_instance_class, @@ -177,6 +181,16 @@ local d = (import 'github.com/jsonnet-libs/docsonnet/doc-util/main.libsonnet'); }, }, }, + '#withNetworkType':: d.fn(help='`aws.string.withNetworkType` constructs a mixin object that can be merged into the `string`\nTerraform resource block to set or update the network_type field.\n\n\n\n**Args**:\n - `resourceLabel` (`string`): The name label of the block to update.\n - `value` (`string`): The value to set for the `network_type` field.\n', args=[]), + withNetworkType(resourceLabel, value): { + resource+: { + aws_dms_replication_instance+: { + [resourceLabel]+: { + network_type: value, + }, + }, + }, + }, '#withPreferredMaintenanceWindow':: d.fn(help='`aws.string.withPreferredMaintenanceWindow` constructs a mixin object that can be merged into the `string`\nTerraform resource block to set or update the preferred_maintenance_window field.\n\n\n\n**Args**:\n - `resourceLabel` (`string`): The name label of the block to update.\n - `value` (`string`): The value to set for the `preferred_maintenance_window` field.\n', args=[]), withPreferredMaintenanceWindow(resourceLabel, value): { resource+: { diff --git a/5.x/_gen/resources/dms_replication_subnet_group.libsonnet b/5.x/_gen/resources/dms_replication_subnet_group.libsonnet index a4953c02..82d6e77e 100644 --- a/5.x/_gen/resources/dms_replication_subnet_group.libsonnet +++ b/5.x/_gen/resources/dms_replication_subnet_group.libsonnet @@ -2,7 +2,7 @@ local tf = (import 'github.com/tf-libsonnet/core/main.libsonnet'); local d = (import 'github.com/jsonnet-libs/docsonnet/doc-util/main.libsonnet'); { '#':: d.pkg(name='dms_replication_subnet_group', url='', help='`dms_replication_subnet_group` represents the `aws_dms_replication_subnet_group` Terraform resource.\n\n\n\nThis package contains functions and utilities for setting up the resource using Jsonnet code.\n'), - '#new':: d.fn(help="\n`aws.dms_replication_subnet_group.new` injects a new `aws_dms_replication_subnet_group` Terraform `resource`\nblock into the root module document.\n\nAdditionally, this inserts a private function into the `_ref` attribute that generates references to attributes of the\nresource. For example, if you added a new instance to the root using:\n\n # arguments omitted for brevity\n aws.dms_replication_subnet_group.new('some_id')\n\nYou can get the reference to the `id` field of the created `aws.dms_replication_subnet_group` using the reference:\n\n $._ref.aws_dms_replication_subnet_group.some_id.get('id')\n\nThis is the same as directly entering `\"${ aws_dms_replication_subnet_group.some_id.id }\"` as the value.\n\nNOTE: if you are chaining multiple resources together in a merge operation, you may not be able to use `super`, `self`,\nor `$` to refer to the root object. Instead, make an explicit outer object using `local`.\n\n**Args**:\n - `resourceLabel` (`string`): The name label of the block.\n - `replication_subnet_group_description` (`string`): Set the `replication_subnet_group_description` field on the resulting resource block.\n - `replication_subnet_group_id` (`string`): Set the `replication_subnet_group_id` field on the resulting resource block.\n - `subnet_ids` (`list`): Set the `subnet_ids` field on the resulting resource block.\n - `tags` (`obj`): Set the `tags` field on the resulting resource block. When `null`, the `tags` field will be omitted from the resulting object.\n - `tags_all` (`obj`): Set the `tags_all` field on the resulting resource block. When `null`, the `tags_all` field will be omitted from the resulting object.\n - `timeouts` (`obj`): Set the `timeouts` field on the resulting resource block. When `null`, the `timeouts` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [aws.dms_replication_subnet_group.timeouts.new](#fn-timeoutsnew) constructor.\n\n**Returns**:\n- A mixin object that injects the new resource into the root Terraform configuration.\n", args=[]), + '#new':: d.fn(help="\n`aws.dms_replication_subnet_group.new` injects a new `aws_dms_replication_subnet_group` Terraform `resource`\nblock into the root module document.\n\nAdditionally, this inserts a private function into the `_ref` attribute that generates references to attributes of the\nresource. For example, if you added a new instance to the root using:\n\n # arguments omitted for brevity\n aws.dms_replication_subnet_group.new('some_id')\n\nYou can get the reference to the `id` field of the created `aws.dms_replication_subnet_group` using the reference:\n\n $._ref.aws_dms_replication_subnet_group.some_id.get('id')\n\nThis is the same as directly entering `\"${ aws_dms_replication_subnet_group.some_id.id }\"` as the value.\n\nNOTE: if you are chaining multiple resources together in a merge operation, you may not be able to use `super`, `self`,\nor `$` to refer to the root object. Instead, make an explicit outer object using `local`.\n\n**Args**:\n - `resourceLabel` (`string`): The name label of the block.\n - `replication_subnet_group_description` (`string`): Set the `replication_subnet_group_description` field on the resulting resource block.\n - `replication_subnet_group_id` (`string`): Set the `replication_subnet_group_id` field on the resulting resource block.\n - `subnet_ids` (`list`): Set the `subnet_ids` field on the resulting resource block.\n - `tags` (`obj`): Set the `tags` field on the resulting resource block. When `null`, the `tags` field will be omitted from the resulting object.\n - `tags_all` (`obj`): Set the `tags_all` field on the resulting resource block. When `null`, the `tags_all` field will be omitted from the resulting object.\n\n**Returns**:\n- A mixin object that injects the new resource into the root Terraform configuration.\n", args=[]), new( resourceLabel, replication_subnet_group_description, @@ -10,7 +10,6 @@ local d = (import 'github.com/jsonnet-libs/docsonnet/doc-util/main.libsonnet'); subnet_ids, tags=null, tags_all=null, - timeouts=null, _meta={} ):: tf.withResource( type='aws_dms_replication_subnet_group', @@ -20,39 +19,24 @@ local d = (import 'github.com/jsonnet-libs/docsonnet/doc-util/main.libsonnet'); replication_subnet_group_id=replication_subnet_group_id, subnet_ids=subnet_ids, tags=tags, - tags_all=tags_all, - timeouts=timeouts + tags_all=tags_all ), _meta=_meta ), - '#newAttrs':: d.fn(help='\n`aws.dms_replication_subnet_group.newAttrs` constructs a new object with attributes and blocks configured for the `dms_replication_subnet_group`\nTerraform resource.\n\nUnlike [aws.dms_replication_subnet_group.new](#fn-new), this function will not inject the `resource`\nblock into the root Terraform document. Instead, this must be passed in as the `attrs` argument for the\n[tf.withResource](https://github.com/tf-libsonnet/core/tree/main/docs#fn-withresource) function to build a complete block.\n\nThis is most useful when you need to preprocess the attributes with functions, conditional, or looping logic prior to\ninjecting into a complete block.\n\n**Args**:\n - `replication_subnet_group_description` (`string`): Set the `replication_subnet_group_description` field on the resulting object.\n - `replication_subnet_group_id` (`string`): Set the `replication_subnet_group_id` field on the resulting object.\n - `subnet_ids` (`list`): Set the `subnet_ids` field on the resulting object.\n - `tags` (`obj`): Set the `tags` field on the resulting object. When `null`, the `tags` field will be omitted from the resulting object.\n - `tags_all` (`obj`): Set the `tags_all` field on the resulting object. When `null`, the `tags_all` field will be omitted from the resulting object.\n - `timeouts` (`obj`): Set the `timeouts` field on the resulting object. When `null`, the `timeouts` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [aws.dms_replication_subnet_group.timeouts.new](#fn-timeoutsnew) constructor.\n\n**Returns**:\n - An attribute object that can be used with [tf.withResource](https://github.com/tf-libsonnet/core/tree/main/docs#fn-withresource) to construct a new `dms_replication_subnet_group` resource into the root Terraform configuration.\n', args=[]), + '#newAttrs':: d.fn(help='\n`aws.dms_replication_subnet_group.newAttrs` constructs a new object with attributes and blocks configured for the `dms_replication_subnet_group`\nTerraform resource.\n\nUnlike [aws.dms_replication_subnet_group.new](#fn-new), this function will not inject the `resource`\nblock into the root Terraform document. Instead, this must be passed in as the `attrs` argument for the\n[tf.withResource](https://github.com/tf-libsonnet/core/tree/main/docs#fn-withresource) function to build a complete block.\n\nThis is most useful when you need to preprocess the attributes with functions, conditional, or looping logic prior to\ninjecting into a complete block.\n\n**Args**:\n - `replication_subnet_group_description` (`string`): Set the `replication_subnet_group_description` field on the resulting object.\n - `replication_subnet_group_id` (`string`): Set the `replication_subnet_group_id` field on the resulting object.\n - `subnet_ids` (`list`): Set the `subnet_ids` field on the resulting object.\n - `tags` (`obj`): Set the `tags` field on the resulting object. When `null`, the `tags` field will be omitted from the resulting object.\n - `tags_all` (`obj`): Set the `tags_all` field on the resulting object. When `null`, the `tags_all` field will be omitted from the resulting object.\n\n**Returns**:\n - An attribute object that can be used with [tf.withResource](https://github.com/tf-libsonnet/core/tree/main/docs#fn-withresource) to construct a new `dms_replication_subnet_group` resource into the root Terraform configuration.\n', args=[]), newAttrs( replication_subnet_group_description, replication_subnet_group_id, subnet_ids, tags=null, - tags_all=null, - timeouts=null + tags_all=null ):: std.prune(a={ replication_subnet_group_description: replication_subnet_group_description, replication_subnet_group_id: replication_subnet_group_id, subnet_ids: subnet_ids, tags: tags, tags_all: tags_all, - timeouts: timeouts, }), - timeouts:: { - '#new':: d.fn(help='\n`aws.dms_replication_subnet_group.timeouts.new` constructs a new object with attributes and blocks configured for the `timeouts`\nTerraform sub block.\n\n\n\n**Args**:\n - `create` (`string`): Set the `create` field on the resulting object. When `null`, the `create` field will be omitted from the resulting object.\n - `delete` (`string`): Set the `delete` field on the resulting object. When `null`, the `delete` field will be omitted from the resulting object.\n - `update` (`string`): Set the `update` field on the resulting object. When `null`, the `update` field will be omitted from the resulting object.\n\n**Returns**:\n - An attribute object that represents the `timeouts` sub block.\n', args=[]), - new( - create=null, - delete=null, - update=null - ):: std.prune(a={ - create: create, - delete: delete, - update: update, - }), - }, '#withReplicationSubnetGroupDescription':: d.fn(help='`aws.string.withReplicationSubnetGroupDescription` constructs a mixin object that can be merged into the `string`\nTerraform resource block to set or update the replication_subnet_group_description field.\n\n\n\n**Args**:\n - `resourceLabel` (`string`): The name label of the block to update.\n - `value` (`string`): The value to set for the `replication_subnet_group_description` field.\n', args=[]), withReplicationSubnetGroupDescription(resourceLabel, value): { resource+: { @@ -103,24 +87,4 @@ local d = (import 'github.com/jsonnet-libs/docsonnet/doc-util/main.libsonnet'); }, }, }, - '#withTimeouts':: d.fn(help='`aws.obj.withTimeouts` constructs a mixin object that can be merged into the `obj`\nTerraform resource block to set or update the timeouts field.\n\nThis function will replace the map with the passed in `value`. If you wish to instead merge the\npassed in value to the existing map, use the [aws.obj.withTimeoutsMixin](TODO) function.\n\n**Args**:\n - `resourceLabel` (`string`): The name label of the block to update.\n - `value` (`obj`): The value to set for the `timeouts` field.\n', args=[]), - withTimeouts(resourceLabel, value): { - resource+: { - aws_dms_replication_subnet_group+: { - [resourceLabel]+: { - timeouts: value, - }, - }, - }, - }, - '#withTimeoutsMixin':: d.fn(help='`aws.obj.withTimeoutsMixin` constructs a mixin object that can be merged into the `obj`\nTerraform resource block to set or update the timeouts field.\n\nThis function will merge the passed in value to the existing map. If you wish\nto instead replace the entire map with the passed in `value`, use the [aws.obj.withTimeouts](TODO)\nfunction.\n\n\n**Args**:\n - `resourceLabel` (`string`): The name label of the block to update.\n - `value` (`obj`): The value to set for the `timeouts` field.\n', args=[]), - withTimeoutsMixin(resourceLabel, value): { - resource+: { - aws_dms_replication_subnet_group+: { - [resourceLabel]+: { - timeouts+: value, - }, - }, - }, - }, } diff --git a/5.x/_gen/resources/elasticache_cluster.libsonnet b/5.x/_gen/resources/elasticache_cluster.libsonnet index d09bd32a..d946550f 100644 --- a/5.x/_gen/resources/elasticache_cluster.libsonnet +++ b/5.x/_gen/resources/elasticache_cluster.libsonnet @@ -16,7 +16,7 @@ local d = (import 'github.com/jsonnet-libs/docsonnet/doc-util/main.libsonnet'); log_type: log_type, }), }, - '#new':: d.fn(help="\n`aws.elasticache_cluster.new` injects a new `aws_elasticache_cluster` Terraform `resource`\nblock into the root module document.\n\nAdditionally, this inserts a private function into the `_ref` attribute that generates references to attributes of the\nresource. For example, if you added a new instance to the root using:\n\n # arguments omitted for brevity\n aws.elasticache_cluster.new('some_id')\n\nYou can get the reference to the `id` field of the created `aws.elasticache_cluster` using the reference:\n\n $._ref.aws_elasticache_cluster.some_id.get('id')\n\nThis is the same as directly entering `\"${ aws_elasticache_cluster.some_id.id }\"` as the value.\n\nNOTE: if you are chaining multiple resources together in a merge operation, you may not be able to use `super`, `self`,\nor `$` to refer to the root object. Instead, make an explicit outer object using `local`.\n\n**Args**:\n - `resourceLabel` (`string`): The name label of the block.\n - `apply_immediately` (`bool`): Set the `apply_immediately` field on the resulting resource block. When `null`, the `apply_immediately` field will be omitted from the resulting object.\n - `auto_minor_version_upgrade` (`string`): Set the `auto_minor_version_upgrade` field on the resulting resource block. When `null`, the `auto_minor_version_upgrade` field will be omitted from the resulting object.\n - `availability_zone` (`string`): Set the `availability_zone` field on the resulting resource block. When `null`, the `availability_zone` field will be omitted from the resulting object.\n - `az_mode` (`string`): Set the `az_mode` field on the resulting resource block. When `null`, the `az_mode` field will be omitted from the resulting object.\n - `cluster_id` (`string`): Set the `cluster_id` field on the resulting resource block.\n - `engine` (`string`): Set the `engine` field on the resulting resource block. When `null`, the `engine` field will be omitted from the resulting object.\n - `engine_version` (`string`): Set the `engine_version` field on the resulting resource block. When `null`, the `engine_version` field will be omitted from the resulting object.\n - `final_snapshot_identifier` (`string`): Set the `final_snapshot_identifier` field on the resulting resource block. When `null`, the `final_snapshot_identifier` field will be omitted from the resulting object.\n - `ip_discovery` (`string`): Set the `ip_discovery` field on the resulting resource block. When `null`, the `ip_discovery` field will be omitted from the resulting object.\n - `maintenance_window` (`string`): Set the `maintenance_window` field on the resulting resource block. When `null`, the `maintenance_window` field will be omitted from the resulting object.\n - `network_type` (`string`): Set the `network_type` field on the resulting resource block. When `null`, the `network_type` field will be omitted from the resulting object.\n - `node_type` (`string`): Set the `node_type` field on the resulting resource block. When `null`, the `node_type` field will be omitted from the resulting object.\n - `notification_topic_arn` (`string`): Set the `notification_topic_arn` field on the resulting resource block. When `null`, the `notification_topic_arn` field will be omitted from the resulting object.\n - `num_cache_nodes` (`number`): Set the `num_cache_nodes` field on the resulting resource block. When `null`, the `num_cache_nodes` field will be omitted from the resulting object.\n - `outpost_mode` (`string`): Set the `outpost_mode` field on the resulting resource block. When `null`, the `outpost_mode` field will be omitted from the resulting object.\n - `parameter_group_name` (`string`): Set the `parameter_group_name` field on the resulting resource block. When `null`, the `parameter_group_name` field will be omitted from the resulting object.\n - `port` (`number`): Set the `port` field on the resulting resource block. When `null`, the `port` field will be omitted from the resulting object.\n - `preferred_availability_zones` (`list`): Set the `preferred_availability_zones` field on the resulting resource block. When `null`, the `preferred_availability_zones` field will be omitted from the resulting object.\n - `preferred_outpost_arn` (`string`): Set the `preferred_outpost_arn` field on the resulting resource block. When `null`, the `preferred_outpost_arn` field will be omitted from the resulting object.\n - `replication_group_id` (`string`): Set the `replication_group_id` field on the resulting resource block. When `null`, the `replication_group_id` field will be omitted from the resulting object.\n - `security_group_ids` (`list`): Set the `security_group_ids` field on the resulting resource block. When `null`, the `security_group_ids` field will be omitted from the resulting object.\n - `snapshot_arns` (`list`): Set the `snapshot_arns` field on the resulting resource block. When `null`, the `snapshot_arns` field will be omitted from the resulting object.\n - `snapshot_name` (`string`): Set the `snapshot_name` field on the resulting resource block. When `null`, the `snapshot_name` field will be omitted from the resulting object.\n - `snapshot_retention_limit` (`number`): Set the `snapshot_retention_limit` field on the resulting resource block. When `null`, the `snapshot_retention_limit` field will be omitted from the resulting object.\n - `snapshot_window` (`string`): Set the `snapshot_window` field on the resulting resource block. When `null`, the `snapshot_window` field will be omitted from the resulting object.\n - `subnet_group_name` (`string`): Set the `subnet_group_name` field on the resulting resource block. When `null`, the `subnet_group_name` field will be omitted from the resulting object.\n - `tags` (`obj`): Set the `tags` field on the resulting resource block. When `null`, the `tags` field will be omitted from the resulting object.\n - `tags_all` (`obj`): Set the `tags_all` field on the resulting resource block. When `null`, the `tags_all` field will be omitted from the resulting object.\n - `log_delivery_configuration` (`list[obj]`): Set the `log_delivery_configuration` field on the resulting resource block. When `null`, the `log_delivery_configuration` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [aws.elasticache_cluster.log_delivery_configuration.new](#fn-log_delivery_configurationnew) constructor.\n\n**Returns**:\n- A mixin object that injects the new resource into the root Terraform configuration.\n", args=[]), + '#new':: d.fn(help="\n`aws.elasticache_cluster.new` injects a new `aws_elasticache_cluster` Terraform `resource`\nblock into the root module document.\n\nAdditionally, this inserts a private function into the `_ref` attribute that generates references to attributes of the\nresource. For example, if you added a new instance to the root using:\n\n # arguments omitted for brevity\n aws.elasticache_cluster.new('some_id')\n\nYou can get the reference to the `id` field of the created `aws.elasticache_cluster` using the reference:\n\n $._ref.aws_elasticache_cluster.some_id.get('id')\n\nThis is the same as directly entering `\"${ aws_elasticache_cluster.some_id.id }\"` as the value.\n\nNOTE: if you are chaining multiple resources together in a merge operation, you may not be able to use `super`, `self`,\nor `$` to refer to the root object. Instead, make an explicit outer object using `local`.\n\n**Args**:\n - `resourceLabel` (`string`): The name label of the block.\n - `apply_immediately` (`bool`): Set the `apply_immediately` field on the resulting resource block. When `null`, the `apply_immediately` field will be omitted from the resulting object.\n - `auto_minor_version_upgrade` (`string`): Set the `auto_minor_version_upgrade` field on the resulting resource block. When `null`, the `auto_minor_version_upgrade` field will be omitted from the resulting object.\n - `availability_zone` (`string`): Set the `availability_zone` field on the resulting resource block. When `null`, the `availability_zone` field will be omitted from the resulting object.\n - `az_mode` (`string`): Set the `az_mode` field on the resulting resource block. When `null`, the `az_mode` field will be omitted from the resulting object.\n - `cluster_id` (`string`): Set the `cluster_id` field on the resulting resource block.\n - `engine` (`string`): Set the `engine` field on the resulting resource block. When `null`, the `engine` field will be omitted from the resulting object.\n - `engine_version` (`string`): Set the `engine_version` field on the resulting resource block. When `null`, the `engine_version` field will be omitted from the resulting object.\n - `final_snapshot_identifier` (`string`): Set the `final_snapshot_identifier` field on the resulting resource block. When `null`, the `final_snapshot_identifier` field will be omitted from the resulting object.\n - `ip_discovery` (`string`): Set the `ip_discovery` field on the resulting resource block. When `null`, the `ip_discovery` field will be omitted from the resulting object.\n - `maintenance_window` (`string`): Set the `maintenance_window` field on the resulting resource block. When `null`, the `maintenance_window` field will be omitted from the resulting object.\n - `network_type` (`string`): Set the `network_type` field on the resulting resource block. When `null`, the `network_type` field will be omitted from the resulting object.\n - `node_type` (`string`): Set the `node_type` field on the resulting resource block. When `null`, the `node_type` field will be omitted from the resulting object.\n - `notification_topic_arn` (`string`): Set the `notification_topic_arn` field on the resulting resource block. When `null`, the `notification_topic_arn` field will be omitted from the resulting object.\n - `num_cache_nodes` (`number`): Set the `num_cache_nodes` field on the resulting resource block. When `null`, the `num_cache_nodes` field will be omitted from the resulting object.\n - `outpost_mode` (`string`): Set the `outpost_mode` field on the resulting resource block. When `null`, the `outpost_mode` field will be omitted from the resulting object.\n - `parameter_group_name` (`string`): Set the `parameter_group_name` field on the resulting resource block. When `null`, the `parameter_group_name` field will be omitted from the resulting object.\n - `port` (`number`): Set the `port` field on the resulting resource block. When `null`, the `port` field will be omitted from the resulting object.\n - `preferred_availability_zones` (`list`): Set the `preferred_availability_zones` field on the resulting resource block. When `null`, the `preferred_availability_zones` field will be omitted from the resulting object.\n - `preferred_outpost_arn` (`string`): Set the `preferred_outpost_arn` field on the resulting resource block. When `null`, the `preferred_outpost_arn` field will be omitted from the resulting object.\n - `replication_group_id` (`string`): Set the `replication_group_id` field on the resulting resource block. When `null`, the `replication_group_id` field will be omitted from the resulting object.\n - `security_group_ids` (`list`): Set the `security_group_ids` field on the resulting resource block. When `null`, the `security_group_ids` field will be omitted from the resulting object.\n - `snapshot_arns` (`list`): Set the `snapshot_arns` field on the resulting resource block. When `null`, the `snapshot_arns` field will be omitted from the resulting object.\n - `snapshot_name` (`string`): Set the `snapshot_name` field on the resulting resource block. When `null`, the `snapshot_name` field will be omitted from the resulting object.\n - `snapshot_retention_limit` (`number`): Set the `snapshot_retention_limit` field on the resulting resource block. When `null`, the `snapshot_retention_limit` field will be omitted from the resulting object.\n - `snapshot_window` (`string`): Set the `snapshot_window` field on the resulting resource block. When `null`, the `snapshot_window` field will be omitted from the resulting object.\n - `subnet_group_name` (`string`): Set the `subnet_group_name` field on the resulting resource block. When `null`, the `subnet_group_name` field will be omitted from the resulting object.\n - `tags` (`obj`): Set the `tags` field on the resulting resource block. When `null`, the `tags` field will be omitted from the resulting object.\n - `tags_all` (`obj`): Set the `tags_all` field on the resulting resource block. When `null`, the `tags_all` field will be omitted from the resulting object.\n - `transit_encryption_enabled` (`bool`): Set the `transit_encryption_enabled` field on the resulting resource block. When `null`, the `transit_encryption_enabled` field will be omitted from the resulting object.\n - `log_delivery_configuration` (`list[obj]`): Set the `log_delivery_configuration` field on the resulting resource block. When `null`, the `log_delivery_configuration` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [aws.elasticache_cluster.log_delivery_configuration.new](#fn-log_delivery_configurationnew) constructor.\n\n**Returns**:\n- A mixin object that injects the new resource into the root Terraform configuration.\n", args=[]), new( resourceLabel, cluster_id, @@ -48,6 +48,7 @@ local d = (import 'github.com/jsonnet-libs/docsonnet/doc-util/main.libsonnet'); subnet_group_name=null, tags=null, tags_all=null, + transit_encryption_enabled=null, _meta={} ):: tf.withResource( type='aws_elasticache_cluster', @@ -81,11 +82,12 @@ local d = (import 'github.com/jsonnet-libs/docsonnet/doc-util/main.libsonnet'); snapshot_window=snapshot_window, subnet_group_name=subnet_group_name, tags=tags, - tags_all=tags_all + tags_all=tags_all, + transit_encryption_enabled=transit_encryption_enabled ), _meta=_meta ), - '#newAttrs':: d.fn(help='\n`aws.elasticache_cluster.newAttrs` constructs a new object with attributes and blocks configured for the `elasticache_cluster`\nTerraform resource.\n\nUnlike [aws.elasticache_cluster.new](#fn-new), this function will not inject the `resource`\nblock into the root Terraform document. Instead, this must be passed in as the `attrs` argument for the\n[tf.withResource](https://github.com/tf-libsonnet/core/tree/main/docs#fn-withresource) function to build a complete block.\n\nThis is most useful when you need to preprocess the attributes with functions, conditional, or looping logic prior to\ninjecting into a complete block.\n\n**Args**:\n - `apply_immediately` (`bool`): Set the `apply_immediately` field on the resulting object. When `null`, the `apply_immediately` field will be omitted from the resulting object.\n - `auto_minor_version_upgrade` (`string`): Set the `auto_minor_version_upgrade` field on the resulting object. When `null`, the `auto_minor_version_upgrade` field will be omitted from the resulting object.\n - `availability_zone` (`string`): Set the `availability_zone` field on the resulting object. When `null`, the `availability_zone` field will be omitted from the resulting object.\n - `az_mode` (`string`): Set the `az_mode` field on the resulting object. When `null`, the `az_mode` field will be omitted from the resulting object.\n - `cluster_id` (`string`): Set the `cluster_id` field on the resulting object.\n - `engine` (`string`): Set the `engine` field on the resulting object. When `null`, the `engine` field will be omitted from the resulting object.\n - `engine_version` (`string`): Set the `engine_version` field on the resulting object. When `null`, the `engine_version` field will be omitted from the resulting object.\n - `final_snapshot_identifier` (`string`): Set the `final_snapshot_identifier` field on the resulting object. When `null`, the `final_snapshot_identifier` field will be omitted from the resulting object.\n - `ip_discovery` (`string`): Set the `ip_discovery` field on the resulting object. When `null`, the `ip_discovery` field will be omitted from the resulting object.\n - `maintenance_window` (`string`): Set the `maintenance_window` field on the resulting object. When `null`, the `maintenance_window` field will be omitted from the resulting object.\n - `network_type` (`string`): Set the `network_type` field on the resulting object. When `null`, the `network_type` field will be omitted from the resulting object.\n - `node_type` (`string`): Set the `node_type` field on the resulting object. When `null`, the `node_type` field will be omitted from the resulting object.\n - `notification_topic_arn` (`string`): Set the `notification_topic_arn` field on the resulting object. When `null`, the `notification_topic_arn` field will be omitted from the resulting object.\n - `num_cache_nodes` (`number`): Set the `num_cache_nodes` field on the resulting object. When `null`, the `num_cache_nodes` field will be omitted from the resulting object.\n - `outpost_mode` (`string`): Set the `outpost_mode` field on the resulting object. When `null`, the `outpost_mode` field will be omitted from the resulting object.\n - `parameter_group_name` (`string`): Set the `parameter_group_name` field on the resulting object. When `null`, the `parameter_group_name` field will be omitted from the resulting object.\n - `port` (`number`): Set the `port` field on the resulting object. When `null`, the `port` field will be omitted from the resulting object.\n - `preferred_availability_zones` (`list`): Set the `preferred_availability_zones` field on the resulting object. When `null`, the `preferred_availability_zones` field will be omitted from the resulting object.\n - `preferred_outpost_arn` (`string`): Set the `preferred_outpost_arn` field on the resulting object. When `null`, the `preferred_outpost_arn` field will be omitted from the resulting object.\n - `replication_group_id` (`string`): Set the `replication_group_id` field on the resulting object. When `null`, the `replication_group_id` field will be omitted from the resulting object.\n - `security_group_ids` (`list`): Set the `security_group_ids` field on the resulting object. When `null`, the `security_group_ids` field will be omitted from the resulting object.\n - `snapshot_arns` (`list`): Set the `snapshot_arns` field on the resulting object. When `null`, the `snapshot_arns` field will be omitted from the resulting object.\n - `snapshot_name` (`string`): Set the `snapshot_name` field on the resulting object. When `null`, the `snapshot_name` field will be omitted from the resulting object.\n - `snapshot_retention_limit` (`number`): Set the `snapshot_retention_limit` field on the resulting object. When `null`, the `snapshot_retention_limit` field will be omitted from the resulting object.\n - `snapshot_window` (`string`): Set the `snapshot_window` field on the resulting object. When `null`, the `snapshot_window` field will be omitted from the resulting object.\n - `subnet_group_name` (`string`): Set the `subnet_group_name` field on the resulting object. When `null`, the `subnet_group_name` field will be omitted from the resulting object.\n - `tags` (`obj`): Set the `tags` field on the resulting object. When `null`, the `tags` field will be omitted from the resulting object.\n - `tags_all` (`obj`): Set the `tags_all` field on the resulting object. When `null`, the `tags_all` field will be omitted from the resulting object.\n - `log_delivery_configuration` (`list[obj]`): Set the `log_delivery_configuration` field on the resulting object. When `null`, the `log_delivery_configuration` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [aws.elasticache_cluster.log_delivery_configuration.new](#fn-log_delivery_configurationnew) constructor.\n\n**Returns**:\n - An attribute object that can be used with [tf.withResource](https://github.com/tf-libsonnet/core/tree/main/docs#fn-withresource) to construct a new `elasticache_cluster` resource into the root Terraform configuration.\n', args=[]), + '#newAttrs':: d.fn(help='\n`aws.elasticache_cluster.newAttrs` constructs a new object with attributes and blocks configured for the `elasticache_cluster`\nTerraform resource.\n\nUnlike [aws.elasticache_cluster.new](#fn-new), this function will not inject the `resource`\nblock into the root Terraform document. Instead, this must be passed in as the `attrs` argument for the\n[tf.withResource](https://github.com/tf-libsonnet/core/tree/main/docs#fn-withresource) function to build a complete block.\n\nThis is most useful when you need to preprocess the attributes with functions, conditional, or looping logic prior to\ninjecting into a complete block.\n\n**Args**:\n - `apply_immediately` (`bool`): Set the `apply_immediately` field on the resulting object. When `null`, the `apply_immediately` field will be omitted from the resulting object.\n - `auto_minor_version_upgrade` (`string`): Set the `auto_minor_version_upgrade` field on the resulting object. When `null`, the `auto_minor_version_upgrade` field will be omitted from the resulting object.\n - `availability_zone` (`string`): Set the `availability_zone` field on the resulting object. When `null`, the `availability_zone` field will be omitted from the resulting object.\n - `az_mode` (`string`): Set the `az_mode` field on the resulting object. When `null`, the `az_mode` field will be omitted from the resulting object.\n - `cluster_id` (`string`): Set the `cluster_id` field on the resulting object.\n - `engine` (`string`): Set the `engine` field on the resulting object. When `null`, the `engine` field will be omitted from the resulting object.\n - `engine_version` (`string`): Set the `engine_version` field on the resulting object. When `null`, the `engine_version` field will be omitted from the resulting object.\n - `final_snapshot_identifier` (`string`): Set the `final_snapshot_identifier` field on the resulting object. When `null`, the `final_snapshot_identifier` field will be omitted from the resulting object.\n - `ip_discovery` (`string`): Set the `ip_discovery` field on the resulting object. When `null`, the `ip_discovery` field will be omitted from the resulting object.\n - `maintenance_window` (`string`): Set the `maintenance_window` field on the resulting object. When `null`, the `maintenance_window` field will be omitted from the resulting object.\n - `network_type` (`string`): Set the `network_type` field on the resulting object. When `null`, the `network_type` field will be omitted from the resulting object.\n - `node_type` (`string`): Set the `node_type` field on the resulting object. When `null`, the `node_type` field will be omitted from the resulting object.\n - `notification_topic_arn` (`string`): Set the `notification_topic_arn` field on the resulting object. When `null`, the `notification_topic_arn` field will be omitted from the resulting object.\n - `num_cache_nodes` (`number`): Set the `num_cache_nodes` field on the resulting object. When `null`, the `num_cache_nodes` field will be omitted from the resulting object.\n - `outpost_mode` (`string`): Set the `outpost_mode` field on the resulting object. When `null`, the `outpost_mode` field will be omitted from the resulting object.\n - `parameter_group_name` (`string`): Set the `parameter_group_name` field on the resulting object. When `null`, the `parameter_group_name` field will be omitted from the resulting object.\n - `port` (`number`): Set the `port` field on the resulting object. When `null`, the `port` field will be omitted from the resulting object.\n - `preferred_availability_zones` (`list`): Set the `preferred_availability_zones` field on the resulting object. When `null`, the `preferred_availability_zones` field will be omitted from the resulting object.\n - `preferred_outpost_arn` (`string`): Set the `preferred_outpost_arn` field on the resulting object. When `null`, the `preferred_outpost_arn` field will be omitted from the resulting object.\n - `replication_group_id` (`string`): Set the `replication_group_id` field on the resulting object. When `null`, the `replication_group_id` field will be omitted from the resulting object.\n - `security_group_ids` (`list`): Set the `security_group_ids` field on the resulting object. When `null`, the `security_group_ids` field will be omitted from the resulting object.\n - `snapshot_arns` (`list`): Set the `snapshot_arns` field on the resulting object. When `null`, the `snapshot_arns` field will be omitted from the resulting object.\n - `snapshot_name` (`string`): Set the `snapshot_name` field on the resulting object. When `null`, the `snapshot_name` field will be omitted from the resulting object.\n - `snapshot_retention_limit` (`number`): Set the `snapshot_retention_limit` field on the resulting object. When `null`, the `snapshot_retention_limit` field will be omitted from the resulting object.\n - `snapshot_window` (`string`): Set the `snapshot_window` field on the resulting object. When `null`, the `snapshot_window` field will be omitted from the resulting object.\n - `subnet_group_name` (`string`): Set the `subnet_group_name` field on the resulting object. When `null`, the `subnet_group_name` field will be omitted from the resulting object.\n - `tags` (`obj`): Set the `tags` field on the resulting object. When `null`, the `tags` field will be omitted from the resulting object.\n - `tags_all` (`obj`): Set the `tags_all` field on the resulting object. When `null`, the `tags_all` field will be omitted from the resulting object.\n - `transit_encryption_enabled` (`bool`): Set the `transit_encryption_enabled` field on the resulting object. When `null`, the `transit_encryption_enabled` field will be omitted from the resulting object.\n - `log_delivery_configuration` (`list[obj]`): Set the `log_delivery_configuration` field on the resulting object. When `null`, the `log_delivery_configuration` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [aws.elasticache_cluster.log_delivery_configuration.new](#fn-log_delivery_configurationnew) constructor.\n\n**Returns**:\n - An attribute object that can be used with [tf.withResource](https://github.com/tf-libsonnet/core/tree/main/docs#fn-withresource) to construct a new `elasticache_cluster` resource into the root Terraform configuration.\n', args=[]), newAttrs( cluster_id, apply_immediately=null, @@ -115,7 +117,8 @@ local d = (import 'github.com/jsonnet-libs/docsonnet/doc-util/main.libsonnet'); snapshot_window=null, subnet_group_name=null, tags=null, - tags_all=null + tags_all=null, + transit_encryption_enabled=null ):: std.prune(a={ apply_immediately: apply_immediately, auto_minor_version_upgrade: auto_minor_version_upgrade, @@ -146,6 +149,7 @@ local d = (import 'github.com/jsonnet-libs/docsonnet/doc-util/main.libsonnet'); subnet_group_name: subnet_group_name, tags: tags, tags_all: tags_all, + transit_encryption_enabled: transit_encryption_enabled, }), '#withApplyImmediately':: d.fn(help='`aws.bool.withApplyImmediately` constructs a mixin object that can be merged into the `bool`\nTerraform resource block to set or update the apply_immediately field.\n\n\n\n**Args**:\n - `resourceLabel` (`string`): The name label of the block to update.\n - `value` (`bool`): The value to set for the `apply_immediately` field.\n', args=[]), withApplyImmediately(resourceLabel, value): { @@ -447,4 +451,14 @@ local d = (import 'github.com/jsonnet-libs/docsonnet/doc-util/main.libsonnet'); }, }, }, + '#withTransitEncryptionEnabled':: d.fn(help='`aws.bool.withTransitEncryptionEnabled` constructs a mixin object that can be merged into the `bool`\nTerraform resource block to set or update the transit_encryption_enabled field.\n\n\n\n**Args**:\n - `resourceLabel` (`string`): The name label of the block to update.\n - `value` (`bool`): The value to set for the `transit_encryption_enabled` field.\n', args=[]), + withTransitEncryptionEnabled(resourceLabel, value): { + resource+: { + aws_elasticache_cluster+: { + [resourceLabel]+: { + transit_encryption_enabled: value, + }, + }, + }, + }, } diff --git a/5.x/_gen/resources/finspace_kx_environment.libsonnet b/5.x/_gen/resources/finspace_kx_environment.libsonnet index 79d82b3d..c18969f0 100644 --- a/5.x/_gen/resources/finspace_kx_environment.libsonnet +++ b/5.x/_gen/resources/finspace_kx_environment.libsonnet @@ -72,11 +72,51 @@ local d = (import 'github.com/jsonnet-libs/docsonnet/doc-util/main.libsonnet'); }), }, transit_gateway_configuration:: { - '#new':: d.fn(help='\n`aws.finspace_kx_environment.transit_gateway_configuration.new` constructs a new object with attributes and blocks configured for the `transit_gateway_configuration`\nTerraform sub block.\n\n\n\n**Args**:\n - `routable_cidr_space` (`string`): Set the `routable_cidr_space` field on the resulting object.\n - `transit_gateway_id` (`string`): Set the `transit_gateway_id` field on the resulting object.\n\n**Returns**:\n - An attribute object that represents the `transit_gateway_configuration` sub block.\n', args=[]), + attachment_network_acl_configuration:: { + icmp_type_code:: { + '#new':: d.fn(help='\n`aws.finspace_kx_environment.transit_gateway_configuration.attachment_network_acl_configuration.icmp_type_code.new` constructs a new object with attributes and blocks configured for the `icmp_type_code`\nTerraform sub block.\n\n\n\n**Args**:\n - `code` (`number`): Set the `code` field on the resulting object.\n - `type` (`number`): Set the `type` field on the resulting object.\n\n**Returns**:\n - An attribute object that represents the `icmp_type_code` sub block.\n', args=[]), + new( + code, + type + ):: std.prune(a={ + code: code, + type: type, + }), + }, + '#new':: d.fn(help='\n`aws.finspace_kx_environment.transit_gateway_configuration.attachment_network_acl_configuration.new` constructs a new object with attributes and blocks configured for the `attachment_network_acl_configuration`\nTerraform sub block.\n\n\n\n**Args**:\n - `cidr_block` (`string`): Set the `cidr_block` field on the resulting object.\n - `protocol` (`string`): Set the `protocol` field on the resulting object.\n - `rule_action` (`string`): Set the `rule_action` field on the resulting object.\n - `rule_number` (`number`): Set the `rule_number` field on the resulting object.\n - `icmp_type_code` (`list[obj]`): Set the `icmp_type_code` field on the resulting object. When `null`, the `icmp_type_code` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [aws.finspace_kx_environment.transit_gateway_configuration.attachment_network_acl_configuration.icmp_type_code.new](#fn-transit_gateway_configurationtransit_gateway_configurationicmp_type_codenew) constructor.\n - `port_range` (`list[obj]`): Set the `port_range` field on the resulting object. When `null`, the `port_range` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [aws.finspace_kx_environment.transit_gateway_configuration.attachment_network_acl_configuration.port_range.new](#fn-transit_gateway_configurationtransit_gateway_configurationport_rangenew) constructor.\n\n**Returns**:\n - An attribute object that represents the `attachment_network_acl_configuration` sub block.\n', args=[]), + new( + cidr_block, + protocol, + rule_action, + rule_number, + icmp_type_code=null, + port_range=null + ):: std.prune(a={ + cidr_block: cidr_block, + icmp_type_code: icmp_type_code, + port_range: port_range, + protocol: protocol, + rule_action: rule_action, + rule_number: rule_number, + }), + port_range:: { + '#new':: d.fn(help='\n`aws.finspace_kx_environment.transit_gateway_configuration.attachment_network_acl_configuration.port_range.new` constructs a new object with attributes and blocks configured for the `port_range`\nTerraform sub block.\n\n\n\n**Args**:\n - `from` (`number`): Set the `from` field on the resulting object.\n - `to` (`number`): Set the `to` field on the resulting object.\n\n**Returns**:\n - An attribute object that represents the `port_range` sub block.\n', args=[]), + new( + from, + to + ):: std.prune(a={ + from: from, + to: to, + }), + }, + }, + '#new':: d.fn(help='\n`aws.finspace_kx_environment.transit_gateway_configuration.new` constructs a new object with attributes and blocks configured for the `transit_gateway_configuration`\nTerraform sub block.\n\n\n\n**Args**:\n - `routable_cidr_space` (`string`): Set the `routable_cidr_space` field on the resulting object.\n - `transit_gateway_id` (`string`): Set the `transit_gateway_id` field on the resulting object.\n - `attachment_network_acl_configuration` (`list[obj]`): Set the `attachment_network_acl_configuration` field on the resulting object. When `null`, the `attachment_network_acl_configuration` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [aws.finspace_kx_environment.transit_gateway_configuration.attachment_network_acl_configuration.new](#fn-transit_gateway_configurationattachment_network_acl_configurationnew) constructor.\n\n**Returns**:\n - An attribute object that represents the `transit_gateway_configuration` sub block.\n', args=[]), new( routable_cidr_space, - transit_gateway_id + transit_gateway_id, + attachment_network_acl_configuration=null ):: std.prune(a={ + attachment_network_acl_configuration: attachment_network_acl_configuration, routable_cidr_space: routable_cidr_space, transit_gateway_id: transit_gateway_id, }), diff --git a/5.x/_gen/resources/fsx_openzfs_file_system.libsonnet b/5.x/_gen/resources/fsx_openzfs_file_system.libsonnet index c77fd0dc..9b3a158e 100644 --- a/5.x/_gen/resources/fsx_openzfs_file_system.libsonnet +++ b/5.x/_gen/resources/fsx_openzfs_file_system.libsonnet @@ -12,7 +12,7 @@ local d = (import 'github.com/jsonnet-libs/docsonnet/doc-util/main.libsonnet'); mode: mode, }), }, - '#new':: d.fn(help="\n`aws.fsx_openzfs_file_system.new` injects a new `aws_fsx_openzfs_file_system` Terraform `resource`\nblock into the root module document.\n\nAdditionally, this inserts a private function into the `_ref` attribute that generates references to attributes of the\nresource. For example, if you added a new instance to the root using:\n\n # arguments omitted for brevity\n aws.fsx_openzfs_file_system.new('some_id')\n\nYou can get the reference to the `id` field of the created `aws.fsx_openzfs_file_system` using the reference:\n\n $._ref.aws_fsx_openzfs_file_system.some_id.get('id')\n\nThis is the same as directly entering `\"${ aws_fsx_openzfs_file_system.some_id.id }\"` as the value.\n\nNOTE: if you are chaining multiple resources together in a merge operation, you may not be able to use `super`, `self`,\nor `$` to refer to the root object. Instead, make an explicit outer object using `local`.\n\n**Args**:\n - `resourceLabel` (`string`): The name label of the block.\n - `automatic_backup_retention_days` (`number`): Set the `automatic_backup_retention_days` field on the resulting resource block. When `null`, the `automatic_backup_retention_days` field will be omitted from the resulting object.\n - `backup_id` (`string`): Set the `backup_id` field on the resulting resource block. When `null`, the `backup_id` field will be omitted from the resulting object.\n - `copy_tags_to_backups` (`bool`): Set the `copy_tags_to_backups` field on the resulting resource block. When `null`, the `copy_tags_to_backups` field will be omitted from the resulting object.\n - `copy_tags_to_volumes` (`bool`): Set the `copy_tags_to_volumes` field on the resulting resource block. When `null`, the `copy_tags_to_volumes` field will be omitted from the resulting object.\n - `daily_automatic_backup_start_time` (`string`): Set the `daily_automatic_backup_start_time` field on the resulting resource block. When `null`, the `daily_automatic_backup_start_time` field will be omitted from the resulting object.\n - `deployment_type` (`string`): Set the `deployment_type` field on the resulting resource block.\n - `kms_key_id` (`string`): Set the `kms_key_id` field on the resulting resource block. When `null`, the `kms_key_id` field will be omitted from the resulting object.\n - `security_group_ids` (`list`): Set the `security_group_ids` field on the resulting resource block. When `null`, the `security_group_ids` field will be omitted from the resulting object.\n - `storage_capacity` (`number`): Set the `storage_capacity` field on the resulting resource block. When `null`, the `storage_capacity` field will be omitted from the resulting object.\n - `storage_type` (`string`): Set the `storage_type` field on the resulting resource block. When `null`, the `storage_type` field will be omitted from the resulting object.\n - `subnet_ids` (`list`): Set the `subnet_ids` field on the resulting resource block.\n - `tags` (`obj`): Set the `tags` field on the resulting resource block. When `null`, the `tags` field will be omitted from the resulting object.\n - `tags_all` (`obj`): Set the `tags_all` field on the resulting resource block. When `null`, the `tags_all` field will be omitted from the resulting object.\n - `throughput_capacity` (`number`): Set the `throughput_capacity` field on the resulting resource block.\n - `weekly_maintenance_start_time` (`string`): Set the `weekly_maintenance_start_time` field on the resulting resource block. When `null`, the `weekly_maintenance_start_time` field will be omitted from the resulting object.\n - `disk_iops_configuration` (`list[obj]`): Set the `disk_iops_configuration` field on the resulting resource block. When `null`, the `disk_iops_configuration` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [aws.fsx_openzfs_file_system.disk_iops_configuration.new](#fn-disk_iops_configurationnew) constructor.\n - `root_volume_configuration` (`list[obj]`): Set the `root_volume_configuration` field on the resulting resource block. When `null`, the `root_volume_configuration` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [aws.fsx_openzfs_file_system.root_volume_configuration.new](#fn-root_volume_configurationnew) constructor.\n - `timeouts` (`obj`): Set the `timeouts` field on the resulting resource block. When `null`, the `timeouts` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [aws.fsx_openzfs_file_system.timeouts.new](#fn-timeoutsnew) constructor.\n\n**Returns**:\n- A mixin object that injects the new resource into the root Terraform configuration.\n", args=[]), + '#new':: d.fn(help="\n`aws.fsx_openzfs_file_system.new` injects a new `aws_fsx_openzfs_file_system` Terraform `resource`\nblock into the root module document.\n\nAdditionally, this inserts a private function into the `_ref` attribute that generates references to attributes of the\nresource. For example, if you added a new instance to the root using:\n\n # arguments omitted for brevity\n aws.fsx_openzfs_file_system.new('some_id')\n\nYou can get the reference to the `id` field of the created `aws.fsx_openzfs_file_system` using the reference:\n\n $._ref.aws_fsx_openzfs_file_system.some_id.get('id')\n\nThis is the same as directly entering `\"${ aws_fsx_openzfs_file_system.some_id.id }\"` as the value.\n\nNOTE: if you are chaining multiple resources together in a merge operation, you may not be able to use `super`, `self`,\nor `$` to refer to the root object. Instead, make an explicit outer object using `local`.\n\n**Args**:\n - `resourceLabel` (`string`): The name label of the block.\n - `automatic_backup_retention_days` (`number`): Set the `automatic_backup_retention_days` field on the resulting resource block. When `null`, the `automatic_backup_retention_days` field will be omitted from the resulting object.\n - `backup_id` (`string`): Set the `backup_id` field on the resulting resource block. When `null`, the `backup_id` field will be omitted from the resulting object.\n - `copy_tags_to_backups` (`bool`): Set the `copy_tags_to_backups` field on the resulting resource block. When `null`, the `copy_tags_to_backups` field will be omitted from the resulting object.\n - `copy_tags_to_volumes` (`bool`): Set the `copy_tags_to_volumes` field on the resulting resource block. When `null`, the `copy_tags_to_volumes` field will be omitted from the resulting object.\n - `daily_automatic_backup_start_time` (`string`): Set the `daily_automatic_backup_start_time` field on the resulting resource block. When `null`, the `daily_automatic_backup_start_time` field will be omitted from the resulting object.\n - `deployment_type` (`string`): Set the `deployment_type` field on the resulting resource block.\n - `endpoint_ip_address_range` (`string`): Set the `endpoint_ip_address_range` field on the resulting resource block. When `null`, the `endpoint_ip_address_range` field will be omitted from the resulting object.\n - `kms_key_id` (`string`): Set the `kms_key_id` field on the resulting resource block. When `null`, the `kms_key_id` field will be omitted from the resulting object.\n - `preferred_subnet_id` (`string`): Set the `preferred_subnet_id` field on the resulting resource block. When `null`, the `preferred_subnet_id` field will be omitted from the resulting object.\n - `route_table_ids` (`list`): Set the `route_table_ids` field on the resulting resource block. When `null`, the `route_table_ids` field will be omitted from the resulting object.\n - `security_group_ids` (`list`): Set the `security_group_ids` field on the resulting resource block. When `null`, the `security_group_ids` field will be omitted from the resulting object.\n - `storage_capacity` (`number`): Set the `storage_capacity` field on the resulting resource block. When `null`, the `storage_capacity` field will be omitted from the resulting object.\n - `storage_type` (`string`): Set the `storage_type` field on the resulting resource block. When `null`, the `storage_type` field will be omitted from the resulting object.\n - `subnet_ids` (`list`): Set the `subnet_ids` field on the resulting resource block.\n - `tags` (`obj`): Set the `tags` field on the resulting resource block. When `null`, the `tags` field will be omitted from the resulting object.\n - `tags_all` (`obj`): Set the `tags_all` field on the resulting resource block. When `null`, the `tags_all` field will be omitted from the resulting object.\n - `throughput_capacity` (`number`): Set the `throughput_capacity` field on the resulting resource block.\n - `weekly_maintenance_start_time` (`string`): Set the `weekly_maintenance_start_time` field on the resulting resource block. When `null`, the `weekly_maintenance_start_time` field will be omitted from the resulting object.\n - `disk_iops_configuration` (`list[obj]`): Set the `disk_iops_configuration` field on the resulting resource block. When `null`, the `disk_iops_configuration` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [aws.fsx_openzfs_file_system.disk_iops_configuration.new](#fn-disk_iops_configurationnew) constructor.\n - `root_volume_configuration` (`list[obj]`): Set the `root_volume_configuration` field on the resulting resource block. When `null`, the `root_volume_configuration` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [aws.fsx_openzfs_file_system.root_volume_configuration.new](#fn-root_volume_configurationnew) constructor.\n - `timeouts` (`obj`): Set the `timeouts` field on the resulting resource block. When `null`, the `timeouts` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [aws.fsx_openzfs_file_system.timeouts.new](#fn-timeoutsnew) constructor.\n\n**Returns**:\n- A mixin object that injects the new resource into the root Terraform configuration.\n", args=[]), new( resourceLabel, deployment_type, @@ -24,8 +24,11 @@ local d = (import 'github.com/jsonnet-libs/docsonnet/doc-util/main.libsonnet'); copy_tags_to_volumes=null, daily_automatic_backup_start_time=null, disk_iops_configuration=null, + endpoint_ip_address_range=null, kms_key_id=null, + preferred_subnet_id=null, root_volume_configuration=null, + route_table_ids=null, security_group_ids=null, storage_capacity=null, storage_type=null, @@ -45,8 +48,11 @@ local d = (import 'github.com/jsonnet-libs/docsonnet/doc-util/main.libsonnet'); daily_automatic_backup_start_time=daily_automatic_backup_start_time, deployment_type=deployment_type, disk_iops_configuration=disk_iops_configuration, + endpoint_ip_address_range=endpoint_ip_address_range, kms_key_id=kms_key_id, + preferred_subnet_id=preferred_subnet_id, root_volume_configuration=root_volume_configuration, + route_table_ids=route_table_ids, security_group_ids=security_group_ids, storage_capacity=storage_capacity, storage_type=storage_type, @@ -59,7 +65,7 @@ local d = (import 'github.com/jsonnet-libs/docsonnet/doc-util/main.libsonnet'); ), _meta=_meta ), - '#newAttrs':: d.fn(help='\n`aws.fsx_openzfs_file_system.newAttrs` constructs a new object with attributes and blocks configured for the `fsx_openzfs_file_system`\nTerraform resource.\n\nUnlike [aws.fsx_openzfs_file_system.new](#fn-new), this function will not inject the `resource`\nblock into the root Terraform document. Instead, this must be passed in as the `attrs` argument for the\n[tf.withResource](https://github.com/tf-libsonnet/core/tree/main/docs#fn-withresource) function to build a complete block.\n\nThis is most useful when you need to preprocess the attributes with functions, conditional, or looping logic prior to\ninjecting into a complete block.\n\n**Args**:\n - `automatic_backup_retention_days` (`number`): Set the `automatic_backup_retention_days` field on the resulting object. When `null`, the `automatic_backup_retention_days` field will be omitted from the resulting object.\n - `backup_id` (`string`): Set the `backup_id` field on the resulting object. When `null`, the `backup_id` field will be omitted from the resulting object.\n - `copy_tags_to_backups` (`bool`): Set the `copy_tags_to_backups` field on the resulting object. When `null`, the `copy_tags_to_backups` field will be omitted from the resulting object.\n - `copy_tags_to_volumes` (`bool`): Set the `copy_tags_to_volumes` field on the resulting object. When `null`, the `copy_tags_to_volumes` field will be omitted from the resulting object.\n - `daily_automatic_backup_start_time` (`string`): Set the `daily_automatic_backup_start_time` field on the resulting object. When `null`, the `daily_automatic_backup_start_time` field will be omitted from the resulting object.\n - `deployment_type` (`string`): Set the `deployment_type` field on the resulting object.\n - `kms_key_id` (`string`): Set the `kms_key_id` field on the resulting object. When `null`, the `kms_key_id` field will be omitted from the resulting object.\n - `security_group_ids` (`list`): Set the `security_group_ids` field on the resulting object. When `null`, the `security_group_ids` field will be omitted from the resulting object.\n - `storage_capacity` (`number`): Set the `storage_capacity` field on the resulting object. When `null`, the `storage_capacity` field will be omitted from the resulting object.\n - `storage_type` (`string`): Set the `storage_type` field on the resulting object. When `null`, the `storage_type` field will be omitted from the resulting object.\n - `subnet_ids` (`list`): Set the `subnet_ids` field on the resulting object.\n - `tags` (`obj`): Set the `tags` field on the resulting object. When `null`, the `tags` field will be omitted from the resulting object.\n - `tags_all` (`obj`): Set the `tags_all` field on the resulting object. When `null`, the `tags_all` field will be omitted from the resulting object.\n - `throughput_capacity` (`number`): Set the `throughput_capacity` field on the resulting object.\n - `weekly_maintenance_start_time` (`string`): Set the `weekly_maintenance_start_time` field on the resulting object. When `null`, the `weekly_maintenance_start_time` field will be omitted from the resulting object.\n - `disk_iops_configuration` (`list[obj]`): Set the `disk_iops_configuration` field on the resulting object. When `null`, the `disk_iops_configuration` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [aws.fsx_openzfs_file_system.disk_iops_configuration.new](#fn-disk_iops_configurationnew) constructor.\n - `root_volume_configuration` (`list[obj]`): Set the `root_volume_configuration` field on the resulting object. When `null`, the `root_volume_configuration` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [aws.fsx_openzfs_file_system.root_volume_configuration.new](#fn-root_volume_configurationnew) constructor.\n - `timeouts` (`obj`): Set the `timeouts` field on the resulting object. When `null`, the `timeouts` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [aws.fsx_openzfs_file_system.timeouts.new](#fn-timeoutsnew) constructor.\n\n**Returns**:\n - An attribute object that can be used with [tf.withResource](https://github.com/tf-libsonnet/core/tree/main/docs#fn-withresource) to construct a new `fsx_openzfs_file_system` resource into the root Terraform configuration.\n', args=[]), + '#newAttrs':: d.fn(help='\n`aws.fsx_openzfs_file_system.newAttrs` constructs a new object with attributes and blocks configured for the `fsx_openzfs_file_system`\nTerraform resource.\n\nUnlike [aws.fsx_openzfs_file_system.new](#fn-new), this function will not inject the `resource`\nblock into the root Terraform document. Instead, this must be passed in as the `attrs` argument for the\n[tf.withResource](https://github.com/tf-libsonnet/core/tree/main/docs#fn-withresource) function to build a complete block.\n\nThis is most useful when you need to preprocess the attributes with functions, conditional, or looping logic prior to\ninjecting into a complete block.\n\n**Args**:\n - `automatic_backup_retention_days` (`number`): Set the `automatic_backup_retention_days` field on the resulting object. When `null`, the `automatic_backup_retention_days` field will be omitted from the resulting object.\n - `backup_id` (`string`): Set the `backup_id` field on the resulting object. When `null`, the `backup_id` field will be omitted from the resulting object.\n - `copy_tags_to_backups` (`bool`): Set the `copy_tags_to_backups` field on the resulting object. When `null`, the `copy_tags_to_backups` field will be omitted from the resulting object.\n - `copy_tags_to_volumes` (`bool`): Set the `copy_tags_to_volumes` field on the resulting object. When `null`, the `copy_tags_to_volumes` field will be omitted from the resulting object.\n - `daily_automatic_backup_start_time` (`string`): Set the `daily_automatic_backup_start_time` field on the resulting object. When `null`, the `daily_automatic_backup_start_time` field will be omitted from the resulting object.\n - `deployment_type` (`string`): Set the `deployment_type` field on the resulting object.\n - `endpoint_ip_address_range` (`string`): Set the `endpoint_ip_address_range` field on the resulting object. When `null`, the `endpoint_ip_address_range` field will be omitted from the resulting object.\n - `kms_key_id` (`string`): Set the `kms_key_id` field on the resulting object. When `null`, the `kms_key_id` field will be omitted from the resulting object.\n - `preferred_subnet_id` (`string`): Set the `preferred_subnet_id` field on the resulting object. When `null`, the `preferred_subnet_id` field will be omitted from the resulting object.\n - `route_table_ids` (`list`): Set the `route_table_ids` field on the resulting object. When `null`, the `route_table_ids` field will be omitted from the resulting object.\n - `security_group_ids` (`list`): Set the `security_group_ids` field on the resulting object. When `null`, the `security_group_ids` field will be omitted from the resulting object.\n - `storage_capacity` (`number`): Set the `storage_capacity` field on the resulting object. When `null`, the `storage_capacity` field will be omitted from the resulting object.\n - `storage_type` (`string`): Set the `storage_type` field on the resulting object. When `null`, the `storage_type` field will be omitted from the resulting object.\n - `subnet_ids` (`list`): Set the `subnet_ids` field on the resulting object.\n - `tags` (`obj`): Set the `tags` field on the resulting object. When `null`, the `tags` field will be omitted from the resulting object.\n - `tags_all` (`obj`): Set the `tags_all` field on the resulting object. When `null`, the `tags_all` field will be omitted from the resulting object.\n - `throughput_capacity` (`number`): Set the `throughput_capacity` field on the resulting object.\n - `weekly_maintenance_start_time` (`string`): Set the `weekly_maintenance_start_time` field on the resulting object. When `null`, the `weekly_maintenance_start_time` field will be omitted from the resulting object.\n - `disk_iops_configuration` (`list[obj]`): Set the `disk_iops_configuration` field on the resulting object. When `null`, the `disk_iops_configuration` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [aws.fsx_openzfs_file_system.disk_iops_configuration.new](#fn-disk_iops_configurationnew) constructor.\n - `root_volume_configuration` (`list[obj]`): Set the `root_volume_configuration` field on the resulting object. When `null`, the `root_volume_configuration` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [aws.fsx_openzfs_file_system.root_volume_configuration.new](#fn-root_volume_configurationnew) constructor.\n - `timeouts` (`obj`): Set the `timeouts` field on the resulting object. When `null`, the `timeouts` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [aws.fsx_openzfs_file_system.timeouts.new](#fn-timeoutsnew) constructor.\n\n**Returns**:\n - An attribute object that can be used with [tf.withResource](https://github.com/tf-libsonnet/core/tree/main/docs#fn-withresource) to construct a new `fsx_openzfs_file_system` resource into the root Terraform configuration.\n', args=[]), newAttrs( deployment_type, subnet_ids, @@ -70,8 +76,11 @@ local d = (import 'github.com/jsonnet-libs/docsonnet/doc-util/main.libsonnet'); copy_tags_to_volumes=null, daily_automatic_backup_start_time=null, disk_iops_configuration=null, + endpoint_ip_address_range=null, kms_key_id=null, + preferred_subnet_id=null, root_volume_configuration=null, + route_table_ids=null, security_group_ids=null, storage_capacity=null, storage_type=null, @@ -87,8 +96,11 @@ local d = (import 'github.com/jsonnet-libs/docsonnet/doc-util/main.libsonnet'); daily_automatic_backup_start_time: daily_automatic_backup_start_time, deployment_type: deployment_type, disk_iops_configuration: disk_iops_configuration, + endpoint_ip_address_range: endpoint_ip_address_range, kms_key_id: kms_key_id, + preferred_subnet_id: preferred_subnet_id, root_volume_configuration: root_volume_configuration, + route_table_ids: route_table_ids, security_group_ids: security_group_ids, storage_capacity: storage_capacity, storage_type: storage_type, @@ -237,6 +249,16 @@ local d = (import 'github.com/jsonnet-libs/docsonnet/doc-util/main.libsonnet'); }, }, }, + '#withEndpointIpAddressRange':: d.fn(help='`aws.string.withEndpointIpAddressRange` constructs a mixin object that can be merged into the `string`\nTerraform resource block to set or update the endpoint_ip_address_range field.\n\n\n\n**Args**:\n - `resourceLabel` (`string`): The name label of the block to update.\n - `value` (`string`): The value to set for the `endpoint_ip_address_range` field.\n', args=[]), + withEndpointIpAddressRange(resourceLabel, value): { + resource+: { + aws_fsx_openzfs_file_system+: { + [resourceLabel]+: { + endpoint_ip_address_range: value, + }, + }, + }, + }, '#withKmsKeyId':: d.fn(help='`aws.string.withKmsKeyId` constructs a mixin object that can be merged into the `string`\nTerraform resource block to set or update the kms_key_id field.\n\n\n\n**Args**:\n - `resourceLabel` (`string`): The name label of the block to update.\n - `value` (`string`): The value to set for the `kms_key_id` field.\n', args=[]), withKmsKeyId(resourceLabel, value): { resource+: { @@ -247,6 +269,16 @@ local d = (import 'github.com/jsonnet-libs/docsonnet/doc-util/main.libsonnet'); }, }, }, + '#withPreferredSubnetId':: d.fn(help='`aws.string.withPreferredSubnetId` constructs a mixin object that can be merged into the `string`\nTerraform resource block to set or update the preferred_subnet_id field.\n\n\n\n**Args**:\n - `resourceLabel` (`string`): The name label of the block to update.\n - `value` (`string`): The value to set for the `preferred_subnet_id` field.\n', args=[]), + withPreferredSubnetId(resourceLabel, value): { + resource+: { + aws_fsx_openzfs_file_system+: { + [resourceLabel]+: { + preferred_subnet_id: value, + }, + }, + }, + }, '#withRootVolumeConfiguration':: d.fn(help='`aws.list[obj].withRootVolumeConfiguration` constructs a mixin object that can be merged into the `list[obj]`\nTerraform resource block to set or update the root_volume_configuration field.\n\nThis function will replace the array with the passed in `value`. If you wish to instead append the\npassed in value to the existing array, use the [aws.list[obj].withRootVolumeConfigurationMixin](TODO) function.\n\n\n**Args**:\n - `resourceLabel` (`string`): The name label of the block to update.\n - `value` (`list[obj]`): The value to set for the `root_volume_configuration` field.\n', args=[]), withRootVolumeConfiguration(resourceLabel, value): { resource+: { @@ -267,6 +299,16 @@ local d = (import 'github.com/jsonnet-libs/docsonnet/doc-util/main.libsonnet'); }, }, }, + '#withRouteTableIds':: d.fn(help='`aws.list.withRouteTableIds` constructs a mixin object that can be merged into the `list`\nTerraform resource block to set or update the route_table_ids field.\n\n\n\n**Args**:\n - `resourceLabel` (`string`): The name label of the block to update.\n - `value` (`list`): The value to set for the `route_table_ids` field.\n', args=[]), + withRouteTableIds(resourceLabel, value): { + resource+: { + aws_fsx_openzfs_file_system+: { + [resourceLabel]+: { + route_table_ids: value, + }, + }, + }, + }, '#withSecurityGroupIds':: d.fn(help='`aws.list.withSecurityGroupIds` constructs a mixin object that can be merged into the `list`\nTerraform resource block to set or update the security_group_ids field.\n\n\n\n**Args**:\n - `resourceLabel` (`string`): The name label of the block to update.\n - `value` (`list`): The value to set for the `security_group_ids` field.\n', args=[]), withSecurityGroupIds(resourceLabel, value): { resource+: { diff --git a/5.x/_gen/resources/fsx_windows_file_system.libsonnet b/5.x/_gen/resources/fsx_windows_file_system.libsonnet index 9d06e080..42a14126 100644 --- a/5.x/_gen/resources/fsx_windows_file_system.libsonnet +++ b/5.x/_gen/resources/fsx_windows_file_system.libsonnet @@ -14,7 +14,17 @@ local d = (import 'github.com/jsonnet-libs/docsonnet/doc-util/main.libsonnet'); file_share_access_audit_log_level: file_share_access_audit_log_level, }), }, - '#new':: d.fn(help="\n`aws.fsx_windows_file_system.new` injects a new `aws_fsx_windows_file_system` Terraform `resource`\nblock into the root module document.\n\nAdditionally, this inserts a private function into the `_ref` attribute that generates references to attributes of the\nresource. For example, if you added a new instance to the root using:\n\n # arguments omitted for brevity\n aws.fsx_windows_file_system.new('some_id')\n\nYou can get the reference to the `id` field of the created `aws.fsx_windows_file_system` using the reference:\n\n $._ref.aws_fsx_windows_file_system.some_id.get('id')\n\nThis is the same as directly entering `\"${ aws_fsx_windows_file_system.some_id.id }\"` as the value.\n\nNOTE: if you are chaining multiple resources together in a merge operation, you may not be able to use `super`, `self`,\nor `$` to refer to the root object. Instead, make an explicit outer object using `local`.\n\n**Args**:\n - `resourceLabel` (`string`): The name label of the block.\n - `active_directory_id` (`string`): Set the `active_directory_id` field on the resulting resource block. When `null`, the `active_directory_id` field will be omitted from the resulting object.\n - `aliases` (`list`): Set the `aliases` field on the resulting resource block. When `null`, the `aliases` field will be omitted from the resulting object.\n - `automatic_backup_retention_days` (`number`): Set the `automatic_backup_retention_days` field on the resulting resource block. When `null`, the `automatic_backup_retention_days` field will be omitted from the resulting object.\n - `backup_id` (`string`): Set the `backup_id` field on the resulting resource block. When `null`, the `backup_id` field will be omitted from the resulting object.\n - `copy_tags_to_backups` (`bool`): Set the `copy_tags_to_backups` field on the resulting resource block. When `null`, the `copy_tags_to_backups` field will be omitted from the resulting object.\n - `daily_automatic_backup_start_time` (`string`): Set the `daily_automatic_backup_start_time` field on the resulting resource block. When `null`, the `daily_automatic_backup_start_time` field will be omitted from the resulting object.\n - `deployment_type` (`string`): Set the `deployment_type` field on the resulting resource block. When `null`, the `deployment_type` field will be omitted from the resulting object.\n - `kms_key_id` (`string`): Set the `kms_key_id` field on the resulting resource block. When `null`, the `kms_key_id` field will be omitted from the resulting object.\n - `preferred_subnet_id` (`string`): Set the `preferred_subnet_id` field on the resulting resource block. When `null`, the `preferred_subnet_id` field will be omitted from the resulting object.\n - `security_group_ids` (`list`): Set the `security_group_ids` field on the resulting resource block. When `null`, the `security_group_ids` field will be omitted from the resulting object.\n - `skip_final_backup` (`bool`): Set the `skip_final_backup` field on the resulting resource block. When `null`, the `skip_final_backup` field will be omitted from the resulting object.\n - `storage_capacity` (`number`): Set the `storage_capacity` field on the resulting resource block. When `null`, the `storage_capacity` field will be omitted from the resulting object.\n - `storage_type` (`string`): Set the `storage_type` field on the resulting resource block. When `null`, the `storage_type` field will be omitted from the resulting object.\n - `subnet_ids` (`list`): Set the `subnet_ids` field on the resulting resource block.\n - `tags` (`obj`): Set the `tags` field on the resulting resource block. When `null`, the `tags` field will be omitted from the resulting object.\n - `tags_all` (`obj`): Set the `tags_all` field on the resulting resource block. When `null`, the `tags_all` field will be omitted from the resulting object.\n - `throughput_capacity` (`number`): Set the `throughput_capacity` field on the resulting resource block.\n - `weekly_maintenance_start_time` (`string`): Set the `weekly_maintenance_start_time` field on the resulting resource block. When `null`, the `weekly_maintenance_start_time` field will be omitted from the resulting object.\n - `audit_log_configuration` (`list[obj]`): Set the `audit_log_configuration` field on the resulting resource block. When `null`, the `audit_log_configuration` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [aws.fsx_windows_file_system.audit_log_configuration.new](#fn-audit_log_configurationnew) constructor.\n - `self_managed_active_directory` (`list[obj]`): Set the `self_managed_active_directory` field on the resulting resource block. When `null`, the `self_managed_active_directory` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [aws.fsx_windows_file_system.self_managed_active_directory.new](#fn-self_managed_active_directorynew) constructor.\n - `timeouts` (`obj`): Set the `timeouts` field on the resulting resource block. When `null`, the `timeouts` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [aws.fsx_windows_file_system.timeouts.new](#fn-timeoutsnew) constructor.\n\n**Returns**:\n- A mixin object that injects the new resource into the root Terraform configuration.\n", args=[]), + disk_iops_configuration:: { + '#new':: d.fn(help='\n`aws.fsx_windows_file_system.disk_iops_configuration.new` constructs a new object with attributes and blocks configured for the `disk_iops_configuration`\nTerraform sub block.\n\n\n\n**Args**:\n - `iops` (`number`): Set the `iops` field on the resulting object. When `null`, the `iops` field will be omitted from the resulting object.\n - `mode` (`string`): Set the `mode` field on the resulting object. When `null`, the `mode` field will be omitted from the resulting object.\n\n**Returns**:\n - An attribute object that represents the `disk_iops_configuration` sub block.\n', args=[]), + new( + iops=null, + mode=null + ):: std.prune(a={ + iops: iops, + mode: mode, + }), + }, + '#new':: d.fn(help="\n`aws.fsx_windows_file_system.new` injects a new `aws_fsx_windows_file_system` Terraform `resource`\nblock into the root module document.\n\nAdditionally, this inserts a private function into the `_ref` attribute that generates references to attributes of the\nresource. For example, if you added a new instance to the root using:\n\n # arguments omitted for brevity\n aws.fsx_windows_file_system.new('some_id')\n\nYou can get the reference to the `id` field of the created `aws.fsx_windows_file_system` using the reference:\n\n $._ref.aws_fsx_windows_file_system.some_id.get('id')\n\nThis is the same as directly entering `\"${ aws_fsx_windows_file_system.some_id.id }\"` as the value.\n\nNOTE: if you are chaining multiple resources together in a merge operation, you may not be able to use `super`, `self`,\nor `$` to refer to the root object. Instead, make an explicit outer object using `local`.\n\n**Args**:\n - `resourceLabel` (`string`): The name label of the block.\n - `active_directory_id` (`string`): Set the `active_directory_id` field on the resulting resource block. When `null`, the `active_directory_id` field will be omitted from the resulting object.\n - `aliases` (`list`): Set the `aliases` field on the resulting resource block. When `null`, the `aliases` field will be omitted from the resulting object.\n - `automatic_backup_retention_days` (`number`): Set the `automatic_backup_retention_days` field on the resulting resource block. When `null`, the `automatic_backup_retention_days` field will be omitted from the resulting object.\n - `backup_id` (`string`): Set the `backup_id` field on the resulting resource block. When `null`, the `backup_id` field will be omitted from the resulting object.\n - `copy_tags_to_backups` (`bool`): Set the `copy_tags_to_backups` field on the resulting resource block. When `null`, the `copy_tags_to_backups` field will be omitted from the resulting object.\n - `daily_automatic_backup_start_time` (`string`): Set the `daily_automatic_backup_start_time` field on the resulting resource block. When `null`, the `daily_automatic_backup_start_time` field will be omitted from the resulting object.\n - `deployment_type` (`string`): Set the `deployment_type` field on the resulting resource block. When `null`, the `deployment_type` field will be omitted from the resulting object.\n - `kms_key_id` (`string`): Set the `kms_key_id` field on the resulting resource block. When `null`, the `kms_key_id` field will be omitted from the resulting object.\n - `preferred_subnet_id` (`string`): Set the `preferred_subnet_id` field on the resulting resource block. When `null`, the `preferred_subnet_id` field will be omitted from the resulting object.\n - `security_group_ids` (`list`): Set the `security_group_ids` field on the resulting resource block. When `null`, the `security_group_ids` field will be omitted from the resulting object.\n - `skip_final_backup` (`bool`): Set the `skip_final_backup` field on the resulting resource block. When `null`, the `skip_final_backup` field will be omitted from the resulting object.\n - `storage_capacity` (`number`): Set the `storage_capacity` field on the resulting resource block. When `null`, the `storage_capacity` field will be omitted from the resulting object.\n - `storage_type` (`string`): Set the `storage_type` field on the resulting resource block. When `null`, the `storage_type` field will be omitted from the resulting object.\n - `subnet_ids` (`list`): Set the `subnet_ids` field on the resulting resource block.\n - `tags` (`obj`): Set the `tags` field on the resulting resource block. When `null`, the `tags` field will be omitted from the resulting object.\n - `tags_all` (`obj`): Set the `tags_all` field on the resulting resource block. When `null`, the `tags_all` field will be omitted from the resulting object.\n - `throughput_capacity` (`number`): Set the `throughput_capacity` field on the resulting resource block.\n - `weekly_maintenance_start_time` (`string`): Set the `weekly_maintenance_start_time` field on the resulting resource block. When `null`, the `weekly_maintenance_start_time` field will be omitted from the resulting object.\n - `audit_log_configuration` (`list[obj]`): Set the `audit_log_configuration` field on the resulting resource block. When `null`, the `audit_log_configuration` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [aws.fsx_windows_file_system.audit_log_configuration.new](#fn-audit_log_configurationnew) constructor.\n - `disk_iops_configuration` (`list[obj]`): Set the `disk_iops_configuration` field on the resulting resource block. When `null`, the `disk_iops_configuration` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [aws.fsx_windows_file_system.disk_iops_configuration.new](#fn-disk_iops_configurationnew) constructor.\n - `self_managed_active_directory` (`list[obj]`): Set the `self_managed_active_directory` field on the resulting resource block. When `null`, the `self_managed_active_directory` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [aws.fsx_windows_file_system.self_managed_active_directory.new](#fn-self_managed_active_directorynew) constructor.\n - `timeouts` (`obj`): Set the `timeouts` field on the resulting resource block. When `null`, the `timeouts` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [aws.fsx_windows_file_system.timeouts.new](#fn-timeoutsnew) constructor.\n\n**Returns**:\n- A mixin object that injects the new resource into the root Terraform configuration.\n", args=[]), new( resourceLabel, subnet_ids, @@ -27,6 +37,7 @@ local d = (import 'github.com/jsonnet-libs/docsonnet/doc-util/main.libsonnet'); copy_tags_to_backups=null, daily_automatic_backup_start_time=null, deployment_type=null, + disk_iops_configuration=null, kms_key_id=null, preferred_subnet_id=null, security_group_ids=null, @@ -51,6 +62,7 @@ local d = (import 'github.com/jsonnet-libs/docsonnet/doc-util/main.libsonnet'); copy_tags_to_backups=copy_tags_to_backups, daily_automatic_backup_start_time=daily_automatic_backup_start_time, deployment_type=deployment_type, + disk_iops_configuration=disk_iops_configuration, kms_key_id=kms_key_id, preferred_subnet_id=preferred_subnet_id, security_group_ids=security_group_ids, @@ -67,7 +79,7 @@ local d = (import 'github.com/jsonnet-libs/docsonnet/doc-util/main.libsonnet'); ), _meta=_meta ), - '#newAttrs':: d.fn(help='\n`aws.fsx_windows_file_system.newAttrs` constructs a new object with attributes and blocks configured for the `fsx_windows_file_system`\nTerraform resource.\n\nUnlike [aws.fsx_windows_file_system.new](#fn-new), this function will not inject the `resource`\nblock into the root Terraform document. Instead, this must be passed in as the `attrs` argument for the\n[tf.withResource](https://github.com/tf-libsonnet/core/tree/main/docs#fn-withresource) function to build a complete block.\n\nThis is most useful when you need to preprocess the attributes with functions, conditional, or looping logic prior to\ninjecting into a complete block.\n\n**Args**:\n - `active_directory_id` (`string`): Set the `active_directory_id` field on the resulting object. When `null`, the `active_directory_id` field will be omitted from the resulting object.\n - `aliases` (`list`): Set the `aliases` field on the resulting object. When `null`, the `aliases` field will be omitted from the resulting object.\n - `automatic_backup_retention_days` (`number`): Set the `automatic_backup_retention_days` field on the resulting object. When `null`, the `automatic_backup_retention_days` field will be omitted from the resulting object.\n - `backup_id` (`string`): Set the `backup_id` field on the resulting object. When `null`, the `backup_id` field will be omitted from the resulting object.\n - `copy_tags_to_backups` (`bool`): Set the `copy_tags_to_backups` field on the resulting object. When `null`, the `copy_tags_to_backups` field will be omitted from the resulting object.\n - `daily_automatic_backup_start_time` (`string`): Set the `daily_automatic_backup_start_time` field on the resulting object. When `null`, the `daily_automatic_backup_start_time` field will be omitted from the resulting object.\n - `deployment_type` (`string`): Set the `deployment_type` field on the resulting object. When `null`, the `deployment_type` field will be omitted from the resulting object.\n - `kms_key_id` (`string`): Set the `kms_key_id` field on the resulting object. When `null`, the `kms_key_id` field will be omitted from the resulting object.\n - `preferred_subnet_id` (`string`): Set the `preferred_subnet_id` field on the resulting object. When `null`, the `preferred_subnet_id` field will be omitted from the resulting object.\n - `security_group_ids` (`list`): Set the `security_group_ids` field on the resulting object. When `null`, the `security_group_ids` field will be omitted from the resulting object.\n - `skip_final_backup` (`bool`): Set the `skip_final_backup` field on the resulting object. When `null`, the `skip_final_backup` field will be omitted from the resulting object.\n - `storage_capacity` (`number`): Set the `storage_capacity` field on the resulting object. When `null`, the `storage_capacity` field will be omitted from the resulting object.\n - `storage_type` (`string`): Set the `storage_type` field on the resulting object. When `null`, the `storage_type` field will be omitted from the resulting object.\n - `subnet_ids` (`list`): Set the `subnet_ids` field on the resulting object.\n - `tags` (`obj`): Set the `tags` field on the resulting object. When `null`, the `tags` field will be omitted from the resulting object.\n - `tags_all` (`obj`): Set the `tags_all` field on the resulting object. When `null`, the `tags_all` field will be omitted from the resulting object.\n - `throughput_capacity` (`number`): Set the `throughput_capacity` field on the resulting object.\n - `weekly_maintenance_start_time` (`string`): Set the `weekly_maintenance_start_time` field on the resulting object. When `null`, the `weekly_maintenance_start_time` field will be omitted from the resulting object.\n - `audit_log_configuration` (`list[obj]`): Set the `audit_log_configuration` field on the resulting object. When `null`, the `audit_log_configuration` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [aws.fsx_windows_file_system.audit_log_configuration.new](#fn-audit_log_configurationnew) constructor.\n - `self_managed_active_directory` (`list[obj]`): Set the `self_managed_active_directory` field on the resulting object. When `null`, the `self_managed_active_directory` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [aws.fsx_windows_file_system.self_managed_active_directory.new](#fn-self_managed_active_directorynew) constructor.\n - `timeouts` (`obj`): Set the `timeouts` field on the resulting object. When `null`, the `timeouts` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [aws.fsx_windows_file_system.timeouts.new](#fn-timeoutsnew) constructor.\n\n**Returns**:\n - An attribute object that can be used with [tf.withResource](https://github.com/tf-libsonnet/core/tree/main/docs#fn-withresource) to construct a new `fsx_windows_file_system` resource into the root Terraform configuration.\n', args=[]), + '#newAttrs':: d.fn(help='\n`aws.fsx_windows_file_system.newAttrs` constructs a new object with attributes and blocks configured for the `fsx_windows_file_system`\nTerraform resource.\n\nUnlike [aws.fsx_windows_file_system.new](#fn-new), this function will not inject the `resource`\nblock into the root Terraform document. Instead, this must be passed in as the `attrs` argument for the\n[tf.withResource](https://github.com/tf-libsonnet/core/tree/main/docs#fn-withresource) function to build a complete block.\n\nThis is most useful when you need to preprocess the attributes with functions, conditional, or looping logic prior to\ninjecting into a complete block.\n\n**Args**:\n - `active_directory_id` (`string`): Set the `active_directory_id` field on the resulting object. When `null`, the `active_directory_id` field will be omitted from the resulting object.\n - `aliases` (`list`): Set the `aliases` field on the resulting object. When `null`, the `aliases` field will be omitted from the resulting object.\n - `automatic_backup_retention_days` (`number`): Set the `automatic_backup_retention_days` field on the resulting object. When `null`, the `automatic_backup_retention_days` field will be omitted from the resulting object.\n - `backup_id` (`string`): Set the `backup_id` field on the resulting object. When `null`, the `backup_id` field will be omitted from the resulting object.\n - `copy_tags_to_backups` (`bool`): Set the `copy_tags_to_backups` field on the resulting object. When `null`, the `copy_tags_to_backups` field will be omitted from the resulting object.\n - `daily_automatic_backup_start_time` (`string`): Set the `daily_automatic_backup_start_time` field on the resulting object. When `null`, the `daily_automatic_backup_start_time` field will be omitted from the resulting object.\n - `deployment_type` (`string`): Set the `deployment_type` field on the resulting object. When `null`, the `deployment_type` field will be omitted from the resulting object.\n - `kms_key_id` (`string`): Set the `kms_key_id` field on the resulting object. When `null`, the `kms_key_id` field will be omitted from the resulting object.\n - `preferred_subnet_id` (`string`): Set the `preferred_subnet_id` field on the resulting object. When `null`, the `preferred_subnet_id` field will be omitted from the resulting object.\n - `security_group_ids` (`list`): Set the `security_group_ids` field on the resulting object. When `null`, the `security_group_ids` field will be omitted from the resulting object.\n - `skip_final_backup` (`bool`): Set the `skip_final_backup` field on the resulting object. When `null`, the `skip_final_backup` field will be omitted from the resulting object.\n - `storage_capacity` (`number`): Set the `storage_capacity` field on the resulting object. When `null`, the `storage_capacity` field will be omitted from the resulting object.\n - `storage_type` (`string`): Set the `storage_type` field on the resulting object. When `null`, the `storage_type` field will be omitted from the resulting object.\n - `subnet_ids` (`list`): Set the `subnet_ids` field on the resulting object.\n - `tags` (`obj`): Set the `tags` field on the resulting object. When `null`, the `tags` field will be omitted from the resulting object.\n - `tags_all` (`obj`): Set the `tags_all` field on the resulting object. When `null`, the `tags_all` field will be omitted from the resulting object.\n - `throughput_capacity` (`number`): Set the `throughput_capacity` field on the resulting object.\n - `weekly_maintenance_start_time` (`string`): Set the `weekly_maintenance_start_time` field on the resulting object. When `null`, the `weekly_maintenance_start_time` field will be omitted from the resulting object.\n - `audit_log_configuration` (`list[obj]`): Set the `audit_log_configuration` field on the resulting object. When `null`, the `audit_log_configuration` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [aws.fsx_windows_file_system.audit_log_configuration.new](#fn-audit_log_configurationnew) constructor.\n - `disk_iops_configuration` (`list[obj]`): Set the `disk_iops_configuration` field on the resulting object. When `null`, the `disk_iops_configuration` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [aws.fsx_windows_file_system.disk_iops_configuration.new](#fn-disk_iops_configurationnew) constructor.\n - `self_managed_active_directory` (`list[obj]`): Set the `self_managed_active_directory` field on the resulting object. When `null`, the `self_managed_active_directory` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [aws.fsx_windows_file_system.self_managed_active_directory.new](#fn-self_managed_active_directorynew) constructor.\n - `timeouts` (`obj`): Set the `timeouts` field on the resulting object. When `null`, the `timeouts` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [aws.fsx_windows_file_system.timeouts.new](#fn-timeoutsnew) constructor.\n\n**Returns**:\n - An attribute object that can be used with [tf.withResource](https://github.com/tf-libsonnet/core/tree/main/docs#fn-withresource) to construct a new `fsx_windows_file_system` resource into the root Terraform configuration.\n', args=[]), newAttrs( subnet_ids, throughput_capacity, @@ -79,6 +91,7 @@ local d = (import 'github.com/jsonnet-libs/docsonnet/doc-util/main.libsonnet'); copy_tags_to_backups=null, daily_automatic_backup_start_time=null, deployment_type=null, + disk_iops_configuration=null, kms_key_id=null, preferred_subnet_id=null, security_group_ids=null, @@ -99,6 +112,7 @@ local d = (import 'github.com/jsonnet-libs/docsonnet/doc-util/main.libsonnet'); copy_tags_to_backups: copy_tags_to_backups, daily_automatic_backup_start_time: daily_automatic_backup_start_time, deployment_type: deployment_type, + disk_iops_configuration: disk_iops_configuration, kms_key_id: kms_key_id, preferred_subnet_id: preferred_subnet_id, security_group_ids: security_group_ids, @@ -233,6 +247,26 @@ local d = (import 'github.com/jsonnet-libs/docsonnet/doc-util/main.libsonnet'); }, }, }, + '#withDiskIopsConfiguration':: d.fn(help='`aws.list[obj].withDiskIopsConfiguration` constructs a mixin object that can be merged into the `list[obj]`\nTerraform resource block to set or update the disk_iops_configuration field.\n\nThis function will replace the array with the passed in `value`. If you wish to instead append the\npassed in value to the existing array, use the [aws.list[obj].withDiskIopsConfigurationMixin](TODO) function.\n\n\n**Args**:\n - `resourceLabel` (`string`): The name label of the block to update.\n - `value` (`list[obj]`): The value to set for the `disk_iops_configuration` field.\n', args=[]), + withDiskIopsConfiguration(resourceLabel, value): { + resource+: { + aws_fsx_windows_file_system+: { + [resourceLabel]+: { + disk_iops_configuration: value, + }, + }, + }, + }, + '#withDiskIopsConfigurationMixin':: d.fn(help='`aws.list[obj].withDiskIopsConfigurationMixin` constructs a mixin object that can be merged into the `list[obj]`\nTerraform resource block to set or update the disk_iops_configuration field.\n\nThis function will append the passed in array or object to the existing array. If you wish\nto instead replace the array with the passed in `value`, use the [aws.list[obj].withDiskIopsConfiguration](TODO)\nfunction.\n\n\n**Args**:\n - `resourceLabel` (`string`): The name label of the block to update.\n - `value` (`list[obj]`): The value to set for the `disk_iops_configuration` field.\n', args=[]), + withDiskIopsConfigurationMixin(resourceLabel, value): { + resource+: { + aws_fsx_windows_file_system+: { + [resourceLabel]+: { + disk_iops_configuration+: if std.isArray(v=value) then value else [value], + }, + }, + }, + }, '#withKmsKeyId':: d.fn(help='`aws.string.withKmsKeyId` constructs a mixin object that can be merged into the `string`\nTerraform resource block to set or update the kms_key_id field.\n\n\n\n**Args**:\n - `resourceLabel` (`string`): The name label of the block to update.\n - `value` (`string`): The value to set for the `kms_key_id` field.\n', args=[]), withKmsKeyId(resourceLabel, value): { resource+: { diff --git a/5.x/_gen/resources/glue_catalog_table.libsonnet b/5.x/_gen/resources/glue_catalog_table.libsonnet index b5074999..039caad5 100644 --- a/5.x/_gen/resources/glue_catalog_table.libsonnet +++ b/5.x/_gen/resources/glue_catalog_table.libsonnet @@ -2,13 +2,14 @@ local tf = (import 'github.com/tf-libsonnet/core/main.libsonnet'); local d = (import 'github.com/jsonnet-libs/docsonnet/doc-util/main.libsonnet'); { '#':: d.pkg(name='glue_catalog_table', url='', help='`glue_catalog_table` represents the `aws_glue_catalog_table` Terraform resource.\n\n\n\nThis package contains functions and utilities for setting up the resource using Jsonnet code.\n'), - '#new':: d.fn(help="\n`aws.glue_catalog_table.new` injects a new `aws_glue_catalog_table` Terraform `resource`\nblock into the root module document.\n\nAdditionally, this inserts a private function into the `_ref` attribute that generates references to attributes of the\nresource. For example, if you added a new instance to the root using:\n\n # arguments omitted for brevity\n aws.glue_catalog_table.new('some_id')\n\nYou can get the reference to the `id` field of the created `aws.glue_catalog_table` using the reference:\n\n $._ref.aws_glue_catalog_table.some_id.get('id')\n\nThis is the same as directly entering `\"${ aws_glue_catalog_table.some_id.id }\"` as the value.\n\nNOTE: if you are chaining multiple resources together in a merge operation, you may not be able to use `super`, `self`,\nor `$` to refer to the root object. Instead, make an explicit outer object using `local`.\n\n**Args**:\n - `resourceLabel` (`string`): The name label of the block.\n - `catalog_id` (`string`): Set the `catalog_id` field on the resulting resource block. When `null`, the `catalog_id` field will be omitted from the resulting object.\n - `database_name` (`string`): Set the `database_name` field on the resulting resource block.\n - `description` (`string`): Set the `description` field on the resulting resource block. When `null`, the `description` field will be omitted from the resulting object.\n - `name` (`string`): Set the `name` field on the resulting resource block.\n - `owner` (`string`): Set the `owner` field on the resulting resource block. When `null`, the `owner` field will be omitted from the resulting object.\n - `parameters` (`obj`): Set the `parameters` field on the resulting resource block. When `null`, the `parameters` field will be omitted from the resulting object.\n - `retention` (`number`): Set the `retention` field on the resulting resource block. When `null`, the `retention` field will be omitted from the resulting object.\n - `table_type` (`string`): Set the `table_type` field on the resulting resource block. When `null`, the `table_type` field will be omitted from the resulting object.\n - `view_expanded_text` (`string`): Set the `view_expanded_text` field on the resulting resource block. When `null`, the `view_expanded_text` field will be omitted from the resulting object.\n - `view_original_text` (`string`): Set the `view_original_text` field on the resulting resource block. When `null`, the `view_original_text` field will be omitted from the resulting object.\n - `partition_index` (`list[obj]`): Set the `partition_index` field on the resulting resource block. When `null`, the `partition_index` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [aws.glue_catalog_table.partition_index.new](#fn-partition_indexnew) constructor.\n - `partition_keys` (`list[obj]`): Set the `partition_keys` field on the resulting resource block. When `null`, the `partition_keys` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [aws.glue_catalog_table.partition_keys.new](#fn-partition_keysnew) constructor.\n - `storage_descriptor` (`list[obj]`): Set the `storage_descriptor` field on the resulting resource block. When `null`, the `storage_descriptor` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [aws.glue_catalog_table.storage_descriptor.new](#fn-storage_descriptornew) constructor.\n - `target_table` (`list[obj]`): Set the `target_table` field on the resulting resource block. When `null`, the `target_table` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [aws.glue_catalog_table.target_table.new](#fn-target_tablenew) constructor.\n\n**Returns**:\n- A mixin object that injects the new resource into the root Terraform configuration.\n", args=[]), + '#new':: d.fn(help="\n`aws.glue_catalog_table.new` injects a new `aws_glue_catalog_table` Terraform `resource`\nblock into the root module document.\n\nAdditionally, this inserts a private function into the `_ref` attribute that generates references to attributes of the\nresource. For example, if you added a new instance to the root using:\n\n # arguments omitted for brevity\n aws.glue_catalog_table.new('some_id')\n\nYou can get the reference to the `id` field of the created `aws.glue_catalog_table` using the reference:\n\n $._ref.aws_glue_catalog_table.some_id.get('id')\n\nThis is the same as directly entering `\"${ aws_glue_catalog_table.some_id.id }\"` as the value.\n\nNOTE: if you are chaining multiple resources together in a merge operation, you may not be able to use `super`, `self`,\nor `$` to refer to the root object. Instead, make an explicit outer object using `local`.\n\n**Args**:\n - `resourceLabel` (`string`): The name label of the block.\n - `catalog_id` (`string`): Set the `catalog_id` field on the resulting resource block. When `null`, the `catalog_id` field will be omitted from the resulting object.\n - `database_name` (`string`): Set the `database_name` field on the resulting resource block.\n - `description` (`string`): Set the `description` field on the resulting resource block. When `null`, the `description` field will be omitted from the resulting object.\n - `name` (`string`): Set the `name` field on the resulting resource block.\n - `owner` (`string`): Set the `owner` field on the resulting resource block. When `null`, the `owner` field will be omitted from the resulting object.\n - `parameters` (`obj`): Set the `parameters` field on the resulting resource block. When `null`, the `parameters` field will be omitted from the resulting object.\n - `retention` (`number`): Set the `retention` field on the resulting resource block. When `null`, the `retention` field will be omitted from the resulting object.\n - `table_type` (`string`): Set the `table_type` field on the resulting resource block. When `null`, the `table_type` field will be omitted from the resulting object.\n - `view_expanded_text` (`string`): Set the `view_expanded_text` field on the resulting resource block. When `null`, the `view_expanded_text` field will be omitted from the resulting object.\n - `view_original_text` (`string`): Set the `view_original_text` field on the resulting resource block. When `null`, the `view_original_text` field will be omitted from the resulting object.\n - `open_table_format_input` (`list[obj]`): Set the `open_table_format_input` field on the resulting resource block. When `null`, the `open_table_format_input` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [aws.glue_catalog_table.open_table_format_input.new](#fn-open_table_format_inputnew) constructor.\n - `partition_index` (`list[obj]`): Set the `partition_index` field on the resulting resource block. When `null`, the `partition_index` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [aws.glue_catalog_table.partition_index.new](#fn-partition_indexnew) constructor.\n - `partition_keys` (`list[obj]`): Set the `partition_keys` field on the resulting resource block. When `null`, the `partition_keys` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [aws.glue_catalog_table.partition_keys.new](#fn-partition_keysnew) constructor.\n - `storage_descriptor` (`list[obj]`): Set the `storage_descriptor` field on the resulting resource block. When `null`, the `storage_descriptor` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [aws.glue_catalog_table.storage_descriptor.new](#fn-storage_descriptornew) constructor.\n - `target_table` (`list[obj]`): Set the `target_table` field on the resulting resource block. When `null`, the `target_table` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [aws.glue_catalog_table.target_table.new](#fn-target_tablenew) constructor.\n\n**Returns**:\n- A mixin object that injects the new resource into the root Terraform configuration.\n", args=[]), new( resourceLabel, database_name, name, catalog_id=null, description=null, + open_table_format_input=null, owner=null, parameters=null, partition_index=null, @@ -28,6 +29,7 @@ local d = (import 'github.com/jsonnet-libs/docsonnet/doc-util/main.libsonnet'); database_name=database_name, description=description, name=name, + open_table_format_input=open_table_format_input, owner=owner, parameters=parameters, partition_index=partition_index, @@ -41,12 +43,13 @@ local d = (import 'github.com/jsonnet-libs/docsonnet/doc-util/main.libsonnet'); ), _meta=_meta ), - '#newAttrs':: d.fn(help='\n`aws.glue_catalog_table.newAttrs` constructs a new object with attributes and blocks configured for the `glue_catalog_table`\nTerraform resource.\n\nUnlike [aws.glue_catalog_table.new](#fn-new), this function will not inject the `resource`\nblock into the root Terraform document. Instead, this must be passed in as the `attrs` argument for the\n[tf.withResource](https://github.com/tf-libsonnet/core/tree/main/docs#fn-withresource) function to build a complete block.\n\nThis is most useful when you need to preprocess the attributes with functions, conditional, or looping logic prior to\ninjecting into a complete block.\n\n**Args**:\n - `catalog_id` (`string`): Set the `catalog_id` field on the resulting object. When `null`, the `catalog_id` field will be omitted from the resulting object.\n - `database_name` (`string`): Set the `database_name` field on the resulting object.\n - `description` (`string`): Set the `description` field on the resulting object. When `null`, the `description` field will be omitted from the resulting object.\n - `name` (`string`): Set the `name` field on the resulting object.\n - `owner` (`string`): Set the `owner` field on the resulting object. When `null`, the `owner` field will be omitted from the resulting object.\n - `parameters` (`obj`): Set the `parameters` field on the resulting object. When `null`, the `parameters` field will be omitted from the resulting object.\n - `retention` (`number`): Set the `retention` field on the resulting object. When `null`, the `retention` field will be omitted from the resulting object.\n - `table_type` (`string`): Set the `table_type` field on the resulting object. When `null`, the `table_type` field will be omitted from the resulting object.\n - `view_expanded_text` (`string`): Set the `view_expanded_text` field on the resulting object. When `null`, the `view_expanded_text` field will be omitted from the resulting object.\n - `view_original_text` (`string`): Set the `view_original_text` field on the resulting object. When `null`, the `view_original_text` field will be omitted from the resulting object.\n - `partition_index` (`list[obj]`): Set the `partition_index` field on the resulting object. When `null`, the `partition_index` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [aws.glue_catalog_table.partition_index.new](#fn-partition_indexnew) constructor.\n - `partition_keys` (`list[obj]`): Set the `partition_keys` field on the resulting object. When `null`, the `partition_keys` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [aws.glue_catalog_table.partition_keys.new](#fn-partition_keysnew) constructor.\n - `storage_descriptor` (`list[obj]`): Set the `storage_descriptor` field on the resulting object. When `null`, the `storage_descriptor` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [aws.glue_catalog_table.storage_descriptor.new](#fn-storage_descriptornew) constructor.\n - `target_table` (`list[obj]`): Set the `target_table` field on the resulting object. When `null`, the `target_table` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [aws.glue_catalog_table.target_table.new](#fn-target_tablenew) constructor.\n\n**Returns**:\n - An attribute object that can be used with [tf.withResource](https://github.com/tf-libsonnet/core/tree/main/docs#fn-withresource) to construct a new `glue_catalog_table` resource into the root Terraform configuration.\n', args=[]), + '#newAttrs':: d.fn(help='\n`aws.glue_catalog_table.newAttrs` constructs a new object with attributes and blocks configured for the `glue_catalog_table`\nTerraform resource.\n\nUnlike [aws.glue_catalog_table.new](#fn-new), this function will not inject the `resource`\nblock into the root Terraform document. Instead, this must be passed in as the `attrs` argument for the\n[tf.withResource](https://github.com/tf-libsonnet/core/tree/main/docs#fn-withresource) function to build a complete block.\n\nThis is most useful when you need to preprocess the attributes with functions, conditional, or looping logic prior to\ninjecting into a complete block.\n\n**Args**:\n - `catalog_id` (`string`): Set the `catalog_id` field on the resulting object. When `null`, the `catalog_id` field will be omitted from the resulting object.\n - `database_name` (`string`): Set the `database_name` field on the resulting object.\n - `description` (`string`): Set the `description` field on the resulting object. When `null`, the `description` field will be omitted from the resulting object.\n - `name` (`string`): Set the `name` field on the resulting object.\n - `owner` (`string`): Set the `owner` field on the resulting object. When `null`, the `owner` field will be omitted from the resulting object.\n - `parameters` (`obj`): Set the `parameters` field on the resulting object. When `null`, the `parameters` field will be omitted from the resulting object.\n - `retention` (`number`): Set the `retention` field on the resulting object. When `null`, the `retention` field will be omitted from the resulting object.\n - `table_type` (`string`): Set the `table_type` field on the resulting object. When `null`, the `table_type` field will be omitted from the resulting object.\n - `view_expanded_text` (`string`): Set the `view_expanded_text` field on the resulting object. When `null`, the `view_expanded_text` field will be omitted from the resulting object.\n - `view_original_text` (`string`): Set the `view_original_text` field on the resulting object. When `null`, the `view_original_text` field will be omitted from the resulting object.\n - `open_table_format_input` (`list[obj]`): Set the `open_table_format_input` field on the resulting object. When `null`, the `open_table_format_input` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [aws.glue_catalog_table.open_table_format_input.new](#fn-open_table_format_inputnew) constructor.\n - `partition_index` (`list[obj]`): Set the `partition_index` field on the resulting object. When `null`, the `partition_index` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [aws.glue_catalog_table.partition_index.new](#fn-partition_indexnew) constructor.\n - `partition_keys` (`list[obj]`): Set the `partition_keys` field on the resulting object. When `null`, the `partition_keys` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [aws.glue_catalog_table.partition_keys.new](#fn-partition_keysnew) constructor.\n - `storage_descriptor` (`list[obj]`): Set the `storage_descriptor` field on the resulting object. When `null`, the `storage_descriptor` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [aws.glue_catalog_table.storage_descriptor.new](#fn-storage_descriptornew) constructor.\n - `target_table` (`list[obj]`): Set the `target_table` field on the resulting object. When `null`, the `target_table` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [aws.glue_catalog_table.target_table.new](#fn-target_tablenew) constructor.\n\n**Returns**:\n - An attribute object that can be used with [tf.withResource](https://github.com/tf-libsonnet/core/tree/main/docs#fn-withresource) to construct a new `glue_catalog_table` resource into the root Terraform configuration.\n', args=[]), newAttrs( database_name, name, catalog_id=null, description=null, + open_table_format_input=null, owner=null, parameters=null, partition_index=null, @@ -62,6 +65,7 @@ local d = (import 'github.com/jsonnet-libs/docsonnet/doc-util/main.libsonnet'); database_name: database_name, description: description, name: name, + open_table_format_input: open_table_format_input, owner: owner, parameters: parameters, partition_index: partition_index, @@ -73,6 +77,24 @@ local d = (import 'github.com/jsonnet-libs/docsonnet/doc-util/main.libsonnet'); view_expanded_text: view_expanded_text, view_original_text: view_original_text, }), + open_table_format_input:: { + iceberg_input:: { + '#new':: d.fn(help='\n`aws.glue_catalog_table.open_table_format_input.iceberg_input.new` constructs a new object with attributes and blocks configured for the `iceberg_input`\nTerraform sub block.\n\n\n\n**Args**:\n - `metadata_operation` (`string`): Set the `metadata_operation` field on the resulting object.\n - `version` (`string`): Set the `version` field on the resulting object. When `null`, the `version` field will be omitted from the resulting object.\n\n**Returns**:\n - An attribute object that represents the `iceberg_input` sub block.\n', args=[]), + new( + metadata_operation, + version=null + ):: std.prune(a={ + metadata_operation: metadata_operation, + version: version, + }), + }, + '#new':: d.fn(help='\n`aws.glue_catalog_table.open_table_format_input.new` constructs a new object with attributes and blocks configured for the `open_table_format_input`\nTerraform sub block.\n\n\n\n**Args**:\n - `iceberg_input` (`list[obj]`): Set the `iceberg_input` field on the resulting object. When `null`, the `iceberg_input` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [aws.glue_catalog_table.open_table_format_input.iceberg_input.new](#fn-open_table_format_inputiceberg_inputnew) constructor.\n\n**Returns**:\n - An attribute object that represents the `open_table_format_input` sub block.\n', args=[]), + new( + iceberg_input=null + ):: std.prune(a={ + iceberg_input: iceberg_input, + }), + }, partition_index:: { '#new':: d.fn(help='\n`aws.glue_catalog_table.partition_index.new` constructs a new object with attributes and blocks configured for the `partition_index`\nTerraform sub block.\n\n\n\n**Args**:\n - `index_name` (`string`): Set the `index_name` field on the resulting object.\n - `keys` (`list`): Set the `keys` field on the resulting object.\n\n**Returns**:\n - An attribute object that represents the `partition_index` sub block.\n', args=[]), new( @@ -251,6 +273,26 @@ local d = (import 'github.com/jsonnet-libs/docsonnet/doc-util/main.libsonnet'); }, }, }, + '#withOpenTableFormatInput':: d.fn(help='`aws.list[obj].withOpenTableFormatInput` constructs a mixin object that can be merged into the `list[obj]`\nTerraform resource block to set or update the open_table_format_input field.\n\nThis function will replace the array with the passed in `value`. If you wish to instead append the\npassed in value to the existing array, use the [aws.list[obj].withOpenTableFormatInputMixin](TODO) function.\n\n\n**Args**:\n - `resourceLabel` (`string`): The name label of the block to update.\n - `value` (`list[obj]`): The value to set for the `open_table_format_input` field.\n', args=[]), + withOpenTableFormatInput(resourceLabel, value): { + resource+: { + aws_glue_catalog_table+: { + [resourceLabel]+: { + open_table_format_input: value, + }, + }, + }, + }, + '#withOpenTableFormatInputMixin':: d.fn(help='`aws.list[obj].withOpenTableFormatInputMixin` constructs a mixin object that can be merged into the `list[obj]`\nTerraform resource block to set or update the open_table_format_input field.\n\nThis function will append the passed in array or object to the existing array. If you wish\nto instead replace the array with the passed in `value`, use the [aws.list[obj].withOpenTableFormatInput](TODO)\nfunction.\n\n\n**Args**:\n - `resourceLabel` (`string`): The name label of the block to update.\n - `value` (`list[obj]`): The value to set for the `open_table_format_input` field.\n', args=[]), + withOpenTableFormatInputMixin(resourceLabel, value): { + resource+: { + aws_glue_catalog_table+: { + [resourceLabel]+: { + open_table_format_input+: if std.isArray(v=value) then value else [value], + }, + }, + }, + }, '#withOwner':: d.fn(help='`aws.string.withOwner` constructs a mixin object that can be merged into the `string`\nTerraform resource block to set or update the owner field.\n\n\n\n**Args**:\n - `resourceLabel` (`string`): The name label of the block to update.\n - `value` (`string`): The value to set for the `owner` field.\n', args=[]), withOwner(resourceLabel, value): { resource+: { diff --git a/5.x/_gen/resources/imagebuilder_image_pipeline.libsonnet b/5.x/_gen/resources/imagebuilder_image_pipeline.libsonnet index faa25412..944ca7f6 100644 --- a/5.x/_gen/resources/imagebuilder_image_pipeline.libsonnet +++ b/5.x/_gen/resources/imagebuilder_image_pipeline.libsonnet @@ -2,6 +2,26 @@ local tf = (import 'github.com/tf-libsonnet/core/main.libsonnet'); local d = (import 'github.com/jsonnet-libs/docsonnet/doc-util/main.libsonnet'); { '#':: d.pkg(name='imagebuilder_image_pipeline', url='', help='`imagebuilder_image_pipeline` represents the `aws_imagebuilder_image_pipeline` Terraform resource.\n\n\n\nThis package contains functions and utilities for setting up the resource using Jsonnet code.\n'), + image_scanning_configuration:: { + ecr_configuration:: { + '#new':: d.fn(help='\n`aws.imagebuilder_image_pipeline.image_scanning_configuration.ecr_configuration.new` constructs a new object with attributes and blocks configured for the `ecr_configuration`\nTerraform sub block.\n\n\n\n**Args**:\n - `container_tags` (`list`): Set the `container_tags` field on the resulting object. When `null`, the `container_tags` field will be omitted from the resulting object.\n - `repository_name` (`string`): Set the `repository_name` field on the resulting object. When `null`, the `repository_name` field will be omitted from the resulting object.\n\n**Returns**:\n - An attribute object that represents the `ecr_configuration` sub block.\n', args=[]), + new( + container_tags=null, + repository_name=null + ):: std.prune(a={ + container_tags: container_tags, + repository_name: repository_name, + }), + }, + '#new':: d.fn(help='\n`aws.imagebuilder_image_pipeline.image_scanning_configuration.new` constructs a new object with attributes and blocks configured for the `image_scanning_configuration`\nTerraform sub block.\n\n\n\n**Args**:\n - `image_scanning_enabled` (`bool`): Set the `image_scanning_enabled` field on the resulting object. When `null`, the `image_scanning_enabled` field will be omitted from the resulting object.\n - `ecr_configuration` (`list[obj]`): Set the `ecr_configuration` field on the resulting object. When `null`, the `ecr_configuration` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [aws.imagebuilder_image_pipeline.image_scanning_configuration.ecr_configuration.new](#fn-image_scanning_configurationecr_configurationnew) constructor.\n\n**Returns**:\n - An attribute object that represents the `image_scanning_configuration` sub block.\n', args=[]), + new( + ecr_configuration=null, + image_scanning_enabled=null + ):: std.prune(a={ + ecr_configuration: ecr_configuration, + image_scanning_enabled: image_scanning_enabled, + }), + }, image_tests_configuration:: { '#new':: d.fn(help='\n`aws.imagebuilder_image_pipeline.image_tests_configuration.new` constructs a new object with attributes and blocks configured for the `image_tests_configuration`\nTerraform sub block.\n\n\n\n**Args**:\n - `image_tests_enabled` (`bool`): Set the `image_tests_enabled` field on the resulting object. When `null`, the `image_tests_enabled` field will be omitted from the resulting object.\n - `timeout_minutes` (`number`): Set the `timeout_minutes` field on the resulting object. When `null`, the `timeout_minutes` field will be omitted from the resulting object.\n\n**Returns**:\n - An attribute object that represents the `image_tests_configuration` sub block.\n', args=[]), new( @@ -12,7 +32,7 @@ local d = (import 'github.com/jsonnet-libs/docsonnet/doc-util/main.libsonnet'); timeout_minutes: timeout_minutes, }), }, - '#new':: d.fn(help="\n`aws.imagebuilder_image_pipeline.new` injects a new `aws_imagebuilder_image_pipeline` Terraform `resource`\nblock into the root module document.\n\nAdditionally, this inserts a private function into the `_ref` attribute that generates references to attributes of the\nresource. For example, if you added a new instance to the root using:\n\n # arguments omitted for brevity\n aws.imagebuilder_image_pipeline.new('some_id')\n\nYou can get the reference to the `id` field of the created `aws.imagebuilder_image_pipeline` using the reference:\n\n $._ref.aws_imagebuilder_image_pipeline.some_id.get('id')\n\nThis is the same as directly entering `\"${ aws_imagebuilder_image_pipeline.some_id.id }\"` as the value.\n\nNOTE: if you are chaining multiple resources together in a merge operation, you may not be able to use `super`, `self`,\nor `$` to refer to the root object. Instead, make an explicit outer object using `local`.\n\n**Args**:\n - `resourceLabel` (`string`): The name label of the block.\n - `container_recipe_arn` (`string`): Set the `container_recipe_arn` field on the resulting resource block. When `null`, the `container_recipe_arn` field will be omitted from the resulting object.\n - `description` (`string`): Set the `description` field on the resulting resource block. When `null`, the `description` field will be omitted from the resulting object.\n - `distribution_configuration_arn` (`string`): Set the `distribution_configuration_arn` field on the resulting resource block. When `null`, the `distribution_configuration_arn` field will be omitted from the resulting object.\n - `enhanced_image_metadata_enabled` (`bool`): Set the `enhanced_image_metadata_enabled` field on the resulting resource block. When `null`, the `enhanced_image_metadata_enabled` field will be omitted from the resulting object.\n - `image_recipe_arn` (`string`): Set the `image_recipe_arn` field on the resulting resource block. When `null`, the `image_recipe_arn` field will be omitted from the resulting object.\n - `infrastructure_configuration_arn` (`string`): Set the `infrastructure_configuration_arn` field on the resulting resource block.\n - `name` (`string`): Set the `name` field on the resulting resource block.\n - `status` (`string`): Set the `status` field on the resulting resource block. When `null`, the `status` field will be omitted from the resulting object.\n - `tags` (`obj`): Set the `tags` field on the resulting resource block. When `null`, the `tags` field will be omitted from the resulting object.\n - `tags_all` (`obj`): Set the `tags_all` field on the resulting resource block. When `null`, the `tags_all` field will be omitted from the resulting object.\n - `image_tests_configuration` (`list[obj]`): Set the `image_tests_configuration` field on the resulting resource block. When `null`, the `image_tests_configuration` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [aws.imagebuilder_image_pipeline.image_tests_configuration.new](#fn-image_tests_configurationnew) constructor.\n - `schedule` (`list[obj]`): Set the `schedule` field on the resulting resource block. When `null`, the `schedule` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [aws.imagebuilder_image_pipeline.schedule.new](#fn-schedulenew) constructor.\n\n**Returns**:\n- A mixin object that injects the new resource into the root Terraform configuration.\n", args=[]), + '#new':: d.fn(help="\n`aws.imagebuilder_image_pipeline.new` injects a new `aws_imagebuilder_image_pipeline` Terraform `resource`\nblock into the root module document.\n\nAdditionally, this inserts a private function into the `_ref` attribute that generates references to attributes of the\nresource. For example, if you added a new instance to the root using:\n\n # arguments omitted for brevity\n aws.imagebuilder_image_pipeline.new('some_id')\n\nYou can get the reference to the `id` field of the created `aws.imagebuilder_image_pipeline` using the reference:\n\n $._ref.aws_imagebuilder_image_pipeline.some_id.get('id')\n\nThis is the same as directly entering `\"${ aws_imagebuilder_image_pipeline.some_id.id }\"` as the value.\n\nNOTE: if you are chaining multiple resources together in a merge operation, you may not be able to use `super`, `self`,\nor `$` to refer to the root object. Instead, make an explicit outer object using `local`.\n\n**Args**:\n - `resourceLabel` (`string`): The name label of the block.\n - `container_recipe_arn` (`string`): Set the `container_recipe_arn` field on the resulting resource block. When `null`, the `container_recipe_arn` field will be omitted from the resulting object.\n - `description` (`string`): Set the `description` field on the resulting resource block. When `null`, the `description` field will be omitted from the resulting object.\n - `distribution_configuration_arn` (`string`): Set the `distribution_configuration_arn` field on the resulting resource block. When `null`, the `distribution_configuration_arn` field will be omitted from the resulting object.\n - `enhanced_image_metadata_enabled` (`bool`): Set the `enhanced_image_metadata_enabled` field on the resulting resource block. When `null`, the `enhanced_image_metadata_enabled` field will be omitted from the resulting object.\n - `image_recipe_arn` (`string`): Set the `image_recipe_arn` field on the resulting resource block. When `null`, the `image_recipe_arn` field will be omitted from the resulting object.\n - `infrastructure_configuration_arn` (`string`): Set the `infrastructure_configuration_arn` field on the resulting resource block.\n - `name` (`string`): Set the `name` field on the resulting resource block.\n - `status` (`string`): Set the `status` field on the resulting resource block. When `null`, the `status` field will be omitted from the resulting object.\n - `tags` (`obj`): Set the `tags` field on the resulting resource block. When `null`, the `tags` field will be omitted from the resulting object.\n - `tags_all` (`obj`): Set the `tags_all` field on the resulting resource block. When `null`, the `tags_all` field will be omitted from the resulting object.\n - `image_scanning_configuration` (`list[obj]`): Set the `image_scanning_configuration` field on the resulting resource block. When `null`, the `image_scanning_configuration` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [aws.imagebuilder_image_pipeline.image_scanning_configuration.new](#fn-image_scanning_configurationnew) constructor.\n - `image_tests_configuration` (`list[obj]`): Set the `image_tests_configuration` field on the resulting resource block. When `null`, the `image_tests_configuration` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [aws.imagebuilder_image_pipeline.image_tests_configuration.new](#fn-image_tests_configurationnew) constructor.\n - `schedule` (`list[obj]`): Set the `schedule` field on the resulting resource block. When `null`, the `schedule` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [aws.imagebuilder_image_pipeline.schedule.new](#fn-schedulenew) constructor.\n\n**Returns**:\n- A mixin object that injects the new resource into the root Terraform configuration.\n", args=[]), new( resourceLabel, infrastructure_configuration_arn, @@ -22,6 +42,7 @@ local d = (import 'github.com/jsonnet-libs/docsonnet/doc-util/main.libsonnet'); distribution_configuration_arn=null, enhanced_image_metadata_enabled=null, image_recipe_arn=null, + image_scanning_configuration=null, image_tests_configuration=null, schedule=null, status=null, @@ -37,6 +58,7 @@ local d = (import 'github.com/jsonnet-libs/docsonnet/doc-util/main.libsonnet'); distribution_configuration_arn=distribution_configuration_arn, enhanced_image_metadata_enabled=enhanced_image_metadata_enabled, image_recipe_arn=image_recipe_arn, + image_scanning_configuration=image_scanning_configuration, image_tests_configuration=image_tests_configuration, infrastructure_configuration_arn=infrastructure_configuration_arn, name=name, @@ -47,7 +69,7 @@ local d = (import 'github.com/jsonnet-libs/docsonnet/doc-util/main.libsonnet'); ), _meta=_meta ), - '#newAttrs':: d.fn(help='\n`aws.imagebuilder_image_pipeline.newAttrs` constructs a new object with attributes and blocks configured for the `imagebuilder_image_pipeline`\nTerraform resource.\n\nUnlike [aws.imagebuilder_image_pipeline.new](#fn-new), this function will not inject the `resource`\nblock into the root Terraform document. Instead, this must be passed in as the `attrs` argument for the\n[tf.withResource](https://github.com/tf-libsonnet/core/tree/main/docs#fn-withresource) function to build a complete block.\n\nThis is most useful when you need to preprocess the attributes with functions, conditional, or looping logic prior to\ninjecting into a complete block.\n\n**Args**:\n - `container_recipe_arn` (`string`): Set the `container_recipe_arn` field on the resulting object. When `null`, the `container_recipe_arn` field will be omitted from the resulting object.\n - `description` (`string`): Set the `description` field on the resulting object. When `null`, the `description` field will be omitted from the resulting object.\n - `distribution_configuration_arn` (`string`): Set the `distribution_configuration_arn` field on the resulting object. When `null`, the `distribution_configuration_arn` field will be omitted from the resulting object.\n - `enhanced_image_metadata_enabled` (`bool`): Set the `enhanced_image_metadata_enabled` field on the resulting object. When `null`, the `enhanced_image_metadata_enabled` field will be omitted from the resulting object.\n - `image_recipe_arn` (`string`): Set the `image_recipe_arn` field on the resulting object. When `null`, the `image_recipe_arn` field will be omitted from the resulting object.\n - `infrastructure_configuration_arn` (`string`): Set the `infrastructure_configuration_arn` field on the resulting object.\n - `name` (`string`): Set the `name` field on the resulting object.\n - `status` (`string`): Set the `status` field on the resulting object. When `null`, the `status` field will be omitted from the resulting object.\n - `tags` (`obj`): Set the `tags` field on the resulting object. When `null`, the `tags` field will be omitted from the resulting object.\n - `tags_all` (`obj`): Set the `tags_all` field on the resulting object. When `null`, the `tags_all` field will be omitted from the resulting object.\n - `image_tests_configuration` (`list[obj]`): Set the `image_tests_configuration` field on the resulting object. When `null`, the `image_tests_configuration` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [aws.imagebuilder_image_pipeline.image_tests_configuration.new](#fn-image_tests_configurationnew) constructor.\n - `schedule` (`list[obj]`): Set the `schedule` field on the resulting object. When `null`, the `schedule` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [aws.imagebuilder_image_pipeline.schedule.new](#fn-schedulenew) constructor.\n\n**Returns**:\n - An attribute object that can be used with [tf.withResource](https://github.com/tf-libsonnet/core/tree/main/docs#fn-withresource) to construct a new `imagebuilder_image_pipeline` resource into the root Terraform configuration.\n', args=[]), + '#newAttrs':: d.fn(help='\n`aws.imagebuilder_image_pipeline.newAttrs` constructs a new object with attributes and blocks configured for the `imagebuilder_image_pipeline`\nTerraform resource.\n\nUnlike [aws.imagebuilder_image_pipeline.new](#fn-new), this function will not inject the `resource`\nblock into the root Terraform document. Instead, this must be passed in as the `attrs` argument for the\n[tf.withResource](https://github.com/tf-libsonnet/core/tree/main/docs#fn-withresource) function to build a complete block.\n\nThis is most useful when you need to preprocess the attributes with functions, conditional, or looping logic prior to\ninjecting into a complete block.\n\n**Args**:\n - `container_recipe_arn` (`string`): Set the `container_recipe_arn` field on the resulting object. When `null`, the `container_recipe_arn` field will be omitted from the resulting object.\n - `description` (`string`): Set the `description` field on the resulting object. When `null`, the `description` field will be omitted from the resulting object.\n - `distribution_configuration_arn` (`string`): Set the `distribution_configuration_arn` field on the resulting object. When `null`, the `distribution_configuration_arn` field will be omitted from the resulting object.\n - `enhanced_image_metadata_enabled` (`bool`): Set the `enhanced_image_metadata_enabled` field on the resulting object. When `null`, the `enhanced_image_metadata_enabled` field will be omitted from the resulting object.\n - `image_recipe_arn` (`string`): Set the `image_recipe_arn` field on the resulting object. When `null`, the `image_recipe_arn` field will be omitted from the resulting object.\n - `infrastructure_configuration_arn` (`string`): Set the `infrastructure_configuration_arn` field on the resulting object.\n - `name` (`string`): Set the `name` field on the resulting object.\n - `status` (`string`): Set the `status` field on the resulting object. When `null`, the `status` field will be omitted from the resulting object.\n - `tags` (`obj`): Set the `tags` field on the resulting object. When `null`, the `tags` field will be omitted from the resulting object.\n - `tags_all` (`obj`): Set the `tags_all` field on the resulting object. When `null`, the `tags_all` field will be omitted from the resulting object.\n - `image_scanning_configuration` (`list[obj]`): Set the `image_scanning_configuration` field on the resulting object. When `null`, the `image_scanning_configuration` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [aws.imagebuilder_image_pipeline.image_scanning_configuration.new](#fn-image_scanning_configurationnew) constructor.\n - `image_tests_configuration` (`list[obj]`): Set the `image_tests_configuration` field on the resulting object. When `null`, the `image_tests_configuration` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [aws.imagebuilder_image_pipeline.image_tests_configuration.new](#fn-image_tests_configurationnew) constructor.\n - `schedule` (`list[obj]`): Set the `schedule` field on the resulting object. When `null`, the `schedule` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [aws.imagebuilder_image_pipeline.schedule.new](#fn-schedulenew) constructor.\n\n**Returns**:\n - An attribute object that can be used with [tf.withResource](https://github.com/tf-libsonnet/core/tree/main/docs#fn-withresource) to construct a new `imagebuilder_image_pipeline` resource into the root Terraform configuration.\n', args=[]), newAttrs( infrastructure_configuration_arn, name, @@ -56,6 +78,7 @@ local d = (import 'github.com/jsonnet-libs/docsonnet/doc-util/main.libsonnet'); distribution_configuration_arn=null, enhanced_image_metadata_enabled=null, image_recipe_arn=null, + image_scanning_configuration=null, image_tests_configuration=null, schedule=null, status=null, @@ -67,6 +90,7 @@ local d = (import 'github.com/jsonnet-libs/docsonnet/doc-util/main.libsonnet'); distribution_configuration_arn: distribution_configuration_arn, enhanced_image_metadata_enabled: enhanced_image_metadata_enabled, image_recipe_arn: image_recipe_arn, + image_scanning_configuration: image_scanning_configuration, image_tests_configuration: image_tests_configuration, infrastructure_configuration_arn: infrastructure_configuration_arn, name: name, @@ -137,6 +161,26 @@ local d = (import 'github.com/jsonnet-libs/docsonnet/doc-util/main.libsonnet'); }, }, }, + '#withImageScanningConfiguration':: d.fn(help='`aws.list[obj].withImageScanningConfiguration` constructs a mixin object that can be merged into the `list[obj]`\nTerraform resource block to set or update the image_scanning_configuration field.\n\nThis function will replace the array with the passed in `value`. If you wish to instead append the\npassed in value to the existing array, use the [aws.list[obj].withImageScanningConfigurationMixin](TODO) function.\n\n\n**Args**:\n - `resourceLabel` (`string`): The name label of the block to update.\n - `value` (`list[obj]`): The value to set for the `image_scanning_configuration` field.\n', args=[]), + withImageScanningConfiguration(resourceLabel, value): { + resource+: { + aws_imagebuilder_image_pipeline+: { + [resourceLabel]+: { + image_scanning_configuration: value, + }, + }, + }, + }, + '#withImageScanningConfigurationMixin':: d.fn(help='`aws.list[obj].withImageScanningConfigurationMixin` constructs a mixin object that can be merged into the `list[obj]`\nTerraform resource block to set or update the image_scanning_configuration field.\n\nThis function will append the passed in array or object to the existing array. If you wish\nto instead replace the array with the passed in `value`, use the [aws.list[obj].withImageScanningConfiguration](TODO)\nfunction.\n\n\n**Args**:\n - `resourceLabel` (`string`): The name label of the block to update.\n - `value` (`list[obj]`): The value to set for the `image_scanning_configuration` field.\n', args=[]), + withImageScanningConfigurationMixin(resourceLabel, value): { + resource+: { + aws_imagebuilder_image_pipeline+: { + [resourceLabel]+: { + image_scanning_configuration+: if std.isArray(v=value) then value else [value], + }, + }, + }, + }, '#withImageTestsConfiguration':: d.fn(help='`aws.list[obj].withImageTestsConfiguration` constructs a mixin object that can be merged into the `list[obj]`\nTerraform resource block to set or update the image_tests_configuration field.\n\nThis function will replace the array with the passed in `value`. If you wish to instead append the\npassed in value to the existing array, use the [aws.list[obj].withImageTestsConfigurationMixin](TODO) function.\n\n\n**Args**:\n - `resourceLabel` (`string`): The name label of the block to update.\n - `value` (`list[obj]`): The value to set for the `image_tests_configuration` field.\n', args=[]), withImageTestsConfiguration(resourceLabel, value): { resource+: { diff --git a/5.x/_gen/resources/lakeformation_data_lake_settings.libsonnet b/5.x/_gen/resources/lakeformation_data_lake_settings.libsonnet index f1d0a7ac..69ae4a50 100644 --- a/5.x/_gen/resources/lakeformation_data_lake_settings.libsonnet +++ b/5.x/_gen/resources/lakeformation_data_lake_settings.libsonnet @@ -22,7 +22,7 @@ local d = (import 'github.com/jsonnet-libs/docsonnet/doc-util/main.libsonnet'); principal: principal, }), }, - '#new':: d.fn(help="\n`aws.lakeformation_data_lake_settings.new` injects a new `aws_lakeformation_data_lake_settings` Terraform `resource`\nblock into the root module document.\n\nAdditionally, this inserts a private function into the `_ref` attribute that generates references to attributes of the\nresource. For example, if you added a new instance to the root using:\n\n # arguments omitted for brevity\n aws.lakeformation_data_lake_settings.new('some_id')\n\nYou can get the reference to the `id` field of the created `aws.lakeformation_data_lake_settings` using the reference:\n\n $._ref.aws_lakeformation_data_lake_settings.some_id.get('id')\n\nThis is the same as directly entering `\"${ aws_lakeformation_data_lake_settings.some_id.id }\"` as the value.\n\nNOTE: if you are chaining multiple resources together in a merge operation, you may not be able to use `super`, `self`,\nor `$` to refer to the root object. Instead, make an explicit outer object using `local`.\n\n**Args**:\n - `resourceLabel` (`string`): The name label of the block.\n - `admins` (`list`): Set the `admins` field on the resulting resource block. When `null`, the `admins` field will be omitted from the resulting object.\n - `allow_external_data_filtering` (`bool`): Set the `allow_external_data_filtering` field on the resulting resource block. When `null`, the `allow_external_data_filtering` field will be omitted from the resulting object.\n - `authorized_session_tag_value_list` (`list`): Set the `authorized_session_tag_value_list` field on the resulting resource block. When `null`, the `authorized_session_tag_value_list` field will be omitted from the resulting object.\n - `catalog_id` (`string`): Set the `catalog_id` field on the resulting resource block. When `null`, the `catalog_id` field will be omitted from the resulting object.\n - `external_data_filtering_allow_list` (`list`): Set the `external_data_filtering_allow_list` field on the resulting resource block. When `null`, the `external_data_filtering_allow_list` field will be omitted from the resulting object.\n - `trusted_resource_owners` (`list`): Set the `trusted_resource_owners` field on the resulting resource block. When `null`, the `trusted_resource_owners` field will be omitted from the resulting object.\n - `create_database_default_permissions` (`list[obj]`): Set the `create_database_default_permissions` field on the resulting resource block. When `null`, the `create_database_default_permissions` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [aws.lakeformation_data_lake_settings.create_database_default_permissions.new](#fn-create_database_default_permissionsnew) constructor.\n - `create_table_default_permissions` (`list[obj]`): Set the `create_table_default_permissions` field on the resulting resource block. When `null`, the `create_table_default_permissions` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [aws.lakeformation_data_lake_settings.create_table_default_permissions.new](#fn-create_table_default_permissionsnew) constructor.\n\n**Returns**:\n- A mixin object that injects the new resource into the root Terraform configuration.\n", args=[]), + '#new':: d.fn(help="\n`aws.lakeformation_data_lake_settings.new` injects a new `aws_lakeformation_data_lake_settings` Terraform `resource`\nblock into the root module document.\n\nAdditionally, this inserts a private function into the `_ref` attribute that generates references to attributes of the\nresource. For example, if you added a new instance to the root using:\n\n # arguments omitted for brevity\n aws.lakeformation_data_lake_settings.new('some_id')\n\nYou can get the reference to the `id` field of the created `aws.lakeformation_data_lake_settings` using the reference:\n\n $._ref.aws_lakeformation_data_lake_settings.some_id.get('id')\n\nThis is the same as directly entering `\"${ aws_lakeformation_data_lake_settings.some_id.id }\"` as the value.\n\nNOTE: if you are chaining multiple resources together in a merge operation, you may not be able to use `super`, `self`,\nor `$` to refer to the root object. Instead, make an explicit outer object using `local`.\n\n**Args**:\n - `resourceLabel` (`string`): The name label of the block.\n - `admins` (`list`): Set the `admins` field on the resulting resource block. When `null`, the `admins` field will be omitted from the resulting object.\n - `allow_external_data_filtering` (`bool`): Set the `allow_external_data_filtering` field on the resulting resource block. When `null`, the `allow_external_data_filtering` field will be omitted from the resulting object.\n - `authorized_session_tag_value_list` (`list`): Set the `authorized_session_tag_value_list` field on the resulting resource block. When `null`, the `authorized_session_tag_value_list` field will be omitted from the resulting object.\n - `catalog_id` (`string`): Set the `catalog_id` field on the resulting resource block. When `null`, the `catalog_id` field will be omitted from the resulting object.\n - `external_data_filtering_allow_list` (`list`): Set the `external_data_filtering_allow_list` field on the resulting resource block. When `null`, the `external_data_filtering_allow_list` field will be omitted from the resulting object.\n - `read_only_admins` (`list`): Set the `read_only_admins` field on the resulting resource block. When `null`, the `read_only_admins` field will be omitted from the resulting object.\n - `trusted_resource_owners` (`list`): Set the `trusted_resource_owners` field on the resulting resource block. When `null`, the `trusted_resource_owners` field will be omitted from the resulting object.\n - `create_database_default_permissions` (`list[obj]`): Set the `create_database_default_permissions` field on the resulting resource block. When `null`, the `create_database_default_permissions` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [aws.lakeformation_data_lake_settings.create_database_default_permissions.new](#fn-create_database_default_permissionsnew) constructor.\n - `create_table_default_permissions` (`list[obj]`): Set the `create_table_default_permissions` field on the resulting resource block. When `null`, the `create_table_default_permissions` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [aws.lakeformation_data_lake_settings.create_table_default_permissions.new](#fn-create_table_default_permissionsnew) constructor.\n\n**Returns**:\n- A mixin object that injects the new resource into the root Terraform configuration.\n", args=[]), new( resourceLabel, admins=null, @@ -32,6 +32,7 @@ local d = (import 'github.com/jsonnet-libs/docsonnet/doc-util/main.libsonnet'); create_database_default_permissions=null, create_table_default_permissions=null, external_data_filtering_allow_list=null, + read_only_admins=null, trusted_resource_owners=null, _meta={} ):: tf.withResource( @@ -45,11 +46,12 @@ local d = (import 'github.com/jsonnet-libs/docsonnet/doc-util/main.libsonnet'); create_database_default_permissions=create_database_default_permissions, create_table_default_permissions=create_table_default_permissions, external_data_filtering_allow_list=external_data_filtering_allow_list, + read_only_admins=read_only_admins, trusted_resource_owners=trusted_resource_owners ), _meta=_meta ), - '#newAttrs':: d.fn(help='\n`aws.lakeformation_data_lake_settings.newAttrs` constructs a new object with attributes and blocks configured for the `lakeformation_data_lake_settings`\nTerraform resource.\n\nUnlike [aws.lakeformation_data_lake_settings.new](#fn-new), this function will not inject the `resource`\nblock into the root Terraform document. Instead, this must be passed in as the `attrs` argument for the\n[tf.withResource](https://github.com/tf-libsonnet/core/tree/main/docs#fn-withresource) function to build a complete block.\n\nThis is most useful when you need to preprocess the attributes with functions, conditional, or looping logic prior to\ninjecting into a complete block.\n\n**Args**:\n - `admins` (`list`): Set the `admins` field on the resulting object. When `null`, the `admins` field will be omitted from the resulting object.\n - `allow_external_data_filtering` (`bool`): Set the `allow_external_data_filtering` field on the resulting object. When `null`, the `allow_external_data_filtering` field will be omitted from the resulting object.\n - `authorized_session_tag_value_list` (`list`): Set the `authorized_session_tag_value_list` field on the resulting object. When `null`, the `authorized_session_tag_value_list` field will be omitted from the resulting object.\n - `catalog_id` (`string`): Set the `catalog_id` field on the resulting object. When `null`, the `catalog_id` field will be omitted from the resulting object.\n - `external_data_filtering_allow_list` (`list`): Set the `external_data_filtering_allow_list` field on the resulting object. When `null`, the `external_data_filtering_allow_list` field will be omitted from the resulting object.\n - `trusted_resource_owners` (`list`): Set the `trusted_resource_owners` field on the resulting object. When `null`, the `trusted_resource_owners` field will be omitted from the resulting object.\n - `create_database_default_permissions` (`list[obj]`): Set the `create_database_default_permissions` field on the resulting object. When `null`, the `create_database_default_permissions` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [aws.lakeformation_data_lake_settings.create_database_default_permissions.new](#fn-create_database_default_permissionsnew) constructor.\n - `create_table_default_permissions` (`list[obj]`): Set the `create_table_default_permissions` field on the resulting object. When `null`, the `create_table_default_permissions` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [aws.lakeformation_data_lake_settings.create_table_default_permissions.new](#fn-create_table_default_permissionsnew) constructor.\n\n**Returns**:\n - An attribute object that can be used with [tf.withResource](https://github.com/tf-libsonnet/core/tree/main/docs#fn-withresource) to construct a new `lakeformation_data_lake_settings` resource into the root Terraform configuration.\n', args=[]), + '#newAttrs':: d.fn(help='\n`aws.lakeformation_data_lake_settings.newAttrs` constructs a new object with attributes and blocks configured for the `lakeformation_data_lake_settings`\nTerraform resource.\n\nUnlike [aws.lakeformation_data_lake_settings.new](#fn-new), this function will not inject the `resource`\nblock into the root Terraform document. Instead, this must be passed in as the `attrs` argument for the\n[tf.withResource](https://github.com/tf-libsonnet/core/tree/main/docs#fn-withresource) function to build a complete block.\n\nThis is most useful when you need to preprocess the attributes with functions, conditional, or looping logic prior to\ninjecting into a complete block.\n\n**Args**:\n - `admins` (`list`): Set the `admins` field on the resulting object. When `null`, the `admins` field will be omitted from the resulting object.\n - `allow_external_data_filtering` (`bool`): Set the `allow_external_data_filtering` field on the resulting object. When `null`, the `allow_external_data_filtering` field will be omitted from the resulting object.\n - `authorized_session_tag_value_list` (`list`): Set the `authorized_session_tag_value_list` field on the resulting object. When `null`, the `authorized_session_tag_value_list` field will be omitted from the resulting object.\n - `catalog_id` (`string`): Set the `catalog_id` field on the resulting object. When `null`, the `catalog_id` field will be omitted from the resulting object.\n - `external_data_filtering_allow_list` (`list`): Set the `external_data_filtering_allow_list` field on the resulting object. When `null`, the `external_data_filtering_allow_list` field will be omitted from the resulting object.\n - `read_only_admins` (`list`): Set the `read_only_admins` field on the resulting object. When `null`, the `read_only_admins` field will be omitted from the resulting object.\n - `trusted_resource_owners` (`list`): Set the `trusted_resource_owners` field on the resulting object. When `null`, the `trusted_resource_owners` field will be omitted from the resulting object.\n - `create_database_default_permissions` (`list[obj]`): Set the `create_database_default_permissions` field on the resulting object. When `null`, the `create_database_default_permissions` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [aws.lakeformation_data_lake_settings.create_database_default_permissions.new](#fn-create_database_default_permissionsnew) constructor.\n - `create_table_default_permissions` (`list[obj]`): Set the `create_table_default_permissions` field on the resulting object. When `null`, the `create_table_default_permissions` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [aws.lakeformation_data_lake_settings.create_table_default_permissions.new](#fn-create_table_default_permissionsnew) constructor.\n\n**Returns**:\n - An attribute object that can be used with [tf.withResource](https://github.com/tf-libsonnet/core/tree/main/docs#fn-withresource) to construct a new `lakeformation_data_lake_settings` resource into the root Terraform configuration.\n', args=[]), newAttrs( admins=null, allow_external_data_filtering=null, @@ -58,6 +60,7 @@ local d = (import 'github.com/jsonnet-libs/docsonnet/doc-util/main.libsonnet'); create_database_default_permissions=null, create_table_default_permissions=null, external_data_filtering_allow_list=null, + read_only_admins=null, trusted_resource_owners=null ):: std.prune(a={ admins: admins, @@ -67,6 +70,7 @@ local d = (import 'github.com/jsonnet-libs/docsonnet/doc-util/main.libsonnet'); create_database_default_permissions: create_database_default_permissions, create_table_default_permissions: create_table_default_permissions, external_data_filtering_allow_list: external_data_filtering_allow_list, + read_only_admins: read_only_admins, trusted_resource_owners: trusted_resource_owners, }), '#withAdmins':: d.fn(help='`aws.list.withAdmins` constructs a mixin object that can be merged into the `list`\nTerraform resource block to set or update the admins field.\n\n\n\n**Args**:\n - `resourceLabel` (`string`): The name label of the block to update.\n - `value` (`list`): The value to set for the `admins` field.\n', args=[]), @@ -159,6 +163,16 @@ local d = (import 'github.com/jsonnet-libs/docsonnet/doc-util/main.libsonnet'); }, }, }, + '#withReadOnlyAdmins':: d.fn(help='`aws.list.withReadOnlyAdmins` constructs a mixin object that can be merged into the `list`\nTerraform resource block to set or update the read_only_admins field.\n\n\n\n**Args**:\n - `resourceLabel` (`string`): The name label of the block to update.\n - `value` (`list`): The value to set for the `read_only_admins` field.\n', args=[]), + withReadOnlyAdmins(resourceLabel, value): { + resource+: { + aws_lakeformation_data_lake_settings+: { + [resourceLabel]+: { + read_only_admins: value, + }, + }, + }, + }, '#withTrustedResourceOwners':: d.fn(help='`aws.list.withTrustedResourceOwners` constructs a mixin object that can be merged into the `list`\nTerraform resource block to set or update the trusted_resource_owners field.\n\n\n\n**Args**:\n - `resourceLabel` (`string`): The name label of the block to update.\n - `value` (`list`): The value to set for the `trusted_resource_owners` field.\n', args=[]), withTrustedResourceOwners(resourceLabel, value): { resource+: { diff --git a/5.x/_gen/resources/medialive_channel.libsonnet b/5.x/_gen/resources/medialive_channel.libsonnet index 00770605..32761c76 100644 --- a/5.x/_gen/resources/medialive_channel.libsonnet +++ b/5.x/_gen/resources/medialive_channel.libsonnet @@ -2091,14 +2091,24 @@ local d = (import 'github.com/jsonnet-libs/docsonnet/doc-util/main.libsonnet'); }), }, audio_track_selection:: { - '#new':: d.fn(help='\n`aws.medialive_channel.input_attachments.input_settings.audio_selector.selector_settings.audio_track_selection.new` constructs a new object with attributes and blocks configured for the `audio_track_selection`\nTerraform sub block.\n\n\n\n**Args**:\n - `track` (`list[obj]`): Set the `track` field on the resulting object. When `null`, the `track` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [aws.medialive_channel.input_attachments.input_settings.audio_selector.selector_settings.audio_track_selection.track.new](#fn-input_attachmentsinput_attachmentsinput_settingsaudio_selectorselector_settingstracknew) constructor.\n\n**Returns**:\n - An attribute object that represents the `audio_track_selection` sub block.\n', args=[]), + dolby_e_decode:: { + '#new':: d.fn(help='\n`aws.medialive_channel.input_attachments.input_settings.audio_selector.selector_settings.audio_track_selection.dolby_e_decode.new` constructs a new object with attributes and blocks configured for the `dolby_e_decode`\nTerraform sub block.\n\n\n\n**Args**:\n - `program_selection` (`string`): Set the `program_selection` field on the resulting object.\n\n**Returns**:\n - An attribute object that represents the `dolby_e_decode` sub block.\n', args=[]), + new( + program_selection + ):: std.prune(a={ + program_selection: program_selection, + }), + }, + '#new':: d.fn(help='\n`aws.medialive_channel.input_attachments.input_settings.audio_selector.selector_settings.audio_track_selection.new` constructs a new object with attributes and blocks configured for the `audio_track_selection`\nTerraform sub block.\n\n\n\n**Args**:\n - `dolby_e_decode` (`list[obj]`): Set the `dolby_e_decode` field on the resulting object. When `null`, the `dolby_e_decode` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [aws.medialive_channel.input_attachments.input_settings.audio_selector.selector_settings.audio_track_selection.dolby_e_decode.new](#fn-input_attachmentsinput_attachmentsinput_settingsaudio_selectorselector_settingsdolby_e_decodenew) constructor.\n - `tracks` (`list[obj]`): Set the `tracks` field on the resulting object. When `null`, the `tracks` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [aws.medialive_channel.input_attachments.input_settings.audio_selector.selector_settings.audio_track_selection.tracks.new](#fn-input_attachmentsinput_attachmentsinput_settingsaudio_selectorselector_settingstracksnew) constructor.\n\n**Returns**:\n - An attribute object that represents the `audio_track_selection` sub block.\n', args=[]), new( - track=null + dolby_e_decode=null, + tracks=null ):: std.prune(a={ - track: track, + dolby_e_decode: dolby_e_decode, + tracks: tracks, }), - track:: { - '#new':: d.fn(help='\n`aws.medialive_channel.input_attachments.input_settings.audio_selector.selector_settings.audio_track_selection.track.new` constructs a new object with attributes and blocks configured for the `track`\nTerraform sub block.\n\n\n\n**Args**:\n - `track` (`number`): Set the `track` field on the resulting object.\n\n**Returns**:\n - An attribute object that represents the `track` sub block.\n', args=[]), + tracks:: { + '#new':: d.fn(help='\n`aws.medialive_channel.input_attachments.input_settings.audio_selector.selector_settings.audio_track_selection.tracks.new` constructs a new object with attributes and blocks configured for the `tracks`\nTerraform sub block.\n\n\n\n**Args**:\n - `track` (`number`): Set the `track` field on the resulting object.\n\n**Returns**:\n - An attribute object that represents the `tracks` sub block.\n', args=[]), new( track ):: std.prune(a={ @@ -2140,8 +2150,14 @@ local d = (import 'github.com/jsonnet-libs/docsonnet/doc-util/main.libsonnet'); source_ancillary_channel_number: source_ancillary_channel_number, }), }, - dvb_tdt_settings:: { - '#new':: d.fn(help='\n`aws.medialive_channel.input_attachments.input_settings.caption_selector.selector_settings.dvb_tdt_settings.new` constructs a new object with attributes and blocks configured for the `dvb_tdt_settings`\nTerraform sub block.\n\n\n\n**Args**:\n - `ocr_language` (`string`): Set the `ocr_language` field on the resulting object. When `null`, the `ocr_language` field will be omitted from the resulting object.\n - `pid` (`number`): Set the `pid` field on the resulting object. When `null`, the `pid` field will be omitted from the resulting object.\n\n**Returns**:\n - An attribute object that represents the `dvb_tdt_settings` sub block.\n', args=[]), + arib_source_settings:: { + '#new':: d.fn(help='\n`aws.medialive_channel.input_attachments.input_settings.caption_selector.selector_settings.arib_source_settings.new` constructs a new object with attributes and blocks configured for the `arib_source_settings`\nTerraform sub block.\n\n\n\n**Returns**:\n - An attribute object that represents the `arib_source_settings` sub block.\n', args=[]), + new( + + ):: std.prune(a={}), + }, + dvb_sub_source_settings:: { + '#new':: d.fn(help='\n`aws.medialive_channel.input_attachments.input_settings.caption_selector.selector_settings.dvb_sub_source_settings.new` constructs a new object with attributes and blocks configured for the `dvb_sub_source_settings`\nTerraform sub block.\n\n\n\n**Args**:\n - `ocr_language` (`string`): Set the `ocr_language` field on the resulting object. When `null`, the `ocr_language` field will be omitted from the resulting object.\n - `pid` (`number`): Set the `pid` field on the resulting object. When `null`, the `pid` field will be omitted from the resulting object.\n\n**Returns**:\n - An attribute object that represents the `dvb_sub_source_settings` sub block.\n', args=[]), new( ocr_language=null, pid=null @@ -2151,30 +2167,30 @@ local d = (import 'github.com/jsonnet-libs/docsonnet/doc-util/main.libsonnet'); }), }, embedded_source_settings:: { - '#new':: d.fn(help='\n`aws.medialive_channel.input_attachments.input_settings.caption_selector.selector_settings.embedded_source_settings.new` constructs a new object with attributes and blocks configured for the `embedded_source_settings`\nTerraform sub block.\n\n\n\n**Args**:\n - `convert_608_to_708` (`string`): Set the `convert_608_to_708` field on the resulting object. When `null`, the `convert_608_to_708` field will be omitted from the resulting object.\n - `scte20_detection` (`string`): Set the `scte20_detection` field on the resulting object. When `null`, the `scte20_detection` field will be omitted from the resulting object.\n - `source_608_channel_number` (`number`): Set the `source_608_channel_number` field on the resulting object. When `null`, the `source_608_channel_number` field will be omitted from the resulting object.\n - `source_608_track_number` (`number`): Set the `source_608_track_number` field on the resulting object. When `null`, the `source_608_track_number` field will be omitted from the resulting object.\n\n**Returns**:\n - An attribute object that represents the `embedded_source_settings` sub block.\n', args=[]), + '#new':: d.fn(help='\n`aws.medialive_channel.input_attachments.input_settings.caption_selector.selector_settings.embedded_source_settings.new` constructs a new object with attributes and blocks configured for the `embedded_source_settings`\nTerraform sub block.\n\n\n\n**Args**:\n - `convert_608_to_708` (`string`): Set the `convert_608_to_708` field on the resulting object. When `null`, the `convert_608_to_708` field will be omitted from the resulting object.\n - `scte20_detection` (`string`): Set the `scte20_detection` field on the resulting object. When `null`, the `scte20_detection` field will be omitted from the resulting object.\n - `source_608_channel_number` (`number`): Set the `source_608_channel_number` field on the resulting object. When `null`, the `source_608_channel_number` field will be omitted from the resulting object.\n\n**Returns**:\n - An attribute object that represents the `embedded_source_settings` sub block.\n', args=[]), new( convert_608_to_708=null, scte20_detection=null, - source_608_channel_number=null, - source_608_track_number=null + source_608_channel_number=null ):: std.prune(a={ convert_608_to_708: convert_608_to_708, scte20_detection: scte20_detection, source_608_channel_number: source_608_channel_number, - source_608_track_number: source_608_track_number, }), }, - '#new':: d.fn(help='\n`aws.medialive_channel.input_attachments.input_settings.caption_selector.selector_settings.new` constructs a new object with attributes and blocks configured for the `selector_settings`\nTerraform sub block.\n\n\n\n**Args**:\n - `ancillary_source_settings` (`list[obj]`): Set the `ancillary_source_settings` field on the resulting object. When `null`, the `ancillary_source_settings` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [aws.medialive_channel.input_attachments.input_settings.caption_selector.selector_settings.ancillary_source_settings.new](#fn-input_attachmentsinput_attachmentsinput_settingscaption_selectorancillary_source_settingsnew) constructor.\n - `dvb_tdt_settings` (`list[obj]`): Set the `dvb_tdt_settings` field on the resulting object. When `null`, the `dvb_tdt_settings` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [aws.medialive_channel.input_attachments.input_settings.caption_selector.selector_settings.dvb_tdt_settings.new](#fn-input_attachmentsinput_attachmentsinput_settingscaption_selectordvb_tdt_settingsnew) constructor.\n - `embedded_source_settings` (`list[obj]`): Set the `embedded_source_settings` field on the resulting object. When `null`, the `embedded_source_settings` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [aws.medialive_channel.input_attachments.input_settings.caption_selector.selector_settings.embedded_source_settings.new](#fn-input_attachmentsinput_attachmentsinput_settingscaption_selectorembedded_source_settingsnew) constructor.\n - `scte20_source_settings` (`list[obj]`): Set the `scte20_source_settings` field on the resulting object. When `null`, the `scte20_source_settings` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [aws.medialive_channel.input_attachments.input_settings.caption_selector.selector_settings.scte20_source_settings.new](#fn-input_attachmentsinput_attachmentsinput_settingscaption_selectorscte20_source_settingsnew) constructor.\n - `scte27_source_settings` (`list[obj]`): Set the `scte27_source_settings` field on the resulting object. When `null`, the `scte27_source_settings` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [aws.medialive_channel.input_attachments.input_settings.caption_selector.selector_settings.scte27_source_settings.new](#fn-input_attachmentsinput_attachmentsinput_settingscaption_selectorscte27_source_settingsnew) constructor.\n - `teletext_source_settings` (`list[obj]`): Set the `teletext_source_settings` field on the resulting object. When `null`, the `teletext_source_settings` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [aws.medialive_channel.input_attachments.input_settings.caption_selector.selector_settings.teletext_source_settings.new](#fn-input_attachmentsinput_attachmentsinput_settingscaption_selectorteletext_source_settingsnew) constructor.\n\n**Returns**:\n - An attribute object that represents the `selector_settings` sub block.\n', args=[]), + '#new':: d.fn(help='\n`aws.medialive_channel.input_attachments.input_settings.caption_selector.selector_settings.new` constructs a new object with attributes and blocks configured for the `selector_settings`\nTerraform sub block.\n\n\n\n**Args**:\n - `ancillary_source_settings` (`list[obj]`): Set the `ancillary_source_settings` field on the resulting object. When `null`, the `ancillary_source_settings` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [aws.medialive_channel.input_attachments.input_settings.caption_selector.selector_settings.ancillary_source_settings.new](#fn-input_attachmentsinput_attachmentsinput_settingscaption_selectorancillary_source_settingsnew) constructor.\n - `arib_source_settings` (`list[obj]`): Set the `arib_source_settings` field on the resulting object. When `null`, the `arib_source_settings` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [aws.medialive_channel.input_attachments.input_settings.caption_selector.selector_settings.arib_source_settings.new](#fn-input_attachmentsinput_attachmentsinput_settingscaption_selectorarib_source_settingsnew) constructor.\n - `dvb_sub_source_settings` (`list[obj]`): Set the `dvb_sub_source_settings` field on the resulting object. When `null`, the `dvb_sub_source_settings` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [aws.medialive_channel.input_attachments.input_settings.caption_selector.selector_settings.dvb_sub_source_settings.new](#fn-input_attachmentsinput_attachmentsinput_settingscaption_selectordvb_sub_source_settingsnew) constructor.\n - `embedded_source_settings` (`list[obj]`): Set the `embedded_source_settings` field on the resulting object. When `null`, the `embedded_source_settings` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [aws.medialive_channel.input_attachments.input_settings.caption_selector.selector_settings.embedded_source_settings.new](#fn-input_attachmentsinput_attachmentsinput_settingscaption_selectorembedded_source_settingsnew) constructor.\n - `scte20_source_settings` (`list[obj]`): Set the `scte20_source_settings` field on the resulting object. When `null`, the `scte20_source_settings` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [aws.medialive_channel.input_attachments.input_settings.caption_selector.selector_settings.scte20_source_settings.new](#fn-input_attachmentsinput_attachmentsinput_settingscaption_selectorscte20_source_settingsnew) constructor.\n - `scte27_source_settings` (`list[obj]`): Set the `scte27_source_settings` field on the resulting object. When `null`, the `scte27_source_settings` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [aws.medialive_channel.input_attachments.input_settings.caption_selector.selector_settings.scte27_source_settings.new](#fn-input_attachmentsinput_attachmentsinput_settingscaption_selectorscte27_source_settingsnew) constructor.\n - `teletext_source_settings` (`list[obj]`): Set the `teletext_source_settings` field on the resulting object. When `null`, the `teletext_source_settings` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [aws.medialive_channel.input_attachments.input_settings.caption_selector.selector_settings.teletext_source_settings.new](#fn-input_attachmentsinput_attachmentsinput_settingscaption_selectorteletext_source_settingsnew) constructor.\n\n**Returns**:\n - An attribute object that represents the `selector_settings` sub block.\n', args=[]), new( ancillary_source_settings=null, - dvb_tdt_settings=null, + arib_source_settings=null, + dvb_sub_source_settings=null, embedded_source_settings=null, scte20_source_settings=null, scte27_source_settings=null, teletext_source_settings=null ):: std.prune(a={ ancillary_source_settings: ancillary_source_settings, - dvb_tdt_settings: dvb_tdt_settings, + arib_source_settings: arib_source_settings, + dvb_sub_source_settings: dvb_sub_source_settings, embedded_source_settings: embedded_source_settings, scte20_source_settings: scte20_source_settings, scte27_source_settings: scte27_source_settings, diff --git a/5.x/_gen/resources/msk_cluster_policy.libsonnet b/5.x/_gen/resources/msk_cluster_policy.libsonnet new file mode 100644 index 00000000..e8c8a6f3 --- /dev/null +++ b/5.x/_gen/resources/msk_cluster_policy.libsonnet @@ -0,0 +1,45 @@ +local tf = (import 'github.com/tf-libsonnet/core/main.libsonnet'); +local d = (import 'github.com/jsonnet-libs/docsonnet/doc-util/main.libsonnet'); +{ + '#':: d.pkg(name='msk_cluster_policy', url='', help='`msk_cluster_policy` represents the `aws_msk_cluster_policy` Terraform resource.\n\n\n\nThis package contains functions and utilities for setting up the resource using Jsonnet code.\n'), + '#new':: d.fn(help="\n`aws.msk_cluster_policy.new` injects a new `aws_msk_cluster_policy` Terraform `resource`\nblock into the root module document.\n\nAdditionally, this inserts a private function into the `_ref` attribute that generates references to attributes of the\nresource. For example, if you added a new instance to the root using:\n\n # arguments omitted for brevity\n aws.msk_cluster_policy.new('some_id')\n\nYou can get the reference to the `id` field of the created `aws.msk_cluster_policy` using the reference:\n\n $._ref.aws_msk_cluster_policy.some_id.get('id')\n\nThis is the same as directly entering `\"${ aws_msk_cluster_policy.some_id.id }\"` as the value.\n\nNOTE: if you are chaining multiple resources together in a merge operation, you may not be able to use `super`, `self`,\nor `$` to refer to the root object. Instead, make an explicit outer object using `local`.\n\n**Args**:\n - `resourceLabel` (`string`): The name label of the block.\n - `cluster_arn` (`string`): Set the `cluster_arn` field on the resulting resource block.\n - `policy` (`string`): Set the `policy` field on the resulting resource block.\n\n**Returns**:\n- A mixin object that injects the new resource into the root Terraform configuration.\n", args=[]), + new( + resourceLabel, + cluster_arn, + policy, + _meta={} + ):: tf.withResource( + type='aws_msk_cluster_policy', + label=resourceLabel, + attrs=self.newAttrs(cluster_arn=cluster_arn, policy=policy), + _meta=_meta + ), + '#newAttrs':: d.fn(help='\n`aws.msk_cluster_policy.newAttrs` constructs a new object with attributes and blocks configured for the `msk_cluster_policy`\nTerraform resource.\n\nUnlike [aws.msk_cluster_policy.new](#fn-new), this function will not inject the `resource`\nblock into the root Terraform document. Instead, this must be passed in as the `attrs` argument for the\n[tf.withResource](https://github.com/tf-libsonnet/core/tree/main/docs#fn-withresource) function to build a complete block.\n\nThis is most useful when you need to preprocess the attributes with functions, conditional, or looping logic prior to\ninjecting into a complete block.\n\n**Args**:\n - `cluster_arn` (`string`): Set the `cluster_arn` field on the resulting object.\n - `policy` (`string`): Set the `policy` field on the resulting object.\n\n**Returns**:\n - An attribute object that can be used with [tf.withResource](https://github.com/tf-libsonnet/core/tree/main/docs#fn-withresource) to construct a new `msk_cluster_policy` resource into the root Terraform configuration.\n', args=[]), + newAttrs( + cluster_arn, + policy + ):: std.prune(a={ + cluster_arn: cluster_arn, + policy: policy, + }), + '#withClusterArn':: d.fn(help='`aws.string.withClusterArn` constructs a mixin object that can be merged into the `string`\nTerraform resource block to set or update the cluster_arn field.\n\n\n\n**Args**:\n - `resourceLabel` (`string`): The name label of the block to update.\n - `value` (`string`): The value to set for the `cluster_arn` field.\n', args=[]), + withClusterArn(resourceLabel, value): { + resource+: { + aws_msk_cluster_policy+: { + [resourceLabel]+: { + cluster_arn: value, + }, + }, + }, + }, + '#withPolicy':: d.fn(help='`aws.string.withPolicy` constructs a mixin object that can be merged into the `string`\nTerraform resource block to set or update the policy field.\n\n\n\n**Args**:\n - `resourceLabel` (`string`): The name label of the block to update.\n - `value` (`string`): The value to set for the `policy` field.\n', args=[]), + withPolicy(resourceLabel, value): { + resource+: { + aws_msk_cluster_policy+: { + [resourceLabel]+: { + policy: value, + }, + }, + }, + }, +} diff --git a/5.x/_gen/resources/opensearch_domain.libsonnet b/5.x/_gen/resources/opensearch_domain.libsonnet index b9f3903d..d328a481 100644 --- a/5.x/_gen/resources/opensearch_domain.libsonnet +++ b/5.x/_gen/resources/opensearch_domain.libsonnet @@ -71,7 +71,7 @@ local d = (import 'github.com/jsonnet-libs/docsonnet/doc-util/main.libsonnet'); enabled: enabled, }), }, - '#new':: d.fn(help='\n`aws.opensearch_domain.cluster_config.new` constructs a new object with attributes and blocks configured for the `cluster_config`\nTerraform sub block.\n\n\n\n**Args**:\n - `dedicated_master_count` (`number`): Set the `dedicated_master_count` field on the resulting object. When `null`, the `dedicated_master_count` field will be omitted from the resulting object.\n - `dedicated_master_enabled` (`bool`): Set the `dedicated_master_enabled` field on the resulting object. When `null`, the `dedicated_master_enabled` field will be omitted from the resulting object.\n - `dedicated_master_type` (`string`): Set the `dedicated_master_type` field on the resulting object. When `null`, the `dedicated_master_type` field will be omitted from the resulting object.\n - `instance_count` (`number`): Set the `instance_count` field on the resulting object. When `null`, the `instance_count` field will be omitted from the resulting object.\n - `instance_type` (`string`): Set the `instance_type` field on the resulting object. When `null`, the `instance_type` field will be omitted from the resulting object.\n - `warm_count` (`number`): Set the `warm_count` field on the resulting object. When `null`, the `warm_count` field will be omitted from the resulting object.\n - `warm_enabled` (`bool`): Set the `warm_enabled` field on the resulting object. When `null`, the `warm_enabled` field will be omitted from the resulting object.\n - `warm_type` (`string`): Set the `warm_type` field on the resulting object. When `null`, the `warm_type` field will be omitted from the resulting object.\n - `zone_awareness_enabled` (`bool`): Set the `zone_awareness_enabled` field on the resulting object. When `null`, the `zone_awareness_enabled` field will be omitted from the resulting object.\n - `cold_storage_options` (`list[obj]`): Set the `cold_storage_options` field on the resulting object. When `null`, the `cold_storage_options` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [aws.opensearch_domain.cluster_config.cold_storage_options.new](#fn-cluster_configcold_storage_optionsnew) constructor.\n - `zone_awareness_config` (`list[obj]`): Set the `zone_awareness_config` field on the resulting object. When `null`, the `zone_awareness_config` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [aws.opensearch_domain.cluster_config.zone_awareness_config.new](#fn-cluster_configzone_awareness_confignew) constructor.\n\n**Returns**:\n - An attribute object that represents the `cluster_config` sub block.\n', args=[]), + '#new':: d.fn(help='\n`aws.opensearch_domain.cluster_config.new` constructs a new object with attributes and blocks configured for the `cluster_config`\nTerraform sub block.\n\n\n\n**Args**:\n - `dedicated_master_count` (`number`): Set the `dedicated_master_count` field on the resulting object. When `null`, the `dedicated_master_count` field will be omitted from the resulting object.\n - `dedicated_master_enabled` (`bool`): Set the `dedicated_master_enabled` field on the resulting object. When `null`, the `dedicated_master_enabled` field will be omitted from the resulting object.\n - `dedicated_master_type` (`string`): Set the `dedicated_master_type` field on the resulting object. When `null`, the `dedicated_master_type` field will be omitted from the resulting object.\n - `instance_count` (`number`): Set the `instance_count` field on the resulting object. When `null`, the `instance_count` field will be omitted from the resulting object.\n - `instance_type` (`string`): Set the `instance_type` field on the resulting object. When `null`, the `instance_type` field will be omitted from the resulting object.\n - `multi_az_with_standby_enabled` (`bool`): Set the `multi_az_with_standby_enabled` field on the resulting object. When `null`, the `multi_az_with_standby_enabled` field will be omitted from the resulting object.\n - `warm_count` (`number`): Set the `warm_count` field on the resulting object. When `null`, the `warm_count` field will be omitted from the resulting object.\n - `warm_enabled` (`bool`): Set the `warm_enabled` field on the resulting object. When `null`, the `warm_enabled` field will be omitted from the resulting object.\n - `warm_type` (`string`): Set the `warm_type` field on the resulting object. When `null`, the `warm_type` field will be omitted from the resulting object.\n - `zone_awareness_enabled` (`bool`): Set the `zone_awareness_enabled` field on the resulting object. When `null`, the `zone_awareness_enabled` field will be omitted from the resulting object.\n - `cold_storage_options` (`list[obj]`): Set the `cold_storage_options` field on the resulting object. When `null`, the `cold_storage_options` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [aws.opensearch_domain.cluster_config.cold_storage_options.new](#fn-cluster_configcold_storage_optionsnew) constructor.\n - `zone_awareness_config` (`list[obj]`): Set the `zone_awareness_config` field on the resulting object. When `null`, the `zone_awareness_config` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [aws.opensearch_domain.cluster_config.zone_awareness_config.new](#fn-cluster_configzone_awareness_confignew) constructor.\n\n**Returns**:\n - An attribute object that represents the `cluster_config` sub block.\n', args=[]), new( cold_storage_options=null, dedicated_master_count=null, @@ -79,6 +79,7 @@ local d = (import 'github.com/jsonnet-libs/docsonnet/doc-util/main.libsonnet'); dedicated_master_type=null, instance_count=null, instance_type=null, + multi_az_with_standby_enabled=null, warm_count=null, warm_enabled=null, warm_type=null, @@ -91,6 +92,7 @@ local d = (import 'github.com/jsonnet-libs/docsonnet/doc-util/main.libsonnet'); dedicated_master_type: dedicated_master_type, instance_count: instance_count, instance_type: instance_type, + multi_az_with_standby_enabled: multi_az_with_standby_enabled, warm_count: warm_count, warm_enabled: warm_enabled, warm_type: warm_type, @@ -174,7 +176,7 @@ local d = (import 'github.com/jsonnet-libs/docsonnet/doc-util/main.libsonnet'); log_type: log_type, }), }, - '#new':: d.fn(help="\n`aws.opensearch_domain.new` injects a new `aws_opensearch_domain` Terraform `resource`\nblock into the root module document.\n\nAdditionally, this inserts a private function into the `_ref` attribute that generates references to attributes of the\nresource. For example, if you added a new instance to the root using:\n\n # arguments omitted for brevity\n aws.opensearch_domain.new('some_id')\n\nYou can get the reference to the `id` field of the created `aws.opensearch_domain` using the reference:\n\n $._ref.aws_opensearch_domain.some_id.get('id')\n\nThis is the same as directly entering `\"${ aws_opensearch_domain.some_id.id }\"` as the value.\n\nNOTE: if you are chaining multiple resources together in a merge operation, you may not be able to use `super`, `self`,\nor `$` to refer to the root object. Instead, make an explicit outer object using `local`.\n\n**Args**:\n - `resourceLabel` (`string`): The name label of the block.\n - `access_policies` (`string`): Set the `access_policies` field on the resulting resource block. When `null`, the `access_policies` field will be omitted from the resulting object.\n - `advanced_options` (`obj`): Set the `advanced_options` field on the resulting resource block. When `null`, the `advanced_options` field will be omitted from the resulting object.\n - `domain_name` (`string`): Set the `domain_name` field on the resulting resource block.\n - `engine_version` (`string`): Set the `engine_version` field on the resulting resource block. When `null`, the `engine_version` field will be omitted from the resulting object.\n - `tags` (`obj`): Set the `tags` field on the resulting resource block. When `null`, the `tags` field will be omitted from the resulting object.\n - `tags_all` (`obj`): Set the `tags_all` field on the resulting resource block. When `null`, the `tags_all` field will be omitted from the resulting object.\n - `advanced_security_options` (`list[obj]`): Set the `advanced_security_options` field on the resulting resource block. When `null`, the `advanced_security_options` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [aws.opensearch_domain.advanced_security_options.new](#fn-advanced_security_optionsnew) constructor.\n - `auto_tune_options` (`list[obj]`): Set the `auto_tune_options` field on the resulting resource block. When `null`, the `auto_tune_options` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [aws.opensearch_domain.auto_tune_options.new](#fn-auto_tune_optionsnew) constructor.\n - `cluster_config` (`list[obj]`): Set the `cluster_config` field on the resulting resource block. When `null`, the `cluster_config` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [aws.opensearch_domain.cluster_config.new](#fn-cluster_confignew) constructor.\n - `cognito_options` (`list[obj]`): Set the `cognito_options` field on the resulting resource block. When `null`, the `cognito_options` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [aws.opensearch_domain.cognito_options.new](#fn-cognito_optionsnew) constructor.\n - `domain_endpoint_options` (`list[obj]`): Set the `domain_endpoint_options` field on the resulting resource block. When `null`, the `domain_endpoint_options` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [aws.opensearch_domain.domain_endpoint_options.new](#fn-domain_endpoint_optionsnew) constructor.\n - `ebs_options` (`list[obj]`): Set the `ebs_options` field on the resulting resource block. When `null`, the `ebs_options` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [aws.opensearch_domain.ebs_options.new](#fn-ebs_optionsnew) constructor.\n - `encrypt_at_rest` (`list[obj]`): Set the `encrypt_at_rest` field on the resulting resource block. When `null`, the `encrypt_at_rest` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [aws.opensearch_domain.encrypt_at_rest.new](#fn-encrypt_at_restnew) constructor.\n - `log_publishing_options` (`list[obj]`): Set the `log_publishing_options` field on the resulting resource block. When `null`, the `log_publishing_options` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [aws.opensearch_domain.log_publishing_options.new](#fn-log_publishing_optionsnew) constructor.\n - `node_to_node_encryption` (`list[obj]`): Set the `node_to_node_encryption` field on the resulting resource block. When `null`, the `node_to_node_encryption` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [aws.opensearch_domain.node_to_node_encryption.new](#fn-node_to_node_encryptionnew) constructor.\n - `off_peak_window_options` (`list[obj]`): Set the `off_peak_window_options` field on the resulting resource block. When `null`, the `off_peak_window_options` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [aws.opensearch_domain.off_peak_window_options.new](#fn-off_peak_window_optionsnew) constructor.\n - `snapshot_options` (`list[obj]`): Set the `snapshot_options` field on the resulting resource block. When `null`, the `snapshot_options` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [aws.opensearch_domain.snapshot_options.new](#fn-snapshot_optionsnew) constructor.\n - `timeouts` (`obj`): Set the `timeouts` field on the resulting resource block. When `null`, the `timeouts` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [aws.opensearch_domain.timeouts.new](#fn-timeoutsnew) constructor.\n - `vpc_options` (`list[obj]`): Set the `vpc_options` field on the resulting resource block. When `null`, the `vpc_options` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [aws.opensearch_domain.vpc_options.new](#fn-vpc_optionsnew) constructor.\n\n**Returns**:\n- A mixin object that injects the new resource into the root Terraform configuration.\n", args=[]), + '#new':: d.fn(help="\n`aws.opensearch_domain.new` injects a new `aws_opensearch_domain` Terraform `resource`\nblock into the root module document.\n\nAdditionally, this inserts a private function into the `_ref` attribute that generates references to attributes of the\nresource. For example, if you added a new instance to the root using:\n\n # arguments omitted for brevity\n aws.opensearch_domain.new('some_id')\n\nYou can get the reference to the `id` field of the created `aws.opensearch_domain` using the reference:\n\n $._ref.aws_opensearch_domain.some_id.get('id')\n\nThis is the same as directly entering `\"${ aws_opensearch_domain.some_id.id }\"` as the value.\n\nNOTE: if you are chaining multiple resources together in a merge operation, you may not be able to use `super`, `self`,\nor `$` to refer to the root object. Instead, make an explicit outer object using `local`.\n\n**Args**:\n - `resourceLabel` (`string`): The name label of the block.\n - `access_policies` (`string`): Set the `access_policies` field on the resulting resource block. When `null`, the `access_policies` field will be omitted from the resulting object.\n - `advanced_options` (`obj`): Set the `advanced_options` field on the resulting resource block. When `null`, the `advanced_options` field will be omitted from the resulting object.\n - `domain_name` (`string`): Set the `domain_name` field on the resulting resource block.\n - `engine_version` (`string`): Set the `engine_version` field on the resulting resource block. When `null`, the `engine_version` field will be omitted from the resulting object.\n - `tags` (`obj`): Set the `tags` field on the resulting resource block. When `null`, the `tags` field will be omitted from the resulting object.\n - `tags_all` (`obj`): Set the `tags_all` field on the resulting resource block. When `null`, the `tags_all` field will be omitted from the resulting object.\n - `advanced_security_options` (`list[obj]`): Set the `advanced_security_options` field on the resulting resource block. When `null`, the `advanced_security_options` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [aws.opensearch_domain.advanced_security_options.new](#fn-advanced_security_optionsnew) constructor.\n - `auto_tune_options` (`list[obj]`): Set the `auto_tune_options` field on the resulting resource block. When `null`, the `auto_tune_options` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [aws.opensearch_domain.auto_tune_options.new](#fn-auto_tune_optionsnew) constructor.\n - `cluster_config` (`list[obj]`): Set the `cluster_config` field on the resulting resource block. When `null`, the `cluster_config` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [aws.opensearch_domain.cluster_config.new](#fn-cluster_confignew) constructor.\n - `cognito_options` (`list[obj]`): Set the `cognito_options` field on the resulting resource block. When `null`, the `cognito_options` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [aws.opensearch_domain.cognito_options.new](#fn-cognito_optionsnew) constructor.\n - `domain_endpoint_options` (`list[obj]`): Set the `domain_endpoint_options` field on the resulting resource block. When `null`, the `domain_endpoint_options` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [aws.opensearch_domain.domain_endpoint_options.new](#fn-domain_endpoint_optionsnew) constructor.\n - `ebs_options` (`list[obj]`): Set the `ebs_options` field on the resulting resource block. When `null`, the `ebs_options` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [aws.opensearch_domain.ebs_options.new](#fn-ebs_optionsnew) constructor.\n - `encrypt_at_rest` (`list[obj]`): Set the `encrypt_at_rest` field on the resulting resource block. When `null`, the `encrypt_at_rest` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [aws.opensearch_domain.encrypt_at_rest.new](#fn-encrypt_at_restnew) constructor.\n - `log_publishing_options` (`list[obj]`): Set the `log_publishing_options` field on the resulting resource block. When `null`, the `log_publishing_options` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [aws.opensearch_domain.log_publishing_options.new](#fn-log_publishing_optionsnew) constructor.\n - `node_to_node_encryption` (`list[obj]`): Set the `node_to_node_encryption` field on the resulting resource block. When `null`, the `node_to_node_encryption` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [aws.opensearch_domain.node_to_node_encryption.new](#fn-node_to_node_encryptionnew) constructor.\n - `off_peak_window_options` (`list[obj]`): Set the `off_peak_window_options` field on the resulting resource block. When `null`, the `off_peak_window_options` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [aws.opensearch_domain.off_peak_window_options.new](#fn-off_peak_window_optionsnew) constructor.\n - `snapshot_options` (`list[obj]`): Set the `snapshot_options` field on the resulting resource block. When `null`, the `snapshot_options` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [aws.opensearch_domain.snapshot_options.new](#fn-snapshot_optionsnew) constructor.\n - `software_update_options` (`list[obj]`): Set the `software_update_options` field on the resulting resource block. When `null`, the `software_update_options` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [aws.opensearch_domain.software_update_options.new](#fn-software_update_optionsnew) constructor.\n - `timeouts` (`obj`): Set the `timeouts` field on the resulting resource block. When `null`, the `timeouts` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [aws.opensearch_domain.timeouts.new](#fn-timeoutsnew) constructor.\n - `vpc_options` (`list[obj]`): Set the `vpc_options` field on the resulting resource block. When `null`, the `vpc_options` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [aws.opensearch_domain.vpc_options.new](#fn-vpc_optionsnew) constructor.\n\n**Returns**:\n- A mixin object that injects the new resource into the root Terraform configuration.\n", args=[]), new( resourceLabel, domain_name, @@ -192,6 +194,7 @@ local d = (import 'github.com/jsonnet-libs/docsonnet/doc-util/main.libsonnet'); node_to_node_encryption=null, off_peak_window_options=null, snapshot_options=null, + software_update_options=null, tags=null, tags_all=null, timeouts=null, @@ -216,6 +219,7 @@ local d = (import 'github.com/jsonnet-libs/docsonnet/doc-util/main.libsonnet'); node_to_node_encryption=node_to_node_encryption, off_peak_window_options=off_peak_window_options, snapshot_options=snapshot_options, + software_update_options=software_update_options, tags=tags, tags_all=tags_all, timeouts=timeouts, @@ -223,7 +227,7 @@ local d = (import 'github.com/jsonnet-libs/docsonnet/doc-util/main.libsonnet'); ), _meta=_meta ), - '#newAttrs':: d.fn(help='\n`aws.opensearch_domain.newAttrs` constructs a new object with attributes and blocks configured for the `opensearch_domain`\nTerraform resource.\n\nUnlike [aws.opensearch_domain.new](#fn-new), this function will not inject the `resource`\nblock into the root Terraform document. Instead, this must be passed in as the `attrs` argument for the\n[tf.withResource](https://github.com/tf-libsonnet/core/tree/main/docs#fn-withresource) function to build a complete block.\n\nThis is most useful when you need to preprocess the attributes with functions, conditional, or looping logic prior to\ninjecting into a complete block.\n\n**Args**:\n - `access_policies` (`string`): Set the `access_policies` field on the resulting object. When `null`, the `access_policies` field will be omitted from the resulting object.\n - `advanced_options` (`obj`): Set the `advanced_options` field on the resulting object. When `null`, the `advanced_options` field will be omitted from the resulting object.\n - `domain_name` (`string`): Set the `domain_name` field on the resulting object.\n - `engine_version` (`string`): Set the `engine_version` field on the resulting object. When `null`, the `engine_version` field will be omitted from the resulting object.\n - `tags` (`obj`): Set the `tags` field on the resulting object. When `null`, the `tags` field will be omitted from the resulting object.\n - `tags_all` (`obj`): Set the `tags_all` field on the resulting object. When `null`, the `tags_all` field will be omitted from the resulting object.\n - `advanced_security_options` (`list[obj]`): Set the `advanced_security_options` field on the resulting object. When `null`, the `advanced_security_options` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [aws.opensearch_domain.advanced_security_options.new](#fn-advanced_security_optionsnew) constructor.\n - `auto_tune_options` (`list[obj]`): Set the `auto_tune_options` field on the resulting object. When `null`, the `auto_tune_options` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [aws.opensearch_domain.auto_tune_options.new](#fn-auto_tune_optionsnew) constructor.\n - `cluster_config` (`list[obj]`): Set the `cluster_config` field on the resulting object. When `null`, the `cluster_config` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [aws.opensearch_domain.cluster_config.new](#fn-cluster_confignew) constructor.\n - `cognito_options` (`list[obj]`): Set the `cognito_options` field on the resulting object. When `null`, the `cognito_options` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [aws.opensearch_domain.cognito_options.new](#fn-cognito_optionsnew) constructor.\n - `domain_endpoint_options` (`list[obj]`): Set the `domain_endpoint_options` field on the resulting object. When `null`, the `domain_endpoint_options` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [aws.opensearch_domain.domain_endpoint_options.new](#fn-domain_endpoint_optionsnew) constructor.\n - `ebs_options` (`list[obj]`): Set the `ebs_options` field on the resulting object. When `null`, the `ebs_options` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [aws.opensearch_domain.ebs_options.new](#fn-ebs_optionsnew) constructor.\n - `encrypt_at_rest` (`list[obj]`): Set the `encrypt_at_rest` field on the resulting object. When `null`, the `encrypt_at_rest` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [aws.opensearch_domain.encrypt_at_rest.new](#fn-encrypt_at_restnew) constructor.\n - `log_publishing_options` (`list[obj]`): Set the `log_publishing_options` field on the resulting object. When `null`, the `log_publishing_options` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [aws.opensearch_domain.log_publishing_options.new](#fn-log_publishing_optionsnew) constructor.\n - `node_to_node_encryption` (`list[obj]`): Set the `node_to_node_encryption` field on the resulting object. When `null`, the `node_to_node_encryption` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [aws.opensearch_domain.node_to_node_encryption.new](#fn-node_to_node_encryptionnew) constructor.\n - `off_peak_window_options` (`list[obj]`): Set the `off_peak_window_options` field on the resulting object. When `null`, the `off_peak_window_options` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [aws.opensearch_domain.off_peak_window_options.new](#fn-off_peak_window_optionsnew) constructor.\n - `snapshot_options` (`list[obj]`): Set the `snapshot_options` field on the resulting object. When `null`, the `snapshot_options` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [aws.opensearch_domain.snapshot_options.new](#fn-snapshot_optionsnew) constructor.\n - `timeouts` (`obj`): Set the `timeouts` field on the resulting object. When `null`, the `timeouts` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [aws.opensearch_domain.timeouts.new](#fn-timeoutsnew) constructor.\n - `vpc_options` (`list[obj]`): Set the `vpc_options` field on the resulting object. When `null`, the `vpc_options` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [aws.opensearch_domain.vpc_options.new](#fn-vpc_optionsnew) constructor.\n\n**Returns**:\n - An attribute object that can be used with [tf.withResource](https://github.com/tf-libsonnet/core/tree/main/docs#fn-withresource) to construct a new `opensearch_domain` resource into the root Terraform configuration.\n', args=[]), + '#newAttrs':: d.fn(help='\n`aws.opensearch_domain.newAttrs` constructs a new object with attributes and blocks configured for the `opensearch_domain`\nTerraform resource.\n\nUnlike [aws.opensearch_domain.new](#fn-new), this function will not inject the `resource`\nblock into the root Terraform document. Instead, this must be passed in as the `attrs` argument for the\n[tf.withResource](https://github.com/tf-libsonnet/core/tree/main/docs#fn-withresource) function to build a complete block.\n\nThis is most useful when you need to preprocess the attributes with functions, conditional, or looping logic prior to\ninjecting into a complete block.\n\n**Args**:\n - `access_policies` (`string`): Set the `access_policies` field on the resulting object. When `null`, the `access_policies` field will be omitted from the resulting object.\n - `advanced_options` (`obj`): Set the `advanced_options` field on the resulting object. When `null`, the `advanced_options` field will be omitted from the resulting object.\n - `domain_name` (`string`): Set the `domain_name` field on the resulting object.\n - `engine_version` (`string`): Set the `engine_version` field on the resulting object. When `null`, the `engine_version` field will be omitted from the resulting object.\n - `tags` (`obj`): Set the `tags` field on the resulting object. When `null`, the `tags` field will be omitted from the resulting object.\n - `tags_all` (`obj`): Set the `tags_all` field on the resulting object. When `null`, the `tags_all` field will be omitted from the resulting object.\n - `advanced_security_options` (`list[obj]`): Set the `advanced_security_options` field on the resulting object. When `null`, the `advanced_security_options` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [aws.opensearch_domain.advanced_security_options.new](#fn-advanced_security_optionsnew) constructor.\n - `auto_tune_options` (`list[obj]`): Set the `auto_tune_options` field on the resulting object. When `null`, the `auto_tune_options` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [aws.opensearch_domain.auto_tune_options.new](#fn-auto_tune_optionsnew) constructor.\n - `cluster_config` (`list[obj]`): Set the `cluster_config` field on the resulting object. When `null`, the `cluster_config` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [aws.opensearch_domain.cluster_config.new](#fn-cluster_confignew) constructor.\n - `cognito_options` (`list[obj]`): Set the `cognito_options` field on the resulting object. When `null`, the `cognito_options` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [aws.opensearch_domain.cognito_options.new](#fn-cognito_optionsnew) constructor.\n - `domain_endpoint_options` (`list[obj]`): Set the `domain_endpoint_options` field on the resulting object. When `null`, the `domain_endpoint_options` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [aws.opensearch_domain.domain_endpoint_options.new](#fn-domain_endpoint_optionsnew) constructor.\n - `ebs_options` (`list[obj]`): Set the `ebs_options` field on the resulting object. When `null`, the `ebs_options` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [aws.opensearch_domain.ebs_options.new](#fn-ebs_optionsnew) constructor.\n - `encrypt_at_rest` (`list[obj]`): Set the `encrypt_at_rest` field on the resulting object. When `null`, the `encrypt_at_rest` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [aws.opensearch_domain.encrypt_at_rest.new](#fn-encrypt_at_restnew) constructor.\n - `log_publishing_options` (`list[obj]`): Set the `log_publishing_options` field on the resulting object. When `null`, the `log_publishing_options` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [aws.opensearch_domain.log_publishing_options.new](#fn-log_publishing_optionsnew) constructor.\n - `node_to_node_encryption` (`list[obj]`): Set the `node_to_node_encryption` field on the resulting object. When `null`, the `node_to_node_encryption` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [aws.opensearch_domain.node_to_node_encryption.new](#fn-node_to_node_encryptionnew) constructor.\n - `off_peak_window_options` (`list[obj]`): Set the `off_peak_window_options` field on the resulting object. When `null`, the `off_peak_window_options` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [aws.opensearch_domain.off_peak_window_options.new](#fn-off_peak_window_optionsnew) constructor.\n - `snapshot_options` (`list[obj]`): Set the `snapshot_options` field on the resulting object. When `null`, the `snapshot_options` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [aws.opensearch_domain.snapshot_options.new](#fn-snapshot_optionsnew) constructor.\n - `software_update_options` (`list[obj]`): Set the `software_update_options` field on the resulting object. When `null`, the `software_update_options` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [aws.opensearch_domain.software_update_options.new](#fn-software_update_optionsnew) constructor.\n - `timeouts` (`obj`): Set the `timeouts` field on the resulting object. When `null`, the `timeouts` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [aws.opensearch_domain.timeouts.new](#fn-timeoutsnew) constructor.\n - `vpc_options` (`list[obj]`): Set the `vpc_options` field on the resulting object. When `null`, the `vpc_options` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [aws.opensearch_domain.vpc_options.new](#fn-vpc_optionsnew) constructor.\n\n**Returns**:\n - An attribute object that can be used with [tf.withResource](https://github.com/tf-libsonnet/core/tree/main/docs#fn-withresource) to construct a new `opensearch_domain` resource into the root Terraform configuration.\n', args=[]), newAttrs( domain_name, access_policies=null, @@ -240,6 +244,7 @@ local d = (import 'github.com/jsonnet-libs/docsonnet/doc-util/main.libsonnet'); node_to_node_encryption=null, off_peak_window_options=null, snapshot_options=null, + software_update_options=null, tags=null, tags_all=null, timeouts=null, @@ -260,6 +265,7 @@ local d = (import 'github.com/jsonnet-libs/docsonnet/doc-util/main.libsonnet'); node_to_node_encryption: node_to_node_encryption, off_peak_window_options: off_peak_window_options, snapshot_options: snapshot_options, + software_update_options: software_update_options, tags: tags, tags_all: tags_all, timeouts: timeouts, @@ -309,6 +315,14 @@ local d = (import 'github.com/jsonnet-libs/docsonnet/doc-util/main.libsonnet'); automated_snapshot_start_hour: automated_snapshot_start_hour, }), }, + software_update_options:: { + '#new':: d.fn(help='\n`aws.opensearch_domain.software_update_options.new` constructs a new object with attributes and blocks configured for the `software_update_options`\nTerraform sub block.\n\n\n\n**Args**:\n - `auto_software_update_enabled` (`bool`): Set the `auto_software_update_enabled` field on the resulting object. When `null`, the `auto_software_update_enabled` field will be omitted from the resulting object.\n\n**Returns**:\n - An attribute object that represents the `software_update_options` sub block.\n', args=[]), + new( + auto_software_update_enabled=null + ):: std.prune(a={ + auto_software_update_enabled: auto_software_update_enabled, + }), + }, timeouts:: { '#new':: d.fn(help='\n`aws.opensearch_domain.timeouts.new` constructs a new object with attributes and blocks configured for the `timeouts`\nTerraform sub block.\n\n\n\n**Args**:\n - `create` (`string`): Set the `create` field on the resulting object. When `null`, the `create` field will be omitted from the resulting object.\n - `delete` (`string`): Set the `delete` field on the resulting object. When `null`, the `delete` field will be omitted from the resulting object.\n - `update` (`string`): Set the `update` field on the resulting object. When `null`, the `update` field will be omitted from the resulting object.\n\n**Returns**:\n - An attribute object that represents the `timeouts` sub block.\n', args=[]), new( @@ -591,6 +605,26 @@ local d = (import 'github.com/jsonnet-libs/docsonnet/doc-util/main.libsonnet'); }, }, }, + '#withSoftwareUpdateOptions':: d.fn(help='`aws.list[obj].withSoftwareUpdateOptions` constructs a mixin object that can be merged into the `list[obj]`\nTerraform resource block to set or update the software_update_options field.\n\nThis function will replace the array with the passed in `value`. If you wish to instead append the\npassed in value to the existing array, use the [aws.list[obj].withSoftwareUpdateOptionsMixin](TODO) function.\n\n\n**Args**:\n - `resourceLabel` (`string`): The name label of the block to update.\n - `value` (`list[obj]`): The value to set for the `software_update_options` field.\n', args=[]), + withSoftwareUpdateOptions(resourceLabel, value): { + resource+: { + aws_opensearch_domain+: { + [resourceLabel]+: { + software_update_options: value, + }, + }, + }, + }, + '#withSoftwareUpdateOptionsMixin':: d.fn(help='`aws.list[obj].withSoftwareUpdateOptionsMixin` constructs a mixin object that can be merged into the `list[obj]`\nTerraform resource block to set or update the software_update_options field.\n\nThis function will append the passed in array or object to the existing array. If you wish\nto instead replace the array with the passed in `value`, use the [aws.list[obj].withSoftwareUpdateOptions](TODO)\nfunction.\n\n\n**Args**:\n - `resourceLabel` (`string`): The name label of the block to update.\n - `value` (`list[obj]`): The value to set for the `software_update_options` field.\n', args=[]), + withSoftwareUpdateOptionsMixin(resourceLabel, value): { + resource+: { + aws_opensearch_domain+: { + [resourceLabel]+: { + software_update_options+: if std.isArray(v=value) then value else [value], + }, + }, + }, + }, '#withTags':: d.fn(help='`aws.obj.withTags` constructs a mixin object that can be merged into the `obj`\nTerraform resource block to set or update the tags field.\n\n\n\n**Args**:\n - `resourceLabel` (`string`): The name label of the block to update.\n - `value` (`obj`): The value to set for the `tags` field.\n', args=[]), withTags(resourceLabel, value): { resource+: { diff --git a/5.x/_gen/resources/opensearch_vpc_endpoint.libsonnet b/5.x/_gen/resources/opensearch_vpc_endpoint.libsonnet new file mode 100644 index 00000000..7feb8cfc --- /dev/null +++ b/5.x/_gen/resources/opensearch_vpc_endpoint.libsonnet @@ -0,0 +1,100 @@ +local tf = (import 'github.com/tf-libsonnet/core/main.libsonnet'); +local d = (import 'github.com/jsonnet-libs/docsonnet/doc-util/main.libsonnet'); +{ + '#':: d.pkg(name='opensearch_vpc_endpoint', url='', help='`opensearch_vpc_endpoint` represents the `aws_opensearch_vpc_endpoint` Terraform resource.\n\n\n\nThis package contains functions and utilities for setting up the resource using Jsonnet code.\n'), + '#new':: d.fn(help="\n`aws.opensearch_vpc_endpoint.new` injects a new `aws_opensearch_vpc_endpoint` Terraform `resource`\nblock into the root module document.\n\nAdditionally, this inserts a private function into the `_ref` attribute that generates references to attributes of the\nresource. For example, if you added a new instance to the root using:\n\n # arguments omitted for brevity\n aws.opensearch_vpc_endpoint.new('some_id')\n\nYou can get the reference to the `id` field of the created `aws.opensearch_vpc_endpoint` using the reference:\n\n $._ref.aws_opensearch_vpc_endpoint.some_id.get('id')\n\nThis is the same as directly entering `\"${ aws_opensearch_vpc_endpoint.some_id.id }\"` as the value.\n\nNOTE: if you are chaining multiple resources together in a merge operation, you may not be able to use `super`, `self`,\nor `$` to refer to the root object. Instead, make an explicit outer object using `local`.\n\n**Args**:\n - `resourceLabel` (`string`): The name label of the block.\n - `domain_arn` (`string`): Set the `domain_arn` field on the resulting resource block.\n - `timeouts` (`obj`): Set the `timeouts` field on the resulting resource block. When `null`, the `timeouts` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [aws.opensearch_vpc_endpoint.timeouts.new](#fn-timeoutsnew) constructor.\n - `vpc_options` (`list[obj]`): Set the `vpc_options` field on the resulting resource block. When `null`, the `vpc_options` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [aws.opensearch_vpc_endpoint.vpc_options.new](#fn-vpc_optionsnew) constructor.\n\n**Returns**:\n- A mixin object that injects the new resource into the root Terraform configuration.\n", args=[]), + new( + resourceLabel, + domain_arn, + timeouts=null, + vpc_options=null, + _meta={} + ):: tf.withResource( + type='aws_opensearch_vpc_endpoint', + label=resourceLabel, + attrs=self.newAttrs(domain_arn=domain_arn, timeouts=timeouts, vpc_options=vpc_options), + _meta=_meta + ), + '#newAttrs':: d.fn(help='\n`aws.opensearch_vpc_endpoint.newAttrs` constructs a new object with attributes and blocks configured for the `opensearch_vpc_endpoint`\nTerraform resource.\n\nUnlike [aws.opensearch_vpc_endpoint.new](#fn-new), this function will not inject the `resource`\nblock into the root Terraform document. Instead, this must be passed in as the `attrs` argument for the\n[tf.withResource](https://github.com/tf-libsonnet/core/tree/main/docs#fn-withresource) function to build a complete block.\n\nThis is most useful when you need to preprocess the attributes with functions, conditional, or looping logic prior to\ninjecting into a complete block.\n\n**Args**:\n - `domain_arn` (`string`): Set the `domain_arn` field on the resulting object.\n - `timeouts` (`obj`): Set the `timeouts` field on the resulting object. When `null`, the `timeouts` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [aws.opensearch_vpc_endpoint.timeouts.new](#fn-timeoutsnew) constructor.\n - `vpc_options` (`list[obj]`): Set the `vpc_options` field on the resulting object. When `null`, the `vpc_options` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [aws.opensearch_vpc_endpoint.vpc_options.new](#fn-vpc_optionsnew) constructor.\n\n**Returns**:\n - An attribute object that can be used with [tf.withResource](https://github.com/tf-libsonnet/core/tree/main/docs#fn-withresource) to construct a new `opensearch_vpc_endpoint` resource into the root Terraform configuration.\n', args=[]), + newAttrs( + domain_arn, + timeouts=null, + vpc_options=null + ):: std.prune(a={ + domain_arn: domain_arn, + timeouts: timeouts, + vpc_options: vpc_options, + }), + timeouts:: { + '#new':: d.fn(help='\n`aws.opensearch_vpc_endpoint.timeouts.new` constructs a new object with attributes and blocks configured for the `timeouts`\nTerraform sub block.\n\n\n\n**Args**:\n - `create` (`string`): Set the `create` field on the resulting object. When `null`, the `create` field will be omitted from the resulting object.\n - `delete` (`string`): Set the `delete` field on the resulting object. When `null`, the `delete` field will be omitted from the resulting object.\n - `update` (`string`): Set the `update` field on the resulting object. When `null`, the `update` field will be omitted from the resulting object.\n\n**Returns**:\n - An attribute object that represents the `timeouts` sub block.\n', args=[]), + new( + create=null, + delete=null, + update=null + ):: std.prune(a={ + create: create, + delete: delete, + update: update, + }), + }, + vpc_options:: { + '#new':: d.fn(help='\n`aws.opensearch_vpc_endpoint.vpc_options.new` constructs a new object with attributes and blocks configured for the `vpc_options`\nTerraform sub block.\n\n\n\n**Args**:\n - `security_group_ids` (`list`): Set the `security_group_ids` field on the resulting object. When `null`, the `security_group_ids` field will be omitted from the resulting object.\n - `subnet_ids` (`list`): Set the `subnet_ids` field on the resulting object.\n\n**Returns**:\n - An attribute object that represents the `vpc_options` sub block.\n', args=[]), + new( + subnet_ids, + security_group_ids=null + ):: std.prune(a={ + security_group_ids: security_group_ids, + subnet_ids: subnet_ids, + }), + }, + '#withDomainArn':: d.fn(help='`aws.string.withDomainArn` constructs a mixin object that can be merged into the `string`\nTerraform resource block to set or update the domain_arn field.\n\n\n\n**Args**:\n - `resourceLabel` (`string`): The name label of the block to update.\n - `value` (`string`): The value to set for the `domain_arn` field.\n', args=[]), + withDomainArn(resourceLabel, value): { + resource+: { + aws_opensearch_vpc_endpoint+: { + [resourceLabel]+: { + domain_arn: value, + }, + }, + }, + }, + '#withTimeouts':: d.fn(help='`aws.obj.withTimeouts` constructs a mixin object that can be merged into the `obj`\nTerraform resource block to set or update the timeouts field.\n\nThis function will replace the map with the passed in `value`. If you wish to instead merge the\npassed in value to the existing map, use the [aws.obj.withTimeoutsMixin](TODO) function.\n\n**Args**:\n - `resourceLabel` (`string`): The name label of the block to update.\n - `value` (`obj`): The value to set for the `timeouts` field.\n', args=[]), + withTimeouts(resourceLabel, value): { + resource+: { + aws_opensearch_vpc_endpoint+: { + [resourceLabel]+: { + timeouts: value, + }, + }, + }, + }, + '#withTimeoutsMixin':: d.fn(help='`aws.obj.withTimeoutsMixin` constructs a mixin object that can be merged into the `obj`\nTerraform resource block to set or update the timeouts field.\n\nThis function will merge the passed in value to the existing map. If you wish\nto instead replace the entire map with the passed in `value`, use the [aws.obj.withTimeouts](TODO)\nfunction.\n\n\n**Args**:\n - `resourceLabel` (`string`): The name label of the block to update.\n - `value` (`obj`): The value to set for the `timeouts` field.\n', args=[]), + withTimeoutsMixin(resourceLabel, value): { + resource+: { + aws_opensearch_vpc_endpoint+: { + [resourceLabel]+: { + timeouts+: value, + }, + }, + }, + }, + '#withVpcOptions':: d.fn(help='`aws.list[obj].withVpcOptions` constructs a mixin object that can be merged into the `list[obj]`\nTerraform resource block to set or update the vpc_options field.\n\nThis function will replace the array with the passed in `value`. If you wish to instead append the\npassed in value to the existing array, use the [aws.list[obj].withVpcOptionsMixin](TODO) function.\n\n\n**Args**:\n - `resourceLabel` (`string`): The name label of the block to update.\n - `value` (`list[obj]`): The value to set for the `vpc_options` field.\n', args=[]), + withVpcOptions(resourceLabel, value): { + resource+: { + aws_opensearch_vpc_endpoint+: { + [resourceLabel]+: { + vpc_options: value, + }, + }, + }, + }, + '#withVpcOptionsMixin':: d.fn(help='`aws.list[obj].withVpcOptionsMixin` constructs a mixin object that can be merged into the `list[obj]`\nTerraform resource block to set or update the vpc_options field.\n\nThis function will append the passed in array or object to the existing array. If you wish\nto instead replace the array with the passed in `value`, use the [aws.list[obj].withVpcOptions](TODO)\nfunction.\n\n\n**Args**:\n - `resourceLabel` (`string`): The name label of the block to update.\n - `value` (`list[obj]`): The value to set for the `vpc_options` field.\n', args=[]), + withVpcOptionsMixin(resourceLabel, value): { + resource+: { + aws_opensearch_vpc_endpoint+: { + [resourceLabel]+: { + vpc_options+: if std.isArray(v=value) then value else [value], + }, + }, + }, + }, +} diff --git a/5.x/_gen/resources/ram_sharing_with_organization.libsonnet b/5.x/_gen/resources/ram_sharing_with_organization.libsonnet new file mode 100644 index 00000000..ab4cbe3d --- /dev/null +++ b/5.x/_gen/resources/ram_sharing_with_organization.libsonnet @@ -0,0 +1,19 @@ +local tf = (import 'github.com/tf-libsonnet/core/main.libsonnet'); +local d = (import 'github.com/jsonnet-libs/docsonnet/doc-util/main.libsonnet'); +{ + '#':: d.pkg(name='ram_sharing_with_organization', url='', help='`ram_sharing_with_organization` represents the `aws_ram_sharing_with_organization` Terraform resource.\n\n\n\nThis package contains functions and utilities for setting up the resource using Jsonnet code.\n'), + '#new':: d.fn(help="\n`aws.ram_sharing_with_organization.new` injects a new `aws_ram_sharing_with_organization` Terraform `resource`\nblock into the root module document.\n\nAdditionally, this inserts a private function into the `_ref` attribute that generates references to attributes of the\nresource. For example, if you added a new instance to the root using:\n\n # arguments omitted for brevity\n aws.ram_sharing_with_organization.new('some_id')\n\nYou can get the reference to the `id` field of the created `aws.ram_sharing_with_organization` using the reference:\n\n $._ref.aws_ram_sharing_with_organization.some_id.get('id')\n\nThis is the same as directly entering `\"${ aws_ram_sharing_with_organization.some_id.id }\"` as the value.\n\nNOTE: if you are chaining multiple resources together in a merge operation, you may not be able to use `super`, `self`,\nor `$` to refer to the root object. Instead, make an explicit outer object using `local`.\n\n**Args**:\n - `resourceLabel` (`string`): The name label of the block.\n\n**Returns**:\n- A mixin object that injects the new resource into the root Terraform configuration.\n", args=[]), + new( + resourceLabel, + _meta={} + ):: tf.withResource( + type='aws_ram_sharing_with_organization', + label=resourceLabel, + attrs=self.newAttrs(), + _meta=_meta + ), + '#newAttrs':: d.fn(help='\n`aws.ram_sharing_with_organization.newAttrs` constructs a new object with attributes and blocks configured for the `ram_sharing_with_organization`\nTerraform resource.\n\nUnlike [aws.ram_sharing_with_organization.new](#fn-new), this function will not inject the `resource`\nblock into the root Terraform document. Instead, this must be passed in as the `attrs` argument for the\n[tf.withResource](https://github.com/tf-libsonnet/core/tree/main/docs#fn-withresource) function to build a complete block.\n\nThis is most useful when you need to preprocess the attributes with functions, conditional, or looping logic prior to\ninjecting into a complete block.\n\n**Returns**:\n - An attribute object that can be used with [tf.withResource](https://github.com/tf-libsonnet/core/tree/main/docs#fn-withresource) to construct a new `ram_sharing_with_organization` resource into the root Terraform configuration.\n', args=[]), + newAttrs( + + ):: std.prune(a={}), +} diff --git a/5.x/_gen/resources/s3_object.libsonnet b/5.x/_gen/resources/s3_object.libsonnet index a51ca4f3..301e5a4d 100644 --- a/5.x/_gen/resources/s3_object.libsonnet +++ b/5.x/_gen/resources/s3_object.libsonnet @@ -2,7 +2,7 @@ local tf = (import 'github.com/tf-libsonnet/core/main.libsonnet'); local d = (import 'github.com/jsonnet-libs/docsonnet/doc-util/main.libsonnet'); { '#':: d.pkg(name='s3_object', url='', help='`s3_object` represents the `aws_s3_object` Terraform resource.\n\n\n\nThis package contains functions and utilities for setting up the resource using Jsonnet code.\n'), - '#new':: d.fn(help="\n`aws.s3_object.new` injects a new `aws_s3_object` Terraform `resource`\nblock into the root module document.\n\nAdditionally, this inserts a private function into the `_ref` attribute that generates references to attributes of the\nresource. For example, if you added a new instance to the root using:\n\n # arguments omitted for brevity\n aws.s3_object.new('some_id')\n\nYou can get the reference to the `id` field of the created `aws.s3_object` using the reference:\n\n $._ref.aws_s3_object.some_id.get('id')\n\nThis is the same as directly entering `\"${ aws_s3_object.some_id.id }\"` as the value.\n\nNOTE: if you are chaining multiple resources together in a merge operation, you may not be able to use `super`, `self`,\nor `$` to refer to the root object. Instead, make an explicit outer object using `local`.\n\n**Args**:\n - `resourceLabel` (`string`): The name label of the block.\n - `acl` (`string`): Set the `acl` field on the resulting resource block. When `null`, the `acl` field will be omitted from the resulting object.\n - `bucket` (`string`): Set the `bucket` field on the resulting resource block.\n - `bucket_key_enabled` (`bool`): Set the `bucket_key_enabled` field on the resulting resource block. When `null`, the `bucket_key_enabled` field will be omitted from the resulting object.\n - `cache_control` (`string`): Set the `cache_control` field on the resulting resource block. When `null`, the `cache_control` field will be omitted from the resulting object.\n - `content` (`string`): Set the `content` field on the resulting resource block. When `null`, the `content` field will be omitted from the resulting object.\n - `content_base64` (`string`): Set the `content_base64` field on the resulting resource block. When `null`, the `content_base64` field will be omitted from the resulting object.\n - `content_disposition` (`string`): Set the `content_disposition` field on the resulting resource block. When `null`, the `content_disposition` field will be omitted from the resulting object.\n - `content_encoding` (`string`): Set the `content_encoding` field on the resulting resource block. When `null`, the `content_encoding` field will be omitted from the resulting object.\n - `content_language` (`string`): Set the `content_language` field on the resulting resource block. When `null`, the `content_language` field will be omitted from the resulting object.\n - `content_type` (`string`): Set the `content_type` field on the resulting resource block. When `null`, the `content_type` field will be omitted from the resulting object.\n - `etag` (`string`): Set the `etag` field on the resulting resource block. When `null`, the `etag` field will be omitted from the resulting object.\n - `force_destroy` (`bool`): Set the `force_destroy` field on the resulting resource block. When `null`, the `force_destroy` field will be omitted from the resulting object.\n - `key` (`string`): Set the `key` field on the resulting resource block.\n - `kms_key_id` (`string`): Set the `kms_key_id` field on the resulting resource block. When `null`, the `kms_key_id` field will be omitted from the resulting object.\n - `metadata` (`obj`): Set the `metadata` field on the resulting resource block. When `null`, the `metadata` field will be omitted from the resulting object.\n - `object_lock_legal_hold_status` (`string`): Set the `object_lock_legal_hold_status` field on the resulting resource block. When `null`, the `object_lock_legal_hold_status` field will be omitted from the resulting object.\n - `object_lock_mode` (`string`): Set the `object_lock_mode` field on the resulting resource block. When `null`, the `object_lock_mode` field will be omitted from the resulting object.\n - `object_lock_retain_until_date` (`string`): Set the `object_lock_retain_until_date` field on the resulting resource block. When `null`, the `object_lock_retain_until_date` field will be omitted from the resulting object.\n - `server_side_encryption` (`string`): Set the `server_side_encryption` field on the resulting resource block. When `null`, the `server_side_encryption` field will be omitted from the resulting object.\n - `source` (`string`): Set the `source` field on the resulting resource block. When `null`, the `source` field will be omitted from the resulting object.\n - `source_hash` (`string`): Set the `source_hash` field on the resulting resource block. When `null`, the `source_hash` field will be omitted from the resulting object.\n - `storage_class` (`string`): Set the `storage_class` field on the resulting resource block. When `null`, the `storage_class` field will be omitted from the resulting object.\n - `tags` (`obj`): Set the `tags` field on the resulting resource block. When `null`, the `tags` field will be omitted from the resulting object.\n - `tags_all` (`obj`): Set the `tags_all` field on the resulting resource block. When `null`, the `tags_all` field will be omitted from the resulting object.\n - `website_redirect` (`string`): Set the `website_redirect` field on the resulting resource block. When `null`, the `website_redirect` field will be omitted from the resulting object.\n\n**Returns**:\n- A mixin object that injects the new resource into the root Terraform configuration.\n", args=[]), + '#new':: d.fn(help="\n`aws.s3_object.new` injects a new `aws_s3_object` Terraform `resource`\nblock into the root module document.\n\nAdditionally, this inserts a private function into the `_ref` attribute that generates references to attributes of the\nresource. For example, if you added a new instance to the root using:\n\n # arguments omitted for brevity\n aws.s3_object.new('some_id')\n\nYou can get the reference to the `id` field of the created `aws.s3_object` using the reference:\n\n $._ref.aws_s3_object.some_id.get('id')\n\nThis is the same as directly entering `\"${ aws_s3_object.some_id.id }\"` as the value.\n\nNOTE: if you are chaining multiple resources together in a merge operation, you may not be able to use `super`, `self`,\nor `$` to refer to the root object. Instead, make an explicit outer object using `local`.\n\n**Args**:\n - `resourceLabel` (`string`): The name label of the block.\n - `acl` (`string`): Set the `acl` field on the resulting resource block. When `null`, the `acl` field will be omitted from the resulting object.\n - `bucket` (`string`): Set the `bucket` field on the resulting resource block.\n - `bucket_key_enabled` (`bool`): Set the `bucket_key_enabled` field on the resulting resource block. When `null`, the `bucket_key_enabled` field will be omitted from the resulting object.\n - `cache_control` (`string`): Set the `cache_control` field on the resulting resource block. When `null`, the `cache_control` field will be omitted from the resulting object.\n - `checksum_algorithm` (`string`): Set the `checksum_algorithm` field on the resulting resource block. When `null`, the `checksum_algorithm` field will be omitted from the resulting object.\n - `content` (`string`): Set the `content` field on the resulting resource block. When `null`, the `content` field will be omitted from the resulting object.\n - `content_base64` (`string`): Set the `content_base64` field on the resulting resource block. When `null`, the `content_base64` field will be omitted from the resulting object.\n - `content_disposition` (`string`): Set the `content_disposition` field on the resulting resource block. When `null`, the `content_disposition` field will be omitted from the resulting object.\n - `content_encoding` (`string`): Set the `content_encoding` field on the resulting resource block. When `null`, the `content_encoding` field will be omitted from the resulting object.\n - `content_language` (`string`): Set the `content_language` field on the resulting resource block. When `null`, the `content_language` field will be omitted from the resulting object.\n - `content_type` (`string`): Set the `content_type` field on the resulting resource block. When `null`, the `content_type` field will be omitted from the resulting object.\n - `etag` (`string`): Set the `etag` field on the resulting resource block. When `null`, the `etag` field will be omitted from the resulting object.\n - `force_destroy` (`bool`): Set the `force_destroy` field on the resulting resource block. When `null`, the `force_destroy` field will be omitted from the resulting object.\n - `key` (`string`): Set the `key` field on the resulting resource block.\n - `kms_key_id` (`string`): Set the `kms_key_id` field on the resulting resource block. When `null`, the `kms_key_id` field will be omitted from the resulting object.\n - `metadata` (`obj`): Set the `metadata` field on the resulting resource block. When `null`, the `metadata` field will be omitted from the resulting object.\n - `object_lock_legal_hold_status` (`string`): Set the `object_lock_legal_hold_status` field on the resulting resource block. When `null`, the `object_lock_legal_hold_status` field will be omitted from the resulting object.\n - `object_lock_mode` (`string`): Set the `object_lock_mode` field on the resulting resource block. When `null`, the `object_lock_mode` field will be omitted from the resulting object.\n - `object_lock_retain_until_date` (`string`): Set the `object_lock_retain_until_date` field on the resulting resource block. When `null`, the `object_lock_retain_until_date` field will be omitted from the resulting object.\n - `server_side_encryption` (`string`): Set the `server_side_encryption` field on the resulting resource block. When `null`, the `server_side_encryption` field will be omitted from the resulting object.\n - `source` (`string`): Set the `source` field on the resulting resource block. When `null`, the `source` field will be omitted from the resulting object.\n - `source_hash` (`string`): Set the `source_hash` field on the resulting resource block. When `null`, the `source_hash` field will be omitted from the resulting object.\n - `storage_class` (`string`): Set the `storage_class` field on the resulting resource block. When `null`, the `storage_class` field will be omitted from the resulting object.\n - `tags` (`obj`): Set the `tags` field on the resulting resource block. When `null`, the `tags` field will be omitted from the resulting object.\n - `tags_all` (`obj`): Set the `tags_all` field on the resulting resource block. When `null`, the `tags_all` field will be omitted from the resulting object.\n - `website_redirect` (`string`): Set the `website_redirect` field on the resulting resource block. When `null`, the `website_redirect` field will be omitted from the resulting object.\n\n**Returns**:\n- A mixin object that injects the new resource into the root Terraform configuration.\n", args=[]), new( resourceLabel, bucket, @@ -10,6 +10,7 @@ local d = (import 'github.com/jsonnet-libs/docsonnet/doc-util/main.libsonnet'); acl=null, bucket_key_enabled=null, cache_control=null, + checksum_algorithm=null, content=null, content_base64=null, content_disposition=null, @@ -39,6 +40,7 @@ local d = (import 'github.com/jsonnet-libs/docsonnet/doc-util/main.libsonnet'); bucket=bucket, bucket_key_enabled=bucket_key_enabled, cache_control=cache_control, + checksum_algorithm=checksum_algorithm, content=content, content_base64=content_base64, content_disposition=content_disposition, @@ -63,13 +65,14 @@ local d = (import 'github.com/jsonnet-libs/docsonnet/doc-util/main.libsonnet'); ), _meta=_meta ), - '#newAttrs':: d.fn(help='\n`aws.s3_object.newAttrs` constructs a new object with attributes and blocks configured for the `s3_object`\nTerraform resource.\n\nUnlike [aws.s3_object.new](#fn-new), this function will not inject the `resource`\nblock into the root Terraform document. Instead, this must be passed in as the `attrs` argument for the\n[tf.withResource](https://github.com/tf-libsonnet/core/tree/main/docs#fn-withresource) function to build a complete block.\n\nThis is most useful when you need to preprocess the attributes with functions, conditional, or looping logic prior to\ninjecting into a complete block.\n\n**Args**:\n - `acl` (`string`): Set the `acl` field on the resulting object. When `null`, the `acl` field will be omitted from the resulting object.\n - `bucket` (`string`): Set the `bucket` field on the resulting object.\n - `bucket_key_enabled` (`bool`): Set the `bucket_key_enabled` field on the resulting object. When `null`, the `bucket_key_enabled` field will be omitted from the resulting object.\n - `cache_control` (`string`): Set the `cache_control` field on the resulting object. When `null`, the `cache_control` field will be omitted from the resulting object.\n - `content` (`string`): Set the `content` field on the resulting object. When `null`, the `content` field will be omitted from the resulting object.\n - `content_base64` (`string`): Set the `content_base64` field on the resulting object. When `null`, the `content_base64` field will be omitted from the resulting object.\n - `content_disposition` (`string`): Set the `content_disposition` field on the resulting object. When `null`, the `content_disposition` field will be omitted from the resulting object.\n - `content_encoding` (`string`): Set the `content_encoding` field on the resulting object. When `null`, the `content_encoding` field will be omitted from the resulting object.\n - `content_language` (`string`): Set the `content_language` field on the resulting object. When `null`, the `content_language` field will be omitted from the resulting object.\n - `content_type` (`string`): Set the `content_type` field on the resulting object. When `null`, the `content_type` field will be omitted from the resulting object.\n - `etag` (`string`): Set the `etag` field on the resulting object. When `null`, the `etag` field will be omitted from the resulting object.\n - `force_destroy` (`bool`): Set the `force_destroy` field on the resulting object. When `null`, the `force_destroy` field will be omitted from the resulting object.\n - `key` (`string`): Set the `key` field on the resulting object.\n - `kms_key_id` (`string`): Set the `kms_key_id` field on the resulting object. When `null`, the `kms_key_id` field will be omitted from the resulting object.\n - `metadata` (`obj`): Set the `metadata` field on the resulting object. When `null`, the `metadata` field will be omitted from the resulting object.\n - `object_lock_legal_hold_status` (`string`): Set the `object_lock_legal_hold_status` field on the resulting object. When `null`, the `object_lock_legal_hold_status` field will be omitted from the resulting object.\n - `object_lock_mode` (`string`): Set the `object_lock_mode` field on the resulting object. When `null`, the `object_lock_mode` field will be omitted from the resulting object.\n - `object_lock_retain_until_date` (`string`): Set the `object_lock_retain_until_date` field on the resulting object. When `null`, the `object_lock_retain_until_date` field will be omitted from the resulting object.\n - `server_side_encryption` (`string`): Set the `server_side_encryption` field on the resulting object. When `null`, the `server_side_encryption` field will be omitted from the resulting object.\n - `source` (`string`): Set the `source` field on the resulting object. When `null`, the `source` field will be omitted from the resulting object.\n - `source_hash` (`string`): Set the `source_hash` field on the resulting object. When `null`, the `source_hash` field will be omitted from the resulting object.\n - `storage_class` (`string`): Set the `storage_class` field on the resulting object. When `null`, the `storage_class` field will be omitted from the resulting object.\n - `tags` (`obj`): Set the `tags` field on the resulting object. When `null`, the `tags` field will be omitted from the resulting object.\n - `tags_all` (`obj`): Set the `tags_all` field on the resulting object. When `null`, the `tags_all` field will be omitted from the resulting object.\n - `website_redirect` (`string`): Set the `website_redirect` field on the resulting object. When `null`, the `website_redirect` field will be omitted from the resulting object.\n\n**Returns**:\n - An attribute object that can be used with [tf.withResource](https://github.com/tf-libsonnet/core/tree/main/docs#fn-withresource) to construct a new `s3_object` resource into the root Terraform configuration.\n', args=[]), + '#newAttrs':: d.fn(help='\n`aws.s3_object.newAttrs` constructs a new object with attributes and blocks configured for the `s3_object`\nTerraform resource.\n\nUnlike [aws.s3_object.new](#fn-new), this function will not inject the `resource`\nblock into the root Terraform document. Instead, this must be passed in as the `attrs` argument for the\n[tf.withResource](https://github.com/tf-libsonnet/core/tree/main/docs#fn-withresource) function to build a complete block.\n\nThis is most useful when you need to preprocess the attributes with functions, conditional, or looping logic prior to\ninjecting into a complete block.\n\n**Args**:\n - `acl` (`string`): Set the `acl` field on the resulting object. When `null`, the `acl` field will be omitted from the resulting object.\n - `bucket` (`string`): Set the `bucket` field on the resulting object.\n - `bucket_key_enabled` (`bool`): Set the `bucket_key_enabled` field on the resulting object. When `null`, the `bucket_key_enabled` field will be omitted from the resulting object.\n - `cache_control` (`string`): Set the `cache_control` field on the resulting object. When `null`, the `cache_control` field will be omitted from the resulting object.\n - `checksum_algorithm` (`string`): Set the `checksum_algorithm` field on the resulting object. When `null`, the `checksum_algorithm` field will be omitted from the resulting object.\n - `content` (`string`): Set the `content` field on the resulting object. When `null`, the `content` field will be omitted from the resulting object.\n - `content_base64` (`string`): Set the `content_base64` field on the resulting object. When `null`, the `content_base64` field will be omitted from the resulting object.\n - `content_disposition` (`string`): Set the `content_disposition` field on the resulting object. When `null`, the `content_disposition` field will be omitted from the resulting object.\n - `content_encoding` (`string`): Set the `content_encoding` field on the resulting object. When `null`, the `content_encoding` field will be omitted from the resulting object.\n - `content_language` (`string`): Set the `content_language` field on the resulting object. When `null`, the `content_language` field will be omitted from the resulting object.\n - `content_type` (`string`): Set the `content_type` field on the resulting object. When `null`, the `content_type` field will be omitted from the resulting object.\n - `etag` (`string`): Set the `etag` field on the resulting object. When `null`, the `etag` field will be omitted from the resulting object.\n - `force_destroy` (`bool`): Set the `force_destroy` field on the resulting object. When `null`, the `force_destroy` field will be omitted from the resulting object.\n - `key` (`string`): Set the `key` field on the resulting object.\n - `kms_key_id` (`string`): Set the `kms_key_id` field on the resulting object. When `null`, the `kms_key_id` field will be omitted from the resulting object.\n - `metadata` (`obj`): Set the `metadata` field on the resulting object. When `null`, the `metadata` field will be omitted from the resulting object.\n - `object_lock_legal_hold_status` (`string`): Set the `object_lock_legal_hold_status` field on the resulting object. When `null`, the `object_lock_legal_hold_status` field will be omitted from the resulting object.\n - `object_lock_mode` (`string`): Set the `object_lock_mode` field on the resulting object. When `null`, the `object_lock_mode` field will be omitted from the resulting object.\n - `object_lock_retain_until_date` (`string`): Set the `object_lock_retain_until_date` field on the resulting object. When `null`, the `object_lock_retain_until_date` field will be omitted from the resulting object.\n - `server_side_encryption` (`string`): Set the `server_side_encryption` field on the resulting object. When `null`, the `server_side_encryption` field will be omitted from the resulting object.\n - `source` (`string`): Set the `source` field on the resulting object. When `null`, the `source` field will be omitted from the resulting object.\n - `source_hash` (`string`): Set the `source_hash` field on the resulting object. When `null`, the `source_hash` field will be omitted from the resulting object.\n - `storage_class` (`string`): Set the `storage_class` field on the resulting object. When `null`, the `storage_class` field will be omitted from the resulting object.\n - `tags` (`obj`): Set the `tags` field on the resulting object. When `null`, the `tags` field will be omitted from the resulting object.\n - `tags_all` (`obj`): Set the `tags_all` field on the resulting object. When `null`, the `tags_all` field will be omitted from the resulting object.\n - `website_redirect` (`string`): Set the `website_redirect` field on the resulting object. When `null`, the `website_redirect` field will be omitted from the resulting object.\n\n**Returns**:\n - An attribute object that can be used with [tf.withResource](https://github.com/tf-libsonnet/core/tree/main/docs#fn-withresource) to construct a new `s3_object` resource into the root Terraform configuration.\n', args=[]), newAttrs( bucket, key, acl=null, bucket_key_enabled=null, cache_control=null, + checksum_algorithm=null, content=null, content_base64=null, content_disposition=null, @@ -95,6 +98,7 @@ local d = (import 'github.com/jsonnet-libs/docsonnet/doc-util/main.libsonnet'); bucket: bucket, bucket_key_enabled: bucket_key_enabled, cache_control: cache_control, + checksum_algorithm: checksum_algorithm, content: content, content_base64: content_base64, content_disposition: content_disposition, @@ -157,6 +161,16 @@ local d = (import 'github.com/jsonnet-libs/docsonnet/doc-util/main.libsonnet'); }, }, }, + '#withChecksumAlgorithm':: d.fn(help='`aws.string.withChecksumAlgorithm` constructs a mixin object that can be merged into the `string`\nTerraform resource block to set or update the checksum_algorithm field.\n\n\n\n**Args**:\n - `resourceLabel` (`string`): The name label of the block to update.\n - `value` (`string`): The value to set for the `checksum_algorithm` field.\n', args=[]), + withChecksumAlgorithm(resourceLabel, value): { + resource+: { + aws_s3_object+: { + [resourceLabel]+: { + checksum_algorithm: value, + }, + }, + }, + }, '#withContent':: d.fn(help='`aws.string.withContent` constructs a mixin object that can be merged into the `string`\nTerraform resource block to set or update the content field.\n\n\n\n**Args**:\n - `resourceLabel` (`string`): The name label of the block to update.\n - `value` (`string`): The value to set for the `content` field.\n', args=[]), withContent(resourceLabel, value): { resource+: { diff --git a/5.x/_gen/resources/s3_object_copy.libsonnet b/5.x/_gen/resources/s3_object_copy.libsonnet index b2420d69..54a878db 100644 --- a/5.x/_gen/resources/s3_object_copy.libsonnet +++ b/5.x/_gen/resources/s3_object_copy.libsonnet @@ -16,7 +16,7 @@ local d = (import 'github.com/jsonnet-libs/docsonnet/doc-util/main.libsonnet'); uri: uri, }), }, - '#new':: d.fn(help="\n`aws.s3_object_copy.new` injects a new `aws_s3_object_copy` Terraform `resource`\nblock into the root module document.\n\nAdditionally, this inserts a private function into the `_ref` attribute that generates references to attributes of the\nresource. For example, if you added a new instance to the root using:\n\n # arguments omitted for brevity\n aws.s3_object_copy.new('some_id')\n\nYou can get the reference to the `id` field of the created `aws.s3_object_copy` using the reference:\n\n $._ref.aws_s3_object_copy.some_id.get('id')\n\nThis is the same as directly entering `\"${ aws_s3_object_copy.some_id.id }\"` as the value.\n\nNOTE: if you are chaining multiple resources together in a merge operation, you may not be able to use `super`, `self`,\nor `$` to refer to the root object. Instead, make an explicit outer object using `local`.\n\n**Args**:\n - `resourceLabel` (`string`): The name label of the block.\n - `acl` (`string`): Set the `acl` field on the resulting resource block. When `null`, the `acl` field will be omitted from the resulting object.\n - `bucket` (`string`): Set the `bucket` field on the resulting resource block.\n - `bucket_key_enabled` (`bool`): Set the `bucket_key_enabled` field on the resulting resource block. When `null`, the `bucket_key_enabled` field will be omitted from the resulting object.\n - `cache_control` (`string`): Set the `cache_control` field on the resulting resource block. When `null`, the `cache_control` field will be omitted from the resulting object.\n - `content_disposition` (`string`): Set the `content_disposition` field on the resulting resource block. When `null`, the `content_disposition` field will be omitted from the resulting object.\n - `content_encoding` (`string`): Set the `content_encoding` field on the resulting resource block. When `null`, the `content_encoding` field will be omitted from the resulting object.\n - `content_language` (`string`): Set the `content_language` field on the resulting resource block. When `null`, the `content_language` field will be omitted from the resulting object.\n - `content_type` (`string`): Set the `content_type` field on the resulting resource block. When `null`, the `content_type` field will be omitted from the resulting object.\n - `copy_if_match` (`string`): Set the `copy_if_match` field on the resulting resource block. When `null`, the `copy_if_match` field will be omitted from the resulting object.\n - `copy_if_modified_since` (`string`): Set the `copy_if_modified_since` field on the resulting resource block. When `null`, the `copy_if_modified_since` field will be omitted from the resulting object.\n - `copy_if_none_match` (`string`): Set the `copy_if_none_match` field on the resulting resource block. When `null`, the `copy_if_none_match` field will be omitted from the resulting object.\n - `copy_if_unmodified_since` (`string`): Set the `copy_if_unmodified_since` field on the resulting resource block. When `null`, the `copy_if_unmodified_since` field will be omitted from the resulting object.\n - `customer_algorithm` (`string`): Set the `customer_algorithm` field on the resulting resource block. When `null`, the `customer_algorithm` field will be omitted from the resulting object.\n - `customer_key` (`string`): Set the `customer_key` field on the resulting resource block. When `null`, the `customer_key` field will be omitted from the resulting object.\n - `customer_key_md5` (`string`): Set the `customer_key_md5` field on the resulting resource block. When `null`, the `customer_key_md5` field will be omitted from the resulting object.\n - `expected_bucket_owner` (`string`): Set the `expected_bucket_owner` field on the resulting resource block. When `null`, the `expected_bucket_owner` field will be omitted from the resulting object.\n - `expected_source_bucket_owner` (`string`): Set the `expected_source_bucket_owner` field on the resulting resource block. When `null`, the `expected_source_bucket_owner` field will be omitted from the resulting object.\n - `expires` (`string`): Set the `expires` field on the resulting resource block. When `null`, the `expires` field will be omitted from the resulting object.\n - `force_destroy` (`bool`): Set the `force_destroy` field on the resulting resource block. When `null`, the `force_destroy` field will be omitted from the resulting object.\n - `key` (`string`): Set the `key` field on the resulting resource block.\n - `kms_encryption_context` (`string`): Set the `kms_encryption_context` field on the resulting resource block. When `null`, the `kms_encryption_context` field will be omitted from the resulting object.\n - `kms_key_id` (`string`): Set the `kms_key_id` field on the resulting resource block. When `null`, the `kms_key_id` field will be omitted from the resulting object.\n - `metadata` (`obj`): Set the `metadata` field on the resulting resource block. When `null`, the `metadata` field will be omitted from the resulting object.\n - `metadata_directive` (`string`): Set the `metadata_directive` field on the resulting resource block. When `null`, the `metadata_directive` field will be omitted from the resulting object.\n - `object_lock_legal_hold_status` (`string`): Set the `object_lock_legal_hold_status` field on the resulting resource block. When `null`, the `object_lock_legal_hold_status` field will be omitted from the resulting object.\n - `object_lock_mode` (`string`): Set the `object_lock_mode` field on the resulting resource block. When `null`, the `object_lock_mode` field will be omitted from the resulting object.\n - `object_lock_retain_until_date` (`string`): Set the `object_lock_retain_until_date` field on the resulting resource block. When `null`, the `object_lock_retain_until_date` field will be omitted from the resulting object.\n - `request_payer` (`string`): Set the `request_payer` field on the resulting resource block. When `null`, the `request_payer` field will be omitted from the resulting object.\n - `server_side_encryption` (`string`): Set the `server_side_encryption` field on the resulting resource block. When `null`, the `server_side_encryption` field will be omitted from the resulting object.\n - `source` (`string`): Set the `source` field on the resulting resource block.\n - `source_customer_algorithm` (`string`): Set the `source_customer_algorithm` field on the resulting resource block. When `null`, the `source_customer_algorithm` field will be omitted from the resulting object.\n - `source_customer_key` (`string`): Set the `source_customer_key` field on the resulting resource block. When `null`, the `source_customer_key` field will be omitted from the resulting object.\n - `source_customer_key_md5` (`string`): Set the `source_customer_key_md5` field on the resulting resource block. When `null`, the `source_customer_key_md5` field will be omitted from the resulting object.\n - `storage_class` (`string`): Set the `storage_class` field on the resulting resource block. When `null`, the `storage_class` field will be omitted from the resulting object.\n - `tagging_directive` (`string`): Set the `tagging_directive` field on the resulting resource block. When `null`, the `tagging_directive` field will be omitted from the resulting object.\n - `tags` (`obj`): Set the `tags` field on the resulting resource block. When `null`, the `tags` field will be omitted from the resulting object.\n - `tags_all` (`obj`): Set the `tags_all` field on the resulting resource block. When `null`, the `tags_all` field will be omitted from the resulting object.\n - `website_redirect` (`string`): Set the `website_redirect` field on the resulting resource block. When `null`, the `website_redirect` field will be omitted from the resulting object.\n - `grant` (`list[obj]`): Set the `grant` field on the resulting resource block. When `null`, the `grant` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [aws.s3_object_copy.grant.new](#fn-grantnew) constructor.\n\n**Returns**:\n- A mixin object that injects the new resource into the root Terraform configuration.\n", args=[]), + '#new':: d.fn(help="\n`aws.s3_object_copy.new` injects a new `aws_s3_object_copy` Terraform `resource`\nblock into the root module document.\n\nAdditionally, this inserts a private function into the `_ref` attribute that generates references to attributes of the\nresource. For example, if you added a new instance to the root using:\n\n # arguments omitted for brevity\n aws.s3_object_copy.new('some_id')\n\nYou can get the reference to the `id` field of the created `aws.s3_object_copy` using the reference:\n\n $._ref.aws_s3_object_copy.some_id.get('id')\n\nThis is the same as directly entering `\"${ aws_s3_object_copy.some_id.id }\"` as the value.\n\nNOTE: if you are chaining multiple resources together in a merge operation, you may not be able to use `super`, `self`,\nor `$` to refer to the root object. Instead, make an explicit outer object using `local`.\n\n**Args**:\n - `resourceLabel` (`string`): The name label of the block.\n - `acl` (`string`): Set the `acl` field on the resulting resource block. When `null`, the `acl` field will be omitted from the resulting object.\n - `bucket` (`string`): Set the `bucket` field on the resulting resource block.\n - `bucket_key_enabled` (`bool`): Set the `bucket_key_enabled` field on the resulting resource block. When `null`, the `bucket_key_enabled` field will be omitted from the resulting object.\n - `cache_control` (`string`): Set the `cache_control` field on the resulting resource block. When `null`, the `cache_control` field will be omitted from the resulting object.\n - `checksum_algorithm` (`string`): Set the `checksum_algorithm` field on the resulting resource block. When `null`, the `checksum_algorithm` field will be omitted from the resulting object.\n - `content_disposition` (`string`): Set the `content_disposition` field on the resulting resource block. When `null`, the `content_disposition` field will be omitted from the resulting object.\n - `content_encoding` (`string`): Set the `content_encoding` field on the resulting resource block. When `null`, the `content_encoding` field will be omitted from the resulting object.\n - `content_language` (`string`): Set the `content_language` field on the resulting resource block. When `null`, the `content_language` field will be omitted from the resulting object.\n - `content_type` (`string`): Set the `content_type` field on the resulting resource block. When `null`, the `content_type` field will be omitted from the resulting object.\n - `copy_if_match` (`string`): Set the `copy_if_match` field on the resulting resource block. When `null`, the `copy_if_match` field will be omitted from the resulting object.\n - `copy_if_modified_since` (`string`): Set the `copy_if_modified_since` field on the resulting resource block. When `null`, the `copy_if_modified_since` field will be omitted from the resulting object.\n - `copy_if_none_match` (`string`): Set the `copy_if_none_match` field on the resulting resource block. When `null`, the `copy_if_none_match` field will be omitted from the resulting object.\n - `copy_if_unmodified_since` (`string`): Set the `copy_if_unmodified_since` field on the resulting resource block. When `null`, the `copy_if_unmodified_since` field will be omitted from the resulting object.\n - `customer_algorithm` (`string`): Set the `customer_algorithm` field on the resulting resource block. When `null`, the `customer_algorithm` field will be omitted from the resulting object.\n - `customer_key` (`string`): Set the `customer_key` field on the resulting resource block. When `null`, the `customer_key` field will be omitted from the resulting object.\n - `customer_key_md5` (`string`): Set the `customer_key_md5` field on the resulting resource block. When `null`, the `customer_key_md5` field will be omitted from the resulting object.\n - `expected_bucket_owner` (`string`): Set the `expected_bucket_owner` field on the resulting resource block. When `null`, the `expected_bucket_owner` field will be omitted from the resulting object.\n - `expected_source_bucket_owner` (`string`): Set the `expected_source_bucket_owner` field on the resulting resource block. When `null`, the `expected_source_bucket_owner` field will be omitted from the resulting object.\n - `expires` (`string`): Set the `expires` field on the resulting resource block. When `null`, the `expires` field will be omitted from the resulting object.\n - `force_destroy` (`bool`): Set the `force_destroy` field on the resulting resource block. When `null`, the `force_destroy` field will be omitted from the resulting object.\n - `key` (`string`): Set the `key` field on the resulting resource block.\n - `kms_encryption_context` (`string`): Set the `kms_encryption_context` field on the resulting resource block. When `null`, the `kms_encryption_context` field will be omitted from the resulting object.\n - `kms_key_id` (`string`): Set the `kms_key_id` field on the resulting resource block. When `null`, the `kms_key_id` field will be omitted from the resulting object.\n - `metadata` (`obj`): Set the `metadata` field on the resulting resource block. When `null`, the `metadata` field will be omitted from the resulting object.\n - `metadata_directive` (`string`): Set the `metadata_directive` field on the resulting resource block. When `null`, the `metadata_directive` field will be omitted from the resulting object.\n - `object_lock_legal_hold_status` (`string`): Set the `object_lock_legal_hold_status` field on the resulting resource block. When `null`, the `object_lock_legal_hold_status` field will be omitted from the resulting object.\n - `object_lock_mode` (`string`): Set the `object_lock_mode` field on the resulting resource block. When `null`, the `object_lock_mode` field will be omitted from the resulting object.\n - `object_lock_retain_until_date` (`string`): Set the `object_lock_retain_until_date` field on the resulting resource block. When `null`, the `object_lock_retain_until_date` field will be omitted from the resulting object.\n - `request_payer` (`string`): Set the `request_payer` field on the resulting resource block. When `null`, the `request_payer` field will be omitted from the resulting object.\n - `server_side_encryption` (`string`): Set the `server_side_encryption` field on the resulting resource block. When `null`, the `server_side_encryption` field will be omitted from the resulting object.\n - `source` (`string`): Set the `source` field on the resulting resource block.\n - `source_customer_algorithm` (`string`): Set the `source_customer_algorithm` field on the resulting resource block. When `null`, the `source_customer_algorithm` field will be omitted from the resulting object.\n - `source_customer_key` (`string`): Set the `source_customer_key` field on the resulting resource block. When `null`, the `source_customer_key` field will be omitted from the resulting object.\n - `source_customer_key_md5` (`string`): Set the `source_customer_key_md5` field on the resulting resource block. When `null`, the `source_customer_key_md5` field will be omitted from the resulting object.\n - `storage_class` (`string`): Set the `storage_class` field on the resulting resource block. When `null`, the `storage_class` field will be omitted from the resulting object.\n - `tagging_directive` (`string`): Set the `tagging_directive` field on the resulting resource block. When `null`, the `tagging_directive` field will be omitted from the resulting object.\n - `tags` (`obj`): Set the `tags` field on the resulting resource block. When `null`, the `tags` field will be omitted from the resulting object.\n - `tags_all` (`obj`): Set the `tags_all` field on the resulting resource block. When `null`, the `tags_all` field will be omitted from the resulting object.\n - `website_redirect` (`string`): Set the `website_redirect` field on the resulting resource block. When `null`, the `website_redirect` field will be omitted from the resulting object.\n - `grant` (`list[obj]`): Set the `grant` field on the resulting resource block. When `null`, the `grant` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [aws.s3_object_copy.grant.new](#fn-grantnew) constructor.\n\n**Returns**:\n- A mixin object that injects the new resource into the root Terraform configuration.\n", args=[]), new( resourceLabel, bucket, @@ -25,6 +25,7 @@ local d = (import 'github.com/jsonnet-libs/docsonnet/doc-util/main.libsonnet'); acl=null, bucket_key_enabled=null, cache_control=null, + checksum_algorithm=null, content_disposition=null, content_encoding=null, content_language=null, @@ -67,6 +68,7 @@ local d = (import 'github.com/jsonnet-libs/docsonnet/doc-util/main.libsonnet'); bucket=bucket, bucket_key_enabled=bucket_key_enabled, cache_control=cache_control, + checksum_algorithm=checksum_algorithm, content_disposition=content_disposition, content_encoding=content_encoding, content_language=content_language, @@ -105,7 +107,7 @@ local d = (import 'github.com/jsonnet-libs/docsonnet/doc-util/main.libsonnet'); ), _meta=_meta ), - '#newAttrs':: d.fn(help='\n`aws.s3_object_copy.newAttrs` constructs a new object with attributes and blocks configured for the `s3_object_copy`\nTerraform resource.\n\nUnlike [aws.s3_object_copy.new](#fn-new), this function will not inject the `resource`\nblock into the root Terraform document. Instead, this must be passed in as the `attrs` argument for the\n[tf.withResource](https://github.com/tf-libsonnet/core/tree/main/docs#fn-withresource) function to build a complete block.\n\nThis is most useful when you need to preprocess the attributes with functions, conditional, or looping logic prior to\ninjecting into a complete block.\n\n**Args**:\n - `acl` (`string`): Set the `acl` field on the resulting object. When `null`, the `acl` field will be omitted from the resulting object.\n - `bucket` (`string`): Set the `bucket` field on the resulting object.\n - `bucket_key_enabled` (`bool`): Set the `bucket_key_enabled` field on the resulting object. When `null`, the `bucket_key_enabled` field will be omitted from the resulting object.\n - `cache_control` (`string`): Set the `cache_control` field on the resulting object. When `null`, the `cache_control` field will be omitted from the resulting object.\n - `content_disposition` (`string`): Set the `content_disposition` field on the resulting object. When `null`, the `content_disposition` field will be omitted from the resulting object.\n - `content_encoding` (`string`): Set the `content_encoding` field on the resulting object. When `null`, the `content_encoding` field will be omitted from the resulting object.\n - `content_language` (`string`): Set the `content_language` field on the resulting object. When `null`, the `content_language` field will be omitted from the resulting object.\n - `content_type` (`string`): Set the `content_type` field on the resulting object. When `null`, the `content_type` field will be omitted from the resulting object.\n - `copy_if_match` (`string`): Set the `copy_if_match` field on the resulting object. When `null`, the `copy_if_match` field will be omitted from the resulting object.\n - `copy_if_modified_since` (`string`): Set the `copy_if_modified_since` field on the resulting object. When `null`, the `copy_if_modified_since` field will be omitted from the resulting object.\n - `copy_if_none_match` (`string`): Set the `copy_if_none_match` field on the resulting object. When `null`, the `copy_if_none_match` field will be omitted from the resulting object.\n - `copy_if_unmodified_since` (`string`): Set the `copy_if_unmodified_since` field on the resulting object. When `null`, the `copy_if_unmodified_since` field will be omitted from the resulting object.\n - `customer_algorithm` (`string`): Set the `customer_algorithm` field on the resulting object. When `null`, the `customer_algorithm` field will be omitted from the resulting object.\n - `customer_key` (`string`): Set the `customer_key` field on the resulting object. When `null`, the `customer_key` field will be omitted from the resulting object.\n - `customer_key_md5` (`string`): Set the `customer_key_md5` field on the resulting object. When `null`, the `customer_key_md5` field will be omitted from the resulting object.\n - `expected_bucket_owner` (`string`): Set the `expected_bucket_owner` field on the resulting object. When `null`, the `expected_bucket_owner` field will be omitted from the resulting object.\n - `expected_source_bucket_owner` (`string`): Set the `expected_source_bucket_owner` field on the resulting object. When `null`, the `expected_source_bucket_owner` field will be omitted from the resulting object.\n - `expires` (`string`): Set the `expires` field on the resulting object. When `null`, the `expires` field will be omitted from the resulting object.\n - `force_destroy` (`bool`): Set the `force_destroy` field on the resulting object. When `null`, the `force_destroy` field will be omitted from the resulting object.\n - `key` (`string`): Set the `key` field on the resulting object.\n - `kms_encryption_context` (`string`): Set the `kms_encryption_context` field on the resulting object. When `null`, the `kms_encryption_context` field will be omitted from the resulting object.\n - `kms_key_id` (`string`): Set the `kms_key_id` field on the resulting object. When `null`, the `kms_key_id` field will be omitted from the resulting object.\n - `metadata` (`obj`): Set the `metadata` field on the resulting object. When `null`, the `metadata` field will be omitted from the resulting object.\n - `metadata_directive` (`string`): Set the `metadata_directive` field on the resulting object. When `null`, the `metadata_directive` field will be omitted from the resulting object.\n - `object_lock_legal_hold_status` (`string`): Set the `object_lock_legal_hold_status` field on the resulting object. When `null`, the `object_lock_legal_hold_status` field will be omitted from the resulting object.\n - `object_lock_mode` (`string`): Set the `object_lock_mode` field on the resulting object. When `null`, the `object_lock_mode` field will be omitted from the resulting object.\n - `object_lock_retain_until_date` (`string`): Set the `object_lock_retain_until_date` field on the resulting object. When `null`, the `object_lock_retain_until_date` field will be omitted from the resulting object.\n - `request_payer` (`string`): Set the `request_payer` field on the resulting object. When `null`, the `request_payer` field will be omitted from the resulting object.\n - `server_side_encryption` (`string`): Set the `server_side_encryption` field on the resulting object. When `null`, the `server_side_encryption` field will be omitted from the resulting object.\n - `source` (`string`): Set the `source` field on the resulting object.\n - `source_customer_algorithm` (`string`): Set the `source_customer_algorithm` field on the resulting object. When `null`, the `source_customer_algorithm` field will be omitted from the resulting object.\n - `source_customer_key` (`string`): Set the `source_customer_key` field on the resulting object. When `null`, the `source_customer_key` field will be omitted from the resulting object.\n - `source_customer_key_md5` (`string`): Set the `source_customer_key_md5` field on the resulting object. When `null`, the `source_customer_key_md5` field will be omitted from the resulting object.\n - `storage_class` (`string`): Set the `storage_class` field on the resulting object. When `null`, the `storage_class` field will be omitted from the resulting object.\n - `tagging_directive` (`string`): Set the `tagging_directive` field on the resulting object. When `null`, the `tagging_directive` field will be omitted from the resulting object.\n - `tags` (`obj`): Set the `tags` field on the resulting object. When `null`, the `tags` field will be omitted from the resulting object.\n - `tags_all` (`obj`): Set the `tags_all` field on the resulting object. When `null`, the `tags_all` field will be omitted from the resulting object.\n - `website_redirect` (`string`): Set the `website_redirect` field on the resulting object. When `null`, the `website_redirect` field will be omitted from the resulting object.\n - `grant` (`list[obj]`): Set the `grant` field on the resulting object. When `null`, the `grant` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [aws.s3_object_copy.grant.new](#fn-grantnew) constructor.\n\n**Returns**:\n - An attribute object that can be used with [tf.withResource](https://github.com/tf-libsonnet/core/tree/main/docs#fn-withresource) to construct a new `s3_object_copy` resource into the root Terraform configuration.\n', args=[]), + '#newAttrs':: d.fn(help='\n`aws.s3_object_copy.newAttrs` constructs a new object with attributes and blocks configured for the `s3_object_copy`\nTerraform resource.\n\nUnlike [aws.s3_object_copy.new](#fn-new), this function will not inject the `resource`\nblock into the root Terraform document. Instead, this must be passed in as the `attrs` argument for the\n[tf.withResource](https://github.com/tf-libsonnet/core/tree/main/docs#fn-withresource) function to build a complete block.\n\nThis is most useful when you need to preprocess the attributes with functions, conditional, or looping logic prior to\ninjecting into a complete block.\n\n**Args**:\n - `acl` (`string`): Set the `acl` field on the resulting object. When `null`, the `acl` field will be omitted from the resulting object.\n - `bucket` (`string`): Set the `bucket` field on the resulting object.\n - `bucket_key_enabled` (`bool`): Set the `bucket_key_enabled` field on the resulting object. When `null`, the `bucket_key_enabled` field will be omitted from the resulting object.\n - `cache_control` (`string`): Set the `cache_control` field on the resulting object. When `null`, the `cache_control` field will be omitted from the resulting object.\n - `checksum_algorithm` (`string`): Set the `checksum_algorithm` field on the resulting object. When `null`, the `checksum_algorithm` field will be omitted from the resulting object.\n - `content_disposition` (`string`): Set the `content_disposition` field on the resulting object. When `null`, the `content_disposition` field will be omitted from the resulting object.\n - `content_encoding` (`string`): Set the `content_encoding` field on the resulting object. When `null`, the `content_encoding` field will be omitted from the resulting object.\n - `content_language` (`string`): Set the `content_language` field on the resulting object. When `null`, the `content_language` field will be omitted from the resulting object.\n - `content_type` (`string`): Set the `content_type` field on the resulting object. When `null`, the `content_type` field will be omitted from the resulting object.\n - `copy_if_match` (`string`): Set the `copy_if_match` field on the resulting object. When `null`, the `copy_if_match` field will be omitted from the resulting object.\n - `copy_if_modified_since` (`string`): Set the `copy_if_modified_since` field on the resulting object. When `null`, the `copy_if_modified_since` field will be omitted from the resulting object.\n - `copy_if_none_match` (`string`): Set the `copy_if_none_match` field on the resulting object. When `null`, the `copy_if_none_match` field will be omitted from the resulting object.\n - `copy_if_unmodified_since` (`string`): Set the `copy_if_unmodified_since` field on the resulting object. When `null`, the `copy_if_unmodified_since` field will be omitted from the resulting object.\n - `customer_algorithm` (`string`): Set the `customer_algorithm` field on the resulting object. When `null`, the `customer_algorithm` field will be omitted from the resulting object.\n - `customer_key` (`string`): Set the `customer_key` field on the resulting object. When `null`, the `customer_key` field will be omitted from the resulting object.\n - `customer_key_md5` (`string`): Set the `customer_key_md5` field on the resulting object. When `null`, the `customer_key_md5` field will be omitted from the resulting object.\n - `expected_bucket_owner` (`string`): Set the `expected_bucket_owner` field on the resulting object. When `null`, the `expected_bucket_owner` field will be omitted from the resulting object.\n - `expected_source_bucket_owner` (`string`): Set the `expected_source_bucket_owner` field on the resulting object. When `null`, the `expected_source_bucket_owner` field will be omitted from the resulting object.\n - `expires` (`string`): Set the `expires` field on the resulting object. When `null`, the `expires` field will be omitted from the resulting object.\n - `force_destroy` (`bool`): Set the `force_destroy` field on the resulting object. When `null`, the `force_destroy` field will be omitted from the resulting object.\n - `key` (`string`): Set the `key` field on the resulting object.\n - `kms_encryption_context` (`string`): Set the `kms_encryption_context` field on the resulting object. When `null`, the `kms_encryption_context` field will be omitted from the resulting object.\n - `kms_key_id` (`string`): Set the `kms_key_id` field on the resulting object. When `null`, the `kms_key_id` field will be omitted from the resulting object.\n - `metadata` (`obj`): Set the `metadata` field on the resulting object. When `null`, the `metadata` field will be omitted from the resulting object.\n - `metadata_directive` (`string`): Set the `metadata_directive` field on the resulting object. When `null`, the `metadata_directive` field will be omitted from the resulting object.\n - `object_lock_legal_hold_status` (`string`): Set the `object_lock_legal_hold_status` field on the resulting object. When `null`, the `object_lock_legal_hold_status` field will be omitted from the resulting object.\n - `object_lock_mode` (`string`): Set the `object_lock_mode` field on the resulting object. When `null`, the `object_lock_mode` field will be omitted from the resulting object.\n - `object_lock_retain_until_date` (`string`): Set the `object_lock_retain_until_date` field on the resulting object. When `null`, the `object_lock_retain_until_date` field will be omitted from the resulting object.\n - `request_payer` (`string`): Set the `request_payer` field on the resulting object. When `null`, the `request_payer` field will be omitted from the resulting object.\n - `server_side_encryption` (`string`): Set the `server_side_encryption` field on the resulting object. When `null`, the `server_side_encryption` field will be omitted from the resulting object.\n - `source` (`string`): Set the `source` field on the resulting object.\n - `source_customer_algorithm` (`string`): Set the `source_customer_algorithm` field on the resulting object. When `null`, the `source_customer_algorithm` field will be omitted from the resulting object.\n - `source_customer_key` (`string`): Set the `source_customer_key` field on the resulting object. When `null`, the `source_customer_key` field will be omitted from the resulting object.\n - `source_customer_key_md5` (`string`): Set the `source_customer_key_md5` field on the resulting object. When `null`, the `source_customer_key_md5` field will be omitted from the resulting object.\n - `storage_class` (`string`): Set the `storage_class` field on the resulting object. When `null`, the `storage_class` field will be omitted from the resulting object.\n - `tagging_directive` (`string`): Set the `tagging_directive` field on the resulting object. When `null`, the `tagging_directive` field will be omitted from the resulting object.\n - `tags` (`obj`): Set the `tags` field on the resulting object. When `null`, the `tags` field will be omitted from the resulting object.\n - `tags_all` (`obj`): Set the `tags_all` field on the resulting object. When `null`, the `tags_all` field will be omitted from the resulting object.\n - `website_redirect` (`string`): Set the `website_redirect` field on the resulting object. When `null`, the `website_redirect` field will be omitted from the resulting object.\n - `grant` (`list[obj]`): Set the `grant` field on the resulting object. When `null`, the `grant` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [aws.s3_object_copy.grant.new](#fn-grantnew) constructor.\n\n**Returns**:\n - An attribute object that can be used with [tf.withResource](https://github.com/tf-libsonnet/core/tree/main/docs#fn-withresource) to construct a new `s3_object_copy` resource into the root Terraform configuration.\n', args=[]), newAttrs( bucket, key, @@ -113,6 +115,7 @@ local d = (import 'github.com/jsonnet-libs/docsonnet/doc-util/main.libsonnet'); acl=null, bucket_key_enabled=null, cache_control=null, + checksum_algorithm=null, content_disposition=null, content_encoding=null, content_language=null, @@ -151,6 +154,7 @@ local d = (import 'github.com/jsonnet-libs/docsonnet/doc-util/main.libsonnet'); bucket: bucket, bucket_key_enabled: bucket_key_enabled, cache_control: cache_control, + checksum_algorithm: checksum_algorithm, content_disposition: content_disposition, content_encoding: content_encoding, content_language: content_language, @@ -227,6 +231,16 @@ local d = (import 'github.com/jsonnet-libs/docsonnet/doc-util/main.libsonnet'); }, }, }, + '#withChecksumAlgorithm':: d.fn(help='`aws.string.withChecksumAlgorithm` constructs a mixin object that can be merged into the `string`\nTerraform resource block to set or update the checksum_algorithm field.\n\n\n\n**Args**:\n - `resourceLabel` (`string`): The name label of the block to update.\n - `value` (`string`): The value to set for the `checksum_algorithm` field.\n', args=[]), + withChecksumAlgorithm(resourceLabel, value): { + resource+: { + aws_s3_object_copy+: { + [resourceLabel]+: { + checksum_algorithm: value, + }, + }, + }, + }, '#withContentDisposition':: d.fn(help='`aws.string.withContentDisposition` constructs a mixin object that can be merged into the `string`\nTerraform resource block to set or update the content_disposition field.\n\n\n\n**Args**:\n - `resourceLabel` (`string`): The name label of the block to update.\n - `value` (`string`): The value to set for the `content_disposition` field.\n', args=[]), withContentDisposition(resourceLabel, value): { resource+: { diff --git a/5.x/_gen/resources/s3control_multi_region_access_point.libsonnet b/5.x/_gen/resources/s3control_multi_region_access_point.libsonnet index e930932c..27845e12 100644 --- a/5.x/_gen/resources/s3control_multi_region_access_point.libsonnet +++ b/5.x/_gen/resources/s3control_multi_region_access_point.libsonnet @@ -28,11 +28,13 @@ local d = (import 'github.com/jsonnet-libs/docsonnet/doc-util/main.libsonnet'); }), }, region:: { - '#new':: d.fn(help='\n`aws.s3control_multi_region_access_point.details.region.new` constructs a new object with attributes and blocks configured for the `region`\nTerraform sub block.\n\n\n\n**Args**:\n - `bucket` (`string`): Set the `bucket` field on the resulting object.\n\n**Returns**:\n - An attribute object that represents the `region` sub block.\n', args=[]), + '#new':: d.fn(help='\n`aws.s3control_multi_region_access_point.details.region.new` constructs a new object with attributes and blocks configured for the `region`\nTerraform sub block.\n\n\n\n**Args**:\n - `bucket` (`string`): Set the `bucket` field on the resulting object.\n - `bucket_account_id` (`string`): Set the `bucket_account_id` field on the resulting object. When `null`, the `bucket_account_id` field will be omitted from the resulting object.\n\n**Returns**:\n - An attribute object that represents the `region` sub block.\n', args=[]), new( - bucket + bucket, + bucket_account_id=null ):: std.prune(a={ bucket: bucket, + bucket_account_id: bucket_account_id, }), }, }, diff --git a/5.x/_gen/resources/shield_application_layer_automatic_response.libsonnet b/5.x/_gen/resources/shield_application_layer_automatic_response.libsonnet new file mode 100644 index 00000000..f120a8ce --- /dev/null +++ b/5.x/_gen/resources/shield_application_layer_automatic_response.libsonnet @@ -0,0 +1,80 @@ +local tf = (import 'github.com/tf-libsonnet/core/main.libsonnet'); +local d = (import 'github.com/jsonnet-libs/docsonnet/doc-util/main.libsonnet'); +{ + '#':: d.pkg(name='shield_application_layer_automatic_response', url='', help='`shield_application_layer_automatic_response` represents the `aws_shield_application_layer_automatic_response` Terraform resource.\n\n\n\nThis package contains functions and utilities for setting up the resource using Jsonnet code.\n'), + '#new':: d.fn(help="\n`aws.shield_application_layer_automatic_response.new` injects a new `aws_shield_application_layer_automatic_response` Terraform `resource`\nblock into the root module document.\n\nAdditionally, this inserts a private function into the `_ref` attribute that generates references to attributes of the\nresource. For example, if you added a new instance to the root using:\n\n # arguments omitted for brevity\n aws.shield_application_layer_automatic_response.new('some_id')\n\nYou can get the reference to the `id` field of the created `aws.shield_application_layer_automatic_response` using the reference:\n\n $._ref.aws_shield_application_layer_automatic_response.some_id.get('id')\n\nThis is the same as directly entering `\"${ aws_shield_application_layer_automatic_response.some_id.id }\"` as the value.\n\nNOTE: if you are chaining multiple resources together in a merge operation, you may not be able to use `super`, `self`,\nor `$` to refer to the root object. Instead, make an explicit outer object using `local`.\n\n**Args**:\n - `resourceLabel` (`string`): The name label of the block.\n - `action` (`string`): Set the `action` field on the resulting resource block.\n - `resource_arn` (`string`): Set the `resource_arn` field on the resulting resource block.\n - `timeouts` (`obj`): Set the `timeouts` field on the resulting resource block. When `null`, the `timeouts` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [aws.shield_application_layer_automatic_response.timeouts.new](#fn-timeoutsnew) constructor.\n\n**Returns**:\n- A mixin object that injects the new resource into the root Terraform configuration.\n", args=[]), + new( + resourceLabel, + action, + resource_arn, + timeouts=null, + _meta={} + ):: tf.withResource( + type='aws_shield_application_layer_automatic_response', + label=resourceLabel, + attrs=self.newAttrs(action=action, resource_arn=resource_arn, timeouts=timeouts), + _meta=_meta + ), + '#newAttrs':: d.fn(help='\n`aws.shield_application_layer_automatic_response.newAttrs` constructs a new object with attributes and blocks configured for the `shield_application_layer_automatic_response`\nTerraform resource.\n\nUnlike [aws.shield_application_layer_automatic_response.new](#fn-new), this function will not inject the `resource`\nblock into the root Terraform document. Instead, this must be passed in as the `attrs` argument for the\n[tf.withResource](https://github.com/tf-libsonnet/core/tree/main/docs#fn-withresource) function to build a complete block.\n\nThis is most useful when you need to preprocess the attributes with functions, conditional, or looping logic prior to\ninjecting into a complete block.\n\n**Args**:\n - `action` (`string`): Set the `action` field on the resulting object.\n - `resource_arn` (`string`): Set the `resource_arn` field on the resulting object.\n - `timeouts` (`obj`): Set the `timeouts` field on the resulting object. When `null`, the `timeouts` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [aws.shield_application_layer_automatic_response.timeouts.new](#fn-timeoutsnew) constructor.\n\n**Returns**:\n - An attribute object that can be used with [tf.withResource](https://github.com/tf-libsonnet/core/tree/main/docs#fn-withresource) to construct a new `shield_application_layer_automatic_response` resource into the root Terraform configuration.\n', args=[]), + newAttrs( + action, + resource_arn, + timeouts=null + ):: std.prune(a={ + action: action, + resource_arn: resource_arn, + timeouts: timeouts, + }), + timeouts:: { + '#new':: d.fn(help='\n`aws.shield_application_layer_automatic_response.timeouts.new` constructs a new object with attributes and blocks configured for the `timeouts`\nTerraform sub block.\n\n\n\n**Args**:\n - `create` (`string`): A string that can be [parsed as a duration](https://pkg.go.dev/time#ParseDuration) consisting of numbers and unit suffixes, such as "30s" or "2h45m". Valid time units are "s" (seconds), "m" (minutes), "h" (hours). When `null`, the `create` field will be omitted from the resulting object.\n - `delete` (`string`): A string that can be [parsed as a duration](https://pkg.go.dev/time#ParseDuration) consisting of numbers and unit suffixes, such as "30s" or "2h45m". Valid time units are "s" (seconds), "m" (minutes), "h" (hours). Setting a timeout for a Delete operation is only applicable if changes are saved into state before the destroy operation occurs. When `null`, the `delete` field will be omitted from the resulting object.\n - `update` (`string`): A string that can be [parsed as a duration](https://pkg.go.dev/time#ParseDuration) consisting of numbers and unit suffixes, such as "30s" or "2h45m". Valid time units are "s" (seconds), "m" (minutes), "h" (hours). When `null`, the `update` field will be omitted from the resulting object.\n\n**Returns**:\n - An attribute object that represents the `timeouts` sub block.\n', args=[]), + new( + create=null, + delete=null, + update=null + ):: std.prune(a={ + create: create, + delete: delete, + update: update, + }), + }, + '#withAction':: d.fn(help='`aws.string.withAction` constructs a mixin object that can be merged into the `string`\nTerraform resource block to set or update the action field.\n\n\n\n**Args**:\n - `resourceLabel` (`string`): The name label of the block to update.\n - `value` (`string`): The value to set for the `action` field.\n', args=[]), + withAction(resourceLabel, value): { + resource+: { + aws_shield_application_layer_automatic_response+: { + [resourceLabel]+: { + action: value, + }, + }, + }, + }, + '#withResourceArn':: d.fn(help='`aws.string.withResourceArn` constructs a mixin object that can be merged into the `string`\nTerraform resource block to set or update the resource_arn field.\n\n\n\n**Args**:\n - `resourceLabel` (`string`): The name label of the block to update.\n - `value` (`string`): The value to set for the `resource_arn` field.\n', args=[]), + withResourceArn(resourceLabel, value): { + resource+: { + aws_shield_application_layer_automatic_response+: { + [resourceLabel]+: { + resource_arn: value, + }, + }, + }, + }, + '#withTimeouts':: d.fn(help='`aws.obj.withTimeouts` constructs a mixin object that can be merged into the `obj`\nTerraform resource block to set or update the timeouts field.\n\nThis function will replace the map with the passed in `value`. If you wish to instead merge the\npassed in value to the existing map, use the [aws.obj.withTimeoutsMixin](TODO) function.\n\n**Args**:\n - `resourceLabel` (`string`): The name label of the block to update.\n - `value` (`obj`): The value to set for the `timeouts` field.\n', args=[]), + withTimeouts(resourceLabel, value): { + resource+: { + aws_shield_application_layer_automatic_response+: { + [resourceLabel]+: { + timeouts: value, + }, + }, + }, + }, + '#withTimeoutsMixin':: d.fn(help='`aws.obj.withTimeoutsMixin` constructs a mixin object that can be merged into the `obj`\nTerraform resource block to set or update the timeouts field.\n\nThis function will merge the passed in value to the existing map. If you wish\nto instead replace the entire map with the passed in `value`, use the [aws.obj.withTimeouts](TODO)\nfunction.\n\n\n**Args**:\n - `resourceLabel` (`string`): The name label of the block to update.\n - `value` (`obj`): The value to set for the `timeouts` field.\n', args=[]), + withTimeoutsMixin(resourceLabel, value): { + resource+: { + aws_shield_application_layer_automatic_response+: { + [resourceLabel]+: { + timeouts+: value, + }, + }, + }, + }, +} diff --git a/5.x/_gen/resources/shield_drt_access_log_bucket_association.libsonnet b/5.x/_gen/resources/shield_drt_access_log_bucket_association.libsonnet new file mode 100644 index 00000000..7521939b --- /dev/null +++ b/5.x/_gen/resources/shield_drt_access_log_bucket_association.libsonnet @@ -0,0 +1,80 @@ +local tf = (import 'github.com/tf-libsonnet/core/main.libsonnet'); +local d = (import 'github.com/jsonnet-libs/docsonnet/doc-util/main.libsonnet'); +{ + '#':: d.pkg(name='shield_drt_access_log_bucket_association', url='', help='`shield_drt_access_log_bucket_association` represents the `aws_shield_drt_access_log_bucket_association` Terraform resource.\n\n\n\nThis package contains functions and utilities for setting up the resource using Jsonnet code.\n'), + '#new':: d.fn(help="\n`aws.shield_drt_access_log_bucket_association.new` injects a new `aws_shield_drt_access_log_bucket_association` Terraform `resource`\nblock into the root module document.\n\nAdditionally, this inserts a private function into the `_ref` attribute that generates references to attributes of the\nresource. For example, if you added a new instance to the root using:\n\n # arguments omitted for brevity\n aws.shield_drt_access_log_bucket_association.new('some_id')\n\nYou can get the reference to the `id` field of the created `aws.shield_drt_access_log_bucket_association` using the reference:\n\n $._ref.aws_shield_drt_access_log_bucket_association.some_id.get('id')\n\nThis is the same as directly entering `\"${ aws_shield_drt_access_log_bucket_association.some_id.id }\"` as the value.\n\nNOTE: if you are chaining multiple resources together in a merge operation, you may not be able to use `super`, `self`,\nor `$` to refer to the root object. Instead, make an explicit outer object using `local`.\n\n**Args**:\n - `resourceLabel` (`string`): The name label of the block.\n - `log_bucket` (`string`): Set the `log_bucket` field on the resulting resource block.\n - `role_arn_association_id` (`string`): Set the `role_arn_association_id` field on the resulting resource block.\n - `timeouts` (`obj`): Set the `timeouts` field on the resulting resource block. When `null`, the `timeouts` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [aws.shield_drt_access_log_bucket_association.timeouts.new](#fn-timeoutsnew) constructor.\n\n**Returns**:\n- A mixin object that injects the new resource into the root Terraform configuration.\n", args=[]), + new( + resourceLabel, + log_bucket, + role_arn_association_id, + timeouts=null, + _meta={} + ):: tf.withResource( + type='aws_shield_drt_access_log_bucket_association', + label=resourceLabel, + attrs=self.newAttrs(log_bucket=log_bucket, role_arn_association_id=role_arn_association_id, timeouts=timeouts), + _meta=_meta + ), + '#newAttrs':: d.fn(help='\n`aws.shield_drt_access_log_bucket_association.newAttrs` constructs a new object with attributes and blocks configured for the `shield_drt_access_log_bucket_association`\nTerraform resource.\n\nUnlike [aws.shield_drt_access_log_bucket_association.new](#fn-new), this function will not inject the `resource`\nblock into the root Terraform document. Instead, this must be passed in as the `attrs` argument for the\n[tf.withResource](https://github.com/tf-libsonnet/core/tree/main/docs#fn-withresource) function to build a complete block.\n\nThis is most useful when you need to preprocess the attributes with functions, conditional, or looping logic prior to\ninjecting into a complete block.\n\n**Args**:\n - `log_bucket` (`string`): Set the `log_bucket` field on the resulting object.\n - `role_arn_association_id` (`string`): Set the `role_arn_association_id` field on the resulting object.\n - `timeouts` (`obj`): Set the `timeouts` field on the resulting object. When `null`, the `timeouts` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [aws.shield_drt_access_log_bucket_association.timeouts.new](#fn-timeoutsnew) constructor.\n\n**Returns**:\n - An attribute object that can be used with [tf.withResource](https://github.com/tf-libsonnet/core/tree/main/docs#fn-withresource) to construct a new `shield_drt_access_log_bucket_association` resource into the root Terraform configuration.\n', args=[]), + newAttrs( + log_bucket, + role_arn_association_id, + timeouts=null + ):: std.prune(a={ + log_bucket: log_bucket, + role_arn_association_id: role_arn_association_id, + timeouts: timeouts, + }), + timeouts:: { + '#new':: d.fn(help='\n`aws.shield_drt_access_log_bucket_association.timeouts.new` constructs a new object with attributes and blocks configured for the `timeouts`\nTerraform sub block.\n\n\n\n**Args**:\n - `create` (`string`): A string that can be [parsed as a duration](https://pkg.go.dev/time#ParseDuration) consisting of numbers and unit suffixes, such as "30s" or "2h45m". Valid time units are "s" (seconds), "m" (minutes), "h" (hours). When `null`, the `create` field will be omitted from the resulting object.\n - `delete` (`string`): A string that can be [parsed as a duration](https://pkg.go.dev/time#ParseDuration) consisting of numbers and unit suffixes, such as "30s" or "2h45m". Valid time units are "s" (seconds), "m" (minutes), "h" (hours). Setting a timeout for a Delete operation is only applicable if changes are saved into state before the destroy operation occurs. When `null`, the `delete` field will be omitted from the resulting object.\n - `read` (`string`): A string that can be [parsed as a duration](https://pkg.go.dev/time#ParseDuration) consisting of numbers and unit suffixes, such as "30s" or "2h45m". Valid time units are "s" (seconds), "m" (minutes), "h" (hours). Read operations occur during any refresh or planning operation when refresh is enabled. When `null`, the `read` field will be omitted from the resulting object.\n\n**Returns**:\n - An attribute object that represents the `timeouts` sub block.\n', args=[]), + new( + create=null, + delete=null, + read=null + ):: std.prune(a={ + create: create, + delete: delete, + read: read, + }), + }, + '#withLogBucket':: d.fn(help='`aws.string.withLogBucket` constructs a mixin object that can be merged into the `string`\nTerraform resource block to set or update the log_bucket field.\n\n\n\n**Args**:\n - `resourceLabel` (`string`): The name label of the block to update.\n - `value` (`string`): The value to set for the `log_bucket` field.\n', args=[]), + withLogBucket(resourceLabel, value): { + resource+: { + aws_shield_drt_access_log_bucket_association+: { + [resourceLabel]+: { + log_bucket: value, + }, + }, + }, + }, + '#withRoleArnAssociationId':: d.fn(help='`aws.string.withRoleArnAssociationId` constructs a mixin object that can be merged into the `string`\nTerraform resource block to set or update the role_arn_association_id field.\n\n\n\n**Args**:\n - `resourceLabel` (`string`): The name label of the block to update.\n - `value` (`string`): The value to set for the `role_arn_association_id` field.\n', args=[]), + withRoleArnAssociationId(resourceLabel, value): { + resource+: { + aws_shield_drt_access_log_bucket_association+: { + [resourceLabel]+: { + role_arn_association_id: value, + }, + }, + }, + }, + '#withTimeouts':: d.fn(help='`aws.obj.withTimeouts` constructs a mixin object that can be merged into the `obj`\nTerraform resource block to set or update the timeouts field.\n\nThis function will replace the map with the passed in `value`. If you wish to instead merge the\npassed in value to the existing map, use the [aws.obj.withTimeoutsMixin](TODO) function.\n\n**Args**:\n - `resourceLabel` (`string`): The name label of the block to update.\n - `value` (`obj`): The value to set for the `timeouts` field.\n', args=[]), + withTimeouts(resourceLabel, value): { + resource+: { + aws_shield_drt_access_log_bucket_association+: { + [resourceLabel]+: { + timeouts: value, + }, + }, + }, + }, + '#withTimeoutsMixin':: d.fn(help='`aws.obj.withTimeoutsMixin` constructs a mixin object that can be merged into the `obj`\nTerraform resource block to set or update the timeouts field.\n\nThis function will merge the passed in value to the existing map. If you wish\nto instead replace the entire map with the passed in `value`, use the [aws.obj.withTimeouts](TODO)\nfunction.\n\n\n**Args**:\n - `resourceLabel` (`string`): The name label of the block to update.\n - `value` (`obj`): The value to set for the `timeouts` field.\n', args=[]), + withTimeoutsMixin(resourceLabel, value): { + resource+: { + aws_shield_drt_access_log_bucket_association+: { + [resourceLabel]+: { + timeouts+: value, + }, + }, + }, + }, +} diff --git a/5.x/_gen/resources/shield_drt_access_role_arn_association.libsonnet b/5.x/_gen/resources/shield_drt_access_role_arn_association.libsonnet new file mode 100644 index 00000000..728574f2 --- /dev/null +++ b/5.x/_gen/resources/shield_drt_access_role_arn_association.libsonnet @@ -0,0 +1,67 @@ +local tf = (import 'github.com/tf-libsonnet/core/main.libsonnet'); +local d = (import 'github.com/jsonnet-libs/docsonnet/doc-util/main.libsonnet'); +{ + '#':: d.pkg(name='shield_drt_access_role_arn_association', url='', help='`shield_drt_access_role_arn_association` represents the `aws_shield_drt_access_role_arn_association` Terraform resource.\n\n\n\nThis package contains functions and utilities for setting up the resource using Jsonnet code.\n'), + '#new':: d.fn(help="\n`aws.shield_drt_access_role_arn_association.new` injects a new `aws_shield_drt_access_role_arn_association` Terraform `resource`\nblock into the root module document.\n\nAdditionally, this inserts a private function into the `_ref` attribute that generates references to attributes of the\nresource. For example, if you added a new instance to the root using:\n\n # arguments omitted for brevity\n aws.shield_drt_access_role_arn_association.new('some_id')\n\nYou can get the reference to the `id` field of the created `aws.shield_drt_access_role_arn_association` using the reference:\n\n $._ref.aws_shield_drt_access_role_arn_association.some_id.get('id')\n\nThis is the same as directly entering `\"${ aws_shield_drt_access_role_arn_association.some_id.id }\"` as the value.\n\nNOTE: if you are chaining multiple resources together in a merge operation, you may not be able to use `super`, `self`,\nor `$` to refer to the root object. Instead, make an explicit outer object using `local`.\n\n**Args**:\n - `resourceLabel` (`string`): The name label of the block.\n - `role_arn` (`string`): Set the `role_arn` field on the resulting resource block.\n - `timeouts` (`obj`): Set the `timeouts` field on the resulting resource block. When `null`, the `timeouts` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [aws.shield_drt_access_role_arn_association.timeouts.new](#fn-timeoutsnew) constructor.\n\n**Returns**:\n- A mixin object that injects the new resource into the root Terraform configuration.\n", args=[]), + new( + resourceLabel, + role_arn, + timeouts=null, + _meta={} + ):: tf.withResource( + type='aws_shield_drt_access_role_arn_association', + label=resourceLabel, + attrs=self.newAttrs(role_arn=role_arn, timeouts=timeouts), + _meta=_meta + ), + '#newAttrs':: d.fn(help='\n`aws.shield_drt_access_role_arn_association.newAttrs` constructs a new object with attributes and blocks configured for the `shield_drt_access_role_arn_association`\nTerraform resource.\n\nUnlike [aws.shield_drt_access_role_arn_association.new](#fn-new), this function will not inject the `resource`\nblock into the root Terraform document. Instead, this must be passed in as the `attrs` argument for the\n[tf.withResource](https://github.com/tf-libsonnet/core/tree/main/docs#fn-withresource) function to build a complete block.\n\nThis is most useful when you need to preprocess the attributes with functions, conditional, or looping logic prior to\ninjecting into a complete block.\n\n**Args**:\n - `role_arn` (`string`): Set the `role_arn` field on the resulting object.\n - `timeouts` (`obj`): Set the `timeouts` field on the resulting object. When `null`, the `timeouts` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [aws.shield_drt_access_role_arn_association.timeouts.new](#fn-timeoutsnew) constructor.\n\n**Returns**:\n - An attribute object that can be used with [tf.withResource](https://github.com/tf-libsonnet/core/tree/main/docs#fn-withresource) to construct a new `shield_drt_access_role_arn_association` resource into the root Terraform configuration.\n', args=[]), + newAttrs( + role_arn, + timeouts=null + ):: std.prune(a={ + role_arn: role_arn, + timeouts: timeouts, + }), + timeouts:: { + '#new':: d.fn(help='\n`aws.shield_drt_access_role_arn_association.timeouts.new` constructs a new object with attributes and blocks configured for the `timeouts`\nTerraform sub block.\n\n\n\n**Args**:\n - `create` (`string`): A string that can be [parsed as a duration](https://pkg.go.dev/time#ParseDuration) consisting of numbers and unit suffixes, such as "30s" or "2h45m". Valid time units are "s" (seconds), "m" (minutes), "h" (hours). When `null`, the `create` field will be omitted from the resulting object.\n - `delete` (`string`): A string that can be [parsed as a duration](https://pkg.go.dev/time#ParseDuration) consisting of numbers and unit suffixes, such as "30s" or "2h45m". Valid time units are "s" (seconds), "m" (minutes), "h" (hours). Setting a timeout for a Delete operation is only applicable if changes are saved into state before the destroy operation occurs. When `null`, the `delete` field will be omitted from the resulting object.\n - `read` (`string`): A string that can be [parsed as a duration](https://pkg.go.dev/time#ParseDuration) consisting of numbers and unit suffixes, such as "30s" or "2h45m". Valid time units are "s" (seconds), "m" (minutes), "h" (hours). Read operations occur during any refresh or planning operation when refresh is enabled. When `null`, the `read` field will be omitted from the resulting object.\n\n**Returns**:\n - An attribute object that represents the `timeouts` sub block.\n', args=[]), + new( + create=null, + delete=null, + read=null + ):: std.prune(a={ + create: create, + delete: delete, + read: read, + }), + }, + '#withRoleArn':: d.fn(help='`aws.string.withRoleArn` constructs a mixin object that can be merged into the `string`\nTerraform resource block to set or update the role_arn field.\n\n\n\n**Args**:\n - `resourceLabel` (`string`): The name label of the block to update.\n - `value` (`string`): The value to set for the `role_arn` field.\n', args=[]), + withRoleArn(resourceLabel, value): { + resource+: { + aws_shield_drt_access_role_arn_association+: { + [resourceLabel]+: { + role_arn: value, + }, + }, + }, + }, + '#withTimeouts':: d.fn(help='`aws.obj.withTimeouts` constructs a mixin object that can be merged into the `obj`\nTerraform resource block to set or update the timeouts field.\n\nThis function will replace the map with the passed in `value`. If you wish to instead merge the\npassed in value to the existing map, use the [aws.obj.withTimeoutsMixin](TODO) function.\n\n**Args**:\n - `resourceLabel` (`string`): The name label of the block to update.\n - `value` (`obj`): The value to set for the `timeouts` field.\n', args=[]), + withTimeouts(resourceLabel, value): { + resource+: { + aws_shield_drt_access_role_arn_association+: { + [resourceLabel]+: { + timeouts: value, + }, + }, + }, + }, + '#withTimeoutsMixin':: d.fn(help='`aws.obj.withTimeoutsMixin` constructs a mixin object that can be merged into the `obj`\nTerraform resource block to set or update the timeouts field.\n\nThis function will merge the passed in value to the existing map. If you wish\nto instead replace the entire map with the passed in `value`, use the [aws.obj.withTimeouts](TODO)\nfunction.\n\n\n**Args**:\n - `resourceLabel` (`string`): The name label of the block to update.\n - `value` (`obj`): The value to set for the `timeouts` field.\n', args=[]), + withTimeoutsMixin(resourceLabel, value): { + resource+: { + aws_shield_drt_access_role_arn_association+: { + [resourceLabel]+: { + timeouts+: value, + }, + }, + }, + }, +} diff --git a/5.x/_gen/resources/ssm_association.libsonnet b/5.x/_gen/resources/ssm_association.libsonnet index 1fbe9d58..77e66c54 100644 --- a/5.x/_gen/resources/ssm_association.libsonnet +++ b/5.x/_gen/resources/ssm_association.libsonnet @@ -2,7 +2,7 @@ local tf = (import 'github.com/tf-libsonnet/core/main.libsonnet'); local d = (import 'github.com/jsonnet-libs/docsonnet/doc-util/main.libsonnet'); { '#':: d.pkg(name='ssm_association', url='', help='`ssm_association` represents the `aws_ssm_association` Terraform resource.\n\n\n\nThis package contains functions and utilities for setting up the resource using Jsonnet code.\n'), - '#new':: d.fn(help="\n`aws.ssm_association.new` injects a new `aws_ssm_association` Terraform `resource`\nblock into the root module document.\n\nAdditionally, this inserts a private function into the `_ref` attribute that generates references to attributes of the\nresource. For example, if you added a new instance to the root using:\n\n # arguments omitted for brevity\n aws.ssm_association.new('some_id')\n\nYou can get the reference to the `id` field of the created `aws.ssm_association` using the reference:\n\n $._ref.aws_ssm_association.some_id.get('id')\n\nThis is the same as directly entering `\"${ aws_ssm_association.some_id.id }\"` as the value.\n\nNOTE: if you are chaining multiple resources together in a merge operation, you may not be able to use `super`, `self`,\nor `$` to refer to the root object. Instead, make an explicit outer object using `local`.\n\n**Args**:\n - `resourceLabel` (`string`): The name label of the block.\n - `apply_only_at_cron_interval` (`bool`): Set the `apply_only_at_cron_interval` field on the resulting resource block. When `null`, the `apply_only_at_cron_interval` field will be omitted from the resulting object.\n - `association_name` (`string`): Set the `association_name` field on the resulting resource block. When `null`, the `association_name` field will be omitted from the resulting object.\n - `automation_target_parameter_name` (`string`): Set the `automation_target_parameter_name` field on the resulting resource block. When `null`, the `automation_target_parameter_name` field will be omitted from the resulting object.\n - `compliance_severity` (`string`): Set the `compliance_severity` field on the resulting resource block. When `null`, the `compliance_severity` field will be omitted from the resulting object.\n - `document_version` (`string`): Set the `document_version` field on the resulting resource block. When `null`, the `document_version` field will be omitted from the resulting object.\n - `instance_id` (`string`): Set the `instance_id` field on the resulting resource block. When `null`, the `instance_id` field will be omitted from the resulting object.\n - `max_concurrency` (`string`): Set the `max_concurrency` field on the resulting resource block. When `null`, the `max_concurrency` field will be omitted from the resulting object.\n - `max_errors` (`string`): Set the `max_errors` field on the resulting resource block. When `null`, the `max_errors` field will be omitted from the resulting object.\n - `name` (`string`): Set the `name` field on the resulting resource block.\n - `parameters` (`obj`): Set the `parameters` field on the resulting resource block. When `null`, the `parameters` field will be omitted from the resulting object.\n - `schedule_expression` (`string`): Set the `schedule_expression` field on the resulting resource block. When `null`, the `schedule_expression` field will be omitted from the resulting object.\n - `wait_for_success_timeout_seconds` (`number`): Set the `wait_for_success_timeout_seconds` field on the resulting resource block. When `null`, the `wait_for_success_timeout_seconds` field will be omitted from the resulting object.\n - `output_location` (`list[obj]`): Set the `output_location` field on the resulting resource block. When `null`, the `output_location` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [aws.ssm_association.output_location.new](#fn-output_locationnew) constructor.\n - `targets` (`list[obj]`): Set the `targets` field on the resulting resource block. When `null`, the `targets` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [aws.ssm_association.targets.new](#fn-targetsnew) constructor.\n\n**Returns**:\n- A mixin object that injects the new resource into the root Terraform configuration.\n", args=[]), + '#new':: d.fn(help="\n`aws.ssm_association.new` injects a new `aws_ssm_association` Terraform `resource`\nblock into the root module document.\n\nAdditionally, this inserts a private function into the `_ref` attribute that generates references to attributes of the\nresource. For example, if you added a new instance to the root using:\n\n # arguments omitted for brevity\n aws.ssm_association.new('some_id')\n\nYou can get the reference to the `id` field of the created `aws.ssm_association` using the reference:\n\n $._ref.aws_ssm_association.some_id.get('id')\n\nThis is the same as directly entering `\"${ aws_ssm_association.some_id.id }\"` as the value.\n\nNOTE: if you are chaining multiple resources together in a merge operation, you may not be able to use `super`, `self`,\nor `$` to refer to the root object. Instead, make an explicit outer object using `local`.\n\n**Args**:\n - `resourceLabel` (`string`): The name label of the block.\n - `apply_only_at_cron_interval` (`bool`): Set the `apply_only_at_cron_interval` field on the resulting resource block. When `null`, the `apply_only_at_cron_interval` field will be omitted from the resulting object.\n - `association_name` (`string`): Set the `association_name` field on the resulting resource block. When `null`, the `association_name` field will be omitted from the resulting object.\n - `automation_target_parameter_name` (`string`): Set the `automation_target_parameter_name` field on the resulting resource block. When `null`, the `automation_target_parameter_name` field will be omitted from the resulting object.\n - `compliance_severity` (`string`): Set the `compliance_severity` field on the resulting resource block. When `null`, the `compliance_severity` field will be omitted from the resulting object.\n - `document_version` (`string`): Set the `document_version` field on the resulting resource block. When `null`, the `document_version` field will be omitted from the resulting object.\n - `instance_id` (`string`): Set the `instance_id` field on the resulting resource block. When `null`, the `instance_id` field will be omitted from the resulting object.\n - `max_concurrency` (`string`): Set the `max_concurrency` field on the resulting resource block. When `null`, the `max_concurrency` field will be omitted from the resulting object.\n - `max_errors` (`string`): Set the `max_errors` field on the resulting resource block. When `null`, the `max_errors` field will be omitted from the resulting object.\n - `name` (`string`): Set the `name` field on the resulting resource block.\n - `parameters` (`obj`): Set the `parameters` field on the resulting resource block. When `null`, the `parameters` field will be omitted from the resulting object.\n - `schedule_expression` (`string`): Set the `schedule_expression` field on the resulting resource block. When `null`, the `schedule_expression` field will be omitted from the resulting object.\n - `sync_compliance` (`string`): Set the `sync_compliance` field on the resulting resource block. When `null`, the `sync_compliance` field will be omitted from the resulting object.\n - `wait_for_success_timeout_seconds` (`number`): Set the `wait_for_success_timeout_seconds` field on the resulting resource block. When `null`, the `wait_for_success_timeout_seconds` field will be omitted from the resulting object.\n - `output_location` (`list[obj]`): Set the `output_location` field on the resulting resource block. When `null`, the `output_location` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [aws.ssm_association.output_location.new](#fn-output_locationnew) constructor.\n - `targets` (`list[obj]`): Set the `targets` field on the resulting resource block. When `null`, the `targets` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [aws.ssm_association.targets.new](#fn-targetsnew) constructor.\n\n**Returns**:\n- A mixin object that injects the new resource into the root Terraform configuration.\n", args=[]), new( resourceLabel, name, @@ -17,6 +17,7 @@ local d = (import 'github.com/jsonnet-libs/docsonnet/doc-util/main.libsonnet'); output_location=null, parameters=null, schedule_expression=null, + sync_compliance=null, targets=null, wait_for_success_timeout_seconds=null, _meta={} @@ -36,12 +37,13 @@ local d = (import 'github.com/jsonnet-libs/docsonnet/doc-util/main.libsonnet'); output_location=output_location, parameters=parameters, schedule_expression=schedule_expression, + sync_compliance=sync_compliance, targets=targets, wait_for_success_timeout_seconds=wait_for_success_timeout_seconds ), _meta=_meta ), - '#newAttrs':: d.fn(help='\n`aws.ssm_association.newAttrs` constructs a new object with attributes and blocks configured for the `ssm_association`\nTerraform resource.\n\nUnlike [aws.ssm_association.new](#fn-new), this function will not inject the `resource`\nblock into the root Terraform document. Instead, this must be passed in as the `attrs` argument for the\n[tf.withResource](https://github.com/tf-libsonnet/core/tree/main/docs#fn-withresource) function to build a complete block.\n\nThis is most useful when you need to preprocess the attributes with functions, conditional, or looping logic prior to\ninjecting into a complete block.\n\n**Args**:\n - `apply_only_at_cron_interval` (`bool`): Set the `apply_only_at_cron_interval` field on the resulting object. When `null`, the `apply_only_at_cron_interval` field will be omitted from the resulting object.\n - `association_name` (`string`): Set the `association_name` field on the resulting object. When `null`, the `association_name` field will be omitted from the resulting object.\n - `automation_target_parameter_name` (`string`): Set the `automation_target_parameter_name` field on the resulting object. When `null`, the `automation_target_parameter_name` field will be omitted from the resulting object.\n - `compliance_severity` (`string`): Set the `compliance_severity` field on the resulting object. When `null`, the `compliance_severity` field will be omitted from the resulting object.\n - `document_version` (`string`): Set the `document_version` field on the resulting object. When `null`, the `document_version` field will be omitted from the resulting object.\n - `instance_id` (`string`): Set the `instance_id` field on the resulting object. When `null`, the `instance_id` field will be omitted from the resulting object.\n - `max_concurrency` (`string`): Set the `max_concurrency` field on the resulting object. When `null`, the `max_concurrency` field will be omitted from the resulting object.\n - `max_errors` (`string`): Set the `max_errors` field on the resulting object. When `null`, the `max_errors` field will be omitted from the resulting object.\n - `name` (`string`): Set the `name` field on the resulting object.\n - `parameters` (`obj`): Set the `parameters` field on the resulting object. When `null`, the `parameters` field will be omitted from the resulting object.\n - `schedule_expression` (`string`): Set the `schedule_expression` field on the resulting object. When `null`, the `schedule_expression` field will be omitted from the resulting object.\n - `wait_for_success_timeout_seconds` (`number`): Set the `wait_for_success_timeout_seconds` field on the resulting object. When `null`, the `wait_for_success_timeout_seconds` field will be omitted from the resulting object.\n - `output_location` (`list[obj]`): Set the `output_location` field on the resulting object. When `null`, the `output_location` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [aws.ssm_association.output_location.new](#fn-output_locationnew) constructor.\n - `targets` (`list[obj]`): Set the `targets` field on the resulting object. When `null`, the `targets` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [aws.ssm_association.targets.new](#fn-targetsnew) constructor.\n\n**Returns**:\n - An attribute object that can be used with [tf.withResource](https://github.com/tf-libsonnet/core/tree/main/docs#fn-withresource) to construct a new `ssm_association` resource into the root Terraform configuration.\n', args=[]), + '#newAttrs':: d.fn(help='\n`aws.ssm_association.newAttrs` constructs a new object with attributes and blocks configured for the `ssm_association`\nTerraform resource.\n\nUnlike [aws.ssm_association.new](#fn-new), this function will not inject the `resource`\nblock into the root Terraform document. Instead, this must be passed in as the `attrs` argument for the\n[tf.withResource](https://github.com/tf-libsonnet/core/tree/main/docs#fn-withresource) function to build a complete block.\n\nThis is most useful when you need to preprocess the attributes with functions, conditional, or looping logic prior to\ninjecting into a complete block.\n\n**Args**:\n - `apply_only_at_cron_interval` (`bool`): Set the `apply_only_at_cron_interval` field on the resulting object. When `null`, the `apply_only_at_cron_interval` field will be omitted from the resulting object.\n - `association_name` (`string`): Set the `association_name` field on the resulting object. When `null`, the `association_name` field will be omitted from the resulting object.\n - `automation_target_parameter_name` (`string`): Set the `automation_target_parameter_name` field on the resulting object. When `null`, the `automation_target_parameter_name` field will be omitted from the resulting object.\n - `compliance_severity` (`string`): Set the `compliance_severity` field on the resulting object. When `null`, the `compliance_severity` field will be omitted from the resulting object.\n - `document_version` (`string`): Set the `document_version` field on the resulting object. When `null`, the `document_version` field will be omitted from the resulting object.\n - `instance_id` (`string`): Set the `instance_id` field on the resulting object. When `null`, the `instance_id` field will be omitted from the resulting object.\n - `max_concurrency` (`string`): Set the `max_concurrency` field on the resulting object. When `null`, the `max_concurrency` field will be omitted from the resulting object.\n - `max_errors` (`string`): Set the `max_errors` field on the resulting object. When `null`, the `max_errors` field will be omitted from the resulting object.\n - `name` (`string`): Set the `name` field on the resulting object.\n - `parameters` (`obj`): Set the `parameters` field on the resulting object. When `null`, the `parameters` field will be omitted from the resulting object.\n - `schedule_expression` (`string`): Set the `schedule_expression` field on the resulting object. When `null`, the `schedule_expression` field will be omitted from the resulting object.\n - `sync_compliance` (`string`): Set the `sync_compliance` field on the resulting object. When `null`, the `sync_compliance` field will be omitted from the resulting object.\n - `wait_for_success_timeout_seconds` (`number`): Set the `wait_for_success_timeout_seconds` field on the resulting object. When `null`, the `wait_for_success_timeout_seconds` field will be omitted from the resulting object.\n - `output_location` (`list[obj]`): Set the `output_location` field on the resulting object. When `null`, the `output_location` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [aws.ssm_association.output_location.new](#fn-output_locationnew) constructor.\n - `targets` (`list[obj]`): Set the `targets` field on the resulting object. When `null`, the `targets` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [aws.ssm_association.targets.new](#fn-targetsnew) constructor.\n\n**Returns**:\n - An attribute object that can be used with [tf.withResource](https://github.com/tf-libsonnet/core/tree/main/docs#fn-withresource) to construct a new `ssm_association` resource into the root Terraform configuration.\n', args=[]), newAttrs( name, apply_only_at_cron_interval=null, @@ -55,6 +57,7 @@ local d = (import 'github.com/jsonnet-libs/docsonnet/doc-util/main.libsonnet'); output_location=null, parameters=null, schedule_expression=null, + sync_compliance=null, targets=null, wait_for_success_timeout_seconds=null ):: std.prune(a={ @@ -70,6 +73,7 @@ local d = (import 'github.com/jsonnet-libs/docsonnet/doc-util/main.libsonnet'); output_location: output_location, parameters: parameters, schedule_expression: schedule_expression, + sync_compliance: sync_compliance, targets: targets, wait_for_success_timeout_seconds: wait_for_success_timeout_seconds, }), @@ -225,6 +229,16 @@ local d = (import 'github.com/jsonnet-libs/docsonnet/doc-util/main.libsonnet'); }, }, }, + '#withSyncCompliance':: d.fn(help='`aws.string.withSyncCompliance` constructs a mixin object that can be merged into the `string`\nTerraform resource block to set or update the sync_compliance field.\n\n\n\n**Args**:\n - `resourceLabel` (`string`): The name label of the block to update.\n - `value` (`string`): The value to set for the `sync_compliance` field.\n', args=[]), + withSyncCompliance(resourceLabel, value): { + resource+: { + aws_ssm_association+: { + [resourceLabel]+: { + sync_compliance: value, + }, + }, + }, + }, '#withTargets':: d.fn(help='`aws.list[obj].withTargets` constructs a mixin object that can be merged into the `list[obj]`\nTerraform resource block to set or update the targets field.\n\nThis function will replace the array with the passed in `value`. If you wish to instead append the\npassed in value to the existing array, use the [aws.list[obj].withTargetsMixin](TODO) function.\n\n\n**Args**:\n - `resourceLabel` (`string`): The name label of the block to update.\n - `value` (`list[obj]`): The value to set for the `targets` field.\n', args=[]), withTargets(resourceLabel, value): { resource+: { diff --git a/5.x/_gen/resources/ssoadmin_account_assignment.libsonnet b/5.x/_gen/resources/ssoadmin_account_assignment.libsonnet index 49c61dfc..d82c5a4f 100644 --- a/5.x/_gen/resources/ssoadmin_account_assignment.libsonnet +++ b/5.x/_gen/resources/ssoadmin_account_assignment.libsonnet @@ -2,7 +2,7 @@ local tf = (import 'github.com/tf-libsonnet/core/main.libsonnet'); local d = (import 'github.com/jsonnet-libs/docsonnet/doc-util/main.libsonnet'); { '#':: d.pkg(name='ssoadmin_account_assignment', url='', help='`ssoadmin_account_assignment` represents the `aws_ssoadmin_account_assignment` Terraform resource.\n\n\n\nThis package contains functions and utilities for setting up the resource using Jsonnet code.\n'), - '#new':: d.fn(help="\n`aws.ssoadmin_account_assignment.new` injects a new `aws_ssoadmin_account_assignment` Terraform `resource`\nblock into the root module document.\n\nAdditionally, this inserts a private function into the `_ref` attribute that generates references to attributes of the\nresource. For example, if you added a new instance to the root using:\n\n # arguments omitted for brevity\n aws.ssoadmin_account_assignment.new('some_id')\n\nYou can get the reference to the `id` field of the created `aws.ssoadmin_account_assignment` using the reference:\n\n $._ref.aws_ssoadmin_account_assignment.some_id.get('id')\n\nThis is the same as directly entering `\"${ aws_ssoadmin_account_assignment.some_id.id }\"` as the value.\n\nNOTE: if you are chaining multiple resources together in a merge operation, you may not be able to use `super`, `self`,\nor `$` to refer to the root object. Instead, make an explicit outer object using `local`.\n\n**Args**:\n - `resourceLabel` (`string`): The name label of the block.\n - `instance_arn` (`string`): Set the `instance_arn` field on the resulting resource block.\n - `permission_set_arn` (`string`): Set the `permission_set_arn` field on the resulting resource block.\n - `principal_id` (`string`): Set the `principal_id` field on the resulting resource block.\n - `principal_type` (`string`): Set the `principal_type` field on the resulting resource block.\n - `target_id` (`string`): Set the `target_id` field on the resulting resource block.\n - `target_type` (`string`): Set the `target_type` field on the resulting resource block. When `null`, the `target_type` field will be omitted from the resulting object.\n\n**Returns**:\n- A mixin object that injects the new resource into the root Terraform configuration.\n", args=[]), + '#new':: d.fn(help="\n`aws.ssoadmin_account_assignment.new` injects a new `aws_ssoadmin_account_assignment` Terraform `resource`\nblock into the root module document.\n\nAdditionally, this inserts a private function into the `_ref` attribute that generates references to attributes of the\nresource. For example, if you added a new instance to the root using:\n\n # arguments omitted for brevity\n aws.ssoadmin_account_assignment.new('some_id')\n\nYou can get the reference to the `id` field of the created `aws.ssoadmin_account_assignment` using the reference:\n\n $._ref.aws_ssoadmin_account_assignment.some_id.get('id')\n\nThis is the same as directly entering `\"${ aws_ssoadmin_account_assignment.some_id.id }\"` as the value.\n\nNOTE: if you are chaining multiple resources together in a merge operation, you may not be able to use `super`, `self`,\nor `$` to refer to the root object. Instead, make an explicit outer object using `local`.\n\n**Args**:\n - `resourceLabel` (`string`): The name label of the block.\n - `instance_arn` (`string`): Set the `instance_arn` field on the resulting resource block.\n - `permission_set_arn` (`string`): Set the `permission_set_arn` field on the resulting resource block.\n - `principal_id` (`string`): Set the `principal_id` field on the resulting resource block.\n - `principal_type` (`string`): Set the `principal_type` field on the resulting resource block.\n - `target_id` (`string`): Set the `target_id` field on the resulting resource block.\n - `target_type` (`string`): Set the `target_type` field on the resulting resource block. When `null`, the `target_type` field will be omitted from the resulting object.\n - `timeouts` (`obj`): Set the `timeouts` field on the resulting resource block. When `null`, the `timeouts` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [aws.ssoadmin_account_assignment.timeouts.new](#fn-timeoutsnew) constructor.\n\n**Returns**:\n- A mixin object that injects the new resource into the root Terraform configuration.\n", args=[]), new( resourceLabel, instance_arn, @@ -11,6 +11,7 @@ local d = (import 'github.com/jsonnet-libs/docsonnet/doc-util/main.libsonnet'); principal_type, target_id, target_type=null, + timeouts=null, _meta={} ):: tf.withResource( type='aws_ssoadmin_account_assignment', @@ -21,18 +22,20 @@ local d = (import 'github.com/jsonnet-libs/docsonnet/doc-util/main.libsonnet'); principal_id=principal_id, principal_type=principal_type, target_id=target_id, - target_type=target_type + target_type=target_type, + timeouts=timeouts ), _meta=_meta ), - '#newAttrs':: d.fn(help='\n`aws.ssoadmin_account_assignment.newAttrs` constructs a new object with attributes and blocks configured for the `ssoadmin_account_assignment`\nTerraform resource.\n\nUnlike [aws.ssoadmin_account_assignment.new](#fn-new), this function will not inject the `resource`\nblock into the root Terraform document. Instead, this must be passed in as the `attrs` argument for the\n[tf.withResource](https://github.com/tf-libsonnet/core/tree/main/docs#fn-withresource) function to build a complete block.\n\nThis is most useful when you need to preprocess the attributes with functions, conditional, or looping logic prior to\ninjecting into a complete block.\n\n**Args**:\n - `instance_arn` (`string`): Set the `instance_arn` field on the resulting object.\n - `permission_set_arn` (`string`): Set the `permission_set_arn` field on the resulting object.\n - `principal_id` (`string`): Set the `principal_id` field on the resulting object.\n - `principal_type` (`string`): Set the `principal_type` field on the resulting object.\n - `target_id` (`string`): Set the `target_id` field on the resulting object.\n - `target_type` (`string`): Set the `target_type` field on the resulting object. When `null`, the `target_type` field will be omitted from the resulting object.\n\n**Returns**:\n - An attribute object that can be used with [tf.withResource](https://github.com/tf-libsonnet/core/tree/main/docs#fn-withresource) to construct a new `ssoadmin_account_assignment` resource into the root Terraform configuration.\n', args=[]), + '#newAttrs':: d.fn(help='\n`aws.ssoadmin_account_assignment.newAttrs` constructs a new object with attributes and blocks configured for the `ssoadmin_account_assignment`\nTerraform resource.\n\nUnlike [aws.ssoadmin_account_assignment.new](#fn-new), this function will not inject the `resource`\nblock into the root Terraform document. Instead, this must be passed in as the `attrs` argument for the\n[tf.withResource](https://github.com/tf-libsonnet/core/tree/main/docs#fn-withresource) function to build a complete block.\n\nThis is most useful when you need to preprocess the attributes with functions, conditional, or looping logic prior to\ninjecting into a complete block.\n\n**Args**:\n - `instance_arn` (`string`): Set the `instance_arn` field on the resulting object.\n - `permission_set_arn` (`string`): Set the `permission_set_arn` field on the resulting object.\n - `principal_id` (`string`): Set the `principal_id` field on the resulting object.\n - `principal_type` (`string`): Set the `principal_type` field on the resulting object.\n - `target_id` (`string`): Set the `target_id` field on the resulting object.\n - `target_type` (`string`): Set the `target_type` field on the resulting object. When `null`, the `target_type` field will be omitted from the resulting object.\n - `timeouts` (`obj`): Set the `timeouts` field on the resulting object. When `null`, the `timeouts` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [aws.ssoadmin_account_assignment.timeouts.new](#fn-timeoutsnew) constructor.\n\n**Returns**:\n - An attribute object that can be used with [tf.withResource](https://github.com/tf-libsonnet/core/tree/main/docs#fn-withresource) to construct a new `ssoadmin_account_assignment` resource into the root Terraform configuration.\n', args=[]), newAttrs( instance_arn, permission_set_arn, principal_id, principal_type, target_id, - target_type=null + target_type=null, + timeouts=null ):: std.prune(a={ instance_arn: instance_arn, permission_set_arn: permission_set_arn, @@ -40,7 +43,18 @@ local d = (import 'github.com/jsonnet-libs/docsonnet/doc-util/main.libsonnet'); principal_type: principal_type, target_id: target_id, target_type: target_type, + timeouts: timeouts, }), + timeouts:: { + '#new':: d.fn(help='\n`aws.ssoadmin_account_assignment.timeouts.new` constructs a new object with attributes and blocks configured for the `timeouts`\nTerraform sub block.\n\n\n\n**Args**:\n - `create` (`string`): Set the `create` field on the resulting object. When `null`, the `create` field will be omitted from the resulting object.\n - `delete` (`string`): Set the `delete` field on the resulting object. When `null`, the `delete` field will be omitted from the resulting object.\n\n**Returns**:\n - An attribute object that represents the `timeouts` sub block.\n', args=[]), + new( + create=null, + delete=null + ):: std.prune(a={ + create: create, + delete: delete, + }), + }, '#withInstanceArn':: d.fn(help='`aws.string.withInstanceArn` constructs a mixin object that can be merged into the `string`\nTerraform resource block to set or update the instance_arn field.\n\n\n\n**Args**:\n - `resourceLabel` (`string`): The name label of the block to update.\n - `value` (`string`): The value to set for the `instance_arn` field.\n', args=[]), withInstanceArn(resourceLabel, value): { resource+: { @@ -101,4 +115,24 @@ local d = (import 'github.com/jsonnet-libs/docsonnet/doc-util/main.libsonnet'); }, }, }, + '#withTimeouts':: d.fn(help='`aws.obj.withTimeouts` constructs a mixin object that can be merged into the `obj`\nTerraform resource block to set or update the timeouts field.\n\nThis function will replace the map with the passed in `value`. If you wish to instead merge the\npassed in value to the existing map, use the [aws.obj.withTimeoutsMixin](TODO) function.\n\n**Args**:\n - `resourceLabel` (`string`): The name label of the block to update.\n - `value` (`obj`): The value to set for the `timeouts` field.\n', args=[]), + withTimeouts(resourceLabel, value): { + resource+: { + aws_ssoadmin_account_assignment+: { + [resourceLabel]+: { + timeouts: value, + }, + }, + }, + }, + '#withTimeoutsMixin':: d.fn(help='`aws.obj.withTimeoutsMixin` constructs a mixin object that can be merged into the `obj`\nTerraform resource block to set or update the timeouts field.\n\nThis function will merge the passed in value to the existing map. If you wish\nto instead replace the entire map with the passed in `value`, use the [aws.obj.withTimeouts](TODO)\nfunction.\n\n\n**Args**:\n - `resourceLabel` (`string`): The name label of the block to update.\n - `value` (`obj`): The value to set for the `timeouts` field.\n', args=[]), + withTimeoutsMixin(resourceLabel, value): { + resource+: { + aws_ssoadmin_account_assignment+: { + [resourceLabel]+: { + timeouts+: value, + }, + }, + }, + }, } diff --git a/5.x/_gen/resources/ssoadmin_customer_managed_policy_attachment.libsonnet b/5.x/_gen/resources/ssoadmin_customer_managed_policy_attachment.libsonnet index 3e2499d1..c4eda78e 100644 --- a/5.x/_gen/resources/ssoadmin_customer_managed_policy_attachment.libsonnet +++ b/5.x/_gen/resources/ssoadmin_customer_managed_policy_attachment.libsonnet @@ -12,29 +12,47 @@ local d = (import 'github.com/jsonnet-libs/docsonnet/doc-util/main.libsonnet'); path: path, }), }, - '#new':: d.fn(help="\n`aws.ssoadmin_customer_managed_policy_attachment.new` injects a new `aws_ssoadmin_customer_managed_policy_attachment` Terraform `resource`\nblock into the root module document.\n\nAdditionally, this inserts a private function into the `_ref` attribute that generates references to attributes of the\nresource. For example, if you added a new instance to the root using:\n\n # arguments omitted for brevity\n aws.ssoadmin_customer_managed_policy_attachment.new('some_id')\n\nYou can get the reference to the `id` field of the created `aws.ssoadmin_customer_managed_policy_attachment` using the reference:\n\n $._ref.aws_ssoadmin_customer_managed_policy_attachment.some_id.get('id')\n\nThis is the same as directly entering `\"${ aws_ssoadmin_customer_managed_policy_attachment.some_id.id }\"` as the value.\n\nNOTE: if you are chaining multiple resources together in a merge operation, you may not be able to use `super`, `self`,\nor `$` to refer to the root object. Instead, make an explicit outer object using `local`.\n\n**Args**:\n - `resourceLabel` (`string`): The name label of the block.\n - `instance_arn` (`string`): Set the `instance_arn` field on the resulting resource block.\n - `permission_set_arn` (`string`): Set the `permission_set_arn` field on the resulting resource block.\n - `customer_managed_policy_reference` (`list[obj]`): Set the `customer_managed_policy_reference` field on the resulting resource block. When `null`, the `customer_managed_policy_reference` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [aws.ssoadmin_customer_managed_policy_attachment.customer_managed_policy_reference.new](#fn-customer_managed_policy_referencenew) constructor.\n\n**Returns**:\n- A mixin object that injects the new resource into the root Terraform configuration.\n", args=[]), + '#new':: d.fn(help="\n`aws.ssoadmin_customer_managed_policy_attachment.new` injects a new `aws_ssoadmin_customer_managed_policy_attachment` Terraform `resource`\nblock into the root module document.\n\nAdditionally, this inserts a private function into the `_ref` attribute that generates references to attributes of the\nresource. For example, if you added a new instance to the root using:\n\n # arguments omitted for brevity\n aws.ssoadmin_customer_managed_policy_attachment.new('some_id')\n\nYou can get the reference to the `id` field of the created `aws.ssoadmin_customer_managed_policy_attachment` using the reference:\n\n $._ref.aws_ssoadmin_customer_managed_policy_attachment.some_id.get('id')\n\nThis is the same as directly entering `\"${ aws_ssoadmin_customer_managed_policy_attachment.some_id.id }\"` as the value.\n\nNOTE: if you are chaining multiple resources together in a merge operation, you may not be able to use `super`, `self`,\nor `$` to refer to the root object. Instead, make an explicit outer object using `local`.\n\n**Args**:\n - `resourceLabel` (`string`): The name label of the block.\n - `instance_arn` (`string`): Set the `instance_arn` field on the resulting resource block.\n - `permission_set_arn` (`string`): Set the `permission_set_arn` field on the resulting resource block.\n - `customer_managed_policy_reference` (`list[obj]`): Set the `customer_managed_policy_reference` field on the resulting resource block. When `null`, the `customer_managed_policy_reference` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [aws.ssoadmin_customer_managed_policy_attachment.customer_managed_policy_reference.new](#fn-customer_managed_policy_referencenew) constructor.\n - `timeouts` (`obj`): Set the `timeouts` field on the resulting resource block. When `null`, the `timeouts` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [aws.ssoadmin_customer_managed_policy_attachment.timeouts.new](#fn-timeoutsnew) constructor.\n\n**Returns**:\n- A mixin object that injects the new resource into the root Terraform configuration.\n", args=[]), new( resourceLabel, instance_arn, permission_set_arn, customer_managed_policy_reference=null, + timeouts=null, _meta={} ):: tf.withResource( type='aws_ssoadmin_customer_managed_policy_attachment', label=resourceLabel, - attrs=self.newAttrs(customer_managed_policy_reference=customer_managed_policy_reference, instance_arn=instance_arn, permission_set_arn=permission_set_arn), + attrs=self.newAttrs( + customer_managed_policy_reference=customer_managed_policy_reference, + instance_arn=instance_arn, + permission_set_arn=permission_set_arn, + timeouts=timeouts + ), _meta=_meta ), - '#newAttrs':: d.fn(help='\n`aws.ssoadmin_customer_managed_policy_attachment.newAttrs` constructs a new object with attributes and blocks configured for the `ssoadmin_customer_managed_policy_attachment`\nTerraform resource.\n\nUnlike [aws.ssoadmin_customer_managed_policy_attachment.new](#fn-new), this function will not inject the `resource`\nblock into the root Terraform document. Instead, this must be passed in as the `attrs` argument for the\n[tf.withResource](https://github.com/tf-libsonnet/core/tree/main/docs#fn-withresource) function to build a complete block.\n\nThis is most useful when you need to preprocess the attributes with functions, conditional, or looping logic prior to\ninjecting into a complete block.\n\n**Args**:\n - `instance_arn` (`string`): Set the `instance_arn` field on the resulting object.\n - `permission_set_arn` (`string`): Set the `permission_set_arn` field on the resulting object.\n - `customer_managed_policy_reference` (`list[obj]`): Set the `customer_managed_policy_reference` field on the resulting object. When `null`, the `customer_managed_policy_reference` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [aws.ssoadmin_customer_managed_policy_attachment.customer_managed_policy_reference.new](#fn-customer_managed_policy_referencenew) constructor.\n\n**Returns**:\n - An attribute object that can be used with [tf.withResource](https://github.com/tf-libsonnet/core/tree/main/docs#fn-withresource) to construct a new `ssoadmin_customer_managed_policy_attachment` resource into the root Terraform configuration.\n', args=[]), + '#newAttrs':: d.fn(help='\n`aws.ssoadmin_customer_managed_policy_attachment.newAttrs` constructs a new object with attributes and blocks configured for the `ssoadmin_customer_managed_policy_attachment`\nTerraform resource.\n\nUnlike [aws.ssoadmin_customer_managed_policy_attachment.new](#fn-new), this function will not inject the `resource`\nblock into the root Terraform document. Instead, this must be passed in as the `attrs` argument for the\n[tf.withResource](https://github.com/tf-libsonnet/core/tree/main/docs#fn-withresource) function to build a complete block.\n\nThis is most useful when you need to preprocess the attributes with functions, conditional, or looping logic prior to\ninjecting into a complete block.\n\n**Args**:\n - `instance_arn` (`string`): Set the `instance_arn` field on the resulting object.\n - `permission_set_arn` (`string`): Set the `permission_set_arn` field on the resulting object.\n - `customer_managed_policy_reference` (`list[obj]`): Set the `customer_managed_policy_reference` field on the resulting object. When `null`, the `customer_managed_policy_reference` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [aws.ssoadmin_customer_managed_policy_attachment.customer_managed_policy_reference.new](#fn-customer_managed_policy_referencenew) constructor.\n - `timeouts` (`obj`): Set the `timeouts` field on the resulting object. When `null`, the `timeouts` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [aws.ssoadmin_customer_managed_policy_attachment.timeouts.new](#fn-timeoutsnew) constructor.\n\n**Returns**:\n - An attribute object that can be used with [tf.withResource](https://github.com/tf-libsonnet/core/tree/main/docs#fn-withresource) to construct a new `ssoadmin_customer_managed_policy_attachment` resource into the root Terraform configuration.\n', args=[]), newAttrs( instance_arn, permission_set_arn, - customer_managed_policy_reference=null + customer_managed_policy_reference=null, + timeouts=null ):: std.prune(a={ customer_managed_policy_reference: customer_managed_policy_reference, instance_arn: instance_arn, permission_set_arn: permission_set_arn, + timeouts: timeouts, }), + timeouts:: { + '#new':: d.fn(help='\n`aws.ssoadmin_customer_managed_policy_attachment.timeouts.new` constructs a new object with attributes and blocks configured for the `timeouts`\nTerraform sub block.\n\n\n\n**Args**:\n - `create` (`string`): Set the `create` field on the resulting object. When `null`, the `create` field will be omitted from the resulting object.\n - `delete` (`string`): Set the `delete` field on the resulting object. When `null`, the `delete` field will be omitted from the resulting object.\n\n**Returns**:\n - An attribute object that represents the `timeouts` sub block.\n', args=[]), + new( + create=null, + delete=null + ):: std.prune(a={ + create: create, + delete: delete, + }), + }, '#withCustomerManagedPolicyReference':: d.fn(help='`aws.list[obj].withCustomerManagedPolicyReference` constructs a mixin object that can be merged into the `list[obj]`\nTerraform resource block to set or update the customer_managed_policy_reference field.\n\nThis function will replace the array with the passed in `value`. If you wish to instead append the\npassed in value to the existing array, use the [aws.list[obj].withCustomerManagedPolicyReferenceMixin](TODO) function.\n\n\n**Args**:\n - `resourceLabel` (`string`): The name label of the block to update.\n - `value` (`list[obj]`): The value to set for the `customer_managed_policy_reference` field.\n', args=[]), withCustomerManagedPolicyReference(resourceLabel, value): { resource+: { @@ -75,4 +93,24 @@ local d = (import 'github.com/jsonnet-libs/docsonnet/doc-util/main.libsonnet'); }, }, }, + '#withTimeouts':: d.fn(help='`aws.obj.withTimeouts` constructs a mixin object that can be merged into the `obj`\nTerraform resource block to set or update the timeouts field.\n\nThis function will replace the map with the passed in `value`. If you wish to instead merge the\npassed in value to the existing map, use the [aws.obj.withTimeoutsMixin](TODO) function.\n\n**Args**:\n - `resourceLabel` (`string`): The name label of the block to update.\n - `value` (`obj`): The value to set for the `timeouts` field.\n', args=[]), + withTimeouts(resourceLabel, value): { + resource+: { + aws_ssoadmin_customer_managed_policy_attachment+: { + [resourceLabel]+: { + timeouts: value, + }, + }, + }, + }, + '#withTimeoutsMixin':: d.fn(help='`aws.obj.withTimeoutsMixin` constructs a mixin object that can be merged into the `obj`\nTerraform resource block to set or update the timeouts field.\n\nThis function will merge the passed in value to the existing map. If you wish\nto instead replace the entire map with the passed in `value`, use the [aws.obj.withTimeouts](TODO)\nfunction.\n\n\n**Args**:\n - `resourceLabel` (`string`): The name label of the block to update.\n - `value` (`obj`): The value to set for the `timeouts` field.\n', args=[]), + withTimeoutsMixin(resourceLabel, value): { + resource+: { + aws_ssoadmin_customer_managed_policy_attachment+: { + [resourceLabel]+: { + timeouts+: value, + }, + }, + }, + }, } diff --git a/5.x/_gen/resources/ssoadmin_managed_policy_attachment.libsonnet b/5.x/_gen/resources/ssoadmin_managed_policy_attachment.libsonnet index dcc50580..7277e1f3 100644 --- a/5.x/_gen/resources/ssoadmin_managed_policy_attachment.libsonnet +++ b/5.x/_gen/resources/ssoadmin_managed_policy_attachment.libsonnet @@ -2,29 +2,47 @@ local tf = (import 'github.com/tf-libsonnet/core/main.libsonnet'); local d = (import 'github.com/jsonnet-libs/docsonnet/doc-util/main.libsonnet'); { '#':: d.pkg(name='ssoadmin_managed_policy_attachment', url='', help='`ssoadmin_managed_policy_attachment` represents the `aws_ssoadmin_managed_policy_attachment` Terraform resource.\n\n\n\nThis package contains functions and utilities for setting up the resource using Jsonnet code.\n'), - '#new':: d.fn(help="\n`aws.ssoadmin_managed_policy_attachment.new` injects a new `aws_ssoadmin_managed_policy_attachment` Terraform `resource`\nblock into the root module document.\n\nAdditionally, this inserts a private function into the `_ref` attribute that generates references to attributes of the\nresource. For example, if you added a new instance to the root using:\n\n # arguments omitted for brevity\n aws.ssoadmin_managed_policy_attachment.new('some_id')\n\nYou can get the reference to the `id` field of the created `aws.ssoadmin_managed_policy_attachment` using the reference:\n\n $._ref.aws_ssoadmin_managed_policy_attachment.some_id.get('id')\n\nThis is the same as directly entering `\"${ aws_ssoadmin_managed_policy_attachment.some_id.id }\"` as the value.\n\nNOTE: if you are chaining multiple resources together in a merge operation, you may not be able to use `super`, `self`,\nor `$` to refer to the root object. Instead, make an explicit outer object using `local`.\n\n**Args**:\n - `resourceLabel` (`string`): The name label of the block.\n - `instance_arn` (`string`): Set the `instance_arn` field on the resulting resource block.\n - `managed_policy_arn` (`string`): Set the `managed_policy_arn` field on the resulting resource block.\n - `permission_set_arn` (`string`): Set the `permission_set_arn` field on the resulting resource block.\n\n**Returns**:\n- A mixin object that injects the new resource into the root Terraform configuration.\n", args=[]), + '#new':: d.fn(help="\n`aws.ssoadmin_managed_policy_attachment.new` injects a new `aws_ssoadmin_managed_policy_attachment` Terraform `resource`\nblock into the root module document.\n\nAdditionally, this inserts a private function into the `_ref` attribute that generates references to attributes of the\nresource. For example, if you added a new instance to the root using:\n\n # arguments omitted for brevity\n aws.ssoadmin_managed_policy_attachment.new('some_id')\n\nYou can get the reference to the `id` field of the created `aws.ssoadmin_managed_policy_attachment` using the reference:\n\n $._ref.aws_ssoadmin_managed_policy_attachment.some_id.get('id')\n\nThis is the same as directly entering `\"${ aws_ssoadmin_managed_policy_attachment.some_id.id }\"` as the value.\n\nNOTE: if you are chaining multiple resources together in a merge operation, you may not be able to use `super`, `self`,\nor `$` to refer to the root object. Instead, make an explicit outer object using `local`.\n\n**Args**:\n - `resourceLabel` (`string`): The name label of the block.\n - `instance_arn` (`string`): Set the `instance_arn` field on the resulting resource block.\n - `managed_policy_arn` (`string`): Set the `managed_policy_arn` field on the resulting resource block.\n - `permission_set_arn` (`string`): Set the `permission_set_arn` field on the resulting resource block.\n - `timeouts` (`obj`): Set the `timeouts` field on the resulting resource block. When `null`, the `timeouts` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [aws.ssoadmin_managed_policy_attachment.timeouts.new](#fn-timeoutsnew) constructor.\n\n**Returns**:\n- A mixin object that injects the new resource into the root Terraform configuration.\n", args=[]), new( resourceLabel, instance_arn, managed_policy_arn, permission_set_arn, + timeouts=null, _meta={} ):: tf.withResource( type='aws_ssoadmin_managed_policy_attachment', label=resourceLabel, - attrs=self.newAttrs(instance_arn=instance_arn, managed_policy_arn=managed_policy_arn, permission_set_arn=permission_set_arn), + attrs=self.newAttrs( + instance_arn=instance_arn, + managed_policy_arn=managed_policy_arn, + permission_set_arn=permission_set_arn, + timeouts=timeouts + ), _meta=_meta ), - '#newAttrs':: d.fn(help='\n`aws.ssoadmin_managed_policy_attachment.newAttrs` constructs a new object with attributes and blocks configured for the `ssoadmin_managed_policy_attachment`\nTerraform resource.\n\nUnlike [aws.ssoadmin_managed_policy_attachment.new](#fn-new), this function will not inject the `resource`\nblock into the root Terraform document. Instead, this must be passed in as the `attrs` argument for the\n[tf.withResource](https://github.com/tf-libsonnet/core/tree/main/docs#fn-withresource) function to build a complete block.\n\nThis is most useful when you need to preprocess the attributes with functions, conditional, or looping logic prior to\ninjecting into a complete block.\n\n**Args**:\n - `instance_arn` (`string`): Set the `instance_arn` field on the resulting object.\n - `managed_policy_arn` (`string`): Set the `managed_policy_arn` field on the resulting object.\n - `permission_set_arn` (`string`): Set the `permission_set_arn` field on the resulting object.\n\n**Returns**:\n - An attribute object that can be used with [tf.withResource](https://github.com/tf-libsonnet/core/tree/main/docs#fn-withresource) to construct a new `ssoadmin_managed_policy_attachment` resource into the root Terraform configuration.\n', args=[]), + '#newAttrs':: d.fn(help='\n`aws.ssoadmin_managed_policy_attachment.newAttrs` constructs a new object with attributes and blocks configured for the `ssoadmin_managed_policy_attachment`\nTerraform resource.\n\nUnlike [aws.ssoadmin_managed_policy_attachment.new](#fn-new), this function will not inject the `resource`\nblock into the root Terraform document. Instead, this must be passed in as the `attrs` argument for the\n[tf.withResource](https://github.com/tf-libsonnet/core/tree/main/docs#fn-withresource) function to build a complete block.\n\nThis is most useful when you need to preprocess the attributes with functions, conditional, or looping logic prior to\ninjecting into a complete block.\n\n**Args**:\n - `instance_arn` (`string`): Set the `instance_arn` field on the resulting object.\n - `managed_policy_arn` (`string`): Set the `managed_policy_arn` field on the resulting object.\n - `permission_set_arn` (`string`): Set the `permission_set_arn` field on the resulting object.\n - `timeouts` (`obj`): Set the `timeouts` field on the resulting object. When `null`, the `timeouts` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [aws.ssoadmin_managed_policy_attachment.timeouts.new](#fn-timeoutsnew) constructor.\n\n**Returns**:\n - An attribute object that can be used with [tf.withResource](https://github.com/tf-libsonnet/core/tree/main/docs#fn-withresource) to construct a new `ssoadmin_managed_policy_attachment` resource into the root Terraform configuration.\n', args=[]), newAttrs( instance_arn, managed_policy_arn, - permission_set_arn + permission_set_arn, + timeouts=null ):: std.prune(a={ instance_arn: instance_arn, managed_policy_arn: managed_policy_arn, permission_set_arn: permission_set_arn, + timeouts: timeouts, }), + timeouts:: { + '#new':: d.fn(help='\n`aws.ssoadmin_managed_policy_attachment.timeouts.new` constructs a new object with attributes and blocks configured for the `timeouts`\nTerraform sub block.\n\n\n\n**Args**:\n - `create` (`string`): Set the `create` field on the resulting object. When `null`, the `create` field will be omitted from the resulting object.\n - `delete` (`string`): Set the `delete` field on the resulting object. When `null`, the `delete` field will be omitted from the resulting object.\n\n**Returns**:\n - An attribute object that represents the `timeouts` sub block.\n', args=[]), + new( + create=null, + delete=null + ):: std.prune(a={ + create: create, + delete: delete, + }), + }, '#withInstanceArn':: d.fn(help='`aws.string.withInstanceArn` constructs a mixin object that can be merged into the `string`\nTerraform resource block to set or update the instance_arn field.\n\n\n\n**Args**:\n - `resourceLabel` (`string`): The name label of the block to update.\n - `value` (`string`): The value to set for the `instance_arn` field.\n', args=[]), withInstanceArn(resourceLabel, value): { resource+: { @@ -55,4 +73,24 @@ local d = (import 'github.com/jsonnet-libs/docsonnet/doc-util/main.libsonnet'); }, }, }, + '#withTimeouts':: d.fn(help='`aws.obj.withTimeouts` constructs a mixin object that can be merged into the `obj`\nTerraform resource block to set or update the timeouts field.\n\nThis function will replace the map with the passed in `value`. If you wish to instead merge the\npassed in value to the existing map, use the [aws.obj.withTimeoutsMixin](TODO) function.\n\n**Args**:\n - `resourceLabel` (`string`): The name label of the block to update.\n - `value` (`obj`): The value to set for the `timeouts` field.\n', args=[]), + withTimeouts(resourceLabel, value): { + resource+: { + aws_ssoadmin_managed_policy_attachment+: { + [resourceLabel]+: { + timeouts: value, + }, + }, + }, + }, + '#withTimeoutsMixin':: d.fn(help='`aws.obj.withTimeoutsMixin` constructs a mixin object that can be merged into the `obj`\nTerraform resource block to set or update the timeouts field.\n\nThis function will merge the passed in value to the existing map. If you wish\nto instead replace the entire map with the passed in `value`, use the [aws.obj.withTimeouts](TODO)\nfunction.\n\n\n**Args**:\n - `resourceLabel` (`string`): The name label of the block to update.\n - `value` (`obj`): The value to set for the `timeouts` field.\n', args=[]), + withTimeoutsMixin(resourceLabel, value): { + resource+: { + aws_ssoadmin_managed_policy_attachment+: { + [resourceLabel]+: { + timeouts+: value, + }, + }, + }, + }, } diff --git a/5.x/_gen/resources/ssoadmin_permission_set.libsonnet b/5.x/_gen/resources/ssoadmin_permission_set.libsonnet index 39c08030..54fb1324 100644 --- a/5.x/_gen/resources/ssoadmin_permission_set.libsonnet +++ b/5.x/_gen/resources/ssoadmin_permission_set.libsonnet @@ -2,7 +2,7 @@ local tf = (import 'github.com/tf-libsonnet/core/main.libsonnet'); local d = (import 'github.com/jsonnet-libs/docsonnet/doc-util/main.libsonnet'); { '#':: d.pkg(name='ssoadmin_permission_set', url='', help='`ssoadmin_permission_set` represents the `aws_ssoadmin_permission_set` Terraform resource.\n\n\n\nThis package contains functions and utilities for setting up the resource using Jsonnet code.\n'), - '#new':: d.fn(help="\n`aws.ssoadmin_permission_set.new` injects a new `aws_ssoadmin_permission_set` Terraform `resource`\nblock into the root module document.\n\nAdditionally, this inserts a private function into the `_ref` attribute that generates references to attributes of the\nresource. For example, if you added a new instance to the root using:\n\n # arguments omitted for brevity\n aws.ssoadmin_permission_set.new('some_id')\n\nYou can get the reference to the `id` field of the created `aws.ssoadmin_permission_set` using the reference:\n\n $._ref.aws_ssoadmin_permission_set.some_id.get('id')\n\nThis is the same as directly entering `\"${ aws_ssoadmin_permission_set.some_id.id }\"` as the value.\n\nNOTE: if you are chaining multiple resources together in a merge operation, you may not be able to use `super`, `self`,\nor `$` to refer to the root object. Instead, make an explicit outer object using `local`.\n\n**Args**:\n - `resourceLabel` (`string`): The name label of the block.\n - `description` (`string`): Set the `description` field on the resulting resource block. When `null`, the `description` field will be omitted from the resulting object.\n - `instance_arn` (`string`): Set the `instance_arn` field on the resulting resource block.\n - `name` (`string`): Set the `name` field on the resulting resource block.\n - `relay_state` (`string`): Set the `relay_state` field on the resulting resource block. When `null`, the `relay_state` field will be omitted from the resulting object.\n - `session_duration` (`string`): Set the `session_duration` field on the resulting resource block. When `null`, the `session_duration` field will be omitted from the resulting object.\n - `tags` (`obj`): Set the `tags` field on the resulting resource block. When `null`, the `tags` field will be omitted from the resulting object.\n - `tags_all` (`obj`): Set the `tags_all` field on the resulting resource block. When `null`, the `tags_all` field will be omitted from the resulting object.\n\n**Returns**:\n- A mixin object that injects the new resource into the root Terraform configuration.\n", args=[]), + '#new':: d.fn(help="\n`aws.ssoadmin_permission_set.new` injects a new `aws_ssoadmin_permission_set` Terraform `resource`\nblock into the root module document.\n\nAdditionally, this inserts a private function into the `_ref` attribute that generates references to attributes of the\nresource. For example, if you added a new instance to the root using:\n\n # arguments omitted for brevity\n aws.ssoadmin_permission_set.new('some_id')\n\nYou can get the reference to the `id` field of the created `aws.ssoadmin_permission_set` using the reference:\n\n $._ref.aws_ssoadmin_permission_set.some_id.get('id')\n\nThis is the same as directly entering `\"${ aws_ssoadmin_permission_set.some_id.id }\"` as the value.\n\nNOTE: if you are chaining multiple resources together in a merge operation, you may not be able to use `super`, `self`,\nor `$` to refer to the root object. Instead, make an explicit outer object using `local`.\n\n**Args**:\n - `resourceLabel` (`string`): The name label of the block.\n - `description` (`string`): Set the `description` field on the resulting resource block. When `null`, the `description` field will be omitted from the resulting object.\n - `instance_arn` (`string`): Set the `instance_arn` field on the resulting resource block.\n - `name` (`string`): Set the `name` field on the resulting resource block.\n - `relay_state` (`string`): Set the `relay_state` field on the resulting resource block. When `null`, the `relay_state` field will be omitted from the resulting object.\n - `session_duration` (`string`): Set the `session_duration` field on the resulting resource block. When `null`, the `session_duration` field will be omitted from the resulting object.\n - `tags` (`obj`): Set the `tags` field on the resulting resource block. When `null`, the `tags` field will be omitted from the resulting object.\n - `tags_all` (`obj`): Set the `tags_all` field on the resulting resource block. When `null`, the `tags_all` field will be omitted from the resulting object.\n - `timeouts` (`obj`): Set the `timeouts` field on the resulting resource block. When `null`, the `timeouts` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [aws.ssoadmin_permission_set.timeouts.new](#fn-timeoutsnew) constructor.\n\n**Returns**:\n- A mixin object that injects the new resource into the root Terraform configuration.\n", args=[]), new( resourceLabel, instance_arn, @@ -12,6 +12,7 @@ local d = (import 'github.com/jsonnet-libs/docsonnet/doc-util/main.libsonnet'); session_duration=null, tags=null, tags_all=null, + timeouts=null, _meta={} ):: tf.withResource( type='aws_ssoadmin_permission_set', @@ -23,11 +24,12 @@ local d = (import 'github.com/jsonnet-libs/docsonnet/doc-util/main.libsonnet'); relay_state=relay_state, session_duration=session_duration, tags=tags, - tags_all=tags_all + tags_all=tags_all, + timeouts=timeouts ), _meta=_meta ), - '#newAttrs':: d.fn(help='\n`aws.ssoadmin_permission_set.newAttrs` constructs a new object with attributes and blocks configured for the `ssoadmin_permission_set`\nTerraform resource.\n\nUnlike [aws.ssoadmin_permission_set.new](#fn-new), this function will not inject the `resource`\nblock into the root Terraform document. Instead, this must be passed in as the `attrs` argument for the\n[tf.withResource](https://github.com/tf-libsonnet/core/tree/main/docs#fn-withresource) function to build a complete block.\n\nThis is most useful when you need to preprocess the attributes with functions, conditional, or looping logic prior to\ninjecting into a complete block.\n\n**Args**:\n - `description` (`string`): Set the `description` field on the resulting object. When `null`, the `description` field will be omitted from the resulting object.\n - `instance_arn` (`string`): Set the `instance_arn` field on the resulting object.\n - `name` (`string`): Set the `name` field on the resulting object.\n - `relay_state` (`string`): Set the `relay_state` field on the resulting object. When `null`, the `relay_state` field will be omitted from the resulting object.\n - `session_duration` (`string`): Set the `session_duration` field on the resulting object. When `null`, the `session_duration` field will be omitted from the resulting object.\n - `tags` (`obj`): Set the `tags` field on the resulting object. When `null`, the `tags` field will be omitted from the resulting object.\n - `tags_all` (`obj`): Set the `tags_all` field on the resulting object. When `null`, the `tags_all` field will be omitted from the resulting object.\n\n**Returns**:\n - An attribute object that can be used with [tf.withResource](https://github.com/tf-libsonnet/core/tree/main/docs#fn-withresource) to construct a new `ssoadmin_permission_set` resource into the root Terraform configuration.\n', args=[]), + '#newAttrs':: d.fn(help='\n`aws.ssoadmin_permission_set.newAttrs` constructs a new object with attributes and blocks configured for the `ssoadmin_permission_set`\nTerraform resource.\n\nUnlike [aws.ssoadmin_permission_set.new](#fn-new), this function will not inject the `resource`\nblock into the root Terraform document. Instead, this must be passed in as the `attrs` argument for the\n[tf.withResource](https://github.com/tf-libsonnet/core/tree/main/docs#fn-withresource) function to build a complete block.\n\nThis is most useful when you need to preprocess the attributes with functions, conditional, or looping logic prior to\ninjecting into a complete block.\n\n**Args**:\n - `description` (`string`): Set the `description` field on the resulting object. When `null`, the `description` field will be omitted from the resulting object.\n - `instance_arn` (`string`): Set the `instance_arn` field on the resulting object.\n - `name` (`string`): Set the `name` field on the resulting object.\n - `relay_state` (`string`): Set the `relay_state` field on the resulting object. When `null`, the `relay_state` field will be omitted from the resulting object.\n - `session_duration` (`string`): Set the `session_duration` field on the resulting object. When `null`, the `session_duration` field will be omitted from the resulting object.\n - `tags` (`obj`): Set the `tags` field on the resulting object. When `null`, the `tags` field will be omitted from the resulting object.\n - `tags_all` (`obj`): Set the `tags_all` field on the resulting object. When `null`, the `tags_all` field will be omitted from the resulting object.\n - `timeouts` (`obj`): Set the `timeouts` field on the resulting object. When `null`, the `timeouts` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [aws.ssoadmin_permission_set.timeouts.new](#fn-timeoutsnew) constructor.\n\n**Returns**:\n - An attribute object that can be used with [tf.withResource](https://github.com/tf-libsonnet/core/tree/main/docs#fn-withresource) to construct a new `ssoadmin_permission_set` resource into the root Terraform configuration.\n', args=[]), newAttrs( instance_arn, name, @@ -35,7 +37,8 @@ local d = (import 'github.com/jsonnet-libs/docsonnet/doc-util/main.libsonnet'); relay_state=null, session_duration=null, tags=null, - tags_all=null + tags_all=null, + timeouts=null ):: std.prune(a={ description: description, instance_arn: instance_arn, @@ -44,7 +47,16 @@ local d = (import 'github.com/jsonnet-libs/docsonnet/doc-util/main.libsonnet'); session_duration: session_duration, tags: tags, tags_all: tags_all, + timeouts: timeouts, }), + timeouts:: { + '#new':: d.fn(help='\n`aws.ssoadmin_permission_set.timeouts.new` constructs a new object with attributes and blocks configured for the `timeouts`\nTerraform sub block.\n\n\n\n**Args**:\n - `update` (`string`): Set the `update` field on the resulting object. When `null`, the `update` field will be omitted from the resulting object.\n\n**Returns**:\n - An attribute object that represents the `timeouts` sub block.\n', args=[]), + new( + update=null + ):: std.prune(a={ + update: update, + }), + }, '#withDescription':: d.fn(help='`aws.string.withDescription` constructs a mixin object that can be merged into the `string`\nTerraform resource block to set or update the description field.\n\n\n\n**Args**:\n - `resourceLabel` (`string`): The name label of the block to update.\n - `value` (`string`): The value to set for the `description` field.\n', args=[]), withDescription(resourceLabel, value): { resource+: { @@ -115,4 +127,24 @@ local d = (import 'github.com/jsonnet-libs/docsonnet/doc-util/main.libsonnet'); }, }, }, + '#withTimeouts':: d.fn(help='`aws.obj.withTimeouts` constructs a mixin object that can be merged into the `obj`\nTerraform resource block to set or update the timeouts field.\n\nThis function will replace the map with the passed in `value`. If you wish to instead merge the\npassed in value to the existing map, use the [aws.obj.withTimeoutsMixin](TODO) function.\n\n**Args**:\n - `resourceLabel` (`string`): The name label of the block to update.\n - `value` (`obj`): The value to set for the `timeouts` field.\n', args=[]), + withTimeouts(resourceLabel, value): { + resource+: { + aws_ssoadmin_permission_set+: { + [resourceLabel]+: { + timeouts: value, + }, + }, + }, + }, + '#withTimeoutsMixin':: d.fn(help='`aws.obj.withTimeoutsMixin` constructs a mixin object that can be merged into the `obj`\nTerraform resource block to set or update the timeouts field.\n\nThis function will merge the passed in value to the existing map. If you wish\nto instead replace the entire map with the passed in `value`, use the [aws.obj.withTimeouts](TODO)\nfunction.\n\n\n**Args**:\n - `resourceLabel` (`string`): The name label of the block to update.\n - `value` (`obj`): The value to set for the `timeouts` field.\n', args=[]), + withTimeoutsMixin(resourceLabel, value): { + resource+: { + aws_ssoadmin_permission_set+: { + [resourceLabel]+: { + timeouts+: value, + }, + }, + }, + }, } diff --git a/5.x/_gen/resources/ssoadmin_permission_set_inline_policy.libsonnet b/5.x/_gen/resources/ssoadmin_permission_set_inline_policy.libsonnet index 0bf5241d..2927ac75 100644 --- a/5.x/_gen/resources/ssoadmin_permission_set_inline_policy.libsonnet +++ b/5.x/_gen/resources/ssoadmin_permission_set_inline_policy.libsonnet @@ -2,29 +2,47 @@ local tf = (import 'github.com/tf-libsonnet/core/main.libsonnet'); local d = (import 'github.com/jsonnet-libs/docsonnet/doc-util/main.libsonnet'); { '#':: d.pkg(name='ssoadmin_permission_set_inline_policy', url='', help='`ssoadmin_permission_set_inline_policy` represents the `aws_ssoadmin_permission_set_inline_policy` Terraform resource.\n\n\n\nThis package contains functions and utilities for setting up the resource using Jsonnet code.\n'), - '#new':: d.fn(help="\n`aws.ssoadmin_permission_set_inline_policy.new` injects a new `aws_ssoadmin_permission_set_inline_policy` Terraform `resource`\nblock into the root module document.\n\nAdditionally, this inserts a private function into the `_ref` attribute that generates references to attributes of the\nresource. For example, if you added a new instance to the root using:\n\n # arguments omitted for brevity\n aws.ssoadmin_permission_set_inline_policy.new('some_id')\n\nYou can get the reference to the `id` field of the created `aws.ssoadmin_permission_set_inline_policy` using the reference:\n\n $._ref.aws_ssoadmin_permission_set_inline_policy.some_id.get('id')\n\nThis is the same as directly entering `\"${ aws_ssoadmin_permission_set_inline_policy.some_id.id }\"` as the value.\n\nNOTE: if you are chaining multiple resources together in a merge operation, you may not be able to use `super`, `self`,\nor `$` to refer to the root object. Instead, make an explicit outer object using `local`.\n\n**Args**:\n - `resourceLabel` (`string`): The name label of the block.\n - `inline_policy` (`string`): Set the `inline_policy` field on the resulting resource block.\n - `instance_arn` (`string`): Set the `instance_arn` field on the resulting resource block.\n - `permission_set_arn` (`string`): Set the `permission_set_arn` field on the resulting resource block.\n\n**Returns**:\n- A mixin object that injects the new resource into the root Terraform configuration.\n", args=[]), + '#new':: d.fn(help="\n`aws.ssoadmin_permission_set_inline_policy.new` injects a new `aws_ssoadmin_permission_set_inline_policy` Terraform `resource`\nblock into the root module document.\n\nAdditionally, this inserts a private function into the `_ref` attribute that generates references to attributes of the\nresource. For example, if you added a new instance to the root using:\n\n # arguments omitted for brevity\n aws.ssoadmin_permission_set_inline_policy.new('some_id')\n\nYou can get the reference to the `id` field of the created `aws.ssoadmin_permission_set_inline_policy` using the reference:\n\n $._ref.aws_ssoadmin_permission_set_inline_policy.some_id.get('id')\n\nThis is the same as directly entering `\"${ aws_ssoadmin_permission_set_inline_policy.some_id.id }\"` as the value.\n\nNOTE: if you are chaining multiple resources together in a merge operation, you may not be able to use `super`, `self`,\nor `$` to refer to the root object. Instead, make an explicit outer object using `local`.\n\n**Args**:\n - `resourceLabel` (`string`): The name label of the block.\n - `inline_policy` (`string`): Set the `inline_policy` field on the resulting resource block.\n - `instance_arn` (`string`): Set the `instance_arn` field on the resulting resource block.\n - `permission_set_arn` (`string`): Set the `permission_set_arn` field on the resulting resource block.\n - `timeouts` (`obj`): Set the `timeouts` field on the resulting resource block. When `null`, the `timeouts` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [aws.ssoadmin_permission_set_inline_policy.timeouts.new](#fn-timeoutsnew) constructor.\n\n**Returns**:\n- A mixin object that injects the new resource into the root Terraform configuration.\n", args=[]), new( resourceLabel, inline_policy, instance_arn, permission_set_arn, + timeouts=null, _meta={} ):: tf.withResource( type='aws_ssoadmin_permission_set_inline_policy', label=resourceLabel, - attrs=self.newAttrs(inline_policy=inline_policy, instance_arn=instance_arn, permission_set_arn=permission_set_arn), + attrs=self.newAttrs( + inline_policy=inline_policy, + instance_arn=instance_arn, + permission_set_arn=permission_set_arn, + timeouts=timeouts + ), _meta=_meta ), - '#newAttrs':: d.fn(help='\n`aws.ssoadmin_permission_set_inline_policy.newAttrs` constructs a new object with attributes and blocks configured for the `ssoadmin_permission_set_inline_policy`\nTerraform resource.\n\nUnlike [aws.ssoadmin_permission_set_inline_policy.new](#fn-new), this function will not inject the `resource`\nblock into the root Terraform document. Instead, this must be passed in as the `attrs` argument for the\n[tf.withResource](https://github.com/tf-libsonnet/core/tree/main/docs#fn-withresource) function to build a complete block.\n\nThis is most useful when you need to preprocess the attributes with functions, conditional, or looping logic prior to\ninjecting into a complete block.\n\n**Args**:\n - `inline_policy` (`string`): Set the `inline_policy` field on the resulting object.\n - `instance_arn` (`string`): Set the `instance_arn` field on the resulting object.\n - `permission_set_arn` (`string`): Set the `permission_set_arn` field on the resulting object.\n\n**Returns**:\n - An attribute object that can be used with [tf.withResource](https://github.com/tf-libsonnet/core/tree/main/docs#fn-withresource) to construct a new `ssoadmin_permission_set_inline_policy` resource into the root Terraform configuration.\n', args=[]), + '#newAttrs':: d.fn(help='\n`aws.ssoadmin_permission_set_inline_policy.newAttrs` constructs a new object with attributes and blocks configured for the `ssoadmin_permission_set_inline_policy`\nTerraform resource.\n\nUnlike [aws.ssoadmin_permission_set_inline_policy.new](#fn-new), this function will not inject the `resource`\nblock into the root Terraform document. Instead, this must be passed in as the `attrs` argument for the\n[tf.withResource](https://github.com/tf-libsonnet/core/tree/main/docs#fn-withresource) function to build a complete block.\n\nThis is most useful when you need to preprocess the attributes with functions, conditional, or looping logic prior to\ninjecting into a complete block.\n\n**Args**:\n - `inline_policy` (`string`): Set the `inline_policy` field on the resulting object.\n - `instance_arn` (`string`): Set the `instance_arn` field on the resulting object.\n - `permission_set_arn` (`string`): Set the `permission_set_arn` field on the resulting object.\n - `timeouts` (`obj`): Set the `timeouts` field on the resulting object. When `null`, the `timeouts` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [aws.ssoadmin_permission_set_inline_policy.timeouts.new](#fn-timeoutsnew) constructor.\n\n**Returns**:\n - An attribute object that can be used with [tf.withResource](https://github.com/tf-libsonnet/core/tree/main/docs#fn-withresource) to construct a new `ssoadmin_permission_set_inline_policy` resource into the root Terraform configuration.\n', args=[]), newAttrs( inline_policy, instance_arn, - permission_set_arn + permission_set_arn, + timeouts=null ):: std.prune(a={ inline_policy: inline_policy, instance_arn: instance_arn, permission_set_arn: permission_set_arn, + timeouts: timeouts, }), + timeouts:: { + '#new':: d.fn(help='\n`aws.ssoadmin_permission_set_inline_policy.timeouts.new` constructs a new object with attributes and blocks configured for the `timeouts`\nTerraform sub block.\n\n\n\n**Args**:\n - `create` (`string`): Set the `create` field on the resulting object. When `null`, the `create` field will be omitted from the resulting object.\n - `delete` (`string`): Set the `delete` field on the resulting object. When `null`, the `delete` field will be omitted from the resulting object.\n\n**Returns**:\n - An attribute object that represents the `timeouts` sub block.\n', args=[]), + new( + create=null, + delete=null + ):: std.prune(a={ + create: create, + delete: delete, + }), + }, '#withInlinePolicy':: d.fn(help='`aws.string.withInlinePolicy` constructs a mixin object that can be merged into the `string`\nTerraform resource block to set or update the inline_policy field.\n\n\n\n**Args**:\n - `resourceLabel` (`string`): The name label of the block to update.\n - `value` (`string`): The value to set for the `inline_policy` field.\n', args=[]), withInlinePolicy(resourceLabel, value): { resource+: { @@ -55,4 +73,24 @@ local d = (import 'github.com/jsonnet-libs/docsonnet/doc-util/main.libsonnet'); }, }, }, + '#withTimeouts':: d.fn(help='`aws.obj.withTimeouts` constructs a mixin object that can be merged into the `obj`\nTerraform resource block to set or update the timeouts field.\n\nThis function will replace the map with the passed in `value`. If you wish to instead merge the\npassed in value to the existing map, use the [aws.obj.withTimeoutsMixin](TODO) function.\n\n**Args**:\n - `resourceLabel` (`string`): The name label of the block to update.\n - `value` (`obj`): The value to set for the `timeouts` field.\n', args=[]), + withTimeouts(resourceLabel, value): { + resource+: { + aws_ssoadmin_permission_set_inline_policy+: { + [resourceLabel]+: { + timeouts: value, + }, + }, + }, + }, + '#withTimeoutsMixin':: d.fn(help='`aws.obj.withTimeoutsMixin` constructs a mixin object that can be merged into the `obj`\nTerraform resource block to set or update the timeouts field.\n\nThis function will merge the passed in value to the existing map. If you wish\nto instead replace the entire map with the passed in `value`, use the [aws.obj.withTimeouts](TODO)\nfunction.\n\n\n**Args**:\n - `resourceLabel` (`string`): The name label of the block to update.\n - `value` (`obj`): The value to set for the `timeouts` field.\n', args=[]), + withTimeoutsMixin(resourceLabel, value): { + resource+: { + aws_ssoadmin_permission_set_inline_policy+: { + [resourceLabel]+: { + timeouts+: value, + }, + }, + }, + }, } diff --git a/5.x/_gen/resources/ssoadmin_permissions_boundary_attachment.libsonnet b/5.x/_gen/resources/ssoadmin_permissions_boundary_attachment.libsonnet index afb1f031..7a76e44b 100644 --- a/5.x/_gen/resources/ssoadmin_permissions_boundary_attachment.libsonnet +++ b/5.x/_gen/resources/ssoadmin_permissions_boundary_attachment.libsonnet @@ -2,28 +2,36 @@ local tf = (import 'github.com/tf-libsonnet/core/main.libsonnet'); local d = (import 'github.com/jsonnet-libs/docsonnet/doc-util/main.libsonnet'); { '#':: d.pkg(name='ssoadmin_permissions_boundary_attachment', url='', help='`ssoadmin_permissions_boundary_attachment` represents the `aws_ssoadmin_permissions_boundary_attachment` Terraform resource.\n\n\n\nThis package contains functions and utilities for setting up the resource using Jsonnet code.\n'), - '#new':: d.fn(help="\n`aws.ssoadmin_permissions_boundary_attachment.new` injects a new `aws_ssoadmin_permissions_boundary_attachment` Terraform `resource`\nblock into the root module document.\n\nAdditionally, this inserts a private function into the `_ref` attribute that generates references to attributes of the\nresource. For example, if you added a new instance to the root using:\n\n # arguments omitted for brevity\n aws.ssoadmin_permissions_boundary_attachment.new('some_id')\n\nYou can get the reference to the `id` field of the created `aws.ssoadmin_permissions_boundary_attachment` using the reference:\n\n $._ref.aws_ssoadmin_permissions_boundary_attachment.some_id.get('id')\n\nThis is the same as directly entering `\"${ aws_ssoadmin_permissions_boundary_attachment.some_id.id }\"` as the value.\n\nNOTE: if you are chaining multiple resources together in a merge operation, you may not be able to use `super`, `self`,\nor `$` to refer to the root object. Instead, make an explicit outer object using `local`.\n\n**Args**:\n - `resourceLabel` (`string`): The name label of the block.\n - `instance_arn` (`string`): Set the `instance_arn` field on the resulting resource block.\n - `permission_set_arn` (`string`): Set the `permission_set_arn` field on the resulting resource block.\n - `permissions_boundary` (`list[obj]`): Set the `permissions_boundary` field on the resulting resource block. When `null`, the `permissions_boundary` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [aws.ssoadmin_permissions_boundary_attachment.permissions_boundary.new](#fn-permissions_boundarynew) constructor.\n\n**Returns**:\n- A mixin object that injects the new resource into the root Terraform configuration.\n", args=[]), + '#new':: d.fn(help="\n`aws.ssoadmin_permissions_boundary_attachment.new` injects a new `aws_ssoadmin_permissions_boundary_attachment` Terraform `resource`\nblock into the root module document.\n\nAdditionally, this inserts a private function into the `_ref` attribute that generates references to attributes of the\nresource. For example, if you added a new instance to the root using:\n\n # arguments omitted for brevity\n aws.ssoadmin_permissions_boundary_attachment.new('some_id')\n\nYou can get the reference to the `id` field of the created `aws.ssoadmin_permissions_boundary_attachment` using the reference:\n\n $._ref.aws_ssoadmin_permissions_boundary_attachment.some_id.get('id')\n\nThis is the same as directly entering `\"${ aws_ssoadmin_permissions_boundary_attachment.some_id.id }\"` as the value.\n\nNOTE: if you are chaining multiple resources together in a merge operation, you may not be able to use `super`, `self`,\nor `$` to refer to the root object. Instead, make an explicit outer object using `local`.\n\n**Args**:\n - `resourceLabel` (`string`): The name label of the block.\n - `instance_arn` (`string`): Set the `instance_arn` field on the resulting resource block.\n - `permission_set_arn` (`string`): Set the `permission_set_arn` field on the resulting resource block.\n - `permissions_boundary` (`list[obj]`): Set the `permissions_boundary` field on the resulting resource block. When `null`, the `permissions_boundary` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [aws.ssoadmin_permissions_boundary_attachment.permissions_boundary.new](#fn-permissions_boundarynew) constructor.\n - `timeouts` (`obj`): Set the `timeouts` field on the resulting resource block. When `null`, the `timeouts` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [aws.ssoadmin_permissions_boundary_attachment.timeouts.new](#fn-timeoutsnew) constructor.\n\n**Returns**:\n- A mixin object that injects the new resource into the root Terraform configuration.\n", args=[]), new( resourceLabel, instance_arn, permission_set_arn, permissions_boundary=null, + timeouts=null, _meta={} ):: tf.withResource( type='aws_ssoadmin_permissions_boundary_attachment', label=resourceLabel, - attrs=self.newAttrs(instance_arn=instance_arn, permission_set_arn=permission_set_arn, permissions_boundary=permissions_boundary), + attrs=self.newAttrs( + instance_arn=instance_arn, + permission_set_arn=permission_set_arn, + permissions_boundary=permissions_boundary, + timeouts=timeouts + ), _meta=_meta ), - '#newAttrs':: d.fn(help='\n`aws.ssoadmin_permissions_boundary_attachment.newAttrs` constructs a new object with attributes and blocks configured for the `ssoadmin_permissions_boundary_attachment`\nTerraform resource.\n\nUnlike [aws.ssoadmin_permissions_boundary_attachment.new](#fn-new), this function will not inject the `resource`\nblock into the root Terraform document. Instead, this must be passed in as the `attrs` argument for the\n[tf.withResource](https://github.com/tf-libsonnet/core/tree/main/docs#fn-withresource) function to build a complete block.\n\nThis is most useful when you need to preprocess the attributes with functions, conditional, or looping logic prior to\ninjecting into a complete block.\n\n**Args**:\n - `instance_arn` (`string`): Set the `instance_arn` field on the resulting object.\n - `permission_set_arn` (`string`): Set the `permission_set_arn` field on the resulting object.\n - `permissions_boundary` (`list[obj]`): Set the `permissions_boundary` field on the resulting object. When `null`, the `permissions_boundary` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [aws.ssoadmin_permissions_boundary_attachment.permissions_boundary.new](#fn-permissions_boundarynew) constructor.\n\n**Returns**:\n - An attribute object that can be used with [tf.withResource](https://github.com/tf-libsonnet/core/tree/main/docs#fn-withresource) to construct a new `ssoadmin_permissions_boundary_attachment` resource into the root Terraform configuration.\n', args=[]), + '#newAttrs':: d.fn(help='\n`aws.ssoadmin_permissions_boundary_attachment.newAttrs` constructs a new object with attributes and blocks configured for the `ssoadmin_permissions_boundary_attachment`\nTerraform resource.\n\nUnlike [aws.ssoadmin_permissions_boundary_attachment.new](#fn-new), this function will not inject the `resource`\nblock into the root Terraform document. Instead, this must be passed in as the `attrs` argument for the\n[tf.withResource](https://github.com/tf-libsonnet/core/tree/main/docs#fn-withresource) function to build a complete block.\n\nThis is most useful when you need to preprocess the attributes with functions, conditional, or looping logic prior to\ninjecting into a complete block.\n\n**Args**:\n - `instance_arn` (`string`): Set the `instance_arn` field on the resulting object.\n - `permission_set_arn` (`string`): Set the `permission_set_arn` field on the resulting object.\n - `permissions_boundary` (`list[obj]`): Set the `permissions_boundary` field on the resulting object. When `null`, the `permissions_boundary` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [aws.ssoadmin_permissions_boundary_attachment.permissions_boundary.new](#fn-permissions_boundarynew) constructor.\n - `timeouts` (`obj`): Set the `timeouts` field on the resulting object. When `null`, the `timeouts` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [aws.ssoadmin_permissions_boundary_attachment.timeouts.new](#fn-timeoutsnew) constructor.\n\n**Returns**:\n - An attribute object that can be used with [tf.withResource](https://github.com/tf-libsonnet/core/tree/main/docs#fn-withresource) to construct a new `ssoadmin_permissions_boundary_attachment` resource into the root Terraform configuration.\n', args=[]), newAttrs( instance_arn, permission_set_arn, - permissions_boundary=null + permissions_boundary=null, + timeouts=null ):: std.prune(a={ instance_arn: instance_arn, permission_set_arn: permission_set_arn, permissions_boundary: permissions_boundary, + timeouts: timeouts, }), permissions_boundary:: { customer_managed_policy_reference:: { @@ -45,6 +53,16 @@ local d = (import 'github.com/jsonnet-libs/docsonnet/doc-util/main.libsonnet'); managed_policy_arn: managed_policy_arn, }), }, + timeouts:: { + '#new':: d.fn(help='\n`aws.ssoadmin_permissions_boundary_attachment.timeouts.new` constructs a new object with attributes and blocks configured for the `timeouts`\nTerraform sub block.\n\n\n\n**Args**:\n - `create` (`string`): Set the `create` field on the resulting object. When `null`, the `create` field will be omitted from the resulting object.\n - `delete` (`string`): Set the `delete` field on the resulting object. When `null`, the `delete` field will be omitted from the resulting object.\n\n**Returns**:\n - An attribute object that represents the `timeouts` sub block.\n', args=[]), + new( + create=null, + delete=null + ):: std.prune(a={ + create: create, + delete: delete, + }), + }, '#withInstanceArn':: d.fn(help='`aws.string.withInstanceArn` constructs a mixin object that can be merged into the `string`\nTerraform resource block to set or update the instance_arn field.\n\n\n\n**Args**:\n - `resourceLabel` (`string`): The name label of the block to update.\n - `value` (`string`): The value to set for the `instance_arn` field.\n', args=[]), withInstanceArn(resourceLabel, value): { resource+: { @@ -85,4 +103,24 @@ local d = (import 'github.com/jsonnet-libs/docsonnet/doc-util/main.libsonnet'); }, }, }, + '#withTimeouts':: d.fn(help='`aws.obj.withTimeouts` constructs a mixin object that can be merged into the `obj`\nTerraform resource block to set or update the timeouts field.\n\nThis function will replace the map with the passed in `value`. If you wish to instead merge the\npassed in value to the existing map, use the [aws.obj.withTimeoutsMixin](TODO) function.\n\n**Args**:\n - `resourceLabel` (`string`): The name label of the block to update.\n - `value` (`obj`): The value to set for the `timeouts` field.\n', args=[]), + withTimeouts(resourceLabel, value): { + resource+: { + aws_ssoadmin_permissions_boundary_attachment+: { + [resourceLabel]+: { + timeouts: value, + }, + }, + }, + }, + '#withTimeoutsMixin':: d.fn(help='`aws.obj.withTimeoutsMixin` constructs a mixin object that can be merged into the `obj`\nTerraform resource block to set or update the timeouts field.\n\nThis function will merge the passed in value to the existing map. If you wish\nto instead replace the entire map with the passed in `value`, use the [aws.obj.withTimeouts](TODO)\nfunction.\n\n\n**Args**:\n - `resourceLabel` (`string`): The name label of the block to update.\n - `value` (`obj`): The value to set for the `timeouts` field.\n', args=[]), + withTimeoutsMixin(resourceLabel, value): { + resource+: { + aws_ssoadmin_permissions_boundary_attachment+: { + [resourceLabel]+: { + timeouts+: value, + }, + }, + }, + }, } diff --git a/5.x/_gen/resources/transfer_connector.libsonnet b/5.x/_gen/resources/transfer_connector.libsonnet index 0ec89436..1d682a8c 100644 --- a/5.x/_gen/resources/transfer_connector.libsonnet +++ b/5.x/_gen/resources/transfer_connector.libsonnet @@ -24,13 +24,14 @@ local d = (import 'github.com/jsonnet-libs/docsonnet/doc-util/main.libsonnet'); signing_algorithm: signing_algorithm, }), }, - '#new':: d.fn(help="\n`aws.transfer_connector.new` injects a new `aws_transfer_connector` Terraform `resource`\nblock into the root module document.\n\nAdditionally, this inserts a private function into the `_ref` attribute that generates references to attributes of the\nresource. For example, if you added a new instance to the root using:\n\n # arguments omitted for brevity\n aws.transfer_connector.new('some_id')\n\nYou can get the reference to the `id` field of the created `aws.transfer_connector` using the reference:\n\n $._ref.aws_transfer_connector.some_id.get('id')\n\nThis is the same as directly entering `\"${ aws_transfer_connector.some_id.id }\"` as the value.\n\nNOTE: if you are chaining multiple resources together in a merge operation, you may not be able to use `super`, `self`,\nor `$` to refer to the root object. Instead, make an explicit outer object using `local`.\n\n**Args**:\n - `resourceLabel` (`string`): The name label of the block.\n - `access_role` (`string`): Set the `access_role` field on the resulting resource block.\n - `logging_role` (`string`): Set the `logging_role` field on the resulting resource block. When `null`, the `logging_role` field will be omitted from the resulting object.\n - `tags` (`obj`): Set the `tags` field on the resulting resource block. When `null`, the `tags` field will be omitted from the resulting object.\n - `tags_all` (`obj`): Set the `tags_all` field on the resulting resource block. When `null`, the `tags_all` field will be omitted from the resulting object.\n - `url` (`string`): Set the `url` field on the resulting resource block.\n - `as2_config` (`list[obj]`): Set the `as2_config` field on the resulting resource block. When `null`, the `as2_config` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [aws.transfer_connector.as2_config.new](#fn-as2_confignew) constructor.\n\n**Returns**:\n- A mixin object that injects the new resource into the root Terraform configuration.\n", args=[]), + '#new':: d.fn(help="\n`aws.transfer_connector.new` injects a new `aws_transfer_connector` Terraform `resource`\nblock into the root module document.\n\nAdditionally, this inserts a private function into the `_ref` attribute that generates references to attributes of the\nresource. For example, if you added a new instance to the root using:\n\n # arguments omitted for brevity\n aws.transfer_connector.new('some_id')\n\nYou can get the reference to the `id` field of the created `aws.transfer_connector` using the reference:\n\n $._ref.aws_transfer_connector.some_id.get('id')\n\nThis is the same as directly entering `\"${ aws_transfer_connector.some_id.id }\"` as the value.\n\nNOTE: if you are chaining multiple resources together in a merge operation, you may not be able to use `super`, `self`,\nor `$` to refer to the root object. Instead, make an explicit outer object using `local`.\n\n**Args**:\n - `resourceLabel` (`string`): The name label of the block.\n - `access_role` (`string`): Set the `access_role` field on the resulting resource block.\n - `logging_role` (`string`): Set the `logging_role` field on the resulting resource block. When `null`, the `logging_role` field will be omitted from the resulting object.\n - `tags` (`obj`): Set the `tags` field on the resulting resource block. When `null`, the `tags` field will be omitted from the resulting object.\n - `tags_all` (`obj`): Set the `tags_all` field on the resulting resource block. When `null`, the `tags_all` field will be omitted from the resulting object.\n - `url` (`string`): Set the `url` field on the resulting resource block.\n - `as2_config` (`list[obj]`): Set the `as2_config` field on the resulting resource block. When `null`, the `as2_config` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [aws.transfer_connector.as2_config.new](#fn-as2_confignew) constructor.\n - `sftp_config` (`list[obj]`): Set the `sftp_config` field on the resulting resource block. When `null`, the `sftp_config` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [aws.transfer_connector.sftp_config.new](#fn-sftp_confignew) constructor.\n\n**Returns**:\n- A mixin object that injects the new resource into the root Terraform configuration.\n", args=[]), new( resourceLabel, access_role, url, as2_config=null, logging_role=null, + sftp_config=null, tags=null, tags_all=null, _meta={} @@ -41,28 +42,41 @@ local d = (import 'github.com/jsonnet-libs/docsonnet/doc-util/main.libsonnet'); access_role=access_role, as2_config=as2_config, logging_role=logging_role, + sftp_config=sftp_config, tags=tags, tags_all=tags_all, url=url ), _meta=_meta ), - '#newAttrs':: d.fn(help='\n`aws.transfer_connector.newAttrs` constructs a new object with attributes and blocks configured for the `transfer_connector`\nTerraform resource.\n\nUnlike [aws.transfer_connector.new](#fn-new), this function will not inject the `resource`\nblock into the root Terraform document. Instead, this must be passed in as the `attrs` argument for the\n[tf.withResource](https://github.com/tf-libsonnet/core/tree/main/docs#fn-withresource) function to build a complete block.\n\nThis is most useful when you need to preprocess the attributes with functions, conditional, or looping logic prior to\ninjecting into a complete block.\n\n**Args**:\n - `access_role` (`string`): Set the `access_role` field on the resulting object.\n - `logging_role` (`string`): Set the `logging_role` field on the resulting object. When `null`, the `logging_role` field will be omitted from the resulting object.\n - `tags` (`obj`): Set the `tags` field on the resulting object. When `null`, the `tags` field will be omitted from the resulting object.\n - `tags_all` (`obj`): Set the `tags_all` field on the resulting object. When `null`, the `tags_all` field will be omitted from the resulting object.\n - `url` (`string`): Set the `url` field on the resulting object.\n - `as2_config` (`list[obj]`): Set the `as2_config` field on the resulting object. When `null`, the `as2_config` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [aws.transfer_connector.as2_config.new](#fn-as2_confignew) constructor.\n\n**Returns**:\n - An attribute object that can be used with [tf.withResource](https://github.com/tf-libsonnet/core/tree/main/docs#fn-withresource) to construct a new `transfer_connector` resource into the root Terraform configuration.\n', args=[]), + '#newAttrs':: d.fn(help='\n`aws.transfer_connector.newAttrs` constructs a new object with attributes and blocks configured for the `transfer_connector`\nTerraform resource.\n\nUnlike [aws.transfer_connector.new](#fn-new), this function will not inject the `resource`\nblock into the root Terraform document. Instead, this must be passed in as the `attrs` argument for the\n[tf.withResource](https://github.com/tf-libsonnet/core/tree/main/docs#fn-withresource) function to build a complete block.\n\nThis is most useful when you need to preprocess the attributes with functions, conditional, or looping logic prior to\ninjecting into a complete block.\n\n**Args**:\n - `access_role` (`string`): Set the `access_role` field on the resulting object.\n - `logging_role` (`string`): Set the `logging_role` field on the resulting object. When `null`, the `logging_role` field will be omitted from the resulting object.\n - `tags` (`obj`): Set the `tags` field on the resulting object. When `null`, the `tags` field will be omitted from the resulting object.\n - `tags_all` (`obj`): Set the `tags_all` field on the resulting object. When `null`, the `tags_all` field will be omitted from the resulting object.\n - `url` (`string`): Set the `url` field on the resulting object.\n - `as2_config` (`list[obj]`): Set the `as2_config` field on the resulting object. When `null`, the `as2_config` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [aws.transfer_connector.as2_config.new](#fn-as2_confignew) constructor.\n - `sftp_config` (`list[obj]`): Set the `sftp_config` field on the resulting object. When `null`, the `sftp_config` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [aws.transfer_connector.sftp_config.new](#fn-sftp_confignew) constructor.\n\n**Returns**:\n - An attribute object that can be used with [tf.withResource](https://github.com/tf-libsonnet/core/tree/main/docs#fn-withresource) to construct a new `transfer_connector` resource into the root Terraform configuration.\n', args=[]), newAttrs( access_role, url, as2_config=null, logging_role=null, + sftp_config=null, tags=null, tags_all=null ):: std.prune(a={ access_role: access_role, as2_config: as2_config, logging_role: logging_role, + sftp_config: sftp_config, tags: tags, tags_all: tags_all, url: url, }), + sftp_config:: { + '#new':: d.fn(help='\n`aws.transfer_connector.sftp_config.new` constructs a new object with attributes and blocks configured for the `sftp_config`\nTerraform sub block.\n\n\n\n**Args**:\n - `trusted_host_keys` (`list`): Set the `trusted_host_keys` field on the resulting object. When `null`, the `trusted_host_keys` field will be omitted from the resulting object.\n - `user_secret_id` (`string`): Set the `user_secret_id` field on the resulting object. When `null`, the `user_secret_id` field will be omitted from the resulting object.\n\n**Returns**:\n - An attribute object that represents the `sftp_config` sub block.\n', args=[]), + new( + trusted_host_keys=null, + user_secret_id=null + ):: std.prune(a={ + trusted_host_keys: trusted_host_keys, + user_secret_id: user_secret_id, + }), + }, '#withAccessRole':: d.fn(help='`aws.string.withAccessRole` constructs a mixin object that can be merged into the `string`\nTerraform resource block to set or update the access_role field.\n\n\n\n**Args**:\n - `resourceLabel` (`string`): The name label of the block to update.\n - `value` (`string`): The value to set for the `access_role` field.\n', args=[]), withAccessRole(resourceLabel, value): { resource+: { @@ -103,6 +117,26 @@ local d = (import 'github.com/jsonnet-libs/docsonnet/doc-util/main.libsonnet'); }, }, }, + '#withSftpConfig':: d.fn(help='`aws.list[obj].withSftpConfig` constructs a mixin object that can be merged into the `list[obj]`\nTerraform resource block to set or update the sftp_config field.\n\nThis function will replace the array with the passed in `value`. If you wish to instead append the\npassed in value to the existing array, use the [aws.list[obj].withSftpConfigMixin](TODO) function.\n\n\n**Args**:\n - `resourceLabel` (`string`): The name label of the block to update.\n - `value` (`list[obj]`): The value to set for the `sftp_config` field.\n', args=[]), + withSftpConfig(resourceLabel, value): { + resource+: { + aws_transfer_connector+: { + [resourceLabel]+: { + sftp_config: value, + }, + }, + }, + }, + '#withSftpConfigMixin':: d.fn(help='`aws.list[obj].withSftpConfigMixin` constructs a mixin object that can be merged into the `list[obj]`\nTerraform resource block to set or update the sftp_config field.\n\nThis function will append the passed in array or object to the existing array. If you wish\nto instead replace the array with the passed in `value`, use the [aws.list[obj].withSftpConfig](TODO)\nfunction.\n\n\n**Args**:\n - `resourceLabel` (`string`): The name label of the block to update.\n - `value` (`list[obj]`): The value to set for the `sftp_config` field.\n', args=[]), + withSftpConfigMixin(resourceLabel, value): { + resource+: { + aws_transfer_connector+: { + [resourceLabel]+: { + sftp_config+: if std.isArray(v=value) then value else [value], + }, + }, + }, + }, '#withTags':: d.fn(help='`aws.obj.withTags` constructs a mixin object that can be merged into the `obj`\nTerraform resource block to set or update the tags field.\n\n\n\n**Args**:\n - `resourceLabel` (`string`): The name label of the block to update.\n - `value` (`obj`): The value to set for the `tags` field.\n', args=[]), withTags(resourceLabel, value): { resource+: { diff --git a/5.x/_gen/resources/verifiedaccess_instance.libsonnet b/5.x/_gen/resources/verifiedaccess_instance.libsonnet new file mode 100644 index 00000000..65a981df --- /dev/null +++ b/5.x/_gen/resources/verifiedaccess_instance.libsonnet @@ -0,0 +1,58 @@ +local tf = (import 'github.com/tf-libsonnet/core/main.libsonnet'); +local d = (import 'github.com/jsonnet-libs/docsonnet/doc-util/main.libsonnet'); +{ + '#':: d.pkg(name='verifiedaccess_instance', url='', help='`verifiedaccess_instance` represents the `aws_verifiedaccess_instance` Terraform resource.\n\n\n\nThis package contains functions and utilities for setting up the resource using Jsonnet code.\n'), + '#new':: d.fn(help="\n`aws.verifiedaccess_instance.new` injects a new `aws_verifiedaccess_instance` Terraform `resource`\nblock into the root module document.\n\nAdditionally, this inserts a private function into the `_ref` attribute that generates references to attributes of the\nresource. For example, if you added a new instance to the root using:\n\n # arguments omitted for brevity\n aws.verifiedaccess_instance.new('some_id')\n\nYou can get the reference to the `id` field of the created `aws.verifiedaccess_instance` using the reference:\n\n $._ref.aws_verifiedaccess_instance.some_id.get('id')\n\nThis is the same as directly entering `\"${ aws_verifiedaccess_instance.some_id.id }\"` as the value.\n\nNOTE: if you are chaining multiple resources together in a merge operation, you may not be able to use `super`, `self`,\nor `$` to refer to the root object. Instead, make an explicit outer object using `local`.\n\n**Args**:\n - `resourceLabel` (`string`): The name label of the block.\n - `description` (`string`): Set the `description` field on the resulting resource block. When `null`, the `description` field will be omitted from the resulting object.\n - `tags` (`obj`): Set the `tags` field on the resulting resource block. When `null`, the `tags` field will be omitted from the resulting object.\n - `tags_all` (`obj`): Set the `tags_all` field on the resulting resource block. When `null`, the `tags_all` field will be omitted from the resulting object.\n\n**Returns**:\n- A mixin object that injects the new resource into the root Terraform configuration.\n", args=[]), + new( + resourceLabel, + description=null, + tags=null, + tags_all=null, + _meta={} + ):: tf.withResource( + type='aws_verifiedaccess_instance', + label=resourceLabel, + attrs=self.newAttrs(description=description, tags=tags, tags_all=tags_all), + _meta=_meta + ), + '#newAttrs':: d.fn(help='\n`aws.verifiedaccess_instance.newAttrs` constructs a new object with attributes and blocks configured for the `verifiedaccess_instance`\nTerraform resource.\n\nUnlike [aws.verifiedaccess_instance.new](#fn-new), this function will not inject the `resource`\nblock into the root Terraform document. Instead, this must be passed in as the `attrs` argument for the\n[tf.withResource](https://github.com/tf-libsonnet/core/tree/main/docs#fn-withresource) function to build a complete block.\n\nThis is most useful when you need to preprocess the attributes with functions, conditional, or looping logic prior to\ninjecting into a complete block.\n\n**Args**:\n - `description` (`string`): Set the `description` field on the resulting object. When `null`, the `description` field will be omitted from the resulting object.\n - `tags` (`obj`): Set the `tags` field on the resulting object. When `null`, the `tags` field will be omitted from the resulting object.\n - `tags_all` (`obj`): Set the `tags_all` field on the resulting object. When `null`, the `tags_all` field will be omitted from the resulting object.\n\n**Returns**:\n - An attribute object that can be used with [tf.withResource](https://github.com/tf-libsonnet/core/tree/main/docs#fn-withresource) to construct a new `verifiedaccess_instance` resource into the root Terraform configuration.\n', args=[]), + newAttrs( + description=null, + tags=null, + tags_all=null + ):: std.prune(a={ + description: description, + tags: tags, + tags_all: tags_all, + }), + '#withDescription':: d.fn(help='`aws.string.withDescription` constructs a mixin object that can be merged into the `string`\nTerraform resource block to set or update the description field.\n\n\n\n**Args**:\n - `resourceLabel` (`string`): The name label of the block to update.\n - `value` (`string`): The value to set for the `description` field.\n', args=[]), + withDescription(resourceLabel, value): { + resource+: { + aws_verifiedaccess_instance+: { + [resourceLabel]+: { + description: value, + }, + }, + }, + }, + '#withTags':: d.fn(help='`aws.obj.withTags` constructs a mixin object that can be merged into the `obj`\nTerraform resource block to set or update the tags field.\n\n\n\n**Args**:\n - `resourceLabel` (`string`): The name label of the block to update.\n - `value` (`obj`): The value to set for the `tags` field.\n', args=[]), + withTags(resourceLabel, value): { + resource+: { + aws_verifiedaccess_instance+: { + [resourceLabel]+: { + tags: value, + }, + }, + }, + }, + '#withTagsAll':: d.fn(help='`aws.obj.withTagsAll` constructs a mixin object that can be merged into the `obj`\nTerraform resource block to set or update the tags_all field.\n\n\n\n**Args**:\n - `resourceLabel` (`string`): The name label of the block to update.\n - `value` (`obj`): The value to set for the `tags_all` field.\n', args=[]), + withTagsAll(resourceLabel, value): { + resource+: { + aws_verifiedaccess_instance+: { + [resourceLabel]+: { + tags_all: value, + }, + }, + }, + }, +} diff --git a/5.x/_gen/resources/verifiedaccess_trust_provider.libsonnet b/5.x/_gen/resources/verifiedaccess_trust_provider.libsonnet new file mode 100644 index 00000000..db812e75 --- /dev/null +++ b/5.x/_gen/resources/verifiedaccess_trust_provider.libsonnet @@ -0,0 +1,230 @@ +local tf = (import 'github.com/tf-libsonnet/core/main.libsonnet'); +local d = (import 'github.com/jsonnet-libs/docsonnet/doc-util/main.libsonnet'); +{ + '#':: d.pkg(name='verifiedaccess_trust_provider', url='', help='`verifiedaccess_trust_provider` represents the `aws_verifiedaccess_trust_provider` Terraform resource.\n\n\n\nThis package contains functions and utilities for setting up the resource using Jsonnet code.\n'), + device_options:: { + '#new':: d.fn(help='\n`aws.verifiedaccess_trust_provider.device_options.new` constructs a new object with attributes and blocks configured for the `device_options`\nTerraform sub block.\n\n\n\n**Args**:\n - `tenant_id` (`string`): Set the `tenant_id` field on the resulting object. When `null`, the `tenant_id` field will be omitted from the resulting object.\n\n**Returns**:\n - An attribute object that represents the `device_options` sub block.\n', args=[]), + new( + tenant_id=null + ):: std.prune(a={ + tenant_id: tenant_id, + }), + }, + '#new':: d.fn(help="\n`aws.verifiedaccess_trust_provider.new` injects a new `aws_verifiedaccess_trust_provider` Terraform `resource`\nblock into the root module document.\n\nAdditionally, this inserts a private function into the `_ref` attribute that generates references to attributes of the\nresource. For example, if you added a new instance to the root using:\n\n # arguments omitted for brevity\n aws.verifiedaccess_trust_provider.new('some_id')\n\nYou can get the reference to the `id` field of the created `aws.verifiedaccess_trust_provider` using the reference:\n\n $._ref.aws_verifiedaccess_trust_provider.some_id.get('id')\n\nThis is the same as directly entering `\"${ aws_verifiedaccess_trust_provider.some_id.id }\"` as the value.\n\nNOTE: if you are chaining multiple resources together in a merge operation, you may not be able to use `super`, `self`,\nor `$` to refer to the root object. Instead, make an explicit outer object using `local`.\n\n**Args**:\n - `resourceLabel` (`string`): The name label of the block.\n - `description` (`string`): Set the `description` field on the resulting resource block. When `null`, the `description` field will be omitted from the resulting object.\n - `device_trust_provider_type` (`string`): Set the `device_trust_provider_type` field on the resulting resource block. When `null`, the `device_trust_provider_type` field will be omitted from the resulting object.\n - `policy_reference_name` (`string`): Set the `policy_reference_name` field on the resulting resource block.\n - `tags` (`obj`): Set the `tags` field on the resulting resource block. When `null`, the `tags` field will be omitted from the resulting object.\n - `tags_all` (`obj`): Set the `tags_all` field on the resulting resource block. When `null`, the `tags_all` field will be omitted from the resulting object.\n - `trust_provider_type` (`string`): Set the `trust_provider_type` field on the resulting resource block.\n - `user_trust_provider_type` (`string`): Set the `user_trust_provider_type` field on the resulting resource block. When `null`, the `user_trust_provider_type` field will be omitted from the resulting object.\n - `device_options` (`list[obj]`): Set the `device_options` field on the resulting resource block. When `null`, the `device_options` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [aws.verifiedaccess_trust_provider.device_options.new](#fn-device_optionsnew) constructor.\n - `oidc_options` (`list[obj]`): Set the `oidc_options` field on the resulting resource block. When `null`, the `oidc_options` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [aws.verifiedaccess_trust_provider.oidc_options.new](#fn-oidc_optionsnew) constructor.\n - `timeouts` (`obj`): Set the `timeouts` field on the resulting resource block. When `null`, the `timeouts` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [aws.verifiedaccess_trust_provider.timeouts.new](#fn-timeoutsnew) constructor.\n\n**Returns**:\n- A mixin object that injects the new resource into the root Terraform configuration.\n", args=[]), + new( + resourceLabel, + policy_reference_name, + trust_provider_type, + description=null, + device_options=null, + device_trust_provider_type=null, + oidc_options=null, + tags=null, + tags_all=null, + timeouts=null, + user_trust_provider_type=null, + _meta={} + ):: tf.withResource( + type='aws_verifiedaccess_trust_provider', + label=resourceLabel, + attrs=self.newAttrs( + description=description, + device_options=device_options, + device_trust_provider_type=device_trust_provider_type, + oidc_options=oidc_options, + policy_reference_name=policy_reference_name, + tags=tags, + tags_all=tags_all, + timeouts=timeouts, + trust_provider_type=trust_provider_type, + user_trust_provider_type=user_trust_provider_type + ), + _meta=_meta + ), + '#newAttrs':: d.fn(help='\n`aws.verifiedaccess_trust_provider.newAttrs` constructs a new object with attributes and blocks configured for the `verifiedaccess_trust_provider`\nTerraform resource.\n\nUnlike [aws.verifiedaccess_trust_provider.new](#fn-new), this function will not inject the `resource`\nblock into the root Terraform document. Instead, this must be passed in as the `attrs` argument for the\n[tf.withResource](https://github.com/tf-libsonnet/core/tree/main/docs#fn-withresource) function to build a complete block.\n\nThis is most useful when you need to preprocess the attributes with functions, conditional, or looping logic prior to\ninjecting into a complete block.\n\n**Args**:\n - `description` (`string`): Set the `description` field on the resulting object. When `null`, the `description` field will be omitted from the resulting object.\n - `device_trust_provider_type` (`string`): Set the `device_trust_provider_type` field on the resulting object. When `null`, the `device_trust_provider_type` field will be omitted from the resulting object.\n - `policy_reference_name` (`string`): Set the `policy_reference_name` field on the resulting object.\n - `tags` (`obj`): Set the `tags` field on the resulting object. When `null`, the `tags` field will be omitted from the resulting object.\n - `tags_all` (`obj`): Set the `tags_all` field on the resulting object. When `null`, the `tags_all` field will be omitted from the resulting object.\n - `trust_provider_type` (`string`): Set the `trust_provider_type` field on the resulting object.\n - `user_trust_provider_type` (`string`): Set the `user_trust_provider_type` field on the resulting object. When `null`, the `user_trust_provider_type` field will be omitted from the resulting object.\n - `device_options` (`list[obj]`): Set the `device_options` field on the resulting object. When `null`, the `device_options` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [aws.verifiedaccess_trust_provider.device_options.new](#fn-device_optionsnew) constructor.\n - `oidc_options` (`list[obj]`): Set the `oidc_options` field on the resulting object. When `null`, the `oidc_options` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [aws.verifiedaccess_trust_provider.oidc_options.new](#fn-oidc_optionsnew) constructor.\n - `timeouts` (`obj`): Set the `timeouts` field on the resulting object. When `null`, the `timeouts` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [aws.verifiedaccess_trust_provider.timeouts.new](#fn-timeoutsnew) constructor.\n\n**Returns**:\n - An attribute object that can be used with [tf.withResource](https://github.com/tf-libsonnet/core/tree/main/docs#fn-withresource) to construct a new `verifiedaccess_trust_provider` resource into the root Terraform configuration.\n', args=[]), + newAttrs( + policy_reference_name, + trust_provider_type, + description=null, + device_options=null, + device_trust_provider_type=null, + oidc_options=null, + tags=null, + tags_all=null, + timeouts=null, + user_trust_provider_type=null + ):: std.prune(a={ + description: description, + device_options: device_options, + device_trust_provider_type: device_trust_provider_type, + oidc_options: oidc_options, + policy_reference_name: policy_reference_name, + tags: tags, + tags_all: tags_all, + timeouts: timeouts, + trust_provider_type: trust_provider_type, + user_trust_provider_type: user_trust_provider_type, + }), + oidc_options:: { + '#new':: d.fn(help='\n`aws.verifiedaccess_trust_provider.oidc_options.new` constructs a new object with attributes and blocks configured for the `oidc_options`\nTerraform sub block.\n\n\n\n**Args**:\n - `authorization_endpoint` (`string`): Set the `authorization_endpoint` field on the resulting object. When `null`, the `authorization_endpoint` field will be omitted from the resulting object.\n - `client_id` (`string`): Set the `client_id` field on the resulting object. When `null`, the `client_id` field will be omitted from the resulting object.\n - `client_secret` (`string`): Set the `client_secret` field on the resulting object.\n - `issuer` (`string`): Set the `issuer` field on the resulting object. When `null`, the `issuer` field will be omitted from the resulting object.\n - `scope` (`string`): Set the `scope` field on the resulting object. When `null`, the `scope` field will be omitted from the resulting object.\n - `token_endpoint` (`string`): Set the `token_endpoint` field on the resulting object. When `null`, the `token_endpoint` field will be omitted from the resulting object.\n - `user_info_endpoint` (`string`): Set the `user_info_endpoint` field on the resulting object. When `null`, the `user_info_endpoint` field will be omitted from the resulting object.\n\n**Returns**:\n - An attribute object that represents the `oidc_options` sub block.\n', args=[]), + new( + client_secret, + authorization_endpoint=null, + client_id=null, + issuer=null, + scope=null, + token_endpoint=null, + user_info_endpoint=null + ):: std.prune(a={ + authorization_endpoint: authorization_endpoint, + client_id: client_id, + client_secret: client_secret, + issuer: issuer, + scope: scope, + token_endpoint: token_endpoint, + user_info_endpoint: user_info_endpoint, + }), + }, + timeouts:: { + '#new':: d.fn(help='\n`aws.verifiedaccess_trust_provider.timeouts.new` constructs a new object with attributes and blocks configured for the `timeouts`\nTerraform sub block.\n\n\n\n**Args**:\n - `create` (`string`): Set the `create` field on the resulting object. When `null`, the `create` field will be omitted from the resulting object.\n - `delete` (`string`): Set the `delete` field on the resulting object. When `null`, the `delete` field will be omitted from the resulting object.\n - `update` (`string`): Set the `update` field on the resulting object. When `null`, the `update` field will be omitted from the resulting object.\n\n**Returns**:\n - An attribute object that represents the `timeouts` sub block.\n', args=[]), + new( + create=null, + delete=null, + update=null + ):: std.prune(a={ + create: create, + delete: delete, + update: update, + }), + }, + '#withDescription':: d.fn(help='`aws.string.withDescription` constructs a mixin object that can be merged into the `string`\nTerraform resource block to set or update the description field.\n\n\n\n**Args**:\n - `resourceLabel` (`string`): The name label of the block to update.\n - `value` (`string`): The value to set for the `description` field.\n', args=[]), + withDescription(resourceLabel, value): { + resource+: { + aws_verifiedaccess_trust_provider+: { + [resourceLabel]+: { + description: value, + }, + }, + }, + }, + '#withDeviceOptions':: d.fn(help='`aws.list[obj].withDeviceOptions` constructs a mixin object that can be merged into the `list[obj]`\nTerraform resource block to set or update the device_options field.\n\nThis function will replace the array with the passed in `value`. If you wish to instead append the\npassed in value to the existing array, use the [aws.list[obj].withDeviceOptionsMixin](TODO) function.\n\n\n**Args**:\n - `resourceLabel` (`string`): The name label of the block to update.\n - `value` (`list[obj]`): The value to set for the `device_options` field.\n', args=[]), + withDeviceOptions(resourceLabel, value): { + resource+: { + aws_verifiedaccess_trust_provider+: { + [resourceLabel]+: { + device_options: value, + }, + }, + }, + }, + '#withDeviceOptionsMixin':: d.fn(help='`aws.list[obj].withDeviceOptionsMixin` constructs a mixin object that can be merged into the `list[obj]`\nTerraform resource block to set or update the device_options field.\n\nThis function will append the passed in array or object to the existing array. If you wish\nto instead replace the array with the passed in `value`, use the [aws.list[obj].withDeviceOptions](TODO)\nfunction.\n\n\n**Args**:\n - `resourceLabel` (`string`): The name label of the block to update.\n - `value` (`list[obj]`): The value to set for the `device_options` field.\n', args=[]), + withDeviceOptionsMixin(resourceLabel, value): { + resource+: { + aws_verifiedaccess_trust_provider+: { + [resourceLabel]+: { + device_options+: if std.isArray(v=value) then value else [value], + }, + }, + }, + }, + '#withDeviceTrustProviderType':: d.fn(help='`aws.string.withDeviceTrustProviderType` constructs a mixin object that can be merged into the `string`\nTerraform resource block to set or update the device_trust_provider_type field.\n\n\n\n**Args**:\n - `resourceLabel` (`string`): The name label of the block to update.\n - `value` (`string`): The value to set for the `device_trust_provider_type` field.\n', args=[]), + withDeviceTrustProviderType(resourceLabel, value): { + resource+: { + aws_verifiedaccess_trust_provider+: { + [resourceLabel]+: { + device_trust_provider_type: value, + }, + }, + }, + }, + '#withOidcOptions':: d.fn(help='`aws.list[obj].withOidcOptions` constructs a mixin object that can be merged into the `list[obj]`\nTerraform resource block to set or update the oidc_options field.\n\nThis function will replace the array with the passed in `value`. If you wish to instead append the\npassed in value to the existing array, use the [aws.list[obj].withOidcOptionsMixin](TODO) function.\n\n\n**Args**:\n - `resourceLabel` (`string`): The name label of the block to update.\n - `value` (`list[obj]`): The value to set for the `oidc_options` field.\n', args=[]), + withOidcOptions(resourceLabel, value): { + resource+: { + aws_verifiedaccess_trust_provider+: { + [resourceLabel]+: { + oidc_options: value, + }, + }, + }, + }, + '#withOidcOptionsMixin':: d.fn(help='`aws.list[obj].withOidcOptionsMixin` constructs a mixin object that can be merged into the `list[obj]`\nTerraform resource block to set or update the oidc_options field.\n\nThis function will append the passed in array or object to the existing array. If you wish\nto instead replace the array with the passed in `value`, use the [aws.list[obj].withOidcOptions](TODO)\nfunction.\n\n\n**Args**:\n - `resourceLabel` (`string`): The name label of the block to update.\n - `value` (`list[obj]`): The value to set for the `oidc_options` field.\n', args=[]), + withOidcOptionsMixin(resourceLabel, value): { + resource+: { + aws_verifiedaccess_trust_provider+: { + [resourceLabel]+: { + oidc_options+: if std.isArray(v=value) then value else [value], + }, + }, + }, + }, + '#withPolicyReferenceName':: d.fn(help='`aws.string.withPolicyReferenceName` constructs a mixin object that can be merged into the `string`\nTerraform resource block to set or update the policy_reference_name field.\n\n\n\n**Args**:\n - `resourceLabel` (`string`): The name label of the block to update.\n - `value` (`string`): The value to set for the `policy_reference_name` field.\n', args=[]), + withPolicyReferenceName(resourceLabel, value): { + resource+: { + aws_verifiedaccess_trust_provider+: { + [resourceLabel]+: { + policy_reference_name: value, + }, + }, + }, + }, + '#withTags':: d.fn(help='`aws.obj.withTags` constructs a mixin object that can be merged into the `obj`\nTerraform resource block to set or update the tags field.\n\n\n\n**Args**:\n - `resourceLabel` (`string`): The name label of the block to update.\n - `value` (`obj`): The value to set for the `tags` field.\n', args=[]), + withTags(resourceLabel, value): { + resource+: { + aws_verifiedaccess_trust_provider+: { + [resourceLabel]+: { + tags: value, + }, + }, + }, + }, + '#withTagsAll':: d.fn(help='`aws.obj.withTagsAll` constructs a mixin object that can be merged into the `obj`\nTerraform resource block to set or update the tags_all field.\n\n\n\n**Args**:\n - `resourceLabel` (`string`): The name label of the block to update.\n - `value` (`obj`): The value to set for the `tags_all` field.\n', args=[]), + withTagsAll(resourceLabel, value): { + resource+: { + aws_verifiedaccess_trust_provider+: { + [resourceLabel]+: { + tags_all: value, + }, + }, + }, + }, + '#withTimeouts':: d.fn(help='`aws.obj.withTimeouts` constructs a mixin object that can be merged into the `obj`\nTerraform resource block to set or update the timeouts field.\n\nThis function will replace the map with the passed in `value`. If you wish to instead merge the\npassed in value to the existing map, use the [aws.obj.withTimeoutsMixin](TODO) function.\n\n**Args**:\n - `resourceLabel` (`string`): The name label of the block to update.\n - `value` (`obj`): The value to set for the `timeouts` field.\n', args=[]), + withTimeouts(resourceLabel, value): { + resource+: { + aws_verifiedaccess_trust_provider+: { + [resourceLabel]+: { + timeouts: value, + }, + }, + }, + }, + '#withTimeoutsMixin':: d.fn(help='`aws.obj.withTimeoutsMixin` constructs a mixin object that can be merged into the `obj`\nTerraform resource block to set or update the timeouts field.\n\nThis function will merge the passed in value to the existing map. If you wish\nto instead replace the entire map with the passed in `value`, use the [aws.obj.withTimeouts](TODO)\nfunction.\n\n\n**Args**:\n - `resourceLabel` (`string`): The name label of the block to update.\n - `value` (`obj`): The value to set for the `timeouts` field.\n', args=[]), + withTimeoutsMixin(resourceLabel, value): { + resource+: { + aws_verifiedaccess_trust_provider+: { + [resourceLabel]+: { + timeouts+: value, + }, + }, + }, + }, + '#withTrustProviderType':: d.fn(help='`aws.string.withTrustProviderType` constructs a mixin object that can be merged into the `string`\nTerraform resource block to set or update the trust_provider_type field.\n\n\n\n**Args**:\n - `resourceLabel` (`string`): The name label of the block to update.\n - `value` (`string`): The value to set for the `trust_provider_type` field.\n', args=[]), + withTrustProviderType(resourceLabel, value): { + resource+: { + aws_verifiedaccess_trust_provider+: { + [resourceLabel]+: { + trust_provider_type: value, + }, + }, + }, + }, + '#withUserTrustProviderType':: d.fn(help='`aws.string.withUserTrustProviderType` constructs a mixin object that can be merged into the `string`\nTerraform resource block to set or update the user_trust_provider_type field.\n\n\n\n**Args**:\n - `resourceLabel` (`string`): The name label of the block to update.\n - `value` (`string`): The value to set for the `user_trust_provider_type` field.\n', args=[]), + withUserTrustProviderType(resourceLabel, value): { + resource+: { + aws_verifiedaccess_trust_provider+: { + [resourceLabel]+: { + user_trust_provider_type: value, + }, + }, + }, + }, +} diff --git a/5.x/_gen/resources/wafv2_rule_group.libsonnet b/5.x/_gen/resources/wafv2_rule_group.libsonnet index cced4d2c..98a4b5c7 100644 --- a/5.x/_gen/resources/wafv2_rule_group.libsonnet +++ b/5.x/_gen/resources/wafv2_rule_group.libsonnet @@ -14,14 +14,15 @@ local d = (import 'github.com/jsonnet-libs/docsonnet/doc-util/main.libsonnet'); key: key, }), }, - '#new':: d.fn(help="\n`aws.wafv2_rule_group.new` injects a new `aws_wafv2_rule_group` Terraform `resource`\nblock into the root module document.\n\nAdditionally, this inserts a private function into the `_ref` attribute that generates references to attributes of the\nresource. For example, if you added a new instance to the root using:\n\n # arguments omitted for brevity\n aws.wafv2_rule_group.new('some_id')\n\nYou can get the reference to the `id` field of the created `aws.wafv2_rule_group` using the reference:\n\n $._ref.aws_wafv2_rule_group.some_id.get('id')\n\nThis is the same as directly entering `\"${ aws_wafv2_rule_group.some_id.id }\"` as the value.\n\nNOTE: if you are chaining multiple resources together in a merge operation, you may not be able to use `super`, `self`,\nor `$` to refer to the root object. Instead, make an explicit outer object using `local`.\n\n**Args**:\n - `resourceLabel` (`string`): The name label of the block.\n - `capacity` (`number`): Set the `capacity` field on the resulting resource block.\n - `description` (`string`): Set the `description` field on the resulting resource block. When `null`, the `description` field will be omitted from the resulting object.\n - `name` (`string`): Set the `name` field on the resulting resource block.\n - `scope` (`string`): Set the `scope` field on the resulting resource block.\n - `tags` (`obj`): Set the `tags` field on the resulting resource block. When `null`, the `tags` field will be omitted from the resulting object.\n - `tags_all` (`obj`): Set the `tags_all` field on the resulting resource block. When `null`, the `tags_all` field will be omitted from the resulting object.\n - `custom_response_body` (`list[obj]`): Set the `custom_response_body` field on the resulting resource block. When `null`, the `custom_response_body` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [aws.wafv2_rule_group.custom_response_body.new](#fn-custom_response_bodynew) constructor.\n - `rule` (`list[obj]`): Set the `rule` field on the resulting resource block. When `null`, the `rule` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [aws.wafv2_rule_group.rule.new](#fn-rulenew) constructor.\n - `visibility_config` (`list[obj]`): Set the `visibility_config` field on the resulting resource block. When `null`, the `visibility_config` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [aws.wafv2_rule_group.visibility_config.new](#fn-visibility_confignew) constructor.\n\n**Returns**:\n- A mixin object that injects the new resource into the root Terraform configuration.\n", args=[]), + '#new':: d.fn(help="\n`aws.wafv2_rule_group.new` injects a new `aws_wafv2_rule_group` Terraform `resource`\nblock into the root module document.\n\nAdditionally, this inserts a private function into the `_ref` attribute that generates references to attributes of the\nresource. For example, if you added a new instance to the root using:\n\n # arguments omitted for brevity\n aws.wafv2_rule_group.new('some_id')\n\nYou can get the reference to the `id` field of the created `aws.wafv2_rule_group` using the reference:\n\n $._ref.aws_wafv2_rule_group.some_id.get('id')\n\nThis is the same as directly entering `\"${ aws_wafv2_rule_group.some_id.id }\"` as the value.\n\nNOTE: if you are chaining multiple resources together in a merge operation, you may not be able to use `super`, `self`,\nor `$` to refer to the root object. Instead, make an explicit outer object using `local`.\n\n**Args**:\n - `resourceLabel` (`string`): The name label of the block.\n - `capacity` (`number`): Set the `capacity` field on the resulting resource block.\n - `description` (`string`): Set the `description` field on the resulting resource block. When `null`, the `description` field will be omitted from the resulting object.\n - `name` (`string`): Set the `name` field on the resulting resource block. When `null`, the `name` field will be omitted from the resulting object.\n - `name_prefix` (`string`): Set the `name_prefix` field on the resulting resource block. When `null`, the `name_prefix` field will be omitted from the resulting object.\n - `scope` (`string`): Set the `scope` field on the resulting resource block.\n - `tags` (`obj`): Set the `tags` field on the resulting resource block. When `null`, the `tags` field will be omitted from the resulting object.\n - `tags_all` (`obj`): Set the `tags_all` field on the resulting resource block. When `null`, the `tags_all` field will be omitted from the resulting object.\n - `custom_response_body` (`list[obj]`): Set the `custom_response_body` field on the resulting resource block. When `null`, the `custom_response_body` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [aws.wafv2_rule_group.custom_response_body.new](#fn-custom_response_bodynew) constructor.\n - `rule` (`list[obj]`): Set the `rule` field on the resulting resource block. When `null`, the `rule` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [aws.wafv2_rule_group.rule.new](#fn-rulenew) constructor.\n - `visibility_config` (`list[obj]`): Set the `visibility_config` field on the resulting resource block. When `null`, the `visibility_config` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [aws.wafv2_rule_group.visibility_config.new](#fn-visibility_confignew) constructor.\n\n**Returns**:\n- A mixin object that injects the new resource into the root Terraform configuration.\n", args=[]), new( resourceLabel, capacity, - name, scope, custom_response_body=null, description=null, + name=null, + name_prefix=null, rule=null, tags=null, tags_all=null, @@ -35,6 +36,7 @@ local d = (import 'github.com/jsonnet-libs/docsonnet/doc-util/main.libsonnet'); custom_response_body=custom_response_body, description=description, name=name, + name_prefix=name_prefix, rule=rule, scope=scope, tags=tags, @@ -43,13 +45,14 @@ local d = (import 'github.com/jsonnet-libs/docsonnet/doc-util/main.libsonnet'); ), _meta=_meta ), - '#newAttrs':: d.fn(help='\n`aws.wafv2_rule_group.newAttrs` constructs a new object with attributes and blocks configured for the `wafv2_rule_group`\nTerraform resource.\n\nUnlike [aws.wafv2_rule_group.new](#fn-new), this function will not inject the `resource`\nblock into the root Terraform document. Instead, this must be passed in as the `attrs` argument for the\n[tf.withResource](https://github.com/tf-libsonnet/core/tree/main/docs#fn-withresource) function to build a complete block.\n\nThis is most useful when you need to preprocess the attributes with functions, conditional, or looping logic prior to\ninjecting into a complete block.\n\n**Args**:\n - `capacity` (`number`): Set the `capacity` field on the resulting object.\n - `description` (`string`): Set the `description` field on the resulting object. When `null`, the `description` field will be omitted from the resulting object.\n - `name` (`string`): Set the `name` field on the resulting object.\n - `scope` (`string`): Set the `scope` field on the resulting object.\n - `tags` (`obj`): Set the `tags` field on the resulting object. When `null`, the `tags` field will be omitted from the resulting object.\n - `tags_all` (`obj`): Set the `tags_all` field on the resulting object. When `null`, the `tags_all` field will be omitted from the resulting object.\n - `custom_response_body` (`list[obj]`): Set the `custom_response_body` field on the resulting object. When `null`, the `custom_response_body` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [aws.wafv2_rule_group.custom_response_body.new](#fn-custom_response_bodynew) constructor.\n - `rule` (`list[obj]`): Set the `rule` field on the resulting object. When `null`, the `rule` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [aws.wafv2_rule_group.rule.new](#fn-rulenew) constructor.\n - `visibility_config` (`list[obj]`): Set the `visibility_config` field on the resulting object. When `null`, the `visibility_config` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [aws.wafv2_rule_group.visibility_config.new](#fn-visibility_confignew) constructor.\n\n**Returns**:\n - An attribute object that can be used with [tf.withResource](https://github.com/tf-libsonnet/core/tree/main/docs#fn-withresource) to construct a new `wafv2_rule_group` resource into the root Terraform configuration.\n', args=[]), + '#newAttrs':: d.fn(help='\n`aws.wafv2_rule_group.newAttrs` constructs a new object with attributes and blocks configured for the `wafv2_rule_group`\nTerraform resource.\n\nUnlike [aws.wafv2_rule_group.new](#fn-new), this function will not inject the `resource`\nblock into the root Terraform document. Instead, this must be passed in as the `attrs` argument for the\n[tf.withResource](https://github.com/tf-libsonnet/core/tree/main/docs#fn-withresource) function to build a complete block.\n\nThis is most useful when you need to preprocess the attributes with functions, conditional, or looping logic prior to\ninjecting into a complete block.\n\n**Args**:\n - `capacity` (`number`): Set the `capacity` field on the resulting object.\n - `description` (`string`): Set the `description` field on the resulting object. When `null`, the `description` field will be omitted from the resulting object.\n - `name` (`string`): Set the `name` field on the resulting object. When `null`, the `name` field will be omitted from the resulting object.\n - `name_prefix` (`string`): Set the `name_prefix` field on the resulting object. When `null`, the `name_prefix` field will be omitted from the resulting object.\n - `scope` (`string`): Set the `scope` field on the resulting object.\n - `tags` (`obj`): Set the `tags` field on the resulting object. When `null`, the `tags` field will be omitted from the resulting object.\n - `tags_all` (`obj`): Set the `tags_all` field on the resulting object. When `null`, the `tags_all` field will be omitted from the resulting object.\n - `custom_response_body` (`list[obj]`): Set the `custom_response_body` field on the resulting object. When `null`, the `custom_response_body` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [aws.wafv2_rule_group.custom_response_body.new](#fn-custom_response_bodynew) constructor.\n - `rule` (`list[obj]`): Set the `rule` field on the resulting object. When `null`, the `rule` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [aws.wafv2_rule_group.rule.new](#fn-rulenew) constructor.\n - `visibility_config` (`list[obj]`): Set the `visibility_config` field on the resulting object. When `null`, the `visibility_config` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [aws.wafv2_rule_group.visibility_config.new](#fn-visibility_confignew) constructor.\n\n**Returns**:\n - An attribute object that can be used with [tf.withResource](https://github.com/tf-libsonnet/core/tree/main/docs#fn-withresource) to construct a new `wafv2_rule_group` resource into the root Terraform configuration.\n', args=[]), newAttrs( capacity, - name, scope, custom_response_body=null, description=null, + name=null, + name_prefix=null, rule=null, tags=null, tags_all=null, @@ -59,6 +62,7 @@ local d = (import 'github.com/jsonnet-libs/docsonnet/doc-util/main.libsonnet'); custom_response_body: custom_response_body, description: description, name: name, + name_prefix: name_prefix, rule: rule, scope: scope, tags: tags, @@ -64045,6 +64049,16 @@ local d = (import 'github.com/jsonnet-libs/docsonnet/doc-util/main.libsonnet'); }, }, }, + '#withNamePrefix':: d.fn(help='`aws.string.withNamePrefix` constructs a mixin object that can be merged into the `string`\nTerraform resource block to set or update the name_prefix field.\n\n\n\n**Args**:\n - `resourceLabel` (`string`): The name label of the block to update.\n - `value` (`string`): The value to set for the `name_prefix` field.\n', args=[]), + withNamePrefix(resourceLabel, value): { + resource+: { + aws_wafv2_rule_group+: { + [resourceLabel]+: { + name_prefix: value, + }, + }, + }, + }, '#withRule':: d.fn(help='`aws.list[obj].withRule` constructs a mixin object that can be merged into the `list[obj]`\nTerraform resource block to set or update the rule field.\n\nThis function will replace the array with the passed in `value`. If you wish to instead append the\npassed in value to the existing array, use the [aws.list[obj].withRuleMixin](TODO) function.\n\n\n**Args**:\n - `resourceLabel` (`string`): The name label of the block to update.\n - `value` (`list[obj]`): The value to set for the `rule` field.\n', args=[]), withRule(resourceLabel, value): { resource+: { diff --git a/5.x/_gen/resources/wafv2_web_acl.libsonnet b/5.x/_gen/resources/wafv2_web_acl.libsonnet index 4c262972..f50a7b9a 100644 --- a/5.x/_gen/resources/wafv2_web_acl.libsonnet +++ b/5.x/_gen/resources/wafv2_web_acl.libsonnet @@ -16268,12 +16268,14 @@ local d = (import 'github.com/jsonnet-libs/docsonnet/doc-util/main.libsonnet'); managed_rule_group_statement:: { managed_rule_group_configs:: { aws_managed_rules_atp_rule_set:: { - '#new':: d.fn(help='\n`aws.wafv2_web_acl.rule.statement.managed_rule_group_statement.managed_rule_group_configs.aws_managed_rules_atp_rule_set.new` constructs a new object with attributes and blocks configured for the `aws_managed_rules_atp_rule_set`\nTerraform sub block.\n\n\n\n**Args**:\n - `login_path` (`string`): Set the `login_path` field on the resulting object.\n - `request_inspection` (`list[obj]`): Set the `request_inspection` field on the resulting object. When `null`, the `request_inspection` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [aws.wafv2_web_acl.rule.statement.managed_rule_group_statement.managed_rule_group_configs.aws_managed_rules_atp_rule_set.request_inspection.new](#fn-rulerulestatementmanaged_rule_group_statementmanaged_rule_group_configsrequest_inspectionnew) constructor.\n - `response_inspection` (`list[obj]`): Set the `response_inspection` field on the resulting object. When `null`, the `response_inspection` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [aws.wafv2_web_acl.rule.statement.managed_rule_group_statement.managed_rule_group_configs.aws_managed_rules_atp_rule_set.response_inspection.new](#fn-rulerulestatementmanaged_rule_group_statementmanaged_rule_group_configsresponse_inspectionnew) constructor.\n\n**Returns**:\n - An attribute object that represents the `aws_managed_rules_atp_rule_set` sub block.\n', args=[]), + '#new':: d.fn(help='\n`aws.wafv2_web_acl.rule.statement.managed_rule_group_statement.managed_rule_group_configs.aws_managed_rules_atp_rule_set.new` constructs a new object with attributes and blocks configured for the `aws_managed_rules_atp_rule_set`\nTerraform sub block.\n\n\n\n**Args**:\n - `enable_regex_in_path` (`bool`): Set the `enable_regex_in_path` field on the resulting object. When `null`, the `enable_regex_in_path` field will be omitted from the resulting object.\n - `login_path` (`string`): Set the `login_path` field on the resulting object.\n - `request_inspection` (`list[obj]`): Set the `request_inspection` field on the resulting object. When `null`, the `request_inspection` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [aws.wafv2_web_acl.rule.statement.managed_rule_group_statement.managed_rule_group_configs.aws_managed_rules_atp_rule_set.request_inspection.new](#fn-rulerulestatementmanaged_rule_group_statementmanaged_rule_group_configsrequest_inspectionnew) constructor.\n - `response_inspection` (`list[obj]`): Set the `response_inspection` field on the resulting object. When `null`, the `response_inspection` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [aws.wafv2_web_acl.rule.statement.managed_rule_group_statement.managed_rule_group_configs.aws_managed_rules_atp_rule_set.response_inspection.new](#fn-rulerulestatementmanaged_rule_group_statementmanaged_rule_group_configsresponse_inspectionnew) constructor.\n\n**Returns**:\n - An attribute object that represents the `aws_managed_rules_atp_rule_set` sub block.\n', args=[]), new( login_path, + enable_regex_in_path=null, request_inspection=null, response_inspection=null ):: std.prune(a={ + enable_regex_in_path: enable_regex_in_path, login_path: login_path, request_inspection: request_inspection, response_inspection: response_inspection, @@ -16506,6 +16508,32 @@ local d = (import 'github.com/jsonnet-libs/docsonnet/doc-util/main.libsonnet'); custom_request_handling: custom_request_handling, }), }, + challenge:: { + custom_request_handling:: { + insert_header:: { + '#new':: d.fn(help='\n`aws.wafv2_web_acl.rule.statement.managed_rule_group_statement.rule_action_override.action_to_use.challenge.custom_request_handling.insert_header.new` constructs a new object with attributes and blocks configured for the `insert_header`\nTerraform sub block.\n\n\n\n**Args**:\n - `name` (`string`): Set the `name` field on the resulting object.\n - `value` (`string`): Set the `value` field on the resulting object.\n\n**Returns**:\n - An attribute object that represents the `insert_header` sub block.\n', args=[]), + new( + name, + value + ):: std.prune(a={ + name: name, + value: value, + }), + }, + '#new':: d.fn(help='\n`aws.wafv2_web_acl.rule.statement.managed_rule_group_statement.rule_action_override.action_to_use.challenge.custom_request_handling.new` constructs a new object with attributes and blocks configured for the `custom_request_handling`\nTerraform sub block.\n\n\n\n**Args**:\n - `insert_header` (`list[obj]`): Set the `insert_header` field on the resulting object. When `null`, the `insert_header` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [aws.wafv2_web_acl.rule.statement.managed_rule_group_statement.rule_action_override.action_to_use.challenge.custom_request_handling.insert_header.new](#fn-rulerulestatementmanaged_rule_group_statementrule_action_overrideaction_to_usechallengeinsert_headernew) constructor.\n\n**Returns**:\n - An attribute object that represents the `custom_request_handling` sub block.\n', args=[]), + new( + insert_header=null + ):: std.prune(a={ + insert_header: insert_header, + }), + }, + '#new':: d.fn(help='\n`aws.wafv2_web_acl.rule.statement.managed_rule_group_statement.rule_action_override.action_to_use.challenge.new` constructs a new object with attributes and blocks configured for the `challenge`\nTerraform sub block.\n\n\n\n**Args**:\n - `custom_request_handling` (`list[obj]`): Set the `custom_request_handling` field on the resulting object. When `null`, the `custom_request_handling` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [aws.wafv2_web_acl.rule.statement.managed_rule_group_statement.rule_action_override.action_to_use.challenge.custom_request_handling.new](#fn-rulerulestatementmanaged_rule_group_statementrule_action_overrideaction_to_usecustom_request_handlingnew) constructor.\n\n**Returns**:\n - An attribute object that represents the `challenge` sub block.\n', args=[]), + new( + custom_request_handling=null + ):: std.prune(a={ + custom_request_handling: custom_request_handling, + }), + }, count:: { custom_request_handling:: { insert_header:: { @@ -16532,16 +16560,18 @@ local d = (import 'github.com/jsonnet-libs/docsonnet/doc-util/main.libsonnet'); custom_request_handling: custom_request_handling, }), }, - '#new':: d.fn(help='\n`aws.wafv2_web_acl.rule.statement.managed_rule_group_statement.rule_action_override.action_to_use.new` constructs a new object with attributes and blocks configured for the `action_to_use`\nTerraform sub block.\n\n\n\n**Args**:\n - `allow` (`list[obj]`): Set the `allow` field on the resulting object. When `null`, the `allow` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [aws.wafv2_web_acl.rule.statement.managed_rule_group_statement.rule_action_override.action_to_use.allow.new](#fn-rulerulestatementmanaged_rule_group_statementrule_action_overrideallownew) constructor.\n - `block` (`list[obj]`): Set the `block` field on the resulting object. When `null`, the `block` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [aws.wafv2_web_acl.rule.statement.managed_rule_group_statement.rule_action_override.action_to_use.block.new](#fn-rulerulestatementmanaged_rule_group_statementrule_action_overrideblocknew) constructor.\n - `captcha` (`list[obj]`): Set the `captcha` field on the resulting object. When `null`, the `captcha` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [aws.wafv2_web_acl.rule.statement.managed_rule_group_statement.rule_action_override.action_to_use.captcha.new](#fn-rulerulestatementmanaged_rule_group_statementrule_action_overridecaptchanew) constructor.\n - `count` (`list[obj]`): Set the `count` field on the resulting object. When `null`, the `count` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [aws.wafv2_web_acl.rule.statement.managed_rule_group_statement.rule_action_override.action_to_use.count.new](#fn-rulerulestatementmanaged_rule_group_statementrule_action_overridecountnew) constructor.\n\n**Returns**:\n - An attribute object that represents the `action_to_use` sub block.\n', args=[]), + '#new':: d.fn(help='\n`aws.wafv2_web_acl.rule.statement.managed_rule_group_statement.rule_action_override.action_to_use.new` constructs a new object with attributes and blocks configured for the `action_to_use`\nTerraform sub block.\n\n\n\n**Args**:\n - `allow` (`list[obj]`): Set the `allow` field on the resulting object. When `null`, the `allow` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [aws.wafv2_web_acl.rule.statement.managed_rule_group_statement.rule_action_override.action_to_use.allow.new](#fn-rulerulestatementmanaged_rule_group_statementrule_action_overrideallownew) constructor.\n - `block` (`list[obj]`): Set the `block` field on the resulting object. When `null`, the `block` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [aws.wafv2_web_acl.rule.statement.managed_rule_group_statement.rule_action_override.action_to_use.block.new](#fn-rulerulestatementmanaged_rule_group_statementrule_action_overrideblocknew) constructor.\n - `captcha` (`list[obj]`): Set the `captcha` field on the resulting object. When `null`, the `captcha` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [aws.wafv2_web_acl.rule.statement.managed_rule_group_statement.rule_action_override.action_to_use.captcha.new](#fn-rulerulestatementmanaged_rule_group_statementrule_action_overridecaptchanew) constructor.\n - `challenge` (`list[obj]`): Set the `challenge` field on the resulting object. When `null`, the `challenge` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [aws.wafv2_web_acl.rule.statement.managed_rule_group_statement.rule_action_override.action_to_use.challenge.new](#fn-rulerulestatementmanaged_rule_group_statementrule_action_overridechallengenew) constructor.\n - `count` (`list[obj]`): Set the `count` field on the resulting object. When `null`, the `count` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [aws.wafv2_web_acl.rule.statement.managed_rule_group_statement.rule_action_override.action_to_use.count.new](#fn-rulerulestatementmanaged_rule_group_statementrule_action_overridecountnew) constructor.\n\n**Returns**:\n - An attribute object that represents the `action_to_use` sub block.\n', args=[]), new( allow=null, block=null, captcha=null, + challenge=null, count=null ):: std.prune(a={ allow: allow, block: block, captcha: captcha, + challenge: challenge, count: count, }), }, @@ -79558,6 +79588,32 @@ local d = (import 'github.com/jsonnet-libs/docsonnet/doc-util/main.libsonnet'); custom_request_handling: custom_request_handling, }), }, + challenge:: { + custom_request_handling:: { + insert_header:: { + '#new':: d.fn(help='\n`aws.wafv2_web_acl.rule.statement.rule_group_reference_statement.rule_action_override.action_to_use.challenge.custom_request_handling.insert_header.new` constructs a new object with attributes and blocks configured for the `insert_header`\nTerraform sub block.\n\n\n\n**Args**:\n - `name` (`string`): Set the `name` field on the resulting object.\n - `value` (`string`): Set the `value` field on the resulting object.\n\n**Returns**:\n - An attribute object that represents the `insert_header` sub block.\n', args=[]), + new( + name, + value + ):: std.prune(a={ + name: name, + value: value, + }), + }, + '#new':: d.fn(help='\n`aws.wafv2_web_acl.rule.statement.rule_group_reference_statement.rule_action_override.action_to_use.challenge.custom_request_handling.new` constructs a new object with attributes and blocks configured for the `custom_request_handling`\nTerraform sub block.\n\n\n\n**Args**:\n - `insert_header` (`list[obj]`): Set the `insert_header` field on the resulting object. When `null`, the `insert_header` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [aws.wafv2_web_acl.rule.statement.rule_group_reference_statement.rule_action_override.action_to_use.challenge.custom_request_handling.insert_header.new](#fn-rulerulestatementrule_group_reference_statementrule_action_overrideaction_to_usechallengeinsert_headernew) constructor.\n\n**Returns**:\n - An attribute object that represents the `custom_request_handling` sub block.\n', args=[]), + new( + insert_header=null + ):: std.prune(a={ + insert_header: insert_header, + }), + }, + '#new':: d.fn(help='\n`aws.wafv2_web_acl.rule.statement.rule_group_reference_statement.rule_action_override.action_to_use.challenge.new` constructs a new object with attributes and blocks configured for the `challenge`\nTerraform sub block.\n\n\n\n**Args**:\n - `custom_request_handling` (`list[obj]`): Set the `custom_request_handling` field on the resulting object. When `null`, the `custom_request_handling` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [aws.wafv2_web_acl.rule.statement.rule_group_reference_statement.rule_action_override.action_to_use.challenge.custom_request_handling.new](#fn-rulerulestatementrule_group_reference_statementrule_action_overrideaction_to_usecustom_request_handlingnew) constructor.\n\n**Returns**:\n - An attribute object that represents the `challenge` sub block.\n', args=[]), + new( + custom_request_handling=null + ):: std.prune(a={ + custom_request_handling: custom_request_handling, + }), + }, count:: { custom_request_handling:: { insert_header:: { @@ -79584,16 +79640,18 @@ local d = (import 'github.com/jsonnet-libs/docsonnet/doc-util/main.libsonnet'); custom_request_handling: custom_request_handling, }), }, - '#new':: d.fn(help='\n`aws.wafv2_web_acl.rule.statement.rule_group_reference_statement.rule_action_override.action_to_use.new` constructs a new object with attributes and blocks configured for the `action_to_use`\nTerraform sub block.\n\n\n\n**Args**:\n - `allow` (`list[obj]`): Set the `allow` field on the resulting object. When `null`, the `allow` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [aws.wafv2_web_acl.rule.statement.rule_group_reference_statement.rule_action_override.action_to_use.allow.new](#fn-rulerulestatementrule_group_reference_statementrule_action_overrideallownew) constructor.\n - `block` (`list[obj]`): Set the `block` field on the resulting object. When `null`, the `block` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [aws.wafv2_web_acl.rule.statement.rule_group_reference_statement.rule_action_override.action_to_use.block.new](#fn-rulerulestatementrule_group_reference_statementrule_action_overrideblocknew) constructor.\n - `captcha` (`list[obj]`): Set the `captcha` field on the resulting object. When `null`, the `captcha` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [aws.wafv2_web_acl.rule.statement.rule_group_reference_statement.rule_action_override.action_to_use.captcha.new](#fn-rulerulestatementrule_group_reference_statementrule_action_overridecaptchanew) constructor.\n - `count` (`list[obj]`): Set the `count` field on the resulting object. When `null`, the `count` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [aws.wafv2_web_acl.rule.statement.rule_group_reference_statement.rule_action_override.action_to_use.count.new](#fn-rulerulestatementrule_group_reference_statementrule_action_overridecountnew) constructor.\n\n**Returns**:\n - An attribute object that represents the `action_to_use` sub block.\n', args=[]), + '#new':: d.fn(help='\n`aws.wafv2_web_acl.rule.statement.rule_group_reference_statement.rule_action_override.action_to_use.new` constructs a new object with attributes and blocks configured for the `action_to_use`\nTerraform sub block.\n\n\n\n**Args**:\n - `allow` (`list[obj]`): Set the `allow` field on the resulting object. When `null`, the `allow` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [aws.wafv2_web_acl.rule.statement.rule_group_reference_statement.rule_action_override.action_to_use.allow.new](#fn-rulerulestatementrule_group_reference_statementrule_action_overrideallownew) constructor.\n - `block` (`list[obj]`): Set the `block` field on the resulting object. When `null`, the `block` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [aws.wafv2_web_acl.rule.statement.rule_group_reference_statement.rule_action_override.action_to_use.block.new](#fn-rulerulestatementrule_group_reference_statementrule_action_overrideblocknew) constructor.\n - `captcha` (`list[obj]`): Set the `captcha` field on the resulting object. When `null`, the `captcha` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [aws.wafv2_web_acl.rule.statement.rule_group_reference_statement.rule_action_override.action_to_use.captcha.new](#fn-rulerulestatementrule_group_reference_statementrule_action_overridecaptchanew) constructor.\n - `challenge` (`list[obj]`): Set the `challenge` field on the resulting object. When `null`, the `challenge` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [aws.wafv2_web_acl.rule.statement.rule_group_reference_statement.rule_action_override.action_to_use.challenge.new](#fn-rulerulestatementrule_group_reference_statementrule_action_overridechallengenew) constructor.\n - `count` (`list[obj]`): Set the `count` field on the resulting object. When `null`, the `count` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [aws.wafv2_web_acl.rule.statement.rule_group_reference_statement.rule_action_override.action_to_use.count.new](#fn-rulerulestatementrule_group_reference_statementrule_action_overridecountnew) constructor.\n\n**Returns**:\n - An attribute object that represents the `action_to_use` sub block.\n', args=[]), new( allow=null, block=null, captcha=null, + challenge=null, count=null ):: std.prune(a={ allow: allow, block: block, captcha: captcha, + challenge: challenge, count: count, }), }, diff --git a/docs/5.x/README.md b/docs/5.x/README.md index 8f8a5f10..0a59cefe 100644 --- a/docs/5.x/README.md +++ b/docs/5.x/README.md @@ -302,8 +302,10 @@ project. * [datapipeline_pipeline](datapipeline_pipeline.md) * [datapipeline_pipeline_definition](datapipeline_pipeline_definition.md) * [datasync_agent](datasync_agent.md) +* [datasync_location_azure_blob](datasync_location_azure_blob.md) * [datasync_location_efs](datasync_location_efs.md) * [datasync_location_fsx_lustre_file_system](datasync_location_fsx_lustre_file_system.md) +* [datasync_location_fsx_ontap_file_system](datasync_location_fsx_ontap_file_system.md) * [datasync_location_fsx_openzfs_file_system](datasync_location_fsx_openzfs_file_system.md) * [datasync_location_fsx_windows_file_system](datasync_location_fsx_windows_file_system.md) * [datasync_location_hdfs](datasync_location_hdfs.md) @@ -758,6 +760,7 @@ project. * [mq_broker](mq_broker.md) * [mq_configuration](mq_configuration.md) * [msk_cluster](msk_cluster.md) +* [msk_cluster_policy](msk_cluster_policy.md) * [msk_configuration](msk_configuration.md) * [msk_scram_secret_association](msk_scram_secret_association.md) * [msk_serverless_cluster](msk_serverless_cluster.md) @@ -813,6 +816,7 @@ project. * [opensearch_domain_saml_options](opensearch_domain_saml_options.md) * [opensearch_inbound_connection_accepter](opensearch_inbound_connection_accepter.md) * [opensearch_outbound_connection](opensearch_outbound_connection.md) +* [opensearch_vpc_endpoint](opensearch_vpc_endpoint.md) * [opensearchserverless_access_policy](opensearchserverless_access_policy.md) * [opensearchserverless_collection](opensearchserverless_collection.md) * [opensearchserverless_security_config](opensearchserverless_security_config.md) @@ -884,6 +888,7 @@ project. * [ram_resource_association](ram_resource_association.md) * [ram_resource_share](ram_resource_share.md) * [ram_resource_share_accepter](ram_resource_share_accepter.md) +* [ram_sharing_with_organization](ram_sharing_with_organization.md) * [rbin_rule](rbin_rule.md) * [rds_cluster](rds_cluster.md) * [rds_cluster_activity_stream](rds_cluster_activity_stream.md) @@ -1094,6 +1099,9 @@ project. * [sfn_activity](sfn_activity.md) * [sfn_alias](sfn_alias.md) * [sfn_state_machine](sfn_state_machine.md) +* [shield_application_layer_automatic_response](shield_application_layer_automatic_response.md) +* [shield_drt_access_log_bucket_association](shield_drt_access_log_bucket_association.md) +* [shield_drt_access_role_arn_association](shield_drt_access_role_arn_association.md) * [shield_protection](shield_protection.md) * [shield_protection_group](shield_protection_group.md) * [shield_protection_health_check_association](shield_protection_health_check_association.md) @@ -1170,6 +1178,8 @@ project. * [transfer_tag](transfer_tag.md) * [transfer_user](transfer_user.md) * [transfer_workflow](transfer_workflow.md) +* [verifiedaccess_instance](verifiedaccess_instance.md) +* [verifiedaccess_trust_provider](verifiedaccess_trust_provider.md) * [volume_attachment](volume_attachment.md) * [vpc](vpc.md) * [vpc_dhcp_options](vpc_dhcp_options.md) diff --git a/docs/5.x/api_gateway_api_key.md b/docs/5.x/api_gateway_api_key.md index b21910a3..d8e63e95 100644 --- a/docs/5.x/api_gateway_api_key.md +++ b/docs/5.x/api_gateway_api_key.md @@ -15,6 +15,7 @@ This package contains functions and utilities for setting up the resource using * [`fn new()`](#fn-new) * [`fn newAttrs()`](#fn-newattrs) +* [`fn withCustomerId()`](#fn-withcustomerid) * [`fn withDescription()`](#fn-withdescription) * [`fn withEnabled()`](#fn-withenabled) * [`fn withName()`](#fn-withname) @@ -51,6 +52,7 @@ or `$` to refer to the root object. Instead, make an explicit outer object using **Args**: - `resourceLabel` (`string`): The name label of the block. + - `customer_id` (`string`): Set the `customer_id` field on the resulting resource block. When `null`, the `customer_id` field will be omitted from the resulting object. - `description` (`string`): Set the `description` field on the resulting resource block. When `null`, the `description` field will be omitted from the resulting object. - `enabled` (`bool`): Set the `enabled` field on the resulting resource block. When `null`, the `enabled` field will be omitted from the resulting object. - `name` (`string`): Set the `name` field on the resulting resource block. @@ -80,6 +82,7 @@ This is most useful when you need to preprocess the attributes with functions, c injecting into a complete block. **Args**: + - `customer_id` (`string`): Set the `customer_id` field on the resulting object. When `null`, the `customer_id` field will be omitted from the resulting object. - `description` (`string`): Set the `description` field on the resulting object. When `null`, the `description` field will be omitted from the resulting object. - `enabled` (`bool`): Set the `enabled` field on the resulting object. When `null`, the `enabled` field will be omitted from the resulting object. - `name` (`string`): Set the `name` field on the resulting object. @@ -91,6 +94,22 @@ injecting into a complete block. - An attribute object that can be used with [tf.withResource](https://github.com/tf-libsonnet/core/tree/main/docs#fn-withresource) to construct a new `api_gateway_api_key` resource into the root Terraform configuration. +### fn withCustomerId + +```ts +withCustomerId() +``` + +`aws.string.withCustomerId` constructs a mixin object that can be merged into the `string` +Terraform resource block to set or update the customer_id field. + + + +**Args**: + - `resourceLabel` (`string`): The name label of the block to update. + - `value` (`string`): The value to set for the `customer_id` field. + + ### fn withDescription ```ts diff --git a/docs/5.x/autoscaling_group.md b/docs/5.x/autoscaling_group.md index 4f5025d2..86575d60 100644 --- a/docs/5.x/autoscaling_group.md +++ b/docs/5.x/autoscaling_group.md @@ -1115,7 +1115,9 @@ Terraform sub block. - `checkpoint_percentages` (`list`): Set the `checkpoint_percentages` field on the resulting object. When `null`, the `checkpoint_percentages` field will be omitted from the resulting object. - `instance_warmup` (`string`): Set the `instance_warmup` field on the resulting object. When `null`, the `instance_warmup` field will be omitted from the resulting object. - `min_healthy_percentage` (`number`): Set the `min_healthy_percentage` field on the resulting object. When `null`, the `min_healthy_percentage` field will be omitted from the resulting object. + - `scale_in_protected_instances` (`string`): Set the `scale_in_protected_instances` field on the resulting object. When `null`, the `scale_in_protected_instances` field will be omitted from the resulting object. - `skip_matching` (`bool`): Set the `skip_matching` field on the resulting object. When `null`, the `skip_matching` field will be omitted from the resulting object. + - `standby_instances` (`string`): Set the `standby_instances` field on the resulting object. When `null`, the `standby_instances` field will be omitted from the resulting object. **Returns**: - An attribute object that represents the `preferences` sub block. diff --git a/docs/5.x/batch_job_queue.md b/docs/5.x/batch_job_queue.md index c9a428f3..363c3a09 100644 --- a/docs/5.x/batch_job_queue.md +++ b/docs/5.x/batch_job_queue.md @@ -21,7 +21,10 @@ This package contains functions and utilities for setting up the resource using * [`fn withSchedulingPolicyArn()`](#fn-withschedulingpolicyarn) * [`fn withState()`](#fn-withstate) * [`fn withTags()`](#fn-withtags) -* [`fn withTagsAll()`](#fn-withtagsall) +* [`fn withTimeouts()`](#fn-withtimeouts) +* [`fn withTimeoutsMixin()`](#fn-withtimeoutsmixin) +* [`obj timeouts`](#obj-timeouts) + * [`fn new()`](#fn-timeoutsnew) ## Fields @@ -58,7 +61,7 @@ or `$` to refer to the root object. Instead, make an explicit outer object using - `scheduling_policy_arn` (`string`): Set the `scheduling_policy_arn` field on the resulting resource block. When `null`, the `scheduling_policy_arn` field will be omitted from the resulting object. - `state` (`string`): Set the `state` field on the resulting resource block. - `tags` (`obj`): Set the `tags` field on the resulting resource block. When `null`, the `tags` field will be omitted from the resulting object. - - `tags_all` (`obj`): Set the `tags_all` field on the resulting resource block. When `null`, the `tags_all` field will be omitted from the resulting object. + - `timeouts` (`obj`): Set the `timeouts` field on the resulting resource block. When `null`, the `timeouts` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [aws.batch_job_queue.timeouts.new](#fn-timeoutsnew) constructor. **Returns**: - A mixin object that injects the new resource into the root Terraform configuration. @@ -88,7 +91,7 @@ injecting into a complete block. - `scheduling_policy_arn` (`string`): Set the `scheduling_policy_arn` field on the resulting object. When `null`, the `scheduling_policy_arn` field will be omitted from the resulting object. - `state` (`string`): Set the `state` field on the resulting object. - `tags` (`obj`): Set the `tags` field on the resulting object. When `null`, the `tags` field will be omitted from the resulting object. - - `tags_all` (`obj`): Set the `tags_all` field on the resulting object. When `null`, the `tags_all` field will be omitted from the resulting object. + - `timeouts` (`obj`): Set the `timeouts` field on the resulting object. When `null`, the `timeouts` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [aws.batch_job_queue.timeouts.new](#fn-timeoutsnew) constructor. **Returns**: - An attribute object that can be used with [tf.withResource](https://github.com/tf-libsonnet/core/tree/main/docs#fn-withresource) to construct a new `batch_job_queue` resource into the root Terraform configuration. @@ -190,17 +193,62 @@ Terraform resource block to set or update the tags field. - `value` (`obj`): The value to set for the `tags` field. -### fn withTagsAll +### fn withTimeouts ```ts -withTagsAll() +withTimeouts() ``` -`aws.obj.withTagsAll` constructs a mixin object that can be merged into the `obj` -Terraform resource block to set or update the tags_all field. +`aws.obj.withTimeouts` constructs a mixin object that can be merged into the `obj` +Terraform resource block to set or update the timeouts field. +This function will replace the map with the passed in `value`. If you wish to instead merge the +passed in value to the existing map, use the [aws.obj.withTimeoutsMixin](TODO) function. + +**Args**: + - `resourceLabel` (`string`): The name label of the block to update. + - `value` (`obj`): The value to set for the `timeouts` field. + + +### fn withTimeoutsMixin + +```ts +withTimeoutsMixin() +``` + +`aws.obj.withTimeoutsMixin` constructs a mixin object that can be merged into the `obj` +Terraform resource block to set or update the timeouts field. + +This function will merge the passed in value to the existing map. If you wish +to instead replace the entire map with the passed in `value`, use the [aws.obj.withTimeouts](TODO) +function. **Args**: - `resourceLabel` (`string`): The name label of the block to update. - - `value` (`obj`): The value to set for the `tags_all` field. + - `value` (`obj`): The value to set for the `timeouts` field. + + +## obj timeouts + + + +### fn timeouts.new + +```ts +new() +``` + + +`aws.batch_job_queue.timeouts.new` constructs a new object with attributes and blocks configured for the `timeouts` +Terraform sub block. + + + +**Args**: + - `create` (`string`): A string that can be [parsed as a duration](https://pkg.go.dev/time#ParseDuration) consisting of numbers and unit suffixes, such as "30s" or "2h45m". Valid time units are "s" (seconds), "m" (minutes), "h" (hours). When `null`, the `create` field will be omitted from the resulting object. + - `delete` (`string`): A string that can be [parsed as a duration](https://pkg.go.dev/time#ParseDuration) consisting of numbers and unit suffixes, such as "30s" or "2h45m". Valid time units are "s" (seconds), "m" (minutes), "h" (hours). Setting a timeout for a Delete operation is only applicable if changes are saved into state before the destroy operation occurs. When `null`, the `delete` field will be omitted from the resulting object. + - `update` (`string`): A string that can be [parsed as a duration](https://pkg.go.dev/time#ParseDuration) consisting of numbers and unit suffixes, such as "30s" or "2h45m". Valid time units are "s" (seconds), "m" (minutes), "h" (hours). When `null`, the `update` field will be omitted from the resulting object. + +**Returns**: + - An attribute object that represents the `timeouts` sub block. diff --git a/docs/5.x/budgets_budget_action.md b/docs/5.x/budgets_budget_action.md index 0cfe6a63..acea3faf 100644 --- a/docs/5.x/budgets_budget_action.md +++ b/docs/5.x/budgets_budget_action.md @@ -530,6 +530,7 @@ Terraform sub block. **Args**: - `create` (`string`): Set the `create` field on the resulting object. When `null`, the `create` field will be omitted from the resulting object. + - `delete` (`string`): Set the `delete` field on the resulting object. When `null`, the `delete` field will be omitted from the resulting object. - `update` (`string`): Set the `update` field on the resulting object. When `null`, the `update` field will be omitted from the resulting object. **Returns**: diff --git a/docs/5.x/data/cognito_identity_pool.md b/docs/5.x/data/cognito_identity_pool.md new file mode 100644 index 00000000..f8d9ca21 --- /dev/null +++ b/docs/5.x/data/cognito_identity_pool.md @@ -0,0 +1,111 @@ +--- +permalink: /data/cognito_identity_pool/ +--- + +# data.cognito_identity_pool + +`cognito_identity_pool` represents the `aws_cognito_identity_pool` Terraform data source. + + + +This package contains functions and utilities for setting up the data source using Jsonnet code. + + +## Index + +* [`fn new()`](#fn-new) +* [`fn newAttrs()`](#fn-newattrs) +* [`fn withIdentityPoolName()`](#fn-withidentitypoolname) +* [`fn withTags()`](#fn-withtags) + +## Fields + +### fn new + +```ts +new() +``` + + +`aws.data.cognito_identity_pool.new` injects a new `data_aws_cognito_identity_pool` Terraform `data source` +block into the root module document. + +Additionally, this inserts a private function into the `_ref` attribute that generates references to attributes of the +resource. For example, if you added a new instance to the root using: + + # arguments omitted for brevity + aws.data.cognito_identity_pool.new('some_id') + +You can get the reference to the `id` field of the created `aws.data.cognito_identity_pool` using the reference: + + $._ref.data_aws_cognito_identity_pool.some_id.get('id') + +This is the same as directly entering `"${ data_aws_cognito_identity_pool.some_id.id }"` as the value. + +NOTE: if you are chaining multiple resources together in a merge operation, you may not be able to use `super`, `self`, +or `$` to refer to the root object. Instead, make an explicit outer object using `local`. + +**Args**: + - `dataSrcLabel` (`string`): The name label of the block. + - `identity_pool_name` (`string`): Set the `identity_pool_name` field on the resulting data source block. + - `tags` (`obj`): Set the `tags` field on the resulting data source block. When `null`, the `tags` field will be omitted from the resulting object. + +**Returns**: +- A mixin object that injects the new data source into the root Terraform configuration. + + +### fn newAttrs + +```ts +newAttrs() +``` + + +`aws.data.cognito_identity_pool.newAttrs` constructs a new object with attributes and blocks configured for the `cognito_identity_pool` +Terraform data source. + +Unlike [aws.data.cognito_identity_pool.new](#fn-new), this function will not inject the `data source` +block into the root Terraform document. Instead, this must be passed in as the `attrs` argument for the +[tf.withData](https://github.com/tf-libsonnet/core/tree/main/docs#fn-withdata) function to build a complete block. + +This is most useful when you need to preprocess the attributes with functions, conditional, or looping logic prior to +injecting into a complete block. + +**Args**: + - `identity_pool_name` (`string`): Set the `identity_pool_name` field on the resulting object. + - `tags` (`obj`): Set the `tags` field on the resulting object. When `null`, the `tags` field will be omitted from the resulting object. + +**Returns**: + - An attribute object that can be used with [tf.withData](https://github.com/tf-libsonnet/core/tree/main/docs#fn-withdata) to construct a new `cognito_identity_pool` data source into the root Terraform configuration. + + +### fn withIdentityPoolName + +```ts +withIdentityPoolName() +``` + +`aws.string.withIdentityPoolName` constructs a mixin object that can be merged into the `string` +Terraform data source block to set or update the identity_pool_name field. + + + +**Args**: + - `dataSrcLabel` (`string`): The name label of the block to update. + - `value` (`string`): The value to set for the `identity_pool_name` field. + + +### fn withTags + +```ts +withTags() +``` + +`aws.obj.withTags` constructs a mixin object that can be merged into the `obj` +Terraform data source block to set or update the tags field. + + + +**Args**: + - `dataSrcLabel` (`string`): The name label of the block to update. + - `value` (`obj`): The value to set for the `tags` field. diff --git a/docs/5.x/data/dms_endpoint.md b/docs/5.x/data/dms_endpoint.md index d2bd2059..88313ebd 100644 --- a/docs/5.x/data/dms_endpoint.md +++ b/docs/5.x/data/dms_endpoint.md @@ -15,21 +15,8 @@ This package contains functions and utilities for setting up the data source usi * [`fn new()`](#fn-new) * [`fn newAttrs()`](#fn-newattrs) -* [`fn withElasticsearchSettings()`](#fn-withelasticsearchsettings) -* [`fn withElasticsearchSettingsMixin()`](#fn-withelasticsearchsettingsmixin) * [`fn withEndpointId()`](#fn-withendpointid) -* [`fn withExtraConnectionAttributes()`](#fn-withextraconnectionattributes) -* [`fn withKafkaSettings()`](#fn-withkafkasettings) -* [`fn withKafkaSettingsMixin()`](#fn-withkafkasettingsmixin) -* [`fn withMongodbSettings()`](#fn-withmongodbsettings) -* [`fn withMongodbSettingsMixin()`](#fn-withmongodbsettingsmixin) * [`fn withTags()`](#fn-withtags) -* [`obj elasticsearch_settings`](#obj-elasticsearch_settings) - * [`fn new()`](#fn-elasticsearch_settingsnew) -* [`obj kafka_settings`](#obj-kafka_settings) - * [`fn new()`](#fn-kafka_settingsnew) -* [`obj mongodb_settings`](#obj-mongodb_settings) - * [`fn new()`](#fn-mongodb_settingsnew) ## Fields @@ -61,11 +48,7 @@ or `$` to refer to the root object. Instead, make an explicit outer object using **Args**: - `dataSrcLabel` (`string`): The name label of the block. - `endpoint_id` (`string`): Set the `endpoint_id` field on the resulting data source block. - - `extra_connection_attributes` (`string`): Set the `extra_connection_attributes` field on the resulting data source block. When `null`, the `extra_connection_attributes` field will be omitted from the resulting object. - `tags` (`obj`): Set the `tags` field on the resulting data source block. When `null`, the `tags` field will be omitted from the resulting object. - - `elasticsearch_settings` (`list[obj]`): Set the `elasticsearch_settings` field on the resulting data source block. When `null`, the `elasticsearch_settings` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [aws.data.dms_endpoint.elasticsearch_settings.new](#fn-elasticsearch_settingsnew) constructor. - - `kafka_settings` (`list[obj]`): Set the `kafka_settings` field on the resulting data source block. When `null`, the `kafka_settings` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [aws.data.dms_endpoint.kafka_settings.new](#fn-kafka_settingsnew) constructor. - - `mongodb_settings` (`list[obj]`): Set the `mongodb_settings` field on the resulting data source block. When `null`, the `mongodb_settings` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [aws.data.dms_endpoint.mongodb_settings.new](#fn-mongodb_settingsnew) constructor. **Returns**: - A mixin object that injects the new data source into the root Terraform configuration. @@ -90,53 +73,12 @@ injecting into a complete block. **Args**: - `endpoint_id` (`string`): Set the `endpoint_id` field on the resulting object. - - `extra_connection_attributes` (`string`): Set the `extra_connection_attributes` field on the resulting object. When `null`, the `extra_connection_attributes` field will be omitted from the resulting object. - `tags` (`obj`): Set the `tags` field on the resulting object. When `null`, the `tags` field will be omitted from the resulting object. - - `elasticsearch_settings` (`list[obj]`): Set the `elasticsearch_settings` field on the resulting object. When `null`, the `elasticsearch_settings` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [aws.data.dms_endpoint.elasticsearch_settings.new](#fn-elasticsearch_settingsnew) constructor. - - `kafka_settings` (`list[obj]`): Set the `kafka_settings` field on the resulting object. When `null`, the `kafka_settings` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [aws.data.dms_endpoint.kafka_settings.new](#fn-kafka_settingsnew) constructor. - - `mongodb_settings` (`list[obj]`): Set the `mongodb_settings` field on the resulting object. When `null`, the `mongodb_settings` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [aws.data.dms_endpoint.mongodb_settings.new](#fn-mongodb_settingsnew) constructor. **Returns**: - An attribute object that can be used with [tf.withData](https://github.com/tf-libsonnet/core/tree/main/docs#fn-withdata) to construct a new `dms_endpoint` data source into the root Terraform configuration. -### fn withElasticsearchSettings - -```ts -withElasticsearchSettings() -``` - -`aws.list[obj].withElasticsearchSettings` constructs a mixin object that can be merged into the `list[obj]` -Terraform data source block to set or update the elasticsearch_settings field. - -This function will replace the array with the passed in `value`. If you wish to instead append the -passed in value to the existing array, use the [aws.list[obj].withElasticsearchSettingsMixin](TODO) function. - - -**Args**: - - `dataSrcLabel` (`string`): The name label of the block to update. - - `value` (`list[obj]`): The value to set for the `elasticsearch_settings` field. - - -### fn withElasticsearchSettingsMixin - -```ts -withElasticsearchSettingsMixin() -``` - -`aws.list[obj].withElasticsearchSettingsMixin` constructs a mixin object that can be merged into the `list[obj]` -Terraform data source block to set or update the elasticsearch_settings field. - -This function will append the passed in array or object to the existing array. If you wish -to instead replace the array with the passed in `value`, use the [aws.list[obj].withElasticsearchSettings](TODO) -function. - - -**Args**: - - `dataSrcLabel` (`string`): The name label of the block to update. - - `value` (`list[obj]`): The value to set for the `elasticsearch_settings` field. - - ### fn withEndpointId ```ts @@ -153,96 +95,6 @@ Terraform data source block to set or update the endpoint_id field. - `value` (`string`): The value to set for the `endpoint_id` field. -### fn withExtraConnectionAttributes - -```ts -withExtraConnectionAttributes() -``` - -`aws.string.withExtraConnectionAttributes` constructs a mixin object that can be merged into the `string` -Terraform data source block to set or update the extra_connection_attributes field. - - - -**Args**: - - `dataSrcLabel` (`string`): The name label of the block to update. - - `value` (`string`): The value to set for the `extra_connection_attributes` field. - - -### fn withKafkaSettings - -```ts -withKafkaSettings() -``` - -`aws.list[obj].withKafkaSettings` constructs a mixin object that can be merged into the `list[obj]` -Terraform data source block to set or update the kafka_settings field. - -This function will replace the array with the passed in `value`. If you wish to instead append the -passed in value to the existing array, use the [aws.list[obj].withKafkaSettingsMixin](TODO) function. - - -**Args**: - - `dataSrcLabel` (`string`): The name label of the block to update. - - `value` (`list[obj]`): The value to set for the `kafka_settings` field. - - -### fn withKafkaSettingsMixin - -```ts -withKafkaSettingsMixin() -``` - -`aws.list[obj].withKafkaSettingsMixin` constructs a mixin object that can be merged into the `list[obj]` -Terraform data source block to set or update the kafka_settings field. - -This function will append the passed in array or object to the existing array. If you wish -to instead replace the array with the passed in `value`, use the [aws.list[obj].withKafkaSettings](TODO) -function. - - -**Args**: - - `dataSrcLabel` (`string`): The name label of the block to update. - - `value` (`list[obj]`): The value to set for the `kafka_settings` field. - - -### fn withMongodbSettings - -```ts -withMongodbSettings() -``` - -`aws.list[obj].withMongodbSettings` constructs a mixin object that can be merged into the `list[obj]` -Terraform data source block to set or update the mongodb_settings field. - -This function will replace the array with the passed in `value`. If you wish to instead append the -passed in value to the existing array, use the [aws.list[obj].withMongodbSettingsMixin](TODO) function. - - -**Args**: - - `dataSrcLabel` (`string`): The name label of the block to update. - - `value` (`list[obj]`): The value to set for the `mongodb_settings` field. - - -### fn withMongodbSettingsMixin - -```ts -withMongodbSettingsMixin() -``` - -`aws.list[obj].withMongodbSettingsMixin` constructs a mixin object that can be merged into the `list[obj]` -Terraform data source block to set or update the mongodb_settings field. - -This function will append the passed in array or object to the existing array. If you wish -to instead replace the array with the passed in `value`, use the [aws.list[obj].withMongodbSettings](TODO) -function. - - -**Args**: - - `dataSrcLabel` (`string`): The name label of the block to update. - - `value` (`list[obj]`): The value to set for the `mongodb_settings` field. - - ### fn withTags ```ts @@ -257,70 +109,3 @@ Terraform data source block to set or update the tags field. **Args**: - `dataSrcLabel` (`string`): The name label of the block to update. - `value` (`obj`): The value to set for the `tags` field. - - -## obj elasticsearch_settings - - - -### fn elasticsearch_settings.new - -```ts -new() -``` - - -`aws.dms_endpoint.elasticsearch_settings.new` constructs a new object with attributes and blocks configured for the `elasticsearch_settings` -Terraform sub block. - - - -**Args**: - - `endpoint_uri` (`string`): Set the `endpoint_uri` field on the resulting object. - - `service_access_role_arn` (`string`): Set the `service_access_role_arn` field on the resulting object. - -**Returns**: - - An attribute object that represents the `elasticsearch_settings` sub block. - - -## obj kafka_settings - - - -### fn kafka_settings.new - -```ts -new() -``` - - -`aws.dms_endpoint.kafka_settings.new` constructs a new object with attributes and blocks configured for the `kafka_settings` -Terraform sub block. - - - -**Args**: - - `broker` (`string`): Set the `broker` field on the resulting object. - -**Returns**: - - An attribute object that represents the `kafka_settings` sub block. - - -## obj mongodb_settings - - - -### fn mongodb_settings.new - -```ts -new() -``` - - -`aws.dms_endpoint.mongodb_settings.new` constructs a new object with attributes and blocks configured for the `mongodb_settings` -Terraform sub block. - - - -**Returns**: - - An attribute object that represents the `mongodb_settings` sub block. diff --git a/docs/5.x/data/identitystore_group.md b/docs/5.x/data/identitystore_group.md index f3e0dc42..57a4bb4b 100644 --- a/docs/5.x/data/identitystore_group.md +++ b/docs/5.x/data/identitystore_group.md @@ -17,6 +17,8 @@ This package contains functions and utilities for setting up the data source usi * [`fn newAttrs()`](#fn-newattrs) * [`fn withAlternateIdentifier()`](#fn-withalternateidentifier) * [`fn withAlternateIdentifierMixin()`](#fn-withalternateidentifiermixin) +* [`fn withFilter()`](#fn-withfilter) +* [`fn withFilterMixin()`](#fn-withfiltermixin) * [`fn withGroupId()`](#fn-withgroupid) * [`fn withIdentityStoreId()`](#fn-withidentitystoreid) * [`obj alternate_identifier`](#obj-alternate_identifier) @@ -25,6 +27,8 @@ This package contains functions and utilities for setting up the data source usi * [`fn new()`](#fn-alternate_identifierexternal_idnew) * [`obj alternate_identifier.unique_attribute`](#obj-alternate_identifierunique_attribute) * [`fn new()`](#fn-alternate_identifierunique_attributenew) +* [`obj filter`](#obj-filter) + * [`fn new()`](#fn-filternew) ## Fields @@ -58,6 +62,7 @@ or `$` to refer to the root object. Instead, make an explicit outer object using - `group_id` (`string`): Set the `group_id` field on the resulting data source block. When `null`, the `group_id` field will be omitted from the resulting object. - `identity_store_id` (`string`): Set the `identity_store_id` field on the resulting data source block. - `alternate_identifier` (`list[obj]`): Set the `alternate_identifier` field on the resulting data source block. When `null`, the `alternate_identifier` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [aws.data.identitystore_group.alternate_identifier.new](#fn-alternate_identifiernew) constructor. + - `filter` (`list[obj]`): Set the `filter` field on the resulting data source block. When `null`, the `filter` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [aws.data.identitystore_group.filter.new](#fn-filternew) constructor. **Returns**: - A mixin object that injects the new data source into the root Terraform configuration. @@ -84,6 +89,7 @@ injecting into a complete block. - `group_id` (`string`): Set the `group_id` field on the resulting object. When `null`, the `group_id` field will be omitted from the resulting object. - `identity_store_id` (`string`): Set the `identity_store_id` field on the resulting object. - `alternate_identifier` (`list[obj]`): Set the `alternate_identifier` field on the resulting object. When `null`, the `alternate_identifier` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [aws.data.identitystore_group.alternate_identifier.new](#fn-alternate_identifiernew) constructor. + - `filter` (`list[obj]`): Set the `filter` field on the resulting object. When `null`, the `filter` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [aws.data.identitystore_group.filter.new](#fn-filternew) constructor. **Returns**: - An attribute object that can be used with [tf.withData](https://github.com/tf-libsonnet/core/tree/main/docs#fn-withdata) to construct a new `identitystore_group` data source into the root Terraform configuration. @@ -126,6 +132,43 @@ function. - `value` (`list[obj]`): The value to set for the `alternate_identifier` field. +### fn withFilter + +```ts +withFilter() +``` + +`aws.list[obj].withFilter` constructs a mixin object that can be merged into the `list[obj]` +Terraform data source block to set or update the filter field. + +This function will replace the array with the passed in `value`. If you wish to instead append the +passed in value to the existing array, use the [aws.list[obj].withFilterMixin](TODO) function. + + +**Args**: + - `dataSrcLabel` (`string`): The name label of the block to update. + - `value` (`list[obj]`): The value to set for the `filter` field. + + +### fn withFilterMixin + +```ts +withFilterMixin() +``` + +`aws.list[obj].withFilterMixin` constructs a mixin object that can be merged into the `list[obj]` +Terraform data source block to set or update the filter field. + +This function will append the passed in array or object to the existing array. If you wish +to instead replace the array with the passed in `value`, use the [aws.list[obj].withFilter](TODO) +function. + + +**Args**: + - `dataSrcLabel` (`string`): The name label of the block to update. + - `value` (`list[obj]`): The value to set for the `filter` field. + + ### fn withGroupId ```ts @@ -227,3 +270,27 @@ Terraform sub block. **Returns**: - An attribute object that represents the `unique_attribute` sub block. + + +## obj filter + + + +### fn filter.new + +```ts +new() +``` + + +`aws.identitystore_group.filter.new` constructs a new object with attributes and blocks configured for the `filter` +Terraform sub block. + + + +**Args**: + - `attribute_path` (`string`): Set the `attribute_path` field on the resulting object. + - `attribute_value` (`string`): Set the `attribute_value` field on the resulting object. + +**Returns**: + - An attribute object that represents the `filter` sub block. diff --git a/docs/5.x/data/identitystore_user.md b/docs/5.x/data/identitystore_user.md index d7b8c061..bf89166b 100644 --- a/docs/5.x/data/identitystore_user.md +++ b/docs/5.x/data/identitystore_user.md @@ -17,6 +17,8 @@ This package contains functions and utilities for setting up the data source usi * [`fn newAttrs()`](#fn-newattrs) * [`fn withAlternateIdentifier()`](#fn-withalternateidentifier) * [`fn withAlternateIdentifierMixin()`](#fn-withalternateidentifiermixin) +* [`fn withFilter()`](#fn-withfilter) +* [`fn withFilterMixin()`](#fn-withfiltermixin) * [`fn withIdentityStoreId()`](#fn-withidentitystoreid) * [`fn withUserId()`](#fn-withuserid) * [`obj alternate_identifier`](#obj-alternate_identifier) @@ -25,6 +27,8 @@ This package contains functions and utilities for setting up the data source usi * [`fn new()`](#fn-alternate_identifierexternal_idnew) * [`obj alternate_identifier.unique_attribute`](#obj-alternate_identifierunique_attribute) * [`fn new()`](#fn-alternate_identifierunique_attributenew) +* [`obj filter`](#obj-filter) + * [`fn new()`](#fn-filternew) ## Fields @@ -58,6 +62,7 @@ or `$` to refer to the root object. Instead, make an explicit outer object using - `identity_store_id` (`string`): Set the `identity_store_id` field on the resulting data source block. - `user_id` (`string`): Set the `user_id` field on the resulting data source block. When `null`, the `user_id` field will be omitted from the resulting object. - `alternate_identifier` (`list[obj]`): Set the `alternate_identifier` field on the resulting data source block. When `null`, the `alternate_identifier` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [aws.data.identitystore_user.alternate_identifier.new](#fn-alternate_identifiernew) constructor. + - `filter` (`list[obj]`): Set the `filter` field on the resulting data source block. When `null`, the `filter` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [aws.data.identitystore_user.filter.new](#fn-filternew) constructor. **Returns**: - A mixin object that injects the new data source into the root Terraform configuration. @@ -84,6 +89,7 @@ injecting into a complete block. - `identity_store_id` (`string`): Set the `identity_store_id` field on the resulting object. - `user_id` (`string`): Set the `user_id` field on the resulting object. When `null`, the `user_id` field will be omitted from the resulting object. - `alternate_identifier` (`list[obj]`): Set the `alternate_identifier` field on the resulting object. When `null`, the `alternate_identifier` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [aws.data.identitystore_user.alternate_identifier.new](#fn-alternate_identifiernew) constructor. + - `filter` (`list[obj]`): Set the `filter` field on the resulting object. When `null`, the `filter` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [aws.data.identitystore_user.filter.new](#fn-filternew) constructor. **Returns**: - An attribute object that can be used with [tf.withData](https://github.com/tf-libsonnet/core/tree/main/docs#fn-withdata) to construct a new `identitystore_user` data source into the root Terraform configuration. @@ -126,6 +132,43 @@ function. - `value` (`list[obj]`): The value to set for the `alternate_identifier` field. +### fn withFilter + +```ts +withFilter() +``` + +`aws.list[obj].withFilter` constructs a mixin object that can be merged into the `list[obj]` +Terraform data source block to set or update the filter field. + +This function will replace the array with the passed in `value`. If you wish to instead append the +passed in value to the existing array, use the [aws.list[obj].withFilterMixin](TODO) function. + + +**Args**: + - `dataSrcLabel` (`string`): The name label of the block to update. + - `value` (`list[obj]`): The value to set for the `filter` field. + + +### fn withFilterMixin + +```ts +withFilterMixin() +``` + +`aws.list[obj].withFilterMixin` constructs a mixin object that can be merged into the `list[obj]` +Terraform data source block to set or update the filter field. + +This function will append the passed in array or object to the existing array. If you wish +to instead replace the array with the passed in `value`, use the [aws.list[obj].withFilter](TODO) +function. + + +**Args**: + - `dataSrcLabel` (`string`): The name label of the block to update. + - `value` (`list[obj]`): The value to set for the `filter` field. + + ### fn withIdentityStoreId ```ts @@ -227,3 +270,27 @@ Terraform sub block. **Returns**: - An attribute object that represents the `unique_attribute` sub block. + + +## obj filter + + + +### fn filter.new + +```ts +new() +``` + + +`aws.identitystore_user.filter.new` constructs a new object with attributes and blocks configured for the `filter` +Terraform sub block. + + + +**Args**: + - `attribute_path` (`string`): Set the `attribute_path` field on the resulting object. + - `attribute_value` (`string`): Set the `attribute_value` field on the resulting object. + +**Returns**: + - An attribute object that represents the `filter` sub block. diff --git a/docs/5.x/data/index.md b/docs/5.x/data/index.md index 3696e0c2..31acda35 100644 --- a/docs/5.x/data/index.md +++ b/docs/5.x/data/index.md @@ -86,6 +86,7 @@ permalink: /data/ * [codecommit_approval_rule_template](codecommit_approval_rule_template.md) * [codecommit_repository](codecommit_repository.md) * [codestarconnections_connection](codestarconnections_connection.md) +* [cognito_identity_pool](cognito_identity_pool.md) * [cognito_user_pool_client](cognito_user_pool_client.md) * [cognito_user_pool_clients](cognito_user_pool_clients.md) * [cognito_user_pool_signing_certificate](cognito_user_pool_signing_certificate.md) diff --git a/docs/5.x/data/s3_object.md b/docs/5.x/data/s3_object.md index 3506452f..de31542a 100644 --- a/docs/5.x/data/s3_object.md +++ b/docs/5.x/data/s3_object.md @@ -16,6 +16,7 @@ This package contains functions and utilities for setting up the data source usi * [`fn new()`](#fn-new) * [`fn newAttrs()`](#fn-newattrs) * [`fn withBucket()`](#fn-withbucket) +* [`fn withChecksumMode()`](#fn-withchecksummode) * [`fn withKey()`](#fn-withkey) * [`fn withRange()`](#fn-withrange) * [`fn withTags()`](#fn-withtags) @@ -51,6 +52,7 @@ or `$` to refer to the root object. Instead, make an explicit outer object using **Args**: - `dataSrcLabel` (`string`): The name label of the block. - `bucket` (`string`): Set the `bucket` field on the resulting data source block. + - `checksum_mode` (`string`): Set the `checksum_mode` field on the resulting data source block. When `null`, the `checksum_mode` field will be omitted from the resulting object. - `key` (`string`): Set the `key` field on the resulting data source block. - `range` (`string`): Set the `range` field on the resulting data source block. When `null`, the `range` field will be omitted from the resulting object. - `tags` (`obj`): Set the `tags` field on the resulting data source block. When `null`, the `tags` field will be omitted from the resulting object. @@ -79,6 +81,7 @@ injecting into a complete block. **Args**: - `bucket` (`string`): Set the `bucket` field on the resulting object. + - `checksum_mode` (`string`): Set the `checksum_mode` field on the resulting object. When `null`, the `checksum_mode` field will be omitted from the resulting object. - `key` (`string`): Set the `key` field on the resulting object. - `range` (`string`): Set the `range` field on the resulting object. When `null`, the `range` field will be omitted from the resulting object. - `tags` (`obj`): Set the `tags` field on the resulting object. When `null`, the `tags` field will be omitted from the resulting object. @@ -104,6 +107,22 @@ Terraform data source block to set or update the bucket field. - `value` (`string`): The value to set for the `bucket` field. +### fn withChecksumMode + +```ts +withChecksumMode() +``` + +`aws.string.withChecksumMode` constructs a mixin object that can be merged into the `string` +Terraform data source block to set or update the checksum_mode field. + + + +**Args**: + - `dataSrcLabel` (`string`): The name label of the block to update. + - `value` (`string`): The value to set for the `checksum_mode` field. + + ### fn withKey ```ts diff --git a/docs/5.x/data/s3_objects.md b/docs/5.x/data/s3_objects.md index 4ee8ddb9..dbff19eb 100644 --- a/docs/5.x/data/s3_objects.md +++ b/docs/5.x/data/s3_objects.md @@ -21,6 +21,7 @@ This package contains functions and utilities for setting up the data source usi * [`fn withFetchOwner()`](#fn-withfetchowner) * [`fn withMaxKeys()`](#fn-withmaxkeys) * [`fn withPrefix()`](#fn-withprefix) +* [`fn withRequestPayer()`](#fn-withrequestpayer) * [`fn withStartAfter()`](#fn-withstartafter) ## Fields @@ -58,6 +59,7 @@ or `$` to refer to the root object. Instead, make an explicit outer object using - `fetch_owner` (`bool`): Set the `fetch_owner` field on the resulting data source block. When `null`, the `fetch_owner` field will be omitted from the resulting object. - `max_keys` (`number`): Set the `max_keys` field on the resulting data source block. When `null`, the `max_keys` field will be omitted from the resulting object. - `prefix` (`string`): Set the `prefix` field on the resulting data source block. When `null`, the `prefix` field will be omitted from the resulting object. + - `request_payer` (`string`): Set the `request_payer` field on the resulting data source block. When `null`, the `request_payer` field will be omitted from the resulting object. - `start_after` (`string`): Set the `start_after` field on the resulting data source block. When `null`, the `start_after` field will be omitted from the resulting object. **Returns**: @@ -88,6 +90,7 @@ injecting into a complete block. - `fetch_owner` (`bool`): Set the `fetch_owner` field on the resulting object. When `null`, the `fetch_owner` field will be omitted from the resulting object. - `max_keys` (`number`): Set the `max_keys` field on the resulting object. When `null`, the `max_keys` field will be omitted from the resulting object. - `prefix` (`string`): Set the `prefix` field on the resulting object. When `null`, the `prefix` field will be omitted from the resulting object. + - `request_payer` (`string`): Set the `request_payer` field on the resulting object. When `null`, the `request_payer` field will be omitted from the resulting object. - `start_after` (`string`): Set the `start_after` field on the resulting object. When `null`, the `start_after` field will be omitted from the resulting object. **Returns**: @@ -190,6 +193,22 @@ Terraform data source block to set or update the prefix field. - `value` (`string`): The value to set for the `prefix` field. +### fn withRequestPayer + +```ts +withRequestPayer() +``` + +`aws.string.withRequestPayer` constructs a mixin object that can be merged into the `string` +Terraform data source block to set or update the request_payer field. + + + +**Args**: + - `dataSrcLabel` (`string`): The name label of the block to update. + - `value` (`string`): The value to set for the `request_payer` field. + + ### fn withStartAfter ```ts diff --git a/docs/5.x/datasync_location_azure_blob.md b/docs/5.x/datasync_location_azure_blob.md new file mode 100644 index 00000000..3caf2c98 --- /dev/null +++ b/docs/5.x/datasync_location_azure_blob.md @@ -0,0 +1,291 @@ +--- +permalink: /datasync_location_azure_blob/ +--- + +# datasync_location_azure_blob + +`datasync_location_azure_blob` represents the `aws_datasync_location_azure_blob` Terraform resource. + + + +This package contains functions and utilities for setting up the resource using Jsonnet code. + + +## Index + +* [`fn new()`](#fn-new) +* [`fn newAttrs()`](#fn-newattrs) +* [`fn withAccessTier()`](#fn-withaccesstier) +* [`fn withAgentArns()`](#fn-withagentarns) +* [`fn withAuthenticationType()`](#fn-withauthenticationtype) +* [`fn withBlobType()`](#fn-withblobtype) +* [`fn withContainerUrl()`](#fn-withcontainerurl) +* [`fn withSasConfiguration()`](#fn-withsasconfiguration) +* [`fn withSasConfigurationMixin()`](#fn-withsasconfigurationmixin) +* [`fn withSubdirectory()`](#fn-withsubdirectory) +* [`fn withTags()`](#fn-withtags) +* [`fn withTagsAll()`](#fn-withtagsall) +* [`obj sas_configuration`](#obj-sas_configuration) + * [`fn new()`](#fn-sas_configurationnew) + +## Fields + +### fn new + +```ts +new() +``` + + +`aws.datasync_location_azure_blob.new` injects a new `aws_datasync_location_azure_blob` Terraform `resource` +block into the root module document. + +Additionally, this inserts a private function into the `_ref` attribute that generates references to attributes of the +resource. For example, if you added a new instance to the root using: + + # arguments omitted for brevity + aws.datasync_location_azure_blob.new('some_id') + +You can get the reference to the `id` field of the created `aws.datasync_location_azure_blob` using the reference: + + $._ref.aws_datasync_location_azure_blob.some_id.get('id') + +This is the same as directly entering `"${ aws_datasync_location_azure_blob.some_id.id }"` as the value. + +NOTE: if you are chaining multiple resources together in a merge operation, you may not be able to use `super`, `self`, +or `$` to refer to the root object. Instead, make an explicit outer object using `local`. + +**Args**: + - `resourceLabel` (`string`): The name label of the block. + - `access_tier` (`string`): Set the `access_tier` field on the resulting resource block. When `null`, the `access_tier` field will be omitted from the resulting object. + - `agent_arns` (`list`): Set the `agent_arns` field on the resulting resource block. + - `authentication_type` (`string`): Set the `authentication_type` field on the resulting resource block. + - `blob_type` (`string`): Set the `blob_type` field on the resulting resource block. When `null`, the `blob_type` field will be omitted from the resulting object. + - `container_url` (`string`): Set the `container_url` field on the resulting resource block. + - `subdirectory` (`string`): Set the `subdirectory` field on the resulting resource block. When `null`, the `subdirectory` field will be omitted from the resulting object. + - `tags` (`obj`): Set the `tags` field on the resulting resource block. When `null`, the `tags` field will be omitted from the resulting object. + - `tags_all` (`obj`): Set the `tags_all` field on the resulting resource block. When `null`, the `tags_all` field will be omitted from the resulting object. + - `sas_configuration` (`list[obj]`): Set the `sas_configuration` field on the resulting resource block. When `null`, the `sas_configuration` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [aws.datasync_location_azure_blob.sas_configuration.new](#fn-sas_configurationnew) constructor. + +**Returns**: +- A mixin object that injects the new resource into the root Terraform configuration. + + +### fn newAttrs + +```ts +newAttrs() +``` + + +`aws.datasync_location_azure_blob.newAttrs` constructs a new object with attributes and blocks configured for the `datasync_location_azure_blob` +Terraform resource. + +Unlike [aws.datasync_location_azure_blob.new](#fn-new), this function will not inject the `resource` +block into the root Terraform document. Instead, this must be passed in as the `attrs` argument for the +[tf.withResource](https://github.com/tf-libsonnet/core/tree/main/docs#fn-withresource) function to build a complete block. + +This is most useful when you need to preprocess the attributes with functions, conditional, or looping logic prior to +injecting into a complete block. + +**Args**: + - `access_tier` (`string`): Set the `access_tier` field on the resulting object. When `null`, the `access_tier` field will be omitted from the resulting object. + - `agent_arns` (`list`): Set the `agent_arns` field on the resulting object. + - `authentication_type` (`string`): Set the `authentication_type` field on the resulting object. + - `blob_type` (`string`): Set the `blob_type` field on the resulting object. When `null`, the `blob_type` field will be omitted from the resulting object. + - `container_url` (`string`): Set the `container_url` field on the resulting object. + - `subdirectory` (`string`): Set the `subdirectory` field on the resulting object. When `null`, the `subdirectory` field will be omitted from the resulting object. + - `tags` (`obj`): Set the `tags` field on the resulting object. When `null`, the `tags` field will be omitted from the resulting object. + - `tags_all` (`obj`): Set the `tags_all` field on the resulting object. When `null`, the `tags_all` field will be omitted from the resulting object. + - `sas_configuration` (`list[obj]`): Set the `sas_configuration` field on the resulting object. When `null`, the `sas_configuration` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [aws.datasync_location_azure_blob.sas_configuration.new](#fn-sas_configurationnew) constructor. + +**Returns**: + - An attribute object that can be used with [tf.withResource](https://github.com/tf-libsonnet/core/tree/main/docs#fn-withresource) to construct a new `datasync_location_azure_blob` resource into the root Terraform configuration. + + +### fn withAccessTier + +```ts +withAccessTier() +``` + +`aws.string.withAccessTier` constructs a mixin object that can be merged into the `string` +Terraform resource block to set or update the access_tier field. + + + +**Args**: + - `resourceLabel` (`string`): The name label of the block to update. + - `value` (`string`): The value to set for the `access_tier` field. + + +### fn withAgentArns + +```ts +withAgentArns() +``` + +`aws.list.withAgentArns` constructs a mixin object that can be merged into the `list` +Terraform resource block to set or update the agent_arns field. + + + +**Args**: + - `resourceLabel` (`string`): The name label of the block to update. + - `value` (`list`): The value to set for the `agent_arns` field. + + +### fn withAuthenticationType + +```ts +withAuthenticationType() +``` + +`aws.string.withAuthenticationType` constructs a mixin object that can be merged into the `string` +Terraform resource block to set or update the authentication_type field. + + + +**Args**: + - `resourceLabel` (`string`): The name label of the block to update. + - `value` (`string`): The value to set for the `authentication_type` field. + + +### fn withBlobType + +```ts +withBlobType() +``` + +`aws.string.withBlobType` constructs a mixin object that can be merged into the `string` +Terraform resource block to set or update the blob_type field. + + + +**Args**: + - `resourceLabel` (`string`): The name label of the block to update. + - `value` (`string`): The value to set for the `blob_type` field. + + +### fn withContainerUrl + +```ts +withContainerUrl() +``` + +`aws.string.withContainerUrl` constructs a mixin object that can be merged into the `string` +Terraform resource block to set or update the container_url field. + + + +**Args**: + - `resourceLabel` (`string`): The name label of the block to update. + - `value` (`string`): The value to set for the `container_url` field. + + +### fn withSasConfiguration + +```ts +withSasConfiguration() +``` + +`aws.list[obj].withSasConfiguration` constructs a mixin object that can be merged into the `list[obj]` +Terraform resource block to set or update the sas_configuration field. + +This function will replace the array with the passed in `value`. If you wish to instead append the +passed in value to the existing array, use the [aws.list[obj].withSasConfigurationMixin](TODO) function. + + +**Args**: + - `resourceLabel` (`string`): The name label of the block to update. + - `value` (`list[obj]`): The value to set for the `sas_configuration` field. + + +### fn withSasConfigurationMixin + +```ts +withSasConfigurationMixin() +``` + +`aws.list[obj].withSasConfigurationMixin` constructs a mixin object that can be merged into the `list[obj]` +Terraform resource block to set or update the sas_configuration field. + +This function will append the passed in array or object to the existing array. If you wish +to instead replace the array with the passed in `value`, use the [aws.list[obj].withSasConfiguration](TODO) +function. + + +**Args**: + - `resourceLabel` (`string`): The name label of the block to update. + - `value` (`list[obj]`): The value to set for the `sas_configuration` field. + + +### fn withSubdirectory + +```ts +withSubdirectory() +``` + +`aws.string.withSubdirectory` constructs a mixin object that can be merged into the `string` +Terraform resource block to set or update the subdirectory field. + + + +**Args**: + - `resourceLabel` (`string`): The name label of the block to update. + - `value` (`string`): The value to set for the `subdirectory` field. + + +### fn withTags + +```ts +withTags() +``` + +`aws.obj.withTags` constructs a mixin object that can be merged into the `obj` +Terraform resource block to set or update the tags field. + + + +**Args**: + - `resourceLabel` (`string`): The name label of the block to update. + - `value` (`obj`): The value to set for the `tags` field. + + +### fn withTagsAll + +```ts +withTagsAll() +``` + +`aws.obj.withTagsAll` constructs a mixin object that can be merged into the `obj` +Terraform resource block to set or update the tags_all field. + + + +**Args**: + - `resourceLabel` (`string`): The name label of the block to update. + - `value` (`obj`): The value to set for the `tags_all` field. + + +## obj sas_configuration + + + +### fn sas_configuration.new + +```ts +new() +``` + + +`aws.datasync_location_azure_blob.sas_configuration.new` constructs a new object with attributes and blocks configured for the `sas_configuration` +Terraform sub block. + + + +**Args**: + - `token` (`string`): Set the `token` field on the resulting object. + +**Returns**: + - An attribute object that represents the `sas_configuration` sub block. diff --git a/docs/5.x/datasync_location_fsx_ontap_file_system.md b/docs/5.x/datasync_location_fsx_ontap_file_system.md new file mode 100644 index 00000000..3a9a2f4f --- /dev/null +++ b/docs/5.x/datasync_location_fsx_ontap_file_system.md @@ -0,0 +1,338 @@ +--- +permalink: /datasync_location_fsx_ontap_file_system/ +--- + +# datasync_location_fsx_ontap_file_system + +`datasync_location_fsx_ontap_file_system` represents the `aws_datasync_location_fsx_ontap_file_system` Terraform resource. + + + +This package contains functions and utilities for setting up the resource using Jsonnet code. + + +## Index + +* [`fn new()`](#fn-new) +* [`fn newAttrs()`](#fn-newattrs) +* [`fn withProtocol()`](#fn-withprotocol) +* [`fn withProtocolMixin()`](#fn-withprotocolmixin) +* [`fn withSecurityGroupArns()`](#fn-withsecuritygrouparns) +* [`fn withStorageVirtualMachineArn()`](#fn-withstoragevirtualmachinearn) +* [`fn withSubdirectory()`](#fn-withsubdirectory) +* [`fn withTags()`](#fn-withtags) +* [`fn withTagsAll()`](#fn-withtagsall) +* [`obj protocol`](#obj-protocol) + * [`fn new()`](#fn-protocolnew) + * [`obj protocol.nfs`](#obj-protocolnfs) + * [`fn new()`](#fn-protocolnfsnew) + * [`obj protocol.nfs.mount_options`](#obj-protocolnfsmount_options) + * [`fn new()`](#fn-protocolnfsmount_optionsnew) + * [`obj protocol.smb`](#obj-protocolsmb) + * [`fn new()`](#fn-protocolsmbnew) + * [`obj protocol.smb.mount_options`](#obj-protocolsmbmount_options) + * [`fn new()`](#fn-protocolsmbmount_optionsnew) + +## Fields + +### fn new + +```ts +new() +``` + + +`aws.datasync_location_fsx_ontap_file_system.new` injects a new `aws_datasync_location_fsx_ontap_file_system` Terraform `resource` +block into the root module document. + +Additionally, this inserts a private function into the `_ref` attribute that generates references to attributes of the +resource. For example, if you added a new instance to the root using: + + # arguments omitted for brevity + aws.datasync_location_fsx_ontap_file_system.new('some_id') + +You can get the reference to the `id` field of the created `aws.datasync_location_fsx_ontap_file_system` using the reference: + + $._ref.aws_datasync_location_fsx_ontap_file_system.some_id.get('id') + +This is the same as directly entering `"${ aws_datasync_location_fsx_ontap_file_system.some_id.id }"` as the value. + +NOTE: if you are chaining multiple resources together in a merge operation, you may not be able to use `super`, `self`, +or `$` to refer to the root object. Instead, make an explicit outer object using `local`. + +**Args**: + - `resourceLabel` (`string`): The name label of the block. + - `security_group_arns` (`list`): Set the `security_group_arns` field on the resulting resource block. + - `storage_virtual_machine_arn` (`string`): Set the `storage_virtual_machine_arn` field on the resulting resource block. + - `subdirectory` (`string`): Set the `subdirectory` field on the resulting resource block. When `null`, the `subdirectory` field will be omitted from the resulting object. + - `tags` (`obj`): Set the `tags` field on the resulting resource block. When `null`, the `tags` field will be omitted from the resulting object. + - `tags_all` (`obj`): Set the `tags_all` field on the resulting resource block. When `null`, the `tags_all` field will be omitted from the resulting object. + - `protocol` (`list[obj]`): Set the `protocol` field on the resulting resource block. When `null`, the `protocol` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [aws.datasync_location_fsx_ontap_file_system.protocol.new](#fn-protocolnew) constructor. + +**Returns**: +- A mixin object that injects the new resource into the root Terraform configuration. + + +### fn newAttrs + +```ts +newAttrs() +``` + + +`aws.datasync_location_fsx_ontap_file_system.newAttrs` constructs a new object with attributes and blocks configured for the `datasync_location_fsx_ontap_file_system` +Terraform resource. + +Unlike [aws.datasync_location_fsx_ontap_file_system.new](#fn-new), this function will not inject the `resource` +block into the root Terraform document. Instead, this must be passed in as the `attrs` argument for the +[tf.withResource](https://github.com/tf-libsonnet/core/tree/main/docs#fn-withresource) function to build a complete block. + +This is most useful when you need to preprocess the attributes with functions, conditional, or looping logic prior to +injecting into a complete block. + +**Args**: + - `security_group_arns` (`list`): Set the `security_group_arns` field on the resulting object. + - `storage_virtual_machine_arn` (`string`): Set the `storage_virtual_machine_arn` field on the resulting object. + - `subdirectory` (`string`): Set the `subdirectory` field on the resulting object. When `null`, the `subdirectory` field will be omitted from the resulting object. + - `tags` (`obj`): Set the `tags` field on the resulting object. When `null`, the `tags` field will be omitted from the resulting object. + - `tags_all` (`obj`): Set the `tags_all` field on the resulting object. When `null`, the `tags_all` field will be omitted from the resulting object. + - `protocol` (`list[obj]`): Set the `protocol` field on the resulting object. When `null`, the `protocol` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [aws.datasync_location_fsx_ontap_file_system.protocol.new](#fn-protocolnew) constructor. + +**Returns**: + - An attribute object that can be used with [tf.withResource](https://github.com/tf-libsonnet/core/tree/main/docs#fn-withresource) to construct a new `datasync_location_fsx_ontap_file_system` resource into the root Terraform configuration. + + +### fn withProtocol + +```ts +withProtocol() +``` + +`aws.list[obj].withProtocol` constructs a mixin object that can be merged into the `list[obj]` +Terraform resource block to set or update the protocol field. + +This function will replace the array with the passed in `value`. If you wish to instead append the +passed in value to the existing array, use the [aws.list[obj].withProtocolMixin](TODO) function. + + +**Args**: + - `resourceLabel` (`string`): The name label of the block to update. + - `value` (`list[obj]`): The value to set for the `protocol` field. + + +### fn withProtocolMixin + +```ts +withProtocolMixin() +``` + +`aws.list[obj].withProtocolMixin` constructs a mixin object that can be merged into the `list[obj]` +Terraform resource block to set or update the protocol field. + +This function will append the passed in array or object to the existing array. If you wish +to instead replace the array with the passed in `value`, use the [aws.list[obj].withProtocol](TODO) +function. + + +**Args**: + - `resourceLabel` (`string`): The name label of the block to update. + - `value` (`list[obj]`): The value to set for the `protocol` field. + + +### fn withSecurityGroupArns + +```ts +withSecurityGroupArns() +``` + +`aws.list.withSecurityGroupArns` constructs a mixin object that can be merged into the `list` +Terraform resource block to set or update the security_group_arns field. + + + +**Args**: + - `resourceLabel` (`string`): The name label of the block to update. + - `value` (`list`): The value to set for the `security_group_arns` field. + + +### fn withStorageVirtualMachineArn + +```ts +withStorageVirtualMachineArn() +``` + +`aws.string.withStorageVirtualMachineArn` constructs a mixin object that can be merged into the `string` +Terraform resource block to set or update the storage_virtual_machine_arn field. + + + +**Args**: + - `resourceLabel` (`string`): The name label of the block to update. + - `value` (`string`): The value to set for the `storage_virtual_machine_arn` field. + + +### fn withSubdirectory + +```ts +withSubdirectory() +``` + +`aws.string.withSubdirectory` constructs a mixin object that can be merged into the `string` +Terraform resource block to set or update the subdirectory field. + + + +**Args**: + - `resourceLabel` (`string`): The name label of the block to update. + - `value` (`string`): The value to set for the `subdirectory` field. + + +### fn withTags + +```ts +withTags() +``` + +`aws.obj.withTags` constructs a mixin object that can be merged into the `obj` +Terraform resource block to set or update the tags field. + + + +**Args**: + - `resourceLabel` (`string`): The name label of the block to update. + - `value` (`obj`): The value to set for the `tags` field. + + +### fn withTagsAll + +```ts +withTagsAll() +``` + +`aws.obj.withTagsAll` constructs a mixin object that can be merged into the `obj` +Terraform resource block to set or update the tags_all field. + + + +**Args**: + - `resourceLabel` (`string`): The name label of the block to update. + - `value` (`obj`): The value to set for the `tags_all` field. + + +## obj protocol + + + +### fn protocol.new + +```ts +new() +``` + + +`aws.datasync_location_fsx_ontap_file_system.protocol.new` constructs a new object with attributes and blocks configured for the `protocol` +Terraform sub block. + + + +**Args**: + - `nfs` (`list[obj]`): Set the `nfs` field on the resulting object. When `null`, the `nfs` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [aws.datasync_location_fsx_ontap_file_system.protocol.nfs.new](#fn-protocolnfsnew) constructor. + - `smb` (`list[obj]`): Set the `smb` field on the resulting object. When `null`, the `smb` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [aws.datasync_location_fsx_ontap_file_system.protocol.smb.new](#fn-protocolsmbnew) constructor. + +**Returns**: + - An attribute object that represents the `protocol` sub block. + + +## obj protocol.nfs + + + +### fn protocol.nfs.new + +```ts +new() +``` + + +`aws.datasync_location_fsx_ontap_file_system.protocol.nfs.new` constructs a new object with attributes and blocks configured for the `nfs` +Terraform sub block. + + + +**Args**: + - `mount_options` (`list[obj]`): Set the `mount_options` field on the resulting object. When `null`, the `mount_options` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [aws.datasync_location_fsx_ontap_file_system.protocol.nfs.mount_options.new](#fn-protocolprotocolmount_optionsnew) constructor. + +**Returns**: + - An attribute object that represents the `nfs` sub block. + + +## obj protocol.nfs.mount_options + + + +### fn protocol.nfs.mount_options.new + +```ts +new() +``` + + +`aws.datasync_location_fsx_ontap_file_system.protocol.nfs.mount_options.new` constructs a new object with attributes and blocks configured for the `mount_options` +Terraform sub block. + + + +**Args**: + - `version` (`string`): Set the `version` field on the resulting object. When `null`, the `version` field will be omitted from the resulting object. + +**Returns**: + - An attribute object that represents the `mount_options` sub block. + + +## obj protocol.smb + + + +### fn protocol.smb.new + +```ts +new() +``` + + +`aws.datasync_location_fsx_ontap_file_system.protocol.smb.new` constructs a new object with attributes and blocks configured for the `smb` +Terraform sub block. + + + +**Args**: + - `domain` (`string`): Set the `domain` field on the resulting object. When `null`, the `domain` field will be omitted from the resulting object. + - `password` (`string`): Set the `password` field on the resulting object. + - `user` (`string`): Set the `user` field on the resulting object. + - `mount_options` (`list[obj]`): Set the `mount_options` field on the resulting object. When `null`, the `mount_options` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [aws.datasync_location_fsx_ontap_file_system.protocol.smb.mount_options.new](#fn-protocolprotocolmount_optionsnew) constructor. + +**Returns**: + - An attribute object that represents the `smb` sub block. + + +## obj protocol.smb.mount_options + + + +### fn protocol.smb.mount_options.new + +```ts +new() +``` + + +`aws.datasync_location_fsx_ontap_file_system.protocol.smb.mount_options.new` constructs a new object with attributes and blocks configured for the `mount_options` +Terraform sub block. + + + +**Args**: + - `version` (`string`): Set the `version` field on the resulting object. When `null`, the `version` field will be omitted from the resulting object. + +**Returns**: + - An attribute object that represents the `mount_options` sub block. diff --git a/docs/5.x/dms_replication_instance.md b/docs/5.x/dms_replication_instance.md index 256b1542..23a06389 100644 --- a/docs/5.x/dms_replication_instance.md +++ b/docs/5.x/dms_replication_instance.md @@ -23,6 +23,7 @@ This package contains functions and utilities for setting up the resource using * [`fn withEngineVersion()`](#fn-withengineversion) * [`fn withKmsKeyArn()`](#fn-withkmskeyarn) * [`fn withMultiAz()`](#fn-withmultiaz) +* [`fn withNetworkType()`](#fn-withnetworktype) * [`fn withPreferredMaintenanceWindow()`](#fn-withpreferredmaintenancewindow) * [`fn withPubliclyAccessible()`](#fn-withpubliclyaccessible) * [`fn withReplicationInstanceClass()`](#fn-withreplicationinstanceclass) @@ -73,6 +74,7 @@ or `$` to refer to the root object. Instead, make an explicit outer object using - `engine_version` (`string`): Set the `engine_version` field on the resulting resource block. When `null`, the `engine_version` field will be omitted from the resulting object. - `kms_key_arn` (`string`): Set the `kms_key_arn` field on the resulting resource block. When `null`, the `kms_key_arn` field will be omitted from the resulting object. - `multi_az` (`bool`): Set the `multi_az` field on the resulting resource block. When `null`, the `multi_az` field will be omitted from the resulting object. + - `network_type` (`string`): Set the `network_type` field on the resulting resource block. When `null`, the `network_type` field will be omitted from the resulting object. - `preferred_maintenance_window` (`string`): Set the `preferred_maintenance_window` field on the resulting resource block. When `null`, the `preferred_maintenance_window` field will be omitted from the resulting object. - `publicly_accessible` (`bool`): Set the `publicly_accessible` field on the resulting resource block. When `null`, the `publicly_accessible` field will be omitted from the resulting object. - `replication_instance_class` (`string`): Set the `replication_instance_class` field on the resulting resource block. @@ -113,6 +115,7 @@ injecting into a complete block. - `engine_version` (`string`): Set the `engine_version` field on the resulting object. When `null`, the `engine_version` field will be omitted from the resulting object. - `kms_key_arn` (`string`): Set the `kms_key_arn` field on the resulting object. When `null`, the `kms_key_arn` field will be omitted from the resulting object. - `multi_az` (`bool`): Set the `multi_az` field on the resulting object. When `null`, the `multi_az` field will be omitted from the resulting object. + - `network_type` (`string`): Set the `network_type` field on the resulting object. When `null`, the `network_type` field will be omitted from the resulting object. - `preferred_maintenance_window` (`string`): Set the `preferred_maintenance_window` field on the resulting object. When `null`, the `preferred_maintenance_window` field will be omitted from the resulting object. - `publicly_accessible` (`bool`): Set the `publicly_accessible` field on the resulting object. When `null`, the `publicly_accessible` field will be omitted from the resulting object. - `replication_instance_class` (`string`): Set the `replication_instance_class` field on the resulting object. @@ -255,6 +258,22 @@ Terraform resource block to set or update the multi_az field. - `value` (`bool`): The value to set for the `multi_az` field. +### fn withNetworkType + +```ts +withNetworkType() +``` + +`aws.string.withNetworkType` constructs a mixin object that can be merged into the `string` +Terraform resource block to set or update the network_type field. + + + +**Args**: + - `resourceLabel` (`string`): The name label of the block to update. + - `value` (`string`): The value to set for the `network_type` field. + + ### fn withPreferredMaintenanceWindow ```ts diff --git a/docs/5.x/dms_replication_subnet_group.md b/docs/5.x/dms_replication_subnet_group.md index 06673018..ad313e85 100644 --- a/docs/5.x/dms_replication_subnet_group.md +++ b/docs/5.x/dms_replication_subnet_group.md @@ -20,10 +20,6 @@ This package contains functions and utilities for setting up the resource using * [`fn withSubnetIds()`](#fn-withsubnetids) * [`fn withTags()`](#fn-withtags) * [`fn withTagsAll()`](#fn-withtagsall) -* [`fn withTimeouts()`](#fn-withtimeouts) -* [`fn withTimeoutsMixin()`](#fn-withtimeoutsmixin) -* [`obj timeouts`](#obj-timeouts) - * [`fn new()`](#fn-timeoutsnew) ## Fields @@ -59,7 +55,6 @@ or `$` to refer to the root object. Instead, make an explicit outer object using - `subnet_ids` (`list`): Set the `subnet_ids` field on the resulting resource block. - `tags` (`obj`): Set the `tags` field on the resulting resource block. When `null`, the `tags` field will be omitted from the resulting object. - `tags_all` (`obj`): Set the `tags_all` field on the resulting resource block. When `null`, the `tags_all` field will be omitted from the resulting object. - - `timeouts` (`obj`): Set the `timeouts` field on the resulting resource block. When `null`, the `timeouts` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [aws.dms_replication_subnet_group.timeouts.new](#fn-timeoutsnew) constructor. **Returns**: - A mixin object that injects the new resource into the root Terraform configuration. @@ -88,7 +83,6 @@ injecting into a complete block. - `subnet_ids` (`list`): Set the `subnet_ids` field on the resulting object. - `tags` (`obj`): Set the `tags` field on the resulting object. When `null`, the `tags` field will be omitted from the resulting object. - `tags_all` (`obj`): Set the `tags_all` field on the resulting object. When `null`, the `tags_all` field will be omitted from the resulting object. - - `timeouts` (`obj`): Set the `timeouts` field on the resulting object. When `null`, the `timeouts` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [aws.dms_replication_subnet_group.timeouts.new](#fn-timeoutsnew) constructor. **Returns**: - An attribute object that can be used with [tf.withResource](https://github.com/tf-libsonnet/core/tree/main/docs#fn-withresource) to construct a new `dms_replication_subnet_group` resource into the root Terraform configuration. @@ -172,64 +166,3 @@ Terraform resource block to set or update the tags_all field. **Args**: - `resourceLabel` (`string`): The name label of the block to update. - `value` (`obj`): The value to set for the `tags_all` field. - - -### fn withTimeouts - -```ts -withTimeouts() -``` - -`aws.obj.withTimeouts` constructs a mixin object that can be merged into the `obj` -Terraform resource block to set or update the timeouts field. - -This function will replace the map with the passed in `value`. If you wish to instead merge the -passed in value to the existing map, use the [aws.obj.withTimeoutsMixin](TODO) function. - -**Args**: - - `resourceLabel` (`string`): The name label of the block to update. - - `value` (`obj`): The value to set for the `timeouts` field. - - -### fn withTimeoutsMixin - -```ts -withTimeoutsMixin() -``` - -`aws.obj.withTimeoutsMixin` constructs a mixin object that can be merged into the `obj` -Terraform resource block to set or update the timeouts field. - -This function will merge the passed in value to the existing map. If you wish -to instead replace the entire map with the passed in `value`, use the [aws.obj.withTimeouts](TODO) -function. - - -**Args**: - - `resourceLabel` (`string`): The name label of the block to update. - - `value` (`obj`): The value to set for the `timeouts` field. - - -## obj timeouts - - - -### fn timeouts.new - -```ts -new() -``` - - -`aws.dms_replication_subnet_group.timeouts.new` constructs a new object with attributes and blocks configured for the `timeouts` -Terraform sub block. - - - -**Args**: - - `create` (`string`): Set the `create` field on the resulting object. When `null`, the `create` field will be omitted from the resulting object. - - `delete` (`string`): Set the `delete` field on the resulting object. When `null`, the `delete` field will be omitted from the resulting object. - - `update` (`string`): Set the `update` field on the resulting object. When `null`, the `update` field will be omitted from the resulting object. - -**Returns**: - - An attribute object that represents the `timeouts` sub block. diff --git a/docs/5.x/elasticache_cluster.md b/docs/5.x/elasticache_cluster.md index 819e7f7e..bf44f78a 100644 --- a/docs/5.x/elasticache_cluster.md +++ b/docs/5.x/elasticache_cluster.md @@ -45,6 +45,7 @@ This package contains functions and utilities for setting up the resource using * [`fn withSubnetGroupName()`](#fn-withsubnetgroupname) * [`fn withTags()`](#fn-withtags) * [`fn withTagsAll()`](#fn-withtagsall) +* [`fn withTransitEncryptionEnabled()`](#fn-withtransitencryptionenabled) * [`obj log_delivery_configuration`](#obj-log_delivery_configuration) * [`fn new()`](#fn-log_delivery_configurationnew) @@ -105,6 +106,7 @@ or `$` to refer to the root object. Instead, make an explicit outer object using - `subnet_group_name` (`string`): Set the `subnet_group_name` field on the resulting resource block. When `null`, the `subnet_group_name` field will be omitted from the resulting object. - `tags` (`obj`): Set the `tags` field on the resulting resource block. When `null`, the `tags` field will be omitted from the resulting object. - `tags_all` (`obj`): Set the `tags_all` field on the resulting resource block. When `null`, the `tags_all` field will be omitted from the resulting object. + - `transit_encryption_enabled` (`bool`): Set the `transit_encryption_enabled` field on the resulting resource block. When `null`, the `transit_encryption_enabled` field will be omitted from the resulting object. - `log_delivery_configuration` (`list[obj]`): Set the `log_delivery_configuration` field on the resulting resource block. When `null`, the `log_delivery_configuration` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [aws.elasticache_cluster.log_delivery_configuration.new](#fn-log_delivery_configurationnew) constructor. **Returns**: @@ -157,6 +159,7 @@ injecting into a complete block. - `subnet_group_name` (`string`): Set the `subnet_group_name` field on the resulting object. When `null`, the `subnet_group_name` field will be omitted from the resulting object. - `tags` (`obj`): Set the `tags` field on the resulting object. When `null`, the `tags` field will be omitted from the resulting object. - `tags_all` (`obj`): Set the `tags_all` field on the resulting object. When `null`, the `tags_all` field will be omitted from the resulting object. + - `transit_encryption_enabled` (`bool`): Set the `transit_encryption_enabled` field on the resulting object. When `null`, the `transit_encryption_enabled` field will be omitted from the resulting object. - `log_delivery_configuration` (`list[obj]`): Set the `log_delivery_configuration` field on the resulting object. When `null`, the `log_delivery_configuration` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [aws.elasticache_cluster.log_delivery_configuration.new](#fn-log_delivery_configurationnew) constructor. **Returns**: @@ -648,6 +651,22 @@ Terraform resource block to set or update the tags_all field. - `value` (`obj`): The value to set for the `tags_all` field. +### fn withTransitEncryptionEnabled + +```ts +withTransitEncryptionEnabled() +``` + +`aws.bool.withTransitEncryptionEnabled` constructs a mixin object that can be merged into the `bool` +Terraform resource block to set or update the transit_encryption_enabled field. + + + +**Args**: + - `resourceLabel` (`string`): The name label of the block to update. + - `value` (`bool`): The value to set for the `transit_encryption_enabled` field. + + ## obj log_delivery_configuration diff --git a/docs/5.x/finspace_kx_environment.md b/docs/5.x/finspace_kx_environment.md index c0a2fd5e..f8e6ae67 100644 --- a/docs/5.x/finspace_kx_environment.md +++ b/docs/5.x/finspace_kx_environment.md @@ -32,6 +32,12 @@ This package contains functions and utilities for setting up the resource using * [`fn new()`](#fn-timeoutsnew) * [`obj transit_gateway_configuration`](#obj-transit_gateway_configuration) * [`fn new()`](#fn-transit_gateway_configurationnew) + * [`obj transit_gateway_configuration.attachment_network_acl_configuration`](#obj-transit_gateway_configurationattachment_network_acl_configuration) + * [`fn new()`](#fn-transit_gateway_configurationattachment_network_acl_configurationnew) + * [`obj transit_gateway_configuration.attachment_network_acl_configuration.icmp_type_code`](#obj-transit_gateway_configurationattachment_network_acl_configurationicmp_type_code) + * [`fn new()`](#fn-transit_gateway_configurationattachment_network_acl_configurationicmp_type_codenew) + * [`obj transit_gateway_configuration.attachment_network_acl_configuration.port_range`](#obj-transit_gateway_configurationattachment_network_acl_configurationport_range) + * [`fn new()`](#fn-transit_gateway_configurationattachment_network_acl_configurationport_rangenew) ## Fields @@ -364,6 +370,83 @@ Terraform sub block. **Args**: - `routable_cidr_space` (`string`): Set the `routable_cidr_space` field on the resulting object. - `transit_gateway_id` (`string`): Set the `transit_gateway_id` field on the resulting object. + - `attachment_network_acl_configuration` (`list[obj]`): Set the `attachment_network_acl_configuration` field on the resulting object. When `null`, the `attachment_network_acl_configuration` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [aws.finspace_kx_environment.transit_gateway_configuration.attachment_network_acl_configuration.new](#fn-transit_gateway_configurationattachment_network_acl_configurationnew) constructor. **Returns**: - An attribute object that represents the `transit_gateway_configuration` sub block. + + +## obj transit_gateway_configuration.attachment_network_acl_configuration + + + +### fn transit_gateway_configuration.attachment_network_acl_configuration.new + +```ts +new() +``` + + +`aws.finspace_kx_environment.transit_gateway_configuration.attachment_network_acl_configuration.new` constructs a new object with attributes and blocks configured for the `attachment_network_acl_configuration` +Terraform sub block. + + + +**Args**: + - `cidr_block` (`string`): Set the `cidr_block` field on the resulting object. + - `protocol` (`string`): Set the `protocol` field on the resulting object. + - `rule_action` (`string`): Set the `rule_action` field on the resulting object. + - `rule_number` (`number`): Set the `rule_number` field on the resulting object. + - `icmp_type_code` (`list[obj]`): Set the `icmp_type_code` field on the resulting object. When `null`, the `icmp_type_code` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [aws.finspace_kx_environment.transit_gateway_configuration.attachment_network_acl_configuration.icmp_type_code.new](#fn-transit_gateway_configurationtransit_gateway_configurationicmp_type_codenew) constructor. + - `port_range` (`list[obj]`): Set the `port_range` field on the resulting object. When `null`, the `port_range` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [aws.finspace_kx_environment.transit_gateway_configuration.attachment_network_acl_configuration.port_range.new](#fn-transit_gateway_configurationtransit_gateway_configurationport_rangenew) constructor. + +**Returns**: + - An attribute object that represents the `attachment_network_acl_configuration` sub block. + + +## obj transit_gateway_configuration.attachment_network_acl_configuration.icmp_type_code + + + +### fn transit_gateway_configuration.attachment_network_acl_configuration.icmp_type_code.new + +```ts +new() +``` + + +`aws.finspace_kx_environment.transit_gateway_configuration.attachment_network_acl_configuration.icmp_type_code.new` constructs a new object with attributes and blocks configured for the `icmp_type_code` +Terraform sub block. + + + +**Args**: + - `code` (`number`): Set the `code` field on the resulting object. + - `type` (`number`): Set the `type` field on the resulting object. + +**Returns**: + - An attribute object that represents the `icmp_type_code` sub block. + + +## obj transit_gateway_configuration.attachment_network_acl_configuration.port_range + + + +### fn transit_gateway_configuration.attachment_network_acl_configuration.port_range.new + +```ts +new() +``` + + +`aws.finspace_kx_environment.transit_gateway_configuration.attachment_network_acl_configuration.port_range.new` constructs a new object with attributes and blocks configured for the `port_range` +Terraform sub block. + + + +**Args**: + - `from` (`number`): Set the `from` field on the resulting object. + - `to` (`number`): Set the `to` field on the resulting object. + +**Returns**: + - An attribute object that represents the `port_range` sub block. diff --git a/docs/5.x/fsx_openzfs_file_system.md b/docs/5.x/fsx_openzfs_file_system.md index 3f778e39..57ff2ae2 100644 --- a/docs/5.x/fsx_openzfs_file_system.md +++ b/docs/5.x/fsx_openzfs_file_system.md @@ -23,9 +23,12 @@ This package contains functions and utilities for setting up the resource using * [`fn withDeploymentType()`](#fn-withdeploymenttype) * [`fn withDiskIopsConfiguration()`](#fn-withdiskiopsconfiguration) * [`fn withDiskIopsConfigurationMixin()`](#fn-withdiskiopsconfigurationmixin) +* [`fn withEndpointIpAddressRange()`](#fn-withendpointipaddressrange) * [`fn withKmsKeyId()`](#fn-withkmskeyid) +* [`fn withPreferredSubnetId()`](#fn-withpreferredsubnetid) * [`fn withRootVolumeConfiguration()`](#fn-withrootvolumeconfiguration) * [`fn withRootVolumeConfigurationMixin()`](#fn-withrootvolumeconfigurationmixin) +* [`fn withRouteTableIds()`](#fn-withroutetableids) * [`fn withSecurityGroupIds()`](#fn-withsecuritygroupids) * [`fn withStorageCapacity()`](#fn-withstoragecapacity) * [`fn withStorageType()`](#fn-withstoragetype) @@ -84,7 +87,10 @@ or `$` to refer to the root object. Instead, make an explicit outer object using - `copy_tags_to_volumes` (`bool`): Set the `copy_tags_to_volumes` field on the resulting resource block. When `null`, the `copy_tags_to_volumes` field will be omitted from the resulting object. - `daily_automatic_backup_start_time` (`string`): Set the `daily_automatic_backup_start_time` field on the resulting resource block. When `null`, the `daily_automatic_backup_start_time` field will be omitted from the resulting object. - `deployment_type` (`string`): Set the `deployment_type` field on the resulting resource block. + - `endpoint_ip_address_range` (`string`): Set the `endpoint_ip_address_range` field on the resulting resource block. When `null`, the `endpoint_ip_address_range` field will be omitted from the resulting object. - `kms_key_id` (`string`): Set the `kms_key_id` field on the resulting resource block. When `null`, the `kms_key_id` field will be omitted from the resulting object. + - `preferred_subnet_id` (`string`): Set the `preferred_subnet_id` field on the resulting resource block. When `null`, the `preferred_subnet_id` field will be omitted from the resulting object. + - `route_table_ids` (`list`): Set the `route_table_ids` field on the resulting resource block. When `null`, the `route_table_ids` field will be omitted from the resulting object. - `security_group_ids` (`list`): Set the `security_group_ids` field on the resulting resource block. When `null`, the `security_group_ids` field will be omitted from the resulting object. - `storage_capacity` (`number`): Set the `storage_capacity` field on the resulting resource block. When `null`, the `storage_capacity` field will be omitted from the resulting object. - `storage_type` (`string`): Set the `storage_type` field on the resulting resource block. When `null`, the `storage_type` field will be omitted from the resulting object. @@ -125,7 +131,10 @@ injecting into a complete block. - `copy_tags_to_volumes` (`bool`): Set the `copy_tags_to_volumes` field on the resulting object. When `null`, the `copy_tags_to_volumes` field will be omitted from the resulting object. - `daily_automatic_backup_start_time` (`string`): Set the `daily_automatic_backup_start_time` field on the resulting object. When `null`, the `daily_automatic_backup_start_time` field will be omitted from the resulting object. - `deployment_type` (`string`): Set the `deployment_type` field on the resulting object. + - `endpoint_ip_address_range` (`string`): Set the `endpoint_ip_address_range` field on the resulting object. When `null`, the `endpoint_ip_address_range` field will be omitted from the resulting object. - `kms_key_id` (`string`): Set the `kms_key_id` field on the resulting object. When `null`, the `kms_key_id` field will be omitted from the resulting object. + - `preferred_subnet_id` (`string`): Set the `preferred_subnet_id` field on the resulting object. When `null`, the `preferred_subnet_id` field will be omitted from the resulting object. + - `route_table_ids` (`list`): Set the `route_table_ids` field on the resulting object. When `null`, the `route_table_ids` field will be omitted from the resulting object. - `security_group_ids` (`list`): Set the `security_group_ids` field on the resulting object. When `null`, the `security_group_ids` field will be omitted from the resulting object. - `storage_capacity` (`number`): Set the `storage_capacity` field on the resulting object. When `null`, the `storage_capacity` field will be omitted from the resulting object. - `storage_type` (`string`): Set the `storage_type` field on the resulting object. When `null`, the `storage_type` field will be omitted from the resulting object. @@ -275,6 +284,22 @@ function. - `value` (`list[obj]`): The value to set for the `disk_iops_configuration` field. +### fn withEndpointIpAddressRange + +```ts +withEndpointIpAddressRange() +``` + +`aws.string.withEndpointIpAddressRange` constructs a mixin object that can be merged into the `string` +Terraform resource block to set or update the endpoint_ip_address_range field. + + + +**Args**: + - `resourceLabel` (`string`): The name label of the block to update. + - `value` (`string`): The value to set for the `endpoint_ip_address_range` field. + + ### fn withKmsKeyId ```ts @@ -291,6 +316,22 @@ Terraform resource block to set or update the kms_key_id field. - `value` (`string`): The value to set for the `kms_key_id` field. +### fn withPreferredSubnetId + +```ts +withPreferredSubnetId() +``` + +`aws.string.withPreferredSubnetId` constructs a mixin object that can be merged into the `string` +Terraform resource block to set or update the preferred_subnet_id field. + + + +**Args**: + - `resourceLabel` (`string`): The name label of the block to update. + - `value` (`string`): The value to set for the `preferred_subnet_id` field. + + ### fn withRootVolumeConfiguration ```ts @@ -328,6 +369,22 @@ function. - `value` (`list[obj]`): The value to set for the `root_volume_configuration` field. +### fn withRouteTableIds + +```ts +withRouteTableIds() +``` + +`aws.list.withRouteTableIds` constructs a mixin object that can be merged into the `list` +Terraform resource block to set or update the route_table_ids field. + + + +**Args**: + - `resourceLabel` (`string`): The name label of the block to update. + - `value` (`list`): The value to set for the `route_table_ids` field. + + ### fn withSecurityGroupIds ```ts diff --git a/docs/5.x/fsx_windows_file_system.md b/docs/5.x/fsx_windows_file_system.md index f994b1e3..f8553d80 100644 --- a/docs/5.x/fsx_windows_file_system.md +++ b/docs/5.x/fsx_windows_file_system.md @@ -24,6 +24,8 @@ This package contains functions and utilities for setting up the resource using * [`fn withCopyTagsToBackups()`](#fn-withcopytagstobackups) * [`fn withDailyAutomaticBackupStartTime()`](#fn-withdailyautomaticbackupstarttime) * [`fn withDeploymentType()`](#fn-withdeploymenttype) +* [`fn withDiskIopsConfiguration()`](#fn-withdiskiopsconfiguration) +* [`fn withDiskIopsConfigurationMixin()`](#fn-withdiskiopsconfigurationmixin) * [`fn withKmsKeyId()`](#fn-withkmskeyid) * [`fn withPreferredSubnetId()`](#fn-withpreferredsubnetid) * [`fn withSecurityGroupIds()`](#fn-withsecuritygroupids) @@ -41,6 +43,8 @@ This package contains functions and utilities for setting up the resource using * [`fn withWeeklyMaintenanceStartTime()`](#fn-withweeklymaintenancestarttime) * [`obj audit_log_configuration`](#obj-audit_log_configuration) * [`fn new()`](#fn-audit_log_configurationnew) +* [`obj disk_iops_configuration`](#obj-disk_iops_configuration) + * [`fn new()`](#fn-disk_iops_configurationnew) * [`obj self_managed_active_directory`](#obj-self_managed_active_directory) * [`fn new()`](#fn-self_managed_active_directorynew) * [`obj timeouts`](#obj-timeouts) @@ -94,6 +98,7 @@ or `$` to refer to the root object. Instead, make an explicit outer object using - `throughput_capacity` (`number`): Set the `throughput_capacity` field on the resulting resource block. - `weekly_maintenance_start_time` (`string`): Set the `weekly_maintenance_start_time` field on the resulting resource block. When `null`, the `weekly_maintenance_start_time` field will be omitted from the resulting object. - `audit_log_configuration` (`list[obj]`): Set the `audit_log_configuration` field on the resulting resource block. When `null`, the `audit_log_configuration` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [aws.fsx_windows_file_system.audit_log_configuration.new](#fn-audit_log_configurationnew) constructor. + - `disk_iops_configuration` (`list[obj]`): Set the `disk_iops_configuration` field on the resulting resource block. When `null`, the `disk_iops_configuration` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [aws.fsx_windows_file_system.disk_iops_configuration.new](#fn-disk_iops_configurationnew) constructor. - `self_managed_active_directory` (`list[obj]`): Set the `self_managed_active_directory` field on the resulting resource block. When `null`, the `self_managed_active_directory` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [aws.fsx_windows_file_system.self_managed_active_directory.new](#fn-self_managed_active_directorynew) constructor. - `timeouts` (`obj`): Set the `timeouts` field on the resulting resource block. When `null`, the `timeouts` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [aws.fsx_windows_file_system.timeouts.new](#fn-timeoutsnew) constructor. @@ -138,6 +143,7 @@ injecting into a complete block. - `throughput_capacity` (`number`): Set the `throughput_capacity` field on the resulting object. - `weekly_maintenance_start_time` (`string`): Set the `weekly_maintenance_start_time` field on the resulting object. When `null`, the `weekly_maintenance_start_time` field will be omitted from the resulting object. - `audit_log_configuration` (`list[obj]`): Set the `audit_log_configuration` field on the resulting object. When `null`, the `audit_log_configuration` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [aws.fsx_windows_file_system.audit_log_configuration.new](#fn-audit_log_configurationnew) constructor. + - `disk_iops_configuration` (`list[obj]`): Set the `disk_iops_configuration` field on the resulting object. When `null`, the `disk_iops_configuration` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [aws.fsx_windows_file_system.disk_iops_configuration.new](#fn-disk_iops_configurationnew) constructor. - `self_managed_active_directory` (`list[obj]`): Set the `self_managed_active_directory` field on the resulting object. When `null`, the `self_managed_active_directory` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [aws.fsx_windows_file_system.self_managed_active_directory.new](#fn-self_managed_active_directorynew) constructor. - `timeouts` (`obj`): Set the `timeouts` field on the resulting object. When `null`, the `timeouts` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [aws.fsx_windows_file_system.timeouts.new](#fn-timeoutsnew) constructor. @@ -294,6 +300,43 @@ Terraform resource block to set or update the deployment_type field. - `value` (`string`): The value to set for the `deployment_type` field. +### fn withDiskIopsConfiguration + +```ts +withDiskIopsConfiguration() +``` + +`aws.list[obj].withDiskIopsConfiguration` constructs a mixin object that can be merged into the `list[obj]` +Terraform resource block to set or update the disk_iops_configuration field. + +This function will replace the array with the passed in `value`. If you wish to instead append the +passed in value to the existing array, use the [aws.list[obj].withDiskIopsConfigurationMixin](TODO) function. + + +**Args**: + - `resourceLabel` (`string`): The name label of the block to update. + - `value` (`list[obj]`): The value to set for the `disk_iops_configuration` field. + + +### fn withDiskIopsConfigurationMixin + +```ts +withDiskIopsConfigurationMixin() +``` + +`aws.list[obj].withDiskIopsConfigurationMixin` constructs a mixin object that can be merged into the `list[obj]` +Terraform resource block to set or update the disk_iops_configuration field. + +This function will append the passed in array or object to the existing array. If you wish +to instead replace the array with the passed in `value`, use the [aws.list[obj].withDiskIopsConfiguration](TODO) +function. + + +**Args**: + - `resourceLabel` (`string`): The name label of the block to update. + - `value` (`list[obj]`): The value to set for the `disk_iops_configuration` field. + + ### fn withKmsKeyId ```ts @@ -568,6 +611,30 @@ Terraform sub block. - An attribute object that represents the `audit_log_configuration` sub block. +## obj disk_iops_configuration + + + +### fn disk_iops_configuration.new + +```ts +new() +``` + + +`aws.fsx_windows_file_system.disk_iops_configuration.new` constructs a new object with attributes and blocks configured for the `disk_iops_configuration` +Terraform sub block. + + + +**Args**: + - `iops` (`number`): Set the `iops` field on the resulting object. When `null`, the `iops` field will be omitted from the resulting object. + - `mode` (`string`): Set the `mode` field on the resulting object. When `null`, the `mode` field will be omitted from the resulting object. + +**Returns**: + - An attribute object that represents the `disk_iops_configuration` sub block. + + ## obj self_managed_active_directory diff --git a/docs/5.x/glue_catalog_table.md b/docs/5.x/glue_catalog_table.md index e9fd118d..7cc52e94 100644 --- a/docs/5.x/glue_catalog_table.md +++ b/docs/5.x/glue_catalog_table.md @@ -19,6 +19,8 @@ This package contains functions and utilities for setting up the resource using * [`fn withDatabaseName()`](#fn-withdatabasename) * [`fn withDescription()`](#fn-withdescription) * [`fn withName()`](#fn-withname) +* [`fn withOpenTableFormatInput()`](#fn-withopentableformatinput) +* [`fn withOpenTableFormatInputMixin()`](#fn-withopentableformatinputmixin) * [`fn withOwner()`](#fn-withowner) * [`fn withParameters()`](#fn-withparameters) * [`fn withPartitionIndex()`](#fn-withpartitionindex) @@ -33,6 +35,10 @@ This package contains functions and utilities for setting up the resource using * [`fn withTargetTableMixin()`](#fn-withtargettablemixin) * [`fn withViewExpandedText()`](#fn-withviewexpandedtext) * [`fn withViewOriginalText()`](#fn-withvieworiginaltext) +* [`obj open_table_format_input`](#obj-open_table_format_input) + * [`fn new()`](#fn-open_table_format_inputnew) + * [`obj open_table_format_input.iceberg_input`](#obj-open_table_format_inputiceberg_input) + * [`fn new()`](#fn-open_table_format_inputiceberg_inputnew) * [`obj partition_index`](#obj-partition_index) * [`fn new()`](#fn-partition_indexnew) * [`obj partition_keys`](#obj-partition_keys) @@ -93,6 +99,7 @@ or `$` to refer to the root object. Instead, make an explicit outer object using - `table_type` (`string`): Set the `table_type` field on the resulting resource block. When `null`, the `table_type` field will be omitted from the resulting object. - `view_expanded_text` (`string`): Set the `view_expanded_text` field on the resulting resource block. When `null`, the `view_expanded_text` field will be omitted from the resulting object. - `view_original_text` (`string`): Set the `view_original_text` field on the resulting resource block. When `null`, the `view_original_text` field will be omitted from the resulting object. + - `open_table_format_input` (`list[obj]`): Set the `open_table_format_input` field on the resulting resource block. When `null`, the `open_table_format_input` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [aws.glue_catalog_table.open_table_format_input.new](#fn-open_table_format_inputnew) constructor. - `partition_index` (`list[obj]`): Set the `partition_index` field on the resulting resource block. When `null`, the `partition_index` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [aws.glue_catalog_table.partition_index.new](#fn-partition_indexnew) constructor. - `partition_keys` (`list[obj]`): Set the `partition_keys` field on the resulting resource block. When `null`, the `partition_keys` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [aws.glue_catalog_table.partition_keys.new](#fn-partition_keysnew) constructor. - `storage_descriptor` (`list[obj]`): Set the `storage_descriptor` field on the resulting resource block. When `null`, the `storage_descriptor` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [aws.glue_catalog_table.storage_descriptor.new](#fn-storage_descriptornew) constructor. @@ -130,6 +137,7 @@ injecting into a complete block. - `table_type` (`string`): Set the `table_type` field on the resulting object. When `null`, the `table_type` field will be omitted from the resulting object. - `view_expanded_text` (`string`): Set the `view_expanded_text` field on the resulting object. When `null`, the `view_expanded_text` field will be omitted from the resulting object. - `view_original_text` (`string`): Set the `view_original_text` field on the resulting object. When `null`, the `view_original_text` field will be omitted from the resulting object. + - `open_table_format_input` (`list[obj]`): Set the `open_table_format_input` field on the resulting object. When `null`, the `open_table_format_input` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [aws.glue_catalog_table.open_table_format_input.new](#fn-open_table_format_inputnew) constructor. - `partition_index` (`list[obj]`): Set the `partition_index` field on the resulting object. When `null`, the `partition_index` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [aws.glue_catalog_table.partition_index.new](#fn-partition_indexnew) constructor. - `partition_keys` (`list[obj]`): Set the `partition_keys` field on the resulting object. When `null`, the `partition_keys` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [aws.glue_catalog_table.partition_keys.new](#fn-partition_keysnew) constructor. - `storage_descriptor` (`list[obj]`): Set the `storage_descriptor` field on the resulting object. When `null`, the `storage_descriptor` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [aws.glue_catalog_table.storage_descriptor.new](#fn-storage_descriptornew) constructor. @@ -203,6 +211,43 @@ Terraform resource block to set or update the name field. - `value` (`string`): The value to set for the `name` field. +### fn withOpenTableFormatInput + +```ts +withOpenTableFormatInput() +``` + +`aws.list[obj].withOpenTableFormatInput` constructs a mixin object that can be merged into the `list[obj]` +Terraform resource block to set or update the open_table_format_input field. + +This function will replace the array with the passed in `value`. If you wish to instead append the +passed in value to the existing array, use the [aws.list[obj].withOpenTableFormatInputMixin](TODO) function. + + +**Args**: + - `resourceLabel` (`string`): The name label of the block to update. + - `value` (`list[obj]`): The value to set for the `open_table_format_input` field. + + +### fn withOpenTableFormatInputMixin + +```ts +withOpenTableFormatInputMixin() +``` + +`aws.list[obj].withOpenTableFormatInputMixin` constructs a mixin object that can be merged into the `list[obj]` +Terraform resource block to set or update the open_table_format_input field. + +This function will append the passed in array or object to the existing array. If you wish +to instead replace the array with the passed in `value`, use the [aws.list[obj].withOpenTableFormatInput](TODO) +function. + + +**Args**: + - `resourceLabel` (`string`): The name label of the block to update. + - `value` (`list[obj]`): The value to set for the `open_table_format_input` field. + + ### fn withOwner ```ts @@ -447,6 +492,53 @@ Terraform resource block to set or update the view_original_text field. - `value` (`string`): The value to set for the `view_original_text` field. +## obj open_table_format_input + + + +### fn open_table_format_input.new + +```ts +new() +``` + + +`aws.glue_catalog_table.open_table_format_input.new` constructs a new object with attributes and blocks configured for the `open_table_format_input` +Terraform sub block. + + + +**Args**: + - `iceberg_input` (`list[obj]`): Set the `iceberg_input` field on the resulting object. When `null`, the `iceberg_input` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [aws.glue_catalog_table.open_table_format_input.iceberg_input.new](#fn-open_table_format_inputiceberg_inputnew) constructor. + +**Returns**: + - An attribute object that represents the `open_table_format_input` sub block. + + +## obj open_table_format_input.iceberg_input + + + +### fn open_table_format_input.iceberg_input.new + +```ts +new() +``` + + +`aws.glue_catalog_table.open_table_format_input.iceberg_input.new` constructs a new object with attributes and blocks configured for the `iceberg_input` +Terraform sub block. + + + +**Args**: + - `metadata_operation` (`string`): Set the `metadata_operation` field on the resulting object. + - `version` (`string`): Set the `version` field on the resulting object. When `null`, the `version` field will be omitted from the resulting object. + +**Returns**: + - An attribute object that represents the `iceberg_input` sub block. + + ## obj partition_index diff --git a/docs/5.x/imagebuilder_image_pipeline.md b/docs/5.x/imagebuilder_image_pipeline.md index 7aee7137..168f9336 100644 --- a/docs/5.x/imagebuilder_image_pipeline.md +++ b/docs/5.x/imagebuilder_image_pipeline.md @@ -20,6 +20,8 @@ This package contains functions and utilities for setting up the resource using * [`fn withDistributionConfigurationArn()`](#fn-withdistributionconfigurationarn) * [`fn withEnhancedImageMetadataEnabled()`](#fn-withenhancedimagemetadataenabled) * [`fn withImageRecipeArn()`](#fn-withimagerecipearn) +* [`fn withImageScanningConfiguration()`](#fn-withimagescanningconfiguration) +* [`fn withImageScanningConfigurationMixin()`](#fn-withimagescanningconfigurationmixin) * [`fn withImageTestsConfiguration()`](#fn-withimagetestsconfiguration) * [`fn withImageTestsConfigurationMixin()`](#fn-withimagetestsconfigurationmixin) * [`fn withInfrastructureConfigurationArn()`](#fn-withinfrastructureconfigurationarn) @@ -29,6 +31,10 @@ This package contains functions and utilities for setting up the resource using * [`fn withStatus()`](#fn-withstatus) * [`fn withTags()`](#fn-withtags) * [`fn withTagsAll()`](#fn-withtagsall) +* [`obj image_scanning_configuration`](#obj-image_scanning_configuration) + * [`fn new()`](#fn-image_scanning_configurationnew) + * [`obj image_scanning_configuration.ecr_configuration`](#obj-image_scanning_configurationecr_configuration) + * [`fn new()`](#fn-image_scanning_configurationecr_configurationnew) * [`obj image_tests_configuration`](#obj-image_tests_configuration) * [`fn new()`](#fn-image_tests_configurationnew) * [`obj schedule`](#obj-schedule) @@ -73,6 +79,7 @@ or `$` to refer to the root object. Instead, make an explicit outer object using - `status` (`string`): Set the `status` field on the resulting resource block. When `null`, the `status` field will be omitted from the resulting object. - `tags` (`obj`): Set the `tags` field on the resulting resource block. When `null`, the `tags` field will be omitted from the resulting object. - `tags_all` (`obj`): Set the `tags_all` field on the resulting resource block. When `null`, the `tags_all` field will be omitted from the resulting object. + - `image_scanning_configuration` (`list[obj]`): Set the `image_scanning_configuration` field on the resulting resource block. When `null`, the `image_scanning_configuration` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [aws.imagebuilder_image_pipeline.image_scanning_configuration.new](#fn-image_scanning_configurationnew) constructor. - `image_tests_configuration` (`list[obj]`): Set the `image_tests_configuration` field on the resulting resource block. When `null`, the `image_tests_configuration` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [aws.imagebuilder_image_pipeline.image_tests_configuration.new](#fn-image_tests_configurationnew) constructor. - `schedule` (`list[obj]`): Set the `schedule` field on the resulting resource block. When `null`, the `schedule` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [aws.imagebuilder_image_pipeline.schedule.new](#fn-schedulenew) constructor. @@ -108,6 +115,7 @@ injecting into a complete block. - `status` (`string`): Set the `status` field on the resulting object. When `null`, the `status` field will be omitted from the resulting object. - `tags` (`obj`): Set the `tags` field on the resulting object. When `null`, the `tags` field will be omitted from the resulting object. - `tags_all` (`obj`): Set the `tags_all` field on the resulting object. When `null`, the `tags_all` field will be omitted from the resulting object. + - `image_scanning_configuration` (`list[obj]`): Set the `image_scanning_configuration` field on the resulting object. When `null`, the `image_scanning_configuration` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [aws.imagebuilder_image_pipeline.image_scanning_configuration.new](#fn-image_scanning_configurationnew) constructor. - `image_tests_configuration` (`list[obj]`): Set the `image_tests_configuration` field on the resulting object. When `null`, the `image_tests_configuration` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [aws.imagebuilder_image_pipeline.image_tests_configuration.new](#fn-image_tests_configurationnew) constructor. - `schedule` (`list[obj]`): Set the `schedule` field on the resulting object. When `null`, the `schedule` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [aws.imagebuilder_image_pipeline.schedule.new](#fn-schedulenew) constructor. @@ -195,6 +203,43 @@ Terraform resource block to set or update the image_recipe_arn field. - `value` (`string`): The value to set for the `image_recipe_arn` field. +### fn withImageScanningConfiguration + +```ts +withImageScanningConfiguration() +``` + +`aws.list[obj].withImageScanningConfiguration` constructs a mixin object that can be merged into the `list[obj]` +Terraform resource block to set or update the image_scanning_configuration field. + +This function will replace the array with the passed in `value`. If you wish to instead append the +passed in value to the existing array, use the [aws.list[obj].withImageScanningConfigurationMixin](TODO) function. + + +**Args**: + - `resourceLabel` (`string`): The name label of the block to update. + - `value` (`list[obj]`): The value to set for the `image_scanning_configuration` field. + + +### fn withImageScanningConfigurationMixin + +```ts +withImageScanningConfigurationMixin() +``` + +`aws.list[obj].withImageScanningConfigurationMixin` constructs a mixin object that can be merged into the `list[obj]` +Terraform resource block to set or update the image_scanning_configuration field. + +This function will append the passed in array or object to the existing array. If you wish +to instead replace the array with the passed in `value`, use the [aws.list[obj].withImageScanningConfiguration](TODO) +function. + + +**Args**: + - `resourceLabel` (`string`): The name label of the block to update. + - `value` (`list[obj]`): The value to set for the `image_scanning_configuration` field. + + ### fn withImageTestsConfiguration ```ts @@ -349,6 +394,54 @@ Terraform resource block to set or update the tags_all field. - `value` (`obj`): The value to set for the `tags_all` field. +## obj image_scanning_configuration + + + +### fn image_scanning_configuration.new + +```ts +new() +``` + + +`aws.imagebuilder_image_pipeline.image_scanning_configuration.new` constructs a new object with attributes and blocks configured for the `image_scanning_configuration` +Terraform sub block. + + + +**Args**: + - `image_scanning_enabled` (`bool`): Set the `image_scanning_enabled` field on the resulting object. When `null`, the `image_scanning_enabled` field will be omitted from the resulting object. + - `ecr_configuration` (`list[obj]`): Set the `ecr_configuration` field on the resulting object. When `null`, the `ecr_configuration` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [aws.imagebuilder_image_pipeline.image_scanning_configuration.ecr_configuration.new](#fn-image_scanning_configurationecr_configurationnew) constructor. + +**Returns**: + - An attribute object that represents the `image_scanning_configuration` sub block. + + +## obj image_scanning_configuration.ecr_configuration + + + +### fn image_scanning_configuration.ecr_configuration.new + +```ts +new() +``` + + +`aws.imagebuilder_image_pipeline.image_scanning_configuration.ecr_configuration.new` constructs a new object with attributes and blocks configured for the `ecr_configuration` +Terraform sub block. + + + +**Args**: + - `container_tags` (`list`): Set the `container_tags` field on the resulting object. When `null`, the `container_tags` field will be omitted from the resulting object. + - `repository_name` (`string`): Set the `repository_name` field on the resulting object. When `null`, the `repository_name` field will be omitted from the resulting object. + +**Returns**: + - An attribute object that represents the `ecr_configuration` sub block. + + ## obj image_tests_configuration diff --git a/docs/5.x/lakeformation_data_lake_settings.md b/docs/5.x/lakeformation_data_lake_settings.md index 675e660b..9070ff2c 100644 --- a/docs/5.x/lakeformation_data_lake_settings.md +++ b/docs/5.x/lakeformation_data_lake_settings.md @@ -24,6 +24,7 @@ This package contains functions and utilities for setting up the resource using * [`fn withCreateTableDefaultPermissions()`](#fn-withcreatetabledefaultpermissions) * [`fn withCreateTableDefaultPermissionsMixin()`](#fn-withcreatetabledefaultpermissionsmixin) * [`fn withExternalDataFilteringAllowList()`](#fn-withexternaldatafilteringallowlist) +* [`fn withReadOnlyAdmins()`](#fn-withreadonlyadmins) * [`fn withTrustedResourceOwners()`](#fn-withtrustedresourceowners) * [`obj create_database_default_permissions`](#obj-create_database_default_permissions) * [`fn new()`](#fn-create_database_default_permissionsnew) @@ -64,6 +65,7 @@ or `$` to refer to the root object. Instead, make an explicit outer object using - `authorized_session_tag_value_list` (`list`): Set the `authorized_session_tag_value_list` field on the resulting resource block. When `null`, the `authorized_session_tag_value_list` field will be omitted from the resulting object. - `catalog_id` (`string`): Set the `catalog_id` field on the resulting resource block. When `null`, the `catalog_id` field will be omitted from the resulting object. - `external_data_filtering_allow_list` (`list`): Set the `external_data_filtering_allow_list` field on the resulting resource block. When `null`, the `external_data_filtering_allow_list` field will be omitted from the resulting object. + - `read_only_admins` (`list`): Set the `read_only_admins` field on the resulting resource block. When `null`, the `read_only_admins` field will be omitted from the resulting object. - `trusted_resource_owners` (`list`): Set the `trusted_resource_owners` field on the resulting resource block. When `null`, the `trusted_resource_owners` field will be omitted from the resulting object. - `create_database_default_permissions` (`list[obj]`): Set the `create_database_default_permissions` field on the resulting resource block. When `null`, the `create_database_default_permissions` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [aws.lakeformation_data_lake_settings.create_database_default_permissions.new](#fn-create_database_default_permissionsnew) constructor. - `create_table_default_permissions` (`list[obj]`): Set the `create_table_default_permissions` field on the resulting resource block. When `null`, the `create_table_default_permissions` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [aws.lakeformation_data_lake_settings.create_table_default_permissions.new](#fn-create_table_default_permissionsnew) constructor. @@ -95,6 +97,7 @@ injecting into a complete block. - `authorized_session_tag_value_list` (`list`): Set the `authorized_session_tag_value_list` field on the resulting object. When `null`, the `authorized_session_tag_value_list` field will be omitted from the resulting object. - `catalog_id` (`string`): Set the `catalog_id` field on the resulting object. When `null`, the `catalog_id` field will be omitted from the resulting object. - `external_data_filtering_allow_list` (`list`): Set the `external_data_filtering_allow_list` field on the resulting object. When `null`, the `external_data_filtering_allow_list` field will be omitted from the resulting object. + - `read_only_admins` (`list`): Set the `read_only_admins` field on the resulting object. When `null`, the `read_only_admins` field will be omitted from the resulting object. - `trusted_resource_owners` (`list`): Set the `trusted_resource_owners` field on the resulting object. When `null`, the `trusted_resource_owners` field will be omitted from the resulting object. - `create_database_default_permissions` (`list[obj]`): Set the `create_database_default_permissions` field on the resulting object. When `null`, the `create_database_default_permissions` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [aws.lakeformation_data_lake_settings.create_database_default_permissions.new](#fn-create_database_default_permissionsnew) constructor. - `create_table_default_permissions` (`list[obj]`): Set the `create_table_default_permissions` field on the resulting object. When `null`, the `create_table_default_permissions` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [aws.lakeformation_data_lake_settings.create_table_default_permissions.new](#fn-create_table_default_permissionsnew) constructor. @@ -257,6 +260,22 @@ Terraform resource block to set or update the external_data_filtering_allow_list - `value` (`list`): The value to set for the `external_data_filtering_allow_list` field. +### fn withReadOnlyAdmins + +```ts +withReadOnlyAdmins() +``` + +`aws.list.withReadOnlyAdmins` constructs a mixin object that can be merged into the `list` +Terraform resource block to set or update the read_only_admins field. + + + +**Args**: + - `resourceLabel` (`string`): The name label of the block to update. + - `value` (`list`): The value to set for the `read_only_admins` field. + + ### fn withTrustedResourceOwners ```ts diff --git a/docs/5.x/medialive_channel.md b/docs/5.x/medialive_channel.md index 8aa70ea4..ce27e3d2 100644 --- a/docs/5.x/medialive_channel.md +++ b/docs/5.x/medialive_channel.md @@ -320,16 +320,20 @@ This package contains functions and utilities for setting up the resource using * [`fn new()`](#fn-input_attachmentsinput_settingsaudio_selectorselector_settingsaudio_pid_selectionnew) * [`obj input_attachments.input_settings.audio_selector.selector_settings.audio_track_selection`](#obj-input_attachmentsinput_settingsaudio_selectorselector_settingsaudio_track_selection) * [`fn new()`](#fn-input_attachmentsinput_settingsaudio_selectorselector_settingsaudio_track_selectionnew) - * [`obj input_attachments.input_settings.audio_selector.selector_settings.audio_track_selection.track`](#obj-input_attachmentsinput_settingsaudio_selectorselector_settingsaudio_track_selectiontrack) - * [`fn new()`](#fn-input_attachmentsinput_settingsaudio_selectorselector_settingsaudio_track_selectiontracknew) + * [`obj input_attachments.input_settings.audio_selector.selector_settings.audio_track_selection.dolby_e_decode`](#obj-input_attachmentsinput_settingsaudio_selectorselector_settingsaudio_track_selectiondolby_e_decode) + * [`fn new()`](#fn-input_attachmentsinput_settingsaudio_selectorselector_settingsaudio_track_selectiondolby_e_decodenew) + * [`obj input_attachments.input_settings.audio_selector.selector_settings.audio_track_selection.tracks`](#obj-input_attachmentsinput_settingsaudio_selectorselector_settingsaudio_track_selectiontracks) + * [`fn new()`](#fn-input_attachmentsinput_settingsaudio_selectorselector_settingsaudio_track_selectiontracksnew) * [`obj input_attachments.input_settings.caption_selector`](#obj-input_attachmentsinput_settingscaption_selector) * [`fn new()`](#fn-input_attachmentsinput_settingscaption_selectornew) * [`obj input_attachments.input_settings.caption_selector.selector_settings`](#obj-input_attachmentsinput_settingscaption_selectorselector_settings) * [`fn new()`](#fn-input_attachmentsinput_settingscaption_selectorselector_settingsnew) * [`obj input_attachments.input_settings.caption_selector.selector_settings.ancillary_source_settings`](#obj-input_attachmentsinput_settingscaption_selectorselector_settingsancillary_source_settings) * [`fn new()`](#fn-input_attachmentsinput_settingscaption_selectorselector_settingsancillary_source_settingsnew) - * [`obj input_attachments.input_settings.caption_selector.selector_settings.dvb_tdt_settings`](#obj-input_attachmentsinput_settingscaption_selectorselector_settingsdvb_tdt_settings) - * [`fn new()`](#fn-input_attachmentsinput_settingscaption_selectorselector_settingsdvb_tdt_settingsnew) + * [`obj input_attachments.input_settings.caption_selector.selector_settings.arib_source_settings`](#obj-input_attachmentsinput_settingscaption_selectorselector_settingsarib_source_settings) + * [`fn new()`](#fn-input_attachmentsinput_settingscaption_selectorselector_settingsarib_source_settingsnew) + * [`obj input_attachments.input_settings.caption_selector.selector_settings.dvb_sub_source_settings`](#obj-input_attachmentsinput_settingscaption_selectorselector_settingsdvb_sub_source_settings) + * [`fn new()`](#fn-input_attachmentsinput_settingscaption_selectorselector_settingsdvb_sub_source_settingsnew) * [`obj input_attachments.input_settings.caption_selector.selector_settings.embedded_source_settings`](#obj-input_attachmentsinput_settingscaption_selectorselector_settingsembedded_source_settings) * [`fn new()`](#fn-input_attachmentsinput_settingscaption_selectorselector_settingsembedded_source_settingsnew) * [`obj input_attachments.input_settings.caption_selector.selector_settings.scte20_source_settings`](#obj-input_attachmentsinput_settingscaption_selectorselector_settingsscte20_source_settings) @@ -4561,24 +4565,48 @@ Terraform sub block. **Args**: - - `track` (`list[obj]`): Set the `track` field on the resulting object. When `null`, the `track` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [aws.medialive_channel.input_attachments.input_settings.audio_selector.selector_settings.audio_track_selection.track.new](#fn-input_attachmentsinput_attachmentsinput_settingsaudio_selectorselector_settingstracknew) constructor. + - `dolby_e_decode` (`list[obj]`): Set the `dolby_e_decode` field on the resulting object. When `null`, the `dolby_e_decode` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [aws.medialive_channel.input_attachments.input_settings.audio_selector.selector_settings.audio_track_selection.dolby_e_decode.new](#fn-input_attachmentsinput_attachmentsinput_settingsaudio_selectorselector_settingsdolby_e_decodenew) constructor. + - `tracks` (`list[obj]`): Set the `tracks` field on the resulting object. When `null`, the `tracks` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [aws.medialive_channel.input_attachments.input_settings.audio_selector.selector_settings.audio_track_selection.tracks.new](#fn-input_attachmentsinput_attachmentsinput_settingsaudio_selectorselector_settingstracksnew) constructor. **Returns**: - An attribute object that represents the `audio_track_selection` sub block. -## obj input_attachments.input_settings.audio_selector.selector_settings.audio_track_selection.track +## obj input_attachments.input_settings.audio_selector.selector_settings.audio_track_selection.dolby_e_decode -### fn input_attachments.input_settings.audio_selector.selector_settings.audio_track_selection.track.new +### fn input_attachments.input_settings.audio_selector.selector_settings.audio_track_selection.dolby_e_decode.new ```ts new() ``` -`aws.medialive_channel.input_attachments.input_settings.audio_selector.selector_settings.audio_track_selection.track.new` constructs a new object with attributes and blocks configured for the `track` +`aws.medialive_channel.input_attachments.input_settings.audio_selector.selector_settings.audio_track_selection.dolby_e_decode.new` constructs a new object with attributes and blocks configured for the `dolby_e_decode` +Terraform sub block. + + + +**Args**: + - `program_selection` (`string`): Set the `program_selection` field on the resulting object. + +**Returns**: + - An attribute object that represents the `dolby_e_decode` sub block. + + +## obj input_attachments.input_settings.audio_selector.selector_settings.audio_track_selection.tracks + + + +### fn input_attachments.input_settings.audio_selector.selector_settings.audio_track_selection.tracks.new + +```ts +new() +``` + + +`aws.medialive_channel.input_attachments.input_settings.audio_selector.selector_settings.audio_track_selection.tracks.new` constructs a new object with attributes and blocks configured for the `tracks` Terraform sub block. @@ -4587,7 +4615,7 @@ Terraform sub block. - `track` (`number`): Set the `track` field on the resulting object. **Returns**: - - An attribute object that represents the `track` sub block. + - An attribute object that represents the `tracks` sub block. ## obj input_attachments.input_settings.caption_selector @@ -4633,7 +4661,8 @@ Terraform sub block. **Args**: - `ancillary_source_settings` (`list[obj]`): Set the `ancillary_source_settings` field on the resulting object. When `null`, the `ancillary_source_settings` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [aws.medialive_channel.input_attachments.input_settings.caption_selector.selector_settings.ancillary_source_settings.new](#fn-input_attachmentsinput_attachmentsinput_settingscaption_selectorancillary_source_settingsnew) constructor. - - `dvb_tdt_settings` (`list[obj]`): Set the `dvb_tdt_settings` field on the resulting object. When `null`, the `dvb_tdt_settings` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [aws.medialive_channel.input_attachments.input_settings.caption_selector.selector_settings.dvb_tdt_settings.new](#fn-input_attachmentsinput_attachmentsinput_settingscaption_selectordvb_tdt_settingsnew) constructor. + - `arib_source_settings` (`list[obj]`): Set the `arib_source_settings` field on the resulting object. When `null`, the `arib_source_settings` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [aws.medialive_channel.input_attachments.input_settings.caption_selector.selector_settings.arib_source_settings.new](#fn-input_attachmentsinput_attachmentsinput_settingscaption_selectorarib_source_settingsnew) constructor. + - `dvb_sub_source_settings` (`list[obj]`): Set the `dvb_sub_source_settings` field on the resulting object. When `null`, the `dvb_sub_source_settings` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [aws.medialive_channel.input_attachments.input_settings.caption_selector.selector_settings.dvb_sub_source_settings.new](#fn-input_attachmentsinput_attachmentsinput_settingscaption_selectordvb_sub_source_settingsnew) constructor. - `embedded_source_settings` (`list[obj]`): Set the `embedded_source_settings` field on the resulting object. When `null`, the `embedded_source_settings` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [aws.medialive_channel.input_attachments.input_settings.caption_selector.selector_settings.embedded_source_settings.new](#fn-input_attachmentsinput_attachmentsinput_settingscaption_selectorembedded_source_settingsnew) constructor. - `scte20_source_settings` (`list[obj]`): Set the `scte20_source_settings` field on the resulting object. When `null`, the `scte20_source_settings` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [aws.medialive_channel.input_attachments.input_settings.caption_selector.selector_settings.scte20_source_settings.new](#fn-input_attachmentsinput_attachmentsinput_settingscaption_selectorscte20_source_settingsnew) constructor. - `scte27_source_settings` (`list[obj]`): Set the `scte27_source_settings` field on the resulting object. When `null`, the `scte27_source_settings` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [aws.medialive_channel.input_attachments.input_settings.caption_selector.selector_settings.scte27_source_settings.new](#fn-input_attachmentsinput_attachmentsinput_settingscaption_selectorscte27_source_settingsnew) constructor. @@ -4666,18 +4695,38 @@ Terraform sub block. - An attribute object that represents the `ancillary_source_settings` sub block. -## obj input_attachments.input_settings.caption_selector.selector_settings.dvb_tdt_settings +## obj input_attachments.input_settings.caption_selector.selector_settings.arib_source_settings -### fn input_attachments.input_settings.caption_selector.selector_settings.dvb_tdt_settings.new +### fn input_attachments.input_settings.caption_selector.selector_settings.arib_source_settings.new ```ts new() ``` -`aws.medialive_channel.input_attachments.input_settings.caption_selector.selector_settings.dvb_tdt_settings.new` constructs a new object with attributes and blocks configured for the `dvb_tdt_settings` +`aws.medialive_channel.input_attachments.input_settings.caption_selector.selector_settings.arib_source_settings.new` constructs a new object with attributes and blocks configured for the `arib_source_settings` +Terraform sub block. + + + +**Returns**: + - An attribute object that represents the `arib_source_settings` sub block. + + +## obj input_attachments.input_settings.caption_selector.selector_settings.dvb_sub_source_settings + + + +### fn input_attachments.input_settings.caption_selector.selector_settings.dvb_sub_source_settings.new + +```ts +new() +``` + + +`aws.medialive_channel.input_attachments.input_settings.caption_selector.selector_settings.dvb_sub_source_settings.new` constructs a new object with attributes and blocks configured for the `dvb_sub_source_settings` Terraform sub block. @@ -4687,7 +4736,7 @@ Terraform sub block. - `pid` (`number`): Set the `pid` field on the resulting object. When `null`, the `pid` field will be omitted from the resulting object. **Returns**: - - An attribute object that represents the `dvb_tdt_settings` sub block. + - An attribute object that represents the `dvb_sub_source_settings` sub block. ## obj input_attachments.input_settings.caption_selector.selector_settings.embedded_source_settings @@ -4710,7 +4759,6 @@ Terraform sub block. - `convert_608_to_708` (`string`): Set the `convert_608_to_708` field on the resulting object. When `null`, the `convert_608_to_708` field will be omitted from the resulting object. - `scte20_detection` (`string`): Set the `scte20_detection` field on the resulting object. When `null`, the `scte20_detection` field will be omitted from the resulting object. - `source_608_channel_number` (`number`): Set the `source_608_channel_number` field on the resulting object. When `null`, the `source_608_channel_number` field will be omitted from the resulting object. - - `source_608_track_number` (`number`): Set the `source_608_track_number` field on the resulting object. When `null`, the `source_608_track_number` field will be omitted from the resulting object. **Returns**: - An attribute object that represents the `embedded_source_settings` sub block. diff --git a/docs/5.x/msk_cluster_policy.md b/docs/5.x/msk_cluster_policy.md new file mode 100644 index 00000000..6369eaf3 --- /dev/null +++ b/docs/5.x/msk_cluster_policy.md @@ -0,0 +1,111 @@ +--- +permalink: /msk_cluster_policy/ +--- + +# msk_cluster_policy + +`msk_cluster_policy` represents the `aws_msk_cluster_policy` Terraform resource. + + + +This package contains functions and utilities for setting up the resource using Jsonnet code. + + +## Index + +* [`fn new()`](#fn-new) +* [`fn newAttrs()`](#fn-newattrs) +* [`fn withClusterArn()`](#fn-withclusterarn) +* [`fn withPolicy()`](#fn-withpolicy) + +## Fields + +### fn new + +```ts +new() +``` + + +`aws.msk_cluster_policy.new` injects a new `aws_msk_cluster_policy` Terraform `resource` +block into the root module document. + +Additionally, this inserts a private function into the `_ref` attribute that generates references to attributes of the +resource. For example, if you added a new instance to the root using: + + # arguments omitted for brevity + aws.msk_cluster_policy.new('some_id') + +You can get the reference to the `id` field of the created `aws.msk_cluster_policy` using the reference: + + $._ref.aws_msk_cluster_policy.some_id.get('id') + +This is the same as directly entering `"${ aws_msk_cluster_policy.some_id.id }"` as the value. + +NOTE: if you are chaining multiple resources together in a merge operation, you may not be able to use `super`, `self`, +or `$` to refer to the root object. Instead, make an explicit outer object using `local`. + +**Args**: + - `resourceLabel` (`string`): The name label of the block. + - `cluster_arn` (`string`): Set the `cluster_arn` field on the resulting resource block. + - `policy` (`string`): Set the `policy` field on the resulting resource block. + +**Returns**: +- A mixin object that injects the new resource into the root Terraform configuration. + + +### fn newAttrs + +```ts +newAttrs() +``` + + +`aws.msk_cluster_policy.newAttrs` constructs a new object with attributes and blocks configured for the `msk_cluster_policy` +Terraform resource. + +Unlike [aws.msk_cluster_policy.new](#fn-new), this function will not inject the `resource` +block into the root Terraform document. Instead, this must be passed in as the `attrs` argument for the +[tf.withResource](https://github.com/tf-libsonnet/core/tree/main/docs#fn-withresource) function to build a complete block. + +This is most useful when you need to preprocess the attributes with functions, conditional, or looping logic prior to +injecting into a complete block. + +**Args**: + - `cluster_arn` (`string`): Set the `cluster_arn` field on the resulting object. + - `policy` (`string`): Set the `policy` field on the resulting object. + +**Returns**: + - An attribute object that can be used with [tf.withResource](https://github.com/tf-libsonnet/core/tree/main/docs#fn-withresource) to construct a new `msk_cluster_policy` resource into the root Terraform configuration. + + +### fn withClusterArn + +```ts +withClusterArn() +``` + +`aws.string.withClusterArn` constructs a mixin object that can be merged into the `string` +Terraform resource block to set or update the cluster_arn field. + + + +**Args**: + - `resourceLabel` (`string`): The name label of the block to update. + - `value` (`string`): The value to set for the `cluster_arn` field. + + +### fn withPolicy + +```ts +withPolicy() +``` + +`aws.string.withPolicy` constructs a mixin object that can be merged into the `string` +Terraform resource block to set or update the policy field. + + + +**Args**: + - `resourceLabel` (`string`): The name label of the block to update. + - `value` (`string`): The value to set for the `policy` field. diff --git a/docs/5.x/opensearch_domain.md b/docs/5.x/opensearch_domain.md index 1f1c5489..89563f30 100644 --- a/docs/5.x/opensearch_domain.md +++ b/docs/5.x/opensearch_domain.md @@ -41,6 +41,8 @@ This package contains functions and utilities for setting up the resource using * [`fn withOffPeakWindowOptionsMixin()`](#fn-withoffpeakwindowoptionsmixin) * [`fn withSnapshotOptions()`](#fn-withsnapshotoptions) * [`fn withSnapshotOptionsMixin()`](#fn-withsnapshotoptionsmixin) +* [`fn withSoftwareUpdateOptions()`](#fn-withsoftwareupdateoptions) +* [`fn withSoftwareUpdateOptionsMixin()`](#fn-withsoftwareupdateoptionsmixin) * [`fn withTags()`](#fn-withtags) * [`fn withTagsAll()`](#fn-withtagsall) * [`fn withTimeouts()`](#fn-withtimeouts) @@ -83,6 +85,8 @@ This package contains functions and utilities for setting up the resource using * [`fn new()`](#fn-off_peak_window_optionsoff_peak_windowwindow_start_timenew) * [`obj snapshot_options`](#obj-snapshot_options) * [`fn new()`](#fn-snapshot_optionsnew) +* [`obj software_update_options`](#obj-software_update_options) + * [`fn new()`](#fn-software_update_optionsnew) * [`obj timeouts`](#obj-timeouts) * [`fn new()`](#fn-timeoutsnew) * [`obj vpc_options`](#obj-vpc_options) @@ -134,6 +138,7 @@ or `$` to refer to the root object. Instead, make an explicit outer object using - `node_to_node_encryption` (`list[obj]`): Set the `node_to_node_encryption` field on the resulting resource block. When `null`, the `node_to_node_encryption` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [aws.opensearch_domain.node_to_node_encryption.new](#fn-node_to_node_encryptionnew) constructor. - `off_peak_window_options` (`list[obj]`): Set the `off_peak_window_options` field on the resulting resource block. When `null`, the `off_peak_window_options` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [aws.opensearch_domain.off_peak_window_options.new](#fn-off_peak_window_optionsnew) constructor. - `snapshot_options` (`list[obj]`): Set the `snapshot_options` field on the resulting resource block. When `null`, the `snapshot_options` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [aws.opensearch_domain.snapshot_options.new](#fn-snapshot_optionsnew) constructor. + - `software_update_options` (`list[obj]`): Set the `software_update_options` field on the resulting resource block. When `null`, the `software_update_options` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [aws.opensearch_domain.software_update_options.new](#fn-software_update_optionsnew) constructor. - `timeouts` (`obj`): Set the `timeouts` field on the resulting resource block. When `null`, the `timeouts` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [aws.opensearch_domain.timeouts.new](#fn-timeoutsnew) constructor. - `vpc_options` (`list[obj]`): Set the `vpc_options` field on the resulting resource block. When `null`, the `vpc_options` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [aws.opensearch_domain.vpc_options.new](#fn-vpc_optionsnew) constructor. @@ -176,6 +181,7 @@ injecting into a complete block. - `node_to_node_encryption` (`list[obj]`): Set the `node_to_node_encryption` field on the resulting object. When `null`, the `node_to_node_encryption` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [aws.opensearch_domain.node_to_node_encryption.new](#fn-node_to_node_encryptionnew) constructor. - `off_peak_window_options` (`list[obj]`): Set the `off_peak_window_options` field on the resulting object. When `null`, the `off_peak_window_options` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [aws.opensearch_domain.off_peak_window_options.new](#fn-off_peak_window_optionsnew) constructor. - `snapshot_options` (`list[obj]`): Set the `snapshot_options` field on the resulting object. When `null`, the `snapshot_options` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [aws.opensearch_domain.snapshot_options.new](#fn-snapshot_optionsnew) constructor. + - `software_update_options` (`list[obj]`): Set the `software_update_options` field on the resulting object. When `null`, the `software_update_options` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [aws.opensearch_domain.software_update_options.new](#fn-software_update_optionsnew) constructor. - `timeouts` (`obj`): Set the `timeouts` field on the resulting object. When `null`, the `timeouts` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [aws.opensearch_domain.timeouts.new](#fn-timeoutsnew) constructor. - `vpc_options` (`list[obj]`): Set the `vpc_options` field on the resulting object. When `null`, the `vpc_options` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [aws.opensearch_domain.vpc_options.new](#fn-vpc_optionsnew) constructor. @@ -654,6 +660,43 @@ function. - `value` (`list[obj]`): The value to set for the `snapshot_options` field. +### fn withSoftwareUpdateOptions + +```ts +withSoftwareUpdateOptions() +``` + +`aws.list[obj].withSoftwareUpdateOptions` constructs a mixin object that can be merged into the `list[obj]` +Terraform resource block to set or update the software_update_options field. + +This function will replace the array with the passed in `value`. If you wish to instead append the +passed in value to the existing array, use the [aws.list[obj].withSoftwareUpdateOptionsMixin](TODO) function. + + +**Args**: + - `resourceLabel` (`string`): The name label of the block to update. + - `value` (`list[obj]`): The value to set for the `software_update_options` field. + + +### fn withSoftwareUpdateOptionsMixin + +```ts +withSoftwareUpdateOptionsMixin() +``` + +`aws.list[obj].withSoftwareUpdateOptionsMixin` constructs a mixin object that can be merged into the `list[obj]` +Terraform resource block to set or update the software_update_options field. + +This function will append the passed in array or object to the existing array. If you wish +to instead replace the array with the passed in `value`, use the [aws.list[obj].withSoftwareUpdateOptions](TODO) +function. + + +**Args**: + - `resourceLabel` (`string`): The name label of the block to update. + - `value` (`list[obj]`): The value to set for the `software_update_options` field. + + ### fn withTags ```ts @@ -906,6 +949,7 @@ Terraform sub block. - `dedicated_master_type` (`string`): Set the `dedicated_master_type` field on the resulting object. When `null`, the `dedicated_master_type` field will be omitted from the resulting object. - `instance_count` (`number`): Set the `instance_count` field on the resulting object. When `null`, the `instance_count` field will be omitted from the resulting object. - `instance_type` (`string`): Set the `instance_type` field on the resulting object. When `null`, the `instance_type` field will be omitted from the resulting object. + - `multi_az_with_standby_enabled` (`bool`): Set the `multi_az_with_standby_enabled` field on the resulting object. When `null`, the `multi_az_with_standby_enabled` field will be omitted from the resulting object. - `warm_count` (`number`): Set the `warm_count` field on the resulting object. When `null`, the `warm_count` field will be omitted from the resulting object. - `warm_enabled` (`bool`): Set the `warm_enabled` field on the resulting object. When `null`, the `warm_enabled` field will be omitted from the resulting object. - `warm_type` (`string`): Set the `warm_type` field on the resulting object. When `null`, the `warm_type` field will be omitted from the resulting object. @@ -1209,6 +1253,29 @@ Terraform sub block. - An attribute object that represents the `snapshot_options` sub block. +## obj software_update_options + + + +### fn software_update_options.new + +```ts +new() +``` + + +`aws.opensearch_domain.software_update_options.new` constructs a new object with attributes and blocks configured for the `software_update_options` +Terraform sub block. + + + +**Args**: + - `auto_software_update_enabled` (`bool`): Set the `auto_software_update_enabled` field on the resulting object. When `null`, the `auto_software_update_enabled` field will be omitted from the resulting object. + +**Returns**: + - An attribute object that represents the `software_update_options` sub block. + + ## obj timeouts diff --git a/docs/5.x/opensearch_vpc_endpoint.md b/docs/5.x/opensearch_vpc_endpoint.md new file mode 100644 index 00000000..4d7e8f94 --- /dev/null +++ b/docs/5.x/opensearch_vpc_endpoint.md @@ -0,0 +1,226 @@ +--- +permalink: /opensearch_vpc_endpoint/ +--- + +# opensearch_vpc_endpoint + +`opensearch_vpc_endpoint` represents the `aws_opensearch_vpc_endpoint` Terraform resource. + + + +This package contains functions and utilities for setting up the resource using Jsonnet code. + + +## Index + +* [`fn new()`](#fn-new) +* [`fn newAttrs()`](#fn-newattrs) +* [`fn withDomainArn()`](#fn-withdomainarn) +* [`fn withTimeouts()`](#fn-withtimeouts) +* [`fn withTimeoutsMixin()`](#fn-withtimeoutsmixin) +* [`fn withVpcOptions()`](#fn-withvpcoptions) +* [`fn withVpcOptionsMixin()`](#fn-withvpcoptionsmixin) +* [`obj timeouts`](#obj-timeouts) + * [`fn new()`](#fn-timeoutsnew) +* [`obj vpc_options`](#obj-vpc_options) + * [`fn new()`](#fn-vpc_optionsnew) + +## Fields + +### fn new + +```ts +new() +``` + + +`aws.opensearch_vpc_endpoint.new` injects a new `aws_opensearch_vpc_endpoint` Terraform `resource` +block into the root module document. + +Additionally, this inserts a private function into the `_ref` attribute that generates references to attributes of the +resource. For example, if you added a new instance to the root using: + + # arguments omitted for brevity + aws.opensearch_vpc_endpoint.new('some_id') + +You can get the reference to the `id` field of the created `aws.opensearch_vpc_endpoint` using the reference: + + $._ref.aws_opensearch_vpc_endpoint.some_id.get('id') + +This is the same as directly entering `"${ aws_opensearch_vpc_endpoint.some_id.id }"` as the value. + +NOTE: if you are chaining multiple resources together in a merge operation, you may not be able to use `super`, `self`, +or `$` to refer to the root object. Instead, make an explicit outer object using `local`. + +**Args**: + - `resourceLabel` (`string`): The name label of the block. + - `domain_arn` (`string`): Set the `domain_arn` field on the resulting resource block. + - `timeouts` (`obj`): Set the `timeouts` field on the resulting resource block. When `null`, the `timeouts` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [aws.opensearch_vpc_endpoint.timeouts.new](#fn-timeoutsnew) constructor. + - `vpc_options` (`list[obj]`): Set the `vpc_options` field on the resulting resource block. When `null`, the `vpc_options` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [aws.opensearch_vpc_endpoint.vpc_options.new](#fn-vpc_optionsnew) constructor. + +**Returns**: +- A mixin object that injects the new resource into the root Terraform configuration. + + +### fn newAttrs + +```ts +newAttrs() +``` + + +`aws.opensearch_vpc_endpoint.newAttrs` constructs a new object with attributes and blocks configured for the `opensearch_vpc_endpoint` +Terraform resource. + +Unlike [aws.opensearch_vpc_endpoint.new](#fn-new), this function will not inject the `resource` +block into the root Terraform document. Instead, this must be passed in as the `attrs` argument for the +[tf.withResource](https://github.com/tf-libsonnet/core/tree/main/docs#fn-withresource) function to build a complete block. + +This is most useful when you need to preprocess the attributes with functions, conditional, or looping logic prior to +injecting into a complete block. + +**Args**: + - `domain_arn` (`string`): Set the `domain_arn` field on the resulting object. + - `timeouts` (`obj`): Set the `timeouts` field on the resulting object. When `null`, the `timeouts` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [aws.opensearch_vpc_endpoint.timeouts.new](#fn-timeoutsnew) constructor. + - `vpc_options` (`list[obj]`): Set the `vpc_options` field on the resulting object. When `null`, the `vpc_options` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [aws.opensearch_vpc_endpoint.vpc_options.new](#fn-vpc_optionsnew) constructor. + +**Returns**: + - An attribute object that can be used with [tf.withResource](https://github.com/tf-libsonnet/core/tree/main/docs#fn-withresource) to construct a new `opensearch_vpc_endpoint` resource into the root Terraform configuration. + + +### fn withDomainArn + +```ts +withDomainArn() +``` + +`aws.string.withDomainArn` constructs a mixin object that can be merged into the `string` +Terraform resource block to set or update the domain_arn field. + + + +**Args**: + - `resourceLabel` (`string`): The name label of the block to update. + - `value` (`string`): The value to set for the `domain_arn` field. + + +### fn withTimeouts + +```ts +withTimeouts() +``` + +`aws.obj.withTimeouts` constructs a mixin object that can be merged into the `obj` +Terraform resource block to set or update the timeouts field. + +This function will replace the map with the passed in `value`. If you wish to instead merge the +passed in value to the existing map, use the [aws.obj.withTimeoutsMixin](TODO) function. + +**Args**: + - `resourceLabel` (`string`): The name label of the block to update. + - `value` (`obj`): The value to set for the `timeouts` field. + + +### fn withTimeoutsMixin + +```ts +withTimeoutsMixin() +``` + +`aws.obj.withTimeoutsMixin` constructs a mixin object that can be merged into the `obj` +Terraform resource block to set or update the timeouts field. + +This function will merge the passed in value to the existing map. If you wish +to instead replace the entire map with the passed in `value`, use the [aws.obj.withTimeouts](TODO) +function. + + +**Args**: + - `resourceLabel` (`string`): The name label of the block to update. + - `value` (`obj`): The value to set for the `timeouts` field. + + +### fn withVpcOptions + +```ts +withVpcOptions() +``` + +`aws.list[obj].withVpcOptions` constructs a mixin object that can be merged into the `list[obj]` +Terraform resource block to set or update the vpc_options field. + +This function will replace the array with the passed in `value`. If you wish to instead append the +passed in value to the existing array, use the [aws.list[obj].withVpcOptionsMixin](TODO) function. + + +**Args**: + - `resourceLabel` (`string`): The name label of the block to update. + - `value` (`list[obj]`): The value to set for the `vpc_options` field. + + +### fn withVpcOptionsMixin + +```ts +withVpcOptionsMixin() +``` + +`aws.list[obj].withVpcOptionsMixin` constructs a mixin object that can be merged into the `list[obj]` +Terraform resource block to set or update the vpc_options field. + +This function will append the passed in array or object to the existing array. If you wish +to instead replace the array with the passed in `value`, use the [aws.list[obj].withVpcOptions](TODO) +function. + + +**Args**: + - `resourceLabel` (`string`): The name label of the block to update. + - `value` (`list[obj]`): The value to set for the `vpc_options` field. + + +## obj timeouts + + + +### fn timeouts.new + +```ts +new() +``` + + +`aws.opensearch_vpc_endpoint.timeouts.new` constructs a new object with attributes and blocks configured for the `timeouts` +Terraform sub block. + + + +**Args**: + - `create` (`string`): Set the `create` field on the resulting object. When `null`, the `create` field will be omitted from the resulting object. + - `delete` (`string`): Set the `delete` field on the resulting object. When `null`, the `delete` field will be omitted from the resulting object. + - `update` (`string`): Set the `update` field on the resulting object. When `null`, the `update` field will be omitted from the resulting object. + +**Returns**: + - An attribute object that represents the `timeouts` sub block. + + +## obj vpc_options + + + +### fn vpc_options.new + +```ts +new() +``` + + +`aws.opensearch_vpc_endpoint.vpc_options.new` constructs a new object with attributes and blocks configured for the `vpc_options` +Terraform sub block. + + + +**Args**: + - `security_group_ids` (`list`): Set the `security_group_ids` field on the resulting object. When `null`, the `security_group_ids` field will be omitted from the resulting object. + - `subnet_ids` (`list`): Set the `subnet_ids` field on the resulting object. + +**Returns**: + - An attribute object that represents the `vpc_options` sub block. diff --git a/docs/5.x/provider.md b/docs/5.x/provider.md index c73fbce5..3eb8e592 100644 --- a/docs/5.x/provider.md +++ b/docs/5.x/provider.md @@ -60,6 +60,7 @@ created with `aws configure` will be used. When `null`, the `profile` field will - `region` (`string`): The region where AWS operations will take place. Examples are us-east-1, us-west-2, etc. When `null`, the `region` field will be omitted from the resulting object. - `retry_mode` (`string`): Specifies how retries are attempted. Valid values are `standard` and `adaptive`. Can also be configured using the `AWS_RETRY_MODE` environment variable. When `null`, the `retry_mode` field will be omitted from the resulting object. + - `s3_us_east_1_regional_endpoint` (`string`): Specifies whether S3 API calls in the `us-east-1` region use the legacy global endpoint or a regional endpoint. Valid values are `legacy` or `regional`. Can also be configured using the `AWS_S3_US_EAST_1_REGIONAL_ENDPOINT` environment variable or the `s3_us_east_1_regional_endpoint` shared config file parameter When `null`, the `s3_us_east_1_regional_endpoint` field will be omitted from the resulting object. - `s3_use_path_style` (`bool`): Set this to true to enable the request to use path-style addressing, i.e., https://s3.amazonaws.com/BUCKET/KEY. By default, the S3 client will use virtual hosted bucket addressing when possible @@ -131,6 +132,7 @@ created with `aws configure` will be used. When `null`, the `profile` field will - `region` (`string`): The region where AWS operations will take place. Examples are us-east-1, us-west-2, etc. When `null`, the `region` field will be omitted from the resulting object. - `retry_mode` (`string`): Specifies how retries are attempted. Valid values are `standard` and `adaptive`. Can also be configured using the `AWS_RETRY_MODE` environment variable. When `null`, the `retry_mode` field will be omitted from the resulting object. + - `s3_us_east_1_regional_endpoint` (`string`): Specifies whether S3 API calls in the `us-east-1` region use the legacy global endpoint or a regional endpoint. Valid values are `legacy` or `regional`. Can also be configured using the `AWS_S3_US_EAST_1_REGIONAL_ENDPOINT` environment variable or the `s3_us_east_1_regional_endpoint` shared config file parameter When `null`, the `s3_us_east_1_regional_endpoint` field will be omitted from the resulting object. - `s3_use_path_style` (`bool`): Set this to true to enable the request to use path-style addressing, i.e., https://s3.amazonaws.com/BUCKET/KEY. By default, the S3 client will use virtual hosted bucket addressing when possible @@ -409,6 +411,8 @@ Terraform sub block. - `lexmodelbuilding` (`string`): Use this to override the default service endpoint URL When `null`, the `lexmodelbuilding` field will be omitted from the resulting object. - `lexmodelbuildingservice` (`string`): Use this to override the default service endpoint URL When `null`, the `lexmodelbuildingservice` field will be omitted from the resulting object. - `lexmodels` (`string`): Use this to override the default service endpoint URL When `null`, the `lexmodels` field will be omitted from the resulting object. + - `lexmodelsv2` (`string`): Use this to override the default service endpoint URL When `null`, the `lexmodelsv2` field will be omitted from the resulting object. + - `lexv2models` (`string`): Use this to override the default service endpoint URL When `null`, the `lexv2models` field will be omitted from the resulting object. - `licensemanager` (`string`): Use this to override the default service endpoint URL When `null`, the `licensemanager` field will be omitted from the resulting object. - `lightsail` (`string`): Use this to override the default service endpoint URL When `null`, the `lightsail` field will be omitted from the resulting object. - `location` (`string`): Use this to override the default service endpoint URL When `null`, the `location` field will be omitted from the resulting object. diff --git a/docs/5.x/ram_sharing_with_organization.md b/docs/5.x/ram_sharing_with_organization.md new file mode 100644 index 00000000..6b459255 --- /dev/null +++ b/docs/5.x/ram_sharing_with_organization.md @@ -0,0 +1,71 @@ +--- +permalink: /ram_sharing_with_organization/ +--- + +# ram_sharing_with_organization + +`ram_sharing_with_organization` represents the `aws_ram_sharing_with_organization` Terraform resource. + + + +This package contains functions and utilities for setting up the resource using Jsonnet code. + + +## Index + +* [`fn new()`](#fn-new) +* [`fn newAttrs()`](#fn-newattrs) + +## Fields + +### fn new + +```ts +new() +``` + + +`aws.ram_sharing_with_organization.new` injects a new `aws_ram_sharing_with_organization` Terraform `resource` +block into the root module document. + +Additionally, this inserts a private function into the `_ref` attribute that generates references to attributes of the +resource. For example, if you added a new instance to the root using: + + # arguments omitted for brevity + aws.ram_sharing_with_organization.new('some_id') + +You can get the reference to the `id` field of the created `aws.ram_sharing_with_organization` using the reference: + + $._ref.aws_ram_sharing_with_organization.some_id.get('id') + +This is the same as directly entering `"${ aws_ram_sharing_with_organization.some_id.id }"` as the value. + +NOTE: if you are chaining multiple resources together in a merge operation, you may not be able to use `super`, `self`, +or `$` to refer to the root object. Instead, make an explicit outer object using `local`. + +**Args**: + - `resourceLabel` (`string`): The name label of the block. + +**Returns**: +- A mixin object that injects the new resource into the root Terraform configuration. + + +### fn newAttrs + +```ts +newAttrs() +``` + + +`aws.ram_sharing_with_organization.newAttrs` constructs a new object with attributes and blocks configured for the `ram_sharing_with_organization` +Terraform resource. + +Unlike [aws.ram_sharing_with_organization.new](#fn-new), this function will not inject the `resource` +block into the root Terraform document. Instead, this must be passed in as the `attrs` argument for the +[tf.withResource](https://github.com/tf-libsonnet/core/tree/main/docs#fn-withresource) function to build a complete block. + +This is most useful when you need to preprocess the attributes with functions, conditional, or looping logic prior to +injecting into a complete block. + +**Returns**: + - An attribute object that can be used with [tf.withResource](https://github.com/tf-libsonnet/core/tree/main/docs#fn-withresource) to construct a new `ram_sharing_with_organization` resource into the root Terraform configuration. diff --git a/docs/5.x/s3_object.md b/docs/5.x/s3_object.md index 8eab3f7a..96e3cccc 100644 --- a/docs/5.x/s3_object.md +++ b/docs/5.x/s3_object.md @@ -19,6 +19,7 @@ This package contains functions and utilities for setting up the resource using * [`fn withBucket()`](#fn-withbucket) * [`fn withBucketKeyEnabled()`](#fn-withbucketkeyenabled) * [`fn withCacheControl()`](#fn-withcachecontrol) +* [`fn withChecksumAlgorithm()`](#fn-withchecksumalgorithm) * [`fn withContent()`](#fn-withcontent) * [`fn withContentBase64()`](#fn-withcontentbase64) * [`fn withContentDisposition()`](#fn-withcontentdisposition) @@ -74,6 +75,7 @@ or `$` to refer to the root object. Instead, make an explicit outer object using - `bucket` (`string`): Set the `bucket` field on the resulting resource block. - `bucket_key_enabled` (`bool`): Set the `bucket_key_enabled` field on the resulting resource block. When `null`, the `bucket_key_enabled` field will be omitted from the resulting object. - `cache_control` (`string`): Set the `cache_control` field on the resulting resource block. When `null`, the `cache_control` field will be omitted from the resulting object. + - `checksum_algorithm` (`string`): Set the `checksum_algorithm` field on the resulting resource block. When `null`, the `checksum_algorithm` field will be omitted from the resulting object. - `content` (`string`): Set the `content` field on the resulting resource block. When `null`, the `content` field will be omitted from the resulting object. - `content_base64` (`string`): Set the `content_base64` field on the resulting resource block. When `null`, the `content_base64` field will be omitted from the resulting object. - `content_disposition` (`string`): Set the `content_disposition` field on the resulting resource block. When `null`, the `content_disposition` field will be omitted from the resulting object. @@ -122,6 +124,7 @@ injecting into a complete block. - `bucket` (`string`): Set the `bucket` field on the resulting object. - `bucket_key_enabled` (`bool`): Set the `bucket_key_enabled` field on the resulting object. When `null`, the `bucket_key_enabled` field will be omitted from the resulting object. - `cache_control` (`string`): Set the `cache_control` field on the resulting object. When `null`, the `cache_control` field will be omitted from the resulting object. + - `checksum_algorithm` (`string`): Set the `checksum_algorithm` field on the resulting object. When `null`, the `checksum_algorithm` field will be omitted from the resulting object. - `content` (`string`): Set the `content` field on the resulting object. When `null`, the `content` field will be omitted from the resulting object. - `content_base64` (`string`): Set the `content_base64` field on the resulting object. When `null`, the `content_base64` field will be omitted from the resulting object. - `content_disposition` (`string`): Set the `content_disposition` field on the resulting object. When `null`, the `content_disposition` field will be omitted from the resulting object. @@ -212,6 +215,22 @@ Terraform resource block to set or update the cache_control field. - `value` (`string`): The value to set for the `cache_control` field. +### fn withChecksumAlgorithm + +```ts +withChecksumAlgorithm() +``` + +`aws.string.withChecksumAlgorithm` constructs a mixin object that can be merged into the `string` +Terraform resource block to set or update the checksum_algorithm field. + + + +**Args**: + - `resourceLabel` (`string`): The name label of the block to update. + - `value` (`string`): The value to set for the `checksum_algorithm` field. + + ### fn withContent ```ts diff --git a/docs/5.x/s3_object_copy.md b/docs/5.x/s3_object_copy.md index e2e040c1..f5efd17e 100644 --- a/docs/5.x/s3_object_copy.md +++ b/docs/5.x/s3_object_copy.md @@ -19,6 +19,7 @@ This package contains functions and utilities for setting up the resource using * [`fn withBucket()`](#fn-withbucket) * [`fn withBucketKeyEnabled()`](#fn-withbucketkeyenabled) * [`fn withCacheControl()`](#fn-withcachecontrol) +* [`fn withChecksumAlgorithm()`](#fn-withchecksumalgorithm) * [`fn withContentDisposition()`](#fn-withcontentdisposition) * [`fn withContentEncoding()`](#fn-withcontentencoding) * [`fn withContentLanguage()`](#fn-withcontentlanguage) @@ -91,6 +92,7 @@ or `$` to refer to the root object. Instead, make an explicit outer object using - `bucket` (`string`): Set the `bucket` field on the resulting resource block. - `bucket_key_enabled` (`bool`): Set the `bucket_key_enabled` field on the resulting resource block. When `null`, the `bucket_key_enabled` field will be omitted from the resulting object. - `cache_control` (`string`): Set the `cache_control` field on the resulting resource block. When `null`, the `cache_control` field will be omitted from the resulting object. + - `checksum_algorithm` (`string`): Set the `checksum_algorithm` field on the resulting resource block. When `null`, the `checksum_algorithm` field will be omitted from the resulting object. - `content_disposition` (`string`): Set the `content_disposition` field on the resulting resource block. When `null`, the `content_disposition` field will be omitted from the resulting object. - `content_encoding` (`string`): Set the `content_encoding` field on the resulting resource block. When `null`, the `content_encoding` field will be omitted from the resulting object. - `content_language` (`string`): Set the `content_language` field on the resulting resource block. When `null`, the `content_language` field will be omitted from the resulting object. @@ -153,6 +155,7 @@ injecting into a complete block. - `bucket` (`string`): Set the `bucket` field on the resulting object. - `bucket_key_enabled` (`bool`): Set the `bucket_key_enabled` field on the resulting object. When `null`, the `bucket_key_enabled` field will be omitted from the resulting object. - `cache_control` (`string`): Set the `cache_control` field on the resulting object. When `null`, the `cache_control` field will be omitted from the resulting object. + - `checksum_algorithm` (`string`): Set the `checksum_algorithm` field on the resulting object. When `null`, the `checksum_algorithm` field will be omitted from the resulting object. - `content_disposition` (`string`): Set the `content_disposition` field on the resulting object. When `null`, the `content_disposition` field will be omitted from the resulting object. - `content_encoding` (`string`): Set the `content_encoding` field on the resulting object. When `null`, the `content_encoding` field will be omitted from the resulting object. - `content_language` (`string`): Set the `content_language` field on the resulting object. When `null`, the `content_language` field will be omitted from the resulting object. @@ -257,6 +260,22 @@ Terraform resource block to set or update the cache_control field. - `value` (`string`): The value to set for the `cache_control` field. +### fn withChecksumAlgorithm + +```ts +withChecksumAlgorithm() +``` + +`aws.string.withChecksumAlgorithm` constructs a mixin object that can be merged into the `string` +Terraform resource block to set or update the checksum_algorithm field. + + + +**Args**: + - `resourceLabel` (`string`): The name label of the block to update. + - `value` (`string`): The value to set for the `checksum_algorithm` field. + + ### fn withContentDisposition ```ts diff --git a/docs/5.x/s3control_multi_region_access_point.md b/docs/5.x/s3control_multi_region_access_point.md index fc0deea3..4825d3b9 100644 --- a/docs/5.x/s3control_multi_region_access_point.md +++ b/docs/5.x/s3control_multi_region_access_point.md @@ -250,6 +250,7 @@ Terraform sub block. **Args**: - `bucket` (`string`): Set the `bucket` field on the resulting object. + - `bucket_account_id` (`string`): Set the `bucket_account_id` field on the resulting object. When `null`, the `bucket_account_id` field will be omitted from the resulting object. **Returns**: - An attribute object that represents the `region` sub block. diff --git a/docs/5.x/shield_application_layer_automatic_response.md b/docs/5.x/shield_application_layer_automatic_response.md new file mode 100644 index 00000000..35fbe50a --- /dev/null +++ b/docs/5.x/shield_application_layer_automatic_response.md @@ -0,0 +1,178 @@ +--- +permalink: /shield_application_layer_automatic_response/ +--- + +# shield_application_layer_automatic_response + +`shield_application_layer_automatic_response` represents the `aws_shield_application_layer_automatic_response` Terraform resource. + + + +This package contains functions and utilities for setting up the resource using Jsonnet code. + + +## Index + +* [`fn new()`](#fn-new) +* [`fn newAttrs()`](#fn-newattrs) +* [`fn withAction()`](#fn-withaction) +* [`fn withResourceArn()`](#fn-withresourcearn) +* [`fn withTimeouts()`](#fn-withtimeouts) +* [`fn withTimeoutsMixin()`](#fn-withtimeoutsmixin) +* [`obj timeouts`](#obj-timeouts) + * [`fn new()`](#fn-timeoutsnew) + +## Fields + +### fn new + +```ts +new() +``` + + +`aws.shield_application_layer_automatic_response.new` injects a new `aws_shield_application_layer_automatic_response` Terraform `resource` +block into the root module document. + +Additionally, this inserts a private function into the `_ref` attribute that generates references to attributes of the +resource. For example, if you added a new instance to the root using: + + # arguments omitted for brevity + aws.shield_application_layer_automatic_response.new('some_id') + +You can get the reference to the `id` field of the created `aws.shield_application_layer_automatic_response` using the reference: + + $._ref.aws_shield_application_layer_automatic_response.some_id.get('id') + +This is the same as directly entering `"${ aws_shield_application_layer_automatic_response.some_id.id }"` as the value. + +NOTE: if you are chaining multiple resources together in a merge operation, you may not be able to use `super`, `self`, +or `$` to refer to the root object. Instead, make an explicit outer object using `local`. + +**Args**: + - `resourceLabel` (`string`): The name label of the block. + - `action` (`string`): Set the `action` field on the resulting resource block. + - `resource_arn` (`string`): Set the `resource_arn` field on the resulting resource block. + - `timeouts` (`obj`): Set the `timeouts` field on the resulting resource block. When `null`, the `timeouts` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [aws.shield_application_layer_automatic_response.timeouts.new](#fn-timeoutsnew) constructor. + +**Returns**: +- A mixin object that injects the new resource into the root Terraform configuration. + + +### fn newAttrs + +```ts +newAttrs() +``` + + +`aws.shield_application_layer_automatic_response.newAttrs` constructs a new object with attributes and blocks configured for the `shield_application_layer_automatic_response` +Terraform resource. + +Unlike [aws.shield_application_layer_automatic_response.new](#fn-new), this function will not inject the `resource` +block into the root Terraform document. Instead, this must be passed in as the `attrs` argument for the +[tf.withResource](https://github.com/tf-libsonnet/core/tree/main/docs#fn-withresource) function to build a complete block. + +This is most useful when you need to preprocess the attributes with functions, conditional, or looping logic prior to +injecting into a complete block. + +**Args**: + - `action` (`string`): Set the `action` field on the resulting object. + - `resource_arn` (`string`): Set the `resource_arn` field on the resulting object. + - `timeouts` (`obj`): Set the `timeouts` field on the resulting object. When `null`, the `timeouts` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [aws.shield_application_layer_automatic_response.timeouts.new](#fn-timeoutsnew) constructor. + +**Returns**: + - An attribute object that can be used with [tf.withResource](https://github.com/tf-libsonnet/core/tree/main/docs#fn-withresource) to construct a new `shield_application_layer_automatic_response` resource into the root Terraform configuration. + + +### fn withAction + +```ts +withAction() +``` + +`aws.string.withAction` constructs a mixin object that can be merged into the `string` +Terraform resource block to set or update the action field. + + + +**Args**: + - `resourceLabel` (`string`): The name label of the block to update. + - `value` (`string`): The value to set for the `action` field. + + +### fn withResourceArn + +```ts +withResourceArn() +``` + +`aws.string.withResourceArn` constructs a mixin object that can be merged into the `string` +Terraform resource block to set or update the resource_arn field. + + + +**Args**: + - `resourceLabel` (`string`): The name label of the block to update. + - `value` (`string`): The value to set for the `resource_arn` field. + + +### fn withTimeouts + +```ts +withTimeouts() +``` + +`aws.obj.withTimeouts` constructs a mixin object that can be merged into the `obj` +Terraform resource block to set or update the timeouts field. + +This function will replace the map with the passed in `value`. If you wish to instead merge the +passed in value to the existing map, use the [aws.obj.withTimeoutsMixin](TODO) function. + +**Args**: + - `resourceLabel` (`string`): The name label of the block to update. + - `value` (`obj`): The value to set for the `timeouts` field. + + +### fn withTimeoutsMixin + +```ts +withTimeoutsMixin() +``` + +`aws.obj.withTimeoutsMixin` constructs a mixin object that can be merged into the `obj` +Terraform resource block to set or update the timeouts field. + +This function will merge the passed in value to the existing map. If you wish +to instead replace the entire map with the passed in `value`, use the [aws.obj.withTimeouts](TODO) +function. + + +**Args**: + - `resourceLabel` (`string`): The name label of the block to update. + - `value` (`obj`): The value to set for the `timeouts` field. + + +## obj timeouts + + + +### fn timeouts.new + +```ts +new() +``` + + +`aws.shield_application_layer_automatic_response.timeouts.new` constructs a new object with attributes and blocks configured for the `timeouts` +Terraform sub block. + + + +**Args**: + - `create` (`string`): A string that can be [parsed as a duration](https://pkg.go.dev/time#ParseDuration) consisting of numbers and unit suffixes, such as "30s" or "2h45m". Valid time units are "s" (seconds), "m" (minutes), "h" (hours). When `null`, the `create` field will be omitted from the resulting object. + - `delete` (`string`): A string that can be [parsed as a duration](https://pkg.go.dev/time#ParseDuration) consisting of numbers and unit suffixes, such as "30s" or "2h45m". Valid time units are "s" (seconds), "m" (minutes), "h" (hours). Setting a timeout for a Delete operation is only applicable if changes are saved into state before the destroy operation occurs. When `null`, the `delete` field will be omitted from the resulting object. + - `update` (`string`): A string that can be [parsed as a duration](https://pkg.go.dev/time#ParseDuration) consisting of numbers and unit suffixes, such as "30s" or "2h45m". Valid time units are "s" (seconds), "m" (minutes), "h" (hours). When `null`, the `update` field will be omitted from the resulting object. + +**Returns**: + - An attribute object that represents the `timeouts` sub block. diff --git a/docs/5.x/shield_drt_access_log_bucket_association.md b/docs/5.x/shield_drt_access_log_bucket_association.md new file mode 100644 index 00000000..cd224f88 --- /dev/null +++ b/docs/5.x/shield_drt_access_log_bucket_association.md @@ -0,0 +1,178 @@ +--- +permalink: /shield_drt_access_log_bucket_association/ +--- + +# shield_drt_access_log_bucket_association + +`shield_drt_access_log_bucket_association` represents the `aws_shield_drt_access_log_bucket_association` Terraform resource. + + + +This package contains functions and utilities for setting up the resource using Jsonnet code. + + +## Index + +* [`fn new()`](#fn-new) +* [`fn newAttrs()`](#fn-newattrs) +* [`fn withLogBucket()`](#fn-withlogbucket) +* [`fn withRoleArnAssociationId()`](#fn-withrolearnassociationid) +* [`fn withTimeouts()`](#fn-withtimeouts) +* [`fn withTimeoutsMixin()`](#fn-withtimeoutsmixin) +* [`obj timeouts`](#obj-timeouts) + * [`fn new()`](#fn-timeoutsnew) + +## Fields + +### fn new + +```ts +new() +``` + + +`aws.shield_drt_access_log_bucket_association.new` injects a new `aws_shield_drt_access_log_bucket_association` Terraform `resource` +block into the root module document. + +Additionally, this inserts a private function into the `_ref` attribute that generates references to attributes of the +resource. For example, if you added a new instance to the root using: + + # arguments omitted for brevity + aws.shield_drt_access_log_bucket_association.new('some_id') + +You can get the reference to the `id` field of the created `aws.shield_drt_access_log_bucket_association` using the reference: + + $._ref.aws_shield_drt_access_log_bucket_association.some_id.get('id') + +This is the same as directly entering `"${ aws_shield_drt_access_log_bucket_association.some_id.id }"` as the value. + +NOTE: if you are chaining multiple resources together in a merge operation, you may not be able to use `super`, `self`, +or `$` to refer to the root object. Instead, make an explicit outer object using `local`. + +**Args**: + - `resourceLabel` (`string`): The name label of the block. + - `log_bucket` (`string`): Set the `log_bucket` field on the resulting resource block. + - `role_arn_association_id` (`string`): Set the `role_arn_association_id` field on the resulting resource block. + - `timeouts` (`obj`): Set the `timeouts` field on the resulting resource block. When `null`, the `timeouts` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [aws.shield_drt_access_log_bucket_association.timeouts.new](#fn-timeoutsnew) constructor. + +**Returns**: +- A mixin object that injects the new resource into the root Terraform configuration. + + +### fn newAttrs + +```ts +newAttrs() +``` + + +`aws.shield_drt_access_log_bucket_association.newAttrs` constructs a new object with attributes and blocks configured for the `shield_drt_access_log_bucket_association` +Terraform resource. + +Unlike [aws.shield_drt_access_log_bucket_association.new](#fn-new), this function will not inject the `resource` +block into the root Terraform document. Instead, this must be passed in as the `attrs` argument for the +[tf.withResource](https://github.com/tf-libsonnet/core/tree/main/docs#fn-withresource) function to build a complete block. + +This is most useful when you need to preprocess the attributes with functions, conditional, or looping logic prior to +injecting into a complete block. + +**Args**: + - `log_bucket` (`string`): Set the `log_bucket` field on the resulting object. + - `role_arn_association_id` (`string`): Set the `role_arn_association_id` field on the resulting object. + - `timeouts` (`obj`): Set the `timeouts` field on the resulting object. When `null`, the `timeouts` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [aws.shield_drt_access_log_bucket_association.timeouts.new](#fn-timeoutsnew) constructor. + +**Returns**: + - An attribute object that can be used with [tf.withResource](https://github.com/tf-libsonnet/core/tree/main/docs#fn-withresource) to construct a new `shield_drt_access_log_bucket_association` resource into the root Terraform configuration. + + +### fn withLogBucket + +```ts +withLogBucket() +``` + +`aws.string.withLogBucket` constructs a mixin object that can be merged into the `string` +Terraform resource block to set or update the log_bucket field. + + + +**Args**: + - `resourceLabel` (`string`): The name label of the block to update. + - `value` (`string`): The value to set for the `log_bucket` field. + + +### fn withRoleArnAssociationId + +```ts +withRoleArnAssociationId() +``` + +`aws.string.withRoleArnAssociationId` constructs a mixin object that can be merged into the `string` +Terraform resource block to set or update the role_arn_association_id field. + + + +**Args**: + - `resourceLabel` (`string`): The name label of the block to update. + - `value` (`string`): The value to set for the `role_arn_association_id` field. + + +### fn withTimeouts + +```ts +withTimeouts() +``` + +`aws.obj.withTimeouts` constructs a mixin object that can be merged into the `obj` +Terraform resource block to set or update the timeouts field. + +This function will replace the map with the passed in `value`. If you wish to instead merge the +passed in value to the existing map, use the [aws.obj.withTimeoutsMixin](TODO) function. + +**Args**: + - `resourceLabel` (`string`): The name label of the block to update. + - `value` (`obj`): The value to set for the `timeouts` field. + + +### fn withTimeoutsMixin + +```ts +withTimeoutsMixin() +``` + +`aws.obj.withTimeoutsMixin` constructs a mixin object that can be merged into the `obj` +Terraform resource block to set or update the timeouts field. + +This function will merge the passed in value to the existing map. If you wish +to instead replace the entire map with the passed in `value`, use the [aws.obj.withTimeouts](TODO) +function. + + +**Args**: + - `resourceLabel` (`string`): The name label of the block to update. + - `value` (`obj`): The value to set for the `timeouts` field. + + +## obj timeouts + + + +### fn timeouts.new + +```ts +new() +``` + + +`aws.shield_drt_access_log_bucket_association.timeouts.new` constructs a new object with attributes and blocks configured for the `timeouts` +Terraform sub block. + + + +**Args**: + - `create` (`string`): A string that can be [parsed as a duration](https://pkg.go.dev/time#ParseDuration) consisting of numbers and unit suffixes, such as "30s" or "2h45m". Valid time units are "s" (seconds), "m" (minutes), "h" (hours). When `null`, the `create` field will be omitted from the resulting object. + - `delete` (`string`): A string that can be [parsed as a duration](https://pkg.go.dev/time#ParseDuration) consisting of numbers and unit suffixes, such as "30s" or "2h45m". Valid time units are "s" (seconds), "m" (minutes), "h" (hours). Setting a timeout for a Delete operation is only applicable if changes are saved into state before the destroy operation occurs. When `null`, the `delete` field will be omitted from the resulting object. + - `read` (`string`): A string that can be [parsed as a duration](https://pkg.go.dev/time#ParseDuration) consisting of numbers and unit suffixes, such as "30s" or "2h45m". Valid time units are "s" (seconds), "m" (minutes), "h" (hours). Read operations occur during any refresh or planning operation when refresh is enabled. When `null`, the `read` field will be omitted from the resulting object. + +**Returns**: + - An attribute object that represents the `timeouts` sub block. diff --git a/docs/5.x/shield_drt_access_role_arn_association.md b/docs/5.x/shield_drt_access_role_arn_association.md new file mode 100644 index 00000000..c42da538 --- /dev/null +++ b/docs/5.x/shield_drt_access_role_arn_association.md @@ -0,0 +1,159 @@ +--- +permalink: /shield_drt_access_role_arn_association/ +--- + +# shield_drt_access_role_arn_association + +`shield_drt_access_role_arn_association` represents the `aws_shield_drt_access_role_arn_association` Terraform resource. + + + +This package contains functions and utilities for setting up the resource using Jsonnet code. + + +## Index + +* [`fn new()`](#fn-new) +* [`fn newAttrs()`](#fn-newattrs) +* [`fn withRoleArn()`](#fn-withrolearn) +* [`fn withTimeouts()`](#fn-withtimeouts) +* [`fn withTimeoutsMixin()`](#fn-withtimeoutsmixin) +* [`obj timeouts`](#obj-timeouts) + * [`fn new()`](#fn-timeoutsnew) + +## Fields + +### fn new + +```ts +new() +``` + + +`aws.shield_drt_access_role_arn_association.new` injects a new `aws_shield_drt_access_role_arn_association` Terraform `resource` +block into the root module document. + +Additionally, this inserts a private function into the `_ref` attribute that generates references to attributes of the +resource. For example, if you added a new instance to the root using: + + # arguments omitted for brevity + aws.shield_drt_access_role_arn_association.new('some_id') + +You can get the reference to the `id` field of the created `aws.shield_drt_access_role_arn_association` using the reference: + + $._ref.aws_shield_drt_access_role_arn_association.some_id.get('id') + +This is the same as directly entering `"${ aws_shield_drt_access_role_arn_association.some_id.id }"` as the value. + +NOTE: if you are chaining multiple resources together in a merge operation, you may not be able to use `super`, `self`, +or `$` to refer to the root object. Instead, make an explicit outer object using `local`. + +**Args**: + - `resourceLabel` (`string`): The name label of the block. + - `role_arn` (`string`): Set the `role_arn` field on the resulting resource block. + - `timeouts` (`obj`): Set the `timeouts` field on the resulting resource block. When `null`, the `timeouts` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [aws.shield_drt_access_role_arn_association.timeouts.new](#fn-timeoutsnew) constructor. + +**Returns**: +- A mixin object that injects the new resource into the root Terraform configuration. + + +### fn newAttrs + +```ts +newAttrs() +``` + + +`aws.shield_drt_access_role_arn_association.newAttrs` constructs a new object with attributes and blocks configured for the `shield_drt_access_role_arn_association` +Terraform resource. + +Unlike [aws.shield_drt_access_role_arn_association.new](#fn-new), this function will not inject the `resource` +block into the root Terraform document. Instead, this must be passed in as the `attrs` argument for the +[tf.withResource](https://github.com/tf-libsonnet/core/tree/main/docs#fn-withresource) function to build a complete block. + +This is most useful when you need to preprocess the attributes with functions, conditional, or looping logic prior to +injecting into a complete block. + +**Args**: + - `role_arn` (`string`): Set the `role_arn` field on the resulting object. + - `timeouts` (`obj`): Set the `timeouts` field on the resulting object. When `null`, the `timeouts` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [aws.shield_drt_access_role_arn_association.timeouts.new](#fn-timeoutsnew) constructor. + +**Returns**: + - An attribute object that can be used with [tf.withResource](https://github.com/tf-libsonnet/core/tree/main/docs#fn-withresource) to construct a new `shield_drt_access_role_arn_association` resource into the root Terraform configuration. + + +### fn withRoleArn + +```ts +withRoleArn() +``` + +`aws.string.withRoleArn` constructs a mixin object that can be merged into the `string` +Terraform resource block to set or update the role_arn field. + + + +**Args**: + - `resourceLabel` (`string`): The name label of the block to update. + - `value` (`string`): The value to set for the `role_arn` field. + + +### fn withTimeouts + +```ts +withTimeouts() +``` + +`aws.obj.withTimeouts` constructs a mixin object that can be merged into the `obj` +Terraform resource block to set or update the timeouts field. + +This function will replace the map with the passed in `value`. If you wish to instead merge the +passed in value to the existing map, use the [aws.obj.withTimeoutsMixin](TODO) function. + +**Args**: + - `resourceLabel` (`string`): The name label of the block to update. + - `value` (`obj`): The value to set for the `timeouts` field. + + +### fn withTimeoutsMixin + +```ts +withTimeoutsMixin() +``` + +`aws.obj.withTimeoutsMixin` constructs a mixin object that can be merged into the `obj` +Terraform resource block to set or update the timeouts field. + +This function will merge the passed in value to the existing map. If you wish +to instead replace the entire map with the passed in `value`, use the [aws.obj.withTimeouts](TODO) +function. + + +**Args**: + - `resourceLabel` (`string`): The name label of the block to update. + - `value` (`obj`): The value to set for the `timeouts` field. + + +## obj timeouts + + + +### fn timeouts.new + +```ts +new() +``` + + +`aws.shield_drt_access_role_arn_association.timeouts.new` constructs a new object with attributes and blocks configured for the `timeouts` +Terraform sub block. + + + +**Args**: + - `create` (`string`): A string that can be [parsed as a duration](https://pkg.go.dev/time#ParseDuration) consisting of numbers and unit suffixes, such as "30s" or "2h45m". Valid time units are "s" (seconds), "m" (minutes), "h" (hours). When `null`, the `create` field will be omitted from the resulting object. + - `delete` (`string`): A string that can be [parsed as a duration](https://pkg.go.dev/time#ParseDuration) consisting of numbers and unit suffixes, such as "30s" or "2h45m". Valid time units are "s" (seconds), "m" (minutes), "h" (hours). Setting a timeout for a Delete operation is only applicable if changes are saved into state before the destroy operation occurs. When `null`, the `delete` field will be omitted from the resulting object. + - `read` (`string`): A string that can be [parsed as a duration](https://pkg.go.dev/time#ParseDuration) consisting of numbers and unit suffixes, such as "30s" or "2h45m". Valid time units are "s" (seconds), "m" (minutes), "h" (hours). Read operations occur during any refresh or planning operation when refresh is enabled. When `null`, the `read` field will be omitted from the resulting object. + +**Returns**: + - An attribute object that represents the `timeouts` sub block. diff --git a/docs/5.x/ssm_association.md b/docs/5.x/ssm_association.md index 4703a68a..13be2275 100644 --- a/docs/5.x/ssm_association.md +++ b/docs/5.x/ssm_association.md @@ -28,6 +28,7 @@ This package contains functions and utilities for setting up the resource using * [`fn withOutputLocationMixin()`](#fn-withoutputlocationmixin) * [`fn withParameters()`](#fn-withparameters) * [`fn withScheduleExpression()`](#fn-withscheduleexpression) +* [`fn withSyncCompliance()`](#fn-withsynccompliance) * [`fn withTargets()`](#fn-withtargets) * [`fn withTargetsMixin()`](#fn-withtargetsmixin) * [`fn withWaitForSuccessTimeoutSeconds()`](#fn-withwaitforsuccesstimeoutseconds) @@ -76,6 +77,7 @@ or `$` to refer to the root object. Instead, make an explicit outer object using - `name` (`string`): Set the `name` field on the resulting resource block. - `parameters` (`obj`): Set the `parameters` field on the resulting resource block. When `null`, the `parameters` field will be omitted from the resulting object. - `schedule_expression` (`string`): Set the `schedule_expression` field on the resulting resource block. When `null`, the `schedule_expression` field will be omitted from the resulting object. + - `sync_compliance` (`string`): Set the `sync_compliance` field on the resulting resource block. When `null`, the `sync_compliance` field will be omitted from the resulting object. - `wait_for_success_timeout_seconds` (`number`): Set the `wait_for_success_timeout_seconds` field on the resulting resource block. When `null`, the `wait_for_success_timeout_seconds` field will be omitted from the resulting object. - `output_location` (`list[obj]`): Set the `output_location` field on the resulting resource block. When `null`, the `output_location` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [aws.ssm_association.output_location.new](#fn-output_locationnew) constructor. - `targets` (`list[obj]`): Set the `targets` field on the resulting resource block. When `null`, the `targets` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [aws.ssm_association.targets.new](#fn-targetsnew) constructor. @@ -113,6 +115,7 @@ injecting into a complete block. - `name` (`string`): Set the `name` field on the resulting object. - `parameters` (`obj`): Set the `parameters` field on the resulting object. When `null`, the `parameters` field will be omitted from the resulting object. - `schedule_expression` (`string`): Set the `schedule_expression` field on the resulting object. When `null`, the `schedule_expression` field will be omitted from the resulting object. + - `sync_compliance` (`string`): Set the `sync_compliance` field on the resulting object. When `null`, the `sync_compliance` field will be omitted from the resulting object. - `wait_for_success_timeout_seconds` (`number`): Set the `wait_for_success_timeout_seconds` field on the resulting object. When `null`, the `wait_for_success_timeout_seconds` field will be omitted from the resulting object. - `output_location` (`list[obj]`): Set the `output_location` field on the resulting object. When `null`, the `output_location` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [aws.ssm_association.output_location.new](#fn-output_locationnew) constructor. - `targets` (`list[obj]`): Set the `targets` field on the resulting object. When `null`, the `targets` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [aws.ssm_association.targets.new](#fn-targetsnew) constructor. @@ -334,6 +337,22 @@ Terraform resource block to set or update the schedule_expression field. - `value` (`string`): The value to set for the `schedule_expression` field. +### fn withSyncCompliance + +```ts +withSyncCompliance() +``` + +`aws.string.withSyncCompliance` constructs a mixin object that can be merged into the `string` +Terraform resource block to set or update the sync_compliance field. + + + +**Args**: + - `resourceLabel` (`string`): The name label of the block to update. + - `value` (`string`): The value to set for the `sync_compliance` field. + + ### fn withTargets ```ts diff --git a/docs/5.x/ssoadmin_account_assignment.md b/docs/5.x/ssoadmin_account_assignment.md index 2987dafa..02053d68 100644 --- a/docs/5.x/ssoadmin_account_assignment.md +++ b/docs/5.x/ssoadmin_account_assignment.md @@ -21,6 +21,10 @@ This package contains functions and utilities for setting up the resource using * [`fn withPrincipalType()`](#fn-withprincipaltype) * [`fn withTargetId()`](#fn-withtargetid) * [`fn withTargetType()`](#fn-withtargettype) +* [`fn withTimeouts()`](#fn-withtimeouts) +* [`fn withTimeoutsMixin()`](#fn-withtimeoutsmixin) +* [`obj timeouts`](#obj-timeouts) + * [`fn new()`](#fn-timeoutsnew) ## Fields @@ -57,6 +61,7 @@ or `$` to refer to the root object. Instead, make an explicit outer object using - `principal_type` (`string`): Set the `principal_type` field on the resulting resource block. - `target_id` (`string`): Set the `target_id` field on the resulting resource block. - `target_type` (`string`): Set the `target_type` field on the resulting resource block. When `null`, the `target_type` field will be omitted from the resulting object. + - `timeouts` (`obj`): Set the `timeouts` field on the resulting resource block. When `null`, the `timeouts` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [aws.ssoadmin_account_assignment.timeouts.new](#fn-timeoutsnew) constructor. **Returns**: - A mixin object that injects the new resource into the root Terraform configuration. @@ -86,6 +91,7 @@ injecting into a complete block. - `principal_type` (`string`): Set the `principal_type` field on the resulting object. - `target_id` (`string`): Set the `target_id` field on the resulting object. - `target_type` (`string`): Set the `target_type` field on the resulting object. When `null`, the `target_type` field will be omitted from the resulting object. + - `timeouts` (`obj`): Set the `timeouts` field on the resulting object. When `null`, the `timeouts` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [aws.ssoadmin_account_assignment.timeouts.new](#fn-timeoutsnew) constructor. **Returns**: - An attribute object that can be used with [tf.withResource](https://github.com/tf-libsonnet/core/tree/main/docs#fn-withresource) to construct a new `ssoadmin_account_assignment` resource into the root Terraform configuration. @@ -185,3 +191,63 @@ Terraform resource block to set or update the target_type field. **Args**: - `resourceLabel` (`string`): The name label of the block to update. - `value` (`string`): The value to set for the `target_type` field. + + +### fn withTimeouts + +```ts +withTimeouts() +``` + +`aws.obj.withTimeouts` constructs a mixin object that can be merged into the `obj` +Terraform resource block to set or update the timeouts field. + +This function will replace the map with the passed in `value`. If you wish to instead merge the +passed in value to the existing map, use the [aws.obj.withTimeoutsMixin](TODO) function. + +**Args**: + - `resourceLabel` (`string`): The name label of the block to update. + - `value` (`obj`): The value to set for the `timeouts` field. + + +### fn withTimeoutsMixin + +```ts +withTimeoutsMixin() +``` + +`aws.obj.withTimeoutsMixin` constructs a mixin object that can be merged into the `obj` +Terraform resource block to set or update the timeouts field. + +This function will merge the passed in value to the existing map. If you wish +to instead replace the entire map with the passed in `value`, use the [aws.obj.withTimeouts](TODO) +function. + + +**Args**: + - `resourceLabel` (`string`): The name label of the block to update. + - `value` (`obj`): The value to set for the `timeouts` field. + + +## obj timeouts + + + +### fn timeouts.new + +```ts +new() +``` + + +`aws.ssoadmin_account_assignment.timeouts.new` constructs a new object with attributes and blocks configured for the `timeouts` +Terraform sub block. + + + +**Args**: + - `create` (`string`): Set the `create` field on the resulting object. When `null`, the `create` field will be omitted from the resulting object. + - `delete` (`string`): Set the `delete` field on the resulting object. When `null`, the `delete` field will be omitted from the resulting object. + +**Returns**: + - An attribute object that represents the `timeouts` sub block. diff --git a/docs/5.x/ssoadmin_customer_managed_policy_attachment.md b/docs/5.x/ssoadmin_customer_managed_policy_attachment.md index 90e1f732..5997a43c 100644 --- a/docs/5.x/ssoadmin_customer_managed_policy_attachment.md +++ b/docs/5.x/ssoadmin_customer_managed_policy_attachment.md @@ -19,8 +19,12 @@ This package contains functions and utilities for setting up the resource using * [`fn withCustomerManagedPolicyReferenceMixin()`](#fn-withcustomermanagedpolicyreferencemixin) * [`fn withInstanceArn()`](#fn-withinstancearn) * [`fn withPermissionSetArn()`](#fn-withpermissionsetarn) +* [`fn withTimeouts()`](#fn-withtimeouts) +* [`fn withTimeoutsMixin()`](#fn-withtimeoutsmixin) * [`obj customer_managed_policy_reference`](#obj-customer_managed_policy_reference) * [`fn new()`](#fn-customer_managed_policy_referencenew) +* [`obj timeouts`](#obj-timeouts) + * [`fn new()`](#fn-timeoutsnew) ## Fields @@ -54,6 +58,7 @@ or `$` to refer to the root object. Instead, make an explicit outer object using - `instance_arn` (`string`): Set the `instance_arn` field on the resulting resource block. - `permission_set_arn` (`string`): Set the `permission_set_arn` field on the resulting resource block. - `customer_managed_policy_reference` (`list[obj]`): Set the `customer_managed_policy_reference` field on the resulting resource block. When `null`, the `customer_managed_policy_reference` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [aws.ssoadmin_customer_managed_policy_attachment.customer_managed_policy_reference.new](#fn-customer_managed_policy_referencenew) constructor. + - `timeouts` (`obj`): Set the `timeouts` field on the resulting resource block. When `null`, the `timeouts` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [aws.ssoadmin_customer_managed_policy_attachment.timeouts.new](#fn-timeoutsnew) constructor. **Returns**: - A mixin object that injects the new resource into the root Terraform configuration. @@ -80,6 +85,7 @@ injecting into a complete block. - `instance_arn` (`string`): Set the `instance_arn` field on the resulting object. - `permission_set_arn` (`string`): Set the `permission_set_arn` field on the resulting object. - `customer_managed_policy_reference` (`list[obj]`): Set the `customer_managed_policy_reference` field on the resulting object. When `null`, the `customer_managed_policy_reference` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [aws.ssoadmin_customer_managed_policy_attachment.customer_managed_policy_reference.new](#fn-customer_managed_policy_referencenew) constructor. + - `timeouts` (`obj`): Set the `timeouts` field on the resulting object. When `null`, the `timeouts` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [aws.ssoadmin_customer_managed_policy_attachment.timeouts.new](#fn-timeoutsnew) constructor. **Returns**: - An attribute object that can be used with [tf.withResource](https://github.com/tf-libsonnet/core/tree/main/docs#fn-withresource) to construct a new `ssoadmin_customer_managed_policy_attachment` resource into the root Terraform configuration. @@ -154,6 +160,42 @@ Terraform resource block to set or update the permission_set_arn field. - `value` (`string`): The value to set for the `permission_set_arn` field. +### fn withTimeouts + +```ts +withTimeouts() +``` + +`aws.obj.withTimeouts` constructs a mixin object that can be merged into the `obj` +Terraform resource block to set or update the timeouts field. + +This function will replace the map with the passed in `value`. If you wish to instead merge the +passed in value to the existing map, use the [aws.obj.withTimeoutsMixin](TODO) function. + +**Args**: + - `resourceLabel` (`string`): The name label of the block to update. + - `value` (`obj`): The value to set for the `timeouts` field. + + +### fn withTimeoutsMixin + +```ts +withTimeoutsMixin() +``` + +`aws.obj.withTimeoutsMixin` constructs a mixin object that can be merged into the `obj` +Terraform resource block to set or update the timeouts field. + +This function will merge the passed in value to the existing map. If you wish +to instead replace the entire map with the passed in `value`, use the [aws.obj.withTimeouts](TODO) +function. + + +**Args**: + - `resourceLabel` (`string`): The name label of the block to update. + - `value` (`obj`): The value to set for the `timeouts` field. + + ## obj customer_managed_policy_reference @@ -176,3 +218,27 @@ Terraform sub block. **Returns**: - An attribute object that represents the `customer_managed_policy_reference` sub block. + + +## obj timeouts + + + +### fn timeouts.new + +```ts +new() +``` + + +`aws.ssoadmin_customer_managed_policy_attachment.timeouts.new` constructs a new object with attributes and blocks configured for the `timeouts` +Terraform sub block. + + + +**Args**: + - `create` (`string`): Set the `create` field on the resulting object. When `null`, the `create` field will be omitted from the resulting object. + - `delete` (`string`): Set the `delete` field on the resulting object. When `null`, the `delete` field will be omitted from the resulting object. + +**Returns**: + - An attribute object that represents the `timeouts` sub block. diff --git a/docs/5.x/ssoadmin_managed_policy_attachment.md b/docs/5.x/ssoadmin_managed_policy_attachment.md index 1e229a20..d28e0c12 100644 --- a/docs/5.x/ssoadmin_managed_policy_attachment.md +++ b/docs/5.x/ssoadmin_managed_policy_attachment.md @@ -18,6 +18,10 @@ This package contains functions and utilities for setting up the resource using * [`fn withInstanceArn()`](#fn-withinstancearn) * [`fn withManagedPolicyArn()`](#fn-withmanagedpolicyarn) * [`fn withPermissionSetArn()`](#fn-withpermissionsetarn) +* [`fn withTimeouts()`](#fn-withtimeouts) +* [`fn withTimeoutsMixin()`](#fn-withtimeoutsmixin) +* [`obj timeouts`](#obj-timeouts) + * [`fn new()`](#fn-timeoutsnew) ## Fields @@ -51,6 +55,7 @@ or `$` to refer to the root object. Instead, make an explicit outer object using - `instance_arn` (`string`): Set the `instance_arn` field on the resulting resource block. - `managed_policy_arn` (`string`): Set the `managed_policy_arn` field on the resulting resource block. - `permission_set_arn` (`string`): Set the `permission_set_arn` field on the resulting resource block. + - `timeouts` (`obj`): Set the `timeouts` field on the resulting resource block. When `null`, the `timeouts` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [aws.ssoadmin_managed_policy_attachment.timeouts.new](#fn-timeoutsnew) constructor. **Returns**: - A mixin object that injects the new resource into the root Terraform configuration. @@ -77,6 +82,7 @@ injecting into a complete block. - `instance_arn` (`string`): Set the `instance_arn` field on the resulting object. - `managed_policy_arn` (`string`): Set the `managed_policy_arn` field on the resulting object. - `permission_set_arn` (`string`): Set the `permission_set_arn` field on the resulting object. + - `timeouts` (`obj`): Set the `timeouts` field on the resulting object. When `null`, the `timeouts` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [aws.ssoadmin_managed_policy_attachment.timeouts.new](#fn-timeoutsnew) constructor. **Returns**: - An attribute object that can be used with [tf.withResource](https://github.com/tf-libsonnet/core/tree/main/docs#fn-withresource) to construct a new `ssoadmin_managed_policy_attachment` resource into the root Terraform configuration. @@ -128,3 +134,63 @@ Terraform resource block to set or update the permission_set_arn field. **Args**: - `resourceLabel` (`string`): The name label of the block to update. - `value` (`string`): The value to set for the `permission_set_arn` field. + + +### fn withTimeouts + +```ts +withTimeouts() +``` + +`aws.obj.withTimeouts` constructs a mixin object that can be merged into the `obj` +Terraform resource block to set or update the timeouts field. + +This function will replace the map with the passed in `value`. If you wish to instead merge the +passed in value to the existing map, use the [aws.obj.withTimeoutsMixin](TODO) function. + +**Args**: + - `resourceLabel` (`string`): The name label of the block to update. + - `value` (`obj`): The value to set for the `timeouts` field. + + +### fn withTimeoutsMixin + +```ts +withTimeoutsMixin() +``` + +`aws.obj.withTimeoutsMixin` constructs a mixin object that can be merged into the `obj` +Terraform resource block to set or update the timeouts field. + +This function will merge the passed in value to the existing map. If you wish +to instead replace the entire map with the passed in `value`, use the [aws.obj.withTimeouts](TODO) +function. + + +**Args**: + - `resourceLabel` (`string`): The name label of the block to update. + - `value` (`obj`): The value to set for the `timeouts` field. + + +## obj timeouts + + + +### fn timeouts.new + +```ts +new() +``` + + +`aws.ssoadmin_managed_policy_attachment.timeouts.new` constructs a new object with attributes and blocks configured for the `timeouts` +Terraform sub block. + + + +**Args**: + - `create` (`string`): Set the `create` field on the resulting object. When `null`, the `create` field will be omitted from the resulting object. + - `delete` (`string`): Set the `delete` field on the resulting object. When `null`, the `delete` field will be omitted from the resulting object. + +**Returns**: + - An attribute object that represents the `timeouts` sub block. diff --git a/docs/5.x/ssoadmin_permission_set.md b/docs/5.x/ssoadmin_permission_set.md index f56cc429..c79c0f50 100644 --- a/docs/5.x/ssoadmin_permission_set.md +++ b/docs/5.x/ssoadmin_permission_set.md @@ -22,6 +22,10 @@ This package contains functions and utilities for setting up the resource using * [`fn withSessionDuration()`](#fn-withsessionduration) * [`fn withTags()`](#fn-withtags) * [`fn withTagsAll()`](#fn-withtagsall) +* [`fn withTimeouts()`](#fn-withtimeouts) +* [`fn withTimeoutsMixin()`](#fn-withtimeoutsmixin) +* [`obj timeouts`](#obj-timeouts) + * [`fn new()`](#fn-timeoutsnew) ## Fields @@ -59,6 +63,7 @@ or `$` to refer to the root object. Instead, make an explicit outer object using - `session_duration` (`string`): Set the `session_duration` field on the resulting resource block. When `null`, the `session_duration` field will be omitted from the resulting object. - `tags` (`obj`): Set the `tags` field on the resulting resource block. When `null`, the `tags` field will be omitted from the resulting object. - `tags_all` (`obj`): Set the `tags_all` field on the resulting resource block. When `null`, the `tags_all` field will be omitted from the resulting object. + - `timeouts` (`obj`): Set the `timeouts` field on the resulting resource block. When `null`, the `timeouts` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [aws.ssoadmin_permission_set.timeouts.new](#fn-timeoutsnew) constructor. **Returns**: - A mixin object that injects the new resource into the root Terraform configuration. @@ -89,6 +94,7 @@ injecting into a complete block. - `session_duration` (`string`): Set the `session_duration` field on the resulting object. When `null`, the `session_duration` field will be omitted from the resulting object. - `tags` (`obj`): Set the `tags` field on the resulting object. When `null`, the `tags` field will be omitted from the resulting object. - `tags_all` (`obj`): Set the `tags_all` field on the resulting object. When `null`, the `tags_all` field will be omitted from the resulting object. + - `timeouts` (`obj`): Set the `timeouts` field on the resulting object. When `null`, the `timeouts` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [aws.ssoadmin_permission_set.timeouts.new](#fn-timeoutsnew) constructor. **Returns**: - An attribute object that can be used with [tf.withResource](https://github.com/tf-libsonnet/core/tree/main/docs#fn-withresource) to construct a new `ssoadmin_permission_set` resource into the root Terraform configuration. @@ -204,3 +210,62 @@ Terraform resource block to set or update the tags_all field. **Args**: - `resourceLabel` (`string`): The name label of the block to update. - `value` (`obj`): The value to set for the `tags_all` field. + + +### fn withTimeouts + +```ts +withTimeouts() +``` + +`aws.obj.withTimeouts` constructs a mixin object that can be merged into the `obj` +Terraform resource block to set or update the timeouts field. + +This function will replace the map with the passed in `value`. If you wish to instead merge the +passed in value to the existing map, use the [aws.obj.withTimeoutsMixin](TODO) function. + +**Args**: + - `resourceLabel` (`string`): The name label of the block to update. + - `value` (`obj`): The value to set for the `timeouts` field. + + +### fn withTimeoutsMixin + +```ts +withTimeoutsMixin() +``` + +`aws.obj.withTimeoutsMixin` constructs a mixin object that can be merged into the `obj` +Terraform resource block to set or update the timeouts field. + +This function will merge the passed in value to the existing map. If you wish +to instead replace the entire map with the passed in `value`, use the [aws.obj.withTimeouts](TODO) +function. + + +**Args**: + - `resourceLabel` (`string`): The name label of the block to update. + - `value` (`obj`): The value to set for the `timeouts` field. + + +## obj timeouts + + + +### fn timeouts.new + +```ts +new() +``` + + +`aws.ssoadmin_permission_set.timeouts.new` constructs a new object with attributes and blocks configured for the `timeouts` +Terraform sub block. + + + +**Args**: + - `update` (`string`): Set the `update` field on the resulting object. When `null`, the `update` field will be omitted from the resulting object. + +**Returns**: + - An attribute object that represents the `timeouts` sub block. diff --git a/docs/5.x/ssoadmin_permission_set_inline_policy.md b/docs/5.x/ssoadmin_permission_set_inline_policy.md index 468d92b2..ca21c6bc 100644 --- a/docs/5.x/ssoadmin_permission_set_inline_policy.md +++ b/docs/5.x/ssoadmin_permission_set_inline_policy.md @@ -18,6 +18,10 @@ This package contains functions and utilities for setting up the resource using * [`fn withInlinePolicy()`](#fn-withinlinepolicy) * [`fn withInstanceArn()`](#fn-withinstancearn) * [`fn withPermissionSetArn()`](#fn-withpermissionsetarn) +* [`fn withTimeouts()`](#fn-withtimeouts) +* [`fn withTimeoutsMixin()`](#fn-withtimeoutsmixin) +* [`obj timeouts`](#obj-timeouts) + * [`fn new()`](#fn-timeoutsnew) ## Fields @@ -51,6 +55,7 @@ or `$` to refer to the root object. Instead, make an explicit outer object using - `inline_policy` (`string`): Set the `inline_policy` field on the resulting resource block. - `instance_arn` (`string`): Set the `instance_arn` field on the resulting resource block. - `permission_set_arn` (`string`): Set the `permission_set_arn` field on the resulting resource block. + - `timeouts` (`obj`): Set the `timeouts` field on the resulting resource block. When `null`, the `timeouts` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [aws.ssoadmin_permission_set_inline_policy.timeouts.new](#fn-timeoutsnew) constructor. **Returns**: - A mixin object that injects the new resource into the root Terraform configuration. @@ -77,6 +82,7 @@ injecting into a complete block. - `inline_policy` (`string`): Set the `inline_policy` field on the resulting object. - `instance_arn` (`string`): Set the `instance_arn` field on the resulting object. - `permission_set_arn` (`string`): Set the `permission_set_arn` field on the resulting object. + - `timeouts` (`obj`): Set the `timeouts` field on the resulting object. When `null`, the `timeouts` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [aws.ssoadmin_permission_set_inline_policy.timeouts.new](#fn-timeoutsnew) constructor. **Returns**: - An attribute object that can be used with [tf.withResource](https://github.com/tf-libsonnet/core/tree/main/docs#fn-withresource) to construct a new `ssoadmin_permission_set_inline_policy` resource into the root Terraform configuration. @@ -128,3 +134,63 @@ Terraform resource block to set or update the permission_set_arn field. **Args**: - `resourceLabel` (`string`): The name label of the block to update. - `value` (`string`): The value to set for the `permission_set_arn` field. + + +### fn withTimeouts + +```ts +withTimeouts() +``` + +`aws.obj.withTimeouts` constructs a mixin object that can be merged into the `obj` +Terraform resource block to set or update the timeouts field. + +This function will replace the map with the passed in `value`. If you wish to instead merge the +passed in value to the existing map, use the [aws.obj.withTimeoutsMixin](TODO) function. + +**Args**: + - `resourceLabel` (`string`): The name label of the block to update. + - `value` (`obj`): The value to set for the `timeouts` field. + + +### fn withTimeoutsMixin + +```ts +withTimeoutsMixin() +``` + +`aws.obj.withTimeoutsMixin` constructs a mixin object that can be merged into the `obj` +Terraform resource block to set or update the timeouts field. + +This function will merge the passed in value to the existing map. If you wish +to instead replace the entire map with the passed in `value`, use the [aws.obj.withTimeouts](TODO) +function. + + +**Args**: + - `resourceLabel` (`string`): The name label of the block to update. + - `value` (`obj`): The value to set for the `timeouts` field. + + +## obj timeouts + + + +### fn timeouts.new + +```ts +new() +``` + + +`aws.ssoadmin_permission_set_inline_policy.timeouts.new` constructs a new object with attributes and blocks configured for the `timeouts` +Terraform sub block. + + + +**Args**: + - `create` (`string`): Set the `create` field on the resulting object. When `null`, the `create` field will be omitted from the resulting object. + - `delete` (`string`): Set the `delete` field on the resulting object. When `null`, the `delete` field will be omitted from the resulting object. + +**Returns**: + - An attribute object that represents the `timeouts` sub block. diff --git a/docs/5.x/ssoadmin_permissions_boundary_attachment.md b/docs/5.x/ssoadmin_permissions_boundary_attachment.md index f9d1bd6a..18a30331 100644 --- a/docs/5.x/ssoadmin_permissions_boundary_attachment.md +++ b/docs/5.x/ssoadmin_permissions_boundary_attachment.md @@ -19,10 +19,14 @@ This package contains functions and utilities for setting up the resource using * [`fn withPermissionSetArn()`](#fn-withpermissionsetarn) * [`fn withPermissionsBoundary()`](#fn-withpermissionsboundary) * [`fn withPermissionsBoundaryMixin()`](#fn-withpermissionsboundarymixin) +* [`fn withTimeouts()`](#fn-withtimeouts) +* [`fn withTimeoutsMixin()`](#fn-withtimeoutsmixin) * [`obj permissions_boundary`](#obj-permissions_boundary) * [`fn new()`](#fn-permissions_boundarynew) * [`obj permissions_boundary.customer_managed_policy_reference`](#obj-permissions_boundarycustomer_managed_policy_reference) * [`fn new()`](#fn-permissions_boundarycustomer_managed_policy_referencenew) +* [`obj timeouts`](#obj-timeouts) + * [`fn new()`](#fn-timeoutsnew) ## Fields @@ -56,6 +60,7 @@ or `$` to refer to the root object. Instead, make an explicit outer object using - `instance_arn` (`string`): Set the `instance_arn` field on the resulting resource block. - `permission_set_arn` (`string`): Set the `permission_set_arn` field on the resulting resource block. - `permissions_boundary` (`list[obj]`): Set the `permissions_boundary` field on the resulting resource block. When `null`, the `permissions_boundary` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [aws.ssoadmin_permissions_boundary_attachment.permissions_boundary.new](#fn-permissions_boundarynew) constructor. + - `timeouts` (`obj`): Set the `timeouts` field on the resulting resource block. When `null`, the `timeouts` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [aws.ssoadmin_permissions_boundary_attachment.timeouts.new](#fn-timeoutsnew) constructor. **Returns**: - A mixin object that injects the new resource into the root Terraform configuration. @@ -82,6 +87,7 @@ injecting into a complete block. - `instance_arn` (`string`): Set the `instance_arn` field on the resulting object. - `permission_set_arn` (`string`): Set the `permission_set_arn` field on the resulting object. - `permissions_boundary` (`list[obj]`): Set the `permissions_boundary` field on the resulting object. When `null`, the `permissions_boundary` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [aws.ssoadmin_permissions_boundary_attachment.permissions_boundary.new](#fn-permissions_boundarynew) constructor. + - `timeouts` (`obj`): Set the `timeouts` field on the resulting object. When `null`, the `timeouts` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [aws.ssoadmin_permissions_boundary_attachment.timeouts.new](#fn-timeoutsnew) constructor. **Returns**: - An attribute object that can be used with [tf.withResource](https://github.com/tf-libsonnet/core/tree/main/docs#fn-withresource) to construct a new `ssoadmin_permissions_boundary_attachment` resource into the root Terraform configuration. @@ -156,6 +162,42 @@ function. - `value` (`list[obj]`): The value to set for the `permissions_boundary` field. +### fn withTimeouts + +```ts +withTimeouts() +``` + +`aws.obj.withTimeouts` constructs a mixin object that can be merged into the `obj` +Terraform resource block to set or update the timeouts field. + +This function will replace the map with the passed in `value`. If you wish to instead merge the +passed in value to the existing map, use the [aws.obj.withTimeoutsMixin](TODO) function. + +**Args**: + - `resourceLabel` (`string`): The name label of the block to update. + - `value` (`obj`): The value to set for the `timeouts` field. + + +### fn withTimeoutsMixin + +```ts +withTimeoutsMixin() +``` + +`aws.obj.withTimeoutsMixin` constructs a mixin object that can be merged into the `obj` +Terraform resource block to set or update the timeouts field. + +This function will merge the passed in value to the existing map. If you wish +to instead replace the entire map with the passed in `value`, use the [aws.obj.withTimeouts](TODO) +function. + + +**Args**: + - `resourceLabel` (`string`): The name label of the block to update. + - `value` (`obj`): The value to set for the `timeouts` field. + + ## obj permissions_boundary @@ -202,3 +244,27 @@ Terraform sub block. **Returns**: - An attribute object that represents the `customer_managed_policy_reference` sub block. + + +## obj timeouts + + + +### fn timeouts.new + +```ts +new() +``` + + +`aws.ssoadmin_permissions_boundary_attachment.timeouts.new` constructs a new object with attributes and blocks configured for the `timeouts` +Terraform sub block. + + + +**Args**: + - `create` (`string`): Set the `create` field on the resulting object. When `null`, the `create` field will be omitted from the resulting object. + - `delete` (`string`): Set the `delete` field on the resulting object. When `null`, the `delete` field will be omitted from the resulting object. + +**Returns**: + - An attribute object that represents the `timeouts` sub block. diff --git a/docs/5.x/transfer_connector.md b/docs/5.x/transfer_connector.md index 29cbfa30..e38fcc1f 100644 --- a/docs/5.x/transfer_connector.md +++ b/docs/5.x/transfer_connector.md @@ -19,11 +19,15 @@ This package contains functions and utilities for setting up the resource using * [`fn withAs2Config()`](#fn-withas2config) * [`fn withAs2ConfigMixin()`](#fn-withas2configmixin) * [`fn withLoggingRole()`](#fn-withloggingrole) +* [`fn withSftpConfig()`](#fn-withsftpconfig) +* [`fn withSftpConfigMixin()`](#fn-withsftpconfigmixin) * [`fn withTags()`](#fn-withtags) * [`fn withTagsAll()`](#fn-withtagsall) * [`fn withUrl()`](#fn-withurl) * [`obj as2_config`](#obj-as2_config) * [`fn new()`](#fn-as2_confignew) +* [`obj sftp_config`](#obj-sftp_config) + * [`fn new()`](#fn-sftp_confignew) ## Fields @@ -60,6 +64,7 @@ or `$` to refer to the root object. Instead, make an explicit outer object using - `tags_all` (`obj`): Set the `tags_all` field on the resulting resource block. When `null`, the `tags_all` field will be omitted from the resulting object. - `url` (`string`): Set the `url` field on the resulting resource block. - `as2_config` (`list[obj]`): Set the `as2_config` field on the resulting resource block. When `null`, the `as2_config` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [aws.transfer_connector.as2_config.new](#fn-as2_confignew) constructor. + - `sftp_config` (`list[obj]`): Set the `sftp_config` field on the resulting resource block. When `null`, the `sftp_config` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [aws.transfer_connector.sftp_config.new](#fn-sftp_confignew) constructor. **Returns**: - A mixin object that injects the new resource into the root Terraform configuration. @@ -89,6 +94,7 @@ injecting into a complete block. - `tags_all` (`obj`): Set the `tags_all` field on the resulting object. When `null`, the `tags_all` field will be omitted from the resulting object. - `url` (`string`): Set the `url` field on the resulting object. - `as2_config` (`list[obj]`): Set the `as2_config` field on the resulting object. When `null`, the `as2_config` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [aws.transfer_connector.as2_config.new](#fn-as2_confignew) constructor. + - `sftp_config` (`list[obj]`): Set the `sftp_config` field on the resulting object. When `null`, the `sftp_config` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [aws.transfer_connector.sftp_config.new](#fn-sftp_confignew) constructor. **Returns**: - An attribute object that can be used with [tf.withResource](https://github.com/tf-libsonnet/core/tree/main/docs#fn-withresource) to construct a new `transfer_connector` resource into the root Terraform configuration. @@ -163,6 +169,43 @@ Terraform resource block to set or update the logging_role field. - `value` (`string`): The value to set for the `logging_role` field. +### fn withSftpConfig + +```ts +withSftpConfig() +``` + +`aws.list[obj].withSftpConfig` constructs a mixin object that can be merged into the `list[obj]` +Terraform resource block to set or update the sftp_config field. + +This function will replace the array with the passed in `value`. If you wish to instead append the +passed in value to the existing array, use the [aws.list[obj].withSftpConfigMixin](TODO) function. + + +**Args**: + - `resourceLabel` (`string`): The name label of the block to update. + - `value` (`list[obj]`): The value to set for the `sftp_config` field. + + +### fn withSftpConfigMixin + +```ts +withSftpConfigMixin() +``` + +`aws.list[obj].withSftpConfigMixin` constructs a mixin object that can be merged into the `list[obj]` +Terraform resource block to set or update the sftp_config field. + +This function will append the passed in array or object to the existing array. If you wish +to instead replace the array with the passed in `value`, use the [aws.list[obj].withSftpConfig](TODO) +function. + + +**Args**: + - `resourceLabel` (`string`): The name label of the block to update. + - `value` (`list[obj]`): The value to set for the `sftp_config` field. + + ### fn withTags ```ts @@ -239,3 +282,27 @@ Terraform sub block. **Returns**: - An attribute object that represents the `as2_config` sub block. + + +## obj sftp_config + + + +### fn sftp_config.new + +```ts +new() +``` + + +`aws.transfer_connector.sftp_config.new` constructs a new object with attributes and blocks configured for the `sftp_config` +Terraform sub block. + + + +**Args**: + - `trusted_host_keys` (`list`): Set the `trusted_host_keys` field on the resulting object. When `null`, the `trusted_host_keys` field will be omitted from the resulting object. + - `user_secret_id` (`string`): Set the `user_secret_id` field on the resulting object. When `null`, the `user_secret_id` field will be omitted from the resulting object. + +**Returns**: + - An attribute object that represents the `sftp_config` sub block. diff --git a/docs/5.x/verifiedaccess_instance.md b/docs/5.x/verifiedaccess_instance.md new file mode 100644 index 00000000..d649fb9c --- /dev/null +++ b/docs/5.x/verifiedaccess_instance.md @@ -0,0 +1,130 @@ +--- +permalink: /verifiedaccess_instance/ +--- + +# verifiedaccess_instance + +`verifiedaccess_instance` represents the `aws_verifiedaccess_instance` Terraform resource. + + + +This package contains functions and utilities for setting up the resource using Jsonnet code. + + +## Index + +* [`fn new()`](#fn-new) +* [`fn newAttrs()`](#fn-newattrs) +* [`fn withDescription()`](#fn-withdescription) +* [`fn withTags()`](#fn-withtags) +* [`fn withTagsAll()`](#fn-withtagsall) + +## Fields + +### fn new + +```ts +new() +``` + + +`aws.verifiedaccess_instance.new` injects a new `aws_verifiedaccess_instance` Terraform `resource` +block into the root module document. + +Additionally, this inserts a private function into the `_ref` attribute that generates references to attributes of the +resource. For example, if you added a new instance to the root using: + + # arguments omitted for brevity + aws.verifiedaccess_instance.new('some_id') + +You can get the reference to the `id` field of the created `aws.verifiedaccess_instance` using the reference: + + $._ref.aws_verifiedaccess_instance.some_id.get('id') + +This is the same as directly entering `"${ aws_verifiedaccess_instance.some_id.id }"` as the value. + +NOTE: if you are chaining multiple resources together in a merge operation, you may not be able to use `super`, `self`, +or `$` to refer to the root object. Instead, make an explicit outer object using `local`. + +**Args**: + - `resourceLabel` (`string`): The name label of the block. + - `description` (`string`): Set the `description` field on the resulting resource block. When `null`, the `description` field will be omitted from the resulting object. + - `tags` (`obj`): Set the `tags` field on the resulting resource block. When `null`, the `tags` field will be omitted from the resulting object. + - `tags_all` (`obj`): Set the `tags_all` field on the resulting resource block. When `null`, the `tags_all` field will be omitted from the resulting object. + +**Returns**: +- A mixin object that injects the new resource into the root Terraform configuration. + + +### fn newAttrs + +```ts +newAttrs() +``` + + +`aws.verifiedaccess_instance.newAttrs` constructs a new object with attributes and blocks configured for the `verifiedaccess_instance` +Terraform resource. + +Unlike [aws.verifiedaccess_instance.new](#fn-new), this function will not inject the `resource` +block into the root Terraform document. Instead, this must be passed in as the `attrs` argument for the +[tf.withResource](https://github.com/tf-libsonnet/core/tree/main/docs#fn-withresource) function to build a complete block. + +This is most useful when you need to preprocess the attributes with functions, conditional, or looping logic prior to +injecting into a complete block. + +**Args**: + - `description` (`string`): Set the `description` field on the resulting object. When `null`, the `description` field will be omitted from the resulting object. + - `tags` (`obj`): Set the `tags` field on the resulting object. When `null`, the `tags` field will be omitted from the resulting object. + - `tags_all` (`obj`): Set the `tags_all` field on the resulting object. When `null`, the `tags_all` field will be omitted from the resulting object. + +**Returns**: + - An attribute object that can be used with [tf.withResource](https://github.com/tf-libsonnet/core/tree/main/docs#fn-withresource) to construct a new `verifiedaccess_instance` resource into the root Terraform configuration. + + +### fn withDescription + +```ts +withDescription() +``` + +`aws.string.withDescription` constructs a mixin object that can be merged into the `string` +Terraform resource block to set or update the description field. + + + +**Args**: + - `resourceLabel` (`string`): The name label of the block to update. + - `value` (`string`): The value to set for the `description` field. + + +### fn withTags + +```ts +withTags() +``` + +`aws.obj.withTags` constructs a mixin object that can be merged into the `obj` +Terraform resource block to set or update the tags field. + + + +**Args**: + - `resourceLabel` (`string`): The name label of the block to update. + - `value` (`obj`): The value to set for the `tags` field. + + +### fn withTagsAll + +```ts +withTagsAll() +``` + +`aws.obj.withTagsAll` constructs a mixin object that can be merged into the `obj` +Terraform resource block to set or update the tags_all field. + + + +**Args**: + - `resourceLabel` (`string`): The name label of the block to update. + - `value` (`obj`): The value to set for the `tags_all` field. diff --git a/docs/5.x/verifiedaccess_trust_provider.md b/docs/5.x/verifiedaccess_trust_provider.md new file mode 100644 index 00000000..0daa91b7 --- /dev/null +++ b/docs/5.x/verifiedaccess_trust_provider.md @@ -0,0 +1,411 @@ +--- +permalink: /verifiedaccess_trust_provider/ +--- + +# verifiedaccess_trust_provider + +`verifiedaccess_trust_provider` represents the `aws_verifiedaccess_trust_provider` Terraform resource. + + + +This package contains functions and utilities for setting up the resource using Jsonnet code. + + +## Index + +* [`fn new()`](#fn-new) +* [`fn newAttrs()`](#fn-newattrs) +* [`fn withDescription()`](#fn-withdescription) +* [`fn withDeviceOptions()`](#fn-withdeviceoptions) +* [`fn withDeviceOptionsMixin()`](#fn-withdeviceoptionsmixin) +* [`fn withDeviceTrustProviderType()`](#fn-withdevicetrustprovidertype) +* [`fn withOidcOptions()`](#fn-withoidcoptions) +* [`fn withOidcOptionsMixin()`](#fn-withoidcoptionsmixin) +* [`fn withPolicyReferenceName()`](#fn-withpolicyreferencename) +* [`fn withTags()`](#fn-withtags) +* [`fn withTagsAll()`](#fn-withtagsall) +* [`fn withTimeouts()`](#fn-withtimeouts) +* [`fn withTimeoutsMixin()`](#fn-withtimeoutsmixin) +* [`fn withTrustProviderType()`](#fn-withtrustprovidertype) +* [`fn withUserTrustProviderType()`](#fn-withusertrustprovidertype) +* [`obj device_options`](#obj-device_options) + * [`fn new()`](#fn-device_optionsnew) +* [`obj oidc_options`](#obj-oidc_options) + * [`fn new()`](#fn-oidc_optionsnew) +* [`obj timeouts`](#obj-timeouts) + * [`fn new()`](#fn-timeoutsnew) + +## Fields + +### fn new + +```ts +new() +``` + + +`aws.verifiedaccess_trust_provider.new` injects a new `aws_verifiedaccess_trust_provider` Terraform `resource` +block into the root module document. + +Additionally, this inserts a private function into the `_ref` attribute that generates references to attributes of the +resource. For example, if you added a new instance to the root using: + + # arguments omitted for brevity + aws.verifiedaccess_trust_provider.new('some_id') + +You can get the reference to the `id` field of the created `aws.verifiedaccess_trust_provider` using the reference: + + $._ref.aws_verifiedaccess_trust_provider.some_id.get('id') + +This is the same as directly entering `"${ aws_verifiedaccess_trust_provider.some_id.id }"` as the value. + +NOTE: if you are chaining multiple resources together in a merge operation, you may not be able to use `super`, `self`, +or `$` to refer to the root object. Instead, make an explicit outer object using `local`. + +**Args**: + - `resourceLabel` (`string`): The name label of the block. + - `description` (`string`): Set the `description` field on the resulting resource block. When `null`, the `description` field will be omitted from the resulting object. + - `device_trust_provider_type` (`string`): Set the `device_trust_provider_type` field on the resulting resource block. When `null`, the `device_trust_provider_type` field will be omitted from the resulting object. + - `policy_reference_name` (`string`): Set the `policy_reference_name` field on the resulting resource block. + - `tags` (`obj`): Set the `tags` field on the resulting resource block. When `null`, the `tags` field will be omitted from the resulting object. + - `tags_all` (`obj`): Set the `tags_all` field on the resulting resource block. When `null`, the `tags_all` field will be omitted from the resulting object. + - `trust_provider_type` (`string`): Set the `trust_provider_type` field on the resulting resource block. + - `user_trust_provider_type` (`string`): Set the `user_trust_provider_type` field on the resulting resource block. When `null`, the `user_trust_provider_type` field will be omitted from the resulting object. + - `device_options` (`list[obj]`): Set the `device_options` field on the resulting resource block. When `null`, the `device_options` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [aws.verifiedaccess_trust_provider.device_options.new](#fn-device_optionsnew) constructor. + - `oidc_options` (`list[obj]`): Set the `oidc_options` field on the resulting resource block. When `null`, the `oidc_options` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [aws.verifiedaccess_trust_provider.oidc_options.new](#fn-oidc_optionsnew) constructor. + - `timeouts` (`obj`): Set the `timeouts` field on the resulting resource block. When `null`, the `timeouts` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [aws.verifiedaccess_trust_provider.timeouts.new](#fn-timeoutsnew) constructor. + +**Returns**: +- A mixin object that injects the new resource into the root Terraform configuration. + + +### fn newAttrs + +```ts +newAttrs() +``` + + +`aws.verifiedaccess_trust_provider.newAttrs` constructs a new object with attributes and blocks configured for the `verifiedaccess_trust_provider` +Terraform resource. + +Unlike [aws.verifiedaccess_trust_provider.new](#fn-new), this function will not inject the `resource` +block into the root Terraform document. Instead, this must be passed in as the `attrs` argument for the +[tf.withResource](https://github.com/tf-libsonnet/core/tree/main/docs#fn-withresource) function to build a complete block. + +This is most useful when you need to preprocess the attributes with functions, conditional, or looping logic prior to +injecting into a complete block. + +**Args**: + - `description` (`string`): Set the `description` field on the resulting object. When `null`, the `description` field will be omitted from the resulting object. + - `device_trust_provider_type` (`string`): Set the `device_trust_provider_type` field on the resulting object. When `null`, the `device_trust_provider_type` field will be omitted from the resulting object. + - `policy_reference_name` (`string`): Set the `policy_reference_name` field on the resulting object. + - `tags` (`obj`): Set the `tags` field on the resulting object. When `null`, the `tags` field will be omitted from the resulting object. + - `tags_all` (`obj`): Set the `tags_all` field on the resulting object. When `null`, the `tags_all` field will be omitted from the resulting object. + - `trust_provider_type` (`string`): Set the `trust_provider_type` field on the resulting object. + - `user_trust_provider_type` (`string`): Set the `user_trust_provider_type` field on the resulting object. When `null`, the `user_trust_provider_type` field will be omitted from the resulting object. + - `device_options` (`list[obj]`): Set the `device_options` field on the resulting object. When `null`, the `device_options` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [aws.verifiedaccess_trust_provider.device_options.new](#fn-device_optionsnew) constructor. + - `oidc_options` (`list[obj]`): Set the `oidc_options` field on the resulting object. When `null`, the `oidc_options` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [aws.verifiedaccess_trust_provider.oidc_options.new](#fn-oidc_optionsnew) constructor. + - `timeouts` (`obj`): Set the `timeouts` field on the resulting object. When `null`, the `timeouts` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [aws.verifiedaccess_trust_provider.timeouts.new](#fn-timeoutsnew) constructor. + +**Returns**: + - An attribute object that can be used with [tf.withResource](https://github.com/tf-libsonnet/core/tree/main/docs#fn-withresource) to construct a new `verifiedaccess_trust_provider` resource into the root Terraform configuration. + + +### fn withDescription + +```ts +withDescription() +``` + +`aws.string.withDescription` constructs a mixin object that can be merged into the `string` +Terraform resource block to set or update the description field. + + + +**Args**: + - `resourceLabel` (`string`): The name label of the block to update. + - `value` (`string`): The value to set for the `description` field. + + +### fn withDeviceOptions + +```ts +withDeviceOptions() +``` + +`aws.list[obj].withDeviceOptions` constructs a mixin object that can be merged into the `list[obj]` +Terraform resource block to set or update the device_options field. + +This function will replace the array with the passed in `value`. If you wish to instead append the +passed in value to the existing array, use the [aws.list[obj].withDeviceOptionsMixin](TODO) function. + + +**Args**: + - `resourceLabel` (`string`): The name label of the block to update. + - `value` (`list[obj]`): The value to set for the `device_options` field. + + +### fn withDeviceOptionsMixin + +```ts +withDeviceOptionsMixin() +``` + +`aws.list[obj].withDeviceOptionsMixin` constructs a mixin object that can be merged into the `list[obj]` +Terraform resource block to set or update the device_options field. + +This function will append the passed in array or object to the existing array. If you wish +to instead replace the array with the passed in `value`, use the [aws.list[obj].withDeviceOptions](TODO) +function. + + +**Args**: + - `resourceLabel` (`string`): The name label of the block to update. + - `value` (`list[obj]`): The value to set for the `device_options` field. + + +### fn withDeviceTrustProviderType + +```ts +withDeviceTrustProviderType() +``` + +`aws.string.withDeviceTrustProviderType` constructs a mixin object that can be merged into the `string` +Terraform resource block to set or update the device_trust_provider_type field. + + + +**Args**: + - `resourceLabel` (`string`): The name label of the block to update. + - `value` (`string`): The value to set for the `device_trust_provider_type` field. + + +### fn withOidcOptions + +```ts +withOidcOptions() +``` + +`aws.list[obj].withOidcOptions` constructs a mixin object that can be merged into the `list[obj]` +Terraform resource block to set or update the oidc_options field. + +This function will replace the array with the passed in `value`. If you wish to instead append the +passed in value to the existing array, use the [aws.list[obj].withOidcOptionsMixin](TODO) function. + + +**Args**: + - `resourceLabel` (`string`): The name label of the block to update. + - `value` (`list[obj]`): The value to set for the `oidc_options` field. + + +### fn withOidcOptionsMixin + +```ts +withOidcOptionsMixin() +``` + +`aws.list[obj].withOidcOptionsMixin` constructs a mixin object that can be merged into the `list[obj]` +Terraform resource block to set or update the oidc_options field. + +This function will append the passed in array or object to the existing array. If you wish +to instead replace the array with the passed in `value`, use the [aws.list[obj].withOidcOptions](TODO) +function. + + +**Args**: + - `resourceLabel` (`string`): The name label of the block to update. + - `value` (`list[obj]`): The value to set for the `oidc_options` field. + + +### fn withPolicyReferenceName + +```ts +withPolicyReferenceName() +``` + +`aws.string.withPolicyReferenceName` constructs a mixin object that can be merged into the `string` +Terraform resource block to set or update the policy_reference_name field. + + + +**Args**: + - `resourceLabel` (`string`): The name label of the block to update. + - `value` (`string`): The value to set for the `policy_reference_name` field. + + +### fn withTags + +```ts +withTags() +``` + +`aws.obj.withTags` constructs a mixin object that can be merged into the `obj` +Terraform resource block to set or update the tags field. + + + +**Args**: + - `resourceLabel` (`string`): The name label of the block to update. + - `value` (`obj`): The value to set for the `tags` field. + + +### fn withTagsAll + +```ts +withTagsAll() +``` + +`aws.obj.withTagsAll` constructs a mixin object that can be merged into the `obj` +Terraform resource block to set or update the tags_all field. + + + +**Args**: + - `resourceLabel` (`string`): The name label of the block to update. + - `value` (`obj`): The value to set for the `tags_all` field. + + +### fn withTimeouts + +```ts +withTimeouts() +``` + +`aws.obj.withTimeouts` constructs a mixin object that can be merged into the `obj` +Terraform resource block to set or update the timeouts field. + +This function will replace the map with the passed in `value`. If you wish to instead merge the +passed in value to the existing map, use the [aws.obj.withTimeoutsMixin](TODO) function. + +**Args**: + - `resourceLabel` (`string`): The name label of the block to update. + - `value` (`obj`): The value to set for the `timeouts` field. + + +### fn withTimeoutsMixin + +```ts +withTimeoutsMixin() +``` + +`aws.obj.withTimeoutsMixin` constructs a mixin object that can be merged into the `obj` +Terraform resource block to set or update the timeouts field. + +This function will merge the passed in value to the existing map. If you wish +to instead replace the entire map with the passed in `value`, use the [aws.obj.withTimeouts](TODO) +function. + + +**Args**: + - `resourceLabel` (`string`): The name label of the block to update. + - `value` (`obj`): The value to set for the `timeouts` field. + + +### fn withTrustProviderType + +```ts +withTrustProviderType() +``` + +`aws.string.withTrustProviderType` constructs a mixin object that can be merged into the `string` +Terraform resource block to set or update the trust_provider_type field. + + + +**Args**: + - `resourceLabel` (`string`): The name label of the block to update. + - `value` (`string`): The value to set for the `trust_provider_type` field. + + +### fn withUserTrustProviderType + +```ts +withUserTrustProviderType() +``` + +`aws.string.withUserTrustProviderType` constructs a mixin object that can be merged into the `string` +Terraform resource block to set or update the user_trust_provider_type field. + + + +**Args**: + - `resourceLabel` (`string`): The name label of the block to update. + - `value` (`string`): The value to set for the `user_trust_provider_type` field. + + +## obj device_options + + + +### fn device_options.new + +```ts +new() +``` + + +`aws.verifiedaccess_trust_provider.device_options.new` constructs a new object with attributes and blocks configured for the `device_options` +Terraform sub block. + + + +**Args**: + - `tenant_id` (`string`): Set the `tenant_id` field on the resulting object. When `null`, the `tenant_id` field will be omitted from the resulting object. + +**Returns**: + - An attribute object that represents the `device_options` sub block. + + +## obj oidc_options + + + +### fn oidc_options.new + +```ts +new() +``` + + +`aws.verifiedaccess_trust_provider.oidc_options.new` constructs a new object with attributes and blocks configured for the `oidc_options` +Terraform sub block. + + + +**Args**: + - `authorization_endpoint` (`string`): Set the `authorization_endpoint` field on the resulting object. When `null`, the `authorization_endpoint` field will be omitted from the resulting object. + - `client_id` (`string`): Set the `client_id` field on the resulting object. When `null`, the `client_id` field will be omitted from the resulting object. + - `client_secret` (`string`): Set the `client_secret` field on the resulting object. + - `issuer` (`string`): Set the `issuer` field on the resulting object. When `null`, the `issuer` field will be omitted from the resulting object. + - `scope` (`string`): Set the `scope` field on the resulting object. When `null`, the `scope` field will be omitted from the resulting object. + - `token_endpoint` (`string`): Set the `token_endpoint` field on the resulting object. When `null`, the `token_endpoint` field will be omitted from the resulting object. + - `user_info_endpoint` (`string`): Set the `user_info_endpoint` field on the resulting object. When `null`, the `user_info_endpoint` field will be omitted from the resulting object. + +**Returns**: + - An attribute object that represents the `oidc_options` sub block. + + +## obj timeouts + + + +### fn timeouts.new + +```ts +new() +``` + + +`aws.verifiedaccess_trust_provider.timeouts.new` constructs a new object with attributes and blocks configured for the `timeouts` +Terraform sub block. + + + +**Args**: + - `create` (`string`): Set the `create` field on the resulting object. When `null`, the `create` field will be omitted from the resulting object. + - `delete` (`string`): Set the `delete` field on the resulting object. When `null`, the `delete` field will be omitted from the resulting object. + - `update` (`string`): Set the `update` field on the resulting object. When `null`, the `update` field will be omitted from the resulting object. + +**Returns**: + - An attribute object that represents the `timeouts` sub block. diff --git a/docs/5.x/wafv2_rule_group.md b/docs/5.x/wafv2_rule_group.md index 07d9fdc8..4a5c3e1b 100644 --- a/docs/5.x/wafv2_rule_group.md +++ b/docs/5.x/wafv2_rule_group.md @@ -20,6 +20,7 @@ This package contains functions and utilities for setting up the resource using * [`fn withCustomResponseBodyMixin()`](#fn-withcustomresponsebodymixin) * [`fn withDescription()`](#fn-withdescription) * [`fn withName()`](#fn-withname) +* [`fn withNamePrefix()`](#fn-withnameprefix) * [`fn withRule()`](#fn-withrule) * [`fn withRuleMixin()`](#fn-withrulemixin) * [`fn withScope()`](#fn-withscope) @@ -12931,7 +12932,8 @@ or `$` to refer to the root object. Instead, make an explicit outer object using - `resourceLabel` (`string`): The name label of the block. - `capacity` (`number`): Set the `capacity` field on the resulting resource block. - `description` (`string`): Set the `description` field on the resulting resource block. When `null`, the `description` field will be omitted from the resulting object. - - `name` (`string`): Set the `name` field on the resulting resource block. + - `name` (`string`): Set the `name` field on the resulting resource block. When `null`, the `name` field will be omitted from the resulting object. + - `name_prefix` (`string`): Set the `name_prefix` field on the resulting resource block. When `null`, the `name_prefix` field will be omitted from the resulting object. - `scope` (`string`): Set the `scope` field on the resulting resource block. - `tags` (`obj`): Set the `tags` field on the resulting resource block. When `null`, the `tags` field will be omitted from the resulting object. - `tags_all` (`obj`): Set the `tags_all` field on the resulting resource block. When `null`, the `tags_all` field will be omitted from the resulting object. @@ -12963,7 +12965,8 @@ injecting into a complete block. **Args**: - `capacity` (`number`): Set the `capacity` field on the resulting object. - `description` (`string`): Set the `description` field on the resulting object. When `null`, the `description` field will be omitted from the resulting object. - - `name` (`string`): Set the `name` field on the resulting object. + - `name` (`string`): Set the `name` field on the resulting object. When `null`, the `name` field will be omitted from the resulting object. + - `name_prefix` (`string`): Set the `name_prefix` field on the resulting object. When `null`, the `name_prefix` field will be omitted from the resulting object. - `scope` (`string`): Set the `scope` field on the resulting object. - `tags` (`obj`): Set the `tags` field on the resulting object. When `null`, the `tags` field will be omitted from the resulting object. - `tags_all` (`obj`): Set the `tags_all` field on the resulting object. When `null`, the `tags_all` field will be omitted from the resulting object. @@ -13060,6 +13063,22 @@ Terraform resource block to set or update the name field. - `value` (`string`): The value to set for the `name` field. +### fn withNamePrefix + +```ts +withNamePrefix() +``` + +`aws.string.withNamePrefix` constructs a mixin object that can be merged into the `string` +Terraform resource block to set or update the name_prefix field. + + + +**Args**: + - `resourceLabel` (`string`): The name label of the block to update. + - `value` (`string`): The value to set for the `name_prefix` field. + + ### fn withRule ```ts diff --git a/docs/5.x/wafv2_web_acl.md b/docs/5.x/wafv2_web_acl.md index 676e7cd5..6ce07244 100644 --- a/docs/5.x/wafv2_web_acl.md +++ b/docs/5.x/wafv2_web_acl.md @@ -3351,6 +3351,12 @@ This package contains functions and utilities for setting up the resource using * [`fn new()`](#fn-rulestatementmanaged_rule_group_statementrule_action_overrideaction_to_usecaptchacustom_request_handlingnew) * [`obj rule.statement.managed_rule_group_statement.rule_action_override.action_to_use.captcha.custom_request_handling.insert_header`](#obj-rulestatementmanaged_rule_group_statementrule_action_overrideaction_to_usecaptchacustom_request_handlinginsert_header) * [`fn new()`](#fn-rulestatementmanaged_rule_group_statementrule_action_overrideaction_to_usecaptchacustom_request_handlinginsert_headernew) + * [`obj rule.statement.managed_rule_group_statement.rule_action_override.action_to_use.challenge`](#obj-rulestatementmanaged_rule_group_statementrule_action_overrideaction_to_usechallenge) + * [`fn new()`](#fn-rulestatementmanaged_rule_group_statementrule_action_overrideaction_to_usechallengenew) + * [`obj rule.statement.managed_rule_group_statement.rule_action_override.action_to_use.challenge.custom_request_handling`](#obj-rulestatementmanaged_rule_group_statementrule_action_overrideaction_to_usechallengecustom_request_handling) + * [`fn new()`](#fn-rulestatementmanaged_rule_group_statementrule_action_overrideaction_to_usechallengecustom_request_handlingnew) + * [`obj rule.statement.managed_rule_group_statement.rule_action_override.action_to_use.challenge.custom_request_handling.insert_header`](#obj-rulestatementmanaged_rule_group_statementrule_action_overrideaction_to_usechallengecustom_request_handlinginsert_header) + * [`fn new()`](#fn-rulestatementmanaged_rule_group_statementrule_action_overrideaction_to_usechallengecustom_request_handlinginsert_headernew) * [`obj rule.statement.managed_rule_group_statement.rule_action_override.action_to_use.count`](#obj-rulestatementmanaged_rule_group_statementrule_action_overrideaction_to_usecount) * [`fn new()`](#fn-rulestatementmanaged_rule_group_statementrule_action_overrideaction_to_usecountnew) * [`obj rule.statement.managed_rule_group_statement.rule_action_override.action_to_use.count.custom_request_handling`](#obj-rulestatementmanaged_rule_group_statementrule_action_overrideaction_to_usecountcustom_request_handling) @@ -16041,6 +16047,12 @@ This package contains functions and utilities for setting up the resource using * [`fn new()`](#fn-rulestatementrule_group_reference_statementrule_action_overrideaction_to_usecaptchacustom_request_handlingnew) * [`obj rule.statement.rule_group_reference_statement.rule_action_override.action_to_use.captcha.custom_request_handling.insert_header`](#obj-rulestatementrule_group_reference_statementrule_action_overrideaction_to_usecaptchacustom_request_handlinginsert_header) * [`fn new()`](#fn-rulestatementrule_group_reference_statementrule_action_overrideaction_to_usecaptchacustom_request_handlinginsert_headernew) + * [`obj rule.statement.rule_group_reference_statement.rule_action_override.action_to_use.challenge`](#obj-rulestatementrule_group_reference_statementrule_action_overrideaction_to_usechallenge) + * [`fn new()`](#fn-rulestatementrule_group_reference_statementrule_action_overrideaction_to_usechallengenew) + * [`obj rule.statement.rule_group_reference_statement.rule_action_override.action_to_use.challenge.custom_request_handling`](#obj-rulestatementrule_group_reference_statementrule_action_overrideaction_to_usechallengecustom_request_handling) + * [`fn new()`](#fn-rulestatementrule_group_reference_statementrule_action_overrideaction_to_usechallengecustom_request_handlingnew) + * [`obj rule.statement.rule_group_reference_statement.rule_action_override.action_to_use.challenge.custom_request_handling.insert_header`](#obj-rulestatementrule_group_reference_statementrule_action_overrideaction_to_usechallengecustom_request_handlinginsert_header) + * [`fn new()`](#fn-rulestatementrule_group_reference_statementrule_action_overrideaction_to_usechallengecustom_request_handlinginsert_headernew) * [`obj rule.statement.rule_group_reference_statement.rule_action_override.action_to_use.count`](#obj-rulestatementrule_group_reference_statementrule_action_overrideaction_to_usecount) * [`fn new()`](#fn-rulestatementrule_group_reference_statementrule_action_overrideaction_to_usecountnew) * [`obj rule.statement.rule_group_reference_statement.rule_action_override.action_to_use.count.custom_request_handling`](#obj-rulestatementrule_group_reference_statementrule_action_overrideaction_to_usecountcustom_request_handling) @@ -54692,6 +54704,7 @@ Terraform sub block. **Args**: + - `enable_regex_in_path` (`bool`): Set the `enable_regex_in_path` field on the resulting object. When `null`, the `enable_regex_in_path` field will be omitted from the resulting object. - `login_path` (`string`): Set the `login_path` field on the resulting object. - `request_inspection` (`list[obj]`): Set the `request_inspection` field on the resulting object. When `null`, the `request_inspection` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [aws.wafv2_web_acl.rule.statement.managed_rule_group_statement.managed_rule_group_configs.aws_managed_rules_atp_rule_set.request_inspection.new](#fn-rulerulestatementmanaged_rule_group_statementmanaged_rule_group_configsrequest_inspectionnew) constructor. - `response_inspection` (`list[obj]`): Set the `response_inspection` field on the resulting object. When `null`, the `response_inspection` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [aws.wafv2_web_acl.rule.statement.managed_rule_group_statement.managed_rule_group_configs.aws_managed_rules_atp_rule_set.response_inspection.new](#fn-rulerulestatementmanaged_rule_group_statementmanaged_rule_group_configsresponse_inspectionnew) constructor. @@ -55008,6 +55021,7 @@ Terraform sub block. - `allow` (`list[obj]`): Set the `allow` field on the resulting object. When `null`, the `allow` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [aws.wafv2_web_acl.rule.statement.managed_rule_group_statement.rule_action_override.action_to_use.allow.new](#fn-rulerulestatementmanaged_rule_group_statementrule_action_overrideallownew) constructor. - `block` (`list[obj]`): Set the `block` field on the resulting object. When `null`, the `block` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [aws.wafv2_web_acl.rule.statement.managed_rule_group_statement.rule_action_override.action_to_use.block.new](#fn-rulerulestatementmanaged_rule_group_statementrule_action_overrideblocknew) constructor. - `captcha` (`list[obj]`): Set the `captcha` field on the resulting object. When `null`, the `captcha` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [aws.wafv2_web_acl.rule.statement.managed_rule_group_statement.rule_action_override.action_to_use.captcha.new](#fn-rulerulestatementmanaged_rule_group_statementrule_action_overridecaptchanew) constructor. + - `challenge` (`list[obj]`): Set the `challenge` field on the resulting object. When `null`, the `challenge` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [aws.wafv2_web_acl.rule.statement.managed_rule_group_statement.rule_action_override.action_to_use.challenge.new](#fn-rulerulestatementmanaged_rule_group_statementrule_action_overridechallengenew) constructor. - `count` (`list[obj]`): Set the `count` field on the resulting object. When `null`, the `count` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [aws.wafv2_web_acl.rule.statement.managed_rule_group_statement.rule_action_override.action_to_use.count.new](#fn-rulerulestatementmanaged_rule_group_statementrule_action_overridecountnew) constructor. **Returns**: @@ -55218,6 +55232,76 @@ Terraform sub block. +**Args**: + - `name` (`string`): Set the `name` field on the resulting object. + - `value` (`string`): Set the `value` field on the resulting object. + +**Returns**: + - An attribute object that represents the `insert_header` sub block. + + +## obj rule.statement.managed_rule_group_statement.rule_action_override.action_to_use.challenge + + + +### fn rule.statement.managed_rule_group_statement.rule_action_override.action_to_use.challenge.new + +```ts +new() +``` + + +`aws.wafv2_web_acl.rule.statement.managed_rule_group_statement.rule_action_override.action_to_use.challenge.new` constructs a new object with attributes and blocks configured for the `challenge` +Terraform sub block. + + + +**Args**: + - `custom_request_handling` (`list[obj]`): Set the `custom_request_handling` field on the resulting object. When `null`, the `custom_request_handling` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [aws.wafv2_web_acl.rule.statement.managed_rule_group_statement.rule_action_override.action_to_use.challenge.custom_request_handling.new](#fn-rulerulestatementmanaged_rule_group_statementrule_action_overrideaction_to_usecustom_request_handlingnew) constructor. + +**Returns**: + - An attribute object that represents the `challenge` sub block. + + +## obj rule.statement.managed_rule_group_statement.rule_action_override.action_to_use.challenge.custom_request_handling + + + +### fn rule.statement.managed_rule_group_statement.rule_action_override.action_to_use.challenge.custom_request_handling.new + +```ts +new() +``` + + +`aws.wafv2_web_acl.rule.statement.managed_rule_group_statement.rule_action_override.action_to_use.challenge.custom_request_handling.new` constructs a new object with attributes and blocks configured for the `custom_request_handling` +Terraform sub block. + + + +**Args**: + - `insert_header` (`list[obj]`): Set the `insert_header` field on the resulting object. When `null`, the `insert_header` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [aws.wafv2_web_acl.rule.statement.managed_rule_group_statement.rule_action_override.action_to_use.challenge.custom_request_handling.insert_header.new](#fn-rulerulestatementmanaged_rule_group_statementrule_action_overrideaction_to_usechallengeinsert_headernew) constructor. + +**Returns**: + - An attribute object that represents the `custom_request_handling` sub block. + + +## obj rule.statement.managed_rule_group_statement.rule_action_override.action_to_use.challenge.custom_request_handling.insert_header + + + +### fn rule.statement.managed_rule_group_statement.rule_action_override.action_to_use.challenge.custom_request_handling.insert_header.new + +```ts +new() +``` + + +`aws.wafv2_web_acl.rule.statement.managed_rule_group_statement.rule_action_override.action_to_use.challenge.custom_request_handling.insert_header.new` constructs a new object with attributes and blocks configured for the `insert_header` +Terraform sub block. + + + **Args**: - `name` (`string`): Set the `name` field on the resulting object. - `value` (`string`): Set the `value` field on the resulting object. @@ -202676,6 +202760,7 @@ Terraform sub block. - `allow` (`list[obj]`): Set the `allow` field on the resulting object. When `null`, the `allow` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [aws.wafv2_web_acl.rule.statement.rule_group_reference_statement.rule_action_override.action_to_use.allow.new](#fn-rulerulestatementrule_group_reference_statementrule_action_overrideallownew) constructor. - `block` (`list[obj]`): Set the `block` field on the resulting object. When `null`, the `block` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [aws.wafv2_web_acl.rule.statement.rule_group_reference_statement.rule_action_override.action_to_use.block.new](#fn-rulerulestatementrule_group_reference_statementrule_action_overrideblocknew) constructor. - `captcha` (`list[obj]`): Set the `captcha` field on the resulting object. When `null`, the `captcha` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [aws.wafv2_web_acl.rule.statement.rule_group_reference_statement.rule_action_override.action_to_use.captcha.new](#fn-rulerulestatementrule_group_reference_statementrule_action_overridecaptchanew) constructor. + - `challenge` (`list[obj]`): Set the `challenge` field on the resulting object. When `null`, the `challenge` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [aws.wafv2_web_acl.rule.statement.rule_group_reference_statement.rule_action_override.action_to_use.challenge.new](#fn-rulerulestatementrule_group_reference_statementrule_action_overridechallengenew) constructor. - `count` (`list[obj]`): Set the `count` field on the resulting object. When `null`, the `count` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [aws.wafv2_web_acl.rule.statement.rule_group_reference_statement.rule_action_override.action_to_use.count.new](#fn-rulerulestatementrule_group_reference_statementrule_action_overridecountnew) constructor. **Returns**: @@ -202886,6 +202971,76 @@ Terraform sub block. +**Args**: + - `name` (`string`): Set the `name` field on the resulting object. + - `value` (`string`): Set the `value` field on the resulting object. + +**Returns**: + - An attribute object that represents the `insert_header` sub block. + + +## obj rule.statement.rule_group_reference_statement.rule_action_override.action_to_use.challenge + + + +### fn rule.statement.rule_group_reference_statement.rule_action_override.action_to_use.challenge.new + +```ts +new() +``` + + +`aws.wafv2_web_acl.rule.statement.rule_group_reference_statement.rule_action_override.action_to_use.challenge.new` constructs a new object with attributes and blocks configured for the `challenge` +Terraform sub block. + + + +**Args**: + - `custom_request_handling` (`list[obj]`): Set the `custom_request_handling` field on the resulting object. When `null`, the `custom_request_handling` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [aws.wafv2_web_acl.rule.statement.rule_group_reference_statement.rule_action_override.action_to_use.challenge.custom_request_handling.new](#fn-rulerulestatementrule_group_reference_statementrule_action_overrideaction_to_usecustom_request_handlingnew) constructor. + +**Returns**: + - An attribute object that represents the `challenge` sub block. + + +## obj rule.statement.rule_group_reference_statement.rule_action_override.action_to_use.challenge.custom_request_handling + + + +### fn rule.statement.rule_group_reference_statement.rule_action_override.action_to_use.challenge.custom_request_handling.new + +```ts +new() +``` + + +`aws.wafv2_web_acl.rule.statement.rule_group_reference_statement.rule_action_override.action_to_use.challenge.custom_request_handling.new` constructs a new object with attributes and blocks configured for the `custom_request_handling` +Terraform sub block. + + + +**Args**: + - `insert_header` (`list[obj]`): Set the `insert_header` field on the resulting object. When `null`, the `insert_header` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [aws.wafv2_web_acl.rule.statement.rule_group_reference_statement.rule_action_override.action_to_use.challenge.custom_request_handling.insert_header.new](#fn-rulerulestatementrule_group_reference_statementrule_action_overrideaction_to_usechallengeinsert_headernew) constructor. + +**Returns**: + - An attribute object that represents the `custom_request_handling` sub block. + + +## obj rule.statement.rule_group_reference_statement.rule_action_override.action_to_use.challenge.custom_request_handling.insert_header + + + +### fn rule.statement.rule_group_reference_statement.rule_action_override.action_to_use.challenge.custom_request_handling.insert_header.new + +```ts +new() +``` + + +`aws.wafv2_web_acl.rule.statement.rule_group_reference_statement.rule_action_override.action_to_use.challenge.custom_request_handling.insert_header.new` constructs a new object with attributes and blocks configured for the `insert_header` +Terraform sub block. + + + **Args**: - `name` (`string`): Set the `name` field on the resulting object. - `value` (`string`): Set the `value` field on the resulting object.