Class CfnRepositoryProps
Properties for defining a CfnRepository
.
Inheritance
Implements
Namespace: Amazon.CDK.AWS.CodeCommit
Assembly: Amazon.CDK.Lib.dll
Syntax (csharp)
public class CfnRepositoryProps : Object, ICfnRepositoryProps
Syntax (vb)
Public Class CfnRepositoryProps
Inherits Object
Implements ICfnRepositoryProps
Remarks
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.CodeCommit;
var cfnRepositoryProps = new CfnRepositoryProps {
RepositoryName = "repositoryName",
// the properties below are optional
Code = new CodeProperty {
S3 = new S3Property {
Bucket = "bucket",
Key = "key",
// the properties below are optional
ObjectVersion = "objectVersion"
},
// the properties below are optional
BranchName = "branchName"
},
KmsKeyId = "kmsKeyId",
RepositoryDescription = "repositoryDescription",
Tags = new [] { new CfnTag {
Key = "key",
Value = "value"
} },
Triggers = new [] { new RepositoryTriggerProperty {
DestinationArn = "destinationArn",
Events = new [] { "events" },
Name = "name",
// the properties below are optional
Branches = new [] { "branches" },
CustomData = "customData"
} }
};
Synopsis
Constructors
CfnRepositoryProps() |
Properties
Code | Information about code to be committed to a repository after it is created in an AWS CloudFormation stack. |
KmsKeyId | The ID of the AWS Key Management Service encryption key used to encrypt and decrypt the repository. |
RepositoryDescription | A comment or description about the new repository. |
RepositoryName | The name of the new repository to be created. |
Tags | One or more tag key-value pairs to use when tagging this repository. |
Triggers | The JSON block of configuration information for each trigger. |
Constructors
CfnRepositoryProps()
public CfnRepositoryProps()
Properties
Code
Information about code to be committed to a repository after it is created in an AWS CloudFormation stack.
public object Code { get; set; }
Property Value
System.Object
Remarks
Information about code is only used in resource creation. Updates to a stack will not reflect changes made to code properties after initial resource creation.
You can only use this property to add code when creating a repository with a AWS CloudFormation template at creation time. This property cannot be used for updating code to an existing repository.
KmsKeyId
The ID of the AWS Key Management Service encryption key used to encrypt and decrypt the repository.
public string KmsKeyId { get; set; }
Property Value
System.String
Remarks
The input can be the full ARN, the key ID, or the key alias. For more information, see Finding the key ID and key ARN .
RepositoryDescription
A comment or description about the new repository.
public string RepositoryDescription { get; set; }
Property Value
System.String
Remarks
The description field for a repository accepts all HTML characters and all valid Unicode characters. Applications that do not HTML-encode the description and display it in a webpage can expose users to potentially malicious code. Make sure that you HTML-encode the description field in any application that uses this API to display the repository description on a webpage.
RepositoryName
The name of the new repository to be created.
public string RepositoryName { get; set; }
Property Value
System.String
Remarks
The repository name must be unique across the calling AWS account . Repository names are limited to 100 alphanumeric, dash, and underscore characters, and cannot include certain characters. For more information about the limits on repository names, see Quotas in the AWS CodeCommit User Guide . The suffix .git is prohibited.
Tags
One or more tag key-value pairs to use when tagging this repository.
public ICfnTag[] Tags { get; set; }
Property Value
ICfnTag[]
Remarks
Triggers
The JSON block of configuration information for each trigger.
public object Triggers { get; set; }
Property Value
System.Object