Interface ICfnRepositoryProps
Properties for defining a CfnRepository
.
Namespace: Amazon.CDK.AWS.CodeCommit
Assembly: Amazon.CDK.AWS.CodeCommit.dll
Syntax (csharp)
public interface ICfnRepositoryProps
Syntax (vb)
Public Interface 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"
},
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
Properties
Code | Information about code to be committed to a repository after it is created in an AWS CloudFormation stack. |
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. |
Properties
Code
Information about code to be committed to a repository after it is created in an AWS CloudFormation stack.
virtual object Code { get; }
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.
RepositoryDescription
A comment or description about the new repository.
virtual string RepositoryDescription { get; }
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.
string RepositoryName { get; }
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.
virtual ICfnTag[] Tags { get; }
Property Value
ICfnTag[]
Remarks
Triggers
The JSON block of configuration information for each trigger.
virtual object Triggers { get; }
Property Value
System.Object