CfnBuildPropsMixin

class aws_cdk.mixins_preview.aws_gamelift.mixins.CfnBuildPropsMixin(props, *, strategy=None)

Bases: Mixin

The AWS::GameLift::Build resource creates a game server build that is installed and run on instances in an Amazon GameLift fleet.

This resource points to an Amazon S3 location that contains a zip file with all of the components of the game server build.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-gamelift-build.html
CloudformationResource:: AWS::GameLift::Build
Mixin:: true
ExampleMetadata:: fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk.mixins_preview import mixins
from aws_cdk.mixins_preview.aws_gamelift import mixins as gamelift_mixins

cfn_build_props_mixin = gamelift_mixins.CfnBuildPropsMixin(gamelift_mixins.CfnBuildMixinProps(
    name="name",
    operating_system="operatingSystem",
    server_sdk_version="serverSdkVersion",
    storage_location=gamelift_mixins.CfnBuildPropsMixin.StorageLocationProperty(
        bucket="bucket",
        key="key",
        object_version="objectVersion",
        role_arn="roleArn"
    ),
    tags=[CfnTag(
        key="key",
        value="value"
    )],
    version="version"
),
    strategy=mixins.PropertyMergeStrategy.OVERRIDE
)

Create a mixin to apply properties to AWS::GameLift::Build.

Parameters:

props (Union[CfnBuildMixinProps, Dict[str, Any]]) – L1 properties to apply.
strategy (Optional[PropertyMergeStrategy]) – (experimental) Strategy for merging nested properties. Default: - PropertyMergeStrategy.MERGE

Methods

apply_to(construct)

Apply the mixin properties to the construct.

Parameters:: construct (IConstruct)
Return type:: IConstruct

supports(construct)

Check if this mixin supports the given construct.

Parameters:: construct (IConstruct)
Return type:: bool

Attributes

CFN_PROPERTY_KEYS = ['name', 'operatingSystem', 'serverSdkVersion', 'storageLocation', 'tags', 'version']

Static Methods

classmethod is_mixin(x)

(experimental) Checks if x is a Mixin.

Parameters:: x (Any) – Any object.
Return type:: bool
Returns:: true if x is an object created from a class which extends Mixin.
Stability:: experimental

StorageLocationProperty

class CfnBuildPropsMixin.StorageLocationProperty(*, bucket=None, key=None, object_version=None, role_arn=None)

Bases: object

The location in Amazon S3 where build or script files are stored for access by Amazon GameLift.

Parameters:

bucket (Optional[str]) – An Amazon S3 bucket identifier. The name of the S3 bucket. .. epigraph:: Amazon GameLift doesn’t support uploading from Amazon S3 buckets with names that contain a dot (.).
key (Optional[str]) – The name of the zip file that contains the build files or script files.
object_version (Optional[str]) – A version of a stored file to retrieve, if the object versioning feature is turned on for the S3 bucket. Use this parameter to specify a specific version. If this parameter isn’t set, Amazon GameLift Servers retrieves the latest version of the file.
role_arn (Optional[str]) – The ARNfor an IAM role that allows Amazon GameLift to access the S3 bucket.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-gamelift-build-storagelocation.html

ExampleMetadata:

fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk.mixins_preview.aws_gamelift import mixins as gamelift_mixins

storage_location_property = gamelift_mixins.CfnBuildPropsMixin.StorageLocationProperty(
    bucket="bucket",
    key="key",
    object_version="objectVersion",
    role_arn="roleArn"
)