Package software.amazon.awscdk.services.vpclattice

Interface CfnServiceProps

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnServiceProps.Jsii$Proxy

@Generated(value="jsii-pacmak/1.104.0 (build e79254c)",
           date="2024-12-17T21:37:40.426Z")
@Stability(Stable)
public interface CfnServiceProps
extends software.amazon.jsii.JsiiSerializable

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 software.amazon.awscdk.services.vpclattice.*;
 CfnServiceProps cfnServiceProps = CfnServiceProps.builder()
         .authType("authType")
         .certificateArn("certificateArn")
         .customDomainName("customDomainName")
         .dnsEntry(DnsEntryProperty.builder()
                 .domainName("domainName")
                 .hostedZoneId("hostedZoneId")
                 .build())
         .name("name")
         .tags(List.of(CfnTag.builder()
                 .key("key")
                 .value("value")
                 .build()))
         .build();
 

See Also:

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

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static final class	CfnServiceProps.Builder	A builder for CfnServiceProps
static final class	CfnServiceProps.Jsii$Proxy	An implementation for CfnServiceProps

Method Summary

Modifier and Type	Method	Description
static CfnServiceProps.Builder	builder()
default String	getAuthType()	The type of IAM policy.
default String	getCertificateArn()	The Amazon Resource Name (ARN) of the certificate.
default String	getCustomDomainName()	The custom domain name of the service.
default Object	getDnsEntry()	The DNS information of the service.
default String	getName()	The name of the service.
default List<CfnTag>	getTags()	The tags for the service.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getAuthType

@Stability(Stable)
@Nullable
default String getAuthType()

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.

Default: - "NONE"

See Also:

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

getCertificateArn

@Stability(Stable)
@Nullable
default String getCertificateArn()

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

getCustomDomainName

@Stability(Stable)
@Nullable
default String getCustomDomainName()

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

getDnsEntry

@Stability(Stable)
@Nullable
default Object getDnsEntry()

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

getName

@Stability(Stable)
@Nullable
default String getName()

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

getTags

@Stability(Stable)
@Nullable
default List<CfnTag> getTags()

The tags for the service.

See Also:

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

builder

@Stability(Stable)
static CfnServiceProps.Builder builder()

Returns:

a CfnServiceProps.Builder of CfnServiceProps