_aws_profile Input Column
The AWS profile defines the AWS identity used. It can be defined via credentials or by assuming a IAM role. | STRUCT(
"type" VARCHAR,
"name" VARCHAR,
"account_id" VARCHAR,
"via_profile_name" VARCHAR,
"assumed_role_arn" VARCHAR,
"organization" STRUCT(
"account_name" VARCHAR,
"id" VARCHAR,
"tags" STRUCT(
"key" VARCHAR,
"value" VARCHAR
)[],
"master_account" STRUCT(
"id" VARCHAR,
"email" VARCHAR
),
"parents" STRUCT(
"type" VARCHAR,
"id" VARCHAR,
"name" VARCHAR,
"tags" STRUCT(
"key" VARCHAR,
"value" VARCHAR
)[]
)[]
)
) |
dry_run_config
Details about the changes you're planning to make on the domain. | STRUCT(
"domain_id" VARCHAR,
"domain_name" VARCHAR,
"arn" VARCHAR,
"created" BOOLEAN,
"deleted" BOOLEAN,
"endpoint" VARCHAR,
"endpoint_v2" VARCHAR,
"endpoints" MAP(VARCHAR, VARCHAR),
"domain_endpoint_v2_hosted_zone_id" VARCHAR,
"processing" BOOLEAN,
"upgrade_processing" BOOLEAN,
"engine_version" VARCHAR,
"cluster_config" STRUCT(
"instance_type" VARCHAR,
"instance_count" BIGINT,
"dedicated_master_enabled" BOOLEAN,
"zone_awareness_enabled" BOOLEAN,
"zone_awareness_config" STRUCT(
"availability_zone_count" BIGINT
),
"dedicated_master_type" VARCHAR,
"dedicated_master_count" BIGINT,
"warm_enabled" BOOLEAN,
"warm_type" VARCHAR,
"warm_count" BIGINT,
"cold_storage_options" STRUCT(
"enabled" BOOLEAN
),
"multi_az_with_standby_enabled" BOOLEAN
),
"ebs_options" STRUCT(
"ebs_enabled" BOOLEAN,
"volume_type" VARCHAR,
"volume_size" BIGINT,
"iops" BIGINT,
"throughput" BIGINT
),
"access_policies" VARCHAR,
"ip_address_type" VARCHAR,
"snapshot_options" STRUCT(
"automated_snapshot_start_hour" BIGINT
),
"vpc_options" STRUCT(
"vpc_id" VARCHAR,
"subnet_ids" VARCHAR[],
"availability_zones" VARCHAR[],
"security_group_ids" VARCHAR[]
),
"cognito_options" STRUCT(
"enabled" BOOLEAN,
"user_pool_id" VARCHAR,
"identity_pool_id" VARCHAR,
"role_arn" VARCHAR
),
"encryption_at_rest_options" STRUCT(
"enabled" BOOLEAN,
"kms_key_id" VARCHAR
),
"node_to_node_encryption_options" STRUCT(
"enabled" BOOLEAN
),
"advanced_options" MAP(VARCHAR, VARCHAR),
"log_publishing_options" MAP(VARCHAR, STRUCT(
"cloud_watch_logs_log_group_arn" VARCHAR,
"enabled" BOOLEAN
)),
"service_software_options" STRUCT(
"current_version" VARCHAR,
"new_version" VARCHAR,
"update_available" BOOLEAN,
"cancellable" BOOLEAN,
"update_status" VARCHAR,
"description" VARCHAR,
"automated_update_date" TIMESTAMP_S,
"optional_deployment" BOOLEAN
),
"domain_endpoint_options" STRUCT(
"enforce_https" BOOLEAN,
"tls_security_policy" VARCHAR,
"custom_endpoint_enabled" BOOLEAN,
"custom_endpoint" VARCHAR,
"custom_endpoint_certificate_arn" VARCHAR
),
"advanced_security_options" STRUCT(
"enabled" BOOLEAN,
"internal_user_database_enabled" BOOLEAN,
"saml_options" STRUCT(
"enabled" BOOLEAN,
"idp" STRUCT(
"metadata_content" VARCHAR,
"entity_id" VARCHAR
),
"subject_key" VARCHAR,
"roles_key" VARCHAR,
"session_timeout_minutes" BIGINT
),
"jwt_options" STRUCT(
"enabled" BOOLEAN,
"subject_key" VARCHAR,
"roles_key" VARCHAR,
"public_key" VARCHAR
),
"anonymous_auth_disable_date" TIMESTAMP_S,
"anonymous_auth_enabled" BOOLEAN
),
"auto_tune_options" STRUCT(
"state" VARCHAR,
"error_message" VARCHAR,
"use_off_peak_window" BOOLEAN
),
"change_progress_details" STRUCT(
"change_id" VARCHAR,
"message" VARCHAR,
"config_change_status" VARCHAR,
"initiated_by" VARCHAR,
"start_time" TIMESTAMP_S,
"last_updated_time" TIMESTAMP_S
),
"off_peak_window_options" STRUCT(
"enabled" BOOLEAN,
"off_peak_window" STRUCT(
"window_start_time" STRUCT(
"hours" BIGINT,
"minutes" BIGINT
)
)
),
"software_update_options" STRUCT(
"auto_software_update_enabled" BOOLEAN
),
"domain_processing_status" VARCHAR,
"modifying_properties" STRUCT(
"name" VARCHAR,
"active_value" VARCHAR,
"pending_value" VARCHAR,
"value_type" VARCHAR
)[],
"aiml_options" STRUCT(
"natural_language_query_generation_options" STRUCT(
"desired_state" VARCHAR,
"current_state" VARCHAR
)
)
) |
Show child fields- dry_run_config.access_policies
Identity and Access Management (IAM) policy document specifying the access policies for the domain. - dry_run_config.advanced_options
Key-value pairs that specify advanced configuration options. - dry_run_config.advanced_security_options
Settings for fine-grained access control. Show child fields- dry_run_config.advanced_security_options.anonymous_auth_disable_date
Date and time when the migration period will be disabled. Only necessary when enabling fine-grained access control on an existing domain. - dry_run_config.advanced_security_options.anonymous_auth_enabled
True if a 30-day migration period is enabled, during which administrators can create role mappings. Only necessary when enabling fine-grained access control on an existing domain. - dry_run_config.advanced_security_options.enabled
True if fine-grained access control is enabled. - dry_run_config.advanced_security_options.internal_user_database_enabled
True if the internal user database is enabled. - dry_run_config.advanced_security_options.jwt_options
Container for information about the JWT configuration of the Amazon OpenSearch Service. Show child fields- dry_run_config.advanced_security_options.jwt_options.enabled
True if JWT use is enabled. - dry_run_config.advanced_security_options.jwt_options.public_key
The key used to verify the signature of incoming JWT requests. - dry_run_config.advanced_security_options.jwt_options.roles_key
The key used for matching the JWT roles attribute. - dry_run_config.advanced_security_options.jwt_options.subject_key
The key used for matching the JWT subject attribute.
- dry_run_config.advanced_security_options.saml_options
Container for information about the SAML configuration for OpenSearch Dashboards. Show child fields- dry_run_config.advanced_security_options.saml_options.enabled
True if SAML is enabled. - dry_run_config.advanced_security_options.saml_options.idp
Describes the SAML identity provider's information. Show child fields- dry_run_config.advanced_security_options.saml_options.idp.entity_id
The unique entity ID of the application in the SAML identity provider. - dry_run_config.advanced_security_options.saml_options.idp.metadata_content
The metadata of the SAML application, in XML format.
- dry_run_config.advanced_security_options.saml_options.roles_key
The key used for matching the SAML roles attribute. - dry_run_config.advanced_security_options.saml_options.session_timeout_minutes
The duration, in minutes, after which a user session becomes inactive. - dry_run_config.advanced_security_options.saml_options.subject_key
The key used for matching the SAML subject attribute.
- dry_run_config.aiml_options
Container for parameters required to enable all machine learning features. Show child fields- dry_run_config.aiml_options.natural_language_query_generation_options
Container for parameters required for natural language query generation on the specified domain. Show child fields- dry_run_config.aiml_options.natural_language_query_generation_options.current_state
The current state of the natural language query generation feature, indicating completion, in progress, or failure. - dry_run_config.aiml_options.natural_language_query_generation_options.desired_state
The desired state of the natural language query generation feature. Valid values are ENABLED and DISABLED.
- dry_run_config.arn
The Amazon Resource Name (ARN) of the domain. For more information, see IAM identifiers in the AWS Identity and Access Management User Guide. - dry_run_config.auto_tune_options
Auto-Tune settings for the domain. Show child fields- dry_run_config.auto_tune_options.error_message
Any errors that occurred while enabling or disabling Auto-Tune. - dry_run_config.auto_tune_options.state
The current state of Auto-Tune on the domain. - dry_run_config.auto_tune_options.use_off_peak_window
Whether the domain's off-peak window will be used to deploy Auto-Tune changes rather than a maintenance schedule.
- dry_run_config.change_progress_details
Information about a configuration change happening on the domain. Show child fields- dry_run_config.change_progress_details.change_id
The ID of the configuration change. - dry_run_config.change_progress_details.config_change_status
The current status of the configuration change. - dry_run_config.change_progress_details.initiated_by
The IAM principal who initiated the configuration change. - dry_run_config.change_progress_details.last_updated_time
The last time that the configuration change was updated. - dry_run_config.change_progress_details.message
A message corresponding to the status of the configuration change. - dry_run_config.change_progress_details.start_time
The time that the configuration change was initiated, in Universal Coordinated Time (UTC).
- dry_run_config.cluster_config
Container for the cluster configuration of the domain. Show child fields- dry_run_config.cluster_config.cold_storage_options
Container for cold storage configuration options. Show child fields- dry_run_config.cluster_config.cold_storage_options.enabled
Whether to enable or disable cold storage on the domain. You must enable UltraWarm storage to enable cold storage.
- dry_run_config.cluster_config.dedicated_master_count
Number of dedicated master nodes in the cluster. This number must be greater than 2 and not 4, otherwise you receive a validation exception. - dry_run_config.cluster_config.dedicated_master_enabled
Indicates whether dedicated master nodes are enabled for the cluster.True if the cluster will use a dedicated master node.False if the cluster will not. - dry_run_config.cluster_config.dedicated_master_type
OpenSearch Service instance type of the dedicated master nodes in the cluster. - dry_run_config.cluster_config.instance_count
Number of data nodes in the cluster. This number must be greater than 1, otherwise you receive a validation exception. - dry_run_config.cluster_config.instance_type
Instance type of data nodes in the cluster. - dry_run_config.cluster_config.multi_az_with_standby_enabled
A boolean that indicates whether a multi-AZ domain is turned on with a standby AZ. For more information, see Configuring a multi-AZ domain in Amazon OpenSearch Service. - dry_run_config.cluster_config.warm_count
The number of warm nodes in the cluster. - dry_run_config.cluster_config.warm_enabled
Whether to enable warm storage for the cluster. - dry_run_config.cluster_config.warm_type
The instance type for the cluster's warm nodes. - dry_run_config.cluster_config.zone_awareness_config
Container for zone awareness configuration options. Only required if ZoneAwarenessEnabled is true. Show child fields- dry_run_config.cluster_config.zone_awareness_config.availability_zone_count
If you enabled multiple Availability Zones, this value is the number of zones that you want the domain to use. Valid values are 2 and 3. If your domain is provisioned within a VPC, this value be equal to number of subnets.
- dry_run_config.cluster_config.zone_awareness_enabled
Indicates whether multiple Availability Zones are enabled. For more information, see Configuring a multi-AZ domain in Amazon OpenSearch Service.
- dry_run_config.cognito_options
Key-value pairs to configure Amazon Cognito authentication for OpenSearch Dashboards. Show child fields- dry_run_config.cognito_options.enabled
Whether to enable or disable Amazon Cognito authentication for OpenSearch Dashboards. - dry_run_config.cognito_options.identity_pool_id
The Amazon Cognito identity pool ID that you want OpenSearch Service to use for OpenSearch Dashboards authentication. - dry_run_config.cognito_options.role_arn
The AmazonOpenSearchServiceCognitoAccess role that allows OpenSearch Service to configure your user pool and identity pool. - dry_run_config.cognito_options.user_pool_id
The Amazon Cognito user pool ID that you want OpenSearch Service to use for OpenSearch Dashboards authentication.
- dry_run_config.created
Creation status of an OpenSearch Service domain. True if domain creation is complete. False if domain creation is still in progress. - dry_run_config.deleted
Deletion status of an OpenSearch Service domain. True if domain deletion is complete. False if domain deletion is still in progress. Once deletion is complete, the status of the domain is no longer returned. - dry_run_config.domain_endpoint_options
Additional options for the domain endpoint, such as whether to require HTTPS for all traffic. Show child fields- dry_run_config.domain_endpoint_options.custom_endpoint
The fully qualified URL for the custom endpoint. - dry_run_config.domain_endpoint_options.custom_endpoint_certificate_arn
The ARN for your security certificate, managed in Amazon Web Services Certificate Manager (ACM). - dry_run_config.domain_endpoint_options.custom_endpoint_enabled
Whether to enable a custom endpoint for the domain. - dry_run_config.domain_endpoint_options.enforce_https
True to require that all traffic to the domain arrive over HTTPS. - dry_run_config.domain_endpoint_options.tls_security_policy
Specify the TLS security policy to apply to the HTTPS endpoint of the domain. The policy can be one of the following values: -
Policy-Min-TLS-1-0-2019-07: TLS security policy that supports TLS version 1.0 to TLS version 1.2 -
Policy-Min-TLS-1-2-2019-07: TLS security policy that supports only TLS version 1.2 -
Policy-Min-TLS-1-2-PFS-2023-10: TLS security policy that supports TLS version 1.2 to TLS version 1.3 with perfect forward secrecy cipher suites
- dry_run_config.domain_endpoint_v2_hosted_zone_id
The dual stack hosted zone ID for the domain. - dry_run_config.domain_id
Unique identifier for the domain. - dry_run_config.domain_name
Name of the domain. Domain names are unique across all domains owned by the same account within an Amazon Web Services Region. - dry_run_config.domain_processing_status
The status of any changes that are currently in progress for the domain. - dry_run_config.ebs_options
Container for EBS-based storage settings for the domain. Show child fields- dry_run_config.ebs_options.ebs_enabled
Indicates whether EBS volumes are attached to data nodes in an OpenSearch Service domain. - dry_run_config.ebs_options.iops
Specifies the baseline input/output (I/O) performance of EBS volumes attached to data nodes. Applicable only for the gp3 and provisioned IOPS EBS volume types. - dry_run_config.ebs_options.throughput
Specifies the throughput (in MiB/s) of the EBS volumes attached to data nodes. Applicable only for the gp3 volume type. - dry_run_config.ebs_options.volume_size
Specifies the size (in GiB) of EBS volumes attached to data nodes. - dry_run_config.ebs_options.volume_type
Specifies the type of EBS volumes attached to data nodes.
- dry_run_config.encryption_at_rest_options
Encryption at rest settings for the domain. Show child fields- dry_run_config.encryption_at_rest_options.enabled
True to enable encryption at rest. - dry_run_config.encryption_at_rest_options.kms_key_id
The KMS key ID. Takes the form 1a2a3a4-1a2a-3a4a-5a6a-1a2a3a4a5a6a.
- dry_run_config.endpoint
Domain-specific endpoint used to submit index, search, and data upload requests to the domain. - dry_run_config.endpoint_v2
If IPAddressType to set to dualstack, a version 2 domain endpoint is provisioned. This endpoint functions like a normal endpoint, except that it works with both IPv4 and IPv6 IP addresses. Normal endpoints work only with IPv4 IP addresses. - dry_run_config.endpoints
The key-value pair that exists if the OpenSearch Service domain uses VPC endpoints. For example: -
IPv4 IP addresses - 'vpc','vpc-endpoint-h2dsd34efgyghrtguk5gt6j2foh4.us-east-1.es.amazonaws.com' -
Dual stack IP addresses - 'vpcv2':'vpc-endpoint-h2dsd34efgyghrtguk5gt6j2foh4.aos.us-east-1.on.aws' - dry_run_config.engine_version
Version of OpenSearch or Elasticsearch that the domain is running, in the format Elasticsearch_X.Y or OpenSearch_X.Y. - dry_run_config.ip_address_type
The type of IP addresses supported by the endpoint for the domain. - dry_run_config.log_publishing_options
Log publishing options for the domain. - dry_run_config.modifying_properties[]
Show child fields- dry_run_config.modifying_properties[].active_value
The current value of the domain property that is being modified. - dry_run_config.modifying_properties[].name
The name of the property that is currently being modified. - dry_run_config.modifying_properties[].pending_value
The value that the property that is currently being modified will eventually have. - dry_run_config.modifying_properties[].value_type
The type of value that is currently being modified. Properties can have two types: -
PLAIN_TEXT: Contain direct values such as "1", "True", or "c5.large.search". -
STRINGIFIED_JSON: Contain content in JSON format, such as {"Enabled":"True"}".
- dry_run_config.node_to_node_encryption_options
Whether node-to-node encryption is enabled or disabled. Show child fields- dry_run_config.node_to_node_encryption_options.enabled
True to enable node-to-node encryption.
- dry_run_config.off_peak_window_options
Options that specify a custom 10-hour window during which OpenSearch Service can perform configuration changes on the domain. Show child fields- dry_run_config.off_peak_window_options.enabled
Whether to enable an off-peak window. This option is only available when modifying a domain created prior to February 16, 2023, not when creating a new domain. All domains created after this date have the off-peak window enabled by default. You can't disable the off-peak window after it's enabled for a domain. - dry_run_config.off_peak_window_options.off_peak_window
Off-peak window settings for the domain. Show child fields- dry_run_config.off_peak_window_options.off_peak_window.window_start_time
A custom start time for the off-peak window, in Coordinated Universal Time (UTC). The window length will always be 10 hours, so you can't specify an end time. For example, if you specify 11:00 P.M. UTC as a start time, the end time will automatically be set to 9:00 A.M. Show child fields- dry_run_config.off_peak_window_options.off_peak_window.window_start_time.hours
The start hour of the window in Coordinated Universal Time (UTC), using 24-hour time. For example, 17 refers to 5:00 P.M. UTC. - dry_run_config.off_peak_window_options.off_peak_window.window_start_time.minutes
The start minute of the window, in UTC.
- dry_run_config.processing
The status of the domain configuration. True if OpenSearch Service is processing configuration changes. False if the configuration is active. - dry_run_config.service_software_options
The current status of the domain's service software. Show child fields- dry_run_config.service_software_options.automated_update_date
The timestamp, in Epoch time, until which you can manually request a service software update. After this date, we automatically update your service software. - dry_run_config.service_software_options.cancellable
True if you're able to cancel your service software version update. False if you can't cancel your service software update. - dry_run_config.service_software_options.current_version
The current service software version present on the domain. - dry_run_config.service_software_options.description
A description of the service software update status. - dry_run_config.service_software_options.new_version
The new service software version, if one is available. - dry_run_config.service_software_options.optional_deployment
True if a service software is never automatically updated. False if a service software is automatically updated after the automated update date. - dry_run_config.service_software_options.update_available
True if you're able to update your service software version. False if you can't update your service software version. - dry_run_config.service_software_options.update_status
The status of your service software update.
- dry_run_config.snapshot_options
DEPRECATED. Container for parameters required to configure automated snapshots of domain indexes. Show child fields- dry_run_config.snapshot_options.automated_snapshot_start_hour
The time, in UTC format, when OpenSearch Service takes a daily automated snapshot of the specified domain. Default is 0 hours.
- dry_run_config.software_update_options
Service software update options for the domain. Show child fields- dry_run_config.software_update_options.auto_software_update_enabled
Whether automatic service software updates are enabled for the domain.
- dry_run_config.upgrade_processing
The status of a domain version upgrade to a new version of OpenSearch or Elasticsearch. True if OpenSearch Service is in the process of a version upgrade. False if the configuration is active. - dry_run_config.vpc_options
The VPC configuration for the domain. Show child fields- dry_run_config.vpc_options.availability_zones[]
- dry_run_config.vpc_options.security_group_ids[]
- dry_run_config.vpc_options.subnet_ids[]
- dry_run_config.vpc_options.vpc_id
The ID for your VPC. Amazon VPC generates this value when you create a VPC.
|