awscodecommit

package
v2.0.0-rc.24 Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: Oct 13, 2021 License: Apache-2.0 Imports: 9 Imported by: 6

Documentation

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

func CfnRepository_CFN_RESOURCE_TYPE_NAME 

func CfnRepository_CFN_RESOURCE_TYPE_NAME() *string

func CfnRepository_IsCfnElement 

func CfnRepository_IsCfnElement(x interface{}) *bool

Returns `true` if a construct is a stack element (i.e. part of the synthesized cloudformation template).

Uses duck-typing instead of `instanceof` to allow stack elements from different versions of this library to be included in the same stack.

Returns: The construct as a stack element or undefined if it is not a stack element. Experimental.

func CfnRepository_IsCfnResource 

func CfnRepository_IsCfnResource(construct constructs.IConstruct) *bool

Check whether the given construct is a CfnResource. Experimental.

func CfnRepository_IsConstruct 

func CfnRepository_IsConstruct(x interface{}) *bool

Checks if `x` is a construct.

Returns: true if `x` is an object created from a class which extends `Construct`. Deprecated: use `x instanceof Construct` instead

func NewCfnRepository_Override 

func NewCfnRepository_Override(c CfnRepository, scope constructs.Construct, id *string, props *CfnRepositoryProps)

Create a new `AWS::CodeCommit::Repository`.

func NewRepository_Override 

func NewRepository_Override(r Repository, scope constructs.Construct, id *string, props *RepositoryProps)

Experimental.

func ReferenceEvent_CommitId 

func ReferenceEvent_CommitId() *string

func ReferenceEvent_EventType 

func ReferenceEvent_EventType() *string

func ReferenceEvent_ReferenceFullName 

func ReferenceEvent_ReferenceFullName() *string

func ReferenceEvent_ReferenceName 

func ReferenceEvent_ReferenceName() *string

func ReferenceEvent_ReferenceType 

func ReferenceEvent_ReferenceType() *string

func ReferenceEvent_RepositoryId 

func ReferenceEvent_RepositoryId() *string

func ReferenceEvent_RepositoryName 

func ReferenceEvent_RepositoryName() *string

func Repository_IsConstruct 

func Repository_IsConstruct(x interface{}) *bool

Checks if `x` is a construct.

Returns: true if `x` is an object created from a class which extends `Construct`. Deprecated: use `x instanceof Construct` instead

func Repository_IsResource 

func Repository_IsResource(construct constructs.IConstruct) *bool

Check whether the given construct is a Resource. Experimental.

Types

type CfnRepository 

type CfnRepository interface {
	awscdk.CfnResource
	awscdk.IInspectable
	AttrArn() *string
	AttrCloneUrlHttp() *string
	AttrCloneUrlSsh() *string
	AttrName() *string
	CfnOptions() awscdk.ICfnResourceOptions
	CfnProperties() *map[string]interface{}
	CfnResourceType() *string
	Code() interface{}
	SetCode(val interface{})
	CreationStack() *[]*string
	LogicalId() *string
	Node() constructs.Node
	Ref() *string
	RepositoryDescription() *string
	SetRepositoryDescription(val *string)
	RepositoryName() *string
	SetRepositoryName(val *string)
	Stack() awscdk.Stack
	Tags() awscdk.TagManager
	Triggers() interface{}
	SetTriggers(val interface{})
	UpdatedProperites() *map[string]interface{}
	AddDeletionOverride(path *string)
	AddDependsOn(target awscdk.CfnResource)
	AddMetadata(key *string, value interface{})
	AddOverride(path *string, value interface{})
	AddPropertyDeletionOverride(propertyPath *string)
	AddPropertyOverride(propertyPath *string, value interface{})
	ApplyRemovalPolicy(policy awscdk.RemovalPolicy, options *awscdk.RemovalPolicyOptions)
	GetAtt(attributeName *string) awscdk.Reference
	GetMetadata(key *string) interface{}
	Inspect(inspector awscdk.TreeInspector)
	OverrideLogicalId(newLogicalId *string)
	RenderProperties(props *map[string]interface{}) *map[string]interface{}
	ShouldSynthesize() *bool
	ToString() *string
	ValidateProperties(_properties interface{})
}

