CfnDataAccessor

class aws_cdk.aws_qbusiness.CfnDataAccessor(scope, id, *, action_configurations, application_id, display_name, principal, tags=None)

Bases: CfnResource

Creates a new data accessor for an ISV to access data from a Amazon Q Business application.

The data accessor is an entity that represents the ISV’s access to the Amazon Q Business application’s data. It includes the IAM role ARN for the ISV, a friendly name, and a set of action configurations that define the specific actions the ISV is allowed to perform and any associated data filters. When the data accessor is created, an IAM Identity Center application is also created to manage the ISV’s identity and authentication for accessing the Amazon Q Business application.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-qbusiness-dataaccessor.html
CloudformationResource:: AWS::QBusiness::DataAccessor
ExampleMetadata:: fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk import aws_qbusiness as qbusiness

# attribute_filter_property_: qbusiness.CfnDataAccessor.AttributeFilterProperty

cfn_data_accessor = qbusiness.CfnDataAccessor(self, "MyCfnDataAccessor",
    action_configurations=[qbusiness.CfnDataAccessor.ActionConfigurationProperty(
        action="action",

        # the properties below are optional
        filter_configuration=qbusiness.CfnDataAccessor.ActionFilterConfigurationProperty(
            document_attribute_filter=qbusiness.CfnDataAccessor.AttributeFilterProperty(
                and_all_filters=[attribute_filter_property_],
                contains_all=qbusiness.CfnDataAccessor.DocumentAttributeProperty(
                    name="name",
                    value=qbusiness.CfnDataAccessor.DocumentAttributeValueProperty(
                        date_value="dateValue",
                        long_value=123,
                        string_list_value=["stringListValue"],
                        string_value="stringValue"
                    )
                ),
                contains_any=qbusiness.CfnDataAccessor.DocumentAttributeProperty(
                    name="name",
                    value=qbusiness.CfnDataAccessor.DocumentAttributeValueProperty(
                        date_value="dateValue",
                        long_value=123,
                        string_list_value=["stringListValue"],
                        string_value="stringValue"
                    )
                ),
                equals_to=qbusiness.CfnDataAccessor.DocumentAttributeProperty(
                    name="name",
                    value=qbusiness.CfnDataAccessor.DocumentAttributeValueProperty(
                        date_value="dateValue",
                        long_value=123,
                        string_list_value=["stringListValue"],
                        string_value="stringValue"
                    )
                ),
                greater_than=qbusiness.CfnDataAccessor.DocumentAttributeProperty(
                    name="name",
                    value=qbusiness.CfnDataAccessor.DocumentAttributeValueProperty(
                        date_value="dateValue",
                        long_value=123,
                        string_list_value=["stringListValue"],
                        string_value="stringValue"
                    )
                ),
                greater_than_or_equals=qbusiness.CfnDataAccessor.DocumentAttributeProperty(
                    name="name",
                    value=qbusiness.CfnDataAccessor.DocumentAttributeValueProperty(
                        date_value="dateValue",
                        long_value=123,
                        string_list_value=["stringListValue"],
                        string_value="stringValue"
                    )
                ),
                less_than=qbusiness.CfnDataAccessor.DocumentAttributeProperty(
                    name="name",
                    value=qbusiness.CfnDataAccessor.DocumentAttributeValueProperty(
                        date_value="dateValue",
                        long_value=123,
                        string_list_value=["stringListValue"],
                        string_value="stringValue"
                    )
                ),
                less_than_or_equals=qbusiness.CfnDataAccessor.DocumentAttributeProperty(
                    name="name",
                    value=qbusiness.CfnDataAccessor.DocumentAttributeValueProperty(
                        date_value="dateValue",
                        long_value=123,
                        string_list_value=["stringListValue"],
                        string_value="stringValue"
                    )
                ),
                not_filter=attribute_filter_property_,
                or_all_filters=[attribute_filter_property_]
            )
        )
    )],
    application_id="applicationId",
    display_name="displayName",
    principal="principal",

    # the properties below are optional
    tags=[CfnTag(
        key="key",
        value="value"
    )]
)

