Skip to content

README.md

Latest commit

 

History

History
95 lines (56 loc) · 2.64 KB

README.md

File metadata and controls

95 lines (56 loc) · 2.64 KB

GitLab::Code::Tag

Creates a tag against a code ref in GitLab

Syntax

To declare this entity in your AWS CloudFormation template, use the following syntax:

JSON

{
    "Type" : "GitLab::Code::Tag",
    "Properties" : {
        "Name" : String,
        "ProjectId" : Integer,
        "Ref" : String,
        "Message" : String,
    }
}

YAML

Type: GitLab::Code::Tag
Properties:
    Name: String
    ProjectId: Integer
    Ref: String
    Message: String

Properties

Name

The name of the tag to create

Required: Yes

Type: String

Maximum Length: 64

Update requires: Replacement

ProjectId

The ID of the project which will be tagged

Required: Yes

Type: Integer

Update requires: Replacement

Ref

The reference to the code commit to be tagged, either a commit SHA ID or a branch name (to use the commit which is head of that branch at time of tag creation)

Required: Yes

Type: String

Maximum Length: 64

Update requires: Replacement

Message

A message to attach to the tag

Required: No

Type: String

Update requires: No interruption

Return Values

Fn::GetAtt

The Fn::GetAtt intrinsic function returns a value for a specified attribute of this type. The following are the available attributes and sample return values.

For more information about using the Fn::GetAtt intrinsic function, see Fn::GetAtt.

TagId

A CloudFormation ID to identify this tag

CommitId

The actual commit SHA ID referenced by this tag, set by the resource provider. This will be equal to Ref if Ref is a commit SHA ID, or set by the provider to point at the commit if Ref is a branch name.