Package software.amazon.awscdk.services.codepipeline

Interface CfnPipeline.RuleTypeIdProperty

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnPipeline.RuleTypeIdProperty.Jsii$Proxy

Enclosing class:

CfnPipeline

@Stability(Stable)
public static interface CfnPipeline.RuleTypeIdProperty
extends software.amazon.jsii.JsiiSerializable

The ID for the rule type, which is made up of the combined values for category, owner, provider, and version.

For more information about conditions, see Stage conditions . For more information about rules, see the AWS CodePipeline rule reference .

Example:

 // The code below shows an example of how to instantiate this type.
 // The values are placeholders you should change.
 import software.amazon.awscdk.services.codepipeline.*;
 RuleTypeIdProperty ruleTypeIdProperty = RuleTypeIdProperty.builder()
         .category("category")
         .owner("owner")
         .provider("provider")
         .version("version")
         .build();
 

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codepipeline-pipeline-ruletypeid.html

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static final class	CfnPipeline.RuleTypeIdProperty.Builder	A builder for CfnPipeline.RuleTypeIdProperty
static final class	CfnPipeline.RuleTypeIdProperty.Jsii$Proxy	An implementation for CfnPipeline.RuleTypeIdProperty

Method Summary

Modifier and Type	Method	Description
static CfnPipeline.RuleTypeIdProperty.Builder	builder()
default String	getCategory()	A category defines what kind of rule can be run in the stage, and constrains the provider type for the rule.
default String	getOwner()	The creator of the rule being called.
default String	getProvider()	The rule provider, such as the DeploymentWindow rule.
default String	getVersion()	A string that describes the rule version.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getCategory

@Stability(Stable)
@Nullable
default String getCategory()

A category defines what kind of rule can be run in the stage, and constrains the provider type for the rule.

The valid category is Rule .

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codepipeline-pipeline-ruletypeid.html#cfn-codepipeline-pipeline-ruletypeid-category

getOwner

@Stability(Stable)
@Nullable
default String getOwner()

The creator of the rule being called.

The valid value for the Owner field in the rule category is AWS .

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codepipeline-pipeline-ruletypeid.html#cfn-codepipeline-pipeline-ruletypeid-owner

getProvider

@Stability(Stable)
@Nullable
default String getProvider()

The rule provider, such as the DeploymentWindow rule.

For a list of rule provider names, see the rules listed in the AWS CodePipeline rule reference .

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codepipeline-pipeline-ruletypeid.html#cfn-codepipeline-pipeline-ruletypeid-provider

getVersion

@Stability(Stable)
@Nullable
default String getVersion()

A string that describes the rule version.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codepipeline-pipeline-ruletypeid.html#cfn-codepipeline-pipeline-ruletypeid-version

builder

@Stability(Stable)
static CfnPipeline.RuleTypeIdProperty.Builder builder()

Returns:

a CfnPipeline.RuleTypeIdProperty.Builder of CfnPipeline.RuleTypeIdProperty