From 1e4261d04015c4f25b237203b48a3c693da43c6b Mon Sep 17 00:00:00 2001 From: "renovate[bot]" Date: Tue, 12 Sep 2023 02:05:26 +0000 Subject: [PATCH] Generate libsonnet source from libgenerator PR https://github.com/tf-libsonnet/libgenerator/pull/208 Signed-off-by: tflibsonnet-ci <120686569+tflibsonnet-ci@users.noreply.github.com> --- 5.x/_gen/data/cognito_identity_pool.libsonnet | 45 ++ 5.x/_gen/data/main.libsonnet | 1 + 5.x/_gen/main.libsonnet | 1 + .../verifiedaccess_trust_provider.libsonnet | 230 ++++++++++ docs/5.x/README.md | 1 + docs/5.x/data/cognito_identity_pool.md | 111 +++++ docs/5.x/data/index.md | 1 + docs/5.x/verifiedaccess_trust_provider.md | 411 ++++++++++++++++++ 8 files changed, 801 insertions(+) create mode 100644 5.x/_gen/data/cognito_identity_pool.libsonnet create mode 100644 5.x/_gen/resources/verifiedaccess_trust_provider.libsonnet create mode 100644 docs/5.x/data/cognito_identity_pool.md create mode 100644 docs/5.x/verifiedaccess_trust_provider.md diff --git a/5.x/_gen/data/cognito_identity_pool.libsonnet b/5.x/_gen/data/cognito_identity_pool.libsonnet new file mode 100644 index 00000000..6f9095e7 --- /dev/null +++ b/5.x/_gen/data/cognito_identity_pool.libsonnet @@ -0,0 +1,45 @@ +local tf = (import 'github.com/tf-libsonnet/core/main.libsonnet'); +local d = (import 'github.com/jsonnet-libs/docsonnet/doc-util/main.libsonnet'); +{ + '#':: d.pkg(name='cognito_identity_pool', url='', help='`cognito_identity_pool` represents the `aws_cognito_identity_pool` Terraform data source.\n\n\n\nThis package contains functions and utilities for setting up the data source using Jsonnet code.\n'), + '#new':: d.fn(help="\n`aws.data.cognito_identity_pool.new` injects a new `data_aws_cognito_identity_pool` Terraform `data source`\nblock into the root module document.\n\nAdditionally, this inserts a private function into the `_ref` attribute that generates references to attributes of the\nresource. For example, if you added a new instance to the root using:\n\n # arguments omitted for brevity\n aws.data.cognito_identity_pool.new('some_id')\n\nYou can get the reference to the `id` field of the created `aws.data.cognito_identity_pool` using the reference:\n\n $._ref.data_aws_cognito_identity_pool.some_id.get('id')\n\nThis is the same as directly entering `\"${ data_aws_cognito_identity_pool.some_id.id }\"` as the value.\n\nNOTE: if you are chaining multiple resources together in a merge operation, you may not be able to use `super`, `self`,\nor `$` to refer to the root object. Instead, make an explicit outer object using `local`.\n\n**Args**:\n - `dataSrcLabel` (`string`): The name label of the block.\n - `identity_pool_name` (`string`): Set the `identity_pool_name` field on the resulting data source block.\n - `tags` (`obj`): Set the `tags` field on the resulting data source block. When `null`, the `tags` field will be omitted from the resulting object.\n\n**Returns**:\n- A mixin object that injects the new data source into the root Terraform configuration.\n", args=[]), + new( + dataSrcLabel, + identity_pool_name, + tags=null, + _meta={} + ):: tf.withData( + type='aws_cognito_identity_pool', + label=dataSrcLabel, + attrs=self.newAttrs(identity_pool_name=identity_pool_name, tags=tags), + _meta=_meta + ), + '#newAttrs':: d.fn(help='\n`aws.data.cognito_identity_pool.newAttrs` constructs a new object with attributes and blocks configured for the `cognito_identity_pool`\nTerraform data source.\n\nUnlike [aws.data.cognito_identity_pool.new](#fn-new), this function will not inject the `data source`\nblock into the root Terraform document. Instead, this must be passed in as the `attrs` argument for the\n[tf.withData](https://github.com/tf-libsonnet/core/tree/main/docs#fn-withdata) function to build a complete block.\n\nThis is most useful when you need to preprocess the attributes with functions, conditional, or looping logic prior to\ninjecting into a complete block.\n\n**Args**:\n - `identity_pool_name` (`string`): Set the `identity_pool_name` field on the resulting object.\n - `tags` (`obj`): Set the `tags` field on the resulting object. When `null`, the `tags` field will be omitted from the resulting object.\n\n**Returns**:\n - An attribute object that can be used with [tf.withData](https://github.com/tf-libsonnet/core/tree/main/docs#fn-withdata) to construct a new `cognito_identity_pool` data source into the root Terraform configuration.\n', args=[]), + newAttrs( + identity_pool_name, + tags=null + ):: std.prune(a={ + identity_pool_name: identity_pool_name, + tags: tags, + }), + '#withIdentityPoolName':: d.fn(help='`aws.string.withIdentityPoolName` constructs a mixin object that can be merged into the `string`\nTerraform data source block to set or update the identity_pool_name field.\n\n\n\n**Args**:\n - `dataSrcLabel` (`string`): The name label of the block to update.\n - `value` (`string`): The value to set for the `identity_pool_name` field.\n', args=[]), + withIdentityPoolName(dataSrcLabel, value): { + data+: { + aws_cognito_identity_pool+: { + [dataSrcLabel]+: { + identity_pool_name: value, + }, + }, + }, + }, + '#withTags':: d.fn(help='`aws.obj.withTags` constructs a mixin object that can be merged into the `obj`\nTerraform data source block to set or update the tags field.\n\n\n\n**Args**:\n - `dataSrcLabel` (`string`): The name label of the block to update.\n - `value` (`obj`): The value to set for the `tags` field.\n', args=[]), + withTags(dataSrcLabel, value): { + data+: { + aws_cognito_identity_pool+: { + [dataSrcLabel]+: { + tags: value, + }, + }, + }, + }, +} diff --git a/5.x/_gen/data/main.libsonnet b/5.x/_gen/data/main.libsonnet index c0a7a1ee..4c13a929 100644 --- a/5.x/_gen/data/main.libsonnet +++ b/5.x/_gen/data/main.libsonnet @@ -81,6 +81,7 @@ local d = (import 'github.com/jsonnet-libs/docsonnet/doc-util/main.libsonnet'); codecommit_approval_rule_template: (import 'codecommit_approval_rule_template.libsonnet'), codecommit_repository: (import 'codecommit_repository.libsonnet'), codestarconnections_connection: (import 'codestarconnections_connection.libsonnet'), + cognito_identity_pool: (import 'cognito_identity_pool.libsonnet'), cognito_user_pool_client: (import 'cognito_user_pool_client.libsonnet'), cognito_user_pool_clients: (import 'cognito_user_pool_clients.libsonnet'), cognito_user_pool_signing_certificate: (import 'cognito_user_pool_signing_certificate.libsonnet'), diff --git a/5.x/_gen/main.libsonnet b/5.x/_gen/main.libsonnet index 7bc62eb5..cc1b29cb 100644 --- a/5.x/_gen/main.libsonnet +++ b/5.x/_gen/main.libsonnet @@ -1166,6 +1166,7 @@ local d = (import 'github.com/jsonnet-libs/docsonnet/doc-util/main.libsonnet'); transfer_tag: (import 'resources/transfer_tag.libsonnet'), transfer_user: (import 'resources/transfer_user.libsonnet'), transfer_workflow: (import 'resources/transfer_workflow.libsonnet'), + verifiedaccess_trust_provider: (import 'resources/verifiedaccess_trust_provider.libsonnet'), volume_attachment: (import 'resources/volume_attachment.libsonnet'), vpc: (import 'resources/vpc.libsonnet'), vpc_dhcp_options: (import 'resources/vpc_dhcp_options.libsonnet'), diff --git a/5.x/_gen/resources/verifiedaccess_trust_provider.libsonnet b/5.x/_gen/resources/verifiedaccess_trust_provider.libsonnet new file mode 100644 index 00000000..db812e75 --- /dev/null +++ b/5.x/_gen/resources/verifiedaccess_trust_provider.libsonnet @@ -0,0 +1,230 @@ +local tf = (import 'github.com/tf-libsonnet/core/main.libsonnet'); +local d = (import 'github.com/jsonnet-libs/docsonnet/doc-util/main.libsonnet'); +{ + '#':: d.pkg(name='verifiedaccess_trust_provider', url='', help='`verifiedaccess_trust_provider` represents the `aws_verifiedaccess_trust_provider` Terraform resource.\n\n\n\nThis package contains functions and utilities for setting up the resource using Jsonnet code.\n'), + device_options:: { + '#new':: d.fn(help='\n`aws.verifiedaccess_trust_provider.device_options.new` constructs a new object with attributes and blocks configured for the `device_options`\nTerraform sub block.\n\n\n\n**Args**:\n - `tenant_id` (`string`): Set the `tenant_id` field on the resulting object. When `null`, the `tenant_id` field will be omitted from the resulting object.\n\n**Returns**:\n - An attribute object that represents the `device_options` sub block.\n', args=[]), + new( + tenant_id=null + ):: std.prune(a={ + tenant_id: tenant_id, + }), + }, + '#new':: d.fn(help="\n`aws.verifiedaccess_trust_provider.new` injects a new `aws_verifiedaccess_trust_provider` Terraform `resource`\nblock into the root module document.\n\nAdditionally, this inserts a private function into the `_ref` attribute that generates references to attributes of the\nresource. For example, if you added a new instance to the root using:\n\n # arguments omitted for brevity\n aws.verifiedaccess_trust_provider.new('some_id')\n\nYou can get the reference to the `id` field of the created `aws.verifiedaccess_trust_provider` using the reference:\n\n $._ref.aws_verifiedaccess_trust_provider.some_id.get('id')\n\nThis is the same as directly entering `\"${ aws_verifiedaccess_trust_provider.some_id.id }\"` as the value.\n\nNOTE: if you are chaining multiple resources together in a merge operation, you may not be able to use `super`, `self`,\nor `$` to refer to the root object. Instead, make an explicit outer object using `local`.\n\n**Args**:\n - `resourceLabel` (`string`): The name label of the block.\n - `description` (`string`): Set the `description` field on the resulting resource block. When `null`, the `description` field will be omitted from the resulting object.\n - `device_trust_provider_type` (`string`): Set the `device_trust_provider_type` field on the resulting resource block. When `null`, the `device_trust_provider_type` field will be omitted from the resulting object.\n - `policy_reference_name` (`string`): Set the `policy_reference_name` field on the resulting resource block.\n - `tags` (`obj`): Set the `tags` field on the resulting resource block. When `null`, the `tags` field will be omitted from the resulting object.\n - `tags_all` (`obj`): Set the `tags_all` field on the resulting resource block. When `null`, the `tags_all` field will be omitted from the resulting object.\n - `trust_provider_type` (`string`): Set the `trust_provider_type` field on the resulting resource block.\n - `user_trust_provider_type` (`string`): Set the `user_trust_provider_type` field on the resulting resource block. When `null`, the `user_trust_provider_type` field will be omitted from the resulting object.\n - `device_options` (`list[obj]`): Set the `device_options` field on the resulting resource block. When `null`, the `device_options` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [aws.verifiedaccess_trust_provider.device_options.new](#fn-device_optionsnew) constructor.\n - `oidc_options` (`list[obj]`): Set the `oidc_options` field on the resulting resource block. When `null`, the `oidc_options` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [aws.verifiedaccess_trust_provider.oidc_options.new](#fn-oidc_optionsnew) constructor.\n - `timeouts` (`obj`): Set the `timeouts` field on the resulting resource block. When `null`, the `timeouts` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [aws.verifiedaccess_trust_provider.timeouts.new](#fn-timeoutsnew) constructor.\n\n**Returns**:\n- A mixin object that injects the new resource into the root Terraform configuration.\n", args=[]), + new( + resourceLabel, + policy_reference_name, + trust_provider_type, + description=null, + device_options=null, + device_trust_provider_type=null, + oidc_options=null, + tags=null, + tags_all=null, + timeouts=null, + user_trust_provider_type=null, + _meta={} + ):: tf.withResource( + type='aws_verifiedaccess_trust_provider', + label=resourceLabel, + attrs=self.newAttrs( + description=description, + device_options=device_options, + device_trust_provider_type=device_trust_provider_type, + oidc_options=oidc_options, + policy_reference_name=policy_reference_name, + tags=tags, + tags_all=tags_all, + timeouts=timeouts, + trust_provider_type=trust_provider_type, + user_trust_provider_type=user_trust_provider_type + ), + _meta=_meta + ), + '#newAttrs':: d.fn(help='\n`aws.verifiedaccess_trust_provider.newAttrs` constructs a new object with attributes and blocks configured for the `verifiedaccess_trust_provider`\nTerraform resource.\n\nUnlike [aws.verifiedaccess_trust_provider.new](#fn-new), this function will not inject the `resource`\nblock into the root Terraform document. Instead, this must be passed in as the `attrs` argument for the\n[tf.withResource](https://github.com/tf-libsonnet/core/tree/main/docs#fn-withresource) function to build a complete block.\n\nThis is most useful when you need to preprocess the attributes with functions, conditional, or looping logic prior to\ninjecting into a complete block.\n\n**Args**:\n - `description` (`string`): Set the `description` field on the resulting object. When `null`, the `description` field will be omitted from the resulting object.\n - `device_trust_provider_type` (`string`): Set the `device_trust_provider_type` field on the resulting object. When `null`, the `device_trust_provider_type` field will be omitted from the resulting object.\n - `policy_reference_name` (`string`): Set the `policy_reference_name` field on the resulting object.\n - `tags` (`obj`): Set the `tags` field on the resulting object. When `null`, the `tags` field will be omitted from the resulting object.\n - `tags_all` (`obj`): Set the `tags_all` field on the resulting object. When `null`, the `tags_all` field will be omitted from the resulting object.\n - `trust_provider_type` (`string`): Set the `trust_provider_type` field on the resulting object.\n - `user_trust_provider_type` (`string`): Set the `user_trust_provider_type` field on the resulting object. When `null`, the `user_trust_provider_type` field will be omitted from the resulting object.\n - `device_options` (`list[obj]`): Set the `device_options` field on the resulting object. When `null`, the `device_options` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [aws.verifiedaccess_trust_provider.device_options.new](#fn-device_optionsnew) constructor.\n - `oidc_options` (`list[obj]`): Set the `oidc_options` field on the resulting object. When `null`, the `oidc_options` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [aws.verifiedaccess_trust_provider.oidc_options.new](#fn-oidc_optionsnew) constructor.\n - `timeouts` (`obj`): Set the `timeouts` field on the resulting object. When `null`, the `timeouts` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [aws.verifiedaccess_trust_provider.timeouts.new](#fn-timeoutsnew) constructor.\n\n**Returns**:\n - An attribute object that can be used with [tf.withResource](https://github.com/tf-libsonnet/core/tree/main/docs#fn-withresource) to construct a new `verifiedaccess_trust_provider` resource into the root Terraform configuration.\n', args=[]), + newAttrs( + policy_reference_name, + trust_provider_type, + description=null, + device_options=null, + device_trust_provider_type=null, + oidc_options=null, + tags=null, + tags_all=null, + timeouts=null, + user_trust_provider_type=null + ):: std.prune(a={ + description: description, + device_options: device_options, + device_trust_provider_type: device_trust_provider_type, + oidc_options: oidc_options, + policy_reference_name: policy_reference_name, + tags: tags, + tags_all: tags_all, + timeouts: timeouts, + trust_provider_type: trust_provider_type, + user_trust_provider_type: user_trust_provider_type, + }), + oidc_options:: { + '#new':: d.fn(help='\n`aws.verifiedaccess_trust_provider.oidc_options.new` constructs a new object with attributes and blocks configured for the `oidc_options`\nTerraform sub block.\n\n\n\n**Args**:\n - `authorization_endpoint` (`string`): Set the `authorization_endpoint` field on the resulting object. When `null`, the `authorization_endpoint` field will be omitted from the resulting object.\n - `client_id` (`string`): Set the `client_id` field on the resulting object. When `null`, the `client_id` field will be omitted from the resulting object.\n - `client_secret` (`string`): Set the `client_secret` field on the resulting object.\n - `issuer` (`string`): Set the `issuer` field on the resulting object. When `null`, the `issuer` field will be omitted from the resulting object.\n - `scope` (`string`): Set the `scope` field on the resulting object. When `null`, the `scope` field will be omitted from the resulting object.\n - `token_endpoint` (`string`): Set the `token_endpoint` field on the resulting object. When `null`, the `token_endpoint` field will be omitted from the resulting object.\n - `user_info_endpoint` (`string`): Set the `user_info_endpoint` field on the resulting object. When `null`, the `user_info_endpoint` field will be omitted from the resulting object.\n\n**Returns**:\n - An attribute object that represents the `oidc_options` sub block.\n', args=[]), + new( + client_secret, + authorization_endpoint=null, + client_id=null, + issuer=null, + scope=null, + token_endpoint=null, + user_info_endpoint=null + ):: std.prune(a={ + authorization_endpoint: authorization_endpoint, + client_id: client_id, + client_secret: client_secret, + issuer: issuer, + scope: scope, + token_endpoint: token_endpoint, + user_info_endpoint: user_info_endpoint, + }), + }, + timeouts:: { + '#new':: d.fn(help='\n`aws.verifiedaccess_trust_provider.timeouts.new` constructs a new object with attributes and blocks configured for the `timeouts`\nTerraform sub block.\n\n\n\n**Args**:\n - `create` (`string`): Set the `create` field on the resulting object. When `null`, the `create` field will be omitted from the resulting object.\n - `delete` (`string`): Set the `delete` field on the resulting object. When `null`, the `delete` field will be omitted from the resulting object.\n - `update` (`string`): Set the `update` field on the resulting object. When `null`, the `update` field will be omitted from the resulting object.\n\n**Returns**:\n - An attribute object that represents the `timeouts` sub block.\n', args=[]), + new( + create=null, + delete=null, + update=null + ):: std.prune(a={ + create: create, + delete: delete, + update: update, + }), + }, + '#withDescription':: d.fn(help='`aws.string.withDescription` constructs a mixin object that can be merged into the `string`\nTerraform resource block to set or update the description field.\n\n\n\n**Args**:\n - `resourceLabel` (`string`): The name label of the block to update.\n - `value` (`string`): The value to set for the `description` field.\n', args=[]), + withDescription(resourceLabel, value): { + resource+: { + aws_verifiedaccess_trust_provider+: { + [resourceLabel]+: { + description: value, + }, + }, + }, + }, + '#withDeviceOptions':: d.fn(help='`aws.list[obj].withDeviceOptions` constructs a mixin object that can be merged into the `list[obj]`\nTerraform resource block to set or update the device_options field.\n\nThis function will replace the array with the passed in `value`. If you wish to instead append the\npassed in value to the existing array, use the [aws.list[obj].withDeviceOptionsMixin](TODO) function.\n\n\n**Args**:\n - `resourceLabel` (`string`): The name label of the block to update.\n - `value` (`list[obj]`): The value to set for the `device_options` field.\n', args=[]), + withDeviceOptions(resourceLabel, value): { + resource+: { + aws_verifiedaccess_trust_provider+: { + [resourceLabel]+: { + device_options: value, + }, + }, + }, + }, + '#withDeviceOptionsMixin':: d.fn(help='`aws.list[obj].withDeviceOptionsMixin` constructs a mixin object that can be merged into the `list[obj]`\nTerraform resource block to set or update the device_options field.\n\nThis function will append the passed in array or object to the existing array. If you wish\nto instead replace the array with the passed in `value`, use the [aws.list[obj].withDeviceOptions](TODO)\nfunction.\n\n\n**Args**:\n - `resourceLabel` (`string`): The name label of the block to update.\n - `value` (`list[obj]`): The value to set for the `device_options` field.\n', args=[]), + withDeviceOptionsMixin(resourceLabel, value): { + resource+: { + aws_verifiedaccess_trust_provider+: { + [resourceLabel]+: { + device_options+: if std.isArray(v=value) then value else [value], + }, + }, + }, + }, + '#withDeviceTrustProviderType':: d.fn(help='`aws.string.withDeviceTrustProviderType` constructs a mixin object that can be merged into the `string`\nTerraform resource block to set or update the device_trust_provider_type field.\n\n\n\n**Args**:\n - `resourceLabel` (`string`): The name label of the block to update.\n - `value` (`string`): The value to set for the `device_trust_provider_type` field.\n', args=[]), + withDeviceTrustProviderType(resourceLabel, value): { + resource+: { + aws_verifiedaccess_trust_provider+: { + [resourceLabel]+: { + device_trust_provider_type: value, + }, + }, + }, + }, + '#withOidcOptions':: d.fn(help='`aws.list[obj].withOidcOptions` constructs a mixin object that can be merged into the `list[obj]`\nTerraform resource block to set or update the oidc_options field.\n\nThis function will replace the array with the passed in `value`. If you wish to instead append the\npassed in value to the existing array, use the [aws.list[obj].withOidcOptionsMixin](TODO) function.\n\n\n**Args**:\n - `resourceLabel` (`string`): The name label of the block to update.\n - `value` (`list[obj]`): The value to set for the `oidc_options` field.\n', args=[]), + withOidcOptions(resourceLabel, value): { + resource+: { + aws_verifiedaccess_trust_provider+: { + [resourceLabel]+: { + oidc_options: value, + }, + }, + }, + }, + '#withOidcOptionsMixin':: d.fn(help='`aws.list[obj].withOidcOptionsMixin` constructs a mixin object that can be merged into the `list[obj]`\nTerraform resource block to set or update the oidc_options field.\n\nThis function will append the passed in array or object to the existing array. If you wish\nto instead replace the array with the passed in `value`, use the [aws.list[obj].withOidcOptions](TODO)\nfunction.\n\n\n**Args**:\n - `resourceLabel` (`string`): The name label of the block to update.\n - `value` (`list[obj]`): The value to set for the `oidc_options` field.\n', args=[]), + withOidcOptionsMixin(resourceLabel, value): { + resource+: { + aws_verifiedaccess_trust_provider+: { + [resourceLabel]+: { + oidc_options+: if std.isArray(v=value) then value else [value], + }, + }, + }, + }, + '#withPolicyReferenceName':: d.fn(help='`aws.string.withPolicyReferenceName` constructs a mixin object that can be merged into the `string`\nTerraform resource block to set or update the policy_reference_name field.\n\n\n\n**Args**:\n - `resourceLabel` (`string`): The name label of the block to update.\n - `value` (`string`): The value to set for the `policy_reference_name` field.\n', args=[]), + withPolicyReferenceName(resourceLabel, value): { + resource+: { + aws_verifiedaccess_trust_provider+: { + [resourceLabel]+: { + policy_reference_name: value, + }, + }, + }, + }, + '#withTags':: d.fn(help='`aws.obj.withTags` constructs a mixin object that can be merged into the `obj`\nTerraform resource block to set or update the tags field.\n\n\n\n**Args**:\n - `resourceLabel` (`string`): The name label of the block to update.\n - `value` (`obj`): The value to set for the `tags` field.\n', args=[]), + withTags(resourceLabel, value): { + resource+: { + aws_verifiedaccess_trust_provider+: { + [resourceLabel]+: { + tags: value, + }, + }, + }, + }, + '#withTagsAll':: d.fn(help='`aws.obj.withTagsAll` constructs a mixin object that can be merged into the `obj`\nTerraform resource block to set or update the tags_all field.\n\n\n\n**Args**:\n - `resourceLabel` (`string`): The name label of the block to update.\n - `value` (`obj`): The value to set for the `tags_all` field.\n', args=[]), + withTagsAll(resourceLabel, value): { + resource+: { + aws_verifiedaccess_trust_provider+: { + [resourceLabel]+: { + tags_all: value, + }, + }, + }, + }, + '#withTimeouts':: d.fn(help='`aws.obj.withTimeouts` constructs a mixin object that can be merged into the `obj`\nTerraform resource block to set or update the timeouts field.\n\nThis function will replace the map with the passed in `value`. If you wish to instead merge the\npassed in value to the existing map, use the [aws.obj.withTimeoutsMixin](TODO) function.\n\n**Args**:\n - `resourceLabel` (`string`): The name label of the block to update.\n - `value` (`obj`): The value to set for the `timeouts` field.\n', args=[]), + withTimeouts(resourceLabel, value): { + resource+: { + aws_verifiedaccess_trust_provider+: { + [resourceLabel]+: { + timeouts: value, + }, + }, + }, + }, + '#withTimeoutsMixin':: d.fn(help='`aws.obj.withTimeoutsMixin` constructs a mixin object that can be merged into the `obj`\nTerraform resource block to set or update the timeouts field.\n\nThis function will merge the passed in value to the existing map. If you wish\nto instead replace the entire map with the passed in `value`, use the [aws.obj.withTimeouts](TODO)\nfunction.\n\n\n**Args**:\n - `resourceLabel` (`string`): The name label of the block to update.\n - `value` (`obj`): The value to set for the `timeouts` field.\n', args=[]), + withTimeoutsMixin(resourceLabel, value): { + resource+: { + aws_verifiedaccess_trust_provider+: { + [resourceLabel]+: { + timeouts+: value, + }, + }, + }, + }, + '#withTrustProviderType':: d.fn(help='`aws.string.withTrustProviderType` constructs a mixin object that can be merged into the `string`\nTerraform resource block to set or update the trust_provider_type field.\n\n\n\n**Args**:\n - `resourceLabel` (`string`): The name label of the block to update.\n - `value` (`string`): The value to set for the `trust_provider_type` field.\n', args=[]), + withTrustProviderType(resourceLabel, value): { + resource+: { + aws_verifiedaccess_trust_provider+: { + [resourceLabel]+: { + trust_provider_type: value, + }, + }, + }, + }, + '#withUserTrustProviderType':: d.fn(help='`aws.string.withUserTrustProviderType` constructs a mixin object that can be merged into the `string`\nTerraform resource block to set or update the user_trust_provider_type field.\n\n\n\n**Args**:\n - `resourceLabel` (`string`): The name label of the block to update.\n - `value` (`string`): The value to set for the `user_trust_provider_type` field.\n', args=[]), + withUserTrustProviderType(resourceLabel, value): { + resource+: { + aws_verifiedaccess_trust_provider+: { + [resourceLabel]+: { + user_trust_provider_type: value, + }, + }, + }, + }, +} diff --git a/docs/5.x/README.md b/docs/5.x/README.md index 10525c44..09102f13 100644 --- a/docs/5.x/README.md +++ b/docs/5.x/README.md @@ -1177,6 +1177,7 @@ project. * [transfer_tag](transfer_tag.md) * [transfer_user](transfer_user.md) * [transfer_workflow](transfer_workflow.md) +* [verifiedaccess_trust_provider](verifiedaccess_trust_provider.md) * [volume_attachment](volume_attachment.md) * [vpc](vpc.md) * [vpc_dhcp_options](vpc_dhcp_options.md) diff --git a/docs/5.x/data/cognito_identity_pool.md b/docs/5.x/data/cognito_identity_pool.md new file mode 100644 index 00000000..f8d9ca21 --- /dev/null +++ b/docs/5.x/data/cognito_identity_pool.md @@ -0,0 +1,111 @@ +--- +permalink: /data/cognito_identity_pool/ +--- + +# data.cognito_identity_pool + +`cognito_identity_pool` represents the `aws_cognito_identity_pool` Terraform data source. + + + +This package contains functions and utilities for setting up the data source using Jsonnet code. + + +## Index + +* [`fn new()`](#fn-new) +* [`fn newAttrs()`](#fn-newattrs) +* [`fn withIdentityPoolName()`](#fn-withidentitypoolname) +* [`fn withTags()`](#fn-withtags) + +## Fields + +### fn new + +```ts +new() +``` + + +`aws.data.cognito_identity_pool.new` injects a new `data_aws_cognito_identity_pool` Terraform `data source` +block into the root module document. + +Additionally, this inserts a private function into the `_ref` attribute that generates references to attributes of the +resource. For example, if you added a new instance to the root using: + + # arguments omitted for brevity + aws.data.cognito_identity_pool.new('some_id') + +You can get the reference to the `id` field of the created `aws.data.cognito_identity_pool` using the reference: + + $._ref.data_aws_cognito_identity_pool.some_id.get('id') + +This is the same as directly entering `"${ data_aws_cognito_identity_pool.some_id.id }"` as the value. + +NOTE: if you are chaining multiple resources together in a merge operation, you may not be able to use `super`, `self`, +or `$` to refer to the root object. Instead, make an explicit outer object using `local`. + +**Args**: + - `dataSrcLabel` (`string`): The name label of the block. + - `identity_pool_name` (`string`): Set the `identity_pool_name` field on the resulting data source block. + - `tags` (`obj`): Set the `tags` field on the resulting data source block. When `null`, the `tags` field will be omitted from the resulting object. + +**Returns**: +- A mixin object that injects the new data source into the root Terraform configuration. + + +### fn newAttrs + +```ts +newAttrs() +``` + + +`aws.data.cognito_identity_pool.newAttrs` constructs a new object with attributes and blocks configured for the `cognito_identity_pool` +Terraform data source. + +Unlike [aws.data.cognito_identity_pool.new](#fn-new), this function will not inject the `data source` +block into the root Terraform document. Instead, this must be passed in as the `attrs` argument for the +[tf.withData](https://github.com/tf-libsonnet/core/tree/main/docs#fn-withdata) function to build a complete block. + +This is most useful when you need to preprocess the attributes with functions, conditional, or looping logic prior to +injecting into a complete block. + +**Args**: + - `identity_pool_name` (`string`): Set the `identity_pool_name` field on the resulting object. + - `tags` (`obj`): Set the `tags` field on the resulting object. When `null`, the `tags` field will be omitted from the resulting object. + +**Returns**: + - An attribute object that can be used with [tf.withData](https://github.com/tf-libsonnet/core/tree/main/docs#fn-withdata) to construct a new `cognito_identity_pool` data source into the root Terraform configuration. + + +### fn withIdentityPoolName + +```ts +withIdentityPoolName() +``` + +`aws.string.withIdentityPoolName` constructs a mixin object that can be merged into the `string` +Terraform data source block to set or update the identity_pool_name field. + + + +**Args**: + - `dataSrcLabel` (`string`): The name label of the block to update. + - `value` (`string`): The value to set for the `identity_pool_name` field. + + +### fn withTags + +```ts +withTags() +``` + +`aws.obj.withTags` constructs a mixin object that can be merged into the `obj` +Terraform data source block to set or update the tags field. + + + +**Args**: + - `dataSrcLabel` (`string`): The name label of the block to update. + - `value` (`obj`): The value to set for the `tags` field. diff --git a/docs/5.x/data/index.md b/docs/5.x/data/index.md index 3696e0c2..31acda35 100644 --- a/docs/5.x/data/index.md +++ b/docs/5.x/data/index.md @@ -86,6 +86,7 @@ permalink: /data/ * [codecommit_approval_rule_template](codecommit_approval_rule_template.md) * [codecommit_repository](codecommit_repository.md) * [codestarconnections_connection](codestarconnections_connection.md) +* [cognito_identity_pool](cognito_identity_pool.md) * [cognito_user_pool_client](cognito_user_pool_client.md) * [cognito_user_pool_clients](cognito_user_pool_clients.md) * [cognito_user_pool_signing_certificate](cognito_user_pool_signing_certificate.md) diff --git a/docs/5.x/verifiedaccess_trust_provider.md b/docs/5.x/verifiedaccess_trust_provider.md new file mode 100644 index 00000000..0daa91b7 --- /dev/null +++ b/docs/5.x/verifiedaccess_trust_provider.md @@ -0,0 +1,411 @@ +--- +permalink: /verifiedaccess_trust_provider/ +--- + +# verifiedaccess_trust_provider + +`verifiedaccess_trust_provider` represents the `aws_verifiedaccess_trust_provider` Terraform resource. + + + +This package contains functions and utilities for setting up the resource using Jsonnet code. + + +## Index + +* [`fn new()`](#fn-new) +* [`fn newAttrs()`](#fn-newattrs) +* [`fn withDescription()`](#fn-withdescription) +* [`fn withDeviceOptions()`](#fn-withdeviceoptions) +* [`fn withDeviceOptionsMixin()`](#fn-withdeviceoptionsmixin) +* [`fn withDeviceTrustProviderType()`](#fn-withdevicetrustprovidertype) +* [`fn withOidcOptions()`](#fn-withoidcoptions) +* [`fn withOidcOptionsMixin()`](#fn-withoidcoptionsmixin) +* [`fn withPolicyReferenceName()`](#fn-withpolicyreferencename) +* [`fn withTags()`](#fn-withtags) +* [`fn withTagsAll()`](#fn-withtagsall) +* [`fn withTimeouts()`](#fn-withtimeouts) +* [`fn withTimeoutsMixin()`](#fn-withtimeoutsmixin) +* [`fn withTrustProviderType()`](#fn-withtrustprovidertype) +* [`fn withUserTrustProviderType()`](#fn-withusertrustprovidertype) +* [`obj device_options`](#obj-device_options) + * [`fn new()`](#fn-device_optionsnew) +* [`obj oidc_options`](#obj-oidc_options) + * [`fn new()`](#fn-oidc_optionsnew) +* [`obj timeouts`](#obj-timeouts) + * [`fn new()`](#fn-timeoutsnew) + +## Fields + +### fn new + +```ts +new() +``` + + +`aws.verifiedaccess_trust_provider.new` injects a new `aws_verifiedaccess_trust_provider` Terraform `resource` +block into the root module document. + +Additionally, this inserts a private function into the `_ref` attribute that generates references to attributes of the +resource. For example, if you added a new instance to the root using: + + # arguments omitted for brevity + aws.verifiedaccess_trust_provider.new('some_id') + +You can get the reference to the `id` field of the created `aws.verifiedaccess_trust_provider` using the reference: + + $._ref.aws_verifiedaccess_trust_provider.some_id.get('id') + +This is the same as directly entering `"${ aws_verifiedaccess_trust_provider.some_id.id }"` as the value. + +NOTE: if you are chaining multiple resources together in a merge operation, you may not be able to use `super`, `self`, +or `$` to refer to the root object. Instead, make an explicit outer object using `local`. + +**Args**: + - `resourceLabel` (`string`): The name label of the block. + - `description` (`string`): Set the `description` field on the resulting resource block. When `null`, the `description` field will be omitted from the resulting object. + - `device_trust_provider_type` (`string`): Set the `device_trust_provider_type` field on the resulting resource block. When `null`, the `device_trust_provider_type` field will be omitted from the resulting object. + - `policy_reference_name` (`string`): Set the `policy_reference_name` field on the resulting resource block. + - `tags` (`obj`): Set the `tags` field on the resulting resource block. When `null`, the `tags` field will be omitted from the resulting object. + - `tags_all` (`obj`): Set the `tags_all` field on the resulting resource block. When `null`, the `tags_all` field will be omitted from the resulting object. + - `trust_provider_type` (`string`): Set the `trust_provider_type` field on the resulting resource block. + - `user_trust_provider_type` (`string`): Set the `user_trust_provider_type` field on the resulting resource block. When `null`, the `user_trust_provider_type` field will be omitted from the resulting object. + - `device_options` (`list[obj]`): Set the `device_options` field on the resulting resource block. When `null`, the `device_options` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [aws.verifiedaccess_trust_provider.device_options.new](#fn-device_optionsnew) constructor. + - `oidc_options` (`list[obj]`): Set the `oidc_options` field on the resulting resource block. When `null`, the `oidc_options` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [aws.verifiedaccess_trust_provider.oidc_options.new](#fn-oidc_optionsnew) constructor. + - `timeouts` (`obj`): Set the `timeouts` field on the resulting resource block. When `null`, the `timeouts` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [aws.verifiedaccess_trust_provider.timeouts.new](#fn-timeoutsnew) constructor. + +**Returns**: +- A mixin object that injects the new resource into the root Terraform configuration. + + +### fn newAttrs + +```ts +newAttrs() +``` + + +`aws.verifiedaccess_trust_provider.newAttrs` constructs a new object with attributes and blocks configured for the `verifiedaccess_trust_provider` +Terraform resource. + +Unlike [aws.verifiedaccess_trust_provider.new](#fn-new), this function will not inject the `resource` +block into the root Terraform document. Instead, this must be passed in as the `attrs` argument for the +[tf.withResource](https://github.com/tf-libsonnet/core/tree/main/docs#fn-withresource) function to build a complete block. + +This is most useful when you need to preprocess the attributes with functions, conditional, or looping logic prior to +injecting into a complete block. + +**Args**: + - `description` (`string`): Set the `description` field on the resulting object. When `null`, the `description` field will be omitted from the resulting object. + - `device_trust_provider_type` (`string`): Set the `device_trust_provider_type` field on the resulting object. When `null`, the `device_trust_provider_type` field will be omitted from the resulting object. + - `policy_reference_name` (`string`): Set the `policy_reference_name` field on the resulting object. + - `tags` (`obj`): Set the `tags` field on the resulting object. When `null`, the `tags` field will be omitted from the resulting object. + - `tags_all` (`obj`): Set the `tags_all` field on the resulting object. When `null`, the `tags_all` field will be omitted from the resulting object. + - `trust_provider_type` (`string`): Set the `trust_provider_type` field on the resulting object. + - `user_trust_provider_type` (`string`): Set the `user_trust_provider_type` field on the resulting object. When `null`, the `user_trust_provider_type` field will be omitted from the resulting object. + - `device_options` (`list[obj]`): Set the `device_options` field on the resulting object. When `null`, the `device_options` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [aws.verifiedaccess_trust_provider.device_options.new](#fn-device_optionsnew) constructor. + - `oidc_options` (`list[obj]`): Set the `oidc_options` field on the resulting object. When `null`, the `oidc_options` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [aws.verifiedaccess_trust_provider.oidc_options.new](#fn-oidc_optionsnew) constructor. + - `timeouts` (`obj`): Set the `timeouts` field on the resulting object. When `null`, the `timeouts` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [aws.verifiedaccess_trust_provider.timeouts.new](#fn-timeoutsnew) constructor. + +**Returns**: + - An attribute object that can be used with [tf.withResource](https://github.com/tf-libsonnet/core/tree/main/docs#fn-withresource) to construct a new `verifiedaccess_trust_provider` resource into the root Terraform configuration. + + +### fn withDescription + +```ts +withDescription() +``` + +`aws.string.withDescription` constructs a mixin object that can be merged into the `string` +Terraform resource block to set or update the description field. + + + +**Args**: + - `resourceLabel` (`string`): The name label of the block to update. + - `value` (`string`): The value to set for the `description` field. + + +### fn withDeviceOptions + +```ts +withDeviceOptions() +``` + +`aws.list[obj].withDeviceOptions` constructs a mixin object that can be merged into the `list[obj]` +Terraform resource block to set or update the device_options field. + +This function will replace the array with the passed in `value`. If you wish to instead append the +passed in value to the existing array, use the [aws.list[obj].withDeviceOptionsMixin](TODO) function. + + +**Args**: + - `resourceLabel` (`string`): The name label of the block to update. + - `value` (`list[obj]`): The value to set for the `device_options` field. + + +### fn withDeviceOptionsMixin + +```ts +withDeviceOptionsMixin() +``` + +`aws.list[obj].withDeviceOptionsMixin` constructs a mixin object that can be merged into the `list[obj]` +Terraform resource block to set or update the device_options field. + +This function will append the passed in array or object to the existing array. If you wish +to instead replace the array with the passed in `value`, use the [aws.list[obj].withDeviceOptions](TODO) +function. + + +**Args**: + - `resourceLabel` (`string`): The name label of the block to update. + - `value` (`list[obj]`): The value to set for the `device_options` field. + + +### fn withDeviceTrustProviderType + +```ts +withDeviceTrustProviderType() +``` + +`aws.string.withDeviceTrustProviderType` constructs a mixin object that can be merged into the `string` +Terraform resource block to set or update the device_trust_provider_type field. + + + +**Args**: + - `resourceLabel` (`string`): The name label of the block to update. + - `value` (`string`): The value to set for the `device_trust_provider_type` field. + + +### fn withOidcOptions + +```ts +withOidcOptions() +``` + +`aws.list[obj].withOidcOptions` constructs a mixin object that can be merged into the `list[obj]` +Terraform resource block to set or update the oidc_options field. + +This function will replace the array with the passed in `value`. If you wish to instead append the +passed in value to the existing array, use the [aws.list[obj].withOidcOptionsMixin](TODO) function. + + +**Args**: + - `resourceLabel` (`string`): The name label of the block to update. + - `value` (`list[obj]`): The value to set for the `oidc_options` field. + + +### fn withOidcOptionsMixin + +```ts +withOidcOptionsMixin() +``` + +`aws.list[obj].withOidcOptionsMixin` constructs a mixin object that can be merged into the `list[obj]` +Terraform resource block to set or update the oidc_options field. + +This function will append the passed in array or object to the existing array. If you wish +to instead replace the array with the passed in `value`, use the [aws.list[obj].withOidcOptions](TODO) +function. + + +**Args**: + - `resourceLabel` (`string`): The name label of the block to update. + - `value` (`list[obj]`): The value to set for the `oidc_options` field. + + +### fn withPolicyReferenceName + +```ts +withPolicyReferenceName() +``` + +`aws.string.withPolicyReferenceName` constructs a mixin object that can be merged into the `string` +Terraform resource block to set or update the policy_reference_name field. + + + +**Args**: + - `resourceLabel` (`string`): The name label of the block to update. + - `value` (`string`): The value to set for the `policy_reference_name` field. + + +### fn withTags + +```ts +withTags() +``` + +`aws.obj.withTags` constructs a mixin object that can be merged into the `obj` +Terraform resource block to set or update the tags field. + + + +**Args**: + - `resourceLabel` (`string`): The name label of the block to update. + - `value` (`obj`): The value to set for the `tags` field. + + +### fn withTagsAll + +```ts +withTagsAll() +``` + +`aws.obj.withTagsAll` constructs a mixin object that can be merged into the `obj` +Terraform resource block to set or update the tags_all field. + + + +**Args**: + - `resourceLabel` (`string`): The name label of the block to update. + - `value` (`obj`): The value to set for the `tags_all` field. + + +### fn withTimeouts + +```ts +withTimeouts() +``` + +`aws.obj.withTimeouts` constructs a mixin object that can be merged into the `obj` +Terraform resource block to set or update the timeouts field. + +This function will replace the map with the passed in `value`. If you wish to instead merge the +passed in value to the existing map, use the [aws.obj.withTimeoutsMixin](TODO) function. + +**Args**: + - `resourceLabel` (`string`): The name label of the block to update. + - `value` (`obj`): The value to set for the `timeouts` field. + + +### fn withTimeoutsMixin + +```ts +withTimeoutsMixin() +``` + +`aws.obj.withTimeoutsMixin` constructs a mixin object that can be merged into the `obj` +Terraform resource block to set or update the timeouts field. + +This function will merge the passed in value to the existing map. If you wish +to instead replace the entire map with the passed in `value`, use the [aws.obj.withTimeouts](TODO) +function. + + +**Args**: + - `resourceLabel` (`string`): The name label of the block to update. + - `value` (`obj`): The value to set for the `timeouts` field. + + +### fn withTrustProviderType + +```ts +withTrustProviderType() +``` + +`aws.string.withTrustProviderType` constructs a mixin object that can be merged into the `string` +Terraform resource block to set or update the trust_provider_type field. + + + +**Args**: + - `resourceLabel` (`string`): The name label of the block to update. + - `value` (`string`): The value to set for the `trust_provider_type` field. + + +### fn withUserTrustProviderType + +```ts +withUserTrustProviderType() +``` + +`aws.string.withUserTrustProviderType` constructs a mixin object that can be merged into the `string` +Terraform resource block to set or update the user_trust_provider_type field. + + + +**Args**: + - `resourceLabel` (`string`): The name label of the block to update. + - `value` (`string`): The value to set for the `user_trust_provider_type` field. + + +## obj device_options + + + +### fn device_options.new + +```ts +new() +``` + + +`aws.verifiedaccess_trust_provider.device_options.new` constructs a new object with attributes and blocks configured for the `device_options` +Terraform sub block. + + + +**Args**: + - `tenant_id` (`string`): Set the `tenant_id` field on the resulting object. When `null`, the `tenant_id` field will be omitted from the resulting object. + +**Returns**: + - An attribute object that represents the `device_options` sub block. + + +## obj oidc_options + + + +### fn oidc_options.new + +```ts +new() +``` + + +`aws.verifiedaccess_trust_provider.oidc_options.new` constructs a new object with attributes and blocks configured for the `oidc_options` +Terraform sub block. + + + +**Args**: + - `authorization_endpoint` (`string`): Set the `authorization_endpoint` field on the resulting object. When `null`, the `authorization_endpoint` field will be omitted from the resulting object. + - `client_id` (`string`): Set the `client_id` field on the resulting object. When `null`, the `client_id` field will be omitted from the resulting object. + - `client_secret` (`string`): Set the `client_secret` field on the resulting object. + - `issuer` (`string`): Set the `issuer` field on the resulting object. When `null`, the `issuer` field will be omitted from the resulting object. + - `scope` (`string`): Set the `scope` field on the resulting object. When `null`, the `scope` field will be omitted from the resulting object. + - `token_endpoint` (`string`): Set the `token_endpoint` field on the resulting object. When `null`, the `token_endpoint` field will be omitted from the resulting object. + - `user_info_endpoint` (`string`): Set the `user_info_endpoint` field on the resulting object. When `null`, the `user_info_endpoint` field will be omitted from the resulting object. + +**Returns**: + - An attribute object that represents the `oidc_options` sub block. + + +## obj timeouts + + + +### fn timeouts.new + +```ts +new() +``` + + +`aws.verifiedaccess_trust_provider.timeouts.new` constructs a new object with attributes and blocks configured for the `timeouts` +Terraform sub block. + + + +**Args**: + - `create` (`string`): Set the `create` field on the resulting object. When `null`, the `create` field will be omitted from the resulting object. + - `delete` (`string`): Set the `delete` field on the resulting object. When `null`, the `delete` field will be omitted from the resulting object. + - `update` (`string`): Set the `update` field on the resulting object. When `null`, the `update` field will be omitted from the resulting object. + +**Returns**: + - An attribute object that represents the `timeouts` sub block.