# DomainNameAttributes

Used as argument in: [DomainName.fromDomainNameAttributes](https://docs.aws.amazon.com/cdk/api/v2/docs/aws-cdk-lib.aws_apigateway.DomainName.html#fromdomainnameattributes)

- Source: [`aws-apigateway/lib/domain-name.ts`](https://github.com/aws/aws-cdk/blob/v2.278.0/packages/aws-cdk-lib/aws-apigateway/lib/domain-name.ts#L491)

## Example

TypeScript:

```ts
declare const api: apigateway.RestApi;

const domainName = apigateway.DomainName.fromDomainNameAttributes(this, 'DomainName', {
  domainName: 'domainName',
  domainNameAliasHostedZoneId: 'domainNameAliasHostedZoneId',
  domainNameAliasTarget: 'domainNameAliasTarget',
});

new apigateway.BasePathMapping(this, 'BasePathMapping', {
  domainName: domainName,
  restApi: api,
});
```

Python:

```python
# api: apigateway.RestApi

domain_name = apigateway.DomainName.from_domain_name_attributes(self, "DomainName",
    domain_name="domainName",
    domain_name_alias_hosted_zone_id="domainNameAliasHostedZoneId",
    domain_name_alias_target="domainNameAliasTarget"
)

apigateway.BasePathMapping(self, "BasePathMapping",
    domain_name=domain_name,
    rest_api=api
)
```

Java:

```java
RestApi api;

IDomainName domainName = DomainName.fromDomainNameAttributes(this, "DomainName", DomainNameAttributes.builder()
        .domainName("domainName")
        .domainNameAliasHostedZoneId("domainNameAliasHostedZoneId")
        .domainNameAliasTarget("domainNameAliasTarget")
        .build());

BasePathMapping.Builder.create(this, "BasePathMapping")
        .domainName(domainName)
        .restApi(api)
        .build();
```

C# / .NET:

```csharp
// Install: dotnet add package Amazon.CDK.Lib
RestApi api;

var domainName = DomainName.FromDomainNameAttributes(this, "DomainName", new DomainNameAttributes {
    DomainName = "domainName",
    DomainNameAliasHostedZoneId = "domainNameAliasHostedZoneId",
    DomainNameAliasTarget = "domainNameAliasTarget"
});

new BasePathMapping(this, "BasePathMapping", new BasePathMappingProps {
    DomainName = domainName,
    RestApi = api
});
```

Golang:

```go
// Install: go get github.com/aws/aws-cdk-go/awscdk/v2
var api RestApi

domainName := apigateway.DomainName_FromDomainNameAttributes(this, jsii.String("DomainName"), &DomainNameAttributes{
	DomainName: jsii.String("domainName"),
	DomainNameAliasHostedZoneId: jsii.String("domainNameAliasHostedZoneId"),
	DomainNameAliasTarget: jsii.String("domainNameAliasTarget"),
})

apigateway.NewBasePathMapping(this, jsii.String("BasePathMapping"), &BasePathMappingProps{
	DomainName: domainName,
	RestApi: api,
})
```

## Properties

- `domainName`: string (required) — The domain name (e.g. `example.com`).

- `domainNameAliasHostedZoneId`: string (required) — The Route53 hosted zone ID to use in order to connect a record set to this domain through an alias.

- `domainNameAliasTarget`: string (required) — The Route53 alias target to use in order to connect a record set to this domain through an alias.
