Skip to content
v2.277.0

CfnDomainProps Struct ​

Properties for defining a CfnDomain.

Example ​

ts
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import { aws_codeartifact as codeartifact } from 'aws-cdk-lib';

declare const permissionsPolicyDocument: any;
const cfnDomainProps: codeartifact.CfnDomainProps = {
  domainName: 'domainName',

  // the properties below are optional
  encryptionKey: 'encryptionKey',
  permissionsPolicyDocument: permissionsPolicyDocument,
  tags: [{
    key: 'key',
    value: 'value',
  }],
};
python
from aws_cdk import CfnTag
# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk import aws_codeartifact as codeartifact

# permissions_policy_document: Any

cfn_domain_props = codeartifact.CfnDomainProps(
    domain_name="domainName",

    # the properties below are optional
    encryption_key="encryptionKey",
    permissions_policy_document=permissions_policy_document,
    tags=[CfnTag(
        key="key",
        value="value"
    )]
)
java
// 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();
csharp
// Install: dotnet add package Amazon.CDK.Lib
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
using Amazon.CDK.AWS.CodeArtifact;

var permissionsPolicyDocument;

var cfnDomainProps = new CfnDomainProps {
    DomainName = "domainName",

    // the properties below are optional
    EncryptionKey = "encryptionKey",
    PermissionsPolicyDocument = permissionsPolicyDocument,
    Tags = new [] { new CfnTag {
        Key = "key",
        Value = "value"
    } }
};
go
// Install: go get github.com/aws/aws-cdk-go/awscdk/v2
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import "github.com/aws/aws-cdk-go/awscdk"

var permissionsPolicyDocument interface{}

cfnDomainProps := &CfnDomainProps{
	DomainName: jsii.String("domainName"),

	// the properties below are optional
	EncryptionKey: jsii.String("encryptionKey"),
	PermissionsPolicyDocument: permissionsPolicyDocument,
	Tags: []CfnTag{
		&CfnTag{
			Key: jsii.String("key"),
			Value: jsii.String("value"),
		},
	},
}

Properties ​

domainNamestringdomain_namestrdomainNameStringDomainNamestringDomainName*string required #
A string that specifies the name of the requested domain.
encryptionKeyoptionalstringencryption_keyoptionalstrencryptionKeyoptionalStringEncryptionKeyoptionalstringEncryptionKeyoptional*string #
The key used to encrypt the domain.
permissionsPolicyDocumentoptionalanypermissions_policy_documentoptionalAnypermissionsPolicyDocumentoptionalObjectPermissionsPolicyDocumentoptionalobjectPermissionsPolicyDocumentoptionalinterface{} #
The document that defines the resource policy that is set on a domain.
tagsoptionalCfnTag[]tagsoptionaltyping.List[CfnTag]tagsoptionalList<CfnTag>TagsoptionalCfnTag[]Tagsoptional*[]CfnTag #
A list of tags to be applied to the domain.