Parameters:

scope (Construct) – Scope in which this resource is defined.
id (str) – Construct identifier for this resource (unique in its scope).
action_configurations (Union[IResolvable, Sequence[Union[IResolvable, ActionConfigurationProperty, Dict[str, Any]]]]) – A list of action configurations specifying the allowed actions and any associated filters.
application_id (str) – The unique identifier of the Amazon Q Business application.
display_name (str) – The friendly name of the data accessor.
principal (str) – The Amazon Resource Name (ARN) of the IAM role for the ISV associated with this data accessor.
tags (Optional[Sequence[Union[CfnTag, Dict[str, Any]]]]) – The tags to associate with the data accessor.

Methods

add_deletion_override(path)

Syntactic sugar for addOverride(path, undefined).

Parameters:: path (str) – The path of the value to delete.
Return type:: None

add_dependency(target)

Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned.

This can be used for resources across stacks (or nested stack) boundaries and the dependency will automatically be transferred to the relevant scope.

Parameters:

target (CfnResource) –

Return type:

None

add_depends_on(target)

(deprecated) Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned.

Parameters:

target (CfnResource) –

Deprecated:

use addDependency

Stability:

deprecated

Return type:

None

add_metadata(key, value)

Add a value to the CloudFormation Resource Metadata.

Parameters:

key (str) –
value (Any) –

See:

Return type:

None

https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html

Note that this is a different set of metadata from CDK node metadata; this metadata ends up in the stack template under the resource, whereas CDK node metadata ends up in the Cloud Assembly.

add_override(path, value)

Adds an override to the synthesized CloudFormation resource.

To add a property override, either use addPropertyOverride or prefix path with “Properties.” (i.e. Properties.TopicName).

If the override is nested, separate each nested level using a dot (.) in the path parameter. If there is an array as part of the nesting, specify the index in the path.

To include a literal . in the property name, prefix with a \. In most programming languages you will need to write this as "\\." because the \ itself will need to be escaped.

For example:

cfn_resource.add_override("Properties.GlobalSecondaryIndexes.0.Projection.NonKeyAttributes", ["myattribute"])
cfn_resource.add_override("Properties.GlobalSecondaryIndexes.1.ProjectionType", "INCLUDE")

would add the overrides Example:

"Properties": {
  "GlobalSecondaryIndexes": [
    {
      "Projection": {
        "NonKeyAttributes": [ "myattribute" ]
        ...
      }
      ...
    },
    {
      "ProjectionType": "INCLUDE"
      ...
    },
  ]
  ...
}

The value argument to addOverride will not be processed or translated in any way. Pass raw JSON values in here with the correct capitalization for CloudFormation. If you pass CDK classes or structs, they will be rendered with lowercased key names, and CloudFormation will reject the template.

Parameters:

path (str) –
- The path of the property, you can use dot notation to override values in complex types. Any intermediate keys will be created as needed.
value (Any) –
- The value. Could be primitive or complex.

Return type:

None

add_property_deletion_override(property_path)

Adds an override that deletes the value of a property from the resource definition.

Parameters:: property_path (str) – The path to the property.
Return type:: None

add_property_override(property_path, value)

Adds an override to a resource property.

Syntactic sugar for addOverride("Properties.<...>", value).

Parameters:

property_path (str) – The path of the property.
value (Any) – The value.

Return type:

None

apply_removal_policy(policy=None, *, apply_to_update_replace_policy=None, default=None)

Sets the deletion policy of the resource based on the removal policy specified.

The Removal Policy controls what happens to this resource when it stops being managed by CloudFormation, either because you’ve removed it from the CDK application or because you’ve made a change that requires the resource to be replaced.

The resource can be deleted (RemovalPolicy.DESTROY), or left in your AWS account for data recovery and cleanup later (RemovalPolicy.RETAIN). In some cases, a snapshot can be taken of the resource prior to deletion (RemovalPolicy.SNAPSHOT). A list of resources that support this policy can be found in the following link:

