Skip to content
v2.277.0

CfnDataAccessorProps Struct ​

Properties for defining a CfnDataAccessor.

Example ​

ts
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import { aws_qbusiness as qbusiness } from 'aws-cdk-lib';

declare const attributeFilterProperty_: qbusiness.CfnDataAccessor.AttributeFilterProperty;
const cfnDataAccessorProps: qbusiness.CfnDataAccessorProps = {
  actionConfigurations: [{
    action: 'action',

    // the properties below are optional
    filterConfiguration: {
      documentAttributeFilter: {
        andAllFilters: [attributeFilterProperty_],
        containsAll: {
          name: 'name',
          value: {
            dateValue: 'dateValue',
            longValue: 123,
            stringListValue: ['stringListValue'],
            stringValue: 'stringValue',
          },
        },
        containsAny: {
          name: 'name',
          value: {
            dateValue: 'dateValue',
            longValue: 123,
            stringListValue: ['stringListValue'],
            stringValue: 'stringValue',
          },
        },
        equalsTo: {
          name: 'name',
          value: {
            dateValue: 'dateValue',
            longValue: 123,
            stringListValue: ['stringListValue'],
            stringValue: 'stringValue',
          },
        },
        greaterThan: {
          name: 'name',
          value: {
            dateValue: 'dateValue',
            longValue: 123,
            stringListValue: ['stringListValue'],
            stringValue: 'stringValue',
          },
        },
        greaterThanOrEquals: {
          name: 'name',
          value: {
            dateValue: 'dateValue',
            longValue: 123,
            stringListValue: ['stringListValue'],
            stringValue: 'stringValue',
          },
        },
        lessThan: {
          name: 'name',
          value: {
            dateValue: 'dateValue',
            longValue: 123,
            stringListValue: ['stringListValue'],
            stringValue: 'stringValue',
          },
        },
        lessThanOrEquals: {
          name: 'name',
          value: {
            dateValue: 'dateValue',
            longValue: 123,
            stringListValue: ['stringListValue'],
            stringValue: 'stringValue',
          },
        },
        notFilter: attributeFilterProperty_,
        orAllFilters: [attributeFilterProperty_],
      },
    },
  }],
  applicationId: 'applicationId',
  displayName: 'displayName',
  principal: 'principal',

  // the properties below are optional
  authenticationDetail: {
    authenticationType: 'authenticationType',

    // the properties below are optional
    authenticationConfiguration: {
      idcTrustedTokenIssuerConfiguration: {
        idcTrustedTokenIssuerArn: 'idcTrustedTokenIssuerArn',
      },
    },
    externalIds: ['externalIds'],
  },
  tags: [{
    key: 'key',
    value: 'value',
  }],
};
python
from aws_cdk import CfnTag
# 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_props = qbusiness.CfnDataAccessorProps(
    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
    authentication_detail=qbusiness.CfnDataAccessor.DataAccessorAuthenticationDetailProperty(
        authentication_type="authenticationType",

        # the properties below are optional
        authentication_configuration=qbusiness.CfnDataAccessor.DataAccessorAuthenticationConfigurationProperty(
            idc_trusted_token_issuer_configuration=qbusiness.CfnDataAccessor.DataAccessorIdcTrustedTokenIssuerConfigurationProperty(
                idc_trusted_token_issuer_arn="idcTrustedTokenIssuerArn"
            )
        ),
        external_ids=["externalIds"]
    ),
    tags=[CfnTag(
        key="key",
        value="value"
    )]
)
java
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import software.amazon.awscdk.services.qbusiness.*;

AttributeFilterProperty attributeFilterProperty_;

