interface CfnServiceProps

Language	Type name
.NET	Amazon.CDK.AWS.VpcLattice.CfnServiceProps
Java	software.amazon.awscdk.services.vpclattice.CfnServiceProps
Python	aws_cdk.aws_vpclattice.CfnServiceProps
TypeScript	@aws-cdk/aws-vpclattice » CfnServiceProps

Properties for defining a CfnService.

Example

// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import * as vpclattice from '@aws-cdk/aws-vpclattice';
const cfnServiceProps: vpclattice.CfnServiceProps = {
  authType: 'authType',
  certificateArn: 'certificateArn',
  customDomainName: 'customDomainName',
  dnsEntry: {
    domainName: 'domainName',
    hostedZoneId: 'hostedZoneId',
  },
  name: 'name',
  tags: [{
    key: 'key',
    value: 'value',
  }],
};

Properties

Name	Type	Description
authType?	string	The type of IAM policy.
certificateArn?	string	The Amazon Resource Name (ARN) of the certificate.
customDomainName?	string	The custom domain name of the service.
dnsEntry?	IResolvable | DnsEntryProperty	AWS::VpcLattice::Service.DnsEntry.
name?	string	The name of the service.
tags?	CfnTag[]	The tags for the service.

---

authType?

Type: string (optional)

The type of IAM policy.

• NONE : The resource does not use an IAM policy. This is the default.
• AWS_IAM : The resource uses an IAM policy. When this type is used, auth is enabled and an auth policy is required.

---

certificateArn?

Type: string (optional)

The Amazon Resource Name (ARN) of the certificate.

---

customDomainName?

Type: string (optional)

The custom domain name of the service.

---

dnsEntry?

Type: IResolvable | DnsEntryProperty (optional)

AWS::VpcLattice::Service.DnsEntry.

---

name?

Type: string (optional)

The name of the service.

The name must be unique within the account. The valid characters are a-z, 0-9, and hyphens (-). You can't use a hyphen as the first or last character, or immediately after another hyphen.

If you don't specify a name, CloudFormation generates one. However, if you specify a name, and later want to replace the resource, you must specify a new name.

---

tags?

Type: CfnTag[] (optional)

The tags for the service.