Package software.amazon.awscdk.services.vpclattice

Class CfnService

java.lang.Object
software.amazon.jsii.JsiiObject
software.constructs.Construct
software.amazon.awscdk.core.Construct
software.amazon.awscdk.core.CfnElement
software.amazon.awscdk.core.CfnRefElement
software.amazon.awscdk.core.CfnResource
software.amazon.awscdk.services.vpclattice.CfnService
All Implemented Interfaces:
IConstruct, IDependable, IInspectable, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct
@Generated(value="jsii-pacmak/1.84.0 (build 5404dcf)", date="2023-06-19T16:30:36.002Z") @Stability(Stable) public class CfnService extends CfnResource implements IInspectable
A CloudFormation AWS::VpcLattice::Service.

Creates a service. A service is any software application that can run on instances containers, or serverless functions within an account or virtual private cloud (VPC).

For more information, see Services in the Amazon VPC Lattice User Guide .

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.*;
 CfnService cfnService = CfnService.Builder.create(this, "MyCfnService")
         .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();

  • Field Details

    • CFN_RESOURCE_TYPE_NAME

      @Stability(Stable) public static final String CFN_RESOURCE_TYPE_NAME
      The CloudFormation resource type name for this resource class.

  • Constructor Details

    • CfnService

      protected CfnService(software.amazon.jsii.JsiiObjectRef objRef)

    • CfnService

      protected CfnService(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)

    • CfnService

      @Stability(Stable) public CfnService(@NotNull Construct scope, @NotNull String id, @Nullable CfnServiceProps props)
      Create a new AWS::VpcLattice::Service.

      Parameters:
      scope -
      • scope in which this resource is defined.
      This parameter is required.
      id -
      • scoped id of the resource.
      This parameter is required.
      props -
      • resource properties.

    • CfnService

      @Stability(Stable) public CfnService(@NotNull Construct scope, @NotNull String id)
      Create a new AWS::VpcLattice::Service.

      Parameters:
      scope -
      • scope in which this resource is defined.
      This parameter is required.
      id -
      • scoped id of the resource.
      This parameter is required.

  • Method Details

    • inspect

      @Stability(Stable) public void inspect(@NotNull TreeInspector inspector)
      Examines the CloudFormation resource and discloses attributes.

      Specified by:
      inspect in interface IInspectable
      Parameters:
      inspector -
      • tree inspector to collect and process attributes.
      This parameter is required.

    • renderProperties

      @Stability(Stable) @NotNull protected Map<String,Object> renderProperties(@NotNull Map<String,Object> props)
      Overrides:
      renderProperties in class CfnResource
      Parameters:
      props - This parameter is required.

    • getAttrArn

      @Stability(Stable) @NotNull public String getAttrArn()
      The Amazon Resource Name (ARN) of the service.

    • getAttrCreatedAt

      @Stability(Stable) @NotNull public String getAttrCreatedAt()
      The date and time that the service was created, specified in ISO-8601 format.

    • getAttrDnsEntryDomainName

      @Stability(Stable) @NotNull public String getAttrDnsEntryDomainName()
      The domain name of the service.

    • getAttrDnsEntryHostedZoneId

      @Stability(Stable) @NotNull public String getAttrDnsEntryHostedZoneId()
      The ID of the hosted zone.

    • getAttrId

      @Stability(Stable) @NotNull public String getAttrId()
      The ID of the service.

    • getAttrLastUpdatedAt

      @Stability(Stable) @NotNull public String getAttrLastUpdatedAt()
      The date and time that the service was last updated, specified in ISO-8601 format.

    • getAttrStatus

      @Stability(Stable) @NotNull public String getAttrStatus()
      The status of the service.

    • getCfnProperties

      @Stability(Stable) @NotNull protected Map<String,Object> getCfnProperties()
      Overrides:
      getCfnProperties in class CfnResource

    • getTags

      @Stability(Stable) @NotNull public TagManager getTags()
      The tags for the service.

    • getAuthType

      @Stability(Stable) @Nullable public 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.

    • setAuthType

      @Stability(Stable) public void setAuthType(@Nullable String value)
      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.

    • getCertificateArn

      @Stability(Stable) @Nullable public String getCertificateArn()
      The Amazon Resource Name (ARN) of the certificate.

    • setCertificateArn

      @Stability(Stable) public void setCertificateArn(@Nullable String value)
      The Amazon Resource Name (ARN) of the certificate.

    • getCustomDomainName

      @Stability(Stable) @Nullable public String getCustomDomainName()
      The custom domain name of the service.

    • setCustomDomainName

      @Stability(Stable) public void setCustomDomainName(@Nullable String value)
      The custom domain name of the service.

    • getDnsEntry

      @Stability(Stable) @Nullable public Object getDnsEntry()
      AWS::VpcLattice::Service.DnsEntry.

    • setDnsEntry

      @Stability(Stable) public void setDnsEntry(@Nullable IResolvable value)
      AWS::VpcLattice::Service.DnsEntry.

    • setDnsEntry

      @Stability(Stable) public void setDnsEntry(@Nullable CfnService.DnsEntryProperty value)
      AWS::VpcLattice::Service.DnsEntry.

    • getName

      @Stability(Stable) @Nullable public 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.

    • setName

      @Stability(Stable) public void setName(@Nullable String value)
      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.