Class: AWSCDK::BedrockAgentCore::CfnGatewayTarget::OAuthCredentialProviderProperty

Inherits:

Jsii::Struct

• Object
• Jsii::Struct
• AWSCDK::BedrockAgentCore::CfnGatewayTarget::OAuthCredentialProviderProperty

Defined in:

bedrock_agent_core/cfn_gateway_target.rb

Overview

The OAuth credential provider for the gateway target.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrockagentcore-gatewaytarget-oauthcredentialprovider.html

Instance Attribute Summary

• #custom_parameters ⇒ AWSCDK::IResolvable, ... readonly

  The OAuth credential provider.

• #default_return_url ⇒ String^? readonly

  Return URL for OAuth callback.

• #grant_type ⇒ String^? readonly
• #provider_arn ⇒ String readonly

  The provider ARN for the gateway target.

• #scopes ⇒ Array<String> readonly

  The OAuth credential provider scopes.

Class Method Summary

• .jsii_properties ⇒ Object

Instance Method Summary

• #initialize(provider_arn:, scopes:, custom_parameters: nil, default_return_url: nil, grant_type: nil) ⇒ OAuthCredentialProviderProperty constructor

  A new instance of OAuthCredentialProviderProperty.

• #to_jsii ⇒ Object

Constructor Details

#initialize(provider_arn:, scopes:, custom_parameters: nil, default_return_url: nil, grant_type: nil) ⇒ OAuthCredentialProviderProperty

Returns a new instance of OAuthCredentialProviderProperty.

Parameters:

• provider_arn (String) —

  The provider ARN for the gateway target.

• scopes (Array<String>) —

  The OAuth credential provider scopes.

• custom_parameters (AWSCDK::IResolvable, Hash{String => String}, nil) (defaults to: nil) —

  The OAuth credential provider.

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

  Return URL for OAuth callback.

• grant_type (String, nil) (defaults to: nil)

# File 'bedrock_agent_core/cfn_gateway_target.rb', line 1719

def initialize(provider_arn:, scopes:, custom_parameters: nil, default_return_url: nil, grant_type: nil)
  @provider_arn = provider_arn
  Jsii::Type.check_type(@provider_arn, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "providerArn")
  @scopes = scopes
  Jsii::Type.check_type(@scopes, JSON.parse(Base64.strict_decode64("eyJjb2xsZWN0aW9uIjp7ImVsZW1lbnR0eXBlIjp7InByaW1pdGl2ZSI6InN0cmluZyJ9LCJraW5kIjoiYXJyYXkifX0=")), "scopes")
  @custom_parameters = custom_parameters
  Jsii::Type.check_type(@custom_parameters, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImNvbGxlY3Rpb24iOnsiZWxlbWVudHR5cGUiOnsicHJpbWl0aXZlIjoic3RyaW5nIn0sImtpbmQiOiJtYXAifX1dfX0=")), "customParameters") unless @custom_parameters.nil?
  @default_return_url = default_return_url
  Jsii::Type.check_type(@default_return_url, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "defaultReturnUrl") unless @default_return_url.nil?
  @grant_type = grant_type
  Jsii::Type.check_type(@grant_type, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "grantType") unless @grant_type.nil?
end

Instance Attribute Details

#custom_parameters ⇒ AWSCDK::IResolvable, ... (readonly)

The OAuth credential provider.

Returns:

• (AWSCDK::IResolvable, Hash{String => String}, nil)

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrockagentcore-gatewaytarget-oauthcredentialprovider.html#cfn-bedrockagentcore-gatewaytarget-oauthcredentialprovider-customparameters

# File 'bedrock_agent_core/cfn_gateway_target.rb', line 1746

def custom_parameters
  @custom_parameters
end

#default_return_url ⇒ String^? (readonly)

Return URL for OAuth callback.

Returns:

• (String, nil)

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrockagentcore-gatewaytarget-oauthcredentialprovider.html#cfn-bedrockagentcore-gatewaytarget-oauthcredentialprovider-defaultreturnurl

# File 'bedrock_agent_core/cfn_gateway_target.rb', line 1751

def default_return_url
  @default_return_url
end

#grant_type ⇒ String^? (readonly)

Returns:

• (String, nil)

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrockagentcore-gatewaytarget-oauthcredentialprovider.html#cfn-bedrockagentcore-gatewaytarget-oauthcredentialprovider-granttype

# File 'bedrock_agent_core/cfn_gateway_target.rb', line 1754

def grant_type
  @grant_type
end

#provider_arn ⇒ String (readonly)

The provider ARN for the gateway target.

Returns:

• (String)

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrockagentcore-gatewaytarget-oauthcredentialprovider.html#cfn-bedrockagentcore-gatewaytarget-oauthcredentialprovider-providerarn

# File 'bedrock_agent_core/cfn_gateway_target.rb', line 1736

def provider_arn
  @provider_arn
end

#scopes ⇒ Array<String> (readonly)

The OAuth credential provider scopes.

Returns:

• (Array<String>)

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrockagentcore-gatewaytarget-oauthcredentialprovider.html#cfn-bedrockagentcore-gatewaytarget-oauthcredentialprovider-scopes

# File 'bedrock_agent_core/cfn_gateway_target.rb', line 1741

def scopes
  @scopes
end

Class Method Details

.jsii_properties ⇒ Object

# File 'bedrock_agent_core/cfn_gateway_target.rb', line 1756

def self.jsii_properties
  {
    :provider_arn => "providerArn",
    :scopes => "scopes",
    :custom_parameters => "customParameters",
    :default_return_url => "defaultReturnUrl",
    :grant_type => "grantType",
  }
end

Instance Method Details

#to_jsii ⇒ Object

# File 'bedrock_agent_core/cfn_gateway_target.rb', line 1766

def to_jsii
  result = {}
  result.merge!({
    "providerArn" => @provider_arn,
    "scopes" => @scopes,
    "customParameters" => @custom_parameters,
    "defaultReturnUrl" => @default_return_url,
    "grantType" => @grant_type,
  })
  result.compact
end