From 68c44ace984fd163c33ad6f14833b9b320bf2191 Mon Sep 17 00:00:00 2001 From: "renovate[bot]" Date: Fri, 8 Dec 2023 02:03:59 +0000 Subject: [PATCH] Generate libsonnet source from libgenerator PR https://github.com/tf-libsonnet/libgenerator/pull/238 Signed-off-by: tflibsonnet-ci <120686569+tflibsonnet-ci@users.noreply.github.com> --- ...codeguruprofiler_profiling_group.libsonnet | 32 + 5.x/_gen/data/ecr_repositories.libsonnet | 19 + 5.x/_gen/data/lb_trust_store.libsonnet | 45 ++ 5.x/_gen/data/main.libsonnet | 5 + 5.x/_gen/data/ssoadmin_application.libsonnet | 69 ++ .../ssoadmin_application_providers.libsonnet | 56 ++ 5.x/_gen/main.libsonnet | 9 + 5.x/_gen/provider_aws.libsonnet | 4 +- 5.x/_gen/resources/alb.libsonnet | 18 +- 5.x/_gen/resources/alb_listener.libsonnet | 48 +- .../appconfig_configuration_profile.libsonnet | 18 +- .../resources/appconfig_deployment.libsonnet | 18 +- 5.x/_gen/resources/appflow_flow.libsonnet | 4 +- .../resources/cloudwatch_log_group.libsonnet | 18 +- ...codeguruprofiler_profiling_group.libsonnet | 94 +++ .../customerprofiles_domain.libsonnet | 298 ++++++++ .../customerprofiles_profile.libsonnet | 472 ++++++++++++ 5.x/_gen/resources/lb.libsonnet | 18 +- 5.x/_gen/resources/lb_listener.libsonnet | 48 +- 5.x/_gen/resources/lb_trust_store.libsonnet | 152 ++++ .../lb_trust_store_revocation.libsonnet | 108 +++ 5.x/_gen/resources/sagemaker_app.libsonnet | 4 +- .../sagemaker_app_image_config.libsonnet | 48 +- 5.x/_gen/resources/sagemaker_domain.libsonnet | 166 +++- 5.x/_gen/resources/sagemaker_space.libsonnet | 26 +- .../sagemaker_user_profile.libsonnet | 154 +++- .../securitylake_data_lake.libsonnet | 160 ++++ .../resources/ssoadmin_application.libsonnet | 162 ++++ .../ssoadmin_application_assignment.libsonnet | 58 ++ ...ication_assignment_configuration.libsonnet | 45 ++ docs/5.x/README.md | 9 + docs/5.x/alb.md | 19 + docs/5.x/alb_listener.md | 71 +- docs/5.x/appconfig_configuration_profile.md | 19 + docs/5.x/appconfig_deployment.md | 19 + docs/5.x/appflow_flow.md | 2 +- docs/5.x/cloudwatch_log_group.md | 19 + docs/5.x/codeguruprofiler_profiling_group.md | 196 +++++ docs/5.x/customerprofiles_domain.md | 615 +++++++++++++++ docs/5.x/customerprofiles_profile.md | 715 ++++++++++++++++++ .../data/codeguruprofiler_profiling_group.md | 92 +++ docs/5.x/data/ecr_repositories.md | 71 ++ docs/5.x/data/index.md | 5 + docs/5.x/data/lb_trust_store.md | 111 +++ docs/5.x/data/ssoadmin_application.md | 180 +++++ .../data/ssoadmin_application_providers.md | 161 ++++ docs/5.x/lb.md | 19 + docs/5.x/lb_listener.md | 71 +- docs/5.x/lb_trust_store.md | 272 +++++++ docs/5.x/lb_trust_store_revocation.md | 214 ++++++ docs/5.x/provider.md | 1 + docs/5.x/sagemaker_app.md | 1 + docs/5.x/sagemaker_app_image_config.md | 93 +++ docs/5.x/sagemaker_domain.md | 306 ++++++++ docs/5.x/sagemaker_space.md | 21 + docs/5.x/sagemaker_user_profile.md | 303 ++++++++ docs/5.x/securitylake_data_lake.md | 350 +++++++++ docs/5.x/ssoadmin_application.md | 299 ++++++++ docs/5.x/ssoadmin_application_assignment.md | 130 ++++ ...in_application_assignment_configuration.md | 111 +++ 60 files changed, 6825 insertions(+), 46 deletions(-) create mode 100644 5.x/_gen/data/codeguruprofiler_profiling_group.libsonnet create mode 100644 5.x/_gen/data/ecr_repositories.libsonnet create mode 100644 5.x/_gen/data/lb_trust_store.libsonnet create mode 100644 5.x/_gen/data/ssoadmin_application.libsonnet create mode 100644 5.x/_gen/data/ssoadmin_application_providers.libsonnet create mode 100644 5.x/_gen/resources/codeguruprofiler_profiling_group.libsonnet create mode 100644 5.x/_gen/resources/customerprofiles_domain.libsonnet create mode 100644 5.x/_gen/resources/customerprofiles_profile.libsonnet create mode 100644 5.x/_gen/resources/lb_trust_store.libsonnet create mode 100644 5.x/_gen/resources/lb_trust_store_revocation.libsonnet create mode 100644 5.x/_gen/resources/securitylake_data_lake.libsonnet create mode 100644 5.x/_gen/resources/ssoadmin_application.libsonnet create mode 100644 5.x/_gen/resources/ssoadmin_application_assignment.libsonnet create mode 100644 5.x/_gen/resources/ssoadmin_application_assignment_configuration.libsonnet create mode 100644 docs/5.x/codeguruprofiler_profiling_group.md create mode 100644 docs/5.x/customerprofiles_domain.md create mode 100644 docs/5.x/customerprofiles_profile.md create mode 100644 docs/5.x/data/codeguruprofiler_profiling_group.md create mode 100644 docs/5.x/data/ecr_repositories.md create mode 100644 docs/5.x/data/lb_trust_store.md create mode 100644 docs/5.x/data/ssoadmin_application.md create mode 100644 docs/5.x/data/ssoadmin_application_providers.md create mode 100644 docs/5.x/lb_trust_store.md create mode 100644 docs/5.x/lb_trust_store_revocation.md create mode 100644 docs/5.x/securitylake_data_lake.md create mode 100644 docs/5.x/ssoadmin_application.md create mode 100644 docs/5.x/ssoadmin_application_assignment.md create mode 100644 docs/5.x/ssoadmin_application_assignment_configuration.md diff --git a/5.x/_gen/data/codeguruprofiler_profiling_group.libsonnet b/5.x/_gen/data/codeguruprofiler_profiling_group.libsonnet new file mode 100644 index 00000000..cf56de6d --- /dev/null +++ b/5.x/_gen/data/codeguruprofiler_profiling_group.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='codeguruprofiler_profiling_group', url='', help='`codeguruprofiler_profiling_group` represents the `aws_codeguruprofiler_profiling_group` 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.codeguruprofiler_profiling_group.new` injects a new `data_aws_codeguruprofiler_profiling_group` Terraform `data source`\nblock into the root module document.\n\nAdditionally, this inserts a private function into the `_ref` attribute that generates references to attributes of the\nresource. For example, if you added a new instance to the root using:\n\n # arguments omitted for brevity\n aws.data.codeguruprofiler_profiling_group.new('some_id')\n\nYou can get the reference to the `id` field of the created `aws.data.codeguruprofiler_profiling_group` using the reference:\n\n $._ref.data_aws_codeguruprofiler_profiling_group.some_id.get('id')\n\nThis is the same as directly entering `\"${ data_aws_codeguruprofiler_profiling_group.some_id.id }\"` as the value.\n\nNOTE: if you are chaining multiple resources together in a merge operation, you may not be able to use `super`, `self`,\nor `$` to refer to the root object. Instead, make an explicit outer object using `local`.\n\n**Args**:\n - `dataSrcLabel` (`string`): The name label of the block.\n - `name` (`string`): Set the `name` field on the resulting data source block.\n\n**Returns**:\n- A mixin object that injects the new data source into the root Terraform configuration.\n", args=[]), + new( + dataSrcLabel, + name, + _meta={} + ):: tf.withData( + type='aws_codeguruprofiler_profiling_group', + label=dataSrcLabel, + attrs=self.newAttrs(name=name), + _meta=_meta + ), + '#newAttrs':: d.fn(help='\n`aws.data.codeguruprofiler_profiling_group.newAttrs` constructs a new object with attributes and blocks configured for the `codeguruprofiler_profiling_group`\nTerraform data source.\n\nUnlike [aws.data.codeguruprofiler_profiling_group.new](#fn-new), this function will not inject the `data source`\nblock into the root Terraform document. Instead, this must be passed in as the `attrs` argument for the\n[tf.withData](https://github.com/tf-libsonnet/core/tree/main/docs#fn-withdata) function to build a complete block.\n\nThis is most useful when you need to preprocess the attributes with functions, conditional, or looping logic prior to\ninjecting into a complete block.\n\n**Args**:\n - `name` (`string`): Set the `name` field on 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 `codeguruprofiler_profiling_group` data source into the root Terraform configuration.\n', args=[]), + newAttrs( + name + ):: std.prune(a={ + name: name, + }), + '#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_codeguruprofiler_profiling_group+: { + [dataSrcLabel]+: { + name: value, + }, + }, + }, + }, +} diff --git a/5.x/_gen/data/ecr_repositories.libsonnet b/5.x/_gen/data/ecr_repositories.libsonnet new file mode 100644 index 00000000..19eb548d --- /dev/null +++ b/5.x/_gen/data/ecr_repositories.libsonnet @@ -0,0 +1,19 @@ +local tf = (import 'github.com/tf-libsonnet/core/main.libsonnet'); +local d = (import 'github.com/jsonnet-libs/docsonnet/doc-util/main.libsonnet'); +{ + '#':: d.pkg(name='ecr_repositories', url='', help='`ecr_repositories` represents the `aws_ecr_repositories` 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.ecr_repositories.new` injects a new `data_aws_ecr_repositories` 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.ecr_repositories.new('some_id')\n\nYou can get the reference to the `id` field of the created `aws.data.ecr_repositories` using the reference:\n\n $._ref.data_aws_ecr_repositories.some_id.get('id')\n\nThis is the same as directly entering `\"${ data_aws_ecr_repositories.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\n**Returns**:\n- A mixin object that injects the new data source into the root Terraform configuration.\n", args=[]), + new( + dataSrcLabel, + _meta={} + ):: tf.withData( + type='aws_ecr_repositories', + label=dataSrcLabel, + attrs=self.newAttrs(), + _meta=_meta + ), + '#newAttrs':: d.fn(help='\n`aws.data.ecr_repositories.newAttrs` constructs a new object with attributes and blocks configured for the `ecr_repositories`\nTerraform data source.\n\nUnlike [aws.data.ecr_repositories.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**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 `ecr_repositories` data source into the root Terraform configuration.\n', args=[]), + newAttrs( + + ):: std.prune(a={}), +} diff --git a/5.x/_gen/data/lb_trust_store.libsonnet b/5.x/_gen/data/lb_trust_store.libsonnet new file mode 100644 index 00000000..2066359a --- /dev/null +++ b/5.x/_gen/data/lb_trust_store.libsonnet @@ -0,0 +1,45 @@ +local tf = (import 'github.com/tf-libsonnet/core/main.libsonnet'); +local d = (import 'github.com/jsonnet-libs/docsonnet/doc-util/main.libsonnet'); +{ + '#':: d.pkg(name='lb_trust_store', url='', help='`lb_trust_store` represents the `aws_lb_trust_store` 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.lb_trust_store.new` injects a new `data_aws_lb_trust_store` 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.lb_trust_store.new('some_id')\n\nYou can get the reference to the `id` field of the created `aws.data.lb_trust_store` using the reference:\n\n $._ref.data_aws_lb_trust_store.some_id.get('id')\n\nThis is the same as directly entering `\"${ data_aws_lb_trust_store.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 - `arn` (`string`): Set the `arn` field on the resulting data source block. When `null`, the `arn` field will be omitted from the resulting object.\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\n**Returns**:\n- A mixin object that injects the new data source into the root Terraform configuration.\n", args=[]), + new( + dataSrcLabel, + arn=null, + name=null, + _meta={} + ):: tf.withData( + type='aws_lb_trust_store', + label=dataSrcLabel, + attrs=self.newAttrs(arn=arn, name=name), + _meta=_meta + ), + '#newAttrs':: d.fn(help='\n`aws.data.lb_trust_store.newAttrs` constructs a new object with attributes and blocks configured for the `lb_trust_store`\nTerraform data source.\n\nUnlike [aws.data.lb_trust_store.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 - `arn` (`string`): Set the `arn` field on the resulting object. When `null`, the `arn` field will be omitted from the resulting object.\n - `name` (`string`): Set the `name` field on the resulting object. When `null`, the `name` field will be omitted from the resulting object.\n\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 `lb_trust_store` data source into the root Terraform configuration.\n', args=[]), + newAttrs( + arn=null, + name=null + ):: std.prune(a={ + arn: arn, + name: name, + }), + '#withArn':: d.fn(help='`aws.string.withArn` constructs a mixin object that can be merged into the `string`\nTerraform data source block to set or update the arn 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 `arn` field.\n', args=[]), + withArn(dataSrcLabel, value): { + data+: { + aws_lb_trust_store+: { + [dataSrcLabel]+: { + arn: value, + }, + }, + }, + }, + '#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_lb_trust_store+: { + [dataSrcLabel]+: { + name: value, + }, + }, + }, + }, +} diff --git a/5.x/_gen/data/main.libsonnet b/5.x/_gen/data/main.libsonnet index ae10f097..5b8c7508 100644 --- a/5.x/_gen/data/main.libsonnet +++ b/5.x/_gen/data/main.libsonnet @@ -84,6 +84,7 @@ local d = (import 'github.com/jsonnet-libs/docsonnet/doc-util/main.libsonnet'); codecatalyst_dev_environment: (import 'codecatalyst_dev_environment.libsonnet'), codecommit_approval_rule_template: (import 'codecommit_approval_rule_template.libsonnet'), codecommit_repository: (import 'codecommit_repository.libsonnet'), + codeguruprofiler_profiling_group: (import 'codeguruprofiler_profiling_group.libsonnet'), codestarconnections_connection: (import 'codestarconnections_connection.libsonnet'), cognito_identity_pool: (import 'cognito_identity_pool.libsonnet'), cognito_user_pool_client: (import 'cognito_user_pool_client.libsonnet'), @@ -182,6 +183,7 @@ local d = (import 'github.com/jsonnet-libs/docsonnet/doc-util/main.libsonnet'); ecr_authorization_token: (import 'ecr_authorization_token.libsonnet'), ecr_image: (import 'ecr_image.libsonnet'), ecr_pull_through_cache_rule: (import 'ecr_pull_through_cache_rule.libsonnet'), + ecr_repositories: (import 'ecr_repositories.libsonnet'), ecr_repository: (import 'ecr_repository.libsonnet'), ecrpublic_authorization_token: (import 'ecrpublic_authorization_token.libsonnet'), ecs_cluster: (import 'ecs_cluster.libsonnet'), @@ -302,6 +304,7 @@ local d = (import 'github.com/jsonnet-libs/docsonnet/doc-util/main.libsonnet'); lb_hosted_zone_id: (import 'lb_hosted_zone_id.libsonnet'), lb_listener: (import 'lb_listener.libsonnet'), lb_target_group: (import 'lb_target_group.libsonnet'), + lb_trust_store: (import 'lb_trust_store.libsonnet'), lbs: (import 'lbs.libsonnet'), lex_bot: (import 'lex_bot.libsonnet'), lex_bot_alias: (import 'lex_bot_alias.libsonnet'), @@ -486,6 +489,8 @@ local d = (import 'github.com/jsonnet-libs/docsonnet/doc-util/main.libsonnet'); ssmcontacts_plan: (import 'ssmcontacts_plan.libsonnet'), ssmincidents_replication_set: (import 'ssmincidents_replication_set.libsonnet'), ssmincidents_response_plan: (import 'ssmincidents_response_plan.libsonnet'), + ssoadmin_application: (import 'ssoadmin_application.libsonnet'), + ssoadmin_application_providers: (import 'ssoadmin_application_providers.libsonnet'), ssoadmin_instances: (import 'ssoadmin_instances.libsonnet'), ssoadmin_permission_set: (import 'ssoadmin_permission_set.libsonnet'), storagegateway_local_disk: (import 'storagegateway_local_disk.libsonnet'), diff --git a/5.x/_gen/data/ssoadmin_application.libsonnet b/5.x/_gen/data/ssoadmin_application.libsonnet new file mode 100644 index 00000000..1a47959d --- /dev/null +++ b/5.x/_gen/data/ssoadmin_application.libsonnet @@ -0,0 +1,69 @@ +local tf = (import 'github.com/tf-libsonnet/core/main.libsonnet'); +local d = (import 'github.com/jsonnet-libs/docsonnet/doc-util/main.libsonnet'); +{ + '#':: d.pkg(name='ssoadmin_application', url='', help='`ssoadmin_application` represents the `aws_ssoadmin_application` 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.ssoadmin_application.new` injects a new `data_aws_ssoadmin_application` 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.ssoadmin_application.new('some_id')\n\nYou can get the reference to the `id` field of the created `aws.data.ssoadmin_application` using the reference:\n\n $._ref.data_aws_ssoadmin_application.some_id.get('id')\n\nThis is the same as directly entering `\"${ data_aws_ssoadmin_application.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 - `application_arn` (`string`): Set the `application_arn` field on the resulting data source block.\n - `portal_options` (`list[obj]`): Set the `portal_options` field on the resulting data source block. When `null`, the `portal_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.data.ssoadmin_application.portal_options.new](#fn-portal_optionsnew) constructor.\n\n**Returns**:\n- A mixin object that injects the new data source into the root Terraform configuration.\n", args=[]), + new( + dataSrcLabel, + application_arn, + portal_options=null, + _meta={} + ):: tf.withData( + type='aws_ssoadmin_application', + label=dataSrcLabel, + attrs=self.newAttrs(application_arn=application_arn, portal_options=portal_options), + _meta=_meta + ), + '#newAttrs':: d.fn(help='\n`aws.data.ssoadmin_application.newAttrs` constructs a new object with attributes and blocks configured for the `ssoadmin_application`\nTerraform data source.\n\nUnlike [aws.data.ssoadmin_application.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 - `application_arn` (`string`): Set the `application_arn` field on the resulting object.\n - `portal_options` (`list[obj]`): Set the `portal_options` field on the resulting object. When `null`, the `portal_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.data.ssoadmin_application.portal_options.new](#fn-portal_optionsnew) 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 `ssoadmin_application` data source into the root Terraform configuration.\n', args=[]), + newAttrs( + application_arn, + portal_options=null + ):: std.prune(a={ + application_arn: application_arn, + portal_options: portal_options, + }), + portal_options:: { + '#new':: d.fn(help='\n`aws.ssoadmin_application.portal_options.new` constructs a new object with attributes and blocks configured for the `portal_options`\nTerraform sub block.\n\n\n\n**Args**:\n - `sign_in_options` (`list[obj]`): Set the `sign_in_options` field on the resulting object. When `null`, the `sign_in_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.ssoadmin_application.portal_options.sign_in_options.new](#fn-portal_optionssign_in_optionsnew) constructor.\n\n**Returns**:\n - An attribute object that represents the `portal_options` sub block.\n', args=[]), + new( + sign_in_options=null + ):: std.prune(a={ + sign_in_options: sign_in_options, + }), + sign_in_options:: { + '#new':: d.fn(help='\n`aws.ssoadmin_application.portal_options.sign_in_options.new` constructs a new object with attributes and blocks configured for the `sign_in_options`\nTerraform sub block.\n\n\n\n**Returns**:\n - An attribute object that represents the `sign_in_options` sub block.\n', args=[]), + new( + + ):: std.prune(a={}), + }, + }, + '#withApplicationArn':: d.fn(help='`aws.string.withApplicationArn` constructs a mixin object that can be merged into the `string`\nTerraform data source block to set or update the application_arn 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 `application_arn` field.\n', args=[]), + withApplicationArn(dataSrcLabel, value): { + data+: { + aws_ssoadmin_application+: { + [dataSrcLabel]+: { + application_arn: value, + }, + }, + }, + }, + '#withPortalOptions':: d.fn(help='`aws.list[obj].withPortalOptions` constructs a mixin object that can be merged into the `list[obj]`\nTerraform data source block to set or update the portal_options field.\n\nThis function will replace the array with the passed in `value`. If you wish to instead append the\npassed in value to the existing array, use the [aws.list[obj].withPortalOptionsMixin](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 `portal_options` field.\n', args=[]), + withPortalOptions(dataSrcLabel, value): { + data+: { + aws_ssoadmin_application+: { + [dataSrcLabel]+: { + portal_options: value, + }, + }, + }, + }, + '#withPortalOptionsMixin':: d.fn(help='`aws.list[obj].withPortalOptionsMixin` constructs a mixin object that can be merged into the `list[obj]`\nTerraform data source block to set or update the portal_options field.\n\nThis function will append the passed in array or object to the existing array. If you wish\nto instead replace the array with the passed in `value`, use the [aws.list[obj].withPortalOptions](TODO)\nfunction.\n\n\n**Args**:\n - `dataSrcLabel` (`string`): The name label of the block to update.\n - `value` (`list[obj]`): The value to set for the `portal_options` field.\n', args=[]), + withPortalOptionsMixin(dataSrcLabel, value): { + data+: { + aws_ssoadmin_application+: { + [dataSrcLabel]+: { + portal_options+: if std.isArray(v=value) then value else [value], + }, + }, + }, + }, +} diff --git a/5.x/_gen/data/ssoadmin_application_providers.libsonnet b/5.x/_gen/data/ssoadmin_application_providers.libsonnet new file mode 100644 index 00000000..a5d1e368 --- /dev/null +++ b/5.x/_gen/data/ssoadmin_application_providers.libsonnet @@ -0,0 +1,56 @@ +local tf = (import 'github.com/tf-libsonnet/core/main.libsonnet'); +local d = (import 'github.com/jsonnet-libs/docsonnet/doc-util/main.libsonnet'); +{ + '#':: d.pkg(name='ssoadmin_application_providers', url='', help='`ssoadmin_application_providers` represents the `aws_ssoadmin_application_providers` Terraform data source.\n\n\n\nThis package contains functions and utilities for setting up the data source using Jsonnet code.\n'), + application_providers:: { + display_data:: { + '#new':: d.fn(help='\n`aws.ssoadmin_application_providers.application_providers.display_data.new` constructs a new object with attributes and blocks configured for the `display_data`\nTerraform sub block.\n\n\n\n**Returns**:\n - An attribute object that represents the `display_data` sub block.\n', args=[]), + new( + + ):: std.prune(a={}), + }, + '#new':: d.fn(help='\n`aws.ssoadmin_application_providers.application_providers.new` constructs a new object with attributes and blocks configured for the `application_providers`\nTerraform sub block.\n\n\n\n**Args**:\n - `display_data` (`list[obj]`): Set the `display_data` field on the resulting object. When `null`, the `display_data` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [aws.ssoadmin_application_providers.application_providers.display_data.new](#fn-application_providersdisplay_datanew) constructor.\n\n**Returns**:\n - An attribute object that represents the `application_providers` sub block.\n', args=[]), + new( + display_data=null + ):: std.prune(a={ + display_data: display_data, + }), + }, + '#new':: d.fn(help="\n`aws.data.ssoadmin_application_providers.new` injects a new `data_aws_ssoadmin_application_providers` 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.ssoadmin_application_providers.new('some_id')\n\nYou can get the reference to the `id` field of the created `aws.data.ssoadmin_application_providers` using the reference:\n\n $._ref.data_aws_ssoadmin_application_providers.some_id.get('id')\n\nThis is the same as directly entering `\"${ data_aws_ssoadmin_application_providers.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 - `application_providers` (`list[obj]`): Set the `application_providers` field on the resulting data source block. When `null`, the `application_providers` 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.ssoadmin_application_providers.application_providers.new](#fn-application_providersnew) constructor.\n\n**Returns**:\n- A mixin object that injects the new data source into the root Terraform configuration.\n", args=[]), + new( + dataSrcLabel, + application_providers=null, + _meta={} + ):: tf.withData( + type='aws_ssoadmin_application_providers', + label=dataSrcLabel, + attrs=self.newAttrs(application_providers=application_providers), + _meta=_meta + ), + '#newAttrs':: d.fn(help='\n`aws.data.ssoadmin_application_providers.newAttrs` constructs a new object with attributes and blocks configured for the `ssoadmin_application_providers`\nTerraform data source.\n\nUnlike [aws.data.ssoadmin_application_providers.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 - `application_providers` (`list[obj]`): Set the `application_providers` field on the resulting object. When `null`, the `application_providers` 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.ssoadmin_application_providers.application_providers.new](#fn-application_providersnew) 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 `ssoadmin_application_providers` data source into the root Terraform configuration.\n', args=[]), + newAttrs( + application_providers=null + ):: std.prune(a={ + application_providers: application_providers, + }), + '#withApplicationProviders':: d.fn(help='`aws.list[obj].withApplicationProviders` constructs a mixin object that can be merged into the `list[obj]`\nTerraform data source block to set or update the application_providers 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].withApplicationProvidersMixin](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 `application_providers` field.\n', args=[]), + withApplicationProviders(dataSrcLabel, value): { + data+: { + aws_ssoadmin_application_providers+: { + [dataSrcLabel]+: { + application_providers: value, + }, + }, + }, + }, + '#withApplicationProvidersMixin':: d.fn(help='`aws.list[obj].withApplicationProvidersMixin` constructs a mixin object that can be merged into the `list[obj]`\nTerraform data source block to set or update the application_providers 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].withApplicationProviders](TODO)\nfunction.\n\n\n**Args**:\n - `dataSrcLabel` (`string`): The name label of the block to update.\n - `value` (`list[obj]`): The value to set for the `application_providers` field.\n', args=[]), + withApplicationProvidersMixin(dataSrcLabel, value): { + data+: { + aws_ssoadmin_application_providers+: { + [dataSrcLabel]+: { + application_providers+: if std.isArray(v=value) then value else [value], + }, + }, + }, + }, +} diff --git a/5.x/_gen/main.libsonnet b/5.x/_gen/main.libsonnet index 2aa321ef..031a8aa4 100644 --- a/5.x/_gen/main.libsonnet +++ b/5.x/_gen/main.libsonnet @@ -237,6 +237,7 @@ local d = (import 'github.com/jsonnet-libs/docsonnet/doc-util/main.libsonnet'); codedeploy_app: (import 'resources/codedeploy_app.libsonnet'), codedeploy_deployment_config: (import 'resources/codedeploy_deployment_config.libsonnet'), codedeploy_deployment_group: (import 'resources/codedeploy_deployment_group.libsonnet'), + codeguruprofiler_profiling_group: (import 'resources/codeguruprofiler_profiling_group.libsonnet'), codegurureviewer_repository_association: (import 'resources/codegurureviewer_repository_association.libsonnet'), codepipeline: (import 'resources/codepipeline.libsonnet'), codepipeline_custom_action_type: (import 'resources/codepipeline_custom_action_type.libsonnet'), @@ -291,6 +292,8 @@ local d = (import 'github.com/jsonnet-libs/docsonnet/doc-util/main.libsonnet'); controltower_control: (import 'resources/controltower_control.libsonnet'), cur_report_definition: (import 'resources/cur_report_definition.libsonnet'), customer_gateway: (import 'resources/customer_gateway.libsonnet'), + customerprofiles_domain: (import 'resources/customerprofiles_domain.libsonnet'), + customerprofiles_profile: (import 'resources/customerprofiles_profile.libsonnet'), dataexchange_data_set: (import 'resources/dataexchange_data_set.libsonnet'), dataexchange_revision: (import 'resources/dataexchange_revision.libsonnet'), datapipeline_pipeline: (import 'resources/datapipeline_pipeline.libsonnet'), @@ -700,6 +703,8 @@ local d = (import 'github.com/jsonnet-libs/docsonnet/doc-util/main.libsonnet'); lb_ssl_negotiation_policy: (import 'resources/lb_ssl_negotiation_policy.libsonnet'), lb_target_group: (import 'resources/lb_target_group.libsonnet'), lb_target_group_attachment: (import 'resources/lb_target_group_attachment.libsonnet'), + lb_trust_store: (import 'resources/lb_trust_store.libsonnet'), + lb_trust_store_revocation: (import 'resources/lb_trust_store_revocation.libsonnet'), lex_bot: (import 'resources/lex_bot.libsonnet'), lex_bot_alias: (import 'resources/lex_bot_alias.libsonnet'), lex_intent: (import 'resources/lex_intent.libsonnet'), @@ -1074,6 +1079,7 @@ local d = (import 'github.com/jsonnet-libs/docsonnet/doc-util/main.libsonnet'); securityhub_product_subscription: (import 'resources/securityhub_product_subscription.libsonnet'), securityhub_standards_control: (import 'resources/securityhub_standards_control.libsonnet'), securityhub_standards_subscription: (import 'resources/securityhub_standards_subscription.libsonnet'), + securitylake_data_lake: (import 'resources/securitylake_data_lake.libsonnet'), serverlessapplicationrepository_cloudformation_stack: (import 'resources/serverlessapplicationrepository_cloudformation_stack.libsonnet'), service_discovery_http_namespace: (import 'resources/service_discovery_http_namespace.libsonnet'), service_discovery_instance: (import 'resources/service_discovery_instance.libsonnet'), @@ -1164,6 +1170,9 @@ local d = (import 'github.com/jsonnet-libs/docsonnet/doc-util/main.libsonnet'); ssmincidents_replication_set: (import 'resources/ssmincidents_replication_set.libsonnet'), ssmincidents_response_plan: (import 'resources/ssmincidents_response_plan.libsonnet'), ssoadmin_account_assignment: (import 'resources/ssoadmin_account_assignment.libsonnet'), + ssoadmin_application: (import 'resources/ssoadmin_application.libsonnet'), + ssoadmin_application_assignment: (import 'resources/ssoadmin_application_assignment.libsonnet'), + ssoadmin_application_assignment_configuration: (import 'resources/ssoadmin_application_assignment_configuration.libsonnet'), ssoadmin_customer_managed_policy_attachment: (import 'resources/ssoadmin_customer_managed_policy_attachment.libsonnet'), ssoadmin_instance_access_control_attributes: (import 'resources/ssoadmin_instance_access_control_attributes.libsonnet'), ssoadmin_managed_policy_attachment: (import 'resources/ssoadmin_managed_policy_attachment.libsonnet'), diff --git a/5.x/_gen/provider_aws.libsonnet b/5.x/_gen/provider_aws.libsonnet index a241cd60..ee134b1b 100644 --- a/5.x/_gen/provider_aws.libsonnet +++ b/5.x/_gen/provider_aws.libsonnet @@ -200,7 +200,7 @@ local d = (import 'github.com/jsonnet-libs/docsonnet/doc-util/main.libsonnet'); }), }, endpoints:: { - '#new':: d.fn(help='\n`aws.endpoints.new` constructs a new object with attributes and blocks configured for the `endpoints`\nTerraform sub block.\n\n\n\n**Args**:\n - `accessanalyzer` (`string`): Use this to override the default service endpoint URL When `null`, the `accessanalyzer` field will be omitted from the resulting object.\n - `account` (`string`): Use this to override the default service endpoint URL When `null`, the `account` field will be omitted from the resulting object.\n - `acm` (`string`): Use this to override the default service endpoint URL When `null`, the `acm` field will be omitted from the resulting object.\n - `acmpca` (`string`): Use this to override the default service endpoint URL When `null`, the `acmpca` field will be omitted from the resulting object.\n - `amg` (`string`): Use this to override the default service endpoint URL When `null`, the `amg` field will be omitted from the resulting object.\n - `amp` (`string`): Use this to override the default service endpoint URL When `null`, the `amp` field will be omitted from the resulting object.\n - `amplify` (`string`): Use this to override the default service endpoint URL When `null`, the `amplify` field will be omitted from the resulting object.\n - `apigateway` (`string`): Use this to override the default service endpoint URL When `null`, the `apigateway` field will be omitted from the resulting object.\n - `apigatewayv2` (`string`): Use this to override the default service endpoint URL When `null`, the `apigatewayv2` field will be omitted from the resulting object.\n - `appautoscaling` (`string`): Use this to override the default service endpoint URL When `null`, the `appautoscaling` field will be omitted from the resulting object.\n - `appconfig` (`string`): Use this to override the default service endpoint URL When `null`, the `appconfig` field will be omitted from the resulting object.\n - `appfabric` (`string`): Use this to override the default service endpoint URL When `null`, the `appfabric` field will be omitted from the resulting object.\n - `appflow` (`string`): Use this to override the default service endpoint URL When `null`, the `appflow` field will be omitted from the resulting object.\n - `appintegrations` (`string`): Use this to override the default service endpoint URL When `null`, the `appintegrations` field will be omitted from the resulting object.\n - `appintegrationsservice` (`string`): Use this to override the default service endpoint URL When `null`, the `appintegrationsservice` field will be omitted from the resulting object.\n - `applicationautoscaling` (`string`): Use this to override the default service endpoint URL When `null`, the `applicationautoscaling` field will be omitted from the resulting object.\n - `applicationinsights` (`string`): Use this to override the default service endpoint URL When `null`, the `applicationinsights` field will be omitted from the resulting object.\n - `appmesh` (`string`): Use this to override the default service endpoint URL When `null`, the `appmesh` field will be omitted from the resulting object.\n - `apprunner` (`string`): Use this to override the default service endpoint URL When `null`, the `apprunner` field will be omitted from the resulting object.\n - `appstream` (`string`): Use this to override the default service endpoint URL When `null`, the `appstream` field will be omitted from the resulting object.\n - `appsync` (`string`): Use this to override the default service endpoint URL When `null`, the `appsync` field will be omitted from the resulting object.\n - `athena` (`string`): Use this to override the default service endpoint URL When `null`, the `athena` field will be omitted from the resulting object.\n - `auditmanager` (`string`): Use this to override the default service endpoint URL When `null`, the `auditmanager` field will be omitted from the resulting object.\n - `autoscaling` (`string`): Use this to override the default service endpoint URL When `null`, the `autoscaling` field will be omitted from the resulting object.\n - `autoscalingplans` (`string`): Use this to override the default service endpoint URL When `null`, the `autoscalingplans` field will be omitted from the resulting object.\n - `backup` (`string`): Use this to override the default service endpoint URL When `null`, the `backup` field will be omitted from the resulting object.\n - `batch` (`string`): Use this to override the default service endpoint URL When `null`, the `batch` field will be omitted from the resulting object.\n - `beanstalk` (`string`): Use this to override the default service endpoint URL When `null`, the `beanstalk` field will be omitted from the resulting object.\n - `bedrock` (`string`): Use this to override the default service endpoint URL When `null`, the `bedrock` field will be omitted from the resulting object.\n - `budgets` (`string`): Use this to override the default service endpoint URL When `null`, the `budgets` field will be omitted from the resulting object.\n - `ce` (`string`): Use this to override the default service endpoint URL When `null`, the `ce` field will be omitted from the resulting object.\n - `chime` (`string`): Use this to override the default service endpoint URL When `null`, the `chime` field will be omitted from the resulting object.\n - `chimesdkmediapipelines` (`string`): Use this to override the default service endpoint URL When `null`, the `chimesdkmediapipelines` field will be omitted from the resulting object.\n - `chimesdkvoice` (`string`): Use this to override the default service endpoint URL When `null`, the `chimesdkvoice` field will be omitted from the resulting object.\n - `cleanrooms` (`string`): Use this to override the default service endpoint URL When `null`, the `cleanrooms` field will be omitted from the resulting object.\n - `cloud9` (`string`): Use this to override the default service endpoint URL When `null`, the `cloud9` field will be omitted from the resulting object.\n - `cloudcontrol` (`string`): Use this to override the default service endpoint URL When `null`, the `cloudcontrol` field will be omitted from the resulting object.\n - `cloudcontrolapi` (`string`): Use this to override the default service endpoint URL When `null`, the `cloudcontrolapi` field will be omitted from the resulting object.\n - `cloudformation` (`string`): Use this to override the default service endpoint URL When `null`, the `cloudformation` field will be omitted from the resulting object.\n - `cloudfront` (`string`): Use this to override the default service endpoint URL When `null`, the `cloudfront` field will be omitted from the resulting object.\n - `cloudhsm` (`string`): Use this to override the default service endpoint URL When `null`, the `cloudhsm` field will be omitted from the resulting object.\n - `cloudhsmv2` (`string`): Use this to override the default service endpoint URL When `null`, the `cloudhsmv2` field will be omitted from the resulting object.\n - `cloudsearch` (`string`): Use this to override the default service endpoint URL When `null`, the `cloudsearch` field will be omitted from the resulting object.\n - `cloudtrail` (`string`): Use this to override the default service endpoint URL When `null`, the `cloudtrail` field will be omitted from the resulting object.\n - `cloudwatch` (`string`): Use this to override the default service endpoint URL When `null`, the `cloudwatch` field will be omitted from the resulting object.\n - `cloudwatchevents` (`string`): Use this to override the default service endpoint URL When `null`, the `cloudwatchevents` field will be omitted from the resulting object.\n - `cloudwatchevidently` (`string`): Use this to override the default service endpoint URL When `null`, the `cloudwatchevidently` field will be omitted from the resulting object.\n - `cloudwatchlog` (`string`): Use this to override the default service endpoint URL When `null`, the `cloudwatchlog` field will be omitted from the resulting object.\n - `cloudwatchlogs` (`string`): Use this to override the default service endpoint URL When `null`, the `cloudwatchlogs` field will be omitted from the resulting object.\n - `cloudwatchobservabilityaccessmanager` (`string`): Use this to override the default service endpoint URL When `null`, the `cloudwatchobservabilityaccessmanager` field will be omitted from the resulting object.\n - `cloudwatchrum` (`string`): Use this to override the default service endpoint URL When `null`, the `cloudwatchrum` field will be omitted from the resulting object.\n - `codeartifact` (`string`): Use this to override the default service endpoint URL When `null`, the `codeartifact` field will be omitted from the resulting object.\n - `codebuild` (`string`): Use this to override the default service endpoint URL When `null`, the `codebuild` field will be omitted from the resulting object.\n - `codecatalyst` (`string`): Use this to override the default service endpoint URL When `null`, the `codecatalyst` field will be omitted from the resulting object.\n - `codecommit` (`string`): Use this to override the default service endpoint URL When `null`, the `codecommit` field will be omitted from the resulting object.\n - `codedeploy` (`string`): Use this to override the default service endpoint URL When `null`, the `codedeploy` field will be omitted from the resulting object.\n - `codeguruprofiler` (`string`): Use this to override the default service endpoint URL When `null`, the `codeguruprofiler` field will be omitted from the resulting object.\n - `codegurureviewer` (`string`): Use this to override the default service endpoint URL When `null`, the `codegurureviewer` field will be omitted from the resulting object.\n - `codepipeline` (`string`): Use this to override the default service endpoint URL When `null`, the `codepipeline` field will be omitted from the resulting object.\n - `codestarconnections` (`string`): Use this to override the default service endpoint URL When `null`, the `codestarconnections` field will be omitted from the resulting object.\n - `codestarnotifications` (`string`): Use this to override the default service endpoint URL When `null`, the `codestarnotifications` field will be omitted from the resulting object.\n - `cognitoidentity` (`string`): Use this to override the default service endpoint URL When `null`, the `cognitoidentity` field will be omitted from the resulting object.\n - `cognitoidentityprovider` (`string`): Use this to override the default service endpoint URL When `null`, the `cognitoidentityprovider` field will be omitted from the resulting object.\n - `cognitoidp` (`string`): Use this to override the default service endpoint URL When `null`, the `cognitoidp` field will be omitted from the resulting object.\n - `comprehend` (`string`): Use this to override the default service endpoint URL When `null`, the `comprehend` field will be omitted from the resulting object.\n - `computeoptimizer` (`string`): Use this to override the default service endpoint URL When `null`, the `computeoptimizer` field will be omitted from the resulting object.\n - `config` (`string`): Use this to override the default service endpoint URL When `null`, the `config` field will be omitted from the resulting object.\n - `configservice` (`string`): Use this to override the default service endpoint URL When `null`, the `configservice` field will be omitted from the resulting object.\n - `connect` (`string`): Use this to override the default service endpoint URL When `null`, the `connect` field will be omitted from the resulting object.\n - `connectcases` (`string`): Use this to override the default service endpoint URL When `null`, the `connectcases` field will be omitted from the resulting object.\n - `controltower` (`string`): Use this to override the default service endpoint URL When `null`, the `controltower` field will be omitted from the resulting object.\n - `costandusagereportservice` (`string`): Use this to override the default service endpoint URL When `null`, the `costandusagereportservice` field will be omitted from the resulting object.\n - `costexplorer` (`string`): Use this to override the default service endpoint URL When `null`, the `costexplorer` field will be omitted from the resulting object.\n - `cur` (`string`): Use this to override the default service endpoint URL When `null`, the `cur` field will be omitted from the resulting object.\n - `customerprofiles` (`string`): Use this to override the default service endpoint URL When `null`, the `customerprofiles` field will be omitted from the resulting object.\n - `databasemigration` (`string`): Use this to override the default service endpoint URL When `null`, the `databasemigration` field will be omitted from the resulting object.\n - `databasemigrationservice` (`string`): Use this to override the default service endpoint URL When `null`, the `databasemigrationservice` field will be omitted from the resulting object.\n - `dataexchange` (`string`): Use this to override the default service endpoint URL When `null`, the `dataexchange` field will be omitted from the resulting object.\n - `datapipeline` (`string`): Use this to override the default service endpoint URL When `null`, the `datapipeline` field will be omitted from the resulting object.\n - `datasync` (`string`): Use this to override the default service endpoint URL When `null`, the `datasync` field will be omitted from the resulting object.\n - `dax` (`string`): Use this to override the default service endpoint URL When `null`, the `dax` field will be omitted from the resulting object.\n - `deploy` (`string`): Use this to override the default service endpoint URL When `null`, the `deploy` field will be omitted from the resulting object.\n - `detective` (`string`): Use this to override the default service endpoint URL When `null`, the `detective` field will be omitted from the resulting object.\n - `devicefarm` (`string`): Use this to override the default service endpoint URL When `null`, the `devicefarm` field will be omitted from the resulting object.\n - `directconnect` (`string`): Use this to override the default service endpoint URL When `null`, the `directconnect` field will be omitted from the resulting object.\n - `directoryservice` (`string`): Use this to override the default service endpoint URL When `null`, the `directoryservice` field will be omitted from the resulting object.\n - `dlm` (`string`): Use this to override the default service endpoint URL When `null`, the `dlm` field will be omitted from the resulting object.\n - `dms` (`string`): Use this to override the default service endpoint URL When `null`, the `dms` field will be omitted from the resulting object.\n - `docdb` (`string`): Use this to override the default service endpoint URL When `null`, the `docdb` field will be omitted from the resulting object.\n - `docdbelastic` (`string`): Use this to override the default service endpoint URL When `null`, the `docdbelastic` field will be omitted from the resulting object.\n - `ds` (`string`): Use this to override the default service endpoint URL When `null`, the `ds` field will be omitted from the resulting object.\n - `dynamodb` (`string`): Use this to override the default service endpoint URL When `null`, the `dynamodb` field will be omitted from the resulting object.\n - `ec2` (`string`): Use this to override the default service endpoint URL When `null`, the `ec2` field will be omitted from the resulting object.\n - `ecr` (`string`): Use this to override the default service endpoint URL When `null`, the `ecr` field will be omitted from the resulting object.\n - `ecrpublic` (`string`): Use this to override the default service endpoint URL When `null`, the `ecrpublic` field will be omitted from the resulting object.\n - `ecs` (`string`): Use this to override the default service endpoint URL When `null`, the `ecs` field will be omitted from the resulting object.\n - `efs` (`string`): Use this to override the default service endpoint URL When `null`, the `efs` field will be omitted from the resulting object.\n - `eks` (`string`): Use this to override the default service endpoint URL When `null`, the `eks` field will be omitted from the resulting object.\n - `elasticache` (`string`): Use this to override the default service endpoint URL When `null`, the `elasticache` field will be omitted from the resulting object.\n - `elasticbeanstalk` (`string`): Use this to override the default service endpoint URL When `null`, the `elasticbeanstalk` field will be omitted from the resulting object.\n - `elasticloadbalancing` (`string`): Use this to override the default service endpoint URL When `null`, the `elasticloadbalancing` field will be omitted from the resulting object.\n - `elasticloadbalancingv2` (`string`): Use this to override the default service endpoint URL When `null`, the `elasticloadbalancingv2` field will be omitted from the resulting object.\n - `elasticsearch` (`string`): Use this to override the default service endpoint URL When `null`, the `elasticsearch` field will be omitted from the resulting object.\n - `elasticsearchservice` (`string`): Use this to override the default service endpoint URL When `null`, the `elasticsearchservice` field will be omitted from the resulting object.\n - `elastictranscoder` (`string`): Use this to override the default service endpoint URL When `null`, the `elastictranscoder` field will be omitted from the resulting object.\n - `elb` (`string`): Use this to override the default service endpoint URL When `null`, the `elb` field will be omitted from the resulting object.\n - `elbv2` (`string`): Use this to override the default service endpoint URL When `null`, the `elbv2` field will be omitted from the resulting object.\n - `emr` (`string`): Use this to override the default service endpoint URL When `null`, the `emr` field will be omitted from the resulting object.\n - `emrcontainers` (`string`): Use this to override the default service endpoint URL When `null`, the `emrcontainers` field will be omitted from the resulting object.\n - `emrserverless` (`string`): Use this to override the default service endpoint URL When `null`, the `emrserverless` field will be omitted from the resulting object.\n - `es` (`string`): Use this to override the default service endpoint URL When `null`, the `es` field will be omitted from the resulting object.\n - `eventbridge` (`string`): Use this to override the default service endpoint URL When `null`, the `eventbridge` field will be omitted from the resulting object.\n - `events` (`string`): Use this to override the default service endpoint URL When `null`, the `events` field will be omitted from the resulting object.\n - `evidently` (`string`): Use this to override the default service endpoint URL When `null`, the `evidently` field will be omitted from the resulting object.\n - `finspace` (`string`): Use this to override the default service endpoint URL When `null`, the `finspace` field will be omitted from the resulting object.\n - `firehose` (`string`): Use this to override the default service endpoint URL When `null`, the `firehose` field will be omitted from the resulting object.\n - `fis` (`string`): Use this to override the default service endpoint URL When `null`, the `fis` field will be omitted from the resulting object.\n - `fms` (`string`): Use this to override the default service endpoint URL When `null`, the `fms` field will be omitted from the resulting object.\n - `fsx` (`string`): Use this to override the default service endpoint URL When `null`, the `fsx` field will be omitted from the resulting object.\n - `gamelift` (`string`): Use this to override the default service endpoint URL When `null`, the `gamelift` field will be omitted from the resulting object.\n - `glacier` (`string`): Use this to override the default service endpoint URL When `null`, the `glacier` field will be omitted from the resulting object.\n - `globalaccelerator` (`string`): Use this to override the default service endpoint URL When `null`, the `globalaccelerator` field will be omitted from the resulting object.\n - `glue` (`string`): Use this to override the default service endpoint URL When `null`, the `glue` field will be omitted from the resulting object.\n - `grafana` (`string`): Use this to override the default service endpoint URL When `null`, the `grafana` field will be omitted from the resulting object.\n - `greengrass` (`string`): Use this to override the default service endpoint URL When `null`, the `greengrass` field will be omitted from the resulting object.\n - `guardduty` (`string`): Use this to override the default service endpoint URL When `null`, the `guardduty` field will be omitted from the resulting object.\n - `healthlake` (`string`): Use this to override the default service endpoint URL When `null`, the `healthlake` field will be omitted from the resulting object.\n - `iam` (`string`): Use this to override the default service endpoint URL When `null`, the `iam` field will be omitted from the resulting object.\n - `identitystore` (`string`): Use this to override the default service endpoint URL When `null`, the `identitystore` field will be omitted from the resulting object.\n - `imagebuilder` (`string`): Use this to override the default service endpoint URL When `null`, the `imagebuilder` field will be omitted from the resulting object.\n - `inspector` (`string`): Use this to override the default service endpoint URL When `null`, the `inspector` field will be omitted from the resulting object.\n - `inspector2` (`string`): Use this to override the default service endpoint URL When `null`, the `inspector2` field will be omitted from the resulting object.\n - `inspectorv2` (`string`): Use this to override the default service endpoint URL When `null`, the `inspectorv2` field will be omitted from the resulting object.\n - `internetmonitor` (`string`): Use this to override the default service endpoint URL When `null`, the `internetmonitor` field will be omitted from the resulting object.\n - `iot` (`string`): Use this to override the default service endpoint URL When `null`, the `iot` field will be omitted from the resulting object.\n - `iotanalytics` (`string`): Use this to override the default service endpoint URL When `null`, the `iotanalytics` field will be omitted from the resulting object.\n - `iotevents` (`string`): Use this to override the default service endpoint URL When `null`, the `iotevents` field will be omitted from the resulting object.\n - `ivs` (`string`): Use this to override the default service endpoint URL When `null`, the `ivs` field will be omitted from the resulting object.\n - `ivschat` (`string`): Use this to override the default service endpoint URL When `null`, the `ivschat` field will be omitted from the resulting object.\n - `kafka` (`string`): Use this to override the default service endpoint URL When `null`, the `kafka` field will be omitted from the resulting object.\n - `kafkaconnect` (`string`): Use this to override the default service endpoint URL When `null`, the `kafkaconnect` field will be omitted from the resulting object.\n - `kendra` (`string`): Use this to override the default service endpoint URL When `null`, the `kendra` field will be omitted from the resulting object.\n - `keyspaces` (`string`): Use this to override the default service endpoint URL When `null`, the `keyspaces` field will be omitted from the resulting object.\n - `kinesis` (`string`): Use this to override the default service endpoint URL When `null`, the `kinesis` field will be omitted from the resulting object.\n - `kinesisanalytics` (`string`): Use this to override the default service endpoint URL When `null`, the `kinesisanalytics` field will be omitted from the resulting object.\n - `kinesisanalyticsv2` (`string`): Use this to override the default service endpoint URL When `null`, the `kinesisanalyticsv2` field will be omitted from the resulting object.\n - `kinesisvideo` (`string`): Use this to override the default service endpoint URL When `null`, the `kinesisvideo` field will be omitted from the resulting object.\n - `kms` (`string`): Use this to override the default service endpoint URL When `null`, the `kms` field will be omitted from the resulting object.\n - `lakeformation` (`string`): Use this to override the default service endpoint URL When `null`, the `lakeformation` field will be omitted from the resulting object.\n - `lambda` (`string`): Use this to override the default service endpoint URL When `null`, the `lambda` field will be omitted from the resulting object.\n - `lex` (`string`): Use this to override the default service endpoint URL When `null`, the `lex` field will be omitted from the resulting object.\n - `lexmodelbuilding` (`string`): Use this to override the default service endpoint URL When `null`, the `lexmodelbuilding` field will be omitted from the resulting object.\n - `lexmodelbuildingservice` (`string`): Use this to override the default service endpoint URL When `null`, the `lexmodelbuildingservice` field will be omitted from the resulting object.\n - `lexmodels` (`string`): Use this to override the default service endpoint URL When `null`, the `lexmodels` field will be omitted from the resulting object.\n - `lexmodelsv2` (`string`): Use this to override the default service endpoint URL When `null`, the `lexmodelsv2` field will be omitted from the resulting object.\n - `lexv2models` (`string`): Use this to override the default service endpoint URL When `null`, the `lexv2models` field will be omitted from the resulting object.\n - `licensemanager` (`string`): Use this to override the default service endpoint URL When `null`, the `licensemanager` field will be omitted from the resulting object.\n - `lightsail` (`string`): Use this to override the default service endpoint URL When `null`, the `lightsail` field will be omitted from the resulting object.\n - `location` (`string`): Use this to override the default service endpoint URL When `null`, the `location` field will be omitted from the resulting object.\n - `locationservice` (`string`): Use this to override the default service endpoint URL When `null`, the `locationservice` field will be omitted from the resulting object.\n - `logs` (`string`): Use this to override the default service endpoint URL When `null`, the `logs` field will be omitted from the resulting object.\n - `macie2` (`string`): Use this to override the default service endpoint URL When `null`, the `macie2` field will be omitted from the resulting object.\n - `managedgrafana` (`string`): Use this to override the default service endpoint URL When `null`, the `managedgrafana` field will be omitted from the resulting object.\n - `mediaconnect` (`string`): Use this to override the default service endpoint URL When `null`, the `mediaconnect` field will be omitted from the resulting object.\n - `mediaconvert` (`string`): Use this to override the default service endpoint URL When `null`, the `mediaconvert` field will be omitted from the resulting object.\n - `medialive` (`string`): Use this to override the default service endpoint URL When `null`, the `medialive` field will be omitted from the resulting object.\n - `mediapackage` (`string`): Use this to override the default service endpoint URL When `null`, the `mediapackage` field will be omitted from the resulting object.\n - `mediapackagev2` (`string`): Use this to override the default service endpoint URL When `null`, the `mediapackagev2` field will be omitted from the resulting object.\n - `mediastore` (`string`): Use this to override the default service endpoint URL When `null`, the `mediastore` field will be omitted from the resulting object.\n - `memorydb` (`string`): Use this to override the default service endpoint URL When `null`, the `memorydb` field will be omitted from the resulting object.\n - `mq` (`string`): Use this to override the default service endpoint URL When `null`, the `mq` field will be omitted from the resulting object.\n - `msk` (`string`): Use this to override the default service endpoint URL When `null`, the `msk` field will be omitted from the resulting object.\n - `mwaa` (`string`): Use this to override the default service endpoint URL When `null`, the `mwaa` field will be omitted from the resulting object.\n - `neptune` (`string`): Use this to override the default service endpoint URL When `null`, the `neptune` field will be omitted from the resulting object.\n - `networkfirewall` (`string`): Use this to override the default service endpoint URL When `null`, the `networkfirewall` field will be omitted from the resulting object.\n - `networkmanager` (`string`): Use this to override the default service endpoint URL When `null`, the `networkmanager` field will be omitted from the resulting object.\n - `oam` (`string`): Use this to override the default service endpoint URL When `null`, the `oam` field will be omitted from the resulting object.\n - `opensearch` (`string`): Use this to override the default service endpoint URL When `null`, the `opensearch` field will be omitted from the resulting object.\n - `opensearchingestion` (`string`): Use this to override the default service endpoint URL When `null`, the `opensearchingestion` field will be omitted from the resulting object.\n - `opensearchserverless` (`string`): Use this to override the default service endpoint URL When `null`, the `opensearchserverless` field will be omitted from the resulting object.\n - `opensearchservice` (`string`): Use this to override the default service endpoint URL When `null`, the `opensearchservice` field will be omitted from the resulting object.\n - `opsworks` (`string`): Use this to override the default service endpoint URL When `null`, the `opsworks` field will be omitted from the resulting object.\n - `organizations` (`string`): Use this to override the default service endpoint URL When `null`, the `organizations` field will be omitted from the resulting object.\n - `osis` (`string`): Use this to override the default service endpoint URL When `null`, the `osis` field will be omitted from the resulting object.\n - `outposts` (`string`): Use this to override the default service endpoint URL When `null`, the `outposts` field will be omitted from the resulting object.\n - `pinpoint` (`string`): Use this to override the default service endpoint URL When `null`, the `pinpoint` field will be omitted from the resulting object.\n - `pipes` (`string`): Use this to override the default service endpoint URL When `null`, the `pipes` field will be omitted from the resulting object.\n - `pricing` (`string`): Use this to override the default service endpoint URL When `null`, the `pricing` field will be omitted from the resulting object.\n - `prometheus` (`string`): Use this to override the default service endpoint URL When `null`, the `prometheus` field will be omitted from the resulting object.\n - `prometheusservice` (`string`): Use this to override the default service endpoint URL When `null`, the `prometheusservice` field will be omitted from the resulting object.\n - `qldb` (`string`): Use this to override the default service endpoint URL When `null`, the `qldb` field will be omitted from the resulting object.\n - `quicksight` (`string`): Use this to override the default service endpoint URL When `null`, the `quicksight` field will be omitted from the resulting object.\n - `ram` (`string`): Use this to override the default service endpoint URL When `null`, the `ram` field will be omitted from the resulting object.\n - `rbin` (`string`): Use this to override the default service endpoint URL When `null`, the `rbin` field will be omitted from the resulting object.\n - `rds` (`string`): Use this to override the default service endpoint URL When `null`, the `rds` field will be omitted from the resulting object.\n - `recyclebin` (`string`): Use this to override the default service endpoint URL When `null`, the `recyclebin` field will be omitted from the resulting object.\n - `redshift` (`string`): Use this to override the default service endpoint URL When `null`, the `redshift` field will be omitted from the resulting object.\n - `redshiftdata` (`string`): Use this to override the default service endpoint URL When `null`, the `redshiftdata` field will be omitted from the resulting object.\n - `redshiftdataapiservice` (`string`): Use this to override the default service endpoint URL When `null`, the `redshiftdataapiservice` field will be omitted from the resulting object.\n - `redshiftserverless` (`string`): Use this to override the default service endpoint URL When `null`, the `redshiftserverless` field will be omitted from the resulting object.\n - `resourceexplorer2` (`string`): Use this to override the default service endpoint URL When `null`, the `resourceexplorer2` field will be omitted from the resulting object.\n - `resourcegroups` (`string`): Use this to override the default service endpoint URL When `null`, the `resourcegroups` field will be omitted from the resulting object.\n - `resourcegroupstagging` (`string`): Use this to override the default service endpoint URL When `null`, the `resourcegroupstagging` field will be omitted from the resulting object.\n - `resourcegroupstaggingapi` (`string`): Use this to override the default service endpoint URL When `null`, the `resourcegroupstaggingapi` field will be omitted from the resulting object.\n - `rolesanywhere` (`string`): Use this to override the default service endpoint URL When `null`, the `rolesanywhere` field will be omitted from the resulting object.\n - `route53` (`string`): Use this to override the default service endpoint URL When `null`, the `route53` field will be omitted from the resulting object.\n - `route53domains` (`string`): Use this to override the default service endpoint URL When `null`, the `route53domains` field will be omitted from the resulting object.\n - `route53recoverycontrolconfig` (`string`): Use this to override the default service endpoint URL When `null`, the `route53recoverycontrolconfig` field will be omitted from the resulting object.\n - `route53recoveryreadiness` (`string`): Use this to override the default service endpoint URL When `null`, the `route53recoveryreadiness` field will be omitted from the resulting object.\n - `route53resolver` (`string`): Use this to override the default service endpoint URL When `null`, the `route53resolver` field will be omitted from the resulting object.\n - `rum` (`string`): Use this to override the default service endpoint URL When `null`, the `rum` field will be omitted from the resulting object.\n - `s3` (`string`): Use this to override the default service endpoint URL When `null`, the `s3` field will be omitted from the resulting object.\n - `s3api` (`string`): Use this to override the default service endpoint URL When `null`, the `s3api` field will be omitted from the resulting object.\n - `s3control` (`string`): Use this to override the default service endpoint URL When `null`, the `s3control` field will be omitted from the resulting object.\n - `s3outposts` (`string`): Use this to override the default service endpoint URL When `null`, the `s3outposts` field will be omitted from the resulting object.\n - `sagemaker` (`string`): Use this to override the default service endpoint URL When `null`, the `sagemaker` field will be omitted from the resulting object.\n - `scheduler` (`string`): Use this to override the default service endpoint URL When `null`, the `scheduler` field will be omitted from the resulting object.\n - `schemas` (`string`): Use this to override the default service endpoint URL When `null`, the `schemas` field will be omitted from the resulting object.\n - `sdb` (`string`): Use this to override the default service endpoint URL When `null`, the `sdb` field will be omitted from the resulting object.\n - `secretsmanager` (`string`): Use this to override the default service endpoint URL When `null`, the `secretsmanager` field will be omitted from the resulting object.\n - `securityhub` (`string`): Use this to override the default service endpoint URL When `null`, the `securityhub` field will be omitted from the resulting object.\n - `securitylake` (`string`): Use this to override the default service endpoint URL When `null`, the `securitylake` field will be omitted from the resulting object.\n - `serverlessapplicationrepository` (`string`): Use this to override the default service endpoint URL When `null`, the `serverlessapplicationrepository` field will be omitted from the resulting object.\n - `serverlessapprepo` (`string`): Use this to override the default service endpoint URL When `null`, the `serverlessapprepo` field will be omitted from the resulting object.\n - `serverlessrepo` (`string`): Use this to override the default service endpoint URL When `null`, the `serverlessrepo` field will be omitted from the resulting object.\n - `servicecatalog` (`string`): Use this to override the default service endpoint URL When `null`, the `servicecatalog` field will be omitted from the resulting object.\n - `servicediscovery` (`string`): Use this to override the default service endpoint URL When `null`, the `servicediscovery` field will be omitted from the resulting object.\n - `servicequotas` (`string`): Use this to override the default service endpoint URL When `null`, the `servicequotas` field will be omitted from the resulting object.\n - `ses` (`string`): Use this to override the default service endpoint URL When `null`, the `ses` field will be omitted from the resulting object.\n - `sesv2` (`string`): Use this to override the default service endpoint URL When `null`, the `sesv2` field will be omitted from the resulting object.\n - `sfn` (`string`): Use this to override the default service endpoint URL When `null`, the `sfn` field will be omitted from the resulting object.\n - `shield` (`string`): Use this to override the default service endpoint URL When `null`, the `shield` field will be omitted from the resulting object.\n - `signer` (`string`): Use this to override the default service endpoint URL When `null`, the `signer` field will be omitted from the resulting object.\n - `simpledb` (`string`): Use this to override the default service endpoint URL When `null`, the `simpledb` field will be omitted from the resulting object.\n - `sns` (`string`): Use this to override the default service endpoint URL When `null`, the `sns` field will be omitted from the resulting object.\n - `sqs` (`string`): Use this to override the default service endpoint URL When `null`, the `sqs` field will be omitted from the resulting object.\n - `ssm` (`string`): Use this to override the default service endpoint URL When `null`, the `ssm` field will be omitted from the resulting object.\n - `ssmcontacts` (`string`): Use this to override the default service endpoint URL When `null`, the `ssmcontacts` field will be omitted from the resulting object.\n - `ssmincidents` (`string`): Use this to override the default service endpoint URL When `null`, the `ssmincidents` field will be omitted from the resulting object.\n - `sso` (`string`): Use this to override the default service endpoint URL When `null`, the `sso` field will be omitted from the resulting object.\n - `ssoadmin` (`string`): Use this to override the default service endpoint URL When `null`, the `ssoadmin` field will be omitted from the resulting object.\n - `stepfunctions` (`string`): Use this to override the default service endpoint URL When `null`, the `stepfunctions` field will be omitted from the resulting object.\n - `storagegateway` (`string`): Use this to override the default service endpoint URL When `null`, the `storagegateway` field will be omitted from the resulting object.\n - `sts` (`string`): Use this to override the default service endpoint URL When `null`, the `sts` field will be omitted from the resulting object.\n - `swf` (`string`): Use this to override the default service endpoint URL When `null`, the `swf` field will be omitted from the resulting object.\n - `synthetics` (`string`): Use this to override the default service endpoint URL When `null`, the `synthetics` field will be omitted from the resulting object.\n - `timestreamwrite` (`string`): Use this to override the default service endpoint URL When `null`, the `timestreamwrite` field will be omitted from the resulting object.\n - `transcribe` (`string`): Use this to override the default service endpoint URL When `null`, the `transcribe` field will be omitted from the resulting object.\n - `transcribeservice` (`string`): Use this to override the default service endpoint URL When `null`, the `transcribeservice` field will be omitted from the resulting object.\n - `transfer` (`string`): Use this to override the default service endpoint URL When `null`, the `transfer` field will be omitted from the resulting object.\n - `verifiedpermissions` (`string`): Use this to override the default service endpoint URL When `null`, the `verifiedpermissions` field will be omitted from the resulting object.\n - `vpclattice` (`string`): Use this to override the default service endpoint URL When `null`, the `vpclattice` field will be omitted from the resulting object.\n - `waf` (`string`): Use this to override the default service endpoint URL When `null`, the `waf` field will be omitted from the resulting object.\n - `wafregional` (`string`): Use this to override the default service endpoint URL When `null`, the `wafregional` field will be omitted from the resulting object.\n - `wafv2` (`string`): Use this to override the default service endpoint URL When `null`, the `wafv2` field will be omitted from the resulting object.\n - `worklink` (`string`): Use this to override the default service endpoint URL When `null`, the `worklink` field will be omitted from the resulting object.\n - `workspaces` (`string`): Use this to override the default service endpoint URL When `null`, the `workspaces` field will be omitted from the resulting object.\n - `xray` (`string`): Use this to override the default service endpoint URL When `null`, the `xray` field will be omitted from the resulting object.\n\n**Returns**:\n - An attribute object that represents the `endpoints` sub block.\n', args=[]), + '#new':: d.fn(help='\n`aws.endpoints.new` constructs a new object with attributes and blocks configured for the `endpoints`\nTerraform sub block.\n\n\n\n**Args**:\n - `accessanalyzer` (`string`): Use this to override the default service endpoint URL When `null`, the `accessanalyzer` field will be omitted from the resulting object.\n - `account` (`string`): Use this to override the default service endpoint URL When `null`, the `account` field will be omitted from the resulting object.\n - `acm` (`string`): Use this to override the default service endpoint URL When `null`, the `acm` field will be omitted from the resulting object.\n - `acmpca` (`string`): Use this to override the default service endpoint URL When `null`, the `acmpca` field will be omitted from the resulting object.\n - `amg` (`string`): Use this to override the default service endpoint URL When `null`, the `amg` field will be omitted from the resulting object.\n - `amp` (`string`): Use this to override the default service endpoint URL When `null`, the `amp` field will be omitted from the resulting object.\n - `amplify` (`string`): Use this to override the default service endpoint URL When `null`, the `amplify` field will be omitted from the resulting object.\n - `apigateway` (`string`): Use this to override the default service endpoint URL When `null`, the `apigateway` field will be omitted from the resulting object.\n - `apigatewayv2` (`string`): Use this to override the default service endpoint URL When `null`, the `apigatewayv2` field will be omitted from the resulting object.\n - `appautoscaling` (`string`): Use this to override the default service endpoint URL When `null`, the `appautoscaling` field will be omitted from the resulting object.\n - `appconfig` (`string`): Use this to override the default service endpoint URL When `null`, the `appconfig` field will be omitted from the resulting object.\n - `appfabric` (`string`): Use this to override the default service endpoint URL When `null`, the `appfabric` field will be omitted from the resulting object.\n - `appflow` (`string`): Use this to override the default service endpoint URL When `null`, the `appflow` field will be omitted from the resulting object.\n - `appintegrations` (`string`): Use this to override the default service endpoint URL When `null`, the `appintegrations` field will be omitted from the resulting object.\n - `appintegrationsservice` (`string`): Use this to override the default service endpoint URL When `null`, the `appintegrationsservice` field will be omitted from the resulting object.\n - `applicationautoscaling` (`string`): Use this to override the default service endpoint URL When `null`, the `applicationautoscaling` field will be omitted from the resulting object.\n - `applicationinsights` (`string`): Use this to override the default service endpoint URL When `null`, the `applicationinsights` field will be omitted from the resulting object.\n - `appmesh` (`string`): Use this to override the default service endpoint URL When `null`, the `appmesh` field will be omitted from the resulting object.\n - `apprunner` (`string`): Use this to override the default service endpoint URL When `null`, the `apprunner` field will be omitted from the resulting object.\n - `appstream` (`string`): Use this to override the default service endpoint URL When `null`, the `appstream` field will be omitted from the resulting object.\n - `appsync` (`string`): Use this to override the default service endpoint URL When `null`, the `appsync` field will be omitted from the resulting object.\n - `athena` (`string`): Use this to override the default service endpoint URL When `null`, the `athena` field will be omitted from the resulting object.\n - `auditmanager` (`string`): Use this to override the default service endpoint URL When `null`, the `auditmanager` field will be omitted from the resulting object.\n - `autoscaling` (`string`): Use this to override the default service endpoint URL When `null`, the `autoscaling` field will be omitted from the resulting object.\n - `autoscalingplans` (`string`): Use this to override the default service endpoint URL When `null`, the `autoscalingplans` field will be omitted from the resulting object.\n - `backup` (`string`): Use this to override the default service endpoint URL When `null`, the `backup` field will be omitted from the resulting object.\n - `batch` (`string`): Use this to override the default service endpoint URL When `null`, the `batch` field will be omitted from the resulting object.\n - `beanstalk` (`string`): Use this to override the default service endpoint URL When `null`, the `beanstalk` field will be omitted from the resulting object.\n - `bedrock` (`string`): Use this to override the default service endpoint URL When `null`, the `bedrock` field will be omitted from the resulting object.\n - `budgets` (`string`): Use this to override the default service endpoint URL When `null`, the `budgets` field will be omitted from the resulting object.\n - `ce` (`string`): Use this to override the default service endpoint URL When `null`, the `ce` field will be omitted from the resulting object.\n - `chime` (`string`): Use this to override the default service endpoint URL When `null`, the `chime` field will be omitted from the resulting object.\n - `chimesdkmediapipelines` (`string`): Use this to override the default service endpoint URL When `null`, the `chimesdkmediapipelines` field will be omitted from the resulting object.\n - `chimesdkvoice` (`string`): Use this to override the default service endpoint URL When `null`, the `chimesdkvoice` field will be omitted from the resulting object.\n - `cleanrooms` (`string`): Use this to override the default service endpoint URL When `null`, the `cleanrooms` field will be omitted from the resulting object.\n - `cloud9` (`string`): Use this to override the default service endpoint URL When `null`, the `cloud9` field will be omitted from the resulting object.\n - `cloudcontrol` (`string`): Use this to override the default service endpoint URL When `null`, the `cloudcontrol` field will be omitted from the resulting object.\n - `cloudcontrolapi` (`string`): Use this to override the default service endpoint URL When `null`, the `cloudcontrolapi` field will be omitted from the resulting object.\n - `cloudformation` (`string`): Use this to override the default service endpoint URL When `null`, the `cloudformation` field will be omitted from the resulting object.\n - `cloudfront` (`string`): Use this to override the default service endpoint URL When `null`, the `cloudfront` field will be omitted from the resulting object.\n - `cloudhsm` (`string`): Use this to override the default service endpoint URL When `null`, the `cloudhsm` field will be omitted from the resulting object.\n - `cloudhsmv2` (`string`): Use this to override the default service endpoint URL When `null`, the `cloudhsmv2` field will be omitted from the resulting object.\n - `cloudsearch` (`string`): Use this to override the default service endpoint URL When `null`, the `cloudsearch` field will be omitted from the resulting object.\n - `cloudtrail` (`string`): Use this to override the default service endpoint URL When `null`, the `cloudtrail` field will be omitted from the resulting object.\n - `cloudwatch` (`string`): Use this to override the default service endpoint URL When `null`, the `cloudwatch` field will be omitted from the resulting object.\n - `cloudwatchevents` (`string`): Use this to override the default service endpoint URL When `null`, the `cloudwatchevents` field will be omitted from the resulting object.\n - `cloudwatchevidently` (`string`): Use this to override the default service endpoint URL When `null`, the `cloudwatchevidently` field will be omitted from the resulting object.\n - `cloudwatchlog` (`string`): Use this to override the default service endpoint URL When `null`, the `cloudwatchlog` field will be omitted from the resulting object.\n - `cloudwatchlogs` (`string`): Use this to override the default service endpoint URL When `null`, the `cloudwatchlogs` field will be omitted from the resulting object.\n - `cloudwatchobservabilityaccessmanager` (`string`): Use this to override the default service endpoint URL When `null`, the `cloudwatchobservabilityaccessmanager` field will be omitted from the resulting object.\n - `cloudwatchrum` (`string`): Use this to override the default service endpoint URL When `null`, the `cloudwatchrum` field will be omitted from the resulting object.\n - `codeartifact` (`string`): Use this to override the default service endpoint URL When `null`, the `codeartifact` field will be omitted from the resulting object.\n - `codebuild` (`string`): Use this to override the default service endpoint URL When `null`, the `codebuild` field will be omitted from the resulting object.\n - `codecatalyst` (`string`): Use this to override the default service endpoint URL When `null`, the `codecatalyst` field will be omitted from the resulting object.\n - `codecommit` (`string`): Use this to override the default service endpoint URL When `null`, the `codecommit` field will be omitted from the resulting object.\n - `codedeploy` (`string`): Use this to override the default service endpoint URL When `null`, the `codedeploy` field will be omitted from the resulting object.\n - `codeguruprofiler` (`string`): Use this to override the default service endpoint URL When `null`, the `codeguruprofiler` field will be omitted from the resulting object.\n - `codegurureviewer` (`string`): Use this to override the default service endpoint URL When `null`, the `codegurureviewer` field will be omitted from the resulting object.\n - `codepipeline` (`string`): Use this to override the default service endpoint URL When `null`, the `codepipeline` field will be omitted from the resulting object.\n - `codestarconnections` (`string`): Use this to override the default service endpoint URL When `null`, the `codestarconnections` field will be omitted from the resulting object.\n - `codestarnotifications` (`string`): Use this to override the default service endpoint URL When `null`, the `codestarnotifications` field will be omitted from the resulting object.\n - `cognitoidentity` (`string`): Use this to override the default service endpoint URL When `null`, the `cognitoidentity` field will be omitted from the resulting object.\n - `cognitoidentityprovider` (`string`): Use this to override the default service endpoint URL When `null`, the `cognitoidentityprovider` field will be omitted from the resulting object.\n - `cognitoidp` (`string`): Use this to override the default service endpoint URL When `null`, the `cognitoidp` field will be omitted from the resulting object.\n - `comprehend` (`string`): Use this to override the default service endpoint URL When `null`, the `comprehend` field will be omitted from the resulting object.\n - `computeoptimizer` (`string`): Use this to override the default service endpoint URL When `null`, the `computeoptimizer` field will be omitted from the resulting object.\n - `config` (`string`): Use this to override the default service endpoint URL When `null`, the `config` field will be omitted from the resulting object.\n - `configservice` (`string`): Use this to override the default service endpoint URL When `null`, the `configservice` field will be omitted from the resulting object.\n - `connect` (`string`): Use this to override the default service endpoint URL When `null`, the `connect` field will be omitted from the resulting object.\n - `connectcases` (`string`): Use this to override the default service endpoint URL When `null`, the `connectcases` field will be omitted from the resulting object.\n - `controltower` (`string`): Use this to override the default service endpoint URL When `null`, the `controltower` field will be omitted from the resulting object.\n - `costandusagereportservice` (`string`): Use this to override the default service endpoint URL When `null`, the `costandusagereportservice` field will be omitted from the resulting object.\n - `costexplorer` (`string`): Use this to override the default service endpoint URL When `null`, the `costexplorer` field will be omitted from the resulting object.\n - `cur` (`string`): Use this to override the default service endpoint URL When `null`, the `cur` field will be omitted from the resulting object.\n - `customerprofiles` (`string`): Use this to override the default service endpoint URL When `null`, the `customerprofiles` field will be omitted from the resulting object.\n - `databasemigration` (`string`): Use this to override the default service endpoint URL When `null`, the `databasemigration` field will be omitted from the resulting object.\n - `databasemigrationservice` (`string`): Use this to override the default service endpoint URL When `null`, the `databasemigrationservice` field will be omitted from the resulting object.\n - `dataexchange` (`string`): Use this to override the default service endpoint URL When `null`, the `dataexchange` field will be omitted from the resulting object.\n - `datapipeline` (`string`): Use this to override the default service endpoint URL When `null`, the `datapipeline` field will be omitted from the resulting object.\n - `datasync` (`string`): Use this to override the default service endpoint URL When `null`, the `datasync` field will be omitted from the resulting object.\n - `dax` (`string`): Use this to override the default service endpoint URL When `null`, the `dax` field will be omitted from the resulting object.\n - `deploy` (`string`): Use this to override the default service endpoint URL When `null`, the `deploy` field will be omitted from the resulting object.\n - `detective` (`string`): Use this to override the default service endpoint URL When `null`, the `detective` field will be omitted from the resulting object.\n - `devicefarm` (`string`): Use this to override the default service endpoint URL When `null`, the `devicefarm` field will be omitted from the resulting object.\n - `directconnect` (`string`): Use this to override the default service endpoint URL When `null`, the `directconnect` field will be omitted from the resulting object.\n - `directoryservice` (`string`): Use this to override the default service endpoint URL When `null`, the `directoryservice` field will be omitted from the resulting object.\n - `dlm` (`string`): Use this to override the default service endpoint URL When `null`, the `dlm` field will be omitted from the resulting object.\n - `dms` (`string`): Use this to override the default service endpoint URL When `null`, the `dms` field will be omitted from the resulting object.\n - `docdb` (`string`): Use this to override the default service endpoint URL When `null`, the `docdb` field will be omitted from the resulting object.\n - `docdbelastic` (`string`): Use this to override the default service endpoint URL When `null`, the `docdbelastic` field will be omitted from the resulting object.\n - `ds` (`string`): Use this to override the default service endpoint URL When `null`, the `ds` field will be omitted from the resulting object.\n - `dynamodb` (`string`): Use this to override the default service endpoint URL When `null`, the `dynamodb` field will be omitted from the resulting object.\n - `ec2` (`string`): Use this to override the default service endpoint URL When `null`, the `ec2` field will be omitted from the resulting object.\n - `ecr` (`string`): Use this to override the default service endpoint URL When `null`, the `ecr` field will be omitted from the resulting object.\n - `ecrpublic` (`string`): Use this to override the default service endpoint URL When `null`, the `ecrpublic` field will be omitted from the resulting object.\n - `ecs` (`string`): Use this to override the default service endpoint URL When `null`, the `ecs` field will be omitted from the resulting object.\n - `efs` (`string`): Use this to override the default service endpoint URL When `null`, the `efs` field will be omitted from the resulting object.\n - `eks` (`string`): Use this to override the default service endpoint URL When `null`, the `eks` field will be omitted from the resulting object.\n - `elasticache` (`string`): Use this to override the default service endpoint URL When `null`, the `elasticache` field will be omitted from the resulting object.\n - `elasticbeanstalk` (`string`): Use this to override the default service endpoint URL When `null`, the `elasticbeanstalk` field will be omitted from the resulting object.\n - `elasticloadbalancing` (`string`): Use this to override the default service endpoint URL When `null`, the `elasticloadbalancing` field will be omitted from the resulting object.\n - `elasticloadbalancingv2` (`string`): Use this to override the default service endpoint URL When `null`, the `elasticloadbalancingv2` field will be omitted from the resulting object.\n - `elasticsearch` (`string`): Use this to override the default service endpoint URL When `null`, the `elasticsearch` field will be omitted from the resulting object.\n - `elasticsearchservice` (`string`): Use this to override the default service endpoint URL When `null`, the `elasticsearchservice` field will be omitted from the resulting object.\n - `elastictranscoder` (`string`): Use this to override the default service endpoint URL When `null`, the `elastictranscoder` field will be omitted from the resulting object.\n - `elb` (`string`): Use this to override the default service endpoint URL When `null`, the `elb` field will be omitted from the resulting object.\n - `elbv2` (`string`): Use this to override the default service endpoint URL When `null`, the `elbv2` field will be omitted from the resulting object.\n - `emr` (`string`): Use this to override the default service endpoint URL When `null`, the `emr` field will be omitted from the resulting object.\n - `emrcontainers` (`string`): Use this to override the default service endpoint URL When `null`, the `emrcontainers` field will be omitted from the resulting object.\n - `emrserverless` (`string`): Use this to override the default service endpoint URL When `null`, the `emrserverless` field will be omitted from the resulting object.\n - `es` (`string`): Use this to override the default service endpoint URL When `null`, the `es` field will be omitted from the resulting object.\n - `eventbridge` (`string`): Use this to override the default service endpoint URL When `null`, the `eventbridge` field will be omitted from the resulting object.\n - `events` (`string`): Use this to override the default service endpoint URL When `null`, the `events` field will be omitted from the resulting object.\n - `evidently` (`string`): Use this to override the default service endpoint URL When `null`, the `evidently` field will be omitted from the resulting object.\n - `finspace` (`string`): Use this to override the default service endpoint URL When `null`, the `finspace` field will be omitted from the resulting object.\n - `firehose` (`string`): Use this to override the default service endpoint URL When `null`, the `firehose` field will be omitted from the resulting object.\n - `fis` (`string`): Use this to override the default service endpoint URL When `null`, the `fis` field will be omitted from the resulting object.\n - `fms` (`string`): Use this to override the default service endpoint URL When `null`, the `fms` field will be omitted from the resulting object.\n - `fsx` (`string`): Use this to override the default service endpoint URL When `null`, the `fsx` field will be omitted from the resulting object.\n - `gamelift` (`string`): Use this to override the default service endpoint URL When `null`, the `gamelift` field will be omitted from the resulting object.\n - `glacier` (`string`): Use this to override the default service endpoint URL When `null`, the `glacier` field will be omitted from the resulting object.\n - `globalaccelerator` (`string`): Use this to override the default service endpoint URL When `null`, the `globalaccelerator` field will be omitted from the resulting object.\n - `glue` (`string`): Use this to override the default service endpoint URL When `null`, the `glue` field will be omitted from the resulting object.\n - `grafana` (`string`): Use this to override the default service endpoint URL When `null`, the `grafana` field will be omitted from the resulting object.\n - `greengrass` (`string`): Use this to override the default service endpoint URL When `null`, the `greengrass` field will be omitted from the resulting object.\n - `guardduty` (`string`): Use this to override the default service endpoint URL When `null`, the `guardduty` field will be omitted from the resulting object.\n - `healthlake` (`string`): Use this to override the default service endpoint URL When `null`, the `healthlake` field will be omitted from the resulting object.\n - `iam` (`string`): Use this to override the default service endpoint URL When `null`, the `iam` field will be omitted from the resulting object.\n - `identitystore` (`string`): Use this to override the default service endpoint URL When `null`, the `identitystore` field will be omitted from the resulting object.\n - `imagebuilder` (`string`): Use this to override the default service endpoint URL When `null`, the `imagebuilder` field will be omitted from the resulting object.\n - `inspector` (`string`): Use this to override the default service endpoint URL When `null`, the `inspector` field will be omitted from the resulting object.\n - `inspector2` (`string`): Use this to override the default service endpoint URL When `null`, the `inspector2` field will be omitted from the resulting object.\n - `inspectorv2` (`string`): Use this to override the default service endpoint URL When `null`, the `inspectorv2` field will be omitted from the resulting object.\n - `internetmonitor` (`string`): Use this to override the default service endpoint URL When `null`, the `internetmonitor` field will be omitted from the resulting object.\n - `iot` (`string`): Use this to override the default service endpoint URL When `null`, the `iot` field will be omitted from the resulting object.\n - `iotanalytics` (`string`): Use this to override the default service endpoint URL When `null`, the `iotanalytics` field will be omitted from the resulting object.\n - `iotevents` (`string`): Use this to override the default service endpoint URL When `null`, the `iotevents` field will be omitted from the resulting object.\n - `ivs` (`string`): Use this to override the default service endpoint URL When `null`, the `ivs` field will be omitted from the resulting object.\n - `ivschat` (`string`): Use this to override the default service endpoint URL When `null`, the `ivschat` field will be omitted from the resulting object.\n - `kafka` (`string`): Use this to override the default service endpoint URL When `null`, the `kafka` field will be omitted from the resulting object.\n - `kafkaconnect` (`string`): Use this to override the default service endpoint URL When `null`, the `kafkaconnect` field will be omitted from the resulting object.\n - `kendra` (`string`): Use this to override the default service endpoint URL When `null`, the `kendra` field will be omitted from the resulting object.\n - `keyspaces` (`string`): Use this to override the default service endpoint URL When `null`, the `keyspaces` field will be omitted from the resulting object.\n - `kinesis` (`string`): Use this to override the default service endpoint URL When `null`, the `kinesis` field will be omitted from the resulting object.\n - `kinesisanalytics` (`string`): Use this to override the default service endpoint URL When `null`, the `kinesisanalytics` field will be omitted from the resulting object.\n - `kinesisanalyticsv2` (`string`): Use this to override the default service endpoint URL When `null`, the `kinesisanalyticsv2` field will be omitted from the resulting object.\n - `kinesisvideo` (`string`): Use this to override the default service endpoint URL When `null`, the `kinesisvideo` field will be omitted from the resulting object.\n - `kms` (`string`): Use this to override the default service endpoint URL When `null`, the `kms` field will be omitted from the resulting object.\n - `lakeformation` (`string`): Use this to override the default service endpoint URL When `null`, the `lakeformation` field will be omitted from the resulting object.\n - `lambda` (`string`): Use this to override the default service endpoint URL When `null`, the `lambda` field will be omitted from the resulting object.\n - `lex` (`string`): Use this to override the default service endpoint URL When `null`, the `lex` field will be omitted from the resulting object.\n - `lexmodelbuilding` (`string`): Use this to override the default service endpoint URL When `null`, the `lexmodelbuilding` field will be omitted from the resulting object.\n - `lexmodelbuildingservice` (`string`): Use this to override the default service endpoint URL When `null`, the `lexmodelbuildingservice` field will be omitted from the resulting object.\n - `lexmodels` (`string`): Use this to override the default service endpoint URL When `null`, the `lexmodels` field will be omitted from the resulting object.\n - `lexmodelsv2` (`string`): Use this to override the default service endpoint URL When `null`, the `lexmodelsv2` field will be omitted from the resulting object.\n - `lexv2models` (`string`): Use this to override the default service endpoint URL When `null`, the `lexv2models` field will be omitted from the resulting object.\n - `licensemanager` (`string`): Use this to override the default service endpoint URL When `null`, the `licensemanager` field will be omitted from the resulting object.\n - `lightsail` (`string`): Use this to override the default service endpoint URL When `null`, the `lightsail` field will be omitted from the resulting object.\n - `location` (`string`): Use this to override the default service endpoint URL When `null`, the `location` field will be omitted from the resulting object.\n - `locationservice` (`string`): Use this to override the default service endpoint URL When `null`, the `locationservice` field will be omitted from the resulting object.\n - `logs` (`string`): Use this to override the default service endpoint URL When `null`, the `logs` field will be omitted from the resulting object.\n - `lookoutmetrics` (`string`): Use this to override the default service endpoint URL When `null`, the `lookoutmetrics` field will be omitted from the resulting object.\n - `macie2` (`string`): Use this to override the default service endpoint URL When `null`, the `macie2` field will be omitted from the resulting object.\n - `managedgrafana` (`string`): Use this to override the default service endpoint URL When `null`, the `managedgrafana` field will be omitted from the resulting object.\n - `mediaconnect` (`string`): Use this to override the default service endpoint URL When `null`, the `mediaconnect` field will be omitted from the resulting object.\n - `mediaconvert` (`string`): Use this to override the default service endpoint URL When `null`, the `mediaconvert` field will be omitted from the resulting object.\n - `medialive` (`string`): Use this to override the default service endpoint URL When `null`, the `medialive` field will be omitted from the resulting object.\n - `mediapackage` (`string`): Use this to override the default service endpoint URL When `null`, the `mediapackage` field will be omitted from the resulting object.\n - `mediapackagev2` (`string`): Use this to override the default service endpoint URL When `null`, the `mediapackagev2` field will be omitted from the resulting object.\n - `mediastore` (`string`): Use this to override the default service endpoint URL When `null`, the `mediastore` field will be omitted from the resulting object.\n - `memorydb` (`string`): Use this to override the default service endpoint URL When `null`, the `memorydb` field will be omitted from the resulting object.\n - `mq` (`string`): Use this to override the default service endpoint URL When `null`, the `mq` field will be omitted from the resulting object.\n - `msk` (`string`): Use this to override the default service endpoint URL When `null`, the `msk` field will be omitted from the resulting object.\n - `mwaa` (`string`): Use this to override the default service endpoint URL When `null`, the `mwaa` field will be omitted from the resulting object.\n - `neptune` (`string`): Use this to override the default service endpoint URL When `null`, the `neptune` field will be omitted from the resulting object.\n - `networkfirewall` (`string`): Use this to override the default service endpoint URL When `null`, the `networkfirewall` field will be omitted from the resulting object.\n - `networkmanager` (`string`): Use this to override the default service endpoint URL When `null`, the `networkmanager` field will be omitted from the resulting object.\n - `oam` (`string`): Use this to override the default service endpoint URL When `null`, the `oam` field will be omitted from the resulting object.\n - `opensearch` (`string`): Use this to override the default service endpoint URL When `null`, the `opensearch` field will be omitted from the resulting object.\n - `opensearchingestion` (`string`): Use this to override the default service endpoint URL When `null`, the `opensearchingestion` field will be omitted from the resulting object.\n - `opensearchserverless` (`string`): Use this to override the default service endpoint URL When `null`, the `opensearchserverless` field will be omitted from the resulting object.\n - `opensearchservice` (`string`): Use this to override the default service endpoint URL When `null`, the `opensearchservice` field will be omitted from the resulting object.\n - `opsworks` (`string`): Use this to override the default service endpoint URL When `null`, the `opsworks` field will be omitted from the resulting object.\n - `organizations` (`string`): Use this to override the default service endpoint URL When `null`, the `organizations` field will be omitted from the resulting object.\n - `osis` (`string`): Use this to override the default service endpoint URL When `null`, the `osis` field will be omitted from the resulting object.\n - `outposts` (`string`): Use this to override the default service endpoint URL When `null`, the `outposts` field will be omitted from the resulting object.\n - `pinpoint` (`string`): Use this to override the default service endpoint URL When `null`, the `pinpoint` field will be omitted from the resulting object.\n - `pipes` (`string`): Use this to override the default service endpoint URL When `null`, the `pipes` field will be omitted from the resulting object.\n - `pricing` (`string`): Use this to override the default service endpoint URL When `null`, the `pricing` field will be omitted from the resulting object.\n - `prometheus` (`string`): Use this to override the default service endpoint URL When `null`, the `prometheus` field will be omitted from the resulting object.\n - `prometheusservice` (`string`): Use this to override the default service endpoint URL When `null`, the `prometheusservice` field will be omitted from the resulting object.\n - `qldb` (`string`): Use this to override the default service endpoint URL When `null`, the `qldb` field will be omitted from the resulting object.\n - `quicksight` (`string`): Use this to override the default service endpoint URL When `null`, the `quicksight` field will be omitted from the resulting object.\n - `ram` (`string`): Use this to override the default service endpoint URL When `null`, the `ram` field will be omitted from the resulting object.\n - `rbin` (`string`): Use this to override the default service endpoint URL When `null`, the `rbin` field will be omitted from the resulting object.\n - `rds` (`string`): Use this to override the default service endpoint URL When `null`, the `rds` field will be omitted from the resulting object.\n - `recyclebin` (`string`): Use this to override the default service endpoint URL When `null`, the `recyclebin` field will be omitted from the resulting object.\n - `redshift` (`string`): Use this to override the default service endpoint URL When `null`, the `redshift` field will be omitted from the resulting object.\n - `redshiftdata` (`string`): Use this to override the default service endpoint URL When `null`, the `redshiftdata` field will be omitted from the resulting object.\n - `redshiftdataapiservice` (`string`): Use this to override the default service endpoint URL When `null`, the `redshiftdataapiservice` field will be omitted from the resulting object.\n - `redshiftserverless` (`string`): Use this to override the default service endpoint URL When `null`, the `redshiftserverless` field will be omitted from the resulting object.\n - `resourceexplorer2` (`string`): Use this to override the default service endpoint URL When `null`, the `resourceexplorer2` field will be omitted from the resulting object.\n - `resourcegroups` (`string`): Use this to override the default service endpoint URL When `null`, the `resourcegroups` field will be omitted from the resulting object.\n - `resourcegroupstagging` (`string`): Use this to override the default service endpoint URL When `null`, the `resourcegroupstagging` field will be omitted from the resulting object.\n - `resourcegroupstaggingapi` (`string`): Use this to override the default service endpoint URL When `null`, the `resourcegroupstaggingapi` field will be omitted from the resulting object.\n - `rolesanywhere` (`string`): Use this to override the default service endpoint URL When `null`, the `rolesanywhere` field will be omitted from the resulting object.\n - `route53` (`string`): Use this to override the default service endpoint URL When `null`, the `route53` field will be omitted from the resulting object.\n - `route53domains` (`string`): Use this to override the default service endpoint URL When `null`, the `route53domains` field will be omitted from the resulting object.\n - `route53recoverycontrolconfig` (`string`): Use this to override the default service endpoint URL When `null`, the `route53recoverycontrolconfig` field will be omitted from the resulting object.\n - `route53recoveryreadiness` (`string`): Use this to override the default service endpoint URL When `null`, the `route53recoveryreadiness` field will be omitted from the resulting object.\n - `route53resolver` (`string`): Use this to override the default service endpoint URL When `null`, the `route53resolver` field will be omitted from the resulting object.\n - `rum` (`string`): Use this to override the default service endpoint URL When `null`, the `rum` field will be omitted from the resulting object.\n - `s3` (`string`): Use this to override the default service endpoint URL When `null`, the `s3` field will be omitted from the resulting object.\n - `s3api` (`string`): Use this to override the default service endpoint URL When `null`, the `s3api` field will be omitted from the resulting object.\n - `s3control` (`string`): Use this to override the default service endpoint URL When `null`, the `s3control` field will be omitted from the resulting object.\n - `s3outposts` (`string`): Use this to override the default service endpoint URL When `null`, the `s3outposts` field will be omitted from the resulting object.\n - `sagemaker` (`string`): Use this to override the default service endpoint URL When `null`, the `sagemaker` field will be omitted from the resulting object.\n - `scheduler` (`string`): Use this to override the default service endpoint URL When `null`, the `scheduler` field will be omitted from the resulting object.\n - `schemas` (`string`): Use this to override the default service endpoint URL When `null`, the `schemas` field will be omitted from the resulting object.\n - `sdb` (`string`): Use this to override the default service endpoint URL When `null`, the `sdb` field will be omitted from the resulting object.\n - `secretsmanager` (`string`): Use this to override the default service endpoint URL When `null`, the `secretsmanager` field will be omitted from the resulting object.\n - `securityhub` (`string`): Use this to override the default service endpoint URL When `null`, the `securityhub` field will be omitted from the resulting object.\n - `securitylake` (`string`): Use this to override the default service endpoint URL When `null`, the `securitylake` field will be omitted from the resulting object.\n - `serverlessapplicationrepository` (`string`): Use this to override the default service endpoint URL When `null`, the `serverlessapplicationrepository` field will be omitted from the resulting object.\n - `serverlessapprepo` (`string`): Use this to override the default service endpoint URL When `null`, the `serverlessapprepo` field will be omitted from the resulting object.\n - `serverlessrepo` (`string`): Use this to override the default service endpoint URL When `null`, the `serverlessrepo` field will be omitted from the resulting object.\n - `servicecatalog` (`string`): Use this to override the default service endpoint URL When `null`, the `servicecatalog` field will be omitted from the resulting object.\n - `servicediscovery` (`string`): Use this to override the default service endpoint URL When `null`, the `servicediscovery` field will be omitted from the resulting object.\n - `servicequotas` (`string`): Use this to override the default service endpoint URL When `null`, the `servicequotas` field will be omitted from the resulting object.\n - `ses` (`string`): Use this to override the default service endpoint URL When `null`, the `ses` field will be omitted from the resulting object.\n - `sesv2` (`string`): Use this to override the default service endpoint URL When `null`, the `sesv2` field will be omitted from the resulting object.\n - `sfn` (`string`): Use this to override the default service endpoint URL When `null`, the `sfn` field will be omitted from the resulting object.\n - `shield` (`string`): Use this to override the default service endpoint URL When `null`, the `shield` field will be omitted from the resulting object.\n - `signer` (`string`): Use this to override the default service endpoint URL When `null`, the `signer` field will be omitted from the resulting object.\n - `simpledb` (`string`): Use this to override the default service endpoint URL When `null`, the `simpledb` field will be omitted from the resulting object.\n - `sns` (`string`): Use this to override the default service endpoint URL When `null`, the `sns` field will be omitted from the resulting object.\n - `sqs` (`string`): Use this to override the default service endpoint URL When `null`, the `sqs` field will be omitted from the resulting object.\n - `ssm` (`string`): Use this to override the default service endpoint URL When `null`, the `ssm` field will be omitted from the resulting object.\n - `ssmcontacts` (`string`): Use this to override the default service endpoint URL When `null`, the `ssmcontacts` field will be omitted from the resulting object.\n - `ssmincidents` (`string`): Use this to override the default service endpoint URL When `null`, the `ssmincidents` field will be omitted from the resulting object.\n - `sso` (`string`): Use this to override the default service endpoint URL When `null`, the `sso` field will be omitted from the resulting object.\n - `ssoadmin` (`string`): Use this to override the default service endpoint URL When `null`, the `ssoadmin` field will be omitted from the resulting object.\n - `stepfunctions` (`string`): Use this to override the default service endpoint URL When `null`, the `stepfunctions` field will be omitted from the resulting object.\n - `storagegateway` (`string`): Use this to override the default service endpoint URL When `null`, the `storagegateway` field will be omitted from the resulting object.\n - `sts` (`string`): Use this to override the default service endpoint URL When `null`, the `sts` field will be omitted from the resulting object.\n - `swf` (`string`): Use this to override the default service endpoint URL When `null`, the `swf` field will be omitted from the resulting object.\n - `synthetics` (`string`): Use this to override the default service endpoint URL When `null`, the `synthetics` field will be omitted from the resulting object.\n - `timestreamwrite` (`string`): Use this to override the default service endpoint URL When `null`, the `timestreamwrite` field will be omitted from the resulting object.\n - `transcribe` (`string`): Use this to override the default service endpoint URL When `null`, the `transcribe` field will be omitted from the resulting object.\n - `transcribeservice` (`string`): Use this to override the default service endpoint URL When `null`, the `transcribeservice` field will be omitted from the resulting object.\n - `transfer` (`string`): Use this to override the default service endpoint URL When `null`, the `transfer` field will be omitted from the resulting object.\n - `verifiedpermissions` (`string`): Use this to override the default service endpoint URL When `null`, the `verifiedpermissions` field will be omitted from the resulting object.\n - `vpclattice` (`string`): Use this to override the default service endpoint URL When `null`, the `vpclattice` field will be omitted from the resulting object.\n - `waf` (`string`): Use this to override the default service endpoint URL When `null`, the `waf` field will be omitted from the resulting object.\n - `wafregional` (`string`): Use this to override the default service endpoint URL When `null`, the `wafregional` field will be omitted from the resulting object.\n - `wafv2` (`string`): Use this to override the default service endpoint URL When `null`, the `wafv2` field will be omitted from the resulting object.\n - `worklink` (`string`): Use this to override the default service endpoint URL When `null`, the `worklink` field will be omitted from the resulting object.\n - `workspaces` (`string`): Use this to override the default service endpoint URL When `null`, the `workspaces` field will be omitted from the resulting object.\n - `xray` (`string`): Use this to override the default service endpoint URL When `null`, the `xray` field will be omitted from the resulting object.\n\n**Returns**:\n - An attribute object that represents the `endpoints` sub block.\n', args=[]), new( accessanalyzer=null, account=null, @@ -363,6 +363,7 @@ local d = (import 'github.com/jsonnet-libs/docsonnet/doc-util/main.libsonnet'); location=null, locationservice=null, logs=null, + lookoutmetrics=null, macie2=null, managedgrafana=null, mediaconnect=null, @@ -622,6 +623,7 @@ local d = (import 'github.com/jsonnet-libs/docsonnet/doc-util/main.libsonnet'); location: location, locationservice: locationservice, logs: logs, + lookoutmetrics: lookoutmetrics, macie2: macie2, managedgrafana: managedgrafana, mediaconnect: mediaconnect, diff --git a/5.x/_gen/resources/alb.libsonnet b/5.x/_gen/resources/alb.libsonnet index 65d45758..5c5deb0d 100644 --- a/5.x/_gen/resources/alb.libsonnet +++ b/5.x/_gen/resources/alb.libsonnet @@ -14,7 +14,7 @@ local d = (import 'github.com/jsonnet-libs/docsonnet/doc-util/main.libsonnet'); prefix: prefix, }), }, - '#new':: d.fn(help="\n`aws.alb.new` injects a new `aws_alb` 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.alb.new('some_id')\n\nYou can get the reference to the `id` field of the created `aws.alb` using the reference:\n\n $._ref.aws_alb.some_id.get('id')\n\nThis is the same as directly entering `\"${ aws_alb.some_id.id }\"` as the value.\n\nNOTE: if you are chaining multiple resources together in a merge operation, you may not be able to use `super`, `self`,\nor `$` to refer to the root object. Instead, make an explicit outer object using `local`.\n\n**Args**:\n - `resourceLabel` (`string`): The name label of the block.\n - `customer_owned_ipv4_pool` (`string`): Set the `customer_owned_ipv4_pool` field on the resulting resource block. When `null`, the `customer_owned_ipv4_pool` field will be omitted from the resulting object.\n - `desync_mitigation_mode` (`string`): Set the `desync_mitigation_mode` field on the resulting resource block. When `null`, the `desync_mitigation_mode` field will be omitted from the resulting object.\n - `dns_record_client_routing_policy` (`string`): Set the `dns_record_client_routing_policy` field on the resulting resource block. When `null`, the `dns_record_client_routing_policy` field will be omitted from the resulting object.\n - `drop_invalid_header_fields` (`bool`): Set the `drop_invalid_header_fields` field on the resulting resource block. When `null`, the `drop_invalid_header_fields` field will be omitted from the resulting object.\n - `enable_cross_zone_load_balancing` (`bool`): Set the `enable_cross_zone_load_balancing` field on the resulting resource block. When `null`, the `enable_cross_zone_load_balancing` field will be omitted from the resulting object.\n - `enable_deletion_protection` (`bool`): Set the `enable_deletion_protection` field on the resulting resource block. When `null`, the `enable_deletion_protection` field will be omitted from the resulting object.\n - `enable_http2` (`bool`): Set the `enable_http2` field on the resulting resource block. When `null`, the `enable_http2` field will be omitted from the resulting object.\n - `enable_tls_version_and_cipher_suite_headers` (`bool`): Set the `enable_tls_version_and_cipher_suite_headers` field on the resulting resource block. When `null`, the `enable_tls_version_and_cipher_suite_headers` field will be omitted from the resulting object.\n - `enable_waf_fail_open` (`bool`): Set the `enable_waf_fail_open` field on the resulting resource block. When `null`, the `enable_waf_fail_open` field will be omitted from the resulting object.\n - `enable_xff_client_port` (`bool`): Set the `enable_xff_client_port` field on the resulting resource block. When `null`, the `enable_xff_client_port` field will be omitted from the resulting object.\n - `idle_timeout` (`number`): Set the `idle_timeout` field on the resulting resource block. When `null`, the `idle_timeout` field will be omitted from the resulting object.\n - `internal` (`bool`): Set the `internal` field on the resulting resource block. When `null`, the `internal` field will be omitted from the resulting object.\n - `ip_address_type` (`string`): Set the `ip_address_type` field on the resulting resource block. When `null`, the `ip_address_type` field will be omitted from the resulting object.\n - `load_balancer_type` (`string`): Set the `load_balancer_type` field on the resulting resource block. When `null`, the `load_balancer_type` field will be omitted from the resulting object.\n - `name` (`string`): Set the `name` field on the resulting resource block. When `null`, the `name` field will be omitted from the resulting object.\n - `name_prefix` (`string`): Set the `name_prefix` field on the resulting resource block. When `null`, the `name_prefix` field will be omitted from the resulting object.\n - `preserve_host_header` (`bool`): Set the `preserve_host_header` field on the resulting resource block. When `null`, the `preserve_host_header` field will be omitted from the resulting object.\n - `security_groups` (`list`): Set the `security_groups` field on the resulting resource block. When `null`, the `security_groups` field will be omitted from the resulting object.\n - `subnets` (`list`): Set the `subnets` field on the resulting resource block. When `null`, the `subnets` 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 - `xff_header_processing_mode` (`string`): Set the `xff_header_processing_mode` field on the resulting resource block. When `null`, the `xff_header_processing_mode` field will be omitted from the resulting object.\n - `access_logs` (`list[obj]`): Set the `access_logs` field on the resulting resource block. When `null`, the `access_logs` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [aws.alb.access_logs.new](#fn-access_logsnew) constructor.\n - `subnet_mapping` (`list[obj]`): Set the `subnet_mapping` field on the resulting resource block. When `null`, the `subnet_mapping` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [aws.alb.subnet_mapping.new](#fn-subnet_mappingnew) constructor.\n - `timeouts` (`obj`): Set the `timeouts` field on the resulting resource block. When `null`, the `timeouts` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [aws.alb.timeouts.new](#fn-timeoutsnew) constructor.\n\n**Returns**:\n- A mixin object that injects the new resource into the root Terraform configuration.\n", args=[]), + '#new':: d.fn(help="\n`aws.alb.new` injects a new `aws_alb` 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.alb.new('some_id')\n\nYou can get the reference to the `id` field of the created `aws.alb` using the reference:\n\n $._ref.aws_alb.some_id.get('id')\n\nThis is the same as directly entering `\"${ aws_alb.some_id.id }\"` as the value.\n\nNOTE: if you are chaining multiple resources together in a merge operation, you may not be able to use `super`, `self`,\nor `$` to refer to the root object. Instead, make an explicit outer object using `local`.\n\n**Args**:\n - `resourceLabel` (`string`): The name label of the block.\n - `customer_owned_ipv4_pool` (`string`): Set the `customer_owned_ipv4_pool` field on the resulting resource block. When `null`, the `customer_owned_ipv4_pool` field will be omitted from the resulting object.\n - `desync_mitigation_mode` (`string`): Set the `desync_mitigation_mode` field on the resulting resource block. When `null`, the `desync_mitigation_mode` field will be omitted from the resulting object.\n - `dns_record_client_routing_policy` (`string`): Set the `dns_record_client_routing_policy` field on the resulting resource block. When `null`, the `dns_record_client_routing_policy` field will be omitted from the resulting object.\n - `drop_invalid_header_fields` (`bool`): Set the `drop_invalid_header_fields` field on the resulting resource block. When `null`, the `drop_invalid_header_fields` field will be omitted from the resulting object.\n - `enable_cross_zone_load_balancing` (`bool`): Set the `enable_cross_zone_load_balancing` field on the resulting resource block. When `null`, the `enable_cross_zone_load_balancing` field will be omitted from the resulting object.\n - `enable_deletion_protection` (`bool`): Set the `enable_deletion_protection` field on the resulting resource block. When `null`, the `enable_deletion_protection` field will be omitted from the resulting object.\n - `enable_http2` (`bool`): Set the `enable_http2` field on the resulting resource block. When `null`, the `enable_http2` field will be omitted from the resulting object.\n - `enable_tls_version_and_cipher_suite_headers` (`bool`): Set the `enable_tls_version_and_cipher_suite_headers` field on the resulting resource block. When `null`, the `enable_tls_version_and_cipher_suite_headers` field will be omitted from the resulting object.\n - `enable_waf_fail_open` (`bool`): Set the `enable_waf_fail_open` field on the resulting resource block. When `null`, the `enable_waf_fail_open` field will be omitted from the resulting object.\n - `enable_xff_client_port` (`bool`): Set the `enable_xff_client_port` field on the resulting resource block. When `null`, the `enable_xff_client_port` field will be omitted from the resulting object.\n - `enforce_security_group_inbound_rules_on_private_link_traffic` (`string`): Set the `enforce_security_group_inbound_rules_on_private_link_traffic` field on the resulting resource block. When `null`, the `enforce_security_group_inbound_rules_on_private_link_traffic` field will be omitted from the resulting object.\n - `idle_timeout` (`number`): Set the `idle_timeout` field on the resulting resource block. When `null`, the `idle_timeout` field will be omitted from the resulting object.\n - `internal` (`bool`): Set the `internal` field on the resulting resource block. When `null`, the `internal` field will be omitted from the resulting object.\n - `ip_address_type` (`string`): Set the `ip_address_type` field on the resulting resource block. When `null`, the `ip_address_type` field will be omitted from the resulting object.\n - `load_balancer_type` (`string`): Set the `load_balancer_type` field on the resulting resource block. When `null`, the `load_balancer_type` field will be omitted from the resulting object.\n - `name` (`string`): Set the `name` field on the resulting resource block. When `null`, the `name` field will be omitted from the resulting object.\n - `name_prefix` (`string`): Set the `name_prefix` field on the resulting resource block. When `null`, the `name_prefix` field will be omitted from the resulting object.\n - `preserve_host_header` (`bool`): Set the `preserve_host_header` field on the resulting resource block. When `null`, the `preserve_host_header` field will be omitted from the resulting object.\n - `security_groups` (`list`): Set the `security_groups` field on the resulting resource block. When `null`, the `security_groups` field will be omitted from the resulting object.\n - `subnets` (`list`): Set the `subnets` field on the resulting resource block. When `null`, the `subnets` 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 - `xff_header_processing_mode` (`string`): Set the `xff_header_processing_mode` field on the resulting resource block. When `null`, the `xff_header_processing_mode` field will be omitted from the resulting object.\n - `access_logs` (`list[obj]`): Set the `access_logs` field on the resulting resource block. When `null`, the `access_logs` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [aws.alb.access_logs.new](#fn-access_logsnew) constructor.\n - `subnet_mapping` (`list[obj]`): Set the `subnet_mapping` field on the resulting resource block. When `null`, the `subnet_mapping` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [aws.alb.subnet_mapping.new](#fn-subnet_mappingnew) constructor.\n - `timeouts` (`obj`): Set the `timeouts` field on the resulting resource block. When `null`, the `timeouts` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [aws.alb.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, access_logs=null, @@ -28,6 +28,7 @@ local d = (import 'github.com/jsonnet-libs/docsonnet/doc-util/main.libsonnet'); enable_tls_version_and_cipher_suite_headers=null, enable_waf_fail_open=null, enable_xff_client_port=null, + enforce_security_group_inbound_rules_on_private_link_traffic=null, idle_timeout=null, internal=null, ip_address_type=null, @@ -58,6 +59,7 @@ local d = (import 'github.com/jsonnet-libs/docsonnet/doc-util/main.libsonnet'); enable_tls_version_and_cipher_suite_headers=enable_tls_version_and_cipher_suite_headers, enable_waf_fail_open=enable_waf_fail_open, enable_xff_client_port=enable_xff_client_port, + enforce_security_group_inbound_rules_on_private_link_traffic=enforce_security_group_inbound_rules_on_private_link_traffic, idle_timeout=idle_timeout, internal=internal, ip_address_type=ip_address_type, @@ -75,7 +77,7 @@ local d = (import 'github.com/jsonnet-libs/docsonnet/doc-util/main.libsonnet'); ), _meta=_meta ), - '#newAttrs':: d.fn(help='\n`aws.alb.newAttrs` constructs a new object with attributes and blocks configured for the `alb`\nTerraform resource.\n\nUnlike [aws.alb.new](#fn-new), this function will not inject the `resource`\nblock into the root Terraform document. Instead, this must be passed in as the `attrs` argument for the\n[tf.withResource](https://github.com/tf-libsonnet/core/tree/main/docs#fn-withresource) function to build a complete block.\n\nThis is most useful when you need to preprocess the attributes with functions, conditional, or looping logic prior to\ninjecting into a complete block.\n\n**Args**:\n - `customer_owned_ipv4_pool` (`string`): Set the `customer_owned_ipv4_pool` field on the resulting object. When `null`, the `customer_owned_ipv4_pool` field will be omitted from the resulting object.\n - `desync_mitigation_mode` (`string`): Set the `desync_mitigation_mode` field on the resulting object. When `null`, the `desync_mitigation_mode` field will be omitted from the resulting object.\n - `dns_record_client_routing_policy` (`string`): Set the `dns_record_client_routing_policy` field on the resulting object. When `null`, the `dns_record_client_routing_policy` field will be omitted from the resulting object.\n - `drop_invalid_header_fields` (`bool`): Set the `drop_invalid_header_fields` field on the resulting object. When `null`, the `drop_invalid_header_fields` field will be omitted from the resulting object.\n - `enable_cross_zone_load_balancing` (`bool`): Set the `enable_cross_zone_load_balancing` field on the resulting object. When `null`, the `enable_cross_zone_load_balancing` field will be omitted from the resulting object.\n - `enable_deletion_protection` (`bool`): Set the `enable_deletion_protection` field on the resulting object. When `null`, the `enable_deletion_protection` field will be omitted from the resulting object.\n - `enable_http2` (`bool`): Set the `enable_http2` field on the resulting object. When `null`, the `enable_http2` field will be omitted from the resulting object.\n - `enable_tls_version_and_cipher_suite_headers` (`bool`): Set the `enable_tls_version_and_cipher_suite_headers` field on the resulting object. When `null`, the `enable_tls_version_and_cipher_suite_headers` field will be omitted from the resulting object.\n - `enable_waf_fail_open` (`bool`): Set the `enable_waf_fail_open` field on the resulting object. When `null`, the `enable_waf_fail_open` field will be omitted from the resulting object.\n - `enable_xff_client_port` (`bool`): Set the `enable_xff_client_port` field on the resulting object. When `null`, the `enable_xff_client_port` field will be omitted from the resulting object.\n - `idle_timeout` (`number`): Set the `idle_timeout` field on the resulting object. When `null`, the `idle_timeout` field will be omitted from the resulting object.\n - `internal` (`bool`): Set the `internal` field on the resulting object. When `null`, the `internal` field will be omitted from the resulting object.\n - `ip_address_type` (`string`): Set the `ip_address_type` field on the resulting object. When `null`, the `ip_address_type` field will be omitted from the resulting object.\n - `load_balancer_type` (`string`): Set the `load_balancer_type` field on the resulting object. When `null`, the `load_balancer_type` field will be omitted from the resulting object.\n - `name` (`string`): Set the `name` field on the resulting object. When `null`, the `name` field will be omitted from the resulting object.\n - `name_prefix` (`string`): Set the `name_prefix` field on the resulting object. When `null`, the `name_prefix` field will be omitted from the resulting object.\n - `preserve_host_header` (`bool`): Set the `preserve_host_header` field on the resulting object. When `null`, the `preserve_host_header` field will be omitted from the resulting object.\n - `security_groups` (`list`): Set the `security_groups` field on the resulting object. When `null`, the `security_groups` field will be omitted from the resulting object.\n - `subnets` (`list`): Set the `subnets` field on the resulting object. When `null`, the `subnets` 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 - `xff_header_processing_mode` (`string`): Set the `xff_header_processing_mode` field on the resulting object. When `null`, the `xff_header_processing_mode` field will be omitted from the resulting object.\n - `access_logs` (`list[obj]`): Set the `access_logs` field on the resulting object. When `null`, the `access_logs` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [aws.alb.access_logs.new](#fn-access_logsnew) constructor.\n - `subnet_mapping` (`list[obj]`): Set the `subnet_mapping` field on the resulting object. When `null`, the `subnet_mapping` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [aws.alb.subnet_mapping.new](#fn-subnet_mappingnew) constructor.\n - `timeouts` (`obj`): Set the `timeouts` field on the resulting object. When `null`, the `timeouts` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [aws.alb.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 `alb` resource into the root Terraform configuration.\n', args=[]), + '#newAttrs':: d.fn(help='\n`aws.alb.newAttrs` constructs a new object with attributes and blocks configured for the `alb`\nTerraform resource.\n\nUnlike [aws.alb.new](#fn-new), this function will not inject the `resource`\nblock into the root Terraform document. Instead, this must be passed in as the `attrs` argument for the\n[tf.withResource](https://github.com/tf-libsonnet/core/tree/main/docs#fn-withresource) function to build a complete block.\n\nThis is most useful when you need to preprocess the attributes with functions, conditional, or looping logic prior to\ninjecting into a complete block.\n\n**Args**:\n - `customer_owned_ipv4_pool` (`string`): Set the `customer_owned_ipv4_pool` field on the resulting object. When `null`, the `customer_owned_ipv4_pool` field will be omitted from the resulting object.\n - `desync_mitigation_mode` (`string`): Set the `desync_mitigation_mode` field on the resulting object. When `null`, the `desync_mitigation_mode` field will be omitted from the resulting object.\n - `dns_record_client_routing_policy` (`string`): Set the `dns_record_client_routing_policy` field on the resulting object. When `null`, the `dns_record_client_routing_policy` field will be omitted from the resulting object.\n - `drop_invalid_header_fields` (`bool`): Set the `drop_invalid_header_fields` field on the resulting object. When `null`, the `drop_invalid_header_fields` field will be omitted from the resulting object.\n - `enable_cross_zone_load_balancing` (`bool`): Set the `enable_cross_zone_load_balancing` field on the resulting object. When `null`, the `enable_cross_zone_load_balancing` field will be omitted from the resulting object.\n - `enable_deletion_protection` (`bool`): Set the `enable_deletion_protection` field on the resulting object. When `null`, the `enable_deletion_protection` field will be omitted from the resulting object.\n - `enable_http2` (`bool`): Set the `enable_http2` field on the resulting object. When `null`, the `enable_http2` field will be omitted from the resulting object.\n - `enable_tls_version_and_cipher_suite_headers` (`bool`): Set the `enable_tls_version_and_cipher_suite_headers` field on the resulting object. When `null`, the `enable_tls_version_and_cipher_suite_headers` field will be omitted from the resulting object.\n - `enable_waf_fail_open` (`bool`): Set the `enable_waf_fail_open` field on the resulting object. When `null`, the `enable_waf_fail_open` field will be omitted from the resulting object.\n - `enable_xff_client_port` (`bool`): Set the `enable_xff_client_port` field on the resulting object. When `null`, the `enable_xff_client_port` field will be omitted from the resulting object.\n - `enforce_security_group_inbound_rules_on_private_link_traffic` (`string`): Set the `enforce_security_group_inbound_rules_on_private_link_traffic` field on the resulting object. When `null`, the `enforce_security_group_inbound_rules_on_private_link_traffic` field will be omitted from the resulting object.\n - `idle_timeout` (`number`): Set the `idle_timeout` field on the resulting object. When `null`, the `idle_timeout` field will be omitted from the resulting object.\n - `internal` (`bool`): Set the `internal` field on the resulting object. When `null`, the `internal` field will be omitted from the resulting object.\n - `ip_address_type` (`string`): Set the `ip_address_type` field on the resulting object. When `null`, the `ip_address_type` field will be omitted from the resulting object.\n - `load_balancer_type` (`string`): Set the `load_balancer_type` field on the resulting object. When `null`, the `load_balancer_type` field will be omitted from the resulting object.\n - `name` (`string`): Set the `name` field on the resulting object. When `null`, the `name` field will be omitted from the resulting object.\n - `name_prefix` (`string`): Set the `name_prefix` field on the resulting object. When `null`, the `name_prefix` field will be omitted from the resulting object.\n - `preserve_host_header` (`bool`): Set the `preserve_host_header` field on the resulting object. When `null`, the `preserve_host_header` field will be omitted from the resulting object.\n - `security_groups` (`list`): Set the `security_groups` field on the resulting object. When `null`, the `security_groups` field will be omitted from the resulting object.\n - `subnets` (`list`): Set the `subnets` field on the resulting object. When `null`, the `subnets` 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 - `xff_header_processing_mode` (`string`): Set the `xff_header_processing_mode` field on the resulting object. When `null`, the `xff_header_processing_mode` field will be omitted from the resulting object.\n - `access_logs` (`list[obj]`): Set the `access_logs` field on the resulting object. When `null`, the `access_logs` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [aws.alb.access_logs.new](#fn-access_logsnew) constructor.\n - `subnet_mapping` (`list[obj]`): Set the `subnet_mapping` field on the resulting object. When `null`, the `subnet_mapping` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [aws.alb.subnet_mapping.new](#fn-subnet_mappingnew) constructor.\n - `timeouts` (`obj`): Set the `timeouts` field on the resulting object. When `null`, the `timeouts` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [aws.alb.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 `alb` resource into the root Terraform configuration.\n', args=[]), newAttrs( access_logs=null, customer_owned_ipv4_pool=null, @@ -88,6 +90,7 @@ local d = (import 'github.com/jsonnet-libs/docsonnet/doc-util/main.libsonnet'); enable_tls_version_and_cipher_suite_headers=null, enable_waf_fail_open=null, enable_xff_client_port=null, + enforce_security_group_inbound_rules_on_private_link_traffic=null, idle_timeout=null, internal=null, ip_address_type=null, @@ -114,6 +117,7 @@ local d = (import 'github.com/jsonnet-libs/docsonnet/doc-util/main.libsonnet'); enable_tls_version_and_cipher_suite_headers: enable_tls_version_and_cipher_suite_headers, enable_waf_fail_open: enable_waf_fail_open, enable_xff_client_port: enable_xff_client_port, + enforce_security_group_inbound_rules_on_private_link_traffic: enforce_security_group_inbound_rules_on_private_link_traffic, idle_timeout: idle_timeout, internal: internal, ip_address_type: ip_address_type, @@ -275,6 +279,16 @@ local d = (import 'github.com/jsonnet-libs/docsonnet/doc-util/main.libsonnet'); }, }, }, + '#withEnforceSecurityGroupInboundRulesOnPrivateLinkTraffic':: d.fn(help='`aws.string.withEnforceSecurityGroupInboundRulesOnPrivateLinkTraffic` constructs a mixin object that can be merged into the `string`\nTerraform resource block to set or update the enforce_security_group_inbound_rules_on_private_link_traffic 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 `enforce_security_group_inbound_rules_on_private_link_traffic` field.\n', args=[]), + withEnforceSecurityGroupInboundRulesOnPrivateLinkTraffic(resourceLabel, value): { + resource+: { + aws_alb+: { + [resourceLabel]+: { + enforce_security_group_inbound_rules_on_private_link_traffic: value, + }, + }, + }, + }, '#withIdleTimeout':: d.fn(help='`aws.number.withIdleTimeout` constructs a mixin object that can be merged into the `number`\nTerraform resource block to set or update the idle_timeout 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 `idle_timeout` field.\n', args=[]), withIdleTimeout(resourceLabel, value): { resource+: { diff --git a/5.x/_gen/resources/alb_listener.libsonnet b/5.x/_gen/resources/alb_listener.libsonnet index 19f49872..f841c737 100644 --- a/5.x/_gen/resources/alb_listener.libsonnet +++ b/5.x/_gen/resources/alb_listener.libsonnet @@ -134,13 +134,26 @@ local d = (import 'github.com/jsonnet-libs/docsonnet/doc-util/main.libsonnet'); }), }, }, - '#new':: d.fn(help="\n`aws.alb_listener.new` injects a new `aws_alb_listener` 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.alb_listener.new('some_id')\n\nYou can get the reference to the `id` field of the created `aws.alb_listener` using the reference:\n\n $._ref.aws_alb_listener.some_id.get('id')\n\nThis is the same as directly entering `\"${ aws_alb_listener.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 - `alpn_policy` (`string`): Set the `alpn_policy` field on the resulting resource block. When `null`, the `alpn_policy` field will be omitted from the resulting object.\n - `certificate_arn` (`string`): Set the `certificate_arn` field on the resulting resource block. When `null`, the `certificate_arn` field will be omitted from the resulting object.\n - `load_balancer_arn` (`string`): Set the `load_balancer_arn` field on the resulting resource block.\n - `port` (`number`): Set the `port` field on the resulting resource block. When `null`, the `port` field will be omitted from the resulting object.\n - `protocol` (`string`): Set the `protocol` field on the resulting resource block. When `null`, the `protocol` field will be omitted from the resulting object.\n - `ssl_policy` (`string`): Set the `ssl_policy` field on the resulting resource block. When `null`, the `ssl_policy` 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 - `default_action` (`list[obj]`): Set the `default_action` field on the resulting resource block. When `null`, the `default_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.alb_listener.default_action.new](#fn-default_actionnew) constructor.\n - `timeouts` (`obj`): Set the `timeouts` field on the resulting resource block. When `null`, the `timeouts` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [aws.alb_listener.timeouts.new](#fn-timeoutsnew) constructor.\n\n**Returns**:\n- A mixin object that injects the new resource into the root Terraform configuration.\n", args=[]), + mutual_authentication:: { + '#new':: d.fn(help='\n`aws.alb_listener.mutual_authentication.new` constructs a new object with attributes and blocks configured for the `mutual_authentication`\nTerraform sub block.\n\n\n\n**Args**:\n - `ignore_client_certificate_expiry` (`bool`): Set the `ignore_client_certificate_expiry` field on the resulting object. When `null`, the `ignore_client_certificate_expiry` field will be omitted from the resulting object.\n - `mode` (`string`): Set the `mode` field on the resulting object.\n - `trust_store_arn` (`string`): Set the `trust_store_arn` field on the resulting object. When `null`, the `trust_store_arn` field will be omitted from the resulting object.\n\n**Returns**:\n - An attribute object that represents the `mutual_authentication` sub block.\n', args=[]), + new( + mode, + ignore_client_certificate_expiry=null, + trust_store_arn=null + ):: std.prune(a={ + ignore_client_certificate_expiry: ignore_client_certificate_expiry, + mode: mode, + trust_store_arn: trust_store_arn, + }), + }, + '#new':: d.fn(help="\n`aws.alb_listener.new` injects a new `aws_alb_listener` 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.alb_listener.new('some_id')\n\nYou can get the reference to the `id` field of the created `aws.alb_listener` using the reference:\n\n $._ref.aws_alb_listener.some_id.get('id')\n\nThis is the same as directly entering `\"${ aws_alb_listener.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 - `alpn_policy` (`string`): Set the `alpn_policy` field on the resulting resource block. When `null`, the `alpn_policy` field will be omitted from the resulting object.\n - `certificate_arn` (`string`): Set the `certificate_arn` field on the resulting resource block. When `null`, the `certificate_arn` field will be omitted from the resulting object.\n - `load_balancer_arn` (`string`): Set the `load_balancer_arn` field on the resulting resource block.\n - `port` (`number`): Set the `port` field on the resulting resource block. When `null`, the `port` field will be omitted from the resulting object.\n - `protocol` (`string`): Set the `protocol` field on the resulting resource block. When `null`, the `protocol` field will be omitted from the resulting object.\n - `ssl_policy` (`string`): Set the `ssl_policy` field on the resulting resource block. When `null`, the `ssl_policy` 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 - `default_action` (`list[obj]`): Set the `default_action` field on the resulting resource block. When `null`, the `default_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.alb_listener.default_action.new](#fn-default_actionnew) constructor.\n - `mutual_authentication` (`list[obj]`): Set the `mutual_authentication` field on the resulting resource block. When `null`, the `mutual_authentication` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [aws.alb_listener.mutual_authentication.new](#fn-mutual_authenticationnew) constructor.\n - `timeouts` (`obj`): Set the `timeouts` field on the resulting resource block. When `null`, the `timeouts` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [aws.alb_listener.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, load_balancer_arn, alpn_policy=null, certificate_arn=null, default_action=null, + mutual_authentication=null, port=null, protocol=null, ssl_policy=null, @@ -156,6 +169,7 @@ local d = (import 'github.com/jsonnet-libs/docsonnet/doc-util/main.libsonnet'); certificate_arn=certificate_arn, default_action=default_action, load_balancer_arn=load_balancer_arn, + mutual_authentication=mutual_authentication, port=port, protocol=protocol, ssl_policy=ssl_policy, @@ -165,12 +179,13 @@ local d = (import 'github.com/jsonnet-libs/docsonnet/doc-util/main.libsonnet'); ), _meta=_meta ), - '#newAttrs':: d.fn(help='\n`aws.alb_listener.newAttrs` constructs a new object with attributes and blocks configured for the `alb_listener`\nTerraform resource.\n\nUnlike [aws.alb_listener.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 - `alpn_policy` (`string`): Set the `alpn_policy` field on the resulting object. When `null`, the `alpn_policy` field will be omitted from the resulting object.\n - `certificate_arn` (`string`): Set the `certificate_arn` field on the resulting object. When `null`, the `certificate_arn` field will be omitted from the resulting object.\n - `load_balancer_arn` (`string`): Set the `load_balancer_arn` field on the resulting object.\n - `port` (`number`): Set the `port` field on the resulting object. When `null`, the `port` field will be omitted from the resulting object.\n - `protocol` (`string`): Set the `protocol` field on the resulting object. When `null`, the `protocol` field will be omitted from the resulting object.\n - `ssl_policy` (`string`): Set the `ssl_policy` field on the resulting object. When `null`, the `ssl_policy` 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 - `default_action` (`list[obj]`): Set the `default_action` field on the resulting object. When `null`, the `default_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.alb_listener.default_action.new](#fn-default_actionnew) constructor.\n - `timeouts` (`obj`): Set the `timeouts` field on the resulting object. When `null`, the `timeouts` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [aws.alb_listener.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 `alb_listener` resource into the root Terraform configuration.\n', args=[]), + '#newAttrs':: d.fn(help='\n`aws.alb_listener.newAttrs` constructs a new object with attributes and blocks configured for the `alb_listener`\nTerraform resource.\n\nUnlike [aws.alb_listener.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 - `alpn_policy` (`string`): Set the `alpn_policy` field on the resulting object. When `null`, the `alpn_policy` field will be omitted from the resulting object.\n - `certificate_arn` (`string`): Set the `certificate_arn` field on the resulting object. When `null`, the `certificate_arn` field will be omitted from the resulting object.\n - `load_balancer_arn` (`string`): Set the `load_balancer_arn` field on the resulting object.\n - `port` (`number`): Set the `port` field on the resulting object. When `null`, the `port` field will be omitted from the resulting object.\n - `protocol` (`string`): Set the `protocol` field on the resulting object. When `null`, the `protocol` field will be omitted from the resulting object.\n - `ssl_policy` (`string`): Set the `ssl_policy` field on the resulting object. When `null`, the `ssl_policy` 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 - `default_action` (`list[obj]`): Set the `default_action` field on the resulting object. When `null`, the `default_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.alb_listener.default_action.new](#fn-default_actionnew) constructor.\n - `mutual_authentication` (`list[obj]`): Set the `mutual_authentication` field on the resulting object. When `null`, the `mutual_authentication` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [aws.alb_listener.mutual_authentication.new](#fn-mutual_authenticationnew) constructor.\n - `timeouts` (`obj`): Set the `timeouts` field on the resulting object. When `null`, the `timeouts` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [aws.alb_listener.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 `alb_listener` resource into the root Terraform configuration.\n', args=[]), newAttrs( load_balancer_arn, alpn_policy=null, certificate_arn=null, default_action=null, + mutual_authentication=null, port=null, protocol=null, ssl_policy=null, @@ -182,6 +197,7 @@ local d = (import 'github.com/jsonnet-libs/docsonnet/doc-util/main.libsonnet'); certificate_arn: certificate_arn, default_action: default_action, load_balancer_arn: load_balancer_arn, + mutual_authentication: mutual_authentication, port: port, protocol: protocol, ssl_policy: ssl_policy, @@ -190,11 +206,13 @@ local d = (import 'github.com/jsonnet-libs/docsonnet/doc-util/main.libsonnet'); timeouts: timeouts, }), timeouts:: { - '#new':: d.fn(help='\n`aws.alb_listener.timeouts.new` constructs a new object with attributes and blocks configured for the `timeouts`\nTerraform sub block.\n\n\n\n**Args**:\n - `read` (`string`): Set the `read` field on the resulting object. When `null`, the `read` field will be omitted from the resulting object.\n\n**Returns**:\n - An attribute object that represents the `timeouts` sub block.\n', args=[]), + '#new':: d.fn(help='\n`aws.alb_listener.timeouts.new` constructs a new object with attributes and blocks configured for the `timeouts`\nTerraform sub block.\n\n\n\n**Args**:\n - `create` (`string`): Set the `create` field on the resulting object. When `null`, the `create` field will be omitted from the resulting object.\n - `update` (`string`): Set the `update` field on the resulting object. When `null`, the `update` field will be omitted from the resulting object.\n\n**Returns**:\n - An attribute object that represents the `timeouts` sub block.\n', args=[]), new( - read=null + create=null, + update=null ):: std.prune(a={ - read: read, + create: create, + update: update, }), }, '#withAlpnPolicy':: d.fn(help='`aws.string.withAlpnPolicy` constructs a mixin object that can be merged into the `string`\nTerraform resource block to set or update the alpn_policy field.\n\n\n\n**Args**:\n - `resourceLabel` (`string`): The name label of the block to update.\n - `value` (`string`): The value to set for the `alpn_policy` field.\n', args=[]), @@ -247,6 +265,26 @@ local d = (import 'github.com/jsonnet-libs/docsonnet/doc-util/main.libsonnet'); }, }, }, + '#withMutualAuthentication':: d.fn(help='`aws.list[obj].withMutualAuthentication` constructs a mixin object that can be merged into the `list[obj]`\nTerraform resource block to set or update the mutual_authentication 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].withMutualAuthenticationMixin](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 `mutual_authentication` field.\n', args=[]), + withMutualAuthentication(resourceLabel, value): { + resource+: { + aws_alb_listener+: { + [resourceLabel]+: { + mutual_authentication: value, + }, + }, + }, + }, + '#withMutualAuthenticationMixin':: d.fn(help='`aws.list[obj].withMutualAuthenticationMixin` constructs a mixin object that can be merged into the `list[obj]`\nTerraform resource block to set or update the mutual_authentication 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].withMutualAuthentication](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 `mutual_authentication` field.\n', args=[]), + withMutualAuthenticationMixin(resourceLabel, value): { + resource+: { + aws_alb_listener+: { + [resourceLabel]+: { + mutual_authentication+: if std.isArray(v=value) then value else [value], + }, + }, + }, + }, '#withPort':: d.fn(help='`aws.number.withPort` constructs a mixin object that can be merged into the `number`\nTerraform resource block to set or update the port 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 `port` field.\n', args=[]), withPort(resourceLabel, value): { resource+: { diff --git a/5.x/_gen/resources/appconfig_configuration_profile.libsonnet b/5.x/_gen/resources/appconfig_configuration_profile.libsonnet index a0c0e0c6..6a894e74 100644 --- a/5.x/_gen/resources/appconfig_configuration_profile.libsonnet +++ b/5.x/_gen/resources/appconfig_configuration_profile.libsonnet @@ -2,13 +2,14 @@ local tf = (import 'github.com/tf-libsonnet/core/main.libsonnet'); local d = (import 'github.com/jsonnet-libs/docsonnet/doc-util/main.libsonnet'); { '#':: d.pkg(name='appconfig_configuration_profile', url='', help='`appconfig_configuration_profile` represents the `aws_appconfig_configuration_profile` 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.appconfig_configuration_profile.new` injects a new `aws_appconfig_configuration_profile` 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.appconfig_configuration_profile.new('some_id')\n\nYou can get the reference to the `id` field of the created `aws.appconfig_configuration_profile` using the reference:\n\n $._ref.aws_appconfig_configuration_profile.some_id.get('id')\n\nThis is the same as directly entering `\"${ aws_appconfig_configuration_profile.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 - `application_id` (`string`): Set the `application_id` field on the resulting resource block.\n - `description` (`string`): Set the `description` field on the resulting resource block. When `null`, the `description` field will be omitted from the resulting object.\n - `location_uri` (`string`): Set the `location_uri` field on the resulting resource block.\n - `name` (`string`): Set the `name` field on the resulting resource block.\n - `retrieval_role_arn` (`string`): Set the `retrieval_role_arn` field on the resulting resource block. When `null`, the `retrieval_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 - `type` (`string`): Set the `type` field on the resulting resource block. When `null`, the `type` field will be omitted from the resulting object.\n - `validator` (`list[obj]`): Set the `validator` field on the resulting resource block. When `null`, the `validator` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [aws.appconfig_configuration_profile.validator.new](#fn-validatornew) 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.appconfig_configuration_profile.new` injects a new `aws_appconfig_configuration_profile` 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.appconfig_configuration_profile.new('some_id')\n\nYou can get the reference to the `id` field of the created `aws.appconfig_configuration_profile` using the reference:\n\n $._ref.aws_appconfig_configuration_profile.some_id.get('id')\n\nThis is the same as directly entering `\"${ aws_appconfig_configuration_profile.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 - `application_id` (`string`): Set the `application_id` field on the resulting resource block.\n - `description` (`string`): Set the `description` field on the resulting resource block. When `null`, the `description` field will be omitted from the resulting object.\n - `kms_key_identifier` (`string`): Set the `kms_key_identifier` field on the resulting resource block. When `null`, the `kms_key_identifier` field will be omitted from the resulting object.\n - `location_uri` (`string`): Set the `location_uri` field on the resulting resource block.\n - `name` (`string`): Set the `name` field on the resulting resource block.\n - `retrieval_role_arn` (`string`): Set the `retrieval_role_arn` field on the resulting resource block. When `null`, the `retrieval_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 - `type` (`string`): Set the `type` field on the resulting resource block. When `null`, the `type` field will be omitted from the resulting object.\n - `validator` (`list[obj]`): Set the `validator` field on the resulting resource block. When `null`, the `validator` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [aws.appconfig_configuration_profile.validator.new](#fn-validatornew) constructor.\n\n**Returns**:\n- A mixin object that injects the new resource into the root Terraform configuration.\n", args=[]), new( resourceLabel, application_id, location_uri, name, description=null, + kms_key_identifier=null, retrieval_role_arn=null, tags=null, tags_all=null, @@ -21,6 +22,7 @@ local d = (import 'github.com/jsonnet-libs/docsonnet/doc-util/main.libsonnet'); attrs=self.newAttrs( application_id=application_id, description=description, + kms_key_identifier=kms_key_identifier, location_uri=location_uri, name=name, retrieval_role_arn=retrieval_role_arn, @@ -31,12 +33,13 @@ local d = (import 'github.com/jsonnet-libs/docsonnet/doc-util/main.libsonnet'); ), _meta=_meta ), - '#newAttrs':: d.fn(help='\n`aws.appconfig_configuration_profile.newAttrs` constructs a new object with attributes and blocks configured for the `appconfig_configuration_profile`\nTerraform resource.\n\nUnlike [aws.appconfig_configuration_profile.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 - `application_id` (`string`): Set the `application_id` field on the resulting object.\n - `description` (`string`): Set the `description` field on the resulting object. When `null`, the `description` field will be omitted from the resulting object.\n - `location_uri` (`string`): Set the `location_uri` field on the resulting object.\n - `name` (`string`): Set the `name` field on the resulting object.\n - `retrieval_role_arn` (`string`): Set the `retrieval_role_arn` field on the resulting object. When `null`, the `retrieval_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 - `type` (`string`): Set the `type` field on the resulting object. When `null`, the `type` field will be omitted from the resulting object.\n - `validator` (`list[obj]`): Set the `validator` field on the resulting object. When `null`, the `validator` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [aws.appconfig_configuration_profile.validator.new](#fn-validatornew) 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 `appconfig_configuration_profile` resource into the root Terraform configuration.\n', args=[]), + '#newAttrs':: d.fn(help='\n`aws.appconfig_configuration_profile.newAttrs` constructs a new object with attributes and blocks configured for the `appconfig_configuration_profile`\nTerraform resource.\n\nUnlike [aws.appconfig_configuration_profile.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 - `application_id` (`string`): Set the `application_id` field on the resulting object.\n - `description` (`string`): Set the `description` field on the resulting object. When `null`, the `description` field will be omitted from the resulting object.\n - `kms_key_identifier` (`string`): Set the `kms_key_identifier` field on the resulting object. When `null`, the `kms_key_identifier` field will be omitted from the resulting object.\n - `location_uri` (`string`): Set the `location_uri` field on the resulting object.\n - `name` (`string`): Set the `name` field on the resulting object.\n - `retrieval_role_arn` (`string`): Set the `retrieval_role_arn` field on the resulting object. When `null`, the `retrieval_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 - `type` (`string`): Set the `type` field on the resulting object. When `null`, the `type` field will be omitted from the resulting object.\n - `validator` (`list[obj]`): Set the `validator` field on the resulting object. When `null`, the `validator` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [aws.appconfig_configuration_profile.validator.new](#fn-validatornew) 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 `appconfig_configuration_profile` resource into the root Terraform configuration.\n', args=[]), newAttrs( application_id, location_uri, name, description=null, + kms_key_identifier=null, retrieval_role_arn=null, tags=null, tags_all=null, @@ -45,6 +48,7 @@ local d = (import 'github.com/jsonnet-libs/docsonnet/doc-util/main.libsonnet'); ):: std.prune(a={ application_id: application_id, description: description, + kms_key_identifier: kms_key_identifier, location_uri: location_uri, name: name, retrieval_role_arn: retrieval_role_arn, @@ -83,6 +87,16 @@ local d = (import 'github.com/jsonnet-libs/docsonnet/doc-util/main.libsonnet'); }, }, }, + '#withKmsKeyIdentifier':: d.fn(help='`aws.string.withKmsKeyIdentifier` constructs a mixin object that can be merged into the `string`\nTerraform resource block to set or update the kms_key_identifier field.\n\n\n\n**Args**:\n - `resourceLabel` (`string`): The name label of the block to update.\n - `value` (`string`): The value to set for the `kms_key_identifier` field.\n', args=[]), + withKmsKeyIdentifier(resourceLabel, value): { + resource+: { + aws_appconfig_configuration_profile+: { + [resourceLabel]+: { + kms_key_identifier: value, + }, + }, + }, + }, '#withLocationUri':: d.fn(help='`aws.string.withLocationUri` constructs a mixin object that can be merged into the `string`\nTerraform resource block to set or update the location_uri 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 `location_uri` field.\n', args=[]), withLocationUri(resourceLabel, value): { resource+: { diff --git a/5.x/_gen/resources/appconfig_deployment.libsonnet b/5.x/_gen/resources/appconfig_deployment.libsonnet index 4d475797..273235f4 100644 --- a/5.x/_gen/resources/appconfig_deployment.libsonnet +++ b/5.x/_gen/resources/appconfig_deployment.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='appconfig_deployment', url='', help='`appconfig_deployment` represents the `aws_appconfig_deployment` 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.appconfig_deployment.new` injects a new `aws_appconfig_deployment` 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.appconfig_deployment.new('some_id')\n\nYou can get the reference to the `id` field of the created `aws.appconfig_deployment` using the reference:\n\n $._ref.aws_appconfig_deployment.some_id.get('id')\n\nThis is the same as directly entering `\"${ aws_appconfig_deployment.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 - `application_id` (`string`): Set the `application_id` field on the resulting resource block.\n - `configuration_profile_id` (`string`): Set the `configuration_profile_id` field on the resulting resource block.\n - `configuration_version` (`string`): Set the `configuration_version` field on the resulting resource block.\n - `deployment_strategy_id` (`string`): Set the `deployment_strategy_id` field on the resulting resource block.\n - `description` (`string`): Set the `description` field on the resulting resource block. When `null`, the `description` field will be omitted from the resulting object.\n - `environment_id` (`string`): Set the `environment_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.appconfig_deployment.new` injects a new `aws_appconfig_deployment` 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.appconfig_deployment.new('some_id')\n\nYou can get the reference to the `id` field of the created `aws.appconfig_deployment` using the reference:\n\n $._ref.aws_appconfig_deployment.some_id.get('id')\n\nThis is the same as directly entering `\"${ aws_appconfig_deployment.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 - `application_id` (`string`): Set the `application_id` field on the resulting resource block.\n - `configuration_profile_id` (`string`): Set the `configuration_profile_id` field on the resulting resource block.\n - `configuration_version` (`string`): Set the `configuration_version` field on the resulting resource block.\n - `deployment_strategy_id` (`string`): Set the `deployment_strategy_id` field on the resulting resource block.\n - `description` (`string`): Set the `description` field on the resulting resource block. When `null`, the `description` field will be omitted from the resulting object.\n - `environment_id` (`string`): Set the `environment_id` field on the resulting resource block.\n - `kms_key_identifier` (`string`): Set the `kms_key_identifier` field on the resulting resource block. When `null`, the `kms_key_identifier` field will be omitted from the resulting object.\n - `tags` (`obj`): Set the `tags` field on the resulting resource block. When `null`, the `tags` field will be omitted from the resulting object.\n - `tags_all` (`obj`): Set the `tags_all` field on the resulting resource block. When `null`, the `tags_all` field will be omitted from the resulting object.\n\n**Returns**:\n- A mixin object that injects the new resource into the root Terraform configuration.\n", args=[]), new( resourceLabel, application_id, @@ -11,6 +11,7 @@ local d = (import 'github.com/jsonnet-libs/docsonnet/doc-util/main.libsonnet'); deployment_strategy_id, environment_id, description=null, + kms_key_identifier=null, tags=null, tags_all=null, _meta={} @@ -24,12 +25,13 @@ local d = (import 'github.com/jsonnet-libs/docsonnet/doc-util/main.libsonnet'); deployment_strategy_id=deployment_strategy_id, description=description, environment_id=environment_id, + kms_key_identifier=kms_key_identifier, tags=tags, tags_all=tags_all ), _meta=_meta ), - '#newAttrs':: d.fn(help='\n`aws.appconfig_deployment.newAttrs` constructs a new object with attributes and blocks configured for the `appconfig_deployment`\nTerraform resource.\n\nUnlike [aws.appconfig_deployment.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 - `application_id` (`string`): Set the `application_id` field on the resulting object.\n - `configuration_profile_id` (`string`): Set the `configuration_profile_id` field on the resulting object.\n - `configuration_version` (`string`): Set the `configuration_version` field on the resulting object.\n - `deployment_strategy_id` (`string`): Set the `deployment_strategy_id` field on the resulting object.\n - `description` (`string`): Set the `description` field on the resulting object. When `null`, the `description` field will be omitted from the resulting object.\n - `environment_id` (`string`): Set the `environment_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 `appconfig_deployment` resource into the root Terraform configuration.\n', args=[]), + '#newAttrs':: d.fn(help='\n`aws.appconfig_deployment.newAttrs` constructs a new object with attributes and blocks configured for the `appconfig_deployment`\nTerraform resource.\n\nUnlike [aws.appconfig_deployment.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 - `application_id` (`string`): Set the `application_id` field on the resulting object.\n - `configuration_profile_id` (`string`): Set the `configuration_profile_id` field on the resulting object.\n - `configuration_version` (`string`): Set the `configuration_version` field on the resulting object.\n - `deployment_strategy_id` (`string`): Set the `deployment_strategy_id` field on the resulting object.\n - `description` (`string`): Set the `description` field on the resulting object. When `null`, the `description` field will be omitted from the resulting object.\n - `environment_id` (`string`): Set the `environment_id` field on the resulting object.\n - `kms_key_identifier` (`string`): Set the `kms_key_identifier` field on the resulting object. When `null`, the `kms_key_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 - `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 `appconfig_deployment` resource into the root Terraform configuration.\n', args=[]), newAttrs( application_id, configuration_profile_id, @@ -37,6 +39,7 @@ local d = (import 'github.com/jsonnet-libs/docsonnet/doc-util/main.libsonnet'); deployment_strategy_id, environment_id, description=null, + kms_key_identifier=null, tags=null, tags_all=null ):: std.prune(a={ @@ -46,6 +49,7 @@ local d = (import 'github.com/jsonnet-libs/docsonnet/doc-util/main.libsonnet'); deployment_strategy_id: deployment_strategy_id, description: description, environment_id: environment_id, + kms_key_identifier: kms_key_identifier, tags: tags, tags_all: tags_all, }), @@ -109,6 +113,16 @@ local d = (import 'github.com/jsonnet-libs/docsonnet/doc-util/main.libsonnet'); }, }, }, + '#withKmsKeyIdentifier':: d.fn(help='`aws.string.withKmsKeyIdentifier` constructs a mixin object that can be merged into the `string`\nTerraform resource block to set or update the kms_key_identifier field.\n\n\n\n**Args**:\n - `resourceLabel` (`string`): The name label of the block to update.\n - `value` (`string`): The value to set for the `kms_key_identifier` field.\n', args=[]), + withKmsKeyIdentifier(resourceLabel, value): { + resource+: { + aws_appconfig_deployment+: { + [resourceLabel]+: { + kms_key_identifier: value, + }, + }, + }, + }, '#withTags':: d.fn(help='`aws.obj.withTags` constructs a mixin object that can be merged into the `obj`\nTerraform resource block to set or update the tags field.\n\n\n\n**Args**:\n - `resourceLabel` (`string`): The name label of the block to update.\n - `value` (`obj`): The value to set for the `tags` field.\n', args=[]), withTags(resourceLabel, value): { resource+: { diff --git a/5.x/_gen/resources/appflow_flow.libsonnet b/5.x/_gen/resources/appflow_flow.libsonnet index 0fe1b943..694d2b2a 100644 --- a/5.x/_gen/resources/appflow_flow.libsonnet +++ b/5.x/_gen/resources/appflow_flow.libsonnet @@ -556,10 +556,10 @@ local d = (import 'github.com/jsonnet-libs/docsonnet/doc-util/main.libsonnet'); zendesk: zendesk, }), s3:: { - '#new':: d.fn(help='\n`aws.appflow_flow.source_flow_config.source_connector_properties.s3.new` constructs a new object with attributes and blocks configured for the `s3`\nTerraform sub block.\n\n\n\n**Args**:\n - `bucket_name` (`string`): Set the `bucket_name` field on the resulting object.\n - `bucket_prefix` (`string`): Set the `bucket_prefix` field on the resulting object. When `null`, the `bucket_prefix` field will be omitted from the resulting object.\n - `s3_input_format_config` (`list[obj]`): Set the `s3_input_format_config` field on the resulting object. When `null`, the `s3_input_format_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.appflow_flow.source_flow_config.source_connector_properties.s3.s3_input_format_config.new](#fn-source_flow_configsource_flow_configsource_connector_propertiess3_input_format_confignew) constructor.\n\n**Returns**:\n - An attribute object that represents the `s3` sub block.\n', args=[]), + '#new':: d.fn(help='\n`aws.appflow_flow.source_flow_config.source_connector_properties.s3.new` constructs a new object with attributes and blocks configured for the `s3`\nTerraform sub block.\n\n\n\n**Args**:\n - `bucket_name` (`string`): Set the `bucket_name` field on the resulting object.\n - `bucket_prefix` (`string`): Set the `bucket_prefix` field on the resulting object.\n - `s3_input_format_config` (`list[obj]`): Set the `s3_input_format_config` field on the resulting object. When `null`, the `s3_input_format_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.appflow_flow.source_flow_config.source_connector_properties.s3.s3_input_format_config.new](#fn-source_flow_configsource_flow_configsource_connector_propertiess3_input_format_confignew) constructor.\n\n**Returns**:\n - An attribute object that represents the `s3` sub block.\n', args=[]), new( bucket_name, - bucket_prefix=null, + bucket_prefix, s3_input_format_config=null ):: std.prune(a={ bucket_name: bucket_name, diff --git a/5.x/_gen/resources/cloudwatch_log_group.libsonnet b/5.x/_gen/resources/cloudwatch_log_group.libsonnet index 1203059e..b4884e51 100644 --- a/5.x/_gen/resources/cloudwatch_log_group.libsonnet +++ b/5.x/_gen/resources/cloudwatch_log_group.libsonnet @@ -2,10 +2,11 @@ local tf = (import 'github.com/tf-libsonnet/core/main.libsonnet'); local d = (import 'github.com/jsonnet-libs/docsonnet/doc-util/main.libsonnet'); { '#':: d.pkg(name='cloudwatch_log_group', url='', help='`cloudwatch_log_group` represents the `aws_cloudwatch_log_group` Terraform resource.\n\n\n\nThis package contains functions and utilities for setting up the resource using Jsonnet code.\n'), - '#new':: d.fn(help="\n`aws.cloudwatch_log_group.new` injects a new `aws_cloudwatch_log_group` Terraform `resource`\nblock into the root module document.\n\nAdditionally, this inserts a private function into the `_ref` attribute that generates references to attributes of the\nresource. For example, if you added a new instance to the root using:\n\n # arguments omitted for brevity\n aws.cloudwatch_log_group.new('some_id')\n\nYou can get the reference to the `id` field of the created `aws.cloudwatch_log_group` using the reference:\n\n $._ref.aws_cloudwatch_log_group.some_id.get('id')\n\nThis is the same as directly entering `\"${ aws_cloudwatch_log_group.some_id.id }\"` as the value.\n\nNOTE: if you are chaining multiple resources together in a merge operation, you may not be able to use `super`, `self`,\nor `$` to refer to the root object. Instead, make an explicit outer object using `local`.\n\n**Args**:\n - `resourceLabel` (`string`): The name label of the block.\n - `kms_key_id` (`string`): Set the `kms_key_id` field on the resulting resource block. When `null`, the `kms_key_id` field will be omitted from the resulting object.\n - `name` (`string`): Set the `name` field on the resulting resource block. When `null`, the `name` field will be omitted from the resulting object.\n - `name_prefix` (`string`): Set the `name_prefix` field on the resulting resource block. When `null`, the `name_prefix` field will be omitted from the resulting object.\n - `retention_in_days` (`number`): Set the `retention_in_days` field on the resulting resource block. When `null`, the `retention_in_days` field will be omitted from the resulting object.\n - `skip_destroy` (`bool`): Set the `skip_destroy` field on the resulting resource block. When `null`, the `skip_destroy` field will be omitted from the resulting object.\n - `tags` (`obj`): Set the `tags` field on the resulting resource block. When `null`, the `tags` field will be omitted from the resulting object.\n - `tags_all` (`obj`): Set the `tags_all` field on the resulting resource block. When `null`, the `tags_all` field will be omitted from the resulting object.\n\n**Returns**:\n- A mixin object that injects the new resource into the root Terraform configuration.\n", args=[]), + '#new':: d.fn(help="\n`aws.cloudwatch_log_group.new` injects a new `aws_cloudwatch_log_group` Terraform `resource`\nblock into the root module document.\n\nAdditionally, this inserts a private function into the `_ref` attribute that generates references to attributes of the\nresource. For example, if you added a new instance to the root using:\n\n # arguments omitted for brevity\n aws.cloudwatch_log_group.new('some_id')\n\nYou can get the reference to the `id` field of the created `aws.cloudwatch_log_group` using the reference:\n\n $._ref.aws_cloudwatch_log_group.some_id.get('id')\n\nThis is the same as directly entering `\"${ aws_cloudwatch_log_group.some_id.id }\"` as the value.\n\nNOTE: if you are chaining multiple resources together in a merge operation, you may not be able to use `super`, `self`,\nor `$` to refer to the root object. Instead, make an explicit outer object using `local`.\n\n**Args**:\n - `resourceLabel` (`string`): The name label of the block.\n - `kms_key_id` (`string`): Set the `kms_key_id` field on the resulting resource block. When `null`, the `kms_key_id` field will be omitted from the resulting object.\n - `log_group_class` (`string`): Set the `log_group_class` field on the resulting resource block. When `null`, the `log_group_class` field will be omitted from the resulting object.\n - `name` (`string`): Set the `name` field on the resulting resource block. When `null`, the `name` field will be omitted from the resulting object.\n - `name_prefix` (`string`): Set the `name_prefix` field on the resulting resource block. When `null`, the `name_prefix` field will be omitted from the resulting object.\n - `retention_in_days` (`number`): Set the `retention_in_days` field on the resulting resource block. When `null`, the `retention_in_days` field will be omitted from the resulting object.\n - `skip_destroy` (`bool`): Set the `skip_destroy` field on the resulting resource block. When `null`, the `skip_destroy` field will be omitted from the resulting object.\n - `tags` (`obj`): Set the `tags` field on the resulting resource block. When `null`, the `tags` field will be omitted from the resulting object.\n - `tags_all` (`obj`): Set the `tags_all` field on the resulting resource block. When `null`, the `tags_all` field will be omitted from the resulting object.\n\n**Returns**:\n- A mixin object that injects the new resource into the root Terraform configuration.\n", args=[]), new( resourceLabel, kms_key_id=null, + log_group_class=null, name=null, name_prefix=null, retention_in_days=null, @@ -18,6 +19,7 @@ local d = (import 'github.com/jsonnet-libs/docsonnet/doc-util/main.libsonnet'); label=resourceLabel, attrs=self.newAttrs( kms_key_id=kms_key_id, + log_group_class=log_group_class, name=name, name_prefix=name_prefix, retention_in_days=retention_in_days, @@ -27,9 +29,10 @@ local d = (import 'github.com/jsonnet-libs/docsonnet/doc-util/main.libsonnet'); ), _meta=_meta ), - '#newAttrs':: d.fn(help='\n`aws.cloudwatch_log_group.newAttrs` constructs a new object with attributes and blocks configured for the `cloudwatch_log_group`\nTerraform resource.\n\nUnlike [aws.cloudwatch_log_group.new](#fn-new), this function will not inject the `resource`\nblock into the root Terraform document. Instead, this must be passed in as the `attrs` argument for the\n[tf.withResource](https://github.com/tf-libsonnet/core/tree/main/docs#fn-withresource) function to build a complete block.\n\nThis is most useful when you need to preprocess the attributes with functions, conditional, or looping logic prior to\ninjecting into a complete block.\n\n**Args**:\n - `kms_key_id` (`string`): Set the `kms_key_id` field on the resulting object. When `null`, the `kms_key_id` field will be omitted from the resulting object.\n - `name` (`string`): Set the `name` field on the resulting object. When `null`, the `name` field will be omitted from the resulting object.\n - `name_prefix` (`string`): Set the `name_prefix` field on the resulting object. When `null`, the `name_prefix` field will be omitted from the resulting object.\n - `retention_in_days` (`number`): Set the `retention_in_days` field on the resulting object. When `null`, the `retention_in_days` field will be omitted from the resulting object.\n - `skip_destroy` (`bool`): Set the `skip_destroy` field on the resulting object. When `null`, the `skip_destroy` field will be omitted from the resulting object.\n - `tags` (`obj`): Set the `tags` field on the resulting object. When `null`, the `tags` field will be omitted from the resulting object.\n - `tags_all` (`obj`): Set the `tags_all` field on the resulting object. When `null`, the `tags_all` field will be omitted from the resulting object.\n\n**Returns**:\n - An attribute object that can be used with [tf.withResource](https://github.com/tf-libsonnet/core/tree/main/docs#fn-withresource) to construct a new `cloudwatch_log_group` resource into the root Terraform configuration.\n', args=[]), + '#newAttrs':: d.fn(help='\n`aws.cloudwatch_log_group.newAttrs` constructs a new object with attributes and blocks configured for the `cloudwatch_log_group`\nTerraform resource.\n\nUnlike [aws.cloudwatch_log_group.new](#fn-new), this function will not inject the `resource`\nblock into the root Terraform document. Instead, this must be passed in as the `attrs` argument for the\n[tf.withResource](https://github.com/tf-libsonnet/core/tree/main/docs#fn-withresource) function to build a complete block.\n\nThis is most useful when you need to preprocess the attributes with functions, conditional, or looping logic prior to\ninjecting into a complete block.\n\n**Args**:\n - `kms_key_id` (`string`): Set the `kms_key_id` field on the resulting object. When `null`, the `kms_key_id` field will be omitted from the resulting object.\n - `log_group_class` (`string`): Set the `log_group_class` field on the resulting object. When `null`, the `log_group_class` field will be omitted from the resulting object.\n - `name` (`string`): Set the `name` field on the resulting object. When `null`, the `name` field will be omitted from the resulting object.\n - `name_prefix` (`string`): Set the `name_prefix` field on the resulting object. When `null`, the `name_prefix` field will be omitted from the resulting object.\n - `retention_in_days` (`number`): Set the `retention_in_days` field on the resulting object. When `null`, the `retention_in_days` field will be omitted from the resulting object.\n - `skip_destroy` (`bool`): Set the `skip_destroy` field on the resulting object. When `null`, the `skip_destroy` field will be omitted from the resulting object.\n - `tags` (`obj`): Set the `tags` field on the resulting object. When `null`, the `tags` field will be omitted from the resulting object.\n - `tags_all` (`obj`): Set the `tags_all` field on the resulting object. When `null`, the `tags_all` field will be omitted from the resulting object.\n\n**Returns**:\n - An attribute object that can be used with [tf.withResource](https://github.com/tf-libsonnet/core/tree/main/docs#fn-withresource) to construct a new `cloudwatch_log_group` resource into the root Terraform configuration.\n', args=[]), newAttrs( kms_key_id=null, + log_group_class=null, name=null, name_prefix=null, retention_in_days=null, @@ -38,6 +41,7 @@ local d = (import 'github.com/jsonnet-libs/docsonnet/doc-util/main.libsonnet'); tags_all=null ):: std.prune(a={ kms_key_id: kms_key_id, + log_group_class: log_group_class, name: name, name_prefix: name_prefix, retention_in_days: retention_in_days, @@ -55,6 +59,16 @@ local d = (import 'github.com/jsonnet-libs/docsonnet/doc-util/main.libsonnet'); }, }, }, + '#withLogGroupClass':: d.fn(help='`aws.string.withLogGroupClass` constructs a mixin object that can be merged into the `string`\nTerraform resource block to set or update the log_group_class field.\n\n\n\n**Args**:\n - `resourceLabel` (`string`): The name label of the block to update.\n - `value` (`string`): The value to set for the `log_group_class` field.\n', args=[]), + withLogGroupClass(resourceLabel, value): { + resource+: { + aws_cloudwatch_log_group+: { + [resourceLabel]+: { + log_group_class: value, + }, + }, + }, + }, '#withName':: d.fn(help='`aws.string.withName` constructs a mixin object that can be merged into the `string`\nTerraform resource block to set or update the 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 `name` field.\n', args=[]), withName(resourceLabel, value): { resource+: { diff --git a/5.x/_gen/resources/codeguruprofiler_profiling_group.libsonnet b/5.x/_gen/resources/codeguruprofiler_profiling_group.libsonnet new file mode 100644 index 00000000..7d888a6b --- /dev/null +++ b/5.x/_gen/resources/codeguruprofiler_profiling_group.libsonnet @@ -0,0 +1,94 @@ +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='codeguruprofiler_profiling_group', url='', help='`codeguruprofiler_profiling_group` represents the `aws_codeguruprofiler_profiling_group` Terraform resource.\n\n\n\nThis package contains functions and utilities for setting up the resource using Jsonnet code.\n'), + agent_orchestration_config:: { + '#new':: d.fn(help='\n`aws.codeguruprofiler_profiling_group.agent_orchestration_config.new` constructs a new object with attributes and blocks configured for the `agent_orchestration_config`\nTerraform sub block.\n\n\n\n**Args**:\n - `profiling_enabled` (`bool`): Set the `profiling_enabled` field on the resulting object.\n\n**Returns**:\n - An attribute object that represents the `agent_orchestration_config` sub block.\n', args=[]), + new( + profiling_enabled + ):: std.prune(a={ + profiling_enabled: profiling_enabled, + }), + }, + '#new':: d.fn(help="\n`aws.codeguruprofiler_profiling_group.new` injects a new `aws_codeguruprofiler_profiling_group` Terraform `resource`\nblock into the root module document.\n\nAdditionally, this inserts a private function into the `_ref` attribute that generates references to attributes of the\nresource. For example, if you added a new instance to the root using:\n\n # arguments omitted for brevity\n aws.codeguruprofiler_profiling_group.new('some_id')\n\nYou can get the reference to the `id` field of the created `aws.codeguruprofiler_profiling_group` using the reference:\n\n $._ref.aws_codeguruprofiler_profiling_group.some_id.get('id')\n\nThis is the same as directly entering `\"${ aws_codeguruprofiler_profiling_group.some_id.id }\"` as the value.\n\nNOTE: if you are chaining multiple resources together in a merge operation, you may not be able to use `super`, `self`,\nor `$` to refer to the root object. Instead, make an explicit outer object using `local`.\n\n**Args**:\n - `resourceLabel` (`string`): The name label of the block.\n - `compute_platform` (`string`): Set the `compute_platform` field on the resulting resource block. When `null`, the `compute_platform` field will be omitted from the resulting object.\n - `name` (`string`): Set the `name` field on the resulting resource block.\n - `tags` (`obj`): Set the `tags` field on the resulting resource block. When `null`, the `tags` field will be omitted from the resulting object.\n - `agent_orchestration_config` (`list[obj]`): Set the `agent_orchestration_config` field on the resulting resource block. When `null`, the `agent_orchestration_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.codeguruprofiler_profiling_group.agent_orchestration_config.new](#fn-agent_orchestration_confignew) constructor.\n\n**Returns**:\n- A mixin object that injects the new resource into the root Terraform configuration.\n", args=[]), + new( + resourceLabel, + name, + agent_orchestration_config=null, + compute_platform=null, + tags=null, + _meta={} + ):: tf.withResource( + type='aws_codeguruprofiler_profiling_group', + label=resourceLabel, + attrs=self.newAttrs( + agent_orchestration_config=agent_orchestration_config, + compute_platform=compute_platform, + name=name, + tags=tags + ), + _meta=_meta + ), + '#newAttrs':: d.fn(help='\n`aws.codeguruprofiler_profiling_group.newAttrs` constructs a new object with attributes and blocks configured for the `codeguruprofiler_profiling_group`\nTerraform resource.\n\nUnlike [aws.codeguruprofiler_profiling_group.new](#fn-new), this function will not inject the `resource`\nblock into the root Terraform document. Instead, this must be passed in as the `attrs` argument for the\n[tf.withResource](https://github.com/tf-libsonnet/core/tree/main/docs#fn-withresource) function to build a complete block.\n\nThis is most useful when you need to preprocess the attributes with functions, conditional, or looping logic prior to\ninjecting into a complete block.\n\n**Args**:\n - `compute_platform` (`string`): Set the `compute_platform` field on the resulting object. When `null`, the `compute_platform` field will be omitted from the resulting object.\n - `name` (`string`): Set the `name` field on the resulting object.\n - `tags` (`obj`): Set the `tags` field on the resulting object. When `null`, the `tags` field will be omitted from the resulting object.\n - `agent_orchestration_config` (`list[obj]`): Set the `agent_orchestration_config` field on the resulting object. When `null`, the `agent_orchestration_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.codeguruprofiler_profiling_group.agent_orchestration_config.new](#fn-agent_orchestration_confignew) constructor.\n\n**Returns**:\n - An attribute object that can be used with [tf.withResource](https://github.com/tf-libsonnet/core/tree/main/docs#fn-withresource) to construct a new `codeguruprofiler_profiling_group` resource into the root Terraform configuration.\n', args=[]), + newAttrs( + name, + agent_orchestration_config=null, + compute_platform=null, + tags=null + ):: std.prune(a={ + agent_orchestration_config: agent_orchestration_config, + compute_platform: compute_platform, + name: name, + tags: tags, + }), + '#withAgentOrchestrationConfig':: d.fn(help='`aws.list[obj].withAgentOrchestrationConfig` constructs a mixin object that can be merged into the `list[obj]`\nTerraform resource block to set or update the agent_orchestration_config field.\n\nThis function will replace the array with the passed in `value`. If you wish to instead append the\npassed in value to the existing array, use the [aws.list[obj].withAgentOrchestrationConfigMixin](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 `agent_orchestration_config` field.\n', args=[]), + withAgentOrchestrationConfig(resourceLabel, value): { + resource+: { + aws_codeguruprofiler_profiling_group+: { + [resourceLabel]+: { + agent_orchestration_config: value, + }, + }, + }, + }, + '#withAgentOrchestrationConfigMixin':: d.fn(help='`aws.list[obj].withAgentOrchestrationConfigMixin` constructs a mixin object that can be merged into the `list[obj]`\nTerraform resource block to set or update the agent_orchestration_config field.\n\nThis function will append the passed in array or object to the existing array. If you wish\nto instead replace the array with the passed in `value`, use the [aws.list[obj].withAgentOrchestrationConfig](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 `agent_orchestration_config` field.\n', args=[]), + withAgentOrchestrationConfigMixin(resourceLabel, value): { + resource+: { + aws_codeguruprofiler_profiling_group+: { + [resourceLabel]+: { + agent_orchestration_config+: if std.isArray(v=value) then value else [value], + }, + }, + }, + }, + '#withComputePlatform':: d.fn(help='`aws.string.withComputePlatform` constructs a mixin object that can be merged into the `string`\nTerraform resource block to set or update the compute_platform 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 `compute_platform` field.\n', args=[]), + withComputePlatform(resourceLabel, value): { + resource+: { + aws_codeguruprofiler_profiling_group+: { + [resourceLabel]+: { + compute_platform: value, + }, + }, + }, + }, + '#withName':: d.fn(help='`aws.string.withName` constructs a mixin object that can be merged into the `string`\nTerraform resource block to set or update the 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 `name` field.\n', args=[]), + withName(resourceLabel, value): { + resource+: { + aws_codeguruprofiler_profiling_group+: { + [resourceLabel]+: { + name: value, + }, + }, + }, + }, + '#withTags':: d.fn(help='`aws.obj.withTags` constructs a mixin object that can be merged into the `obj`\nTerraform resource block to set or update the tags field.\n\n\n\n**Args**:\n - `resourceLabel` (`string`): The name label of the block to update.\n - `value` (`obj`): The value to set for the `tags` field.\n', args=[]), + withTags(resourceLabel, value): { + resource+: { + aws_codeguruprofiler_profiling_group+: { + [resourceLabel]+: { + tags: value, + }, + }, + }, + }, +} diff --git a/5.x/_gen/resources/customerprofiles_domain.libsonnet b/5.x/_gen/resources/customerprofiles_domain.libsonnet new file mode 100644 index 00000000..9b76435b --- /dev/null +++ b/5.x/_gen/resources/customerprofiles_domain.libsonnet @@ -0,0 +1,298 @@ +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='customerprofiles_domain', url='', help='`customerprofiles_domain` represents the `aws_customerprofiles_domain` Terraform resource.\n\n\n\nThis package contains functions and utilities for setting up the resource using Jsonnet code.\n'), + matching:: { + auto_merging:: { + conflict_resolution:: { + '#new':: d.fn(help='\n`aws.customerprofiles_domain.matching.auto_merging.conflict_resolution.new` constructs a new object with attributes and blocks configured for the `conflict_resolution`\nTerraform sub block.\n\n\n\n**Args**:\n - `conflict_resolving_model` (`string`): Set the `conflict_resolving_model` field on the resulting object.\n - `source_name` (`string`): Set the `source_name` field on the resulting object. When `null`, the `source_name` field will be omitted from the resulting object.\n\n**Returns**:\n - An attribute object that represents the `conflict_resolution` sub block.\n', args=[]), + new( + conflict_resolving_model, + source_name=null + ):: std.prune(a={ + conflict_resolving_model: conflict_resolving_model, + source_name: source_name, + }), + }, + consolidation:: { + '#new':: d.fn(help='\n`aws.customerprofiles_domain.matching.auto_merging.consolidation.new` constructs a new object with attributes and blocks configured for the `consolidation`\nTerraform sub block.\n\n\n\n**Args**:\n - `matching_attributes_list` (`list`): Set the `matching_attributes_list` field on the resulting object.\n\n**Returns**:\n - An attribute object that represents the `consolidation` sub block.\n', args=[]), + new( + matching_attributes_list + ):: std.prune(a={ + matching_attributes_list: matching_attributes_list, + }), + }, + '#new':: d.fn(help='\n`aws.customerprofiles_domain.matching.auto_merging.new` constructs a new object with attributes and blocks configured for the `auto_merging`\nTerraform sub block.\n\n\n\n**Args**:\n - `enabled` (`bool`): Set the `enabled` field on the resulting object.\n - `min_allowed_confidence_score_for_merging` (`number`): Set the `min_allowed_confidence_score_for_merging` field on the resulting object. When `null`, the `min_allowed_confidence_score_for_merging` field will be omitted from the resulting object.\n - `conflict_resolution` (`list[obj]`): Set the `conflict_resolution` field on the resulting object. When `null`, the `conflict_resolution` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [aws.customerprofiles_domain.matching.auto_merging.conflict_resolution.new](#fn-matchingmatchingconflict_resolutionnew) constructor.\n - `consolidation` (`list[obj]`): Set the `consolidation` field on the resulting object. When `null`, the `consolidation` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [aws.customerprofiles_domain.matching.auto_merging.consolidation.new](#fn-matchingmatchingconsolidationnew) constructor.\n\n**Returns**:\n - An attribute object that represents the `auto_merging` sub block.\n', args=[]), + new( + enabled, + conflict_resolution=null, + consolidation=null, + min_allowed_confidence_score_for_merging=null + ):: std.prune(a={ + conflict_resolution: conflict_resolution, + consolidation: consolidation, + enabled: enabled, + min_allowed_confidence_score_for_merging: min_allowed_confidence_score_for_merging, + }), + }, + exporting_config:: { + '#new':: d.fn(help='\n`aws.customerprofiles_domain.matching.exporting_config.new` constructs a new object with attributes and blocks configured for the `exporting_config`\nTerraform sub block.\n\n\n\n**Args**:\n - `s3_exporting` (`list[obj]`): Set the `s3_exporting` field on the resulting object. When `null`, the `s3_exporting` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [aws.customerprofiles_domain.matching.exporting_config.s3_exporting.new](#fn-matchingmatchings3_exportingnew) constructor.\n\n**Returns**:\n - An attribute object that represents the `exporting_config` sub block.\n', args=[]), + new( + s3_exporting=null + ):: std.prune(a={ + s3_exporting: s3_exporting, + }), + s3_exporting:: { + '#new':: d.fn(help='\n`aws.customerprofiles_domain.matching.exporting_config.s3_exporting.new` constructs a new object with attributes and blocks configured for the `s3_exporting`\nTerraform sub block.\n\n\n\n**Args**:\n - `s3_bucket_name` (`string`): Set the `s3_bucket_name` field on the resulting object.\n - `s3_key_name` (`string`): Set the `s3_key_name` field on the resulting object. When `null`, the `s3_key_name` field will be omitted from the resulting object.\n\n**Returns**:\n - An attribute object that represents the `s3_exporting` sub block.\n', args=[]), + new( + s3_bucket_name, + s3_key_name=null + ):: std.prune(a={ + s3_bucket_name: s3_bucket_name, + s3_key_name: s3_key_name, + }), + }, + }, + job_schedule:: { + '#new':: d.fn(help='\n`aws.customerprofiles_domain.matching.job_schedule.new` constructs a new object with attributes and blocks configured for the `job_schedule`\nTerraform sub block.\n\n\n\n**Args**:\n - `day_of_the_week` (`string`): Set the `day_of_the_week` field on the resulting object.\n - `time` (`string`): Set the `time` field on the resulting object.\n\n**Returns**:\n - An attribute object that represents the `job_schedule` sub block.\n', args=[]), + new( + day_of_the_week, + time + ):: std.prune(a={ + day_of_the_week: day_of_the_week, + time: time, + }), + }, + '#new':: d.fn(help='\n`aws.customerprofiles_domain.matching.new` constructs a new object with attributes and blocks configured for the `matching`\nTerraform sub block.\n\n\n\n**Args**:\n - `enabled` (`bool`): Set the `enabled` field on the resulting object.\n - `auto_merging` (`list[obj]`): Set the `auto_merging` field on the resulting object. When `null`, the `auto_merging` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [aws.customerprofiles_domain.matching.auto_merging.new](#fn-matchingauto_mergingnew) constructor.\n - `exporting_config` (`list[obj]`): Set the `exporting_config` field on the resulting object. When `null`, the `exporting_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.customerprofiles_domain.matching.exporting_config.new](#fn-matchingexporting_confignew) constructor.\n - `job_schedule` (`list[obj]`): Set the `job_schedule` field on the resulting object. When `null`, the `job_schedule` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [aws.customerprofiles_domain.matching.job_schedule.new](#fn-matchingjob_schedulenew) constructor.\n\n**Returns**:\n - An attribute object that represents the `matching` sub block.\n', args=[]), + new( + enabled, + auto_merging=null, + exporting_config=null, + job_schedule=null + ):: std.prune(a={ + auto_merging: auto_merging, + enabled: enabled, + exporting_config: exporting_config, + job_schedule: job_schedule, + }), + }, + '#new':: d.fn(help="\n`aws.customerprofiles_domain.new` injects a new `aws_customerprofiles_domain` Terraform `resource`\nblock into the root module document.\n\nAdditionally, this inserts a private function into the `_ref` attribute that generates references to attributes of the\nresource. For example, if you added a new instance to the root using:\n\n # arguments omitted for brevity\n aws.customerprofiles_domain.new('some_id')\n\nYou can get the reference to the `id` field of the created `aws.customerprofiles_domain` using the reference:\n\n $._ref.aws_customerprofiles_domain.some_id.get('id')\n\nThis is the same as directly entering `\"${ aws_customerprofiles_domain.some_id.id }\"` as the value.\n\nNOTE: if you are chaining multiple resources together in a merge operation, you may not be able to use `super`, `self`,\nor `$` to refer to the root object. Instead, make an explicit outer object using `local`.\n\n**Args**:\n - `resourceLabel` (`string`): The name label of the block.\n - `dead_letter_queue_url` (`string`): Set the `dead_letter_queue_url` field on the resulting resource block. When `null`, the `dead_letter_queue_url` field will be omitted from the resulting object.\n - `default_encryption_key` (`string`): Set the `default_encryption_key` field on the resulting resource block. When `null`, the `default_encryption_key` field will be omitted from the resulting object.\n - `default_expiration_days` (`number`): Set the `default_expiration_days` field on the resulting resource block.\n - `domain_name` (`string`): Set the `domain_name` field on the resulting resource block.\n - `tags` (`obj`): Set the `tags` field on the resulting resource block. When `null`, the `tags` field will be omitted from the resulting object.\n - `tags_all` (`obj`): Set the `tags_all` field on the resulting resource block. When `null`, the `tags_all` field will be omitted from the resulting object.\n - `matching` (`list[obj]`): Set the `matching` field on the resulting resource block. When `null`, the `matching` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [aws.customerprofiles_domain.matching.new](#fn-matchingnew) constructor.\n - `rule_based_matching` (`list[obj]`): Set the `rule_based_matching` field on the resulting resource block. When `null`, the `rule_based_matching` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [aws.customerprofiles_domain.rule_based_matching.new](#fn-rule_based_matchingnew) constructor.\n\n**Returns**:\n- A mixin object that injects the new resource into the root Terraform configuration.\n", args=[]), + new( + resourceLabel, + default_expiration_days, + domain_name, + dead_letter_queue_url=null, + default_encryption_key=null, + matching=null, + rule_based_matching=null, + tags=null, + tags_all=null, + _meta={} + ):: tf.withResource( + type='aws_customerprofiles_domain', + label=resourceLabel, + attrs=self.newAttrs( + dead_letter_queue_url=dead_letter_queue_url, + default_encryption_key=default_encryption_key, + default_expiration_days=default_expiration_days, + domain_name=domain_name, + matching=matching, + rule_based_matching=rule_based_matching, + tags=tags, + tags_all=tags_all + ), + _meta=_meta + ), + '#newAttrs':: d.fn(help='\n`aws.customerprofiles_domain.newAttrs` constructs a new object with attributes and blocks configured for the `customerprofiles_domain`\nTerraform resource.\n\nUnlike [aws.customerprofiles_domain.new](#fn-new), this function will not inject the `resource`\nblock into the root Terraform document. Instead, this must be passed in as the `attrs` argument for the\n[tf.withResource](https://github.com/tf-libsonnet/core/tree/main/docs#fn-withresource) function to build a complete block.\n\nThis is most useful when you need to preprocess the attributes with functions, conditional, or looping logic prior to\ninjecting into a complete block.\n\n**Args**:\n - `dead_letter_queue_url` (`string`): Set the `dead_letter_queue_url` field on the resulting object. When `null`, the `dead_letter_queue_url` field will be omitted from the resulting object.\n - `default_encryption_key` (`string`): Set the `default_encryption_key` field on the resulting object. When `null`, the `default_encryption_key` field will be omitted from the resulting object.\n - `default_expiration_days` (`number`): Set the `default_expiration_days` field on the resulting object.\n - `domain_name` (`string`): Set the `domain_name` field on the resulting object.\n - `tags` (`obj`): Set the `tags` field on the resulting object. When `null`, the `tags` field will be omitted from the resulting object.\n - `tags_all` (`obj`): Set the `tags_all` field on the resulting object. When `null`, the `tags_all` field will be omitted from the resulting object.\n - `matching` (`list[obj]`): Set the `matching` field on the resulting object. When `null`, the `matching` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [aws.customerprofiles_domain.matching.new](#fn-matchingnew) constructor.\n - `rule_based_matching` (`list[obj]`): Set the `rule_based_matching` field on the resulting object. When `null`, the `rule_based_matching` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [aws.customerprofiles_domain.rule_based_matching.new](#fn-rule_based_matchingnew) 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 `customerprofiles_domain` resource into the root Terraform configuration.\n', args=[]), + newAttrs( + default_expiration_days, + domain_name, + dead_letter_queue_url=null, + default_encryption_key=null, + matching=null, + rule_based_matching=null, + tags=null, + tags_all=null + ):: std.prune(a={ + dead_letter_queue_url: dead_letter_queue_url, + default_encryption_key: default_encryption_key, + default_expiration_days: default_expiration_days, + domain_name: domain_name, + matching: matching, + rule_based_matching: rule_based_matching, + tags: tags, + tags_all: tags_all, + }), + rule_based_matching:: { + attribute_types_selector:: { + '#new':: d.fn(help='\n`aws.customerprofiles_domain.rule_based_matching.attribute_types_selector.new` constructs a new object with attributes and blocks configured for the `attribute_types_selector`\nTerraform sub block.\n\n\n\n**Args**:\n - `address` (`list`): Set the `address` field on the resulting object. When `null`, the `address` field will be omitted from the resulting object.\n - `attribute_matching_model` (`string`): Set the `attribute_matching_model` field on the resulting object.\n - `email_address` (`list`): Set the `email_address` field on the resulting object. When `null`, the `email_address` field will be omitted from the resulting object.\n - `phone_number` (`list`): Set the `phone_number` field on the resulting object. When `null`, the `phone_number` field will be omitted from the resulting object.\n\n**Returns**:\n - An attribute object that represents the `attribute_types_selector` sub block.\n', args=[]), + new( + attribute_matching_model, + address=null, + email_address=null, + phone_number=null + ):: std.prune(a={ + address: address, + attribute_matching_model: attribute_matching_model, + email_address: email_address, + phone_number: phone_number, + }), + }, + conflict_resolution:: { + '#new':: d.fn(help='\n`aws.customerprofiles_domain.rule_based_matching.conflict_resolution.new` constructs a new object with attributes and blocks configured for the `conflict_resolution`\nTerraform sub block.\n\n\n\n**Args**:\n - `conflict_resolving_model` (`string`): Set the `conflict_resolving_model` field on the resulting object.\n - `source_name` (`string`): Set the `source_name` field on the resulting object. When `null`, the `source_name` field will be omitted from the resulting object.\n\n**Returns**:\n - An attribute object that represents the `conflict_resolution` sub block.\n', args=[]), + new( + conflict_resolving_model, + source_name=null + ):: std.prune(a={ + conflict_resolving_model: conflict_resolving_model, + source_name: source_name, + }), + }, + exporting_config:: { + '#new':: d.fn(help='\n`aws.customerprofiles_domain.rule_based_matching.exporting_config.new` constructs a new object with attributes and blocks configured for the `exporting_config`\nTerraform sub block.\n\n\n\n**Args**:\n - `s3_exporting` (`list[obj]`): Set the `s3_exporting` field on the resulting object. When `null`, the `s3_exporting` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [aws.customerprofiles_domain.rule_based_matching.exporting_config.s3_exporting.new](#fn-rule_based_matchingrule_based_matchings3_exportingnew) constructor.\n\n**Returns**:\n - An attribute object that represents the `exporting_config` sub block.\n', args=[]), + new( + s3_exporting=null + ):: std.prune(a={ + s3_exporting: s3_exporting, + }), + s3_exporting:: { + '#new':: d.fn(help='\n`aws.customerprofiles_domain.rule_based_matching.exporting_config.s3_exporting.new` constructs a new object with attributes and blocks configured for the `s3_exporting`\nTerraform sub block.\n\n\n\n**Args**:\n - `s3_bucket_name` (`string`): Set the `s3_bucket_name` field on the resulting object.\n - `s3_key_name` (`string`): Set the `s3_key_name` field on the resulting object. When `null`, the `s3_key_name` field will be omitted from the resulting object.\n\n**Returns**:\n - An attribute object that represents the `s3_exporting` sub block.\n', args=[]), + new( + s3_bucket_name, + s3_key_name=null + ):: std.prune(a={ + s3_bucket_name: s3_bucket_name, + s3_key_name: s3_key_name, + }), + }, + }, + matching_rules:: { + '#new':: d.fn(help='\n`aws.customerprofiles_domain.rule_based_matching.matching_rules.new` constructs a new object with attributes and blocks configured for the `matching_rules`\nTerraform sub block.\n\n\n\n**Args**:\n - `rule` (`list`): Set the `rule` field on the resulting object.\n\n**Returns**:\n - An attribute object that represents the `matching_rules` sub block.\n', args=[]), + new( + rule + ):: std.prune(a={ + rule: rule, + }), + }, + '#new':: d.fn(help='\n`aws.customerprofiles_domain.rule_based_matching.new` constructs a new object with attributes and blocks configured for the `rule_based_matching`\nTerraform sub block.\n\n\n\n**Args**:\n - `enabled` (`bool`): Set the `enabled` field on the resulting object.\n - `max_allowed_rule_level_for_matching` (`number`): Set the `max_allowed_rule_level_for_matching` field on the resulting object. When `null`, the `max_allowed_rule_level_for_matching` field will be omitted from the resulting object.\n - `max_allowed_rule_level_for_merging` (`number`): Set the `max_allowed_rule_level_for_merging` field on the resulting object. When `null`, the `max_allowed_rule_level_for_merging` 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 - `attribute_types_selector` (`list[obj]`): Set the `attribute_types_selector` field on the resulting object. When `null`, the `attribute_types_selector` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [aws.customerprofiles_domain.rule_based_matching.attribute_types_selector.new](#fn-rule_based_matchingattribute_types_selectornew) constructor.\n - `conflict_resolution` (`list[obj]`): Set the `conflict_resolution` field on the resulting object. When `null`, the `conflict_resolution` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [aws.customerprofiles_domain.rule_based_matching.conflict_resolution.new](#fn-rule_based_matchingconflict_resolutionnew) constructor.\n - `exporting_config` (`list[obj]`): Set the `exporting_config` field on the resulting object. When `null`, the `exporting_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.customerprofiles_domain.rule_based_matching.exporting_config.new](#fn-rule_based_matchingexporting_confignew) constructor.\n - `matching_rules` (`list[obj]`): Set the `matching_rules` field on the resulting object. When `null`, the `matching_rules` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [aws.customerprofiles_domain.rule_based_matching.matching_rules.new](#fn-rule_based_matchingmatching_rulesnew) constructor.\n\n**Returns**:\n - An attribute object that represents the `rule_based_matching` sub block.\n', args=[]), + new( + enabled, + attribute_types_selector=null, + conflict_resolution=null, + exporting_config=null, + matching_rules=null, + max_allowed_rule_level_for_matching=null, + max_allowed_rule_level_for_merging=null, + status=null + ):: std.prune(a={ + attribute_types_selector: attribute_types_selector, + conflict_resolution: conflict_resolution, + enabled: enabled, + exporting_config: exporting_config, + matching_rules: matching_rules, + max_allowed_rule_level_for_matching: max_allowed_rule_level_for_matching, + max_allowed_rule_level_for_merging: max_allowed_rule_level_for_merging, + status: status, + }), + }, + '#withDeadLetterQueueUrl':: d.fn(help='`aws.string.withDeadLetterQueueUrl` constructs a mixin object that can be merged into the `string`\nTerraform resource block to set or update the dead_letter_queue_url field.\n\n\n\n**Args**:\n - `resourceLabel` (`string`): The name label of the block to update.\n - `value` (`string`): The value to set for the `dead_letter_queue_url` field.\n', args=[]), + withDeadLetterQueueUrl(resourceLabel, value): { + resource+: { + aws_customerprofiles_domain+: { + [resourceLabel]+: { + dead_letter_queue_url: value, + }, + }, + }, + }, + '#withDefaultEncryptionKey':: d.fn(help='`aws.string.withDefaultEncryptionKey` constructs a mixin object that can be merged into the `string`\nTerraform resource block to set or update the default_encryption_key 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 `default_encryption_key` field.\n', args=[]), + withDefaultEncryptionKey(resourceLabel, value): { + resource+: { + aws_customerprofiles_domain+: { + [resourceLabel]+: { + default_encryption_key: value, + }, + }, + }, + }, + '#withDefaultExpirationDays':: d.fn(help='`aws.number.withDefaultExpirationDays` constructs a mixin object that can be merged into the `number`\nTerraform resource block to set or update the default_expiration_days 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 `default_expiration_days` field.\n', args=[]), + withDefaultExpirationDays(resourceLabel, value): { + resource+: { + aws_customerprofiles_domain+: { + [resourceLabel]+: { + default_expiration_days: value, + }, + }, + }, + }, + '#withDomainName':: d.fn(help='`aws.string.withDomainName` constructs a mixin object that can be merged into the `string`\nTerraform resource block to set or update the domain_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 `domain_name` field.\n', args=[]), + withDomainName(resourceLabel, value): { + resource+: { + aws_customerprofiles_domain+: { + [resourceLabel]+: { + domain_name: value, + }, + }, + }, + }, + '#withMatching':: d.fn(help='`aws.list[obj].withMatching` constructs a mixin object that can be merged into the `list[obj]`\nTerraform resource block to set or update the matching 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].withMatchingMixin](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 `matching` field.\n', args=[]), + withMatching(resourceLabel, value): { + resource+: { + aws_customerprofiles_domain+: { + [resourceLabel]+: { + matching: value, + }, + }, + }, + }, + '#withMatchingMixin':: d.fn(help='`aws.list[obj].withMatchingMixin` constructs a mixin object that can be merged into the `list[obj]`\nTerraform resource block to set or update the matching 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].withMatching](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 `matching` field.\n', args=[]), + withMatchingMixin(resourceLabel, value): { + resource+: { + aws_customerprofiles_domain+: { + [resourceLabel]+: { + matching+: if std.isArray(v=value) then value else [value], + }, + }, + }, + }, + '#withRuleBasedMatching':: d.fn(help='`aws.list[obj].withRuleBasedMatching` constructs a mixin object that can be merged into the `list[obj]`\nTerraform resource block to set or update the rule_based_matching 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].withRuleBasedMatchingMixin](TODO) function.\n\n\n**Args**:\n - `resourceLabel` (`string`): The name label of the block to update.\n - `value` (`list[obj]`): The value to set for the `rule_based_matching` field.\n', args=[]), + withRuleBasedMatching(resourceLabel, value): { + resource+: { + aws_customerprofiles_domain+: { + [resourceLabel]+: { + rule_based_matching: value, + }, + }, + }, + }, + '#withRuleBasedMatchingMixin':: d.fn(help='`aws.list[obj].withRuleBasedMatchingMixin` constructs a mixin object that can be merged into the `list[obj]`\nTerraform resource block to set or update the rule_based_matching 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].withRuleBasedMatching](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 `rule_based_matching` field.\n', args=[]), + withRuleBasedMatchingMixin(resourceLabel, value): { + resource+: { + aws_customerprofiles_domain+: { + [resourceLabel]+: { + rule_based_matching+: if std.isArray(v=value) then value else [value], + }, + }, + }, + }, + '#withTags':: d.fn(help='`aws.obj.withTags` constructs a mixin object that can be merged into the `obj`\nTerraform resource block to set or update the tags field.\n\n\n\n**Args**:\n - `resourceLabel` (`string`): The name label of the block to update.\n - `value` (`obj`): The value to set for the `tags` field.\n', args=[]), + withTags(resourceLabel, value): { + resource+: { + aws_customerprofiles_domain+: { + [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_customerprofiles_domain+: { + [resourceLabel]+: { + tags_all: value, + }, + }, + }, + }, +} diff --git a/5.x/_gen/resources/customerprofiles_profile.libsonnet b/5.x/_gen/resources/customerprofiles_profile.libsonnet new file mode 100644 index 00000000..0dcfe0b3 --- /dev/null +++ b/5.x/_gen/resources/customerprofiles_profile.libsonnet @@ -0,0 +1,472 @@ +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='customerprofiles_profile', url='', help='`customerprofiles_profile` represents the `aws_customerprofiles_profile` Terraform resource.\n\n\n\nThis package contains functions and utilities for setting up the resource using Jsonnet code.\n'), + address:: { + '#new':: d.fn(help='\n`aws.customerprofiles_profile.address.new` constructs a new object with attributes and blocks configured for the `address`\nTerraform sub block.\n\n\n\n**Args**:\n - `address_1` (`string`): Set the `address_1` field on the resulting object. When `null`, the `address_1` field will be omitted from the resulting object.\n - `address_2` (`string`): Set the `address_2` field on the resulting object. When `null`, the `address_2` field will be omitted from the resulting object.\n - `address_3` (`string`): Set the `address_3` field on the resulting object. When `null`, the `address_3` field will be omitted from the resulting object.\n - `address_4` (`string`): Set the `address_4` field on the resulting object. When `null`, the `address_4` field will be omitted from the resulting object.\n - `city` (`string`): Set the `city` field on the resulting object. When `null`, the `city` field will be omitted from the resulting object.\n - `country` (`string`): Set the `country` field on the resulting object. When `null`, the `country` field will be omitted from the resulting object.\n - `county` (`string`): Set the `county` field on the resulting object. When `null`, the `county` field will be omitted from the resulting object.\n - `postal_code` (`string`): Set the `postal_code` field on the resulting object. When `null`, the `postal_code` field will be omitted from the resulting object.\n - `province` (`string`): Set the `province` field on the resulting object. When `null`, the `province` field will be omitted from the resulting object.\n - `state` (`string`): Set the `state` field on the resulting object. When `null`, the `state` field will be omitted from the resulting object.\n\n**Returns**:\n - An attribute object that represents the `address` sub block.\n', args=[]), + new( + address_1=null, + address_2=null, + address_3=null, + address_4=null, + city=null, + country=null, + county=null, + postal_code=null, + province=null, + state=null + ):: std.prune(a={ + address_1: address_1, + address_2: address_2, + address_3: address_3, + address_4: address_4, + city: city, + country: country, + county: county, + postal_code: postal_code, + province: province, + state: state, + }), + }, + billing_address:: { + '#new':: d.fn(help='\n`aws.customerprofiles_profile.billing_address.new` constructs a new object with attributes and blocks configured for the `billing_address`\nTerraform sub block.\n\n\n\n**Args**:\n - `address_1` (`string`): Set the `address_1` field on the resulting object. When `null`, the `address_1` field will be omitted from the resulting object.\n - `address_2` (`string`): Set the `address_2` field on the resulting object. When `null`, the `address_2` field will be omitted from the resulting object.\n - `address_3` (`string`): Set the `address_3` field on the resulting object. When `null`, the `address_3` field will be omitted from the resulting object.\n - `address_4` (`string`): Set the `address_4` field on the resulting object. When `null`, the `address_4` field will be omitted from the resulting object.\n - `city` (`string`): Set the `city` field on the resulting object. When `null`, the `city` field will be omitted from the resulting object.\n - `country` (`string`): Set the `country` field on the resulting object. When `null`, the `country` field will be omitted from the resulting object.\n - `county` (`string`): Set the `county` field on the resulting object. When `null`, the `county` field will be omitted from the resulting object.\n - `postal_code` (`string`): Set the `postal_code` field on the resulting object. When `null`, the `postal_code` field will be omitted from the resulting object.\n - `province` (`string`): Set the `province` field on the resulting object. When `null`, the `province` field will be omitted from the resulting object.\n - `state` (`string`): Set the `state` field on the resulting object. When `null`, the `state` field will be omitted from the resulting object.\n\n**Returns**:\n - An attribute object that represents the `billing_address` sub block.\n', args=[]), + new( + address_1=null, + address_2=null, + address_3=null, + address_4=null, + city=null, + country=null, + county=null, + postal_code=null, + province=null, + state=null + ):: std.prune(a={ + address_1: address_1, + address_2: address_2, + address_3: address_3, + address_4: address_4, + city: city, + country: country, + county: county, + postal_code: postal_code, + province: province, + state: state, + }), + }, + mailing_address:: { + '#new':: d.fn(help='\n`aws.customerprofiles_profile.mailing_address.new` constructs a new object with attributes and blocks configured for the `mailing_address`\nTerraform sub block.\n\n\n\n**Args**:\n - `address_1` (`string`): Set the `address_1` field on the resulting object. When `null`, the `address_1` field will be omitted from the resulting object.\n - `address_2` (`string`): Set the `address_2` field on the resulting object. When `null`, the `address_2` field will be omitted from the resulting object.\n - `address_3` (`string`): Set the `address_3` field on the resulting object. When `null`, the `address_3` field will be omitted from the resulting object.\n - `address_4` (`string`): Set the `address_4` field on the resulting object. When `null`, the `address_4` field will be omitted from the resulting object.\n - `city` (`string`): Set the `city` field on the resulting object. When `null`, the `city` field will be omitted from the resulting object.\n - `country` (`string`): Set the `country` field on the resulting object. When `null`, the `country` field will be omitted from the resulting object.\n - `county` (`string`): Set the `county` field on the resulting object. When `null`, the `county` field will be omitted from the resulting object.\n - `postal_code` (`string`): Set the `postal_code` field on the resulting object. When `null`, the `postal_code` field will be omitted from the resulting object.\n - `province` (`string`): Set the `province` field on the resulting object. When `null`, the `province` field will be omitted from the resulting object.\n - `state` (`string`): Set the `state` field on the resulting object. When `null`, the `state` field will be omitted from the resulting object.\n\n**Returns**:\n - An attribute object that represents the `mailing_address` sub block.\n', args=[]), + new( + address_1=null, + address_2=null, + address_3=null, + address_4=null, + city=null, + country=null, + county=null, + postal_code=null, + province=null, + state=null + ):: std.prune(a={ + address_1: address_1, + address_2: address_2, + address_3: address_3, + address_4: address_4, + city: city, + country: country, + county: county, + postal_code: postal_code, + province: province, + state: state, + }), + }, + '#new':: d.fn(help="\n`aws.customerprofiles_profile.new` injects a new `aws_customerprofiles_profile` 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.customerprofiles_profile.new('some_id')\n\nYou can get the reference to the `id` field of the created `aws.customerprofiles_profile` using the reference:\n\n $._ref.aws_customerprofiles_profile.some_id.get('id')\n\nThis is the same as directly entering `\"${ aws_customerprofiles_profile.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 - `account_number` (`string`): Set the `account_number` field on the resulting resource block. When `null`, the `account_number` field will be omitted from the resulting object.\n - `additional_information` (`string`): Set the `additional_information` field on the resulting resource block. When `null`, the `additional_information` field will be omitted from the resulting object.\n - `attributes` (`obj`): Set the `attributes` field on the resulting resource block. When `null`, the `attributes` field will be omitted from the resulting object.\n - `birth_date` (`string`): Set the `birth_date` field on the resulting resource block. When `null`, the `birth_date` field will be omitted from the resulting object.\n - `business_email_address` (`string`): Set the `business_email_address` field on the resulting resource block. When `null`, the `business_email_address` field will be omitted from the resulting object.\n - `business_name` (`string`): Set the `business_name` field on the resulting resource block. When `null`, the `business_name` field will be omitted from the resulting object.\n - `business_phone_number` (`string`): Set the `business_phone_number` field on the resulting resource block. When `null`, the `business_phone_number` field will be omitted from the resulting object.\n - `domain_name` (`string`): Set the `domain_name` field on the resulting resource block.\n - `email_address` (`string`): Set the `email_address` field on the resulting resource block. When `null`, the `email_address` field will be omitted from the resulting object.\n - `first_name` (`string`): Set the `first_name` field on the resulting resource block. When `null`, the `first_name` field will be omitted from the resulting object.\n - `gender_string` (`string`): Set the `gender_string` field on the resulting resource block. When `null`, the `gender_string` field will be omitted from the resulting object.\n - `home_phone_number` (`string`): Set the `home_phone_number` field on the resulting resource block. When `null`, the `home_phone_number` field will be omitted from the resulting object.\n - `last_name` (`string`): Set the `last_name` field on the resulting resource block. When `null`, the `last_name` field will be omitted from the resulting object.\n - `middle_name` (`string`): Set the `middle_name` field on the resulting resource block. When `null`, the `middle_name` field will be omitted from the resulting object.\n - `mobile_phone_number` (`string`): Set the `mobile_phone_number` field on the resulting resource block. When `null`, the `mobile_phone_number` field will be omitted from the resulting object.\n - `party_type_string` (`string`): Set the `party_type_string` field on the resulting resource block. When `null`, the `party_type_string` field will be omitted from the resulting object.\n - `personal_email_address` (`string`): Set the `personal_email_address` field on the resulting resource block. When `null`, the `personal_email_address` field will be omitted from the resulting object.\n - `phone_number` (`string`): Set the `phone_number` field on the resulting resource block. When `null`, the `phone_number` field will be omitted from the resulting object.\n - `address` (`list[obj]`): Set the `address` field on the resulting resource block. When `null`, the `address` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [aws.customerprofiles_profile.address.new](#fn-addressnew) constructor.\n - `billing_address` (`list[obj]`): Set the `billing_address` field on the resulting resource block. When `null`, the `billing_address` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [aws.customerprofiles_profile.billing_address.new](#fn-billing_addressnew) constructor.\n - `mailing_address` (`list[obj]`): Set the `mailing_address` field on the resulting resource block. When `null`, the `mailing_address` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [aws.customerprofiles_profile.mailing_address.new](#fn-mailing_addressnew) constructor.\n - `shipping_address` (`list[obj]`): Set the `shipping_address` field on the resulting resource block. When `null`, the `shipping_address` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [aws.customerprofiles_profile.shipping_address.new](#fn-shipping_addressnew) constructor.\n\n**Returns**:\n- A mixin object that injects the new resource into the root Terraform configuration.\n", args=[]), + new( + resourceLabel, + domain_name, + account_number=null, + additional_information=null, + address=null, + attributes=null, + billing_address=null, + birth_date=null, + business_email_address=null, + business_name=null, + business_phone_number=null, + email_address=null, + first_name=null, + gender_string=null, + home_phone_number=null, + last_name=null, + mailing_address=null, + middle_name=null, + mobile_phone_number=null, + party_type_string=null, + personal_email_address=null, + phone_number=null, + shipping_address=null, + _meta={} + ):: tf.withResource( + type='aws_customerprofiles_profile', + label=resourceLabel, + attrs=self.newAttrs( + account_number=account_number, + additional_information=additional_information, + address=address, + attributes=attributes, + billing_address=billing_address, + birth_date=birth_date, + business_email_address=business_email_address, + business_name=business_name, + business_phone_number=business_phone_number, + domain_name=domain_name, + email_address=email_address, + first_name=first_name, + gender_string=gender_string, + home_phone_number=home_phone_number, + last_name=last_name, + mailing_address=mailing_address, + middle_name=middle_name, + mobile_phone_number=mobile_phone_number, + party_type_string=party_type_string, + personal_email_address=personal_email_address, + phone_number=phone_number, + shipping_address=shipping_address + ), + _meta=_meta + ), + '#newAttrs':: d.fn(help='\n`aws.customerprofiles_profile.newAttrs` constructs a new object with attributes and blocks configured for the `customerprofiles_profile`\nTerraform resource.\n\nUnlike [aws.customerprofiles_profile.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 - `account_number` (`string`): Set the `account_number` field on the resulting object. When `null`, the `account_number` field will be omitted from the resulting object.\n - `additional_information` (`string`): Set the `additional_information` field on the resulting object. When `null`, the `additional_information` field will be omitted from the resulting object.\n - `attributes` (`obj`): Set the `attributes` field on the resulting object. When `null`, the `attributes` field will be omitted from the resulting object.\n - `birth_date` (`string`): Set the `birth_date` field on the resulting object. When `null`, the `birth_date` field will be omitted from the resulting object.\n - `business_email_address` (`string`): Set the `business_email_address` field on the resulting object. When `null`, the `business_email_address` field will be omitted from the resulting object.\n - `business_name` (`string`): Set the `business_name` field on the resulting object. When `null`, the `business_name` field will be omitted from the resulting object.\n - `business_phone_number` (`string`): Set the `business_phone_number` field on the resulting object. When `null`, the `business_phone_number` field will be omitted from the resulting object.\n - `domain_name` (`string`): Set the `domain_name` field on the resulting object.\n - `email_address` (`string`): Set the `email_address` field on the resulting object. When `null`, the `email_address` field will be omitted from the resulting object.\n - `first_name` (`string`): Set the `first_name` field on the resulting object. When `null`, the `first_name` field will be omitted from the resulting object.\n - `gender_string` (`string`): Set the `gender_string` field on the resulting object. When `null`, the `gender_string` field will be omitted from the resulting object.\n - `home_phone_number` (`string`): Set the `home_phone_number` field on the resulting object. When `null`, the `home_phone_number` field will be omitted from the resulting object.\n - `last_name` (`string`): Set the `last_name` field on the resulting object. When `null`, the `last_name` field will be omitted from the resulting object.\n - `middle_name` (`string`): Set the `middle_name` field on the resulting object. When `null`, the `middle_name` field will be omitted from the resulting object.\n - `mobile_phone_number` (`string`): Set the `mobile_phone_number` field on the resulting object. When `null`, the `mobile_phone_number` field will be omitted from the resulting object.\n - `party_type_string` (`string`): Set the `party_type_string` field on the resulting object. When `null`, the `party_type_string` field will be omitted from the resulting object.\n - `personal_email_address` (`string`): Set the `personal_email_address` field on the resulting object. When `null`, the `personal_email_address` field will be omitted from the resulting object.\n - `phone_number` (`string`): Set the `phone_number` field on the resulting object. When `null`, the `phone_number` field will be omitted from the resulting object.\n - `address` (`list[obj]`): Set the `address` field on the resulting object. When `null`, the `address` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [aws.customerprofiles_profile.address.new](#fn-addressnew) constructor.\n - `billing_address` (`list[obj]`): Set the `billing_address` field on the resulting object. When `null`, the `billing_address` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [aws.customerprofiles_profile.billing_address.new](#fn-billing_addressnew) constructor.\n - `mailing_address` (`list[obj]`): Set the `mailing_address` field on the resulting object. When `null`, the `mailing_address` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [aws.customerprofiles_profile.mailing_address.new](#fn-mailing_addressnew) constructor.\n - `shipping_address` (`list[obj]`): Set the `shipping_address` field on the resulting object. When `null`, the `shipping_address` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [aws.customerprofiles_profile.shipping_address.new](#fn-shipping_addressnew) 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 `customerprofiles_profile` resource into the root Terraform configuration.\n', args=[]), + newAttrs( + domain_name, + account_number=null, + additional_information=null, + address=null, + attributes=null, + billing_address=null, + birth_date=null, + business_email_address=null, + business_name=null, + business_phone_number=null, + email_address=null, + first_name=null, + gender_string=null, + home_phone_number=null, + last_name=null, + mailing_address=null, + middle_name=null, + mobile_phone_number=null, + party_type_string=null, + personal_email_address=null, + phone_number=null, + shipping_address=null + ):: std.prune(a={ + account_number: account_number, + additional_information: additional_information, + address: address, + attributes: attributes, + billing_address: billing_address, + birth_date: birth_date, + business_email_address: business_email_address, + business_name: business_name, + business_phone_number: business_phone_number, + domain_name: domain_name, + email_address: email_address, + first_name: first_name, + gender_string: gender_string, + home_phone_number: home_phone_number, + last_name: last_name, + mailing_address: mailing_address, + middle_name: middle_name, + mobile_phone_number: mobile_phone_number, + party_type_string: party_type_string, + personal_email_address: personal_email_address, + phone_number: phone_number, + shipping_address: shipping_address, + }), + shipping_address:: { + '#new':: d.fn(help='\n`aws.customerprofiles_profile.shipping_address.new` constructs a new object with attributes and blocks configured for the `shipping_address`\nTerraform sub block.\n\n\n\n**Args**:\n - `address_1` (`string`): Set the `address_1` field on the resulting object. When `null`, the `address_1` field will be omitted from the resulting object.\n - `address_2` (`string`): Set the `address_2` field on the resulting object. When `null`, the `address_2` field will be omitted from the resulting object.\n - `address_3` (`string`): Set the `address_3` field on the resulting object. When `null`, the `address_3` field will be omitted from the resulting object.\n - `address_4` (`string`): Set the `address_4` field on the resulting object. When `null`, the `address_4` field will be omitted from the resulting object.\n - `city` (`string`): Set the `city` field on the resulting object. When `null`, the `city` field will be omitted from the resulting object.\n - `country` (`string`): Set the `country` field on the resulting object. When `null`, the `country` field will be omitted from the resulting object.\n - `county` (`string`): Set the `county` field on the resulting object. When `null`, the `county` field will be omitted from the resulting object.\n - `postal_code` (`string`): Set the `postal_code` field on the resulting object. When `null`, the `postal_code` field will be omitted from the resulting object.\n - `province` (`string`): Set the `province` field on the resulting object. When `null`, the `province` field will be omitted from the resulting object.\n - `state` (`string`): Set the `state` field on the resulting object. When `null`, the `state` field will be omitted from the resulting object.\n\n**Returns**:\n - An attribute object that represents the `shipping_address` sub block.\n', args=[]), + new( + address_1=null, + address_2=null, + address_3=null, + address_4=null, + city=null, + country=null, + county=null, + postal_code=null, + province=null, + state=null + ):: std.prune(a={ + address_1: address_1, + address_2: address_2, + address_3: address_3, + address_4: address_4, + city: city, + country: country, + county: county, + postal_code: postal_code, + province: province, + state: state, + }), + }, + '#withAccountNumber':: d.fn(help='`aws.string.withAccountNumber` constructs a mixin object that can be merged into the `string`\nTerraform resource block to set or update the account_number 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 `account_number` field.\n', args=[]), + withAccountNumber(resourceLabel, value): { + resource+: { + aws_customerprofiles_profile+: { + [resourceLabel]+: { + account_number: value, + }, + }, + }, + }, + '#withAdditionalInformation':: d.fn(help='`aws.string.withAdditionalInformation` constructs a mixin object that can be merged into the `string`\nTerraform resource block to set or update the additional_information 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 `additional_information` field.\n', args=[]), + withAdditionalInformation(resourceLabel, value): { + resource+: { + aws_customerprofiles_profile+: { + [resourceLabel]+: { + additional_information: value, + }, + }, + }, + }, + '#withAddress':: d.fn(help='`aws.list[obj].withAddress` constructs a mixin object that can be merged into the `list[obj]`\nTerraform resource block to set or update the address 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].withAddressMixin](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 `address` field.\n', args=[]), + withAddress(resourceLabel, value): { + resource+: { + aws_customerprofiles_profile+: { + [resourceLabel]+: { + address: value, + }, + }, + }, + }, + '#withAddressMixin':: d.fn(help='`aws.list[obj].withAddressMixin` constructs a mixin object that can be merged into the `list[obj]`\nTerraform resource block to set or update the address 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].withAddress](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 `address` field.\n', args=[]), + withAddressMixin(resourceLabel, value): { + resource+: { + aws_customerprofiles_profile+: { + [resourceLabel]+: { + address+: if std.isArray(v=value) then value else [value], + }, + }, + }, + }, + '#withAttributes':: d.fn(help='`aws.obj.withAttributes` constructs a mixin object that can be merged into the `obj`\nTerraform resource block to set or update the attributes 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 `attributes` field.\n', args=[]), + withAttributes(resourceLabel, value): { + resource+: { + aws_customerprofiles_profile+: { + [resourceLabel]+: { + attributes: value, + }, + }, + }, + }, + '#withBillingAddress':: d.fn(help='`aws.list[obj].withBillingAddress` constructs a mixin object that can be merged into the `list[obj]`\nTerraform resource block to set or update the billing_address 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].withBillingAddressMixin](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 `billing_address` field.\n', args=[]), + withBillingAddress(resourceLabel, value): { + resource+: { + aws_customerprofiles_profile+: { + [resourceLabel]+: { + billing_address: value, + }, + }, + }, + }, + '#withBillingAddressMixin':: d.fn(help='`aws.list[obj].withBillingAddressMixin` constructs a mixin object that can be merged into the `list[obj]`\nTerraform resource block to set or update the billing_address 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].withBillingAddress](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 `billing_address` field.\n', args=[]), + withBillingAddressMixin(resourceLabel, value): { + resource+: { + aws_customerprofiles_profile+: { + [resourceLabel]+: { + billing_address+: if std.isArray(v=value) then value else [value], + }, + }, + }, + }, + '#withBirthDate':: d.fn(help='`aws.string.withBirthDate` constructs a mixin object that can be merged into the `string`\nTerraform resource block to set or update the birth_date 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 `birth_date` field.\n', args=[]), + withBirthDate(resourceLabel, value): { + resource+: { + aws_customerprofiles_profile+: { + [resourceLabel]+: { + birth_date: value, + }, + }, + }, + }, + '#withBusinessEmailAddress':: d.fn(help='`aws.string.withBusinessEmailAddress` constructs a mixin object that can be merged into the `string`\nTerraform resource block to set or update the business_email_address 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 `business_email_address` field.\n', args=[]), + withBusinessEmailAddress(resourceLabel, value): { + resource+: { + aws_customerprofiles_profile+: { + [resourceLabel]+: { + business_email_address: value, + }, + }, + }, + }, + '#withBusinessName':: d.fn(help='`aws.string.withBusinessName` constructs a mixin object that can be merged into the `string`\nTerraform resource block to set or update the business_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 `business_name` field.\n', args=[]), + withBusinessName(resourceLabel, value): { + resource+: { + aws_customerprofiles_profile+: { + [resourceLabel]+: { + business_name: value, + }, + }, + }, + }, + '#withBusinessPhoneNumber':: d.fn(help='`aws.string.withBusinessPhoneNumber` constructs a mixin object that can be merged into the `string`\nTerraform resource block to set or update the business_phone_number 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 `business_phone_number` field.\n', args=[]), + withBusinessPhoneNumber(resourceLabel, value): { + resource+: { + aws_customerprofiles_profile+: { + [resourceLabel]+: { + business_phone_number: value, + }, + }, + }, + }, + '#withDomainName':: d.fn(help='`aws.string.withDomainName` constructs a mixin object that can be merged into the `string`\nTerraform resource block to set or update the domain_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 `domain_name` field.\n', args=[]), + withDomainName(resourceLabel, value): { + resource+: { + aws_customerprofiles_profile+: { + [resourceLabel]+: { + domain_name: value, + }, + }, + }, + }, + '#withEmailAddress':: d.fn(help='`aws.string.withEmailAddress` constructs a mixin object that can be merged into the `string`\nTerraform resource block to set or update the email_address 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 `email_address` field.\n', args=[]), + withEmailAddress(resourceLabel, value): { + resource+: { + aws_customerprofiles_profile+: { + [resourceLabel]+: { + email_address: value, + }, + }, + }, + }, + '#withFirstName':: d.fn(help='`aws.string.withFirstName` constructs a mixin object that can be merged into the `string`\nTerraform resource block to set or update the first_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 `first_name` field.\n', args=[]), + withFirstName(resourceLabel, value): { + resource+: { + aws_customerprofiles_profile+: { + [resourceLabel]+: { + first_name: value, + }, + }, + }, + }, + '#withGenderString':: d.fn(help='`aws.string.withGenderString` constructs a mixin object that can be merged into the `string`\nTerraform resource block to set or update the gender_string 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 `gender_string` field.\n', args=[]), + withGenderString(resourceLabel, value): { + resource+: { + aws_customerprofiles_profile+: { + [resourceLabel]+: { + gender_string: value, + }, + }, + }, + }, + '#withHomePhoneNumber':: d.fn(help='`aws.string.withHomePhoneNumber` constructs a mixin object that can be merged into the `string`\nTerraform resource block to set or update the home_phone_number 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 `home_phone_number` field.\n', args=[]), + withHomePhoneNumber(resourceLabel, value): { + resource+: { + aws_customerprofiles_profile+: { + [resourceLabel]+: { + home_phone_number: value, + }, + }, + }, + }, + '#withLastName':: d.fn(help='`aws.string.withLastName` constructs a mixin object that can be merged into the `string`\nTerraform resource block to set or update the last_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 `last_name` field.\n', args=[]), + withLastName(resourceLabel, value): { + resource+: { + aws_customerprofiles_profile+: { + [resourceLabel]+: { + last_name: value, + }, + }, + }, + }, + '#withMailingAddress':: d.fn(help='`aws.list[obj].withMailingAddress` constructs a mixin object that can be merged into the `list[obj]`\nTerraform resource block to set or update the mailing_address 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].withMailingAddressMixin](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 `mailing_address` field.\n', args=[]), + withMailingAddress(resourceLabel, value): { + resource+: { + aws_customerprofiles_profile+: { + [resourceLabel]+: { + mailing_address: value, + }, + }, + }, + }, + '#withMailingAddressMixin':: d.fn(help='`aws.list[obj].withMailingAddressMixin` constructs a mixin object that can be merged into the `list[obj]`\nTerraform resource block to set or update the mailing_address 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].withMailingAddress](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 `mailing_address` field.\n', args=[]), + withMailingAddressMixin(resourceLabel, value): { + resource+: { + aws_customerprofiles_profile+: { + [resourceLabel]+: { + mailing_address+: if std.isArray(v=value) then value else [value], + }, + }, + }, + }, + '#withMiddleName':: d.fn(help='`aws.string.withMiddleName` constructs a mixin object that can be merged into the `string`\nTerraform resource block to set or update the middle_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 `middle_name` field.\n', args=[]), + withMiddleName(resourceLabel, value): { + resource+: { + aws_customerprofiles_profile+: { + [resourceLabel]+: { + middle_name: value, + }, + }, + }, + }, + '#withMobilePhoneNumber':: d.fn(help='`aws.string.withMobilePhoneNumber` constructs a mixin object that can be merged into the `string`\nTerraform resource block to set or update the mobile_phone_number 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 `mobile_phone_number` field.\n', args=[]), + withMobilePhoneNumber(resourceLabel, value): { + resource+: { + aws_customerprofiles_profile+: { + [resourceLabel]+: { + mobile_phone_number: value, + }, + }, + }, + }, + '#withPartyTypeString':: d.fn(help='`aws.string.withPartyTypeString` constructs a mixin object that can be merged into the `string`\nTerraform resource block to set or update the party_type_string 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 `party_type_string` field.\n', args=[]), + withPartyTypeString(resourceLabel, value): { + resource+: { + aws_customerprofiles_profile+: { + [resourceLabel]+: { + party_type_string: value, + }, + }, + }, + }, + '#withPersonalEmailAddress':: d.fn(help='`aws.string.withPersonalEmailAddress` constructs a mixin object that can be merged into the `string`\nTerraform resource block to set or update the personal_email_address 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 `personal_email_address` field.\n', args=[]), + withPersonalEmailAddress(resourceLabel, value): { + resource+: { + aws_customerprofiles_profile+: { + [resourceLabel]+: { + personal_email_address: value, + }, + }, + }, + }, + '#withPhoneNumber':: d.fn(help='`aws.string.withPhoneNumber` constructs a mixin object that can be merged into the `string`\nTerraform resource block to set or update the phone_number 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 `phone_number` field.\n', args=[]), + withPhoneNumber(resourceLabel, value): { + resource+: { + aws_customerprofiles_profile+: { + [resourceLabel]+: { + phone_number: value, + }, + }, + }, + }, + '#withShippingAddress':: d.fn(help='`aws.list[obj].withShippingAddress` constructs a mixin object that can be merged into the `list[obj]`\nTerraform resource block to set or update the shipping_address 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].withShippingAddressMixin](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 `shipping_address` field.\n', args=[]), + withShippingAddress(resourceLabel, value): { + resource+: { + aws_customerprofiles_profile+: { + [resourceLabel]+: { + shipping_address: value, + }, + }, + }, + }, + '#withShippingAddressMixin':: d.fn(help='`aws.list[obj].withShippingAddressMixin` constructs a mixin object that can be merged into the `list[obj]`\nTerraform resource block to set or update the shipping_address 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].withShippingAddress](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 `shipping_address` field.\n', args=[]), + withShippingAddressMixin(resourceLabel, value): { + resource+: { + aws_customerprofiles_profile+: { + [resourceLabel]+: { + shipping_address+: if std.isArray(v=value) then value else [value], + }, + }, + }, + }, +} diff --git a/5.x/_gen/resources/lb.libsonnet b/5.x/_gen/resources/lb.libsonnet index fbe5019b..5ec3ec43 100644 --- a/5.x/_gen/resources/lb.libsonnet +++ b/5.x/_gen/resources/lb.libsonnet @@ -14,7 +14,7 @@ local d = (import 'github.com/jsonnet-libs/docsonnet/doc-util/main.libsonnet'); prefix: prefix, }), }, - '#new':: d.fn(help="\n`aws.lb.new` injects a new `aws_lb` 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.lb.new('some_id')\n\nYou can get the reference to the `id` field of the created `aws.lb` using the reference:\n\n $._ref.aws_lb.some_id.get('id')\n\nThis is the same as directly entering `\"${ aws_lb.some_id.id }\"` as the value.\n\nNOTE: if you are chaining multiple resources together in a merge operation, you may not be able to use `super`, `self`,\nor `$` to refer to the root object. Instead, make an explicit outer object using `local`.\n\n**Args**:\n - `resourceLabel` (`string`): The name label of the block.\n - `customer_owned_ipv4_pool` (`string`): Set the `customer_owned_ipv4_pool` field on the resulting resource block. When `null`, the `customer_owned_ipv4_pool` field will be omitted from the resulting object.\n - `desync_mitigation_mode` (`string`): Set the `desync_mitigation_mode` field on the resulting resource block. When `null`, the `desync_mitigation_mode` field will be omitted from the resulting object.\n - `dns_record_client_routing_policy` (`string`): Set the `dns_record_client_routing_policy` field on the resulting resource block. When `null`, the `dns_record_client_routing_policy` field will be omitted from the resulting object.\n - `drop_invalid_header_fields` (`bool`): Set the `drop_invalid_header_fields` field on the resulting resource block. When `null`, the `drop_invalid_header_fields` field will be omitted from the resulting object.\n - `enable_cross_zone_load_balancing` (`bool`): Set the `enable_cross_zone_load_balancing` field on the resulting resource block. When `null`, the `enable_cross_zone_load_balancing` field will be omitted from the resulting object.\n - `enable_deletion_protection` (`bool`): Set the `enable_deletion_protection` field on the resulting resource block. When `null`, the `enable_deletion_protection` field will be omitted from the resulting object.\n - `enable_http2` (`bool`): Set the `enable_http2` field on the resulting resource block. When `null`, the `enable_http2` field will be omitted from the resulting object.\n - `enable_tls_version_and_cipher_suite_headers` (`bool`): Set the `enable_tls_version_and_cipher_suite_headers` field on the resulting resource block. When `null`, the `enable_tls_version_and_cipher_suite_headers` field will be omitted from the resulting object.\n - `enable_waf_fail_open` (`bool`): Set the `enable_waf_fail_open` field on the resulting resource block. When `null`, the `enable_waf_fail_open` field will be omitted from the resulting object.\n - `enable_xff_client_port` (`bool`): Set the `enable_xff_client_port` field on the resulting resource block. When `null`, the `enable_xff_client_port` field will be omitted from the resulting object.\n - `idle_timeout` (`number`): Set the `idle_timeout` field on the resulting resource block. When `null`, the `idle_timeout` field will be omitted from the resulting object.\n - `internal` (`bool`): Set the `internal` field on the resulting resource block. When `null`, the `internal` field will be omitted from the resulting object.\n - `ip_address_type` (`string`): Set the `ip_address_type` field on the resulting resource block. When `null`, the `ip_address_type` field will be omitted from the resulting object.\n - `load_balancer_type` (`string`): Set the `load_balancer_type` field on the resulting resource block. When `null`, the `load_balancer_type` field will be omitted from the resulting object.\n - `name` (`string`): Set the `name` field on the resulting resource block. When `null`, the `name` field will be omitted from the resulting object.\n - `name_prefix` (`string`): Set the `name_prefix` field on the resulting resource block. When `null`, the `name_prefix` field will be omitted from the resulting object.\n - `preserve_host_header` (`bool`): Set the `preserve_host_header` field on the resulting resource block. When `null`, the `preserve_host_header` field will be omitted from the resulting object.\n - `security_groups` (`list`): Set the `security_groups` field on the resulting resource block. When `null`, the `security_groups` field will be omitted from the resulting object.\n - `subnets` (`list`): Set the `subnets` field on the resulting resource block. When `null`, the `subnets` 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 - `xff_header_processing_mode` (`string`): Set the `xff_header_processing_mode` field on the resulting resource block. When `null`, the `xff_header_processing_mode` field will be omitted from the resulting object.\n - `access_logs` (`list[obj]`): Set the `access_logs` field on the resulting resource block. When `null`, the `access_logs` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [aws.lb.access_logs.new](#fn-access_logsnew) constructor.\n - `subnet_mapping` (`list[obj]`): Set the `subnet_mapping` field on the resulting resource block. When `null`, the `subnet_mapping` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [aws.lb.subnet_mapping.new](#fn-subnet_mappingnew) constructor.\n - `timeouts` (`obj`): Set the `timeouts` field on the resulting resource block. When `null`, the `timeouts` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [aws.lb.timeouts.new](#fn-timeoutsnew) constructor.\n\n**Returns**:\n- A mixin object that injects the new resource into the root Terraform configuration.\n", args=[]), + '#new':: d.fn(help="\n`aws.lb.new` injects a new `aws_lb` 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.lb.new('some_id')\n\nYou can get the reference to the `id` field of the created `aws.lb` using the reference:\n\n $._ref.aws_lb.some_id.get('id')\n\nThis is the same as directly entering `\"${ aws_lb.some_id.id }\"` as the value.\n\nNOTE: if you are chaining multiple resources together in a merge operation, you may not be able to use `super`, `self`,\nor `$` to refer to the root object. Instead, make an explicit outer object using `local`.\n\n**Args**:\n - `resourceLabel` (`string`): The name label of the block.\n - `customer_owned_ipv4_pool` (`string`): Set the `customer_owned_ipv4_pool` field on the resulting resource block. When `null`, the `customer_owned_ipv4_pool` field will be omitted from the resulting object.\n - `desync_mitigation_mode` (`string`): Set the `desync_mitigation_mode` field on the resulting resource block. When `null`, the `desync_mitigation_mode` field will be omitted from the resulting object.\n - `dns_record_client_routing_policy` (`string`): Set the `dns_record_client_routing_policy` field on the resulting resource block. When `null`, the `dns_record_client_routing_policy` field will be omitted from the resulting object.\n - `drop_invalid_header_fields` (`bool`): Set the `drop_invalid_header_fields` field on the resulting resource block. When `null`, the `drop_invalid_header_fields` field will be omitted from the resulting object.\n - `enable_cross_zone_load_balancing` (`bool`): Set the `enable_cross_zone_load_balancing` field on the resulting resource block. When `null`, the `enable_cross_zone_load_balancing` field will be omitted from the resulting object.\n - `enable_deletion_protection` (`bool`): Set the `enable_deletion_protection` field on the resulting resource block. When `null`, the `enable_deletion_protection` field will be omitted from the resulting object.\n - `enable_http2` (`bool`): Set the `enable_http2` field on the resulting resource block. When `null`, the `enable_http2` field will be omitted from the resulting object.\n - `enable_tls_version_and_cipher_suite_headers` (`bool`): Set the `enable_tls_version_and_cipher_suite_headers` field on the resulting resource block. When `null`, the `enable_tls_version_and_cipher_suite_headers` field will be omitted from the resulting object.\n - `enable_waf_fail_open` (`bool`): Set the `enable_waf_fail_open` field on the resulting resource block. When `null`, the `enable_waf_fail_open` field will be omitted from the resulting object.\n - `enable_xff_client_port` (`bool`): Set the `enable_xff_client_port` field on the resulting resource block. When `null`, the `enable_xff_client_port` field will be omitted from the resulting object.\n - `enforce_security_group_inbound_rules_on_private_link_traffic` (`string`): Set the `enforce_security_group_inbound_rules_on_private_link_traffic` field on the resulting resource block. When `null`, the `enforce_security_group_inbound_rules_on_private_link_traffic` field will be omitted from the resulting object.\n - `idle_timeout` (`number`): Set the `idle_timeout` field on the resulting resource block. When `null`, the `idle_timeout` field will be omitted from the resulting object.\n - `internal` (`bool`): Set the `internal` field on the resulting resource block. When `null`, the `internal` field will be omitted from the resulting object.\n - `ip_address_type` (`string`): Set the `ip_address_type` field on the resulting resource block. When `null`, the `ip_address_type` field will be omitted from the resulting object.\n - `load_balancer_type` (`string`): Set the `load_balancer_type` field on the resulting resource block. When `null`, the `load_balancer_type` field will be omitted from the resulting object.\n - `name` (`string`): Set the `name` field on the resulting resource block. When `null`, the `name` field will be omitted from the resulting object.\n - `name_prefix` (`string`): Set the `name_prefix` field on the resulting resource block. When `null`, the `name_prefix` field will be omitted from the resulting object.\n - `preserve_host_header` (`bool`): Set the `preserve_host_header` field on the resulting resource block. When `null`, the `preserve_host_header` field will be omitted from the resulting object.\n - `security_groups` (`list`): Set the `security_groups` field on the resulting resource block. When `null`, the `security_groups` field will be omitted from the resulting object.\n - `subnets` (`list`): Set the `subnets` field on the resulting resource block. When `null`, the `subnets` 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 - `xff_header_processing_mode` (`string`): Set the `xff_header_processing_mode` field on the resulting resource block. When `null`, the `xff_header_processing_mode` field will be omitted from the resulting object.\n - `access_logs` (`list[obj]`): Set the `access_logs` field on the resulting resource block. When `null`, the `access_logs` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [aws.lb.access_logs.new](#fn-access_logsnew) constructor.\n - `subnet_mapping` (`list[obj]`): Set the `subnet_mapping` field on the resulting resource block. When `null`, the `subnet_mapping` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [aws.lb.subnet_mapping.new](#fn-subnet_mappingnew) constructor.\n - `timeouts` (`obj`): Set the `timeouts` field on the resulting resource block. When `null`, the `timeouts` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [aws.lb.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, access_logs=null, @@ -28,6 +28,7 @@ local d = (import 'github.com/jsonnet-libs/docsonnet/doc-util/main.libsonnet'); enable_tls_version_and_cipher_suite_headers=null, enable_waf_fail_open=null, enable_xff_client_port=null, + enforce_security_group_inbound_rules_on_private_link_traffic=null, idle_timeout=null, internal=null, ip_address_type=null, @@ -58,6 +59,7 @@ local d = (import 'github.com/jsonnet-libs/docsonnet/doc-util/main.libsonnet'); enable_tls_version_and_cipher_suite_headers=enable_tls_version_and_cipher_suite_headers, enable_waf_fail_open=enable_waf_fail_open, enable_xff_client_port=enable_xff_client_port, + enforce_security_group_inbound_rules_on_private_link_traffic=enforce_security_group_inbound_rules_on_private_link_traffic, idle_timeout=idle_timeout, internal=internal, ip_address_type=ip_address_type, @@ -75,7 +77,7 @@ local d = (import 'github.com/jsonnet-libs/docsonnet/doc-util/main.libsonnet'); ), _meta=_meta ), - '#newAttrs':: d.fn(help='\n`aws.lb.newAttrs` constructs a new object with attributes and blocks configured for the `lb`\nTerraform resource.\n\nUnlike [aws.lb.new](#fn-new), this function will not inject the `resource`\nblock into the root Terraform document. Instead, this must be passed in as the `attrs` argument for the\n[tf.withResource](https://github.com/tf-libsonnet/core/tree/main/docs#fn-withresource) function to build a complete block.\n\nThis is most useful when you need to preprocess the attributes with functions, conditional, or looping logic prior to\ninjecting into a complete block.\n\n**Args**:\n - `customer_owned_ipv4_pool` (`string`): Set the `customer_owned_ipv4_pool` field on the resulting object. When `null`, the `customer_owned_ipv4_pool` field will be omitted from the resulting object.\n - `desync_mitigation_mode` (`string`): Set the `desync_mitigation_mode` field on the resulting object. When `null`, the `desync_mitigation_mode` field will be omitted from the resulting object.\n - `dns_record_client_routing_policy` (`string`): Set the `dns_record_client_routing_policy` field on the resulting object. When `null`, the `dns_record_client_routing_policy` field will be omitted from the resulting object.\n - `drop_invalid_header_fields` (`bool`): Set the `drop_invalid_header_fields` field on the resulting object. When `null`, the `drop_invalid_header_fields` field will be omitted from the resulting object.\n - `enable_cross_zone_load_balancing` (`bool`): Set the `enable_cross_zone_load_balancing` field on the resulting object. When `null`, the `enable_cross_zone_load_balancing` field will be omitted from the resulting object.\n - `enable_deletion_protection` (`bool`): Set the `enable_deletion_protection` field on the resulting object. When `null`, the `enable_deletion_protection` field will be omitted from the resulting object.\n - `enable_http2` (`bool`): Set the `enable_http2` field on the resulting object. When `null`, the `enable_http2` field will be omitted from the resulting object.\n - `enable_tls_version_and_cipher_suite_headers` (`bool`): Set the `enable_tls_version_and_cipher_suite_headers` field on the resulting object. When `null`, the `enable_tls_version_and_cipher_suite_headers` field will be omitted from the resulting object.\n - `enable_waf_fail_open` (`bool`): Set the `enable_waf_fail_open` field on the resulting object. When `null`, the `enable_waf_fail_open` field will be omitted from the resulting object.\n - `enable_xff_client_port` (`bool`): Set the `enable_xff_client_port` field on the resulting object. When `null`, the `enable_xff_client_port` field will be omitted from the resulting object.\n - `idle_timeout` (`number`): Set the `idle_timeout` field on the resulting object. When `null`, the `idle_timeout` field will be omitted from the resulting object.\n - `internal` (`bool`): Set the `internal` field on the resulting object. When `null`, the `internal` field will be omitted from the resulting object.\n - `ip_address_type` (`string`): Set the `ip_address_type` field on the resulting object. When `null`, the `ip_address_type` field will be omitted from the resulting object.\n - `load_balancer_type` (`string`): Set the `load_balancer_type` field on the resulting object. When `null`, the `load_balancer_type` field will be omitted from the resulting object.\n - `name` (`string`): Set the `name` field on the resulting object. When `null`, the `name` field will be omitted from the resulting object.\n - `name_prefix` (`string`): Set the `name_prefix` field on the resulting object. When `null`, the `name_prefix` field will be omitted from the resulting object.\n - `preserve_host_header` (`bool`): Set the `preserve_host_header` field on the resulting object. When `null`, the `preserve_host_header` field will be omitted from the resulting object.\n - `security_groups` (`list`): Set the `security_groups` field on the resulting object. When `null`, the `security_groups` field will be omitted from the resulting object.\n - `subnets` (`list`): Set the `subnets` field on the resulting object. When `null`, the `subnets` 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 - `xff_header_processing_mode` (`string`): Set the `xff_header_processing_mode` field on the resulting object. When `null`, the `xff_header_processing_mode` field will be omitted from the resulting object.\n - `access_logs` (`list[obj]`): Set the `access_logs` field on the resulting object. When `null`, the `access_logs` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [aws.lb.access_logs.new](#fn-access_logsnew) constructor.\n - `subnet_mapping` (`list[obj]`): Set the `subnet_mapping` field on the resulting object. When `null`, the `subnet_mapping` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [aws.lb.subnet_mapping.new](#fn-subnet_mappingnew) constructor.\n - `timeouts` (`obj`): Set the `timeouts` field on the resulting object. When `null`, the `timeouts` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [aws.lb.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 `lb` resource into the root Terraform configuration.\n', args=[]), + '#newAttrs':: d.fn(help='\n`aws.lb.newAttrs` constructs a new object with attributes and blocks configured for the `lb`\nTerraform resource.\n\nUnlike [aws.lb.new](#fn-new), this function will not inject the `resource`\nblock into the root Terraform document. Instead, this must be passed in as the `attrs` argument for the\n[tf.withResource](https://github.com/tf-libsonnet/core/tree/main/docs#fn-withresource) function to build a complete block.\n\nThis is most useful when you need to preprocess the attributes with functions, conditional, or looping logic prior to\ninjecting into a complete block.\n\n**Args**:\n - `customer_owned_ipv4_pool` (`string`): Set the `customer_owned_ipv4_pool` field on the resulting object. When `null`, the `customer_owned_ipv4_pool` field will be omitted from the resulting object.\n - `desync_mitigation_mode` (`string`): Set the `desync_mitigation_mode` field on the resulting object. When `null`, the `desync_mitigation_mode` field will be omitted from the resulting object.\n - `dns_record_client_routing_policy` (`string`): Set the `dns_record_client_routing_policy` field on the resulting object. When `null`, the `dns_record_client_routing_policy` field will be omitted from the resulting object.\n - `drop_invalid_header_fields` (`bool`): Set the `drop_invalid_header_fields` field on the resulting object. When `null`, the `drop_invalid_header_fields` field will be omitted from the resulting object.\n - `enable_cross_zone_load_balancing` (`bool`): Set the `enable_cross_zone_load_balancing` field on the resulting object. When `null`, the `enable_cross_zone_load_balancing` field will be omitted from the resulting object.\n - `enable_deletion_protection` (`bool`): Set the `enable_deletion_protection` field on the resulting object. When `null`, the `enable_deletion_protection` field will be omitted from the resulting object.\n - `enable_http2` (`bool`): Set the `enable_http2` field on the resulting object. When `null`, the `enable_http2` field will be omitted from the resulting object.\n - `enable_tls_version_and_cipher_suite_headers` (`bool`): Set the `enable_tls_version_and_cipher_suite_headers` field on the resulting object. When `null`, the `enable_tls_version_and_cipher_suite_headers` field will be omitted from the resulting object.\n - `enable_waf_fail_open` (`bool`): Set the `enable_waf_fail_open` field on the resulting object. When `null`, the `enable_waf_fail_open` field will be omitted from the resulting object.\n - `enable_xff_client_port` (`bool`): Set the `enable_xff_client_port` field on the resulting object. When `null`, the `enable_xff_client_port` field will be omitted from the resulting object.\n - `enforce_security_group_inbound_rules_on_private_link_traffic` (`string`): Set the `enforce_security_group_inbound_rules_on_private_link_traffic` field on the resulting object. When `null`, the `enforce_security_group_inbound_rules_on_private_link_traffic` field will be omitted from the resulting object.\n - `idle_timeout` (`number`): Set the `idle_timeout` field on the resulting object. When `null`, the `idle_timeout` field will be omitted from the resulting object.\n - `internal` (`bool`): Set the `internal` field on the resulting object. When `null`, the `internal` field will be omitted from the resulting object.\n - `ip_address_type` (`string`): Set the `ip_address_type` field on the resulting object. When `null`, the `ip_address_type` field will be omitted from the resulting object.\n - `load_balancer_type` (`string`): Set the `load_balancer_type` field on the resulting object. When `null`, the `load_balancer_type` field will be omitted from the resulting object.\n - `name` (`string`): Set the `name` field on the resulting object. When `null`, the `name` field will be omitted from the resulting object.\n - `name_prefix` (`string`): Set the `name_prefix` field on the resulting object. When `null`, the `name_prefix` field will be omitted from the resulting object.\n - `preserve_host_header` (`bool`): Set the `preserve_host_header` field on the resulting object. When `null`, the `preserve_host_header` field will be omitted from the resulting object.\n - `security_groups` (`list`): Set the `security_groups` field on the resulting object. When `null`, the `security_groups` field will be omitted from the resulting object.\n - `subnets` (`list`): Set the `subnets` field on the resulting object. When `null`, the `subnets` 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 - `xff_header_processing_mode` (`string`): Set the `xff_header_processing_mode` field on the resulting object. When `null`, the `xff_header_processing_mode` field will be omitted from the resulting object.\n - `access_logs` (`list[obj]`): Set the `access_logs` field on the resulting object. When `null`, the `access_logs` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [aws.lb.access_logs.new](#fn-access_logsnew) constructor.\n - `subnet_mapping` (`list[obj]`): Set the `subnet_mapping` field on the resulting object. When `null`, the `subnet_mapping` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [aws.lb.subnet_mapping.new](#fn-subnet_mappingnew) constructor.\n - `timeouts` (`obj`): Set the `timeouts` field on the resulting object. When `null`, the `timeouts` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [aws.lb.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 `lb` resource into the root Terraform configuration.\n', args=[]), newAttrs( access_logs=null, customer_owned_ipv4_pool=null, @@ -88,6 +90,7 @@ local d = (import 'github.com/jsonnet-libs/docsonnet/doc-util/main.libsonnet'); enable_tls_version_and_cipher_suite_headers=null, enable_waf_fail_open=null, enable_xff_client_port=null, + enforce_security_group_inbound_rules_on_private_link_traffic=null, idle_timeout=null, internal=null, ip_address_type=null, @@ -114,6 +117,7 @@ local d = (import 'github.com/jsonnet-libs/docsonnet/doc-util/main.libsonnet'); enable_tls_version_and_cipher_suite_headers: enable_tls_version_and_cipher_suite_headers, enable_waf_fail_open: enable_waf_fail_open, enable_xff_client_port: enable_xff_client_port, + enforce_security_group_inbound_rules_on_private_link_traffic: enforce_security_group_inbound_rules_on_private_link_traffic, idle_timeout: idle_timeout, internal: internal, ip_address_type: ip_address_type, @@ -275,6 +279,16 @@ local d = (import 'github.com/jsonnet-libs/docsonnet/doc-util/main.libsonnet'); }, }, }, + '#withEnforceSecurityGroupInboundRulesOnPrivateLinkTraffic':: d.fn(help='`aws.string.withEnforceSecurityGroupInboundRulesOnPrivateLinkTraffic` constructs a mixin object that can be merged into the `string`\nTerraform resource block to set or update the enforce_security_group_inbound_rules_on_private_link_traffic 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 `enforce_security_group_inbound_rules_on_private_link_traffic` field.\n', args=[]), + withEnforceSecurityGroupInboundRulesOnPrivateLinkTraffic(resourceLabel, value): { + resource+: { + aws_lb+: { + [resourceLabel]+: { + enforce_security_group_inbound_rules_on_private_link_traffic: value, + }, + }, + }, + }, '#withIdleTimeout':: d.fn(help='`aws.number.withIdleTimeout` constructs a mixin object that can be merged into the `number`\nTerraform resource block to set or update the idle_timeout 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 `idle_timeout` field.\n', args=[]), withIdleTimeout(resourceLabel, value): { resource+: { diff --git a/5.x/_gen/resources/lb_listener.libsonnet b/5.x/_gen/resources/lb_listener.libsonnet index 843d0360..1eb46e08 100644 --- a/5.x/_gen/resources/lb_listener.libsonnet +++ b/5.x/_gen/resources/lb_listener.libsonnet @@ -134,13 +134,26 @@ local d = (import 'github.com/jsonnet-libs/docsonnet/doc-util/main.libsonnet'); }), }, }, - '#new':: d.fn(help="\n`aws.lb_listener.new` injects a new `aws_lb_listener` 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.lb_listener.new('some_id')\n\nYou can get the reference to the `id` field of the created `aws.lb_listener` using the reference:\n\n $._ref.aws_lb_listener.some_id.get('id')\n\nThis is the same as directly entering `\"${ aws_lb_listener.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 - `alpn_policy` (`string`): Set the `alpn_policy` field on the resulting resource block. When `null`, the `alpn_policy` field will be omitted from the resulting object.\n - `certificate_arn` (`string`): Set the `certificate_arn` field on the resulting resource block. When `null`, the `certificate_arn` field will be omitted from the resulting object.\n - `load_balancer_arn` (`string`): Set the `load_balancer_arn` field on the resulting resource block.\n - `port` (`number`): Set the `port` field on the resulting resource block. When `null`, the `port` field will be omitted from the resulting object.\n - `protocol` (`string`): Set the `protocol` field on the resulting resource block. When `null`, the `protocol` field will be omitted from the resulting object.\n - `ssl_policy` (`string`): Set the `ssl_policy` field on the resulting resource block. When `null`, the `ssl_policy` 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 - `default_action` (`list[obj]`): Set the `default_action` field on the resulting resource block. When `null`, the `default_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.lb_listener.default_action.new](#fn-default_actionnew) constructor.\n - `timeouts` (`obj`): Set the `timeouts` field on the resulting resource block. When `null`, the `timeouts` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [aws.lb_listener.timeouts.new](#fn-timeoutsnew) constructor.\n\n**Returns**:\n- A mixin object that injects the new resource into the root Terraform configuration.\n", args=[]), + mutual_authentication:: { + '#new':: d.fn(help='\n`aws.lb_listener.mutual_authentication.new` constructs a new object with attributes and blocks configured for the `mutual_authentication`\nTerraform sub block.\n\n\n\n**Args**:\n - `ignore_client_certificate_expiry` (`bool`): Set the `ignore_client_certificate_expiry` field on the resulting object. When `null`, the `ignore_client_certificate_expiry` field will be omitted from the resulting object.\n - `mode` (`string`): Set the `mode` field on the resulting object.\n - `trust_store_arn` (`string`): Set the `trust_store_arn` field on the resulting object. When `null`, the `trust_store_arn` field will be omitted from the resulting object.\n\n**Returns**:\n - An attribute object that represents the `mutual_authentication` sub block.\n', args=[]), + new( + mode, + ignore_client_certificate_expiry=null, + trust_store_arn=null + ):: std.prune(a={ + ignore_client_certificate_expiry: ignore_client_certificate_expiry, + mode: mode, + trust_store_arn: trust_store_arn, + }), + }, + '#new':: d.fn(help="\n`aws.lb_listener.new` injects a new `aws_lb_listener` 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.lb_listener.new('some_id')\n\nYou can get the reference to the `id` field of the created `aws.lb_listener` using the reference:\n\n $._ref.aws_lb_listener.some_id.get('id')\n\nThis is the same as directly entering `\"${ aws_lb_listener.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 - `alpn_policy` (`string`): Set the `alpn_policy` field on the resulting resource block. When `null`, the `alpn_policy` field will be omitted from the resulting object.\n - `certificate_arn` (`string`): Set the `certificate_arn` field on the resulting resource block. When `null`, the `certificate_arn` field will be omitted from the resulting object.\n - `load_balancer_arn` (`string`): Set the `load_balancer_arn` field on the resulting resource block.\n - `port` (`number`): Set the `port` field on the resulting resource block. When `null`, the `port` field will be omitted from the resulting object.\n - `protocol` (`string`): Set the `protocol` field on the resulting resource block. When `null`, the `protocol` field will be omitted from the resulting object.\n - `ssl_policy` (`string`): Set the `ssl_policy` field on the resulting resource block. When `null`, the `ssl_policy` 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 - `default_action` (`list[obj]`): Set the `default_action` field on the resulting resource block. When `null`, the `default_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.lb_listener.default_action.new](#fn-default_actionnew) constructor.\n - `mutual_authentication` (`list[obj]`): Set the `mutual_authentication` field on the resulting resource block. When `null`, the `mutual_authentication` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [aws.lb_listener.mutual_authentication.new](#fn-mutual_authenticationnew) constructor.\n - `timeouts` (`obj`): Set the `timeouts` field on the resulting resource block. When `null`, the `timeouts` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [aws.lb_listener.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, load_balancer_arn, alpn_policy=null, certificate_arn=null, default_action=null, + mutual_authentication=null, port=null, protocol=null, ssl_policy=null, @@ -156,6 +169,7 @@ local d = (import 'github.com/jsonnet-libs/docsonnet/doc-util/main.libsonnet'); certificate_arn=certificate_arn, default_action=default_action, load_balancer_arn=load_balancer_arn, + mutual_authentication=mutual_authentication, port=port, protocol=protocol, ssl_policy=ssl_policy, @@ -165,12 +179,13 @@ local d = (import 'github.com/jsonnet-libs/docsonnet/doc-util/main.libsonnet'); ), _meta=_meta ), - '#newAttrs':: d.fn(help='\n`aws.lb_listener.newAttrs` constructs a new object with attributes and blocks configured for the `lb_listener`\nTerraform resource.\n\nUnlike [aws.lb_listener.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 - `alpn_policy` (`string`): Set the `alpn_policy` field on the resulting object. When `null`, the `alpn_policy` field will be omitted from the resulting object.\n - `certificate_arn` (`string`): Set the `certificate_arn` field on the resulting object. When `null`, the `certificate_arn` field will be omitted from the resulting object.\n - `load_balancer_arn` (`string`): Set the `load_balancer_arn` field on the resulting object.\n - `port` (`number`): Set the `port` field on the resulting object. When `null`, the `port` field will be omitted from the resulting object.\n - `protocol` (`string`): Set the `protocol` field on the resulting object. When `null`, the `protocol` field will be omitted from the resulting object.\n - `ssl_policy` (`string`): Set the `ssl_policy` field on the resulting object. When `null`, the `ssl_policy` 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 - `default_action` (`list[obj]`): Set the `default_action` field on the resulting object. When `null`, the `default_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.lb_listener.default_action.new](#fn-default_actionnew) constructor.\n - `timeouts` (`obj`): Set the `timeouts` field on the resulting object. When `null`, the `timeouts` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [aws.lb_listener.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 `lb_listener` resource into the root Terraform configuration.\n', args=[]), + '#newAttrs':: d.fn(help='\n`aws.lb_listener.newAttrs` constructs a new object with attributes and blocks configured for the `lb_listener`\nTerraform resource.\n\nUnlike [aws.lb_listener.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 - `alpn_policy` (`string`): Set the `alpn_policy` field on the resulting object. When `null`, the `alpn_policy` field will be omitted from the resulting object.\n - `certificate_arn` (`string`): Set the `certificate_arn` field on the resulting object. When `null`, the `certificate_arn` field will be omitted from the resulting object.\n - `load_balancer_arn` (`string`): Set the `load_balancer_arn` field on the resulting object.\n - `port` (`number`): Set the `port` field on the resulting object. When `null`, the `port` field will be omitted from the resulting object.\n - `protocol` (`string`): Set the `protocol` field on the resulting object. When `null`, the `protocol` field will be omitted from the resulting object.\n - `ssl_policy` (`string`): Set the `ssl_policy` field on the resulting object. When `null`, the `ssl_policy` 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 - `default_action` (`list[obj]`): Set the `default_action` field on the resulting object. When `null`, the `default_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.lb_listener.default_action.new](#fn-default_actionnew) constructor.\n - `mutual_authentication` (`list[obj]`): Set the `mutual_authentication` field on the resulting object. When `null`, the `mutual_authentication` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [aws.lb_listener.mutual_authentication.new](#fn-mutual_authenticationnew) constructor.\n - `timeouts` (`obj`): Set the `timeouts` field on the resulting object. When `null`, the `timeouts` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [aws.lb_listener.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 `lb_listener` resource into the root Terraform configuration.\n', args=[]), newAttrs( load_balancer_arn, alpn_policy=null, certificate_arn=null, default_action=null, + mutual_authentication=null, port=null, protocol=null, ssl_policy=null, @@ -182,6 +197,7 @@ local d = (import 'github.com/jsonnet-libs/docsonnet/doc-util/main.libsonnet'); certificate_arn: certificate_arn, default_action: default_action, load_balancer_arn: load_balancer_arn, + mutual_authentication: mutual_authentication, port: port, protocol: protocol, ssl_policy: ssl_policy, @@ -190,11 +206,13 @@ local d = (import 'github.com/jsonnet-libs/docsonnet/doc-util/main.libsonnet'); timeouts: timeouts, }), timeouts:: { - '#new':: d.fn(help='\n`aws.lb_listener.timeouts.new` constructs a new object with attributes and blocks configured for the `timeouts`\nTerraform sub block.\n\n\n\n**Args**:\n - `read` (`string`): Set the `read` field on the resulting object. When `null`, the `read` field will be omitted from the resulting object.\n\n**Returns**:\n - An attribute object that represents the `timeouts` sub block.\n', args=[]), + '#new':: d.fn(help='\n`aws.lb_listener.timeouts.new` constructs a new object with attributes and blocks configured for the `timeouts`\nTerraform sub block.\n\n\n\n**Args**:\n - `create` (`string`): Set the `create` field on the resulting object. When `null`, the `create` field will be omitted from the resulting object.\n - `update` (`string`): Set the `update` field on the resulting object. When `null`, the `update` field will be omitted from the resulting object.\n\n**Returns**:\n - An attribute object that represents the `timeouts` sub block.\n', args=[]), new( - read=null + create=null, + update=null ):: std.prune(a={ - read: read, + create: create, + update: update, }), }, '#withAlpnPolicy':: d.fn(help='`aws.string.withAlpnPolicy` constructs a mixin object that can be merged into the `string`\nTerraform resource block to set or update the alpn_policy field.\n\n\n\n**Args**:\n - `resourceLabel` (`string`): The name label of the block to update.\n - `value` (`string`): The value to set for the `alpn_policy` field.\n', args=[]), @@ -247,6 +265,26 @@ local d = (import 'github.com/jsonnet-libs/docsonnet/doc-util/main.libsonnet'); }, }, }, + '#withMutualAuthentication':: d.fn(help='`aws.list[obj].withMutualAuthentication` constructs a mixin object that can be merged into the `list[obj]`\nTerraform resource block to set or update the mutual_authentication 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].withMutualAuthenticationMixin](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 `mutual_authentication` field.\n', args=[]), + withMutualAuthentication(resourceLabel, value): { + resource+: { + aws_lb_listener+: { + [resourceLabel]+: { + mutual_authentication: value, + }, + }, + }, + }, + '#withMutualAuthenticationMixin':: d.fn(help='`aws.list[obj].withMutualAuthenticationMixin` constructs a mixin object that can be merged into the `list[obj]`\nTerraform resource block to set or update the mutual_authentication 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].withMutualAuthentication](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 `mutual_authentication` field.\n', args=[]), + withMutualAuthenticationMixin(resourceLabel, value): { + resource+: { + aws_lb_listener+: { + [resourceLabel]+: { + mutual_authentication+: if std.isArray(v=value) then value else [value], + }, + }, + }, + }, '#withPort':: d.fn(help='`aws.number.withPort` constructs a mixin object that can be merged into the `number`\nTerraform resource block to set or update the port 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 `port` field.\n', args=[]), withPort(resourceLabel, value): { resource+: { diff --git a/5.x/_gen/resources/lb_trust_store.libsonnet b/5.x/_gen/resources/lb_trust_store.libsonnet new file mode 100644 index 00000000..79dc9719 --- /dev/null +++ b/5.x/_gen/resources/lb_trust_store.libsonnet @@ -0,0 +1,152 @@ +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='lb_trust_store', url='', help='`lb_trust_store` represents the `aws_lb_trust_store` 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.lb_trust_store.new` injects a new `aws_lb_trust_store` 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.lb_trust_store.new('some_id')\n\nYou can get the reference to the `id` field of the created `aws.lb_trust_store` using the reference:\n\n $._ref.aws_lb_trust_store.some_id.get('id')\n\nThis is the same as directly entering `\"${ aws_lb_trust_store.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 - `ca_certificates_bundle_s3_bucket` (`string`): Set the `ca_certificates_bundle_s3_bucket` field on the resulting resource block.\n - `ca_certificates_bundle_s3_key` (`string`): Set the `ca_certificates_bundle_s3_key` field on the resulting resource block.\n - `ca_certificates_bundle_s3_object_version` (`string`): Set the `ca_certificates_bundle_s3_object_version` field on the resulting resource block. When `null`, the `ca_certificates_bundle_s3_object_version` field will be omitted from the resulting object.\n - `name` (`string`): Set the `name` field on the resulting resource block. When `null`, the `name` field will be omitted from the resulting object.\n - `name_prefix` (`string`): Set the `name_prefix` field on the resulting resource block. When `null`, the `name_prefix` field will be omitted from the resulting object.\n - `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.lb_trust_store.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, + ca_certificates_bundle_s3_bucket, + ca_certificates_bundle_s3_key, + ca_certificates_bundle_s3_object_version=null, + name=null, + name_prefix=null, + tags=null, + tags_all=null, + timeouts=null, + _meta={} + ):: tf.withResource( + type='aws_lb_trust_store', + label=resourceLabel, + attrs=self.newAttrs( + ca_certificates_bundle_s3_bucket=ca_certificates_bundle_s3_bucket, + ca_certificates_bundle_s3_key=ca_certificates_bundle_s3_key, + ca_certificates_bundle_s3_object_version=ca_certificates_bundle_s3_object_version, + name=name, + name_prefix=name_prefix, + tags=tags, + tags_all=tags_all, + timeouts=timeouts + ), + _meta=_meta + ), + '#newAttrs':: d.fn(help='\n`aws.lb_trust_store.newAttrs` constructs a new object with attributes and blocks configured for the `lb_trust_store`\nTerraform resource.\n\nUnlike [aws.lb_trust_store.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 - `ca_certificates_bundle_s3_bucket` (`string`): Set the `ca_certificates_bundle_s3_bucket` field on the resulting object.\n - `ca_certificates_bundle_s3_key` (`string`): Set the `ca_certificates_bundle_s3_key` field on the resulting object.\n - `ca_certificates_bundle_s3_object_version` (`string`): Set the `ca_certificates_bundle_s3_object_version` field on the resulting object. When `null`, the `ca_certificates_bundle_s3_object_version` field will be omitted from the resulting object.\n - `name` (`string`): Set the `name` field on the resulting object. When `null`, the `name` field will be omitted from the resulting object.\n - `name_prefix` (`string`): Set the `name_prefix` field on the resulting object. When `null`, the `name_prefix` field will be omitted from the resulting object.\n - `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.lb_trust_store.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 `lb_trust_store` resource into the root Terraform configuration.\n', args=[]), + newAttrs( + ca_certificates_bundle_s3_bucket, + ca_certificates_bundle_s3_key, + ca_certificates_bundle_s3_object_version=null, + name=null, + name_prefix=null, + tags=null, + tags_all=null, + timeouts=null + ):: std.prune(a={ + ca_certificates_bundle_s3_bucket: ca_certificates_bundle_s3_bucket, + ca_certificates_bundle_s3_key: ca_certificates_bundle_s3_key, + ca_certificates_bundle_s3_object_version: ca_certificates_bundle_s3_object_version, + name: name, + name_prefix: name_prefix, + tags: tags, + tags_all: tags_all, + timeouts: timeouts, + }), + timeouts:: { + '#new':: d.fn(help='\n`aws.lb_trust_store.timeouts.new` constructs a new object with attributes and blocks configured for the `timeouts`\nTerraform sub block.\n\n\n\n**Args**:\n - `create` (`string`): Set the `create` field on the resulting object. When `null`, the `create` field will be omitted from the resulting object.\n - `delete` (`string`): Set the `delete` field on the resulting object. When `null`, the `delete` field will be omitted from the resulting object.\n\n**Returns**:\n - An attribute object that represents the `timeouts` sub block.\n', args=[]), + new( + create=null, + delete=null + ):: std.prune(a={ + create: create, + delete: delete, + }), + }, + '#withCaCertificatesBundleS3Bucket':: d.fn(help='`aws.string.withCaCertificatesBundleS3Bucket` constructs a mixin object that can be merged into the `string`\nTerraform resource block to set or update the ca_certificates_bundle_s3_bucket field.\n\n\n\n**Args**:\n - `resourceLabel` (`string`): The name label of the block to update.\n - `value` (`string`): The value to set for the `ca_certificates_bundle_s3_bucket` field.\n', args=[]), + withCaCertificatesBundleS3Bucket(resourceLabel, value): { + resource+: { + aws_lb_trust_store+: { + [resourceLabel]+: { + ca_certificates_bundle_s3_bucket: value, + }, + }, + }, + }, + '#withCaCertificatesBundleS3Key':: d.fn(help='`aws.string.withCaCertificatesBundleS3Key` constructs a mixin object that can be merged into the `string`\nTerraform resource block to set or update the ca_certificates_bundle_s3_key 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 `ca_certificates_bundle_s3_key` field.\n', args=[]), + withCaCertificatesBundleS3Key(resourceLabel, value): { + resource+: { + aws_lb_trust_store+: { + [resourceLabel]+: { + ca_certificates_bundle_s3_key: value, + }, + }, + }, + }, + '#withCaCertificatesBundleS3ObjectVersion':: d.fn(help='`aws.string.withCaCertificatesBundleS3ObjectVersion` constructs a mixin object that can be merged into the `string`\nTerraform resource block to set or update the ca_certificates_bundle_s3_object_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 `ca_certificates_bundle_s3_object_version` field.\n', args=[]), + withCaCertificatesBundleS3ObjectVersion(resourceLabel, value): { + resource+: { + aws_lb_trust_store+: { + [resourceLabel]+: { + ca_certificates_bundle_s3_object_version: value, + }, + }, + }, + }, + '#withName':: d.fn(help='`aws.string.withName` constructs a mixin object that can be merged into the `string`\nTerraform resource block to set or update the 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 `name` field.\n', args=[]), + withName(resourceLabel, value): { + resource+: { + aws_lb_trust_store+: { + [resourceLabel]+: { + name: value, + }, + }, + }, + }, + '#withNamePrefix':: d.fn(help='`aws.string.withNamePrefix` constructs a mixin object that can be merged into the `string`\nTerraform resource block to set or update the name_prefix field.\n\n\n\n**Args**:\n - `resourceLabel` (`string`): The name label of the block to update.\n - `value` (`string`): The value to set for the `name_prefix` field.\n', args=[]), + withNamePrefix(resourceLabel, value): { + resource+: { + aws_lb_trust_store+: { + [resourceLabel]+: { + name_prefix: 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_lb_trust_store+: { + [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_lb_trust_store+: { + [resourceLabel]+: { + tags_all: value, + }, + }, + }, + }, + '#withTimeouts':: d.fn(help='`aws.obj.withTimeouts` constructs a mixin object that can be merged into the `obj`\nTerraform resource block to set or update the timeouts field.\n\nThis function will replace the map with the passed in `value`. If you wish to instead merge the\npassed in value to the existing map, use the [aws.obj.withTimeoutsMixin](TODO) function.\n\n**Args**:\n - `resourceLabel` (`string`): The name label of the block to update.\n - `value` (`obj`): The value to set for the `timeouts` field.\n', args=[]), + withTimeouts(resourceLabel, value): { + resource+: { + aws_lb_trust_store+: { + [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_lb_trust_store+: { + [resourceLabel]+: { + timeouts+: value, + }, + }, + }, + }, +} diff --git a/5.x/_gen/resources/lb_trust_store_revocation.libsonnet b/5.x/_gen/resources/lb_trust_store_revocation.libsonnet new file mode 100644 index 00000000..fa95b6ab --- /dev/null +++ b/5.x/_gen/resources/lb_trust_store_revocation.libsonnet @@ -0,0 +1,108 @@ +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='lb_trust_store_revocation', url='', help='`lb_trust_store_revocation` represents the `aws_lb_trust_store_revocation` 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.lb_trust_store_revocation.new` injects a new `aws_lb_trust_store_revocation` 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.lb_trust_store_revocation.new('some_id')\n\nYou can get the reference to the `id` field of the created `aws.lb_trust_store_revocation` using the reference:\n\n $._ref.aws_lb_trust_store_revocation.some_id.get('id')\n\nThis is the same as directly entering `\"${ aws_lb_trust_store_revocation.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 - `revocations_s3_bucket` (`string`): Set the `revocations_s3_bucket` field on the resulting resource block.\n - `revocations_s3_key` (`string`): Set the `revocations_s3_key` field on the resulting resource block.\n - `revocations_s3_object_version` (`string`): Set the `revocations_s3_object_version` field on the resulting resource block. When `null`, the `revocations_s3_object_version` field will be omitted from the resulting object.\n - `trust_store_arn` (`string`): Set the `trust_store_arn` field on the resulting resource block.\n - `timeouts` (`obj`): Set the `timeouts` field on the resulting resource block. When `null`, the `timeouts` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [aws.lb_trust_store_revocation.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, + revocations_s3_bucket, + revocations_s3_key, + trust_store_arn, + revocations_s3_object_version=null, + timeouts=null, + _meta={} + ):: tf.withResource( + type='aws_lb_trust_store_revocation', + label=resourceLabel, + attrs=self.newAttrs( + revocations_s3_bucket=revocations_s3_bucket, + revocations_s3_key=revocations_s3_key, + revocations_s3_object_version=revocations_s3_object_version, + timeouts=timeouts, + trust_store_arn=trust_store_arn + ), + _meta=_meta + ), + '#newAttrs':: d.fn(help='\n`aws.lb_trust_store_revocation.newAttrs` constructs a new object with attributes and blocks configured for the `lb_trust_store_revocation`\nTerraform resource.\n\nUnlike [aws.lb_trust_store_revocation.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 - `revocations_s3_bucket` (`string`): Set the `revocations_s3_bucket` field on the resulting object.\n - `revocations_s3_key` (`string`): Set the `revocations_s3_key` field on the resulting object.\n - `revocations_s3_object_version` (`string`): Set the `revocations_s3_object_version` field on the resulting object. When `null`, the `revocations_s3_object_version` field will be omitted from the resulting object.\n - `trust_store_arn` (`string`): Set the `trust_store_arn` field on the resulting object.\n - `timeouts` (`obj`): Set the `timeouts` field on the resulting object. When `null`, the `timeouts` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [aws.lb_trust_store_revocation.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 `lb_trust_store_revocation` resource into the root Terraform configuration.\n', args=[]), + newAttrs( + revocations_s3_bucket, + revocations_s3_key, + trust_store_arn, + revocations_s3_object_version=null, + timeouts=null + ):: std.prune(a={ + revocations_s3_bucket: revocations_s3_bucket, + revocations_s3_key: revocations_s3_key, + revocations_s3_object_version: revocations_s3_object_version, + timeouts: timeouts, + trust_store_arn: trust_store_arn, + }), + timeouts:: { + '#new':: d.fn(help='\n`aws.lb_trust_store_revocation.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\n**Returns**:\n - An attribute object that represents the `timeouts` sub block.\n', args=[]), + new( + create=null + ):: std.prune(a={ + create: create, + }), + }, + '#withRevocationsS3Bucket':: d.fn(help='`aws.string.withRevocationsS3Bucket` constructs a mixin object that can be merged into the `string`\nTerraform resource block to set or update the revocations_s3_bucket field.\n\n\n\n**Args**:\n - `resourceLabel` (`string`): The name label of the block to update.\n - `value` (`string`): The value to set for the `revocations_s3_bucket` field.\n', args=[]), + withRevocationsS3Bucket(resourceLabel, value): { + resource+: { + aws_lb_trust_store_revocation+: { + [resourceLabel]+: { + revocations_s3_bucket: value, + }, + }, + }, + }, + '#withRevocationsS3Key':: d.fn(help='`aws.string.withRevocationsS3Key` constructs a mixin object that can be merged into the `string`\nTerraform resource block to set or update the revocations_s3_key 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 `revocations_s3_key` field.\n', args=[]), + withRevocationsS3Key(resourceLabel, value): { + resource+: { + aws_lb_trust_store_revocation+: { + [resourceLabel]+: { + revocations_s3_key: value, + }, + }, + }, + }, + '#withRevocationsS3ObjectVersion':: d.fn(help='`aws.string.withRevocationsS3ObjectVersion` constructs a mixin object that can be merged into the `string`\nTerraform resource block to set or update the revocations_s3_object_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 `revocations_s3_object_version` field.\n', args=[]), + withRevocationsS3ObjectVersion(resourceLabel, value): { + resource+: { + aws_lb_trust_store_revocation+: { + [resourceLabel]+: { + revocations_s3_object_version: value, + }, + }, + }, + }, + '#withTimeouts':: d.fn(help='`aws.obj.withTimeouts` constructs a mixin object that can be merged into the `obj`\nTerraform resource block to set or update the timeouts field.\n\nThis function will replace the map with the passed in `value`. If you wish to instead merge the\npassed in value to the existing map, use the [aws.obj.withTimeoutsMixin](TODO) function.\n\n**Args**:\n - `resourceLabel` (`string`): The name label of the block to update.\n - `value` (`obj`): The value to set for the `timeouts` field.\n', args=[]), + withTimeouts(resourceLabel, value): { + resource+: { + aws_lb_trust_store_revocation+: { + [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_lb_trust_store_revocation+: { + [resourceLabel]+: { + timeouts+: value, + }, + }, + }, + }, + '#withTrustStoreArn':: d.fn(help='`aws.string.withTrustStoreArn` constructs a mixin object that can be merged into the `string`\nTerraform resource block to set or update the trust_store_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 `trust_store_arn` field.\n', args=[]), + withTrustStoreArn(resourceLabel, value): { + resource+: { + aws_lb_trust_store_revocation+: { + [resourceLabel]+: { + trust_store_arn: value, + }, + }, + }, + }, +} diff --git a/5.x/_gen/resources/sagemaker_app.libsonnet b/5.x/_gen/resources/sagemaker_app.libsonnet index bcb10fb7..de914682 100644 --- a/5.x/_gen/resources/sagemaker_app.libsonnet +++ b/5.x/_gen/resources/sagemaker_app.libsonnet @@ -50,16 +50,18 @@ local d = (import 'github.com/jsonnet-libs/docsonnet/doc-util/main.libsonnet'); user_profile_name: user_profile_name, }), resource_spec:: { - '#new':: d.fn(help='\n`aws.sagemaker_app.resource_spec.new` constructs a new object with attributes and blocks configured for the `resource_spec`\nTerraform sub block.\n\n\n\n**Args**:\n - `instance_type` (`string`): Set the `instance_type` field on the resulting object. When `null`, the `instance_type` field will be omitted from the resulting object.\n - `lifecycle_config_arn` (`string`): Set the `lifecycle_config_arn` field on the resulting object. When `null`, the `lifecycle_config_arn` field will be omitted from the resulting object.\n - `sagemaker_image_arn` (`string`): Set the `sagemaker_image_arn` field on the resulting object. When `null`, the `sagemaker_image_arn` field will be omitted from the resulting object.\n - `sagemaker_image_version_arn` (`string`): Set the `sagemaker_image_version_arn` field on the resulting object. When `null`, the `sagemaker_image_version_arn` field will be omitted from the resulting object.\n\n**Returns**:\n - An attribute object that represents the `resource_spec` sub block.\n', args=[]), + '#new':: d.fn(help='\n`aws.sagemaker_app.resource_spec.new` constructs a new object with attributes and blocks configured for the `resource_spec`\nTerraform sub block.\n\n\n\n**Args**:\n - `instance_type` (`string`): Set the `instance_type` field on the resulting object. When `null`, the `instance_type` field will be omitted from the resulting object.\n - `lifecycle_config_arn` (`string`): Set the `lifecycle_config_arn` field on the resulting object. When `null`, the `lifecycle_config_arn` field will be omitted from the resulting object.\n - `sagemaker_image_arn` (`string`): Set the `sagemaker_image_arn` field on the resulting object. When `null`, the `sagemaker_image_arn` field will be omitted from the resulting object.\n - `sagemaker_image_version_alias` (`string`): Set the `sagemaker_image_version_alias` field on the resulting object. When `null`, the `sagemaker_image_version_alias` field will be omitted from the resulting object.\n - `sagemaker_image_version_arn` (`string`): Set the `sagemaker_image_version_arn` field on the resulting object. When `null`, the `sagemaker_image_version_arn` field will be omitted from the resulting object.\n\n**Returns**:\n - An attribute object that represents the `resource_spec` sub block.\n', args=[]), new( instance_type=null, lifecycle_config_arn=null, sagemaker_image_arn=null, + sagemaker_image_version_alias=null, sagemaker_image_version_arn=null ):: std.prune(a={ instance_type: instance_type, lifecycle_config_arn: lifecycle_config_arn, sagemaker_image_arn: sagemaker_image_arn, + sagemaker_image_version_alias: sagemaker_image_version_alias, sagemaker_image_version_arn: sagemaker_image_version_arn, }), }, diff --git a/5.x/_gen/resources/sagemaker_app_image_config.libsonnet b/5.x/_gen/resources/sagemaker_app_image_config.libsonnet index a49ad657..d3dfcd17 100644 --- a/5.x/_gen/resources/sagemaker_app_image_config.libsonnet +++ b/5.x/_gen/resources/sagemaker_app_image_config.libsonnet @@ -2,6 +2,26 @@ local tf = (import 'github.com/tf-libsonnet/core/main.libsonnet'); local d = (import 'github.com/jsonnet-libs/docsonnet/doc-util/main.libsonnet'); { '#':: d.pkg(name='sagemaker_app_image_config', url='', help='`sagemaker_app_image_config` represents the `aws_sagemaker_app_image_config` Terraform resource.\n\n\n\nThis package contains functions and utilities for setting up the resource using Jsonnet code.\n'), + jupyter_lab_image_config:: { + container_config:: { + '#new':: d.fn(help='\n`aws.sagemaker_app_image_config.jupyter_lab_image_config.container_config.new` constructs a new object with attributes and blocks configured for the `container_config`\nTerraform sub block.\n\n\n\n**Args**:\n - `container_arguments` (`list`): Set the `container_arguments` field on the resulting object. When `null`, the `container_arguments` field will be omitted from the resulting object.\n - `container_entrypoint` (`list`): Set the `container_entrypoint` field on the resulting object. When `null`, the `container_entrypoint` field will be omitted from the resulting object.\n - `container_environment_variables` (`obj`): Set the `container_environment_variables` field on the resulting object. When `null`, the `container_environment_variables` field will be omitted from the resulting object.\n\n**Returns**:\n - An attribute object that represents the `container_config` sub block.\n', args=[]), + new( + container_arguments=null, + container_entrypoint=null, + container_environment_variables=null + ):: std.prune(a={ + container_arguments: container_arguments, + container_entrypoint: container_entrypoint, + container_environment_variables: container_environment_variables, + }), + }, + '#new':: d.fn(help='\n`aws.sagemaker_app_image_config.jupyter_lab_image_config.new` constructs a new object with attributes and blocks configured for the `jupyter_lab_image_config`\nTerraform sub block.\n\n\n\n**Args**:\n - `container_config` (`list[obj]`): Set the `container_config` field on the resulting object. When `null`, the `container_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_app_image_config.jupyter_lab_image_config.container_config.new](#fn-jupyter_lab_image_configcontainer_confignew) constructor.\n\n**Returns**:\n - An attribute object that represents the `jupyter_lab_image_config` sub block.\n', args=[]), + new( + container_config=null + ):: std.prune(a={ + container_config: container_config, + }), + }, kernel_gateway_image_config:: { file_system_config:: { '#new':: d.fn(help='\n`aws.sagemaker_app_image_config.kernel_gateway_image_config.file_system_config.new` constructs a new object with attributes and blocks configured for the `file_system_config`\nTerraform sub block.\n\n\n\n**Args**:\n - `default_gid` (`number`): Set the `default_gid` field on the resulting object. When `null`, the `default_gid` field will be omitted from the resulting object.\n - `default_uid` (`number`): Set the `default_uid` field on the resulting object. When `null`, the `default_uid` field will be omitted from the resulting object.\n - `mount_path` (`string`): Set the `mount_path` field on the resulting object. When `null`, the `mount_path` field will be omitted from the resulting object.\n\n**Returns**:\n - An attribute object that represents the `file_system_config` sub block.\n', args=[]), @@ -34,10 +54,11 @@ local d = (import 'github.com/jsonnet-libs/docsonnet/doc-util/main.libsonnet'); kernel_spec: kernel_spec, }), }, - '#new':: d.fn(help="\n`aws.sagemaker_app_image_config.new` injects a new `aws_sagemaker_app_image_config` 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_app_image_config.new('some_id')\n\nYou can get the reference to the `id` field of the created `aws.sagemaker_app_image_config` using the reference:\n\n $._ref.aws_sagemaker_app_image_config.some_id.get('id')\n\nThis is the same as directly entering `\"${ aws_sagemaker_app_image_config.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 - `app_image_config_name` (`string`): Set the `app_image_config_name` field on the resulting resource block.\n - `tags` (`obj`): Set the `tags` field on the resulting resource block. When `null`, the `tags` field will be omitted from the resulting object.\n - `tags_all` (`obj`): Set the `tags_all` field on the resulting resource block. When `null`, the `tags_all` field will be omitted from the resulting object.\n - `kernel_gateway_image_config` (`list[obj]`): Set the `kernel_gateway_image_config` field on the resulting resource block. When `null`, the `kernel_gateway_image_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_app_image_config.kernel_gateway_image_config.new](#fn-kernel_gateway_image_confignew) constructor.\n\n**Returns**:\n- A mixin object that injects the new resource into the root Terraform configuration.\n", args=[]), + '#new':: d.fn(help="\n`aws.sagemaker_app_image_config.new` injects a new `aws_sagemaker_app_image_config` 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_app_image_config.new('some_id')\n\nYou can get the reference to the `id` field of the created `aws.sagemaker_app_image_config` using the reference:\n\n $._ref.aws_sagemaker_app_image_config.some_id.get('id')\n\nThis is the same as directly entering `\"${ aws_sagemaker_app_image_config.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 - `app_image_config_name` (`string`): Set the `app_image_config_name` field on the resulting resource block.\n - `tags` (`obj`): Set the `tags` field on the resulting resource block. When `null`, the `tags` field will be omitted from the resulting object.\n - `tags_all` (`obj`): Set the `tags_all` field on the resulting resource block. When `null`, the `tags_all` field will be omitted from the resulting object.\n - `jupyter_lab_image_config` (`list[obj]`): Set the `jupyter_lab_image_config` field on the resulting resource block. When `null`, the `jupyter_lab_image_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_app_image_config.jupyter_lab_image_config.new](#fn-jupyter_lab_image_confignew) constructor.\n - `kernel_gateway_image_config` (`list[obj]`): Set the `kernel_gateway_image_config` field on the resulting resource block. When `null`, the `kernel_gateway_image_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_app_image_config.kernel_gateway_image_config.new](#fn-kernel_gateway_image_confignew) constructor.\n\n**Returns**:\n- A mixin object that injects the new resource into the root Terraform configuration.\n", args=[]), new( resourceLabel, app_image_config_name, + jupyter_lab_image_config=null, kernel_gateway_image_config=null, tags=null, tags_all=null, @@ -47,20 +68,23 @@ local d = (import 'github.com/jsonnet-libs/docsonnet/doc-util/main.libsonnet'); label=resourceLabel, attrs=self.newAttrs( app_image_config_name=app_image_config_name, + jupyter_lab_image_config=jupyter_lab_image_config, kernel_gateway_image_config=kernel_gateway_image_config, tags=tags, tags_all=tags_all ), _meta=_meta ), - '#newAttrs':: d.fn(help='\n`aws.sagemaker_app_image_config.newAttrs` constructs a new object with attributes and blocks configured for the `sagemaker_app_image_config`\nTerraform resource.\n\nUnlike [aws.sagemaker_app_image_config.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 - `app_image_config_name` (`string`): Set the `app_image_config_name` field on the resulting object.\n - `tags` (`obj`): Set the `tags` field on the resulting object. When `null`, the `tags` field will be omitted from the resulting object.\n - `tags_all` (`obj`): Set the `tags_all` field on the resulting object. When `null`, the `tags_all` field will be omitted from the resulting object.\n - `kernel_gateway_image_config` (`list[obj]`): Set the `kernel_gateway_image_config` field on the resulting object. When `null`, the `kernel_gateway_image_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_app_image_config.kernel_gateway_image_config.new](#fn-kernel_gateway_image_confignew) constructor.\n\n**Returns**:\n - An attribute object that can be used with [tf.withResource](https://github.com/tf-libsonnet/core/tree/main/docs#fn-withresource) to construct a new `sagemaker_app_image_config` resource into the root Terraform configuration.\n', args=[]), + '#newAttrs':: d.fn(help='\n`aws.sagemaker_app_image_config.newAttrs` constructs a new object with attributes and blocks configured for the `sagemaker_app_image_config`\nTerraform resource.\n\nUnlike [aws.sagemaker_app_image_config.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 - `app_image_config_name` (`string`): Set the `app_image_config_name` field on the resulting object.\n - `tags` (`obj`): Set the `tags` field on the resulting object. When `null`, the `tags` field will be omitted from the resulting object.\n - `tags_all` (`obj`): Set the `tags_all` field on the resulting object. When `null`, the `tags_all` field will be omitted from the resulting object.\n - `jupyter_lab_image_config` (`list[obj]`): Set the `jupyter_lab_image_config` field on the resulting object. When `null`, the `jupyter_lab_image_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_app_image_config.jupyter_lab_image_config.new](#fn-jupyter_lab_image_confignew) constructor.\n - `kernel_gateway_image_config` (`list[obj]`): Set the `kernel_gateway_image_config` field on the resulting object. When `null`, the `kernel_gateway_image_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_app_image_config.kernel_gateway_image_config.new](#fn-kernel_gateway_image_confignew) constructor.\n\n**Returns**:\n - An attribute object that can be used with [tf.withResource](https://github.com/tf-libsonnet/core/tree/main/docs#fn-withresource) to construct a new `sagemaker_app_image_config` resource into the root Terraform configuration.\n', args=[]), newAttrs( app_image_config_name, + jupyter_lab_image_config=null, kernel_gateway_image_config=null, tags=null, tags_all=null ):: std.prune(a={ app_image_config_name: app_image_config_name, + jupyter_lab_image_config: jupyter_lab_image_config, kernel_gateway_image_config: kernel_gateway_image_config, tags: tags, tags_all: tags_all, @@ -75,6 +99,26 @@ local d = (import 'github.com/jsonnet-libs/docsonnet/doc-util/main.libsonnet'); }, }, }, + '#withJupyterLabImageConfig':: d.fn(help='`aws.list[obj].withJupyterLabImageConfig` constructs a mixin object that can be merged into the `list[obj]`\nTerraform resource block to set or update the jupyter_lab_image_config field.\n\nThis function will replace the array with the passed in `value`. If you wish to instead append the\npassed in value to the existing array, use the [aws.list[obj].withJupyterLabImageConfigMixin](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 `jupyter_lab_image_config` field.\n', args=[]), + withJupyterLabImageConfig(resourceLabel, value): { + resource+: { + aws_sagemaker_app_image_config+: { + [resourceLabel]+: { + jupyter_lab_image_config: value, + }, + }, + }, + }, + '#withJupyterLabImageConfigMixin':: d.fn(help='`aws.list[obj].withJupyterLabImageConfigMixin` constructs a mixin object that can be merged into the `list[obj]`\nTerraform resource block to set or update the jupyter_lab_image_config field.\n\nThis function will append the passed in array or object to the existing array. If you wish\nto instead replace the array with the passed in `value`, use the [aws.list[obj].withJupyterLabImageConfig](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 `jupyter_lab_image_config` field.\n', args=[]), + withJupyterLabImageConfigMixin(resourceLabel, value): { + resource+: { + aws_sagemaker_app_image_config+: { + [resourceLabel]+: { + jupyter_lab_image_config+: if std.isArray(v=value) then value else [value], + }, + }, + }, + }, '#withKernelGatewayImageConfig':: d.fn(help='`aws.list[obj].withKernelGatewayImageConfig` constructs a mixin object that can be merged into the `list[obj]`\nTerraform resource block to set or update the kernel_gateway_image_config field.\n\nThis function will replace the array with the passed in `value`. If you wish to instead append the\npassed in value to the existing array, use the [aws.list[obj].withKernelGatewayImageConfigMixin](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 `kernel_gateway_image_config` field.\n', args=[]), withKernelGatewayImageConfig(resourceLabel, value): { resource+: { diff --git a/5.x/_gen/resources/sagemaker_domain.libsonnet b/5.x/_gen/resources/sagemaker_domain.libsonnet index f089de57..4c8d6582 100644 --- a/5.x/_gen/resources/sagemaker_domain.libsonnet +++ b/5.x/_gen/resources/sagemaker_domain.libsonnet @@ -13,16 +13,18 @@ local d = (import 'github.com/jsonnet-libs/docsonnet/doc-util/main.libsonnet'); }), }, default_resource_spec:: { - '#new':: d.fn(help='\n`aws.sagemaker_domain.default_space_settings.jupyter_server_app_settings.default_resource_spec.new` constructs a new object with attributes and blocks configured for the `default_resource_spec`\nTerraform sub block.\n\n\n\n**Args**:\n - `instance_type` (`string`): Set the `instance_type` field on the resulting object. When `null`, the `instance_type` field will be omitted from the resulting object.\n - `lifecycle_config_arn` (`string`): Set the `lifecycle_config_arn` field on the resulting object. When `null`, the `lifecycle_config_arn` field will be omitted from the resulting object.\n - `sagemaker_image_arn` (`string`): Set the `sagemaker_image_arn` field on the resulting object. When `null`, the `sagemaker_image_arn` field will be omitted from the resulting object.\n - `sagemaker_image_version_arn` (`string`): Set the `sagemaker_image_version_arn` field on the resulting object. When `null`, the `sagemaker_image_version_arn` field will be omitted from the resulting object.\n\n**Returns**:\n - An attribute object that represents the `default_resource_spec` sub block.\n', args=[]), + '#new':: d.fn(help='\n`aws.sagemaker_domain.default_space_settings.jupyter_server_app_settings.default_resource_spec.new` constructs a new object with attributes and blocks configured for the `default_resource_spec`\nTerraform sub block.\n\n\n\n**Args**:\n - `instance_type` (`string`): Set the `instance_type` field on the resulting object. When `null`, the `instance_type` field will be omitted from the resulting object.\n - `lifecycle_config_arn` (`string`): Set the `lifecycle_config_arn` field on the resulting object. When `null`, the `lifecycle_config_arn` field will be omitted from the resulting object.\n - `sagemaker_image_arn` (`string`): Set the `sagemaker_image_arn` field on the resulting object. When `null`, the `sagemaker_image_arn` field will be omitted from the resulting object.\n - `sagemaker_image_version_alias` (`string`): Set the `sagemaker_image_version_alias` field on the resulting object. When `null`, the `sagemaker_image_version_alias` field will be omitted from the resulting object.\n - `sagemaker_image_version_arn` (`string`): Set the `sagemaker_image_version_arn` field on the resulting object. When `null`, the `sagemaker_image_version_arn` field will be omitted from the resulting object.\n\n**Returns**:\n - An attribute object that represents the `default_resource_spec` sub block.\n', args=[]), new( instance_type=null, lifecycle_config_arn=null, sagemaker_image_arn=null, + sagemaker_image_version_alias=null, sagemaker_image_version_arn=null ):: std.prune(a={ instance_type: instance_type, lifecycle_config_arn: lifecycle_config_arn, sagemaker_image_arn: sagemaker_image_arn, + sagemaker_image_version_alias: sagemaker_image_version_alias, sagemaker_image_version_arn: sagemaker_image_version_arn, }), }, @@ -51,16 +53,18 @@ local d = (import 'github.com/jsonnet-libs/docsonnet/doc-util/main.libsonnet'); }), }, default_resource_spec:: { - '#new':: d.fn(help='\n`aws.sagemaker_domain.default_space_settings.kernel_gateway_app_settings.default_resource_spec.new` constructs a new object with attributes and blocks configured for the `default_resource_spec`\nTerraform sub block.\n\n\n\n**Args**:\n - `instance_type` (`string`): Set the `instance_type` field on the resulting object. When `null`, the `instance_type` field will be omitted from the resulting object.\n - `lifecycle_config_arn` (`string`): Set the `lifecycle_config_arn` field on the resulting object. When `null`, the `lifecycle_config_arn` field will be omitted from the resulting object.\n - `sagemaker_image_arn` (`string`): Set the `sagemaker_image_arn` field on the resulting object. When `null`, the `sagemaker_image_arn` field will be omitted from the resulting object.\n - `sagemaker_image_version_arn` (`string`): Set the `sagemaker_image_version_arn` field on the resulting object. When `null`, the `sagemaker_image_version_arn` field will be omitted from the resulting object.\n\n**Returns**:\n - An attribute object that represents the `default_resource_spec` sub block.\n', args=[]), + '#new':: d.fn(help='\n`aws.sagemaker_domain.default_space_settings.kernel_gateway_app_settings.default_resource_spec.new` constructs a new object with attributes and blocks configured for the `default_resource_spec`\nTerraform sub block.\n\n\n\n**Args**:\n - `instance_type` (`string`): Set the `instance_type` field on the resulting object. When `null`, the `instance_type` field will be omitted from the resulting object.\n - `lifecycle_config_arn` (`string`): Set the `lifecycle_config_arn` field on the resulting object. When `null`, the `lifecycle_config_arn` field will be omitted from the resulting object.\n - `sagemaker_image_arn` (`string`): Set the `sagemaker_image_arn` field on the resulting object. When `null`, the `sagemaker_image_arn` field will be omitted from the resulting object.\n - `sagemaker_image_version_alias` (`string`): Set the `sagemaker_image_version_alias` field on the resulting object. When `null`, the `sagemaker_image_version_alias` field will be omitted from the resulting object.\n - `sagemaker_image_version_arn` (`string`): Set the `sagemaker_image_version_arn` field on the resulting object. When `null`, the `sagemaker_image_version_arn` field will be omitted from the resulting object.\n\n**Returns**:\n - An attribute object that represents the `default_resource_spec` sub block.\n', args=[]), new( instance_type=null, lifecycle_config_arn=null, sagemaker_image_arn=null, + sagemaker_image_version_alias=null, sagemaker_image_version_arn=null ):: std.prune(a={ instance_type: instance_type, lifecycle_config_arn: lifecycle_config_arn, sagemaker_image_arn: sagemaker_image_arn, + sagemaker_image_version_alias: sagemaker_image_version_alias, sagemaker_image_version_arn: sagemaker_image_version_arn, }), }, @@ -165,6 +169,110 @@ local d = (import 'github.com/jsonnet-libs/docsonnet/doc-util/main.libsonnet'); }), }, }, + code_editor_app_settings:: { + default_resource_spec:: { + '#new':: d.fn(help='\n`aws.sagemaker_domain.default_user_settings.code_editor_app_settings.default_resource_spec.new` constructs a new object with attributes and blocks configured for the `default_resource_spec`\nTerraform sub block.\n\n\n\n**Args**:\n - `instance_type` (`string`): Set the `instance_type` field on the resulting object. When `null`, the `instance_type` field will be omitted from the resulting object.\n - `lifecycle_config_arn` (`string`): Set the `lifecycle_config_arn` field on the resulting object. When `null`, the `lifecycle_config_arn` field will be omitted from the resulting object.\n - `sagemaker_image_arn` (`string`): Set the `sagemaker_image_arn` field on the resulting object. When `null`, the `sagemaker_image_arn` field will be omitted from the resulting object.\n - `sagemaker_image_version_alias` (`string`): Set the `sagemaker_image_version_alias` field on the resulting object. When `null`, the `sagemaker_image_version_alias` field will be omitted from the resulting object.\n - `sagemaker_image_version_arn` (`string`): Set the `sagemaker_image_version_arn` field on the resulting object. When `null`, the `sagemaker_image_version_arn` field will be omitted from the resulting object.\n\n**Returns**:\n - An attribute object that represents the `default_resource_spec` sub block.\n', args=[]), + new( + instance_type=null, + lifecycle_config_arn=null, + sagemaker_image_arn=null, + sagemaker_image_version_alias=null, + sagemaker_image_version_arn=null + ):: std.prune(a={ + instance_type: instance_type, + lifecycle_config_arn: lifecycle_config_arn, + sagemaker_image_arn: sagemaker_image_arn, + sagemaker_image_version_alias: sagemaker_image_version_alias, + sagemaker_image_version_arn: sagemaker_image_version_arn, + }), + }, + '#new':: d.fn(help='\n`aws.sagemaker_domain.default_user_settings.code_editor_app_settings.new` constructs a new object with attributes and blocks configured for the `code_editor_app_settings`\nTerraform sub block.\n\n\n\n**Args**:\n - `lifecycle_config_arns` (`list`): Set the `lifecycle_config_arns` field on the resulting object. When `null`, the `lifecycle_config_arns` field will be omitted from the resulting object.\n - `default_resource_spec` (`list[obj]`): Set the `default_resource_spec` field on the resulting object. When `null`, the `default_resource_spec` 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.code_editor_app_settings.default_resource_spec.new](#fn-default_user_settingsdefault_user_settingsdefault_resource_specnew) constructor.\n\n**Returns**:\n - An attribute object that represents the `code_editor_app_settings` sub block.\n', args=[]), + new( + default_resource_spec=null, + lifecycle_config_arns=null + ):: std.prune(a={ + default_resource_spec: default_resource_spec, + lifecycle_config_arns: lifecycle_config_arns, + }), + }, + custom_file_system_config:: { + efs_file_system_config:: { + '#new':: d.fn(help='\n`aws.sagemaker_domain.default_user_settings.custom_file_system_config.efs_file_system_config.new` constructs a new object with attributes and blocks configured for the `efs_file_system_config`\nTerraform sub block.\n\n\n\n**Args**:\n - `file_system_id` (`string`): Set the `file_system_id` field on the resulting object.\n - `file_system_path` (`string`): Set the `file_system_path` field on the resulting object.\n\n**Returns**:\n - An attribute object that represents the `efs_file_system_config` sub block.\n', args=[]), + new( + file_system_id, + file_system_path + ):: std.prune(a={ + file_system_id: file_system_id, + file_system_path: file_system_path, + }), + }, + '#new':: d.fn(help='\n`aws.sagemaker_domain.default_user_settings.custom_file_system_config.new` constructs a new object with attributes and blocks configured for the `custom_file_system_config`\nTerraform sub block.\n\n\n\n**Args**:\n - `efs_file_system_config` (`list[obj]`): Set the `efs_file_system_config` field on the resulting object. When `null`, the `efs_file_system_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_domain.default_user_settings.custom_file_system_config.efs_file_system_config.new](#fn-default_user_settingsdefault_user_settingsefs_file_system_confignew) constructor.\n\n**Returns**:\n - An attribute object that represents the `custom_file_system_config` sub block.\n', args=[]), + new( + efs_file_system_config=null + ):: std.prune(a={ + efs_file_system_config: efs_file_system_config, + }), + }, + custom_posix_user_config:: { + '#new':: d.fn(help='\n`aws.sagemaker_domain.default_user_settings.custom_posix_user_config.new` constructs a new object with attributes and blocks configured for the `custom_posix_user_config`\nTerraform sub block.\n\n\n\n**Args**:\n - `gid` (`number`): Set the `gid` field on the resulting object.\n - `uid` (`number`): Set the `uid` field on the resulting object.\n\n**Returns**:\n - An attribute object that represents the `custom_posix_user_config` sub block.\n', args=[]), + new( + gid, + uid + ):: std.prune(a={ + gid: gid, + uid: uid, + }), + }, + jupyter_lab_app_settings:: { + code_repository:: { + '#new':: d.fn(help='\n`aws.sagemaker_domain.default_user_settings.jupyter_lab_app_settings.code_repository.new` constructs a new object with attributes and blocks configured for the `code_repository`\nTerraform sub block.\n\n\n\n**Args**:\n - `repository_url` (`string`): Set the `repository_url` field on the resulting object.\n\n**Returns**:\n - An attribute object that represents the `code_repository` sub block.\n', args=[]), + new( + repository_url + ):: std.prune(a={ + repository_url: repository_url, + }), + }, + custom_image:: { + '#new':: d.fn(help='\n`aws.sagemaker_domain.default_user_settings.jupyter_lab_app_settings.custom_image.new` constructs a new object with attributes and blocks configured for the `custom_image`\nTerraform sub block.\n\n\n\n**Args**:\n - `app_image_config_name` (`string`): Set the `app_image_config_name` field on the resulting object.\n - `image_name` (`string`): Set the `image_name` field on the resulting object.\n - `image_version_number` (`number`): Set the `image_version_number` field on the resulting object. When `null`, the `image_version_number` field will be omitted from the resulting object.\n\n**Returns**:\n - An attribute object that represents the `custom_image` sub block.\n', args=[]), + new( + app_image_config_name, + image_name, + image_version_number=null + ):: std.prune(a={ + app_image_config_name: app_image_config_name, + image_name: image_name, + image_version_number: image_version_number, + }), + }, + default_resource_spec:: { + '#new':: d.fn(help='\n`aws.sagemaker_domain.default_user_settings.jupyter_lab_app_settings.default_resource_spec.new` constructs a new object with attributes and blocks configured for the `default_resource_spec`\nTerraform sub block.\n\n\n\n**Args**:\n - `instance_type` (`string`): Set the `instance_type` field on the resulting object. When `null`, the `instance_type` field will be omitted from the resulting object.\n - `lifecycle_config_arn` (`string`): Set the `lifecycle_config_arn` field on the resulting object. When `null`, the `lifecycle_config_arn` field will be omitted from the resulting object.\n - `sagemaker_image_arn` (`string`): Set the `sagemaker_image_arn` field on the resulting object. When `null`, the `sagemaker_image_arn` field will be omitted from the resulting object.\n - `sagemaker_image_version_alias` (`string`): Set the `sagemaker_image_version_alias` field on the resulting object. When `null`, the `sagemaker_image_version_alias` field will be omitted from the resulting object.\n - `sagemaker_image_version_arn` (`string`): Set the `sagemaker_image_version_arn` field on the resulting object. When `null`, the `sagemaker_image_version_arn` field will be omitted from the resulting object.\n\n**Returns**:\n - An attribute object that represents the `default_resource_spec` sub block.\n', args=[]), + new( + instance_type=null, + lifecycle_config_arn=null, + sagemaker_image_arn=null, + sagemaker_image_version_alias=null, + sagemaker_image_version_arn=null + ):: std.prune(a={ + instance_type: instance_type, + lifecycle_config_arn: lifecycle_config_arn, + sagemaker_image_arn: sagemaker_image_arn, + sagemaker_image_version_alias: sagemaker_image_version_alias, + sagemaker_image_version_arn: sagemaker_image_version_arn, + }), + }, + '#new':: d.fn(help='\n`aws.sagemaker_domain.default_user_settings.jupyter_lab_app_settings.new` constructs a new object with attributes and blocks configured for the `jupyter_lab_app_settings`\nTerraform sub block.\n\n\n\n**Args**:\n - `lifecycle_config_arns` (`list`): Set the `lifecycle_config_arns` field on the resulting object. When `null`, the `lifecycle_config_arns` field will be omitted from the resulting object.\n - `code_repository` (`list[obj]`): Set the `code_repository` field on the resulting object. When `null`, the `code_repository` 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.jupyter_lab_app_settings.code_repository.new](#fn-default_user_settingsdefault_user_settingscode_repositorynew) constructor.\n - `custom_image` (`list[obj]`): Set the `custom_image` field on the resulting object. When `null`, the `custom_image` 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.jupyter_lab_app_settings.custom_image.new](#fn-default_user_settingsdefault_user_settingscustom_imagenew) constructor.\n - `default_resource_spec` (`list[obj]`): Set the `default_resource_spec` field on the resulting object. When `null`, the `default_resource_spec` 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.jupyter_lab_app_settings.default_resource_spec.new](#fn-default_user_settingsdefault_user_settingsdefault_resource_specnew) constructor.\n\n**Returns**:\n - An attribute object that represents the `jupyter_lab_app_settings` sub block.\n', args=[]), + new( + code_repository=null, + custom_image=null, + default_resource_spec=null, + lifecycle_config_arns=null + ):: std.prune(a={ + code_repository: code_repository, + custom_image: custom_image, + default_resource_spec: default_resource_spec, + lifecycle_config_arns: lifecycle_config_arns, + }), + }, jupyter_server_app_settings:: { code_repository:: { '#new':: d.fn(help='\n`aws.sagemaker_domain.default_user_settings.jupyter_server_app_settings.code_repository.new` constructs a new object with attributes and blocks configured for the `code_repository`\nTerraform sub block.\n\n\n\n**Args**:\n - `repository_url` (`string`): Set the `repository_url` field on the resulting object.\n\n**Returns**:\n - An attribute object that represents the `code_repository` sub block.\n', args=[]), @@ -175,16 +283,18 @@ local d = (import 'github.com/jsonnet-libs/docsonnet/doc-util/main.libsonnet'); }), }, default_resource_spec:: { - '#new':: d.fn(help='\n`aws.sagemaker_domain.default_user_settings.jupyter_server_app_settings.default_resource_spec.new` constructs a new object with attributes and blocks configured for the `default_resource_spec`\nTerraform sub block.\n\n\n\n**Args**:\n - `instance_type` (`string`): Set the `instance_type` field on the resulting object. When `null`, the `instance_type` field will be omitted from the resulting object.\n - `lifecycle_config_arn` (`string`): Set the `lifecycle_config_arn` field on the resulting object. When `null`, the `lifecycle_config_arn` field will be omitted from the resulting object.\n - `sagemaker_image_arn` (`string`): Set the `sagemaker_image_arn` field on the resulting object. When `null`, the `sagemaker_image_arn` field will be omitted from the resulting object.\n - `sagemaker_image_version_arn` (`string`): Set the `sagemaker_image_version_arn` field on the resulting object. When `null`, the `sagemaker_image_version_arn` field will be omitted from the resulting object.\n\n**Returns**:\n - An attribute object that represents the `default_resource_spec` sub block.\n', args=[]), + '#new':: d.fn(help='\n`aws.sagemaker_domain.default_user_settings.jupyter_server_app_settings.default_resource_spec.new` constructs a new object with attributes and blocks configured for the `default_resource_spec`\nTerraform sub block.\n\n\n\n**Args**:\n - `instance_type` (`string`): Set the `instance_type` field on the resulting object. When `null`, the `instance_type` field will be omitted from the resulting object.\n - `lifecycle_config_arn` (`string`): Set the `lifecycle_config_arn` field on the resulting object. When `null`, the `lifecycle_config_arn` field will be omitted from the resulting object.\n - `sagemaker_image_arn` (`string`): Set the `sagemaker_image_arn` field on the resulting object. When `null`, the `sagemaker_image_arn` field will be omitted from the resulting object.\n - `sagemaker_image_version_alias` (`string`): Set the `sagemaker_image_version_alias` field on the resulting object. When `null`, the `sagemaker_image_version_alias` field will be omitted from the resulting object.\n - `sagemaker_image_version_arn` (`string`): Set the `sagemaker_image_version_arn` field on the resulting object. When `null`, the `sagemaker_image_version_arn` field will be omitted from the resulting object.\n\n**Returns**:\n - An attribute object that represents the `default_resource_spec` sub block.\n', args=[]), new( instance_type=null, lifecycle_config_arn=null, sagemaker_image_arn=null, + sagemaker_image_version_alias=null, sagemaker_image_version_arn=null ):: std.prune(a={ instance_type: instance_type, lifecycle_config_arn: lifecycle_config_arn, sagemaker_image_arn: sagemaker_image_arn, + sagemaker_image_version_alias: sagemaker_image_version_alias, sagemaker_image_version_arn: sagemaker_image_version_arn, }), }, @@ -213,16 +323,18 @@ local d = (import 'github.com/jsonnet-libs/docsonnet/doc-util/main.libsonnet'); }), }, default_resource_spec:: { - '#new':: d.fn(help='\n`aws.sagemaker_domain.default_user_settings.kernel_gateway_app_settings.default_resource_spec.new` constructs a new object with attributes and blocks configured for the `default_resource_spec`\nTerraform sub block.\n\n\n\n**Args**:\n - `instance_type` (`string`): Set the `instance_type` field on the resulting object. When `null`, the `instance_type` field will be omitted from the resulting object.\n - `lifecycle_config_arn` (`string`): Set the `lifecycle_config_arn` field on the resulting object. When `null`, the `lifecycle_config_arn` field will be omitted from the resulting object.\n - `sagemaker_image_arn` (`string`): Set the `sagemaker_image_arn` field on the resulting object. When `null`, the `sagemaker_image_arn` field will be omitted from the resulting object.\n - `sagemaker_image_version_arn` (`string`): Set the `sagemaker_image_version_arn` field on the resulting object. When `null`, the `sagemaker_image_version_arn` field will be omitted from the resulting object.\n\n**Returns**:\n - An attribute object that represents the `default_resource_spec` sub block.\n', args=[]), + '#new':: d.fn(help='\n`aws.sagemaker_domain.default_user_settings.kernel_gateway_app_settings.default_resource_spec.new` constructs a new object with attributes and blocks configured for the `default_resource_spec`\nTerraform sub block.\n\n\n\n**Args**:\n - `instance_type` (`string`): Set the `instance_type` field on the resulting object. When `null`, the `instance_type` field will be omitted from the resulting object.\n - `lifecycle_config_arn` (`string`): Set the `lifecycle_config_arn` field on the resulting object. When `null`, the `lifecycle_config_arn` field will be omitted from the resulting object.\n - `sagemaker_image_arn` (`string`): Set the `sagemaker_image_arn` field on the resulting object. When `null`, the `sagemaker_image_arn` field will be omitted from the resulting object.\n - `sagemaker_image_version_alias` (`string`): Set the `sagemaker_image_version_alias` field on the resulting object. When `null`, the `sagemaker_image_version_alias` field will be omitted from the resulting object.\n - `sagemaker_image_version_arn` (`string`): Set the `sagemaker_image_version_arn` field on the resulting object. When `null`, the `sagemaker_image_version_arn` field will be omitted from the resulting object.\n\n**Returns**:\n - An attribute object that represents the `default_resource_spec` sub block.\n', args=[]), new( instance_type=null, lifecycle_config_arn=null, sagemaker_image_arn=null, + sagemaker_image_version_alias=null, sagemaker_image_version_arn=null ):: std.prune(a={ instance_type: instance_type, lifecycle_config_arn: lifecycle_config_arn, sagemaker_image_arn: sagemaker_image_arn, + sagemaker_image_version_alias: sagemaker_image_version_alias, sagemaker_image_version_arn: sagemaker_image_version_arn, }), }, @@ -237,26 +349,40 @@ local d = (import 'github.com/jsonnet-libs/docsonnet/doc-util/main.libsonnet'); lifecycle_config_arns: lifecycle_config_arns, }), }, - '#new':: d.fn(help='\n`aws.sagemaker_domain.default_user_settings.new` constructs a new object with attributes and blocks configured for the `default_user_settings`\nTerraform sub block.\n\n\n\n**Args**:\n - `execution_role` (`string`): Set the `execution_role` field on the resulting object.\n - `security_groups` (`list`): Set the `security_groups` field on the resulting object. When `null`, the `security_groups` field will be omitted from the resulting object.\n - `canvas_app_settings` (`list[obj]`): Set the `canvas_app_settings` field on the resulting object. When `null`, the `canvas_app_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.new](#fn-default_user_settingscanvas_app_settingsnew) constructor.\n - `jupyter_server_app_settings` (`list[obj]`): Set the `jupyter_server_app_settings` field on the resulting object. When `null`, the `jupyter_server_app_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.jupyter_server_app_settings.new](#fn-default_user_settingsjupyter_server_app_settingsnew) constructor.\n - `kernel_gateway_app_settings` (`list[obj]`): Set the `kernel_gateway_app_settings` field on the resulting object. When `null`, the `kernel_gateway_app_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.kernel_gateway_app_settings.new](#fn-default_user_settingskernel_gateway_app_settingsnew) constructor.\n - `r_session_app_settings` (`list[obj]`): Set the `r_session_app_settings` field on the resulting object. When `null`, the `r_session_app_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.r_session_app_settings.new](#fn-default_user_settingsr_session_app_settingsnew) constructor.\n - `r_studio_server_pro_app_settings` (`list[obj]`): Set the `r_studio_server_pro_app_settings` field on the resulting object. When `null`, the `r_studio_server_pro_app_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.r_studio_server_pro_app_settings.new](#fn-default_user_settingsr_studio_server_pro_app_settingsnew) constructor.\n - `sharing_settings` (`list[obj]`): Set the `sharing_settings` field on the resulting object. When `null`, the `sharing_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.sharing_settings.new](#fn-default_user_settingssharing_settingsnew) constructor.\n - `tensor_board_app_settings` (`list[obj]`): Set the `tensor_board_app_settings` field on the resulting object. When `null`, the `tensor_board_app_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.tensor_board_app_settings.new](#fn-default_user_settingstensor_board_app_settingsnew) constructor.\n\n**Returns**:\n - An attribute object that represents the `default_user_settings` sub block.\n', args=[]), + '#new':: d.fn(help='\n`aws.sagemaker_domain.default_user_settings.new` constructs a new object with attributes and blocks configured for the `default_user_settings`\nTerraform sub block.\n\n\n\n**Args**:\n - `default_landing_uri` (`string`): Set the `default_landing_uri` field on the resulting object. When `null`, the `default_landing_uri` field will be omitted from the resulting object.\n - `execution_role` (`string`): Set the `execution_role` field on the resulting object.\n - `security_groups` (`list`): Set the `security_groups` field on the resulting object. When `null`, the `security_groups` field will be omitted from the resulting object.\n - `studio_web_portal` (`string`): Set the `studio_web_portal` field on the resulting object. When `null`, the `studio_web_portal` field will be omitted from the resulting object.\n - `canvas_app_settings` (`list[obj]`): Set the `canvas_app_settings` field on the resulting object. When `null`, the `canvas_app_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.new](#fn-default_user_settingscanvas_app_settingsnew) constructor.\n - `code_editor_app_settings` (`list[obj]`): Set the `code_editor_app_settings` field on the resulting object. When `null`, the `code_editor_app_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.code_editor_app_settings.new](#fn-default_user_settingscode_editor_app_settingsnew) constructor.\n - `custom_file_system_config` (`list[obj]`): Set the `custom_file_system_config` field on the resulting object. When `null`, the `custom_file_system_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_domain.default_user_settings.custom_file_system_config.new](#fn-default_user_settingscustom_file_system_confignew) constructor.\n - `custom_posix_user_config` (`list[obj]`): Set the `custom_posix_user_config` field on the resulting object. When `null`, the `custom_posix_user_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_domain.default_user_settings.custom_posix_user_config.new](#fn-default_user_settingscustom_posix_user_confignew) constructor.\n - `jupyter_lab_app_settings` (`list[obj]`): Set the `jupyter_lab_app_settings` field on the resulting object. When `null`, the `jupyter_lab_app_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.jupyter_lab_app_settings.new](#fn-default_user_settingsjupyter_lab_app_settingsnew) constructor.\n - `jupyter_server_app_settings` (`list[obj]`): Set the `jupyter_server_app_settings` field on the resulting object. When `null`, the `jupyter_server_app_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.jupyter_server_app_settings.new](#fn-default_user_settingsjupyter_server_app_settingsnew) constructor.\n - `kernel_gateway_app_settings` (`list[obj]`): Set the `kernel_gateway_app_settings` field on the resulting object. When `null`, the `kernel_gateway_app_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.kernel_gateway_app_settings.new](#fn-default_user_settingskernel_gateway_app_settingsnew) constructor.\n - `r_session_app_settings` (`list[obj]`): Set the `r_session_app_settings` field on the resulting object. When `null`, the `r_session_app_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.r_session_app_settings.new](#fn-default_user_settingsr_session_app_settingsnew) constructor.\n - `r_studio_server_pro_app_settings` (`list[obj]`): Set the `r_studio_server_pro_app_settings` field on the resulting object. When `null`, the `r_studio_server_pro_app_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.r_studio_server_pro_app_settings.new](#fn-default_user_settingsr_studio_server_pro_app_settingsnew) constructor.\n - `sharing_settings` (`list[obj]`): Set the `sharing_settings` field on the resulting object. When `null`, the `sharing_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.sharing_settings.new](#fn-default_user_settingssharing_settingsnew) constructor.\n - `space_storage_settings` (`list[obj]`): Set the `space_storage_settings` field on the resulting object. When `null`, the `space_storage_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.space_storage_settings.new](#fn-default_user_settingsspace_storage_settingsnew) constructor.\n - `tensor_board_app_settings` (`list[obj]`): Set the `tensor_board_app_settings` field on the resulting object. When `null`, the `tensor_board_app_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.tensor_board_app_settings.new](#fn-default_user_settingstensor_board_app_settingsnew) constructor.\n\n**Returns**:\n - An attribute object that represents the `default_user_settings` sub block.\n', args=[]), new( execution_role, canvas_app_settings=null, + code_editor_app_settings=null, + custom_file_system_config=null, + custom_posix_user_config=null, + default_landing_uri=null, + jupyter_lab_app_settings=null, jupyter_server_app_settings=null, kernel_gateway_app_settings=null, r_session_app_settings=null, r_studio_server_pro_app_settings=null, security_groups=null, sharing_settings=null, + space_storage_settings=null, + studio_web_portal=null, tensor_board_app_settings=null ):: std.prune(a={ canvas_app_settings: canvas_app_settings, + code_editor_app_settings: code_editor_app_settings, + custom_file_system_config: custom_file_system_config, + custom_posix_user_config: custom_posix_user_config, + default_landing_uri: default_landing_uri, execution_role: execution_role, + jupyter_lab_app_settings: jupyter_lab_app_settings, jupyter_server_app_settings: jupyter_server_app_settings, kernel_gateway_app_settings: kernel_gateway_app_settings, r_session_app_settings: r_session_app_settings, r_studio_server_pro_app_settings: r_studio_server_pro_app_settings, security_groups: security_groups, sharing_settings: sharing_settings, + space_storage_settings: space_storage_settings, + studio_web_portal: studio_web_portal, tensor_board_app_settings: tensor_board_app_settings, }), r_session_app_settings:: { @@ -273,16 +399,18 @@ local d = (import 'github.com/jsonnet-libs/docsonnet/doc-util/main.libsonnet'); }), }, default_resource_spec:: { - '#new':: d.fn(help='\n`aws.sagemaker_domain.default_user_settings.r_session_app_settings.default_resource_spec.new` constructs a new object with attributes and blocks configured for the `default_resource_spec`\nTerraform sub block.\n\n\n\n**Args**:\n - `instance_type` (`string`): Set the `instance_type` field on the resulting object. When `null`, the `instance_type` field will be omitted from the resulting object.\n - `lifecycle_config_arn` (`string`): Set the `lifecycle_config_arn` field on the resulting object. When `null`, the `lifecycle_config_arn` field will be omitted from the resulting object.\n - `sagemaker_image_arn` (`string`): Set the `sagemaker_image_arn` field on the resulting object. When `null`, the `sagemaker_image_arn` field will be omitted from the resulting object.\n - `sagemaker_image_version_arn` (`string`): Set the `sagemaker_image_version_arn` field on the resulting object. When `null`, the `sagemaker_image_version_arn` field will be omitted from the resulting object.\n\n**Returns**:\n - An attribute object that represents the `default_resource_spec` sub block.\n', args=[]), + '#new':: d.fn(help='\n`aws.sagemaker_domain.default_user_settings.r_session_app_settings.default_resource_spec.new` constructs a new object with attributes and blocks configured for the `default_resource_spec`\nTerraform sub block.\n\n\n\n**Args**:\n - `instance_type` (`string`): Set the `instance_type` field on the resulting object. When `null`, the `instance_type` field will be omitted from the resulting object.\n - `lifecycle_config_arn` (`string`): Set the `lifecycle_config_arn` field on the resulting object. When `null`, the `lifecycle_config_arn` field will be omitted from the resulting object.\n - `sagemaker_image_arn` (`string`): Set the `sagemaker_image_arn` field on the resulting object. When `null`, the `sagemaker_image_arn` field will be omitted from the resulting object.\n - `sagemaker_image_version_alias` (`string`): Set the `sagemaker_image_version_alias` field on the resulting object. When `null`, the `sagemaker_image_version_alias` field will be omitted from the resulting object.\n - `sagemaker_image_version_arn` (`string`): Set the `sagemaker_image_version_arn` field on the resulting object. When `null`, the `sagemaker_image_version_arn` field will be omitted from the resulting object.\n\n**Returns**:\n - An attribute object that represents the `default_resource_spec` sub block.\n', args=[]), new( instance_type=null, lifecycle_config_arn=null, sagemaker_image_arn=null, + sagemaker_image_version_alias=null, sagemaker_image_version_arn=null ):: std.prune(a={ instance_type: instance_type, lifecycle_config_arn: lifecycle_config_arn, sagemaker_image_arn: sagemaker_image_arn, + sagemaker_image_version_alias: sagemaker_image_version_alias, sagemaker_image_version_arn: sagemaker_image_version_arn, }), }, @@ -317,18 +445,38 @@ local d = (import 'github.com/jsonnet-libs/docsonnet/doc-util/main.libsonnet'); s3_output_path: s3_output_path, }), }, + space_storage_settings:: { + default_ebs_storage_settings:: { + '#new':: d.fn(help='\n`aws.sagemaker_domain.default_user_settings.space_storage_settings.default_ebs_storage_settings.new` constructs a new object with attributes and blocks configured for the `default_ebs_storage_settings`\nTerraform sub block.\n\n\n\n**Args**:\n - `default_ebs_volume_size_in_gb` (`number`): Set the `default_ebs_volume_size_in_gb` field on the resulting object.\n - `maximum_ebs_volume_size_in_gb` (`number`): Set the `maximum_ebs_volume_size_in_gb` field on the resulting object.\n\n**Returns**:\n - An attribute object that represents the `default_ebs_storage_settings` sub block.\n', args=[]), + new( + default_ebs_volume_size_in_gb, + maximum_ebs_volume_size_in_gb + ):: std.prune(a={ + default_ebs_volume_size_in_gb: default_ebs_volume_size_in_gb, + maximum_ebs_volume_size_in_gb: maximum_ebs_volume_size_in_gb, + }), + }, + '#new':: d.fn(help='\n`aws.sagemaker_domain.default_user_settings.space_storage_settings.new` constructs a new object with attributes and blocks configured for the `space_storage_settings`\nTerraform sub block.\n\n\n\n**Args**:\n - `default_ebs_storage_settings` (`list[obj]`): Set the `default_ebs_storage_settings` field on the resulting object. When `null`, the `default_ebs_storage_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.space_storage_settings.default_ebs_storage_settings.new](#fn-default_user_settingsdefault_user_settingsdefault_ebs_storage_settingsnew) constructor.\n\n**Returns**:\n - An attribute object that represents the `space_storage_settings` sub block.\n', args=[]), + new( + default_ebs_storage_settings=null + ):: std.prune(a={ + default_ebs_storage_settings: default_ebs_storage_settings, + }), + }, tensor_board_app_settings:: { default_resource_spec:: { - '#new':: d.fn(help='\n`aws.sagemaker_domain.default_user_settings.tensor_board_app_settings.default_resource_spec.new` constructs a new object with attributes and blocks configured for the `default_resource_spec`\nTerraform sub block.\n\n\n\n**Args**:\n - `instance_type` (`string`): Set the `instance_type` field on the resulting object. When `null`, the `instance_type` field will be omitted from the resulting object.\n - `lifecycle_config_arn` (`string`): Set the `lifecycle_config_arn` field on the resulting object. When `null`, the `lifecycle_config_arn` field will be omitted from the resulting object.\n - `sagemaker_image_arn` (`string`): Set the `sagemaker_image_arn` field on the resulting object. When `null`, the `sagemaker_image_arn` field will be omitted from the resulting object.\n - `sagemaker_image_version_arn` (`string`): Set the `sagemaker_image_version_arn` field on the resulting object. When `null`, the `sagemaker_image_version_arn` field will be omitted from the resulting object.\n\n**Returns**:\n - An attribute object that represents the `default_resource_spec` sub block.\n', args=[]), + '#new':: d.fn(help='\n`aws.sagemaker_domain.default_user_settings.tensor_board_app_settings.default_resource_spec.new` constructs a new object with attributes and blocks configured for the `default_resource_spec`\nTerraform sub block.\n\n\n\n**Args**:\n - `instance_type` (`string`): Set the `instance_type` field on the resulting object. When `null`, the `instance_type` field will be omitted from the resulting object.\n - `lifecycle_config_arn` (`string`): Set the `lifecycle_config_arn` field on the resulting object. When `null`, the `lifecycle_config_arn` field will be omitted from the resulting object.\n - `sagemaker_image_arn` (`string`): Set the `sagemaker_image_arn` field on the resulting object. When `null`, the `sagemaker_image_arn` field will be omitted from the resulting object.\n - `sagemaker_image_version_alias` (`string`): Set the `sagemaker_image_version_alias` field on the resulting object. When `null`, the `sagemaker_image_version_alias` field will be omitted from the resulting object.\n - `sagemaker_image_version_arn` (`string`): Set the `sagemaker_image_version_arn` field on the resulting object. When `null`, the `sagemaker_image_version_arn` field will be omitted from the resulting object.\n\n**Returns**:\n - An attribute object that represents the `default_resource_spec` sub block.\n', args=[]), new( instance_type=null, lifecycle_config_arn=null, sagemaker_image_arn=null, + sagemaker_image_version_alias=null, sagemaker_image_version_arn=null ):: std.prune(a={ instance_type: instance_type, lifecycle_config_arn: lifecycle_config_arn, sagemaker_image_arn: sagemaker_image_arn, + sagemaker_image_version_alias: sagemaker_image_version_alias, sagemaker_image_version_arn: sagemaker_image_version_arn, }), }, @@ -353,16 +501,18 @@ local d = (import 'github.com/jsonnet-libs/docsonnet/doc-util/main.libsonnet'); }), r_studio_server_pro_domain_settings:: { default_resource_spec:: { - '#new':: d.fn(help='\n`aws.sagemaker_domain.domain_settings.r_studio_server_pro_domain_settings.default_resource_spec.new` constructs a new object with attributes and blocks configured for the `default_resource_spec`\nTerraform sub block.\n\n\n\n**Args**:\n - `instance_type` (`string`): Set the `instance_type` field on the resulting object. When `null`, the `instance_type` field will be omitted from the resulting object.\n - `lifecycle_config_arn` (`string`): Set the `lifecycle_config_arn` field on the resulting object. When `null`, the `lifecycle_config_arn` field will be omitted from the resulting object.\n - `sagemaker_image_arn` (`string`): Set the `sagemaker_image_arn` field on the resulting object. When `null`, the `sagemaker_image_arn` field will be omitted from the resulting object.\n - `sagemaker_image_version_arn` (`string`): Set the `sagemaker_image_version_arn` field on the resulting object. When `null`, the `sagemaker_image_version_arn` field will be omitted from the resulting object.\n\n**Returns**:\n - An attribute object that represents the `default_resource_spec` sub block.\n', args=[]), + '#new':: d.fn(help='\n`aws.sagemaker_domain.domain_settings.r_studio_server_pro_domain_settings.default_resource_spec.new` constructs a new object with attributes and blocks configured for the `default_resource_spec`\nTerraform sub block.\n\n\n\n**Args**:\n - `instance_type` (`string`): Set the `instance_type` field on the resulting object. When `null`, the `instance_type` field will be omitted from the resulting object.\n - `lifecycle_config_arn` (`string`): Set the `lifecycle_config_arn` field on the resulting object. When `null`, the `lifecycle_config_arn` field will be omitted from the resulting object.\n - `sagemaker_image_arn` (`string`): Set the `sagemaker_image_arn` field on the resulting object. When `null`, the `sagemaker_image_arn` field will be omitted from the resulting object.\n - `sagemaker_image_version_alias` (`string`): Set the `sagemaker_image_version_alias` field on the resulting object. When `null`, the `sagemaker_image_version_alias` field will be omitted from the resulting object.\n - `sagemaker_image_version_arn` (`string`): Set the `sagemaker_image_version_arn` field on the resulting object. When `null`, the `sagemaker_image_version_arn` field will be omitted from the resulting object.\n\n**Returns**:\n - An attribute object that represents the `default_resource_spec` sub block.\n', args=[]), new( instance_type=null, lifecycle_config_arn=null, sagemaker_image_arn=null, + sagemaker_image_version_alias=null, sagemaker_image_version_arn=null ):: std.prune(a={ instance_type: instance_type, lifecycle_config_arn: lifecycle_config_arn, sagemaker_image_arn: sagemaker_image_arn, + sagemaker_image_version_alias: sagemaker_image_version_alias, sagemaker_image_version_arn: sagemaker_image_version_arn, }), }, diff --git a/5.x/_gen/resources/sagemaker_space.libsonnet b/5.x/_gen/resources/sagemaker_space.libsonnet index cc50df99..9737c432 100644 --- a/5.x/_gen/resources/sagemaker_space.libsonnet +++ b/5.x/_gen/resources/sagemaker_space.libsonnet @@ -2,11 +2,12 @@ local tf = (import 'github.com/tf-libsonnet/core/main.libsonnet'); local d = (import 'github.com/jsonnet-libs/docsonnet/doc-util/main.libsonnet'); { '#':: d.pkg(name='sagemaker_space', url='', help='`sagemaker_space` represents the `aws_sagemaker_space` 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_space.new` injects a new `aws_sagemaker_space` 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_space.new('some_id')\n\nYou can get the reference to the `id` field of the created `aws.sagemaker_space` using the reference:\n\n $._ref.aws_sagemaker_space.some_id.get('id')\n\nThis is the same as directly entering `\"${ aws_sagemaker_space.some_id.id }\"` as the value.\n\nNOTE: if you are chaining multiple resources together in a merge operation, you may not be able to use `super`, `self`,\nor `$` to refer to the root object. Instead, make an explicit outer object using `local`.\n\n**Args**:\n - `resourceLabel` (`string`): The name label of the block.\n - `domain_id` (`string`): Set the `domain_id` field on the resulting resource block.\n - `space_name` (`string`): Set the `space_name` field on the resulting resource block.\n - `tags` (`obj`): Set the `tags` field on the resulting resource block. When `null`, the `tags` field will be omitted from the resulting object.\n - `tags_all` (`obj`): Set the `tags_all` field on the resulting resource block. When `null`, the `tags_all` field will be omitted from the resulting object.\n - `space_settings` (`list[obj]`): Set the `space_settings` field on the resulting resource block. When `null`, the `space_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_space.space_settings.new](#fn-space_settingsnew) 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.sagemaker_space.new` injects a new `aws_sagemaker_space` 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_space.new('some_id')\n\nYou can get the reference to the `id` field of the created `aws.sagemaker_space` using the reference:\n\n $._ref.aws_sagemaker_space.some_id.get('id')\n\nThis is the same as directly entering `\"${ aws_sagemaker_space.some_id.id }\"` as the value.\n\nNOTE: if you are chaining multiple resources together in a merge operation, you may not be able to use `super`, `self`,\nor `$` to refer to the root object. Instead, make an explicit outer object using `local`.\n\n**Args**:\n - `resourceLabel` (`string`): The name label of the block.\n - `domain_id` (`string`): Set the `domain_id` field on the resulting resource block.\n - `space_display_name` (`string`): Set the `space_display_name` field on the resulting resource block. When `null`, the `space_display_name` field will be omitted from the resulting object.\n - `space_name` (`string`): Set the `space_name` field on the resulting resource block.\n - `tags` (`obj`): Set the `tags` field on the resulting resource block. When `null`, the `tags` field will be omitted from the resulting object.\n - `tags_all` (`obj`): Set the `tags_all` field on the resulting resource block. When `null`, the `tags_all` field will be omitted from the resulting object.\n - `space_settings` (`list[obj]`): Set the `space_settings` field on the resulting resource block. When `null`, the `space_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_space.space_settings.new](#fn-space_settingsnew) constructor.\n\n**Returns**:\n- A mixin object that injects the new resource into the root Terraform configuration.\n", args=[]), new( resourceLabel, domain_id, space_name, + space_display_name=null, space_settings=null, tags=null, tags_all=null, @@ -16,6 +17,7 @@ local d = (import 'github.com/jsonnet-libs/docsonnet/doc-util/main.libsonnet'); label=resourceLabel, attrs=self.newAttrs( domain_id=domain_id, + space_display_name=space_display_name, space_name=space_name, space_settings=space_settings, tags=tags, @@ -23,15 +25,17 @@ local d = (import 'github.com/jsonnet-libs/docsonnet/doc-util/main.libsonnet'); ), _meta=_meta ), - '#newAttrs':: d.fn(help='\n`aws.sagemaker_space.newAttrs` constructs a new object with attributes and blocks configured for the `sagemaker_space`\nTerraform resource.\n\nUnlike [aws.sagemaker_space.new](#fn-new), this function will not inject the `resource`\nblock into the root Terraform document. Instead, this must be passed in as the `attrs` argument for the\n[tf.withResource](https://github.com/tf-libsonnet/core/tree/main/docs#fn-withresource) function to build a complete block.\n\nThis is most useful when you need to preprocess the attributes with functions, conditional, or looping logic prior to\ninjecting into a complete block.\n\n**Args**:\n - `domain_id` (`string`): Set the `domain_id` field on the resulting object.\n - `space_name` (`string`): Set the `space_name` field on the resulting object.\n - `tags` (`obj`): Set the `tags` field on the resulting object. When `null`, the `tags` field will be omitted from the resulting object.\n - `tags_all` (`obj`): Set the `tags_all` field on the resulting object. When `null`, the `tags_all` field will be omitted from the resulting object.\n - `space_settings` (`list[obj]`): Set the `space_settings` field on the resulting object. When `null`, the `space_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_space.space_settings.new](#fn-space_settingsnew) 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_space` resource into the root Terraform configuration.\n', args=[]), + '#newAttrs':: d.fn(help='\n`aws.sagemaker_space.newAttrs` constructs a new object with attributes and blocks configured for the `sagemaker_space`\nTerraform resource.\n\nUnlike [aws.sagemaker_space.new](#fn-new), this function will not inject the `resource`\nblock into the root Terraform document. Instead, this must be passed in as the `attrs` argument for the\n[tf.withResource](https://github.com/tf-libsonnet/core/tree/main/docs#fn-withresource) function to build a complete block.\n\nThis is most useful when you need to preprocess the attributes with functions, conditional, or looping logic prior to\ninjecting into a complete block.\n\n**Args**:\n - `domain_id` (`string`): Set the `domain_id` field on the resulting object.\n - `space_display_name` (`string`): Set the `space_display_name` field on the resulting object. When `null`, the `space_display_name` field will be omitted from the resulting object.\n - `space_name` (`string`): Set the `space_name` field on the resulting object.\n - `tags` (`obj`): Set the `tags` field on the resulting object. When `null`, the `tags` field will be omitted from the resulting object.\n - `tags_all` (`obj`): Set the `tags_all` field on the resulting object. When `null`, the `tags_all` field will be omitted from the resulting object.\n - `space_settings` (`list[obj]`): Set the `space_settings` field on the resulting object. When `null`, the `space_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_space.space_settings.new](#fn-space_settingsnew) 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_space` resource into the root Terraform configuration.\n', args=[]), newAttrs( domain_id, space_name, + space_display_name=null, space_settings=null, tags=null, tags_all=null ):: std.prune(a={ domain_id: domain_id, + space_display_name: space_display_name, space_name: space_name, space_settings: space_settings, tags: tags, @@ -48,16 +52,18 @@ local d = (import 'github.com/jsonnet-libs/docsonnet/doc-util/main.libsonnet'); }), }, default_resource_spec:: { - '#new':: d.fn(help='\n`aws.sagemaker_space.space_settings.jupyter_server_app_settings.default_resource_spec.new` constructs a new object with attributes and blocks configured for the `default_resource_spec`\nTerraform sub block.\n\n\n\n**Args**:\n - `instance_type` (`string`): Set the `instance_type` field on the resulting object. When `null`, the `instance_type` field will be omitted from the resulting object.\n - `lifecycle_config_arn` (`string`): Set the `lifecycle_config_arn` field on the resulting object. When `null`, the `lifecycle_config_arn` field will be omitted from the resulting object.\n - `sagemaker_image_arn` (`string`): Set the `sagemaker_image_arn` field on the resulting object. When `null`, the `sagemaker_image_arn` field will be omitted from the resulting object.\n - `sagemaker_image_version_arn` (`string`): Set the `sagemaker_image_version_arn` field on the resulting object. When `null`, the `sagemaker_image_version_arn` field will be omitted from the resulting object.\n\n**Returns**:\n - An attribute object that represents the `default_resource_spec` sub block.\n', args=[]), + '#new':: d.fn(help='\n`aws.sagemaker_space.space_settings.jupyter_server_app_settings.default_resource_spec.new` constructs a new object with attributes and blocks configured for the `default_resource_spec`\nTerraform sub block.\n\n\n\n**Args**:\n - `instance_type` (`string`): Set the `instance_type` field on the resulting object. When `null`, the `instance_type` field will be omitted from the resulting object.\n - `lifecycle_config_arn` (`string`): Set the `lifecycle_config_arn` field on the resulting object. When `null`, the `lifecycle_config_arn` field will be omitted from the resulting object.\n - `sagemaker_image_arn` (`string`): Set the `sagemaker_image_arn` field on the resulting object. When `null`, the `sagemaker_image_arn` field will be omitted from the resulting object.\n - `sagemaker_image_version_alias` (`string`): Set the `sagemaker_image_version_alias` field on the resulting object. When `null`, the `sagemaker_image_version_alias` field will be omitted from the resulting object.\n - `sagemaker_image_version_arn` (`string`): Set the `sagemaker_image_version_arn` field on the resulting object. When `null`, the `sagemaker_image_version_arn` field will be omitted from the resulting object.\n\n**Returns**:\n - An attribute object that represents the `default_resource_spec` sub block.\n', args=[]), new( instance_type=null, lifecycle_config_arn=null, sagemaker_image_arn=null, + sagemaker_image_version_alias=null, sagemaker_image_version_arn=null ):: std.prune(a={ instance_type: instance_type, lifecycle_config_arn: lifecycle_config_arn, sagemaker_image_arn: sagemaker_image_arn, + sagemaker_image_version_alias: sagemaker_image_version_alias, sagemaker_image_version_arn: sagemaker_image_version_arn, }), }, @@ -86,16 +92,18 @@ local d = (import 'github.com/jsonnet-libs/docsonnet/doc-util/main.libsonnet'); }), }, default_resource_spec:: { - '#new':: d.fn(help='\n`aws.sagemaker_space.space_settings.kernel_gateway_app_settings.default_resource_spec.new` constructs a new object with attributes and blocks configured for the `default_resource_spec`\nTerraform sub block.\n\n\n\n**Args**:\n - `instance_type` (`string`): Set the `instance_type` field on the resulting object. When `null`, the `instance_type` field will be omitted from the resulting object.\n - `lifecycle_config_arn` (`string`): Set the `lifecycle_config_arn` field on the resulting object. When `null`, the `lifecycle_config_arn` field will be omitted from the resulting object.\n - `sagemaker_image_arn` (`string`): Set the `sagemaker_image_arn` field on the resulting object. When `null`, the `sagemaker_image_arn` field will be omitted from the resulting object.\n - `sagemaker_image_version_arn` (`string`): Set the `sagemaker_image_version_arn` field on the resulting object. When `null`, the `sagemaker_image_version_arn` field will be omitted from the resulting object.\n\n**Returns**:\n - An attribute object that represents the `default_resource_spec` sub block.\n', args=[]), + '#new':: d.fn(help='\n`aws.sagemaker_space.space_settings.kernel_gateway_app_settings.default_resource_spec.new` constructs a new object with attributes and blocks configured for the `default_resource_spec`\nTerraform sub block.\n\n\n\n**Args**:\n - `instance_type` (`string`): Set the `instance_type` field on the resulting object. When `null`, the `instance_type` field will be omitted from the resulting object.\n - `lifecycle_config_arn` (`string`): Set the `lifecycle_config_arn` field on the resulting object. When `null`, the `lifecycle_config_arn` field will be omitted from the resulting object.\n - `sagemaker_image_arn` (`string`): Set the `sagemaker_image_arn` field on the resulting object. When `null`, the `sagemaker_image_arn` field will be omitted from the resulting object.\n - `sagemaker_image_version_alias` (`string`): Set the `sagemaker_image_version_alias` field on the resulting object. When `null`, the `sagemaker_image_version_alias` field will be omitted from the resulting object.\n - `sagemaker_image_version_arn` (`string`): Set the `sagemaker_image_version_arn` field on the resulting object. When `null`, the `sagemaker_image_version_arn` field will be omitted from the resulting object.\n\n**Returns**:\n - An attribute object that represents the `default_resource_spec` sub block.\n', args=[]), new( instance_type=null, lifecycle_config_arn=null, sagemaker_image_arn=null, + sagemaker_image_version_alias=null, sagemaker_image_version_arn=null ):: std.prune(a={ instance_type: instance_type, lifecycle_config_arn: lifecycle_config_arn, sagemaker_image_arn: sagemaker_image_arn, + sagemaker_image_version_alias: sagemaker_image_version_alias, sagemaker_image_version_arn: sagemaker_image_version_arn, }), }, @@ -129,6 +137,16 @@ local d = (import 'github.com/jsonnet-libs/docsonnet/doc-util/main.libsonnet'); }, }, }, + '#withSpaceDisplayName':: d.fn(help='`aws.string.withSpaceDisplayName` constructs a mixin object that can be merged into the `string`\nTerraform resource block to set or update the space_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 `space_display_name` field.\n', args=[]), + withSpaceDisplayName(resourceLabel, value): { + resource+: { + aws_sagemaker_space+: { + [resourceLabel]+: { + space_display_name: value, + }, + }, + }, + }, '#withSpaceName':: d.fn(help='`aws.string.withSpaceName` constructs a mixin object that can be merged into the `string`\nTerraform resource block to set or update the space_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 `space_name` field.\n', args=[]), withSpaceName(resourceLabel, value): { resource+: { diff --git a/5.x/_gen/resources/sagemaker_user_profile.libsonnet b/5.x/_gen/resources/sagemaker_user_profile.libsonnet index e97e89f4..99cc6477 100644 --- a/5.x/_gen/resources/sagemaker_user_profile.libsonnet +++ b/5.x/_gen/resources/sagemaker_user_profile.libsonnet @@ -122,6 +122,110 @@ local d = (import 'github.com/jsonnet-libs/docsonnet/doc-util/main.libsonnet'); }), }, }, + code_editor_app_settings:: { + default_resource_spec:: { + '#new':: d.fn(help='\n`aws.sagemaker_user_profile.user_settings.code_editor_app_settings.default_resource_spec.new` constructs a new object with attributes and blocks configured for the `default_resource_spec`\nTerraform sub block.\n\n\n\n**Args**:\n - `instance_type` (`string`): Set the `instance_type` field on the resulting object. When `null`, the `instance_type` field will be omitted from the resulting object.\n - `lifecycle_config_arn` (`string`): Set the `lifecycle_config_arn` field on the resulting object. When `null`, the `lifecycle_config_arn` field will be omitted from the resulting object.\n - `sagemaker_image_arn` (`string`): Set the `sagemaker_image_arn` field on the resulting object. When `null`, the `sagemaker_image_arn` field will be omitted from the resulting object.\n - `sagemaker_image_version_alias` (`string`): Set the `sagemaker_image_version_alias` field on the resulting object. When `null`, the `sagemaker_image_version_alias` field will be omitted from the resulting object.\n - `sagemaker_image_version_arn` (`string`): Set the `sagemaker_image_version_arn` field on the resulting object. When `null`, the `sagemaker_image_version_arn` field will be omitted from the resulting object.\n\n**Returns**:\n - An attribute object that represents the `default_resource_spec` sub block.\n', args=[]), + new( + instance_type=null, + lifecycle_config_arn=null, + sagemaker_image_arn=null, + sagemaker_image_version_alias=null, + sagemaker_image_version_arn=null + ):: std.prune(a={ + instance_type: instance_type, + lifecycle_config_arn: lifecycle_config_arn, + sagemaker_image_arn: sagemaker_image_arn, + sagemaker_image_version_alias: sagemaker_image_version_alias, + sagemaker_image_version_arn: sagemaker_image_version_arn, + }), + }, + '#new':: d.fn(help='\n`aws.sagemaker_user_profile.user_settings.code_editor_app_settings.new` constructs a new object with attributes and blocks configured for the `code_editor_app_settings`\nTerraform sub block.\n\n\n\n**Args**:\n - `lifecycle_config_arns` (`list`): Set the `lifecycle_config_arns` field on the resulting object. When `null`, the `lifecycle_config_arns` field will be omitted from the resulting object.\n - `default_resource_spec` (`list[obj]`): Set the `default_resource_spec` field on the resulting object. When `null`, the `default_resource_spec` 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.code_editor_app_settings.default_resource_spec.new](#fn-user_settingsuser_settingsdefault_resource_specnew) constructor.\n\n**Returns**:\n - An attribute object that represents the `code_editor_app_settings` sub block.\n', args=[]), + new( + default_resource_spec=null, + lifecycle_config_arns=null + ):: std.prune(a={ + default_resource_spec: default_resource_spec, + lifecycle_config_arns: lifecycle_config_arns, + }), + }, + custom_file_system_config:: { + efs_file_system_config:: { + '#new':: d.fn(help='\n`aws.sagemaker_user_profile.user_settings.custom_file_system_config.efs_file_system_config.new` constructs a new object with attributes and blocks configured for the `efs_file_system_config`\nTerraform sub block.\n\n\n\n**Args**:\n - `file_system_id` (`string`): Set the `file_system_id` field on the resulting object.\n - `file_system_path` (`string`): Set the `file_system_path` field on the resulting object. When `null`, the `file_system_path` field will be omitted from the resulting object.\n\n**Returns**:\n - An attribute object that represents the `efs_file_system_config` sub block.\n', args=[]), + new( + file_system_id, + file_system_path=null + ):: std.prune(a={ + file_system_id: file_system_id, + file_system_path: file_system_path, + }), + }, + '#new':: d.fn(help='\n`aws.sagemaker_user_profile.user_settings.custom_file_system_config.new` constructs a new object with attributes and blocks configured for the `custom_file_system_config`\nTerraform sub block.\n\n\n\n**Args**:\n - `efs_file_system_config` (`list[obj]`): Set the `efs_file_system_config` field on the resulting object. When `null`, the `efs_file_system_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_user_profile.user_settings.custom_file_system_config.efs_file_system_config.new](#fn-user_settingsuser_settingsefs_file_system_confignew) constructor.\n\n**Returns**:\n - An attribute object that represents the `custom_file_system_config` sub block.\n', args=[]), + new( + efs_file_system_config=null + ):: std.prune(a={ + efs_file_system_config: efs_file_system_config, + }), + }, + custom_posix_user_config:: { + '#new':: d.fn(help='\n`aws.sagemaker_user_profile.user_settings.custom_posix_user_config.new` constructs a new object with attributes and blocks configured for the `custom_posix_user_config`\nTerraform sub block.\n\n\n\n**Args**:\n - `gid` (`number`): Set the `gid` field on the resulting object.\n - `uid` (`number`): Set the `uid` field on the resulting object.\n\n**Returns**:\n - An attribute object that represents the `custom_posix_user_config` sub block.\n', args=[]), + new( + gid, + uid + ):: std.prune(a={ + gid: gid, + uid: uid, + }), + }, + jupyter_lab_app_settings:: { + code_repository:: { + '#new':: d.fn(help='\n`aws.sagemaker_user_profile.user_settings.jupyter_lab_app_settings.code_repository.new` constructs a new object with attributes and blocks configured for the `code_repository`\nTerraform sub block.\n\n\n\n**Args**:\n - `repository_url` (`string`): Set the `repository_url` field on the resulting object.\n\n**Returns**:\n - An attribute object that represents the `code_repository` sub block.\n', args=[]), + new( + repository_url + ):: std.prune(a={ + repository_url: repository_url, + }), + }, + custom_image:: { + '#new':: d.fn(help='\n`aws.sagemaker_user_profile.user_settings.jupyter_lab_app_settings.custom_image.new` constructs a new object with attributes and blocks configured for the `custom_image`\nTerraform sub block.\n\n\n\n**Args**:\n - `app_image_config_name` (`string`): Set the `app_image_config_name` field on the resulting object.\n - `image_name` (`string`): Set the `image_name` field on the resulting object.\n - `image_version_number` (`number`): Set the `image_version_number` field on the resulting object. When `null`, the `image_version_number` field will be omitted from the resulting object.\n\n**Returns**:\n - An attribute object that represents the `custom_image` sub block.\n', args=[]), + new( + app_image_config_name, + image_name, + image_version_number=null + ):: std.prune(a={ + app_image_config_name: app_image_config_name, + image_name: image_name, + image_version_number: image_version_number, + }), + }, + default_resource_spec:: { + '#new':: d.fn(help='\n`aws.sagemaker_user_profile.user_settings.jupyter_lab_app_settings.default_resource_spec.new` constructs a new object with attributes and blocks configured for the `default_resource_spec`\nTerraform sub block.\n\n\n\n**Args**:\n - `instance_type` (`string`): Set the `instance_type` field on the resulting object. When `null`, the `instance_type` field will be omitted from the resulting object.\n - `lifecycle_config_arn` (`string`): Set the `lifecycle_config_arn` field on the resulting object. When `null`, the `lifecycle_config_arn` field will be omitted from the resulting object.\n - `sagemaker_image_arn` (`string`): Set the `sagemaker_image_arn` field on the resulting object. When `null`, the `sagemaker_image_arn` field will be omitted from the resulting object.\n - `sagemaker_image_version_alias` (`string`): Set the `sagemaker_image_version_alias` field on the resulting object. When `null`, the `sagemaker_image_version_alias` field will be omitted from the resulting object.\n - `sagemaker_image_version_arn` (`string`): Set the `sagemaker_image_version_arn` field on the resulting object. When `null`, the `sagemaker_image_version_arn` field will be omitted from the resulting object.\n\n**Returns**:\n - An attribute object that represents the `default_resource_spec` sub block.\n', args=[]), + new( + instance_type=null, + lifecycle_config_arn=null, + sagemaker_image_arn=null, + sagemaker_image_version_alias=null, + sagemaker_image_version_arn=null + ):: std.prune(a={ + instance_type: instance_type, + lifecycle_config_arn: lifecycle_config_arn, + sagemaker_image_arn: sagemaker_image_arn, + sagemaker_image_version_alias: sagemaker_image_version_alias, + sagemaker_image_version_arn: sagemaker_image_version_arn, + }), + }, + '#new':: d.fn(help='\n`aws.sagemaker_user_profile.user_settings.jupyter_lab_app_settings.new` constructs a new object with attributes and blocks configured for the `jupyter_lab_app_settings`\nTerraform sub block.\n\n\n\n**Args**:\n - `lifecycle_config_arns` (`list`): Set the `lifecycle_config_arns` field on the resulting object. When `null`, the `lifecycle_config_arns` field will be omitted from the resulting object.\n - `code_repository` (`list[obj]`): Set the `code_repository` field on the resulting object. When `null`, the `code_repository` 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.jupyter_lab_app_settings.code_repository.new](#fn-user_settingsuser_settingscode_repositorynew) constructor.\n - `custom_image` (`list[obj]`): Set the `custom_image` field on the resulting object. When `null`, the `custom_image` 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.jupyter_lab_app_settings.custom_image.new](#fn-user_settingsuser_settingscustom_imagenew) constructor.\n - `default_resource_spec` (`list[obj]`): Set the `default_resource_spec` field on the resulting object. When `null`, the `default_resource_spec` 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.jupyter_lab_app_settings.default_resource_spec.new](#fn-user_settingsuser_settingsdefault_resource_specnew) constructor.\n\n**Returns**:\n - An attribute object that represents the `jupyter_lab_app_settings` sub block.\n', args=[]), + new( + code_repository=null, + custom_image=null, + default_resource_spec=null, + lifecycle_config_arns=null + ):: std.prune(a={ + code_repository: code_repository, + custom_image: custom_image, + default_resource_spec: default_resource_spec, + lifecycle_config_arns: lifecycle_config_arns, + }), + }, jupyter_server_app_settings:: { code_repository:: { '#new':: d.fn(help='\n`aws.sagemaker_user_profile.user_settings.jupyter_server_app_settings.code_repository.new` constructs a new object with attributes and blocks configured for the `code_repository`\nTerraform sub block.\n\n\n\n**Args**:\n - `repository_url` (`string`): Set the `repository_url` field on the resulting object.\n\n**Returns**:\n - An attribute object that represents the `code_repository` sub block.\n', args=[]), @@ -132,16 +236,18 @@ local d = (import 'github.com/jsonnet-libs/docsonnet/doc-util/main.libsonnet'); }), }, default_resource_spec:: { - '#new':: d.fn(help='\n`aws.sagemaker_user_profile.user_settings.jupyter_server_app_settings.default_resource_spec.new` constructs a new object with attributes and blocks configured for the `default_resource_spec`\nTerraform sub block.\n\n\n\n**Args**:\n - `instance_type` (`string`): Set the `instance_type` field on the resulting object. When `null`, the `instance_type` field will be omitted from the resulting object.\n - `lifecycle_config_arn` (`string`): Set the `lifecycle_config_arn` field on the resulting object. When `null`, the `lifecycle_config_arn` field will be omitted from the resulting object.\n - `sagemaker_image_arn` (`string`): Set the `sagemaker_image_arn` field on the resulting object. When `null`, the `sagemaker_image_arn` field will be omitted from the resulting object.\n - `sagemaker_image_version_arn` (`string`): Set the `sagemaker_image_version_arn` field on the resulting object. When `null`, the `sagemaker_image_version_arn` field will be omitted from the resulting object.\n\n**Returns**:\n - An attribute object that represents the `default_resource_spec` sub block.\n', args=[]), + '#new':: d.fn(help='\n`aws.sagemaker_user_profile.user_settings.jupyter_server_app_settings.default_resource_spec.new` constructs a new object with attributes and blocks configured for the `default_resource_spec`\nTerraform sub block.\n\n\n\n**Args**:\n - `instance_type` (`string`): Set the `instance_type` field on the resulting object. When `null`, the `instance_type` field will be omitted from the resulting object.\n - `lifecycle_config_arn` (`string`): Set the `lifecycle_config_arn` field on the resulting object. When `null`, the `lifecycle_config_arn` field will be omitted from the resulting object.\n - `sagemaker_image_arn` (`string`): Set the `sagemaker_image_arn` field on the resulting object. When `null`, the `sagemaker_image_arn` field will be omitted from the resulting object.\n - `sagemaker_image_version_alias` (`string`): Set the `sagemaker_image_version_alias` field on the resulting object. When `null`, the `sagemaker_image_version_alias` field will be omitted from the resulting object.\n - `sagemaker_image_version_arn` (`string`): Set the `sagemaker_image_version_arn` field on the resulting object. When `null`, the `sagemaker_image_version_arn` field will be omitted from the resulting object.\n\n**Returns**:\n - An attribute object that represents the `default_resource_spec` sub block.\n', args=[]), new( instance_type=null, lifecycle_config_arn=null, sagemaker_image_arn=null, + sagemaker_image_version_alias=null, sagemaker_image_version_arn=null ):: std.prune(a={ instance_type: instance_type, lifecycle_config_arn: lifecycle_config_arn, sagemaker_image_arn: sagemaker_image_arn, + sagemaker_image_version_alias: sagemaker_image_version_alias, sagemaker_image_version_arn: sagemaker_image_version_arn, }), }, @@ -170,16 +276,18 @@ local d = (import 'github.com/jsonnet-libs/docsonnet/doc-util/main.libsonnet'); }), }, default_resource_spec:: { - '#new':: d.fn(help='\n`aws.sagemaker_user_profile.user_settings.kernel_gateway_app_settings.default_resource_spec.new` constructs a new object with attributes and blocks configured for the `default_resource_spec`\nTerraform sub block.\n\n\n\n**Args**:\n - `instance_type` (`string`): Set the `instance_type` field on the resulting object. When `null`, the `instance_type` field will be omitted from the resulting object.\n - `lifecycle_config_arn` (`string`): Set the `lifecycle_config_arn` field on the resulting object. When `null`, the `lifecycle_config_arn` field will be omitted from the resulting object.\n - `sagemaker_image_arn` (`string`): Set the `sagemaker_image_arn` field on the resulting object. When `null`, the `sagemaker_image_arn` field will be omitted from the resulting object.\n - `sagemaker_image_version_arn` (`string`): Set the `sagemaker_image_version_arn` field on the resulting object. When `null`, the `sagemaker_image_version_arn` field will be omitted from the resulting object.\n\n**Returns**:\n - An attribute object that represents the `default_resource_spec` sub block.\n', args=[]), + '#new':: d.fn(help='\n`aws.sagemaker_user_profile.user_settings.kernel_gateway_app_settings.default_resource_spec.new` constructs a new object with attributes and blocks configured for the `default_resource_spec`\nTerraform sub block.\n\n\n\n**Args**:\n - `instance_type` (`string`): Set the `instance_type` field on the resulting object. When `null`, the `instance_type` field will be omitted from the resulting object.\n - `lifecycle_config_arn` (`string`): Set the `lifecycle_config_arn` field on the resulting object. When `null`, the `lifecycle_config_arn` field will be omitted from the resulting object.\n - `sagemaker_image_arn` (`string`): Set the `sagemaker_image_arn` field on the resulting object. When `null`, the `sagemaker_image_arn` field will be omitted from the resulting object.\n - `sagemaker_image_version_alias` (`string`): Set the `sagemaker_image_version_alias` field on the resulting object. When `null`, the `sagemaker_image_version_alias` field will be omitted from the resulting object.\n - `sagemaker_image_version_arn` (`string`): Set the `sagemaker_image_version_arn` field on the resulting object. When `null`, the `sagemaker_image_version_arn` field will be omitted from the resulting object.\n\n**Returns**:\n - An attribute object that represents the `default_resource_spec` sub block.\n', args=[]), new( instance_type=null, lifecycle_config_arn=null, sagemaker_image_arn=null, + sagemaker_image_version_alias=null, sagemaker_image_version_arn=null ):: std.prune(a={ instance_type: instance_type, lifecycle_config_arn: lifecycle_config_arn, sagemaker_image_arn: sagemaker_image_arn, + sagemaker_image_version_alias: sagemaker_image_version_alias, sagemaker_image_version_arn: sagemaker_image_version_arn, }), }, @@ -194,26 +302,40 @@ local d = (import 'github.com/jsonnet-libs/docsonnet/doc-util/main.libsonnet'); lifecycle_config_arns: lifecycle_config_arns, }), }, - '#new':: d.fn(help='\n`aws.sagemaker_user_profile.user_settings.new` constructs a new object with attributes and blocks configured for the `user_settings`\nTerraform sub block.\n\n\n\n**Args**:\n - `execution_role` (`string`): Set the `execution_role` field on the resulting object.\n - `security_groups` (`list`): Set the `security_groups` field on the resulting object. When `null`, the `security_groups` field will be omitted from the resulting object.\n - `canvas_app_settings` (`list[obj]`): Set the `canvas_app_settings` field on the resulting object. When `null`, the `canvas_app_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.new](#fn-user_settingscanvas_app_settingsnew) constructor.\n - `jupyter_server_app_settings` (`list[obj]`): Set the `jupyter_server_app_settings` field on the resulting object. When `null`, the `jupyter_server_app_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.jupyter_server_app_settings.new](#fn-user_settingsjupyter_server_app_settingsnew) constructor.\n - `kernel_gateway_app_settings` (`list[obj]`): Set the `kernel_gateway_app_settings` field on the resulting object. When `null`, the `kernel_gateway_app_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.kernel_gateway_app_settings.new](#fn-user_settingskernel_gateway_app_settingsnew) constructor.\n - `r_session_app_settings` (`list[obj]`): Set the `r_session_app_settings` field on the resulting object. When `null`, the `r_session_app_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.r_session_app_settings.new](#fn-user_settingsr_session_app_settingsnew) constructor.\n - `r_studio_server_pro_app_settings` (`list[obj]`): Set the `r_studio_server_pro_app_settings` field on the resulting object. When `null`, the `r_studio_server_pro_app_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.r_studio_server_pro_app_settings.new](#fn-user_settingsr_studio_server_pro_app_settingsnew) constructor.\n - `sharing_settings` (`list[obj]`): Set the `sharing_settings` field on the resulting object. When `null`, the `sharing_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.sharing_settings.new](#fn-user_settingssharing_settingsnew) constructor.\n - `tensor_board_app_settings` (`list[obj]`): Set the `tensor_board_app_settings` field on the resulting object. When `null`, the `tensor_board_app_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.tensor_board_app_settings.new](#fn-user_settingstensor_board_app_settingsnew) constructor.\n\n**Returns**:\n - An attribute object that represents the `user_settings` sub block.\n', args=[]), + '#new':: d.fn(help='\n`aws.sagemaker_user_profile.user_settings.new` constructs a new object with attributes and blocks configured for the `user_settings`\nTerraform sub block.\n\n\n\n**Args**:\n - `default_landing_uri` (`string`): Set the `default_landing_uri` field on the resulting object. When `null`, the `default_landing_uri` field will be omitted from the resulting object.\n - `execution_role` (`string`): Set the `execution_role` field on the resulting object.\n - `security_groups` (`list`): Set the `security_groups` field on the resulting object. When `null`, the `security_groups` field will be omitted from the resulting object.\n - `studio_web_portal` (`string`): Set the `studio_web_portal` field on the resulting object. When `null`, the `studio_web_portal` field will be omitted from the resulting object.\n - `canvas_app_settings` (`list[obj]`): Set the `canvas_app_settings` field on the resulting object. When `null`, the `canvas_app_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.new](#fn-user_settingscanvas_app_settingsnew) constructor.\n - `code_editor_app_settings` (`list[obj]`): Set the `code_editor_app_settings` field on the resulting object. When `null`, the `code_editor_app_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.code_editor_app_settings.new](#fn-user_settingscode_editor_app_settingsnew) constructor.\n - `custom_file_system_config` (`list[obj]`): Set the `custom_file_system_config` field on the resulting object. When `null`, the `custom_file_system_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_user_profile.user_settings.custom_file_system_config.new](#fn-user_settingscustom_file_system_confignew) constructor.\n - `custom_posix_user_config` (`list[obj]`): Set the `custom_posix_user_config` field on the resulting object. When `null`, the `custom_posix_user_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_user_profile.user_settings.custom_posix_user_config.new](#fn-user_settingscustom_posix_user_confignew) constructor.\n - `jupyter_lab_app_settings` (`list[obj]`): Set the `jupyter_lab_app_settings` field on the resulting object. When `null`, the `jupyter_lab_app_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.jupyter_lab_app_settings.new](#fn-user_settingsjupyter_lab_app_settingsnew) constructor.\n - `jupyter_server_app_settings` (`list[obj]`): Set the `jupyter_server_app_settings` field on the resulting object. When `null`, the `jupyter_server_app_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.jupyter_server_app_settings.new](#fn-user_settingsjupyter_server_app_settingsnew) constructor.\n - `kernel_gateway_app_settings` (`list[obj]`): Set the `kernel_gateway_app_settings` field on the resulting object. When `null`, the `kernel_gateway_app_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.kernel_gateway_app_settings.new](#fn-user_settingskernel_gateway_app_settingsnew) constructor.\n - `r_session_app_settings` (`list[obj]`): Set the `r_session_app_settings` field on the resulting object. When `null`, the `r_session_app_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.r_session_app_settings.new](#fn-user_settingsr_session_app_settingsnew) constructor.\n - `r_studio_server_pro_app_settings` (`list[obj]`): Set the `r_studio_server_pro_app_settings` field on the resulting object. When `null`, the `r_studio_server_pro_app_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.r_studio_server_pro_app_settings.new](#fn-user_settingsr_studio_server_pro_app_settingsnew) constructor.\n - `sharing_settings` (`list[obj]`): Set the `sharing_settings` field on the resulting object. When `null`, the `sharing_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.sharing_settings.new](#fn-user_settingssharing_settingsnew) constructor.\n - `space_storage_settings` (`list[obj]`): Set the `space_storage_settings` field on the resulting object. When `null`, the `space_storage_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.space_storage_settings.new](#fn-user_settingsspace_storage_settingsnew) constructor.\n - `tensor_board_app_settings` (`list[obj]`): Set the `tensor_board_app_settings` field on the resulting object. When `null`, the `tensor_board_app_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.tensor_board_app_settings.new](#fn-user_settingstensor_board_app_settingsnew) constructor.\n\n**Returns**:\n - An attribute object that represents the `user_settings` sub block.\n', args=[]), new( execution_role, canvas_app_settings=null, + code_editor_app_settings=null, + custom_file_system_config=null, + custom_posix_user_config=null, + default_landing_uri=null, + jupyter_lab_app_settings=null, jupyter_server_app_settings=null, kernel_gateway_app_settings=null, r_session_app_settings=null, r_studio_server_pro_app_settings=null, security_groups=null, sharing_settings=null, + space_storage_settings=null, + studio_web_portal=null, tensor_board_app_settings=null ):: std.prune(a={ canvas_app_settings: canvas_app_settings, + code_editor_app_settings: code_editor_app_settings, + custom_file_system_config: custom_file_system_config, + custom_posix_user_config: custom_posix_user_config, + default_landing_uri: default_landing_uri, execution_role: execution_role, + jupyter_lab_app_settings: jupyter_lab_app_settings, jupyter_server_app_settings: jupyter_server_app_settings, kernel_gateway_app_settings: kernel_gateway_app_settings, r_session_app_settings: r_session_app_settings, r_studio_server_pro_app_settings: r_studio_server_pro_app_settings, security_groups: security_groups, sharing_settings: sharing_settings, + space_storage_settings: space_storage_settings, + studio_web_portal: studio_web_portal, tensor_board_app_settings: tensor_board_app_settings, }), r_session_app_settings:: { @@ -230,16 +352,18 @@ local d = (import 'github.com/jsonnet-libs/docsonnet/doc-util/main.libsonnet'); }), }, default_resource_spec:: { - '#new':: d.fn(help='\n`aws.sagemaker_user_profile.user_settings.r_session_app_settings.default_resource_spec.new` constructs a new object with attributes and blocks configured for the `default_resource_spec`\nTerraform sub block.\n\n\n\n**Args**:\n - `instance_type` (`string`): Set the `instance_type` field on the resulting object. When `null`, the `instance_type` field will be omitted from the resulting object.\n - `lifecycle_config_arn` (`string`): Set the `lifecycle_config_arn` field on the resulting object. When `null`, the `lifecycle_config_arn` field will be omitted from the resulting object.\n - `sagemaker_image_arn` (`string`): Set the `sagemaker_image_arn` field on the resulting object. When `null`, the `sagemaker_image_arn` field will be omitted from the resulting object.\n - `sagemaker_image_version_arn` (`string`): Set the `sagemaker_image_version_arn` field on the resulting object. When `null`, the `sagemaker_image_version_arn` field will be omitted from the resulting object.\n\n**Returns**:\n - An attribute object that represents the `default_resource_spec` sub block.\n', args=[]), + '#new':: d.fn(help='\n`aws.sagemaker_user_profile.user_settings.r_session_app_settings.default_resource_spec.new` constructs a new object with attributes and blocks configured for the `default_resource_spec`\nTerraform sub block.\n\n\n\n**Args**:\n - `instance_type` (`string`): Set the `instance_type` field on the resulting object. When `null`, the `instance_type` field will be omitted from the resulting object.\n - `lifecycle_config_arn` (`string`): Set the `lifecycle_config_arn` field on the resulting object. When `null`, the `lifecycle_config_arn` field will be omitted from the resulting object.\n - `sagemaker_image_arn` (`string`): Set the `sagemaker_image_arn` field on the resulting object. When `null`, the `sagemaker_image_arn` field will be omitted from the resulting object.\n - `sagemaker_image_version_alias` (`string`): Set the `sagemaker_image_version_alias` field on the resulting object. When `null`, the `sagemaker_image_version_alias` field will be omitted from the resulting object.\n - `sagemaker_image_version_arn` (`string`): Set the `sagemaker_image_version_arn` field on the resulting object. When `null`, the `sagemaker_image_version_arn` field will be omitted from the resulting object.\n\n**Returns**:\n - An attribute object that represents the `default_resource_spec` sub block.\n', args=[]), new( instance_type=null, lifecycle_config_arn=null, sagemaker_image_arn=null, + sagemaker_image_version_alias=null, sagemaker_image_version_arn=null ):: std.prune(a={ instance_type: instance_type, lifecycle_config_arn: lifecycle_config_arn, sagemaker_image_arn: sagemaker_image_arn, + sagemaker_image_version_alias: sagemaker_image_version_alias, sagemaker_image_version_arn: sagemaker_image_version_arn, }), }, @@ -274,18 +398,38 @@ local d = (import 'github.com/jsonnet-libs/docsonnet/doc-util/main.libsonnet'); s3_output_path: s3_output_path, }), }, + space_storage_settings:: { + default_ebs_storage_settings:: { + '#new':: d.fn(help='\n`aws.sagemaker_user_profile.user_settings.space_storage_settings.default_ebs_storage_settings.new` constructs a new object with attributes and blocks configured for the `default_ebs_storage_settings`\nTerraform sub block.\n\n\n\n**Args**:\n - `default_ebs_volume_size_in_gb` (`number`): Set the `default_ebs_volume_size_in_gb` field on the resulting object.\n - `maximum_ebs_volume_size_in_gb` (`number`): Set the `maximum_ebs_volume_size_in_gb` field on the resulting object.\n\n**Returns**:\n - An attribute object that represents the `default_ebs_storage_settings` sub block.\n', args=[]), + new( + default_ebs_volume_size_in_gb, + maximum_ebs_volume_size_in_gb + ):: std.prune(a={ + default_ebs_volume_size_in_gb: default_ebs_volume_size_in_gb, + maximum_ebs_volume_size_in_gb: maximum_ebs_volume_size_in_gb, + }), + }, + '#new':: d.fn(help='\n`aws.sagemaker_user_profile.user_settings.space_storage_settings.new` constructs a new object with attributes and blocks configured for the `space_storage_settings`\nTerraform sub block.\n\n\n\n**Args**:\n - `default_ebs_storage_settings` (`list[obj]`): Set the `default_ebs_storage_settings` field on the resulting object. When `null`, the `default_ebs_storage_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.space_storage_settings.default_ebs_storage_settings.new](#fn-user_settingsuser_settingsdefault_ebs_storage_settingsnew) constructor.\n\n**Returns**:\n - An attribute object that represents the `space_storage_settings` sub block.\n', args=[]), + new( + default_ebs_storage_settings=null + ):: std.prune(a={ + default_ebs_storage_settings: default_ebs_storage_settings, + }), + }, tensor_board_app_settings:: { default_resource_spec:: { - '#new':: d.fn(help='\n`aws.sagemaker_user_profile.user_settings.tensor_board_app_settings.default_resource_spec.new` constructs a new object with attributes and blocks configured for the `default_resource_spec`\nTerraform sub block.\n\n\n\n**Args**:\n - `instance_type` (`string`): Set the `instance_type` field on the resulting object. When `null`, the `instance_type` field will be omitted from the resulting object.\n - `lifecycle_config_arn` (`string`): Set the `lifecycle_config_arn` field on the resulting object. When `null`, the `lifecycle_config_arn` field will be omitted from the resulting object.\n - `sagemaker_image_arn` (`string`): Set the `sagemaker_image_arn` field on the resulting object. When `null`, the `sagemaker_image_arn` field will be omitted from the resulting object.\n - `sagemaker_image_version_arn` (`string`): Set the `sagemaker_image_version_arn` field on the resulting object. When `null`, the `sagemaker_image_version_arn` field will be omitted from the resulting object.\n\n**Returns**:\n - An attribute object that represents the `default_resource_spec` sub block.\n', args=[]), + '#new':: d.fn(help='\n`aws.sagemaker_user_profile.user_settings.tensor_board_app_settings.default_resource_spec.new` constructs a new object with attributes and blocks configured for the `default_resource_spec`\nTerraform sub block.\n\n\n\n**Args**:\n - `instance_type` (`string`): Set the `instance_type` field on the resulting object. When `null`, the `instance_type` field will be omitted from the resulting object.\n - `lifecycle_config_arn` (`string`): Set the `lifecycle_config_arn` field on the resulting object. When `null`, the `lifecycle_config_arn` field will be omitted from the resulting object.\n - `sagemaker_image_arn` (`string`): Set the `sagemaker_image_arn` field on the resulting object. When `null`, the `sagemaker_image_arn` field will be omitted from the resulting object.\n - `sagemaker_image_version_alias` (`string`): Set the `sagemaker_image_version_alias` field on the resulting object. When `null`, the `sagemaker_image_version_alias` field will be omitted from the resulting object.\n - `sagemaker_image_version_arn` (`string`): Set the `sagemaker_image_version_arn` field on the resulting object. When `null`, the `sagemaker_image_version_arn` field will be omitted from the resulting object.\n\n**Returns**:\n - An attribute object that represents the `default_resource_spec` sub block.\n', args=[]), new( instance_type=null, lifecycle_config_arn=null, sagemaker_image_arn=null, + sagemaker_image_version_alias=null, sagemaker_image_version_arn=null ):: std.prune(a={ instance_type: instance_type, lifecycle_config_arn: lifecycle_config_arn, sagemaker_image_arn: sagemaker_image_arn, + sagemaker_image_version_alias: sagemaker_image_version_alias, sagemaker_image_version_arn: sagemaker_image_version_arn, }), }, diff --git a/5.x/_gen/resources/securitylake_data_lake.libsonnet b/5.x/_gen/resources/securitylake_data_lake.libsonnet new file mode 100644 index 00000000..8bcaab10 --- /dev/null +++ b/5.x/_gen/resources/securitylake_data_lake.libsonnet @@ -0,0 +1,160 @@ +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='securitylake_data_lake', url='', help='`securitylake_data_lake` represents the `aws_securitylake_data_lake` Terraform resource.\n\n\n\nThis package contains functions and utilities for setting up the resource using Jsonnet code.\n'), + configuration:: { + lifecycle_configuration:: { + expiration:: { + '#new':: d.fn(help='\n`aws.securitylake_data_lake.configuration.lifecycle_configuration.expiration.new` constructs a new object with attributes and blocks configured for the `expiration`\nTerraform sub block.\n\n\n\n**Args**:\n - `days` (`number`): Set the `days` field on the resulting object. When `null`, the `days` field will be omitted from the resulting object.\n\n**Returns**:\n - An attribute object that represents the `expiration` sub block.\n', args=[]), + new( + days=null + ):: std.prune(a={ + days: days, + }), + }, + '#new':: d.fn(help='\n`aws.securitylake_data_lake.configuration.lifecycle_configuration.new` constructs a new object with attributes and blocks configured for the `lifecycle_configuration`\nTerraform sub block.\n\n\n\n**Args**:\n - `expiration` (`list[obj]`): Set the `expiration` field on the resulting object. When `null`, the `expiration` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [aws.securitylake_data_lake.configuration.lifecycle_configuration.expiration.new](#fn-configurationconfigurationexpirationnew) constructor.\n - `transition` (`list[obj]`): Set the `transition` field on the resulting object. When `null`, the `transition` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [aws.securitylake_data_lake.configuration.lifecycle_configuration.transition.new](#fn-configurationconfigurationtransitionnew) constructor.\n\n**Returns**:\n - An attribute object that represents the `lifecycle_configuration` sub block.\n', args=[]), + new( + expiration=null, + transition=null + ):: std.prune(a={ + expiration: expiration, + transition: transition, + }), + transition:: { + '#new':: d.fn(help='\n`aws.securitylake_data_lake.configuration.lifecycle_configuration.transition.new` constructs a new object with attributes and blocks configured for the `transition`\nTerraform sub block.\n\n\n\n**Args**:\n - `days` (`number`): Set the `days` field on the resulting object. When `null`, the `days` field will be omitted from the resulting object.\n - `storage_class` (`string`): Set the `storage_class` field on the resulting object. When `null`, the `storage_class` field will be omitted from the resulting object.\n\n**Returns**:\n - An attribute object that represents the `transition` sub block.\n', args=[]), + new( + days=null, + storage_class=null + ):: std.prune(a={ + days: days, + storage_class: storage_class, + }), + }, + }, + '#new':: d.fn(help='\n`aws.securitylake_data_lake.configuration.new` constructs a new object with attributes and blocks configured for the `configuration`\nTerraform sub block.\n\n\n\n**Args**:\n - `encryption_configuration` (`list`): Set the `encryption_configuration` field on the resulting object. When `null`, the `encryption_configuration` field will be omitted from the resulting object.\n - `region` (`string`): Set the `region` field on the resulting object.\n - `lifecycle_configuration` (`list[obj]`): Set the `lifecycle_configuration` field on the resulting object. When `null`, the `lifecycle_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.securitylake_data_lake.configuration.lifecycle_configuration.new](#fn-configurationlifecycle_configurationnew) constructor.\n - `replication_configuration` (`list[obj]`): Set the `replication_configuration` field on the resulting object. When `null`, the `replication_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.securitylake_data_lake.configuration.replication_configuration.new](#fn-configurationreplication_configurationnew) constructor.\n\n**Returns**:\n - An attribute object that represents the `configuration` sub block.\n', args=[]), + new( + region, + encryption_configuration=null, + lifecycle_configuration=null, + replication_configuration=null + ):: std.prune(a={ + encryption_configuration: encryption_configuration, + lifecycle_configuration: lifecycle_configuration, + region: region, + replication_configuration: replication_configuration, + }), + replication_configuration:: { + '#new':: d.fn(help='\n`aws.securitylake_data_lake.configuration.replication_configuration.new` constructs a new object with attributes and blocks configured for the `replication_configuration`\nTerraform sub block.\n\n\n\n**Args**:\n - `regions` (`list`): Set the `regions` field on the resulting object. When `null`, the `regions` field will be omitted from 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\n**Returns**:\n - An attribute object that represents the `replication_configuration` sub block.\n', args=[]), + new( + regions=null, + role_arn=null + ):: std.prune(a={ + regions: regions, + role_arn: role_arn, + }), + }, + }, + '#new':: d.fn(help="\n`aws.securitylake_data_lake.new` injects a new `aws_securitylake_data_lake` 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.securitylake_data_lake.new('some_id')\n\nYou can get the reference to the `id` field of the created `aws.securitylake_data_lake` using the reference:\n\n $._ref.aws_securitylake_data_lake.some_id.get('id')\n\nThis is the same as directly entering `\"${ aws_securitylake_data_lake.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 - `meta_store_manager_role_arn` (`string`): Set the `meta_store_manager_role_arn` 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 - `configuration` (`list[obj]`): Set the `configuration` field on the resulting resource block. When `null`, the `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.securitylake_data_lake.configuration.new](#fn-configurationnew) constructor.\n - `timeouts` (`obj`): Set the `timeouts` field on the resulting resource block. When `null`, the `timeouts` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [aws.securitylake_data_lake.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, + meta_store_manager_role_arn, + configuration=null, + tags=null, + timeouts=null, + _meta={} + ):: tf.withResource( + type='aws_securitylake_data_lake', + label=resourceLabel, + attrs=self.newAttrs( + configuration=configuration, + meta_store_manager_role_arn=meta_store_manager_role_arn, + tags=tags, + timeouts=timeouts + ), + _meta=_meta + ), + '#newAttrs':: d.fn(help='\n`aws.securitylake_data_lake.newAttrs` constructs a new object with attributes and blocks configured for the `securitylake_data_lake`\nTerraform resource.\n\nUnlike [aws.securitylake_data_lake.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 - `meta_store_manager_role_arn` (`string`): Set the `meta_store_manager_role_arn` 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 - `configuration` (`list[obj]`): Set the `configuration` field on the resulting object. When `null`, the `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.securitylake_data_lake.configuration.new](#fn-configurationnew) constructor.\n - `timeouts` (`obj`): Set the `timeouts` field on the resulting object. When `null`, the `timeouts` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [aws.securitylake_data_lake.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 `securitylake_data_lake` resource into the root Terraform configuration.\n', args=[]), + newAttrs( + meta_store_manager_role_arn, + configuration=null, + tags=null, + timeouts=null + ):: std.prune(a={ + configuration: configuration, + meta_store_manager_role_arn: meta_store_manager_role_arn, + tags: tags, + timeouts: timeouts, + }), + timeouts:: { + '#new':: d.fn(help='\n`aws.securitylake_data_lake.timeouts.new` constructs a new object with attributes and blocks configured for the `timeouts`\nTerraform sub block.\n\n\n\n**Args**:\n - `create` (`string`): A string that can be [parsed as a duration](https://pkg.go.dev/time#ParseDuration) consisting of numbers and unit suffixes, such as "30s" or "2h45m". Valid time units are "s" (seconds), "m" (minutes), "h" (hours). When `null`, the `create` field will be omitted from the resulting object.\n - `delete` (`string`): A string that can be [parsed as a duration](https://pkg.go.dev/time#ParseDuration) consisting of numbers and unit suffixes, such as "30s" or "2h45m". Valid time units are "s" (seconds), "m" (minutes), "h" (hours). Setting a timeout for a Delete operation is only applicable if changes are saved into state before the destroy operation occurs. When `null`, the `delete` field will be omitted from the resulting object.\n - `update` (`string`): A string that can be [parsed as a duration](https://pkg.go.dev/time#ParseDuration) consisting of numbers and unit suffixes, such as "30s" or "2h45m". Valid time units are "s" (seconds), "m" (minutes), "h" (hours). When `null`, the `update` field will be omitted from the resulting object.\n\n**Returns**:\n - An attribute object that represents the `timeouts` sub block.\n', args=[]), + new( + create=null, + delete=null, + update=null + ):: std.prune(a={ + create: create, + delete: delete, + update: update, + }), + }, + '#withConfiguration':: d.fn(help='`aws.list[obj].withConfiguration` constructs a mixin object that can be merged into the `list[obj]`\nTerraform resource block to set or update the 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].withConfigurationMixin](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 `configuration` field.\n', args=[]), + withConfiguration(resourceLabel, value): { + resource+: { + aws_securitylake_data_lake+: { + [resourceLabel]+: { + configuration: value, + }, + }, + }, + }, + '#withConfigurationMixin':: d.fn(help='`aws.list[obj].withConfigurationMixin` constructs a mixin object that can be merged into the `list[obj]`\nTerraform resource block to set or update the 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].withConfiguration](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 `configuration` field.\n', args=[]), + withConfigurationMixin(resourceLabel, value): { + resource+: { + aws_securitylake_data_lake+: { + [resourceLabel]+: { + configuration+: if std.isArray(v=value) then value else [value], + }, + }, + }, + }, + '#withMetaStoreManagerRoleArn':: d.fn(help='`aws.string.withMetaStoreManagerRoleArn` constructs a mixin object that can be merged into the `string`\nTerraform resource block to set or update the meta_store_manager_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 `meta_store_manager_role_arn` field.\n', args=[]), + withMetaStoreManagerRoleArn(resourceLabel, value): { + resource+: { + aws_securitylake_data_lake+: { + [resourceLabel]+: { + meta_store_manager_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_securitylake_data_lake+: { + [resourceLabel]+: { + tags: value, + }, + }, + }, + }, + '#withTimeouts':: d.fn(help='`aws.obj.withTimeouts` constructs a mixin object that can be merged into the `obj`\nTerraform resource block to set or update the timeouts field.\n\nThis function will replace the map with the passed in `value`. If you wish to instead merge the\npassed in value to the existing map, use the [aws.obj.withTimeoutsMixin](TODO) function.\n\n**Args**:\n - `resourceLabel` (`string`): The name label of the block to update.\n - `value` (`obj`): The value to set for the `timeouts` field.\n', args=[]), + withTimeouts(resourceLabel, value): { + resource+: { + aws_securitylake_data_lake+: { + [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_securitylake_data_lake+: { + [resourceLabel]+: { + timeouts+: value, + }, + }, + }, + }, +} diff --git a/5.x/_gen/resources/ssoadmin_application.libsonnet b/5.x/_gen/resources/ssoadmin_application.libsonnet new file mode 100644 index 00000000..bc1447bf --- /dev/null +++ b/5.x/_gen/resources/ssoadmin_application.libsonnet @@ -0,0 +1,162 @@ +local tf = (import 'github.com/tf-libsonnet/core/main.libsonnet'); +local d = (import 'github.com/jsonnet-libs/docsonnet/doc-util/main.libsonnet'); +{ + '#':: d.pkg(name='ssoadmin_application', url='', help='`ssoadmin_application` represents the `aws_ssoadmin_application` Terraform resource.\n\n\n\nThis package contains functions and utilities for setting up the resource using Jsonnet code.\n'), + '#new':: d.fn(help="\n`aws.ssoadmin_application.new` injects a new `aws_ssoadmin_application` Terraform `resource`\nblock into the root module document.\n\nAdditionally, this inserts a private function into the `_ref` attribute that generates references to attributes of the\nresource. For example, if you added a new instance to the root using:\n\n # arguments omitted for brevity\n aws.ssoadmin_application.new('some_id')\n\nYou can get the reference to the `id` field of the created `aws.ssoadmin_application` using the reference:\n\n $._ref.aws_ssoadmin_application.some_id.get('id')\n\nThis is the same as directly entering `\"${ aws_ssoadmin_application.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 - `application_provider_arn` (`string`): Set the `application_provider_arn` field on the resulting resource block.\n - `client_token` (`string`): Set the `client_token` field on the resulting resource block. When `null`, the `client_token` field will be omitted from the resulting object.\n - `description` (`string`): Set the `description` field on the resulting resource block. When `null`, the `description` field will be omitted from the resulting object.\n - `instance_arn` (`string`): Set the `instance_arn` field on the resulting resource block.\n - `name` (`string`): Set the `name` field on the resulting resource block.\n - `status` (`string`): Set the `status` field on the resulting resource block. When `null`, the `status` field will be omitted from the resulting object.\n - `tags` (`obj`): Set the `tags` field on the resulting resource block. When `null`, the `tags` field will be omitted from the resulting object.\n - `portal_options` (`list[obj]`): Set the `portal_options` field on the resulting resource block. When `null`, the `portal_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.ssoadmin_application.portal_options.new](#fn-portal_optionsnew) constructor.\n\n**Returns**:\n- A mixin object that injects the new resource into the root Terraform configuration.\n", args=[]), + new( + resourceLabel, + application_provider_arn, + instance_arn, + name, + client_token=null, + description=null, + portal_options=null, + status=null, + tags=null, + _meta={} + ):: tf.withResource( + type='aws_ssoadmin_application', + label=resourceLabel, + attrs=self.newAttrs( + application_provider_arn=application_provider_arn, + client_token=client_token, + description=description, + instance_arn=instance_arn, + name=name, + portal_options=portal_options, + status=status, + tags=tags + ), + _meta=_meta + ), + '#newAttrs':: d.fn(help='\n`aws.ssoadmin_application.newAttrs` constructs a new object with attributes and blocks configured for the `ssoadmin_application`\nTerraform resource.\n\nUnlike [aws.ssoadmin_application.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 - `application_provider_arn` (`string`): Set the `application_provider_arn` field on the resulting object.\n - `client_token` (`string`): Set the `client_token` field on the resulting object. When `null`, the `client_token` field will be omitted from the resulting object.\n - `description` (`string`): Set the `description` field on the resulting object. When `null`, the `description` field will be omitted from the resulting object.\n - `instance_arn` (`string`): Set the `instance_arn` field on the resulting object.\n - `name` (`string`): Set the `name` field on the resulting object.\n - `status` (`string`): Set the `status` field on the resulting object. When `null`, the `status` field will be omitted from the resulting object.\n - `tags` (`obj`): Set the `tags` field on the resulting object. When `null`, the `tags` field will be omitted from the resulting object.\n - `portal_options` (`list[obj]`): Set the `portal_options` field on the resulting object. When `null`, the `portal_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.ssoadmin_application.portal_options.new](#fn-portal_optionsnew) constructor.\n\n**Returns**:\n - An attribute object that can be used with [tf.withResource](https://github.com/tf-libsonnet/core/tree/main/docs#fn-withresource) to construct a new `ssoadmin_application` resource into the root Terraform configuration.\n', args=[]), + newAttrs( + application_provider_arn, + instance_arn, + name, + client_token=null, + description=null, + portal_options=null, + status=null, + tags=null + ):: std.prune(a={ + application_provider_arn: application_provider_arn, + client_token: client_token, + description: description, + instance_arn: instance_arn, + name: name, + portal_options: portal_options, + status: status, + tags: tags, + }), + portal_options:: { + '#new':: d.fn(help='\n`aws.ssoadmin_application.portal_options.new` constructs a new object with attributes and blocks configured for the `portal_options`\nTerraform sub block.\n\n\n\n**Args**:\n - `visibility` (`string`): Set the `visibility` field on the resulting object. When `null`, the `visibility` field will be omitted from the resulting object.\n - `sign_in_options` (`list[obj]`): Set the `sign_in_options` field on the resulting object. When `null`, the `sign_in_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.ssoadmin_application.portal_options.sign_in_options.new](#fn-portal_optionssign_in_optionsnew) constructor.\n\n**Returns**:\n - An attribute object that represents the `portal_options` sub block.\n', args=[]), + new( + sign_in_options=null, + visibility=null + ):: std.prune(a={ + sign_in_options: sign_in_options, + visibility: visibility, + }), + sign_in_options:: { + '#new':: d.fn(help='\n`aws.ssoadmin_application.portal_options.sign_in_options.new` constructs a new object with attributes and blocks configured for the `sign_in_options`\nTerraform sub block.\n\n\n\n**Args**:\n - `application_url` (`string`): Set the `application_url` field on the resulting object. When `null`, the `application_url` field will be omitted from the resulting object.\n - `origin` (`string`): Set the `origin` field on the resulting object.\n\n**Returns**:\n - An attribute object that represents the `sign_in_options` sub block.\n', args=[]), + new( + origin, + application_url=null + ):: std.prune(a={ + application_url: application_url, + origin: origin, + }), + }, + }, + '#withApplicationProviderArn':: d.fn(help='`aws.string.withApplicationProviderArn` constructs a mixin object that can be merged into the `string`\nTerraform resource block to set or update the application_provider_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 `application_provider_arn` field.\n', args=[]), + withApplicationProviderArn(resourceLabel, value): { + resource+: { + aws_ssoadmin_application+: { + [resourceLabel]+: { + application_provider_arn: value, + }, + }, + }, + }, + '#withClientToken':: d.fn(help='`aws.string.withClientToken` constructs a mixin object that can be merged into the `string`\nTerraform resource block to set or update the client_token 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 `client_token` field.\n', args=[]), + withClientToken(resourceLabel, value): { + resource+: { + aws_ssoadmin_application+: { + [resourceLabel]+: { + client_token: value, + }, + }, + }, + }, + '#withDescription':: d.fn(help='`aws.string.withDescription` constructs a mixin object that can be merged into the `string`\nTerraform resource block to set or update the description field.\n\n\n\n**Args**:\n - `resourceLabel` (`string`): The name label of the block to update.\n - `value` (`string`): The value to set for the `description` field.\n', args=[]), + withDescription(resourceLabel, value): { + resource+: { + aws_ssoadmin_application+: { + [resourceLabel]+: { + description: value, + }, + }, + }, + }, + '#withInstanceArn':: d.fn(help='`aws.string.withInstanceArn` constructs a mixin object that can be merged into the `string`\nTerraform resource block to set or update the instance_arn field.\n\n\n\n**Args**:\n - `resourceLabel` (`string`): The name label of the block to update.\n - `value` (`string`): The value to set for the `instance_arn` field.\n', args=[]), + withInstanceArn(resourceLabel, value): { + resource+: { + aws_ssoadmin_application+: { + [resourceLabel]+: { + instance_arn: value, + }, + }, + }, + }, + '#withName':: d.fn(help='`aws.string.withName` constructs a mixin object that can be merged into the `string`\nTerraform resource block to set or update the 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 `name` field.\n', args=[]), + withName(resourceLabel, value): { + resource+: { + aws_ssoadmin_application+: { + [resourceLabel]+: { + name: value, + }, + }, + }, + }, + '#withPortalOptions':: d.fn(help='`aws.list[obj].withPortalOptions` constructs a mixin object that can be merged into the `list[obj]`\nTerraform resource block to set or update the portal_options field.\n\nThis function will replace the array with the passed in `value`. If you wish to instead append the\npassed in value to the existing array, use the [aws.list[obj].withPortalOptionsMixin](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 `portal_options` field.\n', args=[]), + withPortalOptions(resourceLabel, value): { + resource+: { + aws_ssoadmin_application+: { + [resourceLabel]+: { + portal_options: value, + }, + }, + }, + }, + '#withPortalOptionsMixin':: d.fn(help='`aws.list[obj].withPortalOptionsMixin` constructs a mixin object that can be merged into the `list[obj]`\nTerraform resource block to set or update the portal_options field.\n\nThis function will append the passed in array or object to the existing array. If you wish\nto instead replace the array with the passed in `value`, use the [aws.list[obj].withPortalOptions](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 `portal_options` field.\n', args=[]), + withPortalOptionsMixin(resourceLabel, value): { + resource+: { + aws_ssoadmin_application+: { + [resourceLabel]+: { + portal_options+: if std.isArray(v=value) then value else [value], + }, + }, + }, + }, + '#withStatus':: d.fn(help='`aws.string.withStatus` constructs a mixin object that can be merged into the `string`\nTerraform resource block to set or update the status 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 `status` field.\n', args=[]), + withStatus(resourceLabel, value): { + resource+: { + aws_ssoadmin_application+: { + [resourceLabel]+: { + status: 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_ssoadmin_application+: { + [resourceLabel]+: { + tags: value, + }, + }, + }, + }, +} diff --git a/5.x/_gen/resources/ssoadmin_application_assignment.libsonnet b/5.x/_gen/resources/ssoadmin_application_assignment.libsonnet new file mode 100644 index 00000000..571f96c1 --- /dev/null +++ b/5.x/_gen/resources/ssoadmin_application_assignment.libsonnet @@ -0,0 +1,58 @@ +local tf = (import 'github.com/tf-libsonnet/core/main.libsonnet'); +local d = (import 'github.com/jsonnet-libs/docsonnet/doc-util/main.libsonnet'); +{ + '#':: d.pkg(name='ssoadmin_application_assignment', url='', help='`ssoadmin_application_assignment` represents the `aws_ssoadmin_application_assignment` Terraform resource.\n\n\n\nThis package contains functions and utilities for setting up the resource using Jsonnet code.\n'), + '#new':: d.fn(help="\n`aws.ssoadmin_application_assignment.new` injects a new `aws_ssoadmin_application_assignment` Terraform `resource`\nblock into the root module document.\n\nAdditionally, this inserts a private function into the `_ref` attribute that generates references to attributes of the\nresource. For example, if you added a new instance to the root using:\n\n # arguments omitted for brevity\n aws.ssoadmin_application_assignment.new('some_id')\n\nYou can get the reference to the `id` field of the created `aws.ssoadmin_application_assignment` using the reference:\n\n $._ref.aws_ssoadmin_application_assignment.some_id.get('id')\n\nThis is the same as directly entering `\"${ aws_ssoadmin_application_assignment.some_id.id }\"` as the value.\n\nNOTE: if you are chaining multiple resources together in a merge operation, you may not be able to use `super`, `self`,\nor `$` to refer to the root object. Instead, make an explicit outer object using `local`.\n\n**Args**:\n - `resourceLabel` (`string`): The name label of the block.\n - `application_arn` (`string`): Set the `application_arn` field on the resulting resource block.\n - `principal_id` (`string`): Set the `principal_id` field on the resulting resource block.\n - `principal_type` (`string`): Set the `principal_type` field on the resulting resource block.\n\n**Returns**:\n- A mixin object that injects the new resource into the root Terraform configuration.\n", args=[]), + new( + resourceLabel, + application_arn, + principal_id, + principal_type, + _meta={} + ):: tf.withResource( + type='aws_ssoadmin_application_assignment', + label=resourceLabel, + attrs=self.newAttrs(application_arn=application_arn, principal_id=principal_id, principal_type=principal_type), + _meta=_meta + ), + '#newAttrs':: d.fn(help='\n`aws.ssoadmin_application_assignment.newAttrs` constructs a new object with attributes and blocks configured for the `ssoadmin_application_assignment`\nTerraform resource.\n\nUnlike [aws.ssoadmin_application_assignment.new](#fn-new), this function will not inject the `resource`\nblock into the root Terraform document. Instead, this must be passed in as the `attrs` argument for the\n[tf.withResource](https://github.com/tf-libsonnet/core/tree/main/docs#fn-withresource) function to build a complete block.\n\nThis is most useful when you need to preprocess the attributes with functions, conditional, or looping logic prior to\ninjecting into a complete block.\n\n**Args**:\n - `application_arn` (`string`): Set the `application_arn` field on the resulting object.\n - `principal_id` (`string`): Set the `principal_id` field on the resulting object.\n - `principal_type` (`string`): Set the `principal_type` field on the resulting object.\n\n**Returns**:\n - An attribute object that can be used with [tf.withResource](https://github.com/tf-libsonnet/core/tree/main/docs#fn-withresource) to construct a new `ssoadmin_application_assignment` resource into the root Terraform configuration.\n', args=[]), + newAttrs( + application_arn, + principal_id, + principal_type + ):: std.prune(a={ + application_arn: application_arn, + principal_id: principal_id, + principal_type: principal_type, + }), + '#withApplicationArn':: d.fn(help='`aws.string.withApplicationArn` constructs a mixin object that can be merged into the `string`\nTerraform resource block to set or update the application_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 `application_arn` field.\n', args=[]), + withApplicationArn(resourceLabel, value): { + resource+: { + aws_ssoadmin_application_assignment+: { + [resourceLabel]+: { + application_arn: value, + }, + }, + }, + }, + '#withPrincipalId':: d.fn(help='`aws.string.withPrincipalId` constructs a mixin object that can be merged into the `string`\nTerraform resource block to set or update the principal_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 `principal_id` field.\n', args=[]), + withPrincipalId(resourceLabel, value): { + resource+: { + aws_ssoadmin_application_assignment+: { + [resourceLabel]+: { + principal_id: value, + }, + }, + }, + }, + '#withPrincipalType':: d.fn(help='`aws.string.withPrincipalType` constructs a mixin object that can be merged into the `string`\nTerraform resource block to set or update the principal_type field.\n\n\n\n**Args**:\n - `resourceLabel` (`string`): The name label of the block to update.\n - `value` (`string`): The value to set for the `principal_type` field.\n', args=[]), + withPrincipalType(resourceLabel, value): { + resource+: { + aws_ssoadmin_application_assignment+: { + [resourceLabel]+: { + principal_type: value, + }, + }, + }, + }, +} diff --git a/5.x/_gen/resources/ssoadmin_application_assignment_configuration.libsonnet b/5.x/_gen/resources/ssoadmin_application_assignment_configuration.libsonnet new file mode 100644 index 00000000..632eb269 --- /dev/null +++ b/5.x/_gen/resources/ssoadmin_application_assignment_configuration.libsonnet @@ -0,0 +1,45 @@ +local tf = (import 'github.com/tf-libsonnet/core/main.libsonnet'); +local d = (import 'github.com/jsonnet-libs/docsonnet/doc-util/main.libsonnet'); +{ + '#':: d.pkg(name='ssoadmin_application_assignment_configuration', url='', help='`ssoadmin_application_assignment_configuration` represents the `aws_ssoadmin_application_assignment_configuration` Terraform resource.\n\n\n\nThis package contains functions and utilities for setting up the resource using Jsonnet code.\n'), + '#new':: d.fn(help="\n`aws.ssoadmin_application_assignment_configuration.new` injects a new `aws_ssoadmin_application_assignment_configuration` Terraform `resource`\nblock into the root module document.\n\nAdditionally, this inserts a private function into the `_ref` attribute that generates references to attributes of the\nresource. For example, if you added a new instance to the root using:\n\n # arguments omitted for brevity\n aws.ssoadmin_application_assignment_configuration.new('some_id')\n\nYou can get the reference to the `id` field of the created `aws.ssoadmin_application_assignment_configuration` using the reference:\n\n $._ref.aws_ssoadmin_application_assignment_configuration.some_id.get('id')\n\nThis is the same as directly entering `\"${ aws_ssoadmin_application_assignment_configuration.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 - `application_arn` (`string`): Set the `application_arn` field on the resulting resource block.\n - `assignment_required` (`bool`): Set the `assignment_required` 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, + application_arn, + assignment_required, + _meta={} + ):: tf.withResource( + type='aws_ssoadmin_application_assignment_configuration', + label=resourceLabel, + attrs=self.newAttrs(application_arn=application_arn, assignment_required=assignment_required), + _meta=_meta + ), + '#newAttrs':: d.fn(help='\n`aws.ssoadmin_application_assignment_configuration.newAttrs` constructs a new object with attributes and blocks configured for the `ssoadmin_application_assignment_configuration`\nTerraform resource.\n\nUnlike [aws.ssoadmin_application_assignment_configuration.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 - `application_arn` (`string`): Set the `application_arn` field on the resulting object.\n - `assignment_required` (`bool`): Set the `assignment_required` field on the resulting object.\n\n**Returns**:\n - An attribute object that can be used with [tf.withResource](https://github.com/tf-libsonnet/core/tree/main/docs#fn-withresource) to construct a new `ssoadmin_application_assignment_configuration` resource into the root Terraform configuration.\n', args=[]), + newAttrs( + application_arn, + assignment_required + ):: std.prune(a={ + application_arn: application_arn, + assignment_required: assignment_required, + }), + '#withApplicationArn':: d.fn(help='`aws.string.withApplicationArn` constructs a mixin object that can be merged into the `string`\nTerraform resource block to set or update the application_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 `application_arn` field.\n', args=[]), + withApplicationArn(resourceLabel, value): { + resource+: { + aws_ssoadmin_application_assignment_configuration+: { + [resourceLabel]+: { + application_arn: value, + }, + }, + }, + }, + '#withAssignmentRequired':: d.fn(help='`aws.bool.withAssignmentRequired` constructs a mixin object that can be merged into the `bool`\nTerraform resource block to set or update the assignment_required field.\n\n\n\n**Args**:\n - `resourceLabel` (`string`): The name label of the block to update.\n - `value` (`bool`): The value to set for the `assignment_required` field.\n', args=[]), + withAssignmentRequired(resourceLabel, value): { + resource+: { + aws_ssoadmin_application_assignment_configuration+: { + [resourceLabel]+: { + assignment_required: value, + }, + }, + }, + }, +} diff --git a/docs/5.x/README.md b/docs/5.x/README.md index eab09a80..ecc1a867 100644 --- a/docs/5.x/README.md +++ b/docs/5.x/README.md @@ -246,6 +246,7 @@ project. * [codedeploy_app](codedeploy_app.md) * [codedeploy_deployment_config](codedeploy_deployment_config.md) * [codedeploy_deployment_group](codedeploy_deployment_group.md) +* [codeguruprofiler_profiling_group](codeguruprofiler_profiling_group.md) * [codegurureviewer_repository_association](codegurureviewer_repository_association.md) * [codepipeline](codepipeline.md) * [codepipeline_custom_action_type](codepipeline_custom_action_type.md) @@ -300,6 +301,8 @@ project. * [controltower_control](controltower_control.md) * [cur_report_definition](cur_report_definition.md) * [customer_gateway](customer_gateway.md) +* [customerprofiles_domain](customerprofiles_domain.md) +* [customerprofiles_profile](customerprofiles_profile.md) * [data](data/index.md) * [dataexchange_data_set](dataexchange_data_set.md) * [dataexchange_revision](dataexchange_revision.md) @@ -710,6 +713,8 @@ project. * [lb_ssl_negotiation_policy](lb_ssl_negotiation_policy.md) * [lb_target_group](lb_target_group.md) * [lb_target_group_attachment](lb_target_group_attachment.md) +* [lb_trust_store](lb_trust_store.md) +* [lb_trust_store_revocation](lb_trust_store_revocation.md) * [lex_bot](lex_bot.md) * [lex_bot_alias](lex_bot_alias.md) * [lex_intent](lex_intent.md) @@ -1085,6 +1090,7 @@ project. * [securityhub_product_subscription](securityhub_product_subscription.md) * [securityhub_standards_control](securityhub_standards_control.md) * [securityhub_standards_subscription](securityhub_standards_subscription.md) +* [securitylake_data_lake](securitylake_data_lake.md) * [serverlessapplicationrepository_cloudformation_stack](serverlessapplicationrepository_cloudformation_stack.md) * [service_discovery_http_namespace](service_discovery_http_namespace.md) * [service_discovery_instance](service_discovery_instance.md) @@ -1175,6 +1181,9 @@ project. * [ssmincidents_replication_set](ssmincidents_replication_set.md) * [ssmincidents_response_plan](ssmincidents_response_plan.md) * [ssoadmin_account_assignment](ssoadmin_account_assignment.md) +* [ssoadmin_application](ssoadmin_application.md) +* [ssoadmin_application_assignment](ssoadmin_application_assignment.md) +* [ssoadmin_application_assignment_configuration](ssoadmin_application_assignment_configuration.md) * [ssoadmin_customer_managed_policy_attachment](ssoadmin_customer_managed_policy_attachment.md) * [ssoadmin_instance_access_control_attributes](ssoadmin_instance_access_control_attributes.md) * [ssoadmin_managed_policy_attachment](ssoadmin_managed_policy_attachment.md) diff --git a/docs/5.x/alb.md b/docs/5.x/alb.md index bad4cbb1..155ba2fd 100644 --- a/docs/5.x/alb.md +++ b/docs/5.x/alb.md @@ -27,6 +27,7 @@ This package contains functions and utilities for setting up the resource using * [`fn withEnableTlsVersionAndCipherSuiteHeaders()`](#fn-withenabletlsversionandciphersuiteheaders) * [`fn withEnableWafFailOpen()`](#fn-withenablewaffailopen) * [`fn withEnableXffClientPort()`](#fn-withenablexffclientport) +* [`fn withEnforceSecurityGroupInboundRulesOnPrivateLinkTraffic()`](#fn-withenforcesecuritygroupinboundrulesonprivatelinktraffic) * [`fn withIdleTimeout()`](#fn-withidletimeout) * [`fn withInternal()`](#fn-withinternal) * [`fn withIpAddressType()`](#fn-withipaddresstype) @@ -89,6 +90,7 @@ or `$` to refer to the root object. Instead, make an explicit outer object using - `enable_tls_version_and_cipher_suite_headers` (`bool`): Set the `enable_tls_version_and_cipher_suite_headers` field on the resulting resource block. When `null`, the `enable_tls_version_and_cipher_suite_headers` field will be omitted from the resulting object. - `enable_waf_fail_open` (`bool`): Set the `enable_waf_fail_open` field on the resulting resource block. When `null`, the `enable_waf_fail_open` field will be omitted from the resulting object. - `enable_xff_client_port` (`bool`): Set the `enable_xff_client_port` field on the resulting resource block. When `null`, the `enable_xff_client_port` field will be omitted from the resulting object. + - `enforce_security_group_inbound_rules_on_private_link_traffic` (`string`): Set the `enforce_security_group_inbound_rules_on_private_link_traffic` field on the resulting resource block. When `null`, the `enforce_security_group_inbound_rules_on_private_link_traffic` field will be omitted from the resulting object. - `idle_timeout` (`number`): Set the `idle_timeout` field on the resulting resource block. When `null`, the `idle_timeout` field will be omitted from the resulting object. - `internal` (`bool`): Set the `internal` field on the resulting resource block. When `null`, the `internal` field will be omitted from the resulting object. - `ip_address_type` (`string`): Set the `ip_address_type` field on the resulting resource block. When `null`, the `ip_address_type` field will be omitted from the resulting object. @@ -137,6 +139,7 @@ injecting into a complete block. - `enable_tls_version_and_cipher_suite_headers` (`bool`): Set the `enable_tls_version_and_cipher_suite_headers` field on the resulting object. When `null`, the `enable_tls_version_and_cipher_suite_headers` field will be omitted from the resulting object. - `enable_waf_fail_open` (`bool`): Set the `enable_waf_fail_open` field on the resulting object. When `null`, the `enable_waf_fail_open` field will be omitted from the resulting object. - `enable_xff_client_port` (`bool`): Set the `enable_xff_client_port` field on the resulting object. When `null`, the `enable_xff_client_port` field will be omitted from the resulting object. + - `enforce_security_group_inbound_rules_on_private_link_traffic` (`string`): Set the `enforce_security_group_inbound_rules_on_private_link_traffic` field on the resulting object. When `null`, the `enforce_security_group_inbound_rules_on_private_link_traffic` field will be omitted from the resulting object. - `idle_timeout` (`number`): Set the `idle_timeout` field on the resulting object. When `null`, the `idle_timeout` field will be omitted from the resulting object. - `internal` (`bool`): Set the `internal` field on the resulting object. When `null`, the `internal` field will be omitted from the resulting object. - `ip_address_type` (`string`): Set the `ip_address_type` field on the resulting object. When `null`, the `ip_address_type` field will be omitted from the resulting object. @@ -354,6 +357,22 @@ Terraform resource block to set or update the enable_xff_client_port field. - `value` (`bool`): The value to set for the `enable_xff_client_port` field. +### fn withEnforceSecurityGroupInboundRulesOnPrivateLinkTraffic + +```ts +withEnforceSecurityGroupInboundRulesOnPrivateLinkTraffic() +``` + +`aws.string.withEnforceSecurityGroupInboundRulesOnPrivateLinkTraffic` constructs a mixin object that can be merged into the `string` +Terraform resource block to set or update the enforce_security_group_inbound_rules_on_private_link_traffic field. + + + +**Args**: + - `resourceLabel` (`string`): The name label of the block to update. + - `value` (`string`): The value to set for the `enforce_security_group_inbound_rules_on_private_link_traffic` field. + + ### fn withIdleTimeout ```ts diff --git a/docs/5.x/alb_listener.md b/docs/5.x/alb_listener.md index 3f10ee88..e2120ae6 100644 --- a/docs/5.x/alb_listener.md +++ b/docs/5.x/alb_listener.md @@ -20,6 +20,8 @@ This package contains functions and utilities for setting up the resource using * [`fn withDefaultAction()`](#fn-withdefaultaction) * [`fn withDefaultActionMixin()`](#fn-withdefaultactionmixin) * [`fn withLoadBalancerArn()`](#fn-withloadbalancerarn) +* [`fn withMutualAuthentication()`](#fn-withmutualauthentication) +* [`fn withMutualAuthenticationMixin()`](#fn-withmutualauthenticationmixin) * [`fn withPort()`](#fn-withport) * [`fn withProtocol()`](#fn-withprotocol) * [`fn withSslPolicy()`](#fn-withsslpolicy) @@ -43,6 +45,8 @@ This package contains functions and utilities for setting up the resource using * [`fn new()`](#fn-default_actionforwardtarget_groupnew) * [`obj default_action.redirect`](#obj-default_actionredirect) * [`fn new()`](#fn-default_actionredirectnew) +* [`obj mutual_authentication`](#obj-mutual_authentication) + * [`fn new()`](#fn-mutual_authenticationnew) * [`obj timeouts`](#obj-timeouts) * [`fn new()`](#fn-timeoutsnew) @@ -84,6 +88,7 @@ or `$` to refer to the root object. Instead, make an explicit outer object using - `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. - `default_action` (`list[obj]`): Set the `default_action` field on the resulting resource block. When `null`, the `default_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.alb_listener.default_action.new](#fn-default_actionnew) constructor. + - `mutual_authentication` (`list[obj]`): Set the `mutual_authentication` field on the resulting resource block. When `null`, the `mutual_authentication` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [aws.alb_listener.mutual_authentication.new](#fn-mutual_authenticationnew) constructor. - `timeouts` (`obj`): Set the `timeouts` field on the resulting resource block. When `null`, the `timeouts` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [aws.alb_listener.timeouts.new](#fn-timeoutsnew) constructor. **Returns**: @@ -117,6 +122,7 @@ injecting into a complete block. - `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. - `default_action` (`list[obj]`): Set the `default_action` field on the resulting object. When `null`, the `default_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.alb_listener.default_action.new](#fn-default_actionnew) constructor. + - `mutual_authentication` (`list[obj]`): Set the `mutual_authentication` field on the resulting object. When `null`, the `mutual_authentication` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [aws.alb_listener.mutual_authentication.new](#fn-mutual_authenticationnew) constructor. - `timeouts` (`obj`): Set the `timeouts` field on the resulting object. When `null`, the `timeouts` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [aws.alb_listener.timeouts.new](#fn-timeoutsnew) constructor. **Returns**: @@ -208,6 +214,43 @@ Terraform resource block to set or update the load_balancer_arn field. - `value` (`string`): The value to set for the `load_balancer_arn` field. +### fn withMutualAuthentication + +```ts +withMutualAuthentication() +``` + +`aws.list[obj].withMutualAuthentication` constructs a mixin object that can be merged into the `list[obj]` +Terraform resource block to set or update the mutual_authentication 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].withMutualAuthenticationMixin](TODO) function. + + +**Args**: + - `resourceLabel` (`string`): The name label of the block to update. + - `value` (`list[obj]`): The value to set for the `mutual_authentication` field. + + +### fn withMutualAuthenticationMixin + +```ts +withMutualAuthenticationMixin() +``` + +`aws.list[obj].withMutualAuthenticationMixin` constructs a mixin object that can be merged into the `list[obj]` +Terraform resource block to set or update the mutual_authentication 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].withMutualAuthentication](TODO) +function. + + +**Args**: + - `resourceLabel` (`string`): The name label of the block to update. + - `value` (`list[obj]`): The value to set for the `mutual_authentication` field. + + ### fn withPort ```ts @@ -542,6 +585,31 @@ Terraform sub block. - An attribute object that represents the `redirect` sub block. +## obj mutual_authentication + + + +### fn mutual_authentication.new + +```ts +new() +``` + + +`aws.alb_listener.mutual_authentication.new` constructs a new object with attributes and blocks configured for the `mutual_authentication` +Terraform sub block. + + + +**Args**: + - `ignore_client_certificate_expiry` (`bool`): Set the `ignore_client_certificate_expiry` field on the resulting object. When `null`, the `ignore_client_certificate_expiry` field will be omitted from the resulting object. + - `mode` (`string`): Set the `mode` field on the resulting object. + - `trust_store_arn` (`string`): Set the `trust_store_arn` field on the resulting object. When `null`, the `trust_store_arn` field will be omitted from the resulting object. + +**Returns**: + - An attribute object that represents the `mutual_authentication` sub block. + + ## obj timeouts @@ -559,7 +627,8 @@ Terraform sub block. **Args**: - - `read` (`string`): Set the `read` field on the resulting object. When `null`, the `read` field will be omitted from the resulting object. + - `create` (`string`): Set the `create` field on the resulting object. When `null`, the `create` 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/appconfig_configuration_profile.md b/docs/5.x/appconfig_configuration_profile.md index 68fa8490..a5a9ab63 100644 --- a/docs/5.x/appconfig_configuration_profile.md +++ b/docs/5.x/appconfig_configuration_profile.md @@ -17,6 +17,7 @@ This package contains functions and utilities for setting up the resource using * [`fn newAttrs()`](#fn-newattrs) * [`fn withApplicationId()`](#fn-withapplicationid) * [`fn withDescription()`](#fn-withdescription) +* [`fn withKmsKeyIdentifier()`](#fn-withkmskeyidentifier) * [`fn withLocationUri()`](#fn-withlocationuri) * [`fn withName()`](#fn-withname) * [`fn withRetrievalRoleArn()`](#fn-withretrievalrolearn) @@ -59,6 +60,7 @@ or `$` to refer to the root object. Instead, make an explicit outer object using - `resourceLabel` (`string`): The name label of the block. - `application_id` (`string`): Set the `application_id` field on the resulting resource block. - `description` (`string`): Set the `description` field on the resulting resource block. When `null`, the `description` field will be omitted from the resulting object. + - `kms_key_identifier` (`string`): Set the `kms_key_identifier` field on the resulting resource block. When `null`, the `kms_key_identifier` field will be omitted from the resulting object. - `location_uri` (`string`): Set the `location_uri` field on the resulting resource block. - `name` (`string`): Set the `name` field on the resulting resource block. - `retrieval_role_arn` (`string`): Set the `retrieval_role_arn` field on the resulting resource block. When `null`, the `retrieval_role_arn` field will be omitted from the resulting object. @@ -91,6 +93,7 @@ injecting into a complete block. **Args**: - `application_id` (`string`): Set the `application_id` field on the resulting object. - `description` (`string`): Set the `description` field on the resulting object. When `null`, the `description` field will be omitted from the resulting object. + - `kms_key_identifier` (`string`): Set the `kms_key_identifier` field on the resulting object. When `null`, the `kms_key_identifier` field will be omitted from the resulting object. - `location_uri` (`string`): Set the `location_uri` field on the resulting object. - `name` (`string`): Set the `name` field on the resulting object. - `retrieval_role_arn` (`string`): Set the `retrieval_role_arn` field on the resulting object. When `null`, the `retrieval_role_arn` field will be omitted from the resulting object. @@ -135,6 +138,22 @@ Terraform resource block to set or update the description field. - `value` (`string`): The value to set for the `description` field. +### fn withKmsKeyIdentifier + +```ts +withKmsKeyIdentifier() +``` + +`aws.string.withKmsKeyIdentifier` constructs a mixin object that can be merged into the `string` +Terraform resource block to set or update the kms_key_identifier field. + + + +**Args**: + - `resourceLabel` (`string`): The name label of the block to update. + - `value` (`string`): The value to set for the `kms_key_identifier` field. + + ### fn withLocationUri ```ts diff --git a/docs/5.x/appconfig_deployment.md b/docs/5.x/appconfig_deployment.md index fe5f1f14..163fa009 100644 --- a/docs/5.x/appconfig_deployment.md +++ b/docs/5.x/appconfig_deployment.md @@ -21,6 +21,7 @@ This package contains functions and utilities for setting up the resource using * [`fn withDeploymentStrategyId()`](#fn-withdeploymentstrategyid) * [`fn withDescription()`](#fn-withdescription) * [`fn withEnvironmentId()`](#fn-withenvironmentid) +* [`fn withKmsKeyIdentifier()`](#fn-withkmskeyidentifier) * [`fn withTags()`](#fn-withtags) * [`fn withTagsAll()`](#fn-withtagsall) @@ -59,6 +60,7 @@ or `$` to refer to the root object. Instead, make an explicit outer object using - `deployment_strategy_id` (`string`): Set the `deployment_strategy_id` field on the resulting resource block. - `description` (`string`): Set the `description` field on the resulting resource block. When `null`, the `description` field will be omitted from the resulting object. - `environment_id` (`string`): Set the `environment_id` field on the resulting resource block. + - `kms_key_identifier` (`string`): Set the `kms_key_identifier` field on the resulting resource block. When `null`, the `kms_key_identifier` 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. @@ -90,6 +92,7 @@ injecting into a complete block. - `deployment_strategy_id` (`string`): Set the `deployment_strategy_id` field on the resulting object. - `description` (`string`): Set the `description` field on the resulting object. When `null`, the `description` field will be omitted from the resulting object. - `environment_id` (`string`): Set the `environment_id` field on the resulting object. + - `kms_key_identifier` (`string`): Set the `kms_key_identifier` field on the resulting object. When `null`, the `kms_key_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. - `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. @@ -193,6 +196,22 @@ Terraform resource block to set or update the environment_id field. - `value` (`string`): The value to set for the `environment_id` field. +### fn withKmsKeyIdentifier + +```ts +withKmsKeyIdentifier() +``` + +`aws.string.withKmsKeyIdentifier` constructs a mixin object that can be merged into the `string` +Terraform resource block to set or update the kms_key_identifier field. + + + +**Args**: + - `resourceLabel` (`string`): The name label of the block to update. + - `value` (`string`): The value to set for the `kms_key_identifier` field. + + ### fn withTags ```ts diff --git a/docs/5.x/appflow_flow.md b/docs/5.x/appflow_flow.md index 54e7c9a7..e9da5856 100644 --- a/docs/5.x/appflow_flow.md +++ b/docs/5.x/appflow_flow.md @@ -1491,7 +1491,7 @@ Terraform sub block. **Args**: - `bucket_name` (`string`): Set the `bucket_name` field on the resulting object. - - `bucket_prefix` (`string`): Set the `bucket_prefix` field on the resulting object. When `null`, the `bucket_prefix` field will be omitted from the resulting object. + - `bucket_prefix` (`string`): Set the `bucket_prefix` field on the resulting object. - `s3_input_format_config` (`list[obj]`): Set the `s3_input_format_config` field on the resulting object. When `null`, the `s3_input_format_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.appflow_flow.source_flow_config.source_connector_properties.s3.s3_input_format_config.new](#fn-source_flow_configsource_flow_configsource_connector_propertiess3_input_format_confignew) constructor. **Returns**: diff --git a/docs/5.x/cloudwatch_log_group.md b/docs/5.x/cloudwatch_log_group.md index 8721bf32..a3477759 100644 --- a/docs/5.x/cloudwatch_log_group.md +++ b/docs/5.x/cloudwatch_log_group.md @@ -16,6 +16,7 @@ This package contains functions and utilities for setting up the resource using * [`fn new()`](#fn-new) * [`fn newAttrs()`](#fn-newattrs) * [`fn withKmsKeyId()`](#fn-withkmskeyid) +* [`fn withLogGroupClass()`](#fn-withloggroupclass) * [`fn withName()`](#fn-withname) * [`fn withNamePrefix()`](#fn-withnameprefix) * [`fn withRetentionInDays()`](#fn-withretentionindays) @@ -53,6 +54,7 @@ or `$` to refer to the root object. Instead, make an explicit outer object using **Args**: - `resourceLabel` (`string`): The name label of the block. - `kms_key_id` (`string`): Set the `kms_key_id` field on the resulting resource block. When `null`, the `kms_key_id` field will be omitted from the resulting object. + - `log_group_class` (`string`): Set the `log_group_class` field on the resulting resource block. When `null`, the `log_group_class` field will be omitted from the resulting object. - `name` (`string`): Set the `name` field on the resulting resource block. When `null`, the `name` field will be omitted from the resulting object. - `name_prefix` (`string`): Set the `name_prefix` field on the resulting resource block. When `null`, the `name_prefix` field will be omitted from the resulting object. - `retention_in_days` (`number`): Set the `retention_in_days` field on the resulting resource block. When `null`, the `retention_in_days` field will be omitted from the resulting object. @@ -83,6 +85,7 @@ injecting into a complete block. **Args**: - `kms_key_id` (`string`): Set the `kms_key_id` field on the resulting object. When `null`, the `kms_key_id` field will be omitted from the resulting object. + - `log_group_class` (`string`): Set the `log_group_class` field on the resulting object. When `null`, the `log_group_class` field will be omitted from the resulting object. - `name` (`string`): Set the `name` field on the resulting object. When `null`, the `name` field will be omitted from the resulting object. - `name_prefix` (`string`): Set the `name_prefix` field on the resulting object. When `null`, the `name_prefix` field will be omitted from the resulting object. - `retention_in_days` (`number`): Set the `retention_in_days` field on the resulting object. When `null`, the `retention_in_days` field will be omitted from the resulting object. @@ -110,6 +113,22 @@ Terraform resource block to set or update the kms_key_id field. - `value` (`string`): The value to set for the `kms_key_id` field. +### fn withLogGroupClass + +```ts +withLogGroupClass() +``` + +`aws.string.withLogGroupClass` constructs a mixin object that can be merged into the `string` +Terraform resource block to set or update the log_group_class field. + + + +**Args**: + - `resourceLabel` (`string`): The name label of the block to update. + - `value` (`string`): The value to set for the `log_group_class` field. + + ### fn withName ```ts diff --git a/docs/5.x/codeguruprofiler_profiling_group.md b/docs/5.x/codeguruprofiler_profiling_group.md new file mode 100644 index 00000000..04987da6 --- /dev/null +++ b/docs/5.x/codeguruprofiler_profiling_group.md @@ -0,0 +1,196 @@ +--- +permalink: /codeguruprofiler_profiling_group/ +--- + +# codeguruprofiler_profiling_group + +`codeguruprofiler_profiling_group` represents the `aws_codeguruprofiler_profiling_group` 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 withAgentOrchestrationConfig()`](#fn-withagentorchestrationconfig) +* [`fn withAgentOrchestrationConfigMixin()`](#fn-withagentorchestrationconfigmixin) +* [`fn withComputePlatform()`](#fn-withcomputeplatform) +* [`fn withName()`](#fn-withname) +* [`fn withTags()`](#fn-withtags) +* [`obj agent_orchestration_config`](#obj-agent_orchestration_config) + * [`fn new()`](#fn-agent_orchestration_confignew) + +## Fields + +### fn new + +```ts +new() +``` + + +`aws.codeguruprofiler_profiling_group.new` injects a new `aws_codeguruprofiler_profiling_group` 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.codeguruprofiler_profiling_group.new('some_id') + +You can get the reference to the `id` field of the created `aws.codeguruprofiler_profiling_group` using the reference: + + $._ref.aws_codeguruprofiler_profiling_group.some_id.get('id') + +This is the same as directly entering `"${ aws_codeguruprofiler_profiling_group.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. + - `compute_platform` (`string`): Set the `compute_platform` field on the resulting resource block. When `null`, the `compute_platform` field will be omitted from the resulting object. + - `name` (`string`): Set the `name` field on the resulting resource block. + - `tags` (`obj`): Set the `tags` field on the resulting resource block. When `null`, the `tags` field will be omitted from the resulting object. + - `agent_orchestration_config` (`list[obj]`): Set the `agent_orchestration_config` field on the resulting resource block. When `null`, the `agent_orchestration_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.codeguruprofiler_profiling_group.agent_orchestration_config.new](#fn-agent_orchestration_confignew) constructor. + +**Returns**: +- A mixin object that injects the new resource into the root Terraform configuration. + + +### fn newAttrs + +```ts +newAttrs() +``` + + +`aws.codeguruprofiler_profiling_group.newAttrs` constructs a new object with attributes and blocks configured for the `codeguruprofiler_profiling_group` +Terraform resource. + +Unlike [aws.codeguruprofiler_profiling_group.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**: + - `compute_platform` (`string`): Set the `compute_platform` field on the resulting object. When `null`, the `compute_platform` field will be omitted from the resulting object. + - `name` (`string`): Set the `name` field on the resulting object. + - `tags` (`obj`): Set the `tags` field on the resulting object. When `null`, the `tags` field will be omitted from the resulting object. + - `agent_orchestration_config` (`list[obj]`): Set the `agent_orchestration_config` field on the resulting object. When `null`, the `agent_orchestration_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.codeguruprofiler_profiling_group.agent_orchestration_config.new](#fn-agent_orchestration_confignew) constructor. + +**Returns**: + - An attribute object that can be used with [tf.withResource](https://github.com/tf-libsonnet/core/tree/main/docs#fn-withresource) to construct a new `codeguruprofiler_profiling_group` resource into the root Terraform configuration. + + +### fn withAgentOrchestrationConfig + +```ts +withAgentOrchestrationConfig() +``` + +`aws.list[obj].withAgentOrchestrationConfig` constructs a mixin object that can be merged into the `list[obj]` +Terraform resource block to set or update the agent_orchestration_config field. + +This function will replace the array with the passed in `value`. If you wish to instead append the +passed in value to the existing array, use the [aws.list[obj].withAgentOrchestrationConfigMixin](TODO) function. + + +**Args**: + - `resourceLabel` (`string`): The name label of the block to update. + - `value` (`list[obj]`): The value to set for the `agent_orchestration_config` field. + + +### fn withAgentOrchestrationConfigMixin + +```ts +withAgentOrchestrationConfigMixin() +``` + +`aws.list[obj].withAgentOrchestrationConfigMixin` constructs a mixin object that can be merged into the `list[obj]` +Terraform resource block to set or update the agent_orchestration_config field. + +This function will append the passed in array or object to the existing array. If you wish +to instead replace the array with the passed in `value`, use the [aws.list[obj].withAgentOrchestrationConfig](TODO) +function. + + +**Args**: + - `resourceLabel` (`string`): The name label of the block to update. + - `value` (`list[obj]`): The value to set for the `agent_orchestration_config` field. + + +### fn withComputePlatform + +```ts +withComputePlatform() +``` + +`aws.string.withComputePlatform` constructs a mixin object that can be merged into the `string` +Terraform resource block to set or update the compute_platform field. + + + +**Args**: + - `resourceLabel` (`string`): The name label of the block to update. + - `value` (`string`): The value to set for the `compute_platform` field. + + +### fn withName + +```ts +withName() +``` + +`aws.string.withName` constructs a mixin object that can be merged into the `string` +Terraform resource block to set or update the name field. + + + +**Args**: + - `resourceLabel` (`string`): The name label of the block to update. + - `value` (`string`): The value to set for the `name` field. + + +### fn withTags + +```ts +withTags() +``` + +`aws.obj.withTags` constructs a mixin object that can be merged into the `obj` +Terraform resource block to set or update the tags field. + + + +**Args**: + - `resourceLabel` (`string`): The name label of the block to update. + - `value` (`obj`): The value to set for the `tags` field. + + +## obj agent_orchestration_config + + + +### fn agent_orchestration_config.new + +```ts +new() +``` + + +`aws.codeguruprofiler_profiling_group.agent_orchestration_config.new` constructs a new object with attributes and blocks configured for the `agent_orchestration_config` +Terraform sub block. + + + +**Args**: + - `profiling_enabled` (`bool`): Set the `profiling_enabled` field on the resulting object. + +**Returns**: + - An attribute object that represents the `agent_orchestration_config` sub block. diff --git a/docs/5.x/customerprofiles_domain.md b/docs/5.x/customerprofiles_domain.md new file mode 100644 index 00000000..f25c97e7 --- /dev/null +++ b/docs/5.x/customerprofiles_domain.md @@ -0,0 +1,615 @@ +--- +permalink: /customerprofiles_domain/ +--- + +# customerprofiles_domain + +`customerprofiles_domain` represents the `aws_customerprofiles_domain` 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 withDeadLetterQueueUrl()`](#fn-withdeadletterqueueurl) +* [`fn withDefaultEncryptionKey()`](#fn-withdefaultencryptionkey) +* [`fn withDefaultExpirationDays()`](#fn-withdefaultexpirationdays) +* [`fn withDomainName()`](#fn-withdomainname) +* [`fn withMatching()`](#fn-withmatching) +* [`fn withMatchingMixin()`](#fn-withmatchingmixin) +* [`fn withRuleBasedMatching()`](#fn-withrulebasedmatching) +* [`fn withRuleBasedMatchingMixin()`](#fn-withrulebasedmatchingmixin) +* [`fn withTags()`](#fn-withtags) +* [`fn withTagsAll()`](#fn-withtagsall) +* [`obj matching`](#obj-matching) + * [`fn new()`](#fn-matchingnew) + * [`obj matching.auto_merging`](#obj-matchingauto_merging) + * [`fn new()`](#fn-matchingauto_mergingnew) + * [`obj matching.auto_merging.conflict_resolution`](#obj-matchingauto_mergingconflict_resolution) + * [`fn new()`](#fn-matchingauto_mergingconflict_resolutionnew) + * [`obj matching.auto_merging.consolidation`](#obj-matchingauto_mergingconsolidation) + * [`fn new()`](#fn-matchingauto_mergingconsolidationnew) + * [`obj matching.exporting_config`](#obj-matchingexporting_config) + * [`fn new()`](#fn-matchingexporting_confignew) + * [`obj matching.exporting_config.s3_exporting`](#obj-matchingexporting_configs3_exporting) + * [`fn new()`](#fn-matchingexporting_configs3_exportingnew) + * [`obj matching.job_schedule`](#obj-matchingjob_schedule) + * [`fn new()`](#fn-matchingjob_schedulenew) +* [`obj rule_based_matching`](#obj-rule_based_matching) + * [`fn new()`](#fn-rule_based_matchingnew) + * [`obj rule_based_matching.attribute_types_selector`](#obj-rule_based_matchingattribute_types_selector) + * [`fn new()`](#fn-rule_based_matchingattribute_types_selectornew) + * [`obj rule_based_matching.conflict_resolution`](#obj-rule_based_matchingconflict_resolution) + * [`fn new()`](#fn-rule_based_matchingconflict_resolutionnew) + * [`obj rule_based_matching.exporting_config`](#obj-rule_based_matchingexporting_config) + * [`fn new()`](#fn-rule_based_matchingexporting_confignew) + * [`obj rule_based_matching.exporting_config.s3_exporting`](#obj-rule_based_matchingexporting_configs3_exporting) + * [`fn new()`](#fn-rule_based_matchingexporting_configs3_exportingnew) + * [`obj rule_based_matching.matching_rules`](#obj-rule_based_matchingmatching_rules) + * [`fn new()`](#fn-rule_based_matchingmatching_rulesnew) + +## Fields + +### fn new + +```ts +new() +``` + + +`aws.customerprofiles_domain.new` injects a new `aws_customerprofiles_domain` 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.customerprofiles_domain.new('some_id') + +You can get the reference to the `id` field of the created `aws.customerprofiles_domain` using the reference: + + $._ref.aws_customerprofiles_domain.some_id.get('id') + +This is the same as directly entering `"${ aws_customerprofiles_domain.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. + - `dead_letter_queue_url` (`string`): Set the `dead_letter_queue_url` field on the resulting resource block. When `null`, the `dead_letter_queue_url` field will be omitted from the resulting object. + - `default_encryption_key` (`string`): Set the `default_encryption_key` field on the resulting resource block. When `null`, the `default_encryption_key` field will be omitted from the resulting object. + - `default_expiration_days` (`number`): Set the `default_expiration_days` field on the resulting resource block. + - `domain_name` (`string`): Set the `domain_name` field on the resulting resource block. + - `tags` (`obj`): Set the `tags` field on the resulting resource block. When `null`, the `tags` field will be omitted from the resulting object. + - `tags_all` (`obj`): Set the `tags_all` field on the resulting resource block. When `null`, the `tags_all` field will be omitted from the resulting object. + - `matching` (`list[obj]`): Set the `matching` field on the resulting resource block. When `null`, the `matching` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [aws.customerprofiles_domain.matching.new](#fn-matchingnew) constructor. + - `rule_based_matching` (`list[obj]`): Set the `rule_based_matching` field on the resulting resource block. When `null`, the `rule_based_matching` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [aws.customerprofiles_domain.rule_based_matching.new](#fn-rule_based_matchingnew) constructor. + +**Returns**: +- A mixin object that injects the new resource into the root Terraform configuration. + + +### fn newAttrs + +```ts +newAttrs() +``` + + +`aws.customerprofiles_domain.newAttrs` constructs a new object with attributes and blocks configured for the `customerprofiles_domain` +Terraform resource. + +Unlike [aws.customerprofiles_domain.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**: + - `dead_letter_queue_url` (`string`): Set the `dead_letter_queue_url` field on the resulting object. When `null`, the `dead_letter_queue_url` field will be omitted from the resulting object. + - `default_encryption_key` (`string`): Set the `default_encryption_key` field on the resulting object. When `null`, the `default_encryption_key` field will be omitted from the resulting object. + - `default_expiration_days` (`number`): Set the `default_expiration_days` field on the resulting object. + - `domain_name` (`string`): Set the `domain_name` field on the resulting object. + - `tags` (`obj`): Set the `tags` field on the resulting object. When `null`, the `tags` field will be omitted from the resulting object. + - `tags_all` (`obj`): Set the `tags_all` field on the resulting object. When `null`, the `tags_all` field will be omitted from the resulting object. + - `matching` (`list[obj]`): Set the `matching` field on the resulting object. When `null`, the `matching` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [aws.customerprofiles_domain.matching.new](#fn-matchingnew) constructor. + - `rule_based_matching` (`list[obj]`): Set the `rule_based_matching` field on the resulting object. When `null`, the `rule_based_matching` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [aws.customerprofiles_domain.rule_based_matching.new](#fn-rule_based_matchingnew) 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 `customerprofiles_domain` resource into the root Terraform configuration. + + +### fn withDeadLetterQueueUrl + +```ts +withDeadLetterQueueUrl() +``` + +`aws.string.withDeadLetterQueueUrl` constructs a mixin object that can be merged into the `string` +Terraform resource block to set or update the dead_letter_queue_url field. + + + +**Args**: + - `resourceLabel` (`string`): The name label of the block to update. + - `value` (`string`): The value to set for the `dead_letter_queue_url` field. + + +### fn withDefaultEncryptionKey + +```ts +withDefaultEncryptionKey() +``` + +`aws.string.withDefaultEncryptionKey` constructs a mixin object that can be merged into the `string` +Terraform resource block to set or update the default_encryption_key field. + + + +**Args**: + - `resourceLabel` (`string`): The name label of the block to update. + - `value` (`string`): The value to set for the `default_encryption_key` field. + + +### fn withDefaultExpirationDays + +```ts +withDefaultExpirationDays() +``` + +`aws.number.withDefaultExpirationDays` constructs a mixin object that can be merged into the `number` +Terraform resource block to set or update the default_expiration_days field. + + + +**Args**: + - `resourceLabel` (`string`): The name label of the block to update. + - `value` (`number`): The value to set for the `default_expiration_days` field. + + +### fn withDomainName + +```ts +withDomainName() +``` + +`aws.string.withDomainName` constructs a mixin object that can be merged into the `string` +Terraform resource block to set or update the domain_name field. + + + +**Args**: + - `resourceLabel` (`string`): The name label of the block to update. + - `value` (`string`): The value to set for the `domain_name` field. + + +### fn withMatching + +```ts +withMatching() +``` + +`aws.list[obj].withMatching` constructs a mixin object that can be merged into the `list[obj]` +Terraform resource block to set or update the matching 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].withMatchingMixin](TODO) function. + + +**Args**: + - `resourceLabel` (`string`): The name label of the block to update. + - `value` (`list[obj]`): The value to set for the `matching` field. + + +### fn withMatchingMixin + +```ts +withMatchingMixin() +``` + +`aws.list[obj].withMatchingMixin` constructs a mixin object that can be merged into the `list[obj]` +Terraform resource block to set or update the matching 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].withMatching](TODO) +function. + + +**Args**: + - `resourceLabel` (`string`): The name label of the block to update. + - `value` (`list[obj]`): The value to set for the `matching` field. + + +### fn withRuleBasedMatching + +```ts +withRuleBasedMatching() +``` + +`aws.list[obj].withRuleBasedMatching` constructs a mixin object that can be merged into the `list[obj]` +Terraform resource block to set or update the rule_based_matching 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].withRuleBasedMatchingMixin](TODO) function. + + +**Args**: + - `resourceLabel` (`string`): The name label of the block to update. + - `value` (`list[obj]`): The value to set for the `rule_based_matching` field. + + +### fn withRuleBasedMatchingMixin + +```ts +withRuleBasedMatchingMixin() +``` + +`aws.list[obj].withRuleBasedMatchingMixin` constructs a mixin object that can be merged into the `list[obj]` +Terraform resource block to set or update the rule_based_matching 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].withRuleBasedMatching](TODO) +function. + + +**Args**: + - `resourceLabel` (`string`): The name label of the block to update. + - `value` (`list[obj]`): The value to set for the `rule_based_matching` 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 matching + + + +### fn matching.new + +```ts +new() +``` + + +`aws.customerprofiles_domain.matching.new` constructs a new object with attributes and blocks configured for the `matching` +Terraform sub block. + + + +**Args**: + - `enabled` (`bool`): Set the `enabled` field on the resulting object. + - `auto_merging` (`list[obj]`): Set the `auto_merging` field on the resulting object. When `null`, the `auto_merging` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [aws.customerprofiles_domain.matching.auto_merging.new](#fn-matchingauto_mergingnew) constructor. + - `exporting_config` (`list[obj]`): Set the `exporting_config` field on the resulting object. When `null`, the `exporting_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.customerprofiles_domain.matching.exporting_config.new](#fn-matchingexporting_confignew) constructor. + - `job_schedule` (`list[obj]`): Set the `job_schedule` field on the resulting object. When `null`, the `job_schedule` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [aws.customerprofiles_domain.matching.job_schedule.new](#fn-matchingjob_schedulenew) constructor. + +**Returns**: + - An attribute object that represents the `matching` sub block. + + +## obj matching.auto_merging + + + +### fn matching.auto_merging.new + +```ts +new() +``` + + +`aws.customerprofiles_domain.matching.auto_merging.new` constructs a new object with attributes and blocks configured for the `auto_merging` +Terraform sub block. + + + +**Args**: + - `enabled` (`bool`): Set the `enabled` field on the resulting object. + - `min_allowed_confidence_score_for_merging` (`number`): Set the `min_allowed_confidence_score_for_merging` field on the resulting object. When `null`, the `min_allowed_confidence_score_for_merging` field will be omitted from the resulting object. + - `conflict_resolution` (`list[obj]`): Set the `conflict_resolution` field on the resulting object. When `null`, the `conflict_resolution` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [aws.customerprofiles_domain.matching.auto_merging.conflict_resolution.new](#fn-matchingmatchingconflict_resolutionnew) constructor. + - `consolidation` (`list[obj]`): Set the `consolidation` field on the resulting object. When `null`, the `consolidation` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [aws.customerprofiles_domain.matching.auto_merging.consolidation.new](#fn-matchingmatchingconsolidationnew) constructor. + +**Returns**: + - An attribute object that represents the `auto_merging` sub block. + + +## obj matching.auto_merging.conflict_resolution + + + +### fn matching.auto_merging.conflict_resolution.new + +```ts +new() +``` + + +`aws.customerprofiles_domain.matching.auto_merging.conflict_resolution.new` constructs a new object with attributes and blocks configured for the `conflict_resolution` +Terraform sub block. + + + +**Args**: + - `conflict_resolving_model` (`string`): Set the `conflict_resolving_model` field on the resulting object. + - `source_name` (`string`): Set the `source_name` field on the resulting object. When `null`, the `source_name` field will be omitted from the resulting object. + +**Returns**: + - An attribute object that represents the `conflict_resolution` sub block. + + +## obj matching.auto_merging.consolidation + + + +### fn matching.auto_merging.consolidation.new + +```ts +new() +``` + + +`aws.customerprofiles_domain.matching.auto_merging.consolidation.new` constructs a new object with attributes and blocks configured for the `consolidation` +Terraform sub block. + + + +**Args**: + - `matching_attributes_list` (`list`): Set the `matching_attributes_list` field on the resulting object. + +**Returns**: + - An attribute object that represents the `consolidation` sub block. + + +## obj matching.exporting_config + + + +### fn matching.exporting_config.new + +```ts +new() +``` + + +`aws.customerprofiles_domain.matching.exporting_config.new` constructs a new object with attributes and blocks configured for the `exporting_config` +Terraform sub block. + + + +**Args**: + - `s3_exporting` (`list[obj]`): Set the `s3_exporting` field on the resulting object. When `null`, the `s3_exporting` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [aws.customerprofiles_domain.matching.exporting_config.s3_exporting.new](#fn-matchingmatchings3_exportingnew) constructor. + +**Returns**: + - An attribute object that represents the `exporting_config` sub block. + + +## obj matching.exporting_config.s3_exporting + + + +### fn matching.exporting_config.s3_exporting.new + +```ts +new() +``` + + +`aws.customerprofiles_domain.matching.exporting_config.s3_exporting.new` constructs a new object with attributes and blocks configured for the `s3_exporting` +Terraform sub block. + + + +**Args**: + - `s3_bucket_name` (`string`): Set the `s3_bucket_name` field on the resulting object. + - `s3_key_name` (`string`): Set the `s3_key_name` field on the resulting object. When `null`, the `s3_key_name` field will be omitted from the resulting object. + +**Returns**: + - An attribute object that represents the `s3_exporting` sub block. + + +## obj matching.job_schedule + + + +### fn matching.job_schedule.new + +```ts +new() +``` + + +`aws.customerprofiles_domain.matching.job_schedule.new` constructs a new object with attributes and blocks configured for the `job_schedule` +Terraform sub block. + + + +**Args**: + - `day_of_the_week` (`string`): Set the `day_of_the_week` field on the resulting object. + - `time` (`string`): Set the `time` field on the resulting object. + +**Returns**: + - An attribute object that represents the `job_schedule` sub block. + + +## obj rule_based_matching + + + +### fn rule_based_matching.new + +```ts +new() +``` + + +`aws.customerprofiles_domain.rule_based_matching.new` constructs a new object with attributes and blocks configured for the `rule_based_matching` +Terraform sub block. + + + +**Args**: + - `enabled` (`bool`): Set the `enabled` field on the resulting object. + - `max_allowed_rule_level_for_matching` (`number`): Set the `max_allowed_rule_level_for_matching` field on the resulting object. When `null`, the `max_allowed_rule_level_for_matching` field will be omitted from the resulting object. + - `max_allowed_rule_level_for_merging` (`number`): Set the `max_allowed_rule_level_for_merging` field on the resulting object. When `null`, the `max_allowed_rule_level_for_merging` field will be omitted from the resulting object. + - `status` (`string`): Set the `status` field on the resulting object. When `null`, the `status` field will be omitted from the resulting object. + - `attribute_types_selector` (`list[obj]`): Set the `attribute_types_selector` field on the resulting object. When `null`, the `attribute_types_selector` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [aws.customerprofiles_domain.rule_based_matching.attribute_types_selector.new](#fn-rule_based_matchingattribute_types_selectornew) constructor. + - `conflict_resolution` (`list[obj]`): Set the `conflict_resolution` field on the resulting object. When `null`, the `conflict_resolution` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [aws.customerprofiles_domain.rule_based_matching.conflict_resolution.new](#fn-rule_based_matchingconflict_resolutionnew) constructor. + - `exporting_config` (`list[obj]`): Set the `exporting_config` field on the resulting object. When `null`, the `exporting_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.customerprofiles_domain.rule_based_matching.exporting_config.new](#fn-rule_based_matchingexporting_confignew) constructor. + - `matching_rules` (`list[obj]`): Set the `matching_rules` field on the resulting object. When `null`, the `matching_rules` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [aws.customerprofiles_domain.rule_based_matching.matching_rules.new](#fn-rule_based_matchingmatching_rulesnew) constructor. + +**Returns**: + - An attribute object that represents the `rule_based_matching` sub block. + + +## obj rule_based_matching.attribute_types_selector + + + +### fn rule_based_matching.attribute_types_selector.new + +```ts +new() +``` + + +`aws.customerprofiles_domain.rule_based_matching.attribute_types_selector.new` constructs a new object with attributes and blocks configured for the `attribute_types_selector` +Terraform sub block. + + + +**Args**: + - `address` (`list`): Set the `address` field on the resulting object. When `null`, the `address` field will be omitted from the resulting object. + - `attribute_matching_model` (`string`): Set the `attribute_matching_model` field on the resulting object. + - `email_address` (`list`): Set the `email_address` field on the resulting object. When `null`, the `email_address` field will be omitted from the resulting object. + - `phone_number` (`list`): Set the `phone_number` field on the resulting object. When `null`, the `phone_number` field will be omitted from the resulting object. + +**Returns**: + - An attribute object that represents the `attribute_types_selector` sub block. + + +## obj rule_based_matching.conflict_resolution + + + +### fn rule_based_matching.conflict_resolution.new + +```ts +new() +``` + + +`aws.customerprofiles_domain.rule_based_matching.conflict_resolution.new` constructs a new object with attributes and blocks configured for the `conflict_resolution` +Terraform sub block. + + + +**Args**: + - `conflict_resolving_model` (`string`): Set the `conflict_resolving_model` field on the resulting object. + - `source_name` (`string`): Set the `source_name` field on the resulting object. When `null`, the `source_name` field will be omitted from the resulting object. + +**Returns**: + - An attribute object that represents the `conflict_resolution` sub block. + + +## obj rule_based_matching.exporting_config + + + +### fn rule_based_matching.exporting_config.new + +```ts +new() +``` + + +`aws.customerprofiles_domain.rule_based_matching.exporting_config.new` constructs a new object with attributes and blocks configured for the `exporting_config` +Terraform sub block. + + + +**Args**: + - `s3_exporting` (`list[obj]`): Set the `s3_exporting` field on the resulting object. When `null`, the `s3_exporting` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [aws.customerprofiles_domain.rule_based_matching.exporting_config.s3_exporting.new](#fn-rule_based_matchingrule_based_matchings3_exportingnew) constructor. + +**Returns**: + - An attribute object that represents the `exporting_config` sub block. + + +## obj rule_based_matching.exporting_config.s3_exporting + + + +### fn rule_based_matching.exporting_config.s3_exporting.new + +```ts +new() +``` + + +`aws.customerprofiles_domain.rule_based_matching.exporting_config.s3_exporting.new` constructs a new object with attributes and blocks configured for the `s3_exporting` +Terraform sub block. + + + +**Args**: + - `s3_bucket_name` (`string`): Set the `s3_bucket_name` field on the resulting object. + - `s3_key_name` (`string`): Set the `s3_key_name` field on the resulting object. When `null`, the `s3_key_name` field will be omitted from the resulting object. + +**Returns**: + - An attribute object that represents the `s3_exporting` sub block. + + +## obj rule_based_matching.matching_rules + + + +### fn rule_based_matching.matching_rules.new + +```ts +new() +``` + + +`aws.customerprofiles_domain.rule_based_matching.matching_rules.new` constructs a new object with attributes and blocks configured for the `matching_rules` +Terraform sub block. + + + +**Args**: + - `rule` (`list`): Set the `rule` field on the resulting object. + +**Returns**: + - An attribute object that represents the `matching_rules` sub block. diff --git a/docs/5.x/customerprofiles_profile.md b/docs/5.x/customerprofiles_profile.md new file mode 100644 index 00000000..e18293ba --- /dev/null +++ b/docs/5.x/customerprofiles_profile.md @@ -0,0 +1,715 @@ +--- +permalink: /customerprofiles_profile/ +--- + +# customerprofiles_profile + +`customerprofiles_profile` represents the `aws_customerprofiles_profile` 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 withAccountNumber()`](#fn-withaccountnumber) +* [`fn withAdditionalInformation()`](#fn-withadditionalinformation) +* [`fn withAddress()`](#fn-withaddress) +* [`fn withAddressMixin()`](#fn-withaddressmixin) +* [`fn withAttributes()`](#fn-withattributes) +* [`fn withBillingAddress()`](#fn-withbillingaddress) +* [`fn withBillingAddressMixin()`](#fn-withbillingaddressmixin) +* [`fn withBirthDate()`](#fn-withbirthdate) +* [`fn withBusinessEmailAddress()`](#fn-withbusinessemailaddress) +* [`fn withBusinessName()`](#fn-withbusinessname) +* [`fn withBusinessPhoneNumber()`](#fn-withbusinessphonenumber) +* [`fn withDomainName()`](#fn-withdomainname) +* [`fn withEmailAddress()`](#fn-withemailaddress) +* [`fn withFirstName()`](#fn-withfirstname) +* [`fn withGenderString()`](#fn-withgenderstring) +* [`fn withHomePhoneNumber()`](#fn-withhomephonenumber) +* [`fn withLastName()`](#fn-withlastname) +* [`fn withMailingAddress()`](#fn-withmailingaddress) +* [`fn withMailingAddressMixin()`](#fn-withmailingaddressmixin) +* [`fn withMiddleName()`](#fn-withmiddlename) +* [`fn withMobilePhoneNumber()`](#fn-withmobilephonenumber) +* [`fn withPartyTypeString()`](#fn-withpartytypestring) +* [`fn withPersonalEmailAddress()`](#fn-withpersonalemailaddress) +* [`fn withPhoneNumber()`](#fn-withphonenumber) +* [`fn withShippingAddress()`](#fn-withshippingaddress) +* [`fn withShippingAddressMixin()`](#fn-withshippingaddressmixin) +* [`obj address`](#obj-address) + * [`fn new()`](#fn-addressnew) +* [`obj billing_address`](#obj-billing_address) + * [`fn new()`](#fn-billing_addressnew) +* [`obj mailing_address`](#obj-mailing_address) + * [`fn new()`](#fn-mailing_addressnew) +* [`obj shipping_address`](#obj-shipping_address) + * [`fn new()`](#fn-shipping_addressnew) + +## Fields + +### fn new + +```ts +new() +``` + + +`aws.customerprofiles_profile.new` injects a new `aws_customerprofiles_profile` 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.customerprofiles_profile.new('some_id') + +You can get the reference to the `id` field of the created `aws.customerprofiles_profile` using the reference: + + $._ref.aws_customerprofiles_profile.some_id.get('id') + +This is the same as directly entering `"${ aws_customerprofiles_profile.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. + - `account_number` (`string`): Set the `account_number` field on the resulting resource block. When `null`, the `account_number` field will be omitted from the resulting object. + - `additional_information` (`string`): Set the `additional_information` field on the resulting resource block. When `null`, the `additional_information` field will be omitted from the resulting object. + - `attributes` (`obj`): Set the `attributes` field on the resulting resource block. When `null`, the `attributes` field will be omitted from the resulting object. + - `birth_date` (`string`): Set the `birth_date` field on the resulting resource block. When `null`, the `birth_date` field will be omitted from the resulting object. + - `business_email_address` (`string`): Set the `business_email_address` field on the resulting resource block. When `null`, the `business_email_address` field will be omitted from the resulting object. + - `business_name` (`string`): Set the `business_name` field on the resulting resource block. When `null`, the `business_name` field will be omitted from the resulting object. + - `business_phone_number` (`string`): Set the `business_phone_number` field on the resulting resource block. When `null`, the `business_phone_number` field will be omitted from the resulting object. + - `domain_name` (`string`): Set the `domain_name` field on the resulting resource block. + - `email_address` (`string`): Set the `email_address` field on the resulting resource block. When `null`, the `email_address` field will be omitted from the resulting object. + - `first_name` (`string`): Set the `first_name` field on the resulting resource block. When `null`, the `first_name` field will be omitted from the resulting object. + - `gender_string` (`string`): Set the `gender_string` field on the resulting resource block. When `null`, the `gender_string` field will be omitted from the resulting object. + - `home_phone_number` (`string`): Set the `home_phone_number` field on the resulting resource block. When `null`, the `home_phone_number` field will be omitted from the resulting object. + - `last_name` (`string`): Set the `last_name` field on the resulting resource block. When `null`, the `last_name` field will be omitted from the resulting object. + - `middle_name` (`string`): Set the `middle_name` field on the resulting resource block. When `null`, the `middle_name` field will be omitted from the resulting object. + - `mobile_phone_number` (`string`): Set the `mobile_phone_number` field on the resulting resource block. When `null`, the `mobile_phone_number` field will be omitted from the resulting object. + - `party_type_string` (`string`): Set the `party_type_string` field on the resulting resource block. When `null`, the `party_type_string` field will be omitted from the resulting object. + - `personal_email_address` (`string`): Set the `personal_email_address` field on the resulting resource block. When `null`, the `personal_email_address` field will be omitted from the resulting object. + - `phone_number` (`string`): Set the `phone_number` field on the resulting resource block. When `null`, the `phone_number` field will be omitted from the resulting object. + - `address` (`list[obj]`): Set the `address` field on the resulting resource block. When `null`, the `address` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [aws.customerprofiles_profile.address.new](#fn-addressnew) constructor. + - `billing_address` (`list[obj]`): Set the `billing_address` field on the resulting resource block. When `null`, the `billing_address` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [aws.customerprofiles_profile.billing_address.new](#fn-billing_addressnew) constructor. + - `mailing_address` (`list[obj]`): Set the `mailing_address` field on the resulting resource block. When `null`, the `mailing_address` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [aws.customerprofiles_profile.mailing_address.new](#fn-mailing_addressnew) constructor. + - `shipping_address` (`list[obj]`): Set the `shipping_address` field on the resulting resource block. When `null`, the `shipping_address` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [aws.customerprofiles_profile.shipping_address.new](#fn-shipping_addressnew) constructor. + +**Returns**: +- A mixin object that injects the new resource into the root Terraform configuration. + + +### fn newAttrs + +```ts +newAttrs() +``` + + +`aws.customerprofiles_profile.newAttrs` constructs a new object with attributes and blocks configured for the `customerprofiles_profile` +Terraform resource. + +Unlike [aws.customerprofiles_profile.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**: + - `account_number` (`string`): Set the `account_number` field on the resulting object. When `null`, the `account_number` field will be omitted from the resulting object. + - `additional_information` (`string`): Set the `additional_information` field on the resulting object. When `null`, the `additional_information` field will be omitted from the resulting object. + - `attributes` (`obj`): Set the `attributes` field on the resulting object. When `null`, the `attributes` field will be omitted from the resulting object. + - `birth_date` (`string`): Set the `birth_date` field on the resulting object. When `null`, the `birth_date` field will be omitted from the resulting object. + - `business_email_address` (`string`): Set the `business_email_address` field on the resulting object. When `null`, the `business_email_address` field will be omitted from the resulting object. + - `business_name` (`string`): Set the `business_name` field on the resulting object. When `null`, the `business_name` field will be omitted from the resulting object. + - `business_phone_number` (`string`): Set the `business_phone_number` field on the resulting object. When `null`, the `business_phone_number` field will be omitted from the resulting object. + - `domain_name` (`string`): Set the `domain_name` field on the resulting object. + - `email_address` (`string`): Set the `email_address` field on the resulting object. When `null`, the `email_address` field will be omitted from the resulting object. + - `first_name` (`string`): Set the `first_name` field on the resulting object. When `null`, the `first_name` field will be omitted from the resulting object. + - `gender_string` (`string`): Set the `gender_string` field on the resulting object. When `null`, the `gender_string` field will be omitted from the resulting object. + - `home_phone_number` (`string`): Set the `home_phone_number` field on the resulting object. When `null`, the `home_phone_number` field will be omitted from the resulting object. + - `last_name` (`string`): Set the `last_name` field on the resulting object. When `null`, the `last_name` field will be omitted from the resulting object. + - `middle_name` (`string`): Set the `middle_name` field on the resulting object. When `null`, the `middle_name` field will be omitted from the resulting object. + - `mobile_phone_number` (`string`): Set the `mobile_phone_number` field on the resulting object. When `null`, the `mobile_phone_number` field will be omitted from the resulting object. + - `party_type_string` (`string`): Set the `party_type_string` field on the resulting object. When `null`, the `party_type_string` field will be omitted from the resulting object. + - `personal_email_address` (`string`): Set the `personal_email_address` field on the resulting object. When `null`, the `personal_email_address` field will be omitted from the resulting object. + - `phone_number` (`string`): Set the `phone_number` field on the resulting object. When `null`, the `phone_number` field will be omitted from the resulting object. + - `address` (`list[obj]`): Set the `address` field on the resulting object. When `null`, the `address` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [aws.customerprofiles_profile.address.new](#fn-addressnew) constructor. + - `billing_address` (`list[obj]`): Set the `billing_address` field on the resulting object. When `null`, the `billing_address` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [aws.customerprofiles_profile.billing_address.new](#fn-billing_addressnew) constructor. + - `mailing_address` (`list[obj]`): Set the `mailing_address` field on the resulting object. When `null`, the `mailing_address` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [aws.customerprofiles_profile.mailing_address.new](#fn-mailing_addressnew) constructor. + - `shipping_address` (`list[obj]`): Set the `shipping_address` field on the resulting object. When `null`, the `shipping_address` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [aws.customerprofiles_profile.shipping_address.new](#fn-shipping_addressnew) 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 `customerprofiles_profile` resource into the root Terraform configuration. + + +### fn withAccountNumber + +```ts +withAccountNumber() +``` + +`aws.string.withAccountNumber` constructs a mixin object that can be merged into the `string` +Terraform resource block to set or update the account_number field. + + + +**Args**: + - `resourceLabel` (`string`): The name label of the block to update. + - `value` (`string`): The value to set for the `account_number` field. + + +### fn withAdditionalInformation + +```ts +withAdditionalInformation() +``` + +`aws.string.withAdditionalInformation` constructs a mixin object that can be merged into the `string` +Terraform resource block to set or update the additional_information field. + + + +**Args**: + - `resourceLabel` (`string`): The name label of the block to update. + - `value` (`string`): The value to set for the `additional_information` field. + + +### fn withAddress + +```ts +withAddress() +``` + +`aws.list[obj].withAddress` constructs a mixin object that can be merged into the `list[obj]` +Terraform resource block to set or update the address 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].withAddressMixin](TODO) function. + + +**Args**: + - `resourceLabel` (`string`): The name label of the block to update. + - `value` (`list[obj]`): The value to set for the `address` field. + + +### fn withAddressMixin + +```ts +withAddressMixin() +``` + +`aws.list[obj].withAddressMixin` constructs a mixin object that can be merged into the `list[obj]` +Terraform resource block to set or update the address 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].withAddress](TODO) +function. + + +**Args**: + - `resourceLabel` (`string`): The name label of the block to update. + - `value` (`list[obj]`): The value to set for the `address` field. + + +### fn withAttributes + +```ts +withAttributes() +``` + +`aws.obj.withAttributes` constructs a mixin object that can be merged into the `obj` +Terraform resource block to set or update the attributes field. + + + +**Args**: + - `resourceLabel` (`string`): The name label of the block to update. + - `value` (`obj`): The value to set for the `attributes` field. + + +### fn withBillingAddress + +```ts +withBillingAddress() +``` + +`aws.list[obj].withBillingAddress` constructs a mixin object that can be merged into the `list[obj]` +Terraform resource block to set or update the billing_address 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].withBillingAddressMixin](TODO) function. + + +**Args**: + - `resourceLabel` (`string`): The name label of the block to update. + - `value` (`list[obj]`): The value to set for the `billing_address` field. + + +### fn withBillingAddressMixin + +```ts +withBillingAddressMixin() +``` + +`aws.list[obj].withBillingAddressMixin` constructs a mixin object that can be merged into the `list[obj]` +Terraform resource block to set or update the billing_address 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].withBillingAddress](TODO) +function. + + +**Args**: + - `resourceLabel` (`string`): The name label of the block to update. + - `value` (`list[obj]`): The value to set for the `billing_address` field. + + +### fn withBirthDate + +```ts +withBirthDate() +``` + +`aws.string.withBirthDate` constructs a mixin object that can be merged into the `string` +Terraform resource block to set or update the birth_date field. + + + +**Args**: + - `resourceLabel` (`string`): The name label of the block to update. + - `value` (`string`): The value to set for the `birth_date` field. + + +### fn withBusinessEmailAddress + +```ts +withBusinessEmailAddress() +``` + +`aws.string.withBusinessEmailAddress` constructs a mixin object that can be merged into the `string` +Terraform resource block to set or update the business_email_address field. + + + +**Args**: + - `resourceLabel` (`string`): The name label of the block to update. + - `value` (`string`): The value to set for the `business_email_address` field. + + +### fn withBusinessName + +```ts +withBusinessName() +``` + +`aws.string.withBusinessName` constructs a mixin object that can be merged into the `string` +Terraform resource block to set or update the business_name field. + + + +**Args**: + - `resourceLabel` (`string`): The name label of the block to update. + - `value` (`string`): The value to set for the `business_name` field. + + +### fn withBusinessPhoneNumber + +```ts +withBusinessPhoneNumber() +``` + +`aws.string.withBusinessPhoneNumber` constructs a mixin object that can be merged into the `string` +Terraform resource block to set or update the business_phone_number field. + + + +**Args**: + - `resourceLabel` (`string`): The name label of the block to update. + - `value` (`string`): The value to set for the `business_phone_number` field. + + +### fn withDomainName + +```ts +withDomainName() +``` + +`aws.string.withDomainName` constructs a mixin object that can be merged into the `string` +Terraform resource block to set or update the domain_name field. + + + +**Args**: + - `resourceLabel` (`string`): The name label of the block to update. + - `value` (`string`): The value to set for the `domain_name` field. + + +### fn withEmailAddress + +```ts +withEmailAddress() +``` + +`aws.string.withEmailAddress` constructs a mixin object that can be merged into the `string` +Terraform resource block to set or update the email_address field. + + + +**Args**: + - `resourceLabel` (`string`): The name label of the block to update. + - `value` (`string`): The value to set for the `email_address` field. + + +### fn withFirstName + +```ts +withFirstName() +``` + +`aws.string.withFirstName` constructs a mixin object that can be merged into the `string` +Terraform resource block to set or update the first_name field. + + + +**Args**: + - `resourceLabel` (`string`): The name label of the block to update. + - `value` (`string`): The value to set for the `first_name` field. + + +### fn withGenderString + +```ts +withGenderString() +``` + +`aws.string.withGenderString` constructs a mixin object that can be merged into the `string` +Terraform resource block to set or update the gender_string field. + + + +**Args**: + - `resourceLabel` (`string`): The name label of the block to update. + - `value` (`string`): The value to set for the `gender_string` field. + + +### fn withHomePhoneNumber + +```ts +withHomePhoneNumber() +``` + +`aws.string.withHomePhoneNumber` constructs a mixin object that can be merged into the `string` +Terraform resource block to set or update the home_phone_number field. + + + +**Args**: + - `resourceLabel` (`string`): The name label of the block to update. + - `value` (`string`): The value to set for the `home_phone_number` field. + + +### fn withLastName + +```ts +withLastName() +``` + +`aws.string.withLastName` constructs a mixin object that can be merged into the `string` +Terraform resource block to set or update the last_name field. + + + +**Args**: + - `resourceLabel` (`string`): The name label of the block to update. + - `value` (`string`): The value to set for the `last_name` field. + + +### fn withMailingAddress + +```ts +withMailingAddress() +``` + +`aws.list[obj].withMailingAddress` constructs a mixin object that can be merged into the `list[obj]` +Terraform resource block to set or update the mailing_address 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].withMailingAddressMixin](TODO) function. + + +**Args**: + - `resourceLabel` (`string`): The name label of the block to update. + - `value` (`list[obj]`): The value to set for the `mailing_address` field. + + +### fn withMailingAddressMixin + +```ts +withMailingAddressMixin() +``` + +`aws.list[obj].withMailingAddressMixin` constructs a mixin object that can be merged into the `list[obj]` +Terraform resource block to set or update the mailing_address 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].withMailingAddress](TODO) +function. + + +**Args**: + - `resourceLabel` (`string`): The name label of the block to update. + - `value` (`list[obj]`): The value to set for the `mailing_address` field. + + +### fn withMiddleName + +```ts +withMiddleName() +``` + +`aws.string.withMiddleName` constructs a mixin object that can be merged into the `string` +Terraform resource block to set or update the middle_name field. + + + +**Args**: + - `resourceLabel` (`string`): The name label of the block to update. + - `value` (`string`): The value to set for the `middle_name` field. + + +### fn withMobilePhoneNumber + +```ts +withMobilePhoneNumber() +``` + +`aws.string.withMobilePhoneNumber` constructs a mixin object that can be merged into the `string` +Terraform resource block to set or update the mobile_phone_number field. + + + +**Args**: + - `resourceLabel` (`string`): The name label of the block to update. + - `value` (`string`): The value to set for the `mobile_phone_number` field. + + +### fn withPartyTypeString + +```ts +withPartyTypeString() +``` + +`aws.string.withPartyTypeString` constructs a mixin object that can be merged into the `string` +Terraform resource block to set or update the party_type_string field. + + + +**Args**: + - `resourceLabel` (`string`): The name label of the block to update. + - `value` (`string`): The value to set for the `party_type_string` field. + + +### fn withPersonalEmailAddress + +```ts +withPersonalEmailAddress() +``` + +`aws.string.withPersonalEmailAddress` constructs a mixin object that can be merged into the `string` +Terraform resource block to set or update the personal_email_address field. + + + +**Args**: + - `resourceLabel` (`string`): The name label of the block to update. + - `value` (`string`): The value to set for the `personal_email_address` field. + + +### fn withPhoneNumber + +```ts +withPhoneNumber() +``` + +`aws.string.withPhoneNumber` constructs a mixin object that can be merged into the `string` +Terraform resource block to set or update the phone_number field. + + + +**Args**: + - `resourceLabel` (`string`): The name label of the block to update. + - `value` (`string`): The value to set for the `phone_number` field. + + +### fn withShippingAddress + +```ts +withShippingAddress() +``` + +`aws.list[obj].withShippingAddress` constructs a mixin object that can be merged into the `list[obj]` +Terraform resource block to set or update the shipping_address 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].withShippingAddressMixin](TODO) function. + + +**Args**: + - `resourceLabel` (`string`): The name label of the block to update. + - `value` (`list[obj]`): The value to set for the `shipping_address` field. + + +### fn withShippingAddressMixin + +```ts +withShippingAddressMixin() +``` + +`aws.list[obj].withShippingAddressMixin` constructs a mixin object that can be merged into the `list[obj]` +Terraform resource block to set or update the shipping_address 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].withShippingAddress](TODO) +function. + + +**Args**: + - `resourceLabel` (`string`): The name label of the block to update. + - `value` (`list[obj]`): The value to set for the `shipping_address` field. + + +## obj address + + + +### fn address.new + +```ts +new() +``` + + +`aws.customerprofiles_profile.address.new` constructs a new object with attributes and blocks configured for the `address` +Terraform sub block. + + + +**Args**: + - `address_1` (`string`): Set the `address_1` field on the resulting object. When `null`, the `address_1` field will be omitted from the resulting object. + - `address_2` (`string`): Set the `address_2` field on the resulting object. When `null`, the `address_2` field will be omitted from the resulting object. + - `address_3` (`string`): Set the `address_3` field on the resulting object. When `null`, the `address_3` field will be omitted from the resulting object. + - `address_4` (`string`): Set the `address_4` field on the resulting object. When `null`, the `address_4` field will be omitted from the resulting object. + - `city` (`string`): Set the `city` field on the resulting object. When `null`, the `city` field will be omitted from the resulting object. + - `country` (`string`): Set the `country` field on the resulting object. When `null`, the `country` field will be omitted from the resulting object. + - `county` (`string`): Set the `county` field on the resulting object. When `null`, the `county` field will be omitted from the resulting object. + - `postal_code` (`string`): Set the `postal_code` field on the resulting object. When `null`, the `postal_code` field will be omitted from the resulting object. + - `province` (`string`): Set the `province` field on the resulting object. When `null`, the `province` field will be omitted from the resulting object. + - `state` (`string`): Set the `state` field on the resulting object. When `null`, the `state` field will be omitted from the resulting object. + +**Returns**: + - An attribute object that represents the `address` sub block. + + +## obj billing_address + + + +### fn billing_address.new + +```ts +new() +``` + + +`aws.customerprofiles_profile.billing_address.new` constructs a new object with attributes and blocks configured for the `billing_address` +Terraform sub block. + + + +**Args**: + - `address_1` (`string`): Set the `address_1` field on the resulting object. When `null`, the `address_1` field will be omitted from the resulting object. + - `address_2` (`string`): Set the `address_2` field on the resulting object. When `null`, the `address_2` field will be omitted from the resulting object. + - `address_3` (`string`): Set the `address_3` field on the resulting object. When `null`, the `address_3` field will be omitted from the resulting object. + - `address_4` (`string`): Set the `address_4` field on the resulting object. When `null`, the `address_4` field will be omitted from the resulting object. + - `city` (`string`): Set the `city` field on the resulting object. When `null`, the `city` field will be omitted from the resulting object. + - `country` (`string`): Set the `country` field on the resulting object. When `null`, the `country` field will be omitted from the resulting object. + - `county` (`string`): Set the `county` field on the resulting object. When `null`, the `county` field will be omitted from the resulting object. + - `postal_code` (`string`): Set the `postal_code` field on the resulting object. When `null`, the `postal_code` field will be omitted from the resulting object. + - `province` (`string`): Set the `province` field on the resulting object. When `null`, the `province` field will be omitted from the resulting object. + - `state` (`string`): Set the `state` field on the resulting object. When `null`, the `state` field will be omitted from the resulting object. + +**Returns**: + - An attribute object that represents the `billing_address` sub block. + + +## obj mailing_address + + + +### fn mailing_address.new + +```ts +new() +``` + + +`aws.customerprofiles_profile.mailing_address.new` constructs a new object with attributes and blocks configured for the `mailing_address` +Terraform sub block. + + + +**Args**: + - `address_1` (`string`): Set the `address_1` field on the resulting object. When `null`, the `address_1` field will be omitted from the resulting object. + - `address_2` (`string`): Set the `address_2` field on the resulting object. When `null`, the `address_2` field will be omitted from the resulting object. + - `address_3` (`string`): Set the `address_3` field on the resulting object. When `null`, the `address_3` field will be omitted from the resulting object. + - `address_4` (`string`): Set the `address_4` field on the resulting object. When `null`, the `address_4` field will be omitted from the resulting object. + - `city` (`string`): Set the `city` field on the resulting object. When `null`, the `city` field will be omitted from the resulting object. + - `country` (`string`): Set the `country` field on the resulting object. When `null`, the `country` field will be omitted from the resulting object. + - `county` (`string`): Set the `county` field on the resulting object. When `null`, the `county` field will be omitted from the resulting object. + - `postal_code` (`string`): Set the `postal_code` field on the resulting object. When `null`, the `postal_code` field will be omitted from the resulting object. + - `province` (`string`): Set the `province` field on the resulting object. When `null`, the `province` field will be omitted from the resulting object. + - `state` (`string`): Set the `state` field on the resulting object. When `null`, the `state` field will be omitted from the resulting object. + +**Returns**: + - An attribute object that represents the `mailing_address` sub block. + + +## obj shipping_address + + + +### fn shipping_address.new + +```ts +new() +``` + + +`aws.customerprofiles_profile.shipping_address.new` constructs a new object with attributes and blocks configured for the `shipping_address` +Terraform sub block. + + + +**Args**: + - `address_1` (`string`): Set the `address_1` field on the resulting object. When `null`, the `address_1` field will be omitted from the resulting object. + - `address_2` (`string`): Set the `address_2` field on the resulting object. When `null`, the `address_2` field will be omitted from the resulting object. + - `address_3` (`string`): Set the `address_3` field on the resulting object. When `null`, the `address_3` field will be omitted from the resulting object. + - `address_4` (`string`): Set the `address_4` field on the resulting object. When `null`, the `address_4` field will be omitted from the resulting object. + - `city` (`string`): Set the `city` field on the resulting object. When `null`, the `city` field will be omitted from the resulting object. + - `country` (`string`): Set the `country` field on the resulting object. When `null`, the `country` field will be omitted from the resulting object. + - `county` (`string`): Set the `county` field on the resulting object. When `null`, the `county` field will be omitted from the resulting object. + - `postal_code` (`string`): Set the `postal_code` field on the resulting object. When `null`, the `postal_code` field will be omitted from the resulting object. + - `province` (`string`): Set the `province` field on the resulting object. When `null`, the `province` field will be omitted from the resulting object. + - `state` (`string`): Set the `state` field on the resulting object. When `null`, the `state` field will be omitted from the resulting object. + +**Returns**: + - An attribute object that represents the `shipping_address` sub block. diff --git a/docs/5.x/data/codeguruprofiler_profiling_group.md b/docs/5.x/data/codeguruprofiler_profiling_group.md new file mode 100644 index 00000000..41cf1d2d --- /dev/null +++ b/docs/5.x/data/codeguruprofiler_profiling_group.md @@ -0,0 +1,92 @@ +--- +permalink: /data/codeguruprofiler_profiling_group/ +--- + +# data.codeguruprofiler_profiling_group + +`codeguruprofiler_profiling_group` represents the `aws_codeguruprofiler_profiling_group` Terraform data source. + + + +This package contains functions and utilities for setting up the data source using Jsonnet code. + + +## Index + +* [`fn new()`](#fn-new) +* [`fn newAttrs()`](#fn-newattrs) +* [`fn withName()`](#fn-withname) + +## Fields + +### fn new + +```ts +new() +``` + + +`aws.data.codeguruprofiler_profiling_group.new` injects a new `data_aws_codeguruprofiler_profiling_group` Terraform `data source` +block into the root module document. + +Additionally, this inserts a private function into the `_ref` attribute that generates references to attributes of the +resource. For example, if you added a new instance to the root using: + + # arguments omitted for brevity + aws.data.codeguruprofiler_profiling_group.new('some_id') + +You can get the reference to the `id` field of the created `aws.data.codeguruprofiler_profiling_group` using the reference: + + $._ref.data_aws_codeguruprofiler_profiling_group.some_id.get('id') + +This is the same as directly entering `"${ data_aws_codeguruprofiler_profiling_group.some_id.id }"` as the value. + +NOTE: if you are chaining multiple resources together in a merge operation, you may not be able to use `super`, `self`, +or `$` to refer to the root object. Instead, make an explicit outer object using `local`. + +**Args**: + - `dataSrcLabel` (`string`): The name label of the block. + - `name` (`string`): Set the `name` field on the resulting data source block. + +**Returns**: +- A mixin object that injects the new data source into the root Terraform configuration. + + +### fn newAttrs + +```ts +newAttrs() +``` + + +`aws.data.codeguruprofiler_profiling_group.newAttrs` constructs a new object with attributes and blocks configured for the `codeguruprofiler_profiling_group` +Terraform data source. + +Unlike [aws.data.codeguruprofiler_profiling_group.new](#fn-new), this function will not inject the `data source` +block into the root Terraform document. Instead, this must be passed in as the `attrs` argument for the +[tf.withData](https://github.com/tf-libsonnet/core/tree/main/docs#fn-withdata) function to build a complete block. + +This is most useful when you need to preprocess the attributes with functions, conditional, or looping logic prior to +injecting into a complete block. + +**Args**: + - `name` (`string`): Set the `name` field on 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 `codeguruprofiler_profiling_group` 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. diff --git a/docs/5.x/data/ecr_repositories.md b/docs/5.x/data/ecr_repositories.md new file mode 100644 index 00000000..bab59be3 --- /dev/null +++ b/docs/5.x/data/ecr_repositories.md @@ -0,0 +1,71 @@ +--- +permalink: /data/ecr_repositories/ +--- + +# data.ecr_repositories + +`ecr_repositories` represents the `aws_ecr_repositories` Terraform data source. + + + +This package contains functions and utilities for setting up the data source using Jsonnet code. + + +## Index + +* [`fn new()`](#fn-new) +* [`fn newAttrs()`](#fn-newattrs) + +## Fields + +### fn new + +```ts +new() +``` + + +`aws.data.ecr_repositories.new` injects a new `data_aws_ecr_repositories` Terraform `data source` +block into the root module document. + +Additionally, this inserts a private function into the `_ref` attribute that generates references to attributes of the +resource. For example, if you added a new instance to the root using: + + # arguments omitted for brevity + aws.data.ecr_repositories.new('some_id') + +You can get the reference to the `id` field of the created `aws.data.ecr_repositories` using the reference: + + $._ref.data_aws_ecr_repositories.some_id.get('id') + +This is the same as directly entering `"${ data_aws_ecr_repositories.some_id.id }"` as the value. + +NOTE: if you are chaining multiple resources together in a merge operation, you may not be able to use `super`, `self`, +or `$` to refer to the root object. Instead, make an explicit outer object using `local`. + +**Args**: + - `dataSrcLabel` (`string`): The name label of the block. + +**Returns**: +- A mixin object that injects the new data source into the root Terraform configuration. + + +### fn newAttrs + +```ts +newAttrs() +``` + + +`aws.data.ecr_repositories.newAttrs` constructs a new object with attributes and blocks configured for the `ecr_repositories` +Terraform data source. + +Unlike [aws.data.ecr_repositories.new](#fn-new), this function will not inject the `data source` +block into the root Terraform document. Instead, this must be passed in as the `attrs` argument for the +[tf.withData](https://github.com/tf-libsonnet/core/tree/main/docs#fn-withdata) function to build a complete block. + +This is most useful when you need to preprocess the attributes with functions, conditional, or looping logic prior to +injecting into a complete block. + +**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 `ecr_repositories` data source into the root Terraform configuration. diff --git a/docs/5.x/data/index.md b/docs/5.x/data/index.md index c9b638aa..19d795c4 100644 --- a/docs/5.x/data/index.md +++ b/docs/5.x/data/index.md @@ -89,6 +89,7 @@ permalink: /data/ * [codecatalyst_dev_environment](codecatalyst_dev_environment.md) * [codecommit_approval_rule_template](codecommit_approval_rule_template.md) * [codecommit_repository](codecommit_repository.md) +* [codeguruprofiler_profiling_group](codeguruprofiler_profiling_group.md) * [codestarconnections_connection](codestarconnections_connection.md) * [cognito_identity_pool](cognito_identity_pool.md) * [cognito_user_pool_client](cognito_user_pool_client.md) @@ -187,6 +188,7 @@ permalink: /data/ * [ecr_authorization_token](ecr_authorization_token.md) * [ecr_image](ecr_image.md) * [ecr_pull_through_cache_rule](ecr_pull_through_cache_rule.md) +* [ecr_repositories](ecr_repositories.md) * [ecr_repository](ecr_repository.md) * [ecrpublic_authorization_token](ecrpublic_authorization_token.md) * [ecs_cluster](ecs_cluster.md) @@ -307,6 +309,7 @@ permalink: /data/ * [lb_hosted_zone_id](lb_hosted_zone_id.md) * [lb_listener](lb_listener.md) * [lb_target_group](lb_target_group.md) +* [lb_trust_store](lb_trust_store.md) * [lbs](lbs.md) * [lex_bot](lex_bot.md) * [lex_bot_alias](lex_bot_alias.md) @@ -491,6 +494,8 @@ permalink: /data/ * [ssmcontacts_plan](ssmcontacts_plan.md) * [ssmincidents_replication_set](ssmincidents_replication_set.md) * [ssmincidents_response_plan](ssmincidents_response_plan.md) +* [ssoadmin_application](ssoadmin_application.md) +* [ssoadmin_application_providers](ssoadmin_application_providers.md) * [ssoadmin_instances](ssoadmin_instances.md) * [ssoadmin_permission_set](ssoadmin_permission_set.md) * [storagegateway_local_disk](storagegateway_local_disk.md) diff --git a/docs/5.x/data/lb_trust_store.md b/docs/5.x/data/lb_trust_store.md new file mode 100644 index 00000000..d66dbe8c --- /dev/null +++ b/docs/5.x/data/lb_trust_store.md @@ -0,0 +1,111 @@ +--- +permalink: /data/lb_trust_store/ +--- + +# data.lb_trust_store + +`lb_trust_store` represents the `aws_lb_trust_store` Terraform data source. + + + +This package contains functions and utilities for setting up the data source using Jsonnet code. + + +## Index + +* [`fn new()`](#fn-new) +* [`fn newAttrs()`](#fn-newattrs) +* [`fn withArn()`](#fn-witharn) +* [`fn withName()`](#fn-withname) + +## Fields + +### fn new + +```ts +new() +``` + + +`aws.data.lb_trust_store.new` injects a new `data_aws_lb_trust_store` Terraform `data source` +block into the root module document. + +Additionally, this inserts a private function into the `_ref` attribute that generates references to attributes of the +resource. For example, if you added a new instance to the root using: + + # arguments omitted for brevity + aws.data.lb_trust_store.new('some_id') + +You can get the reference to the `id` field of the created `aws.data.lb_trust_store` using the reference: + + $._ref.data_aws_lb_trust_store.some_id.get('id') + +This is the same as directly entering `"${ data_aws_lb_trust_store.some_id.id }"` as the value. + +NOTE: if you are chaining multiple resources together in a merge operation, you may not be able to use `super`, `self`, +or `$` to refer to the root object. Instead, make an explicit outer object using `local`. + +**Args**: + - `dataSrcLabel` (`string`): The name label of the block. + - `arn` (`string`): Set the `arn` field on the resulting data source block. When `null`, the `arn` field will be omitted from the resulting object. + - `name` (`string`): Set the `name` field on the resulting data source block. When `null`, the `name` field will be omitted from the resulting object. + +**Returns**: +- A mixin object that injects the new data source into the root Terraform configuration. + + +### fn newAttrs + +```ts +newAttrs() +``` + + +`aws.data.lb_trust_store.newAttrs` constructs a new object with attributes and blocks configured for the `lb_trust_store` +Terraform data source. + +Unlike [aws.data.lb_trust_store.new](#fn-new), this function will not inject the `data source` +block into the root Terraform document. Instead, this must be passed in as the `attrs` argument for the +[tf.withData](https://github.com/tf-libsonnet/core/tree/main/docs#fn-withdata) function to build a complete block. + +This is most useful when you need to preprocess the attributes with functions, conditional, or looping logic prior to +injecting into a complete block. + +**Args**: + - `arn` (`string`): Set the `arn` field on the resulting object. When `null`, the `arn` field will be omitted from 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. + +**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 `lb_trust_store` data source into the root Terraform configuration. + + +### fn withArn + +```ts +withArn() +``` + +`aws.string.withArn` constructs a mixin object that can be merged into the `string` +Terraform data source block to set or update the arn field. + + + +**Args**: + - `dataSrcLabel` (`string`): The name label of the block to update. + - `value` (`string`): The value to set for the `arn` field. + + +### 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. diff --git a/docs/5.x/data/ssoadmin_application.md b/docs/5.x/data/ssoadmin_application.md new file mode 100644 index 00000000..92376d87 --- /dev/null +++ b/docs/5.x/data/ssoadmin_application.md @@ -0,0 +1,180 @@ +--- +permalink: /data/ssoadmin_application/ +--- + +# data.ssoadmin_application + +`ssoadmin_application` represents the `aws_ssoadmin_application` Terraform data source. + + + +This package contains functions and utilities for setting up the data source using Jsonnet code. + + +## Index + +* [`fn new()`](#fn-new) +* [`fn newAttrs()`](#fn-newattrs) +* [`fn withApplicationArn()`](#fn-withapplicationarn) +* [`fn withPortalOptions()`](#fn-withportaloptions) +* [`fn withPortalOptionsMixin()`](#fn-withportaloptionsmixin) +* [`obj portal_options`](#obj-portal_options) + * [`fn new()`](#fn-portal_optionsnew) + * [`obj portal_options.sign_in_options`](#obj-portal_optionssign_in_options) + * [`fn new()`](#fn-portal_optionssign_in_optionsnew) + +## Fields + +### fn new + +```ts +new() +``` + + +`aws.data.ssoadmin_application.new` injects a new `data_aws_ssoadmin_application` Terraform `data source` +block into the root module document. + +Additionally, this inserts a private function into the `_ref` attribute that generates references to attributes of the +resource. For example, if you added a new instance to the root using: + + # arguments omitted for brevity + aws.data.ssoadmin_application.new('some_id') + +You can get the reference to the `id` field of the created `aws.data.ssoadmin_application` using the reference: + + $._ref.data_aws_ssoadmin_application.some_id.get('id') + +This is the same as directly entering `"${ data_aws_ssoadmin_application.some_id.id }"` as the value. + +NOTE: if you are chaining multiple resources together in a merge operation, you may not be able to use `super`, `self`, +or `$` to refer to the root object. Instead, make an explicit outer object using `local`. + +**Args**: + - `dataSrcLabel` (`string`): The name label of the block. + - `application_arn` (`string`): Set the `application_arn` field on the resulting data source block. + - `portal_options` (`list[obj]`): Set the `portal_options` field on the resulting data source block. When `null`, the `portal_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.data.ssoadmin_application.portal_options.new](#fn-portal_optionsnew) constructor. + +**Returns**: +- A mixin object that injects the new data source into the root Terraform configuration. + + +### fn newAttrs + +```ts +newAttrs() +``` + + +`aws.data.ssoadmin_application.newAttrs` constructs a new object with attributes and blocks configured for the `ssoadmin_application` +Terraform data source. + +Unlike [aws.data.ssoadmin_application.new](#fn-new), this function will not inject the `data source` +block into the root Terraform document. Instead, this must be passed in as the `attrs` argument for the +[tf.withData](https://github.com/tf-libsonnet/core/tree/main/docs#fn-withdata) function to build a complete block. + +This is most useful when you need to preprocess the attributes with functions, conditional, or looping logic prior to +injecting into a complete block. + +**Args**: + - `application_arn` (`string`): Set the `application_arn` field on the resulting object. + - `portal_options` (`list[obj]`): Set the `portal_options` field on the resulting object. When `null`, the `portal_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.data.ssoadmin_application.portal_options.new](#fn-portal_optionsnew) constructor. + +**Returns**: + - An attribute object that can be used with [tf.withData](https://github.com/tf-libsonnet/core/tree/main/docs#fn-withdata) to construct a new `ssoadmin_application` data source into the root Terraform configuration. + + +### fn withApplicationArn + +```ts +withApplicationArn() +``` + +`aws.string.withApplicationArn` constructs a mixin object that can be merged into the `string` +Terraform data source block to set or update the application_arn field. + + + +**Args**: + - `dataSrcLabel` (`string`): The name label of the block to update. + - `value` (`string`): The value to set for the `application_arn` field. + + +### fn withPortalOptions + +```ts +withPortalOptions() +``` + +`aws.list[obj].withPortalOptions` constructs a mixin object that can be merged into the `list[obj]` +Terraform data source block to set or update the portal_options field. + +This function will replace the array with the passed in `value`. If you wish to instead append the +passed in value to the existing array, use the [aws.list[obj].withPortalOptionsMixin](TODO) function. + + +**Args**: + - `dataSrcLabel` (`string`): The name label of the block to update. + - `value` (`list[obj]`): The value to set for the `portal_options` field. + + +### fn withPortalOptionsMixin + +```ts +withPortalOptionsMixin() +``` + +`aws.list[obj].withPortalOptionsMixin` constructs a mixin object that can be merged into the `list[obj]` +Terraform data source block to set or update the portal_options field. + +This function will append the passed in array or object to the existing array. If you wish +to instead replace the array with the passed in `value`, use the [aws.list[obj].withPortalOptions](TODO) +function. + + +**Args**: + - `dataSrcLabel` (`string`): The name label of the block to update. + - `value` (`list[obj]`): The value to set for the `portal_options` field. + + +## obj portal_options + + + +### fn portal_options.new + +```ts +new() +``` + + +`aws.ssoadmin_application.portal_options.new` constructs a new object with attributes and blocks configured for the `portal_options` +Terraform sub block. + + + +**Args**: + - `sign_in_options` (`list[obj]`): Set the `sign_in_options` field on the resulting object. When `null`, the `sign_in_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.ssoadmin_application.portal_options.sign_in_options.new](#fn-portal_optionssign_in_optionsnew) constructor. + +**Returns**: + - An attribute object that represents the `portal_options` sub block. + + +## obj portal_options.sign_in_options + + + +### fn portal_options.sign_in_options.new + +```ts +new() +``` + + +`aws.ssoadmin_application.portal_options.sign_in_options.new` constructs a new object with attributes and blocks configured for the `sign_in_options` +Terraform sub block. + + + +**Returns**: + - An attribute object that represents the `sign_in_options` sub block. diff --git a/docs/5.x/data/ssoadmin_application_providers.md b/docs/5.x/data/ssoadmin_application_providers.md new file mode 100644 index 00000000..8ef6a01e --- /dev/null +++ b/docs/5.x/data/ssoadmin_application_providers.md @@ -0,0 +1,161 @@ +--- +permalink: /data/ssoadmin_application_providers/ +--- + +# data.ssoadmin_application_providers + +`ssoadmin_application_providers` represents the `aws_ssoadmin_application_providers` Terraform data source. + + + +This package contains functions and utilities for setting up the data source using Jsonnet code. + + +## Index + +* [`fn new()`](#fn-new) +* [`fn newAttrs()`](#fn-newattrs) +* [`fn withApplicationProviders()`](#fn-withapplicationproviders) +* [`fn withApplicationProvidersMixin()`](#fn-withapplicationprovidersmixin) +* [`obj application_providers`](#obj-application_providers) + * [`fn new()`](#fn-application_providersnew) + * [`obj application_providers.display_data`](#obj-application_providersdisplay_data) + * [`fn new()`](#fn-application_providersdisplay_datanew) + +## Fields + +### fn new + +```ts +new() +``` + + +`aws.data.ssoadmin_application_providers.new` injects a new `data_aws_ssoadmin_application_providers` Terraform `data source` +block into the root module document. + +Additionally, this inserts a private function into the `_ref` attribute that generates references to attributes of the +resource. For example, if you added a new instance to the root using: + + # arguments omitted for brevity + aws.data.ssoadmin_application_providers.new('some_id') + +You can get the reference to the `id` field of the created `aws.data.ssoadmin_application_providers` using the reference: + + $._ref.data_aws_ssoadmin_application_providers.some_id.get('id') + +This is the same as directly entering `"${ data_aws_ssoadmin_application_providers.some_id.id }"` as the value. + +NOTE: if you are chaining multiple resources together in a merge operation, you may not be able to use `super`, `self`, +or `$` to refer to the root object. Instead, make an explicit outer object using `local`. + +**Args**: + - `dataSrcLabel` (`string`): The name label of the block. + - `application_providers` (`list[obj]`): Set the `application_providers` field on the resulting data source block. When `null`, the `application_providers` 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.ssoadmin_application_providers.application_providers.new](#fn-application_providersnew) constructor. + +**Returns**: +- A mixin object that injects the new data source into the root Terraform configuration. + + +### fn newAttrs + +```ts +newAttrs() +``` + + +`aws.data.ssoadmin_application_providers.newAttrs` constructs a new object with attributes and blocks configured for the `ssoadmin_application_providers` +Terraform data source. + +Unlike [aws.data.ssoadmin_application_providers.new](#fn-new), this function will not inject the `data source` +block into the root Terraform document. Instead, this must be passed in as the `attrs` argument for the +[tf.withData](https://github.com/tf-libsonnet/core/tree/main/docs#fn-withdata) function to build a complete block. + +This is most useful when you need to preprocess the attributes with functions, conditional, or looping logic prior to +injecting into a complete block. + +**Args**: + - `application_providers` (`list[obj]`): Set the `application_providers` field on the resulting object. When `null`, the `application_providers` 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.ssoadmin_application_providers.application_providers.new](#fn-application_providersnew) constructor. + +**Returns**: + - An attribute object that can be used with [tf.withData](https://github.com/tf-libsonnet/core/tree/main/docs#fn-withdata) to construct a new `ssoadmin_application_providers` data source into the root Terraform configuration. + + +### fn withApplicationProviders + +```ts +withApplicationProviders() +``` + +`aws.list[obj].withApplicationProviders` constructs a mixin object that can be merged into the `list[obj]` +Terraform data source block to set or update the application_providers 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].withApplicationProvidersMixin](TODO) function. + + +**Args**: + - `dataSrcLabel` (`string`): The name label of the block to update. + - `value` (`list[obj]`): The value to set for the `application_providers` field. + + +### fn withApplicationProvidersMixin + +```ts +withApplicationProvidersMixin() +``` + +`aws.list[obj].withApplicationProvidersMixin` constructs a mixin object that can be merged into the `list[obj]` +Terraform data source block to set or update the application_providers 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].withApplicationProviders](TODO) +function. + + +**Args**: + - `dataSrcLabel` (`string`): The name label of the block to update. + - `value` (`list[obj]`): The value to set for the `application_providers` field. + + +## obj application_providers + + + +### fn application_providers.new + +```ts +new() +``` + + +`aws.ssoadmin_application_providers.application_providers.new` constructs a new object with attributes and blocks configured for the `application_providers` +Terraform sub block. + + + +**Args**: + - `display_data` (`list[obj]`): Set the `display_data` field on the resulting object. When `null`, the `display_data` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [aws.ssoadmin_application_providers.application_providers.display_data.new](#fn-application_providersdisplay_datanew) constructor. + +**Returns**: + - An attribute object that represents the `application_providers` sub block. + + +## obj application_providers.display_data + + + +### fn application_providers.display_data.new + +```ts +new() +``` + + +`aws.ssoadmin_application_providers.application_providers.display_data.new` constructs a new object with attributes and blocks configured for the `display_data` +Terraform sub block. + + + +**Returns**: + - An attribute object that represents the `display_data` sub block. diff --git a/docs/5.x/lb.md b/docs/5.x/lb.md index 35b5a7c4..d3a0153f 100644 --- a/docs/5.x/lb.md +++ b/docs/5.x/lb.md @@ -27,6 +27,7 @@ This package contains functions and utilities for setting up the resource using * [`fn withEnableTlsVersionAndCipherSuiteHeaders()`](#fn-withenabletlsversionandciphersuiteheaders) * [`fn withEnableWafFailOpen()`](#fn-withenablewaffailopen) * [`fn withEnableXffClientPort()`](#fn-withenablexffclientport) +* [`fn withEnforceSecurityGroupInboundRulesOnPrivateLinkTraffic()`](#fn-withenforcesecuritygroupinboundrulesonprivatelinktraffic) * [`fn withIdleTimeout()`](#fn-withidletimeout) * [`fn withInternal()`](#fn-withinternal) * [`fn withIpAddressType()`](#fn-withipaddresstype) @@ -89,6 +90,7 @@ or `$` to refer to the root object. Instead, make an explicit outer object using - `enable_tls_version_and_cipher_suite_headers` (`bool`): Set the `enable_tls_version_and_cipher_suite_headers` field on the resulting resource block. When `null`, the `enable_tls_version_and_cipher_suite_headers` field will be omitted from the resulting object. - `enable_waf_fail_open` (`bool`): Set the `enable_waf_fail_open` field on the resulting resource block. When `null`, the `enable_waf_fail_open` field will be omitted from the resulting object. - `enable_xff_client_port` (`bool`): Set the `enable_xff_client_port` field on the resulting resource block. When `null`, the `enable_xff_client_port` field will be omitted from the resulting object. + - `enforce_security_group_inbound_rules_on_private_link_traffic` (`string`): Set the `enforce_security_group_inbound_rules_on_private_link_traffic` field on the resulting resource block. When `null`, the `enforce_security_group_inbound_rules_on_private_link_traffic` field will be omitted from the resulting object. - `idle_timeout` (`number`): Set the `idle_timeout` field on the resulting resource block. When `null`, the `idle_timeout` field will be omitted from the resulting object. - `internal` (`bool`): Set the `internal` field on the resulting resource block. When `null`, the `internal` field will be omitted from the resulting object. - `ip_address_type` (`string`): Set the `ip_address_type` field on the resulting resource block. When `null`, the `ip_address_type` field will be omitted from the resulting object. @@ -137,6 +139,7 @@ injecting into a complete block. - `enable_tls_version_and_cipher_suite_headers` (`bool`): Set the `enable_tls_version_and_cipher_suite_headers` field on the resulting object. When `null`, the `enable_tls_version_and_cipher_suite_headers` field will be omitted from the resulting object. - `enable_waf_fail_open` (`bool`): Set the `enable_waf_fail_open` field on the resulting object. When `null`, the `enable_waf_fail_open` field will be omitted from the resulting object. - `enable_xff_client_port` (`bool`): Set the `enable_xff_client_port` field on the resulting object. When `null`, the `enable_xff_client_port` field will be omitted from the resulting object. + - `enforce_security_group_inbound_rules_on_private_link_traffic` (`string`): Set the `enforce_security_group_inbound_rules_on_private_link_traffic` field on the resulting object. When `null`, the `enforce_security_group_inbound_rules_on_private_link_traffic` field will be omitted from the resulting object. - `idle_timeout` (`number`): Set the `idle_timeout` field on the resulting object. When `null`, the `idle_timeout` field will be omitted from the resulting object. - `internal` (`bool`): Set the `internal` field on the resulting object. When `null`, the `internal` field will be omitted from the resulting object. - `ip_address_type` (`string`): Set the `ip_address_type` field on the resulting object. When `null`, the `ip_address_type` field will be omitted from the resulting object. @@ -354,6 +357,22 @@ Terraform resource block to set or update the enable_xff_client_port field. - `value` (`bool`): The value to set for the `enable_xff_client_port` field. +### fn withEnforceSecurityGroupInboundRulesOnPrivateLinkTraffic + +```ts +withEnforceSecurityGroupInboundRulesOnPrivateLinkTraffic() +``` + +`aws.string.withEnforceSecurityGroupInboundRulesOnPrivateLinkTraffic` constructs a mixin object that can be merged into the `string` +Terraform resource block to set or update the enforce_security_group_inbound_rules_on_private_link_traffic field. + + + +**Args**: + - `resourceLabel` (`string`): The name label of the block to update. + - `value` (`string`): The value to set for the `enforce_security_group_inbound_rules_on_private_link_traffic` field. + + ### fn withIdleTimeout ```ts diff --git a/docs/5.x/lb_listener.md b/docs/5.x/lb_listener.md index 327f805f..1a10cf8c 100644 --- a/docs/5.x/lb_listener.md +++ b/docs/5.x/lb_listener.md @@ -20,6 +20,8 @@ This package contains functions and utilities for setting up the resource using * [`fn withDefaultAction()`](#fn-withdefaultaction) * [`fn withDefaultActionMixin()`](#fn-withdefaultactionmixin) * [`fn withLoadBalancerArn()`](#fn-withloadbalancerarn) +* [`fn withMutualAuthentication()`](#fn-withmutualauthentication) +* [`fn withMutualAuthenticationMixin()`](#fn-withmutualauthenticationmixin) * [`fn withPort()`](#fn-withport) * [`fn withProtocol()`](#fn-withprotocol) * [`fn withSslPolicy()`](#fn-withsslpolicy) @@ -43,6 +45,8 @@ This package contains functions and utilities for setting up the resource using * [`fn new()`](#fn-default_actionforwardtarget_groupnew) * [`obj default_action.redirect`](#obj-default_actionredirect) * [`fn new()`](#fn-default_actionredirectnew) +* [`obj mutual_authentication`](#obj-mutual_authentication) + * [`fn new()`](#fn-mutual_authenticationnew) * [`obj timeouts`](#obj-timeouts) * [`fn new()`](#fn-timeoutsnew) @@ -84,6 +88,7 @@ or `$` to refer to the root object. Instead, make an explicit outer object using - `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. - `default_action` (`list[obj]`): Set the `default_action` field on the resulting resource block. When `null`, the `default_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.lb_listener.default_action.new](#fn-default_actionnew) constructor. + - `mutual_authentication` (`list[obj]`): Set the `mutual_authentication` field on the resulting resource block. When `null`, the `mutual_authentication` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [aws.lb_listener.mutual_authentication.new](#fn-mutual_authenticationnew) constructor. - `timeouts` (`obj`): Set the `timeouts` field on the resulting resource block. When `null`, the `timeouts` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [aws.lb_listener.timeouts.new](#fn-timeoutsnew) constructor. **Returns**: @@ -117,6 +122,7 @@ injecting into a complete block. - `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. - `default_action` (`list[obj]`): Set the `default_action` field on the resulting object. When `null`, the `default_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.lb_listener.default_action.new](#fn-default_actionnew) constructor. + - `mutual_authentication` (`list[obj]`): Set the `mutual_authentication` field on the resulting object. When `null`, the `mutual_authentication` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [aws.lb_listener.mutual_authentication.new](#fn-mutual_authenticationnew) constructor. - `timeouts` (`obj`): Set the `timeouts` field on the resulting object. When `null`, the `timeouts` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [aws.lb_listener.timeouts.new](#fn-timeoutsnew) constructor. **Returns**: @@ -208,6 +214,43 @@ Terraform resource block to set or update the load_balancer_arn field. - `value` (`string`): The value to set for the `load_balancer_arn` field. +### fn withMutualAuthentication + +```ts +withMutualAuthentication() +``` + +`aws.list[obj].withMutualAuthentication` constructs a mixin object that can be merged into the `list[obj]` +Terraform resource block to set or update the mutual_authentication 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].withMutualAuthenticationMixin](TODO) function. + + +**Args**: + - `resourceLabel` (`string`): The name label of the block to update. + - `value` (`list[obj]`): The value to set for the `mutual_authentication` field. + + +### fn withMutualAuthenticationMixin + +```ts +withMutualAuthenticationMixin() +``` + +`aws.list[obj].withMutualAuthenticationMixin` constructs a mixin object that can be merged into the `list[obj]` +Terraform resource block to set or update the mutual_authentication 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].withMutualAuthentication](TODO) +function. + + +**Args**: + - `resourceLabel` (`string`): The name label of the block to update. + - `value` (`list[obj]`): The value to set for the `mutual_authentication` field. + + ### fn withPort ```ts @@ -542,6 +585,31 @@ Terraform sub block. - An attribute object that represents the `redirect` sub block. +## obj mutual_authentication + + + +### fn mutual_authentication.new + +```ts +new() +``` + + +`aws.lb_listener.mutual_authentication.new` constructs a new object with attributes and blocks configured for the `mutual_authentication` +Terraform sub block. + + + +**Args**: + - `ignore_client_certificate_expiry` (`bool`): Set the `ignore_client_certificate_expiry` field on the resulting object. When `null`, the `ignore_client_certificate_expiry` field will be omitted from the resulting object. + - `mode` (`string`): Set the `mode` field on the resulting object. + - `trust_store_arn` (`string`): Set the `trust_store_arn` field on the resulting object. When `null`, the `trust_store_arn` field will be omitted from the resulting object. + +**Returns**: + - An attribute object that represents the `mutual_authentication` sub block. + + ## obj timeouts @@ -559,7 +627,8 @@ Terraform sub block. **Args**: - - `read` (`string`): Set the `read` field on the resulting object. When `null`, the `read` field will be omitted from the resulting object. + - `create` (`string`): Set the `create` field on the resulting object. When `null`, the `create` 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/lb_trust_store.md b/docs/5.x/lb_trust_store.md new file mode 100644 index 00000000..ba27df64 --- /dev/null +++ b/docs/5.x/lb_trust_store.md @@ -0,0 +1,272 @@ +--- +permalink: /lb_trust_store/ +--- + +# lb_trust_store + +`lb_trust_store` represents the `aws_lb_trust_store` 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 withCaCertificatesBundleS3Bucket()`](#fn-withcacertificatesbundles3bucket) +* [`fn withCaCertificatesBundleS3Key()`](#fn-withcacertificatesbundles3key) +* [`fn withCaCertificatesBundleS3ObjectVersion()`](#fn-withcacertificatesbundles3objectversion) +* [`fn withName()`](#fn-withname) +* [`fn withNamePrefix()`](#fn-withnameprefix) +* [`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 + +### fn new + +```ts +new() +``` + + +`aws.lb_trust_store.new` injects a new `aws_lb_trust_store` 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.lb_trust_store.new('some_id') + +You can get the reference to the `id` field of the created `aws.lb_trust_store` using the reference: + + $._ref.aws_lb_trust_store.some_id.get('id') + +This is the same as directly entering `"${ aws_lb_trust_store.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. + - `ca_certificates_bundle_s3_bucket` (`string`): Set the `ca_certificates_bundle_s3_bucket` field on the resulting resource block. + - `ca_certificates_bundle_s3_key` (`string`): Set the `ca_certificates_bundle_s3_key` field on the resulting resource block. + - `ca_certificates_bundle_s3_object_version` (`string`): Set the `ca_certificates_bundle_s3_object_version` field on the resulting resource block. When `null`, the `ca_certificates_bundle_s3_object_version` field will be omitted from the resulting object. + - `name` (`string`): Set the `name` field on the resulting resource block. When `null`, the `name` field will be omitted from the resulting object. + - `name_prefix` (`string`): Set the `name_prefix` field on the resulting resource block. When `null`, the `name_prefix` field will be omitted from the resulting object. + - `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.lb_trust_store.timeouts.new](#fn-timeoutsnew) constructor. + +**Returns**: +- A mixin object that injects the new resource into the root Terraform configuration. + + +### fn newAttrs + +```ts +newAttrs() +``` + + +`aws.lb_trust_store.newAttrs` constructs a new object with attributes and blocks configured for the `lb_trust_store` +Terraform resource. + +Unlike [aws.lb_trust_store.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**: + - `ca_certificates_bundle_s3_bucket` (`string`): Set the `ca_certificates_bundle_s3_bucket` field on the resulting object. + - `ca_certificates_bundle_s3_key` (`string`): Set the `ca_certificates_bundle_s3_key` field on the resulting object. + - `ca_certificates_bundle_s3_object_version` (`string`): Set the `ca_certificates_bundle_s3_object_version` field on the resulting object. When `null`, the `ca_certificates_bundle_s3_object_version` field will be omitted from the resulting object. + - `name` (`string`): Set the `name` field on the resulting object. When `null`, the `name` field will be omitted from the resulting object. + - `name_prefix` (`string`): Set the `name_prefix` field on the resulting object. When `null`, the `name_prefix` field will be omitted from the resulting object. + - `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.lb_trust_store.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 `lb_trust_store` resource into the root Terraform configuration. + + +### fn withCaCertificatesBundleS3Bucket + +```ts +withCaCertificatesBundleS3Bucket() +``` + +`aws.string.withCaCertificatesBundleS3Bucket` constructs a mixin object that can be merged into the `string` +Terraform resource block to set or update the ca_certificates_bundle_s3_bucket field. + + + +**Args**: + - `resourceLabel` (`string`): The name label of the block to update. + - `value` (`string`): The value to set for the `ca_certificates_bundle_s3_bucket` field. + + +### fn withCaCertificatesBundleS3Key + +```ts +withCaCertificatesBundleS3Key() +``` + +`aws.string.withCaCertificatesBundleS3Key` constructs a mixin object that can be merged into the `string` +Terraform resource block to set or update the ca_certificates_bundle_s3_key field. + + + +**Args**: + - `resourceLabel` (`string`): The name label of the block to update. + - `value` (`string`): The value to set for the `ca_certificates_bundle_s3_key` field. + + +### fn withCaCertificatesBundleS3ObjectVersion + +```ts +withCaCertificatesBundleS3ObjectVersion() +``` + +`aws.string.withCaCertificatesBundleS3ObjectVersion` constructs a mixin object that can be merged into the `string` +Terraform resource block to set or update the ca_certificates_bundle_s3_object_version field. + + + +**Args**: + - `resourceLabel` (`string`): The name label of the block to update. + - `value` (`string`): The value to set for the `ca_certificates_bundle_s3_object_version` field. + + +### fn withName + +```ts +withName() +``` + +`aws.string.withName` constructs a mixin object that can be merged into the `string` +Terraform resource block to set or update the name field. + + + +**Args**: + - `resourceLabel` (`string`): The name label of the block to update. + - `value` (`string`): The value to set for the `name` field. + + +### fn withNamePrefix + +```ts +withNamePrefix() +``` + +`aws.string.withNamePrefix` constructs a mixin object that can be merged into the `string` +Terraform resource block to set or update the name_prefix field. + + + +**Args**: + - `resourceLabel` (`string`): The name label of the block to update. + - `value` (`string`): The value to set for the `name_prefix` field. + + +### fn withTags + +```ts +withTags() +``` + +`aws.obj.withTags` constructs a mixin object that can be merged into the `obj` +Terraform resource block to set or update the tags field. + + + +**Args**: + - `resourceLabel` (`string`): The name label of the block to update. + - `value` (`obj`): The value to set for the `tags` field. + + +### fn withTagsAll + +```ts +withTagsAll() +``` + +`aws.obj.withTagsAll` constructs a mixin object that can be merged into the `obj` +Terraform resource block to set or update the tags_all field. + + + +**Args**: + - `resourceLabel` (`string`): The name label of the block to update. + - `value` (`obj`): The value to set for the `tags_all` field. + + +### fn withTimeouts + +```ts +withTimeouts() +``` + +`aws.obj.withTimeouts` constructs a mixin object that can be merged into the `obj` +Terraform resource block to set or update the timeouts field. + +This function will replace the map with the passed in `value`. If you wish to instead merge the +passed in value to the existing map, use the [aws.obj.withTimeoutsMixin](TODO) function. + +**Args**: + - `resourceLabel` (`string`): The name label of the block to update. + - `value` (`obj`): The value to set for the `timeouts` field. + + +### fn withTimeoutsMixin + +```ts +withTimeoutsMixin() +``` + +`aws.obj.withTimeoutsMixin` constructs a mixin object that can be merged into the `obj` +Terraform resource block to set or update the timeouts field. + +This function will merge the passed in value to the existing map. If you wish +to instead replace the entire map with the passed in `value`, use the [aws.obj.withTimeouts](TODO) +function. + + +**Args**: + - `resourceLabel` (`string`): The name label of the block to update. + - `value` (`obj`): The value to set for the `timeouts` field. + + +## obj timeouts + + + +### fn timeouts.new + +```ts +new() +``` + + +`aws.lb_trust_store.timeouts.new` constructs a new object with attributes and blocks configured for the `timeouts` +Terraform sub block. + + + +**Args**: + - `create` (`string`): Set the `create` field on the resulting object. When `null`, the `create` field will be omitted from the resulting object. + - `delete` (`string`): Set the `delete` field on the resulting object. When `null`, the `delete` field will be omitted from the resulting object. + +**Returns**: + - An attribute object that represents the `timeouts` sub block. diff --git a/docs/5.x/lb_trust_store_revocation.md b/docs/5.x/lb_trust_store_revocation.md new file mode 100644 index 00000000..8a6f5bba --- /dev/null +++ b/docs/5.x/lb_trust_store_revocation.md @@ -0,0 +1,214 @@ +--- +permalink: /lb_trust_store_revocation/ +--- + +# lb_trust_store_revocation + +`lb_trust_store_revocation` represents the `aws_lb_trust_store_revocation` 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 withRevocationsS3Bucket()`](#fn-withrevocationss3bucket) +* [`fn withRevocationsS3Key()`](#fn-withrevocationss3key) +* [`fn withRevocationsS3ObjectVersion()`](#fn-withrevocationss3objectversion) +* [`fn withTimeouts()`](#fn-withtimeouts) +* [`fn withTimeoutsMixin()`](#fn-withtimeoutsmixin) +* [`fn withTrustStoreArn()`](#fn-withtruststorearn) +* [`obj timeouts`](#obj-timeouts) + * [`fn new()`](#fn-timeoutsnew) + +## Fields + +### fn new + +```ts +new() +``` + + +`aws.lb_trust_store_revocation.new` injects a new `aws_lb_trust_store_revocation` 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.lb_trust_store_revocation.new('some_id') + +You can get the reference to the `id` field of the created `aws.lb_trust_store_revocation` using the reference: + + $._ref.aws_lb_trust_store_revocation.some_id.get('id') + +This is the same as directly entering `"${ aws_lb_trust_store_revocation.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. + - `revocations_s3_bucket` (`string`): Set the `revocations_s3_bucket` field on the resulting resource block. + - `revocations_s3_key` (`string`): Set the `revocations_s3_key` field on the resulting resource block. + - `revocations_s3_object_version` (`string`): Set the `revocations_s3_object_version` field on the resulting resource block. When `null`, the `revocations_s3_object_version` field will be omitted from the resulting object. + - `trust_store_arn` (`string`): Set the `trust_store_arn` field on the resulting resource block. + - `timeouts` (`obj`): Set the `timeouts` field on the resulting resource block. When `null`, the `timeouts` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [aws.lb_trust_store_revocation.timeouts.new](#fn-timeoutsnew) constructor. + +**Returns**: +- A mixin object that injects the new resource into the root Terraform configuration. + + +### fn newAttrs + +```ts +newAttrs() +``` + + +`aws.lb_trust_store_revocation.newAttrs` constructs a new object with attributes and blocks configured for the `lb_trust_store_revocation` +Terraform resource. + +Unlike [aws.lb_trust_store_revocation.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**: + - `revocations_s3_bucket` (`string`): Set the `revocations_s3_bucket` field on the resulting object. + - `revocations_s3_key` (`string`): Set the `revocations_s3_key` field on the resulting object. + - `revocations_s3_object_version` (`string`): Set the `revocations_s3_object_version` field on the resulting object. When `null`, the `revocations_s3_object_version` field will be omitted from the resulting object. + - `trust_store_arn` (`string`): Set the `trust_store_arn` field on the resulting object. + - `timeouts` (`obj`): Set the `timeouts` field on the resulting object. When `null`, the `timeouts` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [aws.lb_trust_store_revocation.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 `lb_trust_store_revocation` resource into the root Terraform configuration. + + +### fn withRevocationsS3Bucket + +```ts +withRevocationsS3Bucket() +``` + +`aws.string.withRevocationsS3Bucket` constructs a mixin object that can be merged into the `string` +Terraform resource block to set or update the revocations_s3_bucket field. + + + +**Args**: + - `resourceLabel` (`string`): The name label of the block to update. + - `value` (`string`): The value to set for the `revocations_s3_bucket` field. + + +### fn withRevocationsS3Key + +```ts +withRevocationsS3Key() +``` + +`aws.string.withRevocationsS3Key` constructs a mixin object that can be merged into the `string` +Terraform resource block to set or update the revocations_s3_key field. + + + +**Args**: + - `resourceLabel` (`string`): The name label of the block to update. + - `value` (`string`): The value to set for the `revocations_s3_key` field. + + +### fn withRevocationsS3ObjectVersion + +```ts +withRevocationsS3ObjectVersion() +``` + +`aws.string.withRevocationsS3ObjectVersion` constructs a mixin object that can be merged into the `string` +Terraform resource block to set or update the revocations_s3_object_version field. + + + +**Args**: + - `resourceLabel` (`string`): The name label of the block to update. + - `value` (`string`): The value to set for the `revocations_s3_object_version` field. + + +### fn withTimeouts + +```ts +withTimeouts() +``` + +`aws.obj.withTimeouts` constructs a mixin object that can be merged into the `obj` +Terraform resource block to set or update the timeouts field. + +This function will replace the map with the passed in `value`. If you wish to instead merge the +passed in value to the existing map, use the [aws.obj.withTimeoutsMixin](TODO) function. + +**Args**: + - `resourceLabel` (`string`): The name label of the block to update. + - `value` (`obj`): The value to set for the `timeouts` field. + + +### fn withTimeoutsMixin + +```ts +withTimeoutsMixin() +``` + +`aws.obj.withTimeoutsMixin` constructs a mixin object that can be merged into the `obj` +Terraform resource block to set or update the timeouts field. + +This function will merge the passed in value to the existing map. If you wish +to instead replace the entire map with the passed in `value`, use the [aws.obj.withTimeouts](TODO) +function. + + +**Args**: + - `resourceLabel` (`string`): The name label of the block to update. + - `value` (`obj`): The value to set for the `timeouts` field. + + +### fn withTrustStoreArn + +```ts +withTrustStoreArn() +``` + +`aws.string.withTrustStoreArn` constructs a mixin object that can be merged into the `string` +Terraform resource block to set or update the trust_store_arn field. + + + +**Args**: + - `resourceLabel` (`string`): The name label of the block to update. + - `value` (`string`): The value to set for the `trust_store_arn` field. + + +## obj timeouts + + + +### fn timeouts.new + +```ts +new() +``` + + +`aws.lb_trust_store_revocation.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. + +**Returns**: + - An attribute object that represents the `timeouts` sub block. diff --git a/docs/5.x/provider.md b/docs/5.x/provider.md index 488d311f..2b7445db 100644 --- a/docs/5.x/provider.md +++ b/docs/5.x/provider.md @@ -427,6 +427,7 @@ Terraform sub block. - `location` (`string`): Use this to override the default service endpoint URL When `null`, the `location` field will be omitted from the resulting object. - `locationservice` (`string`): Use this to override the default service endpoint URL When `null`, the `locationservice` field will be omitted from the resulting object. - `logs` (`string`): Use this to override the default service endpoint URL When `null`, the `logs` field will be omitted from the resulting object. + - `lookoutmetrics` (`string`): Use this to override the default service endpoint URL When `null`, the `lookoutmetrics` field will be omitted from the resulting object. - `macie2` (`string`): Use this to override the default service endpoint URL When `null`, the `macie2` field will be omitted from the resulting object. - `managedgrafana` (`string`): Use this to override the default service endpoint URL When `null`, the `managedgrafana` field will be omitted from the resulting object. - `mediaconnect` (`string`): Use this to override the default service endpoint URL When `null`, the `mediaconnect` field will be omitted from the resulting object. diff --git a/docs/5.x/sagemaker_app.md b/docs/5.x/sagemaker_app.md index f610a7cb..7e2de2eb 100644 --- a/docs/5.x/sagemaker_app.md +++ b/docs/5.x/sagemaker_app.md @@ -269,6 +269,7 @@ Terraform sub block. - `instance_type` (`string`): Set the `instance_type` field on the resulting object. When `null`, the `instance_type` field will be omitted from the resulting object. - `lifecycle_config_arn` (`string`): Set the `lifecycle_config_arn` field on the resulting object. When `null`, the `lifecycle_config_arn` field will be omitted from the resulting object. - `sagemaker_image_arn` (`string`): Set the `sagemaker_image_arn` field on the resulting object. When `null`, the `sagemaker_image_arn` field will be omitted from the resulting object. + - `sagemaker_image_version_alias` (`string`): Set the `sagemaker_image_version_alias` field on the resulting object. When `null`, the `sagemaker_image_version_alias` field will be omitted from the resulting object. - `sagemaker_image_version_arn` (`string`): Set the `sagemaker_image_version_arn` field on the resulting object. When `null`, the `sagemaker_image_version_arn` field will be omitted from the resulting object. **Returns**: diff --git a/docs/5.x/sagemaker_app_image_config.md b/docs/5.x/sagemaker_app_image_config.md index d0bb9813..b84ae550 100644 --- a/docs/5.x/sagemaker_app_image_config.md +++ b/docs/5.x/sagemaker_app_image_config.md @@ -16,10 +16,16 @@ This package contains functions and utilities for setting up the resource using * [`fn new()`](#fn-new) * [`fn newAttrs()`](#fn-newattrs) * [`fn withAppImageConfigName()`](#fn-withappimageconfigname) +* [`fn withJupyterLabImageConfig()`](#fn-withjupyterlabimageconfig) +* [`fn withJupyterLabImageConfigMixin()`](#fn-withjupyterlabimageconfigmixin) * [`fn withKernelGatewayImageConfig()`](#fn-withkernelgatewayimageconfig) * [`fn withKernelGatewayImageConfigMixin()`](#fn-withkernelgatewayimageconfigmixin) * [`fn withTags()`](#fn-withtags) * [`fn withTagsAll()`](#fn-withtagsall) +* [`obj jupyter_lab_image_config`](#obj-jupyter_lab_image_config) + * [`fn new()`](#fn-jupyter_lab_image_confignew) + * [`obj jupyter_lab_image_config.container_config`](#obj-jupyter_lab_image_configcontainer_config) + * [`fn new()`](#fn-jupyter_lab_image_configcontainer_confignew) * [`obj kernel_gateway_image_config`](#obj-kernel_gateway_image_config) * [`fn new()`](#fn-kernel_gateway_image_confignew) * [`obj kernel_gateway_image_config.file_system_config`](#obj-kernel_gateway_image_configfile_system_config) @@ -59,6 +65,7 @@ or `$` to refer to the root object. Instead, make an explicit outer object using - `app_image_config_name` (`string`): Set the `app_image_config_name` field on the resulting resource block. - `tags` (`obj`): Set the `tags` field on the resulting resource block. When `null`, the `tags` field will be omitted from the resulting object. - `tags_all` (`obj`): Set the `tags_all` field on the resulting resource block. When `null`, the `tags_all` field will be omitted from the resulting object. + - `jupyter_lab_image_config` (`list[obj]`): Set the `jupyter_lab_image_config` field on the resulting resource block. When `null`, the `jupyter_lab_image_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_app_image_config.jupyter_lab_image_config.new](#fn-jupyter_lab_image_confignew) constructor. - `kernel_gateway_image_config` (`list[obj]`): Set the `kernel_gateway_image_config` field on the resulting resource block. When `null`, the `kernel_gateway_image_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_app_image_config.kernel_gateway_image_config.new](#fn-kernel_gateway_image_confignew) constructor. **Returns**: @@ -86,6 +93,7 @@ injecting into a complete block. - `app_image_config_name` (`string`): Set the `app_image_config_name` field on the resulting object. - `tags` (`obj`): Set the `tags` field on the resulting object. When `null`, the `tags` field will be omitted from the resulting object. - `tags_all` (`obj`): Set the `tags_all` field on the resulting object. When `null`, the `tags_all` field will be omitted from the resulting object. + - `jupyter_lab_image_config` (`list[obj]`): Set the `jupyter_lab_image_config` field on the resulting object. When `null`, the `jupyter_lab_image_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_app_image_config.jupyter_lab_image_config.new](#fn-jupyter_lab_image_confignew) constructor. - `kernel_gateway_image_config` (`list[obj]`): Set the `kernel_gateway_image_config` field on the resulting object. When `null`, the `kernel_gateway_image_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_app_image_config.kernel_gateway_image_config.new](#fn-kernel_gateway_image_confignew) constructor. **Returns**: @@ -108,6 +116,43 @@ Terraform resource block to set or update the app_image_config_name field. - `value` (`string`): The value to set for the `app_image_config_name` field. +### fn withJupyterLabImageConfig + +```ts +withJupyterLabImageConfig() +``` + +`aws.list[obj].withJupyterLabImageConfig` constructs a mixin object that can be merged into the `list[obj]` +Terraform resource block to set or update the jupyter_lab_image_config field. + +This function will replace the array with the passed in `value`. If you wish to instead append the +passed in value to the existing array, use the [aws.list[obj].withJupyterLabImageConfigMixin](TODO) function. + + +**Args**: + - `resourceLabel` (`string`): The name label of the block to update. + - `value` (`list[obj]`): The value to set for the `jupyter_lab_image_config` field. + + +### fn withJupyterLabImageConfigMixin + +```ts +withJupyterLabImageConfigMixin() +``` + +`aws.list[obj].withJupyterLabImageConfigMixin` constructs a mixin object that can be merged into the `list[obj]` +Terraform resource block to set or update the jupyter_lab_image_config field. + +This function will append the passed in array or object to the existing array. If you wish +to instead replace the array with the passed in `value`, use the [aws.list[obj].withJupyterLabImageConfig](TODO) +function. + + +**Args**: + - `resourceLabel` (`string`): The name label of the block to update. + - `value` (`list[obj]`): The value to set for the `jupyter_lab_image_config` field. + + ### fn withKernelGatewayImageConfig ```ts @@ -177,6 +222,54 @@ Terraform resource block to set or update the tags_all field. - `value` (`obj`): The value to set for the `tags_all` field. +## obj jupyter_lab_image_config + + + +### fn jupyter_lab_image_config.new + +```ts +new() +``` + + +`aws.sagemaker_app_image_config.jupyter_lab_image_config.new` constructs a new object with attributes and blocks configured for the `jupyter_lab_image_config` +Terraform sub block. + + + +**Args**: + - `container_config` (`list[obj]`): Set the `container_config` field on the resulting object. When `null`, the `container_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_app_image_config.jupyter_lab_image_config.container_config.new](#fn-jupyter_lab_image_configcontainer_confignew) constructor. + +**Returns**: + - An attribute object that represents the `jupyter_lab_image_config` sub block. + + +## obj jupyter_lab_image_config.container_config + + + +### fn jupyter_lab_image_config.container_config.new + +```ts +new() +``` + + +`aws.sagemaker_app_image_config.jupyter_lab_image_config.container_config.new` constructs a new object with attributes and blocks configured for the `container_config` +Terraform sub block. + + + +**Args**: + - `container_arguments` (`list`): Set the `container_arguments` field on the resulting object. When `null`, the `container_arguments` field will be omitted from the resulting object. + - `container_entrypoint` (`list`): Set the `container_entrypoint` field on the resulting object. When `null`, the `container_entrypoint` field will be omitted from the resulting object. + - `container_environment_variables` (`obj`): Set the `container_environment_variables` field on the resulting object. When `null`, the `container_environment_variables` field will be omitted from the resulting object. + +**Returns**: + - An attribute object that represents the `container_config` sub block. + + ## obj kernel_gateway_image_config diff --git a/docs/5.x/sagemaker_domain.md b/docs/5.x/sagemaker_domain.md index f9bb0c07..7277f879 100644 --- a/docs/5.x/sagemaker_domain.md +++ b/docs/5.x/sagemaker_domain.md @@ -62,6 +62,24 @@ This package contains functions and utilities for setting up the resource using * [`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.code_editor_app_settings`](#obj-default_user_settingscode_editor_app_settings) + * [`fn new()`](#fn-default_user_settingscode_editor_app_settingsnew) + * [`obj default_user_settings.code_editor_app_settings.default_resource_spec`](#obj-default_user_settingscode_editor_app_settingsdefault_resource_spec) + * [`fn new()`](#fn-default_user_settingscode_editor_app_settingsdefault_resource_specnew) + * [`obj default_user_settings.custom_file_system_config`](#obj-default_user_settingscustom_file_system_config) + * [`fn new()`](#fn-default_user_settingscustom_file_system_confignew) + * [`obj default_user_settings.custom_file_system_config.efs_file_system_config`](#obj-default_user_settingscustom_file_system_configefs_file_system_config) + * [`fn new()`](#fn-default_user_settingscustom_file_system_configefs_file_system_confignew) + * [`obj default_user_settings.custom_posix_user_config`](#obj-default_user_settingscustom_posix_user_config) + * [`fn new()`](#fn-default_user_settingscustom_posix_user_confignew) + * [`obj default_user_settings.jupyter_lab_app_settings`](#obj-default_user_settingsjupyter_lab_app_settings) + * [`fn new()`](#fn-default_user_settingsjupyter_lab_app_settingsnew) + * [`obj default_user_settings.jupyter_lab_app_settings.code_repository`](#obj-default_user_settingsjupyter_lab_app_settingscode_repository) + * [`fn new()`](#fn-default_user_settingsjupyter_lab_app_settingscode_repositorynew) + * [`obj default_user_settings.jupyter_lab_app_settings.custom_image`](#obj-default_user_settingsjupyter_lab_app_settingscustom_image) + * [`fn new()`](#fn-default_user_settingsjupyter_lab_app_settingscustom_imagenew) + * [`obj default_user_settings.jupyter_lab_app_settings.default_resource_spec`](#obj-default_user_settingsjupyter_lab_app_settingsdefault_resource_spec) + * [`fn new()`](#fn-default_user_settingsjupyter_lab_app_settingsdefault_resource_specnew) * [`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) @@ -84,6 +102,10 @@ This package contains functions and utilities for setting up the resource using * [`fn new()`](#fn-default_user_settingsr_studio_server_pro_app_settingsnew) * [`obj default_user_settings.sharing_settings`](#obj-default_user_settingssharing_settings) * [`fn new()`](#fn-default_user_settingssharing_settingsnew) + * [`obj default_user_settings.space_storage_settings`](#obj-default_user_settingsspace_storage_settings) + * [`fn new()`](#fn-default_user_settingsspace_storage_settingsnew) + * [`obj default_user_settings.space_storage_settings.default_ebs_storage_settings`](#obj-default_user_settingsspace_storage_settingsdefault_ebs_storage_settings) + * [`fn new()`](#fn-default_user_settingsspace_storage_settingsdefault_ebs_storage_settingsnew) * [`obj default_user_settings.tensor_board_app_settings`](#obj-default_user_settingstensor_board_app_settings) * [`fn new()`](#fn-default_user_settingstensor_board_app_settingsnew) * [`obj default_user_settings.tensor_board_app_settings.default_resource_spec`](#obj-default_user_settingstensor_board_app_settingsdefault_resource_spec) @@ -566,6 +588,7 @@ Terraform sub block. - `instance_type` (`string`): Set the `instance_type` field on the resulting object. When `null`, the `instance_type` field will be omitted from the resulting object. - `lifecycle_config_arn` (`string`): Set the `lifecycle_config_arn` field on the resulting object. When `null`, the `lifecycle_config_arn` field will be omitted from the resulting object. - `sagemaker_image_arn` (`string`): Set the `sagemaker_image_arn` field on the resulting object. When `null`, the `sagemaker_image_arn` field will be omitted from the resulting object. + - `sagemaker_image_version_alias` (`string`): Set the `sagemaker_image_version_alias` field on the resulting object. When `null`, the `sagemaker_image_version_alias` field will be omitted from the resulting object. - `sagemaker_image_version_arn` (`string`): Set the `sagemaker_image_version_arn` field on the resulting object. When `null`, the `sagemaker_image_version_arn` field will be omitted from the resulting object. **Returns**: @@ -642,6 +665,7 @@ Terraform sub block. - `instance_type` (`string`): Set the `instance_type` field on the resulting object. When `null`, the `instance_type` field will be omitted from the resulting object. - `lifecycle_config_arn` (`string`): Set the `lifecycle_config_arn` field on the resulting object. When `null`, the `lifecycle_config_arn` field will be omitted from the resulting object. - `sagemaker_image_arn` (`string`): Set the `sagemaker_image_arn` field on the resulting object. When `null`, the `sagemaker_image_arn` field will be omitted from the resulting object. + - `sagemaker_image_version_alias` (`string`): Set the `sagemaker_image_version_alias` field on the resulting object. When `null`, the `sagemaker_image_version_alias` field will be omitted from the resulting object. - `sagemaker_image_version_arn` (`string`): Set the `sagemaker_image_version_arn` field on the resulting object. When `null`, the `sagemaker_image_version_arn` field will be omitted from the resulting object. **Returns**: @@ -665,14 +689,21 @@ Terraform sub block. **Args**: + - `default_landing_uri` (`string`): Set the `default_landing_uri` field on the resulting object. When `null`, the `default_landing_uri` field will be omitted from the resulting object. - `execution_role` (`string`): Set the `execution_role` field on the resulting object. - `security_groups` (`list`): Set the `security_groups` field on the resulting object. When `null`, the `security_groups` field will be omitted from the resulting object. + - `studio_web_portal` (`string`): Set the `studio_web_portal` field on the resulting object. When `null`, the `studio_web_portal` field will be omitted from the resulting object. - `canvas_app_settings` (`list[obj]`): Set the `canvas_app_settings` field on the resulting object. When `null`, the `canvas_app_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.new](#fn-default_user_settingscanvas_app_settingsnew) constructor. + - `code_editor_app_settings` (`list[obj]`): Set the `code_editor_app_settings` field on the resulting object. When `null`, the `code_editor_app_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.code_editor_app_settings.new](#fn-default_user_settingscode_editor_app_settingsnew) constructor. + - `custom_file_system_config` (`list[obj]`): Set the `custom_file_system_config` field on the resulting object. When `null`, the `custom_file_system_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_domain.default_user_settings.custom_file_system_config.new](#fn-default_user_settingscustom_file_system_confignew) constructor. + - `custom_posix_user_config` (`list[obj]`): Set the `custom_posix_user_config` field on the resulting object. When `null`, the `custom_posix_user_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_domain.default_user_settings.custom_posix_user_config.new](#fn-default_user_settingscustom_posix_user_confignew) constructor. + - `jupyter_lab_app_settings` (`list[obj]`): Set the `jupyter_lab_app_settings` field on the resulting object. When `null`, the `jupyter_lab_app_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.jupyter_lab_app_settings.new](#fn-default_user_settingsjupyter_lab_app_settingsnew) constructor. - `jupyter_server_app_settings` (`list[obj]`): Set the `jupyter_server_app_settings` field on the resulting object. When `null`, the `jupyter_server_app_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.jupyter_server_app_settings.new](#fn-default_user_settingsjupyter_server_app_settingsnew) constructor. - `kernel_gateway_app_settings` (`list[obj]`): Set the `kernel_gateway_app_settings` field on the resulting object. When `null`, the `kernel_gateway_app_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.kernel_gateway_app_settings.new](#fn-default_user_settingskernel_gateway_app_settingsnew) constructor. - `r_session_app_settings` (`list[obj]`): Set the `r_session_app_settings` field on the resulting object. When `null`, the `r_session_app_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.r_session_app_settings.new](#fn-default_user_settingsr_session_app_settingsnew) constructor. - `r_studio_server_pro_app_settings` (`list[obj]`): Set the `r_studio_server_pro_app_settings` field on the resulting object. When `null`, the `r_studio_server_pro_app_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.r_studio_server_pro_app_settings.new](#fn-default_user_settingsr_studio_server_pro_app_settingsnew) constructor. - `sharing_settings` (`list[obj]`): Set the `sharing_settings` field on the resulting object. When `null`, the `sharing_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.sharing_settings.new](#fn-default_user_settingssharing_settingsnew) constructor. + - `space_storage_settings` (`list[obj]`): Set the `space_storage_settings` field on the resulting object. When `null`, the `space_storage_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.space_storage_settings.new](#fn-default_user_settingsspace_storage_settingsnew) constructor. - `tensor_board_app_settings` (`list[obj]`): Set the `tensor_board_app_settings` field on the resulting object. When `null`, the `tensor_board_app_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.tensor_board_app_settings.new](#fn-default_user_settingstensor_board_app_settingsnew) constructor. **Returns**: @@ -850,6 +881,229 @@ Terraform sub block. - An attribute object that represents the `workspace_settings` sub block. +## obj default_user_settings.code_editor_app_settings + + + +### fn default_user_settings.code_editor_app_settings.new + +```ts +new() +``` + + +`aws.sagemaker_domain.default_user_settings.code_editor_app_settings.new` constructs a new object with attributes and blocks configured for the `code_editor_app_settings` +Terraform sub block. + + + +**Args**: + - `lifecycle_config_arns` (`list`): Set the `lifecycle_config_arns` field on the resulting object. When `null`, the `lifecycle_config_arns` field will be omitted from the resulting object. + - `default_resource_spec` (`list[obj]`): Set the `default_resource_spec` field on the resulting object. When `null`, the `default_resource_spec` 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.code_editor_app_settings.default_resource_spec.new](#fn-default_user_settingsdefault_user_settingsdefault_resource_specnew) constructor. + +**Returns**: + - An attribute object that represents the `code_editor_app_settings` sub block. + + +## obj default_user_settings.code_editor_app_settings.default_resource_spec + + + +### fn default_user_settings.code_editor_app_settings.default_resource_spec.new + +```ts +new() +``` + + +`aws.sagemaker_domain.default_user_settings.code_editor_app_settings.default_resource_spec.new` constructs a new object with attributes and blocks configured for the `default_resource_spec` +Terraform sub block. + + + +**Args**: + - `instance_type` (`string`): Set the `instance_type` field on the resulting object. When `null`, the `instance_type` field will be omitted from the resulting object. + - `lifecycle_config_arn` (`string`): Set the `lifecycle_config_arn` field on the resulting object. When `null`, the `lifecycle_config_arn` field will be omitted from the resulting object. + - `sagemaker_image_arn` (`string`): Set the `sagemaker_image_arn` field on the resulting object. When `null`, the `sagemaker_image_arn` field will be omitted from the resulting object. + - `sagemaker_image_version_alias` (`string`): Set the `sagemaker_image_version_alias` field on the resulting object. When `null`, the `sagemaker_image_version_alias` field will be omitted from the resulting object. + - `sagemaker_image_version_arn` (`string`): Set the `sagemaker_image_version_arn` field on the resulting object. When `null`, the `sagemaker_image_version_arn` field will be omitted from the resulting object. + +**Returns**: + - An attribute object that represents the `default_resource_spec` sub block. + + +## obj default_user_settings.custom_file_system_config + + + +### fn default_user_settings.custom_file_system_config.new + +```ts +new() +``` + + +`aws.sagemaker_domain.default_user_settings.custom_file_system_config.new` constructs a new object with attributes and blocks configured for the `custom_file_system_config` +Terraform sub block. + + + +**Args**: + - `efs_file_system_config` (`list[obj]`): Set the `efs_file_system_config` field on the resulting object. When `null`, the `efs_file_system_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_domain.default_user_settings.custom_file_system_config.efs_file_system_config.new](#fn-default_user_settingsdefault_user_settingsefs_file_system_confignew) constructor. + +**Returns**: + - An attribute object that represents the `custom_file_system_config` sub block. + + +## obj default_user_settings.custom_file_system_config.efs_file_system_config + + + +### fn default_user_settings.custom_file_system_config.efs_file_system_config.new + +```ts +new() +``` + + +`aws.sagemaker_domain.default_user_settings.custom_file_system_config.efs_file_system_config.new` constructs a new object with attributes and blocks configured for the `efs_file_system_config` +Terraform sub block. + + + +**Args**: + - `file_system_id` (`string`): Set the `file_system_id` field on the resulting object. + - `file_system_path` (`string`): Set the `file_system_path` field on the resulting object. + +**Returns**: + - An attribute object that represents the `efs_file_system_config` sub block. + + +## obj default_user_settings.custom_posix_user_config + + + +### fn default_user_settings.custom_posix_user_config.new + +```ts +new() +``` + + +`aws.sagemaker_domain.default_user_settings.custom_posix_user_config.new` constructs a new object with attributes and blocks configured for the `custom_posix_user_config` +Terraform sub block. + + + +**Args**: + - `gid` (`number`): Set the `gid` field on the resulting object. + - `uid` (`number`): Set the `uid` field on the resulting object. + +**Returns**: + - An attribute object that represents the `custom_posix_user_config` sub block. + + +## obj default_user_settings.jupyter_lab_app_settings + + + +### fn default_user_settings.jupyter_lab_app_settings.new + +```ts +new() +``` + + +`aws.sagemaker_domain.default_user_settings.jupyter_lab_app_settings.new` constructs a new object with attributes and blocks configured for the `jupyter_lab_app_settings` +Terraform sub block. + + + +**Args**: + - `lifecycle_config_arns` (`list`): Set the `lifecycle_config_arns` field on the resulting object. When `null`, the `lifecycle_config_arns` field will be omitted from the resulting object. + - `code_repository` (`list[obj]`): Set the `code_repository` field on the resulting object. When `null`, the `code_repository` 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.jupyter_lab_app_settings.code_repository.new](#fn-default_user_settingsdefault_user_settingscode_repositorynew) constructor. + - `custom_image` (`list[obj]`): Set the `custom_image` field on the resulting object. When `null`, the `custom_image` 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.jupyter_lab_app_settings.custom_image.new](#fn-default_user_settingsdefault_user_settingscustom_imagenew) constructor. + - `default_resource_spec` (`list[obj]`): Set the `default_resource_spec` field on the resulting object. When `null`, the `default_resource_spec` 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.jupyter_lab_app_settings.default_resource_spec.new](#fn-default_user_settingsdefault_user_settingsdefault_resource_specnew) constructor. + +**Returns**: + - An attribute object that represents the `jupyter_lab_app_settings` sub block. + + +## obj default_user_settings.jupyter_lab_app_settings.code_repository + + + +### fn default_user_settings.jupyter_lab_app_settings.code_repository.new + +```ts +new() +``` + + +`aws.sagemaker_domain.default_user_settings.jupyter_lab_app_settings.code_repository.new` constructs a new object with attributes and blocks configured for the `code_repository` +Terraform sub block. + + + +**Args**: + - `repository_url` (`string`): Set the `repository_url` field on the resulting object. + +**Returns**: + - An attribute object that represents the `code_repository` sub block. + + +## obj default_user_settings.jupyter_lab_app_settings.custom_image + + + +### fn default_user_settings.jupyter_lab_app_settings.custom_image.new + +```ts +new() +``` + + +`aws.sagemaker_domain.default_user_settings.jupyter_lab_app_settings.custom_image.new` constructs a new object with attributes and blocks configured for the `custom_image` +Terraform sub block. + + + +**Args**: + - `app_image_config_name` (`string`): Set the `app_image_config_name` field on the resulting object. + - `image_name` (`string`): Set the `image_name` field on the resulting object. + - `image_version_number` (`number`): Set the `image_version_number` field on the resulting object. When `null`, the `image_version_number` field will be omitted from the resulting object. + +**Returns**: + - An attribute object that represents the `custom_image` sub block. + + +## obj default_user_settings.jupyter_lab_app_settings.default_resource_spec + + + +### fn default_user_settings.jupyter_lab_app_settings.default_resource_spec.new + +```ts +new() +``` + + +`aws.sagemaker_domain.default_user_settings.jupyter_lab_app_settings.default_resource_spec.new` constructs a new object with attributes and blocks configured for the `default_resource_spec` +Terraform sub block. + + + +**Args**: + - `instance_type` (`string`): Set the `instance_type` field on the resulting object. When `null`, the `instance_type` field will be omitted from the resulting object. + - `lifecycle_config_arn` (`string`): Set the `lifecycle_config_arn` field on the resulting object. When `null`, the `lifecycle_config_arn` field will be omitted from the resulting object. + - `sagemaker_image_arn` (`string`): Set the `sagemaker_image_arn` field on the resulting object. When `null`, the `sagemaker_image_arn` field will be omitted from the resulting object. + - `sagemaker_image_version_alias` (`string`): Set the `sagemaker_image_version_alias` field on the resulting object. When `null`, the `sagemaker_image_version_alias` field will be omitted from the resulting object. + - `sagemaker_image_version_arn` (`string`): Set the `sagemaker_image_version_arn` field on the resulting object. When `null`, the `sagemaker_image_version_arn` field will be omitted from the resulting object. + +**Returns**: + - An attribute object that represents the `default_resource_spec` sub block. + + ## obj default_user_settings.jupyter_server_app_settings @@ -918,6 +1172,7 @@ Terraform sub block. - `instance_type` (`string`): Set the `instance_type` field on the resulting object. When `null`, the `instance_type` field will be omitted from the resulting object. - `lifecycle_config_arn` (`string`): Set the `lifecycle_config_arn` field on the resulting object. When `null`, the `lifecycle_config_arn` field will be omitted from the resulting object. - `sagemaker_image_arn` (`string`): Set the `sagemaker_image_arn` field on the resulting object. When `null`, the `sagemaker_image_arn` field will be omitted from the resulting object. + - `sagemaker_image_version_alias` (`string`): Set the `sagemaker_image_version_alias` field on the resulting object. When `null`, the `sagemaker_image_version_alias` field will be omitted from the resulting object. - `sagemaker_image_version_arn` (`string`): Set the `sagemaker_image_version_arn` field on the resulting object. When `null`, the `sagemaker_image_version_arn` field will be omitted from the resulting object. **Returns**: @@ -994,6 +1249,7 @@ Terraform sub block. - `instance_type` (`string`): Set the `instance_type` field on the resulting object. When `null`, the `instance_type` field will be omitted from the resulting object. - `lifecycle_config_arn` (`string`): Set the `lifecycle_config_arn` field on the resulting object. When `null`, the `lifecycle_config_arn` field will be omitted from the resulting object. - `sagemaker_image_arn` (`string`): Set the `sagemaker_image_arn` field on the resulting object. When `null`, the `sagemaker_image_arn` field will be omitted from the resulting object. + - `sagemaker_image_version_alias` (`string`): Set the `sagemaker_image_version_alias` field on the resulting object. When `null`, the `sagemaker_image_version_alias` field will be omitted from the resulting object. - `sagemaker_image_version_arn` (`string`): Set the `sagemaker_image_version_arn` field on the resulting object. When `null`, the `sagemaker_image_version_arn` field will be omitted from the resulting object. **Returns**: @@ -1069,6 +1325,7 @@ Terraform sub block. - `instance_type` (`string`): Set the `instance_type` field on the resulting object. When `null`, the `instance_type` field will be omitted from the resulting object. - `lifecycle_config_arn` (`string`): Set the `lifecycle_config_arn` field on the resulting object. When `null`, the `lifecycle_config_arn` field will be omitted from the resulting object. - `sagemaker_image_arn` (`string`): Set the `sagemaker_image_arn` field on the resulting object. When `null`, the `sagemaker_image_arn` field will be omitted from the resulting object. + - `sagemaker_image_version_alias` (`string`): Set the `sagemaker_image_version_alias` field on the resulting object. When `null`, the `sagemaker_image_version_alias` field will be omitted from the resulting object. - `sagemaker_image_version_arn` (`string`): Set the `sagemaker_image_version_arn` field on the resulting object. When `null`, the `sagemaker_image_version_arn` field will be omitted from the resulting object. **Returns**: @@ -1124,6 +1381,53 @@ Terraform sub block. - An attribute object that represents the `sharing_settings` sub block. +## obj default_user_settings.space_storage_settings + + + +### fn default_user_settings.space_storage_settings.new + +```ts +new() +``` + + +`aws.sagemaker_domain.default_user_settings.space_storage_settings.new` constructs a new object with attributes and blocks configured for the `space_storage_settings` +Terraform sub block. + + + +**Args**: + - `default_ebs_storage_settings` (`list[obj]`): Set the `default_ebs_storage_settings` field on the resulting object. When `null`, the `default_ebs_storage_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.space_storage_settings.default_ebs_storage_settings.new](#fn-default_user_settingsdefault_user_settingsdefault_ebs_storage_settingsnew) constructor. + +**Returns**: + - An attribute object that represents the `space_storage_settings` sub block. + + +## obj default_user_settings.space_storage_settings.default_ebs_storage_settings + + + +### fn default_user_settings.space_storage_settings.default_ebs_storage_settings.new + +```ts +new() +``` + + +`aws.sagemaker_domain.default_user_settings.space_storage_settings.default_ebs_storage_settings.new` constructs a new object with attributes and blocks configured for the `default_ebs_storage_settings` +Terraform sub block. + + + +**Args**: + - `default_ebs_volume_size_in_gb` (`number`): Set the `default_ebs_volume_size_in_gb` field on the resulting object. + - `maximum_ebs_volume_size_in_gb` (`number`): Set the `maximum_ebs_volume_size_in_gb` field on the resulting object. + +**Returns**: + - An attribute object that represents the `default_ebs_storage_settings` sub block. + + ## obj default_user_settings.tensor_board_app_settings @@ -1167,6 +1471,7 @@ Terraform sub block. - `instance_type` (`string`): Set the `instance_type` field on the resulting object. When `null`, the `instance_type` field will be omitted from the resulting object. - `lifecycle_config_arn` (`string`): Set the `lifecycle_config_arn` field on the resulting object. When `null`, the `lifecycle_config_arn` field will be omitted from the resulting object. - `sagemaker_image_arn` (`string`): Set the `sagemaker_image_arn` field on the resulting object. When `null`, the `sagemaker_image_arn` field will be omitted from the resulting object. + - `sagemaker_image_version_alias` (`string`): Set the `sagemaker_image_version_alias` field on the resulting object. When `null`, the `sagemaker_image_version_alias` field will be omitted from the resulting object. - `sagemaker_image_version_arn` (`string`): Set the `sagemaker_image_version_arn` field on the resulting object. When `null`, the `sagemaker_image_version_arn` field will be omitted from the resulting object. **Returns**: @@ -1244,6 +1549,7 @@ Terraform sub block. - `instance_type` (`string`): Set the `instance_type` field on the resulting object. When `null`, the `instance_type` field will be omitted from the resulting object. - `lifecycle_config_arn` (`string`): Set the `lifecycle_config_arn` field on the resulting object. When `null`, the `lifecycle_config_arn` field will be omitted from the resulting object. - `sagemaker_image_arn` (`string`): Set the `sagemaker_image_arn` field on the resulting object. When `null`, the `sagemaker_image_arn` field will be omitted from the resulting object. + - `sagemaker_image_version_alias` (`string`): Set the `sagemaker_image_version_alias` field on the resulting object. When `null`, the `sagemaker_image_version_alias` field will be omitted from the resulting object. - `sagemaker_image_version_arn` (`string`): Set the `sagemaker_image_version_arn` field on the resulting object. When `null`, the `sagemaker_image_version_arn` field will be omitted from the resulting object. **Returns**: diff --git a/docs/5.x/sagemaker_space.md b/docs/5.x/sagemaker_space.md index 1564a0e2..4be8be46 100644 --- a/docs/5.x/sagemaker_space.md +++ b/docs/5.x/sagemaker_space.md @@ -16,6 +16,7 @@ This package contains functions and utilities for setting up the resource using * [`fn new()`](#fn-new) * [`fn newAttrs()`](#fn-newattrs) * [`fn withDomainId()`](#fn-withdomainid) +* [`fn withSpaceDisplayName()`](#fn-withspacedisplayname) * [`fn withSpaceName()`](#fn-withspacename) * [`fn withSpaceSettings()`](#fn-withspacesettings) * [`fn withSpaceSettingsMixin()`](#fn-withspacesettingsmixin) @@ -66,6 +67,7 @@ or `$` to refer to the root object. Instead, make an explicit outer object using **Args**: - `resourceLabel` (`string`): The name label of the block. - `domain_id` (`string`): Set the `domain_id` field on the resulting resource block. + - `space_display_name` (`string`): Set the `space_display_name` field on the resulting resource block. When `null`, the `space_display_name` field will be omitted from the resulting object. - `space_name` (`string`): Set the `space_name` field on the resulting resource block. - `tags` (`obj`): Set the `tags` field on the resulting resource block. When `null`, the `tags` field will be omitted from the resulting object. - `tags_all` (`obj`): Set the `tags_all` field on the resulting resource block. When `null`, the `tags_all` field will be omitted from the resulting object. @@ -94,6 +96,7 @@ injecting into a complete block. **Args**: - `domain_id` (`string`): Set the `domain_id` field on the resulting object. + - `space_display_name` (`string`): Set the `space_display_name` field on the resulting object. When `null`, the `space_display_name` field will be omitted from the resulting object. - `space_name` (`string`): Set the `space_name` field on the resulting object. - `tags` (`obj`): Set the `tags` field on the resulting object. When `null`, the `tags` field will be omitted from the resulting object. - `tags_all` (`obj`): Set the `tags_all` field on the resulting object. When `null`, the `tags_all` field will be omitted from the resulting object. @@ -119,6 +122,22 @@ Terraform resource block to set or update the domain_id field. - `value` (`string`): The value to set for the `domain_id` field. +### fn withSpaceDisplayName + +```ts +withSpaceDisplayName() +``` + +`aws.string.withSpaceDisplayName` constructs a mixin object that can be merged into the `string` +Terraform resource block to set or update the space_display_name field. + + + +**Args**: + - `resourceLabel` (`string`): The name label of the block to update. + - `value` (`string`): The value to set for the `space_display_name` field. + + ### fn withSpaceName ```ts @@ -296,6 +315,7 @@ Terraform sub block. - `instance_type` (`string`): Set the `instance_type` field on the resulting object. When `null`, the `instance_type` field will be omitted from the resulting object. - `lifecycle_config_arn` (`string`): Set the `lifecycle_config_arn` field on the resulting object. When `null`, the `lifecycle_config_arn` field will be omitted from the resulting object. - `sagemaker_image_arn` (`string`): Set the `sagemaker_image_arn` field on the resulting object. When `null`, the `sagemaker_image_arn` field will be omitted from the resulting object. + - `sagemaker_image_version_alias` (`string`): Set the `sagemaker_image_version_alias` field on the resulting object. When `null`, the `sagemaker_image_version_alias` field will be omitted from the resulting object. - `sagemaker_image_version_arn` (`string`): Set the `sagemaker_image_version_arn` field on the resulting object. When `null`, the `sagemaker_image_version_arn` field will be omitted from the resulting object. **Returns**: @@ -372,6 +392,7 @@ Terraform sub block. - `instance_type` (`string`): Set the `instance_type` field on the resulting object. When `null`, the `instance_type` field will be omitted from the resulting object. - `lifecycle_config_arn` (`string`): Set the `lifecycle_config_arn` field on the resulting object. When `null`, the `lifecycle_config_arn` field will be omitted from the resulting object. - `sagemaker_image_arn` (`string`): Set the `sagemaker_image_arn` field on the resulting object. When `null`, the `sagemaker_image_arn` field will be omitted from the resulting object. + - `sagemaker_image_version_alias` (`string`): Set the `sagemaker_image_version_alias` field on the resulting object. When `null`, the `sagemaker_image_version_alias` field will be omitted from the resulting object. - `sagemaker_image_version_arn` (`string`): Set the `sagemaker_image_version_arn` field on the resulting object. When `null`, the `sagemaker_image_version_arn` field will be omitted from the resulting object. **Returns**: diff --git a/docs/5.x/sagemaker_user_profile.md b/docs/5.x/sagemaker_user_profile.md index b7f78b04..b4dfff06 100644 --- a/docs/5.x/sagemaker_user_profile.md +++ b/docs/5.x/sagemaker_user_profile.md @@ -39,6 +39,24 @@ This package contains functions and utilities for setting up the resource using * [`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.code_editor_app_settings`](#obj-user_settingscode_editor_app_settings) + * [`fn new()`](#fn-user_settingscode_editor_app_settingsnew) + * [`obj user_settings.code_editor_app_settings.default_resource_spec`](#obj-user_settingscode_editor_app_settingsdefault_resource_spec) + * [`fn new()`](#fn-user_settingscode_editor_app_settingsdefault_resource_specnew) + * [`obj user_settings.custom_file_system_config`](#obj-user_settingscustom_file_system_config) + * [`fn new()`](#fn-user_settingscustom_file_system_confignew) + * [`obj user_settings.custom_file_system_config.efs_file_system_config`](#obj-user_settingscustom_file_system_configefs_file_system_config) + * [`fn new()`](#fn-user_settingscustom_file_system_configefs_file_system_confignew) + * [`obj user_settings.custom_posix_user_config`](#obj-user_settingscustom_posix_user_config) + * [`fn new()`](#fn-user_settingscustom_posix_user_confignew) + * [`obj user_settings.jupyter_lab_app_settings`](#obj-user_settingsjupyter_lab_app_settings) + * [`fn new()`](#fn-user_settingsjupyter_lab_app_settingsnew) + * [`obj user_settings.jupyter_lab_app_settings.code_repository`](#obj-user_settingsjupyter_lab_app_settingscode_repository) + * [`fn new()`](#fn-user_settingsjupyter_lab_app_settingscode_repositorynew) + * [`obj user_settings.jupyter_lab_app_settings.custom_image`](#obj-user_settingsjupyter_lab_app_settingscustom_image) + * [`fn new()`](#fn-user_settingsjupyter_lab_app_settingscustom_imagenew) + * [`obj user_settings.jupyter_lab_app_settings.default_resource_spec`](#obj-user_settingsjupyter_lab_app_settingsdefault_resource_spec) + * [`fn new()`](#fn-user_settingsjupyter_lab_app_settingsdefault_resource_specnew) * [`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) @@ -61,6 +79,10 @@ This package contains functions and utilities for setting up the resource using * [`fn new()`](#fn-user_settingsr_studio_server_pro_app_settingsnew) * [`obj user_settings.sharing_settings`](#obj-user_settingssharing_settings) * [`fn new()`](#fn-user_settingssharing_settingsnew) + * [`obj user_settings.space_storage_settings`](#obj-user_settingsspace_storage_settings) + * [`fn new()`](#fn-user_settingsspace_storage_settingsnew) + * [`obj user_settings.space_storage_settings.default_ebs_storage_settings`](#obj-user_settingsspace_storage_settingsdefault_ebs_storage_settings) + * [`fn new()`](#fn-user_settingsspace_storage_settingsdefault_ebs_storage_settingsnew) * [`obj user_settings.tensor_board_app_settings`](#obj-user_settingstensor_board_app_settings) * [`fn new()`](#fn-user_settingstensor_board_app_settingsnew) * [`obj user_settings.tensor_board_app_settings.default_resource_spec`](#obj-user_settingstensor_board_app_settingsdefault_resource_spec) @@ -287,14 +309,21 @@ Terraform sub block. **Args**: + - `default_landing_uri` (`string`): Set the `default_landing_uri` field on the resulting object. When `null`, the `default_landing_uri` field will be omitted from the resulting object. - `execution_role` (`string`): Set the `execution_role` field on the resulting object. - `security_groups` (`list`): Set the `security_groups` field on the resulting object. When `null`, the `security_groups` field will be omitted from the resulting object. + - `studio_web_portal` (`string`): Set the `studio_web_portal` field on the resulting object. When `null`, the `studio_web_portal` field will be omitted from the resulting object. - `canvas_app_settings` (`list[obj]`): Set the `canvas_app_settings` field on the resulting object. When `null`, the `canvas_app_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.new](#fn-user_settingscanvas_app_settingsnew) constructor. + - `code_editor_app_settings` (`list[obj]`): Set the `code_editor_app_settings` field on the resulting object. When `null`, the `code_editor_app_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.code_editor_app_settings.new](#fn-user_settingscode_editor_app_settingsnew) constructor. + - `custom_file_system_config` (`list[obj]`): Set the `custom_file_system_config` field on the resulting object. When `null`, the `custom_file_system_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_user_profile.user_settings.custom_file_system_config.new](#fn-user_settingscustom_file_system_confignew) constructor. + - `custom_posix_user_config` (`list[obj]`): Set the `custom_posix_user_config` field on the resulting object. When `null`, the `custom_posix_user_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_user_profile.user_settings.custom_posix_user_config.new](#fn-user_settingscustom_posix_user_confignew) constructor. + - `jupyter_lab_app_settings` (`list[obj]`): Set the `jupyter_lab_app_settings` field on the resulting object. When `null`, the `jupyter_lab_app_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.jupyter_lab_app_settings.new](#fn-user_settingsjupyter_lab_app_settingsnew) constructor. - `jupyter_server_app_settings` (`list[obj]`): Set the `jupyter_server_app_settings` field on the resulting object. When `null`, the `jupyter_server_app_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.jupyter_server_app_settings.new](#fn-user_settingsjupyter_server_app_settingsnew) constructor. - `kernel_gateway_app_settings` (`list[obj]`): Set the `kernel_gateway_app_settings` field on the resulting object. When `null`, the `kernel_gateway_app_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.kernel_gateway_app_settings.new](#fn-user_settingskernel_gateway_app_settingsnew) constructor. - `r_session_app_settings` (`list[obj]`): Set the `r_session_app_settings` field on the resulting object. When `null`, the `r_session_app_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.r_session_app_settings.new](#fn-user_settingsr_session_app_settingsnew) constructor. - `r_studio_server_pro_app_settings` (`list[obj]`): Set the `r_studio_server_pro_app_settings` field on the resulting object. When `null`, the `r_studio_server_pro_app_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.r_studio_server_pro_app_settings.new](#fn-user_settingsr_studio_server_pro_app_settingsnew) constructor. - `sharing_settings` (`list[obj]`): Set the `sharing_settings` field on the resulting object. When `null`, the `sharing_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.sharing_settings.new](#fn-user_settingssharing_settingsnew) constructor. + - `space_storage_settings` (`list[obj]`): Set the `space_storage_settings` field on the resulting object. When `null`, the `space_storage_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.space_storage_settings.new](#fn-user_settingsspace_storage_settingsnew) constructor. - `tensor_board_app_settings` (`list[obj]`): Set the `tensor_board_app_settings` field on the resulting object. When `null`, the `tensor_board_app_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.tensor_board_app_settings.new](#fn-user_settingstensor_board_app_settingsnew) constructor. **Returns**: @@ -472,6 +501,229 @@ Terraform sub block. - An attribute object that represents the `workspace_settings` sub block. +## obj user_settings.code_editor_app_settings + + + +### fn user_settings.code_editor_app_settings.new + +```ts +new() +``` + + +`aws.sagemaker_user_profile.user_settings.code_editor_app_settings.new` constructs a new object with attributes and blocks configured for the `code_editor_app_settings` +Terraform sub block. + + + +**Args**: + - `lifecycle_config_arns` (`list`): Set the `lifecycle_config_arns` field on the resulting object. When `null`, the `lifecycle_config_arns` field will be omitted from the resulting object. + - `default_resource_spec` (`list[obj]`): Set the `default_resource_spec` field on the resulting object. When `null`, the `default_resource_spec` 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.code_editor_app_settings.default_resource_spec.new](#fn-user_settingsuser_settingsdefault_resource_specnew) constructor. + +**Returns**: + - An attribute object that represents the `code_editor_app_settings` sub block. + + +## obj user_settings.code_editor_app_settings.default_resource_spec + + + +### fn user_settings.code_editor_app_settings.default_resource_spec.new + +```ts +new() +``` + + +`aws.sagemaker_user_profile.user_settings.code_editor_app_settings.default_resource_spec.new` constructs a new object with attributes and blocks configured for the `default_resource_spec` +Terraform sub block. + + + +**Args**: + - `instance_type` (`string`): Set the `instance_type` field on the resulting object. When `null`, the `instance_type` field will be omitted from the resulting object. + - `lifecycle_config_arn` (`string`): Set the `lifecycle_config_arn` field on the resulting object. When `null`, the `lifecycle_config_arn` field will be omitted from the resulting object. + - `sagemaker_image_arn` (`string`): Set the `sagemaker_image_arn` field on the resulting object. When `null`, the `sagemaker_image_arn` field will be omitted from the resulting object. + - `sagemaker_image_version_alias` (`string`): Set the `sagemaker_image_version_alias` field on the resulting object. When `null`, the `sagemaker_image_version_alias` field will be omitted from the resulting object. + - `sagemaker_image_version_arn` (`string`): Set the `sagemaker_image_version_arn` field on the resulting object. When `null`, the `sagemaker_image_version_arn` field will be omitted from the resulting object. + +**Returns**: + - An attribute object that represents the `default_resource_spec` sub block. + + +## obj user_settings.custom_file_system_config + + + +### fn user_settings.custom_file_system_config.new + +```ts +new() +``` + + +`aws.sagemaker_user_profile.user_settings.custom_file_system_config.new` constructs a new object with attributes and blocks configured for the `custom_file_system_config` +Terraform sub block. + + + +**Args**: + - `efs_file_system_config` (`list[obj]`): Set the `efs_file_system_config` field on the resulting object. When `null`, the `efs_file_system_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_user_profile.user_settings.custom_file_system_config.efs_file_system_config.new](#fn-user_settingsuser_settingsefs_file_system_confignew) constructor. + +**Returns**: + - An attribute object that represents the `custom_file_system_config` sub block. + + +## obj user_settings.custom_file_system_config.efs_file_system_config + + + +### fn user_settings.custom_file_system_config.efs_file_system_config.new + +```ts +new() +``` + + +`aws.sagemaker_user_profile.user_settings.custom_file_system_config.efs_file_system_config.new` constructs a new object with attributes and blocks configured for the `efs_file_system_config` +Terraform sub block. + + + +**Args**: + - `file_system_id` (`string`): Set the `file_system_id` field on the resulting object. + - `file_system_path` (`string`): Set the `file_system_path` field on the resulting object. When `null`, the `file_system_path` field will be omitted from the resulting object. + +**Returns**: + - An attribute object that represents the `efs_file_system_config` sub block. + + +## obj user_settings.custom_posix_user_config + + + +### fn user_settings.custom_posix_user_config.new + +```ts +new() +``` + + +`aws.sagemaker_user_profile.user_settings.custom_posix_user_config.new` constructs a new object with attributes and blocks configured for the `custom_posix_user_config` +Terraform sub block. + + + +**Args**: + - `gid` (`number`): Set the `gid` field on the resulting object. + - `uid` (`number`): Set the `uid` field on the resulting object. + +**Returns**: + - An attribute object that represents the `custom_posix_user_config` sub block. + + +## obj user_settings.jupyter_lab_app_settings + + + +### fn user_settings.jupyter_lab_app_settings.new + +```ts +new() +``` + + +`aws.sagemaker_user_profile.user_settings.jupyter_lab_app_settings.new` constructs a new object with attributes and blocks configured for the `jupyter_lab_app_settings` +Terraform sub block. + + + +**Args**: + - `lifecycle_config_arns` (`list`): Set the `lifecycle_config_arns` field on the resulting object. When `null`, the `lifecycle_config_arns` field will be omitted from the resulting object. + - `code_repository` (`list[obj]`): Set the `code_repository` field on the resulting object. When `null`, the `code_repository` 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.jupyter_lab_app_settings.code_repository.new](#fn-user_settingsuser_settingscode_repositorynew) constructor. + - `custom_image` (`list[obj]`): Set the `custom_image` field on the resulting object. When `null`, the `custom_image` 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.jupyter_lab_app_settings.custom_image.new](#fn-user_settingsuser_settingscustom_imagenew) constructor. + - `default_resource_spec` (`list[obj]`): Set the `default_resource_spec` field on the resulting object. When `null`, the `default_resource_spec` 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.jupyter_lab_app_settings.default_resource_spec.new](#fn-user_settingsuser_settingsdefault_resource_specnew) constructor. + +**Returns**: + - An attribute object that represents the `jupyter_lab_app_settings` sub block. + + +## obj user_settings.jupyter_lab_app_settings.code_repository + + + +### fn user_settings.jupyter_lab_app_settings.code_repository.new + +```ts +new() +``` + + +`aws.sagemaker_user_profile.user_settings.jupyter_lab_app_settings.code_repository.new` constructs a new object with attributes and blocks configured for the `code_repository` +Terraform sub block. + + + +**Args**: + - `repository_url` (`string`): Set the `repository_url` field on the resulting object. + +**Returns**: + - An attribute object that represents the `code_repository` sub block. + + +## obj user_settings.jupyter_lab_app_settings.custom_image + + + +### fn user_settings.jupyter_lab_app_settings.custom_image.new + +```ts +new() +``` + + +`aws.sagemaker_user_profile.user_settings.jupyter_lab_app_settings.custom_image.new` constructs a new object with attributes and blocks configured for the `custom_image` +Terraform sub block. + + + +**Args**: + - `app_image_config_name` (`string`): Set the `app_image_config_name` field on the resulting object. + - `image_name` (`string`): Set the `image_name` field on the resulting object. + - `image_version_number` (`number`): Set the `image_version_number` field on the resulting object. When `null`, the `image_version_number` field will be omitted from the resulting object. + +**Returns**: + - An attribute object that represents the `custom_image` sub block. + + +## obj user_settings.jupyter_lab_app_settings.default_resource_spec + + + +### fn user_settings.jupyter_lab_app_settings.default_resource_spec.new + +```ts +new() +``` + + +`aws.sagemaker_user_profile.user_settings.jupyter_lab_app_settings.default_resource_spec.new` constructs a new object with attributes and blocks configured for the `default_resource_spec` +Terraform sub block. + + + +**Args**: + - `instance_type` (`string`): Set the `instance_type` field on the resulting object. When `null`, the `instance_type` field will be omitted from the resulting object. + - `lifecycle_config_arn` (`string`): Set the `lifecycle_config_arn` field on the resulting object. When `null`, the `lifecycle_config_arn` field will be omitted from the resulting object. + - `sagemaker_image_arn` (`string`): Set the `sagemaker_image_arn` field on the resulting object. When `null`, the `sagemaker_image_arn` field will be omitted from the resulting object. + - `sagemaker_image_version_alias` (`string`): Set the `sagemaker_image_version_alias` field on the resulting object. When `null`, the `sagemaker_image_version_alias` field will be omitted from the resulting object. + - `sagemaker_image_version_arn` (`string`): Set the `sagemaker_image_version_arn` field on the resulting object. When `null`, the `sagemaker_image_version_arn` field will be omitted from the resulting object. + +**Returns**: + - An attribute object that represents the `default_resource_spec` sub block. + + ## obj user_settings.jupyter_server_app_settings @@ -540,6 +792,7 @@ Terraform sub block. - `instance_type` (`string`): Set the `instance_type` field on the resulting object. When `null`, the `instance_type` field will be omitted from the resulting object. - `lifecycle_config_arn` (`string`): Set the `lifecycle_config_arn` field on the resulting object. When `null`, the `lifecycle_config_arn` field will be omitted from the resulting object. - `sagemaker_image_arn` (`string`): Set the `sagemaker_image_arn` field on the resulting object. When `null`, the `sagemaker_image_arn` field will be omitted from the resulting object. + - `sagemaker_image_version_alias` (`string`): Set the `sagemaker_image_version_alias` field on the resulting object. When `null`, the `sagemaker_image_version_alias` field will be omitted from the resulting object. - `sagemaker_image_version_arn` (`string`): Set the `sagemaker_image_version_arn` field on the resulting object. When `null`, the `sagemaker_image_version_arn` field will be omitted from the resulting object. **Returns**: @@ -616,6 +869,7 @@ Terraform sub block. - `instance_type` (`string`): Set the `instance_type` field on the resulting object. When `null`, the `instance_type` field will be omitted from the resulting object. - `lifecycle_config_arn` (`string`): Set the `lifecycle_config_arn` field on the resulting object. When `null`, the `lifecycle_config_arn` field will be omitted from the resulting object. - `sagemaker_image_arn` (`string`): Set the `sagemaker_image_arn` field on the resulting object. When `null`, the `sagemaker_image_arn` field will be omitted from the resulting object. + - `sagemaker_image_version_alias` (`string`): Set the `sagemaker_image_version_alias` field on the resulting object. When `null`, the `sagemaker_image_version_alias` field will be omitted from the resulting object. - `sagemaker_image_version_arn` (`string`): Set the `sagemaker_image_version_arn` field on the resulting object. When `null`, the `sagemaker_image_version_arn` field will be omitted from the resulting object. **Returns**: @@ -691,6 +945,7 @@ Terraform sub block. - `instance_type` (`string`): Set the `instance_type` field on the resulting object. When `null`, the `instance_type` field will be omitted from the resulting object. - `lifecycle_config_arn` (`string`): Set the `lifecycle_config_arn` field on the resulting object. When `null`, the `lifecycle_config_arn` field will be omitted from the resulting object. - `sagemaker_image_arn` (`string`): Set the `sagemaker_image_arn` field on the resulting object. When `null`, the `sagemaker_image_arn` field will be omitted from the resulting object. + - `sagemaker_image_version_alias` (`string`): Set the `sagemaker_image_version_alias` field on the resulting object. When `null`, the `sagemaker_image_version_alias` field will be omitted from the resulting object. - `sagemaker_image_version_arn` (`string`): Set the `sagemaker_image_version_arn` field on the resulting object. When `null`, the `sagemaker_image_version_arn` field will be omitted from the resulting object. **Returns**: @@ -746,6 +1001,53 @@ Terraform sub block. - An attribute object that represents the `sharing_settings` sub block. +## obj user_settings.space_storage_settings + + + +### fn user_settings.space_storage_settings.new + +```ts +new() +``` + + +`aws.sagemaker_user_profile.user_settings.space_storage_settings.new` constructs a new object with attributes and blocks configured for the `space_storage_settings` +Terraform sub block. + + + +**Args**: + - `default_ebs_storage_settings` (`list[obj]`): Set the `default_ebs_storage_settings` field on the resulting object. When `null`, the `default_ebs_storage_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.space_storage_settings.default_ebs_storage_settings.new](#fn-user_settingsuser_settingsdefault_ebs_storage_settingsnew) constructor. + +**Returns**: + - An attribute object that represents the `space_storage_settings` sub block. + + +## obj user_settings.space_storage_settings.default_ebs_storage_settings + + + +### fn user_settings.space_storage_settings.default_ebs_storage_settings.new + +```ts +new() +``` + + +`aws.sagemaker_user_profile.user_settings.space_storage_settings.default_ebs_storage_settings.new` constructs a new object with attributes and blocks configured for the `default_ebs_storage_settings` +Terraform sub block. + + + +**Args**: + - `default_ebs_volume_size_in_gb` (`number`): Set the `default_ebs_volume_size_in_gb` field on the resulting object. + - `maximum_ebs_volume_size_in_gb` (`number`): Set the `maximum_ebs_volume_size_in_gb` field on the resulting object. + +**Returns**: + - An attribute object that represents the `default_ebs_storage_settings` sub block. + + ## obj user_settings.tensor_board_app_settings @@ -789,6 +1091,7 @@ Terraform sub block. - `instance_type` (`string`): Set the `instance_type` field on the resulting object. When `null`, the `instance_type` field will be omitted from the resulting object. - `lifecycle_config_arn` (`string`): Set the `lifecycle_config_arn` field on the resulting object. When `null`, the `lifecycle_config_arn` field will be omitted from the resulting object. - `sagemaker_image_arn` (`string`): Set the `sagemaker_image_arn` field on the resulting object. When `null`, the `sagemaker_image_arn` field will be omitted from the resulting object. + - `sagemaker_image_version_alias` (`string`): Set the `sagemaker_image_version_alias` field on the resulting object. When `null`, the `sagemaker_image_version_alias` field will be omitted from the resulting object. - `sagemaker_image_version_arn` (`string`): Set the `sagemaker_image_version_arn` field on the resulting object. When `null`, the `sagemaker_image_version_arn` field will be omitted from the resulting object. **Returns**: diff --git a/docs/5.x/securitylake_data_lake.md b/docs/5.x/securitylake_data_lake.md new file mode 100644 index 00000000..151002ce --- /dev/null +++ b/docs/5.x/securitylake_data_lake.md @@ -0,0 +1,350 @@ +--- +permalink: /securitylake_data_lake/ +--- + +# securitylake_data_lake + +`securitylake_data_lake` represents the `aws_securitylake_data_lake` 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 withConfiguration()`](#fn-withconfiguration) +* [`fn withConfigurationMixin()`](#fn-withconfigurationmixin) +* [`fn withMetaStoreManagerRoleArn()`](#fn-withmetastoremanagerrolearn) +* [`fn withTags()`](#fn-withtags) +* [`fn withTimeouts()`](#fn-withtimeouts) +* [`fn withTimeoutsMixin()`](#fn-withtimeoutsmixin) +* [`obj configuration`](#obj-configuration) + * [`fn new()`](#fn-configurationnew) + * [`obj configuration.lifecycle_configuration`](#obj-configurationlifecycle_configuration) + * [`fn new()`](#fn-configurationlifecycle_configurationnew) + * [`obj configuration.lifecycle_configuration.expiration`](#obj-configurationlifecycle_configurationexpiration) + * [`fn new()`](#fn-configurationlifecycle_configurationexpirationnew) + * [`obj configuration.lifecycle_configuration.transition`](#obj-configurationlifecycle_configurationtransition) + * [`fn new()`](#fn-configurationlifecycle_configurationtransitionnew) + * [`obj configuration.replication_configuration`](#obj-configurationreplication_configuration) + * [`fn new()`](#fn-configurationreplication_configurationnew) +* [`obj timeouts`](#obj-timeouts) + * [`fn new()`](#fn-timeoutsnew) + +## Fields + +### fn new + +```ts +new() +``` + + +`aws.securitylake_data_lake.new` injects a new `aws_securitylake_data_lake` 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.securitylake_data_lake.new('some_id') + +You can get the reference to the `id` field of the created `aws.securitylake_data_lake` using the reference: + + $._ref.aws_securitylake_data_lake.some_id.get('id') + +This is the same as directly entering `"${ aws_securitylake_data_lake.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. + - `meta_store_manager_role_arn` (`string`): Set the `meta_store_manager_role_arn` 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. + - `configuration` (`list[obj]`): Set the `configuration` field on the resulting resource block. When `null`, the `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.securitylake_data_lake.configuration.new](#fn-configurationnew) constructor. + - `timeouts` (`obj`): Set the `timeouts` field on the resulting resource block. When `null`, the `timeouts` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [aws.securitylake_data_lake.timeouts.new](#fn-timeoutsnew) constructor. + +**Returns**: +- A mixin object that injects the new resource into the root Terraform configuration. + + +### fn newAttrs + +```ts +newAttrs() +``` + + +`aws.securitylake_data_lake.newAttrs` constructs a new object with attributes and blocks configured for the `securitylake_data_lake` +Terraform resource. + +Unlike [aws.securitylake_data_lake.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**: + - `meta_store_manager_role_arn` (`string`): Set the `meta_store_manager_role_arn` 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. + - `configuration` (`list[obj]`): Set the `configuration` field on the resulting object. When `null`, the `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.securitylake_data_lake.configuration.new](#fn-configurationnew) constructor. + - `timeouts` (`obj`): Set the `timeouts` field on the resulting object. When `null`, the `timeouts` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [aws.securitylake_data_lake.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 `securitylake_data_lake` resource into the root Terraform configuration. + + +### fn withConfiguration + +```ts +withConfiguration() +``` + +`aws.list[obj].withConfiguration` constructs a mixin object that can be merged into the `list[obj]` +Terraform resource block to set or update the 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].withConfigurationMixin](TODO) function. + + +**Args**: + - `resourceLabel` (`string`): The name label of the block to update. + - `value` (`list[obj]`): The value to set for the `configuration` field. + + +### fn withConfigurationMixin + +```ts +withConfigurationMixin() +``` + +`aws.list[obj].withConfigurationMixin` constructs a mixin object that can be merged into the `list[obj]` +Terraform resource block to set or update the 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].withConfiguration](TODO) +function. + + +**Args**: + - `resourceLabel` (`string`): The name label of the block to update. + - `value` (`list[obj]`): The value to set for the `configuration` field. + + +### fn withMetaStoreManagerRoleArn + +```ts +withMetaStoreManagerRoleArn() +``` + +`aws.string.withMetaStoreManagerRoleArn` constructs a mixin object that can be merged into the `string` +Terraform resource block to set or update the meta_store_manager_role_arn field. + + + +**Args**: + - `resourceLabel` (`string`): The name label of the block to update. + - `value` (`string`): The value to set for the `meta_store_manager_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 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 configuration + + + +### fn configuration.new + +```ts +new() +``` + + +`aws.securitylake_data_lake.configuration.new` constructs a new object with attributes and blocks configured for the `configuration` +Terraform sub block. + + + +**Args**: + - `encryption_configuration` (`list`): Set the `encryption_configuration` field on the resulting object. When `null`, the `encryption_configuration` field will be omitted from the resulting object. + - `region` (`string`): Set the `region` field on the resulting object. + - `lifecycle_configuration` (`list[obj]`): Set the `lifecycle_configuration` field on the resulting object. When `null`, the `lifecycle_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.securitylake_data_lake.configuration.lifecycle_configuration.new](#fn-configurationlifecycle_configurationnew) constructor. + - `replication_configuration` (`list[obj]`): Set the `replication_configuration` field on the resulting object. When `null`, the `replication_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.securitylake_data_lake.configuration.replication_configuration.new](#fn-configurationreplication_configurationnew) constructor. + +**Returns**: + - An attribute object that represents the `configuration` sub block. + + +## obj configuration.lifecycle_configuration + + + +### fn configuration.lifecycle_configuration.new + +```ts +new() +``` + + +`aws.securitylake_data_lake.configuration.lifecycle_configuration.new` constructs a new object with attributes and blocks configured for the `lifecycle_configuration` +Terraform sub block. + + + +**Args**: + - `expiration` (`list[obj]`): Set the `expiration` field on the resulting object. When `null`, the `expiration` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [aws.securitylake_data_lake.configuration.lifecycle_configuration.expiration.new](#fn-configurationconfigurationexpirationnew) constructor. + - `transition` (`list[obj]`): Set the `transition` field on the resulting object. When `null`, the `transition` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [aws.securitylake_data_lake.configuration.lifecycle_configuration.transition.new](#fn-configurationconfigurationtransitionnew) constructor. + +**Returns**: + - An attribute object that represents the `lifecycle_configuration` sub block. + + +## obj configuration.lifecycle_configuration.expiration + + + +### fn configuration.lifecycle_configuration.expiration.new + +```ts +new() +``` + + +`aws.securitylake_data_lake.configuration.lifecycle_configuration.expiration.new` constructs a new object with attributes and blocks configured for the `expiration` +Terraform sub block. + + + +**Args**: + - `days` (`number`): Set the `days` field on the resulting object. When `null`, the `days` field will be omitted from the resulting object. + +**Returns**: + - An attribute object that represents the `expiration` sub block. + + +## obj configuration.lifecycle_configuration.transition + + + +### fn configuration.lifecycle_configuration.transition.new + +```ts +new() +``` + + +`aws.securitylake_data_lake.configuration.lifecycle_configuration.transition.new` constructs a new object with attributes and blocks configured for the `transition` +Terraform sub block. + + + +**Args**: + - `days` (`number`): Set the `days` field on the resulting object. When `null`, the `days` field will be omitted from the resulting object. + - `storage_class` (`string`): Set the `storage_class` field on the resulting object. When `null`, the `storage_class` field will be omitted from the resulting object. + +**Returns**: + - An attribute object that represents the `transition` sub block. + + +## obj configuration.replication_configuration + + + +### fn configuration.replication_configuration.new + +```ts +new() +``` + + +`aws.securitylake_data_lake.configuration.replication_configuration.new` constructs a new object with attributes and blocks configured for the `replication_configuration` +Terraform sub block. + + + +**Args**: + - `regions` (`list`): Set the `regions` field on the resulting object. When `null`, the `regions` field will be omitted from 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. + +**Returns**: + - An attribute object that represents the `replication_configuration` sub block. + + +## obj timeouts + + + +### fn timeouts.new + +```ts +new() +``` + + +`aws.securitylake_data_lake.timeouts.new` constructs a new object with attributes and blocks configured for the `timeouts` +Terraform sub block. + + + +**Args**: + - `create` (`string`): A string that can be [parsed as a duration](https://pkg.go.dev/time#ParseDuration) consisting of numbers and unit suffixes, such as "30s" or "2h45m". Valid time units are "s" (seconds), "m" (minutes), "h" (hours). When `null`, the `create` field will be omitted from the resulting object. + - `delete` (`string`): A string that can be [parsed as a duration](https://pkg.go.dev/time#ParseDuration) consisting of numbers and unit suffixes, such as "30s" or "2h45m". Valid time units are "s" (seconds), "m" (minutes), "h" (hours). Setting a timeout for a Delete operation is only applicable if changes are saved into state before the destroy operation occurs. When `null`, the `delete` field will be omitted from the resulting object. + - `update` (`string`): A string that can be [parsed as a duration](https://pkg.go.dev/time#ParseDuration) consisting of numbers and unit suffixes, such as "30s" or "2h45m". Valid time units are "s" (seconds), "m" (minutes), "h" (hours). When `null`, the `update` field will be omitted from the resulting object. + +**Returns**: + - An attribute object that represents the `timeouts` sub block. diff --git a/docs/5.x/ssoadmin_application.md b/docs/5.x/ssoadmin_application.md new file mode 100644 index 00000000..c60c9a8d --- /dev/null +++ b/docs/5.x/ssoadmin_application.md @@ -0,0 +1,299 @@ +--- +permalink: /ssoadmin_application/ +--- + +# ssoadmin_application + +`ssoadmin_application` represents the `aws_ssoadmin_application` 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 withApplicationProviderArn()`](#fn-withapplicationproviderarn) +* [`fn withClientToken()`](#fn-withclienttoken) +* [`fn withDescription()`](#fn-withdescription) +* [`fn withInstanceArn()`](#fn-withinstancearn) +* [`fn withName()`](#fn-withname) +* [`fn withPortalOptions()`](#fn-withportaloptions) +* [`fn withPortalOptionsMixin()`](#fn-withportaloptionsmixin) +* [`fn withStatus()`](#fn-withstatus) +* [`fn withTags()`](#fn-withtags) +* [`obj portal_options`](#obj-portal_options) + * [`fn new()`](#fn-portal_optionsnew) + * [`obj portal_options.sign_in_options`](#obj-portal_optionssign_in_options) + * [`fn new()`](#fn-portal_optionssign_in_optionsnew) + +## Fields + +### fn new + +```ts +new() +``` + + +`aws.ssoadmin_application.new` injects a new `aws_ssoadmin_application` 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.ssoadmin_application.new('some_id') + +You can get the reference to the `id` field of the created `aws.ssoadmin_application` using the reference: + + $._ref.aws_ssoadmin_application.some_id.get('id') + +This is the same as directly entering `"${ aws_ssoadmin_application.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. + - `application_provider_arn` (`string`): Set the `application_provider_arn` field on the resulting resource block. + - `client_token` (`string`): Set the `client_token` field on the resulting resource block. When `null`, the `client_token` field will be omitted from the resulting object. + - `description` (`string`): Set the `description` field on the resulting resource block. When `null`, the `description` field will be omitted from the resulting object. + - `instance_arn` (`string`): Set the `instance_arn` field on the resulting resource block. + - `name` (`string`): Set the `name` field on the resulting resource block. + - `status` (`string`): Set the `status` field on the resulting resource block. When `null`, the `status` field will be omitted from the resulting object. + - `tags` (`obj`): Set the `tags` field on the resulting resource block. When `null`, the `tags` field will be omitted from the resulting object. + - `portal_options` (`list[obj]`): Set the `portal_options` field on the resulting resource block. When `null`, the `portal_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.ssoadmin_application.portal_options.new](#fn-portal_optionsnew) constructor. + +**Returns**: +- A mixin object that injects the new resource into the root Terraform configuration. + + +### fn newAttrs + +```ts +newAttrs() +``` + + +`aws.ssoadmin_application.newAttrs` constructs a new object with attributes and blocks configured for the `ssoadmin_application` +Terraform resource. + +Unlike [aws.ssoadmin_application.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**: + - `application_provider_arn` (`string`): Set the `application_provider_arn` field on the resulting object. + - `client_token` (`string`): Set the `client_token` field on the resulting object. When `null`, the `client_token` field will be omitted from the resulting object. + - `description` (`string`): Set the `description` field on the resulting object. When `null`, the `description` field will be omitted from the resulting object. + - `instance_arn` (`string`): Set the `instance_arn` field on the resulting object. + - `name` (`string`): Set the `name` field on the resulting object. + - `status` (`string`): Set the `status` field on the resulting object. When `null`, the `status` field will be omitted from the resulting object. + - `tags` (`obj`): Set the `tags` field on the resulting object. When `null`, the `tags` field will be omitted from the resulting object. + - `portal_options` (`list[obj]`): Set the `portal_options` field on the resulting object. When `null`, the `portal_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.ssoadmin_application.portal_options.new](#fn-portal_optionsnew) constructor. + +**Returns**: + - An attribute object that can be used with [tf.withResource](https://github.com/tf-libsonnet/core/tree/main/docs#fn-withresource) to construct a new `ssoadmin_application` resource into the root Terraform configuration. + + +### fn withApplicationProviderArn + +```ts +withApplicationProviderArn() +``` + +`aws.string.withApplicationProviderArn` constructs a mixin object that can be merged into the `string` +Terraform resource block to set or update the application_provider_arn field. + + + +**Args**: + - `resourceLabel` (`string`): The name label of the block to update. + - `value` (`string`): The value to set for the `application_provider_arn` field. + + +### fn withClientToken + +```ts +withClientToken() +``` + +`aws.string.withClientToken` constructs a mixin object that can be merged into the `string` +Terraform resource block to set or update the client_token field. + + + +**Args**: + - `resourceLabel` (`string`): The name label of the block to update. + - `value` (`string`): The value to set for the `client_token` field. + + +### fn withDescription + +```ts +withDescription() +``` + +`aws.string.withDescription` constructs a mixin object that can be merged into the `string` +Terraform resource block to set or update the description field. + + + +**Args**: + - `resourceLabel` (`string`): The name label of the block to update. + - `value` (`string`): The value to set for the `description` field. + + +### fn withInstanceArn + +```ts +withInstanceArn() +``` + +`aws.string.withInstanceArn` constructs a mixin object that can be merged into the `string` +Terraform resource block to set or update the instance_arn field. + + + +**Args**: + - `resourceLabel` (`string`): The name label of the block to update. + - `value` (`string`): The value to set for the `instance_arn` field. + + +### fn withName + +```ts +withName() +``` + +`aws.string.withName` constructs a mixin object that can be merged into the `string` +Terraform resource block to set or update the name field. + + + +**Args**: + - `resourceLabel` (`string`): The name label of the block to update. + - `value` (`string`): The value to set for the `name` field. + + +### fn withPortalOptions + +```ts +withPortalOptions() +``` + +`aws.list[obj].withPortalOptions` constructs a mixin object that can be merged into the `list[obj]` +Terraform resource block to set or update the portal_options field. + +This function will replace the array with the passed in `value`. If you wish to instead append the +passed in value to the existing array, use the [aws.list[obj].withPortalOptionsMixin](TODO) function. + + +**Args**: + - `resourceLabel` (`string`): The name label of the block to update. + - `value` (`list[obj]`): The value to set for the `portal_options` field. + + +### fn withPortalOptionsMixin + +```ts +withPortalOptionsMixin() +``` + +`aws.list[obj].withPortalOptionsMixin` constructs a mixin object that can be merged into the `list[obj]` +Terraform resource block to set or update the portal_options field. + +This function will append the passed in array or object to the existing array. If you wish +to instead replace the array with the passed in `value`, use the [aws.list[obj].withPortalOptions](TODO) +function. + + +**Args**: + - `resourceLabel` (`string`): The name label of the block to update. + - `value` (`list[obj]`): The value to set for the `portal_options` field. + + +### fn withStatus + +```ts +withStatus() +``` + +`aws.string.withStatus` constructs a mixin object that can be merged into the `string` +Terraform resource block to set or update the status field. + + + +**Args**: + - `resourceLabel` (`string`): The name label of the block to update. + - `value` (`string`): The value to set for the `status` 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. + + +## obj portal_options + + + +### fn portal_options.new + +```ts +new() +``` + + +`aws.ssoadmin_application.portal_options.new` constructs a new object with attributes and blocks configured for the `portal_options` +Terraform sub block. + + + +**Args**: + - `visibility` (`string`): Set the `visibility` field on the resulting object. When `null`, the `visibility` field will be omitted from the resulting object. + - `sign_in_options` (`list[obj]`): Set the `sign_in_options` field on the resulting object. When `null`, the `sign_in_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.ssoadmin_application.portal_options.sign_in_options.new](#fn-portal_optionssign_in_optionsnew) constructor. + +**Returns**: + - An attribute object that represents the `portal_options` sub block. + + +## obj portal_options.sign_in_options + + + +### fn portal_options.sign_in_options.new + +```ts +new() +``` + + +`aws.ssoadmin_application.portal_options.sign_in_options.new` constructs a new object with attributes and blocks configured for the `sign_in_options` +Terraform sub block. + + + +**Args**: + - `application_url` (`string`): Set the `application_url` field on the resulting object. When `null`, the `application_url` field will be omitted from the resulting object. + - `origin` (`string`): Set the `origin` field on the resulting object. + +**Returns**: + - An attribute object that represents the `sign_in_options` sub block. diff --git a/docs/5.x/ssoadmin_application_assignment.md b/docs/5.x/ssoadmin_application_assignment.md new file mode 100644 index 00000000..a1407a5b --- /dev/null +++ b/docs/5.x/ssoadmin_application_assignment.md @@ -0,0 +1,130 @@ +--- +permalink: /ssoadmin_application_assignment/ +--- + +# ssoadmin_application_assignment + +`ssoadmin_application_assignment` represents the `aws_ssoadmin_application_assignment` 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 withApplicationArn()`](#fn-withapplicationarn) +* [`fn withPrincipalId()`](#fn-withprincipalid) +* [`fn withPrincipalType()`](#fn-withprincipaltype) + +## Fields + +### fn new + +```ts +new() +``` + + +`aws.ssoadmin_application_assignment.new` injects a new `aws_ssoadmin_application_assignment` 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.ssoadmin_application_assignment.new('some_id') + +You can get the reference to the `id` field of the created `aws.ssoadmin_application_assignment` using the reference: + + $._ref.aws_ssoadmin_application_assignment.some_id.get('id') + +This is the same as directly entering `"${ aws_ssoadmin_application_assignment.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. + - `application_arn` (`string`): Set the `application_arn` field on the resulting resource block. + - `principal_id` (`string`): Set the `principal_id` field on the resulting resource block. + - `principal_type` (`string`): Set the `principal_type` 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.ssoadmin_application_assignment.newAttrs` constructs a new object with attributes and blocks configured for the `ssoadmin_application_assignment` +Terraform resource. + +Unlike [aws.ssoadmin_application_assignment.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**: + - `application_arn` (`string`): Set the `application_arn` field on the resulting object. + - `principal_id` (`string`): Set the `principal_id` field on the resulting object. + - `principal_type` (`string`): Set the `principal_type` 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 `ssoadmin_application_assignment` resource into the root Terraform configuration. + + +### fn withApplicationArn + +```ts +withApplicationArn() +``` + +`aws.string.withApplicationArn` constructs a mixin object that can be merged into the `string` +Terraform resource block to set or update the application_arn field. + + + +**Args**: + - `resourceLabel` (`string`): The name label of the block to update. + - `value` (`string`): The value to set for the `application_arn` field. + + +### fn withPrincipalId + +```ts +withPrincipalId() +``` + +`aws.string.withPrincipalId` constructs a mixin object that can be merged into the `string` +Terraform resource block to set or update the principal_id field. + + + +**Args**: + - `resourceLabel` (`string`): The name label of the block to update. + - `value` (`string`): The value to set for the `principal_id` field. + + +### fn withPrincipalType + +```ts +withPrincipalType() +``` + +`aws.string.withPrincipalType` constructs a mixin object that can be merged into the `string` +Terraform resource block to set or update the principal_type field. + + + +**Args**: + - `resourceLabel` (`string`): The name label of the block to update. + - `value` (`string`): The value to set for the `principal_type` field. diff --git a/docs/5.x/ssoadmin_application_assignment_configuration.md b/docs/5.x/ssoadmin_application_assignment_configuration.md new file mode 100644 index 00000000..fc5c3930 --- /dev/null +++ b/docs/5.x/ssoadmin_application_assignment_configuration.md @@ -0,0 +1,111 @@ +--- +permalink: /ssoadmin_application_assignment_configuration/ +--- + +# ssoadmin_application_assignment_configuration + +`ssoadmin_application_assignment_configuration` represents the `aws_ssoadmin_application_assignment_configuration` 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 withApplicationArn()`](#fn-withapplicationarn) +* [`fn withAssignmentRequired()`](#fn-withassignmentrequired) + +## Fields + +### fn new + +```ts +new() +``` + + +`aws.ssoadmin_application_assignment_configuration.new` injects a new `aws_ssoadmin_application_assignment_configuration` 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.ssoadmin_application_assignment_configuration.new('some_id') + +You can get the reference to the `id` field of the created `aws.ssoadmin_application_assignment_configuration` using the reference: + + $._ref.aws_ssoadmin_application_assignment_configuration.some_id.get('id') + +This is the same as directly entering `"${ aws_ssoadmin_application_assignment_configuration.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. + - `application_arn` (`string`): Set the `application_arn` field on the resulting resource block. + - `assignment_required` (`bool`): Set the `assignment_required` 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.ssoadmin_application_assignment_configuration.newAttrs` constructs a new object with attributes and blocks configured for the `ssoadmin_application_assignment_configuration` +Terraform resource. + +Unlike [aws.ssoadmin_application_assignment_configuration.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**: + - `application_arn` (`string`): Set the `application_arn` field on the resulting object. + - `assignment_required` (`bool`): Set the `assignment_required` 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 `ssoadmin_application_assignment_configuration` resource into the root Terraform configuration. + + +### fn withApplicationArn + +```ts +withApplicationArn() +``` + +`aws.string.withApplicationArn` constructs a mixin object that can be merged into the `string` +Terraform resource block to set or update the application_arn field. + + + +**Args**: + - `resourceLabel` (`string`): The name label of the block to update. + - `value` (`string`): The value to set for the `application_arn` field. + + +### fn withAssignmentRequired + +```ts +withAssignmentRequired() +``` + +`aws.bool.withAssignmentRequired` constructs a mixin object that can be merged into the `bool` +Terraform resource block to set or update the assignment_required field. + + + +**Args**: + - `resourceLabel` (`string`): The name label of the block to update. + - `value` (`bool`): The value to set for the `assignment_required` field.