Parameters:

policy (Optional[RemovalPolicy]) –
apply_to_update_replace_policy (Optional[bool]) – Apply the same deletion policy to the resource’s “UpdateReplacePolicy”. Default: true
default (Optional[RemovalPolicy]) – The default policy to apply in case the removal policy is not defined. Default: - Default value is resource specific. To determine the default value for a resource, please consult that specific resource’s documentation.

See:

https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-attribute-deletionpolicy.html#aws-attribute-deletionpolicy-options

Return type:

None

get_att(attribute_name, type_hint=None)

Returns a token for an runtime attribute of this resource.

Ideally, use generated attribute accessors (e.g. resource.arn), but this can be used for future compatibility in case there is no generated attribute.

Parameters:

attribute_name (str) – The name of the attribute.
type_hint (Optional[ResolutionTypeHint]) –

Return type:

Reference

get_metadata(key)

Retrieve a value value from the CloudFormation Resource Metadata.

Parameters:

key (str) –

See:

Return type:

Any

https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html

Note that this is a different set of metadata from CDK node metadata; this metadata ends up in the stack template under the resource, whereas CDK node metadata ends up in the Cloud Assembly.

inspect(inspector)

Examines the CloudFormation resource and discloses attributes.

Parameters:: inspector (TreeInspector) – tree inspector to collect and process attributes.
Return type:: None

obtain_dependencies()

Retrieves an array of resources this resource depends on.

This assembles dependencies on resources across stacks (including nested stacks) automatically.

Return type:: List[Union[Stack, CfnResource]]

obtain_resource_dependencies()

Get a shallow copy of dependencies between this resource and other resources in the same stack.

Return type:: List[CfnResource]

override_logical_id(new_logical_id)

Overrides the auto-generated logical ID with a specific ID.

Parameters:: new_logical_id (str) – The new logical ID to use for this stack element.
Return type:: None

remove_dependency(target)

Indicates that this resource no longer depends on another resource.

This can be used for resources across stacks (including nested stacks) and the dependency will automatically be removed from the relevant scope.

Parameters:

target (CfnResource) –

Return type:

None

replace_dependency(target, new_target)

Replaces one dependency with another.

Parameters:

target (CfnResource) – The dependency to replace.
new_target (CfnResource) – The new dependency to add.

Return type:

None

to_string()

Returns a string representation of this construct.

Return type:: str
Returns:: a string representation of this resource

Attributes

CFN_RESOURCE_TYPE_NAME = 'AWS::QBusiness::DataAccessor'

action_configurations: A list of action configurations specifying the allowed actions and any associated filters.

application_id: The unique identifier of the Amazon Q Business application.

attr_created_at

The timestamp when the data accessor was created.

CloudformationAttribute:: CreatedAt

attr_data_accessor_arn

The Amazon Resource Name (ARN) of the data accessor.

CloudformationAttribute:: DataAccessorArn

attr_data_accessor_id

The unique identifier of the data accessor.

CloudformationAttribute:: DataAccessorId

attr_idc_application_arn

The Amazon Resource Name (ARN) of the associated IAM Identity Center application.

CloudformationAttribute:: IdcApplicationArn

attr_updated_at

The timestamp when the data accessor was last updated.

CloudformationAttribute:: UpdatedAt

cdk_tag_manager: Tag Manager which manages the tags for this resource.

cfn_options: Options for this resource, such as condition, update policy etc.

cfn_resource_type: AWS resource type.

creation_stack

return:

the stack trace of the point where this Resource was created from, sourced from the +metadata+ entry typed +aws:cdk:logicalId+, and with the bottom-most node +internal+ entries filtered.

display_name: The friendly name of the data accessor.

logical_id

The logical ID for this CloudFormation stack element.

The logical ID of the element is calculated from the path of the resource node in the construct tree.

To override this value, use overrideLogicalId(newLogicalId).

Returns:

the logical ID as a stringified token. This value will only get resolved during synthesis.

