Package software.amazon.awssdk.services.codeconnections.model

Class CreateSyncConfigurationRequest

java.lang.Object

software.amazon.awssdk.core.SdkRequest

software.amazon.awssdk.awscore.AwsRequest

software.amazon.awssdk.services.codeconnections.model.CodeConnectionsRequest

software.amazon.awssdk.services.codeconnections.model.CreateSyncConfigurationRequest

All Implemented Interfaces:

SdkPojo, ToCopyableBuilder<CreateSyncConfigurationRequest.Builder,CreateSyncConfigurationRequest>

@Generated("software.amazon.awssdk:codegen")
public final class CreateSyncConfigurationRequest
extends CodeConnectionsRequest
implements ToCopyableBuilder<CreateSyncConfigurationRequest.Builder,CreateSyncConfigurationRequest>

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	CreateSyncConfigurationRequest.Builder

Method Summary

Modifier and Type	Method	Description
String	branch()	The branch in the repository from which changes will be synced.
static CreateSyncConfigurationRequest.Builder	builder()
String	configFile()	The file name of the configuration file that manages syncing between the connection and the repository.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
PublishDeploymentStatus	publishDeploymentStatus()	Whether to enable or disable publishing of deployment status to source providers.
String	publishDeploymentStatusAsString()	Whether to enable or disable publishing of deployment status to source providers.
PullRequestComment	pullRequestComment()	A toggle that specifies whether to enable or disable pull request comments for the sync configuration to be created.
String	pullRequestCommentAsString()	A toggle that specifies whether to enable or disable pull request comments for the sync configuration to be created.
String	repositoryLinkId()	The ID of the repository link created for the connection.
String	resourceName()	The name of the Amazon Web Services resource (for example, a CloudFormation stack in the case of CFN_STACK_SYNC) that will be synchronized from the linked repository.
String	roleArn()	The ARN of the IAM role that grants permission for Amazon Web Services to use Git sync to update a given Amazon Web Services resource on your behalf.
Map<String,SdkField<?>>	sdkFieldNameToField()
List<SdkField<?>>	sdkFields()
static Class<? extends CreateSyncConfigurationRequest.Builder>	serializableBuilderClass()
SyncConfigurationType	syncType()	The type of sync configuration.
String	syncTypeAsString()	The type of sync configuration.
CreateSyncConfigurationRequest.Builder	toBuilder()
String	toString()	Returns a string representation of this object.
TriggerResourceUpdateOn	triggerResourceUpdateOn()	When to trigger Git sync to begin the stack update.
String	triggerResourceUpdateOnAsString()	When to trigger Git sync to begin the stack update.

Methods inherited from class software.amazon.awssdk.awscore.AwsRequest

overrideConfiguration

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder

copy

Method Detail

branch

public final String branch()

The branch in the repository from which changes will be synced.

Returns:

The branch in the repository from which changes will be synced.

configFile

public final String configFile()

The file name of the configuration file that manages syncing between the connection and the repository. This configuration file is stored in the repository.

Returns:

The file name of the configuration file that manages syncing between the connection and the repository. This configuration file is stored in the repository.

repositoryLinkId

public final String repositoryLinkId()

The ID of the repository link created for the connection. A repository link allows Git sync to monitor and sync changes to files in a specified Git repository.

Returns:

The ID of the repository link created for the connection. A repository link allows Git sync to monitor and sync changes to files in a specified Git repository.

resourceName

public final String resourceName()

The name of the Amazon Web Services resource (for example, a CloudFormation stack in the case of CFN_STACK_SYNC) that will be synchronized from the linked repository.

Returns:

The name of the Amazon Web Services resource (for example, a CloudFormation stack in the case of CFN_STACK_SYNC) that will be synchronized from the linked repository.

roleArn

public final String roleArn()

The ARN of the IAM role that grants permission for Amazon Web Services to use Git sync to update a given Amazon Web Services resource on your behalf.

Returns:

The ARN of the IAM role that grants permission for Amazon Web Services to use Git sync to update a given Amazon Web Services resource on your behalf.

syncType

public final SyncConfigurationType syncType()

The type of sync configuration.