CfnDataAccessorProps cfnDataAccessorProps = CfnDataAccessorProps.builder()
        .actionConfigurations(List.of(ActionConfigurationProperty.builder()
                .action("action")

                // the properties below are optional
                .filterConfiguration(ActionFilterConfigurationProperty.builder()
                        .documentAttributeFilter(AttributeFilterProperty.builder()
                                .andAllFilters(List.of(attributeFilterProperty_))
                                .containsAll(DocumentAttributeProperty.builder()
                                        .name("name")
                                        .value(DocumentAttributeValueProperty.builder()
                                                .dateValue("dateValue")
                                                .longValue(123)
                                                .stringListValue(List.of("stringListValue"))
                                                .stringValue("stringValue")
                                                .build())
                                        .build())
                                .containsAny(DocumentAttributeProperty.builder()
                                        .name("name")
                                        .value(DocumentAttributeValueProperty.builder()
                                                .dateValue("dateValue")
                                                .longValue(123)
                                                .stringListValue(List.of("stringListValue"))
                                                .stringValue("stringValue")
                                                .build())
                                        .build())
                                .equalsTo(DocumentAttributeProperty.builder()
                                        .name("name")
                                        .value(DocumentAttributeValueProperty.builder()
                                                .dateValue("dateValue")
                                                .longValue(123)
                                                .stringListValue(List.of("stringListValue"))
                                                .stringValue("stringValue")
                                                .build())
                                        .build())
                                .greaterThan(DocumentAttributeProperty.builder()
                                        .name("name")
                                        .value(DocumentAttributeValueProperty.builder()
                                                .dateValue("dateValue")
                                                .longValue(123)
                                                .stringListValue(List.of("stringListValue"))
                                                .stringValue("stringValue")
                                                .build())
                                        .build())
                                .greaterThanOrEquals(DocumentAttributeProperty.builder()
                                        .name("name")
                                        .value(DocumentAttributeValueProperty.builder()
                                                .dateValue("dateValue")
                                                .longValue(123)
                                                .stringListValue(List.of("stringListValue"))
                                                .stringValue("stringValue")
                                                .build())
                                        .build())
                                .lessThan(DocumentAttributeProperty.builder()
                                        .name("name")
                                        .value(DocumentAttributeValueProperty.builder()
                                                .dateValue("dateValue")
                                                .longValue(123)
                                                .stringListValue(List.of("stringListValue"))
                                                .stringValue("stringValue")
                                                .build())
                                        .build())
                                .lessThanOrEquals(DocumentAttributeProperty.builder()
                                        .name("name")
                                        .value(DocumentAttributeValueProperty.builder()
                                                .dateValue("dateValue")
                                                .longValue(123)
                                                .stringListValue(List.of("stringListValue"))
                                                .stringValue("stringValue")
                                                .build())
                                        .build())
                                .notFilter(attributeFilterProperty_)
                                .orAllFilters(List.of(attributeFilterProperty_))
                                .build())
                        .build())
                .build()))
        .applicationId("applicationId")
        .displayName("displayName")
        .principal("principal")

        // the properties below are optional
        .authenticationDetail(DataAccessorAuthenticationDetailProperty.builder()
                .authenticationType("authenticationType")

                // the properties below are optional
                .authenticationConfiguration(DataAccessorAuthenticationConfigurationProperty.builder()
                        .idcTrustedTokenIssuerConfiguration(DataAccessorIdcTrustedTokenIssuerConfigurationProperty.builder()
                                .idcTrustedTokenIssuerArn("idcTrustedTokenIssuerArn")
                                .build())
                        .build())
                .externalIds(List.of("externalIds"))
                .build())
        .tags(List.of(CfnTag.builder()
                .key("key")
                .value("value")
                .build()))
        .build();
csharp
// Install: dotnet add package Amazon.CDK.Lib
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
using Amazon.CDK.AWS.QBusiness;

AttributeFilterProperty attributeFilterProperty_;

