Package software.amazon.awscdk.services.codeartifact

Class CfnDomain

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.codeartifact.CfnDomain
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:29:55.891Z") @Stability(Stable) public class CfnDomain extends CfnResource implements IInspectable
A CloudFormation AWS::CodeArtifact::Domain.

The AWS::CodeArtifact::Domain resource creates an AWS CodeArtifact domain. CodeArtifact domains make it easier to manage multiple repositories across an organization. You can use a domain to apply permissions across many repositories owned by different AWS accounts. For more information about domains, see the Domain concepts information in the CodeArtifact User Guide . For more information about the CreateDomain API, see CreateDomain in the CodeArtifact API Reference .

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.codeartifact.*;
 Object permissionsPolicyDocument;
 CfnDomain cfnDomain = CfnDomain.Builder.create(this, "MyCfnDomain")
         .domainName("domainName")
         // the properties below are optional
         .encryptionKey("encryptionKey")
         .permissionsPolicyDocument(permissionsPolicyDocument)
         .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

    • CfnDomain

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

    • CfnDomain

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

    • CfnDomain

      @Stability(Stable) public CfnDomain(@NotNull Construct scope, @NotNull String id, @NotNull CfnDomainProps props)
      Create a new AWS::CodeArtifact::Domain.

      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.
      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()
      When you pass the logical ID of this resource, the function returns the Amazon Resource Name (ARN) of the domain.

    • getAttrEncryptionKey

      @Stability(Stable) @NotNull public String getAttrEncryptionKey()
      When you pass the logical ID of this resource, the function returns the key used to encrypt the domain.

    • getAttrName

      @Stability(Stable) @NotNull public String getAttrName()
      When you pass the logical ID of this resource, the function returns the name of the domain.

    • getAttrOwner

      @Stability(Stable) @NotNull public String getAttrOwner()
      When you pass the logical ID of this resource, the function returns the 12-digit account number of the AWS account that owns the domain.

    • getCfnProperties

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

    • getTags

      @Stability(Stable) @NotNull public TagManager getTags()
      A list of tags to be applied to the domain.

    • getDomainName

      @Stability(Stable) @NotNull public String getDomainName()
      A string that specifies the name of the requested domain.

    • setDomainName

      @Stability(Stable) public void setDomainName(@NotNull String value)
      A string that specifies the name of the requested domain.

    • getPermissionsPolicyDocument

      @Stability(Stable) @NotNull public Object getPermissionsPolicyDocument()
      The document that defines the resource policy that is set on a domain.

    • setPermissionsPolicyDocument

      @Stability(Stable) public void setPermissionsPolicyDocument(@NotNull Object value)
      The document that defines the resource policy that is set on a domain.

    • getEncryptionKey

      @Stability(Stable) @Nullable public String getEncryptionKey()
      The key used to encrypt the domain.

    • setEncryptionKey

      @Stability(Stable) public void setEncryptionKey(@Nullable String value)
      The key used to encrypt the domain.