If the service returns an enum value that is not available in the current SDK version, syncType will return SyncConfigurationType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from syncTypeAsString().

Returns:

The type of sync configuration.

See Also:

SyncConfigurationType

syncTypeAsString

public final String syncTypeAsString()

The type of sync configuration.

If the service returns an enum value that is not available in the current SDK version, syncType will return SyncConfigurationType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from syncTypeAsString().

Returns:

The type of sync configuration.

See Also:

SyncConfigurationType

publishDeploymentStatus

public final PublishDeploymentStatus publishDeploymentStatus()

Whether to enable or disable publishing of deployment status to source providers.

If the service returns an enum value that is not available in the current SDK version, publishDeploymentStatus will return PublishDeploymentStatus.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from publishDeploymentStatusAsString().

Returns:

Whether to enable or disable publishing of deployment status to source providers.

See Also:

PublishDeploymentStatus

publishDeploymentStatusAsString

public final String publishDeploymentStatusAsString()

Whether to enable or disable publishing of deployment status to source providers.

If the service returns an enum value that is not available in the current SDK version, publishDeploymentStatus will return PublishDeploymentStatus.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from publishDeploymentStatusAsString().

Returns:

Whether to enable or disable publishing of deployment status to source providers.

See Also:

PublishDeploymentStatus

triggerResourceUpdateOn

public final TriggerResourceUpdateOn triggerResourceUpdateOn()

When to trigger Git sync to begin the stack update.

If the service returns an enum value that is not available in the current SDK version, triggerResourceUpdateOn will return TriggerResourceUpdateOn.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from triggerResourceUpdateOnAsString().

Returns:

When to trigger Git sync to begin the stack update.

See Also:

TriggerResourceUpdateOn

triggerResourceUpdateOnAsString

public final String triggerResourceUpdateOnAsString()

When to trigger Git sync to begin the stack update.

If the service returns an enum value that is not available in the current SDK version, triggerResourceUpdateOn will return TriggerResourceUpdateOn.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from triggerResourceUpdateOnAsString().

Returns:

When to trigger Git sync to begin the stack update.

See Also:

TriggerResourceUpdateOn

pullRequestComment

public final PullRequestComment pullRequestComment()

A toggle that specifies whether to enable or disable pull request comments for the sync configuration to be created.

If the service returns an enum value that is not available in the current SDK version, pullRequestComment will return PullRequestComment.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from pullRequestCommentAsString().

Returns:

A toggle that specifies whether to enable or disable pull request comments for the sync configuration to be created.

See Also:

PullRequestComment

pullRequestCommentAsString

public final String pullRequestCommentAsString()

A toggle that specifies whether to enable or disable pull request comments for the sync configuration to be created.

If the service returns an enum value that is not available in the current SDK version, pullRequestComment will return PullRequestComment.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from pullRequestCommentAsString().

Returns:

A toggle that specifies whether to enable or disable pull request comments for the sync configuration to be created.

See Also:

PullRequestComment

toBuilder

public CreateSyncConfigurationRequest.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<CreateSyncConfigurationRequest.Builder,CreateSyncConfigurationRequest>

Specified by:

toBuilder in class CodeConnectionsRequest

builder

public static CreateSyncConfigurationRequest.Builder builder()

serializableBuilderClass

public static Class<? extends CreateSyncConfigurationRequest.Builder> serializableBuilderClass()

hashCode

public final int hashCode()

Overrides:

hashCode in class AwsRequest

equals

public final boolean equals(Object obj)

Overrides:

equals in class AwsRequest

equalsBySdkFields

public final boolean equalsBySdkFields(Object obj)

Specified by:

equalsBySdkFields in interface SdkPojo

toString

public final String toString()

Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value.

Overrides:

toString in class Object

getValueForField

public final <T> Optional<T> getValueForField(String fieldName,
                                              Class<T> clazz)

Overrides:

getValueForField in class SdkRequest

sdkFields

public final List<SdkField<?>> sdkFields()

Specified by:

sdkFields in interface SdkPojo

sdkFieldNameToField

public final Map<String,SdkField<?>> sdkFieldNameToField()

Specified by:

sdkFieldNameToField in interface SdkPojo