Show / Hide Table of Contents

Class CfnStack.SourceProperty

Contains the information required to retrieve an app or cookbook from a repository.

Inheritance
System.Object
CfnStack.SourceProperty
Implements
CfnStack.ISourceProperty
Namespace: Amazon.CDK.AWS.OpsWorks
Assembly: Amazon.CDK.AWS.OpsWorks.dll
Syntax (csharp)
public class SourceProperty : Object, CfnStack.ISourceProperty
Syntax (vb)
Public Class SourceProperty
    Inherits Object
    Implements CfnStack.ISourceProperty
Remarks

For more information, see Creating Apps or Custom Recipes and Cookbooks .

Link: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-opsworks-stack-source.html

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.OpsWorks;

var sourceProperty = new SourceProperty {
    Password = "password",
    Revision = "revision",
    SshKey = "sshKey",
    Type = "type",
    Url = "url",
    Username = "username"
};

Synopsis

Constructors

SourceProperty()

Properties

Password

When included in a request, the parameter depends on the repository type.

Revision

The application's version.

SshKey

The repository's SSH key.

Type

The repository type.

Url

The source URL.

Username

This parameter depends on the repository type.

Constructors

SourceProperty()

public SourceProperty()

Properties

Password

When included in a request, the parameter depends on the repository type.

public string Password { get; set; }
Property Value

System.String

Remarks

    For more information on how to safely handle IAM credentials, see .

    In responses, AWS OpsWorks Stacks returns FILTERED instead of the actual value.

    Link: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-opsworks-stack-source.html#cfn-opsworks-custcookbooksource-password

    Revision

    The application's version.

    public string Revision { get; set; }
    Property Value

    System.String

    Remarks

    AWS OpsWorks Stacks enables you to easily deploy new versions of an application. One of the simplest approaches is to have branches or revisions in your repository that represent different versions that can potentially be deployed.

    Link: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-opsworks-stack-source.html#cfn-opsworks-custcookbooksource-revision

    SshKey

    The repository's SSH key.

    public string SshKey { get; set; }
    Property Value

    System.String

    Remarks

    For more information, see Using Git Repository SSH Keys in the AWS OpsWorks User Guide . To pass in an SSH key as a parameter, see the following example:

    "Parameters" : { "GitSSHKey" : { "Description" : "Change SSH key newlines to commas.", "Type" : "CommaDelimitedList", "NoEcho" : "true" }, ... "CustomCookbooksSource": { "Revision" : { "Ref": "GitRevision"}, "SshKey" : { "Fn::Join" : [ "\n", { "Ref": "GitSSHKey"} ] }, "Type": "git", "Url": { "Ref": "GitURL"} } ...

    Link: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-opsworks-stack-source.html#cfn-opsworks-custcookbooksource-sshkey

    Type

    The repository type.

    public string Type { get; set; }
    Property Value

    System.String

    Remarks

    Link: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-opsworks-stack-source.html#cfn-opsworks-custcookbooksource-type

    Url

    The source URL.

    public string Url { get; set; }
    Property Value

    System.String

    Remarks

    The following is an example of an Amazon S3 source URL: https://s3.amazonaws.com/opsworks-demo-bucket/opsworks_cookbook_demo.tar.gz .

    Link: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-opsworks-stack-source.html#cfn-opsworks-custcookbooksource-url

    Username

    This parameter depends on the repository type.

    public string Username { get; set; }
    Property Value

    System.String

    Remarks

      Link: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-opsworks-stack-source.html#cfn-opsworks-custcookbooksource-username

      Implements

      CfnStack.ISourceProperty
      Back to top Generated by DocFX