node: The tree node.

principal: The Amazon Resource Name (ARN) of the IAM role for the ISV associated with this data accessor.

ref

Return a string that will be resolved to a CloudFormation { Ref } for this element.

If, by any chance, the intrinsic reference of a resource is not a string, you could coerce it to an IResolvable through Lazy.any({ produce: resource.ref }).

stack

The stack in which this element is defined.

CfnElements must be defined within a stack scope (directly or indirectly).

tags: The tags to associate with the data accessor.

Static Methods

classmethod is_cfn_element(x)

Returns true if a construct is a stack element (i.e. part of the synthesized cloudformation template).

Uses duck-typing instead of instanceof to allow stack elements from different versions of this library to be included in the same stack.

Parameters:

x (Any) –

Return type:

bool

Returns:

The construct as a stack element or undefined if it is not a stack element.

classmethod is_cfn_resource(x)

Check whether the given object is a CfnResource.

Parameters:

x (Any) –

Return type:

bool

classmethod is_construct(x)

Checks if x is a construct.

Use this method instead of instanceof to properly detect Construct instances, even when the construct library is symlinked.

Explanation: in JavaScript, multiple copies of the constructs library on disk are seen as independent, completely different libraries. As a consequence, the class Construct in each copy of the constructs library is seen as a different class, and an instance of one class will not test as instanceof the other class. npm install will not create installations like this, but users may manually symlink construct libraries together or use a monorepo tool: in those cases, multiple copies of the constructs library can be accidentally installed, and instanceof will behave unpredictably. It is safest to avoid using instanceof, and using this type-testing method instead.

Parameters:: x (Any) – Any object.
Return type:: bool
Returns:: true if x is an object created from a class which extends Construct.

ActionConfigurationProperty

class CfnDataAccessor.ActionConfigurationProperty(*, action, filter_configuration=None)

Bases: object

Specifies an allowed action and its associated filter configuration.

Parameters:

action (str) – The Amazon Q Business action that is allowed.
filter_configuration (Union[IResolvable, ActionFilterConfigurationProperty, Dict[str, Any], None]) – The filter configuration for the action, if any.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-qbusiness-dataaccessor-actionconfiguration.html

ExampleMetadata:

fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk import aws_qbusiness as qbusiness

# attribute_filter_property_: qbusiness.CfnDataAccessor.AttributeFilterProperty

action_configuration_property = qbusiness.CfnDataAccessor.ActionConfigurationProperty(
    action="action",

    # the properties below are optional
    filter_configuration=qbusiness.CfnDataAccessor.ActionFilterConfigurationProperty(
        document_attribute_filter=qbusiness.CfnDataAccessor.AttributeFilterProperty(
            and_all_filters=[attribute_filter_property_],
            contains_all=qbusiness.CfnDataAccessor.DocumentAttributeProperty(
                name="name",
                value=qbusiness.CfnDataAccessor.DocumentAttributeValueProperty(
                    date_value="dateValue",
                    long_value=123,
                    string_list_value=["stringListValue"],
                    string_value="stringValue"
                )
            ),
            contains_any=qbusiness.CfnDataAccessor.DocumentAttributeProperty(
                name="name",
                value=qbusiness.CfnDataAccessor.DocumentAttributeValueProperty(
                    date_value="dateValue",
                    long_value=123,
                    string_list_value=["stringListValue"],
                    string_value="stringValue"
                )
            ),
            equals_to=qbusiness.CfnDataAccessor.DocumentAttributeProperty(
                name="name",
                value=qbusiness.CfnDataAccessor.DocumentAttributeValueProperty(
                    date_value="dateValue",
                    long_value=123,
                    string_list_value=["stringListValue"],
                    string_value="stringValue"
                )
            ),
            greater_than=qbusiness.CfnDataAccessor.DocumentAttributeProperty(
                name="name",
                value=qbusiness.CfnDataAccessor.DocumentAttributeValueProperty(
                    date_value="dateValue",
                    long_value=123,
                    string_list_value=["stringListValue"],
                    string_value="stringValue"
                )
            ),
            greater_than_or_equals=qbusiness.CfnDataAccessor.DocumentAttributeProperty(
                name="name",
                value=qbusiness.CfnDataAccessor.DocumentAttributeValueProperty(
                    date_value="dateValue",
                    long_value=123,
                    string_list_value=["stringListValue"],
                    string_value="stringValue"
                )
            ),
            less_than=qbusiness.CfnDataAccessor.DocumentAttributeProperty(
                name="name",
                value=qbusiness.CfnDataAccessor.DocumentAttributeValueProperty(
                    date_value="dateValue",
                    long_value=123,
                    string_list_value=["stringListValue"],
                    string_value="stringValue"
                )
            ),
            less_than_or_equals=qbusiness.CfnDataAccessor.DocumentAttributeProperty(
                name="name",
                value=qbusiness.CfnDataAccessor.DocumentAttributeValueProperty(
                    date_value="dateValue",
                    long_value=123,
                    string_list_value=["stringListValue"],
                    string_value="stringValue"
                )
            ),
            not_filter=attribute_filter_property_,
            or_all_filters=[attribute_filter_property_]
        )
    )
)