var cfnDataAccessorProps = new CfnDataAccessorProps {
    ActionConfigurations = new [] { new ActionConfigurationProperty {
        Action = "action",

        // the properties below are optional
        FilterConfiguration = new ActionFilterConfigurationProperty {
            DocumentAttributeFilter = new AttributeFilterProperty {
                AndAllFilters = new [] { attributeFilterProperty_ },
                ContainsAll = new DocumentAttributeProperty {
                    Name = "name",
                    Value = new DocumentAttributeValueProperty {
                        DateValue = "dateValue",
                        LongValue = 123,
                        StringListValue = new [] { "stringListValue" },
                        StringValue = "stringValue"
                    }
                },
                ContainsAny = new DocumentAttributeProperty {
                    Name = "name",
                    Value = new DocumentAttributeValueProperty {
                        DateValue = "dateValue",
                        LongValue = 123,
                        StringListValue = new [] { "stringListValue" },
                        StringValue = "stringValue"
                    }
                },
                EqualsTo = new DocumentAttributeProperty {
                    Name = "name",
                    Value = new DocumentAttributeValueProperty {
                        DateValue = "dateValue",
                        LongValue = 123,
                        StringListValue = new [] { "stringListValue" },
                        StringValue = "stringValue"
                    }
                },
                GreaterThan = new DocumentAttributeProperty {
                    Name = "name",
                    Value = new DocumentAttributeValueProperty {
                        DateValue = "dateValue",
                        LongValue = 123,
                        StringListValue = new [] { "stringListValue" },
                        StringValue = "stringValue"
                    }
                },
                GreaterThanOrEquals = new DocumentAttributeProperty {
                    Name = "name",
                    Value = new DocumentAttributeValueProperty {
                        DateValue = "dateValue",
                        LongValue = 123,
                        StringListValue = new [] { "stringListValue" },
                        StringValue = "stringValue"
                    }
                },
                LessThan = new DocumentAttributeProperty {
                    Name = "name",
                    Value = new DocumentAttributeValueProperty {
                        DateValue = "dateValue",
                        LongValue = 123,
                        StringListValue = new [] { "stringListValue" },
                        StringValue = "stringValue"
                    }
                },
                LessThanOrEquals = new DocumentAttributeProperty {
                    Name = "name",
                    Value = new DocumentAttributeValueProperty {
                        DateValue = "dateValue",
                        LongValue = 123,
                        StringListValue = new [] { "stringListValue" },
                        StringValue = "stringValue"
                    }
                },
                NotFilter = attributeFilterProperty_,
                OrAllFilters = new [] { attributeFilterProperty_ }
            }
        }
    } },
    ApplicationId = "applicationId",
    DisplayName = "displayName",
    Principal = "principal",

    // the properties below are optional
    AuthenticationDetail = new DataAccessorAuthenticationDetailProperty {
        AuthenticationType = "authenticationType",

        // the properties below are optional
        AuthenticationConfiguration = new DataAccessorAuthenticationConfigurationProperty {
            IdcTrustedTokenIssuerConfiguration = new DataAccessorIdcTrustedTokenIssuerConfigurationProperty {
                IdcTrustedTokenIssuerArn = "idcTrustedTokenIssuerArn"
            }
        },
        ExternalIds = new [] { "externalIds" }
    },
    Tags = new [] { new CfnTag {
        Key = "key",
        Value = "value"
    } }
};
go
// Install: go get github.com/aws/aws-cdk-go/awscdk/v2
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import "github.com/aws/aws-cdk-go/awscdk"

var attributeFilterProperty_ AttributeFilterProperty

