// The CDK Construct Library for AWS::Amplify package awscdkamplifyalpha import ( _init_ "github.com/aws/aws-cdk-go/awscdkamplifyalpha/v2/jsii" _jsii_ "github.com/aws/jsii-runtime-go/runtime" "github.com/aws/aws-cdk-go/awscdk/v2" "github.com/aws/aws-cdk-go/awscdkamplifyalpha/v2/internal" "github.com/aws/constructs-go/constructs/v10" ) // An Amplify Console domain. // // Example: // var amplifyApp app // var main branch // var dev branch // // // domain := amplifyApp.AddDomain(jsii.String("example.com"), &DomainOptions{ // EnableAutoSubdomain: jsii.Boolean(true), // // in case subdomains should be auto registered for branches // AutoSubdomainCreationPatterns: []*string{ // jsii.String("*"), // jsii.String("pr*"), // }, // }) // domain.MapRoot(main) // map main branch to domain root // domain.MapSubDomain(main, jsii.String("www")) // domain.MapSubDomain(dev) // // Experimental. type Domain interface { awscdk.Resource // The ARN of the domain. // Experimental. Arn() *string // The DNS Record for certificate verification. // Experimental. CertificateRecord() *string // Branch patterns for the automatically created subdomain. // Experimental. DomainAutoSubDomainCreationPatterns() *[]*string // The IAM service role for the subdomain. // Experimental. DomainAutoSubDomainIamRole() *string // Specifies whether the automated creation of subdomains for branches is enabled. // Experimental. DomainEnableAutoSubDomain() awscdk.IResolvable // The name of the domain. // Experimental. DomainName() *string // The status of the domain association. // Experimental. DomainStatus() *string // The environment this resource belongs to. // // For resources that are created and managed by the CDK // (generally, those created by creating new class instances like Role, Bucket, etc.), // this is always the same as the environment of the stack they belong to; // however, for imported resources // (those obtained from static methods like fromRoleArn, fromBucketName, etc.), // that might be different than the stack they were imported into. // Experimental. Env() *awscdk.ResourceEnvironment // The tree node. // Experimental. Node() constructs.Node // Returns a string-encoded token that resolves to the physical name that should be passed to the CloudFormation resource. // // This value will resolve to one of the following: // - a concrete value (e.g. `"my-awesome-bucket"`) // - `undefined`, when a name should be generated by CloudFormation // - a concrete name generated automatically during synthesis, in // cross-environment scenarios. // Experimental. PhysicalName() *string // The stack in which this resource is defined. // Experimental. Stack() awscdk.Stack // The reason for the current status of the domain. // Experimental. StatusReason() *string // Apply the given removal policy to this resource. // // The Removal Policy controls what happens to this resource when it stops // being managed by CloudFormation, either because you've removed it from the // CDK application or because you've made a change that requires the resource // to be replaced. // // The resource can be deleted (`RemovalPolicy.DESTROY`), or left in your AWS // account for data recovery and cleanup later (`RemovalPolicy.RETAIN`). // Experimental. ApplyRemovalPolicy(policy awscdk.RemovalPolicy) // Experimental. GeneratePhysicalName() *string // Returns an environment-sensitive token that should be used for the resource's "ARN" attribute (e.g. `bucket.bucketArn`). // // Normally, this token will resolve to `arnAttr`, but if the resource is // referenced across environments, `arnComponents` will be used to synthesize // a concrete ARN with the resource's physical name. Make sure to reference // `this.physicalName` in `arnComponents`. // Experimental. GetResourceArnAttribute(arnAttr *string, arnComponents *awscdk.ArnComponents) *string // Returns an environment-sensitive token that should be used for the resource's "name" attribute (e.g. `bucket.bucketName`). // // Normally, this token will resolve to `nameAttr`, but if the resource is // referenced across environments, it will be resolved to `this.physicalName`, // which will be a concrete name. // Experimental. GetResourceNameAttribute(nameAttr *string) *string // Maps a branch to the domain root. // Experimental. MapRoot(branch IBranch) Domain // Maps a branch to a sub domain. // Experimental. MapSubDomain(branch IBranch, prefix *string) Domain // Returns a string representation of this construct. // Experimental. ToString() *string } // The jsii proxy struct for Domain type jsiiProxy_Domain struct { internal.Type__awscdkResource } func (j *jsiiProxy_Domain) Arn() *string { var returns *string _jsii_.Get( j, "arn", &returns, ) return returns } func (j *jsiiProxy_Domain) CertificateRecord() *string { var returns *string _jsii_.Get( j, "certificateRecord", &returns, ) return returns } func (j *jsiiProxy_Domain) DomainAutoSubDomainCreationPatterns() *[]*string { var returns *[]*string _jsii_.Get( j, "domainAutoSubDomainCreationPatterns", &returns, ) return returns } func (j *jsiiProxy_Domain) DomainAutoSubDomainIamRole() *string { var returns *string _jsii_.Get( j, "domainAutoSubDomainIamRole", &returns, ) return returns } func (j *jsiiProxy_Domain) DomainEnableAutoSubDomain() awscdk.IResolvable { var returns awscdk.IResolvable _jsii_.Get( j, "domainEnableAutoSubDomain", &returns, ) return returns } func (j *jsiiProxy_Domain) DomainName() *string { var returns *string _jsii_.Get( j, "domainName", &returns, ) return returns } func (j *jsiiProxy_Domain) DomainStatus() *string { var returns *string _jsii_.Get( j, "domainStatus", &returns, ) return returns } func (j *jsiiProxy_Domain) Env() *awscdk.ResourceEnvironment { var returns *awscdk.ResourceEnvironment _jsii_.Get( j, "env", &returns, ) return returns } func (j *jsiiProxy_Domain) Node() constructs.Node { var returns constructs.Node _jsii_.Get( j, "node", &returns, ) return returns } func (j *jsiiProxy_Domain) PhysicalName() *string { var returns *string _jsii_.Get( j, "physicalName", &returns, ) return returns } func (j *jsiiProxy_Domain) Stack() awscdk.Stack { var returns awscdk.Stack _jsii_.Get( j, "stack", &returns, ) return returns } func (j *jsiiProxy_Domain) StatusReason() *string { var returns *string _jsii_.Get( j, "statusReason", &returns, ) return returns } // Experimental. func NewDomain(scope constructs.Construct, id *string, props *DomainProps) Domain { _init_.Initialize() if err := validateNewDomainParameters(scope, id, props); err != nil { panic(err) } j := jsiiProxy_Domain{} _jsii_.Create( "@aws-cdk/aws-amplify-alpha.Domain", []interface{}{scope, id, props}, &j, ) return &j } // Experimental. func NewDomain_Override(d Domain, scope constructs.Construct, id *string, props *DomainProps) { _init_.Initialize() _jsii_.Create( "@aws-cdk/aws-amplify-alpha.Domain", []interface{}{scope, id, props}, d, ) } // Checks if `x` is a construct. // // Use this method instead of `instanceof` to properly detect `Construct` // instances, even when the construct library is symlinked. // // Explanation: in JavaScript, multiple copies of the `constructs` library on // disk are seen as independent, completely different libraries. As a // consequence, the class `Construct` in each copy of the `constructs` library // is seen as a different class, and an instance of one class will not test as // `instanceof` the other class. `npm install` will not create installations // like this, but users may manually symlink construct libraries together or // use a monorepo tool: in those cases, multiple copies of the `constructs` // library can be accidentally installed, and `instanceof` will behave // unpredictably. It is safest to avoid using `instanceof`, and using // this type-testing method instead. // // Returns: true if `x` is an object created from a class which extends `Construct`. // Experimental. func Domain_IsConstruct(x interface{}) *bool { _init_.Initialize() if err := validateDomain_IsConstructParameters(x); err != nil { panic(err) } var returns *bool _jsii_.StaticInvoke( "@aws-cdk/aws-amplify-alpha.Domain", "isConstruct", []interface{}{x}, &returns, ) return returns } // Returns true if the construct was created by CDK, and false otherwise. // Experimental. func Domain_IsOwnedResource(construct constructs.IConstruct) *bool { _init_.Initialize() if err := validateDomain_IsOwnedResourceParameters(construct); err != nil { panic(err) } var returns *bool _jsii_.StaticInvoke( "@aws-cdk/aws-amplify-alpha.Domain", "isOwnedResource", []interface{}{construct}, &returns, ) return returns } // Check whether the given construct is a Resource. // Experimental. func Domain_IsResource(construct constructs.IConstruct) *bool { _init_.Initialize() if err := validateDomain_IsResourceParameters(construct); err != nil { panic(err) } var returns *bool _jsii_.StaticInvoke( "@aws-cdk/aws-amplify-alpha.Domain", "isResource", []interface{}{construct}, &returns, ) return returns } func (d *jsiiProxy_Domain) ApplyRemovalPolicy(policy awscdk.RemovalPolicy) { if err := d.validateApplyRemovalPolicyParameters(policy); err != nil { panic(err) } _jsii_.InvokeVoid( d, "applyRemovalPolicy", []interface{}{policy}, ) } func (d *jsiiProxy_Domain) GeneratePhysicalName() *string { var returns *string _jsii_.Invoke( d, "generatePhysicalName", nil, // no parameters &returns, ) return returns } func (d *jsiiProxy_Domain) GetResourceArnAttribute(arnAttr *string, arnComponents *awscdk.ArnComponents) *string { if err := d.validateGetResourceArnAttributeParameters(arnAttr, arnComponents); err != nil { panic(err) } var returns *string _jsii_.Invoke( d, "getResourceArnAttribute", []interface{}{arnAttr, arnComponents}, &returns, ) return returns } func (d *jsiiProxy_Domain) GetResourceNameAttribute(nameAttr *string) *string { if err := d.validateGetResourceNameAttributeParameters(nameAttr); err != nil { panic(err) } var returns *string _jsii_.Invoke( d, "getResourceNameAttribute", []interface{}{nameAttr}, &returns, ) return returns } func (d *jsiiProxy_Domain) MapRoot(branch IBranch) Domain { if err := d.validateMapRootParameters(branch); err != nil { panic(err) } var returns Domain _jsii_.Invoke( d, "mapRoot", []interface{}{branch}, &returns, ) return returns } func (d *jsiiProxy_Domain) MapSubDomain(branch IBranch, prefix *string) Domain { if err := d.validateMapSubDomainParameters(branch); err != nil { panic(err) } var returns Domain _jsii_.Invoke( d, "mapSubDomain", []interface{}{branch, prefix}, &returns, ) return returns } func (d *jsiiProxy_Domain) ToString() *string { var returns *string _jsii_.Invoke( d, "toString", nil, // no parameters &returns, ) return returns }