Attributes

action

The Amazon Q Business action that is allowed.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-qbusiness-dataaccessor-actionconfiguration.html#cfn-qbusiness-dataaccessor-actionconfiguration-action

filter_configuration

The filter configuration for the action, if any.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-qbusiness-dataaccessor-actionconfiguration.html#cfn-qbusiness-dataaccessor-actionconfiguration-filterconfiguration

ActionFilterConfigurationProperty

class CfnDataAccessor.ActionFilterConfigurationProperty(*, document_attribute_filter)

Bases: object

Specifies filters to apply to an allowed action.

Parameters:: document_attribute_filter (Union[IResolvable, AttributeFilterProperty, Dict[str, Any]]) – Enables filtering of responses based on document attributes or metadata fields.
See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-qbusiness-dataaccessor-actionfilterconfiguration.html
ExampleMetadata:: fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk import aws_qbusiness as qbusiness

# attribute_filter_property_: qbusiness.CfnDataAccessor.AttributeFilterProperty

action_filter_configuration_property = qbusiness.CfnDataAccessor.ActionFilterConfigurationProperty(
    document_attribute_filter=qbusiness.CfnDataAccessor.AttributeFilterProperty(
        and_all_filters=[attribute_filter_property_],
        contains_all=qbusiness.CfnDataAccessor.DocumentAttributeProperty(
            name="name",
            value=qbusiness.CfnDataAccessor.DocumentAttributeValueProperty(
                date_value="dateValue",
                long_value=123,
                string_list_value=["stringListValue"],
                string_value="stringValue"
            )
        ),
        contains_any=qbusiness.CfnDataAccessor.DocumentAttributeProperty(
            name="name",
            value=qbusiness.CfnDataAccessor.DocumentAttributeValueProperty(
                date_value="dateValue",
                long_value=123,
                string_list_value=["stringListValue"],
                string_value="stringValue"
            )
        ),
        equals_to=qbusiness.CfnDataAccessor.DocumentAttributeProperty(
            name="name",
            value=qbusiness.CfnDataAccessor.DocumentAttributeValueProperty(
                date_value="dateValue",
                long_value=123,
                string_list_value=["stringListValue"],
                string_value="stringValue"
            )
        ),
        greater_than=qbusiness.CfnDataAccessor.DocumentAttributeProperty(
            name="name",
            value=qbusiness.CfnDataAccessor.DocumentAttributeValueProperty(
                date_value="dateValue",
                long_value=123,
                string_list_value=["stringListValue"],
                string_value="stringValue"
            )
        ),
        greater_than_or_equals=qbusiness.CfnDataAccessor.DocumentAttributeProperty(
            name="name",
            value=qbusiness.CfnDataAccessor.DocumentAttributeValueProperty(
                date_value="dateValue",
                long_value=123,
                string_list_value=["stringListValue"],
                string_value="stringValue"
            )
        ),
        less_than=qbusiness.CfnDataAccessor.DocumentAttributeProperty(
            name="name",
            value=qbusiness.CfnDataAccessor.DocumentAttributeValueProperty(
                date_value="dateValue",
                long_value=123,
                string_list_value=["stringListValue"],
                string_value="stringValue"
            )
        ),
        less_than_or_equals=qbusiness.CfnDataAccessor.DocumentAttributeProperty(
            name="name",
            value=qbusiness.CfnDataAccessor.DocumentAttributeValueProperty(
                date_value="dateValue",
                long_value=123,
                string_list_value=["stringListValue"],
                string_value="stringValue"
            )
        ),
        not_filter=attribute_filter_property_,
        or_all_filters=[attribute_filter_property_]
    )
)

