Package software.amazon.awscdk.services.codeartifact

Interface CfnDomainProps

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnDomainProps.Jsii$Proxy

@Generated(value="jsii-pacmak/1.104.0 (build e79254c)",
           date="2024-11-15T10:24:56.275Z")
@Stability(Stable)
public interface CfnDomainProps
extends software.amazon.jsii.JsiiSerializable

Properties for defining a CfnDomain.

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;
 CfnDomainProps cfnDomainProps = CfnDomainProps.builder()
         .domainName("domainName")
         // the properties below are optional
         .encryptionKey("encryptionKey")
         .permissionsPolicyDocument(permissionsPolicyDocument)
         .tags(List.of(CfnTag.builder()
                 .key("key")
                 .value("value")
                 .build()))
         .build();
 

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-codeartifact-domain.html

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method	Description
static CfnDomainProps.Builder	builder()
String	getDomainName()	A string that specifies the name of the requested domain.
default String	getEncryptionKey()	The key used to encrypt the domain.
default Object	getPermissionsPolicyDocument()	The document that defines the resource policy that is set on a domain.
default List<CfnTag>	getTags()	A list of tags to be applied to the domain.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getDomainName

@Stability(Stable)
@NotNull
String getDomainName()

A string that specifies the name of the requested domain.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-codeartifact-domain.html#cfn-codeartifact-domain-domainname

getEncryptionKey

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

The key used to encrypt the domain.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-codeartifact-domain.html#cfn-codeartifact-domain-encryptionkey

getPermissionsPolicyDocument

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

The document that defines the resource policy that is set on a domain.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-codeartifact-domain.html#cfn-codeartifact-domain-permissionspolicydocument

getTags

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

A list of tags to be applied to the domain.

See Also:

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

builder

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

Returns:

a CfnDomainProps.Builder of CfnDomainProps