Class: AWSCDK::Amplify::CfnDomain::SubDomainSettingProperty

Inherits:

Jsii::Struct

• Object
• Jsii::Struct
• AWSCDK::Amplify::CfnDomain::SubDomainSettingProperty

Defined in:

amplify/cfn_domain.rb

Overview

The SubDomainSetting property type enables you to connect a subdomain (for example, example.exampledomain.com) to a specific branch.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-amplify-domain-subdomainsetting.html

Instance Attribute Summary

• #branch_name ⇒ String readonly

  The branch name setting for the subdomain.

• #prefix ⇒ String readonly

  The prefix setting for the subdomain.

Class Method Summary

• .jsii_properties ⇒ Object

Instance Method Summary

• #initialize(branch_name:, prefix:) ⇒ SubDomainSettingProperty constructor

  A new instance of SubDomainSettingProperty.

• #to_jsii ⇒ Object

Constructor Details

#initialize(branch_name:, prefix:) ⇒ SubDomainSettingProperty

Returns a new instance of SubDomainSettingProperty.

Parameters:

• branch_name (String) —

  The branch name setting for the subdomain.

• prefix (String) —

  The prefix setting for the subdomain.

# File 'amplify/cfn_domain.rb', line 781

def initialize(branch_name:, prefix:)
  @branch_name = branch_name
  Jsii::Type.check_type(@branch_name, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "branchName")
  @prefix = prefix
  Jsii::Type.check_type(@prefix, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "prefix")
end

Instance Attribute Details

#branch_name ⇒ String (readonly)

The branch name setting for the subdomain.

Length Constraints: Minimum length of 1. Maximum length of 255.

Pattern: (?s).+

Returns:

• (String)

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-amplify-domain-subdomainsetting.html#cfn-amplify-domain-subdomainsetting-branchname

# File 'amplify/cfn_domain.rb', line 796

def branch_name
  @branch_name
end

#prefix ⇒ String (readonly)

The prefix setting for the subdomain.

Returns:

• (String)

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-amplify-domain-subdomainsetting.html#cfn-amplify-domain-subdomainsetting-prefix

# File 'amplify/cfn_domain.rb', line 801

def prefix
  @prefix
end

Class Method Details

.jsii_properties ⇒ Object

# File 'amplify/cfn_domain.rb', line 803

def self.jsii_properties
  {
    :branch_name => "branchName",
    :prefix => "prefix",
  }
end

Instance Method Details

#to_jsii ⇒ Object

# File 'amplify/cfn_domain.rb', line 810

def to_jsii
  result = {}
  result.merge!({
    "branchName" => @branch_name,
    "prefix" => @prefix,
  })
  result.compact
end