From 2788f5f7b3fd4ae7600f3a487191175cb2232d86 Mon Sep 17 00:00:00 2001 From: tflibsonnet-ci <120686569+tflibsonnet-ci@users.noreply.github.com> Date: Fri, 4 Aug 2023 14:35:04 -0500 Subject: [PATCH] Update dependency hashicorp/terraform-provider-aws to v5.11.0 (#45) Signed-off-by: tflibsonnet-ci <120686569+tflibsonnet-ci@users.noreply.github.com> Co-authored-by: renovate[bot] --- 5.x/_gen/data/db_instance.libsonnet | 8 +- 5.x/_gen/data/db_instances.libsonnet | 21 +- 5.x/_gen/data/db_snapshot.libsonnet | 22 +- 5.x/_gen/data/vpclattice_service.libsonnet | 23 +- 5.x/_gen/main.libsonnet | 2 + .../resources/finspace_kx_cluster.libsonnet | 4 +- 5.x/_gen/resources/glue_job.libsonnet | 6 +- ...curity_token_service_preferences.libsonnet | 32 + .../resources/medialive_channel.libsonnet | 322 ++++++++- 5.x/_gen/resources/nat_gateway.libsonnet | 86 ++- .../networkfirewall_firewall_policy.libsonnet | 30 +- .../resources/quicksight_analysis.libsonnet | 12 +- .../resources/quicksight_dashboard.libsonnet | 12 +- .../resources/quicksight_template.libsonnet | 12 +- 5.x/_gen/resources/sagemaker_domain.libsonnet | 16 +- .../resources/sagemaker_endpoint.libsonnet | 40 +- .../resources/sagemaker_pipeline.libsonnet | 186 +++++ .../sagemaker_user_profile.libsonnet | 16 +- 5.x/_gen/resources/transfer_server.libsonnet | 18 +- docs/5.x/README.md | 2 + docs/5.x/data/db_instance.md | 4 +- docs/5.x/data/db_instances.md | 19 + docs/5.x/data/db_snapshot.md | 19 + docs/5.x/data/vpclattice_service.md | 23 +- docs/5.x/finspace_kx_cluster.md | 2 +- docs/5.x/glue_job.md | 1 + .../iam_security_token_service_preferences.md | 92 +++ docs/5.x/medialive_channel.md | 646 ++++++++++++++++++ docs/5.x/nat_gateway.md | 124 ++++ docs/5.x/networkfirewall_firewall_policy.md | 77 +++ docs/5.x/quicksight_analysis.md | 4 +- docs/5.x/quicksight_dashboard.md | 4 +- docs/5.x/quicksight_template.md | 4 +- docs/5.x/sagemaker_domain.md | 27 + docs/5.x/sagemaker_endpoint.md | 81 +++ docs/5.x/sagemaker_pipeline.md | 340 +++++++++ docs/5.x/sagemaker_user_profile.md | 27 + docs/5.x/transfer_server.md | 19 + 38 files changed, 2319 insertions(+), 64 deletions(-) create mode 100644 5.x/_gen/resources/iam_security_token_service_preferences.libsonnet create mode 100644 5.x/_gen/resources/sagemaker_pipeline.libsonnet create mode 100644 docs/5.x/iam_security_token_service_preferences.md create mode 100644 docs/5.x/sagemaker_pipeline.md diff --git a/5.x/_gen/data/db_instance.libsonnet b/5.x/_gen/data/db_instance.libsonnet index 61f67302..2c5f5ec0 100644 --- a/5.x/_gen/data/db_instance.libsonnet +++ b/5.x/_gen/data/db_instance.libsonnet @@ -2,10 +2,10 @@ 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='db_instance', url='', help='`db_instance` represents the `aws_db_instance` 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.db_instance.new` injects a new `data_aws_db_instance` 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.db_instance.new('some_id')\n\nYou can get the reference to the `id` field of the created `aws.data.db_instance` using the reference:\n\n $._ref.data_aws_db_instance.some_id.get('id')\n\nThis is the same as directly entering `\"${ data_aws_db_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 - `dataSrcLabel` (`string`): The name label of the block.\n - `db_instance_identifier` (`string`): Set the `db_instance_identifier` 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':: d.fn(help="\n`aws.data.db_instance.new` injects a new `data_aws_db_instance` 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.db_instance.new('some_id')\n\nYou can get the reference to the `id` field of the created `aws.data.db_instance` using the reference:\n\n $._ref.data_aws_db_instance.some_id.get('id')\n\nThis is the same as directly entering `\"${ data_aws_db_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 - `dataSrcLabel` (`string`): The name label of the block.\n - `db_instance_identifier` (`string`): Set the `db_instance_identifier` field on the resulting data source block. When `null`, the `db_instance_identifier` 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\n**Returns**:\n- A mixin object that injects the new data source into the root Terraform configuration.\n", args=[]), new( dataSrcLabel, - db_instance_identifier, + db_instance_identifier=null, tags=null, _meta={} ):: tf.withData( @@ -14,9 +14,9 @@ local d = (import 'github.com/jsonnet-libs/docsonnet/doc-util/main.libsonnet'); attrs=self.newAttrs(db_instance_identifier=db_instance_identifier, tags=tags), _meta=_meta ), - '#newAttrs':: d.fn(help='\n`aws.data.db_instance.newAttrs` constructs a new object with attributes and blocks configured for the `db_instance`\nTerraform data source.\n\nUnlike [aws.data.db_instance.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 - `db_instance_identifier` (`string`): Set the `db_instance_identifier` 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 `db_instance` data source into the root Terraform configuration.\n', args=[]), + '#newAttrs':: d.fn(help='\n`aws.data.db_instance.newAttrs` constructs a new object with attributes and blocks configured for the `db_instance`\nTerraform data source.\n\nUnlike [aws.data.db_instance.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 - `db_instance_identifier` (`string`): Set the `db_instance_identifier` field on the resulting object. When `null`, the `db_instance_identifier` 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\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 `db_instance` data source into the root Terraform configuration.\n', args=[]), newAttrs( - db_instance_identifier, + db_instance_identifier=null, tags=null ):: std.prune(a={ db_instance_identifier: db_instance_identifier, diff --git a/5.x/_gen/data/db_instances.libsonnet b/5.x/_gen/data/db_instances.libsonnet index c904562e..eaf851e0 100644 --- a/5.x/_gen/data/db_instances.libsonnet +++ b/5.x/_gen/data/db_instances.libsonnet @@ -12,22 +12,25 @@ local d = (import 'github.com/jsonnet-libs/docsonnet/doc-util/main.libsonnet'); values: values, }), }, - '#new':: d.fn(help="\n`aws.data.db_instances.new` injects a new `data_aws_db_instances` 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.db_instances.new('some_id')\n\nYou can get the reference to the `id` field of the created `aws.data.db_instances` using the reference:\n\n $._ref.data_aws_db_instances.some_id.get('id')\n\nThis is the same as directly entering `\"${ data_aws_db_instances.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 - `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.db_instances.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':: d.fn(help="\n`aws.data.db_instances.new` injects a new `data_aws_db_instances` 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.db_instances.new('some_id')\n\nYou can get the reference to the `id` field of the created `aws.data.db_instances` using the reference:\n\n $._ref.data_aws_db_instances.some_id.get('id')\n\nThis is the same as directly entering `\"${ data_aws_db_instances.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 - `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 - `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.db_instances.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, filter=null, + tags=null, _meta={} ):: tf.withData( type='aws_db_instances', label=dataSrcLabel, - attrs=self.newAttrs(filter=filter), + attrs=self.newAttrs(filter=filter, tags=tags), _meta=_meta ), - '#newAttrs':: d.fn(help='\n`aws.data.db_instances.newAttrs` constructs a new object with attributes and blocks configured for the `db_instances`\nTerraform data source.\n\nUnlike [aws.data.db_instances.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 - `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.db_instances.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 `db_instances` data source into the root Terraform configuration.\n', args=[]), + '#newAttrs':: d.fn(help='\n`aws.data.db_instances.newAttrs` constructs a new object with attributes and blocks configured for the `db_instances`\nTerraform data source.\n\nUnlike [aws.data.db_instances.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 - `tags` (`obj`): Set the `tags` field on the resulting object. When `null`, the `tags` field will be omitted from the resulting object.\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.db_instances.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 `db_instances` data source into the root Terraform configuration.\n', args=[]), newAttrs( - filter=null + filter=null, + tags=null ):: std.prune(a={ filter: filter, + tags: tags, }), '#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): { @@ -49,4 +52,14 @@ local d = (import 'github.com/jsonnet-libs/docsonnet/doc-util/main.libsonnet'); }, }, }, + '#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_db_instances+: { + [dataSrcLabel]+: { + tags: value, + }, + }, + }, + }, } diff --git a/5.x/_gen/data/db_snapshot.libsonnet b/5.x/_gen/data/db_snapshot.libsonnet index 4ae96d58..23828b28 100644 --- a/5.x/_gen/data/db_snapshot.libsonnet +++ b/5.x/_gen/data/db_snapshot.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='db_snapshot', url='', help='`db_snapshot` represents the `aws_db_snapshot` 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.db_snapshot.new` injects a new `data_aws_db_snapshot` 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.db_snapshot.new('some_id')\n\nYou can get the reference to the `id` field of the created `aws.data.db_snapshot` using the reference:\n\n $._ref.data_aws_db_snapshot.some_id.get('id')\n\nThis is the same as directly entering `\"${ data_aws_db_snapshot.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 - `db_instance_identifier` (`string`): Set the `db_instance_identifier` field on the resulting data source block. When `null`, the `db_instance_identifier` field will be omitted from the resulting object.\n - `db_snapshot_identifier` (`string`): Set the `db_snapshot_identifier` field on the resulting data source block. When `null`, the `db_snapshot_identifier` field will be omitted from the resulting object.\n - `include_public` (`bool`): Set the `include_public` field on the resulting data source block. When `null`, the `include_public` field will be omitted from the resulting object.\n - `include_shared` (`bool`): Set the `include_shared` field on the resulting data source block. When `null`, the `include_shared` field will be omitted from the resulting object.\n - `most_recent` (`bool`): Set the `most_recent` field on the resulting data source block. When `null`, the `most_recent` field will be omitted from the resulting object.\n - `snapshot_type` (`string`): Set the `snapshot_type` field on the resulting data source block. When `null`, the `snapshot_type` 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.db_snapshot.new` injects a new `data_aws_db_snapshot` 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.db_snapshot.new('some_id')\n\nYou can get the reference to the `id` field of the created `aws.data.db_snapshot` using the reference:\n\n $._ref.data_aws_db_snapshot.some_id.get('id')\n\nThis is the same as directly entering `\"${ data_aws_db_snapshot.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 - `db_instance_identifier` (`string`): Set the `db_instance_identifier` field on the resulting data source block. When `null`, the `db_instance_identifier` field will be omitted from the resulting object.\n - `db_snapshot_identifier` (`string`): Set the `db_snapshot_identifier` field on the resulting data source block. When `null`, the `db_snapshot_identifier` field will be omitted from the resulting object.\n - `include_public` (`bool`): Set the `include_public` field on the resulting data source block. When `null`, the `include_public` field will be omitted from the resulting object.\n - `include_shared` (`bool`): Set the `include_shared` field on the resulting data source block. When `null`, the `include_shared` field will be omitted from the resulting object.\n - `most_recent` (`bool`): Set the `most_recent` field on the resulting data source block. When `null`, the `most_recent` field will be omitted from the resulting object.\n - `snapshot_type` (`string`): Set the `snapshot_type` field on the resulting data source block. When `null`, the `snapshot_type` 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\n**Returns**:\n- A mixin object that injects the new data source into the root Terraform configuration.\n", args=[]), new( dataSrcLabel, db_instance_identifier=null, @@ -11,6 +11,7 @@ local d = (import 'github.com/jsonnet-libs/docsonnet/doc-util/main.libsonnet'); include_shared=null, most_recent=null, snapshot_type=null, + tags=null, _meta={} ):: tf.withData( type='aws_db_snapshot', @@ -21,18 +22,20 @@ local d = (import 'github.com/jsonnet-libs/docsonnet/doc-util/main.libsonnet'); include_public=include_public, include_shared=include_shared, most_recent=most_recent, - snapshot_type=snapshot_type + snapshot_type=snapshot_type, + tags=tags ), _meta=_meta ), - '#newAttrs':: d.fn(help='\n`aws.data.db_snapshot.newAttrs` constructs a new object with attributes and blocks configured for the `db_snapshot`\nTerraform data source.\n\nUnlike [aws.data.db_snapshot.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 - `db_instance_identifier` (`string`): Set the `db_instance_identifier` field on the resulting object. When `null`, the `db_instance_identifier` field will be omitted from the resulting object.\n - `db_snapshot_identifier` (`string`): Set the `db_snapshot_identifier` field on the resulting object. When `null`, the `db_snapshot_identifier` field will be omitted from the resulting object.\n - `include_public` (`bool`): Set the `include_public` field on the resulting object. When `null`, the `include_public` field will be omitted from the resulting object.\n - `include_shared` (`bool`): Set the `include_shared` field on the resulting object. When `null`, the `include_shared` field will be omitted from the resulting object.\n - `most_recent` (`bool`): Set the `most_recent` field on the resulting object. When `null`, the `most_recent` field will be omitted from the resulting object.\n - `snapshot_type` (`string`): Set the `snapshot_type` field on the resulting object. When `null`, the `snapshot_type` 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 `db_snapshot` data source into the root Terraform configuration.\n', args=[]), + '#newAttrs':: d.fn(help='\n`aws.data.db_snapshot.newAttrs` constructs a new object with attributes and blocks configured for the `db_snapshot`\nTerraform data source.\n\nUnlike [aws.data.db_snapshot.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 - `db_instance_identifier` (`string`): Set the `db_instance_identifier` field on the resulting object. When `null`, the `db_instance_identifier` field will be omitted from the resulting object.\n - `db_snapshot_identifier` (`string`): Set the `db_snapshot_identifier` field on the resulting object. When `null`, the `db_snapshot_identifier` field will be omitted from the resulting object.\n - `include_public` (`bool`): Set the `include_public` field on the resulting object. When `null`, the `include_public` field will be omitted from the resulting object.\n - `include_shared` (`bool`): Set the `include_shared` field on the resulting object. When `null`, the `include_shared` field will be omitted from the resulting object.\n - `most_recent` (`bool`): Set the `most_recent` field on the resulting object. When `null`, the `most_recent` field will be omitted from the resulting object.\n - `snapshot_type` (`string`): Set the `snapshot_type` field on the resulting object. When `null`, the `snapshot_type` 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\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 `db_snapshot` data source into the root Terraform configuration.\n', args=[]), newAttrs( db_instance_identifier=null, db_snapshot_identifier=null, include_public=null, include_shared=null, most_recent=null, - snapshot_type=null + snapshot_type=null, + tags=null ):: std.prune(a={ db_instance_identifier: db_instance_identifier, db_snapshot_identifier: db_snapshot_identifier, @@ -40,6 +43,7 @@ local d = (import 'github.com/jsonnet-libs/docsonnet/doc-util/main.libsonnet'); include_shared: include_shared, most_recent: most_recent, snapshot_type: snapshot_type, + tags: tags, }), '#withDbInstanceIdentifier':: d.fn(help='`aws.string.withDbInstanceIdentifier` constructs a mixin object that can be merged into the `string`\nTerraform data source block to set or update the db_instance_identifier 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 `db_instance_identifier` field.\n', args=[]), withDbInstanceIdentifier(dataSrcLabel, value): { @@ -101,4 +105,14 @@ local d = (import 'github.com/jsonnet-libs/docsonnet/doc-util/main.libsonnet'); }, }, }, + '#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_db_snapshot+: { + [dataSrcLabel]+: { + tags: value, + }, + }, + }, + }, } diff --git a/5.x/_gen/data/vpclattice_service.libsonnet b/5.x/_gen/data/vpclattice_service.libsonnet index a0cd364a..03488990 100644 --- a/5.x/_gen/data/vpclattice_service.libsonnet +++ b/5.x/_gen/data/vpclattice_service.libsonnet @@ -2,26 +2,39 @@ 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='vpclattice_service', url='', help='`vpclattice_service` represents the `aws_vpclattice_service` 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.vpclattice_service.new` injects a new `data_aws_vpclattice_service` 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.vpclattice_service.new('some_id')\n\nYou can get the reference to the `id` field of the created `aws.data.vpclattice_service` using the reference:\n\n $._ref.data_aws_vpclattice_service.some_id.get('id')\n\nThis is the same as directly entering `\"${ data_aws_vpclattice_service.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 - `service_identifier` (`string`): Set the `service_identifier` 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':: d.fn(help="\n`aws.data.vpclattice_service.new` injects a new `data_aws_vpclattice_service` 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.vpclattice_service.new('some_id')\n\nYou can get the reference to the `id` field of the created `aws.data.vpclattice_service` using the reference:\n\n $._ref.data_aws_vpclattice_service.some_id.get('id')\n\nThis is the same as directly entering `\"${ data_aws_vpclattice_service.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 - `name` (`string`): Set the `name` field on the resulting data source block. When `null`, the `name` field will be omitted from the resulting object.\n - `service_identifier` (`string`): Set the `service_identifier` field on the resulting data source block. When `null`, the `service_identifier` 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\n**Returns**:\n- A mixin object that injects the new data source into the root Terraform configuration.\n", args=[]), new( dataSrcLabel, - service_identifier, + name=null, + service_identifier=null, tags=null, _meta={} ):: tf.withData( type='aws_vpclattice_service', label=dataSrcLabel, - attrs=self.newAttrs(service_identifier=service_identifier, tags=tags), + attrs=self.newAttrs(name=name, service_identifier=service_identifier, tags=tags), _meta=_meta ), - '#newAttrs':: d.fn(help='\n`aws.data.vpclattice_service.newAttrs` constructs a new object with attributes and blocks configured for the `vpclattice_service`\nTerraform data source.\n\nUnlike [aws.data.vpclattice_service.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 - `service_identifier` (`string`): Set the `service_identifier` 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 `vpclattice_service` data source into the root Terraform configuration.\n', args=[]), + '#newAttrs':: d.fn(help='\n`aws.data.vpclattice_service.newAttrs` constructs a new object with attributes and blocks configured for the `vpclattice_service`\nTerraform data source.\n\nUnlike [aws.data.vpclattice_service.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 - `name` (`string`): Set the `name` field on the resulting object. When `null`, the `name` field will be omitted from the resulting object.\n - `service_identifier` (`string`): Set the `service_identifier` field on the resulting object. When `null`, the `service_identifier` 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\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 `vpclattice_service` data source into the root Terraform configuration.\n', args=[]), newAttrs( - service_identifier, + name=null, + service_identifier=null, tags=null ):: std.prune(a={ + name: name, service_identifier: service_identifier, tags: tags, }), + '#withName':: d.fn(help='`aws.string.withName` constructs a mixin object that can be merged into the `string`\nTerraform data source block to set or update the 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 `name` field.\n', args=[]), + withName(dataSrcLabel, value): { + data+: { + aws_vpclattice_service+: { + [dataSrcLabel]+: { + name: value, + }, + }, + }, + }, '#withServiceIdentifier':: d.fn(help='`aws.string.withServiceIdentifier` constructs a mixin object that can be merged into the `string`\nTerraform data source block to set or update the service_identifier 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 `service_identifier` field.\n', args=[]), withServiceIdentifier(dataSrcLabel, value): { data+: { diff --git a/5.x/_gen/main.libsonnet b/5.x/_gen/main.libsonnet index 3851ee1e..9420cea5 100644 --- a/5.x/_gen/main.libsonnet +++ b/5.x/_gen/main.libsonnet @@ -573,6 +573,7 @@ local d = (import 'github.com/jsonnet-libs/docsonnet/doc-util/main.libsonnet'); iam_role_policy: (import 'resources/iam_role_policy.libsonnet'), iam_role_policy_attachment: (import 'resources/iam_role_policy_attachment.libsonnet'), iam_saml_provider: (import 'resources/iam_saml_provider.libsonnet'), + iam_security_token_service_preferences: (import 'resources/iam_security_token_service_preferences.libsonnet'), iam_server_certificate: (import 'resources/iam_server_certificate.libsonnet'), iam_service_linked_role: (import 'resources/iam_service_linked_role.libsonnet'), iam_service_specific_credential: (import 'resources/iam_service_specific_credential.libsonnet'), @@ -1001,6 +1002,7 @@ local d = (import 'github.com/jsonnet-libs/docsonnet/doc-util/main.libsonnet'); sagemaker_monitoring_schedule: (import 'resources/sagemaker_monitoring_schedule.libsonnet'), sagemaker_notebook_instance: (import 'resources/sagemaker_notebook_instance.libsonnet'), sagemaker_notebook_instance_lifecycle_configuration: (import 'resources/sagemaker_notebook_instance_lifecycle_configuration.libsonnet'), + sagemaker_pipeline: (import 'resources/sagemaker_pipeline.libsonnet'), sagemaker_project: (import 'resources/sagemaker_project.libsonnet'), sagemaker_servicecatalog_portfolio_status: (import 'resources/sagemaker_servicecatalog_portfolio_status.libsonnet'), sagemaker_space: (import 'resources/sagemaker_space.libsonnet'), diff --git a/5.x/_gen/resources/finspace_kx_cluster.libsonnet b/5.x/_gen/resources/finspace_kx_cluster.libsonnet index 4624c46b..571d299b 100644 --- a/5.x/_gen/resources/finspace_kx_cluster.libsonnet +++ b/5.x/_gen/resources/finspace_kx_cluster.libsonnet @@ -54,10 +54,10 @@ local d = (import 'github.com/jsonnet-libs/docsonnet/doc-util/main.libsonnet'); }, database:: { cache_configurations:: { - '#new':: d.fn(help='\n`aws.finspace_kx_cluster.database.cache_configurations.new` constructs a new object with attributes and blocks configured for the `cache_configurations`\nTerraform sub block.\n\n\n\n**Args**:\n - `cache_type` (`string`): Set the `cache_type` field on the resulting object.\n - `db_paths` (`list`): Set the `db_paths` field on the resulting object.\n\n**Returns**:\n - An attribute object that represents the `cache_configurations` sub block.\n', args=[]), + '#new':: d.fn(help='\n`aws.finspace_kx_cluster.database.cache_configurations.new` constructs a new object with attributes and blocks configured for the `cache_configurations`\nTerraform sub block.\n\n\n\n**Args**:\n - `cache_type` (`string`): Set the `cache_type` field on the resulting object.\n - `db_paths` (`list`): Set the `db_paths` field on the resulting object. When `null`, the `db_paths` field will be omitted from the resulting object.\n\n**Returns**:\n - An attribute object that represents the `cache_configurations` sub block.\n', args=[]), new( cache_type, - db_paths + db_paths=null ):: std.prune(a={ cache_type: cache_type, db_paths: db_paths, diff --git a/5.x/_gen/resources/glue_job.libsonnet b/5.x/_gen/resources/glue_job.libsonnet index 9cacb4f6..191cb845 100644 --- a/5.x/_gen/resources/glue_job.libsonnet +++ b/5.x/_gen/resources/glue_job.libsonnet @@ -3,14 +3,16 @@ local d = (import 'github.com/jsonnet-libs/docsonnet/doc-util/main.libsonnet'); { '#':: d.pkg(name='glue_job', url='', help='`glue_job` represents the `aws_glue_job` Terraform resource.\n\n\n\nThis package contains functions and utilities for setting up the resource using Jsonnet code.\n'), command:: { - '#new':: d.fn(help='\n`aws.glue_job.command.new` constructs a new object with attributes and blocks configured for the `command`\nTerraform sub block.\n\n\n\n**Args**:\n - `name` (`string`): Set the `name` field on the resulting object. When `null`, the `name` field will be omitted from the resulting object.\n - `python_version` (`string`): Set the `python_version` field on the resulting object. When `null`, the `python_version` field will be omitted from the resulting object.\n - `script_location` (`string`): Set the `script_location` field on the resulting object.\n\n**Returns**:\n - An attribute object that represents the `command` sub block.\n', args=[]), + '#new':: d.fn(help='\n`aws.glue_job.command.new` constructs a new object with attributes and blocks configured for the `command`\nTerraform sub block.\n\n\n\n**Args**:\n - `name` (`string`): Set the `name` field on the resulting object. When `null`, the `name` field will be omitted from the resulting object.\n - `python_version` (`string`): Set the `python_version` field on the resulting object. When `null`, the `python_version` field will be omitted from the resulting object.\n - `runtime` (`string`): Set the `runtime` field on the resulting object. When `null`, the `runtime` field will be omitted from the resulting object.\n - `script_location` (`string`): Set the `script_location` field on the resulting object.\n\n**Returns**:\n - An attribute object that represents the `command` sub block.\n', args=[]), new( script_location, name=null, - python_version=null + python_version=null, + runtime=null ):: std.prune(a={ name: name, python_version: python_version, + runtime: runtime, script_location: script_location, }), }, diff --git a/5.x/_gen/resources/iam_security_token_service_preferences.libsonnet b/5.x/_gen/resources/iam_security_token_service_preferences.libsonnet new file mode 100644 index 00000000..4b1856e7 --- /dev/null +++ b/5.x/_gen/resources/iam_security_token_service_preferences.libsonnet @@ -0,0 +1,32 @@ +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='iam_security_token_service_preferences', url='', help='`iam_security_token_service_preferences` represents the `aws_iam_security_token_service_preferences` 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.iam_security_token_service_preferences.new` injects a new `aws_iam_security_token_service_preferences` 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.iam_security_token_service_preferences.new('some_id')\n\nYou can get the reference to the `id` field of the created `aws.iam_security_token_service_preferences` using the reference:\n\n $._ref.aws_iam_security_token_service_preferences.some_id.get('id')\n\nThis is the same as directly entering `\"${ aws_iam_security_token_service_preferences.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 - `global_endpoint_token_version` (`string`): Set the `global_endpoint_token_version` 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, + global_endpoint_token_version, + _meta={} + ):: tf.withResource( + type='aws_iam_security_token_service_preferences', + label=resourceLabel, + attrs=self.newAttrs(global_endpoint_token_version=global_endpoint_token_version), + _meta=_meta + ), + '#newAttrs':: d.fn(help='\n`aws.iam_security_token_service_preferences.newAttrs` constructs a new object with attributes and blocks configured for the `iam_security_token_service_preferences`\nTerraform resource.\n\nUnlike [aws.iam_security_token_service_preferences.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 - `global_endpoint_token_version` (`string`): Set the `global_endpoint_token_version` 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 `iam_security_token_service_preferences` resource into the root Terraform configuration.\n', args=[]), + newAttrs( + global_endpoint_token_version + ):: std.prune(a={ + global_endpoint_token_version: global_endpoint_token_version, + }), + '#withGlobalEndpointTokenVersion':: d.fn(help='`aws.string.withGlobalEndpointTokenVersion` constructs a mixin object that can be merged into the `string`\nTerraform resource block to set or update the global_endpoint_token_version 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 `global_endpoint_token_version` field.\n', args=[]), + withGlobalEndpointTokenVersion(resourceLabel, value): { + resource+: { + aws_iam_security_token_service_preferences+: { + [resourceLabel]+: { + global_endpoint_token_version: value, + }, + }, + }, + }, +} diff --git a/5.x/_gen/resources/medialive_channel.libsonnet b/5.x/_gen/resources/medialive_channel.libsonnet index b4f1f5bc..00770605 100644 --- a/5.x/_gen/resources/medialive_channel.libsonnet +++ b/5.x/_gen/resources/medialive_channel.libsonnet @@ -351,20 +351,340 @@ local d = (import 'github.com/jsonnet-libs/docsonnet/doc-util/main.libsonnet'); state: state, }), }, - '#new':: d.fn(help='\n`aws.medialive_channel.encoder_settings.new` constructs a new object with attributes and blocks configured for the `encoder_settings`\nTerraform sub block.\n\n\n\n**Args**:\n - `audio_descriptions` (`list[obj]`): Set the `audio_descriptions` field on the resulting object. When `null`, the `audio_descriptions` 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.encoder_settings.audio_descriptions.new](#fn-encoder_settingsaudio_descriptionsnew) constructor.\n - `avail_blanking` (`list[obj]`): Set the `avail_blanking` field on the resulting object. When `null`, the `avail_blanking` 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.encoder_settings.avail_blanking.new](#fn-encoder_settingsavail_blankingnew) constructor.\n - `output_groups` (`list[obj]`): Set the `output_groups` field on the resulting object. When `null`, the `output_groups` 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.encoder_settings.output_groups.new](#fn-encoder_settingsoutput_groupsnew) constructor.\n - `timecode_config` (`list[obj]`): Set the `timecode_config` field on the resulting object. When `null`, the `timecode_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.medialive_channel.encoder_settings.timecode_config.new](#fn-encoder_settingstimecode_confignew) constructor.\n - `video_descriptions` (`list[obj]`): Set the `video_descriptions` field on the resulting object. When `null`, the `video_descriptions` 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.encoder_settings.video_descriptions.new](#fn-encoder_settingsvideo_descriptionsnew) constructor.\n\n**Returns**:\n - An attribute object that represents the `encoder_settings` sub block.\n', args=[]), + caption_descriptions:: { + destination_settings:: { + arib_destination_settings:: { + '#new':: d.fn(help='\n`aws.medialive_channel.encoder_settings.caption_descriptions.destination_settings.arib_destination_settings.new` constructs a new object with attributes and blocks configured for the `arib_destination_settings`\nTerraform sub block.\n\n\n\n**Returns**:\n - An attribute object that represents the `arib_destination_settings` sub block.\n', args=[]), + new( + + ):: std.prune(a={}), + }, + burn_in_destination_settings:: { + font:: { + '#new':: d.fn(help='\n`aws.medialive_channel.encoder_settings.caption_descriptions.destination_settings.burn_in_destination_settings.font.new` constructs a new object with attributes and blocks configured for the `font`\nTerraform sub block.\n\n\n\n**Args**:\n - `password_param` (`string`): Set the `password_param` field on the resulting object. When `null`, the `password_param` field will be omitted from the resulting object.\n - `uri` (`string`): Set the `uri` field on the resulting object.\n - `username` (`string`): Set the `username` field on the resulting object. When `null`, the `username` field will be omitted from the resulting object.\n\n**Returns**:\n - An attribute object that represents the `font` sub block.\n', args=[]), + new( + uri, + password_param=null, + username=null + ):: std.prune(a={ + password_param: password_param, + uri: uri, + username: username, + }), + }, + '#new':: d.fn(help='\n`aws.medialive_channel.encoder_settings.caption_descriptions.destination_settings.burn_in_destination_settings.new` constructs a new object with attributes and blocks configured for the `burn_in_destination_settings`\nTerraform sub block.\n\n\n\n**Args**:\n - `alignment` (`string`): Set the `alignment` field on the resulting object. When `null`, the `alignment` field will be omitted from the resulting object.\n - `background_color` (`string`): Set the `background_color` field on the resulting object. When `null`, the `background_color` field will be omitted from the resulting object.\n - `background_opacity` (`number`): Set the `background_opacity` field on the resulting object. When `null`, the `background_opacity` field will be omitted from the resulting object.\n - `font_color` (`string`): Set the `font_color` field on the resulting object. When `null`, the `font_color` field will be omitted from the resulting object.\n - `font_opacity` (`number`): Set the `font_opacity` field on the resulting object. When `null`, the `font_opacity` field will be omitted from the resulting object.\n - `font_resolution` (`number`): Set the `font_resolution` field on the resulting object. When `null`, the `font_resolution` field will be omitted from the resulting object.\n - `font_size` (`string`): Set the `font_size` field on the resulting object. When `null`, the `font_size` field will be omitted from the resulting object.\n - `outline_color` (`string`): Set the `outline_color` field on the resulting object.\n - `outline_size` (`number`): Set the `outline_size` field on the resulting object. When `null`, the `outline_size` field will be omitted from the resulting object.\n - `shadow_color` (`string`): Set the `shadow_color` field on the resulting object. When `null`, the `shadow_color` field will be omitted from the resulting object.\n - `shadow_opacity` (`number`): Set the `shadow_opacity` field on the resulting object. When `null`, the `shadow_opacity` field will be omitted from the resulting object.\n - `shadow_x_offset` (`number`): Set the `shadow_x_offset` field on the resulting object. When `null`, the `shadow_x_offset` field will be omitted from the resulting object.\n - `shadow_y_offset` (`number`): Set the `shadow_y_offset` field on the resulting object. When `null`, the `shadow_y_offset` field will be omitted from the resulting object.\n - `teletext_grid_control` (`string`): Set the `teletext_grid_control` field on the resulting object.\n - `x_position` (`number`): Set the `x_position` field on the resulting object. When `null`, the `x_position` field will be omitted from the resulting object.\n - `y_position` (`number`): Set the `y_position` field on the resulting object. When `null`, the `y_position` field will be omitted from the resulting object.\n - `font` (`list[obj]`): Set the `font` field on the resulting object. When `null`, the `font` 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.encoder_settings.caption_descriptions.destination_settings.burn_in_destination_settings.font.new](#fn-encoder_settingsencoder_settingscaption_descriptionsdestination_settingsfontnew) constructor.\n\n**Returns**:\n - An attribute object that represents the `burn_in_destination_settings` sub block.\n', args=[]), + new( + outline_color, + teletext_grid_control, + alignment=null, + background_color=null, + background_opacity=null, + font=null, + font_color=null, + font_opacity=null, + font_resolution=null, + font_size=null, + outline_size=null, + shadow_color=null, + shadow_opacity=null, + shadow_x_offset=null, + shadow_y_offset=null, + x_position=null, + y_position=null + ):: std.prune(a={ + alignment: alignment, + background_color: background_color, + background_opacity: background_opacity, + font: font, + font_color: font_color, + font_opacity: font_opacity, + font_resolution: font_resolution, + font_size: font_size, + outline_color: outline_color, + outline_size: outline_size, + shadow_color: shadow_color, + shadow_opacity: shadow_opacity, + shadow_x_offset: shadow_x_offset, + shadow_y_offset: shadow_y_offset, + teletext_grid_control: teletext_grid_control, + x_position: x_position, + y_position: y_position, + }), + }, + dvb_sub_destination_settings:: { + font:: { + '#new':: d.fn(help='\n`aws.medialive_channel.encoder_settings.caption_descriptions.destination_settings.dvb_sub_destination_settings.font.new` constructs a new object with attributes and blocks configured for the `font`\nTerraform sub block.\n\n\n\n**Args**:\n - `password_param` (`string`): Set the `password_param` field on the resulting object. When `null`, the `password_param` field will be omitted from the resulting object.\n - `uri` (`string`): Set the `uri` field on the resulting object.\n - `username` (`string`): Set the `username` field on the resulting object. When `null`, the `username` field will be omitted from the resulting object.\n\n**Returns**:\n - An attribute object that represents the `font` sub block.\n', args=[]), + new( + uri, + password_param=null, + username=null + ):: std.prune(a={ + password_param: password_param, + uri: uri, + username: username, + }), + }, + '#new':: d.fn(help='\n`aws.medialive_channel.encoder_settings.caption_descriptions.destination_settings.dvb_sub_destination_settings.new` constructs a new object with attributes and blocks configured for the `dvb_sub_destination_settings`\nTerraform sub block.\n\n\n\n**Args**:\n - `alignment` (`string`): Set the `alignment` field on the resulting object. When `null`, the `alignment` field will be omitted from the resulting object.\n - `background_color` (`string`): Set the `background_color` field on the resulting object. When `null`, the `background_color` field will be omitted from the resulting object.\n - `background_opacity` (`number`): Set the `background_opacity` field on the resulting object. When `null`, the `background_opacity` field will be omitted from the resulting object.\n - `font_color` (`string`): Set the `font_color` field on the resulting object. When `null`, the `font_color` field will be omitted from the resulting object.\n - `font_opacity` (`number`): Set the `font_opacity` field on the resulting object. When `null`, the `font_opacity` field will be omitted from the resulting object.\n - `font_resolution` (`number`): Set the `font_resolution` field on the resulting object. When `null`, the `font_resolution` field will be omitted from the resulting object.\n - `font_size` (`string`): Set the `font_size` field on the resulting object. When `null`, the `font_size` field will be omitted from the resulting object.\n - `outline_color` (`string`): Set the `outline_color` field on the resulting object. When `null`, the `outline_color` field will be omitted from the resulting object.\n - `outline_size` (`number`): Set the `outline_size` field on the resulting object. When `null`, the `outline_size` field will be omitted from the resulting object.\n - `shadow_color` (`string`): Set the `shadow_color` field on the resulting object. When `null`, the `shadow_color` field will be omitted from the resulting object.\n - `shadow_opacity` (`number`): Set the `shadow_opacity` field on the resulting object. When `null`, the `shadow_opacity` field will be omitted from the resulting object.\n - `shadow_x_offset` (`number`): Set the `shadow_x_offset` field on the resulting object. When `null`, the `shadow_x_offset` field will be omitted from the resulting object.\n - `shadow_y_offset` (`number`): Set the `shadow_y_offset` field on the resulting object. When `null`, the `shadow_y_offset` field will be omitted from the resulting object.\n - `teletext_grid_control` (`string`): Set the `teletext_grid_control` field on the resulting object. When `null`, the `teletext_grid_control` field will be omitted from the resulting object.\n - `x_position` (`number`): Set the `x_position` field on the resulting object. When `null`, the `x_position` field will be omitted from the resulting object.\n - `y_position` (`number`): Set the `y_position` field on the resulting object. When `null`, the `y_position` field will be omitted from the resulting object.\n - `font` (`list[obj]`): Set the `font` field on the resulting object. When `null`, the `font` 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.encoder_settings.caption_descriptions.destination_settings.dvb_sub_destination_settings.font.new](#fn-encoder_settingsencoder_settingscaption_descriptionsdestination_settingsfontnew) constructor.\n\n**Returns**:\n - An attribute object that represents the `dvb_sub_destination_settings` sub block.\n', args=[]), + new( + alignment=null, + background_color=null, + background_opacity=null, + font=null, + font_color=null, + font_opacity=null, + font_resolution=null, + font_size=null, + outline_color=null, + outline_size=null, + shadow_color=null, + shadow_opacity=null, + shadow_x_offset=null, + shadow_y_offset=null, + teletext_grid_control=null, + x_position=null, + y_position=null + ):: std.prune(a={ + alignment: alignment, + background_color: background_color, + background_opacity: background_opacity, + font: font, + font_color: font_color, + font_opacity: font_opacity, + font_resolution: font_resolution, + font_size: font_size, + outline_color: outline_color, + outline_size: outline_size, + shadow_color: shadow_color, + shadow_opacity: shadow_opacity, + shadow_x_offset: shadow_x_offset, + shadow_y_offset: shadow_y_offset, + teletext_grid_control: teletext_grid_control, + x_position: x_position, + y_position: y_position, + }), + }, + ebu_tt_d_destination_settings:: { + '#new':: d.fn(help='\n`aws.medialive_channel.encoder_settings.caption_descriptions.destination_settings.ebu_tt_d_destination_settings.new` constructs a new object with attributes and blocks configured for the `ebu_tt_d_destination_settings`\nTerraform sub block.\n\n\n\n**Args**:\n - `copyright_holder` (`string`): Set the `copyright_holder` field on the resulting object. When `null`, the `copyright_holder` field will be omitted from the resulting object.\n - `fill_line_gap` (`string`): Set the `fill_line_gap` field on the resulting object. When `null`, the `fill_line_gap` field will be omitted from the resulting object.\n - `font_family` (`string`): Set the `font_family` field on the resulting object. When `null`, the `font_family` field will be omitted from the resulting object.\n - `style_control` (`string`): Set the `style_control` field on the resulting object. When `null`, the `style_control` field will be omitted from the resulting object.\n\n**Returns**:\n - An attribute object that represents the `ebu_tt_d_destination_settings` sub block.\n', args=[]), + new( + copyright_holder=null, + fill_line_gap=null, + font_family=null, + style_control=null + ):: std.prune(a={ + copyright_holder: copyright_holder, + fill_line_gap: fill_line_gap, + font_family: font_family, + style_control: style_control, + }), + }, + embedded_destination_settings:: { + '#new':: d.fn(help='\n`aws.medialive_channel.encoder_settings.caption_descriptions.destination_settings.embedded_destination_settings.new` constructs a new object with attributes and blocks configured for the `embedded_destination_settings`\nTerraform sub block.\n\n\n\n**Returns**:\n - An attribute object that represents the `embedded_destination_settings` sub block.\n', args=[]), + new( + + ):: std.prune(a={}), + }, + embedded_plus_scte20_destination_settings:: { + '#new':: d.fn(help='\n`aws.medialive_channel.encoder_settings.caption_descriptions.destination_settings.embedded_plus_scte20_destination_settings.new` constructs a new object with attributes and blocks configured for the `embedded_plus_scte20_destination_settings`\nTerraform sub block.\n\n\n\n**Returns**:\n - An attribute object that represents the `embedded_plus_scte20_destination_settings` sub block.\n', args=[]), + new( + + ):: std.prune(a={}), + }, + '#new':: d.fn(help='\n`aws.medialive_channel.encoder_settings.caption_descriptions.destination_settings.new` constructs a new object with attributes and blocks configured for the `destination_settings`\nTerraform sub block.\n\n\n\n**Args**:\n - `arib_destination_settings` (`list[obj]`): Set the `arib_destination_settings` field on the resulting object. When `null`, the `arib_destination_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.encoder_settings.caption_descriptions.destination_settings.arib_destination_settings.new](#fn-encoder_settingsencoder_settingscaption_descriptionsarib_destination_settingsnew) constructor.\n - `burn_in_destination_settings` (`list[obj]`): Set the `burn_in_destination_settings` field on the resulting object. When `null`, the `burn_in_destination_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.encoder_settings.caption_descriptions.destination_settings.burn_in_destination_settings.new](#fn-encoder_settingsencoder_settingscaption_descriptionsburn_in_destination_settingsnew) constructor.\n - `dvb_sub_destination_settings` (`list[obj]`): Set the `dvb_sub_destination_settings` field on the resulting object. When `null`, the `dvb_sub_destination_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.encoder_settings.caption_descriptions.destination_settings.dvb_sub_destination_settings.new](#fn-encoder_settingsencoder_settingscaption_descriptionsdvb_sub_destination_settingsnew) constructor.\n - `ebu_tt_d_destination_settings` (`list[obj]`): Set the `ebu_tt_d_destination_settings` field on the resulting object. When `null`, the `ebu_tt_d_destination_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.encoder_settings.caption_descriptions.destination_settings.ebu_tt_d_destination_settings.new](#fn-encoder_settingsencoder_settingscaption_descriptionsebu_tt_d_destination_settingsnew) constructor.\n - `embedded_destination_settings` (`list[obj]`): Set the `embedded_destination_settings` field on the resulting object. When `null`, the `embedded_destination_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.encoder_settings.caption_descriptions.destination_settings.embedded_destination_settings.new](#fn-encoder_settingsencoder_settingscaption_descriptionsembedded_destination_settingsnew) constructor.\n - `embedded_plus_scte20_destination_settings` (`list[obj]`): Set the `embedded_plus_scte20_destination_settings` field on the resulting object. When `null`, the `embedded_plus_scte20_destination_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.encoder_settings.caption_descriptions.destination_settings.embedded_plus_scte20_destination_settings.new](#fn-encoder_settingsencoder_settingscaption_descriptionsembedded_plus_scte20_destination_settingsnew) constructor.\n - `rtmp_caption_info_destination_settings` (`list[obj]`): Set the `rtmp_caption_info_destination_settings` field on the resulting object. When `null`, the `rtmp_caption_info_destination_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.encoder_settings.caption_descriptions.destination_settings.rtmp_caption_info_destination_settings.new](#fn-encoder_settingsencoder_settingscaption_descriptionsrtmp_caption_info_destination_settingsnew) constructor.\n - `scte20_plus_embedded_destination_settings` (`list[obj]`): Set the `scte20_plus_embedded_destination_settings` field on the resulting object. When `null`, the `scte20_plus_embedded_destination_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.encoder_settings.caption_descriptions.destination_settings.scte20_plus_embedded_destination_settings.new](#fn-encoder_settingsencoder_settingscaption_descriptionsscte20_plus_embedded_destination_settingsnew) constructor.\n - `scte27_destination_settings` (`list[obj]`): Set the `scte27_destination_settings` field on the resulting object. When `null`, the `scte27_destination_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.encoder_settings.caption_descriptions.destination_settings.scte27_destination_settings.new](#fn-encoder_settingsencoder_settingscaption_descriptionsscte27_destination_settingsnew) constructor.\n - `smpte_tt_destination_settings` (`list[obj]`): Set the `smpte_tt_destination_settings` field on the resulting object. When `null`, the `smpte_tt_destination_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.encoder_settings.caption_descriptions.destination_settings.smpte_tt_destination_settings.new](#fn-encoder_settingsencoder_settingscaption_descriptionssmpte_tt_destination_settingsnew) constructor.\n - `teletext_destination_settings` (`list[obj]`): Set the `teletext_destination_settings` field on the resulting object. When `null`, the `teletext_destination_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.encoder_settings.caption_descriptions.destination_settings.teletext_destination_settings.new](#fn-encoder_settingsencoder_settingscaption_descriptionsteletext_destination_settingsnew) constructor.\n - `ttml_destination_settings` (`list[obj]`): Set the `ttml_destination_settings` field on the resulting object. When `null`, the `ttml_destination_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.encoder_settings.caption_descriptions.destination_settings.ttml_destination_settings.new](#fn-encoder_settingsencoder_settingscaption_descriptionsttml_destination_settingsnew) constructor.\n - `webvtt_destination_settings` (`list[obj]`): Set the `webvtt_destination_settings` field on the resulting object. When `null`, the `webvtt_destination_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.encoder_settings.caption_descriptions.destination_settings.webvtt_destination_settings.new](#fn-encoder_settingsencoder_settingscaption_descriptionswebvtt_destination_settingsnew) constructor.\n\n**Returns**:\n - An attribute object that represents the `destination_settings` sub block.\n', args=[]), + new( + arib_destination_settings=null, + burn_in_destination_settings=null, + dvb_sub_destination_settings=null, + ebu_tt_d_destination_settings=null, + embedded_destination_settings=null, + embedded_plus_scte20_destination_settings=null, + rtmp_caption_info_destination_settings=null, + scte20_plus_embedded_destination_settings=null, + scte27_destination_settings=null, + smpte_tt_destination_settings=null, + teletext_destination_settings=null, + ttml_destination_settings=null, + webvtt_destination_settings=null + ):: std.prune(a={ + arib_destination_settings: arib_destination_settings, + burn_in_destination_settings: burn_in_destination_settings, + dvb_sub_destination_settings: dvb_sub_destination_settings, + ebu_tt_d_destination_settings: ebu_tt_d_destination_settings, + embedded_destination_settings: embedded_destination_settings, + embedded_plus_scte20_destination_settings: embedded_plus_scte20_destination_settings, + rtmp_caption_info_destination_settings: rtmp_caption_info_destination_settings, + scte20_plus_embedded_destination_settings: scte20_plus_embedded_destination_settings, + scte27_destination_settings: scte27_destination_settings, + smpte_tt_destination_settings: smpte_tt_destination_settings, + teletext_destination_settings: teletext_destination_settings, + ttml_destination_settings: ttml_destination_settings, + webvtt_destination_settings: webvtt_destination_settings, + }), + rtmp_caption_info_destination_settings:: { + '#new':: d.fn(help='\n`aws.medialive_channel.encoder_settings.caption_descriptions.destination_settings.rtmp_caption_info_destination_settings.new` constructs a new object with attributes and blocks configured for the `rtmp_caption_info_destination_settings`\nTerraform sub block.\n\n\n\n**Returns**:\n - An attribute object that represents the `rtmp_caption_info_destination_settings` sub block.\n', args=[]), + new( + + ):: std.prune(a={}), + }, + scte20_plus_embedded_destination_settings:: { + '#new':: d.fn(help='\n`aws.medialive_channel.encoder_settings.caption_descriptions.destination_settings.scte20_plus_embedded_destination_settings.new` constructs a new object with attributes and blocks configured for the `scte20_plus_embedded_destination_settings`\nTerraform sub block.\n\n\n\n**Returns**:\n - An attribute object that represents the `scte20_plus_embedded_destination_settings` sub block.\n', args=[]), + new( + + ):: std.prune(a={}), + }, + scte27_destination_settings:: { + '#new':: d.fn(help='\n`aws.medialive_channel.encoder_settings.caption_descriptions.destination_settings.scte27_destination_settings.new` constructs a new object with attributes and blocks configured for the `scte27_destination_settings`\nTerraform sub block.\n\n\n\n**Returns**:\n - An attribute object that represents the `scte27_destination_settings` sub block.\n', args=[]), + new( + + ):: std.prune(a={}), + }, + smpte_tt_destination_settings:: { + '#new':: d.fn(help='\n`aws.medialive_channel.encoder_settings.caption_descriptions.destination_settings.smpte_tt_destination_settings.new` constructs a new object with attributes and blocks configured for the `smpte_tt_destination_settings`\nTerraform sub block.\n\n\n\n**Returns**:\n - An attribute object that represents the `smpte_tt_destination_settings` sub block.\n', args=[]), + new( + + ):: std.prune(a={}), + }, + teletext_destination_settings:: { + '#new':: d.fn(help='\n`aws.medialive_channel.encoder_settings.caption_descriptions.destination_settings.teletext_destination_settings.new` constructs a new object with attributes and blocks configured for the `teletext_destination_settings`\nTerraform sub block.\n\n\n\n**Returns**:\n - An attribute object that represents the `teletext_destination_settings` sub block.\n', args=[]), + new( + + ):: std.prune(a={}), + }, + ttml_destination_settings:: { + '#new':: d.fn(help='\n`aws.medialive_channel.encoder_settings.caption_descriptions.destination_settings.ttml_destination_settings.new` constructs a new object with attributes and blocks configured for the `ttml_destination_settings`\nTerraform sub block.\n\n\n\n**Args**:\n - `style_control` (`string`): Set the `style_control` field on the resulting object.\n\n**Returns**:\n - An attribute object that represents the `ttml_destination_settings` sub block.\n', args=[]), + new( + style_control + ):: std.prune(a={ + style_control: style_control, + }), + }, + webvtt_destination_settings:: { + '#new':: d.fn(help='\n`aws.medialive_channel.encoder_settings.caption_descriptions.destination_settings.webvtt_destination_settings.new` constructs a new object with attributes and blocks configured for the `webvtt_destination_settings`\nTerraform sub block.\n\n\n\n**Args**:\n - `style_control` (`string`): Set the `style_control` field on the resulting object.\n\n**Returns**:\n - An attribute object that represents the `webvtt_destination_settings` sub block.\n', args=[]), + new( + style_control + ):: std.prune(a={ + style_control: style_control, + }), + }, + }, + '#new':: d.fn(help='\n`aws.medialive_channel.encoder_settings.caption_descriptions.new` constructs a new object with attributes and blocks configured for the `caption_descriptions`\nTerraform sub block.\n\n\n\n**Args**:\n - `accessibility` (`string`): Set the `accessibility` field on the resulting object. When `null`, the `accessibility` field will be omitted from the resulting object.\n - `caption_selector_name` (`string`): Set the `caption_selector_name` field on the resulting object.\n - `language_code` (`string`): Set the `language_code` field on the resulting object. When `null`, the `language_code` field will be omitted from the resulting object.\n - `language_description` (`string`): Set the `language_description` field on the resulting object. When `null`, the `language_description` field will be omitted from the resulting object.\n - `name` (`string`): Set the `name` field on the resulting object.\n - `destination_settings` (`list[obj]`): Set the `destination_settings` field on the resulting object. When `null`, the `destination_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.encoder_settings.caption_descriptions.destination_settings.new](#fn-encoder_settingsencoder_settingsdestination_settingsnew) constructor.\n\n**Returns**:\n - An attribute object that represents the `caption_descriptions` sub block.\n', args=[]), + new( + caption_selector_name, + name, + accessibility=null, + destination_settings=null, + language_code=null, + language_description=null + ):: std.prune(a={ + accessibility: accessibility, + caption_selector_name: caption_selector_name, + destination_settings: destination_settings, + language_code: language_code, + language_description: language_description, + name: name, + }), + }, + global_configuration:: { + input_loss_behavior:: { + input_loss_image_slate:: { + '#new':: d.fn(help='\n`aws.medialive_channel.encoder_settings.global_configuration.input_loss_behavior.input_loss_image_slate.new` constructs a new object with attributes and blocks configured for the `input_loss_image_slate`\nTerraform sub block.\n\n\n\n**Args**:\n - `password_param` (`string`): Set the `password_param` field on the resulting object. When `null`, the `password_param` field will be omitted from the resulting object.\n - `uri` (`string`): Set the `uri` field on the resulting object.\n - `username` (`string`): Set the `username` field on the resulting object. When `null`, the `username` field will be omitted from the resulting object.\n\n**Returns**:\n - An attribute object that represents the `input_loss_image_slate` sub block.\n', args=[]), + new( + uri, + password_param=null, + username=null + ):: std.prune(a={ + password_param: password_param, + uri: uri, + username: username, + }), + }, + '#new':: d.fn(help='\n`aws.medialive_channel.encoder_settings.global_configuration.input_loss_behavior.new` constructs a new object with attributes and blocks configured for the `input_loss_behavior`\nTerraform sub block.\n\n\n\n**Args**:\n - `black_frame_msec` (`number`): Set the `black_frame_msec` field on the resulting object. When `null`, the `black_frame_msec` field will be omitted from the resulting object.\n - `input_loss_image_color` (`string`): Set the `input_loss_image_color` field on the resulting object. When `null`, the `input_loss_image_color` field will be omitted from the resulting object.\n - `input_loss_image_type` (`string`): Set the `input_loss_image_type` field on the resulting object. When `null`, the `input_loss_image_type` field will be omitted from the resulting object.\n - `repeat_frame_msec` (`number`): Set the `repeat_frame_msec` field on the resulting object. When `null`, the `repeat_frame_msec` field will be omitted from the resulting object.\n - `input_loss_image_slate` (`list[obj]`): Set the `input_loss_image_slate` field on the resulting object. When `null`, the `input_loss_image_slate` 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.encoder_settings.global_configuration.input_loss_behavior.input_loss_image_slate.new](#fn-encoder_settingsencoder_settingsglobal_configurationinput_loss_image_slatenew) constructor.\n\n**Returns**:\n - An attribute object that represents the `input_loss_behavior` sub block.\n', args=[]), + new( + black_frame_msec=null, + input_loss_image_color=null, + input_loss_image_slate=null, + input_loss_image_type=null, + repeat_frame_msec=null + ):: std.prune(a={ + black_frame_msec: black_frame_msec, + input_loss_image_color: input_loss_image_color, + input_loss_image_slate: input_loss_image_slate, + input_loss_image_type: input_loss_image_type, + repeat_frame_msec: repeat_frame_msec, + }), + }, + '#new':: d.fn(help='\n`aws.medialive_channel.encoder_settings.global_configuration.new` constructs a new object with attributes and blocks configured for the `global_configuration`\nTerraform sub block.\n\n\n\n**Args**:\n - `initial_audio_gain` (`number`): Set the `initial_audio_gain` field on the resulting object. When `null`, the `initial_audio_gain` field will be omitted from the resulting object.\n - `input_end_action` (`string`): Set the `input_end_action` field on the resulting object. When `null`, the `input_end_action` field will be omitted from the resulting object.\n - `output_locking_mode` (`string`): Set the `output_locking_mode` field on the resulting object. When `null`, the `output_locking_mode` field will be omitted from the resulting object.\n - `output_timing_source` (`string`): Set the `output_timing_source` field on the resulting object. When `null`, the `output_timing_source` field will be omitted from the resulting object.\n - `support_low_framerate_inputs` (`string`): Set the `support_low_framerate_inputs` field on the resulting object. When `null`, the `support_low_framerate_inputs` field will be omitted from the resulting object.\n - `input_loss_behavior` (`list[obj]`): Set the `input_loss_behavior` field on the resulting object. When `null`, the `input_loss_behavior` 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.encoder_settings.global_configuration.input_loss_behavior.new](#fn-encoder_settingsencoder_settingsinput_loss_behaviornew) constructor.\n\n**Returns**:\n - An attribute object that represents the `global_configuration` sub block.\n', args=[]), + new( + initial_audio_gain=null, + input_end_action=null, + input_loss_behavior=null, + output_locking_mode=null, + output_timing_source=null, + support_low_framerate_inputs=null + ):: std.prune(a={ + initial_audio_gain: initial_audio_gain, + input_end_action: input_end_action, + input_loss_behavior: input_loss_behavior, + output_locking_mode: output_locking_mode, + output_timing_source: output_timing_source, + support_low_framerate_inputs: support_low_framerate_inputs, + }), + }, + motion_graphics_configuration:: { + motion_graphics_settings:: { + html_motion_graphics_settings:: { + '#new':: d.fn(help='\n`aws.medialive_channel.encoder_settings.motion_graphics_configuration.motion_graphics_settings.html_motion_graphics_settings.new` constructs a new object with attributes and blocks configured for the `html_motion_graphics_settings`\nTerraform sub block.\n\n\n\n**Returns**:\n - An attribute object that represents the `html_motion_graphics_settings` sub block.\n', args=[]), + new( + + ):: std.prune(a={}), + }, + '#new':: d.fn(help='\n`aws.medialive_channel.encoder_settings.motion_graphics_configuration.motion_graphics_settings.new` constructs a new object with attributes and blocks configured for the `motion_graphics_settings`\nTerraform sub block.\n\n\n\n**Args**:\n - `html_motion_graphics_settings` (`list[obj]`): Set the `html_motion_graphics_settings` field on the resulting object. When `null`, the `html_motion_graphics_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.encoder_settings.motion_graphics_configuration.motion_graphics_settings.html_motion_graphics_settings.new](#fn-encoder_settingsencoder_settingsmotion_graphics_configurationhtml_motion_graphics_settingsnew) constructor.\n\n**Returns**:\n - An attribute object that represents the `motion_graphics_settings` sub block.\n', args=[]), + new( + html_motion_graphics_settings=null + ):: std.prune(a={ + html_motion_graphics_settings: html_motion_graphics_settings, + }), + }, + '#new':: d.fn(help='\n`aws.medialive_channel.encoder_settings.motion_graphics_configuration.new` constructs a new object with attributes and blocks configured for the `motion_graphics_configuration`\nTerraform sub block.\n\n\n\n**Args**:\n - `motion_graphics_insertion` (`string`): Set the `motion_graphics_insertion` field on the resulting object. When `null`, the `motion_graphics_insertion` field will be omitted from the resulting object.\n - `motion_graphics_settings` (`list[obj]`): Set the `motion_graphics_settings` field on the resulting object. When `null`, the `motion_graphics_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.encoder_settings.motion_graphics_configuration.motion_graphics_settings.new](#fn-encoder_settingsencoder_settingsmotion_graphics_settingsnew) constructor.\n\n**Returns**:\n - An attribute object that represents the `motion_graphics_configuration` sub block.\n', args=[]), + new( + motion_graphics_insertion=null, + motion_graphics_settings=null + ):: std.prune(a={ + motion_graphics_insertion: motion_graphics_insertion, + motion_graphics_settings: motion_graphics_settings, + }), + }, + '#new':: d.fn(help='\n`aws.medialive_channel.encoder_settings.new` constructs a new object with attributes and blocks configured for the `encoder_settings`\nTerraform sub block.\n\n\n\n**Args**:\n - `audio_descriptions` (`list[obj]`): Set the `audio_descriptions` field on the resulting object. When `null`, the `audio_descriptions` 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.encoder_settings.audio_descriptions.new](#fn-encoder_settingsaudio_descriptionsnew) constructor.\n - `avail_blanking` (`list[obj]`): Set the `avail_blanking` field on the resulting object. When `null`, the `avail_blanking` 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.encoder_settings.avail_blanking.new](#fn-encoder_settingsavail_blankingnew) constructor.\n - `caption_descriptions` (`list[obj]`): Set the `caption_descriptions` field on the resulting object. When `null`, the `caption_descriptions` 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.encoder_settings.caption_descriptions.new](#fn-encoder_settingscaption_descriptionsnew) constructor.\n - `global_configuration` (`list[obj]`): Set the `global_configuration` field on the resulting object. When `null`, the `global_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.medialive_channel.encoder_settings.global_configuration.new](#fn-encoder_settingsglobal_configurationnew) constructor.\n - `motion_graphics_configuration` (`list[obj]`): Set the `motion_graphics_configuration` field on the resulting object. When `null`, the `motion_graphics_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.medialive_channel.encoder_settings.motion_graphics_configuration.new](#fn-encoder_settingsmotion_graphics_configurationnew) constructor.\n - `nielsen_configuration` (`list[obj]`): Set the `nielsen_configuration` field on the resulting object. When `null`, the `nielsen_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.medialive_channel.encoder_settings.nielsen_configuration.new](#fn-encoder_settingsnielsen_configurationnew) constructor.\n - `output_groups` (`list[obj]`): Set the `output_groups` field on the resulting object. When `null`, the `output_groups` 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.encoder_settings.output_groups.new](#fn-encoder_settingsoutput_groupsnew) constructor.\n - `timecode_config` (`list[obj]`): Set the `timecode_config` field on the resulting object. When `null`, the `timecode_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.medialive_channel.encoder_settings.timecode_config.new](#fn-encoder_settingstimecode_confignew) constructor.\n - `video_descriptions` (`list[obj]`): Set the `video_descriptions` field on the resulting object. When `null`, the `video_descriptions` 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.encoder_settings.video_descriptions.new](#fn-encoder_settingsvideo_descriptionsnew) constructor.\n\n**Returns**:\n - An attribute object that represents the `encoder_settings` sub block.\n', args=[]), new( audio_descriptions=null, avail_blanking=null, + caption_descriptions=null, + global_configuration=null, + motion_graphics_configuration=null, + nielsen_configuration=null, output_groups=null, timecode_config=null, video_descriptions=null ):: std.prune(a={ audio_descriptions: audio_descriptions, avail_blanking: avail_blanking, + caption_descriptions: caption_descriptions, + global_configuration: global_configuration, + motion_graphics_configuration: motion_graphics_configuration, + nielsen_configuration: nielsen_configuration, output_groups: output_groups, timecode_config: timecode_config, video_descriptions: video_descriptions, }), + nielsen_configuration:: { + '#new':: d.fn(help='\n`aws.medialive_channel.encoder_settings.nielsen_configuration.new` constructs a new object with attributes and blocks configured for the `nielsen_configuration`\nTerraform sub block.\n\n\n\n**Args**:\n - `distributor_id` (`string`): Set the `distributor_id` field on the resulting object. When `null`, the `distributor_id` field will be omitted from the resulting object.\n - `nielsen_pcm_to_id3_tagging` (`string`): Set the `nielsen_pcm_to_id3_tagging` field on the resulting object. When `null`, the `nielsen_pcm_to_id3_tagging` field will be omitted from the resulting object.\n\n**Returns**:\n - An attribute object that represents the `nielsen_configuration` sub block.\n', args=[]), + new( + distributor_id=null, + nielsen_pcm_to_id3_tagging=null + ):: std.prune(a={ + distributor_id: distributor_id, + nielsen_pcm_to_id3_tagging: nielsen_pcm_to_id3_tagging, + }), + }, output_groups:: { '#new':: d.fn(help='\n`aws.medialive_channel.encoder_settings.output_groups.new` constructs a new object with attributes and blocks configured for the `output_groups`\nTerraform sub block.\n\n\n\n**Args**:\n - `name` (`string`): Set the `name` field on the resulting object. When `null`, the `name` field will be omitted from the resulting object.\n - `output_group_settings` (`list[obj]`): Set the `output_group_settings` field on the resulting object. When `null`, the `output_group_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.encoder_settings.output_groups.output_group_settings.new](#fn-encoder_settingsencoder_settingsoutput_group_settingsnew) constructor.\n - `outputs` (`list[obj]`): Set the `outputs` field on the resulting object. When `null`, the `outputs` 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.encoder_settings.output_groups.outputs.new](#fn-encoder_settingsencoder_settingsoutputsnew) constructor.\n\n**Returns**:\n - An attribute object that represents the `output_groups` sub block.\n', args=[]), new( diff --git a/5.x/_gen/resources/nat_gateway.libsonnet b/5.x/_gen/resources/nat_gateway.libsonnet index 6b8039d3..7a676c72 100644 --- a/5.x/_gen/resources/nat_gateway.libsonnet +++ b/5.x/_gen/resources/nat_gateway.libsonnet @@ -2,15 +2,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='nat_gateway', url='', help='`nat_gateway` represents the `aws_nat_gateway` 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.nat_gateway.new` injects a new `aws_nat_gateway` 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.nat_gateway.new('some_id')\n\nYou can get the reference to the `id` field of the created `aws.nat_gateway` using the reference:\n\n $._ref.aws_nat_gateway.some_id.get('id')\n\nThis is the same as directly entering `\"${ aws_nat_gateway.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 - `allocation_id` (`string`): Set the `allocation_id` field on the resulting resource block. When `null`, the `allocation_id` field will be omitted from the resulting object.\n - `connectivity_type` (`string`): Set the `connectivity_type` field on the resulting resource block. When `null`, the `connectivity_type` field will be omitted from the resulting object.\n - `private_ip` (`string`): Set the `private_ip` field on the resulting resource block. When `null`, the `private_ip` field will be omitted from the resulting object.\n - `subnet_id` (`string`): Set the `subnet_id` 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.nat_gateway.new` injects a new `aws_nat_gateway` 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.nat_gateway.new('some_id')\n\nYou can get the reference to the `id` field of the created `aws.nat_gateway` using the reference:\n\n $._ref.aws_nat_gateway.some_id.get('id')\n\nThis is the same as directly entering `\"${ aws_nat_gateway.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 - `allocation_id` (`string`): Set the `allocation_id` field on the resulting resource block. When `null`, the `allocation_id` field will be omitted from the resulting object.\n - `connectivity_type` (`string`): Set the `connectivity_type` field on the resulting resource block. When `null`, the `connectivity_type` field will be omitted from the resulting object.\n - `private_ip` (`string`): Set the `private_ip` field on the resulting resource block. When `null`, the `private_ip` field will be omitted from the resulting object.\n - `secondary_allocation_ids` (`list`): Set the `secondary_allocation_ids` field on the resulting resource block. When `null`, the `secondary_allocation_ids` field will be omitted from the resulting object.\n - `secondary_private_ip_address_count` (`number`): Set the `secondary_private_ip_address_count` field on the resulting resource block. When `null`, the `secondary_private_ip_address_count` field will be omitted from the resulting object.\n - `secondary_private_ip_addresses` (`list`): Set the `secondary_private_ip_addresses` field on the resulting resource block. When `null`, the `secondary_private_ip_addresses` field will be omitted from the resulting object.\n - `subnet_id` (`string`): Set the `subnet_id` 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.nat_gateway.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_id, allocation_id=null, connectivity_type=null, private_ip=null, + secondary_allocation_ids=null, + secondary_private_ip_address_count=null, + secondary_private_ip_addresses=null, tags=null, tags_all=null, + timeouts=null, _meta={} ):: tf.withResource( type='aws_nat_gateway', @@ -19,28 +23,52 @@ local d = (import 'github.com/jsonnet-libs/docsonnet/doc-util/main.libsonnet'); allocation_id=allocation_id, connectivity_type=connectivity_type, private_ip=private_ip, + secondary_allocation_ids=secondary_allocation_ids, + secondary_private_ip_address_count=secondary_private_ip_address_count, + secondary_private_ip_addresses=secondary_private_ip_addresses, subnet_id=subnet_id, tags=tags, - tags_all=tags_all + tags_all=tags_all, + timeouts=timeouts ), _meta=_meta ), - '#newAttrs':: d.fn(help='\n`aws.nat_gateway.newAttrs` constructs a new object with attributes and blocks configured for the `nat_gateway`\nTerraform resource.\n\nUnlike [aws.nat_gateway.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 - `allocation_id` (`string`): Set the `allocation_id` field on the resulting object. When `null`, the `allocation_id` field will be omitted from the resulting object.\n - `connectivity_type` (`string`): Set the `connectivity_type` field on the resulting object. When `null`, the `connectivity_type` field will be omitted from the resulting object.\n - `private_ip` (`string`): Set the `private_ip` field on the resulting object. When `null`, the `private_ip` field will be omitted from the resulting object.\n - `subnet_id` (`string`): Set the `subnet_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 - `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 `nat_gateway` resource into the root Terraform configuration.\n', args=[]), + '#newAttrs':: d.fn(help='\n`aws.nat_gateway.newAttrs` constructs a new object with attributes and blocks configured for the `nat_gateway`\nTerraform resource.\n\nUnlike [aws.nat_gateway.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 - `allocation_id` (`string`): Set the `allocation_id` field on the resulting object. When `null`, the `allocation_id` field will be omitted from the resulting object.\n - `connectivity_type` (`string`): Set the `connectivity_type` field on the resulting object. When `null`, the `connectivity_type` field will be omitted from the resulting object.\n - `private_ip` (`string`): Set the `private_ip` field on the resulting object. When `null`, the `private_ip` field will be omitted from the resulting object.\n - `secondary_allocation_ids` (`list`): Set the `secondary_allocation_ids` field on the resulting object. When `null`, the `secondary_allocation_ids` field will be omitted from the resulting object.\n - `secondary_private_ip_address_count` (`number`): Set the `secondary_private_ip_address_count` field on the resulting object. When `null`, the `secondary_private_ip_address_count` field will be omitted from the resulting object.\n - `secondary_private_ip_addresses` (`list`): Set the `secondary_private_ip_addresses` field on the resulting object. When `null`, the `secondary_private_ip_addresses` field will be omitted from the resulting object.\n - `subnet_id` (`string`): Set the `subnet_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 - `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.nat_gateway.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 `nat_gateway` resource into the root Terraform configuration.\n', args=[]), newAttrs( subnet_id, allocation_id=null, connectivity_type=null, private_ip=null, + secondary_allocation_ids=null, + secondary_private_ip_address_count=null, + secondary_private_ip_addresses=null, tags=null, - tags_all=null + tags_all=null, + timeouts=null ):: std.prune(a={ allocation_id: allocation_id, connectivity_type: connectivity_type, private_ip: private_ip, + secondary_allocation_ids: secondary_allocation_ids, + secondary_private_ip_address_count: secondary_private_ip_address_count, + secondary_private_ip_addresses: secondary_private_ip_addresses, subnet_id: subnet_id, tags: tags, tags_all: tags_all, + timeouts: timeouts, }), + timeouts:: { + '#new':: d.fn(help='\n`aws.nat_gateway.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, + }), + }, '#withAllocationId':: d.fn(help='`aws.string.withAllocationId` constructs a mixin object that can be merged into the `string`\nTerraform resource block to set or update the allocation_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 `allocation_id` field.\n', args=[]), withAllocationId(resourceLabel, value): { resource+: { @@ -71,6 +99,36 @@ local d = (import 'github.com/jsonnet-libs/docsonnet/doc-util/main.libsonnet'); }, }, }, + '#withSecondaryAllocationIds':: d.fn(help='`aws.list.withSecondaryAllocationIds` constructs a mixin object that can be merged into the `list`\nTerraform resource block to set or update the secondary_allocation_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 `secondary_allocation_ids` field.\n', args=[]), + withSecondaryAllocationIds(resourceLabel, value): { + resource+: { + aws_nat_gateway+: { + [resourceLabel]+: { + secondary_allocation_ids: value, + }, + }, + }, + }, + '#withSecondaryPrivateIpAddressCount':: d.fn(help='`aws.number.withSecondaryPrivateIpAddressCount` constructs a mixin object that can be merged into the `number`\nTerraform resource block to set or update the secondary_private_ip_address_count field.\n\n\n\n**Args**:\n - `resourceLabel` (`string`): The name label of the block to update.\n - `value` (`number`): The value to set for the `secondary_private_ip_address_count` field.\n', args=[]), + withSecondaryPrivateIpAddressCount(resourceLabel, value): { + resource+: { + aws_nat_gateway+: { + [resourceLabel]+: { + secondary_private_ip_address_count: value, + }, + }, + }, + }, + '#withSecondaryPrivateIpAddresses':: d.fn(help='`aws.list.withSecondaryPrivateIpAddresses` constructs a mixin object that can be merged into the `list`\nTerraform resource block to set or update the secondary_private_ip_addresses 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 `secondary_private_ip_addresses` field.\n', args=[]), + withSecondaryPrivateIpAddresses(resourceLabel, value): { + resource+: { + aws_nat_gateway+: { + [resourceLabel]+: { + secondary_private_ip_addresses: value, + }, + }, + }, + }, '#withSubnetId':: d.fn(help='`aws.string.withSubnetId` constructs a mixin object that can be merged into the `string`\nTerraform resource block to set or update the 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 `subnet_id` field.\n', args=[]), withSubnetId(resourceLabel, value): { resource+: { @@ -101,4 +159,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_nat_gateway+: { + [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_nat_gateway+: { + [resourceLabel]+: { + timeouts+: value, + }, + }, + }, + }, } diff --git a/5.x/_gen/resources/networkfirewall_firewall_policy.libsonnet b/5.x/_gen/resources/networkfirewall_firewall_policy.libsonnet index d09780b7..01df8811 100644 --- a/5.x/_gen/resources/networkfirewall_firewall_policy.libsonnet +++ b/5.x/_gen/resources/networkfirewall_firewall_policy.libsonnet @@ -13,16 +13,18 @@ local d = (import 'github.com/jsonnet-libs/docsonnet/doc-util/main.libsonnet'); }), }, firewall_policy:: { - '#new':: d.fn(help='\n`aws.networkfirewall_firewall_policy.firewall_policy.new` constructs a new object with attributes and blocks configured for the `firewall_policy`\nTerraform sub block.\n\n\n\n**Args**:\n - `stateful_default_actions` (`list`): Set the `stateful_default_actions` field on the resulting object. When `null`, the `stateful_default_actions` field will be omitted from the resulting object.\n - `stateless_default_actions` (`list`): Set the `stateless_default_actions` field on the resulting object.\n - `stateless_fragment_default_actions` (`list`): Set the `stateless_fragment_default_actions` field on the resulting object.\n - `stateful_engine_options` (`list[obj]`): Set the `stateful_engine_options` field on the resulting object. When `null`, the `stateful_engine_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.networkfirewall_firewall_policy.firewall_policy.stateful_engine_options.new](#fn-firewall_policystateful_engine_optionsnew) constructor.\n - `stateful_rule_group_reference` (`list[obj]`): Set the `stateful_rule_group_reference` field on the resulting object. When `null`, the `stateful_rule_group_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.networkfirewall_firewall_policy.firewall_policy.stateful_rule_group_reference.new](#fn-firewall_policystateful_rule_group_referencenew) constructor.\n - `stateless_custom_action` (`list[obj]`): Set the `stateless_custom_action` field on the resulting object. When `null`, the `stateless_custom_action` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [aws.networkfirewall_firewall_policy.firewall_policy.stateless_custom_action.new](#fn-firewall_policystateless_custom_actionnew) constructor.\n - `stateless_rule_group_reference` (`list[obj]`): Set the `stateless_rule_group_reference` field on the resulting object. When `null`, the `stateless_rule_group_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.networkfirewall_firewall_policy.firewall_policy.stateless_rule_group_reference.new](#fn-firewall_policystateless_rule_group_referencenew) constructor.\n\n**Returns**:\n - An attribute object that represents the `firewall_policy` sub block.\n', args=[]), + '#new':: d.fn(help='\n`aws.networkfirewall_firewall_policy.firewall_policy.new` constructs a new object with attributes and blocks configured for the `firewall_policy`\nTerraform sub block.\n\n\n\n**Args**:\n - `stateful_default_actions` (`list`): Set the `stateful_default_actions` field on the resulting object. When `null`, the `stateful_default_actions` field will be omitted from the resulting object.\n - `stateless_default_actions` (`list`): Set the `stateless_default_actions` field on the resulting object.\n - `stateless_fragment_default_actions` (`list`): Set the `stateless_fragment_default_actions` field on the resulting object.\n - `policy_variables` (`list[obj]`): Set the `policy_variables` field on the resulting object. When `null`, the `policy_variables` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [aws.networkfirewall_firewall_policy.firewall_policy.policy_variables.new](#fn-firewall_policypolicy_variablesnew) constructor.\n - `stateful_engine_options` (`list[obj]`): Set the `stateful_engine_options` field on the resulting object. When `null`, the `stateful_engine_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.networkfirewall_firewall_policy.firewall_policy.stateful_engine_options.new](#fn-firewall_policystateful_engine_optionsnew) constructor.\n - `stateful_rule_group_reference` (`list[obj]`): Set the `stateful_rule_group_reference` field on the resulting object. When `null`, the `stateful_rule_group_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.networkfirewall_firewall_policy.firewall_policy.stateful_rule_group_reference.new](#fn-firewall_policystateful_rule_group_referencenew) constructor.\n - `stateless_custom_action` (`list[obj]`): Set the `stateless_custom_action` field on the resulting object. When `null`, the `stateless_custom_action` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [aws.networkfirewall_firewall_policy.firewall_policy.stateless_custom_action.new](#fn-firewall_policystateless_custom_actionnew) constructor.\n - `stateless_rule_group_reference` (`list[obj]`): Set the `stateless_rule_group_reference` field on the resulting object. When `null`, the `stateless_rule_group_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.networkfirewall_firewall_policy.firewall_policy.stateless_rule_group_reference.new](#fn-firewall_policystateless_rule_group_referencenew) constructor.\n\n**Returns**:\n - An attribute object that represents the `firewall_policy` sub block.\n', args=[]), new( stateless_default_actions, stateless_fragment_default_actions, + policy_variables=null, stateful_default_actions=null, stateful_engine_options=null, stateful_rule_group_reference=null, stateless_custom_action=null, stateless_rule_group_reference=null ):: std.prune(a={ + policy_variables: policy_variables, stateful_default_actions: stateful_default_actions, stateful_engine_options: stateful_engine_options, stateful_rule_group_reference: stateful_rule_group_reference, @@ -31,6 +33,32 @@ local d = (import 'github.com/jsonnet-libs/docsonnet/doc-util/main.libsonnet'); stateless_fragment_default_actions: stateless_fragment_default_actions, stateless_rule_group_reference: stateless_rule_group_reference, }), + policy_variables:: { + '#new':: d.fn(help='\n`aws.networkfirewall_firewall_policy.firewall_policy.policy_variables.new` constructs a new object with attributes and blocks configured for the `policy_variables`\nTerraform sub block.\n\n\n\n**Args**:\n - `rule_variables` (`list[obj]`): Set the `rule_variables` field on the resulting object. When `null`, the `rule_variables` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [aws.networkfirewall_firewall_policy.firewall_policy.policy_variables.rule_variables.new](#fn-firewall_policyfirewall_policyrule_variablesnew) constructor.\n\n**Returns**:\n - An attribute object that represents the `policy_variables` sub block.\n', args=[]), + new( + rule_variables=null + ):: std.prune(a={ + rule_variables: rule_variables, + }), + rule_variables:: { + ip_set:: { + '#new':: d.fn(help='\n`aws.networkfirewall_firewall_policy.firewall_policy.policy_variables.rule_variables.ip_set.new` constructs a new object with attributes and blocks configured for the `ip_set`\nTerraform sub block.\n\n\n\n**Args**:\n - `definition` (`list`): Set the `definition` field on the resulting object.\n\n**Returns**:\n - An attribute object that represents the `ip_set` sub block.\n', args=[]), + new( + definition + ):: std.prune(a={ + definition: definition, + }), + }, + '#new':: d.fn(help='\n`aws.networkfirewall_firewall_policy.firewall_policy.policy_variables.rule_variables.new` constructs a new object with attributes and blocks configured for the `rule_variables`\nTerraform sub block.\n\n\n\n**Args**:\n - `key` (`string`): Set the `key` field on the resulting object.\n - `ip_set` (`list[obj]`): Set the `ip_set` field on the resulting object. When `null`, the `ip_set` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [aws.networkfirewall_firewall_policy.firewall_policy.policy_variables.rule_variables.ip_set.new](#fn-firewall_policyfirewall_policypolicy_variablesip_setnew) constructor.\n\n**Returns**:\n - An attribute object that represents the `rule_variables` sub block.\n', args=[]), + new( + key, + ip_set=null + ):: std.prune(a={ + ip_set: ip_set, + key: key, + }), + }, + }, stateful_engine_options:: { '#new':: d.fn(help='\n`aws.networkfirewall_firewall_policy.firewall_policy.stateful_engine_options.new` constructs a new object with attributes and blocks configured for the `stateful_engine_options`\nTerraform sub block.\n\n\n\n**Args**:\n - `rule_order` (`string`): Set the `rule_order` field on the resulting object. When `null`, the `rule_order` field will be omitted from the resulting object.\n - `stream_exception_policy` (`string`): Set the `stream_exception_policy` field on the resulting object. When `null`, the `stream_exception_policy` field will be omitted from the resulting object.\n\n**Returns**:\n - An attribute object that represents the `stateful_engine_options` sub block.\n', args=[]), new( diff --git a/5.x/_gen/resources/quicksight_analysis.libsonnet b/5.x/_gen/resources/quicksight_analysis.libsonnet index 69b2e3cc..2c7a7c14 100644 --- a/5.x/_gen/resources/quicksight_analysis.libsonnet +++ b/5.x/_gen/resources/quicksight_analysis.libsonnet @@ -2491,10 +2491,10 @@ local d = (import 'github.com/jsonnet-libs/docsonnet/doc-util/main.libsonnet'); screen_canvas_size_options: screen_canvas_size_options, }), screen_canvas_size_options:: { - '#new':: d.fn(help='\n`aws.quicksight_analysis.definition.sheets.layouts.configuration.grid_layout.canvas_size_options.screen_canvas_size_options.new` constructs a new object with attributes and blocks configured for the `screen_canvas_size_options`\nTerraform sub block.\n\n\n\n**Args**:\n - `optimized_view_port_width` (`string`): Set the `optimized_view_port_width` field on the resulting object.\n - `resize_option` (`string`): Set the `resize_option` field on the resulting object.\n\n**Returns**:\n - An attribute object that represents the `screen_canvas_size_options` sub block.\n', args=[]), + '#new':: d.fn(help='\n`aws.quicksight_analysis.definition.sheets.layouts.configuration.grid_layout.canvas_size_options.screen_canvas_size_options.new` constructs a new object with attributes and blocks configured for the `screen_canvas_size_options`\nTerraform sub block.\n\n\n\n**Args**:\n - `optimized_view_port_width` (`string`): Set the `optimized_view_port_width` field on the resulting object. When `null`, the `optimized_view_port_width` field will be omitted from the resulting object.\n - `resize_option` (`string`): Set the `resize_option` field on the resulting object.\n\n**Returns**:\n - An attribute object that represents the `screen_canvas_size_options` sub block.\n', args=[]), new( - optimized_view_port_width, - resize_option + resize_option, + optimized_view_port_width=null ):: std.prune(a={ optimized_view_port_width: optimized_view_port_width, resize_option: resize_option, @@ -3653,10 +3653,10 @@ local d = (import 'github.com/jsonnet-libs/docsonnet/doc-util/main.libsonnet'); screen_canvas_size_options: screen_canvas_size_options, }), screen_canvas_size_options:: { - '#new':: d.fn(help='\n`aws.quicksight_analysis.definition.sheets.sheet_control_layouts.configuration.grid_layout.canvas_size_options.screen_canvas_size_options.new` constructs a new object with attributes and blocks configured for the `screen_canvas_size_options`\nTerraform sub block.\n\n\n\n**Args**:\n - `optimized_view_port_width` (`string`): Set the `optimized_view_port_width` field on the resulting object.\n - `resize_option` (`string`): Set the `resize_option` field on the resulting object.\n\n**Returns**:\n - An attribute object that represents the `screen_canvas_size_options` sub block.\n', args=[]), + '#new':: d.fn(help='\n`aws.quicksight_analysis.definition.sheets.sheet_control_layouts.configuration.grid_layout.canvas_size_options.screen_canvas_size_options.new` constructs a new object with attributes and blocks configured for the `screen_canvas_size_options`\nTerraform sub block.\n\n\n\n**Args**:\n - `optimized_view_port_width` (`string`): Set the `optimized_view_port_width` field on the resulting object. When `null`, the `optimized_view_port_width` field will be omitted from the resulting object.\n - `resize_option` (`string`): Set the `resize_option` field on the resulting object.\n\n**Returns**:\n - An attribute object that represents the `screen_canvas_size_options` sub block.\n', args=[]), new( - optimized_view_port_width, - resize_option + resize_option, + optimized_view_port_width=null ):: std.prune(a={ optimized_view_port_width: optimized_view_port_width, resize_option: resize_option, diff --git a/5.x/_gen/resources/quicksight_dashboard.libsonnet b/5.x/_gen/resources/quicksight_dashboard.libsonnet index eb1453d7..db4092a3 100644 --- a/5.x/_gen/resources/quicksight_dashboard.libsonnet +++ b/5.x/_gen/resources/quicksight_dashboard.libsonnet @@ -2597,10 +2597,10 @@ local d = (import 'github.com/jsonnet-libs/docsonnet/doc-util/main.libsonnet'); screen_canvas_size_options: screen_canvas_size_options, }), screen_canvas_size_options:: { - '#new':: d.fn(help='\n`aws.quicksight_dashboard.definition.sheets.layouts.configuration.grid_layout.canvas_size_options.screen_canvas_size_options.new` constructs a new object with attributes and blocks configured for the `screen_canvas_size_options`\nTerraform sub block.\n\n\n\n**Args**:\n - `optimized_view_port_width` (`string`): Set the `optimized_view_port_width` field on the resulting object.\n - `resize_option` (`string`): Set the `resize_option` field on the resulting object.\n\n**Returns**:\n - An attribute object that represents the `screen_canvas_size_options` sub block.\n', args=[]), + '#new':: d.fn(help='\n`aws.quicksight_dashboard.definition.sheets.layouts.configuration.grid_layout.canvas_size_options.screen_canvas_size_options.new` constructs a new object with attributes and blocks configured for the `screen_canvas_size_options`\nTerraform sub block.\n\n\n\n**Args**:\n - `optimized_view_port_width` (`string`): Set the `optimized_view_port_width` field on the resulting object. When `null`, the `optimized_view_port_width` field will be omitted from the resulting object.\n - `resize_option` (`string`): Set the `resize_option` field on the resulting object.\n\n**Returns**:\n - An attribute object that represents the `screen_canvas_size_options` sub block.\n', args=[]), new( - optimized_view_port_width, - resize_option + resize_option, + optimized_view_port_width=null ):: std.prune(a={ optimized_view_port_width: optimized_view_port_width, resize_option: resize_option, @@ -3759,10 +3759,10 @@ local d = (import 'github.com/jsonnet-libs/docsonnet/doc-util/main.libsonnet'); screen_canvas_size_options: screen_canvas_size_options, }), screen_canvas_size_options:: { - '#new':: d.fn(help='\n`aws.quicksight_dashboard.definition.sheets.sheet_control_layouts.configuration.grid_layout.canvas_size_options.screen_canvas_size_options.new` constructs a new object with attributes and blocks configured for the `screen_canvas_size_options`\nTerraform sub block.\n\n\n\n**Args**:\n - `optimized_view_port_width` (`string`): Set the `optimized_view_port_width` field on the resulting object.\n - `resize_option` (`string`): Set the `resize_option` field on the resulting object.\n\n**Returns**:\n - An attribute object that represents the `screen_canvas_size_options` sub block.\n', args=[]), + '#new':: d.fn(help='\n`aws.quicksight_dashboard.definition.sheets.sheet_control_layouts.configuration.grid_layout.canvas_size_options.screen_canvas_size_options.new` constructs a new object with attributes and blocks configured for the `screen_canvas_size_options`\nTerraform sub block.\n\n\n\n**Args**:\n - `optimized_view_port_width` (`string`): Set the `optimized_view_port_width` field on the resulting object. When `null`, the `optimized_view_port_width` field will be omitted from the resulting object.\n - `resize_option` (`string`): Set the `resize_option` field on the resulting object.\n\n**Returns**:\n - An attribute object that represents the `screen_canvas_size_options` sub block.\n', args=[]), new( - optimized_view_port_width, - resize_option + resize_option, + optimized_view_port_width=null ):: std.prune(a={ optimized_view_port_width: optimized_view_port_width, resize_option: resize_option, diff --git a/5.x/_gen/resources/quicksight_template.libsonnet b/5.x/_gen/resources/quicksight_template.libsonnet index 132d090a..08a3f22d 100644 --- a/5.x/_gen/resources/quicksight_template.libsonnet +++ b/5.x/_gen/resources/quicksight_template.libsonnet @@ -2531,10 +2531,10 @@ local d = (import 'github.com/jsonnet-libs/docsonnet/doc-util/main.libsonnet'); screen_canvas_size_options: screen_canvas_size_options, }), screen_canvas_size_options:: { - '#new':: d.fn(help='\n`aws.quicksight_template.definition.sheets.layouts.configuration.grid_layout.canvas_size_options.screen_canvas_size_options.new` constructs a new object with attributes and blocks configured for the `screen_canvas_size_options`\nTerraform sub block.\n\n\n\n**Args**:\n - `optimized_view_port_width` (`string`): Set the `optimized_view_port_width` field on the resulting object.\n - `resize_option` (`string`): Set the `resize_option` field on the resulting object.\n\n**Returns**:\n - An attribute object that represents the `screen_canvas_size_options` sub block.\n', args=[]), + '#new':: d.fn(help='\n`aws.quicksight_template.definition.sheets.layouts.configuration.grid_layout.canvas_size_options.screen_canvas_size_options.new` constructs a new object with attributes and blocks configured for the `screen_canvas_size_options`\nTerraform sub block.\n\n\n\n**Args**:\n - `optimized_view_port_width` (`string`): Set the `optimized_view_port_width` field on the resulting object. When `null`, the `optimized_view_port_width` field will be omitted from the resulting object.\n - `resize_option` (`string`): Set the `resize_option` field on the resulting object.\n\n**Returns**:\n - An attribute object that represents the `screen_canvas_size_options` sub block.\n', args=[]), new( - optimized_view_port_width, - resize_option + resize_option, + optimized_view_port_width=null ):: std.prune(a={ optimized_view_port_width: optimized_view_port_width, resize_option: resize_option, @@ -3693,10 +3693,10 @@ local d = (import 'github.com/jsonnet-libs/docsonnet/doc-util/main.libsonnet'); screen_canvas_size_options: screen_canvas_size_options, }), screen_canvas_size_options:: { - '#new':: d.fn(help='\n`aws.quicksight_template.definition.sheets.sheet_control_layouts.configuration.grid_layout.canvas_size_options.screen_canvas_size_options.new` constructs a new object with attributes and blocks configured for the `screen_canvas_size_options`\nTerraform sub block.\n\n\n\n**Args**:\n - `optimized_view_port_width` (`string`): Set the `optimized_view_port_width` field on the resulting object.\n - `resize_option` (`string`): Set the `resize_option` field on the resulting object.\n\n**Returns**:\n - An attribute object that represents the `screen_canvas_size_options` sub block.\n', args=[]), + '#new':: d.fn(help='\n`aws.quicksight_template.definition.sheets.sheet_control_layouts.configuration.grid_layout.canvas_size_options.screen_canvas_size_options.new` constructs a new object with attributes and blocks configured for the `screen_canvas_size_options`\nTerraform sub block.\n\n\n\n**Args**:\n - `optimized_view_port_width` (`string`): Set the `optimized_view_port_width` field on the resulting object. When `null`, the `optimized_view_port_width` field will be omitted from the resulting object.\n - `resize_option` (`string`): Set the `resize_option` field on the resulting object.\n\n**Returns**:\n - An attribute object that represents the `screen_canvas_size_options` sub block.\n', args=[]), new( - optimized_view_port_width, - resize_option + resize_option, + optimized_view_port_width=null ):: std.prune(a={ optimized_view_port_width: optimized_view_port_width, resize_option: resize_option, diff --git a/5.x/_gen/resources/sagemaker_domain.libsonnet b/5.x/_gen/resources/sagemaker_domain.libsonnet index d0257029..c3e6b684 100644 --- a/5.x/_gen/resources/sagemaker_domain.libsonnet +++ b/5.x/_gen/resources/sagemaker_domain.libsonnet @@ -100,13 +100,15 @@ local d = (import 'github.com/jsonnet-libs/docsonnet/doc-util/main.libsonnet'); status: status, }), }, - '#new':: d.fn(help='\n`aws.sagemaker_domain.default_user_settings.canvas_app_settings.new` constructs a new object with attributes and blocks configured for the `canvas_app_settings`\nTerraform sub block.\n\n\n\n**Args**:\n - `model_register_settings` (`list[obj]`): Set the `model_register_settings` field on the resulting object. When `null`, the `model_register_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.sagemaker_domain.default_user_settings.canvas_app_settings.model_register_settings.new](#fn-default_user_settingsdefault_user_settingsmodel_register_settingsnew) constructor.\n - `time_series_forecasting_settings` (`list[obj]`): Set the `time_series_forecasting_settings` field on the resulting object. When `null`, the `time_series_forecasting_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.sagemaker_domain.default_user_settings.canvas_app_settings.time_series_forecasting_settings.new](#fn-default_user_settingsdefault_user_settingstime_series_forecasting_settingsnew) constructor.\n\n**Returns**:\n - An attribute object that represents the `canvas_app_settings` sub block.\n', args=[]), + '#new':: d.fn(help='\n`aws.sagemaker_domain.default_user_settings.canvas_app_settings.new` constructs a new object with attributes and blocks configured for the `canvas_app_settings`\nTerraform sub block.\n\n\n\n**Args**:\n - `model_register_settings` (`list[obj]`): Set the `model_register_settings` field on the resulting object. When `null`, the `model_register_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.sagemaker_domain.default_user_settings.canvas_app_settings.model_register_settings.new](#fn-default_user_settingsdefault_user_settingsmodel_register_settingsnew) constructor.\n - `time_series_forecasting_settings` (`list[obj]`): Set the `time_series_forecasting_settings` field on the resulting object. When `null`, the `time_series_forecasting_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.sagemaker_domain.default_user_settings.canvas_app_settings.time_series_forecasting_settings.new](#fn-default_user_settingsdefault_user_settingstime_series_forecasting_settingsnew) constructor.\n - `workspace_settings` (`list[obj]`): Set the `workspace_settings` field on the resulting object. When `null`, the `workspace_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.sagemaker_domain.default_user_settings.canvas_app_settings.workspace_settings.new](#fn-default_user_settingsdefault_user_settingsworkspace_settingsnew) constructor.\n\n**Returns**:\n - An attribute object that represents the `canvas_app_settings` sub block.\n', args=[]), new( model_register_settings=null, - time_series_forecasting_settings=null + time_series_forecasting_settings=null, + workspace_settings=null ):: std.prune(a={ model_register_settings: model_register_settings, time_series_forecasting_settings: time_series_forecasting_settings, + workspace_settings: workspace_settings, }), time_series_forecasting_settings:: { '#new':: d.fn(help='\n`aws.sagemaker_domain.default_user_settings.canvas_app_settings.time_series_forecasting_settings.new` constructs a new object with attributes and blocks configured for the `time_series_forecasting_settings`\nTerraform sub block.\n\n\n\n**Args**:\n - `amazon_forecast_role_arn` (`string`): Set the `amazon_forecast_role_arn` field on the resulting object. When `null`, the `amazon_forecast_role_arn` field will be omitted from 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\n**Returns**:\n - An attribute object that represents the `time_series_forecasting_settings` sub block.\n', args=[]), @@ -118,6 +120,16 @@ local d = (import 'github.com/jsonnet-libs/docsonnet/doc-util/main.libsonnet'); status: status, }), }, + workspace_settings:: { + '#new':: d.fn(help='\n`aws.sagemaker_domain.default_user_settings.canvas_app_settings.workspace_settings.new` constructs a new object with attributes and blocks configured for the `workspace_settings`\nTerraform sub block.\n\n\n\n**Args**:\n - `s3_artifact_path` (`string`): Set the `s3_artifact_path` field on the resulting object. When `null`, the `s3_artifact_path` field will be omitted from the resulting object.\n - `s3_kms_key_id` (`string`): Set the `s3_kms_key_id` field on the resulting object. When `null`, the `s3_kms_key_id` field will be omitted from the resulting object.\n\n**Returns**:\n - An attribute object that represents the `workspace_settings` sub block.\n', args=[]), + new( + s3_artifact_path=null, + s3_kms_key_id=null + ):: std.prune(a={ + s3_artifact_path: s3_artifact_path, + s3_kms_key_id: s3_kms_key_id, + }), + }, }, jupyter_server_app_settings:: { code_repository:: { diff --git a/5.x/_gen/resources/sagemaker_endpoint.libsonnet b/5.x/_gen/resources/sagemaker_endpoint.libsonnet index f92f8807..e90c4169 100644 --- a/5.x/_gen/resources/sagemaker_endpoint.libsonnet +++ b/5.x/_gen/resources/sagemaker_endpoint.libsonnet @@ -65,14 +65,50 @@ local d = (import 'github.com/jsonnet-libs/docsonnet/doc-util/main.libsonnet'); }), }, }, - '#new':: d.fn(help='\n`aws.sagemaker_endpoint.deployment_config.new` constructs a new object with attributes and blocks configured for the `deployment_config`\nTerraform sub block.\n\n\n\n**Args**:\n - `auto_rollback_configuration` (`list[obj]`): Set the `auto_rollback_configuration` field on the resulting object. When `null`, the `auto_rollback_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.sagemaker_endpoint.deployment_config.auto_rollback_configuration.new](#fn-deployment_configauto_rollback_configurationnew) constructor.\n - `blue_green_update_policy` (`list[obj]`): Set the `blue_green_update_policy` field on the resulting object. When `null`, the `blue_green_update_policy` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [aws.sagemaker_endpoint.deployment_config.blue_green_update_policy.new](#fn-deployment_configblue_green_update_policynew) constructor.\n\n**Returns**:\n - An attribute object that represents the `deployment_config` sub block.\n', args=[]), + '#new':: d.fn(help='\n`aws.sagemaker_endpoint.deployment_config.new` constructs a new object with attributes and blocks configured for the `deployment_config`\nTerraform sub block.\n\n\n\n**Args**:\n - `auto_rollback_configuration` (`list[obj]`): Set the `auto_rollback_configuration` field on the resulting object. When `null`, the `auto_rollback_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.sagemaker_endpoint.deployment_config.auto_rollback_configuration.new](#fn-deployment_configauto_rollback_configurationnew) constructor.\n - `blue_green_update_policy` (`list[obj]`): Set the `blue_green_update_policy` field on the resulting object. When `null`, the `blue_green_update_policy` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [aws.sagemaker_endpoint.deployment_config.blue_green_update_policy.new](#fn-deployment_configblue_green_update_policynew) constructor.\n - `rolling_update_policy` (`list[obj]`): Set the `rolling_update_policy` field on the resulting object. When `null`, the `rolling_update_policy` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [aws.sagemaker_endpoint.deployment_config.rolling_update_policy.new](#fn-deployment_configrolling_update_policynew) constructor.\n\n**Returns**:\n - An attribute object that represents the `deployment_config` sub block.\n', args=[]), new( auto_rollback_configuration=null, - blue_green_update_policy=null + blue_green_update_policy=null, + rolling_update_policy=null ):: std.prune(a={ auto_rollback_configuration: auto_rollback_configuration, blue_green_update_policy: blue_green_update_policy, + rolling_update_policy: rolling_update_policy, }), + rolling_update_policy:: { + maximum_batch_size:: { + '#new':: d.fn(help='\n`aws.sagemaker_endpoint.deployment_config.rolling_update_policy.maximum_batch_size.new` constructs a new object with attributes and blocks configured for the `maximum_batch_size`\nTerraform sub block.\n\n\n\n**Args**:\n - `type` (`string`): Set the `type` field on the resulting object.\n - `value` (`number`): Set the `value` field on the resulting object.\n\n**Returns**:\n - An attribute object that represents the `maximum_batch_size` sub block.\n', args=[]), + new( + type, + value + ):: std.prune(a={ + type: type, + value: value, + }), + }, + '#new':: d.fn(help='\n`aws.sagemaker_endpoint.deployment_config.rolling_update_policy.new` constructs a new object with attributes and blocks configured for the `rolling_update_policy`\nTerraform sub block.\n\n\n\n**Args**:\n - `maximum_execution_timeout_in_seconds` (`number`): Set the `maximum_execution_timeout_in_seconds` field on the resulting object. When `null`, the `maximum_execution_timeout_in_seconds` field will be omitted from the resulting object.\n - `wait_interval_in_seconds` (`number`): Set the `wait_interval_in_seconds` field on the resulting object.\n - `maximum_batch_size` (`list[obj]`): Set the `maximum_batch_size` field on the resulting object. When `null`, the `maximum_batch_size` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [aws.sagemaker_endpoint.deployment_config.rolling_update_policy.maximum_batch_size.new](#fn-deployment_configdeployment_configmaximum_batch_sizenew) constructor.\n - `rollback_maximum_batch_size` (`list[obj]`): Set the `rollback_maximum_batch_size` field on the resulting object. When `null`, the `rollback_maximum_batch_size` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [aws.sagemaker_endpoint.deployment_config.rolling_update_policy.rollback_maximum_batch_size.new](#fn-deployment_configdeployment_configrollback_maximum_batch_sizenew) constructor.\n\n**Returns**:\n - An attribute object that represents the `rolling_update_policy` sub block.\n', args=[]), + new( + wait_interval_in_seconds, + maximum_batch_size=null, + maximum_execution_timeout_in_seconds=null, + rollback_maximum_batch_size=null + ):: std.prune(a={ + maximum_batch_size: maximum_batch_size, + maximum_execution_timeout_in_seconds: maximum_execution_timeout_in_seconds, + rollback_maximum_batch_size: rollback_maximum_batch_size, + wait_interval_in_seconds: wait_interval_in_seconds, + }), + rollback_maximum_batch_size:: { + '#new':: d.fn(help='\n`aws.sagemaker_endpoint.deployment_config.rolling_update_policy.rollback_maximum_batch_size.new` constructs a new object with attributes and blocks configured for the `rollback_maximum_batch_size`\nTerraform sub block.\n\n\n\n**Args**:\n - `type` (`string`): Set the `type` field on the resulting object.\n - `value` (`number`): Set the `value` field on the resulting object.\n\n**Returns**:\n - An attribute object that represents the `rollback_maximum_batch_size` sub block.\n', args=[]), + new( + type, + value + ):: std.prune(a={ + type: type, + value: value, + }), + }, + }, }, '#new':: d.fn(help="\n`aws.sagemaker_endpoint.new` injects a new `aws_sagemaker_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.sagemaker_endpoint.new('some_id')\n\nYou can get the reference to the `id` field of the created `aws.sagemaker_endpoint` using the reference:\n\n $._ref.aws_sagemaker_endpoint.some_id.get('id')\n\nThis is the same as directly entering `\"${ aws_sagemaker_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 - `endpoint_config_name` (`string`): Set the `endpoint_config_name` field on the resulting resource block.\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 - `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 - `deployment_config` (`list[obj]`): Set the `deployment_config` field on the resulting resource block. When `null`, the `deployment_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.sagemaker_endpoint.deployment_config.new](#fn-deployment_confignew) constructor.\n\n**Returns**:\n- A mixin object that injects the new resource into the root Terraform configuration.\n", args=[]), new( diff --git a/5.x/_gen/resources/sagemaker_pipeline.libsonnet b/5.x/_gen/resources/sagemaker_pipeline.libsonnet new file mode 100644 index 00000000..00b077d8 --- /dev/null +++ b/5.x/_gen/resources/sagemaker_pipeline.libsonnet @@ -0,0 +1,186 @@ +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='sagemaker_pipeline', url='', help='`sagemaker_pipeline` represents the `aws_sagemaker_pipeline` 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.sagemaker_pipeline.new` injects a new `aws_sagemaker_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.sagemaker_pipeline.new('some_id')\n\nYou can get the reference to the `id` field of the created `aws.sagemaker_pipeline` using the reference:\n\n $._ref.aws_sagemaker_pipeline.some_id.get('id')\n\nThis is the same as directly entering `\"${ aws_sagemaker_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 - `pipeline_definition` (`string`): Set the `pipeline_definition` field on the resulting resource block. When `null`, the `pipeline_definition` field will be omitted from the resulting object.\n - `pipeline_description` (`string`): Set the `pipeline_description` field on the resulting resource block. When `null`, the `pipeline_description` field will be omitted from the resulting object.\n - `pipeline_display_name` (`string`): Set the `pipeline_display_name` field on the resulting resource block.\n - `pipeline_name` (`string`): Set the `pipeline_name` field on the resulting resource block.\n - `role_arn` (`string`): Set the `role_arn` field on the resulting resource block. When `null`, the `role_arn` 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 - `parallelism_configuration` (`list[obj]`): Set the `parallelism_configuration` field on the resulting resource block. When `null`, the `parallelism_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.sagemaker_pipeline.parallelism_configuration.new](#fn-parallelism_configurationnew) constructor.\n - `pipeline_definition_s3_location` (`list[obj]`): Set the `pipeline_definition_s3_location` field on the resulting resource block. When `null`, the `pipeline_definition_s3_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.sagemaker_pipeline.pipeline_definition_s3_location.new](#fn-pipeline_definition_s3_locationnew) constructor.\n\n**Returns**:\n- A mixin object that injects the new resource into the root Terraform configuration.\n", args=[]), + new( + resourceLabel, + pipeline_display_name, + pipeline_name, + parallelism_configuration=null, + pipeline_definition=null, + pipeline_definition_s3_location=null, + pipeline_description=null, + role_arn=null, + tags=null, + tags_all=null, + _meta={} + ):: tf.withResource( + type='aws_sagemaker_pipeline', + label=resourceLabel, + attrs=self.newAttrs( + parallelism_configuration=parallelism_configuration, + pipeline_definition=pipeline_definition, + pipeline_definition_s3_location=pipeline_definition_s3_location, + pipeline_description=pipeline_description, + pipeline_display_name=pipeline_display_name, + pipeline_name=pipeline_name, + role_arn=role_arn, + tags=tags, + tags_all=tags_all + ), + _meta=_meta + ), + '#newAttrs':: d.fn(help='\n`aws.sagemaker_pipeline.newAttrs` constructs a new object with attributes and blocks configured for the `sagemaker_pipeline`\nTerraform resource.\n\nUnlike [aws.sagemaker_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 - `pipeline_definition` (`string`): Set the `pipeline_definition` field on the resulting object. When `null`, the `pipeline_definition` field will be omitted from the resulting object.\n - `pipeline_description` (`string`): Set the `pipeline_description` field on the resulting object. When `null`, the `pipeline_description` field will be omitted from the resulting object.\n - `pipeline_display_name` (`string`): Set the `pipeline_display_name` field on the resulting object.\n - `pipeline_name` (`string`): Set the `pipeline_name` field on the resulting object.\n - `role_arn` (`string`): Set the `role_arn` field on the resulting object. When `null`, the `role_arn` 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 - `parallelism_configuration` (`list[obj]`): Set the `parallelism_configuration` field on the resulting object. When `null`, the `parallelism_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.sagemaker_pipeline.parallelism_configuration.new](#fn-parallelism_configurationnew) constructor.\n - `pipeline_definition_s3_location` (`list[obj]`): Set the `pipeline_definition_s3_location` field on the resulting object. When `null`, the `pipeline_definition_s3_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.sagemaker_pipeline.pipeline_definition_s3_location.new](#fn-pipeline_definition_s3_locationnew) 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 `sagemaker_pipeline` resource into the root Terraform configuration.\n', args=[]), + newAttrs( + pipeline_display_name, + pipeline_name, + parallelism_configuration=null, + pipeline_definition=null, + pipeline_definition_s3_location=null, + pipeline_description=null, + role_arn=null, + tags=null, + tags_all=null + ):: std.prune(a={ + parallelism_configuration: parallelism_configuration, + pipeline_definition: pipeline_definition, + pipeline_definition_s3_location: pipeline_definition_s3_location, + pipeline_description: pipeline_description, + pipeline_display_name: pipeline_display_name, + pipeline_name: pipeline_name, + role_arn: role_arn, + tags: tags, + tags_all: tags_all, + }), + parallelism_configuration:: { + '#new':: d.fn(help='\n`aws.sagemaker_pipeline.parallelism_configuration.new` constructs a new object with attributes and blocks configured for the `parallelism_configuration`\nTerraform sub block.\n\n\n\n**Args**:\n - `max_parallel_execution_steps` (`number`): Set the `max_parallel_execution_steps` field on the resulting object.\n\n**Returns**:\n - An attribute object that represents the `parallelism_configuration` sub block.\n', args=[]), + new( + max_parallel_execution_steps + ):: std.prune(a={ + max_parallel_execution_steps: max_parallel_execution_steps, + }), + }, + pipeline_definition_s3_location:: { + '#new':: d.fn(help='\n`aws.sagemaker_pipeline.pipeline_definition_s3_location.new` constructs a new object with attributes and blocks configured for the `pipeline_definition_s3_location`\nTerraform sub block.\n\n\n\n**Args**:\n - `bucket` (`string`): Set the `bucket` field on the resulting object.\n - `object_key` (`string`): Set the `object_key` field on 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 represents the `pipeline_definition_s3_location` sub block.\n', args=[]), + new( + bucket, + object_key, + version_id=null + ):: std.prune(a={ + bucket: bucket, + object_key: object_key, + version_id: version_id, + }), + }, + '#withParallelismConfiguration':: d.fn(help='`aws.list[obj].withParallelismConfiguration` constructs a mixin object that can be merged into the `list[obj]`\nTerraform resource block to set or update the parallelism_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].withParallelismConfigurationMixin](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 `parallelism_configuration` field.\n', args=[]), + withParallelismConfiguration(resourceLabel, value): { + resource+: { + aws_sagemaker_pipeline+: { + [resourceLabel]+: { + parallelism_configuration: value, + }, + }, + }, + }, + '#withParallelismConfigurationMixin':: d.fn(help='`aws.list[obj].withParallelismConfigurationMixin` constructs a mixin object that can be merged into the `list[obj]`\nTerraform resource block to set or update the parallelism_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].withParallelismConfiguration](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 `parallelism_configuration` field.\n', args=[]), + withParallelismConfigurationMixin(resourceLabel, value): { + resource+: { + aws_sagemaker_pipeline+: { + [resourceLabel]+: { + parallelism_configuration+: if std.isArray(v=value) then value else [value], + }, + }, + }, + }, + '#withPipelineDefinition':: d.fn(help='`aws.string.withPipelineDefinition` constructs a mixin object that can be merged into the `string`\nTerraform resource block to set or update the pipeline_definition 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 `pipeline_definition` field.\n', args=[]), + withPipelineDefinition(resourceLabel, value): { + resource+: { + aws_sagemaker_pipeline+: { + [resourceLabel]+: { + pipeline_definition: value, + }, + }, + }, + }, + '#withPipelineDefinitionS3Location':: d.fn(help='`aws.list[obj].withPipelineDefinitionS3Location` constructs a mixin object that can be merged into the `list[obj]`\nTerraform resource block to set or update the pipeline_definition_s3_location 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].withPipelineDefinitionS3LocationMixin](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 `pipeline_definition_s3_location` field.\n', args=[]), + withPipelineDefinitionS3Location(resourceLabel, value): { + resource+: { + aws_sagemaker_pipeline+: { + [resourceLabel]+: { + pipeline_definition_s3_location: value, + }, + }, + }, + }, + '#withPipelineDefinitionS3LocationMixin':: d.fn(help='`aws.list[obj].withPipelineDefinitionS3LocationMixin` constructs a mixin object that can be merged into the `list[obj]`\nTerraform resource block to set or update the pipeline_definition_s3_location 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].withPipelineDefinitionS3Location](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 `pipeline_definition_s3_location` field.\n', args=[]), + withPipelineDefinitionS3LocationMixin(resourceLabel, value): { + resource+: { + aws_sagemaker_pipeline+: { + [resourceLabel]+: { + pipeline_definition_s3_location+: if std.isArray(v=value) then value else [value], + }, + }, + }, + }, + '#withPipelineDescription':: d.fn(help='`aws.string.withPipelineDescription` constructs a mixin object that can be merged into the `string`\nTerraform resource block to set or update the pipeline_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 `pipeline_description` field.\n', args=[]), + withPipelineDescription(resourceLabel, value): { + resource+: { + aws_sagemaker_pipeline+: { + [resourceLabel]+: { + pipeline_description: value, + }, + }, + }, + }, + '#withPipelineDisplayName':: d.fn(help='`aws.string.withPipelineDisplayName` constructs a mixin object that can be merged into the `string`\nTerraform resource block to set or update the pipeline_display_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 `pipeline_display_name` field.\n', args=[]), + withPipelineDisplayName(resourceLabel, value): { + resource+: { + aws_sagemaker_pipeline+: { + [resourceLabel]+: { + pipeline_display_name: value, + }, + }, + }, + }, + '#withPipelineName':: d.fn(help='`aws.string.withPipelineName` constructs a mixin object that can be merged into the `string`\nTerraform resource block to set or update the pipeline_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 `pipeline_name` field.\n', args=[]), + withPipelineName(resourceLabel, value): { + resource+: { + aws_sagemaker_pipeline+: { + [resourceLabel]+: { + pipeline_name: value, + }, + }, + }, + }, + '#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_sagemaker_pipeline+: { + [resourceLabel]+: { + role_arn: 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_sagemaker_pipeline+: { + [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_sagemaker_pipeline+: { + [resourceLabel]+: { + tags_all: value, + }, + }, + }, + }, +} diff --git a/5.x/_gen/resources/sagemaker_user_profile.libsonnet b/5.x/_gen/resources/sagemaker_user_profile.libsonnet index 7ef248bb..316f4137 100644 --- a/5.x/_gen/resources/sagemaker_user_profile.libsonnet +++ b/5.x/_gen/resources/sagemaker_user_profile.libsonnet @@ -57,13 +57,15 @@ local d = (import 'github.com/jsonnet-libs/docsonnet/doc-util/main.libsonnet'); status: status, }), }, - '#new':: d.fn(help='\n`aws.sagemaker_user_profile.user_settings.canvas_app_settings.new` constructs a new object with attributes and blocks configured for the `canvas_app_settings`\nTerraform sub block.\n\n\n\n**Args**:\n - `model_register_settings` (`list[obj]`): Set the `model_register_settings` field on the resulting object. When `null`, the `model_register_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.sagemaker_user_profile.user_settings.canvas_app_settings.model_register_settings.new](#fn-user_settingsuser_settingsmodel_register_settingsnew) constructor.\n - `time_series_forecasting_settings` (`list[obj]`): Set the `time_series_forecasting_settings` field on the resulting object. When `null`, the `time_series_forecasting_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.sagemaker_user_profile.user_settings.canvas_app_settings.time_series_forecasting_settings.new](#fn-user_settingsuser_settingstime_series_forecasting_settingsnew) constructor.\n\n**Returns**:\n - An attribute object that represents the `canvas_app_settings` sub block.\n', args=[]), + '#new':: d.fn(help='\n`aws.sagemaker_user_profile.user_settings.canvas_app_settings.new` constructs a new object with attributes and blocks configured for the `canvas_app_settings`\nTerraform sub block.\n\n\n\n**Args**:\n - `model_register_settings` (`list[obj]`): Set the `model_register_settings` field on the resulting object. When `null`, the `model_register_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.sagemaker_user_profile.user_settings.canvas_app_settings.model_register_settings.new](#fn-user_settingsuser_settingsmodel_register_settingsnew) constructor.\n - `time_series_forecasting_settings` (`list[obj]`): Set the `time_series_forecasting_settings` field on the resulting object. When `null`, the `time_series_forecasting_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.sagemaker_user_profile.user_settings.canvas_app_settings.time_series_forecasting_settings.new](#fn-user_settingsuser_settingstime_series_forecasting_settingsnew) constructor.\n - `workspace_settings` (`list[obj]`): Set the `workspace_settings` field on the resulting object. When `null`, the `workspace_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.sagemaker_user_profile.user_settings.canvas_app_settings.workspace_settings.new](#fn-user_settingsuser_settingsworkspace_settingsnew) constructor.\n\n**Returns**:\n - An attribute object that represents the `canvas_app_settings` sub block.\n', args=[]), new( model_register_settings=null, - time_series_forecasting_settings=null + time_series_forecasting_settings=null, + workspace_settings=null ):: std.prune(a={ model_register_settings: model_register_settings, time_series_forecasting_settings: time_series_forecasting_settings, + workspace_settings: workspace_settings, }), time_series_forecasting_settings:: { '#new':: d.fn(help='\n`aws.sagemaker_user_profile.user_settings.canvas_app_settings.time_series_forecasting_settings.new` constructs a new object with attributes and blocks configured for the `time_series_forecasting_settings`\nTerraform sub block.\n\n\n\n**Args**:\n - `amazon_forecast_role_arn` (`string`): Set the `amazon_forecast_role_arn` field on the resulting object. When `null`, the `amazon_forecast_role_arn` field will be omitted from 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\n**Returns**:\n - An attribute object that represents the `time_series_forecasting_settings` sub block.\n', args=[]), @@ -75,6 +77,16 @@ local d = (import 'github.com/jsonnet-libs/docsonnet/doc-util/main.libsonnet'); status: status, }), }, + workspace_settings:: { + '#new':: d.fn(help='\n`aws.sagemaker_user_profile.user_settings.canvas_app_settings.workspace_settings.new` constructs a new object with attributes and blocks configured for the `workspace_settings`\nTerraform sub block.\n\n\n\n**Args**:\n - `s3_artifact_path` (`string`): Set the `s3_artifact_path` field on the resulting object. When `null`, the `s3_artifact_path` field will be omitted from the resulting object.\n - `s3_kms_key_id` (`string`): Set the `s3_kms_key_id` field on the resulting object. When `null`, the `s3_kms_key_id` field will be omitted from the resulting object.\n\n**Returns**:\n - An attribute object that represents the `workspace_settings` sub block.\n', args=[]), + new( + s3_artifact_path=null, + s3_kms_key_id=null + ):: std.prune(a={ + s3_artifact_path: s3_artifact_path, + s3_kms_key_id: s3_kms_key_id, + }), + }, }, jupyter_server_app_settings:: { code_repository:: { diff --git a/5.x/_gen/resources/transfer_server.libsonnet b/5.x/_gen/resources/transfer_server.libsonnet index 2d99df9e..741fd255 100644 --- a/5.x/_gen/resources/transfer_server.libsonnet +++ b/5.x/_gen/resources/transfer_server.libsonnet @@ -18,7 +18,7 @@ local d = (import 'github.com/jsonnet-libs/docsonnet/doc-util/main.libsonnet'); vpc_id: vpc_id, }), }, - '#new':: d.fn(help="\n`aws.transfer_server.new` injects a new `aws_transfer_server` 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_server.new('some_id')\n\nYou can get the reference to the `id` field of the created `aws.transfer_server` using the reference:\n\n $._ref.aws_transfer_server.some_id.get('id')\n\nThis is the same as directly entering `\"${ aws_transfer_server.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 - `certificate` (`string`): Set the `certificate` field on the resulting resource block. When `null`, the `certificate` field will be omitted from the resulting object.\n - `directory_id` (`string`): Set the `directory_id` field on the resulting resource block. When `null`, the `directory_id` field will be omitted from the resulting object.\n - `domain` (`string`): Set the `domain` field on the resulting resource block. When `null`, the `domain` field will be omitted from the resulting object.\n - `endpoint_type` (`string`): Set the `endpoint_type` field on the resulting resource block. When `null`, the `endpoint_type` 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 - `function_` (`string`): Set the `function_` field on the resulting resource block. When `null`, the `function_` field will be omitted from the resulting object.\n - `host_key` (`string`): Set the `host_key` field on the resulting resource block. When `null`, the `host_key` field will be omitted from the resulting object.\n - `identity_provider_type` (`string`): Set the `identity_provider_type` field on the resulting resource block. When `null`, the `identity_provider_type` field will be omitted from the resulting object.\n - `invocation_role` (`string`): Set the `invocation_role` field on the resulting resource block. When `null`, the `invocation_role` field will be omitted from the resulting object.\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 - `post_authentication_login_banner` (`string`): Set the `post_authentication_login_banner` field on the resulting resource block. When `null`, the `post_authentication_login_banner` field will be omitted from the resulting object.\n - `pre_authentication_login_banner` (`string`): Set the `pre_authentication_login_banner` field on the resulting resource block. When `null`, the `pre_authentication_login_banner` field will be omitted from the resulting object.\n - `protocols` (`list`): Set the `protocols` field on the resulting resource block. When `null`, the `protocols` field will be omitted from the resulting object.\n - `security_policy_name` (`string`): Set the `security_policy_name` field on the resulting resource block. When `null`, the `security_policy_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 - `url` (`string`): Set the `url` field on the resulting resource block. When `null`, the `url` field will be omitted from the resulting object.\n - `endpoint_details` (`list[obj]`): Set the `endpoint_details` field on the resulting resource block. When `null`, the `endpoint_details` 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_server.endpoint_details.new](#fn-endpoint_detailsnew) constructor.\n - `protocol_details` (`list[obj]`): Set the `protocol_details` field on the resulting resource block. When `null`, the `protocol_details` 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_server.protocol_details.new](#fn-protocol_detailsnew) constructor.\n - `workflow_details` (`list[obj]`): Set the `workflow_details` field on the resulting resource block. When `null`, the `workflow_details` 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_server.workflow_details.new](#fn-workflow_detailsnew) 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_server.new` injects a new `aws_transfer_server` 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_server.new('some_id')\n\nYou can get the reference to the `id` field of the created `aws.transfer_server` using the reference:\n\n $._ref.aws_transfer_server.some_id.get('id')\n\nThis is the same as directly entering `\"${ aws_transfer_server.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 - `certificate` (`string`): Set the `certificate` field on the resulting resource block. When `null`, the `certificate` field will be omitted from the resulting object.\n - `directory_id` (`string`): Set the `directory_id` field on the resulting resource block. When `null`, the `directory_id` field will be omitted from the resulting object.\n - `domain` (`string`): Set the `domain` field on the resulting resource block. When `null`, the `domain` field will be omitted from the resulting object.\n - `endpoint_type` (`string`): Set the `endpoint_type` field on the resulting resource block. When `null`, the `endpoint_type` 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 - `function_` (`string`): Set the `function_` field on the resulting resource block. When `null`, the `function_` field will be omitted from the resulting object.\n - `host_key` (`string`): Set the `host_key` field on the resulting resource block. When `null`, the `host_key` field will be omitted from the resulting object.\n - `identity_provider_type` (`string`): Set the `identity_provider_type` field on the resulting resource block. When `null`, the `identity_provider_type` field will be omitted from the resulting object.\n - `invocation_role` (`string`): Set the `invocation_role` field on the resulting resource block. When `null`, the `invocation_role` field will be omitted from the resulting object.\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 - `post_authentication_login_banner` (`string`): Set the `post_authentication_login_banner` field on the resulting resource block. When `null`, the `post_authentication_login_banner` field will be omitted from the resulting object.\n - `pre_authentication_login_banner` (`string`): Set the `pre_authentication_login_banner` field on the resulting resource block. When `null`, the `pre_authentication_login_banner` field will be omitted from the resulting object.\n - `protocols` (`list`): Set the `protocols` field on the resulting resource block. When `null`, the `protocols` field will be omitted from the resulting object.\n - `security_policy_name` (`string`): Set the `security_policy_name` field on the resulting resource block. When `null`, the `security_policy_name` field will be omitted from the resulting object.\n - `structured_log_destinations` (`list`): This is a set of arns of destinations that will receive structured logs from the transfer server When `null`, the `structured_log_destinations` 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. When `null`, the `url` field will be omitted from the resulting object.\n - `endpoint_details` (`list[obj]`): Set the `endpoint_details` field on the resulting resource block. When `null`, the `endpoint_details` 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_server.endpoint_details.new](#fn-endpoint_detailsnew) constructor.\n - `protocol_details` (`list[obj]`): Set the `protocol_details` field on the resulting resource block. When `null`, the `protocol_details` 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_server.protocol_details.new](#fn-protocol_detailsnew) constructor.\n - `workflow_details` (`list[obj]`): Set the `workflow_details` field on the resulting resource block. When `null`, the `workflow_details` 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_server.workflow_details.new](#fn-workflow_detailsnew) constructor.\n\n**Returns**:\n- A mixin object that injects the new resource into the root Terraform configuration.\n", args=[]), new( resourceLabel, certificate=null, @@ -37,6 +37,7 @@ local d = (import 'github.com/jsonnet-libs/docsonnet/doc-util/main.libsonnet'); protocol_details=null, protocols=null, security_policy_name=null, + structured_log_destinations=null, tags=null, tags_all=null, url=null, @@ -62,6 +63,7 @@ local d = (import 'github.com/jsonnet-libs/docsonnet/doc-util/main.libsonnet'); protocol_details=protocol_details, protocols=protocols, security_policy_name=security_policy_name, + structured_log_destinations=structured_log_destinations, tags=tags, tags_all=tags_all, url=url, @@ -69,7 +71,7 @@ local d = (import 'github.com/jsonnet-libs/docsonnet/doc-util/main.libsonnet'); ), _meta=_meta ), - '#newAttrs':: d.fn(help='\n`aws.transfer_server.newAttrs` constructs a new object with attributes and blocks configured for the `transfer_server`\nTerraform resource.\n\nUnlike [aws.transfer_server.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 - `certificate` (`string`): Set the `certificate` field on the resulting object. When `null`, the `certificate` field will be omitted from the resulting object.\n - `directory_id` (`string`): Set the `directory_id` field on the resulting object. When `null`, the `directory_id` field will be omitted from the resulting object.\n - `domain` (`string`): Set the `domain` field on the resulting object. When `null`, the `domain` field will be omitted from the resulting object.\n - `endpoint_type` (`string`): Set the `endpoint_type` field on the resulting object. When `null`, the `endpoint_type` 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 - `function_` (`string`): Set the `function_` field on the resulting object. When `null`, the `function_` field will be omitted from the resulting object.\n - `host_key` (`string`): Set the `host_key` field on the resulting object. When `null`, the `host_key` field will be omitted from the resulting object.\n - `identity_provider_type` (`string`): Set the `identity_provider_type` field on the resulting object. When `null`, the `identity_provider_type` field will be omitted from the resulting object.\n - `invocation_role` (`string`): Set the `invocation_role` field on the resulting object. When `null`, the `invocation_role` field will be omitted from 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 - `post_authentication_login_banner` (`string`): Set the `post_authentication_login_banner` field on the resulting object. When `null`, the `post_authentication_login_banner` field will be omitted from the resulting object.\n - `pre_authentication_login_banner` (`string`): Set the `pre_authentication_login_banner` field on the resulting object. When `null`, the `pre_authentication_login_banner` field will be omitted from the resulting object.\n - `protocols` (`list`): Set the `protocols` field on the resulting object. When `null`, the `protocols` field will be omitted from the resulting object.\n - `security_policy_name` (`string`): Set the `security_policy_name` field on the resulting object. When `null`, the `security_policy_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 - `url` (`string`): Set the `url` field on the resulting object. When `null`, the `url` field will be omitted from the resulting object.\n - `endpoint_details` (`list[obj]`): Set the `endpoint_details` field on the resulting object. When `null`, the `endpoint_details` 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_server.endpoint_details.new](#fn-endpoint_detailsnew) constructor.\n - `protocol_details` (`list[obj]`): Set the `protocol_details` field on the resulting object. When `null`, the `protocol_details` 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_server.protocol_details.new](#fn-protocol_detailsnew) constructor.\n - `workflow_details` (`list[obj]`): Set the `workflow_details` field on the resulting object. When `null`, the `workflow_details` 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_server.workflow_details.new](#fn-workflow_detailsnew) 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_server` resource into the root Terraform configuration.\n', args=[]), + '#newAttrs':: d.fn(help='\n`aws.transfer_server.newAttrs` constructs a new object with attributes and blocks configured for the `transfer_server`\nTerraform resource.\n\nUnlike [aws.transfer_server.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 - `certificate` (`string`): Set the `certificate` field on the resulting object. When `null`, the `certificate` field will be omitted from the resulting object.\n - `directory_id` (`string`): Set the `directory_id` field on the resulting object. When `null`, the `directory_id` field will be omitted from the resulting object.\n - `domain` (`string`): Set the `domain` field on the resulting object. When `null`, the `domain` field will be omitted from the resulting object.\n - `endpoint_type` (`string`): Set the `endpoint_type` field on the resulting object. When `null`, the `endpoint_type` 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 - `function_` (`string`): Set the `function_` field on the resulting object. When `null`, the `function_` field will be omitted from the resulting object.\n - `host_key` (`string`): Set the `host_key` field on the resulting object. When `null`, the `host_key` field will be omitted from the resulting object.\n - `identity_provider_type` (`string`): Set the `identity_provider_type` field on the resulting object. When `null`, the `identity_provider_type` field will be omitted from the resulting object.\n - `invocation_role` (`string`): Set the `invocation_role` field on the resulting object. When `null`, the `invocation_role` field will be omitted from 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 - `post_authentication_login_banner` (`string`): Set the `post_authentication_login_banner` field on the resulting object. When `null`, the `post_authentication_login_banner` field will be omitted from the resulting object.\n - `pre_authentication_login_banner` (`string`): Set the `pre_authentication_login_banner` field on the resulting object. When `null`, the `pre_authentication_login_banner` field will be omitted from the resulting object.\n - `protocols` (`list`): Set the `protocols` field on the resulting object. When `null`, the `protocols` field will be omitted from the resulting object.\n - `security_policy_name` (`string`): Set the `security_policy_name` field on the resulting object. When `null`, the `security_policy_name` field will be omitted from the resulting object.\n - `structured_log_destinations` (`list`): This is a set of arns of destinations that will receive structured logs from the transfer server When `null`, the `structured_log_destinations` 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. When `null`, the `url` field will be omitted from the resulting object.\n - `endpoint_details` (`list[obj]`): Set the `endpoint_details` field on the resulting object. When `null`, the `endpoint_details` 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_server.endpoint_details.new](#fn-endpoint_detailsnew) constructor.\n - `protocol_details` (`list[obj]`): Set the `protocol_details` field on the resulting object. When `null`, the `protocol_details` 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_server.protocol_details.new](#fn-protocol_detailsnew) constructor.\n - `workflow_details` (`list[obj]`): Set the `workflow_details` field on the resulting object. When `null`, the `workflow_details` 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_server.workflow_details.new](#fn-workflow_detailsnew) 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_server` resource into the root Terraform configuration.\n', args=[]), newAttrs( certificate=null, directory_id=null, @@ -87,6 +89,7 @@ local d = (import 'github.com/jsonnet-libs/docsonnet/doc-util/main.libsonnet'); protocol_details=null, protocols=null, security_policy_name=null, + structured_log_destinations=null, tags=null, tags_all=null, url=null, @@ -108,6 +111,7 @@ local d = (import 'github.com/jsonnet-libs/docsonnet/doc-util/main.libsonnet'); protocol_details: protocol_details, protocols: protocols, security_policy_name: security_policy_name, + structured_log_destinations: structured_log_destinations, tags: tags, tags_all: tags_all, url: url, @@ -307,6 +311,16 @@ local d = (import 'github.com/jsonnet-libs/docsonnet/doc-util/main.libsonnet'); }, }, }, + '#withStructuredLogDestinations':: d.fn(help='`aws.list.withStructuredLogDestinations` constructs a mixin object that can be merged into the `list`\nTerraform resource block to set or update the structured_log_destinations 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 `structured_log_destinations` field.\n', args=[]), + withStructuredLogDestinations(resourceLabel, value): { + resource+: { + aws_transfer_server+: { + [resourceLabel]+: { + structured_log_destinations: 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/docs/5.x/README.md b/docs/5.x/README.md index 09f4822a..664965d1 100644 --- a/docs/5.x/README.md +++ b/docs/5.x/README.md @@ -583,6 +583,7 @@ project. * [iam_role_policy](iam_role_policy.md) * [iam_role_policy_attachment](iam_role_policy_attachment.md) * [iam_saml_provider](iam_saml_provider.md) +* [iam_security_token_service_preferences](iam_security_token_service_preferences.md) * [iam_server_certificate](iam_server_certificate.md) * [iam_service_linked_role](iam_service_linked_role.md) * [iam_service_specific_credential](iam_service_specific_credential.md) @@ -1012,6 +1013,7 @@ project. * [sagemaker_monitoring_schedule](sagemaker_monitoring_schedule.md) * [sagemaker_notebook_instance](sagemaker_notebook_instance.md) * [sagemaker_notebook_instance_lifecycle_configuration](sagemaker_notebook_instance_lifecycle_configuration.md) +* [sagemaker_pipeline](sagemaker_pipeline.md) * [sagemaker_project](sagemaker_project.md) * [sagemaker_servicecatalog_portfolio_status](sagemaker_servicecatalog_portfolio_status.md) * [sagemaker_space](sagemaker_space.md) diff --git a/docs/5.x/data/db_instance.md b/docs/5.x/data/db_instance.md index ca673769..e745d433 100644 --- a/docs/5.x/data/db_instance.md +++ b/docs/5.x/data/db_instance.md @@ -47,7 +47,7 @@ or `$` to refer to the root object. Instead, make an explicit outer object using **Args**: - `dataSrcLabel` (`string`): The name label of the block. - - `db_instance_identifier` (`string`): Set the `db_instance_identifier` field on the resulting data source block. + - `db_instance_identifier` (`string`): Set the `db_instance_identifier` field on the resulting data source block. When `null`, the `db_instance_identifier` 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. **Returns**: @@ -72,7 +72,7 @@ This is most useful when you need to preprocess the attributes with functions, c injecting into a complete block. **Args**: - - `db_instance_identifier` (`string`): Set the `db_instance_identifier` field on the resulting object. + - `db_instance_identifier` (`string`): Set the `db_instance_identifier` field on the resulting object. When `null`, the `db_instance_identifier` 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. **Returns**: diff --git a/docs/5.x/data/db_instances.md b/docs/5.x/data/db_instances.md index 7f9fbdca..d0cdb807 100644 --- a/docs/5.x/data/db_instances.md +++ b/docs/5.x/data/db_instances.md @@ -17,6 +17,7 @@ This package contains functions and utilities for setting up the data source usi * [`fn newAttrs()`](#fn-newattrs) * [`fn withFilter()`](#fn-withfilter) * [`fn withFilterMixin()`](#fn-withfiltermixin) +* [`fn withTags()`](#fn-withtags) * [`obj filter`](#obj-filter) * [`fn new()`](#fn-filternew) @@ -49,6 +50,7 @@ or `$` to refer to the root object. Instead, make an explicit outer object using **Args**: - `dataSrcLabel` (`string`): The name label of the 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. - `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.db_instances.filter.new](#fn-filternew) constructor. **Returns**: @@ -73,6 +75,7 @@ This is most useful when you need to preprocess the attributes with functions, c injecting into a complete block. **Args**: + - `tags` (`obj`): Set the `tags` field on the resulting object. When `null`, the `tags` field will be omitted from the resulting object. - `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.db_instances.filter.new](#fn-filternew) constructor. **Returns**: @@ -116,6 +119,22 @@ function. - `value` (`list[obj]`): The value to set for the `filter` 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. + + ## obj filter diff --git a/docs/5.x/data/db_snapshot.md b/docs/5.x/data/db_snapshot.md index c63390ce..76ac6d69 100644 --- a/docs/5.x/data/db_snapshot.md +++ b/docs/5.x/data/db_snapshot.md @@ -21,6 +21,7 @@ This package contains functions and utilities for setting up the data source usi * [`fn withIncludeShared()`](#fn-withincludeshared) * [`fn withMostRecent()`](#fn-withmostrecent) * [`fn withSnapshotType()`](#fn-withsnapshottype) +* [`fn withTags()`](#fn-withtags) ## Fields @@ -57,6 +58,7 @@ or `$` to refer to the root object. Instead, make an explicit outer object using - `include_shared` (`bool`): Set the `include_shared` field on the resulting data source block. When `null`, the `include_shared` field will be omitted from the resulting object. - `most_recent` (`bool`): Set the `most_recent` field on the resulting data source block. When `null`, the `most_recent` field will be omitted from the resulting object. - `snapshot_type` (`string`): Set the `snapshot_type` field on the resulting data source block. When `null`, the `snapshot_type` 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. **Returns**: - A mixin object that injects the new data source into the root Terraform configuration. @@ -86,6 +88,7 @@ injecting into a complete block. - `include_shared` (`bool`): Set the `include_shared` field on the resulting object. When `null`, the `include_shared` field will be omitted from the resulting object. - `most_recent` (`bool`): Set the `most_recent` field on the resulting object. When `null`, the `most_recent` field will be omitted from the resulting object. - `snapshot_type` (`string`): Set the `snapshot_type` field on the resulting object. When `null`, the `snapshot_type` 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. **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 `db_snapshot` data source into the root Terraform configuration. @@ -185,3 +188,19 @@ Terraform data source block to set or update the snapshot_type field. **Args**: - `dataSrcLabel` (`string`): The name label of the block to update. - `value` (`string`): The value to set for the `snapshot_type` 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/vpclattice_service.md b/docs/5.x/data/vpclattice_service.md index 303e2838..306b03ed 100644 --- a/docs/5.x/data/vpclattice_service.md +++ b/docs/5.x/data/vpclattice_service.md @@ -15,6 +15,7 @@ This package contains functions and utilities for setting up the data source usi * [`fn new()`](#fn-new) * [`fn newAttrs()`](#fn-newattrs) +* [`fn withName()`](#fn-withname) * [`fn withServiceIdentifier()`](#fn-withserviceidentifier) * [`fn withTags()`](#fn-withtags) @@ -47,7 +48,8 @@ or `$` to refer to the root object. Instead, make an explicit outer object using **Args**: - `dataSrcLabel` (`string`): The name label of the block. - - `service_identifier` (`string`): Set the `service_identifier` field on the resulting data source block. + - `name` (`string`): Set the `name` field on the resulting data source block. When `null`, the `name` field will be omitted from the resulting object. + - `service_identifier` (`string`): Set the `service_identifier` field on the resulting data source block. When `null`, the `service_identifier` 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. **Returns**: @@ -72,13 +74,30 @@ This is most useful when you need to preprocess the attributes with functions, c injecting into a complete block. **Args**: - - `service_identifier` (`string`): Set the `service_identifier` 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. + - `service_identifier` (`string`): Set the `service_identifier` field on the resulting object. When `null`, the `service_identifier` 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. **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 `vpclattice_service` data source into the root Terraform configuration. +### fn withName + +```ts +withName() +``` + +`aws.string.withName` constructs a mixin object that can be merged into the `string` +Terraform data source block to set or update the name field. + + + +**Args**: + - `dataSrcLabel` (`string`): The name label of the block to update. + - `value` (`string`): The value to set for the `name` field. + + ### fn withServiceIdentifier ```ts diff --git a/docs/5.x/finspace_kx_cluster.md b/docs/5.x/finspace_kx_cluster.md index b89d34f8..2178dec5 100644 --- a/docs/5.x/finspace_kx_cluster.md +++ b/docs/5.x/finspace_kx_cluster.md @@ -790,7 +790,7 @@ Terraform sub block. **Args**: - `cache_type` (`string`): Set the `cache_type` field on the resulting object. - - `db_paths` (`list`): Set the `db_paths` field on the resulting object. + - `db_paths` (`list`): Set the `db_paths` field on the resulting object. When `null`, the `db_paths` field will be omitted from the resulting object. **Returns**: - An attribute object that represents the `cache_configurations` sub block. diff --git a/docs/5.x/glue_job.md b/docs/5.x/glue_job.md index 6c250185..65c3b379 100644 --- a/docs/5.x/glue_job.md +++ b/docs/5.x/glue_job.md @@ -525,6 +525,7 @@ Terraform sub block. **Args**: - `name` (`string`): Set the `name` field on the resulting object. When `null`, the `name` field will be omitted from the resulting object. - `python_version` (`string`): Set the `python_version` field on the resulting object. When `null`, the `python_version` field will be omitted from the resulting object. + - `runtime` (`string`): Set the `runtime` field on the resulting object. When `null`, the `runtime` field will be omitted from the resulting object. - `script_location` (`string`): Set the `script_location` field on the resulting object. **Returns**: diff --git a/docs/5.x/iam_security_token_service_preferences.md b/docs/5.x/iam_security_token_service_preferences.md new file mode 100644 index 00000000..c9ec0f24 --- /dev/null +++ b/docs/5.x/iam_security_token_service_preferences.md @@ -0,0 +1,92 @@ +--- +permalink: /iam_security_token_service_preferences/ +--- + +# iam_security_token_service_preferences + +`iam_security_token_service_preferences` represents the `aws_iam_security_token_service_preferences` 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 withGlobalEndpointTokenVersion()`](#fn-withglobalendpointtokenversion) + +## Fields + +### fn new + +```ts +new() +``` + + +`aws.iam_security_token_service_preferences.new` injects a new `aws_iam_security_token_service_preferences` 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.iam_security_token_service_preferences.new('some_id') + +You can get the reference to the `id` field of the created `aws.iam_security_token_service_preferences` using the reference: + + $._ref.aws_iam_security_token_service_preferences.some_id.get('id') + +This is the same as directly entering `"${ aws_iam_security_token_service_preferences.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. + - `global_endpoint_token_version` (`string`): Set the `global_endpoint_token_version` 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.iam_security_token_service_preferences.newAttrs` constructs a new object with attributes and blocks configured for the `iam_security_token_service_preferences` +Terraform resource. + +Unlike [aws.iam_security_token_service_preferences.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**: + - `global_endpoint_token_version` (`string`): Set the `global_endpoint_token_version` 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 `iam_security_token_service_preferences` resource into the root Terraform configuration. + + +### fn withGlobalEndpointTokenVersion + +```ts +withGlobalEndpointTokenVersion() +``` + +`aws.string.withGlobalEndpointTokenVersion` constructs a mixin object that can be merged into the `string` +Terraform resource block to set or update the global_endpoint_token_version field. + + + +**Args**: + - `resourceLabel` (`string`): The name label of the block to update. + - `value` (`string`): The value to set for the `global_endpoint_token_version` field. diff --git a/docs/5.x/medialive_channel.md b/docs/5.x/medialive_channel.md index f53d3a98..8aa70ea4 100644 --- a/docs/5.x/medialive_channel.md +++ b/docs/5.x/medialive_channel.md @@ -88,6 +88,54 @@ This package contains functions and utilities for setting up the resource using * [`fn new()`](#fn-encoder_settingsavail_blankingnew) * [`obj encoder_settings.avail_blanking.avail_blanking_image`](#obj-encoder_settingsavail_blankingavail_blanking_image) * [`fn new()`](#fn-encoder_settingsavail_blankingavail_blanking_imagenew) + * [`obj encoder_settings.caption_descriptions`](#obj-encoder_settingscaption_descriptions) + * [`fn new()`](#fn-encoder_settingscaption_descriptionsnew) + * [`obj encoder_settings.caption_descriptions.destination_settings`](#obj-encoder_settingscaption_descriptionsdestination_settings) + * [`fn new()`](#fn-encoder_settingscaption_descriptionsdestination_settingsnew) + * [`obj encoder_settings.caption_descriptions.destination_settings.arib_destination_settings`](#obj-encoder_settingscaption_descriptionsdestination_settingsarib_destination_settings) + * [`fn new()`](#fn-encoder_settingscaption_descriptionsdestination_settingsarib_destination_settingsnew) + * [`obj encoder_settings.caption_descriptions.destination_settings.burn_in_destination_settings`](#obj-encoder_settingscaption_descriptionsdestination_settingsburn_in_destination_settings) + * [`fn new()`](#fn-encoder_settingscaption_descriptionsdestination_settingsburn_in_destination_settingsnew) + * [`obj encoder_settings.caption_descriptions.destination_settings.burn_in_destination_settings.font`](#obj-encoder_settingscaption_descriptionsdestination_settingsburn_in_destination_settingsfont) + * [`fn new()`](#fn-encoder_settingscaption_descriptionsdestination_settingsburn_in_destination_settingsfontnew) + * [`obj encoder_settings.caption_descriptions.destination_settings.dvb_sub_destination_settings`](#obj-encoder_settingscaption_descriptionsdestination_settingsdvb_sub_destination_settings) + * [`fn new()`](#fn-encoder_settingscaption_descriptionsdestination_settingsdvb_sub_destination_settingsnew) + * [`obj encoder_settings.caption_descriptions.destination_settings.dvb_sub_destination_settings.font`](#obj-encoder_settingscaption_descriptionsdestination_settingsdvb_sub_destination_settingsfont) + * [`fn new()`](#fn-encoder_settingscaption_descriptionsdestination_settingsdvb_sub_destination_settingsfontnew) + * [`obj encoder_settings.caption_descriptions.destination_settings.ebu_tt_d_destination_settings`](#obj-encoder_settingscaption_descriptionsdestination_settingsebu_tt_d_destination_settings) + * [`fn new()`](#fn-encoder_settingscaption_descriptionsdestination_settingsebu_tt_d_destination_settingsnew) + * [`obj encoder_settings.caption_descriptions.destination_settings.embedded_destination_settings`](#obj-encoder_settingscaption_descriptionsdestination_settingsembedded_destination_settings) + * [`fn new()`](#fn-encoder_settingscaption_descriptionsdestination_settingsembedded_destination_settingsnew) + * [`obj encoder_settings.caption_descriptions.destination_settings.embedded_plus_scte20_destination_settings`](#obj-encoder_settingscaption_descriptionsdestination_settingsembedded_plus_scte20_destination_settings) + * [`fn new()`](#fn-encoder_settingscaption_descriptionsdestination_settingsembedded_plus_scte20_destination_settingsnew) + * [`obj encoder_settings.caption_descriptions.destination_settings.rtmp_caption_info_destination_settings`](#obj-encoder_settingscaption_descriptionsdestination_settingsrtmp_caption_info_destination_settings) + * [`fn new()`](#fn-encoder_settingscaption_descriptionsdestination_settingsrtmp_caption_info_destination_settingsnew) + * [`obj encoder_settings.caption_descriptions.destination_settings.scte20_plus_embedded_destination_settings`](#obj-encoder_settingscaption_descriptionsdestination_settingsscte20_plus_embedded_destination_settings) + * [`fn new()`](#fn-encoder_settingscaption_descriptionsdestination_settingsscte20_plus_embedded_destination_settingsnew) + * [`obj encoder_settings.caption_descriptions.destination_settings.scte27_destination_settings`](#obj-encoder_settingscaption_descriptionsdestination_settingsscte27_destination_settings) + * [`fn new()`](#fn-encoder_settingscaption_descriptionsdestination_settingsscte27_destination_settingsnew) + * [`obj encoder_settings.caption_descriptions.destination_settings.smpte_tt_destination_settings`](#obj-encoder_settingscaption_descriptionsdestination_settingssmpte_tt_destination_settings) + * [`fn new()`](#fn-encoder_settingscaption_descriptionsdestination_settingssmpte_tt_destination_settingsnew) + * [`obj encoder_settings.caption_descriptions.destination_settings.teletext_destination_settings`](#obj-encoder_settingscaption_descriptionsdestination_settingsteletext_destination_settings) + * [`fn new()`](#fn-encoder_settingscaption_descriptionsdestination_settingsteletext_destination_settingsnew) + * [`obj encoder_settings.caption_descriptions.destination_settings.ttml_destination_settings`](#obj-encoder_settingscaption_descriptionsdestination_settingsttml_destination_settings) + * [`fn new()`](#fn-encoder_settingscaption_descriptionsdestination_settingsttml_destination_settingsnew) + * [`obj encoder_settings.caption_descriptions.destination_settings.webvtt_destination_settings`](#obj-encoder_settingscaption_descriptionsdestination_settingswebvtt_destination_settings) + * [`fn new()`](#fn-encoder_settingscaption_descriptionsdestination_settingswebvtt_destination_settingsnew) + * [`obj encoder_settings.global_configuration`](#obj-encoder_settingsglobal_configuration) + * [`fn new()`](#fn-encoder_settingsglobal_configurationnew) + * [`obj encoder_settings.global_configuration.input_loss_behavior`](#obj-encoder_settingsglobal_configurationinput_loss_behavior) + * [`fn new()`](#fn-encoder_settingsglobal_configurationinput_loss_behaviornew) + * [`obj encoder_settings.global_configuration.input_loss_behavior.input_loss_image_slate`](#obj-encoder_settingsglobal_configurationinput_loss_behaviorinput_loss_image_slate) + * [`fn new()`](#fn-encoder_settingsglobal_configurationinput_loss_behaviorinput_loss_image_slatenew) + * [`obj encoder_settings.motion_graphics_configuration`](#obj-encoder_settingsmotion_graphics_configuration) + * [`fn new()`](#fn-encoder_settingsmotion_graphics_configurationnew) + * [`obj encoder_settings.motion_graphics_configuration.motion_graphics_settings`](#obj-encoder_settingsmotion_graphics_configurationmotion_graphics_settings) + * [`fn new()`](#fn-encoder_settingsmotion_graphics_configurationmotion_graphics_settingsnew) + * [`obj encoder_settings.motion_graphics_configuration.motion_graphics_settings.html_motion_graphics_settings`](#obj-encoder_settingsmotion_graphics_configurationmotion_graphics_settingshtml_motion_graphics_settings) + * [`fn new()`](#fn-encoder_settingsmotion_graphics_configurationmotion_graphics_settingshtml_motion_graphics_settingsnew) + * [`obj encoder_settings.nielsen_configuration`](#obj-encoder_settingsnielsen_configuration) + * [`fn new()`](#fn-encoder_settingsnielsen_configurationnew) * [`obj encoder_settings.output_groups`](#obj-encoder_settingsoutput_groups) * [`fn new()`](#fn-encoder_settingsoutput_groupsnew) * [`obj encoder_settings.output_groups.output_group_settings`](#obj-encoder_settingsoutput_groupsoutput_group_settings) @@ -941,6 +989,10 @@ Terraform sub block. **Args**: - `audio_descriptions` (`list[obj]`): Set the `audio_descriptions` field on the resulting object. When `null`, the `audio_descriptions` 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.encoder_settings.audio_descriptions.new](#fn-encoder_settingsaudio_descriptionsnew) constructor. - `avail_blanking` (`list[obj]`): Set the `avail_blanking` field on the resulting object. When `null`, the `avail_blanking` 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.encoder_settings.avail_blanking.new](#fn-encoder_settingsavail_blankingnew) constructor. + - `caption_descriptions` (`list[obj]`): Set the `caption_descriptions` field on the resulting object. When `null`, the `caption_descriptions` 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.encoder_settings.caption_descriptions.new](#fn-encoder_settingscaption_descriptionsnew) constructor. + - `global_configuration` (`list[obj]`): Set the `global_configuration` field on the resulting object. When `null`, the `global_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.medialive_channel.encoder_settings.global_configuration.new](#fn-encoder_settingsglobal_configurationnew) constructor. + - `motion_graphics_configuration` (`list[obj]`): Set the `motion_graphics_configuration` field on the resulting object. When `null`, the `motion_graphics_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.medialive_channel.encoder_settings.motion_graphics_configuration.new](#fn-encoder_settingsmotion_graphics_configurationnew) constructor. + - `nielsen_configuration` (`list[obj]`): Set the `nielsen_configuration` field on the resulting object. When `null`, the `nielsen_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.medialive_channel.encoder_settings.nielsen_configuration.new](#fn-encoder_settingsnielsen_configurationnew) constructor. - `output_groups` (`list[obj]`): Set the `output_groups` field on the resulting object. When `null`, the `output_groups` 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.encoder_settings.output_groups.new](#fn-encoder_settingsoutput_groupsnew) constructor. - `timecode_config` (`list[obj]`): Set the `timecode_config` field on the resulting object. When `null`, the `timecode_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.medialive_channel.encoder_settings.timecode_config.new](#fn-encoder_settingstimecode_confignew) constructor. - `video_descriptions` (`list[obj]`): Set the `video_descriptions` field on the resulting object. When `null`, the `video_descriptions` 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.encoder_settings.video_descriptions.new](#fn-encoder_settingsvideo_descriptionsnew) constructor. @@ -1456,6 +1508,600 @@ Terraform sub block. - An attribute object that represents the `avail_blanking_image` sub block. +## obj encoder_settings.caption_descriptions + + + +### fn encoder_settings.caption_descriptions.new + +```ts +new() +``` + + +`aws.medialive_channel.encoder_settings.caption_descriptions.new` constructs a new object with attributes and blocks configured for the `caption_descriptions` +Terraform sub block. + + + +**Args**: + - `accessibility` (`string`): Set the `accessibility` field on the resulting object. When `null`, the `accessibility` field will be omitted from the resulting object. + - `caption_selector_name` (`string`): Set the `caption_selector_name` field on the resulting object. + - `language_code` (`string`): Set the `language_code` field on the resulting object. When `null`, the `language_code` field will be omitted from the resulting object. + - `language_description` (`string`): Set the `language_description` field on the resulting object. When `null`, the `language_description` field will be omitted from the resulting object. + - `name` (`string`): Set the `name` field on the resulting object. + - `destination_settings` (`list[obj]`): Set the `destination_settings` field on the resulting object. When `null`, the `destination_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.encoder_settings.caption_descriptions.destination_settings.new](#fn-encoder_settingsencoder_settingsdestination_settingsnew) constructor. + +**Returns**: + - An attribute object that represents the `caption_descriptions` sub block. + + +## obj encoder_settings.caption_descriptions.destination_settings + + + +### fn encoder_settings.caption_descriptions.destination_settings.new + +```ts +new() +``` + + +`aws.medialive_channel.encoder_settings.caption_descriptions.destination_settings.new` constructs a new object with attributes and blocks configured for the `destination_settings` +Terraform sub block. + + + +**Args**: + - `arib_destination_settings` (`list[obj]`): Set the `arib_destination_settings` field on the resulting object. When `null`, the `arib_destination_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.encoder_settings.caption_descriptions.destination_settings.arib_destination_settings.new](#fn-encoder_settingsencoder_settingscaption_descriptionsarib_destination_settingsnew) constructor. + - `burn_in_destination_settings` (`list[obj]`): Set the `burn_in_destination_settings` field on the resulting object. When `null`, the `burn_in_destination_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.encoder_settings.caption_descriptions.destination_settings.burn_in_destination_settings.new](#fn-encoder_settingsencoder_settingscaption_descriptionsburn_in_destination_settingsnew) constructor. + - `dvb_sub_destination_settings` (`list[obj]`): Set the `dvb_sub_destination_settings` field on the resulting object. When `null`, the `dvb_sub_destination_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.encoder_settings.caption_descriptions.destination_settings.dvb_sub_destination_settings.new](#fn-encoder_settingsencoder_settingscaption_descriptionsdvb_sub_destination_settingsnew) constructor. + - `ebu_tt_d_destination_settings` (`list[obj]`): Set the `ebu_tt_d_destination_settings` field on the resulting object. When `null`, the `ebu_tt_d_destination_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.encoder_settings.caption_descriptions.destination_settings.ebu_tt_d_destination_settings.new](#fn-encoder_settingsencoder_settingscaption_descriptionsebu_tt_d_destination_settingsnew) constructor. + - `embedded_destination_settings` (`list[obj]`): Set the `embedded_destination_settings` field on the resulting object. When `null`, the `embedded_destination_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.encoder_settings.caption_descriptions.destination_settings.embedded_destination_settings.new](#fn-encoder_settingsencoder_settingscaption_descriptionsembedded_destination_settingsnew) constructor. + - `embedded_plus_scte20_destination_settings` (`list[obj]`): Set the `embedded_plus_scte20_destination_settings` field on the resulting object. When `null`, the `embedded_plus_scte20_destination_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.encoder_settings.caption_descriptions.destination_settings.embedded_plus_scte20_destination_settings.new](#fn-encoder_settingsencoder_settingscaption_descriptionsembedded_plus_scte20_destination_settingsnew) constructor. + - `rtmp_caption_info_destination_settings` (`list[obj]`): Set the `rtmp_caption_info_destination_settings` field on the resulting object. When `null`, the `rtmp_caption_info_destination_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.encoder_settings.caption_descriptions.destination_settings.rtmp_caption_info_destination_settings.new](#fn-encoder_settingsencoder_settingscaption_descriptionsrtmp_caption_info_destination_settingsnew) constructor. + - `scte20_plus_embedded_destination_settings` (`list[obj]`): Set the `scte20_plus_embedded_destination_settings` field on the resulting object. When `null`, the `scte20_plus_embedded_destination_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.encoder_settings.caption_descriptions.destination_settings.scte20_plus_embedded_destination_settings.new](#fn-encoder_settingsencoder_settingscaption_descriptionsscte20_plus_embedded_destination_settingsnew) constructor. + - `scte27_destination_settings` (`list[obj]`): Set the `scte27_destination_settings` field on the resulting object. When `null`, the `scte27_destination_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.encoder_settings.caption_descriptions.destination_settings.scte27_destination_settings.new](#fn-encoder_settingsencoder_settingscaption_descriptionsscte27_destination_settingsnew) constructor. + - `smpte_tt_destination_settings` (`list[obj]`): Set the `smpte_tt_destination_settings` field on the resulting object. When `null`, the `smpte_tt_destination_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.encoder_settings.caption_descriptions.destination_settings.smpte_tt_destination_settings.new](#fn-encoder_settingsencoder_settingscaption_descriptionssmpte_tt_destination_settingsnew) constructor. + - `teletext_destination_settings` (`list[obj]`): Set the `teletext_destination_settings` field on the resulting object. When `null`, the `teletext_destination_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.encoder_settings.caption_descriptions.destination_settings.teletext_destination_settings.new](#fn-encoder_settingsencoder_settingscaption_descriptionsteletext_destination_settingsnew) constructor. + - `ttml_destination_settings` (`list[obj]`): Set the `ttml_destination_settings` field on the resulting object. When `null`, the `ttml_destination_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.encoder_settings.caption_descriptions.destination_settings.ttml_destination_settings.new](#fn-encoder_settingsencoder_settingscaption_descriptionsttml_destination_settingsnew) constructor. + - `webvtt_destination_settings` (`list[obj]`): Set the `webvtt_destination_settings` field on the resulting object. When `null`, the `webvtt_destination_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.encoder_settings.caption_descriptions.destination_settings.webvtt_destination_settings.new](#fn-encoder_settingsencoder_settingscaption_descriptionswebvtt_destination_settingsnew) constructor. + +**Returns**: + - An attribute object that represents the `destination_settings` sub block. + + +## obj encoder_settings.caption_descriptions.destination_settings.arib_destination_settings + + + +### fn encoder_settings.caption_descriptions.destination_settings.arib_destination_settings.new + +```ts +new() +``` + + +`aws.medialive_channel.encoder_settings.caption_descriptions.destination_settings.arib_destination_settings.new` constructs a new object with attributes and blocks configured for the `arib_destination_settings` +Terraform sub block. + + + +**Returns**: + - An attribute object that represents the `arib_destination_settings` sub block. + + +## obj encoder_settings.caption_descriptions.destination_settings.burn_in_destination_settings + + + +### fn encoder_settings.caption_descriptions.destination_settings.burn_in_destination_settings.new + +```ts +new() +``` + + +`aws.medialive_channel.encoder_settings.caption_descriptions.destination_settings.burn_in_destination_settings.new` constructs a new object with attributes and blocks configured for the `burn_in_destination_settings` +Terraform sub block. + + + +**Args**: + - `alignment` (`string`): Set the `alignment` field on the resulting object. When `null`, the `alignment` field will be omitted from the resulting object. + - `background_color` (`string`): Set the `background_color` field on the resulting object. When `null`, the `background_color` field will be omitted from the resulting object. + - `background_opacity` (`number`): Set the `background_opacity` field on the resulting object. When `null`, the `background_opacity` field will be omitted from the resulting object. + - `font_color` (`string`): Set the `font_color` field on the resulting object. When `null`, the `font_color` field will be omitted from the resulting object. + - `font_opacity` (`number`): Set the `font_opacity` field on the resulting object. When `null`, the `font_opacity` field will be omitted from the resulting object. + - `font_resolution` (`number`): Set the `font_resolution` field on the resulting object. When `null`, the `font_resolution` field will be omitted from the resulting object. + - `font_size` (`string`): Set the `font_size` field on the resulting object. When `null`, the `font_size` field will be omitted from the resulting object. + - `outline_color` (`string`): Set the `outline_color` field on the resulting object. + - `outline_size` (`number`): Set the `outline_size` field on the resulting object. When `null`, the `outline_size` field will be omitted from the resulting object. + - `shadow_color` (`string`): Set the `shadow_color` field on the resulting object. When `null`, the `shadow_color` field will be omitted from the resulting object. + - `shadow_opacity` (`number`): Set the `shadow_opacity` field on the resulting object. When `null`, the `shadow_opacity` field will be omitted from the resulting object. + - `shadow_x_offset` (`number`): Set the `shadow_x_offset` field on the resulting object. When `null`, the `shadow_x_offset` field will be omitted from the resulting object. + - `shadow_y_offset` (`number`): Set the `shadow_y_offset` field on the resulting object. When `null`, the `shadow_y_offset` field will be omitted from the resulting object. + - `teletext_grid_control` (`string`): Set the `teletext_grid_control` field on the resulting object. + - `x_position` (`number`): Set the `x_position` field on the resulting object. When `null`, the `x_position` field will be omitted from the resulting object. + - `y_position` (`number`): Set the `y_position` field on the resulting object. When `null`, the `y_position` field will be omitted from the resulting object. + - `font` (`list[obj]`): Set the `font` field on the resulting object. When `null`, the `font` 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.encoder_settings.caption_descriptions.destination_settings.burn_in_destination_settings.font.new](#fn-encoder_settingsencoder_settingscaption_descriptionsdestination_settingsfontnew) constructor. + +**Returns**: + - An attribute object that represents the `burn_in_destination_settings` sub block. + + +## obj encoder_settings.caption_descriptions.destination_settings.burn_in_destination_settings.font + + + +### fn encoder_settings.caption_descriptions.destination_settings.burn_in_destination_settings.font.new + +```ts +new() +``` + + +`aws.medialive_channel.encoder_settings.caption_descriptions.destination_settings.burn_in_destination_settings.font.new` constructs a new object with attributes and blocks configured for the `font` +Terraform sub block. + + + +**Args**: + - `password_param` (`string`): Set the `password_param` field on the resulting object. When `null`, the `password_param` field will be omitted from the resulting object. + - `uri` (`string`): Set the `uri` field on the resulting object. + - `username` (`string`): Set the `username` field on the resulting object. When `null`, the `username` field will be omitted from the resulting object. + +**Returns**: + - An attribute object that represents the `font` sub block. + + +## obj encoder_settings.caption_descriptions.destination_settings.dvb_sub_destination_settings + + + +### fn encoder_settings.caption_descriptions.destination_settings.dvb_sub_destination_settings.new + +```ts +new() +``` + + +`aws.medialive_channel.encoder_settings.caption_descriptions.destination_settings.dvb_sub_destination_settings.new` constructs a new object with attributes and blocks configured for the `dvb_sub_destination_settings` +Terraform sub block. + + + +**Args**: + - `alignment` (`string`): Set the `alignment` field on the resulting object. When `null`, the `alignment` field will be omitted from the resulting object. + - `background_color` (`string`): Set the `background_color` field on the resulting object. When `null`, the `background_color` field will be omitted from the resulting object. + - `background_opacity` (`number`): Set the `background_opacity` field on the resulting object. When `null`, the `background_opacity` field will be omitted from the resulting object. + - `font_color` (`string`): Set the `font_color` field on the resulting object. When `null`, the `font_color` field will be omitted from the resulting object. + - `font_opacity` (`number`): Set the `font_opacity` field on the resulting object. When `null`, the `font_opacity` field will be omitted from the resulting object. + - `font_resolution` (`number`): Set the `font_resolution` field on the resulting object. When `null`, the `font_resolution` field will be omitted from the resulting object. + - `font_size` (`string`): Set the `font_size` field on the resulting object. When `null`, the `font_size` field will be omitted from the resulting object. + - `outline_color` (`string`): Set the `outline_color` field on the resulting object. When `null`, the `outline_color` field will be omitted from the resulting object. + - `outline_size` (`number`): Set the `outline_size` field on the resulting object. When `null`, the `outline_size` field will be omitted from the resulting object. + - `shadow_color` (`string`): Set the `shadow_color` field on the resulting object. When `null`, the `shadow_color` field will be omitted from the resulting object. + - `shadow_opacity` (`number`): Set the `shadow_opacity` field on the resulting object. When `null`, the `shadow_opacity` field will be omitted from the resulting object. + - `shadow_x_offset` (`number`): Set the `shadow_x_offset` field on the resulting object. When `null`, the `shadow_x_offset` field will be omitted from the resulting object. + - `shadow_y_offset` (`number`): Set the `shadow_y_offset` field on the resulting object. When `null`, the `shadow_y_offset` field will be omitted from the resulting object. + - `teletext_grid_control` (`string`): Set the `teletext_grid_control` field on the resulting object. When `null`, the `teletext_grid_control` field will be omitted from the resulting object. + - `x_position` (`number`): Set the `x_position` field on the resulting object. When `null`, the `x_position` field will be omitted from the resulting object. + - `y_position` (`number`): Set the `y_position` field on the resulting object. When `null`, the `y_position` field will be omitted from the resulting object. + - `font` (`list[obj]`): Set the `font` field on the resulting object. When `null`, the `font` 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.encoder_settings.caption_descriptions.destination_settings.dvb_sub_destination_settings.font.new](#fn-encoder_settingsencoder_settingscaption_descriptionsdestination_settingsfontnew) constructor. + +**Returns**: + - An attribute object that represents the `dvb_sub_destination_settings` sub block. + + +## obj encoder_settings.caption_descriptions.destination_settings.dvb_sub_destination_settings.font + + + +### fn encoder_settings.caption_descriptions.destination_settings.dvb_sub_destination_settings.font.new + +```ts +new() +``` + + +`aws.medialive_channel.encoder_settings.caption_descriptions.destination_settings.dvb_sub_destination_settings.font.new` constructs a new object with attributes and blocks configured for the `font` +Terraform sub block. + + + +**Args**: + - `password_param` (`string`): Set the `password_param` field on the resulting object. When `null`, the `password_param` field will be omitted from the resulting object. + - `uri` (`string`): Set the `uri` field on the resulting object. + - `username` (`string`): Set the `username` field on the resulting object. When `null`, the `username` field will be omitted from the resulting object. + +**Returns**: + - An attribute object that represents the `font` sub block. + + +## obj encoder_settings.caption_descriptions.destination_settings.ebu_tt_d_destination_settings + + + +### fn encoder_settings.caption_descriptions.destination_settings.ebu_tt_d_destination_settings.new + +```ts +new() +``` + + +`aws.medialive_channel.encoder_settings.caption_descriptions.destination_settings.ebu_tt_d_destination_settings.new` constructs a new object with attributes and blocks configured for the `ebu_tt_d_destination_settings` +Terraform sub block. + + + +**Args**: + - `copyright_holder` (`string`): Set the `copyright_holder` field on the resulting object. When `null`, the `copyright_holder` field will be omitted from the resulting object. + - `fill_line_gap` (`string`): Set the `fill_line_gap` field on the resulting object. When `null`, the `fill_line_gap` field will be omitted from the resulting object. + - `font_family` (`string`): Set the `font_family` field on the resulting object. When `null`, the `font_family` field will be omitted from the resulting object. + - `style_control` (`string`): Set the `style_control` field on the resulting object. When `null`, the `style_control` field will be omitted from the resulting object. + +**Returns**: + - An attribute object that represents the `ebu_tt_d_destination_settings` sub block. + + +## obj encoder_settings.caption_descriptions.destination_settings.embedded_destination_settings + + + +### fn encoder_settings.caption_descriptions.destination_settings.embedded_destination_settings.new + +```ts +new() +``` + + +`aws.medialive_channel.encoder_settings.caption_descriptions.destination_settings.embedded_destination_settings.new` constructs a new object with attributes and blocks configured for the `embedded_destination_settings` +Terraform sub block. + + + +**Returns**: + - An attribute object that represents the `embedded_destination_settings` sub block. + + +## obj encoder_settings.caption_descriptions.destination_settings.embedded_plus_scte20_destination_settings + + + +### fn encoder_settings.caption_descriptions.destination_settings.embedded_plus_scte20_destination_settings.new + +```ts +new() +``` + + +`aws.medialive_channel.encoder_settings.caption_descriptions.destination_settings.embedded_plus_scte20_destination_settings.new` constructs a new object with attributes and blocks configured for the `embedded_plus_scte20_destination_settings` +Terraform sub block. + + + +**Returns**: + - An attribute object that represents the `embedded_plus_scte20_destination_settings` sub block. + + +## obj encoder_settings.caption_descriptions.destination_settings.rtmp_caption_info_destination_settings + + + +### fn encoder_settings.caption_descriptions.destination_settings.rtmp_caption_info_destination_settings.new + +```ts +new() +``` + + +`aws.medialive_channel.encoder_settings.caption_descriptions.destination_settings.rtmp_caption_info_destination_settings.new` constructs a new object with attributes and blocks configured for the `rtmp_caption_info_destination_settings` +Terraform sub block. + + + +**Returns**: + - An attribute object that represents the `rtmp_caption_info_destination_settings` sub block. + + +## obj encoder_settings.caption_descriptions.destination_settings.scte20_plus_embedded_destination_settings + + + +### fn encoder_settings.caption_descriptions.destination_settings.scte20_plus_embedded_destination_settings.new + +```ts +new() +``` + + +`aws.medialive_channel.encoder_settings.caption_descriptions.destination_settings.scte20_plus_embedded_destination_settings.new` constructs a new object with attributes and blocks configured for the `scte20_plus_embedded_destination_settings` +Terraform sub block. + + + +**Returns**: + - An attribute object that represents the `scte20_plus_embedded_destination_settings` sub block. + + +## obj encoder_settings.caption_descriptions.destination_settings.scte27_destination_settings + + + +### fn encoder_settings.caption_descriptions.destination_settings.scte27_destination_settings.new + +```ts +new() +``` + + +`aws.medialive_channel.encoder_settings.caption_descriptions.destination_settings.scte27_destination_settings.new` constructs a new object with attributes and blocks configured for the `scte27_destination_settings` +Terraform sub block. + + + +**Returns**: + - An attribute object that represents the `scte27_destination_settings` sub block. + + +## obj encoder_settings.caption_descriptions.destination_settings.smpte_tt_destination_settings + + + +### fn encoder_settings.caption_descriptions.destination_settings.smpte_tt_destination_settings.new + +```ts +new() +``` + + +`aws.medialive_channel.encoder_settings.caption_descriptions.destination_settings.smpte_tt_destination_settings.new` constructs a new object with attributes and blocks configured for the `smpte_tt_destination_settings` +Terraform sub block. + + + +**Returns**: + - An attribute object that represents the `smpte_tt_destination_settings` sub block. + + +## obj encoder_settings.caption_descriptions.destination_settings.teletext_destination_settings + + + +### fn encoder_settings.caption_descriptions.destination_settings.teletext_destination_settings.new + +```ts +new() +``` + + +`aws.medialive_channel.encoder_settings.caption_descriptions.destination_settings.teletext_destination_settings.new` constructs a new object with attributes and blocks configured for the `teletext_destination_settings` +Terraform sub block. + + + +**Returns**: + - An attribute object that represents the `teletext_destination_settings` sub block. + + +## obj encoder_settings.caption_descriptions.destination_settings.ttml_destination_settings + + + +### fn encoder_settings.caption_descriptions.destination_settings.ttml_destination_settings.new + +```ts +new() +``` + + +`aws.medialive_channel.encoder_settings.caption_descriptions.destination_settings.ttml_destination_settings.new` constructs a new object with attributes and blocks configured for the `ttml_destination_settings` +Terraform sub block. + + + +**Args**: + - `style_control` (`string`): Set the `style_control` field on the resulting object. + +**Returns**: + - An attribute object that represents the `ttml_destination_settings` sub block. + + +## obj encoder_settings.caption_descriptions.destination_settings.webvtt_destination_settings + + + +### fn encoder_settings.caption_descriptions.destination_settings.webvtt_destination_settings.new + +```ts +new() +``` + + +`aws.medialive_channel.encoder_settings.caption_descriptions.destination_settings.webvtt_destination_settings.new` constructs a new object with attributes and blocks configured for the `webvtt_destination_settings` +Terraform sub block. + + + +**Args**: + - `style_control` (`string`): Set the `style_control` field on the resulting object. + +**Returns**: + - An attribute object that represents the `webvtt_destination_settings` sub block. + + +## obj encoder_settings.global_configuration + + + +### fn encoder_settings.global_configuration.new + +```ts +new() +``` + + +`aws.medialive_channel.encoder_settings.global_configuration.new` constructs a new object with attributes and blocks configured for the `global_configuration` +Terraform sub block. + + + +**Args**: + - `initial_audio_gain` (`number`): Set the `initial_audio_gain` field on the resulting object. When `null`, the `initial_audio_gain` field will be omitted from the resulting object. + - `input_end_action` (`string`): Set the `input_end_action` field on the resulting object. When `null`, the `input_end_action` field will be omitted from the resulting object. + - `output_locking_mode` (`string`): Set the `output_locking_mode` field on the resulting object. When `null`, the `output_locking_mode` field will be omitted from the resulting object. + - `output_timing_source` (`string`): Set the `output_timing_source` field on the resulting object. When `null`, the `output_timing_source` field will be omitted from the resulting object. + - `support_low_framerate_inputs` (`string`): Set the `support_low_framerate_inputs` field on the resulting object. When `null`, the `support_low_framerate_inputs` field will be omitted from the resulting object. + - `input_loss_behavior` (`list[obj]`): Set the `input_loss_behavior` field on the resulting object. When `null`, the `input_loss_behavior` 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.encoder_settings.global_configuration.input_loss_behavior.new](#fn-encoder_settingsencoder_settingsinput_loss_behaviornew) constructor. + +**Returns**: + - An attribute object that represents the `global_configuration` sub block. + + +## obj encoder_settings.global_configuration.input_loss_behavior + + + +### fn encoder_settings.global_configuration.input_loss_behavior.new + +```ts +new() +``` + + +`aws.medialive_channel.encoder_settings.global_configuration.input_loss_behavior.new` constructs a new object with attributes and blocks configured for the `input_loss_behavior` +Terraform sub block. + + + +**Args**: + - `black_frame_msec` (`number`): Set the `black_frame_msec` field on the resulting object. When `null`, the `black_frame_msec` field will be omitted from the resulting object. + - `input_loss_image_color` (`string`): Set the `input_loss_image_color` field on the resulting object. When `null`, the `input_loss_image_color` field will be omitted from the resulting object. + - `input_loss_image_type` (`string`): Set the `input_loss_image_type` field on the resulting object. When `null`, the `input_loss_image_type` field will be omitted from the resulting object. + - `repeat_frame_msec` (`number`): Set the `repeat_frame_msec` field on the resulting object. When `null`, the `repeat_frame_msec` field will be omitted from the resulting object. + - `input_loss_image_slate` (`list[obj]`): Set the `input_loss_image_slate` field on the resulting object. When `null`, the `input_loss_image_slate` 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.encoder_settings.global_configuration.input_loss_behavior.input_loss_image_slate.new](#fn-encoder_settingsencoder_settingsglobal_configurationinput_loss_image_slatenew) constructor. + +**Returns**: + - An attribute object that represents the `input_loss_behavior` sub block. + + +## obj encoder_settings.global_configuration.input_loss_behavior.input_loss_image_slate + + + +### fn encoder_settings.global_configuration.input_loss_behavior.input_loss_image_slate.new + +```ts +new() +``` + + +`aws.medialive_channel.encoder_settings.global_configuration.input_loss_behavior.input_loss_image_slate.new` constructs a new object with attributes and blocks configured for the `input_loss_image_slate` +Terraform sub block. + + + +**Args**: + - `password_param` (`string`): Set the `password_param` field on the resulting object. When `null`, the `password_param` field will be omitted from the resulting object. + - `uri` (`string`): Set the `uri` field on the resulting object. + - `username` (`string`): Set the `username` field on the resulting object. When `null`, the `username` field will be omitted from the resulting object. + +**Returns**: + - An attribute object that represents the `input_loss_image_slate` sub block. + + +## obj encoder_settings.motion_graphics_configuration + + + +### fn encoder_settings.motion_graphics_configuration.new + +```ts +new() +``` + + +`aws.medialive_channel.encoder_settings.motion_graphics_configuration.new` constructs a new object with attributes and blocks configured for the `motion_graphics_configuration` +Terraform sub block. + + + +**Args**: + - `motion_graphics_insertion` (`string`): Set the `motion_graphics_insertion` field on the resulting object. When `null`, the `motion_graphics_insertion` field will be omitted from the resulting object. + - `motion_graphics_settings` (`list[obj]`): Set the `motion_graphics_settings` field on the resulting object. When `null`, the `motion_graphics_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.encoder_settings.motion_graphics_configuration.motion_graphics_settings.new](#fn-encoder_settingsencoder_settingsmotion_graphics_settingsnew) constructor. + +**Returns**: + - An attribute object that represents the `motion_graphics_configuration` sub block. + + +## obj encoder_settings.motion_graphics_configuration.motion_graphics_settings + + + +### fn encoder_settings.motion_graphics_configuration.motion_graphics_settings.new + +```ts +new() +``` + + +`aws.medialive_channel.encoder_settings.motion_graphics_configuration.motion_graphics_settings.new` constructs a new object with attributes and blocks configured for the `motion_graphics_settings` +Terraform sub block. + + + +**Args**: + - `html_motion_graphics_settings` (`list[obj]`): Set the `html_motion_graphics_settings` field on the resulting object. When `null`, the `html_motion_graphics_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.encoder_settings.motion_graphics_configuration.motion_graphics_settings.html_motion_graphics_settings.new](#fn-encoder_settingsencoder_settingsmotion_graphics_configurationhtml_motion_graphics_settingsnew) constructor. + +**Returns**: + - An attribute object that represents the `motion_graphics_settings` sub block. + + +## obj encoder_settings.motion_graphics_configuration.motion_graphics_settings.html_motion_graphics_settings + + + +### fn encoder_settings.motion_graphics_configuration.motion_graphics_settings.html_motion_graphics_settings.new + +```ts +new() +``` + + +`aws.medialive_channel.encoder_settings.motion_graphics_configuration.motion_graphics_settings.html_motion_graphics_settings.new` constructs a new object with attributes and blocks configured for the `html_motion_graphics_settings` +Terraform sub block. + + + +**Returns**: + - An attribute object that represents the `html_motion_graphics_settings` sub block. + + +## obj encoder_settings.nielsen_configuration + + + +### fn encoder_settings.nielsen_configuration.new + +```ts +new() +``` + + +`aws.medialive_channel.encoder_settings.nielsen_configuration.new` constructs a new object with attributes and blocks configured for the `nielsen_configuration` +Terraform sub block. + + + +**Args**: + - `distributor_id` (`string`): Set the `distributor_id` field on the resulting object. When `null`, the `distributor_id` field will be omitted from the resulting object. + - `nielsen_pcm_to_id3_tagging` (`string`): Set the `nielsen_pcm_to_id3_tagging` field on the resulting object. When `null`, the `nielsen_pcm_to_id3_tagging` field will be omitted from the resulting object. + +**Returns**: + - An attribute object that represents the `nielsen_configuration` sub block. + + ## obj encoder_settings.output_groups diff --git a/docs/5.x/nat_gateway.md b/docs/5.x/nat_gateway.md index 8d1b6ce3..c162d8d9 100644 --- a/docs/5.x/nat_gateway.md +++ b/docs/5.x/nat_gateway.md @@ -18,9 +18,16 @@ This package contains functions and utilities for setting up the resource using * [`fn withAllocationId()`](#fn-withallocationid) * [`fn withConnectivityType()`](#fn-withconnectivitytype) * [`fn withPrivateIp()`](#fn-withprivateip) +* [`fn withSecondaryAllocationIds()`](#fn-withsecondaryallocationids) +* [`fn withSecondaryPrivateIpAddressCount()`](#fn-withsecondaryprivateipaddresscount) +* [`fn withSecondaryPrivateIpAddresses()`](#fn-withsecondaryprivateipaddresses) * [`fn withSubnetId()`](#fn-withsubnetid) * [`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 @@ -54,9 +61,13 @@ or `$` to refer to the root object. Instead, make an explicit outer object using - `allocation_id` (`string`): Set the `allocation_id` field on the resulting resource block. When `null`, the `allocation_id` field will be omitted from the resulting object. - `connectivity_type` (`string`): Set the `connectivity_type` field on the resulting resource block. When `null`, the `connectivity_type` field will be omitted from the resulting object. - `private_ip` (`string`): Set the `private_ip` field on the resulting resource block. When `null`, the `private_ip` field will be omitted from the resulting object. + - `secondary_allocation_ids` (`list`): Set the `secondary_allocation_ids` field on the resulting resource block. When `null`, the `secondary_allocation_ids` field will be omitted from the resulting object. + - `secondary_private_ip_address_count` (`number`): Set the `secondary_private_ip_address_count` field on the resulting resource block. When `null`, the `secondary_private_ip_address_count` field will be omitted from the resulting object. + - `secondary_private_ip_addresses` (`list`): Set the `secondary_private_ip_addresses` field on the resulting resource block. When `null`, the `secondary_private_ip_addresses` field will be omitted from the resulting object. - `subnet_id` (`string`): Set the `subnet_id` 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.nat_gateway.timeouts.new](#fn-timeoutsnew) constructor. **Returns**: - A mixin object that injects the new resource into the root Terraform configuration. @@ -83,9 +94,13 @@ injecting into a complete block. - `allocation_id` (`string`): Set the `allocation_id` field on the resulting object. When `null`, the `allocation_id` field will be omitted from the resulting object. - `connectivity_type` (`string`): Set the `connectivity_type` field on the resulting object. When `null`, the `connectivity_type` field will be omitted from the resulting object. - `private_ip` (`string`): Set the `private_ip` field on the resulting object. When `null`, the `private_ip` field will be omitted from the resulting object. + - `secondary_allocation_ids` (`list`): Set the `secondary_allocation_ids` field on the resulting object. When `null`, the `secondary_allocation_ids` field will be omitted from the resulting object. + - `secondary_private_ip_address_count` (`number`): Set the `secondary_private_ip_address_count` field on the resulting object. When `null`, the `secondary_private_ip_address_count` field will be omitted from the resulting object. + - `secondary_private_ip_addresses` (`list`): Set the `secondary_private_ip_addresses` field on the resulting object. When `null`, the `secondary_private_ip_addresses` field will be omitted from the resulting object. - `subnet_id` (`string`): Set the `subnet_id` 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.nat_gateway.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 `nat_gateway` resource into the root Terraform configuration. @@ -139,6 +154,54 @@ Terraform resource block to set or update the private_ip field. - `value` (`string`): The value to set for the `private_ip` field. +### fn withSecondaryAllocationIds + +```ts +withSecondaryAllocationIds() +``` + +`aws.list.withSecondaryAllocationIds` constructs a mixin object that can be merged into the `list` +Terraform resource block to set or update the secondary_allocation_ids field. + + + +**Args**: + - `resourceLabel` (`string`): The name label of the block to update. + - `value` (`list`): The value to set for the `secondary_allocation_ids` field. + + +### fn withSecondaryPrivateIpAddressCount + +```ts +withSecondaryPrivateIpAddressCount() +``` + +`aws.number.withSecondaryPrivateIpAddressCount` constructs a mixin object that can be merged into the `number` +Terraform resource block to set or update the secondary_private_ip_address_count field. + + + +**Args**: + - `resourceLabel` (`string`): The name label of the block to update. + - `value` (`number`): The value to set for the `secondary_private_ip_address_count` field. + + +### fn withSecondaryPrivateIpAddresses + +```ts +withSecondaryPrivateIpAddresses() +``` + +`aws.list.withSecondaryPrivateIpAddresses` constructs a mixin object that can be merged into the `list` +Terraform resource block to set or update the secondary_private_ip_addresses field. + + + +**Args**: + - `resourceLabel` (`string`): The name label of the block to update. + - `value` (`list`): The value to set for the `secondary_private_ip_addresses` field. + + ### fn withSubnetId ```ts @@ -185,3 +248,64 @@ 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.nat_gateway.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/networkfirewall_firewall_policy.md b/docs/5.x/networkfirewall_firewall_policy.md index 1a74d205..efcac6cf 100644 --- a/docs/5.x/networkfirewall_firewall_policy.md +++ b/docs/5.x/networkfirewall_firewall_policy.md @@ -27,6 +27,12 @@ This package contains functions and utilities for setting up the resource using * [`fn new()`](#fn-encryption_configurationnew) * [`obj firewall_policy`](#obj-firewall_policy) * [`fn new()`](#fn-firewall_policynew) + * [`obj firewall_policy.policy_variables`](#obj-firewall_policypolicy_variables) + * [`fn new()`](#fn-firewall_policypolicy_variablesnew) + * [`obj firewall_policy.policy_variables.rule_variables`](#obj-firewall_policypolicy_variablesrule_variables) + * [`fn new()`](#fn-firewall_policypolicy_variablesrule_variablesnew) + * [`obj firewall_policy.policy_variables.rule_variables.ip_set`](#obj-firewall_policypolicy_variablesrule_variablesip_set) + * [`fn new()`](#fn-firewall_policypolicy_variablesrule_variablesip_setnew) * [`obj firewall_policy.stateful_engine_options`](#obj-firewall_policystateful_engine_options) * [`fn new()`](#fn-firewall_policystateful_engine_optionsnew) * [`obj firewall_policy.stateful_rule_group_reference`](#obj-firewall_policystateful_rule_group_reference) @@ -295,6 +301,7 @@ Terraform sub block. - `stateful_default_actions` (`list`): Set the `stateful_default_actions` field on the resulting object. When `null`, the `stateful_default_actions` field will be omitted from the resulting object. - `stateless_default_actions` (`list`): Set the `stateless_default_actions` field on the resulting object. - `stateless_fragment_default_actions` (`list`): Set the `stateless_fragment_default_actions` field on the resulting object. + - `policy_variables` (`list[obj]`): Set the `policy_variables` field on the resulting object. When `null`, the `policy_variables` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [aws.networkfirewall_firewall_policy.firewall_policy.policy_variables.new](#fn-firewall_policypolicy_variablesnew) constructor. - `stateful_engine_options` (`list[obj]`): Set the `stateful_engine_options` field on the resulting object. When `null`, the `stateful_engine_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.networkfirewall_firewall_policy.firewall_policy.stateful_engine_options.new](#fn-firewall_policystateful_engine_optionsnew) constructor. - `stateful_rule_group_reference` (`list[obj]`): Set the `stateful_rule_group_reference` field on the resulting object. When `null`, the `stateful_rule_group_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.networkfirewall_firewall_policy.firewall_policy.stateful_rule_group_reference.new](#fn-firewall_policystateful_rule_group_referencenew) constructor. - `stateless_custom_action` (`list[obj]`): Set the `stateless_custom_action` field on the resulting object. When `null`, the `stateless_custom_action` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [aws.networkfirewall_firewall_policy.firewall_policy.stateless_custom_action.new](#fn-firewall_policystateless_custom_actionnew) constructor. @@ -304,6 +311,76 @@ Terraform sub block. - An attribute object that represents the `firewall_policy` sub block. +## obj firewall_policy.policy_variables + + + +### fn firewall_policy.policy_variables.new + +```ts +new() +``` + + +`aws.networkfirewall_firewall_policy.firewall_policy.policy_variables.new` constructs a new object with attributes and blocks configured for the `policy_variables` +Terraform sub block. + + + +**Args**: + - `rule_variables` (`list[obj]`): Set the `rule_variables` field on the resulting object. When `null`, the `rule_variables` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [aws.networkfirewall_firewall_policy.firewall_policy.policy_variables.rule_variables.new](#fn-firewall_policyfirewall_policyrule_variablesnew) constructor. + +**Returns**: + - An attribute object that represents the `policy_variables` sub block. + + +## obj firewall_policy.policy_variables.rule_variables + + + +### fn firewall_policy.policy_variables.rule_variables.new + +```ts +new() +``` + + +`aws.networkfirewall_firewall_policy.firewall_policy.policy_variables.rule_variables.new` constructs a new object with attributes and blocks configured for the `rule_variables` +Terraform sub block. + + + +**Args**: + - `key` (`string`): Set the `key` field on the resulting object. + - `ip_set` (`list[obj]`): Set the `ip_set` field on the resulting object. When `null`, the `ip_set` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [aws.networkfirewall_firewall_policy.firewall_policy.policy_variables.rule_variables.ip_set.new](#fn-firewall_policyfirewall_policypolicy_variablesip_setnew) constructor. + +**Returns**: + - An attribute object that represents the `rule_variables` sub block. + + +## obj firewall_policy.policy_variables.rule_variables.ip_set + + + +### fn firewall_policy.policy_variables.rule_variables.ip_set.new + +```ts +new() +``` + + +`aws.networkfirewall_firewall_policy.firewall_policy.policy_variables.rule_variables.ip_set.new` constructs a new object with attributes and blocks configured for the `ip_set` +Terraform sub block. + + + +**Args**: + - `definition` (`list`): Set the `definition` field on the resulting object. + +**Returns**: + - An attribute object that represents the `ip_set` sub block. + + ## obj firewall_policy.stateful_engine_options diff --git a/docs/5.x/quicksight_analysis.md b/docs/5.x/quicksight_analysis.md index 6e407388..9c884c20 100644 --- a/docs/5.x/quicksight_analysis.md +++ b/docs/5.x/quicksight_analysis.md @@ -23161,7 +23161,7 @@ Terraform sub block. **Args**: - - `optimized_view_port_width` (`string`): Set the `optimized_view_port_width` field on the resulting object. + - `optimized_view_port_width` (`string`): Set the `optimized_view_port_width` field on the resulting object. When `null`, the `optimized_view_port_width` field will be omitted from the resulting object. - `resize_option` (`string`): Set the `resize_option` field on the resulting object. **Returns**: @@ -25646,7 +25646,7 @@ Terraform sub block. **Args**: - - `optimized_view_port_width` (`string`): Set the `optimized_view_port_width` field on the resulting object. + - `optimized_view_port_width` (`string`): Set the `optimized_view_port_width` field on the resulting object. When `null`, the `optimized_view_port_width` field will be omitted from the resulting object. - `resize_option` (`string`): Set the `resize_option` field on the resulting object. **Returns**: diff --git a/docs/5.x/quicksight_dashboard.md b/docs/5.x/quicksight_dashboard.md index 9c91b44c..6134cbd3 100644 --- a/docs/5.x/quicksight_dashboard.md +++ b/docs/5.x/quicksight_dashboard.md @@ -23486,7 +23486,7 @@ Terraform sub block. **Args**: - - `optimized_view_port_width` (`string`): Set the `optimized_view_port_width` field on the resulting object. + - `optimized_view_port_width` (`string`): Set the `optimized_view_port_width` field on the resulting object. When `null`, the `optimized_view_port_width` field will be omitted from the resulting object. - `resize_option` (`string`): Set the `resize_option` field on the resulting object. **Returns**: @@ -25971,7 +25971,7 @@ Terraform sub block. **Args**: - - `optimized_view_port_width` (`string`): Set the `optimized_view_port_width` field on the resulting object. + - `optimized_view_port_width` (`string`): Set the `optimized_view_port_width` field on the resulting object. When `null`, the `optimized_view_port_width` field will be omitted from the resulting object. - `resize_option` (`string`): Set the `resize_option` field on the resulting object. **Returns**: diff --git a/docs/5.x/quicksight_template.md b/docs/5.x/quicksight_template.md index f812c519..2fec609a 100644 --- a/docs/5.x/quicksight_template.md +++ b/docs/5.x/quicksight_template.md @@ -23197,7 +23197,7 @@ Terraform sub block. **Args**: - - `optimized_view_port_width` (`string`): Set the `optimized_view_port_width` field on the resulting object. + - `optimized_view_port_width` (`string`): Set the `optimized_view_port_width` field on the resulting object. When `null`, the `optimized_view_port_width` field will be omitted from the resulting object. - `resize_option` (`string`): Set the `resize_option` field on the resulting object. **Returns**: @@ -25682,7 +25682,7 @@ Terraform sub block. **Args**: - - `optimized_view_port_width` (`string`): Set the `optimized_view_port_width` field on the resulting object. + - `optimized_view_port_width` (`string`): Set the `optimized_view_port_width` field on the resulting object. When `null`, the `optimized_view_port_width` field will be omitted from the resulting object. - `resize_option` (`string`): Set the `resize_option` field on the resulting object. **Returns**: diff --git a/docs/5.x/sagemaker_domain.md b/docs/5.x/sagemaker_domain.md index a51ddfaf..dfd60e2b 100644 --- a/docs/5.x/sagemaker_domain.md +++ b/docs/5.x/sagemaker_domain.md @@ -54,6 +54,8 @@ This package contains functions and utilities for setting up the resource using * [`fn new()`](#fn-default_user_settingscanvas_app_settingsmodel_register_settingsnew) * [`obj default_user_settings.canvas_app_settings.time_series_forecasting_settings`](#obj-default_user_settingscanvas_app_settingstime_series_forecasting_settings) * [`fn new()`](#fn-default_user_settingscanvas_app_settingstime_series_forecasting_settingsnew) + * [`obj default_user_settings.canvas_app_settings.workspace_settings`](#obj-default_user_settingscanvas_app_settingsworkspace_settings) + * [`fn new()`](#fn-default_user_settingscanvas_app_settingsworkspace_settingsnew) * [`obj default_user_settings.jupyter_server_app_settings`](#obj-default_user_settingsjupyter_server_app_settings) * [`fn new()`](#fn-default_user_settingsjupyter_server_app_settingsnew) * [`obj default_user_settings.jupyter_server_app_settings.code_repository`](#obj-default_user_settingsjupyter_server_app_settingscode_repository) @@ -690,6 +692,7 @@ Terraform sub block. **Args**: - `model_register_settings` (`list[obj]`): Set the `model_register_settings` field on the resulting object. When `null`, the `model_register_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.sagemaker_domain.default_user_settings.canvas_app_settings.model_register_settings.new](#fn-default_user_settingsdefault_user_settingsmodel_register_settingsnew) constructor. - `time_series_forecasting_settings` (`list[obj]`): Set the `time_series_forecasting_settings` field on the resulting object. When `null`, the `time_series_forecasting_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.sagemaker_domain.default_user_settings.canvas_app_settings.time_series_forecasting_settings.new](#fn-default_user_settingsdefault_user_settingstime_series_forecasting_settingsnew) constructor. + - `workspace_settings` (`list[obj]`): Set the `workspace_settings` field on the resulting object. When `null`, the `workspace_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.sagemaker_domain.default_user_settings.canvas_app_settings.workspace_settings.new](#fn-default_user_settingsdefault_user_settingsworkspace_settingsnew) constructor. **Returns**: - An attribute object that represents the `canvas_app_settings` sub block. @@ -743,6 +746,30 @@ Terraform sub block. - An attribute object that represents the `time_series_forecasting_settings` sub block. +## obj default_user_settings.canvas_app_settings.workspace_settings + + + +### fn default_user_settings.canvas_app_settings.workspace_settings.new + +```ts +new() +``` + + +`aws.sagemaker_domain.default_user_settings.canvas_app_settings.workspace_settings.new` constructs a new object with attributes and blocks configured for the `workspace_settings` +Terraform sub block. + + + +**Args**: + - `s3_artifact_path` (`string`): Set the `s3_artifact_path` field on the resulting object. When `null`, the `s3_artifact_path` field will be omitted from the resulting object. + - `s3_kms_key_id` (`string`): Set the `s3_kms_key_id` field on the resulting object. When `null`, the `s3_kms_key_id` field will be omitted from the resulting object. + +**Returns**: + - An attribute object that represents the `workspace_settings` sub block. + + ## obj default_user_settings.jupyter_server_app_settings diff --git a/docs/5.x/sagemaker_endpoint.md b/docs/5.x/sagemaker_endpoint.md index 7ba3ad61..880c7b2b 100644 --- a/docs/5.x/sagemaker_endpoint.md +++ b/docs/5.x/sagemaker_endpoint.md @@ -35,6 +35,12 @@ This package contains functions and utilities for setting up the resource using * [`fn new()`](#fn-deployment_configblue_green_update_policytraffic_routing_configurationcanary_sizenew) * [`obj deployment_config.blue_green_update_policy.traffic_routing_configuration.linear_step_size`](#obj-deployment_configblue_green_update_policytraffic_routing_configurationlinear_step_size) * [`fn new()`](#fn-deployment_configblue_green_update_policytraffic_routing_configurationlinear_step_sizenew) + * [`obj deployment_config.rolling_update_policy`](#obj-deployment_configrolling_update_policy) + * [`fn new()`](#fn-deployment_configrolling_update_policynew) + * [`obj deployment_config.rolling_update_policy.maximum_batch_size`](#obj-deployment_configrolling_update_policymaximum_batch_size) + * [`fn new()`](#fn-deployment_configrolling_update_policymaximum_batch_sizenew) + * [`obj deployment_config.rolling_update_policy.rollback_maximum_batch_size`](#obj-deployment_configrolling_update_policyrollback_maximum_batch_size) + * [`fn new()`](#fn-deployment_configrolling_update_policyrollback_maximum_batch_sizenew) ## Fields @@ -223,6 +229,7 @@ Terraform sub block. **Args**: - `auto_rollback_configuration` (`list[obj]`): Set the `auto_rollback_configuration` field on the resulting object. When `null`, the `auto_rollback_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.sagemaker_endpoint.deployment_config.auto_rollback_configuration.new](#fn-deployment_configauto_rollback_configurationnew) constructor. - `blue_green_update_policy` (`list[obj]`): Set the `blue_green_update_policy` field on the resulting object. When `null`, the `blue_green_update_policy` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [aws.sagemaker_endpoint.deployment_config.blue_green_update_policy.new](#fn-deployment_configblue_green_update_policynew) constructor. + - `rolling_update_policy` (`list[obj]`): Set the `rolling_update_policy` field on the resulting object. When `null`, the `rolling_update_policy` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [aws.sagemaker_endpoint.deployment_config.rolling_update_policy.new](#fn-deployment_configrolling_update_policynew) constructor. **Returns**: - An attribute object that represents the `deployment_config` sub block. @@ -371,3 +378,77 @@ Terraform sub block. **Returns**: - An attribute object that represents the `linear_step_size` sub block. + + +## obj deployment_config.rolling_update_policy + + + +### fn deployment_config.rolling_update_policy.new + +```ts +new() +``` + + +`aws.sagemaker_endpoint.deployment_config.rolling_update_policy.new` constructs a new object with attributes and blocks configured for the `rolling_update_policy` +Terraform sub block. + + + +**Args**: + - `maximum_execution_timeout_in_seconds` (`number`): Set the `maximum_execution_timeout_in_seconds` field on the resulting object. When `null`, the `maximum_execution_timeout_in_seconds` field will be omitted from the resulting object. + - `wait_interval_in_seconds` (`number`): Set the `wait_interval_in_seconds` field on the resulting object. + - `maximum_batch_size` (`list[obj]`): Set the `maximum_batch_size` field on the resulting object. When `null`, the `maximum_batch_size` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [aws.sagemaker_endpoint.deployment_config.rolling_update_policy.maximum_batch_size.new](#fn-deployment_configdeployment_configmaximum_batch_sizenew) constructor. + - `rollback_maximum_batch_size` (`list[obj]`): Set the `rollback_maximum_batch_size` field on the resulting object. When `null`, the `rollback_maximum_batch_size` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [aws.sagemaker_endpoint.deployment_config.rolling_update_policy.rollback_maximum_batch_size.new](#fn-deployment_configdeployment_configrollback_maximum_batch_sizenew) constructor. + +**Returns**: + - An attribute object that represents the `rolling_update_policy` sub block. + + +## obj deployment_config.rolling_update_policy.maximum_batch_size + + + +### fn deployment_config.rolling_update_policy.maximum_batch_size.new + +```ts +new() +``` + + +`aws.sagemaker_endpoint.deployment_config.rolling_update_policy.maximum_batch_size.new` constructs a new object with attributes and blocks configured for the `maximum_batch_size` +Terraform sub block. + + + +**Args**: + - `type` (`string`): Set the `type` field on the resulting object. + - `value` (`number`): Set the `value` field on the resulting object. + +**Returns**: + - An attribute object that represents the `maximum_batch_size` sub block. + + +## obj deployment_config.rolling_update_policy.rollback_maximum_batch_size + + + +### fn deployment_config.rolling_update_policy.rollback_maximum_batch_size.new + +```ts +new() +``` + + +`aws.sagemaker_endpoint.deployment_config.rolling_update_policy.rollback_maximum_batch_size.new` constructs a new object with attributes and blocks configured for the `rollback_maximum_batch_size` +Terraform sub block. + + + +**Args**: + - `type` (`string`): Set the `type` field on the resulting object. + - `value` (`number`): Set the `value` field on the resulting object. + +**Returns**: + - An attribute object that represents the `rollback_maximum_batch_size` sub block. diff --git a/docs/5.x/sagemaker_pipeline.md b/docs/5.x/sagemaker_pipeline.md new file mode 100644 index 00000000..3f7ed69f --- /dev/null +++ b/docs/5.x/sagemaker_pipeline.md @@ -0,0 +1,340 @@ +--- +permalink: /sagemaker_pipeline/ +--- + +# sagemaker_pipeline + +`sagemaker_pipeline` represents the `aws_sagemaker_pipeline` 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 withParallelismConfiguration()`](#fn-withparallelismconfiguration) +* [`fn withParallelismConfigurationMixin()`](#fn-withparallelismconfigurationmixin) +* [`fn withPipelineDefinition()`](#fn-withpipelinedefinition) +* [`fn withPipelineDefinitionS3Location()`](#fn-withpipelinedefinitions3location) +* [`fn withPipelineDefinitionS3LocationMixin()`](#fn-withpipelinedefinitions3locationmixin) +* [`fn withPipelineDescription()`](#fn-withpipelinedescription) +* [`fn withPipelineDisplayName()`](#fn-withpipelinedisplayname) +* [`fn withPipelineName()`](#fn-withpipelinename) +* [`fn withRoleArn()`](#fn-withrolearn) +* [`fn withTags()`](#fn-withtags) +* [`fn withTagsAll()`](#fn-withtagsall) +* [`obj parallelism_configuration`](#obj-parallelism_configuration) + * [`fn new()`](#fn-parallelism_configurationnew) +* [`obj pipeline_definition_s3_location`](#obj-pipeline_definition_s3_location) + * [`fn new()`](#fn-pipeline_definition_s3_locationnew) + +## Fields + +### fn new + +```ts +new() +``` + + +`aws.sagemaker_pipeline.new` injects a new `aws_sagemaker_pipeline` 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.sagemaker_pipeline.new('some_id') + +You can get the reference to the `id` field of the created `aws.sagemaker_pipeline` using the reference: + + $._ref.aws_sagemaker_pipeline.some_id.get('id') + +This is the same as directly entering `"${ aws_sagemaker_pipeline.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. + - `pipeline_definition` (`string`): Set the `pipeline_definition` field on the resulting resource block. When `null`, the `pipeline_definition` field will be omitted from the resulting object. + - `pipeline_description` (`string`): Set the `pipeline_description` field on the resulting resource block. When `null`, the `pipeline_description` field will be omitted from the resulting object. + - `pipeline_display_name` (`string`): Set the `pipeline_display_name` field on the resulting resource block. + - `pipeline_name` (`string`): Set the `pipeline_name` field on the resulting resource block. + - `role_arn` (`string`): Set the `role_arn` field on the resulting resource block. When `null`, the `role_arn` 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. + - `parallelism_configuration` (`list[obj]`): Set the `parallelism_configuration` field on the resulting resource block. When `null`, the `parallelism_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.sagemaker_pipeline.parallelism_configuration.new](#fn-parallelism_configurationnew) constructor. + - `pipeline_definition_s3_location` (`list[obj]`): Set the `pipeline_definition_s3_location` field on the resulting resource block. When `null`, the `pipeline_definition_s3_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.sagemaker_pipeline.pipeline_definition_s3_location.new](#fn-pipeline_definition_s3_locationnew) constructor. + +**Returns**: +- A mixin object that injects the new resource into the root Terraform configuration. + + +### fn newAttrs + +```ts +newAttrs() +``` + + +`aws.sagemaker_pipeline.newAttrs` constructs a new object with attributes and blocks configured for the `sagemaker_pipeline` +Terraform resource. + +Unlike [aws.sagemaker_pipeline.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**: + - `pipeline_definition` (`string`): Set the `pipeline_definition` field on the resulting object. When `null`, the `pipeline_definition` field will be omitted from the resulting object. + - `pipeline_description` (`string`): Set the `pipeline_description` field on the resulting object. When `null`, the `pipeline_description` field will be omitted from the resulting object. + - `pipeline_display_name` (`string`): Set the `pipeline_display_name` field on the resulting object. + - `pipeline_name` (`string`): Set the `pipeline_name` field on the resulting object. + - `role_arn` (`string`): Set the `role_arn` field on the resulting object. When `null`, the `role_arn` 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. + - `parallelism_configuration` (`list[obj]`): Set the `parallelism_configuration` field on the resulting object. When `null`, the `parallelism_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.sagemaker_pipeline.parallelism_configuration.new](#fn-parallelism_configurationnew) constructor. + - `pipeline_definition_s3_location` (`list[obj]`): Set the `pipeline_definition_s3_location` field on the resulting object. When `null`, the `pipeline_definition_s3_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.sagemaker_pipeline.pipeline_definition_s3_location.new](#fn-pipeline_definition_s3_locationnew) 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 `sagemaker_pipeline` resource into the root Terraform configuration. + + +### fn withParallelismConfiguration + +```ts +withParallelismConfiguration() +``` + +`aws.list[obj].withParallelismConfiguration` constructs a mixin object that can be merged into the `list[obj]` +Terraform resource block to set or update the parallelism_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].withParallelismConfigurationMixin](TODO) function. + + +**Args**: + - `resourceLabel` (`string`): The name label of the block to update. + - `value` (`list[obj]`): The value to set for the `parallelism_configuration` field. + + +### fn withParallelismConfigurationMixin + +```ts +withParallelismConfigurationMixin() +``` + +`aws.list[obj].withParallelismConfigurationMixin` constructs a mixin object that can be merged into the `list[obj]` +Terraform resource block to set or update the parallelism_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].withParallelismConfiguration](TODO) +function. + + +**Args**: + - `resourceLabel` (`string`): The name label of the block to update. + - `value` (`list[obj]`): The value to set for the `parallelism_configuration` field. + + +### fn withPipelineDefinition + +```ts +withPipelineDefinition() +``` + +`aws.string.withPipelineDefinition` constructs a mixin object that can be merged into the `string` +Terraform resource block to set or update the pipeline_definition field. + + + +**Args**: + - `resourceLabel` (`string`): The name label of the block to update. + - `value` (`string`): The value to set for the `pipeline_definition` field. + + +### fn withPipelineDefinitionS3Location + +```ts +withPipelineDefinitionS3Location() +``` + +`aws.list[obj].withPipelineDefinitionS3Location` constructs a mixin object that can be merged into the `list[obj]` +Terraform resource block to set or update the pipeline_definition_s3_location 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].withPipelineDefinitionS3LocationMixin](TODO) function. + + +**Args**: + - `resourceLabel` (`string`): The name label of the block to update. + - `value` (`list[obj]`): The value to set for the `pipeline_definition_s3_location` field. + + +### fn withPipelineDefinitionS3LocationMixin + +```ts +withPipelineDefinitionS3LocationMixin() +``` + +`aws.list[obj].withPipelineDefinitionS3LocationMixin` constructs a mixin object that can be merged into the `list[obj]` +Terraform resource block to set or update the pipeline_definition_s3_location 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].withPipelineDefinitionS3Location](TODO) +function. + + +**Args**: + - `resourceLabel` (`string`): The name label of the block to update. + - `value` (`list[obj]`): The value to set for the `pipeline_definition_s3_location` field. + + +### fn withPipelineDescription + +```ts +withPipelineDescription() +``` + +`aws.string.withPipelineDescription` constructs a mixin object that can be merged into the `string` +Terraform resource block to set or update the pipeline_description field. + + + +**Args**: + - `resourceLabel` (`string`): The name label of the block to update. + - `value` (`string`): The value to set for the `pipeline_description` field. + + +### fn withPipelineDisplayName + +```ts +withPipelineDisplayName() +``` + +`aws.string.withPipelineDisplayName` constructs a mixin object that can be merged into the `string` +Terraform resource block to set or update the pipeline_display_name field. + + + +**Args**: + - `resourceLabel` (`string`): The name label of the block to update. + - `value` (`string`): The value to set for the `pipeline_display_name` field. + + +### fn withPipelineName + +```ts +withPipelineName() +``` + +`aws.string.withPipelineName` constructs a mixin object that can be merged into the `string` +Terraform resource block to set or update the pipeline_name field. + + + +**Args**: + - `resourceLabel` (`string`): The name label of the block to update. + - `value` (`string`): The value to set for the `pipeline_name` field. + + +### 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 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 parallelism_configuration + + + +### fn parallelism_configuration.new + +```ts +new() +``` + + +`aws.sagemaker_pipeline.parallelism_configuration.new` constructs a new object with attributes and blocks configured for the `parallelism_configuration` +Terraform sub block. + + + +**Args**: + - `max_parallel_execution_steps` (`number`): Set the `max_parallel_execution_steps` field on the resulting object. + +**Returns**: + - An attribute object that represents the `parallelism_configuration` sub block. + + +## obj pipeline_definition_s3_location + + + +### fn pipeline_definition_s3_location.new + +```ts +new() +``` + + +`aws.sagemaker_pipeline.pipeline_definition_s3_location.new` constructs a new object with attributes and blocks configured for the `pipeline_definition_s3_location` +Terraform sub block. + + + +**Args**: + - `bucket` (`string`): Set the `bucket` field on the resulting object. + - `object_key` (`string`): Set the `object_key` field on the resulting object. + - `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. + +**Returns**: + - An attribute object that represents the `pipeline_definition_s3_location` sub block. diff --git a/docs/5.x/sagemaker_user_profile.md b/docs/5.x/sagemaker_user_profile.md index 3ed397e6..7099ab74 100644 --- a/docs/5.x/sagemaker_user_profile.md +++ b/docs/5.x/sagemaker_user_profile.md @@ -31,6 +31,8 @@ This package contains functions and utilities for setting up the resource using * [`fn new()`](#fn-user_settingscanvas_app_settingsmodel_register_settingsnew) * [`obj user_settings.canvas_app_settings.time_series_forecasting_settings`](#obj-user_settingscanvas_app_settingstime_series_forecasting_settings) * [`fn new()`](#fn-user_settingscanvas_app_settingstime_series_forecasting_settingsnew) + * [`obj user_settings.canvas_app_settings.workspace_settings`](#obj-user_settingscanvas_app_settingsworkspace_settings) + * [`fn new()`](#fn-user_settingscanvas_app_settingsworkspace_settingsnew) * [`obj user_settings.jupyter_server_app_settings`](#obj-user_settingsjupyter_server_app_settings) * [`fn new()`](#fn-user_settingsjupyter_server_app_settingsnew) * [`obj user_settings.jupyter_server_app_settings.code_repository`](#obj-user_settingsjupyter_server_app_settingscode_repository) @@ -312,6 +314,7 @@ Terraform sub block. **Args**: - `model_register_settings` (`list[obj]`): Set the `model_register_settings` field on the resulting object. When `null`, the `model_register_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.sagemaker_user_profile.user_settings.canvas_app_settings.model_register_settings.new](#fn-user_settingsuser_settingsmodel_register_settingsnew) constructor. - `time_series_forecasting_settings` (`list[obj]`): Set the `time_series_forecasting_settings` field on the resulting object. When `null`, the `time_series_forecasting_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.sagemaker_user_profile.user_settings.canvas_app_settings.time_series_forecasting_settings.new](#fn-user_settingsuser_settingstime_series_forecasting_settingsnew) constructor. + - `workspace_settings` (`list[obj]`): Set the `workspace_settings` field on the resulting object. When `null`, the `workspace_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.sagemaker_user_profile.user_settings.canvas_app_settings.workspace_settings.new](#fn-user_settingsuser_settingsworkspace_settingsnew) constructor. **Returns**: - An attribute object that represents the `canvas_app_settings` sub block. @@ -365,6 +368,30 @@ Terraform sub block. - An attribute object that represents the `time_series_forecasting_settings` sub block. +## obj user_settings.canvas_app_settings.workspace_settings + + + +### fn user_settings.canvas_app_settings.workspace_settings.new + +```ts +new() +``` + + +`aws.sagemaker_user_profile.user_settings.canvas_app_settings.workspace_settings.new` constructs a new object with attributes and blocks configured for the `workspace_settings` +Terraform sub block. + + + +**Args**: + - `s3_artifact_path` (`string`): Set the `s3_artifact_path` field on the resulting object. When `null`, the `s3_artifact_path` field will be omitted from the resulting object. + - `s3_kms_key_id` (`string`): Set the `s3_kms_key_id` field on the resulting object. When `null`, the `s3_kms_key_id` field will be omitted from the resulting object. + +**Returns**: + - An attribute object that represents the `workspace_settings` sub block. + + ## obj user_settings.jupyter_server_app_settings diff --git a/docs/5.x/transfer_server.md b/docs/5.x/transfer_server.md index c50fae73..94de8b3d 100644 --- a/docs/5.x/transfer_server.md +++ b/docs/5.x/transfer_server.md @@ -33,6 +33,7 @@ This package contains functions and utilities for setting up the resource using * [`fn withProtocolDetailsMixin()`](#fn-withprotocoldetailsmixin) * [`fn withProtocols()`](#fn-withprotocols) * [`fn withSecurityPolicyName()`](#fn-withsecuritypolicyname) +* [`fn withStructuredLogDestinations()`](#fn-withstructuredlogdestinations) * [`fn withTags()`](#fn-withtags) * [`fn withTagsAll()`](#fn-withtagsall) * [`fn withUrl()`](#fn-withurl) @@ -92,6 +93,7 @@ or `$` to refer to the root object. Instead, make an explicit outer object using - `pre_authentication_login_banner` (`string`): Set the `pre_authentication_login_banner` field on the resulting resource block. When `null`, the `pre_authentication_login_banner` field will be omitted from the resulting object. - `protocols` (`list`): Set the `protocols` field on the resulting resource block. When `null`, the `protocols` field will be omitted from the resulting object. - `security_policy_name` (`string`): Set the `security_policy_name` field on the resulting resource block. When `null`, the `security_policy_name` field will be omitted from the resulting object. + - `structured_log_destinations` (`list`): This is a set of arns of destinations that will receive structured logs from the transfer server When `null`, the `structured_log_destinations` 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. - `url` (`string`): Set the `url` field on the resulting resource block. When `null`, the `url` field will be omitted from the resulting object. @@ -135,6 +137,7 @@ injecting into a complete block. - `pre_authentication_login_banner` (`string`): Set the `pre_authentication_login_banner` field on the resulting object. When `null`, the `pre_authentication_login_banner` field will be omitted from the resulting object. - `protocols` (`list`): Set the `protocols` field on the resulting object. When `null`, the `protocols` field will be omitted from the resulting object. - `security_policy_name` (`string`): Set the `security_policy_name` field on the resulting object. When `null`, the `security_policy_name` field will be omitted from the resulting object. + - `structured_log_destinations` (`list`): This is a set of arns of destinations that will receive structured logs from the transfer server When `null`, the `structured_log_destinations` 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. - `url` (`string`): Set the `url` field on the resulting object. When `null`, the `url` field will be omitted from the resulting object. @@ -444,6 +447,22 @@ Terraform resource block to set or update the security_policy_name field. - `value` (`string`): The value to set for the `security_policy_name` field. +### fn withStructuredLogDestinations + +```ts +withStructuredLogDestinations() +``` + +`aws.list.withStructuredLogDestinations` constructs a mixin object that can be merged into the `list` +Terraform resource block to set or update the structured_log_destinations field. + + + +**Args**: + - `resourceLabel` (`string`): The name label of the block to update. + - `value` (`list`): The value to set for the `structured_log_destinations` field. + + ### fn withTags ```ts