A CloudFormation `AWS::CodeCommit::Repository`.

func NewCfnRepository 

func NewCfnRepository(scope constructs.Construct, id *string, props *CfnRepositoryProps) CfnRepository

Create a new `AWS::CodeCommit::Repository`.

type CfnRepositoryProps 

type CfnRepositoryProps struct {
	// `AWS::CodeCommit::Repository.RepositoryName`.
	RepositoryName *string `json:"repositoryName"`
	// `AWS::CodeCommit::Repository.Code`.
	Code interface{} `json:"code"`
	// `AWS::CodeCommit::Repository.RepositoryDescription`.
	RepositoryDescription *string `json:"repositoryDescription"`
	// `AWS::CodeCommit::Repository.Tags`.
	Tags *[]*awscdk.CfnTag `json:"tags"`
	// `AWS::CodeCommit::Repository.Triggers`.
	Triggers interface{} `json:"triggers"`
}

Properties for defining a `AWS::CodeCommit::Repository`.

type CfnRepository_CodeProperty 

type CfnRepository_CodeProperty struct {
	// `CfnRepository.CodeProperty.S3`.
	S3 interface{} `json:"s3"`
	// `CfnRepository.CodeProperty.BranchName`.
	BranchName *string `json:"branchName"`
}

type CfnRepository_RepositoryTriggerProperty 

type CfnRepository_RepositoryTriggerProperty struct {
	// `CfnRepository.RepositoryTriggerProperty.DestinationArn`.
	DestinationArn *string `json:"destinationArn"`
	// `CfnRepository.RepositoryTriggerProperty.Events`.
	Events *[]*string `json:"events"`
	// `CfnRepository.RepositoryTriggerProperty.Name`.
	Name *string `json:"name"`
	// `CfnRepository.RepositoryTriggerProperty.Branches`.
	Branches *[]*string `json:"branches"`
	// `CfnRepository.RepositoryTriggerProperty.CustomData`.
	CustomData *string `json:"customData"`
}

type CfnRepository_S3Property 

type CfnRepository_S3Property struct {
	// `CfnRepository.S3Property.Bucket`.
	Bucket *string `json:"bucket"`
	// `CfnRepository.S3Property.Key`.
	Key *string `json:"key"`
	// `CfnRepository.S3Property.ObjectVersion`.
	ObjectVersion *string `json:"objectVersion"`
}

type IRepository 