cfnDataAccessorProps := &CfnDataAccessorProps{
	ActionConfigurations: []interface{}{
		&ActionConfigurationProperty{
			Action: jsii.String("action"),

			// the properties below are optional
			FilterConfiguration: &ActionFilterConfigurationProperty{
				DocumentAttributeFilter: &AttributeFilterProperty{
					AndAllFilters: []interface{}{
						attributeFilterProperty_,
					},
					ContainsAll: &DocumentAttributeProperty{
						Name: jsii.String("name"),
						Value: &DocumentAttributeValueProperty{
							DateValue: jsii.String("dateValue"),
							LongValue: jsii.Number(123),
							StringListValue: []*string{
								jsii.String("stringListValue"),
							},
							StringValue: jsii.String("stringValue"),
						},
					},
					ContainsAny: &DocumentAttributeProperty{
						Name: jsii.String("name"),
						Value: &DocumentAttributeValueProperty{
							DateValue: jsii.String("dateValue"),
							LongValue: jsii.Number(123),
							StringListValue: []*string{
								jsii.String("stringListValue"),
							},
							StringValue: jsii.String("stringValue"),
						},
					},
					EqualsTo: &DocumentAttributeProperty{
						Name: jsii.String("name"),
						Value: &DocumentAttributeValueProperty{
							DateValue: jsii.String("dateValue"),
							LongValue: jsii.Number(123),
							StringListValue: []*string{
								jsii.String("stringListValue"),
							},
							StringValue: jsii.String("stringValue"),
						},
					},
					GreaterThan: &DocumentAttributeProperty{
						Name: jsii.String("name"),
						Value: &DocumentAttributeValueProperty{
							DateValue: jsii.String("dateValue"),
							LongValue: jsii.Number(123),
							StringListValue: []*string{
								jsii.String("stringListValue"),
							},
							StringValue: jsii.String("stringValue"),
						},
					},
					GreaterThanOrEquals: &DocumentAttributeProperty{
						Name: jsii.String("name"),
						Value: &DocumentAttributeValueProperty{
							DateValue: jsii.String("dateValue"),
							LongValue: jsii.Number(123),
							StringListValue: []*string{
								jsii.String("stringListValue"),
							},
							StringValue: jsii.String("stringValue"),
						},
					},
					LessThan: &DocumentAttributeProperty{
						Name: jsii.String("name"),
						Value: &DocumentAttributeValueProperty{
							DateValue: jsii.String("dateValue"),
							LongValue: jsii.Number(123),
							StringListValue: []*string{
								jsii.String("stringListValue"),
							},
							StringValue: jsii.String("stringValue"),
						},
					},
					LessThanOrEquals: &DocumentAttributeProperty{
						Name: jsii.String("name"),
						Value: &DocumentAttributeValueProperty{
							DateValue: jsii.String("dateValue"),
							LongValue: jsii.Number(123),
							StringListValue: []*string{
								jsii.String("stringListValue"),
							},
							StringValue: jsii.String("stringValue"),
						},
					},
					NotFilter: attributeFilterProperty_,
					OrAllFilters: []interface{}{
						attributeFilterProperty_,
					},
				},
			},
		},
	},
	ApplicationId: jsii.String("applicationId"),
	DisplayName: jsii.String("displayName"),
	Principal: jsii.String("principal"),

	// the properties below are optional
	AuthenticationDetail: &DataAccessorAuthenticationDetailProperty{
		AuthenticationType: jsii.String("authenticationType"),

		// the properties below are optional
		AuthenticationConfiguration: &DataAccessorAuthenticationConfigurationProperty{
			IdcTrustedTokenIssuerConfiguration: &DataAccessorIdcTrustedTokenIssuerConfigurationProperty{
				IdcTrustedTokenIssuerArn: jsii.String("idcTrustedTokenIssuerArn"),
			},
		},
		ExternalIds: []*string{
			jsii.String("externalIds"),
		},
	},
	Tags: []CfnTag{
		&CfnTag{
			Key: jsii.String("key"),
			Value: jsii.String("value"),
		},
	},
}

Properties ​

actionConfigurationsIResolvable | IResolvable | CfnDataAccessor.ActionConfigurationProperty[]action_configurationstyping.Union[IResolvable, typing.List[typing.Union[IResolvable, ActionConfigurationProperty]]]actionConfigurationsIResolvableActionConfigurationsIResolvableActionConfigurationsinterface{} required #
A list of action configurations specifying the allowed actions and any associated filters.
applicationIdstringapplication_idstrapplicationIdStringApplicationIdstringApplicationId*string required #
The unique identifier of the Amazon Q Business application.
authenticationDetailoptionalIResolvable | CfnDataAccessor.DataAccessorAuthenticationDetailPropertyauthentication_detailoptionaltyping.Union[IResolvable, DataAccessorAuthenticationDetailProperty]authenticationDetailoptionalIResolvableAuthenticationDetailoptionalIResolvableAuthenticationDetailoptionalinterface{} #
The authentication configuration details for the data accessor.

This specifies how the ISV authenticates when accessing data through this data accessor.

displayNamestringdisplay_namestrdisplayNameStringDisplayNamestringDisplayName*string required #
The friendly name of the data accessor.
principalstringprincipalstrprincipalStringPrincipalstringPrincipal*string required #
The Amazon Resource Name (ARN) of the IAM role for the ISV associated with this data accessor.
tagsoptionalCfnTag[]tagsoptionaltyping.List[CfnTag]tagsoptionalList<CfnTag>TagsoptionalCfnTag[]Tagsoptional*[]CfnTag #
The tags to associate with the data accessor.