Skip to content
v2.277.0

Experimental

@aws-cdk/aws-amplify-alpha is an experimental (alpha) package: its API may change in any release, without a major version bump.

SubDomain Struct ​

Sub domain settings.

Example ​

ts
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import * as amplify_alpha from '@aws-cdk/aws-amplify-alpha';

declare const branch: amplify_alpha.Branch;
const subDomain: amplify_alpha.SubDomain = {
  branch: branch,

  // the properties below are optional
  prefix: 'prefix',
};
python
# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
import aws_cdk.aws_amplify_alpha as amplify_alpha

# branch: amplify_alpha.Branch

sub_domain = amplify_alpha.SubDomain(
    branch=branch,

    # the properties below are optional
    prefix="prefix"
)
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.amplify.alpha.*;

Branch branch;

SubDomain subDomain = SubDomain.builder()
        .branch(branch)

        // the properties below are optional
        .prefix("prefix")
        .build();
csharp
// Install: dotnet add package Amazon.CDK.AWS.Amplify.Alpha
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
using Amazon.CDK.AWS.Amplify.Alpha;

Branch branch;

var subDomain = new SubDomain {
    Branch = branch,

    // the properties below are optional
    Prefix = "prefix"
};
go
// Install: go get github.com/aws/aws-cdk-go/awscdkamplifyalpha/v2
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import amplify_alpha "github.com/aws/aws-cdk-go/awscdkamplifyalpha"

var branch Branch

subDomain := &SubDomain{
	Branch: branch,

	// the properties below are optional
	Prefix: jsii.String("prefix"),
}

Properties ​

branchIBranchbranchIBranchbranchIBranchBranchIBranchBranchIBranch required #
The branch.
prefixoptionalstringprefixoptionalstrprefixoptionalStringPrefixoptionalstringPrefixoptional*string #
The prefix.

Default: the branch name

Use '' to map to the root of the domain