type IRepository interface {
	awscodestarnotifications.INotificationRuleSource
	awscdk.IResource
	// Grant the given principal identity permissions to perform the actions on this repository.
	// Experimental.
	Grant(grantee awsiam.IGrantable, actions ...*string) awsiam.Grant
	// Grant the given identity permissions to pull this repository.
	// Experimental.
	GrantPull(grantee awsiam.IGrantable) awsiam.Grant
	// Grant the given identity permissions to pull and push this repository.
	// Experimental.
	GrantPullPush(grantee awsiam.IGrantable) awsiam.Grant
	// Grant the given identity permissions to read this repository.
	// Experimental.
	GrantRead(grantee awsiam.IGrantable) awsiam.Grant
	// Defines a CodeStar Notification rule which triggers when a pull request is merged.
	// Experimental.
	NotifiyOnPullRequestMerged(id *string, target awscodestarnotifications.INotificationRuleTarget, options *awscodestarnotifications.NotificationRuleOptions) awscodestarnotifications.INotificationRule
	// Defines a CodeStar Notification rule triggered when the project events specified by you are emitted. Similar to `onEvent` API.
	//
	// You can also use the methods to define rules for the specific event emitted.
	// eg: `notifyOnPullRequstCreated`.
	//
	// Returns: CodeStar Notifications rule associated with this repository.
	// Experimental.
	NotifyOn(id *string, target awscodestarnotifications.INotificationRuleTarget, options *RepositoryNotifyOnOptions) awscodestarnotifications.INotificationRule
	// Defines a CodeStar Notification rule which triggers when an approval rule is overridden.
	// Experimental.
	NotifyOnApprovalRuleOverridden(id *string, target awscodestarnotifications.INotificationRuleTarget, options *awscodestarnotifications.NotificationRuleOptions) awscodestarnotifications.INotificationRule
	// Defines a CodeStar Notification rule which triggers when an approval status is changed.
	// Experimental.
	NotifyOnApprovalStatusChanged(id *string, target awscodestarnotifications.INotificationRuleTarget, options *awscodestarnotifications.NotificationRuleOptions) awscodestarnotifications.INotificationRule
	// Defines a CodeStar Notification rule which triggers when a new branch or tag is created.
	// Experimental.
	NotifyOnBranchOrTagCreated(id *string, target awscodestarnotifications.INotificationRuleTarget, options *awscodestarnotifications.NotificationRuleOptions) awscodestarnotifications.INotificationRule
	// Defines a CodeStar Notification rule which triggers when a branch or tag is deleted.
	// Experimental.
	NotifyOnBranchOrTagDeleted(id *string, target awscodestarnotifications.INotificationRuleTarget, options *awscodestarnotifications.NotificationRuleOptions) awscodestarnotifications.INotificationRule
	// Defines a CodeStar Notification rule which triggers when a comment is made on a pull request.
	// Experimental.
	NotifyOnPullRequestComment(id *string, target awscodestarnotifications.INotificationRuleTarget, options *awscodestarnotifications.NotificationRuleOptions) awscodestarnotifications.INotificationRule
	// Defines a CodeStar Notification rule which triggers when a pull request is created.
	// Experimental.
	NotifyOnPullRequestCreated(id *string, target awscodestarnotifications.INotificationRuleTarget, options *awscodestarnotifications.NotificationRuleOptions) awscodestarnotifications.INotificationRule
	// Defines a CloudWatch event rule which triggers when a comment is made on a commit.
	// Experimental.
	OnCommentOnCommit(id *string, options *awsevents.OnEventOptions) awsevents.Rule
	// Defines a CloudWatch event rule which triggers when a comment is made on a pull request.
	// Experimental.
	OnCommentOnPullRequest(id *string, options *awsevents.OnEventOptions) awsevents.Rule
	// Defines a CloudWatch event rule which triggers when a commit is pushed to a branch.
	// Experimental.
	OnCommit(id *string, options *OnCommitOptions) awsevents.Rule
	// Defines a CloudWatch event rule which triggers for repository events.
	//
	// Use
	// `rule.addEventPattern(pattern)` to specify a filter.
	// Experimental.
	OnEvent(id *string, options *awsevents.OnEventOptions) awsevents.Rule
	// Defines a CloudWatch event rule which triggers when a pull request state is changed.
	// Experimental.
	OnPullRequestStateChange(id *string, options *awsevents.OnEventOptions) awsevents.Rule
	// Defines a CloudWatch event rule which triggers when a reference is created (i.e. a new branch/tag is created) to the repository.
	// Experimental.
	OnReferenceCreated(id *string, options *awsevents.OnEventOptions) awsevents.Rule
	// Defines a CloudWatch event rule which triggers when a reference is delete (i.e. a branch/tag is deleted) from the repository.
	// Experimental.
	OnReferenceDeleted(id *string, options *awsevents.OnEventOptions) awsevents.Rule
	// Defines a CloudWatch event rule which triggers when a reference is updated (i.e. a commit is pushed to an existing or new branch) from the repository.
	// Experimental.
	OnReferenceUpdated(id *string, options *awsevents.OnEventOptions) awsevents.Rule
	// Defines a CloudWatch event rule which triggers when a "CodeCommit Repository State Change" event occurs.
	// Experimental.
	OnStateChange(id *string, options *awsevents.OnEventOptions) awsevents.Rule
	// The ARN of this Repository.
	// Experimental.
	RepositoryArn() *string
	// The HTTPS (GRC) clone URL.
	//
	// HTTPS (GRC) is the protocol to use with git-remote-codecommit (GRC).
	//
	// It is the recommended method for supporting connections made with federated
	// access, identity providers, and temporary credentials.
	// See: https://docs.aws.amazon.com/codecommit/latest/userguide/setting-up-git-remote-codecommit.html
	//
	// Experimental.
	RepositoryCloneUrlGrc() *string
	// The HTTP clone URL.
	// Experimental.
	RepositoryCloneUrlHttp() *string
	// The SSH clone URL.
	// Experimental.
	RepositoryCloneUrlSsh() *string
	// The human-visible name of this Repository.
	// Experimental.
	RepositoryName() *string
}

