2.173.2

interface CfnServiceProps

LanguageType name
.NETAmazon.CDK.AWS.VpcLattice.CfnServiceProps
Gogithub.com/aws/aws-cdk-go/awscdk/v2/awsvpclattice#CfnServiceProps
Javasoftware.amazon.awscdk.services.vpclattice.CfnServiceProps
Pythonaws_cdk.aws_vpclattice.CfnServiceProps
TypeScript aws-cdk-lib » aws_vpclattice » CfnServiceProps

Properties for defining a CfnService.

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-vpclattice-service.html

Example

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

Properties

NameTypeDescription
authType?stringThe type of IAM policy.
certificateArn?stringThe Amazon Resource Name (ARN) of the certificate.
customDomainName?stringThe custom domain name of the service.
dnsEntry?IResolvable | DnsEntryPropertyThe DNS information of the service.
name?stringThe name of the service.
tags?CfnTag[]The tags for the service.

authType?

Type: string (optional, default: "NONE")

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.

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-vpclattice-service.html#cfn-vpclattice-service-authtype

certificateArn?

Type: string (optional)

The Amazon Resource Name (ARN) of the certificate.

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-vpclattice-service.html#cfn-vpclattice-service-certificatearn

customDomainName?

Type: string (optional)

The custom domain name of the service.

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-vpclattice-service.html#cfn-vpclattice-service-customdomainname

dnsEntry?

Type: IResolvable | DnsEntryProperty (optional)

The DNS information of the service.

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-vpclattice-service.html#cfn-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.

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-vpclattice-service.html#cfn-vpclattice-service-name

tags?

Type: CfnTag[] (optional)

The tags for the service.

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-vpclattice-service.html#cfn-vpclattice-service-tags

← PreviousNext →