Attributes

document_attribute_filter

Enables filtering of responses based on document attributes or metadata fields.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-qbusiness-dataaccessor-actionfilterconfiguration.html#cfn-qbusiness-dataaccessor-actionfilterconfiguration-documentattributefilter

AttributeFilterProperty

class CfnDataAccessor.AttributeFilterProperty(*, and_all_filters=None, contains_all=None, contains_any=None, equals_to=None, greater_than=None, greater_than_or_equals=None, less_than=None, less_than_or_equals=None, not_filter=None, or_all_filters=None)

Bases: object

Enables filtering of responses based on document attributes or metadata fields.

Parameters:

and_all_filters (Union[IResolvable, Sequence[Union[IResolvable, AttributeFilterProperty, Dict[str, Any]]], None]) – Performs a logical AND operation on all supplied filters.
contains_all (Union[IResolvable, DocumentAttributeProperty, Dict[str, Any], None]) – Returns true when a document contains all the specified document attributes or metadata fields. Supported for the following document attribute value types : stringListValue .
contains_any (Union[IResolvable, DocumentAttributeProperty, Dict[str, Any], None]) –
Returns true when a document contains any of the specified document attributes or metadata fields. Supported for the following document attribute value types : stringListValue .
equals_to (Union[IResolvable, DocumentAttributeProperty, Dict[str, Any], None]) –
Performs an equals operation on two document attributes or metadata fields. Supported for the following document attribute value types : dateValue , longValue , stringListValue and stringValue .
greater_than (Union[IResolvable, DocumentAttributeProperty, Dict[str, Any], None]) –
Performs a greater than operation on two document attributes or metadata fields. Supported for the following document attribute value types : dateValue and longValue .
greater_than_or_equals (Union[IResolvable, DocumentAttributeProperty, Dict[str, Any], None]) –
Performs a greater or equals than operation on two document attributes or metadata fields. Supported for the following document attribute value types : dateValue and longValue .
less_than (Union[IResolvable, DocumentAttributeProperty, Dict[str, Any], None]) –
Performs a less than operation on two document attributes or metadata fields. Supported for the following document attribute value types : dateValue and longValue .
less_than_or_equals (Union[IResolvable, DocumentAttributeProperty, Dict[str, Any], None]) – Performs a less than or equals operation on two document attributes or metadata fields.Supported for the following document attribute value type : dateValue and longValue .
not_filter (Union[IResolvable, AttributeFilterProperty, Dict[str, Any], None]) – Performs a logical NOT operation on all supplied filters.
or_all_filters (Union[IResolvable, Sequence[Union[IResolvable, AttributeFilterProperty, Dict[str, Any]]], None]) – Performs a logical OR operation on all supplied filters.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-qbusiness-dataaccessor-attributefilter.html

ExampleMetadata:

fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk import aws_qbusiness as qbusiness

# attribute_filter_property_: qbusiness.CfnDataAccessor.AttributeFilterProperty