Experimental.

func Repository_FromRepositoryArn 

func Repository_FromRepositoryArn(scope constructs.Construct, id *string, repositoryArn *string) IRepository

Imports a codecommit repository. Experimental.

func Repository_FromRepositoryName 

func Repository_FromRepositoryName(scope constructs.Construct, id *string, repositoryName *string) IRepository

Experimental.

type OnCommitOptions 

type OnCommitOptions struct {
	// A description of the rule's purpose.
	// Experimental.
	Description *string `json:"description"`
	// Additional restrictions for the event to route to the specified target.
	//
	// The method that generates the rule probably imposes some type of event
	// filtering. The filtering implied by what you pass here is added
	// on top of that filtering.
	// See: https://docs.aws.amazon.com/eventbridge/latest/userguide/eventbridge-and-event-patterns.html
	//
	// Experimental.
	EventPattern *awsevents.EventPattern `json:"eventPattern"`
	// A name for the rule.
	// Experimental.
	RuleName *string `json:"ruleName"`
	// The target to register for the event.
	// Experimental.
	Target awsevents.IRuleTarget `json:"target"`
	// The branch to monitor.
	// Experimental.
	Branches *[]*string `json:"branches"`
}

Options for the onCommit() method. Experimental.

type ReferenceEvent 

type ReferenceEvent interface {
}

Fields of CloudWatch Events that change references. See: https://docs.aws.amazon.com/AmazonCloudWatch/latest/events/EventTypes.html#codebuild_event_type

Experimental.

type Repository 

