Class: AWSCDK::Bedrock::CfnDataSource::SharePointSourceConfigurationProperty

Inherits:
Jsii::Struct
  • Object
show all
Defined in:
bedrock/cfn_data_source.rb

Overview

The endpoint information to connect to your SharePoint data source.

See Also:

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(auth_type:, credentials_secret_arn:, domain:, host_type:, site_urls:, tenant_id: nil) ⇒ SharePointSourceConfigurationProperty

Returns a new instance of SharePointSourceConfigurationProperty.

Parameters:

  • auth_type (String) —

    The supported authentication type to authenticate and connect to your SharePoint site/sites.

  • credentials_secret_arn (String) —

    The Amazon Resource Name of an AWS Secrets Manager secret that stores your authentication credentials for your SharePoint site/sites.

  • domain (String) —

    The domain of your SharePoint instance or site URL/URLs.

  • host_type (String) —

    The supported host type, whether online/cloud or server/on-premises.

  • site_urls (Array<String>) —

    A list of one or more SharePoint site URLs.

  • tenant_id (String, nil) (defaults to: nil) —

    The identifier of your Microsoft 365 tenant.



2265
2266
2267
2268
2269
2270
2271
2272
2273
2274
2275
2276
2277
2278
 
# File 'bedrock/cfn_data_source.rb', line 2265

def initialize(auth_type:, credentials_secret_arn:, domain:, host_type:, site_urls:, tenant_id: nil)
  @auth_type = auth_type
  Jsii::Type.check_type(@auth_type, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "authType")
  @credentials_secret_arn = credentials_secret_arn
  Jsii::Type.check_type(@credentials_secret_arn, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "credentialsSecretArn")
  @domain = domain
  Jsii::Type.check_type(@domain, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "domain")
  @host_type = host_type
  Jsii::Type.check_type(@host_type, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "hostType")
  @site_urls = site_urls
  Jsii::Type.check_type(@site_urls, JSON.parse(Base64.strict_decode64("eyJjb2xsZWN0aW9uIjp7ImVsZW1lbnR0eXBlIjp7InByaW1pdGl2ZSI6InN0cmluZyJ9LCJraW5kIjoiYXJyYXkifX0=")), "siteUrls")
  @tenant_id = tenant_id
  Jsii::Type.check_type(@tenant_id, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "tenantId") unless @tenant_id.nil?
end

Instance Attribute Details

#auth_type ⇒ String (readonly)

The supported authentication type to authenticate and connect to your SharePoint site/sites.

Returns:

  • (String)

See Also:



2284
2285
2286
 
# File 'bedrock/cfn_data_source.rb', line 2284

def auth_type
  @auth_type
end

#credentials_secret_arn ⇒ String (readonly)

The Amazon Resource Name of an AWS Secrets Manager secret that stores your authentication credentials for your SharePoint site/sites.

For more information on the key-value pairs that must be included in your secret, depending on your authentication type, see SharePoint connection configuration .

Returns:

  • (String)

See Also:



2291
2292
2293
 
# File 'bedrock/cfn_data_source.rb', line 2291

def credentials_secret_arn
  @credentials_secret_arn
end

#domain ⇒ String (readonly)

The domain of your SharePoint instance or site URL/URLs.

Returns:

  • (String)

See Also:



2296
2297
2298
 
# File 'bedrock/cfn_data_source.rb', line 2296

def domain
  @domain
end

#host_type ⇒ String (readonly)

The supported host type, whether online/cloud or server/on-premises.

Returns:

  • (String)

See Also:



2301
2302
2303
 
# File 'bedrock/cfn_data_source.rb', line 2301

def host_type
  @host_type
end

#site_urls ⇒ Array<String> (readonly)

A list of one or more SharePoint site URLs.

Returns:

  • (Array<String>)

See Also:



2306
2307
2308
 
# File 'bedrock/cfn_data_source.rb', line 2306

def site_urls
  @site_urls
end

#tenant_id ⇒ String? (readonly)

The identifier of your Microsoft 365 tenant.

Returns:

  • (String, nil)

See Also:



2311
2312
2313
 
# File 'bedrock/cfn_data_source.rb', line 2311

def tenant_id
  @tenant_id
end

Class Method Details

.jsii_properties ⇒ Object 



2313
2314
2315
2316
2317
2318
2319
2320
2321
2322
 
# File 'bedrock/cfn_data_source.rb', line 2313

def self.jsii_properties
  {
    :auth_type => "authType",
    :credentials_secret_arn => "credentialsSecretArn",
    :domain => "domain",
    :host_type => "hostType",
    :site_urls => "siteUrls",
    :tenant_id => "tenantId",
  }
end

Instance Method Details

#to_jsii ⇒ Object 



2324
2325
2326
2327
2328
2329
2330
2331
2332
2333
2334
2335
 
# File 'bedrock/cfn_data_source.rb', line 2324

def to_jsii
  result = {}
  result.merge!({
    "authType" => @auth_type,
    "credentialsSecretArn" => @credentials_secret_arn,
    "domain" => @domain,
    "hostType" => @host_type,
    "siteUrls" => @site_urls,
    "tenantId" => @tenant_id,
  })
  result.compact
end