attribute_filter_property = qbusiness.CfnDataAccessor.AttributeFilterProperty(
    and_all_filters=[attribute_filter_property_],
    contains_all=qbusiness.CfnDataAccessor.DocumentAttributeProperty(
        name="name",
        value=qbusiness.CfnDataAccessor.DocumentAttributeValueProperty(
            date_value="dateValue",
            long_value=123,
            string_list_value=["stringListValue"],
            string_value="stringValue"
        )
    ),
    contains_any=qbusiness.CfnDataAccessor.DocumentAttributeProperty(
        name="name",
        value=qbusiness.CfnDataAccessor.DocumentAttributeValueProperty(
            date_value="dateValue",
            long_value=123,
            string_list_value=["stringListValue"],
            string_value="stringValue"
        )
    ),
    equals_to=qbusiness.CfnDataAccessor.DocumentAttributeProperty(
        name="name",
        value=qbusiness.CfnDataAccessor.DocumentAttributeValueProperty(
            date_value="dateValue",
            long_value=123,
            string_list_value=["stringListValue"],
            string_value="stringValue"
        )
    ),
    greater_than=qbusiness.CfnDataAccessor.DocumentAttributeProperty(
        name="name",
        value=qbusiness.CfnDataAccessor.DocumentAttributeValueProperty(
            date_value="dateValue",
            long_value=123,
            string_list_value=["stringListValue"],
            string_value="stringValue"
        )
    ),
    greater_than_or_equals=qbusiness.CfnDataAccessor.DocumentAttributeProperty(
        name="name",
        value=qbusiness.CfnDataAccessor.DocumentAttributeValueProperty(
            date_value="dateValue",
            long_value=123,
            string_list_value=["stringListValue"],
            string_value="stringValue"
        )
    ),
    less_than=qbusiness.CfnDataAccessor.DocumentAttributeProperty(
        name="name",
        value=qbusiness.CfnDataAccessor.DocumentAttributeValueProperty(
            date_value="dateValue",
            long_value=123,
            string_list_value=["stringListValue"],
            string_value="stringValue"
        )
    ),
    less_than_or_equals=qbusiness.CfnDataAccessor.DocumentAttributeProperty(
        name="name",
        value=qbusiness.CfnDataAccessor.DocumentAttributeValueProperty(
            date_value="dateValue",
            long_value=123,
            string_list_value=["stringListValue"],
            string_value="stringValue"
        )
    ),
    not_filter=attribute_filter_property_,
    or_all_filters=[attribute_filter_property_]
)

Attributes

and_all_filters

Performs a logical AND operation on all supplied filters.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-qbusiness-dataaccessor-attributefilter.html#cfn-qbusiness-dataaccessor-attributefilter-andallfilters

contains_all

Returns true when a document contains all the specified document attributes or metadata fields.

Supported for the following document attribute value types : stringListValue .

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-qbusiness-dataaccessor-attributefilter.html#cfn-qbusiness-dataaccessor-attributefilter-containsall

contains_any

Returns true when a document contains any of the specified document attributes or metadata fields.

Supported for the following document attribute value types : stringListValue .

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-qbusiness-dataaccessor-attributefilter.html#cfn-qbusiness-dataaccessor-attributefilter-containsany

equals_to

Performs an equals operation on two document attributes or metadata fields.

Supported for the following document attribute value types : dateValue , longValue , stringListValue and stringValue .

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-qbusiness-dataaccessor-attributefilter.html#cfn-qbusiness-dataaccessor-attributefilter-equalsto

greater_than

Performs a greater than operation on two document attributes or metadata fields.

Supported for the following document attribute value types : dateValue and longValue .

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-qbusiness-dataaccessor-attributefilter.html#cfn-qbusiness-dataaccessor-attributefilter-greaterthan

greater_than_or_equals

Performs a greater or equals than operation on two document attributes or metadata fields.

Supported for the following document attribute value types : dateValue and longValue .

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-qbusiness-dataaccessor-attributefilter.html#cfn-qbusiness-dataaccessor-attributefilter-greaterthanorequals

less_than

Performs a less than operation on two document attributes or metadata fields.

Supported for the following document attribute value types : dateValue and longValue .

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-qbusiness-dataaccessor-attributefilter.html#cfn-qbusiness-dataaccessor-attributefilter-lessthan