type Repository interface {
	awscdk.Resource
	IRepository
	Env() *awscdk.ResourceEnvironment
	Node() constructs.Node
	PhysicalName() *string
	RepositoryArn() *string
	RepositoryCloneUrlGrc() *string
	RepositoryCloneUrlHttp() *string
	RepositoryCloneUrlSsh() *string
	RepositoryName() *string
	Stack() awscdk.Stack
	ApplyRemovalPolicy(policy awscdk.RemovalPolicy)
	BindAsNotificationRuleSource(_scope constructs.Construct) *awscodestarnotifications.NotificationRuleSourceConfig
	GeneratePhysicalName() *string
	GetResourceArnAttribute(arnAttr *string, arnComponents *awscdk.ArnComponents) *string
	GetResourceNameAttribute(nameAttr *string) *string
	Grant(grantee awsiam.IGrantable, actions ...*string) awsiam.Grant
	GrantPull(grantee awsiam.IGrantable) awsiam.Grant
	GrantPullPush(grantee awsiam.IGrantable) awsiam.Grant
	GrantRead(grantee awsiam.IGrantable) awsiam.Grant
	NotifiyOnPullRequestMerged(id *string, target awscodestarnotifications.INotificationRuleTarget, options *awscodestarnotifications.NotificationRuleOptions) awscodestarnotifications.INotificationRule
	Notify(arn *string, options *RepositoryTriggerOptions) Repository
	NotifyOn(id *string, target awscodestarnotifications.INotificationRuleTarget, options *RepositoryNotifyOnOptions) awscodestarnotifications.INotificationRule
	NotifyOnApprovalRuleOverridden(id *string, target awscodestarnotifications.INotificationRuleTarget, options *awscodestarnotifications.NotificationRuleOptions) awscodestarnotifications.INotificationRule
	NotifyOnApprovalStatusChanged(id *string, target awscodestarnotifications.INotificationRuleTarget, options *awscodestarnotifications.NotificationRuleOptions) awscodestarnotifications.INotificationRule
	NotifyOnBranchOrTagCreated(id *string, target awscodestarnotifications.INotificationRuleTarget, options *awscodestarnotifications.NotificationRuleOptions) awscodestarnotifications.INotificationRule
	NotifyOnBranchOrTagDeleted(id *string, target awscodestarnotifications.INotificationRuleTarget, options *awscodestarnotifications.NotificationRuleOptions) awscodestarnotifications.INotificationRule
	NotifyOnPullRequestComment(id *string, target awscodestarnotifications.INotificationRuleTarget, options *awscodestarnotifications.NotificationRuleOptions) awscodestarnotifications.INotificationRule
	NotifyOnPullRequestCreated(id *string, target awscodestarnotifications.INotificationRuleTarget, options *awscodestarnotifications.NotificationRuleOptions) awscodestarnotifications.INotificationRule
	OnCommentOnCommit(id *string, options *awsevents.OnEventOptions) awsevents.Rule
	OnCommentOnPullRequest(id *string, options *awsevents.OnEventOptions) awsevents.Rule
	OnCommit(id *string, options *OnCommitOptions) awsevents.Rule
	OnEvent(id *string, options *awsevents.OnEventOptions) awsevents.Rule
	OnPullRequestStateChange(id *string, options *awsevents.OnEventOptions) awsevents.Rule
	OnReferenceCreated(id *string, options *awsevents.OnEventOptions) awsevents.Rule
	OnReferenceDeleted(id *string, options *awsevents.OnEventOptions) awsevents.Rule
	OnReferenceUpdated(id *string, options *awsevents.OnEventOptions) awsevents.Rule
	OnStateChange(id *string, options *awsevents.OnEventOptions) awsevents.Rule
	ToString() *string
}

Provides a CodeCommit Repository. Experimental.

func NewRepository 

func NewRepository(scope constructs.Construct, id *string, props *RepositoryProps) Repository

Experimental.

type RepositoryEventTrigger 

type RepositoryEventTrigger string

Repository events that will cause the trigger to run actions in another service. Experimental. 

const (
	RepositoryEventTrigger_ALL        RepositoryEventTrigger = "ALL"
	RepositoryEventTrigger_UPDATE_REF RepositoryEventTrigger = "UPDATE_REF"
	RepositoryEventTrigger_CREATE_REF RepositoryEventTrigger = "CREATE_REF"
	RepositoryEventTrigger_DELETE_REF RepositoryEventTrigger = "DELETE_REF"
)

type RepositoryNotificationEvents 

type RepositoryNotificationEvents string

List of event types for AWS CodeCommit. See: https://docs.aws.amazon.com/dtconsole/latest/userguide/concepts.html#events-ref-repositories

Experimental. 

