Class CfnDomain
The AWS::CodeArtifact::Domain
resource creates an AWS CodeArtifact domain.
Inherited Members
Namespace: Amazon.CDK.AWS.CodeArtifact
Assembly: Amazon.CDK.Lib.dll
Syntax (csharp)
public class CfnDomain : CfnResource, IInspectable, ITaggable
Syntax (vb)
Public Class CfnDomain
Inherits CfnResource
Implements IInspectable, ITaggable
Remarks
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 .
See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-codeartifact-domain.html
CloudformationResource: AWS::CodeArtifact::Domain
ExampleMetadata: fixture=_generated
Examples
// 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 cfnDomain = new CfnDomain(this, "MyCfnDomain", new CfnDomainProps {
DomainName = "domainName",
// the properties below are optional
EncryptionKey = "encryptionKey",
PermissionsPolicyDocument = permissionsPolicyDocument,
Tags = new [] { new CfnTag {
Key = "key",
Value = "value"
} }
});
Synopsis
Constructors
CfnDomain(ByRefValue) | Used by jsii to construct an instance of this class from a Javascript-owned object reference |
CfnDomain(DeputyBase.DeputyProps) | Used by jsii to construct an instance of this class from DeputyProps |
CfnDomain(Construct, String, ICfnDomainProps) |
Properties
AttrArn | When you pass the logical ID of this resource, the function returns the Amazon Resource Name (ARN) of the domain. |
AttrEncryptionKey | When you pass the logical ID of this resource, the function returns the key used to encrypt the domain. |
AttrName | When you pass the logical ID of this resource, the function returns the name of the domain. |
AttrOwner | 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. |
CFN_RESOURCE_TYPE_NAME | The CloudFormation resource type name for this resource class. |
CfnProperties | |
DomainName | A string that specifies the name of the requested domain. |
EncryptionKey | The ARN of an AWS Key Management Service (AWS KMS) key associated with a domain. |
PermissionsPolicyDocument | The document that defines the resource policy that is set on a domain. |
Tags | Tag Manager which manages the tags for this resource. |
TagsRaw | A list of tags to be applied to the domain. |
Methods
Inspect(TreeInspector) | Examines the CloudFormation resource and discloses attributes. |
RenderProperties(IDictionary<String, Object>) |
Constructors
CfnDomain(ByRefValue)
Used by jsii to construct an instance of this class from a Javascript-owned object reference
protected CfnDomain(ByRefValue reference)
Parameters
- reference Amazon.JSII.Runtime.Deputy.ByRefValue
The Javascript-owned object reference
CfnDomain(DeputyBase.DeputyProps)
Used by jsii to construct an instance of this class from DeputyProps
protected CfnDomain(DeputyBase.DeputyProps props)
Parameters
- props Amazon.JSII.Runtime.Deputy.DeputyBase.DeputyProps
The deputy props
CfnDomain(Construct, String, ICfnDomainProps)
public CfnDomain(Construct scope, string id, ICfnDomainProps props)
Parameters
- scope Constructs.Construct
Scope in which this resource is defined.
- id System.String
Construct identifier for this resource (unique in its scope).
- props ICfnDomainProps
Resource properties.
Properties
AttrArn
When you pass the logical ID of this resource, the function returns the Amazon Resource Name (ARN) of the domain.
public virtual string AttrArn { get; }
Property Value
System.String
Remarks
CloudformationAttribute: Arn
AttrEncryptionKey
When you pass the logical ID of this resource, the function returns the key used to encrypt the domain.
public virtual string AttrEncryptionKey { get; }
Property Value
System.String
Remarks
CloudformationAttribute: EncryptionKey
AttrName
When you pass the logical ID of this resource, the function returns the name of the domain.
public virtual string AttrName { get; }
Property Value
System.String
Remarks
CloudformationAttribute: Name
AttrOwner
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.
public virtual string AttrOwner { get; }
Property Value
System.String
Remarks
CloudformationAttribute: Owner
CFN_RESOURCE_TYPE_NAME
The CloudFormation resource type name for this resource class.
public static string CFN_RESOURCE_TYPE_NAME { get; }
Property Value
System.String
CfnProperties
protected override IDictionary<string, object> CfnProperties { get; }
Property Value
System.Collections.Generic.IDictionary<System.String, System.Object>
Overrides
DomainName
A string that specifies the name of the requested domain.
public virtual string DomainName { get; set; }
Property Value
System.String
EncryptionKey
The ARN of an AWS Key Management Service (AWS KMS) key associated with a domain.
public virtual string EncryptionKey { get; set; }
Property Value
System.String
PermissionsPolicyDocument
The document that defines the resource policy that is set on a domain.
public virtual object PermissionsPolicyDocument { get; set; }
Property Value
System.Object
Tags
Tag Manager which manages the tags for this resource.
public virtual TagManager Tags { get; }
Property Value
TagsRaw
A list of tags to be applied to the domain.
public virtual ICfnTag[] TagsRaw { get; set; }
Property Value
ICfnTag[]
Methods
Inspect(TreeInspector)
Examines the CloudFormation resource and discloses attributes.
public virtual void Inspect(TreeInspector inspector)
Parameters
- inspector TreeInspector
tree inspector to collect and process attributes.
RenderProperties(IDictionary<String, Object>)
protected override IDictionary<string, object> RenderProperties(IDictionary<string, object> props)
Parameters
- props System.Collections.Generic.IDictionary<System.String, System.Object>
Returns
System.Collections.Generic.IDictionary<System.String, System.Object>