less_than_or_equals

dateValue and longValue .

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-qbusiness-dataaccessor-attributefilter.html#cfn-qbusiness-dataaccessor-attributefilter-lessthanorequals
Type:: Performs a less than or equals operation on two document attributes or metadata fields.Supported for the following `document attribute value type <https
Type:: //docs.aws.amazon.com/amazonq/latest/api-reference/API_DocumentAttributeValue.html>`_

not_filter

Performs a logical NOT operation on all supplied filters.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-qbusiness-dataaccessor-attributefilter.html#cfn-qbusiness-dataaccessor-attributefilter-notfilter

or_all_filters

Performs a logical OR operation on all supplied filters.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-qbusiness-dataaccessor-attributefilter.html#cfn-qbusiness-dataaccessor-attributefilter-orallfilters

DocumentAttributeProperty

class CfnDataAccessor.DocumentAttributeProperty(*, name, value)

Bases: object

A document attribute or metadata field.

Parameters:

name (str) – The identifier for the attribute.
value (Union[IResolvable, DocumentAttributeValueProperty, Dict[str, Any]]) – The value of the attribute.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-qbusiness-dataaccessor-documentattribute.html

ExampleMetadata:

fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk import aws_qbusiness as qbusiness

document_attribute_property = qbusiness.CfnDataAccessor.DocumentAttributeProperty(
    name="name",
    value=qbusiness.CfnDataAccessor.DocumentAttributeValueProperty(
        date_value="dateValue",
        long_value=123,
        string_list_value=["stringListValue"],
        string_value="stringValue"
    )
)

Attributes

name

The identifier for the attribute.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-qbusiness-dataaccessor-documentattribute.html#cfn-qbusiness-dataaccessor-documentattribute-name

value

The value of the attribute.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-qbusiness-dataaccessor-documentattribute.html#cfn-qbusiness-dataaccessor-documentattribute-value

DocumentAttributeValueProperty

class CfnDataAccessor.DocumentAttributeValueProperty(*, date_value=None, long_value=None, string_list_value=None, string_value=None)

Bases: object

The value of a document attribute.

You can only provide one value for a document attribute.

Parameters:

date_value (Optional[str]) – A date expressed as an ISO 8601 string. It’s important for the time zone to be included in the ISO 8601 date-time format. For example, 2012-03-25T12:30:10+01:00 is the ISO 8601 date-time format for March 25th 2012 at 12:30PM (plus 10 seconds) in Central European Time.
long_value (Union[int, float, None]) – A long integer value.
string_list_value (Optional[Sequence[str]]) – A list of strings.
string_value (Optional[str]) – A string.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-qbusiness-dataaccessor-documentattributevalue.html

ExampleMetadata:

fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk import aws_qbusiness as qbusiness

document_attribute_value_property = qbusiness.CfnDataAccessor.DocumentAttributeValueProperty(
    date_value="dateValue",
    long_value=123,
    string_list_value=["stringListValue"],
    string_value="stringValue"
)

Attributes

date_value

A date expressed as an ISO 8601 string.

It’s important for the time zone to be included in the ISO 8601 date-time format. For example, 2012-03-25T12:30:10+01:00 is the ISO 8601 date-time format for March 25th 2012 at 12:30PM (plus 10 seconds) in Central European Time.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-qbusiness-dataaccessor-documentattributevalue.html#cfn-qbusiness-dataaccessor-documentattributevalue-datevalue

long_value

A long integer value.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-qbusiness-dataaccessor-documentattributevalue.html#cfn-qbusiness-dataaccessor-documentattributevalue-longvalue

string_list_value

A list of strings.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-qbusiness-dataaccessor-documentattributevalue.html#cfn-qbusiness-dataaccessor-documentattributevalue-stringlistvalue

string_value

A string.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-qbusiness-dataaccessor-documentattributevalue.html#cfn-qbusiness-dataaccessor-documentattributevalue-stringvalue