const (
	RepositoryNotificationEvents_COMMIT_COMMENT              RepositoryNotificationEvents = "COMMIT_COMMENT"
	RepositoryNotificationEvents_PULL_REQUEST_COMMENT        RepositoryNotificationEvents = "PULL_REQUEST_COMMENT"
	RepositoryNotificationEvents_APPROVAL_STATUS_CHANGED     RepositoryNotificationEvents = "APPROVAL_STATUS_CHANGED"
	RepositoryNotificationEvents_APPROVAL_RULE_OVERRIDDEN    RepositoryNotificationEvents = "APPROVAL_RULE_OVERRIDDEN"
	RepositoryNotificationEvents_PULL_REQUEST_CREATED        RepositoryNotificationEvents = "PULL_REQUEST_CREATED"
	RepositoryNotificationEvents_PULL_REQUEST_SOURCE_UPDATED RepositoryNotificationEvents = "PULL_REQUEST_SOURCE_UPDATED"
	RepositoryNotificationEvents_PULL_REQUEST_STATUS_CHANGED RepositoryNotificationEvents = "PULL_REQUEST_STATUS_CHANGED"
	RepositoryNotificationEvents_PULL_REQUEST_MERGED         RepositoryNotificationEvents = "PULL_REQUEST_MERGED"
	RepositoryNotificationEvents_BRANCH_OR_TAG_CREATED       RepositoryNotificationEvents = "BRANCH_OR_TAG_CREATED"
	RepositoryNotificationEvents_BRANCH_OR_TAG_DELETED       RepositoryNotificationEvents = "BRANCH_OR_TAG_DELETED"
	RepositoryNotificationEvents_BRANCH_OR_TAG_UPDATED       RepositoryNotificationEvents = "BRANCH_OR_TAG_UPDATED"
)

type RepositoryNotifyOnOptions 

type RepositoryNotifyOnOptions struct {
	// The level of detail to include in the notifications for this resource.
	//
	// BASIC will include only the contents of the event as it would appear in AWS CloudWatch.
	// FULL will include any supplemental information provided by AWS CodeStar Notifications and/or the service for the resource for which the notification is created.
	// Experimental.
	DetailType awscodestarnotifications.DetailType `json:"detailType"`
	// The status of the notification rule.
	//
	// If the enabled is set to DISABLED, notifications aren't sent for the notification rule.
	// Experimental.
	Enabled *bool `json:"enabled"`
	// The name for the notification rule.
	//
	// Notification rule names must be unique in your AWS account.
	// Experimental.
	NotificationRuleName *string `json:"notificationRuleName"`
	// A list of event types associated with this notification rule for CodeCommit repositories.
	//
	// For a complete list of event types and IDs, see Notification concepts in the Developer Tools Console User Guide.
	// See: https://docs.aws.amazon.com/dtconsole/latest/userguide/concepts.html#concepts-api
	//
	// Experimental.
	Events *[]RepositoryNotificationEvents `json:"events"`
}

Additional options to pass to the notification rule. Experimental.

type RepositoryProps 

type RepositoryProps struct {
	// Name of the repository.
	//
	// This property is required for all CodeCommit repositories.
	// Experimental.
	RepositoryName *string `json:"repositoryName"`
	// A description of the repository.
	//
	// Use the description to identify the
	// purpose of the repository.
	// Experimental.
	Description *string `json:"description"`
}

Experimental.

type RepositoryTriggerOptions 

type RepositoryTriggerOptions struct {
	// The names of the branches in the AWS CodeCommit repository that contain events that you want to include in the trigger.
	//
	// If you don't specify at
	// least one branch, the trigger applies to all branches.
	// Experimental.
	Branches *[]*string `json:"branches"`
	// When an event is triggered, additional information that AWS CodeCommit includes when it sends information to the target.
	// Experimental.
	CustomData *string `json:"customData"`
	// The repository events for which AWS CodeCommit sends information to the target, which you specified in the DestinationArn property.If you don't specify events, the trigger runs for all repository events.
	// Experimental.
	Events *[]RepositoryEventTrigger `json:"events"`
	// A name for the trigger.Triggers on a repository must have unique names.
	// Experimental.
	Name *string `json:"name"`
}

Creates for a repository trigger to an SNS topic or Lambda function. Experimental.

Source Files

View all Source files

Directories

Path Synopsis

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.